Versions Compared

Key

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

...

Examples

XML

JSON

Example for Task


Expand
titleXML
<taskManual exportReleaseLevel="7.2.0.0" exportTable="ops_task_manual" retainSysIds="true" version="1">
       <actions />
       <variables />
       <notes />
       <virtualResources />
       <exclusiveTasks />
<avgRunTime>3</avgRunTime>
<avgRunTimeDisplay>3 Seconds</avgRunTimeDisplay> <cpDuration /> <cpDurationUnit>Minutes</cpDurationUnit> <credentials /> <credentialsVar /> <customField1 label="Domain">web.com</customField1> <customField2 /> <efDayConstraint>Nth</efDayConstraint> <efDuration>00:00:00:00</efDuration> <efEnabled>false</efEnabled> <efNthAmount>10</efNthAmount>        <efOffsetDuration />
       <efOffsetDurationUnit>Minutes</efOffsetDurationUnit>
       <efOffsetPercentage>0</efOffsetPercentage>
       <efOffsetType>Percentage</efOffsetType>
       <efTime>00:00</efTime> <efType>Time</efType> <executionRestriction>Run</executionRestriction>
<firstRun>2021-03-15 13:59:37 -0400</firstRun> <holdResources>false</holdResources>
<lastRun>2021-03-16 17:12:42 -0400</lastRun>
<lastRunTime>9</lastRunTime>
<lastRunTimeDisplay>9 seconds</lastRunTimeDisplay> <lfDayConstraint>Nth</lfDayConstraint> <lfDuration>00:00:00:00</lfDuration> <lfEnabled>false</lfEnabled> <lfNthAmount>1</lfNthAmount>        <lfOffsetDuration />
       <lfOffsetDurationUnit>Minutes</lfOffsetDurationUnit>
       <lfOffsetPercentage>0</lfOffsetPercentage>
       <lfOffsetType>Percentage</lfOffsetType>
       <lfTime>00:00</lfTime> <lfType>Time</lfType> <lsDayConstraint>Nth</lsDayConstraint> <lsDuration>00:00:00:00</lsDuration> <lsEnabled>false</lsEnabled> <lsNthAmount>7</lsNthAmount> <lsTime>00:00</lsTime> <lsType>Time</lsType>
<maxRunTime>9</maxRunTime>
<maxRunTimeDisplay>9 Seconds</maxRunTimeDisplay>
<minRunTime>3</minRunTime>
<minRunTimeDisplay>3 Seconds</minRunTimeDisplay> <name>uc - Test Email</name> <opswiseGroups /> <resolveNameImmediately>false</resolveNameImmediately> <resPriority>10</resPriority> <restrictionPeriod>Span</restrictionPeriod> 
<restrictionPeriodAfterDate
>2017-11-10</restrictionPeriodAfterDate> <restrictionPeriodAfterTime>10:30</restrictionPeriodAfterTime> <restrictionPeriodBeforeDate>2017-11-20</restrictionPeriodBeforeDate> <restrictionPeriodBeforeTime>15:00</restrictionPeriodBeforeTime> <restrictionPeriodDateList />
<runCount>32</runCount>
<runTime>108</runTime> <startHeld>false</startHeld> <startHeldReason /> <summary>Test Email</summary> <sysId>fb59a227517a421a92c15ff5aefe3b66</sysId> <timeZonePref>-- System Default --</timeZonePref> <twDelayAmount /> <twDelayDuration>00:00:00:00</twDelayDuration> <twDelayType>None</twDelayType> <twWaitAmount /> <twWaitDayConstraint>NONE</twWaitDayConstraint> <twWaitDuration>00:00:00:00</twWaitDuration> <twWaitTime>00:00</twWaitTime> <twWaitType>None</twWaitType> <twWorkflowOnly>-- System Default --</twWorkflowOnly> <userEstimatedDuration /> </taskManual>



Expand
titleJSON
{
  "type": "taskManual",
  "actions": {
    "abortActions": [],
    "emailNotifications": [],
    "setVariableActions": [],
    "snmpNotifications": [],
    "systemOperations": []
  },
"avgRunTime": 3,
"avgRunTimeDisplay": "3 Seconds", "cpDuration": null, "cpDurationUnit": "Minutes", "credentials": null, "credentialsVar": null, "customField1": { "label": "Domain", "value": "http://qa-cntlr-mssql:8080/uc/" }, "customField2": { "label": null, "value": null }, "efDayConstraint": "Nth Day", "efDuration": "00:00:00:00", "efEnabled": false, "efNthAmount": 10,   "efOffsetDuration": null, 
  "efOffsetDurationUnit": "Minutes",
  "efOffsetPercentage": 0,
  "efOffsetType": "Percentage",
  "efTime": "00:00", "efType": "Time", "excludeRelated": false, "exclusiveTasks": [], "executionRestriction": "Run",
"exportReleaseLevel": "7.2.0.0",
"exportTable": "ops_task_manual",
"firstRun": "2021-03-15 13:59:37 -0400", "holdResources": false,
"lastRun": "2021-03-16 17:12:42 -0400",
"lastRunTime": 9,
"lastRunTimeDisplay": "9 Seconds", "lfDayConstraint": "Nth Day", "lfDuration": "00:00:00:00", "lfEnabled": false, "lfNthAmount": 1,   "lfOffsetDuration": null, 
  "lfOffsetDurationUnit": "Minutes",
  "lfOffsetPercentage": 0,
  "lfOffsetType": "Percentage",
  "lfTime": "00:00", "lfType": "Time", "lsDayConstraint": "Nth Day", "lsDuration": "00:00:00:00", "lsEnabled": false, "lsNthAmount": 7, "lsTime": "00:00", "lsType": "Time",
"maxRunTime": 9,
"maxRunTimeDisplay": "9 Seconds",
"minRunTime": 3,
"minRunTimeDisplay": "3 Seconds", "name": "uc - Test Email", "notes": [], "opswiseGroups": null, "resolveNameImmediately": false, "resPriority": 10, "restrictionPeriod": "Span", "restrictionPeriodAfterDate": "2017-11-10", "restrictionPeriodAfterTime": "10:30", "restrictionPeriodBeforeDate": "2017-11-20", "restrictionPeriodBeforeTime": "15:00", "restrictionPeriodDateList": [], "retainSysIds": true,
"runCount": 32,
"runTime": 108, "startHeld": false, "startHeldReason": null, "summary": "Test Email", "sysId": "fb59a227517a421a92c15ff5aefe3b66", "timeZonePref": "-- System Default --", "twDelayAmount": null, "twDelayDuration": "00:00:00:00", "twDelayType": "None", "twWaitAmount": null, "twWaitDayConstraint": "NONE", "twWaitDuration": "00:00:00:00", "twWaitTime": "00:00", "twWaitType": "None", "twWorkflowOnly": "-- System Default --", "userEstimatedDuration": null, "variables": [], "version": 1, "virtualResources": [] }


Anchor
Examples for Task Actions
Examples for Task Actions
Examples for Task Actions


Expand
titleXML

Anchor
Abort
Abort
Abort

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


 

Anchor
Email Notification
Email Notification
Email Notification

<emailNotification>
       <description />
       <exitCodes />
       <notifyOnEarlyFinish>false</notifyOnEarlyFinish>
       <notifyOnLateFinish>false</notifyOnLateFinish>
       <notifyOnLateStart>false</notifyOnLateStart>
       <status>Success</status>
       <sysId>2b72cdaaf3a145e4bbae5a7ddd24baff</sysId>
       <attachFile>false</attachFile>
       <attachJobLog>false</attachJobLog><attachJobLog>false</attachJobLog>
       <attachStdError>false</attachStdError><attachStdError>false</attachStdError>
       <attachStdOut>true</attachStdOut><attachStdOut>true</attachStdOut>
       <bcc<bcc />
       <body>test<body>test body</body>
       <cc />
       <emailConnection>uc - Gmail Account</emailConnection>
       <emailTemplate />
       <emailTemplateVar />
       <fileName />
       <fileNumLines>100</fileNumLines>
       <fileScanText />
       <fileStartLine>1</fileStartLine>
       <joblogNumLines>100</joblogNumLines>
       <joblogScanText />
       <joblogStartLine>1</joblogStartLine>
       <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>


 

Anchor
Set Variable
Set Variable
Set Variable

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

 
 

Anchor
SNMP Notification
SNMP Notification
SNMP Notification


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


 

Anchor
System Operation
System Operation
System Operation

<systemOperation>
       <description />
       <exitCodes />
       <notifyOnEarlyFinish>false</notifyOnEarlyFinish>
       <notifyOnLateFinish>false</notifyOnLateFinish>
       <notifyOnLateStart>false</notifyOnLateStart>
       <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>
       <task>uc - 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>



Expand
titleJSON

Anchor
Abort
Abort
Abort

Panel


Html bobswift
<pre>
"abortActions": [ { 
  "

cancelProcess

Html bobswift
": false,
  "

description

Html bobswift
": null,
  "

exitCodes

Html bobswift
": null,
  "

haltOnFinish

Html bobswift
": true,
  "

notifyOnEarlyFinish

Html bobswift
": false,
  "

notifyOnLateFinish

Html bobswift
": false,
  "

notifyOnLateStart

Html bobswift
": false,
  "

overrideExitCode

Html bobswift
": null,
  "

status

Html bobswift
": "Waiting",
  "

sysId

Html bobswift
": "ad42c3268468425db6e1580cd53f57f0"
} ],
</pre>


 
 

Anchor
Email Notification
Email Notification
Email Notification

Panel


Html bobswift
<pre>
"emailNotifications": [ { 
  "

attachFile

Html bobswift
": false,
  "

attachJobLog

Html bobswift
": false,
  "

attachStdError

Html bobswift
": false,
  "

attachStdOut

Html bobswift
": true,
  "

bcc

Html bobswift
": null,
  "

body

Html bobswift
": "test body",
  "

cc

Html bobswift
": null,
  "

description

Html bobswift
": null,
  "

emailConnection

Html bobswift
": "uc - Gmail Account",
  "

emailTemplate

Html bobswift
": null,
  "

emailTemplateVar

Html bobswift
": null,
  "

exitCodes

Html bobswift
": null,
  "

fileName

Html bobswift
": null,
  "

fileNumLines

Html bobswift
": 100,
  "

fileScanText

Html bobswift
": null,
  "

fileStartLine

Html bobswift
": 1,
  "

joblogNumLines

Html bobswift
": 100,
  "

joblogScanText

Html bobswift
": null,
  "

joblogStartLine

Html bobswift
": 1,
  "

notifyOnEarlyFinish

Html bobswift
": false,
  "

notifyOnLateFinish

Html bobswift
": false,
  "

notifyOnLateStart

Html bobswift
": false,
  "

replyTo

Html bobswift
": "replyTo@test.com",
  "

report

Html bobswift
": {
    "groupName": null,
    "title": "report1",
    "userName": "ops.admin"
  },
  "

status

Html bobswift
": "Success",
  "

stderrNumLines

Html bobswift
": 100,
  "

stderrScanText

Html bobswift
": null,
  "

stderrStartLine

Html bobswift
": 1,
  "

stdoutNumLines

Html bobswift
": 100,
  "

stdoutScanText

Html bobswift
": null,
  "

stdoutStartLine

Html bobswift
": 1,
  "

subject

Html bobswift
": null,
  "

sysId

Html bobswift
": "2b72cdaaf3a145e4bbae5a7ddd24baff",
  "

to

Html bobswift
": "test@test.com"
  }  
],   
</pre>


 

Anchor
Set Variable
Set Variable
Set Variable

Panel


Html bobswift
<pre>
"setVariableActions": [ {
  "

description

Html bobswift
": null,
  "

exitCodes

Html bobswift
": null,
  "

notificationOption

Html bobswift
": "Operation Failure",
  "

notifyOnEarlyFinish

Html bobswift
": false,
  "

notifyOnLateFinish

Html bobswift
": false,
  "

notifyOnLateStart

Html bobswift
": false,
  "

status

Html bobswift
": "Waiting",
  "

sysId

Html bobswift
": "f7824e38add745c2bf41017b07697bdf",
  "

variableName

Html bobswift
": "name",
  "

variableScope

Html bobswift
": "Self",
  "

variableValue

Html bobswift
": null
  } 
],
</pre>


 

Anchor
SNMP Notification
SNMP Notification
SNMP Notification

Panel


Html bobswift
<pre>
"snmpNotifications": [ {
  "

description

Html bobswift
": null,
  "

exitCodes

Html bobswift
": null,
  "

notifyOnEarlyFinish

Html bobswift
": false,
  "

notifyOnLateFinish

Html bobswift
": false,
  "

notifyOnLateStart

Html bobswift
": false,
  "

severity

Html bobswift
": "Normal",
  "

snmpManager

Html bobswift
": "test manager",
  "

status

Html bobswift
": "Resource Requested",
  "

sysId

Html bobswift
": "1a1ddf2fa7f7466db8b5fc7863fc4ea3"
  }
],
</pre>


 

Anchor
System Operation
System Operation
System Operation

Panel


Html bobswift
<pre>
"systemOperations": [ {
  "

agent

Html bobswift
": null,
  "

agentCluster

Html bobswift
": null,
  "

agentClusterVar

Html bobswift
": null,
  "

agentVar

Html bobswift
": null,
  "

description

Html bobswift
": null,
  "

execCommand

Html bobswift
": "Cancel",
  "

execCriteria

Html bobswift
": "Oldest Active Instance",
  "

execId

Html bobswift
": null,
  "

execLookupOption

Html bobswift
": "Task",
  "

execName

Html bobswift
": null,
  "

execWorkflowNameCond

Html bobswift
": null,
  "

execWorkflowName

Html bobswift
": null,
  "

exitCodes

Html bobswift
": null,
  "

limit

Html bobswift
": null,
  "

notificationOption

Html bobswift
": "Operation Failure",
  "

notifyOnEarlyFinish

Html bobswift
": false,
  "

notifyOnLateFinish

Html bobswift
": false,
  "

notifyOnLateStart

Html bobswift
": false,
  "

operation

Html bobswift
": "Run Task Instance Command",
  "

task

Html bobswift
": "uc - B=${B}",
  "

taskLimitType

Html bobswift
": "Unlimited",
  "

taskVar

Html bobswift
": null,
  "

trigger

Html bobswift
": null,
  "

triggerVar

Html bobswift
": null,
  "

status

Html bobswift
": "Held",
  "

sysId

Html bobswift
": "742beaf652834054b1edc37e6423700d",
  "

variables

Html bobswift
": [ {
    "

name

Html bobswift
": "var1",
    "

value

Html bobswift
": "val1"
  },
  {
    "

name

Html bobswift
": "var2",
    "

value

Html bobswift
": "val2"
  } ],
  "

variablesUnresolved

Html bobswift
": false,
  "

virtualResource

Html bobswift
": null,
  "

virtualResourceVar

Html bobswift
": null
  } ]
</pre>




Anchor
Examples for Task-Related Records
Examples for Task-Related Records
Examples for Task-Related Records


Expand
titleXML

Anchor
Mutually Exclusive Tasks
Mutually Exclusive Tasks
Mutually Exclusive Tasks

Panel


Html bobswift
<pre>
&lt;exclusiveTasks&gt;
      &lt;exclusiveTask&gt;
            &lt;

sysId

Html bobswift
&gt;5d2c0886b69745aa916a755602a1b77f&lt;

/sysId

Html bobswift
&gt;
            &lt;

task

Html bobswift
&gt;Sleep 0&lt;

task

Html bobswift
&gt;            
            &lt;

type

Html bobswift
&gt;Direct&lt;

type

Html bobswift
&gt;
      &lt;/exclusiveTask&gt;
      &lt;exclusiveTask&gt;
            &lt;

sysId

Html bobswift
&gt;c1342b7597f9492e927ce24c5126f9d4&lt;

/sysId

Html bobswift
&gt;
            &lt;

task

Html bobswift
&gt;Sleep 30&lt;

/task

Html bobswift
&gt;
            &lt;

type

Html bobswift
&gt;Direct&lt;

/type

Html bobswift
&gt;
      &lt;/exclusiveTask&gt;
&lt;/exclusiveTasks&gt;
</pre>


 

Anchor
Notes
Notes
Notes

Panel


Html bobswift
<pre>
&lt;notes&gt;
      &lt;note&gt;
            &lt;

sysId

Html bobswift
&gt;8122cc80fbdb4e12b2c7118c172038fc&lt;

/sysId

Html bobswift
&gt;
            &lt;

text

Html bobswift
&gt;note2 text&lt;

/text

Html bobswift
&gt;
            &lt;

title

Html bobswift
&gt;note2&lt;

/title

Html bobswift
&gt;
      &lt;/note&gt;
      &lt;note&gt;
            &lt;

sysId

Html bobswift
&gt;eb95737f44664bd3bd4002690e00d715&lt;

/sysId

Html bobswift
&gt;
            &lt;

text

Html bobswift
&gt;note1 text&lt;

/text

Html bobswift
&gt;
            &lt;

title

Html bobswift
&gt;note1&lt;

/title

Html bobswift
&gt;
      &lt;/note&gt;
&lt;/notes&gt;
</pre>


 

Anchor
Variables in Tasks
Variables in Tasks
Variables

Panel


Html bobswift
<pre>
&lt;variables&gt;
       &lt;variable&gt;
             &lt;

description

Html bobswift
&gt;description&lt;

/description

Html bobswift
&gt;
             &lt;

name

Html bobswift
&gt;var1&lt;

/name

Html bobswift
&gt;
             &lt;

sysId

Html bobswift
&gt;76af48c246954c128ef90da254044618&lt;

/sysId

Html bobswift
&gt;
             &lt;

value

Html bobswift
&gt;value1&lt;

/value

Html bobswift
&gt;
       &lt;/variable&gt;
       &lt;variable&gt;
             &lt;

description

Html bobswift
 /&gt;
             &lt;

name

Html bobswift
&gt;var2&lt;

/name

Html bobswift
&gt;
             &lt;

sysId

Html bobswift
&gt;899912878e4b4a36848269dc8a75dc1c&lt;

/sysId

Html bobswift
&gt;
             &lt;

value

Html bobswift
&gt;value2&lt;

/value

Html bobswift
&gt;
       &lt;/variable&gt;
&lt;/variables&gt;
</pre>


 

Anchor
Virtual Resources
Virtual Resources
Virtual Resources

Panel


Html bobswift
<pre>
&lt;virtualResources&gt;
       &lt;

virtualResource

Html bobswift
&gt;
             &lt;

amount

Html bobswift
&gt;1&lt;

/amount

Html bobswift
&gt;
             &lt;

resource

Html bobswift
&gt;uc - Solo&lt;

/resource

Html bobswift
&gt;
             &lt;

sysId

Html bobswift
&gt;4f5bb3fda5874dac8bb1897382d1317d&lt;

/sysId

Html bobswift
&gt;
       &lt;

/virtualResource

Html bobswift
&gt;
&lt;/virtualResources&gt;
</pre>





Expand
titleJSON

Anchor
Mutually Exclusive Tasks
Mutually Exclusive Tasks
Mutually Exclusive Tasks

Panel


Html bobswift
<pre>
"exclusiveTasks": [ {
  "

sysId

Html bobswift
": "5d2c0886b69745aa916a755602a1b77f",
  "

task

Html bobswift
": "Sleep 0",            
  "

type

Html bobswift
": "Direct"
  },
  {
  "

sysId

Html bobswift
": "c1342b7597f9492e927ce24c5126f9d4",
  "

task

Html bobswift
": "Sleep 30",
  "

type

Html bobswift
": "Direct"
  } ]
</pre>


 
 
 

Anchor
Notes
Notes
Notes

Panel


Html bobswift
<pre>
"notes": [ {
  "

sysId

Html bobswift
": "8122cc80fbdb4e12b2c7118c172038fc",
  "

text

Html bobswift
": "note2 text",
  "

title

Html bobswift
": "note2"
  },
  {
  "

sysId

Html bobswift
": "eb95737f44664bd3bd4002690e00d715",
  "

text

Html bobswift
": "note1 text",
  "

title

Html bobswift
": "note1"
  } ]
</pre>


 
 
 

Anchor
Variables in Tasks
Variables in Tasks
Variables

Panel


Html bobswift
<pre>
"variables": [ {
  "

description

Html bobswift
": "description",
  "

name

Html bobswift
": "var1",
  "

sysId

Html bobswift
": "76af48c246954c128ef90da254044618",
  "

value

Html bobswift
": "value1"
  },
  {
  "

description

Html bobswift
": null,
  "

name

Html bobswift
": "var2",
  "

sysId

Html bobswift
": "899912878e4b4a36848269dc8a75dc1c",
  "

value

Html bobswift
": "value2"
  } ]
</pre>


 
 
 

Anchor
Virtual Resources
Virtual Resources
Virtual Resources

Panel


Html bobswift
<pre>
"virtualResources": [ {
  "

amount

Html bobswift
": 1,
  "

resource

Html bobswift
": "uc - Solo",
  "

sysId

Html bobswift
": "4f5bb3fda5874dac8bb1897382d1317d"
  } ]
</pre>




...