This object represents the execution of a Process definition.
Allows to load a process instance from the identifier.
Load (id)
Process instance execution starts.
Start ()
Process instance execution starts. The process execution starts as from the specified activity.
StartFrom (activity)
Name |
Type |
Movement |
Description |
activity |
WorkflowActivity |
Input |
Activity with which you want to Start the process instance (must be one of the initial activities) |
Suspends the process instance.
Suspend ()
Resumes the execution of the process instance.
Resume ()
Aborts the process instance.
Abort ()
Changes process instance states according to the specified value(see documentation on Workflow objects states).
ChangeState (state)
Returns the Application Data type object whose name coincides with the specified one.
GetApplicationDataByName (name): applicationData
Name |
Type |
Movement |
Description |
name |
Character |
Input |
Name of the application data |
It allows preassigning a workitem corresponding to the specified activity. It is considered a previous assignment since the workitem does not need to exist; in the future at the creation of a workitem corresponding to the activity, the workflow engine will make the assignment.
PreassignWorkitem (activity, user)
Returns the workitem object associated to the specified activity. If there is no workitem associated to this activity, an error is received back (801). If there are several workitems associated to the activity, the most recent workitem is received back.
GetWorkitemByActivity (activity): workitem
Creates a workitem associated to the specified activity (*).
CreateWorkitem (activity): workitem
(*) If there is already a workitem corresponding to the activity in active state, the already existing workitem is returned instead of creating a new one.
Restarts from an activity, a terminated process instance.
Reactivate (activity)
Name |
Type |
Movement |
Description |
activity |
WorkflowActivity |
Input |
Activity to restart |
Assigns the organizational unit to the process instance.
AssignOrganizationalUnit (organizationalUnit)
- UnassignOrganizationalUnit
Unassign the organizatinal unit to the process instance.
UnassignOrganizationalUnit (organizationalUnit)
Adds a restriction to the process instance.
AddRestriction (restriction)
Name |
Type |
Movement |
Description |
restriction |
WorkflowRestriction |
Input |
Restriction to be added to the process instance |
Removes a restriction from the process instance.
RemoveRestriction (restriction)
Name |
Type |
Movement |
Description |
restriction |
WorkflowRestriction |
Input |
Restriction to be removed from the process instance |
Allows to throw a signal from the process instance.
ThrowSignal (signal)
Name |
Type |
Movement |
Description |
signal |
WorkflowName |
Input |
Signal Name to be thrown |