Before a task reaches production, DataWorks data governance runs a set of check items against it. A failed check generates a blocking problem event that stops the deployment — preventing non-compliant code from being released. This topic describes how to view, register, enable, and configure check items in DataWorks.
Prerequisites
Before you begin, make sure you have one of the following roles or permissions:
An Alibaba Cloud account
A workspace member with
AliyunDataWorksFullAccesspermissionsA workspace administrator role
A workspace member with tenant-level data governance administrator permissions
A workspace-level data governance administrator role
Regular users can view the check item list but cannot register, enable, or disable check items.
Check items vs. governance items
Check items and governance items both detect data development issues, but they operate at different stages:
| Check items | Governance items | |
|---|---|---|
| When | Before task deployment | After task deployment |
| Purpose | Block non-compliant deployments; prevent new governance issues from being introduced | Detect existing issues in the system that need to be optimized to improve the overall health of the data |
| Effect | A failed check stops the deployment | Findings are detected for review and optimization |
DataWorks workspaces exist in standard mode and basic mode. The task development process differs between the two modes. For more information, see Workspace mode differences.
Go to the check item configuration 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, then click Go to Data Asset Governance.
In the left-side navigation pane, choose System Settings > Governance Settings > Check Item to open the Configure Check Item page.
Register a check item (optional)
Data governance automatically generates a list of initial check items. If those do not meet your needs, register a custom extension as an additional check item.
Initial check items related to code logic currently apply only to MaxCompute SQL nodes. To extend coverage to other node types, register additional check items using custom extensions.
To register a check item:
On the Configure Check Item page, click Register Check Item to register a check item using a custom extension. This adds the check item to the detection scope.
After registration, enable the check item for it to take effect.
For information on creating a custom extension, see Develop and deploy an extension: Function Compute.
Enable a check item
Check items are workspace-specific. When you disable a check item, it becomes inactive only for the currently selected workspace.
On the Configure Check Item page, toggle the check item on or off. Once enabled, data governance checks tasks when Run or Deploy is clicked in DataStudio.
Configure a check item
The Check Item Settings page organizes check items by dimension — development, storage, computing, quality, and security. For each check item, you can configure:
Effective check procedures: Specify which procedures trigger the check, such as code execution or deployment. A failed check blocks that procedure from continuing.
Check item parameters: Set parameter values such as access restrictions and maximum running costs. Available parameters vary by check item.
Perform batch operations on check items
To enable or disable multiple check items at once, select the check items and use the batch operation controls.
How check item triggering works
When a check item is enabled and you click Run or Deploy in DataStudio, data governance runs the check. View the result in the Operation Check interface:
Passed: The task meets the check item's requirements. Deployment proceeds.
Failed: The task violates the check item's rules. A blocking problem event is generated and the deployment is stopped.
Click the check status to view the validation details.
The screenshots above show the new version of DataStudio. To use this version, select Use Data Studio (New Version) when creating a workspace. For more information, see Resource management. Operations in the earlier version of DataStudio are similar.