Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
---|
| Agent | If operation is Suspend Agent, Resume Agent, Suspend Cluster Membership, Resume Cluster Membership, or Set Agent Task Execution Limit; Agent for which the System Operation is to be performed. |
| Y (unless agentVar ,
agentCluster , or agentClusterVar is specified) | agentVar
|
Anchor |
---|
| agentCluster - SO |
---|
| agentCluster - SO |
---|
|
agentCluster | Agent Cluster | If operation is Suspend Agent Cluster, Resume Agent Cluster, Suspend Cluster Membership, Resume Cluster Membership, or Set Cluster Task Execution Limit; Agent Cluster for which the system operation is to be performed. |
| Y (unless agent ,
agentVar , or agentClusterVar is specified) | agentClusterVar
|
Anchor |
---|
| agentClusterVar - SO |
---|
| agentClusterVar - SO |
---|
|
agentClusterVar | Agent Cluster Variable | If operation is Suspend Agent Cluster, Resume Agent Cluster, Suspend Cluster Membership, Resume Cluster Membership, or Set Cluster Task Execution Limit; Name of a variable that will be resolved at run time to the name of the Agent Cluster to use. |
| Y (unless agentCluster ,
agent , or agentVar is specified) | agentCluster
|
Anchor |
---|
| agentvar - SO |
---|
| agentvar - SO |
---|
|
agentVar | Agent Variable | If System Operation is Suspend Agent, Resume Agent, Suspend Cluster Membership, Resume Cluster Membership, or Set Agent Task Execution Limit; Name of a variable that will be resolved at run time to the name of the Agent to use. |
| Y (unless agent ,
agentCluster , or agentClusterVar is specified) | agent
|
Anchor |
---|
| description - SO |
---|
| description - SO |
---|
|
description | Description | Description of this System Operation action. |
| N |
|
Anchor |
---|
| execCommand - SO |
---|
| execCommand - SO |
---|
|
execCommand | Command | If operation is Run Task Instance Command; Type of task instance command to run. | Valid values: - As String = Cancel, As Value = 1
- As String = Force Finish, As Value = 2
- As String = Force Finish (Halt), As Value = 3
- As String = Force Finish/Cancel, As Value = 4
- As String = Force Finish/Cancel (Halt), As Value = 5
- As String = Skip, As Value = 6
- As String = Hold, As Value = 7
- As String = Release, As Value = 8
- As String = Release Recursive, As Value = 9
- As String = Clear All Dependencies, As Value = 10
- As String = Clear Exclusive, As Value = 11
- As String = Clear Predecessors, As Value = 12
- As String = Clear Resources, As Value = 13
- As String = Unskip, As Value = 14
- As String = Clear Timewait, As Value = 15
- As String = Re-run, As Value = 16
Default is Cancel (1). | N |
|
Anchor |
---|
| execCriteria - SO |
---|
| execCriteria - SO |
---|
|
execCriteria | Instance Criteria | If execLookupOption is Instance Name, Instance Name/Task, or Task; Additional criteria for selecting a specific task instance if multiple task instances have matching names. | Valid values: - As String = Oldest Active Instance, As Value = 1
- As String = Newest Active Instance, As Value = 2
- As String = Oldest Instance, As Value = 3 (Unskip command only)
- As String = Newest Instance, As Value = 4 (Unskip command only)
Default is Oldest Active Instance (1). | N |
|
| Instance Id | If execLookupOption is Instance Id; ID of task instance to run the command against. | The instance Id (sysid) is a 32-character universally unique identifier. You can use the ${ops_task_id } variable or ${_siblingid('mytask') } function to get the instance Id. | N |
|
Anchor |
---|
| execLookupOption - SO |
---|
| execLookupOption - SO |
---|
|
execLookupOption | Instance Lookup Option | If operation is Run Task Instance Command; Specification for how to search for the task instance to run a command against. | Valid values: - As String = Instance Name, As Value = 1
- As String = Instance Name/Task, As Value = 2
- As String = Instance Id, As Value = 3
- As String = Task, As Value = 4
Default is Instance Name (1). | N |
|
Anchor |
---|
| execName - SO |
---|
| execName - SO |
---|
|
execName | Instance Name | If execLookupOption is Instance Name or Instance Name/Task; Name of the task instance to run the command against. | Variables are supported. | Y |
|
Anchor |
---|
| execWorkflowNameCond - SO |
---|
| execWorkflowNameCond - SO |
---|
|
execWorkflowNameCond | Workflow Instance Name Condition | If operation is Run Task Instance Command; Type of condition for the name of the parent workflow task instance that contains the task on which to perform the specified action. The action will be performed only on a task instance in a parent workflow task instance meeting the specified condition value. | Valid values: - As String = Equals, As Value = 1
- As String = Start With, As Value = 2
- As String = Contains, As Value = 3
- As String = Ends With, As Value = 4
Default is Equals (1). | N |
|
Anchor |
---|
| execWorkflowName - SO |
---|
| execWorkflowName - SO |
---|
|
execWorkflowName | Workflow Instance Name <Condition Value> | Value for execWorkflowNameCond . |
| Y |
|
Anchor |
---|
| exitCodes - SO |
---|
| exitCodes - SO |
---|
|
exitCodes | Exit Codes | One or more exit codes that will trigger this action. | Integer; if you specify an exit code, you also must specify at least one status . Use commas to separate multiple exit codes; use a hyphen to specify a range. Format: 1,5,22-30 | N |
|
| Limit | If operation is Set Agent Task Execution Limit or Set Cluster Task Execution Limit, and taskLimitType is Limited; Number of tasks that can be run concurrently by the specified Agent / Agent Cluster. | Integer | N |
|
Anchor |
---|
| inheritance - SO |
---|
| inheritance - SO |
---|
|
inheritance | Action Inheritance | For Workflow tasks only; Records that this action applies to. | Valid values: - As String = Self, As Value = 1
- As String = Self/Children, As Value = 2
- As String = Children, As Value = 3
Default is Self (1). | N |
| Name | Name of a variable to override. |
| N |
|
Anchor |
---|
| notificationOption - SO |
---|
| notificationOption - SO |
---|
|
notificationOption | System Notification | Status of the specified operation that will trigger a system notification. | Valid values: - As String = -- None --, As Value = 0
- As String = Operation Failure, As Value = 1
- As String = Operation Success/Failure, As Value = 2
- As String = Operation Success, As Value = 3
Default is Operation Failure (1). | N |
|
Anchor |
---|
| notifyOnEarlyFinish - SO |
---|
| notifyOnEarlyFinish - SO |
---|
|
notifyOnEarlyFinish | On Early Finish | Specification to generate the action if the task finishes early, based on the Early Finish Time specified in the task. | Boolean; Valid values: true/false. Default is false. | N |
|
Anchor |
---|
| notifyOnLateFinish - SO |
---|
| notifyOnLateFinish - SO |
---|
|
notifyOnLateFinish | On Late Finish | Specification to generate the action if the task finishes late, based on the Late Finish Time specified in the task. | Boolean; Valid values: true/false. Default is false. | N |
|
Anchor |
---|
| notifyOnLateStart - SO |
---|
| notifyOnLateStart - SO |
---|
|
notifyOnLateStart | On Late Start | Specification to generate the action if the task starts late, based on the Late Start Time specified in the task. | Boolean; Valid values: true/false. Default is false. | N |
|
Anchor |
---|
| notifyOnProjectedLate - SO |
---|
| notifyOnProjectedLate - SO |
---|
|
notifyOnProjectedLate | On Projected Late | Generates the action if the task is projected to be late, based on the calculated Projected End Time and the Late Start Time, Late Start Duration, or Late Finish Time time option. | Boolean; Valid values: true/false. Default is false. | N |
|
Anchor |
---|
| operation - SO |
---|
| operation - SO |
---|
|
operation | System Operation | System operation to perform. | Valid values: - As String = Suspend Agent, As Value = 1
- As String = Resume Agent, As Value = 2
- As String = Suspend Agent Cluster, As Value = 3
- As String = Resume Agent Cluster, As Value = 4
- As String = Suspend Cluster Membership, As Value = 5
- As String = Resume Cluster Membership, As Value = 6
- As String = Set Agent Task Execution Limit, As Value = 7
- As String = Set Cluster Task Execution Limit, As Value = 8
- As String = Set Virtual Resource Limit, As Value = 9
- As String = Run Task Instance Command, As Value = 10
- As String = Launch Task, As Value = 11
- As String = Trigger Now, As Value = 12
- As String = Enable Trigger, As Value = 13
- As String = Disable Trigger, As Value = 14
Default is Suspend Agent (1). | N |
|
Anchor |
---|
| overrideTriggerDateOffset - SO |
---|
| overrideTriggerDateOffset - SO |
---|
|
overrideTriggerDateOffset | Override Date Offset | Override date offset. | Date Offset value of trigger to fire. | N (unless overrideTriggerDateTime is true) |
|
Anchor |
---|
| overrideTriggerDateTime - SO |
---|
| overrideTriggerDateTime - SO |
---|
|
overrideTriggerDateTime | Override Trigger Date/Time | Request parameter to enable/disable override functionality. | Boolean value (true / false). Default is false. | N |
|
Anchor |
---|
| overrideTriggerTime - SO |
---|
| overrideTriggerTime - SO |
---|
|
overrideTriggerTime | Override Time | Override time. | Time of the trigger to fire. | Y (if overrideTriggerDateTime is true) |
|
| Status | Status of this task, by itself or together with an exit code, that will trigger this System Operation action. You can specify as many statuses as needed. |
| Y |
|
| n/a | sys_id used within the Controller to identify this System Operation action. |
| N |
|
| Task Reference | - If
execLookupOption is Instance Name/Task or Task; Name of the task for which the task instance was run. - If
operation is Launch Task; Name of the task to launch.
|
| N | taskVar
|
Anchor |
---|
| taskLimitType - SO |
---|
| taskLimitType - SO |
---|
|
taskLimitType | Task Execution Limit | If operation is Set Agent Task Execution Limit or Set Cluster Task Execution Limit; Specification for whether a limited or unlimited number of task instances can be run concurrently on the specified Agent / Agent Cluster. | Valid values: - As String = Unlimited, As Value = 1
- As String = Limited, As Value = 2
Default is Unlimited. | N |
|
| Task Reference Variable | - If
execLookupOption is Instance Name/Task or Task; Name of a variable that will be resolved at run time to the name of the task for which the task instance was run. - If
operation is Launch Task; Name of a variable that will be resolved at run time to the name of the task to launch.
|
| N | task
|
| Trigger Reference | If operation is Trigger Now, Enable Trigger, or Disable Trigger; Name of the trigger. |
| N | triggerVar
|
Anchor |
---|
| triggerVar - SO |
---|
| triggerVar - SO |
---|
|
triggerVar | Trigger Reference Variable | If operation is Trigger Now, Enable Trigger, or Disable Trigger; Name of a variable that will be resolved at run time to the name of the trigger. |
| N | trigger
|
| Value | Value of a variable to override. |
| N |
|
Anchor |
---|
| variables - SO |
---|
| variables - SO |
---|
|
variables | Override Variables | List of variables to override. |
| N |
|
Anchor |
---|
| variablesUnresolved - SO |
---|
| variablesUnresolved - SO |
---|
|
variablesUnresolved | Override Variables Resolution Disabled | Specification for whether or not variables resolution should be disabled to allow for passing unresolved variable values. - If
variables resolution is disabled, any unresolved variables will be resolved in the context of the launched or triggered task instance. - If
variables resolution is not disabled, variables will be resolved prior to the execution of the Launch Task or Trigger Now operation .
| Boolean; Valid values: true/false. Default is false. | N |
|
vertexSelection
| Vertex Selection | If operation is Trigger Now or Launch Task; Specifies if the vertex selection can be enabled. | Boolean; Valid Values: true/false | N |
|
vertices
| Vertices | If operation is Trigger Now or Launch Task; Specifies Root Vertices and/or Specific Vertices to be included in the launched workflow. A vertex can be specified by taskName and vertexId . If you specify a vertexId , then only a single vertex will match, whereas, if vertexId is “Any”, any vertex matching by taskName will be selected. To indicate a vertex selection is a Root Vertex, set root to true. If root is unspecified or false, it indicates a vertex selection is a Specific Vertex. | panel Code Block |
---|
<vertices>
<vertex root="true">
<taskName>JOB_A</taskName> |
</vertex><vertex> <vertexName>JOB_B</vertexName><vertexId>10</vertexId>
</vertex>
<vertex root="false">
<taskName>JOB_B</taskName>
|
<vertexId>10<<vertexId>Any</vertexId>
</vertex>
</vertices> |
JSON panel Code Block |
---|
"vertices": [
{
"root": true,
"taskName": "JOB_A",
" |
roottruevertexName"JOB_B"
},
{vertexId10rootfalse | N |
|
Anchor |
---|
| virtualResource - SO |
---|
| virtualResource - SO |
---|
|
virtualResource | Virtual Resource | If operation is Set Virtual Resource Limit; Virtual resource for which a virtual resource limit is to be set. |
| N | virtualResourceVar
|
Anchor |
---|
| virtualResourceVar - SO |
---|
| virtualResourceVar - SO |
---|
|
virtualResourceVar | Virtual Resource Variable | If operation is Set Virtual Resource Limit; Name of a variable that will be resolved at run time to the name of the Agent to use. |
| N | virtualResource
|