Check items are used to check files for violations against constraints before files are deployed. Before files are deployed, check items are used to check whether data in the files violates the constraints that are specified for data development. If the system detects that the data violates the constraints, a check event is generated and blocks the subsequent data development process. You can handle issues that are related to the check event. This way, the data development process can be executed as expected. This topic describes how to view and configure check items.
Prerequisites
Optional. An extension is created. If the default check items provided in Data Asset Governance do not meet your business requirements, you can use the desired custom extension to register a check item and use the custom extension as a check item. For information about how to create an extension, see Develop and deploy an extension based on Function Compute.
Background information
Data Asset Governance automatically generates initial check items by default. You can enable or disable each initial check item based on your business requirements. If the default check items do not meet your business requirements, you can register a custom extension as a check item that you need.
Data Asset Governance allows you to use check items and governance items to detect issues that may occur in the data development process. The check time and check content of check items and governance items vary based on the procedure in which they are triggered.
Check items are used to manage and govern data before a node is deployed. Check items are used to detect violation of rules that a node must abide by before the node is deployed. If the node fails the check, a related check event is generated to block the node deployment procedure and prevent governance issues.
Governance items are used to analyze data after a node is deployed. Governance items can detect issues that need to be resolved and optimized in DataWorks to improve the data health.
DataWorks provides workspaces in standard mode and workspaces in basic mode. The node development process varies based on the mode of a workspace. For more information, see Differences between workspaces in basic mode and workspaces in standard mode.
This topic describes how to use check items in the following sections:
Permission management
Only the following users or roles can register a check item or enable or disable a check item:
Alibaba Cloud account
Workspace member to which the
AliyunDataWorksFullAccesspolicy is attachedWorkspace administrator
Workspace member to which the tenant-level data governance administrator role is assigned
Workspace-level data governance administrator
A common user can only view the check items of the DataWorks workspace to which the user belongs.
Go to the Configure Check Item page
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 . On the page that appears, click Go to Data Asset Governance.
In the left-side navigation pane, choose . The Configure Check Item page appears.
(Optional) Register a check item
If the initial check items do not meet your business requirements, you can click Register Check Item in the upper-right corner of the Configure Check Item page and use a custom extension to register a check item. After the registration is complete, you must enable the check item in the check item list. The check item takes effect only after it is enabled.
Among all initial check items, the check items that are used to check code logic take effect only for ODPS SQL nodes. If you enable this type of initial check item, only ODPS SQL nodes can trigger the check. You can register check items to check for other types of issues based on your business requirements.
Enable a check item
After you enable a check item, Data Asset Governance can check for issues that may occur when an operation such as node running or node deployment is performed. If the node fails the check, a related check event is generated to block the node deployment procedure and prevent governance issues. You can enable check items for specified workspaces based on your business requirements.
If you disable a check item in a workspace, the check item does not take effect only in the workspace.
Configure a check item
On the Configure Check Item page, you can view information about check items in a specific workspace for the current logon account from different dimensions, such as R&D, storage, computing, quality, and security. You can enable or disable the check items and configure parameters for the check items.
Take note of the following items during the configuration:
Procedures for check: You can specify the procedures, such as file running and deployment, for which a check item takes effect. If the file fails the check, a related check event is generated to block the subsequent procedures.
Parameters for a check item: You can configure parameters for a check item. The parameters are related to limits on access or upper limit of the running costs. The parameters that you can configure vary based on the check item. You can view the parameters in the Check Item Settings dialog box.
Manage multiple check items at the same time
If you want to enable or disable a large number of check items, you can perform the operations that are shown in the following figure.
Sample triggering effect of a check item
After you enable a check item in Data Asset Governance, when you click the related icon to run or deploy a node in DataStudio, the system checks the node based on the logic of the check item. You can go to the Operation Check page to view the check status and click the value in the Status column to view the check details. If the node fails the check, a related check event is generated to block the related procedure.
In this example, new-version Data Studio is used. To use new-version Data Studio, select Participate in Public Preview of DataStudio of New Version on the Create Workspace page when you create a workspace.
The data development operations in old-version DataStudio are similar to those in the example.