The tag management feature in DataWorks lets you use business tags to categorize data assets, perform statistical analysis, and automate policy formulation. Each tag consists of a user-defined tag key and tag value. After you define a tag, you can attach it to assets for management and statistical analysis. This topic describes how to create and use tags.
Background
Before you use the tag management feature, make sure that you understand the following concepts:
Data asset: A data entity in DataWorks related to data development, data governance, data analysis, or data services. Examples include tables, APIs, node tasks, data analysis tasks, quality rules, workspaces, and governance and optimization processes.
Asset tag: A predefined phrase used to describe a data asset. You can use asset tags to identify key characteristics, categorize assets, and configure management policies for each asset category. Examples include the following:
Feature tag: application, business process, critical business, and asset loss impact.
Business organization tag: department and project.
After you attach tags to assets, you can use them to quickly collect statistics on related business data, query data details, and perform data analysis.
Limitations
Tenant members can create tags. A tenant's Data Governance Administrator can modify all tags within the tenant. If a user needs to perform these operations, you can grant them the required permissions. For more information, see Manage the roles and permissions of tenant members.
In Tag Management, you can add tags only to assets of the following types: tables, scheduling tasks, and manually triggered workflows.
You can add a maximum of
20tags to each asset.When you create a tag, the tag key must be unique.
Tag types and descriptions
DataWorks provides two types of tags: System Tags and Custom Tags. Both types are effective at the region level. The following list describes each type:
System Tag: Tenant members can only view system tags. They cannot create, modify, or delete them. You can manually attach system tags to or detach them from assets, and view the assets to which the tags are attached.
Custom Tag: You can manually create a tag or add values to multiple tags at a time. Only tenant members can view and create tags. To modify or delete a tag, you must be the tag owner or a tenant-level Data Governance Administrator. You can also manually attach or detach custom tags from assets, or view the assets to which they are attached.
NoteIf a tag is attached to any assets, you must detach it from all of them before you can delete the tag.
Go to the tag management 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 navigation pane on the left, click the
icon and choose .
Custom tags
In Tag Management, you can create custom tags and tag values that meet the business requirements for your resources.
Create a tag
On the Tag Definition page, go to the Custom Tag tab, click Create Tag, and configure the tag in the dialog box that opens.
Parameter
Description
Tag value type
The data type of the tag value. The String, Integer, Float, and Boolean data types are supported. The default value is String.
Tag value
You can specify multiple unique values for a tag. When you attach a tag that contains multiple tag values to an asset, you must select the tag value that you want to attach to the asset. If a finer asset categorization is required, you can configure multiple tag values for a tag.
If the data type of a tag is Boolean, you can specify only the
trueandfalsestatic fields.
Owner
By default, the owner of a tag is the user who creates the tag. The owner can modify or delete the tags that they own.
Click OK to create the custom tag.
Add values to multiple tags at a time
To add Tag Values to multiple tags at once, click Quickly Add Tag Value on the Custom Tag tab. In the dialog box that appears, select a Tag Key from the drop-down list and then add multiple tag values.
Attach tags
After you create a tag, you can attach it to an asset to facilitate subsequent statistical analysis.
Regardless of the method you use to attach a tag to an asset, the tag information is synchronized and displayed in both Tag Management and the functional module where the asset is located, such as Data Map or Data Quality.
When you attach a custom tag to an asset, you can hover over the
icon and enable Mark Based On Automatic Lineage Propagation. The system automatically propagates the tag to upstream assets on the next day (T+1).For table assets, the tag is propagated by default only to other table assets based on table lineage.
For task assets, the tag is propagated by default only to other task assets based on task lineage.
Attach a tag to multiple assets at a time in Tag Management
This method lets you select a tag and then select the assets to which you want to attach it. This method is typically used to attach a specific tag to multiple assets at once.
In the Tag Value Actions column for the destination tag, click the action to open the Attach To Asset dialog box.
In the Attach To Asset dialog box, you can filter for specific assets and attach the tag.
Attach tags in different functional modules
With this method, you go to the functional module, find the specified asset, and then attach the required tag. This method is typically used to attach tags to a single asset.
Functional module | Asset type | Permission description | Attach a tag to an asset |
Table | Only tenant members can add tags to tables that they own. | Go to the details page of a table and edit tags in the section. | |
Business Assets | Tables, scheduling tasks, models, and metrics | Tenant administrators or tenant-level data governance administrators can add tags to assets. | On the Business Assets page, switch between tabs of different asset types to attach tags to different assets in batches or individually. |
Node | Only users who are assigned the Workspace Administrator or Developer role can add tags to nodes. |
| |
Scheduling task | Only users who are assigned the Workspace Administrator or O&M role and the task owner can add tags to tasks. | Go to the Auto Triggered Task page and attach tags to a scheduling task. Note After you attach tags to a task, the tags are also displayed for the recurring instances that are generated for the task. |
Use tags
After you attach tags, you can use them in modules such as Data Asset Governance, Data Map, and Operation Center to quickly collect statistics on related business data, query data details, and perform data analysis.
Manage tags
After you create tags, you can view their overview and details and perform related management operations on the Tag Management page.
View tag overviews
On the Tag Management page, you can filter tags by specified conditions. After you find the tags you want to view, you can see an overview of the tags that meet the filter conditions. You can also perform the following operations on the tags:
Modify tag information: Move the mouse pointer over the name of the destination tag, click the
icon, and then edit the tag information as required.Delete a tag: To delete a tag, click the
icon. To delete multiple tags at once, select the desired tags and click Batch Delete.NoteIf a tag is attached to any assets, you must detach it from all of them before you can delete the tag.
View tag details
Click the name of the destination tag or View Assets in the Tag Value Actions column to open the Tag Details page. On this page, you can view all tag values of the current tag and the details of its attached assets. The following operations are supported only for Tag Values of Custom Tags:
Tag Value: On the Tag Value tab of the Tag Details page, you can view all values for the tag and perform the following operations:
Modify Tag Value: Click Modify Tag Value on the Tag Value tab to add tag values or change the tag owner.
Delete a tag value: You can delete a tag value if it is no longer required. To delete multiple tag values at once, select the tag values and click Batch Delete.
NoteIf a tag value is attached to any assets, you must detach it from all of them before you can delete the tag value.
Associated Assets: Go to the Tag Details page. On the Associated Assets tab, you can view all assets to which the tag is attached and perform the following operations on them.
Edit tags: On the Associated Assets tab, click the
button in the tag column of the destination resource to add, delete, or modify its tag keys and tag values.Detach an asset: On the Associated Assets tab, click Detach Asset in the Actions column to detach the tag from the asset.