Manage Catalog Asset Listings & Permissions in Dataphin - Dataphin - Alibaba Cloud - Dataphin

The Staging Asset list displays assets collected from specified data sources through collection adapters and from the Data Middle Platform. You can view, filter, edit, and manage the listing status and permissions of these assets.

Prerequisites

Table asset/Metric asset/Dashboard asset: You have purchased the asset operation value-added service and enabled the asset operation module for your tenant.
API asset: You have purchased the asset operation value-added service and the data service feature.
To manage dashboard assets, you must create an application system and a Quick BI metadata collection task. For instructions, see Create and Manage Application Systems and Create and Manage Metadata Collection Tasks.

Permissions

Super administrators, operations administrators, and users assigned a custom global role with the listing management - manage permission can create, list, and manage quasi-assets.
Business system operators and maintainers with the asset maintenance permission can manage assets in their respective business systems.

Procedure

On the Dataphin home page, go to Assets > Catalog Management.
In the navigation pane on the left, click Manual Listing and select an asset type to open the Staging Asset page.
The Staging Asset list shows assets collected through collection adapters and from the data middle platform. It includes information such as Asset Name, Metric Type, Associated Technical Metric, asset source, category, latest status, info integrity, previously listed, Asset Import Time, Latest Data Time, and Last Updated.
- Asset source: The asset's origin. API assets originate from a Data Service project, while Quick BI dashboards come from a Quick BI workspace. The Dataphin data section contains only logical tables.
- Latest status: If an asset's status is Listing Failed, hover over the icon next to the status to view the failure reason. After you resolve the issue, you can list the asset again.
- Info integrity: Indicates whether all required attributes for the asset are complete and valid.
- Previously listed: Indicates whether the asset has been unlisted and then listed again.
(Optional) You can filter assets by criteria such as asset source, BI Space/Directory, category, info integrity, latest status, maintainer, metric type, latest data time, last updated, asset import time, last lister, previously listed, first lister, and first list time. You can also search for assets based on specified conditions.

In the Actions column, you can perform several operations on an asset. The available operations, illustrated here with a table asset, are the same for all asset types. You can select up to 10,000 assets for a single batch operation.

Actions	Description
Edit	You can modify the basic information, usage instructions, and visibility permissions of an asset. For more information, see Edit asset information.
List	Click List, or select one or more assets and then click List at the bottom of the page, to list the assets in the front-end asset catalog. If an approval rule is configured for an asset, the listing request requires approval. The approval comments cannot exceed 100 characters. After the request is approved, the asset appears in the front-end asset catalog. If no approval rule is configured, the asset is listed immediately. Note Assets can be listed only if all required information is complete. You must list the parent table asset before you can list its custom metric assets. Only users and roles with asset maintenance permissions can list assets. This operation is available only for Staging Assets with a status of Not Listed or Listing Failed. The names of listed business metrics must be unique within a tenant.
Do Not List	Click Do Not List and provide a reason to set the asset's status accordingly. Assets with this status do not appear in the front-end asset catalog. To edit an asset with the Do Not List status, you must first change its status back to Staging Asset. Note The Do Not List operation on a table asset also applies to its custom metrics, but it skips any metrics that you do not have maintenance permissions for. To list a custom metric when its parent table has the Do Not List status, you must first change the table asset's status back to Staging Asset and then list the metric asset.
Set Maintenance Permissions	This operation is not supported for business metrics. Single operation: Click Set Maintenance Permissions to assign maintainers to the asset. Maintainers are responsible for daily maintenance, such as modifying information and managing the listing status. Batch operation: Click Set Maintenance Permissions at the bottom of the page to add or modify maintainers in batches. Modify: Replaces the maintainers of the selected assets with the newly specified ones. Append: Retains the existing maintainers of the selected assets and adds the newly specified ones.
View change history	Displays an asset's change history over the last 30 days, including attribute and status changes. Note For custom metrics, a change in statistical granularity corresponds to a change in the fields defined as dimensions in the parent table. This change takes effect when the table asset is listed.
Delete	This operation is available only for business metrics. You can delete a business metric if its status is Not Listed, Do Not List, or Listing Failed. Deleting the business metric also removes its associations with related business metrics and technical metrics.
Modify attributes	Select one or more assets and click Modify Attributes at the bottom of the page to edit their attributes in bulk. Compared to editing a single asset, some attributes offer more flexible configuration options. Add all required attributes: Click to quickly add all attributes required for listing the current asset type. Table display name/Description: You can use DDL comments or custom input. You can select the Apply only to assets with an empty display name option. If this option is not selected, the existing display names of the selected tables will be overwritten. Reference DDL comment: Uses the comment of the data table as the asset's display name or description. The value updates automatically when the DDL comment changes. Custom: Allows you to select the Table/Field Name or DDL comment as the asset's display name. You can select the DDL comment as the asset's description or Clear the description. Field display name/Description: You can use a DDL comment or a custom value. You can also select Apply only to assets with empty display names. If you do not select this option, the existing display names of the selected table fields are overwritten. Reference DDL comment: If you select Apply only to assets with empty display names, this setting applies to all fields in the current table that have an empty display name or description. It uses the comment of the data field as the asset's display name or description, which updates automatically with DDL comment changes. Custom: If you select Apply only to assets with empty display names, this setting applies to individual fields in the current table that have an empty display name or description. You can select the Field Name or DDL comment as the display name. You can select the DDL comment as the asset's description or Clear the description. Note Whether you reference DDL comments or use custom values, you must use the same method for all fields in the current table. If you change the setting for a field's display name or description from Reference DDL comment to Custom and select Apply only to assets with empty display names, the change takes effect only if the DDL comments for all fields in the current table are empty. If you change the setting for a field's display name or description from Custom to another Custom setting and select Apply only to assets with empty display names, the change takes effect for any individual field in the current table that has an empty value. Category/Asset tag/Related business metrics: You can Append to the existing configuration or Replace it with the current configuration. If your account has the Listing Management-Manage permission, you can click the Tag Management button to navigate to the Assets > Catalog Management > Other Settings > Basic Settings page to create new tags. Business owner: Modifiable only for business metrics. Visibility/Data profiling report: Controls whether to display the corresponding content on the asset details page in the asset catalog. Atomic metric/Business qualifier/Statistical period/Unit of measure: Modifiable only for custom technical metrics. Is additive/Related business metrics: Modifiable only for technical metrics. Data lineage/Quality profile: Modifiable only for table and metric assets. Controls whether to display the corresponding content on the asset details page. Metric relationship diagram: Modifiable only for standard modeling metric assets. Controls whether to display this diagram on the asset details page. Metadata change history: Modifiable only for table assets. Controls whether to display this information on the asset details page. Other custom attributes: You can configure other custom attributes for assets in Planning > Attribute Management to enrich asset information. Data consumption: Modifiable only for table assets. Controls whether users can apply for consumption permissions on the asset details page. Note For API and dashboard assets, you can modify the following system attributes: Category, Asset Tag, and Visibility. For business metric assets, you can modify the following attributes: Category, Asset Tag, Business Owner, Visibility, and Related Business Metrics. When the table type is a physical table, physical view, materialized view, or data source table, the display names and descriptions for the table and its fields can reference DDL comments.
Export assets	Click Export Assets at the bottom of the page to export the selected assets in batches. The system automatically skips assets for which the current user does not have maintenance permissions. If you are exporting a large number of assets, the export file may take some time to generate. You can monitor the export task and download the file from the Batch Management-Batch Operation History page.

Note

Changes to some asset attributes, such as Category and asset tags, require you to list the asset again to update the front-end catalog. Other changes, such as field or dashboard chart information, update immediately without relisting.
If a listed asset is deleted, the Relisting required column shows Yes. We recommend that you list the asset again to maintain data consistency and availability.
If an asset has been deleted, it can only be viewed.

Edit asset

Note

Saving a table asset automatically generates the corresponding metric assets.
If you select the Publish related metrics simultaneously checkbox, the system publishes the table asset and its related metric assets together.
You must publish the table asset before publishing its custom metrics.
When the table type is physical table, physical view, materialized view, or data source table, you can use DDL comments to define the display name and description for the table and its fields.

Table asset

Parameter		Description
Basic information	Name	Displays the name of the asset. This field cannot be modified.
	Display name	Enter a display name for the asset. You can use a DDL comment or enter a custom name. Use DDL Comment: Uses the data table's comment as the asset's display name. The display name is automatically updated when the DDL comment changes. Custom: Enter a custom display name. The name can be up to 256 characters long. You can also click Use Asset Name or Use Asset Description to quickly populate this field.
	Catalog	Select one or more published catalogs from the table subject.
	Tags	You can select up to 20 tags. If your account has the Listing Management-Manage permission, you can click Tag Management to navigate to the Assets > Catalog Management > Other Settings > Basic Settings page to create new tags.
	Description	You can use a DDL comment or enter a custom description. Use DDL Comment: Uses the data table's comment as the asset's description. The description is automatically updated when the DDL comment changes. Custom: Enter a description for the asset. The description can be up to 1,000 characters long.
Attribute information	Business attributes/Management attributes/Technical attributes	Displays the system and custom attributes of the asset. You can select Hide read-only attributes in the upper-right corner to focus on editable information. System attributes: Business attributes: Includes information about the subject domain. Management attributes: Includes information about the owning system. Data source table: The source system of the collection task. Dataphin table: Displayed as -. Technical attributes: Includes asset source, owning data module/workspace, database type, owning project, table type, asset import name, collection adapter type, and collection adapter information. Asset source: Data source table: The path is Source System > Data Source Name > Table Schema. Dataphin table: The path is Dataphin > Workspace Type (logical tables are identified as an intermediate layer) > Project Name/Data Module Name (a data module contains only logical tables). Asset import name: Data source table: The name of the data source table collection task. Dataphin table: Displayed as -. Custom attributes: The required format depends on the table attribute configuration. For example, if a 'Change management' attribute is configured as a single-select drop-down list with options 'Yes' and 'No', you will see a drop-down list with these two options when editing the table asset. For more information about configuring attributes, see Create and manage R&D object attributes. For an attribute value to function as a clickable link, it must start with `http://` or `https://`. A value cannot consist only of spaces. The maximum length, up to 10,000 characters, is determined by the attribute's configuration.
Field information	No.	You can click the Sort icon next to the column header to sort the fields by their sequence number.
	Field name	You can click the Sort icon next to the column header to sort the fields by name.
	Data type	Displays the data type of the field.
	Field display name	Enter a display name for the field. You can use a DDL comment or a custom name. Use DDL Comment: Uses the field's comment as its display name. The display name is automatically updated when the DDL comment changes. Custom: Enter a display name for the field, up to 512 characters. You can hover over Quick Fill and select Use Description or Use Name to quickly populate this field.
	Description	You can use a DDL comment or enter a custom description. Use DDL Comment: Uses the field's comment as its description. The description is automatically updated when the DDL comment changes. Custom: Enter a description for the field, up to 2,048 characters.
	Business type	You can select one of three business types: dimension, metric, or statistical period.
	Associated entity	If the table type is physical table, physical view, or view, and the field's business type is dimension, you can select a published business entity from the owning data module. If no suitable entity is available, click Create business entity to create one. For instructions, see Create and manage business entities. If the field is already associated with a business entity and you change the data module, you must reselect the business entity. If the table type is dimension logical table or fact logical table, this field displays the associated entity configured for the dimension on the logical table's edit page in R&D > Development. Click the View icon next to the entity to see its details, including role name (e.g., buyer, seller), entity name (code), description, owning module, and subject domain. You can also perform the following actions: View Details: Click to go to the business entity's page under Planning > Data Architecture for more details. View Entity Relationship Diagram: Click to open the Entity Relationship Diagram panel, which shows a diagram centered on this business entity.
	Data classification	The data security module must be enabled to view the data classification of the field.
	Data sensitivity level	The data security module must be enabled to view the data sensitivity level of the field. You can click the Sort icon next to the column header to sort fields by their data sensitivity level.
	Actions	Bulk Edit: Click Bulk Edit. In the Bulk Edit panel, modify the field display name, description, business type, and associated entity for the desired fields, then click OK to apply the changes to the field list. For field display name and description, you can use DDL comments or enter custom values, similar to the single-field configuration. Bulk Set as Dimension/Metric: Select one or more fields in the list and set them as dimensions or metrics in bulk.
Related metrics		When the business type of one or more fields is set to metric, the related metrics list is displayed. This list shows the metric's name, listing status, catalog, tags, atomic metric, business qualifier, statistical period, and unit of measure. You can perform the following operations on the metrics (requires maintenance permission for the metric asset). Bulk Edit: Click Bulk Edit. In the Bulk Edit panel, select the metrics you want to modify, click Batch Operations at the bottom, modify the information, and click OK to apply the changes to the related metrics list. Catalog/Tags: You can bulk append or modify the published metric catalog/tags. You can add up to 20 tags. atomic metric/business qualifier: You can bulk modify the atomic metric or business qualifier. The value can be up to 128 characters long. Statistical Period: You can bulk configure the statistical period for the metrics. Unit of measure: You can bulk configure the unit of measure for the metrics. The value can be up to 32 characters long. Modify Catalog: Select a published catalog under the metric subject. Modify Tags: Add up to 20 tags to the metric. atomic metric/business qualifier: Enter an atomic metric or business qualifier for the metric, up to 128 characters. Statistical Period: Select a statistical period for the metric. To create one, see Create a statistical period. View business entity: In the upper-left corner of the related metrics list, click the view icon to see the business entity's information. Click View Details to go to the Planning > Data Architecture page for more information. When a dimension changes, the update type (addition or deletion) for the statistical granularity is highlighted. In the upper-right corner of the related metrics list, select Apply table attributes to unlisted metrics. When you save the table asset, its display name, description, visibility, data profiling report attributes, data lineage, quality profile, and maintainers are applied to all unlisted metrics.
Usage instructions	Enable	This feature is disabled by default. If you enable it, the usage instructions are visible on the asset details page in the asset catalog. You can add instructions to introduce the asset and guide data consumers, helping them evaluate its usability and apply for access. Note For a link to be clickable, its prefix must be `https://` or `http://`. Each image or video uploaded for an asset cannot exceed 100 MB.
Access control	Visibility	Controls whether the asset is visible in the asset catalog. Three options are available: Visible to all users: All users in the tenant can view the asset. Visible to specific users/Not visible to specific users: The asset is only visible to specified users or user groups. By user: Select active users from the current tenant. By user group: Select active and enabled user groups. The member list is automatically updated based on changes in the user group. To create a user group, see Create and manage user groups.
	Data profiling report	The data profiling report is available only if data profiling is enabled for the asset in the asset inventory (requires the Data quality module). You can set its visibility to Visible to all users, Visible to specific users, or Not visible to any users. The configuration is the same as for Visibility.
	Data lineage	If you enable this option, the asset details page in the asset catalog displays the complete, direct data lineage, including unlisted objects and objects you do not have permission to view. However, you cannot view the details of those objects.
	Quality profile	If you enable this option, the asset details page displays a quality profile, including scores for the six quality dimensions (Completeness, Uniqueness, Timeliness, Validity, Consistency, and Stability) and the results of monitoring rules. Selecting Hide quality rule validation details hides the rule validation details in the quality profile on the asset details page.
	Metadata change history	To configure this option, you must first enable metadata change versioning on the Metadata > Metadata Change History page. Once enabled, the metadata version history is visible on the asset details page. To change the maximum number of versions to retain, see Metadata Change History.
	Data consumption	If you enable this option, users can apply for data consumption permissions from the asset details page in the asset catalog.
Associated row-level security		If you have enabled the row-level security feature, this section displays information about the row-level security policies associated with the asset, including Policy Name, Control Rules, and Associated Fields. You can view the control rules or edit the policy. View Control Rules: Click the View icon next to the number of control rules to see the rules within that policy. Edit: Click Edit to go to the Management Center > Permission Management > Row-Level Security Management page. The system automatically filters for policies associated with this asset, allowing you to modify them. For more information, see Add and manage row-level security policies.

Business metric

Business metrics represent business requirements in a standardized form that developers can act on. Associating them with technical metrics simplifies metric analysis for business personnel.

To create a business metric, click Create Business Metric on the quasi-asset page. The procedures for creating and editing are identical.

Parameter		Description
Basic information	Name	Enter a globally unique name for the business metric. The name can contain English letters, numbers, and the following special characters: `-_/\·#$^&*()%+-=`. The name can be up to 256 characters long.
	Display name	Enter a display name for the asset, up to 1,000 characters long. You can click Fill in Asset Name or Fill in Asset Description to quickly populate this field.
	Parent directory	Select one or more published directories under the metric subject.
	Tag	Select up to 20 tags. If your account has the Listing Management-Manage permission, you can click Tag Management to create new tags on the Asset > Directory Management > Other Settings > Basic Settings page.
	Description	Enter a description for the asset, up to 1,000 characters long.
Metric definition	Metric definition	You can add a metric definition in two ways: through custom input or by referencing another business metric. This definition helps business personnel understand the metric. Custom input: Enter the metric definition, up to 2,000 characters long. Reference business metric: Click Reference Business Metric to select and add a business metric. Alternatively, type @ in the configuration box to perform a fuzzy search by name or display name, or enter keywords to find and add metrics. In the configuration box, use operators to define the relationships between selected metrics. Supported operators include plus (+), minus (-), multiply (*), divide (/), parentheses (), percent (%), and sum (∑).
	Related business metrics	Related business metrics: Click Add Related Business Metrics to add other business metrics related to the current one. This provides a more comprehensive understanding of the business context and data relationships. Related business metrics list: Displays the business metrics you have added and those automatically parsed from the metric definition. You can configure the relationship between the current business metric and the added metrics, including Positive Correlation, Negative Correlation, or Other. You can also edit or delete them. Edit: Click to navigate to the edit page for the metric at Asset > Directory Management > Business Metric to modify its information. Delete: Deleting a metric also removes it from the metric relationship expression, which may leave the expression incomplete. This action cannot be undone, so proceed with caution. Metrics automatically parsed from the metric definition cannot be deleted here. Instead, remove them in the metric definition configuration box. Note You can associate a maximum of 100 business metrics.
	Metric relationship diagram	Based on the related business metrics you have added, you can configure a metric relationship diagram to clearly and intuitively break down the metric's composition. This feature is disabled by default. When enabled, click the Edit icon to open the Configure Metric Relationship Diagram dialog box. A diagram starting with the current metric node is displayed. You can configure the calculation logic for related business metrics on the right. Click OK to save the configuration. The diagram can be viewed when editing the business metric. Canvas: On the left canvas, the first level of the metric relationship automatically updates based on changes to the definition on the right. From the second level onward, the diagram displays the latest saved relationship diagram starting from the current metric (the second-level metric). Metric configuration area: In the Metric Relationship Expression Configuration box on the right, configure the metric's calculation logic and click OK to save the configuration. The system automatically parses business metrics and operators from the metric definition. You can also select a metric from the Business Metric Area to add it. Alternatively, type @ in the configuration box to perform a fuzzy search by name or display name, or enter keywords to find and add metrics. In the configuration box, use operators to define the relationships between selected metrics. Supported operators include plus (+), minus (-), multiply (), divide (/), parentheses (), percent (%), and sum (∑). Note* You must configure at least one related business metric to enable the metric relationship diagram. You can only edit the calculation logic for the current metric. By default, the diagram expands to 10 levels. You can manually expand it further. If a node appears multiple times in the diagram, only the downstream path of its first occurrence can be expanded. Subsequent instances of the same node cannot be re-expanded to prevent loops or content duplication.
Attribute information	Business attributes	Displays the system and custom attributes of the asset. You can select Hide Read-only Attributes in the upper-right corner to focus on editable information. System attributes: Business attributes - Business owner: Select an active user from the current tenant. Custom attributes: The input method depends on how the business metric attributes are configured. For example, if 'Change Management' is configured as a single-select drop-down with options 'Yes' and 'No', then when editing the business metric, this attribute appears as a drop-down list with 'Yes' and 'No' as its options. For more information on attribute configuration, see Create and Manage Development Object Attributes. When the attribute value is a hyperlink, the link must start with `http://` or `https://` to be clickable. Entering only spaces is not supported. The maximum character length depends on the attribute's configuration and cannot exceed 10,000 characters.
Associated technical metrics	Associate technical metrics	Associate technical metrics: Select from existing technical metrics within the current tenant. Each technical metric can be associated only once. You can associate up to 100 technical metrics. Search for technical metrics by name, display name, or description, or click the Filter icon to filter by asset source or status. Associated technical metrics list: Displays information about the selected technical metrics, including name, statistical granularity, statistical period, description, parent summary table, and data type. You can perform the following operations: View summary table: Hover over the View icon next to the summary table name to view its information. Delete: If a metric does not meet business needs, click the Delete icon to remove it.
Usage instructions	Enable	Disabled by default. When enabled, usage instructions appear on the asset details page in the asset catalog. You can add instructions to introduce the asset and guide data consumers. This helps users assess the asset's suitability and provides justification when they request access permissions. Note A hyperlink must begin with `https://` or `http://` to be clickable. Each image or video uploaded for an asset must be 20 MB or less.
Permission control	Visibility scope	This setting controls the asset's visibility in the asset catalog but does not affect its visibility within its summary table. Three visibility scopes are available: Visible to all users: All users in the tenant can view this asset. Visible to some users/Invisible to some users: The asset is visible only to specified users or user groups. Select by user: Select active users from the current tenant. Select by user group: Select active and enabled user groups. The member list updates automatically as the user group changes. To create a user group, see Create and Manage User Groups.

Technical indicator

Parameter		Description
Basic information	Name	Displays the name of the asset. This field is read-only.
	Display name	Enter a display name for the asset, up to 1,000 characters. You can click Fill in Asset Name or Fill in Asset Description to quickly populate this field with the asset's name or description.
	Parent directory	Select one or more published directories from the indicator topic.
	Tag	Select up to 20 tags. If your account has the Listing Management-Manage permission, click Tag Management to go to Asset > Directory Management > Other Settings > Basic Settings and create new tags.
	Indicator definition	This field is displayed only for modeled indicators. It shows the indicator definition entered in Development > Develop > Indicator.
	Description	Enter a description for the asset, up to 1,000 characters.
Attribute information	Business attribute/Technical attribute	Displays the system and custom attributes of the asset. In the upper-right corner, you can select Hide Read-only Attributes to focus on editable attributes. System attribute: Business attribute: Includes the subject domain and associated business indicator information. Associated business indicator: You can select a business indicator created in the current tenant. Click the View icon next to the selection box to view information about the indicator. Clicking View Details in the dialog box redirects you to the corresponding Business Indicator > Published Asset or Business Indicator > Staged Asset page. Technical attribute: Includes indicator type (requires Intelligent R&D Edition), asset source, aggregation table, data domain, business qualifier, atomic indicator, granularity, statistical period, data type, unit of measure, additivity, asset import name, collector adapter type, and collector adapter information. Aggregation table: The name of the table from which the indicator is derived. You can click Edit Table Information (requires table asset maintenance permission) to go to the table asset's edit page. Atomic indicator/Business qualifier: If the indicator or qualifier is from standard modeling, it is read-only. If it is custom, you can enter up to 128 characters. Granularity: For custom indicators, you can click to view the name, code, description, and data domain of the related business objects. For modeled indicators, you can also click View Details to go to the data domain page in Planning > Data Architecture, which automatically filters the list to the business entity for the granularity. Note You specify the granularity of a custom indicator when editing its source table. This setting takes effect automatically after the table is published. If the granularity status is "Updated but not published", you can click Publish to publish the indicator's source summary table and then view the latest granularity. Statistical period: If from standard modeling, it cannot be modified. If custom, you can select a statistical period for the indicator. To create a new one, see Create Statistical Period. Unit of measure: If from a modeled indicator, it cannot be modified. If custom, you can select and modify a unit of measure for the indicator, up to 32 characters. Additivity: Indicates if the indicator can be summed across various dimensions. For modeled indicators, this property is inherited from the associated atomic indicator. Supported values are Additive, Semi-additive, and Non-additive. Additive: Can be summed across all dimensions such as time, geography, and product category. Examples: sales amount, order count, and inventory quantity. Semi-additive: Can be summed across some dimensions but not others. For example, inventory level can be summed across products or locations, but not across time, as it represents a point-in-time state. Non-additive: Cannot be aggregated by simple summation. Examples include percentages, averages, and interest rates. For example, you cannot compute the average customer satisfaction for a month by summing daily averages and dividing by the number of days; you must use a weighted calculation. Custom attribute: The required format depends on the configuration of the technical indicator attributes. For example, if a "Change Management" attribute is configured as a single-select drop-down list with "Yes" and "No" options, you will see a drop-down list with these two options when editing the table asset. For more information, see Create and Manage R&D Object Attributes. When the attribute value is a hyperlink, it must start with `http://` or `https://` to be a clickable link. Entering only spaces is not supported. The maximum character length depends on the attribute's configuration, up to 10,000 characters.
Usage instructions	Enable	This feature is disabled by default. If enabled, the usage instructions are visible on the asset details page in the asset catalog. You can add instructions to introduce the asset and guide data consumers in evaluating its usability and applying for access. Note For a link to be clickable, it must start with `https://` or `http://`. Each uploaded file must be 20 MB or less.
Access control	Visible Scope	Controls whether the asset is visible in the asset catalog. This setting does not affect the indicator's visibility in the aggregation table. Three visibility options are supported: Visible to All Users: All users in the tenant can view the asset. Visible to Some Users/Invisible to Some Users: Only specified users or user groups can view the asset. You can specify members by user or user group. Select by User: Select active users in the current tenant. Select by user group: Select active user groups. The membership is automatically updated when the user group changes. To create a user group, see Create and Manage User Groups.
	Data profiling report	To view a data profiling report, enable data profiling for the asset in the asset inventory (requires the Data Quality feature). It supports Visible to All Users, Visible to Some Users, and Invisible to All Users. The configuration is the same as for the visibility scope.
	Data lineage	When enabled, the asset details page displays the complete direct data lineage. This lineage includes staged assets and objects for which you do not have view permissions, although you cannot view their details.
	Indicator relationship diagram	When enabled, the asset details page shows an indicator relationship breakdown diagram rooted at this indicator. This helps you understand the indicator derivation logic. Selecting Hide SQL Calculation Logic hides the calculation logic in the indicator details dialog box in Asset Catalog > Asset Details.
	Quality overview	When enabled, the asset details page displays a quality overview, including scores for six quality dimensions (Completeness, Uniqueness, Timeliness, Validity, Consistency, and Stability) and monitoring rule statistics. Selecting Hide Quality Rule Check Details hides these details in the Quality Overview section of the asset details page.

API asset

Parameter		Description
Basic information	API_ID	Displays the ID of the asset. This field cannot be modified.
	API name	Displays the name of the asset. This field cannot be modified.
	Directory	Select one or more published directories from the API topic.
	Tag	Select up to 20 tags. If your account has the Listing Management-Manage permission, you can click Tag Management to go to the Asset > Directory Management > Other Settings > Basic Settings page to create tags.
	Description	This field displays the API's original description by default. You can edit the description, which has a 128-character limit.
Attribute information	Business Attributes/Management Attributes/Technical Attributes	Displays the asset's system and custom attributes. In the upper-right corner, select Hide Read-only Properties to view only editable fields. System attribute: Technical attributes: Includes asset source, API group, API type, operation type, data volume, max input records, protocol, invocation mode, return type, data update frequency (only for GET and LIST operation types), cache settings (only for GET and LIST operation types), timeout, execution timeout (only for asynchronous invocation mode), collection adapter type, and collection adapter information. Custom attribute: The input rules are based on the attribute's configuration. For example, an attribute configured as a single-select drop-down list will appear with its predefined options (e.g., "Yes" and "No") during asset editing. For more information about attribute configuration, see Create and manage R&D object attributes. Hyperlink values must start with `http://` or `https://` to be clickable. Values cannot consist only of spaces. The maximum character length depends on the attribute's configuration and can be up to 10,000 characters.
Business Parameter Request List, Public Parameter Request List, and Response Parameter List		Displays the business request parameters, public request parameters, and response parameters for the API. For details, navigate to the API Documentation for the target API on the Service > Market > API tab.
Row-level permission list		Displays the API's enabled row-level permissions. For details, go to the Service > Development > API page and select the target API.
Usage Instructions	Enable	This feature is disabled by default. When enabled, the instructions you provide here appear on the asset's details page. Use these instructions to help data consumers evaluate the asset and justify their access requests. Note Links must start with `https://` or `http://` to be active. Each uploaded image or video must not exceed 20 MB.
Access control	Visibility Scope	Controls the asset's visibility in the asset catalog. The available options are: Visible to all users: All users in the tenant can view the asset. Visible to some users/Not visible to some users: Makes the asset visible to, or hidden from, specified users or user groups. Select by User: Select active users in the current tenant. Select by User Group: Select active and enabled user groups. The membership updates automatically to reflect changes in the user group. To create a user group, see Create and manage user groups.

Dashboard asset

Parameter		Description
Basic information	Dashboard name	Displays the name of the asset. This field is read-only.
	Parent directory	Select one or more published directories under the dashboard topic. The root directory cannot be selected.
	Tags	You can select up to 20 tags. If your account has the Listing Management-Manage permission, you can click Tag Management to navigate to the Assets > Catalog Management > Other Settings > Basic Settings page and create new tags.
	Description	Enter a description for the asset. The description can be up to 1,000 characters long.
Attribute information	Business attribute/Management attribute/Technical attribute	Displays the system and custom attributes for the asset. Select Hide Read-only Attributes in the upper-right corner to focus on editable information. System attributes: Management attributes: Includes asset source, parent BI workspace, parent BI directory, owner, last modified by, last modified time, collaboration authorization policy, public status, and public expiration date. Technical attributes: Includes source dataset, total number of charts, third-party embedding status, collection adapter type, and collection adapter information. Custom attributes: The required format depends on the dashboard attribute configuration. For example, if a "Change Management" attribute is configured as a single-select drop-down list with "Yes" and "No" as options, it will appear as that drop-down list when you edit the asset. For more information about attribute configuration, see Create and manage R&D object attributes. When the property value is a hyperlink, the link must start with `http://` or `https://` to be active. The value cannot consist of only spaces. The character length is determined by the property configuration and cannot exceed 10,000 characters.
Chart information		This section displays detailed information about the charts on the current dashboard, which you can view on the Governance > Metadata > Metadata List > Dashboard tab. Chart display name: Enter a display name for the chart. The name can be up to 256 characters long. Click Quickly Fill Name to use the dashboard's name as the display name. Chart description: Enter a description for the chart. The description can be up to 1,000 characters long. Click Quickly Fill Name to use the dashboard's name as the description.
User guide	Enable	This feature is disabled by default. If enabled, the user guide is visible on the asset details page in the asset catalog. Use this guide to introduce the asset and provide instructions for data viewers, helping them evaluate its usability and request access permissions. Note Links must start with `https://` or `http://` to work. Each image or video uploaded for an asset must be 100 MB or smaller.
Access control	Visible Scope	Determines the asset's visibility in the asset catalog. The following options are available: Visible to all users: All users in the tenant can view the asset. Visible to some users/Hidden from some users: The asset is visible only to specified users or user groups. You can specify members by user or user group. By user: Select active users from the current tenant. By user group: Select active and enabled user groups. The visibility list updates automatically when the user group's membership changes. To create a user group, see Create and manage user groups.

Intelligent generation

Dataphin uses large language models (LLMs) to generate basic information for tables, fields, and business metrics from table assets, reducing manual data configuration effort.

Note

On the intelligent generation page, the first row displays the existing configuration, and the second row shows the intelligently generated information. You can only edit the generated information.
Generating information for a large number of fields or technical metrics can be time-consuming. Please be patient while the process completes.

On the pre-asset tab, click the Edit icon in the Actions column of the target asset to open the Edit Asset page.

On the Edit Asset page, click the Intelligent Generation button in the upper-right corner to open the intelligent generation page. The system generates basic information for the current asset (for technical metric assets, only basic information can be edited), field information, and table-related metric information. You can modify the generated information.

Table asset

Parameter		Description
Basic information	Display name	The system intelligently generates a display name, which you can modify. The display name must be 256 characters or less.
	Directory	The system recommends published directories from the table's subject area. You can select multiple directories.
	Tag	The system intelligently recommends tags. You can select up to 20 tags.
	Description	The system will intelligently generate content based on your custom description (up to 1000 characters), and you can modify the generated content.
Field information	Field display name	The system intelligently generates a display name for the field, which you can modify. The display name must be 512 characters or less.
	Description	The system intelligently generates a description for the field, which you can modify. The description must be 2,048 characters or less.
	Business type	You can select from three business types: dimension, metric, and statistical period. Click Clear to remove all business type information at once. Dimension: When a field name is `id` (case-insensitive), its `business type` is automatically set to dimension. You can change this setting. Metric: For non-measure fields, the system determines if the field is a metric by analyzing its name, display name, and description. If it is, the `business type` is set to metric. You can change this setting. Examples include refund rate, total refund amount, and top 3 purchases per capita. For measure fields, if the data type is `bigint, double, int, smallint, tinyint, float`, the `business type` is automatically set to metric. You can change this setting. Statistical period: If a field's data type is `date, datetime, timestamp`, its `business type` is automatically set to statistical period. You can change this setting.
	Associated entity	This field applies only when the field's `business type` is dimension. The system automatically populates this field with a business entity from the corresponding data domain. You can change this selection. If a field is already associated with a business entity, changing its `data domain` also updates the `business entity`.
	Intelligently generate related metrics	You can click the Intelligently Generate Related Metrics button only if the field's business type includes metrics. If the business type also includes dimensions, you must first select a Data Domain in the field information area before you can click the Intelligently Generate Related Metrics button. Clicking the button generates a list of related metrics.
Intelligently generate related metrics	Metric	Fields with a `business type` of metric are added as metric information. You can modify this information on the metric editing page.
	Directory	The system intelligently recommends up to five published directories from the table's subject area, including those already added. You can select multiple directories.
	Tag	The system intelligently recommends up to eight tags, including those already added. You can select up to 20 tags.

Technical metric

Parameter		Description
Basic information	Display name	The system intelligently generates a display name for the metric, which you can modify. The display name must be 256 characters or less.
	Directory	The system recommends published directories from the metric's subject area. You can select multiple directories.
	Tag	The system intelligently recommends tags. You can select up to 20 tags.
	Description	The system intelligently generates a description for the asset, which you can modify. The description must be 1,000 characters or less.

After you confirm that the generated information for related metrics is correct, click Save. If the saved information does not meet your needs, you can click Clear in the upper-right corner to remove the directory and tag information for the metrics.
After confirming that all information is correct, click Apply to populate the Edit Asset page with the generated information.
You can perform the following actions on all generated information:
- Retry: Regenerates the related metrics or all information.
- Discard: Discards the currently generated related metrics or all information.
- Terminate: Stops the in-progress generation of related metrics or all information.
- Resume Generation: Resumes the stopped generation of related metrics or all information.