Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
---|
Anchor |
---|
| actionCriteriaTask - SA |
---|
| actionCriteriaTask - SA |
---|
|
actionCriteriaTask | Task | Name of a task. In combination with the vertexId , it specifies a specific task within the Workflow to which the step action applies; if no task is specified, the step action applies to all z/OS tasks within the Workflow. |
| N |
|
| 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. |
| N | agentVar
|
Anchor |
---|
| agentCluster - SA |
---|
| agentCluster - SA |
---|
|
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. |
| N | agentClusterVar
|
Anchor |
---|
| agentClusterVar - SA |
---|
| agentClusterVar - SA |
---|
|
agentClusterVar | Agent Cluster Variable | Name of a variable that will be resolved at run time to the name of the Agent Cluster to use. |
| N | agentCluster
|
Anchor |
---|
| agentVar - SA |
---|
| agentVar - SA |
---|
|
agentVar | Agent Variable | Name of a variable that will be resolved at run time to the name of the Agent to use. |
| N | agent
|
Anchor |
---|
| description - SA |
---|
| description - SA |
---|
|
description | Description | Description of this System Operation Step Action. |
| N |
|
Anchor |
---|
| execCommand - SA |
---|
| execCommand - SA |
---|
|
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 value is Cancel (1). | N |
|
Anchor |
---|
| execCriteria - SA |
---|
| execCriteria - SA |
---|
|
execCriteria | Instance Criteria | If operation is Run Task Instance Command; 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
- As String = Newest Instance, As Value = 4
Default is Oldest Active Instance (1). - An Active task instance is an instance that is not in any of these statuses: Skipped, Finished, Success.
- An Unskip command can use only the Newest Instance and Oldest Instance criteria; an active instance cannot be unskipped.
| N |
|
| Instance ID | If execLookupOption is Instance Id; ID of task instance to run the command against. |
| N |
|
Anchor |
---|
| execLookupOption - SA |
---|
| execLookupOption - SA |
---|
|
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 - SA |
---|
| execName - SA |
---|
|
execName | Instance Name | If execLookupOption is Instance Name; Name of the task instance to run the command against. |
| N |
|
Anchor |
---|
| execWorkflowName - SA |
---|
| execWorkflowName - SA |
---|
|
execWorkflowName | Workflow Instance Name | If operation is Run Task Instance Command; Name of the parent workflow task instance that contains the task on which to perform the specified action. |
| N |
|
Anchor |
---|
| execWorkflowNameCond - SA |
---|
| execWorkflowNameCond - SA |
---|
|
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. If you select a condition type, enter a value for that condition. 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 = Starts With, As Value = 2
- As String = Contains, As Value = 3
- As String = Ends With, As Value = 4
Default is Equals (1). | 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. - If
operation is Set Virtual Resource Limit; Virtual resource limit to be set for the specified virtual resource.
|
| N |
|
| Name | Name of a variable to override. |
| N |
|
Anchor |
---|
| notificationOption - SA |
---|
| notificationOption - SA |
---|
|
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 |
---|
| operation - SA |
---|
| operation - SA |
---|
|
operation | System Operation | Specific 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 = 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 - SA |
---|
| overrideTriggerDateOffset - SA |
---|
|
overrideTriggerDateOffset | Override Date Offset | Override date offset. | Date Offset value of trigger to fire. | N (unless overrideTriggerDateTime is true) |
|
Anchor |
---|
| overrideTriggerDateTime - SA |
---|
| overrideTriggerDateTime - SA |
---|
|
overrideTriggerDateTime | Override Trigger Date/Time | Request parameter to enable/disable override functionality. | Boolean value (true / false). Default is false. | N |
|
Anchor |
---|
| overrideTriggerTime - SA |
---|
| overrideTriggerTime - SA |
---|
|
overrideTriggerTime | Override Time | Override time. | Time of the trigger to fire. | Y (if overrideTriggerDateTime is true) |
|
Anchor |
---|
| programName - SA |
---|
| programName - SA |
---|
|
programName | Program | Program name to match. | A blank value or an asterisk ( * ) will match any program name. Generic matching characters asterisk ( * ) and question mark ( ? ) match zero or more characters and one character, respectively. | N |
|
Anchor |
---|
| pstepName - SA |
---|
| pstepName - SA |
---|
|
pstepName | Procedure | Procedure step name to match. | A blank value or an asterisk ( * ) will match any procedure step name. Generic matching characters asterisk ( * ) and question mark ( ? ) match zero or more characters and one character, respectively. | N |
|
Anchor |
---|
| stepCodes - SA |
---|
| stepCodes - SA |
---|
|
stepCodes | Condition Codes | Conditions codes are integer return codes from the program or ABEND codes. Integer return codes are specified as a comma-separated list of integer values or ranges. Ranges are specified with a dash ( - ) separating the lower and upper bounds of the range. The z/OS job step return code range is 0-4095. ABEND codes are specified directly as either a user ABEND or a system ABEND. The ABEND code must be specified verbatim including leading zeroes. |
| N |
|
Anchor |
---|
| stepName - SA |
---|
| stepName - SA |
---|
|
stepName | Step | Job step name to match. | A blank value or an asterisk ( * ) will match any job step name. Generic matching characters asterisk ( * ) and question mark ( ? ) match zero or more characters and one character, respectively. | 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 - SA |
---|
| taskLimitType - SA |
---|
|
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 - SA |
---|
| triggerVar - SA |
---|
|
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 - SA |
---|
| variables - SA |
---|
|
variables | Override Variables | List of variables to override. |
| N |
|
Anchor |
---|
| variablesUnresolved - SA |
---|
| variablesUnresolved - SA |
---|
|
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 |
|
Anchor |
---|
| vertexId - SA |
---|
| vertexId - SA |
---|
|
vertexId | Vertex Id | Numerical ID of the task that identifies it uniquely from other tasks of the same type in the Workflow. | Valid values: - Any - The action applies to any instance of the specified task in the Workflow.
- <number> - The action applies only to this instance of the task in the Workflow.
| 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. | XML Code Block |
---|
| <vertices>
<vertex root="true">
<taskName>JOB_A</taskName>
<vertexId>10</vertexId>
</vertex>
<vertex root="false">
<taskName>JOB_B</taskName>
<vertexId>Any</vertexId>
</vertex>
</vertices> |
JSON Code Block |
---|
| "vertices": [
{
"root": true,
"taskName": "JOB_A",
"vertexId": "10",
},
{
"root": false,
"taskName": "JOB_B",
"vertexId": "Any",
}
] |
| N |
|
Anchor |
---|
| virtualResource - SA |
---|
| virtualResource - SA |
---|
|
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 - SA |
---|
| virtualResourceVar - SA |
---|
|
virtualResourceVar | Virtual Resource Variable | Name of a variable that will be resolved at run time to the name of the Virtual Resource to use. |
| N | virtualResource
|