Versions Compared

Old Version 9

changes.mady.by.user Stonebranch

Saved on

compared with

New Version 10

changes.mady.by.user Stonebranch

Saved on

Key

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

...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
condition - WE
condition - WE
condition

n/a

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

Valid values:

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>
   <variableCondition>
           <firstValue>${_varToLowerCase('variableName')}</firstValue>
           <operator>=</operator>
           <secondValue>${var2}</secondValue>
   </variableCondition>

Step Condition is valid for z/OS tasks only.
 
Success/Failure and Failure are not valid for Workflow, Timer, and Manual tasks.
 

Note
titleNote

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


Anchor
points - WE
points - WE
points

n/a

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

For example:
 

Panel

Y


Anchor
sourceId - WE
sourceId - WE
sourceId

n/a

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


Y


Anchor
straightEdge - WE
straightEdge - WE
straightEdge

n/a

Specification for whether the edge is straight or bent.

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

N


Anchor
targetId - WE
targetId - WE
targetId

n/a

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


Y

...


Variable Condition

AnchorstepName - SCstepName - SCstepName

Step

Job

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor

programName - SCprogramName - SCprogramName

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

AnchorpstepName - SCpstepName - SCpstepName

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

AnchorstepAction - SCstepAction - SCstepAction

Action

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

Valid values:

Default is Continue/Success (1).

N

AnchorstepCodes - SCstepCodes - SCstepCodes

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

VC firstValue
VC firstValue
firstValue

First Value

First Value of the condition evaluation.

Default is an empty/blank string.

N


Anchor
VC operator
VC operator

operator

Operator

Operator of the condition evaluation.

Valid values:

  • As String = , As Value 1.

  • As String != , As Value 2.

  • As String > , As Value 3.

  • As String >= , As Value 4.

  • As String <, As Value 5.

  • As String <= , As Value 6.

  • As String regex , As Value 7.

  • As String contains , As Value 8.

Default is =(1).

N


Anchor
VC secondValue
VC secondValue
secondValue

Second Value

Second Value of the condition evaluation.

Default is an empty/blank string.

N


Anchor
Step Conditions
Step Conditions
Step Conditions

actionCriteriaTaskagentagentClusteragentClusterVaragentVardescriptionexecCommandexecCriteriaexecIdexecLookupOptionexecNameexecWorkflowNameWorkflow Instance Name

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
programName - SC
programName - SC
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 - SC
pstepName - SC
pstepName

Procedure

Procedure step name to match.

A blank value or an asterisk ( * ) will match any job procedure step name. Generic matching characters asterisk ( * ) and question mark ( ? ) match zero or more characters and one character, respectively.

N


Anchor
stepOrder stepAction - SCstepOrder
stepAction - SC
stepOrderstepAction

Evaluation Order

Order for step condition evaluation.

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

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

Valid values:

Default is Continue/Success (1).

N


Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
actionCriteriaTask - SAactionCriteriaTask - SA

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

Anchor
agent - SAagent - SA

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 - SAagentCluster - SA

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 - SAagentClusterVar - SA

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 - SAagentVar - SA

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 - SAdescription - SA

Description

Description of this System Operation Step Action.

N

Anchor
execCommand - SAexecCommand - SA

Command

If operation is Run Task Instance Command; Type of task instance command to run.

Valid values:

Default value is Cancel (1).

N

Anchor
execCriteria - SAexecCriteria - SA

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:

Default is Oldest Active Instance (1).

N

Anchor
execId - SAexecId - SA

Instance ID

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

N

Anchor
execLookupOption - SAexecLookupOption - SA

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:

Default is Instance Name (1).

N

Anchor
execName - SAexecName - SA

Instance Name

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

N

Anchor
execWorkflowName - SAexecWorkflowName - SA
Anchor
sysId stepCodes - SCsysId
stepCodes - SC
sysId

n/a

sys_id used within the Controller to identify this Step Condition.

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


Anchor
stepName - SC
stepName - SC
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


Anchor
stepOrder - SC
stepOrder - SC
stepOrder

Evaluation Order

Order for step condition evaluation.

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

N


Anchor
sysId - SC
sysId - SC
sysId

n/a

sys_id used within the Controller to identify this Step Condition.


N

Anchor
Step Actions
Step Actions
Step Actions

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With AnchorVC firstValueVC firstValuefirstValue

First Value

First Value of the condition evaluation.

Default is an empty/blank string.

N

AnchorVC operatorVC operator

operator

Operator

Operator of the condition evaluation.

Valid values:

  • As String = , As Value 1.

  • As String != , As Value 2.

  • As String > , As Value 3.

  • As String >= , As Value 4.

  • As String <, As Value 5.

  • As String <= , As Value 6.

  • As String regex , As Value 7.

  • As String contains , As Value 8.

Default is =(1).

N

AnchorVC secondValueVC secondValuesecondValue

Second Value

Second Value of the condition evaluation.

Default is an empty/blank string.

NnotificationOptionoverrideTriggerDateOffsetoverrideTriggerDateTimeoverrideTriggerTimeprogramNamepstepNamestepCodesstepNametasktaskLimitTypetaskVartriggertriggerVarvaluevariablesvariablesUnresolvedvertexIdvirtualResourcevirtualResourceVar

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


Anchor
agent - SA
agent - SA
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

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; Name Type of the parent workflow task instance that contains the task on which to perform the specified actioncommand to run.

Valid values:

Default value is Cancel (1).

N


Anchor
execWorkflowNameCond execCriteria - SAexecWorkflowNameCond
execCriteria - SA
execWorkflowNameCondexecCriteria

Workflow Instance Name ConditionCriteria

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 valueAdditional criteria for selecting a specific task instance if multiple task instances have matching names.

Valid values:

Default is Equals Oldest Active Instance (1).

N


Anchor
limit execId - SAlimit
execId - SA
limitexecId

LimitInstance ID

If operation is Set Virtual Resource Limit; Virtual resource limit to be set for the specified virtual resource

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.

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


N


Anchor
name execLookupOption - SAname
execLookupOption - SA
nameexecLookupOption

Name

Name of a variable to override.

N

Anchor
notificationOption - SAnotificationOption - SA

System Notification

Status of the specified operation that will trigger a system notificationInstance 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:

Default is Operation Failure Instance Name (1).

N


Anchor
operation execName - SAoperation
execName - SA
operationexecName

System Operation

Specific system operation to perform.

Valid values:

Default is Suspend Agent (1).

N

Anchor
overrideTriggerDateOffset - SAoverrideTriggerDateOffset - SAOverride Date OffsetOverride date offset.

Date Offset value of trigger to fire.

N
(unless overrideTriggerDateTime is true)
Anchor
overrideTriggerDateTime - SAoverrideTriggerDateTime - SAOverride Trigger Date/Time

Request parameter to enable/disable override functionality.

Boolean value (true / false).  Default is false.

N
Anchor
overrideTriggerTime - SAoverrideTriggerTime - SAOverride TimeOverride time.

Time of the trigger to fire.

Y
(if overrideTriggerDateTime is true)
Anchor
programName - SAprogramName - SA

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 - SApstepName - SA

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 - SAstepCodes - SA

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 - SAstepName - SA

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

Anchor
task - SAtask - SA

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 - SAtaskLimitType - SA

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:

Default is Unlimited.

N

Anchor
taskVar - SAtaskVar - SA

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

Anchor
trigger - SAtrigger - SA

Trigger Reference

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

N

triggerVar

Anchor
triggerVar - SAtriggerVar - SA

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

Anchor
value - SAvalue - SA

Value

Value of a variable to override.

N

Anchor
variables - SAvariables - SA

Override Variables

List of variables to override.

N

Anchor
variablesUnresolved - SAvariablesUnresolved - SA

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 - SAvertexId - SA

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

Anchor
virtualResource - SAvirtualResource - SA

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 - SAvirtualResourceVar - SA

Virtual Resource Variable

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:

Default is Equals (1).

N


Anchor
limit - SA
limit - SA
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


Anchor
name - SA
name - SA
name

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:

Default is Operation Failure (1).

N


Anchor
operation - SA
operation - SA
operation

System Operation

Specific system operation to perform.

Valid values:

Default is Suspend Agent (1).

N


Anchor
overrideTriggerDateOffset - SA
overrideTriggerDateOffset - SA
overrideTriggerDateOffset

Override Date OffsetOverride 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 TimeOverride 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


Anchor
task - SA
task - SA
task

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:

Default is Unlimited.

N


Anchor
taskVar - SA
taskVar - SA
taskVar

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

Anchor
trigger - SA
trigger - SA
trigger

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 Virtual Resource to usetrigger.


N

virtualResource

Variable Condition

Note

For workflow edge variable conditions that use functions to evaluate STDOUT, STDERR, FILE, or JOBLOG output, you must enable Wait For Output when setting up Automatic Output Retrieval.
Furthermore, the evaluation of workflow edge variable conditions happens prior to performing Set Variable Actions on task instance Success and Failed statuses, therefore, evaluation will not take these updates into consideration.

trigger

Anchor
value - SA
value - SA
value

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


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

Anchor
Run Criteria
Run Criteria
Run Criteria

...