Custom attributes in DataWorks Data Map let you extend business metadata for workspaces, datasets, and tables. With attribute inheritance, child objects automatically receive parent values, reducing repetitive configuration.
Overview
In large-scale enterprise data governance, traditional technical metadata such as table schemas, data lineage, and partition information often cannot fully describe the business context of an asset. Custom attributes let you extend business metadata for workspaces, datasets, and tables, and the inheritance mechanism supports bulk maintenance across object hierarchies.
You can currently configure custom attributes for workspaces, datasets, and tables. Objects such as code and APIs do not yet support custom attributes. If you need this capability, please submit a ticket to contact technical support.
Custom attributes help solve the following problems:
Missing business context: Technical metadata cannot answer critical business questions, such as "Who is the business owner?" or "How is this metric defined?"
Inefficient configuration: When thousands of tables or datasets must adhere to the same governance standards, such as a unified approval link, configuring each item manually is costly and difficult to maintain.
The core capabilities of custom attributes include:
Custom attribute declaration: Administrators can define an attribute's name, identifier, and type (such as text or enum value), and bind it to specific entity types.
Attribute value configuration: Users can view and edit the values of custom attributes on the entities to which they are bound.
Attribute inheritance: Child objects automatically inherit attribute values across object hierarchies, reducing repetitive configuration.
Use cases:
Tag a dataset with business information, such as its business domain and data owner, to facilitate search and management in Data Map.
Configure a unified data approval link for a workspace. All datasets within that workspace automatically inherit this link, which eliminates the need for individual configuration.
Limitations
A custom attribute name must be unique within a tenant.
The identifier of a custom attribute must be unique within a tenant and is immutable after creation.
The type of a custom attribute is immutable after creation.
Permissions
The following table describes the permissions required for custom attribute operations. An Alibaba Cloud account has all permissions by default. This table applies only to RAM users and RAM roles.
Actions | Description |
Create and manage custom attributes | Requires one of the following roles or permissions:
|
Configure custom attributes for a workspace | Requires one of the following roles: Tenant-level: Tenant Owner, Tenant Administrator, or Tenant Data Governance Administrator Workspace-level: Workspace Owner or Workspace Administrator |
Configure custom attributes for a dataset | Requires one of the following roles: Tenant-level: Tenant Owner, Tenant Administrator, or Tenant Data Governance Administrator Workspace-level: Workspace Owner, Workspace Administrator, or Workspace Developer |
Configure custom attributes for a table | For MaxCompute tables: You must be the table owner or a Project Administrator. For other tables (including extended table types): Requires one of the following roles or permissions:
|
View custom attributes, workspace details, dataset details, and table details | None. |
Create a custom attribute
To create a custom attribute, perform the following steps.
Log on to the DataWorks console. In the left-side navigation pane, click Data Map.
In the left-side navigation pane, hover over the Configuration Management icon and select Custom Property Configuration.
On the custom attribute management page, click Add.
In the Create Custom Property dialog box, configure the following parameters:
Category
Parameter
Description
Attribute Configuration
ID
A unique identifier (key) for the attribute, used for API calls. The identifier can contain only letters, digits, and underscores (_) and is immutable after creation.
Name
The display name of the custom attribute. Must be unique within the tenant and can be up to 128 characters in length.
Type
The data type of the attribute value, which is immutable after creation. Supported types:
Enum Value: The value is selected from a predefined list of options.
Text: The value is a free-form text string.
Link: The value is a link that includes a Link Title and a URL.
Enum Value
If you set the attribute type to Enum Value, you must define the available options.
Description
A description of the custom attribute.
Effective Scope
Applicable Entity Type
The entity types to which this custom attribute applies. Supported types include tables (such as MySQL, MaxCompute, EMR Hive, Hologres, Data Lake Formation, AnalyticDB for PostgreSQL, and Tablestore), workspaces, and datasets.
Inherit
Available only for the workspace type.
When enabled, datasets within the workspace automatically inherit the value of this attribute.
For example, if you set the "Environment Type" attribute to "Production" for a workspace, its associated datasets automatically receive the same attribute value. When the parent attribute value is updated, the inherited value is also updated.
Allow Overwrite
Allows child objects to override the inherited value. Once overridden, the attribute becomes a local value and no longer updates when the parent value changes.
Enable as a Filter
Allows this attribute to be used as a search filter. Available only for the Enum Value type.
Show on Details Page
Whether to display this custom attribute on the details page of a data object.
Click Confirm. The custom attribute then appears in the management list, where you can edit or delete it.
Edit an attribute: You can modify an attribute's name, description, enum values, bound objects, and inheritance rules. The attribute's identifier and type are immutable.
Delete an attribute: Deleting a custom attribute that is bound to a data object also clears the corresponding attribute value from the object. This action cannot be reversed.
Configure and view custom attribute values
After you create custom attributes, configure attribute values for workspaces, datasets, and tables.
Configure custom attributes for a workspace
On the Data Map page, click the
icon in the left-side navigation pane to go to the Data Catalog page.Expand Dataset. The list of workspaces appears on the right.
Find the target workspace and edit its custom attribute values.
After the configuration is complete, you can also view the custom attribute values on the workspace details page.
Configure custom attributes for a dataset
On the Data Map page, click the
icon in the left-side navigation pane to go to the Data Catalog page.Follow these steps to configure custom attributes for a dataset:
For a new dataset:
You can configure custom attribute values during the dataset creation process.
For an existing dataset:
On the Data Catalog page, expand Dataset, select the target workspace, and then click the target dataset within that workspace.
On the dataset details page, edit its custom attribute values.
On the dataset details page, you can view the configured custom attribute values.
Configure custom attributes for a table
On the Data Map page, click the
icon to go to the Data Catalog page.Click the table type that you want to configure, such as MaxCompute. On the table details page, you can view and edit the custom attribute values for the table.
Filter by custom attribute
For Enum Value-type custom attributes with Enable as a Filter enabled, you can use the attribute to quickly filter workspaces or datasets during search.
Filter workspaces
You can filter workspaces by custom attribute in one of the following two ways:
Method 1: In the left-side navigation pane, click the search icon
to go to the Advanced Search page. Select Workspace as the type and set the filter conditions for custom attributes. For more information, see Multi-dimensional filtering and browsing.
Method 2: In the left-side navigation pane, click the
icon to go to the Data Catalog page. Expand Dataset, select the target workspace, and filter by the enum values of the custom attribute.
Filter datasets
You can filter datasets by custom attribute in one of the following two ways:
Method 1: In the left-side navigation pane, click the search icon
to go to the Advanced Search page. Select Dataset as the type and set the filter conditions for the custom attribute. For more information, see Multi-dimensional filtering and browsing.
Method 2: In the left-side navigation pane, click the
icon to go to the Data Catalog page. Expand Dataset to view the list of workspaces, click Dataset, and filter the results based on the enum values of a custom attribute.
Attribute inheritance
Custom attributes support inheritance across object hierarchies. Child objects automatically receive their parent's attribute values.
Inheritance chain: Custom attribute inheritance follows this hierarchy: .
For example, when you configure a custom attribute value at the workspace level, all datasets within that workspace automatically inherit that value.
Inheritance policy: When you create a custom attribute, you can select the Allow Overwrite option.
Allow Overwrite: Child objects (datasets) inherit the attribute value from the parent (workspace) by default, but you can override the value on the child object. For example, a workspace can be configured with a standard approval link that most of its datasets inherit. For a specific dataset that contains sensitive information, you can override this link with one that requires a more stringent approval process.
Disallow Overwrite: Child objects must inherit the attribute value from the parent object and cannot modify it.
Parent value change: When a parent's attribute value changes, the new value is passed down to all inheriting child objects. Child objects with overridden values are not affected.
Inheritance indicator: On the dataset details page, an indicator icon appears next to custom attributes that are inherited from a workspace. You can hover over the icon to view the inheritance source and override policy.