The following Task Action examples are for all task types.

Examples

XML

JSON

Examples for Task Actions

XML

Abort
<abortAction>
       <description />
       <exitCodes />
       <notifyOnEarlyFinish>false</notifyOnEarlyFinish>
       <notifyOnLateFinish>false</notifyOnLateFinish>
       <notifyOnLateStart>false</notifyOnLateStart>
       <notifyOnProjectedLate>false</notifyOnProjectedLate>
       <status>Waiting</status>
       <sysId>ad42c3268468425db6e1580cd53f57f0</sysId>
       <cancelProcess>false</cancelProcess>
       <haltOnFinish>false</haltOnFinish>
       <overrideExitCode />
</abortAction>



 
Email Notification
<emailNotification>
       <description />
       <exitCodes />
       <notifyOnEarlyFinish>false</notifyOnEarlyFinish>
       <notifyOnLateFinish>false</notifyOnLateFinish>
       <notifyOnLateStart>false</notifyOnLateStart>
       <notifyOnProjectedLate>false</notifyOnProjectedLate>
       <status>Success</status>
       <sysId>2b72cdaaf3a145e4bbae5a7ddd24baff</sysId>
       <attachFile>false</attachFile>
       <attachJobLog>false</attachJobLog>
       <attachLocalFile>true</attachLocalFile>
       <attachStdError>false</attachStdError>
       <attachStdOut>true</attachStdOut>
       <bcc />
       <body>test body</body>
       <cc />
       <emailConnection>Opswise - Gmail Account</emailConnection>
       <emailTemplate />
       <emailTemplateVar />
       <fileName />
       <fileNumLines>100</fileNumLines>
       <fileScanText />
       <fileStartLine>1</fileStartLine>
       <joblogNumLines>100</joblogNumLines>
       <joblogScanText />
       <joblogStartLine>1</joblogStartLine>
       <localAttachment>report.pdf</localAttachment>
       <localAttachmentsPath>E:\temp</localAttachmentsPath>
       <replyTo>replyTo@test.com</replyTo>
       <report>
             <groupName />
             <title>report1</title>
             <userName>ops.admin</userName>
       </report>
       <stderrNumLines>100</stderrNumLines>
       <stderrScanText />
       <stderrStartLine>1</stderrStartLine>
       <stdoutNumLines>100</stdoutNumLines>
       <stdoutScanText />
       <stdoutStartLine>1</stdoutStartLine>
       <subject />
       <to>test@test.com</to>
</emailNotification>


 
 
Set Variable
<setVariableAction>
       <description />
       <exitCodes />
       <notificationOption>Operation Failure</notificationOption>
       <notifyOnEarlyFinish>false</notifyOnEarlyFinish>
       <notifyOnLateFinish>false</notifyOnLateFinish>
       <notifyOnLateStart>false</notifyOnLateStart>
       <notifyOnProjectedLate>false</notifyOnProjectedLate>
       <status>Waiting</status>
       <sysId>f7824e38add745c2bf41017b07697bdf</sysId>
       <variableName>name</variableName>
       <variableScope>Self</variableScope>
       <variableValue />
</setVariableAction>


 
 
SNMP Notification
<snmpNotification>
       <description />
       <exitCodes />
       <notifyOnEarlyFinish>false</notifyOnEarlyFinish>
       <notifyOnLateFinish>false</notifyOnLateFinish>
       <notifyOnLateStart>false</notifyOnLateStart>
       <notifyOnProjectedLate>false</notifyOnProjectLate>
       <status>Resource Requested</status>
       <sysId>1a1ddf2fa7f7466db8b5fc7863fc4ea3</sysId>
       <severity>Normal</severity>
       <snmpManager>test manager</snmpManager>
</snmpNotification>


 
 
System Operation
<systemOperation>
       <description />
       <exitCodes />
       <notifyOnEarlyFinish>false</notifyOnEarlyFinish>
       <notifyOnLateFinish>false</notifyOnLateFinish>
       <notifyOnLateStart>false</notifyOnLateStart>
       <notifyOnProjectedLate>false</notifyOnProjectedLate>
       <status>Held</status>
       <sysId>742beaf652834054b1edc37e6423700d</sysId>
       <agent />
       <agentCluster />
       <agentClusterVar />
       <agentVar />
       <execCommand>Cancel</execCommand>
       <execCriteria>Oldest Active Instance</execCriteria>
       <execId />
       <execLookupOption>Task</execLookupOption>
       <execName />
       <execWorkflowNameCond />
       <execWorkflowName />
       <limit />
       <notificationOption>Operation Failure 
       </notificationOption>
       <operation>Run Task Instance Command</operation>
       <overrideTriggerDateOffset>1</overrideTriggerDateOffset>
       <overrideTriggerDateTime>true</overrideTriggerDateTime>
       <overrideTriggerTime>3:20</overrideTriggerTime>
       <task>Opswise - B=${B}</task> 
       <taskLimitType>Unlimited</taskLimitType> 
       <taskVar /> 
       <trigger /> 
       <triggerVar /> 
       <variables> 
              <variable> 
                     <name>var1</name> 
                     <value>val1</value> 
              </variable> 
              <variable> 
                     <name>var2</name> 
                     <value>val2</value> 
              </variable> 
       </variables>
       <variablesUnresolved>false</variablesUnresolved> 
       <variablesUnresolved /> 
       <virtualResource /> <virtualResourceVar /> 
</systemOperation>

JSON

Abort
"abortActions": [ { 
  "cancelProcess": false,
  "description": null,
  "exitCodes": null,
  "haltOnFinish": true,
  "notifyOnEarlyFinish": false,
  "notifyOnLateFinish": false,
  "notifyOnLateStart": false,
  "notifyOnProjectedLate": false,
  "overrideExitCode": null,
  "status": "Waiting",
  "sysId": "ad42c3268468425db6e1580cd53f57f0"
} ],


 
 
Email Notification
"emailNotifications": [ { 
  "attachFile": false,
  "attachJobLog": false,
  "attachLocalFile": true,
  "attachStdError": false,
  "attachStdOut": true,
  "bcc": null,
  "body": "test body",
  "cc": null,
  "description": null,
  "emailConnection": "Opswise - Gmail Account",
  "emailTemplate": null,
  "emailTemplateVar": null,
  "exitCodes": null,
  "fileName": null,
  "fileNumLines": 100,
  "fileScanText": null,
  "fileStartLine": 1,
  "joblogNumLines": 100,
  "joblogScanText": null,
  "joblogStartLine": 1,
  "localAttachment": "report.pdf",
  "localAttachmentsPath": "E:\temp",
  "notifyOnEarlyFinish": false,
  "notifyOnLateFinish": false,
  "notifyOnLateStart": false,
  "notifyOnProjectedLate": false,
  "replyTo": "replyTo@test.com",
  "report": {
    "groupName": null,
    "title": "report1",
    "userName": "ops.admin"
  },
  "status": "Success",
  "stderrNumLines": 100,
  "stderrScanText": null,
  "stderrStartLine": 1,
  "stdoutNumLines": 100,
  "stdoutScanText": null,
  "stdoutStartLine": 1,
  "subject": null,
  "sysId": "2b72cdaaf3a145e4bbae5a7ddd24baff",
  "to": "test@test.com"
  }  
],   


 
Set Variable
"setVariableActions": [ {
  "description": null,
  "exitCodes": null,
  "notificationOption": "Operation Failure",
  "notifyOnEarlyFinish": false,
  "notifyOnLateFinish": false,
  "notifyOnLateStart": false,
  "notifyOnProjectedLate": false,
  "status": "Waiting",
  "sysId": "f7824e38add745c2bf41017b07697bdf",
  "variableName": "name",
  "variableScope": "Self",
  "variableValue": null
  } 
],


 
SNMP Notification
"snmpNotifications": [ {
  "description": null,
  "exitCodes": null,
  "notifyOnEarlyFinish": false,
  "notifyOnLateFinish": false,
  "notifyOnLateStart": false,
  "notifyOnProjectedLate": false,
  "severity": "Normal", 
  "snmpManager": "test manager", 
  "status": "Resource Requested",
  "sysId": "1a1ddf2fa7f7466db8b5fc7863fc4ea3" 
  } 
],


 
System Operation
"systemOperations": [ {
  "agent": null,
  "agentCluster": null,
  "agentClusterVar": null,
  "agentVar": null,
  "description": null,
  "execCommand": "Cancel",
  "execCriteria": "Oldest Active Instance",
  "execId": null,
  "execLookupOption": "Task",
  "execName": null,
  "execWorkflowNameCond": null,
  "execWorkflowName": null,
  "exitCodes": null,
  "limit": null,
  "notificationOption": "Operation Failure",
  "notifyOnEarlyFinish": false,
  "notifyOnLateFinish": false,
  "notifyOnLateStart": false,
  "notifyOnProjectedLate": false,
  "operation": "Run Task Instance Command",
  "overrideTriggerDateOffset": 1,
  "overrideTriggerDateTime": true,
  "overrideTriggerTime": "3:20",
  "task": "Opswise - B=${B}",
  "taskLimitType": "Unlimited",
  "taskVar": null,
  "trigger": null,
  "triggerVar": null,
  "status": "Held",
  "sysId": "742beaf652834054b1edc37e6423700d",
  "variables": [ {
    "name": "var1",
    "value": "val1"
  },
  {
    "name": "var2",
    "value": "val2"
  } ],
  "variablesUnresolved": false,
  "virtualResource": null,
  "virtualResourceVar": null
  } ]

Properties

See the Task Action Properties page for information on all task action properties.

Task action properties are the same for every task type.

Universal Controller 7.2.x

Task Web Services - Task Actions

Examples

Properties