/
Task Action Properties

Task Action Properties

Abort Action

Property

UI Field Name

Description

Specifications

Required

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

description

Description

Description of this Abort action.


N

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

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

inheritance

Action Inheritance

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

Valid values:

  • As String = Self, As Value = 1
  • As String = Self/Children, As Value = 2
  • As String = Children, As Value = 3

Default is Self (1).

N

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

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

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

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

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

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

sysId

n/a

sys_id used within the Controller to identify this Abort action.


N

Email Notification Action

Property

UI Field Name

Description

Specifications

Required

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

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

attachLocalFile

Attach Local File

Specification for whether or not a local file is attached.

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

N

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

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

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

body

Body

Text of the email message.

Variables and functions are supported.

N

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

description

Description

Description of this Email Notification action.


N

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)

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)

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

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

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)

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

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

fileStartLine

Start Line

Integer; Starting line of the attached data.

Integer.

N

inheritance

Action Inheritance

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

Valid values:

  • As String = Self, As Value = 1
  • As String = Self/Children, As Value = 2
  • As String = Children, As Value = 3

Default is Self (1).

N

joblogNumLines

Number of Lines

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

Integer.

N

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

joblogStartLine

Start Line

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

Integer.

N

localAttachmentsPath

Local Attachments Path

Location of Local Attachments for the connected Node.


N

localAttachment

Local Attachment

Name of the file(s) to attach.


N

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

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

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

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

replyTo

Reply-To

Email address of the sender of the email.

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

N

report

Report

Report attached to this notification.

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

<report>
      <title>XYZ</title>
      <userName>john.doe</userName>
      <groupName />
</report>

 
JSON

"report": {
     "title": "XYZ",
     "userName": "john.doe",
     "groupName": null
  }

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

<report>
      <title>XYZ</title>
      <userName />
      <groupName>Operators</groupName>
</report>

 
JSON

"report": {
     "title": "XYZ",
     "userName": null,
     "groupName": "Operators",
  }

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

<report>
      <title>XYZ</title>
      <groupName />
      <userName />
</report>

 
JSON

"report": {
     "title": "XYZ",
     "userName": null,
     "groupName": null
  }

N

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

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

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

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

stderrStartLine

Start Line

Starting line of the attached stderr data.

Integer.

N

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

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

stdoutStartLine

Start Line

Starting line of the attached stdout data.

Integer.

N

subject

Subject

Subject line of the email.

Variables and functions supported.

N

sysId

n/a

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


N

to

To

Email address of the recipient.

Use commas to separate multiple recipients Variables and functions supported.

Y

Set Variable Action

Property

UI Field Name

Description

Specifications

Required

description

Description

Description of this Set Variable action.


N

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

inheritance

Action Inheritance

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

Valid values:

  • As String = Self, As Value = 1
  • As String = Self/Children, As Value = 2
  • As String = Children, As Value = 3

Default is Self (1).

N

notificationOption

System Notification

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

Valid values:

  • As String = -- None --, As Value = 0
  • As String = Operation Failure, As Value = 1
  • As String = Operation Success/Failure, As Value = 2
  • As String = Operation Success, As Value = 3

Default is Operation Failure (1).

N

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

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

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

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

status

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

sysId

n/a

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


N

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

variableScope

Variable Scope

Applies to variables associated with a task in a Workflow.

Valid values:

  • As String = Self, As Value = 1
  • As String = Parent, As Value = 2
  • As String = Top Level Parent, As Value = 3
  • As String = Global, As Value = 4

Default is Self (1).

N

variableValue

Value

Value of this variable.


N

SNMP Notification Action

Property

UI Field Name

Description

Specifications

Required

description

Description

Description of this action.


N

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

inheritance

Action Inheritance

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

Valid values:

  • As String = Self, As Value = 1
  • As String = Self/Children, As Value = 2
  • As String = Children, As Value = 3

Default is Self (1).

N

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

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

notifyOnLateStart

On Late Start

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