AX2543

Setting up notifications for jobs

Scheduler can be configured to send an email notification when a job completes, or when a job has errors. In order for an email notification to be sent for a particular job, the following must be set up:

• The job must be configured to send a notification on completion or error. The notification settings must include valid To and From email addresses (or use system variables).
• The System.SMTPMessageDelivery system job must be configured with a valid SMTP server for your environment. For more information, see Configuring Scheduler system jobs.

When a job creates an email notification, the notification is first saved to the database. When notifications are detected in the database, the System.SMTPMessageDelivery system job is triggered to deliver the notifications.

To configure a job to send email notifications:

1. In the Scheduler dialog, open a job to edit or create a new job.

2. In the left-hand side of the job, select Notification.

3. In the Job Notification Level section, select one of the following:

   • Send all email notifications: (Default) An email notification is always sent when the job is executed, regardless of the job status (success, failure, aborted, etc.).

   • Send email notification only when the job has errors: An email notification is only sent if the job experiences errors. If the job completes successfully with no errors, no email notification is sent.

   • None: No email notifications are sent for this job. The only way to check the status of the job execution is to view the job history.

   • Send email notification to different email addresses when the job has errors or succeeds: This option works the same way as Send all email notifications, except that a separate email address can be specified to receive the error notifications.

4. In the Notification Message Content section, complete the following for the notification email:

   Item	Description
   To	The email address(es) to receive the notification email. Separate multiple addresses with a semicolon. For example: To send the email to two recipients, enter the addresses such as: jdoe@company.com;dsmith@company.com To use a Scheduler job variable to define a notification recipient, enter the variable name with curly brackets. You can combine regular email addresses and variables, such as: {JobOwner.EmailAddress}; jdoe@company.com By default, the notification is configured to be sent to the user who executed the job, using the variable {CurrentUser.EmailAddress}. The entries in the To field must be valid email addresses, or Scheduler job variables that will resolve to valid email addresses. Currently, it is not supported to list user or role names, or to look up email addresses from Axiom Security. NOTE: When using Send email notification to different email addresses when the job has errors or succeeds, this user will be notified if the job completes successfully (including partial success), but not if the job fails. Job failure notifications are sent to the To (on error) recipients.
   From	The email address that the message is sent from. This can be something like axiomscheduler@company.com, so that the recipient can easily tell that the message has been generated by Scheduler. By default, this is set to the Scheduler "from" email address as defined in the system configuration settings, using the system variable {Scheduler.FromEmailAddress}. NOTE: For installations that are using subsystems, the system variable {Scheduler.FromEmailAddress} may resolve to a subsystem administrator email address instead of the Scheduler "from" email address.
   Subject	The subject of the message. By default, this is set to "Axiom Scheduler Notification."
   User Message	Optional body text for the email. This text is included in addition to the Scheduler auto-generated text regarding the job status.

   If Send email notification to different email addresses when the job has errors or succeeds is enabled, the following additional options are available:

   Item	Description
   To (on error)	The email address(es) to receive the notification email when the job result is Failed. Separate multiple addresses with a semicolon. This user only receives a notification if the job fails. If the job result is Success or Partial Success, this user will not receive a notification (only the To user will).
   Subject (on error)	The subject of the job failure message. By default, this is set to "Axiom Scheduler Notification."

   Job variables can be used in all notification settings.

Application notifications for Scheduler jobs that are run manually

If you run a Scheduler job manually, you can receive a notification within the application to let you know the status of the job. This notification will display in the Notifications task pane of the Desktop Client General term for using either the Excel Client or the Windows Client, both of which are installed to the user's desktop., and in the Notifications panel of the Web Client. This notification works as follows:

• The in-application notification is only sent if the Scheduler job is run manually using the Run Now option in Scheduler (or by using an equivalent "run now" action within a product-specific web page). In-application notifications are not sent if the job is run via a scheduling rule or an event handler.

• The in-application notification honors the Notification settings defined for the job to determine whether the notification is sent. For example, if the job is set to None, then the in-application notification is not sent. If the job is set to Send all email notifications, then both an email notification and an in-application notification will be sent when the job completes.

• The in-application notification only reports the status of the job—success, failure, or partial success. It does not contain any error or success details, and does not include any messaging as defined in the Notification settings for the job. For more information, view the job results within the Scheduler dialog in the Desktop Client, or the Scheduler page of the Web Client.

• The in-application notification is always sent to the user who ran the job manually.

NOTE: If the job is configured to Send email notification to different email addresses when the job has errors or succeeds, this is treated as Send all email notifications for purposes of sending the in-application notification. The user who ran the job will be notified when the job is completed, regardless of the job status.

Example success notification