Page Comparison

...

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:

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

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

	listReportFormat - E
	listReportFormat - E

listReportFormat

List Report Format

Report format.

Note
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

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

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.

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

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

JSON

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

Note
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 would could specify:

XML

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

JSON

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

or

XML

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

JSON

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

Note
Duplicate group visibility is prohibited and thus there should be only a single report (of the same title) visible to a particular group. Therefore, to look up a report visible to multiple groups, you can specify one or more of the visibility groups, as long as the report is visible to all of the specified groups.

To define a report reference for a report with Title XYZ that is visible to groups Operators, Finance, and Development;

You could specify any one of the visibility groups:

XML

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

JSON

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

Or you could specify multiple visibility groups:

XML

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

JSON

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

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

XML

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

JSON

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

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

...

Versions Compared

Old Version 3

New Version Current

Key