How to set up an approval process for data tracking tickets on DMS - Data Management

This topic describes how to configure the approval workflow for data tracking tickets.

Key concepts

Checkpoint

When a data tracking ticket is submitted, the system validates the ticket against the rules of the relevant checkpoint.

Basic configuration item: Specifies the Default Approval Template for Data Tracking. If no approval workflow is specified in Approval rule validation, the system uses this default approval template. You can change the approval workflow of the default template. For more information, see Modify the default approval template.
Approval rule validation: The system processes data tracking tickets based on the rules defined in Approval rule validation. You can use the rules from the security rule template library or create custom rules. For more information, see Add a new rule.

Factors and actions

Factor: A factor is a built-in system variable that provides context for security rule validation, such as the SQL type and affected rows. All factors start with the prefix @fac., followed by the factor name. Each module provides different factors for different checkpoints. The following table describes the factor for data tracking.

Factor	Description
@fac.log_size	The size of the logs involved in the tracking task, in MB. Warning Excessive log sizes can consume significant database server bandwidth and affect online services.

Action: An action is a behavior that the system performs when the conditions of an if statement are met. Examples include prohibiting ticket submission, selecting a workflow, allowing execution, or denying execution. Actions define the primary purpose of a security rule. All action names start with the prefix @act., followed by the action name. Each module provides different actions for different checkpoints. The following table describes the actions for data tracking.

Action	Description
@act.forbid_submit_order	Prohibits ticket submission. Usage: `@act.forbid_submit_order 'Reason for prohibition'`.
@act.do_not_approve	Specifies the approval template ID. For more information, see Set up an approval workflow.
@act.choose_approve_template
@act.choose_approve_template_with_reason

Template library

Security rules include a large library of rule templates that you can enable directly or customize to meet your specific needs. The following table describes the template for data tracking.

Checkpoint	Template
Approval rule validation	Data Tracking Approval Process

Modify the default approval template

Log in to DMS 5.0.
Move the pointer over the 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.
On the Security Rules tab, find the target rule set and click Edit in the Actions column.
In the left-side navigation pane of the Details page, click Database Development > Data Tracking.
On the Data Tracking tab, click Basic Configuration Item.
Find Data Tracking Default Approval Template and click Edit in the Actions column.
In the Edit Configuration Item dialog box, click Switch Approval Template.
Find the target template by its Template Name and click Select in the Actions column.

Note
You can also click Reset to Approval-free to have tickets skip the approval step.
Click Submit.

Add a new rule

Log in to DMS 5.0.
Move the pointer over the 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.
On the Security Rules tab, find the target rule set and click Edit in the Actions column.
In the left-side navigation pane of the Details page, click Database Development > Data Tracking.
On the Data Tracking tab, click Add Rule. In the Checkpoint area, select the Basic Configuration Item tab.

In the Add Rule - Data Tracking dialog box, set the following parameters:

Parameter	Description
Checkpoint (Required)	Select the checkpoint for the new rule. The approval rule validation checkpoint is available for data tracking.
Template Database (Optional)	The security rule template library provides many rule templates. After you select a Checkpoint, you can load a rule template from the Template Database as needed. For a list of available templates, see Template library.
Rule name (Required)	Enter a custom name for the rule. Note If you select a rule template from the Template Database, the system automatically populates this parameter.
Rule DSL (Required)	Enter the rule DSL. For more information about the DSL syntax, see Security rule DSL syntax. Note If you select a rule template from the Template Database, the system automatically populates this parameter.

Click Submit.
By default, the new rule is in the Disabled state. In the rule's row, click Enable in the Actions column.
In the dialog box, click OK.