After you enable a governance plan template, the system generates check items based on the template. You can enable the check items based on your business requirements. If the built-in check items cannot meet your requirements, you can create a check item in Data Governance Center for an extension that you registered. You can use check items to inspect events that are generated before files are committed and deployed. If an event does not pass the check, the subsequent process is blocked.

Prerequisites

  • A governance plan template is enabled. For more information, see View a governance plan template.
  • An extension is registered. The prerequisite is required if you want to create a check item for an extension.

Background information

Data Governance Center allows you to use the out-of-box and built-in check items by enabling a governance plan template. The built-in check items include Forbid Use of select* and Forbid Simple Processing. You can enable the check items based on your business requirements. For more information, see View details of check items.

DataWorks allows you to create a check item in Data Governance Center for a custom extension. After the check item is created, Data Governance Center inspects the events triggered by the custom extension. If you do not want DataWorks to inspect events triggered by the custom extension, do not register a check item for the extension.

Note Built-in check items are available only for ODPS SQL nodes. You can use built-in check items to inspect events that are generated before files are committed and deployed. If an event does not pass the check, the subsequent process is blocked.

Limits

  • Governance administrators and workspace administrators can create, enable, and disable check items. These operations cannot be performed by common users.
  • A governance administrator can view all check items within the current account. A common user can view only the check items in the current DataWorks workspace.
  • Only governance administrators can globally enable or disable the check item feature. An Alibaba Cloud account or a RAM user to which the AliyunDataWorksFullAccess policy is attached can be a governance administrator.

Go to the Inspector Setting page

  1. Go to the Data Governance Center page.
    1. Log on to the DataWorks console.
    2. In the left-side navigation pane, click Workspaces.
    3. In the top navigation bar, select the region where the desired workspace resides. Find the workspace and click DataStudio in the Actions column.
    4. On the DataStudio page, click the Icon icon in the upper-left corner and choose All Products > Data Governance > Data Governance Center.
  2. In the top navigation bar, click Configuration. In the left-side navigation pane, click Inspector. The Inspector Setting page appears.

Manage check items

On the Inspector Setting page, you can view the check items within the current account or the specified workspace. You can also enable or disable specified check items for a workspace. After a check item is enabled, Data Governance Center inspects events triggered by the check item. The following table describes the areas on the Inspector Setting page.
Note
  • A governance administrator can view all check items within the current account. A common user can view only the check items in the current DataWorks workspace.
  • Only governance administrators can globally enable or disable the check item feature. An Alibaba Cloud account or a RAM user to which the AliyunDataWorksFullAccess policy is attached can be a governance administrator.
Configuration - Inspector
Area Description
1 In this area, you can turn on or off Enable check items. This is a global switch and can be used for the following operations:
  • Globally enable or disable the check item feature. If you turn off Enable check items, Data Governance Center does not inspect events that are generated before a node is committed based on the check items in the governance plan template.
  • Determine whether the Icon switches can be operated in the Enabled column for each check item. If you turn off Enable check items, the switches in the Enabled column cannot be used.
  • Determine whether the built-in check items are displayed on the Extension configuration page of the Workspace Management page in all workspaces that reside in the current region.
Note You can globally turn on or off Enable check items only by using an Alibaba Cloud account or as a RAM user to which the AliyunDataWorksFullAccess policy is attached.
2 In this area, you can view check items on the Development, Quality, Safety, Computation, and Storage tabs. On each tab, you can specify which check items are displayed by using the Workspace, Name, Enabled, and Source parameters. R&D, quality, security, computing, and storage
Note You can enter keywords in the Name field to search for specified check items. The keywords are used to perform a fuzzy match. The search result includes all check items whose names match the keywords.
3 In this area, you can view the information of the specified check items, such as the name, check event, source, owner, and modification time. You can also perform the following operations:
  • Specify check events. Find the desired check item and click the Icon icon in the Effective Point column. In the Edit Effective Point dialog box, specify the events to be inspected based on the check item. You can select events that are generated before files are committed and deployed. If an event does not pass the check, the subsequent process is blocked. Edit Effective Point dialog box
  • Enable or disable a specified check item. Turn on or off Icon in the Enabled column to enable or disable a check item. After a check item is disabled, Data Governance Center does not inspect events based on this check item.
    Note If you disable Enable check items, the switches in the Enabled column cannot be operated.
  • Enable or disable multiple check items at a time. You can select multiple check items and click Batch enable or Batch stop in the lower part of the page to enable or disable selected check items at a time.
Note In this area, operations on check items take effect only in the current workspace. After a check item is disabled, the operation takes effect only in the specified workspace. In other workspaces, this check item is still enabled.

Create check items

After you enable a governance plan template, the system generates check items based on the template. If the built-in check items cannot meet your requirements, you can create a check item in Data Governance Center for an extension that you registered.
Note The built-in check items in the governance plan template are available only for ODPS SQL nodes.
  1. Click New Inspector in the upper-right corner.
  2. Configure the check item.
    In the New Inspector dialog box, configure the parameters. New Inspector dialog box
    Parameter Description
    Select Extensions The extension that you registered. Select a registered extension from the drop-down list. If no extension is available, click Go New to register an extension.
    Applicable Workspace Scope The workspace in which the check item takes effect. After you select an extension, all workspaces that meet the requirements are automatically generated and listed as valid values for this parameter.
    Type The type of the check item. Valid values: Development, Quality, Security, Computation, and Storage.R&D, quality, security, computing, and storage After you configure this parameter for the check item, you can view events on the tab of the specified check item type on the Inspector event page of Workbench. For more information, see View and manage check events.
  3. Click OK.

Example of a triggered 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 to pass the check, a block event is generated and blocks the subsequent process.