DataWorks:Configure check items

Prerequisites

Optional: Create an extension. If the default check items provided by data governance do not meet your requirements, you can register a custom extension as a new check item. This adds the custom extension to the check scope. For more information, see Develop and deploy an extension: Function Compute.

Background information

Data governance automatically generates a list of initial check items. You can enable or disable each check item as needed. If the default check items do not meet your requirements, you can register a custom extension as a new check item.

Data governance uses check items and governance items to detect issues that require administration during the data development process. The check timing and content differ between check items and governance items.

• Check items: Used for governance and control before a task is deployed. They primarily check for compliance before deployment, block deployments that have issues, and prevent the introduction of new governance issues.

• Governance items: Used for analysis after a task is deployed. They detect existing issues in the system that need to be optimized to improve the overall health of the data.

This topic describes how to use check items:

• Register a check item (Optional)

• Enable a check item

• Configure a check item

• Perform batch operations on check items

• Example of a check item trigger

Permission management

• To register, enable, or disable check items, you must have one of the following permissions:

  • Alibaba Cloud account

  • Workspace member with AliyunDataWorksFullAccess permissions

  • Workspace administrator

  • Workspace member with tenant-level data governance administrator permissions

  • Workspace-level data governance administrator

• Regular users can only view the list of check items in their DataWorks workspace.

Go to the check item configuration page

1. Go to the Data Asset Governance page.

   Log on to the DataWorks console. In the top navigation bar, select the desired region. In the left-side navigation pane, choose Data Governance > Data Asset Governance. On the page that appears, click Go to Data Asset Governance.

2. In the navigation pane on the left, click System Settings > Governance Settings > Check Item to go to the Configure Check Item page.

Register a check item (Optional)

If the initial check items do not meet your needs, you can click Register Check Item to register a check item using a custom extension. This adds the check item to the detection scope. After registration, you must enable the check item in the check item list for it to take effect.

Enable a check item

After a check item is enabled, data governance checks procedures such as task execution and deployment. A failed check can block the deployment process, intercept existing problems, and prevent the introduction of new governance issues. You can enable specific check items for a workspace as needed.

Configure a check item

On the Check Item Settings page, you can view information about the check items for a specified workspace under the current account. The information is organized by dimensions such as development, storage, computing, quality, and security. You can also configure the status and parameters for each check item.

The main configurations are described as follows:

• Set effective check procedures: Configure whether to check files before procedures such as code execution and deployment. A failed check blocks the subsequent process.

• Set check item parameters: Configure parameters such as access restrictions and maximum running costs. The available parameters vary by check item.

Perform batch operations on check items

To enable or disable multiple check items at a time, you can perform batch operations as shown in the following figure.

Example of a check item trigger effect

If a check item is enabled, a check is triggered in DataStudio when you click Run or Deploy. The system performs the check based on the defined logic of the check item. You can go to the Operation Check interface to view the file check status and click the status to view the validation details. If the check fails, a blocking problem event is generated, which stops the process.