Overview
You can create one or more Email Notifications for any Universal Controller task. For workflow tasks, you can also specify whether you want the email to be triggered by the workflow itself, the workflow and/or its tasks, or by the tasks only.
In order to generate Email Notifications, there must be an Email connection defined, which provides the Email server name and other pertinent information.
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
Notifications Based on Status
You also can generate notifications based on the status of:
Creating an Email Notification
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 New button that displays on the Email Notifications row. The Email Notification Details pop-up displays. |
Step 4 | Using the field descriptions, below, as a guide, complete the fields as needed. |
Step 5 | Click a Save 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. |
Email Notification Details Field Descriptions
The table below describes the fields and buttons that display in the Email Notification Details.
Field Name | Description |
|---|---|
Action Inheritance | Unable to render {include} The included page could not be found. |
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. |
Exit Codes | Unable to render {include} The included page could not be found. |
On Late Start | Unable to render {include} The included page could not be found. |
On Late Finish | Unable to render {include} The included page could not be found. |
On Early Finish | Unable to render {include} The included page could not be found. |
On Projected Late | Unable to render {include} The included page could not be found. |
Description | Description of this action. |
Action Criteria | This section contains criteria for performing the action. |
Action Details | This section contains additional details about the action. |
Email Template | Unable to render {include} The included page could not be found. |
Email Template Variable | Unable to render {include} The included page could not be found. |
Email Connection | Unable to render {include} The included page could not be found. |
Reply-To | Unable to render {include} The included page could not be found. |
To | Unable to render {include} The included page could not be found. |
CC | Unable to render {include} The included page could not be found. |
BCC | Unable to render {include} The included page could not be found. |
Subject | Unable to render {include} The included page could not be found. |
Body | Unable to render {include} The included page could not be found. |
Report | Report to attach to this notification. |
Report Variable | Unable to render {include} The included page could not be found. |
Attach Local File | Unable to render {include} The included page could not be found. |
Local Attachments Path | Unable to render {include} The included page could not be found. |
Local Attachment | Unable to render {include} The included page could not be found. |
Attach Standard Output | Unable to render {include} The included page could not be found. |
Attach Standard Error | Unable to render {include} The included page could not be found. |
Attach Remote File | Unable to render {include} The included page could not be found. |
Attach Job Log | For z/OS tasks only; attach any job logs generated by the associated task. |
Start Line | Unable to render {include} The included page could not be found. |
Number of Lines | Unable to render {include} The included page could not be found. |
Scan Text | Unable to render {include} The included page could not be found. |
File Name | Unable to render {include} The included page could not be found. |
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 | Unable to render {include} The included page could not be found. |
Delete | Unable to render {include} The included page could not be found. |
Refresh | Refreshes any dynamic data displayed in the Details. |
Close | Closes the Details pop-up of this action. |
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.
Accordingly, the following applies regarding Report Variable field resolution.
Once resolved, the Report Variable field value could match multiple Reports with the same Title, but with different visibilities. Therefore, there is an order of precedence to choosing the report by Title:
- User visibility (execution user).
- Group visibility (execution user's groups).
- Everyone visibility.
- Any other report(s). (This is applicable only in the case of an administrator who can view all reports.)
If the execution user belongs to more than one Group, and there is more than one report matching the Title visible to those Groups, the first report found will be chosen.
If multiple reports are found by resolved report Title, the following will be logged:
If the resolved report Title does not match any report visible to the execution user, the notification will be delivered containing the following error message:
If the report variable cannot be resolved, the notification will be delivered containing the following error message:
A Report Variable that resolves to blank implies that no report should be included. This is not considered an error; the notification will proceed as normal.