All Products
Search

This Product

    Data Management:Integrate DMS into the internal approval flow of an enterprise

    Document Center

    Data Management:Integrate DMS into the internal approval flow of an enterprise

    Last Updated:Dec 15, 2025

    This topic describes how enterprises can use their internal approval flows to approve tickets related to databases in DMS.

    Note

    This solution is only applicable to instances in Security Collaboration mode. Instances in other modes do not require ticket approval for data changes.

    Background information

    To ensure enterprise production and data security, DMS has established an approval flow within its ticketing system. For example, when submitting a data change ticket, you can perform data change operations only after the ticket is approved.

    Most enterprises use their own approval flow systems. When submitting a data change ticket in DMS, enterprises need to coordinate between DMS and their internal approval flows. This not only affects usability but may also complicate subsequent audits.

    The solution in this topic helps enterprises integrate their internal approval flow with DMS to improve operational efficiency.

    Prerequisites

    • The control mode of the target database instance is Security Collaboration.

    • The following CIDR blocks of the DMS server is added to the IP whitelist of the server where the Webhook is located: 8.136.163.64/29, 116.62.200.158.

    Solution overview

    The solution is implemented by the following steps:

    1. Establish a dedicated approval flow.

      Create approval nodes and templates dedicated to enterprise personnel within DMS.

    2. Configure security rules.

      Associate the dedicated approval template with the security rules of the instance. Subsequent change operations on the instance must comply with the associated security rules.

    3. Configure the notification method of approval messages.

      Select the modules whose approval messages need to be notified and configure the Webhook address for receiving the messages.

    4. Submit a database ticket in DMS.

    5. Use the enterprise's internal flow to approve the ticket.

      When a user creates a new ticket in DMS and initiates the approval process, a message will be sent to the enterprise internal approval flow through the configured Webhook address.

    6. Perform data changes in DMS.

      After the ticket is approved, the user can continue to perform data change operations in DMS.

    Interaction diagram

    image

    1.Establish a dedicated approval flow

    1.1. Create a new approval node

    1. Log on to the DMS console V5.0.

    2. Move the pointer over the 2023-01-28_15-57-17.png icon in the upper-left corner and choose All Features > Security and disaster recovery (DBS) > Approval Processes.

      Note

      If you use the DMS console in normal mode, choose Security and disaster recovery (DBS) > Approval Processes in the top navigation bar.

    3. On the Approval Node tab, click Add Approval Node.

      Note

      If the target approver is already in the approval node, there is no need to add a new approval node.

    4. Configure the Node Name, Remarks, and Approver information, then click Submit.

    1.2. Create a new approval template

    1. On the Approval Template tab, click Create Approval Template.

      Note

      If there is already a related approval template, there is no need to add a new one.

    2. Configure the Template Name, Remarks, and Approval Node, then click Submit.

    2. Configure security rules

    1. Move the pointer over the 2023-01-28_15-57-17.png icon in the upper-left corner and choose All Features > Security and disaster recovery (DBS) > Security Rules.

      Note

      If you use the DMS console in normal mode, choose Security and disaster recovery (DBS) > Security Rules in the top navigation bar.

    2. Find the security rules associated with the target Security Collaboration instance, and click Edit in the Actions column corresponding to the rule.

      Note

      You can right-click the instance name in the database instance area on the left side of DMS and select View Details to view the security rules associated with the instance.

    3. Select the function that you want to configure the approval template, and then edit the rule.

      The following is an example of how to change the approval template for data changes:

      1. In the left navigation bar, click SQL Correct.

      2. Click Edit on the right side of the default approval template for data changes.

      3. Click Switch Approval Template, select the approval template you created, and click Submit.

    3. Configure the notification method of approval messages

    3.1. Enable module notifications

    1. Mover the pointer over the 2023-01-28_15-57-17.png icon in the upper-left corner and choose All Features > O&M > Notification.

      Note

      If you use the DMS console in normal mode, choose O&M > Notification in the top navigation bar.

    2. Select the module that needs to integrate internal approval flow, and turn on the function message notification switch.

    3.2. Configure user notifications

    In DMS, configure Webhook notifications for the target approver (the approver added in Step 1's approval node). When a user initiates a ticket approval request, DMS will send a message to the Webhook.

    For the operation of configuring Webhook notification method, see Use custom Webhook notifications and Configure personal information and notification method.

    4. Submit a database ticket in DMS

    For specific operations, see Data solution overview.

    5. Use the enterprise's internal flow to approve the ticket

    5.1. Clarify the event trigger conditions

    When the value of messageEvent.event in the POST message body sent by DMS to the Webhook is Pending Approval, it indicates that this message is triggered by an approval event. After clarifying the event trigger conditions, the enterprise can initiate an approval flow. Once the ticket is approved, operations requested in the ticket can be performed.

    5.2. Call an API to get approval flow ID

    Call the GetOrderBaseInfo API to obtain the approval flow ID corresponding to the ticket. You can get its request parameter OrderId is the value of the messageEvent.taskId field in the Webhook message body.

    5.3. Call an API to approve the ticket

    Call the ApproveOrder API to approve the ticket.

    6. Perform data change operations in DMS

    After the ticket is approved in the enterprise's approval flow, the state of the ticket changes to Agreed. The user can then perform the data change operations requested in the ticket in DMS.