Creating a Notification for a task event

Use the New Notification wizard to create notifications for task-based events.

For changes to task notification settings to take effect, the task(s) needs to be stopped and resumed.

To create a notification for a task event

Launch the New Notification wizard as described in Creating a new notification.
In the Notification Name field, type a name for the notification.
Perform the following steps to define the notification:

Define the action that triggers the notification

In the Processing Status section of the Task Events page, you can determine the action that triggers the notification. If the Operator section is not displayed, click on the header with the word Operator to display the options for this section. Select one of the following:

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.

Once you determine when to send the notification, you can decide whether specific changes in status trigger the notification.

If you want to send a message about problems in latency, memory utilization, or disk utilization, click Performance/Resources. See Define which changes of status trigger the notification for an explanation.

If you want to send the notification when certain errors occur, click Errors. See Define errors or warnings that trigger the notification for an explanation.

Or you can click Next to Define the recipients.

Define which changes of status trigger the notification

In the Performance/Resources section of the Task Events page, you can define specific parameters for latency, disk utilization, or memory utilization that trigger a notification.

To set up notifications for latency, disk utilization, or memory utilization:

In the New Notification Wizard'sTask Events page, click Performance/Resources.
Select one of the following:
- Latency is higher than [N] seconds.
- Memory utilization exceeded [N] MB
- Disk utilization exceeded [N] MB
Define the value for the option you select. See the table below for an explanation on each of these options and how to set the value.

If you select one of these options, the notification is sent only when the selected parameter is true. However, you must also Define the action that triggers the notification.

Set Values for Latency, Disk Utilization, Memory Utilization
Notification	Set Value	Notes
Latency is higher than Value seconds	Click [N] and enter a value in the field that is displayed. Latency is the time interval in seconds between the time a change was committed in the source system and the time it is applied and committed in the target system.	-
Clear notification when latency drops below <n> seconds.	Use this to set the value that determines when latency returns to "normal limits." Click [N] and enter a value.	When latency is below the value entered in this field, it is considered to be in the "normal" range and the notification status ends. If selected, a notification is sent to indicate that latency returned to "normal" status. For more information, see Define the notification message.
Memory utilization exceeded Value MB	Click [N] and enter a value in the field that is displayed. Memory utilization is the amount of memory used by the task.
Clear notification when memory utilization is below <n> MB	Use this to set the value that determines when memory utilization returns to "normal limits." Click [N] and enter a value.	When memory utilization is below the value entered in this field, it is considered to be in the "normal" range and the notification status ends. For more information, see Define the notification message.
Disk utilization exceeded Value MB	Click [N] and enter a value in the field that is displayed. Disk utilization is the amount of disk space used. Set a value that indicates that the current amount of disk space used is problematic to running a replication task.
Clear notification when disk utilization is below <n> MB	Use this to set the value that determines when disk utilization returns to "normal limits." Click [N] and enter a value.	When disk utilization is below the value entered in this field, it is considered to be in the "normal" range and the notification status ends. For more information, see Define the notification message.

Once you determine the status changes that trigger a notification, you can decide whether specific errors trigger a notification.

If you want to send the notification when certain errors occur, click Errors. See Define errors or warnings that trigger the notification for an explanation.

Or you can click Next to Define the recipients.

Define errors or warnings that trigger the notification

In the Errors and Warnings dialog of the Task Events wizard, you can determine whether notifications are sent when an error occurs. You can determine whether to send the notification for all errors or only for specific error types.

To set up notifications for errors:

In the New Notification Wizard's Task Events dialog, click Errors and Warnings.
Select one of the following:
- Task was 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.
- 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.
- 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.
- 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: 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.

Once you determine the error types that trigger a notification, you can:

Define the action that triggers the notification, if you have not done this already.
Define which changes of status trigger the notification if you have not done this already.
Or you can click Next to Define the Recipients.

Define the recipients

Notifications are always displayed in Notifications tab in the Messages panel of the Replicate Console. In the Recipients page of the New Notification wizard, you can determine whether to also send the notification to Windows Event Log and/or email recipients.

To determine the notification recipients:

Select any of the following to determine the notification recipients:

Event log: Select this if you want the notification message to be written to the Windows/Linux Event log. For information on how to view the Windows/Linux Event log, see the online help for the version of Windows or Linux you are using.
Default notification email list: Select this option if you want to send an email message to the all the recipients on the Default Notification Email List. For more information, see Creating a Default Recipient List. To see the current list of default recipients, click Show List.
Custom email recipients: Select this option to send the email notification to specific recipients.

Then:
- Click the Add Recipient button.
  The Name field in the first available row in the list is activated.
- Type the name of the user that you want to receive the message.
  
  Information note
  If you click another part of the Replicate Console, the cell will become inactive. You can double-click the cell to enter additional information.
- Press the [tab] key or double click in the in the Email cell, then type the email address for the user you entered in the Name cell.
- Repeat the above to add more recipients.

When you have finished, click Next to Define the Notification Message.

Define the notification message

You can create a custom message for your notification. By default, a standard message is created based on your settings in the Task Events screen.

To create a notification message:

In the New Notification Wizard's, Message page, double-click in any of the table cells to open the Edit Notification Message dialog box. See the table below for an explanation of the information to enter in each field.
Click in the right pane of the dialog box and begin to type your message. In some cases a default message is displayed based on the information you entered in the previous pages of the New Notification Rule wizard. You can edit or delete the message, or create a new message to be sent with the notification in this dialog box.
Add variables in messages and email headers you define for notifications, if necessary. You can enter variables in one of two ways:
- Type a variable into the message pane on the right using the following format:
  
  {{<VARIABLE_NAME >}}
  
  For example: {{TASK_NAME}}.
- Use the variables from the left pane of the Edit Notification dialog box. To add a variable to the notification message, you can:
  
  Double-click the variable. The variable is inserted where your cursor is located in the notification message in the right pane.
  
  Select the variable you want to use and click the arrow key in the middle of the Edit Notification Message dialog box. The variable is inserted where your cursor is located in the notification message in the right pane.
  
  Drag the variable from the left pane to the location you want to place it in the notification message in the right pane.
  
  For more information, see the Supported notification variables.
Click OK to enter the message.

The following table describes how to enter the information in the Message page.

Creating a Notification Message
To where:	Notification On Message	Notification Off Message
This column describes where the message is sent. For more information, see Define the recipients.	The Notification On Message is sent when the replication task meets the conditions for the notification to be sent. For more information, see Define the action that triggers the notification, Define which changes of status trigger the notification, and Define errors or warnings that trigger the notification.	The Notification Off Message is sent when the replication task returns to its normal state. This type of message is sent for notifications about latency, disk utilization, and memory utilization. For more information, see Define which changes of status trigger the notification.
Console: The messages in this row are sent to the Qlik Replicate Console. They are displayed in the Messages section for a specific task. This section is displayed in: The Monitor for a specific task. For more information, see Accessing task messages and notifications. The right pane of the Tasks page. For more information, see Viewing specific tasks. This message is also sent to the Windows Event log if you select this option. For more information, see Define the recipients.	In this field, you can edit, change or delete the message that is sent to the Qlik Replicate Console when the replication task meets the conditions for the notification to be sent. Example: `[{{SERVER_NAME}}\{{NOTIFICATION_NAME}}]{{TASK_NAME}} replication task latency exceeds defined limits.` `Current latency is {{LATENCY}} seconds.` This message is sent to the console when latency reaches a value higher than the value you defined.	In this field, you can edit, change, or delete the message that is sent to the Qlik Replicate Console when the replication task returns to the normal range as you defined when you Define which changes of status trigger the notification This field is relevant only for notifications about latency, disk utilization, and memory utilization. Example: `Latency is back to normal, latency is {{LATENCY}} seconds` This message is sent when latency returns to within its normal limits.
Email Subject: This is the subject of the email messages sent for the notification. See Define the recipients for information about sending a notification as an email.	In this field, you can edit, change or delete the subject line for an email that is sent when the replication task meets the conditions for the notification to be sent. Example: `[{{SERVER_NAME}}\{{NOTIFICATION_NAME}}]{{TASK_NAME}} high latency notification` This is the subject for an email message sent when latency reaches a value higher than the value you defined.	In this field, you can edit, change or delete the subject line for an email that is sent when the replication task returns to the normal range as you defined when you Define which changes of status trigger the notification. This field is relevant only for notifications about latency, disk utilization, and memory utilization. Example: `Replicate notification '{{NOTIFICATION_NAME}}' for task '{{TASK_NAME}}'` This is the subject for an email message sent when latency returns to within its normal limits.
Email Message: This is the body of the email message sent for the notification. See Define the recipients for information about sending a notification as an email.	In this field, you can edit, change or delete the message that is sent by email when the replication task meets the conditions for the notification to be sent. Example: `The latency for replication task {{TASK_NAME}} exceeds defined limits.` `The current latency is {{LATENCY}} seconds.` `------------------------------------------------------------------` `This is an automated message generated by` `Qlik Replicate` `server {{SERVER_NAME}} for notification {{NOTIFICATION_NAME}}.` This is an email message sent when latency reaches a value higher than the value you defined.	In this field, you can edit, change, or delete the message that is sent by email when the replication task returns to the normal range as you defined when you Define which changes of status trigger the notification. This field is relevant only for notifications about latency, disk utilization, and memory utilization. Example `Latency is back to normal, latency is {{LATENCY}} seconds` This is an email message sent when latency returns to within its normal limits.
Event viewer	In this field, you can edit, change or delete the message that is sent to the Windows/Linux event viewer when the replication task meets the conditions for the notification to be sent. Note: This field is available only when you select Event log when you Define the recipients. Example: `[{{SERVER_NAME}}\{{NOTIFICATION_NAME}}]{{TASK_NAME}} high latency notification` `The latency for replication task {{TASK_NAME}} exceeds defined limits.` `The current latency is {{LATENCY}} seconds.` This message is sent to the event viewer when latency reaches a value higher than the value you defined.	-

After you define the message sent with the notification, click Next to associate tasks with the notification.

Associate tasks with the notification

By default, notifications are sent for all tasks that are defined in the Qlik Replicate instance you are using. You can determine whether to send the notification to specific tasks defined in the Qlik Replicate instance you are using. For example, you can define a different latency rate for a specific task that is replicating from a slow system.

To associate the notification with tasks:

In the New Notification Wizard's Associate page, select one of the following:
- All Tasks: To associate this notification with all tasks that are defined in the Qlik Replicate instance you are working with. In this case all tasks that were previously defined and any future task will be associated with this notification.
  
  If you choose to associate this notification with All Tasks, then click Next to review the notification rule.
- Selected Tasks: To associate this notification with one or more specific tasks only. Continue with the next step.
Select the check box next to any of the tasks you want to associate with this notification. You can select one or more tasks.

Information note
The Task check box at the top of the check-box column lets you select all of the tasks that are displayed. When you select this check box it is as if you select each of the tasks individually. Therefore, if you add tasks in the future they will not be included.
Click Next to Review the Notification Rule.

Review the notification rule

The Summary page lets you review the notification rule that you defined so that you can determine whether the selections you made in the wizard are correct. If you want to make changes, click Back and go to the page or pages you want to change.

When you are sure that the notification rule is defined in the way that you want, click Finish to close the wizard and add the rule to the notification list (seeThe Notifications List).

After you close the wizard, make sure to click Save at the top of the Settings page. This will save the information for all settings, not only for the notification rule that you created. If you made changes that you do not want to keep, click Discard to discard all changes before you make changes to any of the other settings.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here