Versions Compared

Key

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

...

Anchor
Manual Task XML and JSON Examples
Manual Task XML and JSON Examples
Manual Task: XML and JSON Examples

The retainSysIds and version properties are specified as attributes in XML. 

The exportReleaseLevel and /wiki/spaces/UC71x/pages/5179227 properties are specified as attributes in XML.


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

Panel

description

exitCodes

notifyOnEarlyFinish

/notifyOnEarlyFinish

notifyOnLateFinish

/notifyOnLateFinish

notifyOnLateStart

/notifyOnLateStart

status

/status

sysId

/sysId

cancelProcess

/cancelProcess

haltOnFinish

/haltOnFinish

overrideExitCode


 

Anchor
Email Notification
Email Notification
Email Notification

Panel

description

exitCodes

notifyOnEarlyFinish

/notifyOnEarlyFinish

notifyOnLateFinish

/notifyOnLateFinish

notifyOnLateStart

/notifyOnLateStart

status

/status

sysId

/sysId

attachFile

/attachFile

attachJobLog

/attachJobLog

attachStdError

/attachStdError

attachStdOut

/attachStdOut

bcc

body

/body

cc

emailConnection

/emailConnection

emailTemplate

emailTemplateVar

fileName

fileNumLines

/fileNumLines

fileScanText

fileStartLine

/fileStartLine

joblogNumLines

/joblogNumLines

joblogScanText

joblogStartLine

/joblogStartLine

replyTo

/replyTo

report

/report

stderrNumLines

/stderrNumLines

stderrScanText

stderrStartLine

/stderrStartLine

stdoutNumLines

/stdoutNumLines

stdoutScanText

stdoutStartLine

/stdoutStartLine

subject

to

/to

 
 

Anchor
Set Variable
Set Variable
Set Variable

Panel

description

exitCodes

notificationOption

/notificationOption

notifyOnEarlyFinish

/notifyOnEarlyFinish

notifyOnLateFinish

/notifyOnLateFinish

notifyOnLateStart

/notifyOnLateStart

status

/status

sysId

/sysId

variableName

/variableName

variableScope

/variableScope

variableValue

 
 

Anchor
SNMP Notification
SNMP Notification
SNMP Notification

Panel

description

exitCodes

notifyOnEarlyFinish

/notifyOnEarlyFinish

notifyOnLateFinish

/notifyOnLateFinish

notifyOnLateStart

/notifyOnLateStart

status

/status

sysId

/sysId

severity

/severity

snmpManager

/snmpManager

 
 

Anchor
System Operation
System Operation
System Operation

Panel

description

exitCodes

notifyOnEarlyFinish

/notifyOnEarlyFinish

notifyOnLateFinish

/notifyOnLateFinish

notifyOnLateStart

/notifyOnLateStart

status

/status

sysId

/sysId

agent

agentCluster

agentClusterVar

agentVar

execCommand

/execCommand

execCriteria

/execCriteria

execId

execLookupOption

/execLookupOption

execName

execWorkflowNameCond

execWorkflowName

limit

notificationOption

/notificationOption

operation

/operation

task

/task

taskLimitType

/taskLimitType

taskVar

trigger

triggerVar

variables

name

/name

value

/value

name

/name

value

/value

/variables

variablesUnresolved

/variablesUnresolved

variablesUnresolved

virtualResource

virtualResourceVar

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

sysId

/sysId

task

task

type

type

sysId

/sysId

task

/task

type

/type

 

Anchor
Notes
Notes
Notes

Panel

sysId

/sysId

text

/text

title

/title

sysId

/sysId

text

/text

title

/title

 

Anchor
Variables in Tasks
Variables in Tasks
Variables

Panel

description

/description

name

/name

sysId

/sysId

value

/value

description

name

/name

sysId

/sysId

value

/value

 

Anchor
Virtual Resources
Virtual Resources
Virtual Resources

Panel

virtualResource

amount

/amount

resource

/resource

sysId

/sysId

/virtualResource

Expand
titleJSON

Anchor
Mutually Exclusive Tasks
Mutually Exclusive Tasks
Mutually Exclusive Tasks

Panel

sysId

task

type

sysId

task

type

 
 
 

Anchor
Notes
Notes
Notes

Panel

sysId

text

title

sysId

text

title

 
 
 

Anchor
Variables in Tasks
Variables in Tasks
Variables

Panel

description

name

sysId

value

description

name

sysId

value

 
 
 

Anchor
Virtual Resources
Virtual Resources
Virtual Resources

Panel

amount

resource

sysId

...