Data Management (DMS) can send notifications about the status updates of tickets and task flows to specified user roles. You can use this feature by creating a notification rule. This topic describes how to manage notification rules.

Prerequisites

  • You are a database administrator (DBA) or a DMS administrator.
  • At least one notification method is configured for each of the recipients. For more information, see Notification method.

Background information

You may need to notify relevant staff of data or schema changes, the approval status of tickets, or the execution status of task flows.

In this case, you can use the notification feature of DMS. DMS supports a variety of notification methods, such as DingTalk notifications, text messages, emails, and DingTalk chatbot messages.

You can configure notification rules for the status updates of tickets or task flows as needed, and specify notification recipients accordingly. For more information about the status updates that are supported by the notification feature of DMS, see Supported status updates of tickets or task flows.

You can specify the following types of recipients when you configure a notification rule:
  • Default notification role: The system automatically selects a user role as the default notification recipient based on the status of tickets or task flows.

    For tickets that are pending approval, the default notification recipients are the users who need to approve the tickets. For tickets that are not pending approval and task flows that are created for task orchestration or data warehouse development, the default notification recipients are the users who submit the tickets or task flows.

  • Optional notification role: The system displays different user roles that you can select as recipients. The displayed user roles may vary based on the state that corresponds to the current tab.

    Optional notification roles include Author, Approver, Related Person, Data Owner, Instance DBA, DBA, Administrator, and Security Administrator.

  • Additional notification User: You can select other users under the current tenant as the notification recipients as needed.

    For example, if a developer changed a schema, big data developers must be notified of the change and perform required operations on the big data side in real time. This helps avoid report exceptions.

Create a notification rule

  1. Log on to the DMS console.
  2. In the top navigation bar, choose System Management > Notification.
  3. On the Notification page, click New in the upper-left corner.
  4. In the New global message notification dialog box, set the parameters as described in the following table.
    New global message notification dialog box
    Parameter Description
    Module / Business type The scenario to which the notification rule applies. You can apply the notification rule to tickets or task flows. If you want to apply the notification rule to tickets, you must select a ticket type. All ticket types are supported.
    Business status The one or more states for which you want DMS to send notifications. The valid values of this parameter vary based on the value of the Module / Business type parameter. For example, if you set the Module / Business type parameter to Task orchestration / Task Flow or Development of data warehouse / Task Flow, the valid values of this parameter are Successful Execution and Execution failed.
    Note If you select multiple states, multiple tabs appear. You must set the parameters on each tab that corresponds to a selected state.
    Notice copy The notification template for the selected state. DMS displays the notification template based on the value of the Module / Business type parameter and the state that corresponds to the current tab.
    Default notification role The default user role to which the notifications are sent. The value of this parameter cannot be modified.
    Optional notification role The one or more user roles to which the notifications are sent. DMS displays different user roles based on the value of the Module / Business type parameter and the state that corresponds to the current tab.
    Additional notification User The other one or more recipients of the notifications.
  5. Turn on Enable message notification.
    Note After you turn on this switch, this notification rule immediately takes effect. DMS starts to send notifications as configured. You can also turn on this switch later.
  6. Click Confirm.

Modify or delete a notification rule

  1. Log on to the DMS console.
  2. In the top navigation bar, choose System Management > Notification.
    Modify a notification rule.
    1. On the Notification page, find the notification rule that you want to modify and click Modify in the Operation column.
      Modify
    2. In the Modify global message notification dialog box, modify the parameters as required.
    3. Click Confirm.
    Delete a notification rule.
    1. On the Notification page, find the notification rule that you want to delete and click Delete in the Operation column.
    2. In the message that appears, click Confirm.
      Delete

Enable or disable multiple notification rules at a time

You can enable or disable multiple notification rules at a time.

  1. Log on to the DMS console.
  2. In the top navigation bar, choose System Management > Notification.
  3. On the Notification page, select the notification rules that you want to enable or disable.
  4. Click Batch enable or Batch disable at the top.
    Batch enable or Batch disable

Supported status updates of tickets or task flows

Feature Scenario Status update
Tickets Permission application The ticket is pending approval.
The ticket is rejected.
The ticket is approved.
Data change The precheck failed.
The ticket is to be submitted for approval.
The ticket is pending approval.
The ticket is rejected.
The ticket is approved.
The data change is successful.
The data change failed.
The task that is generated based on the ticket is pending scheduling.
The task that is generated based on the ticket timed out.
Data export The precheck failed.
The ticket is to be submitted for approval.
The ticket is pending approval.
The ticket is rejected.
The ticket is approved.
The data export is successful.
The data export failed.
Data tracking The system failed to retrieve binlogs.
The ticket is to be submitted for approval.
The ticket is pending approval.
The ticket is rejected.
The ticket is approved.
The binlogs are parsed.
The binlogs failed to be parsed.
Database cloning The ticket is pending approval.
The ticket is rejected.
The ticket is approved.
The data is copied from the source database to the destination database.
The data failed to be copied from the source database to the destination database.
Test data generation The ticket is pending approval.
The ticket is rejected.
The ticket is approved.
The test data is generated.
The test data failed to be generated.
Schema design The ticket is pending approval.
The ticket is rejected.
The ticket is approved.
The schema design is successful.
The schema design failed.
Table synchronization between databases The precheck failed.
The ticket is to be submitted for approval.
The ticket is pending approval.
The ticket is rejected.
The ticket is approved.
The tables are synchronized from the source database to the destination database.
The tables failed to be synchronized from the source database to the destination database.
Task orchestration Task flow The tasks in the task flow are run.
The tasks in the task flow failed.
Data warehouse development Task flow The tasks in the task flow are run.
The tasks in the task flow failed.