Versions Compared

Old Version 1

changes.mady.by.user Stonebranch

Saved on

compared with

New Version Current

changes.mady.by.user Stonebranch

Saved on

Key

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

...

In order to generate Email Notifications, there must be an Email connection defined, which provides the Email server name and other pertinent information.

Anchor
Notifications Based on Events
Notifications Based on Events

Notifications Based on Events

You can generate notifications based on one or more of the following events associated with the task instance of the task for which you create the notification:

  • Status or statuses of the task instance
  • Exit code(s) generated by the program (along with at least one status)
  • Late start
  • Early or late finish

Anchor
Notifications Based on Status
Notifications Based on Status

Notifications Based on Status

You also can generate notifications based on the status of:

...

Step 1

Display the Task Details of the task for which you are creating the Email Notification.

Step 2

Click the Actions tab. A list of any defined Actions for that task displays. 


Step 3

Click the  button that displays on the Email Notifications row. The Email Notification Details pop-up displays.
 Using the field descriptions, below, as a guide, complete the fields as needed. 



 
For Workflow tasks, the Email Notification Details includes the Action Inheritance field:
 

Step 5

Click the   button to save the record in the Controller database.

Step 6

If appropriate, repeat these steps for any additional Email Notifications you want to create.

Anchor
Email Notification Details Field Descriptions
Email Notification Details Field Descriptions

Email Notification Details Field Descriptions

The table below describes the fields and buttons that display in the Email Notification Details.

Field Name

Description

Anchor
Action Inheritance
Action Inheritance
Action Inheritance

Include Page
IL:Action Inheritance - 6.4.1
IL:Action Inheritance - 6.4.1

Anchor
Status
Status
Status

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

Anchor
Exit Codes
Exit Codes
Exit Codes

Include Page
IL:Exit Codes Trigger Actions
IL:Exit Codes Trigger Actions

Anchor
On Late Start
On Late Start
On Late Start

Include Page
IL:On Late Start
IL:On Late Start

Anchor
On Late Finish
On Late Finish
On Late Finish

Include Page
IL:On Late Finish
IL:On Late Finish

Anchor
On Early Finish
On Early Finish
On Early Finish

Include Page
IL:On Early Finish
IL:On Early Finish

Anchor
On Projected Late
On Projected Late
On Projected Late

Include Page
IL:On Projected Late
IL:On Projected Late

Anchor
Description
Description
Description

Description of this action.

Action Criteria

This section contains criteria for performing the action.

Anchor
Action Details
Action Details
Action Details

This section contains additional details about the action.

Anchor
Email Template
Email Template
Email Template

Include Page
IL:Email Template field
IL:Email Template field

Email Template Variable

Include Page
IL:Email Template Variable
IL:Email Template Variable

Anchor
Email Connection
Email Connection
Email Connection

Include Page
IL:Email Connection field - Outgoing - 6.4.2
IL:Email Connection field - Outgoing - 6.4.2

Anchor
Reply-To
Reply-To
Reply-To

Include Page
IL:Reply-To
IL:Reply-To

Anchor
To
To
To

Include Page
IL:To-Email Task
IL:To-Email Task

Anchor
CC
CC
CC

Include Page
IL:CC-Email Task
IL:CC-Email Task

Anchor
BCC
BCC
BCC

Include Page
IL:BCC-Email Task
IL:BCC-Email Task

Anchor
Subject
Subject
Subject

Include Page
IL:Subject-Email
IL:Subject-Email

Anchor
Body
Body
Body

Include Page
IL:Body-Email
IL:Body-Email

Anchor
Report Field - Email Action
Report Field - Email Action
Report

Report to attach to this notification.

Anchor
Report Variable - Email Action
Report Variable - Email Action
Report Variable

Include Page
IL:Report Variable - Email Action
IL:Report Variable - Email Action

Anchor
List Report Format
List Report Format
List Report Format

Report format

Options: 

  • PDF
  • XML
  • JSON
  • CSV
  • TSV
Note

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


Anchor
Attach Local File
Attach Local File
Attach Local File

Include Page
IL:Attach Local File - Email Notification
IL:Attach Local File - Email Notification

Anchor
Local Attachments Path
Local Attachments Path
Local Attachments Path

Include Page
IL:Local Attachments Path
IL:Local Attachments Path

Anchor
Local Attachment
Local Attachment
Local Attachment

Include Page
IL:Local Attachment
IL:Local Attachment

Anchor
Attach Standard Output
Attach Standard Output
Attach Standard Output

Include Page
IL:Attach Standard Output
IL:Attach Standard Output

Anchor
Attach Standard Error
Attach Standard Error
Attach Standard Error

Include Page
IL:Attach Standard Error
IL:Attach Standard Error

Anchor
Attach Remote File
Attach Remote File
Attach Remote File

Include Page
IL:Attach File
IL:Attach File

Anchor
Attach Job Log
Attach Job Log
Attach Job Log

For z/OS tasks only; attach any job logs generated by the associated task.

Anchor
Start Line
Start Line
Start Line

Include Page
IL:Start Line
IL:Start Line

Anchor
Number of Lines
Number of Lines
Number of Lines

Include Page
IL:Number of Lines - Email Notification
IL:Number of Lines - Email Notification

Anchor
Scan Text
Scan Text
Scan Text

Include Page
IL:Scan Text - Email Notification
IL:Scan Text - Email Notification

Anchor
File Name
File Name
File Name

Include Page
IL:Attach File Name
IL:Attach File Name

Buttons

This section identifies the buttons displayed above and below the Action Details that let you perform various actions.

Save

Saves a new Action record in the Controller database.

Save & New

Saves a new record in the Controller database and redisplays empty Details so that you can create another new record.

Save & View

Saves a new record in the Controller database and continues to display that record.

New

Displays empty (except for default values) Details for creating a new record.

Update

Include Page
IL:Update button
IL:Update button

Delete

Include Page
IL:Delete button
IL:Delete button

Refresh

Refreshes any dynamic data displayed in the Details.

Close

Closes the Details pop-up of this action.

Anchor
Report Variable Resolution
Report Variable Resolution

Report Variable Resolution

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.

...