/
Workflow Task - Workflow Task-Related Records Properties

Workflow Task - Workflow Task-Related Records Properties

Jan 30, 2023

Workflow Vertices

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

alias

n/a

Alias used for the task to be inserted within the workflow; specifically, the value of ops_exec_workflow_vertex.name.

 

N

 

task

Task Name

Name of the task to be inserted within the workflow.
 
Example: <task sysId="true">a8756a120a00010357097d05fa5c558e</task>

 

Y

 

vertexId

n/a

Vertex ID of the task to be inserted within the workflow.
 
Each task within a Workflow must have a unique Vertex ID to distinguish it from other tasks, if any, of the same name.

 

Y

 

vertexX

n/a

x-coordinate of the task to be inserted within the workflow.

Default is 0.

N

 

vertexY

n/a

y-coordinate of the task to be inserted within the workflow.

Default is 0.

N

 

Workflow Edges

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

condition

n/a

Dependency condition between the source and target tasks of this edge (connector).
 
Example: <condition type="Exit Code">123</condition>

Valid values:

  • Success

  • Failure

  • Success/Failure

  • Exit Code; Format: Numeric. Use commas to list a series of exit codes; use hyphens to specify a range. Example: 1,5, 22-30

  • Step Conditions; Format: Step:Procedure:Program:Condition codes. Example: *:*:*:JCLERR

Default is Success.
 
For example:
 
   <condition>Success</condition>
   <condition>Failure</condition>
   <condition>Success/Failure</condition>
   <condition>1,5,22-30</condition>
   <condition>*:*:*:JCLERR</condition>
   <condition>S1:PROC1:PGM1:U016</condition>
   <condition type="Exit Code">1,5,22-30</condition>
   <condition type="Step Condition">*:*:*:JCLERR</condition>
   <condition type="Step Condition">*:*:*:S0C4</condition>
   <condition type="Step Condition">S1:PROC1:PGM1:U016</condition>
 
Step Condition is valid for z/OS tasks only.
 
Success/Failure and Failure are not valid for Workflow, Timer, and Manual tasks.
 

Note

The type attribute (type=) is optional for Exit Code and Step Condition. Based on the format of the condition, in most cases it is easily determined if the condition is Exit Code and Step Condition. If the condition cannot be determined, the type attribute can be checked.

Y

 

points

n/a

If straightEdge is false; x and y coordinates of the Edge angles.

For example:
 

<points> <point x="280" y="300" /> </points>

Y

 

sourceId

n/a

Vertex ID of the source task.
 
Example: <sourceId taskName="Sleep 10"taskAlias="Sleep 10-alias">20</sourceId>

 

Y

 

straightEdge

n/a

Specification for whether the edge is straight or bent.

Boolean; Valid values: true/false. Default is true.

N

 

targetId

n/a

Vertex ID of the target task.
 
Example: <targetID taskName="Sleep 10"taskAlias="Sleep 10-alias">20</targetId>

 

Y

 

Step Conditions

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

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

 

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

 

stepAction

Action

Action to take and the task status to set if the Step Condition matches.

Valid values:

  • As String = Continue/Success, As Value = 1

  • As String = Continue/Failed, As Value = 2

  • As String = Halt/Failed, As Value = 3

  • As String = Askoper, As Value = 4

Default is Continue/Success (1).

N

 

stepCodes

Condition Codes

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.

Y

 

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

 

stepOrder

Evaluation Order

Order for step condition evaluation.

Step conditions with a lower order are evaluated before step conditions with a higher order.

N

 

sysId

n/a

sys_id used within the Controller to identify this Step Condition.

 

N

Step Actions

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

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

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

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

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

agentVar

Agent Variable

Name of a variable that will be resolved at run time to the name of the Agent to use.

 

N

agent

description

Description

Description of this System Operation Step Action.

 

N

 

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

 

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

 

execId

Instance ID

If execLookupOption is Instance Id; ID of task instance to run the command against.

 

N

 

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

 

execName

Instance Name

If execLookupOption is Instance Name; Name of the task instance to run the command against.

 

N

 

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

 

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

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

Name of a variable to override.

 

N

 

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

 

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