Tag management
The Tag Management feature in DataWorks lets you use business tags to classify data assets, gather statistics, and create automated policies. You must define a tag key and its corresponding tag values before you can attach tags to assets for management and statistical analysis. This topic describes how to create and use tags.
Background
Before using Tag Management, understand the following concepts:
Data asset: A general term for data-related entities in DataWorks, including those involved in data development, Data Governance, Data Analysis, and Data Service. Examples include tables, APIs, node tasks, data analysis tasks, data quality rules, workspaces, and governance optimization processes.
Asset tag: A predefined, short phrase that provides a standardized annotation for a data asset. You can use tags to identify key asset characteristics, classify assets, and apply specific management policies to different categories of assets. For example:
Feature tag: application, business process, critical business, and asset loss impact.
Business organization tag: department and project.
After attaching tags to assets, you can use them to gather business data statistics, query data details, and perform data analysis.
Limitations
Any tenant member can create tags. A tenant-level Data Governance Administrator can modify all tags within the tenant. To grant a user permission to perform these operations, see Manage the roles and permissions of tenant members.
In Tag Management, you can currently attach tags only to assets such as tables, scheduling tasks, and manually triggered workflows.
You can add a maximum of
100tags to each asset.Tag keys must be unique.
Tag types
DataWorks provides two types of tags: System Tag and Custom Tag. Both apply at the region level. The details are as follows:
System Tag: Tenant members can view, attach, and detach system tags, but cannot create, modify, or delete them. You can also view the assets to which a system tag is attached.
Custom Tag: You can manually create a new tag or add tag values to existing tags in batches. Any tenant member can view and create custom tags. To modify or delete a custom tag, you must be the tag owner or have the tenant-level Data Governance Administrator role. You can also manually attach custom tags to assets, detach them, and view the assets to which they are attached.
NoteTo delete a tag, you must first detach it from all associated assets.
Access the tag management page
Log on to the DataWorks console. In the target region, click in the left-side navigation pane. Click Go to Data Asset Governance.
In the left-side navigation pane, click the
icon and choose .
Custom tags
In Tag Management, you can use custom tags to create tags and tag values that meet your business requirements.
Create a tag
On the Define Tag page, click to enter the Custom Tag tab, and click Add Tag. In the dialog that appears, configure the tag as needed.
Parameter
Description
Tag value type
The data type of the tag value. Valid values: String, Integer, Float, and Boolean. Default value: String.
Tag value
A tag can have multiple tag values, and tag values cannot be duplicated. If a tag contains multiple tag values, you must select the specific tag value to use when attaching the tag to an asset. To further classify assets into more detailed categories, configure multiple tag values.
Boolean tag values support only the fixed values
trueandfalse.
Owner
The tag owner defaults to the user who created the tag. The owner can modify and delete tags under their name.
Click Confirm to create the custom tag.
Add tag values in batches
To add Tag Value to multiple tags at the same time, click Quickly Add Tag Value on the Custom Tag page. In the dialog that appears, select a Tag Key from the drop-down list and manually add multiple tag values.
Attach tags
After you create a tag, you can attach it to the corresponding assets to facilitate subsequent statistical analysis.
Regardless of which method you use to attach tags to assets, the binding information is displayed in both Tag Management and the corresponding feature module where the asset resides (for example, Data Map or Data Quality).
When attaching a custom tag to an asset, you can hover over the
icon to enable Automatically Propagate Tags Based on Lineages. The system will automatically propagate the tag to upstream assets the next day (T+1).For table assets, tags are propagated only to assets of the same type based on table lineage by default.
For task assets, tags are propagated only to assets of the same type based on task lineage by default.
Attach tags in batches through tag management
This method requires you to select a tag first and then select the assets to which you want to attach the tag. It is typically used to attach a specific tag to multiple assets in batches.
In the Tag Value Actions column of the target tag, click to open the Add to Asset dialog.
In the Add to Asset dialog, you can filter by conditions to find assets and attach tags.
Attach tags through feature modules
This method requires you to navigate to the feature module first, find the specific asset, and then attach the corresponding tag to it. It is typically used to attach tags to individual assets.
Feature module | Asset type | Permission description | Attach tags to assets |
Table | Only tenant members can add tags to the tables they own (that is, the member is the table owner). | Go to Table details, and edit tags in . | |
Business assets | Tables, scheduling tasks, models, and metrics | Only a tenant administrator or a tenant-level data governance administrator can add tags to assets. | On the business assets page, switch between asset type tabs to attach tags to different assets in batches or individually. |
Node | Only the Workspace Administrator and Development roles can add node tags. |
| |
Scheduled task | Only the Workspace Administrator and O&M roles, as well as the task owner, can add task tags. | Go to the scheduled tasks page to set tags for scheduled tasks. Note After a tag is set for a task, the scheduled instances generated by the task will also display the corresponding tag. |
Use tags
After you attach tags, you can use them in modules such as Data Asset Governance, Data Map, and Operation Center to gather business data statistics, query data details, and perform data analysis.
Manage tags
After tags are created, you can view tag overview and tag details on the Tag Management page and perform related management operations.
View tag overview
On the Tag Management page, filter tags by conditions. After you find the target tags, you can view their overview information and perform the following operations:
Modify tag information: Hover over the target tag name and click the
button to edit the tag information as needed.Delete a tag: If a tag is no longer needed, click the
button to delete it. To delete multiple tags, select the corresponding tags and click Batch delete.NoteTo delete a tag, you must first detach it from all associated assets.
View tag details
Click the target tag name or click View Assets in the Actions column to go to the Tag Details page. On this page, you can view all tag values of the current tag and the detailed information of the attached assets. Only Tag Value within Custom Tag supports the following operations:
Tag Value: On the Tag Details page, click the Tag Value tab to view all tag values created under this tag. You can perform the following operations on tag values:
Modify Tag Value: On the Tag Value tab, click Modify Tag Value to add new tag values or change the tag owner.
Delete a tag value: If a tag value is no longer needed, you can delete it. To delete multiple tag values, select the corresponding tag values and click Batch delete.
NoteTo delete a tag value, you must first detach it from all associated assets.
Associated Asset: On the Tag Details page, click the Associated Asset tab to view all assets attached to this tag. You can perform the following operations on the attached assets:
Edit tags: On the Associated Asset tab, click the
button in the tag column of the target resource to add, delete, or modify tag keys and tag values for the target resource.Detach an asset: On the Associated Asset tab, click Detach Asset in the Actions column to detach the current tag from the target asset.