Versions Compared

Old Version 16

changes.mady.by.user Stonebranch

Saved on

compared with

New Version 17

changes.mady.by.user IT Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Macro name changed from html to html-bobswift during server to cloud migration processing.

...

sourceId

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-

Html bobswift
<ul>
<li> Success
<li> Failure
<li> Success/Failure
<li> Exit Code; Format: Numeric. Use commas to list a series of exit codes; use hyphens to specify a range. Example: 1,5, 22-30
<li> Step Conditions; Format: Step:Procedure:Program:Condition codes. Example: *:*:*:JCLERR
<li> Variable
</ul>

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.

For JSON, the type attribute is required for Variable Condition. If type = Variable(case sensitive), it will be detected as a Variable Condition. 

Y


Anchor
points - WE
points - WE
points

n/a

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

For example:
 

Anchor
sourceId - WEsourceId - WE
Panel

Y

Html bobswift
<pre>
&lt;points&gt;
	&lt;point x="280" y="300" /&gt;
&lt;/points&gt;
</pre>

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


...

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 procedure step name. Generic matching characters asterisk ( * ) and question mark ( ? ) match zero or more characters and one character, respectively.

N


Anchor
stepAction - SC
stepAction - SC
stepAction

Action

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

Valid values:Default is

Html bobswift
<ul>
<li> As String = Continue/Success
(1).

N

Anchor
, As Value = 1
<li> As String = Continue/Failed, As Value = 2
<li> As String = Halt/Failed, As Value = 3
<li> As String = Askoper, As Value = 4
</ul>

Default is Continue/Success (1).

N


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

...

execCriteriaexecIdexecLookupOptionexecNameexecWorkflowNameexecWorkflowNameCondlimitnamenotificationOptionoperationoverrideTriggerDateOffsetoverrideTriggerDateTimeoverrideTriggerTimeprogramNamepstepNamestepCodesstepNametasktaskLimitTypetaskVartriggertriggerVarvaluevariablesvariablesUnresolvedvertexIdvirtualResourcevirtualResourceVar

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; 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

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

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

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

Name

Name of a variable to override.

N

Anchor
notificationOption - SAnotificationOption - SA

System Notification

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

Valid values:

Default is Operation Failure (1).

N

Anchor
operation - SAoperation - SA

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

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

N

virtualResource

...

businessDayscomplexcomplexAdjectivecomplexNoun

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
businessDays - RCbusinessDays - RC

Business Day

Specification for whether the task runs or skips on all business days.

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

N

Anchor
complex - RCcomplex - RC

Complex

Specification for whether the task runs or skips on the day(s) indicated in the complexAdjective, complexNouns, and complexQualifiers.

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

N

Anchor
complexAdjective - RCcomplexAdjective - RC

Adjective

If complex is specified; Used with complexNouns, complexQualifiers, and complexNthAmount (if complexAdjective is Nth) to specify which in a series of days you want to select.

For example, to specify "the 15th business day of the month," select complexAdjective is Nth, complexNouns is Business Day, complexQualifiers is Month, and complexNthAmount is 15.

Valid values:

Default is Every (0).

N

Anchor
complexNoun - RCcomplexNoun - RC

Noun

Deprecated (used only for single-value Nouns)

If complex is specified; Used with complexAdjective, complexQualifier, and complexNthAmount (if complexAdjective is Nth) to specify the type of day you want to select.
Html bobswift
<ul>
<li> As String = Cancel, As Value = 1
<li> As String = Force Finish, As Value = 2
<li> As String = Force Finish (Halt), As Value = 3
<li> As String = Force Finish/Cancel, As Value = 4
<li> As String = Force Finish/Cancel (Halt), As Value = 5
<li> As String = Skip, As Value = 6
<li> As String = Hold, As Value = 7
<li> As String = Release, As Value = 8
<li> As String = Release Recursive, As Value = 9
<li> As String = Clear All Dependencies, As Value = 10
<li> As String = Clear Exclusive, As Value = 11
<li> As String = Clear Predecessors, As Value = 12
<li> As String = Clear Resources, As Value = 13
<li> As String = Unskip, As Value = 14
<li> As String = Clear Timewait, As Value = 15
<li> As String = Re-run, As Value = 16
</ul>

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:

Html bobswift
<ul>
<li> As String = Oldest Active Instance, As Value = 1
<li> As String = Newest Active Instance, As Value = 2
<li> As String = Oldest Instance, As Value = 3
<li> As String = Newest Instance, As Value = 4
</ul>

Default is Oldest Active Instance (1).

Html bobswift
<ul>
<li> An Active task instance is an instance that is not in any of these statuses: Skipped, Finished, Success.
<li> An Unskip command can use only the Newest Instance and Oldest Instance criteria; an active instance cannot be unskipped.
</ul>

N


Anchor
execId - SA
execId - SA
execId

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:

Html bobswift
<ul>
<li> As String = Instance Name, As Value = 1
<li> As String = Instance Name/Task, As Value = 2
<li> As String = Instance Id, As Value = 3
<li> As String = Task, As Value = 4
</ul>

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:

Html bobswift
<ul>
<li> As String = Equals, As Value = 1
<li> As String = Starts With,  As Value = 2
<li> As String = Contains, As Value = 3
<li> As String = Ends With, As Value = 4
</ul>

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:

Html bobswift
<ul>
<li> As String = -- None --, As Value = 0
<li> As String = Operation Failure, As Value = 1
<li> As String = Operation Success/Failure, As Value = 2
<li> As String = Operation Success, As Value = 3
</ul>

Default is Operation Failure (1).

N


Anchor
operation - SA
operation - SA
operation

System Operation

Specific system operation to perform.

Valid values:

Html bobswift
<ul>
<li> As String = Suspend Agent, As Value = 1
<li> As String = Resume Agent, As Value = 2
<li> As String = Suspend Agent Cluster	, As Value = 3
<li> As String = Resume Agent Cluster, As Value = 4
<li> As String = Suspend Cluster Membership, As Value = 5
<li> As String = Resume Cluster Membership, As Value = 6
<li> As String = Set Agent Task Execution Limit, As Value = 7
<li> As String = Set Cluster Task Execution Limit, As Value = 8
<li> As String = Set Virtual Resource Limit, As Value = 9
<li> As String = Task Instance Command, As Value = 10
<li> As String = Launch Task, As Value = 11
<li> As String = Trigger Now, As Value = 12
<li> As String = Enable Trigger, As Value = 13
<li> As String = Disable Trigger, As Value = 14
</ul>

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:

Html bobswift
<ul>
<li> As String = Unlimited, As Value = 1
<li> As String = Limited, As Value = 2
</ul>

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


N

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

<complexNouns> <complexNoun>Business Day</complexNoun> </complexNouns>

<complexQualifier local="true">Year</complexQualifier>
 
To specify a Custom Day Period, use the name of the Custom Day . For example:
 
XML

<complexNouns> <complexNoun>Monday</complexNoun> <complexNoun>CustomDay1</complexNoun> </complexNouns>

Period. For example:
 
JSONXML

code

<complexQualifier>CustomDayPeriod1</complexQualifier>

true

 
JSON
"

complexNouns

complexQualifier":

[

{


    "value":

"

Monday

CustomDayPeriod1"

}, { "value": "CustomDay1" } ]


}
 
To specify a Local Custom Day Period, use the local attribute. For example:
 
XML

<complexNouns> <complexNoun

<complexQualifier local="true"

>CustomDay2</complexNoun> </complexNouns>

>CustomDayPeriod2</complexQualifier>
 
JSON

linenumbers


"

complexNouns

complexQualifier":

[ {

{
    "local":

"true

,

",
    "value":

"CustomDay1" } ]complexNthAmountcomplexQualifierscomplexAdjustmentcomplexeAdjustmentTypecustomDayChoiceevaluateAtholidayAdjustmentTypevariablevariableNamevariableOp

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
businessDays - RC
businessDays - RC
businessDays

Business Day

Specification for whether the task runs or skips on all business days.

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

N


Anchor
complex - RC
complex - RC
complex

Complex

Specification for whether the task runs or skips on the day(s) indicated in the complexAdjective, complexNouns, and complexQualifiers.

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

N


Anchor
complexAdjective - RC
complexAdjective - RC
complexAdjective

Adjective

If complex is specified; Used with complexNouns, complexQualifiers, and complexNthAmount (if complexAdjective is Nth) to specify which in a series of days you want to select.

For example, to specify "the 15th business day of the month," select complexAdjective is Nth, complexNouns is Business Day, complexQualifiers is Month, and complexNthAmount is 15.

Valid values:

Html bobswift
<ul>
<li> As String = Every, As Value = 0 
<li> As String = 1st, As Value = 1 
<li> As String = 2nd, As Value = 2 
<li> As String = 3rd, As Value = 3 
<li> As String = 4th, As Value = 4 
<li> As String = 5th, As Value = 5 
<li> As String = 6th, As Value = 6
</ul>

Default is Every (0).

N


Anchor
complexNoun - RC
complexNoun - RC
complexNoun

Noun

Deprecated (used only for single-value Nouns)

If complex is specified; Used with complexAdjective, complexQualifier, and complexNthAmount (if complexAdjective is Nth) to specify the type of day you want to select. For example, to specify "the 1st business day of the month," select complexAdjective is 1st, complexNoun is Business Day, and complexQualifier is Month.
 
Example: <complexNoun local="true">LCD1</complexNoun>
 
To specify a Custom Day, use the name of the Custom Day. For example:
 
XML
<complexNoun>CustomDay1</complexNoun>
 
JSON
"complexNoun": {
    "value": "CustomDay1"
}
 
To specify a Local Custom Day, use the local attribute. For example:
 
XML
<complexNoun local="true">CustomDay2</complexNoun>
 
JSON
"complexNoun": {
    "local": "true",
    "value": "CustomDay2"
}
 

Note
titleNote

The Default Calendar for the Workflow task is used to verify Custom Day references.

Valid values:

  • Sunday through Saturday
  • Day (any day)
  • Business Day (The business days specified in the calendar selected in the Workflow Calendar.)
  • Custom Days specified in the calendar selected in the Workflow Calendar.

N


Anchor
complexNouns - RC
complexNouns - RC
complexNouns

Noun(s)

If complex is specified; Used with complexAdjective, complexQualifiers, and complexNthAmount (if complexAdjective is Nth) to specify the type of days you want to select.

For example, to specify "the 1st business day of the month," select select complexAdjective is  as 1st, complexNoun is  complexNouns as Business Day, and complexQualifier is and complexQualifiers as Month.
 

Example: <complexNoun local="true">LCD1</complexNoun>
 

Code Block
languagetext
linenumberstrue
<complexNouns>
  <complexNoun>Business Day</complexNoun>
</complexNouns>


To specify a Custom Day, use the name of the Custom Day. For example:
 
XML

Code Block
languagetext
linenumberstrue
<complexNouns>
  <complexNoun>Monday</complexNoun>
  <complexNoun>CustomDay1</complexNoun>
</complexNouns>

 
JSON

Code Block
"complexNoun": {
    
languagetext
linenumberstrue
"complexNouns": [
  {
    "value": "Monday"
  },
  {
    "value": "CustomDay1"

}
 

  }
]


To specify a Local Custom Day, use the local attribute. For example:
 
XML

Code Block
languagetext
linenumberstrue
<complexNouns>
  <complexNoun local="true">CustomDay2</complexNoun>
</complexNouns>

 
JSON"complexNoun": {
    

Code Block
languagetext
linenumberstrue
"complexNouns": [
  {
    "local":
"
 true
",
    
,
    "value": "
CustomDay2"
}
 
Note
titleNote
The Default Calendar for the Workflow task is used to verify Custom Day references.
CustomDay1"
  }
]

Valid values:

  • Sunday through Saturday
  • Day (any day)
  • Business Day (The business days specified in the calendar selected in the Workflow Calendar.)
  • Custom Days specified in the calendar selected in the Workflow Calendar.

N


Anchor
complexNthAmount - RC
complexNthAmount - RC
complexNthAmount

Nth Amount

If complexAdjective is Nth; Sequential occurrence of the day selected in complexNouns within the selected complexQualifiers.

Integer.

N


Anchor
complexQualifier - RC
complexNouns complexQualifier - RC
complexQualifiercomplexNouns

QualifierNoun(s

Integer.

Deprecated (used only for single-value Qualifiers)

If If complex  is specified; Used with with the complexAdjective,  complexQualifiers complexNoun, and and complexNthAmount  (if if complexAdjective  is Nth) to specify the type of days you want to select.) to specify the period for your selection formula. For example, to specify "the 1st business day of the month," select select complexAdjective as is 1st,  complexNouns as complexNoun is Business Day, and complexQualifiers as complexQualifier is Month.
 
Example:

Code Block
languagetext
linenumberstrue
Code Block
languagetext
linenumberstrue
languagetext
linenumbers
Code Block
languagetext
linenumberstrue
Code Block
languagetext
true

Valid values:

  • Sunday through Saturday
  • Day (any day)
  • Business Day (The business days specified in the calendar selected in the Workflow Calendar.)
  • Custom Days specified in the calendar selected in the Workflow Calendar.

N

Anchor
complexNthAmount - RCcomplexNthAmount - RC

Nth Amount

If complexAdjective is Nth; Sequential occurrence of the day selected in complexNouns within the selected complexQualifiers.

"CustomDayPeriod2"
}
 

Note
titleNote

The Default Calendar for the Workflow task is used to verify Custom Day references.

Valid values:

  • Month
  • Year
  • January through December
  • Custom Period

N


Anchor
complexQualifier complexQualifiers - RCcomplexQualifier
complexQualifiers - RC
complexQualifiercomplexQualifiers

Qualifier

Deprecated (used only for single-value Qualifiers

(s)

If If complex is specified; Used with the with complexAdjective, complexNoun complexQualifiers, and and complexNthAmount (if if complexAdjective is Nth) to specify the period for your selection formula. type of days you want to select.

For example, to specify "the 1st business day of the month," select complexAdjective is 1st, complexNoun is Business Day, complexQualifier is Month.
 
Example: <complexQualifier local="true">Year</complexQualifier>
 
To specify a Custom Day Period, use the name of the Custom Day Period. For example:
 
XML
<complexQualifier>CustomDayPeriod1</complexQualifier>
 
JSON
"complexQualifier": {
    "value": "CustomDayPeriod1"
}
 
To specify a Local Custom Day Period, use the local attribute. For example:
 
XML
<complexQualifier local="true">CustomDayPeriod2</complexQualifier>
 
JSON
"complexQualifier": {
    "local": "true",
    "value": "CustomDayPeriod2"
}
 

Note
titleNote

The Default Calendar for the Workflow task is used to verify Custom Day references.

Valid values:

  • Month
  • Year
  • January through December
  • Custom Period

N

Anchor
complexQualifiers - RCcomplexQualifiers - RC

Qualifier(s)

Valid values:

  • As String = None, As Value = 0

    • As String = Less

    If complex is specified; Used with complexAdjective, complexQualifiers, and complexNthAmount (if complexAdjective is Nth) to specify the type of days you want to select.

    For example, to specify "the 1st business day of the month," select complexAdjective as 1st, complexNouns as Business Day, and complexQualifiers as Month.

    Example:

    Code Block
    languagetext
    linenumberstrue
    <complexQualifiers>
  <complexQualifier>Month</complexQualifier>
</complexQualifiers>

     
    To specify a Custom Day, use the name of the Custom Daymonth," select complexAdjective as 1st, complexNouns as Business Day, and complexQualifiers as Month.

    Example:

    Code Block
    languagetext
    linenumberstrue
    <complexQualifiers>
  <complexQualifier>Month</complexQualifier>
</complexQualifiers>

     
    To specify a Custom Day, use the name of the Custom Day. For example:
     
    XML

    Code Block
    languagetext
    linenumberstrue
    <complexQualifiers>
  <complexQualifier>Jan</complexQualifier>
  <complexQualifier>CustomDay1</complexQualifier>
</complexQualifiers>

     
    JSON

    Code Block
    languagetext
    linenumberstrue
    "complexQualifiers": [
  {
    "value": "Jan"
  },
  {
    "value": "CustomDay1"
  }
]


     
    To specify a Local Custom Day, use the local attribute. For example:
     
    XML

    Code Block
    languagetext
    linenumberstrue
    <complexQualifiers>
  <complexQualifier>Jan</complexQualifier>
  <complexQualifier>CustomDay1<<complexQualifier local="true">CustomDay2</complexQualifier>
</complexQualifiers>


     
    JSON

    Code Block
    languagetext
    linenumberstrue
    "complexQualifiers": [
  {
        "valuelocal": "Jan"
  },
  {true,
    "value": "CustomDay1"
  }
]
     
    To specify a Local Custom Day, use the local attribute. For example:
     
    XML
    Code Block
    languagetext
    linenumberstrue
    <complexQualifiers>
  <complexQualifier local="true">CustomDay2</complexQualifier>
</complexQualifiers>
     
    JSON
    Code Block
    languagetext
    linenumberstrue
    "complexQualifiers": [
  {
    "local": true,
    "value": "CustomDay1"
  }
]

    Valid values:

    • Month
    • Year
    • January through December
    • Custom Period

    N

    Anchor
    holidayAdjustment - RCholidayAdjustment - RC

    Adjustment

    Specification for adjusting a complex day by a less or plus number of days or business days.

    ]

    Valid values:

    • Month
    • Year
    • January through December
    • Custom Period

    N


    Anchor
    holidayAdjustment - RC
    holidayAdjustment - RC
    complexAdjustment

    Adjustment

    Specification for adjusting a complex day by a less or plus number of days or business days.

    Valid values:

    • As String = None, As Value = 0

    • As String = Less, As Value = 1

    • As String = Plus, As Value = 2

    Default is None (0).

    N


    Anchor
    complexAdjustmentAmount - RC
    complexAdjustmentAmount - RC
    complexAdjustmentAmount

    Adjustment Amount

    Number of days or business days to adjust a complex day.

    Integer; Default is 1.

    • Minimum is 1 if complexAdjustmentType is Day (1).
    • Minimum is 0 if complexAdjustmentType is Business Day (2).

    Maximum is 366.

    Y
    (if complexAdjustment is Less (1) or Plus (2) )


    Anchor
    complexeAdjustmentType - RC
    complexeAdjustmentType - RC
    complexeAdjustmentType

    Adjustment Type

    Type of day by which to adjust a complex day.

    Valid values:

    • As String = Day, As Value = 1

    • As String = PlusBusiness Day, As Value = 2

    Default is None Day (01).

    N


    Anchor
    complexAdjustmentAmount customDay - RCcomplexAdjustmentAmount
    customDay - RC
    complexAdjustmentAmountcustomDay

    Adjustment Amount

    Number of days or business days to adjust a complex day.

    Integer; Default is 1.

    • Minimum is 1 if complexAdjustmentType is Day (1).
    • Minimum is 0 if complexAdjustmentType is Business Day (2).

    Maximum is 366.

    Y
    (if complexAdjustment is Less (1) or Plus (2) )

    Anchor
    complexeAdjustmentType - RCcomplexeAdjustmentType - RC

    Adjustment Type

    Type of day by which to adjust a complex day.

    Valid values:

    • As String = Day, As Value = 1

    • As String = Business Day, As Value = 2

    Default is Day Custom Day

    Specification that the task runs or skips on the day you select in the customDayChoice.


    N


    Anchor
    customDayChoice - RC
    customDayChoice - RC
    customDayChoice

    Custom Day Choice

    If customDay is specified; Custom day for which you are specifying run or skip criteria.


    N


    Anchor
    description - RC
    description - RC
    description

    Description

    Description of this record.


    N


    Anchor
    evaluateAt - RC
    evaluateAt - RC
    evaluateAt

    Evaluate At

    If variable is specified; When you want the Controller to evaluate the variable.

    Valid values:

    Html bobswift
    <ul>
<li> As String = Trigger Time, As Value = 1 
<li> As String = Run Time, As Value = 2 
</ul>

    Default is Trigger Time (1).

    N


    Anchor
    customDay holiday - RCcustomDay
    holiday - RC
    customDayholiday

    Custom DayHoliday

    Specification that for whether or not the task runs or skips on the day you select in the customDayChoice.

    N

    Anchor
    customDayChoice - RCcustomDayChoice - RC

    Custom Day Choice

    If customDay is specified; Custom day for which you are specifying run or skip criteriaholidays.

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

    N


    Anchor
    description holidayAdjustment - RCdescription
    holidayAdjustment - RC
    descriptionholidayAdjustment

    Description

    Description of this record.

    N

    Anchor
    evaluateAt - RCevaluateAt - RC

    Evaluate At

    If variable is specified; When you want the Controller to evaluate the variable.

    Valid values:

    Default is Trigger Time (1

    Adjustment

    Specification for adjusting a holiday by a less or plus number of days or business days.

    Valid values:

    • As String = None, As Value = 0

    • As String = Less, As Value = 1

    • As String = Plus, As Value = 2

    Default is None (0).

    N


    Anchor
    holiday holidayAdjustmentAmount - RCholiday
    holidayAdjustmentAmount - RC
    holidayholidayAdjustmentAmount

    Holiday

    Specification for whether or not the task runs or skips on holidays.

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

    Number of days or business days to adjust a holiday.

    Integer; Default is 1.

    • Minimum is 1.
    • Maximum is 366.

    N


    Anchor
    holidayAdjustment holidayAdjustmentType - RCholidayAdjustment
    holidayAdjustmentType - RC
    holidayAdjustmentholidayAdjustmentType

    Adjustment Specification for adjusting a holiday by a less or plus number of days or business daysType

    Type of day by which to adjust a holiday.

    Valid values:

    • As String = NoneDay, As Value = 0As String = Less, As Value = 1

    • As String = PlusBusiness Day, As Value = 2

    Default is None Day (01).

    N


    Anchor
    holidayAdjustmentType - RCholidayAdjustmentType - RC

    Adjustment Type

    Type of day by which to adjust a holiday.

    Valid values:

    • As String = Day, As Value = 1

    • As String = Business Day, As Value = 2

    Default is Day (1)

    Anchor
    holidayAdjustmentAmount specificDay - RCholidayAdjustmentAmount
    specificDay - RC
    holidayAdjustmentAmount

    Adjustment Amount

    Number of days or business days to adjust a holiday.

    Integer; Default is 1.

    • Minimum is 1.
    • Maximum is 366.

    N

    specificDay

    Specific Day(s)

    Specification for whether or not the task runs or skips on the day(s) you select in the specificDayFri to specificDayWed.

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

    N


    Anchor
    specificDayFri - RC
    specificDayFri - RC
    specificDayFri

    Friday

    If specificDay is selected; Specification for whether or not the task runs or skips on this day of the week.

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

    N


    Anchor
    specificDay specificDayMon - RCspecificDay
    specificDayMon - RC
    specificDay

    Specific Day(s)

    specificDayMon

    Monday

    If specificDay is selected; Specification for whether or not the task runs or skips on the day(s) you select in the specificDayFri to specificDayWedthis day of the week.

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

    N


    Anchor
    specificDayFri specificDaySat - RCspecificDayFri
    specificDaySat - RC
    specificDayFrispecificDaySat

    FridaySaturday

    If specificDay is selected; Specification for whether or not the task runs or skips on this day of the week.

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

    N


    Anchor
    specificDayMon specificDaySun - RCspecificDayMon
    specificDaySun - RC
    specificDayMonspecificDaySun

    MondaySunday

    If specificDay is selected; Specification for whether or not the task runs or skips on this day of the week.

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

    N


    Anchor
    specificDaySat specificDayThu - RCspecificDaySat
    specificDayThu - RC
    specificDaySatspecificDayThu

    SaturdayThursday

    If specificDay is selected; Specification for whether or not the task runs or skips on this day of the week.

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

    N


    Anchor
    specificDaySun specificDayTue - RCspecificDaySun
    specificDayTue - RC
    specificDaySunspecificDayTue

    SundayTuesday

    If specificDay is selected; Specification for whether or not the task runs or skips on this day of the week.

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

    N


    Anchor
    specificDayThu specificDayWed - RCspecificDayThu
    specificDayWed - RC
    specificDayThuspecificDayWed

    ThursdayWednesday

    If specificDay is selected; Specification for whether or not the task runs or skips on this day of the week.

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

    N


    specificDayTue
    Anchor
    task - RC
    task - RC
    task

    Task

    Task for which you are specifying run or skip criteria.


    Y


    Anchor
    type - RC
    specificDayTue type - RC
    specificDayTuetype

    TuesdayType

    If specificDay is selected; Specification for whether this criteria is for running or not skipping the task runs or skips on this day of the weekspecified task.Boolean;

    Valid values:

    true/false. Default value is false

    Html bobswift
    <ul>
<li> As String = Run Criteria, As Value = 1 
<li> As String = Skip Criteria, As Value = 2 
</ul>

    Default is Run Criteria (1).

    N


    Anchor
    specificDayWed variable - RCspecificDayWed
    variable - RC
    specificDayWedvariable

    Wednesday

    If specificDay is selected; Specification for whether or not the task runs or skips on this day of the week.

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

    Used with evaluateAt, variableName, variableOp, and variableValue; Instructs the Controller to run or not run the task, depending on the value of a specific variable.


    N


    Anchor
    task variableName - RCtask
    variableName - RC
    taskvariableName

    Task

    Task for which you are specifying run or skip criteria.

    YName

    If variable is specified; Name of the variable being evaluated.


    N


    Anchor
    type variableOp - RCtype
    variableOp - RC
    typevariableOp

    Type

    Specification for whether this criteria is for running or skipping the specified taskOperator

    If variable is specified; Operator to be used in the evaluation.

    Valid values:

    Default is Run Criteria (1).

    N

    Anchor
    variable - RCvariable - RC

    Variable

    Used with evaluateAt, variableName, variableOp, and variableValue; Instructs the Controller to run or not run the task, depending on the value of a specific variable.

    N

    Anchor
    variableName - RCvariableName - RC

    Name

    If variable is specified; Name of the variable being evaluated.

    N

    Anchor
    variableOp - RCvariableOp - RC

    Operator

    If variable is specified; Operator to be used in the evaluation.

    Valid values:

    Html bobswift
    <ul>
<li> As String = =, As Value = 1
<li> As String = !=, As Value = 2
<li> As String = >, As Value = 3
<li> As String = >=, As Value = 4
<li> As String = <, As Value = 5
<li> As String = <=, As Value = 6
<li> As String = regex, As Value = 7
<?ul>

    Default is (1).

    N


    Anchor
    variableValue - RC
    variableValue - RC
    variableValue

    Value

    If variable is specified; Value or regular expression that the Controller should look for when evaluating the variable.

    Maximum 40 alphanumerics.

    N


    Anchor
    vertex - RC
    vertex - RC
    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


    ...