All Products
Search
Document Center

DataWorks:Manage tags

Last Updated:Dec 12, 2024

The tag management feature of DataWorks allows you to create tags to manage data assets in a refined manner, perform statistical analysis on data assets, and automate policy formulation for data assets from a business perspective. Before you can add a tag to a data asset, you must define a key (name) and value for the tag. Then, you can use the tag to collect statistics on and manage the data asset. For example, you can tag cost-related data to effectively manage and analyze costs. This topic describes how to create and use tags.

Background information

Before you use the tag management feature, make sure that you understand the following concepts:

  • Data assets: data entities that are related to data development, data governance, data analysis, and data services in DataWorks. Data entities include tables, APIs, node tasks, data analytics tasks, data quality monitoring rules, workspaces, and governance optimization processes.

  • Asset tags: predefined short phrases that are used as standard descriptions for data assets. You can identify key asset characteristics and categorize assets by tags. Then, you can configure a management policy for each asset category. Examples:

    • Feature tags: application, workflow, critical business, and asset loss impact.

    • Business organization tags: department and project.

In most cases, you can use tags to quickly collect asset-related business data, query relevant details, and analyze the data.

Limits

  • Tenant members can create tags. Tenant-level data governance administrators can modify all tags of a tenant. If a user needs to perform related operations, you must grant the required permissions to the user. For more information, see the "Manage tenant-level roles" section in Manage permissions on global-level services.

  • You can add tags only to assets such as tables, scheduling tasks, and data development nodes. Supported assets:

    • Table: tables of the tenant to which the current user belongs. Tables of multiple data source types, such as MaxCompute and E-MapReduce (EMR), are supported. You can view the supported data source types in the DataWorks console.

    • Scheduling task: scheduling tasks in the workspace to which the current user is added as a member. Scheduling tasks include auto triggered tasks and auto triggered task instances.

    • Data development node: nodes of the workspace to which the current user is added as a member.

  • You can add up to 20 tags to each asset.

Tag types and descriptions

DataWorks supports system tags and custom tags. The following table describes the application scope of tags and permissions on tags.

Tag type

Application scope

Permission description

Create, delete, modify, or query a tag or a tag value

Add tags to an asset

System tags

Note

System tags are built-in tags in DataWorks. You can log on to the DataWorks console to view system tags.

The tags take effect at the region level.

  • Query: tenant members.

  • Create/Modify/Delete: No users.

  • Only members of a tenant can add tags to or remove tags from an asset or view the assets to which tags are added.

  • You can add tags only to assets such as tables, scheduling tasks, and data development nodes. Supported assets:

    • Table: tables of the tenant to which the current user belongs. Tables of multiple data source types, such as MaxCompute and E-MapReduce (EMR), are supported. You can view the supported data source types in the DataWorks console.

    • Scheduling task: scheduling tasks in the workspace to which the current user is added as a member. Scheduling tasks include auto triggered tasks and auto triggered task instances.

    • Data development node: nodes of the workspace to which the current user is added as a member.

Custom tags

The tags take effect at the tenant level.

  • Query: tenant members.

  • Create: tenant members. The user who creates a tag is the owner of the tag.

  • Modify/Delete: the tag owner and tenant-level data governance administrators.

    Note

    If you want to delete a tag that is added to assets, you must remove the tag from the assets before you can delete the tag.

  • View the assets to which a tag is added: tenant members.

  • Add tags to or remove tags from an asset: users that are not a visitor.

  • You can add tags only to assets such as tables, scheduling tasks, and data development nodes. Supported assets:

    • Table: tables of the tenant to which the current user belongs. Tables of multiple data source types, such as MaxCompute and E-MapReduce (EMR), are supported. You can view the supported data source types in the DataWorks console.

    • Scheduling task: scheduling tasks in the workspace to which the current user is added as a member. Scheduling tasks include auto triggered tasks and auto triggered task instances.

    • Data development node: nodes of the workspace to which the current user is added as a member.

Go to the Tag Management page

  1. Go to the Data Governance Center page.

    Log on to the DataWorks console. In the top navigation bar, select the desired region. In the left-side navigation pane, choose Data Development and Governance > Data Governance Center. On the page that appears, click Go to Data Governance Center.

  2. In the upper-left corner of the Data Governance Center page, click the image icon and choose All Products > Data Governance > Tag Management.

Custom tags

Create a tag

  1. On the Tag Management page, click Add Tag.

  2. Configure information about the tag.

    The following table describes the parameters.

    Parameter

    Description

    Tag Key

    The name of the tag.

    Tag Value

    The value of the tag. The following data types are supported for a tag value: string, integer, floating-point, and boolean. If the parameter is left empty, the null value is used.

    Note
    • You can specify multiple unique values for a tag. When you add a tag that contains multiple tag values to an asset, you must select the tag value that you want to add 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 true and false as tag values.

    Owner

    The owner of the tag. You can modify or delete tags that you own. By default, the owner of a tag is the user who creates the tag.

  3. Click Confirmation. The tag configuration is complete.

Add values to multiple tags

After you create tags, you can click Quickly Add Tag Value on the Custom Tag tab and follow the on-screen instructions to add values to multiple tags at the same time. image

Add a tag to an asset

After you create a tag, you can add the tag to an asset to facilitate subsequent statistical analysis. To add a tag to an asset in DataWorks, use one of the following methods:

Note

The tag details of the asset are displayed on the Tag Management page and the service page (such as Data Map and Data Quality) where the asset is used regardless of the method used to add the tag.

Add a tag to multiple assets at the same time

If you use this method, you must select a tag and then select the assets to which you want to add the tag. This method is used when you want to add a specific tag to multiple assets at the same time.

  1. On the Tag Management page, find the desired tag and click Add to Asset in the Actions column.

  2. In the Add to Asset dialog box, select assets and add the tag to the assets.

    You can specify conditions to search for the required assets and add the tag to the assets as shown in the following figure.

    image

Add tags to an asset on the page of a service where the asset is used

If you use this method, you must go to the page of the service where the specified asset is used and add tags to the asset. You can use this method to add tags to a single asset.

Service

Asset type

Permission description

Add tags to an asset

Data Map

Tables

Only tenant members can add tags to tables that the tenant members own.

Go to the details page of a table and add tags to the table as shown in the following figure.image

Operation Center

Auto triggered tasks

Only users that are assigned the Workspace Administrator or O&M role and the owner of a task can add tags to the task.

Go to the Auto Triggered Nodes page in Operation Center and add tags to an auto triggered task as shown in the following figure.

Note

After you configure tags for an auto triggered task, the tags are also displayed for the instances generated for the auto triggered task.

image

Manage tags

After you create a tag, you can check the overview of the tag, view the details of the tag, and manage the tag on the Tag Management page.

Check the overview of the tag

On the Tag Management page, you can specify filter conditions to search for custom or system tags and check the overview of the tags, including the tag owner, tag values, and the number of assets to which the tag is added.

image

You can manage custom tags based on your business requirements:

  • Modify information about a tag: Move the pointer over the tag name and click the image icon to modify the tag information based on your business requirements.

  • Delete a tag: You can delete a tag that you no longer require. To delete multiple tags, select the tags and click Batch Delete.

    Note

    If you want to delete a tag that is added to assets, you must remove the tag from the assets before you can delete the tag.

View the details of a tag

Click the name of a tag to go to the tag details page. You can view the values of the tag and the details of the assets to which the tag is added.image

You can also perform the following operations based on your business requirements:

  • Modify a tag: To add a tag value or change the tag owner, click Modify Tag Value.

    Note

    You can modify only custom tags.

  • Delete a tag value: You can delete a tag value that you no longer require. To delete multiple tag values, select the tag values and click Batch Delete.

    Note
    • If you want to delete a tag value that is added to assets, you must remove the tag value from the assets before you can delete the tag value.

    • You can delete only the values of custom tags.

  • Remove a tag from an asset: If a tag is no longer required by an asset, you can remove the tag from the asset.