Setting a task notification

Notifications can be set for the following events:

• Processing status changes
• Excessive task latency
• Excessive memory usage
• Excessive disk usage
• Processing errors
• Other errors

To set a task notification:

1. Click the toolbar button on the right of the console.

   The Notification Rules window opens.

2. Click the Tasks tab and then click New.

   The New Task Notification wizard opens.

3. Provide a name for the notification.

4. Select a notification in one of the available categories and, where applicable, set the time/size threshold for sending the notification.

    

   Processing Status:

   • Task was started manually or by the Scheduler: To send the notification when the task is started manually or by the Scheduler.
   • Task was stopped manually or by the Scheduler: To send the notification when the task is stopped manually or by the Scheduler.
   • Task was stopped after Full Load: Cached changes were not applied: To send the notification when the task is stopped after Full Load completes but before cached changes (changes to the source tables that occurred during Full Load) are applied to the target.
   • Task was stopped after Full Load: Cached changes were applied: To send the notification when the task is stopped after Full Load completes and cached changes (changes to the source tables that occurred during Full Load) have been applied to the target.
   • Full Load started: To send the notification when the Full Load process starts.
   • Full Load completed: To send the notification when the Full Load process completes.

   Performance/Resources:

   • Latency is higher than [N] seconds

     Specify the desired threshold value and unit of measurement (seconds or minutes).

   • Memory usage exceeds [N] GB

     Specify the desired threshold value and unit of measurement (GB or MB).

   • Disk usage exceeds [N] GB

     Specify the desired threshold value and unit of measurement (GB or MB).

   Errors and Warnings:

   • Any Error: Select this to receive a notification when any error occurs in the system. Note that notification will not be sent for the following error types:
     • Recoverable errors. Recoverable errors are printed as INFO in the log (unless the task logging is set to TRACE, in which case they will be printed as ERROR).
     • Certain user-defined error handling policies. For example, if the Duplicate key when applying INSERT Apply Conflicts handling option is set to Log record to the exceptions table, no notification will be sent. However, if it set to Stop task, a notification will be sent.

   Setting this option may result in a large volume of notifications, depending on the number of tasks running and their current status. It is therefore recommended to define this notification for selected tasks rather than for all tasks.

   • Any Warning: Select this to receive a notification when a warning is issued in the system.
   • No changes were captured in the last <n> minutes: As this notification requires Replicate May 2022 or later, it will not be available if the monitored Replicate Server is an incompatible version. Select this notification if you want to be alerted about delays in capturing changes from the source database. With most databases, receiving this notification will usually indicate a connectivity problem. However, with the following databases, it could simply mean that no changes occurred during the specified period.
     • Microsoft SQL Server
     • IBM DB2 for LUW
     • IBM DB2 for iSeries

     When the task resumes capturing changes, a notification that change capture has resumed will be sent, and the notification timer will be reset.

   • Table processing was suspended due to errors: Select this to receive a notification when an error causes a table to stop processing during a full-load operation or suspend CDC. In this case, the table process stops, but the task continues.

   • Task stopped due to a non-recoverable error: Select this to receive a notification when an error that cannot be retried is returned and the task is stopped due to this error.

     Information note

     An additional notification will be sent when the Performance/Resource threshold returns to normal (where "normal" is 10% below the defined threshold).

   • Errors containing one of these codes

     When this option is selected, a notification will be sent whenever an error matching one of the specified error codes occurs. Error codes for tasks that ended with an error are shown in the Message Center. You can copy the desired codes from the Message Center and paste them into this field.

     Information note

     • Multiple error codes can be specified. In this case, error codes should be separated by a comma.
     • Error codes must contain numeric values only.

5. Click Next.

   The Associate dialog is displayed.

6. Choose whether to associate the notification with Selected Tasks or with All Current and Future Tasks.

   Note that when you complete the Task Notification wizard, the Associated with column in the Notification Rules window will display either Selected Tasks or All Current and Future Tasks depending on which of these options you selected.

   If you chose Selected Tasks, from the Server drop-down list, select All Servers or a specific server.

   Then, select the desired tasks using the arrow buttons in the middle of the screen (multiple selection is supported).

   Information note

   The Server drop-down list only displays servers:

   • That are monitored
   • For which the user who defines the notification has View permission

   The Tasks list only displays tasks:

   • That are running on monitored servers (that are not in an error state)
   • For which the user who defines the notification has View permission

7. Click Next.

   The Recipients dialog is displayed.

8. Notifications will always be displayed in the Message Center. If you also want the notification to be sent to the Windows Event Log and/or specified Email Recipients, select their respective check boxes.

   See also Replicate Event IDs in Windows Event Log.

   If you selected Email Recipients, specify a list of email recipients (separated by semi-colons) in the To, Cc and/or Bcc fields.

   Information note

   Sending notifications to email recipients requires your organization's outgoing mail server settings to be defined.

9. Click Next.

   The Message dialog displays a default email subject and email/Windows Event Log message for the selected notification. You can change the default subject and/or message and make use of any of the variables listed to the right of the message.

   Information note

   The message shown in the Message Center is system generated and cannot be edited.

10. Click Finish to add the notification to Enterprise Manager.

    A summary of the notification settings will be displayed in the Tasks tab in the Notification Rules window.

    Information note

    New notifications are always created as enabled and are active immediately without any need to stop/resume tasks.

Task notification variables

In addition to allowing you to edit the default messages, the Message window also provides a list of variables that you can insert into the notification message. These are described in the table below.

To insert a variable:

1. Select the desired variable.
2. Place the cursor in the message where you want the variable to be inserted.
3. Click the arrow to the left of the variable list.