Examples

The following examples are for task-related records for all task types except where noted otherwise.

Examples

XML

JSON

Examples for Workflow Task-Related Records

XML

Workflow Vertices

<workflowVertices>
	<workflowVertex>
		<alias />
		<task>zos task</task>
		<vertexId>4</vertexId>
		<vertexX>560</vertexX>
		<vertexY>50</vertexY>
	</workflowVertex>
</workflowVertices>

Workflow Edges

<workflowEdges>
	<workflowEdge>
		<condition type="Step Condition">1:*:*:1</condition>
		<sourceId>4</sourceId>
		<straightEdge>true</straightEdge>
		<targetId>2</targetId>
	</workflowEdge> 
	<workflowEdge>
		<points>
			<point x="280" y="300" />
		</points>
		<condition>Success</condition>
		<sourceId>2</sourceId>
		<straightEdge>false</straightEdge>
		<targetId>3</targetId>
	</workflowEdge>
</workflowEdges>

Step Conditions

<stepConditions>
	<stepCondition>
		<programName>programName</programName>
		<pstepName>procedureName</pstepName>
		<stepAction>Continue/Success</stepAction>
		<stepCodes>U0016</stepCodes>
		<stepName>stepName</stepName>
		<stepOrder>0</stepOrder>
		<sysId>1f85c539f50a4b488af5aad39a60c05c</sysId>
	</stepCondition>
</stepConditions>

Variable Conditions
<variableCondition>
<firstValue>${_varToLowerCase('variableName')</firstValue>
<operator>=</operator>
<secondValue>${var2}</secondValue>
</variableCondition>

Step Actions

<stepActions>
	<systemOperation>
		<actionCriteriaTask>zos task</actionCriteriaTask>
		<agent>AGNT0001</agent>
		<agentCluster />
		<agentClusterVar />
		<agentVar />
		<description>description</description>
		<execCommand>Cancel</execCommand>
		<execCriteria>Oldest Active Instance</execCriteria>
		<execId />
		<execLookupOption>Instance Name</execLookupOption>
		<execName />
		<execWorkflowName />
		<execWorkflowNameCode>Equals</execWorkflowNameCode>
		<limit />
		<notificationOption>Operation Success/Failure</notificationOption>
		<operation>Suspend Agent</operation>
		<overrideTriggerDateOffset>5</overrideTriggerDateOffset>
		<overrideTriggerDateTime>true</overrideTriggerDateTime
		<overrideTriggerTime>20:00</overrideTriggerTime>
		<programName />
		<pstepName />
		<stepCodes>123</stepCodes>
		<stepName />
		<sysId>d722fd81df0b4ac8ad0c684a1b17a766</sysId>
		<task />
		<taskLimitType>Unlimited</taskLimitType>
		<taskVar />
                <trigger>Trigger A</trigger>
                <triggerVar />
                <variables>
                      <variable>
                            <name>var1</name>
                            <value>val1</value>
                      </variable>
                      <variable>
                            <name>var2</name>
                            <value>val2</value>
                      </variable>
                </variables>
                <variablesUnresolved>false</variablesUnresolved>
		<vertexId>1</vertexId>
		<virtualResource />
		<virtualResourceVar />
	</systemOperation>
</stepActions>

Run Criteria

<runCriteria>
	<runCriterion>
		<businessDay>true</businessDay>
		<complex>true</complex>
		<complexAdjective>Every</complexAdjective>
		<complexNouns>
                   <complexNoun>Monday</complexNoun>
                   <complexNoun>CustomDay1</complexNoun>
                </complexNouns>
		<complexNthAmount>5</complexNthAmount>
                <complexQualifiers>
                   <complexQualifier>Jan</complexQualifier>
                   <complexQualifier>CustomDay1</complexQualifier>
                </complexQualifiers>
                <complexAdjustment>Less</complexAdjustment>
                <complexAdjustmentAmount>1</complexAdjustmentAmount>
                <complexAdjustmentType>Day</complexAdjustmentType>
		<customDay>false</customDay>
		<customDayChoice />
		<description />
		<evaluateAt>Trigger Time</evaluateAt>
		<holiday>false</holiday>
                <holidayAdjustment>Less</holidayAdjustment>
                <holidayAdjustmentAmount>1</holidayAdjustmentAmount>
                <holidayAdjustmentType>Day</holidayAdjustmentType>
		<specificDay>false</specificDay>
		<specificDayFri>false</specificDayFri>
		<specificDayMon>false</specificDayMon>
		<specificDaySat>false</specificDaySat>
		<specificDaySun>false</specificDaySun>
		<specificDayThu>false</specificDayThu>
		<specificDayTue>false</specificDayTue>
		<specificDayWed>false</specificDayWed>
		<sysId>bb5f7807b0614153942572ecbc2dcfbe</sysId>
		<task>Sleep 60</task>
		<type>Skip Criteria</type>
		<variable>false</variable>
		<variableName />
		<variableOp>=</variableOp>
		<variableValue />
		<vertexId>13</vertexId>
	</runCriterion>
</runCriteria>

Critical Endpoints

 <criticalEndpoints>
        <criticalEndpoint>
            <description>test1</description>
            <lfDayConstraint>Next Day</lfDayConstraint>
            <lfDuration>00:00:00:00</lfDuration>
            <lfEnabled>true</lfEnabled>
            <lfNthAmount>5</lfNthAmount>
            <lfOffsetDuration />
            <lfOffsetDurationUnit>Minutes</lfOffsetDurationUnit>
            <lfOffsetPercentage>0</lfOffsetPercentage>
            <lfOffsetType>Percentage</lfOffsetType>
            <lfTime>22:22</lfTime>
            <lfType>Time</lfType>
            <lsDayConstraint>Same Day</lsDayConstraint>
            <lsDuration>00:00:00:00</lsDuration>
            <lsEnabled>true</lsEnabled>
            <lsNthAmount>5</lsNthAmount>
            <lsTime>01:01</lsTime>
            <lsType>Time</lsType>
            <sysId>6ca686c553314947b8ffcc489b2a84ec</sysId>
            <task>task_1</task>
            <vertexId>Any</vertexId>
        </criticalEndpoint>
    </criticalEndpoints>

JSON

Workflow Vertices

"workflowVertices": [ {
  "alias": null,
  "task": {
      "value": "SB_ZOS_Task "
  },
  "vertexId": "2",
  "vertexX": "510",
  "vertexY": "40"
  }
]

Workflow Edges

"workflowEdges": [ {
  "condition": {
    "value": "Success"
  },
  "sourceId": {
    "taskName": "SB_ZOS_Task ",
    "value": "2"
  },
  "straightEdge": true,
  "targetId": {
    "taskAlias": "Timer 0",
    "taskName": "Sleep 0",
    "value": "3"
  }
]

Step Conditions

"stepConditions": [ {
  "programName": null,
  "pstepName": null,
  "stepAction": "Halt/Failed",
  "stepCodes": "1-4095",
  "stepName": null,
  "stepOrder": 1,
  "sysId": "100b1da7c19f40a3848c2549a7c24de4"
  }
]

Variable Conditions
"condition": {
"firstValue": "${_varToLowerCase('variableName')}",
"operator": "=",
"secondValue": "${var2}",
"type": "Variable"
}

Step Actions

"stepActions": [ {
    "actionCriteriaTask": "SB_ZOS_Task ",
    "agent": null,
    "agentCluster": null,
    "agentClusterVar": null,
    "agentVar": null,
    "description": null,
    "execCommand": "Cancel",
    "execCriteria": "Oldest Active Instance",
    "execId": null,
    "execLookupOption": "Instance Name",
    "execName": "SB_Timer",
    "execWorkflowName": "SB_Workflow",
    "execWorkflowNameCond": "Equals",
    "limit": null,
    "notificationOption": "Operation Failure",
    "operation": "Task Instance Command",
    "overrideTriggerDateOffset": 5,
    "overrideTriggerDateTime": true
    "overrideTriggerTime": "20:00",
    "programName": null,
    "pstepName": null,
    "stepCodes": "S0C4",
    "stepName": null,
    "sysId": "e1149f680ce542febfa022f3c0dbf828",
    "task": null,
    "taskLimitType": "Unlimited",
    "taskVar": null,
    "trigger": null,
    "triggerVar": null,
    "variables": [ ],
    "variablesUnresolved": false,
    "vertexId": "Any",
    "virtualResource": null,
    "virtualResourceVar": null
  } 
]

Run Criteria

"runCriteria": [
         {
            "businessDay": true,
            "complex": false,
            "complexAdjective": "Every",
            "complexAdjustment": "None",
            "complexAdjustmentAmount": 1,
            "complexAdjustmentType": "Day",
            "complexNoun": {
                "value": "Day"
            },
            "complexNouns": [
                {
                    "value": "Day"
                }
            ],
            "complexNthAmount": 5,
            "complexQualifier": {
                "value": "Year"
            },
            "complexQualifiers": [
                {
                    "value": "Year"
                }
            ],
            "customDay": false,
            "customDayChoice": null,
            "description": "test1",
            "evaluateAt": "Trigger Time",
            "holiday": false,
            "holidayAdjustment": "None",
            "holidayAdjustmentAmount": 1,
            "holidayAdjustmentType": "Day",
            "specificDay": false,
            "specificDayFri": false,
            "specificDayMon": false,
            "specificDaySat": false,
            "specificDaySun": false,
            "specificDayThu": false,
            "specificDayTue": false,
            "specificDayWed": false,
            "sysId": "c26f0ecd92fe4cf19782291a91894beb",
            "task": "task_1",
            "type": "Run Criteria",
            "variable": false,
            "variableName": null,
            "variableOp": "=",
            "variableValue": null,
            "vertexId": "Any"
        }
    ],

Critical Endpoints
"criticalEndpoints": [

        {
            "description": "test1",
            "lfDayConstraint": "Next Day",
            "lfDuration": "00:00:00:00",
            "lfEnabled": true,
            "lfNthAmount": 5,
            "lfOffsetDuration": null,
            "lfOffsetDurationUnit": "Minutes",
            "lfOffsetPercentage": 0,
            "lfOffsetType": "Percentage",
            "lfTime": "22:22",
            "lfType": "Time",
            "lsDayConstraint": "Same Day",
            "lsDuration": "00:00:00:00",
            "lsEnabled": true,
            "lsNthAmount": 5,
            "lsTime": "01:01",
            "lsType": "Time",
            "sysId": "331ae420fe264026b3f9a78b1f05e8de",
            "task": "task_1",
            "vertexId": "Any"
        }
    ],

Properties

See the Workflow Task - Workflow Task-Related Records Properties page for information on Workflow task-related records properties.