Create and manage attributes for asset objects, APIs, and dashboards - Dataphin

Custom attributes allow you to flexibly configure attributes and their input specifications for different object types. You can then populate attribute values when manually onboarding assets in Asset > catalog management > manual onboarding. This provides a detailed and accurate description for each asset, giving viewers a comprehensive understanding of its core features and value. This article describes how to create and manage attributes for assets, data service APIs, and dashboards.

Limitations

To use attribute management, you must purchase the metadata center or the metadata management value-added service.

Permissions

Super administrators, system administrators, and custom global roles with Plan-Attribute Management permissions can create and manage object attributes.

Create table attributes

In the top navigation bar of the Dataphin homepage, choose Plan > Attribute Management.
On the Attribute Management page, click View Details on the card for an object type to open the attribute management page for that asset type.
On the attribute management page for the asset type, click Create Custom Attribute.

In the Create Attribute dialog box, configure the following parameters. The configuration process for technical indicators, business indicators, fields, data service APIs, and dashboards is the same as that for tables. The following example uses a table.

Parameter	Description
Attribute Name	Enter a name for the attribute. The name must be globally unique. The name can be up to 32 characters long.
Attribute Code	Enter a code for the attribute. The code must be globally unique. The code can be up to 64 characters long, contain only letters, digits, and underscores (_), and must start with a letter.
Attribute Type	Select a type for the attribute. Attribute types are used to classify object attributes. You can select Management Attribute, Business Attribute, or Technical Attribute. Note This parameter is unavailable for field assets.
Description (Optional)	Enter a description for the attribute to help users understand its meaning. The description can be up to 1,000 characters long.
Entry Method	Defines how attribute values are entered when you edit an asset. Different entry methods are available for different field types: custom input: string and numeric. single-selection drop-down: string, numeric, and boolean. multiple-selection drop-down: string and numeric. hyperlink: string. Note Field types include: string (STRING), numeric (BIGINT and DOUBLE with up to 6 decimal places), and boolean (BOOLEAN with values of True or False). If the entry method is custom input or hyperlink and the field type is string, you can set the maximum number of characters from 0 to 10,000.
Enumerated Value	Constrains the value range of an attribute. When you edit an asset, the attribute value must conform to the defined rules. The available configurations depend on the selected entry method: single-selection drop-down/multiple-selection drop-down: If the field type is string, you can configure custom enumerated values or reference system attributes. If the field type is numeric, you can configure custom enumerated values. If the entry method is single-selection drop-down and the field type is boolean, the enumerated values default to True and False and cannot be edited. Custom enumerated value: Separate multiple values with a comma (,). The type of the enumerated values must match the attribute's value type. Each enumerated value can be up to 32 characters long. The total length of all enumerated values, including commas, cannot exceed 10,000 characters. Click Batch Edit next to the enumerated value text box. In the Edit Enumerated Value dialog box, you can edit and preview the values. Separate multiple values with a comma (,) or a line break. Reference system attribute: If the field type is string, you can reference Dataphin system attributes, such as user, user group, data plate, subject domain, project, and asset topic directory, and department (available only if a third-party account system with department information is integrated). This provides consistency across assets and simplifies centralized management. For example, if you select the data plate system attribute, the available values for this attribute will be all data plates in the current tenant.
Click Interaction	This option is available when the entry method is set to hyperlink. It specifies how the link opens: Open in current page or Open in new page.
Editable In	Specifies the modules where this attribute can be edited. For example, if you select Development, users can set or modify the attribute value on the Development and Integration pages. Note By default, this is set to Asset and cannot be changed.
Visible In	Specifies the modules where this attribute is displayed. For example, if you select Development, the attribute is displayed on the Development and Integration pages. Note By default, this is set to Asset and cannot be changed.

Click OK to create the attribute.

Manage table attributes

The operations for technical indicators, business indicators, fields, data service APIs, and dashboards are the same as those for tables. The following example uses a table.

The table object attribute page displays information for both system and custom attributes, including the attribute name, code, description, source, type, required status, value type, entry method, and its visibility and editability settings.
(Optional) On the Table page, you can filter attributes by entering a name or code, or by selecting a source, type, required status, or entry method.

In the attribute list on the Table page, you can perform the following actions on attributes.

Note

Field attributes are view-only.

Actions	Description
Sort	Click Sort, drag the attribute to the desired position, and then click Finish Sorting. Note Only custom attributes can be sorted. The order that you set here determines the display order of the attributes when you edit an asset.
View	Click the icon in the Actions column for the attribute to view its details in the View Attribute dialog box. If the attribute is a custom attribute and you have Attribute Management - Manage permissions, you can click Edit at the bottom of the dialog box to quickly modify its configuration.
Edit	Click the icon in the Actions column for the attribute to modify it in the Edit Attribute dialog box. For custom attributes, you can modify the attribute name, attribute type, description, entry method, enumerated values, and click interaction. For system attributes, you can only modify the display name and description. The description serves as a tooltip on the asset editing page in Asset > catalog management > manual onboarding. Note You cannot edit system attributes for field assets.
Delete	Click the icon in the Actions column for the attribute. In the Delete Attribute dialog box, click OK. Note System attributes cannot be deleted. Deleted attributes cannot be restored. Proceed with caution.