System Fields

System Fields are default fields available in the Straatos platform and in most cases are pre-filled from the System.

System Fields can be used to:

• Route Documents with an Exclusive Gateway
• Use in Scripts to read the value or assign a value to the System Fields
• add values in Process Steps, for example set the Scan Operator as the email receipiant

The following section explains the different System Fields and how they can be used including some scripting examples

_documentId

When a document is created, a unique numeric ID is generated. The variable _documentId contains this ID. _documentId is a read only variable.

_userId

The variable _userId is used by Web Validation to assign a document to a specific user. For more information see Assign Document to User for Web Validation.

_errorMessage

The variable _errorMessage is used to store error information when a (technical) error occurs in one of the modules, like the Service Task. An example of this would be that the extraction module cannot process a document if the document has not yet been through an OCR step. The variable _errorMessage can also be assigned in a Script Task to indicate a problem, for example:

_errorMessage = 'Web Service did not return expected result';
onwards = false; // keep the document in this workflow step

_status

_status is a system variable set by a previous workflow step, typically a web validation step. The _status field contains the value of the button the user pressed when closing a document. As such, the _status field can have no value if a document has been completed normally or it can have the value 'invalid' to indicate the user pressed the 'Complete Ignoring Validation' button whith at least one invalid field value to close this document. Hence with _status, the document can be routed to different process steps depending on the action the web valiation user has selected.

The _status variable will be assigned one of the following values by Web Validation:

• No value if the document is Completed normally without validation errors
• 'invalid' if the document is completed with validation errors (also if a Custom Button is used to complete the document)
• 'reject' if the Reject button is used
• 'return' if the Return button is used
• 'rework' if the Rework button is used
• 'rescan' if the Rescan button is used

Using _status in Script

The _status value can be assigned and read in a ScriptTask.

Here is a sample script assigning (setting) the _status value:

_status = 'reject';

In this case, the field  _status gets the value 'reject' assigned.

Here is a sample script reading the currently assigned value in _status:

var status;
status = _status;

_moveToStep

In the workflow designer, up to 3 custom buttons can be configured:

If the user presses this button, the variable _moveToStep will be assigned the value 'Custom Action 1'.

_customData

CustomData is a string optionally provided by a capture client, for example Scan+ProcessLite or Scan+Express. This parameter can be any string and passed during the upload of a document to Straatos into the _customData system variable.

_authAccountId

When an account is created in the Admin Panel, a unique numerid ID will be generated for the account. This ID can be seen in the URL of the Account maintenance screen in the Admin Panel:

_authLoginName

When an account is created in the Admin Panel, a Login Email Address is specified:

For each document that was sent into Straatos from a Scan Client (Scan+ProcessLite, Scan+Express, Mobile Capture etc.) the variable _authAccountLoginName will hold the Login Email Address of the account if the user was authenticated.

_authUserIdentifier

When an account is created in the Admin Panel, a User Identifier can be specified:

For each document that was sent into Straatos from a Scan Client (Scan+ProcessLite, Scan+Express, Mobile Capture etc.) the variable _authUserIdentifier will hold the User Identifier of the account if the user was authenticated.