/
Task Action Properties

Task Action Properties

Jul 30, 2024

Abort Action

Property

UI Field Name

Description

Specifications

Required

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 Late

Generates 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

 

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

 

 listReportFormat

List Report Format

Report format.

 

If the attached report is not a List type report, this option will be ignored. 

Default is PDF (1).

Valid Values: 

  • As String = PDF, As Value = 1

  • As String = XML, As Value = 2

  • As String = JSON, As Value = 3

  • As String = CSV, As Value = 4

  • As String = TSV, As Value = 5

 

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 Late

Generates 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 one or more Groups, 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 specify a single visibility group, you can utilize either groupName or groupNames with only one groupName in the list. 

 

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

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

 
JSON

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

or 

XML

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