Properties for Subprocesses
You can use properties to further define the resource you are configuring.
Properties
The following table describes the available options.
Property | Read | Write | Description |
---|---|---|---|
Auto Select | All | None |
Flags a task to be executed prior to non-flagged task steps in a subprocess during run time. |
Absolute Expiry Time | All | All | In a preprocess or a presubprocess, you can set an absolute expiry time (DateTime value) if the Expiry Type is set to Absolute. |
Relative Expiry Time | All | All | In a preprocess or a presubprocess, you can set a relative expiry time (TimeSpan value) if the Expiry Type is set to Relative. |
Expiry Type | All | All | Allows you to set the subprocess's expiration to Absolute, Relative, or None during run time. |
Assigned Location | All | All | This value indicates the assigned location of a computer and/or a piece of equipment. |
Assigned Personnel | All | All | This value indicates the personnel assigned to a task step. |
Completed | All | None | Read Only Allows you to determine if a specific executed subprocess or task step has completed or been cancelled. This value is set to False for all subprocesses at the beginning of the process loop. It is set to True after the subprocess activity execution finishes if the task step was completed (not cancelled). It is reset to False if a jump operation to or before the subprocess is performed. If an unhandled fault occurs during subprocess execution, this flag is set to False. |
Completion Code | All | None | Read Only |
Current Computer | All | None | Read Only |
Current User | All | None | Read Only |
Enabled | All | External | True if enabled, False if not. |
Executed | All | None | Read Only Allows you to determine if a specific subprocess or task step has been executed by the workflow engine. The value for this property is set to False for all subprocesses by the Process Workflow activity before it executes the preprocess. The value is set to True after each subprocess finishes execution, but before the postsubprocess executes. The value is not set to True if the subprocess is skipped. |
Global Subprocess | All | None | Read Only |
Id | All | None | Read Only Unique key in the scope of a workflow/schedule definition that identifies a step within the workflow/schedule. |
Is Global Subprocess | All | None | Read Only |
Is Acquired | All | All |
True if subprocess task step has been acquired by another user, False if it has not. Validation: can only be set to False at runtime when task step is already acquired. |
Manual Start | All | None | True if the task step needs to be manually started, False if it does not. |
My Task List Documents State | All | All | Type: MyTaskListExpanderLayout Possible values: UserConfiguration, Auto, Expanded, Collapsed |
My Task List Documents View | All | All | Type: DocumentsView Possible values: Input, WorkInstructions, LinkedDocuments |
My Task List Documents Visibility | All | All | True if the Task List's documents are visible, False if they are not. |
My Task List Expander Position | All | All | Type: ExpanderPosition Possible values: Horizontal and Vertical |
My Task List Input State | All | All | Type: MyTaskListExpanderLayout Possible values: UserConfiguration, Auto, Expanded, Collapsed |
Task Step Instance Name | All | All | The string name of the task step instance. |
My Task List Input Visibility | All | All | N/A |
Name | All | None | Read Only Display name of the step within the workflow/schedule. |
Subprocess Group | All | None | Process Scope |
Task Step Instance Id | All | None | Read Only Process Scope Unique key that identifies a task step (instance). Task step instance identifiers are assigned each time a subprocess execution begins; that is, just before the presubprocess executes. This property states undefined if you attempt to access the task step instance ID for a task step when it has not started. |
Task Step Instance Name | All | None | Read Only Process Scope String name of the task step instance. |
Task Step Instance Expired | All | None | Read Only Process Scope Time that the task instance can no longer be performed. |
Visible | All | None | True if the task step is visible, False if it is not. |