Versions Compared

Old Version 1

changes.mady.by.user Former user

Saved on

compared with

New Version 2

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.

...

Property

UI Field Name

Description

Specifications

Required

Anchor
cancelProcess - Abort
cancelProcess - Abort
cancelProcess

Cancel Process if Active

Instructs the Controller to cancel the process that was launched by this task before Force Finishing the task.

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

N

Anchor
description - Abort
description - Abort
description

Description

Description of this Abort action.


N

Anchor
exitCodes - Abort
exitCodes - Abort
exitCodes

Exit Codes

One or more exit codes that, together with a status, will trigger the Abort action.

Integer; Use commas to separate multiple exit codes; use a hyphen to specify a range. Example: 1, 5, 22-30.

N

Anchor
haltOnFinish - Abort
haltOnFinish - Abort
haltOnFinish

Halt On Force Finish

Instructs the Controller to Force Finish (Halt) a running task instance, rather than just Force Finish

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

N

Anchor
inheritance - Abort
inheritance - Abort
inheritance

Action Inheritance

For Workflow tasks only; Records that this action applies to.

Valid values:

Html bobswift
<ul>
<li> As String = Self, As Value = 1
<li> As String = Self/Children, As Value = 2
<li> As String = Children, As Value = 3
</ul>

Default is Self (1).

N

Anchor
notifyOnEarlyFinish - Abort
notifyOnEarlyFinish - Abort
notifyOnEarlyFinish

On Early Finish

Generates the action if the task finishes early, based on the Early Finish Time specified in the task.

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

N

Anchor
notifyOnLateFinish - Abort
notifyOnLateFinish - Abort
notifyOnLateFinish

On Late Finish

Generates the action if the task finishes late, based on the Late Finish time specified in the task.

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

N

Anchor
notifyOnLateStart - Abort
notifyOnLateStart - Abort
notifyOnLateStart

On Late Start

Generates the action if the task started late, based on the Late Start Time specified in the task.

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

N

Anchor
notifyOnProjectedLate - Abort
notifyOnProjectedLate - Abort
notifyOnProjectedLate

On Projected LateGenerates the action if the task is projected to be late, based on the calculated Projected End Time and the Late Start Time, Late Start Duration, or Late Finish Time time option.Boolean; Valid values: true/false. Default is false.N

Anchor
overrideExitCode - Abort
overrideExitCode - Abort
overrideExitCode

Override Exit Code

Overrides the exit code returned by the process with this exit code. This enables you to you Force Finish a task instance with a specific exit code so that you can force the workflow to take a conditional path using Conditions.

Integer.

N

Anchor
status - Abort
status - Abort
status

Status

Status of this task, by itself or together with an exit code, that will trigger this Abort action. You can specify as many statuses as needed.


Y

Anchor
sysid - Abort
sysid - Abort
sysId

n/a

sys_id used within the Controller to identify this Abort action.


N

...

Property

UI Field Name

Description

Specifications

Required

Anchor
attachFile - Email
attachFile - Email
attachFile

Attach Remote File

For Agent-based tasks only; Specification for whether or not a text file that is accessible by the Agent is attached.

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

N

Anchor
attachJobLog - Email
attachJobLog - Email
attachJobLog

Attach Job Log

For z/OS tasks; Specification for whether or not a job log is attached.

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

N

Anchor
attachLocalFile - Email
attachLocalFile - Email
attachLocalFile

Attach Local File

Specification for whether or not a local file is attached.

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

N

Anchor
attachStdError - Email
attachStdError - Email
attachStdError

Attach Standard Error

For Agent-based tasks only (except z/OS); Specification for whether or not standard error data generated by the associated task is attached.

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

N

Anchor
attachStdOut - Email
attachStdOut - Email
attachStdOut

Attach Standard Output

For Agent-based tasks only (except z/OS); Specification for whether or not standard output data generated by the associated task is attached.

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

N

Anchor
bcc - Email
bcc - Email
bcc

BCC

Email address of the party being sent a blind (hidden) copy of the email, if any.

Use commas to separate multiple recipients. Variables and functions are supported.

N

Anchor
body - Email
body - Email
body

Body

Text of the email message.

Variables and functions are supported.

N

Anchor
cc - Email
cc - Email
cc

CC

Email address of the party being sent a copy of the email, if any.

Use commas to separate multiple recipients. Variables and functions are supported.

N

Anchor
description - Email
description - Email
description

Description

Description of this Email Notification action.


N

Anchor
emailConnection - Email
emailConnection - Email
emailConnection

Email Connection

Name of an Email Connection.

If you specify both an emailConnection and an emailTemplate, the Controller uses the emailConnection.

Y
(unless emailTemplate
is specified)

Anchor
emailTemplate - Email
emailTemplate - Email
emailTemplate

Email Template

Name of an Email Template.

If you specify both an emailConnection and an emailTemplate, the Controller uses the emailConnection.

Y
(unless emailConnection
is specified)

Anchor
emailTemplateVar - Email
emailTemplateVar - Email
emailTemplateVar

Email Template Variable

Name of a variable that will be resolved at run time to the name of an Email Template to use.

Format: ${variable name}.

N

Anchor
exitCodes - Email
exitCodes - Email
exitCodes

Exit Codes

One or more exit codes that will trigger this action.

Integer; if you specify an exit code, you also must specify at least one status. Use commas to separate multiple exit codes; use a hyphen to specify a range. Example: 1, 5, 22-30.

N

Anchor
fileName - Email
fileName - Email
fileName

File Name

If attachFile is enabled; Name of an attached file.

Full path name is required. Wildcards are NOT supported.

Y
(if attachFile
is specified)

Anchor
fileNumLines - Email
fileNumLines - Email
fileNumLines

Number of Lines

Number of lines to limit the retrieved data to. If fileNumLines is not specified, the default is the value of the Retrieve Output Default Maximum Lines Universal Controller system property.

Integer.

N

Anchor
fileScanText - Email
fileScanText - Email
fileScanText

Scan Text

Regex pattern that the Controller will search for a match for in STDOUT/STDERR or a specified file. The Controller will include the fileNumLines above and below the first line matched.


N

Anchor
fileStartLine - Email
fileStartLine - Email
fileStartLine

Start Line

Integer; Starting line of the attached data.

Integer.

N

Anchor
inheritance - Email
inheritance - Email
inheritance

Action Inheritance

For Workflow tasks only; Records that this action applies to.

Valid values:

Default is Self (1).

N

Html bobswift
<ul>
<li> As String = Self, As Value = 1
<li> As String = Self/Children, As Value = 2
<li> As String = Children, As Value = 3
</ul>

Default is Self (1).

N

Anchor
joblogNumLines - Email
joblogNumLines - Email
joblogNumLines

Number of Lines

For z/OS tasks only; Number of lines to limit the retrieved data in the job log to.

Integer.

N

Anchor
joblogScanText - Email
joblogScanText - Email
joblogScanText

Scan Text

For z/OS tasks only; Regex pattern that the Controller will search for a match for in the job log.

Integer.

N

Anchor
joblogStartLine - Email
joblogStartLine - Email
joblogStartLine

Start Line

For z/OS tasks only; Starting line of the attached job log.

Integer.

N

Anchor
localAttachmentsPath - Email
localAttachmentsPath - Email
localAttachmentsPath

Local Attachments Path

Location of Local Attachments for the connected Node.


N

Anchor
localAttachment - Email
localAttachment - Email
localAttachment

Local Attachment

Name of the file(s) to attach.


N

Anchor
notifyOnEarlyFinish - Email
notifyOnEarlyFinish - Email
notifyOnEarlyFinish

On Early Finish

Specification to generate the action if the task finishes early, based on the Early Finish Time specified in the task.

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

N

Anchor
notifyOnLateFinish - Email
notifyOnLateFinish - Email
notifyOnLateFinish

On Late Finish

Specification to generate the action if the task finishes late, based on the Late Finish Time specified in the task.

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

N

Anchor
notifyOnLateStart - Email
notifyOnLateStart - Email
notifyOnLateStart

On Late Start

Specification to generate the action if the task starts late, based on the Late Start Time specified in the task.

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

N

Anchor
notifyOnProjectedLate - Email
notifyOnProjectedLate - Email
notifyOnProjectedLate

On Projected LateGenerates the action if the task is projected to be late, based on the calculated Projected End Time and the Late Start Time, Late Start Duration, or Late Finish Time time option.Boolean; Valid values: true/false. Default is false.N

Anchor
replyTo - Email
replyTo - Email
replyTo

Reply-To

Email address of the sender of the email.

Use commas to separate multiple recipients. Variables and Functions are supported.

N

Anchor
report - Email
report - Email
report

Report

Report attached to this notification.

...

Variable Scope

...

Applies to variables associated with a task in a Workflow.

...

Valid values:

Default is Self (1).

...

N

...

Value

...

Value of this variable.

...

N

...

descriptionexitCodesinheritancenotifyOnEarlyFinish

 
To define a report reference for a report with Title XYZ that is visible to group Operators, you would specify:
 
XML

 
JSON

 
To define a report reference for a report with title XYZ that is visible to Everyone, you would specify:
 
XML

Property

UI Field Name

Description

Specifications

Required

Anchor
description - SNMPdescription - SNMP

Description

Description of this action.

N

Anchor
exitCodes - SNMPexitCodes - SNMP

Exit Codes

One or more exit codes that will trigger this action.

Integer; if you specify an exit code, you also must specify at least one status. Use commas to separate multiple exit codes; use a hyphen to specify a range. Format: 1,5,22-30

N

Anchor
inheritance - SNMPinheritance - SNMP

Action Inheritance

For Workflow tasks only; Records that this action applies to.

Valid values:

Default is Self (1).

N

Anchor
notifyOnEarlyFinish - SNMPnotifyOnEarlyFinish - SNMP

On Early Finish

Specification to generate the action if the task finishes early, based on the Early Finish

If reportVar is specified, report is ignored.
 
Reports do not have to be unique by Title. However, reports with the same Title must be unique per Visibility: per User, per Group, and per Everyone.
 
Therefore, when specifying a report reference, both the Title and Visibility must be specified.
 
To define a report reference for a report with Title XYZ that is visible to user john.doe, you would specify:
 
XML

Panel

 
JSON

Panel
Panel
Panel
Panel
Html bobswift
<pre>
&lt;report&gt;
      &lt;title&gt;XYZ&lt;/title&gt;
      &lt;userName&gt;john.doe&lt;/userName&gt;
      &lt;groupName /&gt;
&lt;/report&gt;
</pre>

 
JSON

Panel

N

AnchorreportVar - EmailreportVar - EmailreportVar

Report Variable

Name of a variable that will be resolved at run time to the name of the Report to attach.

If reportVar is specified, report is ignored.

N

Anchorstatus - Emailstatus - Emailstatus

Status

Status of this task, by itself or together with an exit code, that will trigger this Email Notification action. You can specify as many statuses as needed.

Y

AnchorstderrNumLines - EmailstderrNumLines - EmailstderrNumLines

Number of Lines

Number of lines to limit the retrieved stderr data to. If stderrNumLines is not specified, the default is the value of the Retrieve Output Default Maximum Lines Universal Controller system property.

Integer.

N

AnchorstderrScanText - EmailstderrScanText - EmailstderrScanText

Scan Text

Regex pattern that the Controller will search for a match for in stderr. The Controller will include the Number of Lines above and below the first line matched.

N

AnchorstderrStartLine - EmailstderrStartLine - EmailstderrStartLine

Start Line

Starting line of the attached stderr data.

Integer.

N

AnchorstdoutNumLines - EmailstdoutNumLines - EmailstdoutNumLines

Number of Lines

Number of lines to limit the retrieved stderr data to. If stdoutNumLines is not specified, the default is the value of the Retrieve Output Default Maximum Lines Universal Controller system property.

Integer.

N

AnchorstdoutScanText - EmailstdoutScanText - EmailstdoutScanText

Scan Text

Regex pattern that the Controller will search for a match for in stdout. The Controller will include the Number of Lines above and below the first line matched.

N

AnchorstdoutStartLine - EmailstdoutStartLine - EmailstdoutStartLine

Start Line

Starting line of the attached stdout data.

Integer.

N

Anchorsubject - Emailsubject - Emailsubject

Subject

Subject line of the email.

Variables and functions supported.

N

Anchorsysid - Emailsysid - Email sysId

n/a

sys_id used within the Controller to identify this Email Notification action.

N

Anchorto - Emailto - Email to

To

Email address of the recipient.

Use commas to separate multiple recipients Variables and functions supported.

Y

...

Property

...

UI Field Name

...

Description

...

Specifications

...

Required

...

Description

...

Description of this Set Variable action.

...

N

...

Exit Codes

...

One or more exit codes that will trigger this action.

...

Integer; if you specify an exit code, you also must specify at least one status. Use commas to separate multiple exit codes; use a hyphen to specify a range. Format: 1,5,22-30

...

N

...

Action Inheritance

...

For Workflow tasks only; Records that this action applies to.

...

Valid values:

Default is Self (1).

...

N

...

System Notification

...

If variableScope is Global (4); Status of the Set Variable action that will trigger a system notification.

...

Valid values:

Default is Operation Failure (1).

...

N

...

On Early Finish]

...

Specification to generate the action if the task finishes early, based on the Early Finish Time specified in the task.

...

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

...

N

...

On Late Finish

...

Specification to generate the action if the task finishes late, based on the Late Finish Time specified in the task.

...

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

...

N

...

On Late Start

...

Specification to generate the action if the task starts late, based on the Late Start Time specified in the task.

...

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

...

N

...

Status

...

Status of this task, by itself or together with an exit code, that will trigger this Set Variable action. You can specify as many statuses as needed.

...

Y

...

n/a

...

sys_id used within the Controller to identify this Email Notification action.

...

N

...

Name

...

Name of the variable.

...

Maximum 40 characters; must begin with an alphabetic character and can consist of: alphabetics (a-z, A-Z), numerics 0-9, _ (underscore). White spaces are not permitted; names are not case-sensitive. Do not begin the name with ops_; this prefix is reserved for built-in variables.

...

N

Html bobswift
<pre>
"report": {
     "title": "XYZ",
     "userName": "john.doe",
     "groupName": null
  }
</pre>

 
To define a report reference for a report with Title XYZ that is visible to group Operators, you would specify:
 
XML

Panel
Html bobswift
<pre>
&lt;report&gt;
      &lt;title&gt;XYZ&lt;/title&gt;
      &lt;userName /&gt;
      &lt;groupName&gt;Operators&lt;/groupName&gt;
&lt;/report&gt;
</pre>

 
JSON

Panel
Html bobswift
<pre>
"report": {
     "title": "XYZ",
     "userName": null,
     "groupName": "Operators",
  }
</pre>

 
To define a report reference for a report with title XYZ that is visible to Everyone, you would specify:
 
XML

Panel
Html bobswift
<pre>
&lt;report&gt;
      &lt;title&gt;XYZ&lt;/title&gt;
      &lt;groupName /&gt;
      &lt;userName /&gt;
&lt;/report&gt;
</pre>

 
JSON

Panel
Html bobswift
<pre>
"report": {
     "title": "XYZ",
     "userName": null,
     "groupName": null
  }
</pre>

N

Anchor
reportVar - Email
reportVar - Email
reportVar

Report Variable

Name of a variable that will be resolved at run time to the name of the Report to attach.

If reportVar is specified, report is ignored.

N

Anchor
status - Email
status - Email
status

Status

Status of this task, by itself or together with an exit code, that will trigger this Email Notification action. You can specify as many statuses as needed.


Y

Anchor
stderrNumLines - Email
stderrNumLines - Email
stderrNumLines

Number of Lines

Number of lines to limit the retrieved stderr data to. If stderrNumLines is not specified, the default is the value of the Retrieve Output Default Maximum Lines Universal Controller system property.

Integer.

N

Anchor
stderrScanText - Email
stderrScanText - Email
stderrScanText

Scan Text

Regex pattern that the Controller will search for a match for in stderr. The Controller will include the Number of Lines above and below the first line matched.


N

Anchor
stderrStartLine - Email
stderrStartLine - Email
stderrStartLine

Start Line

Starting line of the attached stderr data.

Integer.

N

Anchor
stdoutNumLines - Email
stdoutNumLines - Email
stdoutNumLines

Number of Lines

Number of lines to limit the retrieved stderr data to. If stdoutNumLines is not specified, the default is the value of the Retrieve Output Default Maximum Lines Universal Controller system property.

Integer.

N

Anchor
stdoutScanText - Email
stdoutScanText - Email
stdoutScanText

Scan Text

Regex pattern that the Controller will search for a match for in stdout. The Controller will include the Number of Lines above and below the first line matched.


N

Anchor
stdoutStartLine - Email
stdoutStartLine - Email
stdoutStartLine

Start Line

Starting line of the attached stdout data.

Integer.

N

Anchor
subject - Email
subject - Email
subject

Subject

Subject line of the email.

Variables and functions supported.

N

Anchor
sysid - Email
sysid - Email
sysId

n/a

sys_id used within the Controller to identify this Email Notification action.


N

Anchor
to - Email
to - Email
to

To

Email address of the recipient.

Use commas to separate multiple recipients Variables and functions supported.

Y

Anchor
Set Variable Action
Set Variable Action
Set Variable Action

notifyOnProjectedLateseveritystatussysIdsnmpManager

Property

UI Field Name

Description

Specifications

Required

Anchor
description - SV
description - SV
description

Description

Description of this Set Variable action.


N

Anchor
exitCodes - SV
exitCodes - SV
exitCodes

Exit Codes

One or more exit codes that will trigger this action.

Integer; if you specify an exit code, you also must specify at least one status. Use commas to separate multiple exit codes; use a hyphen to specify a range. Format: 1,5,22-30

N

Anchor
inheritance - SV
inheritance - SV
inheritance

Action Inheritance

For Workflow tasks only; Records that this action applies to.

Valid values:

Html bobswift
<ul>
<li> As String = Self, As Value = 1
<li> As String = Self/Children, As Value = 2
<li> As String = Children, As Value = 3
</ul>

Default is Self (1).

N

Anchor
notificationOption - SV
notificationOption - SV
notificationOption

System Notification

If variableScope is Global (4); Status of the Set Variable action 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
notifyOnEarlyFinish - SV
notifyOnEarlyFinish - SV
notifyOnEarlyFinish

On Early Finish]

Specification to generate the action if the task finishes early, based on the Early Finish Time specified in the task.

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

N

Anchor
notifyOnLateFinish - SV
notifyOnLateFinish - SV
notifyOnLateFinish

On Late Finish

Specification to generate the action if the task finishes late, based on the Late Finish Time specified in the task.

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

N

Anchor
notifyOnLateStart - SV
notifyOnLateStart - SV
notifyOnLateStart

On Late Start

Specification to generate the action if the task starts late, based on the Late Start Time specified in the task.

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

N

Anchor
notifyOnLateFinish notifyOnProjectedLate - SNMPSVnotifyOnLateFinish
notifyOnProjectedLate - SNMPSV
notifyOnLateFinishnotifyOnProjectedLate

On Projected Late FinishSpecification to generate Generates the action if the task finishes is projected to be late, based on the calculated Projected End Time and the Late Start Time, Late Start Duration, or Late Finish Time specified in the tasktime option.Boolean; Valid values: true/false. Default is false.N

Anchor
notifyOnLateStart status - SNMPSVnotifyOnLateStart
status - SNMPSV
notifyOnLateStartstatus

On Late Start

Specification to generate the action if the task starts late, based on the Late Start Time specified in the task.

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

N

Anchor
notifyOnProjectedLate - SNMPnotifyOnProjectedLate - SNMPOn Projected LateGenerates the action if the task is projected to be late, based on the calculated Projected End Time and the Late Start Time, Late Start Duration, or Late Finish Time time option.Boolean; Valid values: true/false. Default is false.N
Anchor
severity - SNMPseverity - SNMP

Notification Severity

Severity level of this notification.

Valid values:

Default is Normal (1).

Y

Anchor
status - SNMPstatus - SNMP

Status

Status of this task, by itself or together with an exit code, that will trigger this SNMP Notification action. You can specify as many statuses as needed.

Y

Anchor
sysId - SNMPsysId - SNMP

n/a

sys_id used within the Controller to identify this SNMP Notification action.

N

Anchor
snmpManager - SNMPsnmpManager - SNMP

SNMP Manager

SNMP Manager that will receive this notification.

Y

...

agentagentClusteragentClusterVaragentVardescriptionexecCommandexecCriteriaexecIdexecLookupOptionexecNameexecWorkflowNameCondexecWorkflowNameexitCodeslimitinheritancenamenotificationOptionnotifyOnEarlyFinishnotifyOnLateFinishnotifyOnLateStartnotifyOnProjectedLateoperation

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
agent - SOagent - SO

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.

Y
(unless agentVar,
agentCluster,
or agentClusterVar
is specified)

agentVar

Anchor
agentCluster - SOagentCluster - SO

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.

Y
(unless agent,
agentVar,
or agentClusterVar
is specified)

agentClusterVar

Anchor
agentClusterVar - SOagentClusterVar - SO

Agent Cluster Variable

If operation is Suspend Agent Cluster, Resume Agent Cluster, Suspend Cluster Membership, Resume Cluster Membership, or Set Cluster Task Execution Limit; Name of a variable that will be resolved at run time to the name of the Agent Cluster to use.

Y
(unless agentCluster,
agent,
or agentVar
is specified)

agentCluster

Anchor
agentvar - SOagentvar - SO

Agent Variable

If System Operation is Suspend Agent, Resume Agent, Suspend Cluster Membership, Resume Cluster Membership, or Set Agent Task Execution Limit; Name of a variable that will be resolved at run time to the name of the Agent to use.

Y
(unless agent,
agentCluster,
or agentClusterVar
is specified)

agent

Anchor
description - SOdescription - SO

Description

Description of this System Operation action.

N

Anchor
execCommand - SOexecCommand - SO

Command

If operation is Run Task Instance Command; Type of task instance command to run.

Valid values:

Default is Cancel (1).

N

Anchor
execCriteria - SOexecCriteria - SO

Instance Criteria

If execLookupOption is Instance Name, Instance Name/Task, or Task; 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 - SOexecId - SO

Instance Id

If execLookupOption is Instance Id; ID of task instance to run the command against.

The instance Id (sysid) is a 32-character universally unique identifier. You can use the ${ops_task_id} variable or ${_siblingid('mytask')} function to get the instance Id.

N

Anchor
execLookupOption - SOexecLookupOption - SO

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 - SOexecName - SO

Instance Name

If execLookupOption is Instance Name or Instance Name/Task; Name of the task instance to run the command against.

Variables are supported.

Y

Anchor
execWorkflowNameCond - SOexecWorkflowNameCond - SO

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. 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
execWorkflowName - SOexecWorkflowName - SO

Workflow Instance Name <Condition Value>

Value for execWorkflowNameCond.

Y

Anchor
exitCodes - SOexitCodes - SO

Exit Codes

One or more exit codes that will trigger this action.

Integer; if you specify an exit code, you also must specify at least one status. Use commas to separate multiple exit codes; use a hyphen to specify a range. Format: 1,5,22-30

N

Anchor
limit - SOlimit - SO

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.

Integer

N

Anchor
inheritance - SOinheritance - SO

Action Inheritance

For Workflow tasks only; Records that this action applies to.

Valid values:

Default is Self (1).

N

Anchor
name - SOname - SO

Name

Name of a variable to override.

N

Anchor
notificationOption - SOnotificationOption - SO

System Notification

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

Valid values:

Default is Operation Failure (1).

N

Anchor
notifyOnEarlyFinish - SOnotifyOnEarlyFinish - SO

On Early Finish

Specification to generate the action if the task finishes early, based on the Early Finish Time specified in the task.

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

N

Anchor
notifyOnLateFinish - SOnotifyOnLateFinish - SO

On Late Finish

Specification to generate the action if the task finishes late, based on the Late Finish Time specified in the task.

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

N

Anchor
notifyOnLateStart - SOnotifyOnLateStart - SO

On Late Start

Specification to generate the action if the task starts late, based on the Late Start Time specified in the task.

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

N

Anchor
notifyOnProjectedLate - SOnotifyOnProjectedLate - SOOn Projected LateGenerates the action if the task is projected to be late, based on the calculated Projected End Time and the Late Start Time, Late Start Duration, or Late Finish Time time option.Boolean; Valid values: true/false. Default is false.N
Anchor
operation - SOoperation - SO

System Operation

System operation to perform.

Valid values:

Status

Status of this task, by itself or together with an exit code, that will trigger this Set Variable action. You can specify as many statuses as needed.


Y

Anchor
sysId - SV
sysId - SV
sysId

n/a

sys_id used within the Controller to identify this Email Notification action.


N

Anchor
variableName - SV
variableName - SV
variableName

Name

Name of the variable.

Maximum 40 characters; must begin with an alphabetic character and can consist of: alphabetics (a-z, A-Z), numerics 0-9, _ (underscore). White spaces are not permitted; names are not case-sensitive. Do not begin the name with ops_; this prefix is reserved for built-in variables.

N

Anchor
variableScope - SV
variableScope - SV
variableScope

Variable Scope

Applies to variables associated with a task in a Workflow.

Valid values:

Html bobswift
<ul>
<li> As String = Self, As Value = 1
<li> As String = Parent, As Value = 2
<li> As String = Top Level Parent, As Value = 3
<li> As String = Global, As Value = 4
</ul>

Default is Self (1).

N

Anchor
variableValue - SV
variableValue - SV
variableValue

Value

Value of this variable.


N

Anchor
SNMP Notification Action
SNMP Notification Action
SNMP Notification Action

Property

UI Field Name

Description

Specifications

Required

Anchor
description - SNMP
description - SNMP
description

Description

Description of this action.


N

Anchor
exitCodes - SNMP
exitCodes - SNMP
exitCodes

Exit Codes

One or more exit codes that will trigger this action.

Integer; if you specify an exit code, you also must specify at least one status. Use commas to separate multiple exit codes; use a hyphen to specify a range. Format: 1,5,22-30

N

Anchor
inheritance - SNMP
inheritance - SNMP
inheritance

Action Inheritance

For Workflow tasks only; Records that this action applies to.

Valid values:

Html bobswift
<ul>
<li> As String = Self, As Value = 1
<li> As String = Self/Children, As Value = 2
<li> As String = Children, As Value = 3
</ul>

Default is Self (1).

N

Anchor
notifyOnEarlyFinish - SNMP
notifyOnEarlyFinish - SNMP
notifyOnEarlyFinish

On Early Finish

Specification to generate the action if the task finishes early, based on the Early Finish Time specified in the task.

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

N

Anchor
notifyOnLateFinish - SNMP
notifyOnLateFinish - SNMP
notifyOnLateFinish

On Late Finish

Specification to generate the action if the task finishes late, based on the Late Finish Time specified in the task.

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

N

Anchor
notifyOnLateStart - SNMP
notifyOnLateStart - SNMP
notifyOnLateStart

On Late Start

Specification to generate the action if the task starts late, based on the Late Start Time specified in the task.

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

N

Anchor
notifyOnProjectedLate - SNMP
notifyOnProjectedLate - SNMP
notifyOnProjectedLate

On Projected LateGenerates the action if the task is projected to be late, based on the calculated Projected End Time and the Late Start Time, Late Start Duration, or Late Finish Time time option.Boolean; Valid values: true/false. Default is false.N

Anchor
severity - SNMP
severity - SNMP
severity

Notification Severity

Severity level of this notification.

Valid values:

Html bobswift
<ul>
<li> As String = Normal, As Value = 1
<li> As String = Warning, As Value = 2
<li> As String = Minor, As Value = 3
<li> As String = Major, As Value = 4
<li> As String = Critical, As Value = 5
</ul>

Default is Normal (1).

Y

Anchor
status - SNMP
status - SNMP
status

Status

Status of this task, by itself or together with an exit code, that will trigger this SNMP Notification action. You can specify as many statuses as needed.


Y

Anchor
sysId - SNMP
sysId - SNMP
sysId

n/a

sys_id used within the Controller to identify this SNMP Notification action.


N

Anchor
snmpManager - SNMP
snmpManager - SNMP
snmpManager

SNMP Manager

SNMP Manager that will receive this notification.


Y

Anchor
System Operation Action
System Operation Action
System Operation Action

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
agent - SO
agent - SO
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.


Y
(unless agentVar,
agentCluster,
or agentClusterVar
is specified)

agentVar

Anchor
agentCluster - SO
agentCluster - SO
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.


Y
(unless agent,
agentVar,
or agentClusterVar
is specified)

agentClusterVar

Anchor
agentClusterVar - SO
agentClusterVar - SO
agentClusterVar

Agent Cluster Variable

If operation is Suspend Agent Cluster, Resume Agent Cluster, Suspend Cluster Membership, Resume Cluster Membership, or Set Cluster Task Execution Limit; Name of a variable that will be resolved at run time to the name of the Agent Cluster to use.


Y
(unless agentCluster,
agent,
or agentVar
is specified)

agentCluster

Anchor
agentvar - SO
agentvar - SO
agentVar

Agent Variable

If System Operation is Suspend Agent, Resume Agent, Suspend Cluster Membership, Resume Cluster Membership, or Set Agent Task Execution Limit; Name of a variable that will be resolved at run time to the name of the Agent to use.


Y
(unless agent,
agentCluster,
or agentClusterVar
is specified)

agent

Anchor
description - SO
description - SO
description

Description

Description of this System Operation action.


N


Anchor
execCommand - SO
execCommand - SO
execCommand

Command

If operation is Run Task Instance Command; Type of task instance command to run.

Valid values:

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 is Cancel (1).

N


Anchor
execCriteria - SO
execCriteria - SO
execCriteria

Instance Criteria

If execLookupOption is Instance Name, Instance Name/Task, or Task; 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 (Unskip command only)
<li> As String = Newest Instance, As Value = 4 (Unskip command only)
</ul>

Default is Oldest Active Instance (1).

N


Anchor
execId - SO
execId - SO
execId

Instance Id

If execLookupOption is Instance Id; ID of task instance to run the command against.

The instance Id (sysid) is a 32-character universally unique identifier. You can use the ${ops_task_id} variable or ${_siblingid('mytask')} function to get the instance Id.

N


Anchor
execLookupOption - SO
execLookupOption - SO
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 - SO
execName - SO
execName

Instance Name

If execLookupOption is Instance Name or Instance Name/Task; Name of the task instance to run the command against.

Variables are supported.

Y


Anchor
execWorkflowNameCond - SO
execWorkflowNameCond - SO
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. 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 = Start 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
execWorkflowName - SO
execWorkflowName - SO
execWorkflowName

Workflow Instance Name <Condition Value>

Value for execWorkflowNameCond.


Y


Anchor
exitCodes - SO
exitCodes - SO
exitCodes

Exit Codes

One or more exit codes that will trigger this action.

Integer; if you specify an exit code, you also must specify at least one status. Use commas to separate multiple exit codes; use a hyphen to specify a range. Format: 1,5,22-30

N


Anchor
limit - SO
limit - SO
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.

Integer

N


Anchor
inheritance - SO
inheritance - SO
inheritance

Action Inheritance

For Workflow tasks only; Records that this action applies to.

Valid values:

Html bobswift
<ul>
<li> As String = Self, As Value = 1
<li> As String = Self/Children, As Value = 2
<li> As String = Children, As Value = 3
</ul>

Default is Self (1).

N

Anchor
name - SO
name - SO
name

Name

Name of a variable to override.


N


Anchor
notificationOption - SO
notificationOption - SO
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
notifyOnEarlyFinish - SO
notifyOnEarlyFinish - SO
notifyOnEarlyFinish

On Early Finish

Specification to generate the action if the task finishes early, based on the Early Finish Time specified in the task.

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

N


Anchor
notifyOnLateFinish - SO
notifyOnLateFinish - SO
notifyOnLateFinish

On Late Finish

Specification to generate the action if the task finishes late, based on the Late Finish Time specified in the task.

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

N


Anchor
notifyOnLateStart - SO
notifyOnLateStart - SO
notifyOnLateStart

On Late Start

Specification to generate the action if the task starts late, based on the Late Start Time specified in the task.

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

N


Anchor
notifyOnProjectedLate - SO
notifyOnProjectedLate - SO
notifyOnProjectedLate

On Projected LateGenerates the action if the task is projected to be late, based on the calculated Projected End Time and the Late Start Time, Late Start Duration, or Late Finish Time time option.Boolean; Valid values: true/false. Default is false.N

Anchor
operation - SO
operation - SO
operation

System Operation

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 = Run 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 - SO
overrideTriggerDateOffset - SO
overrideTriggerDateOffset

Override Date Offset

Override date offset.

Date Offset value of trigger to fire.

N
(unless overrideTriggerDateTime is true)

Anchor
overrideTriggerDateTime - SO
overrideTriggerDateTime - SO
overrideTriggerDateTime

Override Trigger Date/Time

Request parameter to enable/disable override functionality.

Boolean value (true / false).  Default is false.

N

Anchor
overrideTriggerTime - SO
overrideTriggerTime - SO
overrideTriggerTime

Override TimeOverride time.

Time of the trigger to fire.

Y
(if overrideTriggerDateTime is true)

Anchor
status - SO
status - SO
status

Status

Status of this task, by itself or together with an exit code, that will trigger this System Operation action. You can specify as many statuses as needed.


Y


Anchor
sysId - SO
sysId - SO
sysId

n/a

sys_id used within the Controller to identify this System Operation action.


N


Anchor
task - SO
task - SO
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 - SO
taskLimitType - SO
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 - SO
taskVar - SO
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 - SO
trigger - SO
trigger

Trigger Reference

If operation is Trigger Now, Enable Trigger, or Disable Trigger; Name of the trigger.


N

triggerVar

Anchor
triggerVar - SO
triggerVar - SO
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 - SO
value - SO
value

Value

Value of a variable to override.


N


Anchor
variables - SO
variables - SO
variables

Override Variables

List of variables to override.


N


Anchor
variablesUnresolved - SO
variablesUnresolved - SO
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
virtualResource - SO
virtualResource - SO
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 - SO
virtualResourceVar - SO
virtualResourceVar

Virtual Resource Variable

If operation is Set Virtual Resource Limit; Name of a variable that will be resolved at run time to the name of the Agent to use.


N

virtualResource