Creating Email Notifications

From OpsWise Documentation Wiki

Open as PDF

Contents 1 Overview 2 Attaching an Email Notification to a Task 3 Email Notifications Field Descriptions

Overview

You can attach one or more email notifications to any OpsWise Automation Center task. For Workflow tasks, you can also specify whether you want the email instructions to apply to the workflow itself, the workflow and its tasks, or to the tasks only.

You can trigger the notification based on one or more of the following events associated with the task instance to which you attach 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

In order to generate Email Notifications, you need an Email resource definition, which provides the Email server name and other pertinent information.

Attaching an Email Notification to a Task

1. Display the task that will generate the email notification.
2. Click on the Actions tab, which displays a list of all defined actions, if any.
3. Click New. The Actions options displays:



4. Select Email Notification.



5. Using the field descriptions provided below as a guide, complete the fields as needed.
6. Click the Submit button to save the record and return to the Email Notifications list, or, right-click and select Save to save the record and remain on the current display.
7. If appropriate, repeat these steps for any additional email notifications you want to add.

Email Notifications Field Descriptions

The table below describes the fields and buttons on the Email Notifications screen.

Field Name	Description
Action Inheritance	Workflow tasks only. Specifies what records these instructions apply to. Options: SELF - These instructions apply only to the workflow. SELF/CHILDREN - These instructions apply to the workflow and its contained tasks (children). CHILDREN - These instructions apply only to the tasks within the workflow (children).
Status	The status of this task. To trigger an email notification, you can specify status only, or status and exit code. You can specify as many statuses as needed. Options: Defined - All task types. The new task instance has been created (the task has been launched). Not yet implemented. Waiting - All task types. The task has been loaded by a workflow and is waiting to run. Held - All task types. The task has been put on hold by a user. Resource Wait - The task with a virtual resource defined is waiting for enough units to become available on the virtual resource. Undeliverable - Agent-based tasks. The agent is unavailable. Queued - Agent-based tasks only. The task has been queued on a resource. Submitted - z/OS only. The task has been submitted to the z/OS Job Entry subsystem and scheduled by the z/OS Job Scheduler. Action Required - Manual tasks only. When a manual task launches, it goes into Action Required status, meaning a user must perform some manual activity. For details, see Manual task. Started - Agent-based and Manual tasks only. The task has started. For agent-based tasks, this means the agent has received the task. Running - All task types. The task is running. For agent-based tasks, the agent has started running the program. Running Problems - Workflows only. One or more tasks within the workflow has one of the following statuses: Held Undeliverable Running Problems (for sub-workflows) Cancel Pending In Doubt Start Failure Cancelled In Doubt - Agent-based tasks only. The agent is "in doubt" about the current status of the task instance. This may occur if an agent or agent connection goes down. In this case, the agent restarts and reviews its data about tasks in progress. If the agent finds a task still running, it resumes normal monitoring. If the agent cannot find the task, this usually indicates that the task completed, but the agent considers the task status to be "in doubt." Start Failure - All task types. The task was unable to start. Cancelled - All task types. The task was cancelled by a user. Failed - All task types. The task ran to a failure status. Skipped - All task types. The task was skipped by a user. Finished - All task types. The task was forced by the user to finish. The user may do this in cases where the task had "Cancelled" or "Failed" status, and the user needed to release other task instances depending on the successful completion of this task instance in a workflow. For more information, see Force Finishing a Task. Success - All task types. The task has completed successfully
Exit Codes	Specifies one or more exit codes that will trigger the email notification. If you specify an exit code, you must also specify at least one status. Use commas to separate multiple exit codes; use a hyphen to specify a range. Example: 1, 5, 22-30.
On Late Start	Generate the email notification if the task started late, based on the Late Start Time specified in the task.
On Late Finish	Generate the email notification if the task finishes late, based on the Late Finish time specified in the task.
On Early Finish	Generate the email notification if the task finishes early, based on the Early Finish Time specified in the task.
Email Template	Optional. The name of the Email template defined using the Email template screen. The Email template allows you to specify standard recipients and text for outgoing emails. Type in a name, or click the magnifying glass to browse to an existing Email template or create a new one. You must specify either an Email template or Email connection, or both.
Email Connection	Optional. The name of the Email server defined using the Email resource screen. Type in a name, or click the magnifying glass to browse to an existing Email server definition or create a new one. You must specify either an Email template or Email connection, or both.
Reply-To	Optional. Specifies the email address of the party identified as the sender of the notification, to whom the recipient can reply. Use commas to separate multiple email addresses.
To	Required. Specifies the email address of the recipient. Use commas to separate multiple recipients.
CC	Optional. Specifies the email address of the party being sent a copy of the email, if any. Use commas to separate multiple recipients.
BCC	Optional. Specifies the email address of the party being sent a blind (hidden) copy of the email, if any. Use commas to separate multiple recipients.
Subject	Optional. Specifies the subject line of the email.
Body	Optional. Contains the text of the email message. Variables supported.
Attach Standard Output	Attach any standard output generated by the associated task.
Attach Standard Error	Attach standard error data generated by the associated task.
Attach File	Attach a file create by the associated task.
Start Line	Attach data beginning at the line indicated.
Number of Lines	Limit the retrieved data to the number of lines specified. The default is 100. You can change the default in the record Configuration > Properties > Retrieve Output Default Maximum Lines.
Scan text:	Scan the data for the text specified and attach only that.
File Name	For Attach File only, the path and filename of the file you want to attach to the email notification.
Submit button	Submits the new record to the database.
Update button	Saves updates to the record.
Delete button	Deletes the current record.