Unlike with regular instance variables, end users can search for process instances using predefined variables in their search conditions.
| Predefined Variable | Permitted Values | Type | Description |
|---|---|---|---|
| action | Modifiable : OK ; FAIL ; RELEASE ; CANCEL ; REPEAT ; ABORT ; BACK ; SKIP ; NONE | Fuego.Lib.Action | The value of the action defines the outcome of the current activity transaction. Depending on this value, the Process Execution Engine decides what to do with the current process instance after the execution of the activity is finished. The action variable is reset before every transaction. See Action Variable for details. |
| activity | Read only | Fuego.Lib.Activity | Holds an object representing the current process activity. |
| activity.deadline | Read only | Time | Set automatically when there is an outgoing Due transition on the current activity (receptionTime + the due transition time interval.) |
| activity.source | Read only | Fuego.Lib.Activity | The activity from which the current instance came into the current activity. Null in the case of Global and Begin activities. When the process instance is in an exception handling flow (or Termination Wait flow), the value of activity.source refers to the activity that raised the exception (or received the notification). |
| attachments | Read only | Fuego.Lib.Attachment[] | Array holding the process instance attachments. |
| children | Read only | String[ordered Object] | Array of the Ids of the process instances that are children of this instance, ordered by the list of activities that created them. Children instances are those instances created by the Subflow activity or Process Creation activity. |
| creation.participant | Read only. | Participant | Participant (end user) that created this process instance. |
| creation.time | Read only | Time | Creation time of this process instance. |
| currentException | Read only | String | When the process instance is within an exception handling flow, this variable holds the name of the exception. |
| deadline | Modifiable. | Time | The Process Execution Engine raises an InstanceExpirationException on the process instance if the instance does not reach the End activity before the time specified by deadline. |
| description | Modifiable | String | Descriptive name of the instance that appears in WorkSpace. By default: ProcessName + id.number. |
| id.id | Read only | String | The process instance unique identifier. It includes the deployed process name, organization, organizational unit and the instance Id (including thread id). |
| id.number | Read only | Int | A number that uniquely identifies an instance within an Engine. |
| id.copy | Read Only | Int | The current instance copy (thread) number. Copies are those instances created by a Multiple Gateways and Split Gateways. |
| notes | Read only | Int | An array of all notes added to an instance. |
| organization | Read Only | String | Name of organization where the process is running. |
| organiztionalUnit | Read Only | String | Name of the process Organizational Unit, such as Marketing or Finance. |
| parent.id | Read only | String | The Id of the parent instance of the current instance if there is one; null otherwise. In the case of a Procedure, it contains the id of the calling process |
| parent.copy | Read only | Int | The parent instance thread number. |
| parent.number | Read only | Int | A number that uniquely identifies the parent instance within an Engine. |
| participant | Read Only. Any participant | Fuego.Lib.Participant | The human participant (end user) that is currently processing the instance. |
| participant.locale | Read Only | Fuego.Util.Locale | The language, country and variant, if applicable, of the current participant. |
| participant.next | Modifiable: Any participant | Fuego.Lib.Participant | The participant to which the instance will be assigned when it arrives to the next activity. |
| participant.sticky | Modifiable: Bool | Fuego.Lib.Participant | If participant.sticky is set to true, variable participant.next is automatically set to the current participant (that is, the value of participant). Each time the instance moves to a new activity, it is assigned to this participant (provided the participant has visibility over the activity). |
| priority | Modifiable: 1 Lowest ; 2 Low ; 3 Normal ; 4 High ; 5 Highest | Int | Priority of the instance. This variable is intended to be used as a hint to participants regarding the urgency of each work item. The value of priority has no effect on how the Process Execution Engine handles each process instance. |
| process | Read Only | Fuego.Lib.Process | The process the instance belongs to. |
| process.id | Read Only | String | The Identifier of the deployed process containing the deployed process name, its organization and organizational unit. |
| process.idNumber | Read Only | Int | A number that identifies the process inside the Engine |
| process.name | Read only | String | The name of the current process. |
| receptionTime | Read only | Time | The time when the current instance arrived at the current activity. |
| result | Modifiable: Any string | String | Generic String you can use to set to indicate the outcome of the
current activity. Intended to be used for evaluating outgoing conditional
transitions. The value of result is reset when the
instances arrives to a new activity.
Important:
For backward compatibility, if the action variable is
not set in a PBL-method and the value of result is
one of the possible values of action, the Engine maps
the value of result to variable
action. For example, if variable
result is set to "FAIL", this is equivalent to
setting action to Action.FAIL.
|
| status | Read Only. RUNNING, EXCEPTION, SUSPENDED, GRABBED, COMPLETED, ABORTED, ACTIVITY_COMPLETED | ProcessInstanceState | Current status of the process instance. |
| timeout | Modifiable | Interval | The amount of time that a PBL-Method transaction has to complete before the Process Execution Engine aborts its execution. By default this variable is set to 5 minutes. The Maximum Timeout property of the Engine defines the maximum value you can assign to variable timeout. |
| totalCopies | Read only | Int | Number of copies of an instance. |