Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

<ul> <li>
  • Suspend
  • Agent
<li>
  • Resume
  • Agent
<li>
  • Suspend
  • Agent
  • Cluster
<li>
  • Resume
  • Agent
  • Cluster
<li>
  • Suspend
  • Cluster
  • Membership
<li>
  • Resume
  • Cluster
  • Membership
<li>
  • Set
  • Agent
  • Task
  • Execution
  • Limit
<li>
  • Set
  • Cluster
  • Task
  • Execution
  • Limit
<li>
  • Set
  • Virtual
  • Resource
  • Limit
<li>
  • Run
  • Task
  • Instance
  • Command
<li>
  • Launch
  • Task
<li>
  • Trigger
  • Now
<li>
  • Enable
  • Trigger
<li>
  • Disable
  • Trigger
</ul>

Field Name

Description

Step Action Criteria

This section contains criteria for performing the step action.

Anchor
Task
Task
Task

Name of a task. In combination with the Vertex Id, 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.

Anchor
Vertex Id
Vertex Id
Vertex Id

Numerical ID of the task that identifies it uniquely from other tasks of the same type in the Workflow. In combination with the Task, it specifies a specific task within the Workflow to which the step action applies.
 
Options:

  • 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.

Anchor
Step
Step
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.

Anchor
Procedure
Procedure
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.

Anchor
Program
Program
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.

Anchor
Condition Codes
Condition Codes
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.

Description

Description of this System Operation Step Action.

Step Action Details

This section contains assorted detailed information about the step action.

Anchor
System Operation
System Operation
System Operation

Specific system operation to perform.
 
Options:

Html bobswift
  • ,
  • if
  • the
Universal Controller system property is true. <li> Suspend Agent and Resume Agent commands permission. </ul>
  •  Universal Controller system property is true.
  • Suspend Agent and Resume Agent commands permission.

For the Suspend Agent Cluster, Resume Agent Cluster, Suspend Agent Cluster Membership, and Resume Agent Cluster Membership operations, the user must have the following Agent Cluster permissions:

Note
titleNote

For the Suspend Agent and Resume Agent operations, the user must have the following Agent permissions:

html-bobswift

<ul> <li>

  • Explicit
Html bobswift
Html bobswift


System Notification

Status of the specified system operation that will trigger a system notification.
 
Options:

Html bobswift<ul> <li> None <li> Operation Failure
  • None
  • Operation Failure (default)
<li>
  • Operation
  • Success/Failure
<li>
  • Operation
  • Success
</ul>
Note
titleNote

The Controller must be configured for system notifications in order for system notifications to be triggered.


Agent

If System 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.

Agent Variable

If System Operation is Suspend Agent, Resume Agent, Suspend Cluster Membership, Resume Cluster Membership, or Set Agent Task Execution Limit; Indication of whether the Agent field is a reference field for selecting a specific Agent (unchecked) or a text field for specifying the Agent as a variable (checked).

Agent Cluster

If System 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.

Agent Cluster Variable

If System Operation is Suspend Agent Cluster, Resume Agent Cluster, Suspend Cluster Membership, Resume Cluster Membership, or Set Cluster Task Execution Limit; Indication of whether the Agent Cluster field is a reference field for selecting a specific Agent Cluster (unchecked) or a text field for specifying the Agent Cluster as a variable (checked).

Anchor
Task Execution Limit
Task Execution Limit
Task Execution Limit

If System 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. (Default is Unlimited.)

Anchor
Virtual Resource
Virtual Resource
Virtual Resource

If System Operation is Set Virtual Resource Limit; Virtual resource for which a virtual resource limit is to be set.
 

Note
titleNote

If the Strict Business Service Membership Read Constraints Universal Controller system property is true, the drop-down list displays only Virtual Resources for which the user has explicit Read permission.


Virtual Resource Variable

If System Operation is Set Virtual Resource Limit; Indication of whether the Virtual Resource field is a reference field for selecting a specific Virtual Resource (unchecked) or a text field for specifying the Virtual Resource as a variable (checked).

Limit

If System Operation is Set Agent Task Execution Limit or Set Cluster Task Execution Limit, and Task Execution Limit is Limited; Number of tasks that can be run concurrently by the specified Agent / Agent Cluster.
 
If System Operation is Set Virtual Resource Limit; Virtual resource limit to be set for the specified virtual resource.

Command

If System Operation is Run Task Instance Command; Type of task instance command to run.
 
Options:

  • Cancel
  • Force Finish
  • Force Finish (Halt)
  • Force Finish/Cancel
  • Force Finish/Cancel (Halt)
  • Skip
  • Unskip
  • Hold
  • Release
  • Release Recursive
  • Clear All Dependencies
  • Clear Exclusive
  • Clear Predecessors
  • Clear Resources
  • Clear Timewait
  • Re-run

Anchor
Instance Lookup Option
Instance Lookup Option
Instance Lookup Option

If System Operation is Run Task Instance Command; Specification for how to search for the task instance to run a command against.
 
Options:

  • Instance Name
  • Instance Name/Task
  • Instance Id
  • Task

Instance Name

If Instance Lookup Option is Instance Name or Instance Name/Task; Name of the task instance to run the command against.

Instance Criteria

If Instance Lookup Option is Instance Name, Instance Name/Task, or Task; Additional criteria for selecting a specific task instance if multiple task instances have matching names.

html-bobswift

<ul> <li>

  • Newest
  • Active
  • Instance
<li>
  • Oldest
  • Active
  • Instance
<li>
  • Newest
  • Instance
<li>
  • Oldest
  • Instance
</ul>

(An Active task instance is an instance that is not in any of these statuses: Skipped, Finished, Success.)
 

Note
titleNote

An Unskip command can use only the Newest Instance and Oldest Instance criteria; an active instance cannot be unskipped.


Anchor
Task
Task
Task Reference

Task Reference Variable

If Instance Lookup Option is Instance Name/Task or Task, or if System Operation is Launch Task; Indication of whether the Task Reference field is a reference field for selecting a specific Task (unchecked) or is a text field for specifying the task as a variable (checked). For a variable, use the format: ${variable name}. The variable must be a supported type as described in Variables and Functions.

Instance ID

If Instance Lookup Option 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.

Anchor
Trigger
Trigger
Trigger Reference

If System Operation is Trigger Now, Enable Trigger, or Disable Trigger; Name of the trigger.

Trigger Reference Variable

If System Operation is Trigger Now, Enable Trigger, or Disable Trigger; Indication of whether the Trigger Reference field is a reference field for selecting a specific Trigger (unchecked) or is a text field for specifying the trigger as a variable (checked). For a variable, use the format: ${variable name}. The variable must be a supported type as described in Variables and Functions.

Override Variables

If System Operation is Launch Task or Trigger Now; Variables to override.

Override Variables Resolution Disabled

If System Operation is Launch Task or Trigger Now; Indication of whether or not Override Variables resolution should be disabled to allow for passing unresolved variable values.

  • If enabled (checked), Override Variables will be left unresolved. Any unresolved variables will be resolved in the context of the launched or triggered task instance.
  • If disabled (unchecked), Override Variables will be resolved prior to the execution of the Launch Task or Trigger Now System Operation.

Anchor
Override Trigger Date Time
Override Trigger Date Time
Override Trigger Date/Time

If System Operation is Trigger Now, Indication of whether or not to override the date/time of the trigger.Override Date OffsetIf Override Trigger Date Time is selected; Override date offset.Override TimeIf Override Trigger Date Time is selected; Override time.

Anchor
Workflow Instance Name Condition
Workflow Instance Name Condition
Workflow Instance Name Condition

If System Operation is Run Task Instance Command; Optional. 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.
 
Options:

Html bobswift<ul> <li> Equals <li> Starts With <li> Contains <li> Ends With </ul>
  • Equals
  • Starts With
  • Contains
  • Ends With

For the selected condition (the default is Equals), a corresponding field displays (see below) that allows you to enter a value for that condition.

Anchor
Workflow Instance Name Equals
Workflow Instance Name Equals
Workflow Instance Name Equals

If Workflow Instance Name Condition = Equals; Exact name of a parent workflow task instance containing the task. Variables are supported.

Anchor
Workflow Instance Name Starts With
Workflow Instance Name Starts With
Workflow Instance Name Starts With

If Workflow Instance Name Condition = Starts With; Character string at the start of the name of a parent workflow task instance containing the task. Variables are supported.

Anchor
Workflow Instance Name Contains
Workflow Instance Name Contains
Workflow Instance Name Contains

If Workflow Instance Name Condition = Contains; Character string in the name of a parent workflow task instance containing the task. Variables are supported.

Anchor
Workflow Instance Name Ends With
Workflow Instance Name Ends With
Workflow Instance Name Ends With

If Workflow Instance Name Condition = Ends With; Character string at the end of the name of a parent workflow task instance containing the task. Variables are supported.

Metadata

This section contains Metadata information about this record.

UUID

Universally Unique Identifier of this record.

Updated By

Name of the user that last updated this record.

Updated

Date and time that this record was last updated.

Created By

Name of the user that created this record.

Created

Date and time that this record was created.

Buttons

This section identifies the buttons displayed above and below the Step Action Details that let you perform various actions.

Save

Saves the new System Operation Step Action Details record in the Controller database.

Save & New

Saves a new record in the Controller database and redisplays empty Details so that you can create another new record.

Save & View

Saves a new record in the Controller database and continues to display that record.

Update

Include Page
IL:Update button
IL:Update button

Refresh

Refreshes any dynamic data displayed in the Details.

Delete

Include Page
IL:Delete button
IL:Delete button

Close

For pop-up view only; closes the pop-up view of this task.

...