Related Documentation › Set Up an Email Notification in the Application

Set Up an Email Notification in the Application

If you want the email notification to apply to all jobs in the Application, set up the email notification in the Application.

Follow these steps:

1. Open the Application in the Define perspective.

   The Application appears in the workspace.

2. Right-click the Application in the Application Workspace view, and select Properties from the pop-up menu.

   The Basic page of the Application properties dialog opens.

3. Click Notifications in the left pane.

   The Notifications page opens in the right pane.

4. Select the Email tab and click New.

   The New Email Notification dialog opens.

5. Complete the following fields as appropriate:

   Return code

   (Optional) Specifies an exit code to send the notification on a more specific condition.

   Note: This field applies to only Complete and Fail monitor states.

   Monitor states

   Specifies the job states you can monitor.

   To

   Specifies the recipient's email address.

   Note: After you specify an email address, you must click Add to add the email address to your notification. You can add multiple email addresses.

   Subject

   (Optional) Specifies a customized email subject.

   Notes:

   • To insert the default subject, select the Use default subject check box. The administrator can edit the default subject by modifying the default email template in the Admin perspective.
   • To specify a customized email subject, clear the Use default subject check box. You can insert Application- and job-level built-in symbolic variables into the subject line by right-clicking in the field and selecting the symbolic variable you want to insert from the drop-down menu.

   Message

   (Optional) Adds a customized message to the email.

   Notes:

   • To insert the default message, select the Use default message option button. The administrator can edit the default message by modifying the default email template in the Admin perspective.
   • To add to the default message, select the Attach to default message option button and enter your message. To specify a customized message or override the default message, select the Override default message option button and enter your message. You can insert Application- and job-level built-in symbolic variables into the message by right-clicking in the text box and selecting the symbolic variable you want to insert.

   Attach spool file

   (Optional) Attaches the job's spool file to the email notification.

   Notes:

   • The administrator can configure a shared parameter to limit the size of spool file attachments in email when providing email notifications for failed jobs. For more information about server shared parameters, see the Admin Perspective Help.
   • Not all job types support the Attach spool file option.

6. Click OK.

   The New Email Notification dialog closes.

7. Click OK.

   The server sends an email notification whenever a job in the Application reaches the monitor state you specified.

Example: Send an Email Notification When a Job Fails or Has an Error

Suppose that you want to send an email notification to operator1@yourcompany.com and operator2@yourcompany.com when a job in the Application fails or has a monitoring or submission error.

To send an email notification when a job fails or has an error

1. Open the New Email Notification dialog.
2. Select the Failed and Suberror monitor states.
3. Enter operator1@yourcompany.com,operator2@yourcompany.com in the To field and click Add.
4. Clear the Use default subject check box and enter Job has failed in the Subject field.
5. Select the Use default message option button.
6. Select the Attach spool file check box and click OK twice.

   The server sends an email notification if a job in the Application fails or has a monitoring or submission error.