Check items are used to check for issues that may occur before a file is committed and deployed. If the file fails the check, a related check event is generated to block the file committing and deployment procedure. After you enable a governance plan template, the system automatically generates initial check items based on the template. You can enable the initial check items based on your business requirements. If the initial check items in the template do not meet your business requirements, you can refer to this topic to register a check item based on the related extension that you created in Open Platform. This topic describes how to configure a check item.
Prerequisites
A governance plan template is enabled. Governance plan templates in DataWorks provide initial check items that are commonly used. You can enable the initial check items based on your business requirements. The governance plan template that you select is enabled by default. For more information, see View a governance plan template.
Optional. An extension is created. If the check items in the governance plan template that you select 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 a custom extension.
Background information
Data Governance Center 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 committed and deployed. Check items are used to detect violation of rules that a node must abide by before the node is committed and deployed. If the node fails the check, a related check event is generated to block the node committing and deployment procedure and prevent governance issues.
Governance items are used to analyze data after a node is committed and 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:
Limits
Permissions
Only Alibaba Cloud accounts, RAM users to which the AliyunDataWorksFullAccess policy is attached, and workspace administrators can register check items and control the status of check items.
Only Alibaba Cloud accounts and RAM users to which the AliyunDataWorksFullAccess policy is attached can view the check items that belong to the current logon account. Common users can view only the check items in the DataWorks workspaces to which the users are added as members.
Node types
The initial check items that are used to check code logic take effect only for ODPS SQL nodes. If you enable the initial check items that are used to check code logic, only ODPS SQL nodes can trigger the check. You can view the types of nodes for which other types of check items can take effect in the DataWorks console.
Go to the Inspector Setting page
Go to the Data Governance Center page.
Log on to the DataWorks console. In the left-side navigation pane, choose . On the page that appears, select the desired workspace from the drop-down list and click Go to DataStudio.
In the upper-left corner of the DataStudio page, click the
icon and choose .
In the top navigation bar, click Setting. In the left-side navigation pane, click Check Item. The Configure Check Item page appears.
Register a check item
If the initial check items generated by the governance plan template that you select do not meet your business requirements, you can click New Inspector in the upper-right corner of the Inspector Setting 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 that are generated by the governance plan template, the initial 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, DataWorks can check for issues that may occur when an operation such as node committing or node deployment is performed. If the node fails the check, a related check event is generated to block the node committing and deployment procedure and prevent governance issues. You can enable the check item feature and then enable a specific check item.
Enable the check item feature:
The Enable check items switch in the upper-left corner of the Inspector Setting page is used to determine whether to enable the check item feature in the current region for the current tenant. You can use the feature only after you turn on Enable check items. Then, you can determine whether to enable a specific check item in a workspace by turning on the switch in the Enabled column. If you turn off Enable check items, the check item feature is unavailable in the current region for the current tenant.
The Enable check items switch in the upper-left corner of the Inspector Setting page is used to determine whether the initial check items provided by DataWorks are available on the Extension page in SettingCenter for all workspaces in the current region for the current tenant. For information about how to access the SettingCenter page in the DataWorks console, see Create and manage workspaces.
NoteOnly Alibaba Cloud accounts and RAM users to which the AliyunDataWorksFullAccess policy is attached can turn on or turn off Enable check items.
By default, the check item feature is enabled.
Enable a specific check item: Used to determine whether to enable a specific check item in a workspace.
NoteYou can configure the status of a specific check item only after you turn on Enable check items.
If you disable a check item in a workspace, the check item does not take effect only in the workspace. The check item still takes effect in other workspaces.
Configure a check item
On the Inspector Setting 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, committing, 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 Governance Center, when you click the Submit icon to commit 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 details. If the node fails the check, a related check event is generated to block the related procedure.