Create a Notification Rule for a Process

When you are beginning to use a new process, you can create notification rules for all possible events. As the process stabilizes over a number of successful executions, you may choose to remove some of the notifications. For stable processes, retain at least the failed notification.

Steps:

  1. From Data Integration Console, click Projects to open the Projects page.
  2. Click the name of the project where you want to create a notification rule.
  3. Locate the process schedule for which you want to create a notification rule, and click No notification rules.

    If the process already has notification rules, the link reads x notification rules.
    The dialog for managing notification rules opens.
  4. Click Add notification rule.
  5. In the Send email to field, enter a valid email address or alias.

    You can configure only one recipient address per notification rule. Some legacy notifications may include references to multiple recipients. Modify these notifications through the gray pages. For more information, see Modifying Multiple Recipients of Notifications through Gray Pages.

  6. From the drop-down, select the event that triggers the notification:
    • success: A notification is sent upon successful completion of the process.
    • failure: A notification is sent if the process fails to complete. You can specify the number of consecutive failures after which a notification should be sent. The maximum number is 30. For more information about automatic retry of a failed process, see Configuring Automatic Retry of Failed Processes.
    • process scheduled: A notification is sent if the process has been added to the queue for execution. Typically, the time between this event and the process started event is very short.
    • process started: A notification is sent when the process begins execution.
    • custom event: You can define specific events that are custom to the specific project. For more information on defining custom events, see Creating Custom Notification Events.
  7. In the Subject field, enter a meaningful text message. This message should indicate that the event occurred.

  8. In the Message field, provide sufficient descriptive information so that the recipient knows the name and type of event that occurred, the project in which it occurred, a start time, and an end time.

    You can insert variables into the subject or the body of the message. The list of available variables varies depending on the selected event. For example:
    {$params.USER_EMAIL}

    When the email is generated, these strings are replaced with the corresponding values from the process. For an example of using these variables in an error notification, see Example Notification Message.

  9. Click Save.
    The notification rules is saved.
  10. Click Close.
    The dialog for managing notification rules closes.
    The number of notification rules set for the process is updated.

Example Notification Message

The following is an example notification message. You can use it for configuring a notification when a process failed to execute.

Note that the load of the GoodData project (id =${params.PROJECT}) using process "${params.PROCESS_NAME}", graph ${params.GRAPH} that started at ${params.START_TIME} failed at ${params.FINISH_TIME} with following error:

${params.ERROR_MESSAGE}

Inspect the ${params.LOG} for more details.