You are here: How To Guides > Job Notifications

Job Notifications

A Job may be configured to send a notification email to a user, a number of specific users, or a whole group of users, each time the job completes execution.

This is useful so that operators of the OEDQ system can monitor and check the status of scheduled jobs without having to log on to OEDQ.

To configure a job notification, open the job and click on the envelope icon on the job toolbar:

You can then select which users and/or groups to send the notification to. Note that only users with valid email addresses configured in User Configuration will receive emails.

Emails will also only be sent if valid SMTP server details have been specified in the mail.properties file in the notification/smtp subfolder of the server config directory. See Configuring Email Notifications for more details. The same SMTP server details are also used for Issue notifications.

The job notification contains summary information of all tasks performed in each phase of a job, as follows:

Snapshot Tasks

The notification displays the status of the snapshot task in the execution of the job. The possible statuses are:

STREAMED - the snapshot was optimized for performance by running the data directly into a process and staging as the process ran
FINISHED - the snapshot ran to completion as an independent task
canceled - the job was canceled by a user during the snapshot task
WARNING - the snapshot ran to completion but one or more warnings were generated (for example, the snapshot had to truncate data from the data source)
ERROR - the snapshot failed to complete due to an error

Where a snapshot task has a FINISHED status, the number of records snapshotted is displayed.

Details of any warnings and errors encountered during processing are included.

Process Tasks

The notification displays the status of the process task in the execution of the job. The possible statuses are:

FINISHED - the process ran to completion
canceled - the job was canceled by a user during the process task
WARNING - the process ran to completion but one or more warnings were generated
ERROR - the process failed to complete due to an error

Record counts are included for each Reader and Writer in a process task as a check that the process ran with the correct number of records. Details of any warnings and errors encountered during processing are included. Note that this may include warnings or errors generated by a Generate Warning processor.

Export Tasks

The notification displays the status of the export task in the execution of the job. The possible statuses are:

STREAMED - the export was optimized for performance by running the data directly out of a process and writing it to the data target
FINISHED - the export ran to completion as an independent task
canceled - the job was canceled by a user during the export task
ERROR - the export failed to complete due to an error

Where an export task has a FINISHED status, the number of records exported is displayed.

Details of any errors encountered during processing are included.

Results Book Export Tasks

The notification displays the status of the results book export task in the execution of the job. The possible statuses are:

FINISHED - the results book export ran to completion
canceled - the job was canceled by a user during the results book export task
ERROR - the results book export failed to complete due to an error

Details of any errors encountered during processing are included

External Tasks

The notification displays the status of the external task in the execution of the job. The possible statuses are:

FINISHED - the external task ran to completion
canceled - the job was canceled by a user during the external task
ERROR - the external task failed to complete due to an error

Details of any errors encountered during processing are included

Example notification

The screenshot below shows an example notification email using the default email template: