Manage prospective assets - Dataphin - Alibaba Cloud Documentation Center

The prospective assets list displays assets that are collected from specified data sources through collection adapters or obtained from the data mid-end. This topic describes how to view and manage these prospective assets.

Prerequisites

You must enable X-Data Steward on the Super X > Intelligent Application Management > Intelligent Applications page to use the intelligent generation feature.
For Table, Metric, or Dashboard assets: You must have purchased the Asset Operation value-added service, and the current tenant must have activated the Asset Operation module.
For API assets: You must have purchased the Asset Operation value-added service and the DataService Studio feature.
You must create an application system and a Quick BI collection task before you can manage dashboard assets. For more information, see Create and manage application systems and Create and manage metadata acquisition tasks.

Permission description

Super administrators, operations administrators, and custom global roles with the Listing Management - Manage permission can create, list, and manage prospective assets.
Operations personnel for business systems and maintenance personnel with asset maintenance permissions can manage assets within the business systems for which they are responsible.

Operation instructions

In the top menu bar of the Dataphin home page, choose Asset > Catalog Management.
In the navigation pane on the left, click Manual Listing > the desired asset type to go to the Pending page.
The prospective assets list displays assets that are collected from specified data sources through collection adapters or obtained from the data mid-end. The list includes information such as asset name, metric type, associated technical metrics, asset source, catalog, latest status, information completeness, whether the asset was previously listed, asset import time, latest data timestamp, and last update time.
- Asset Source: The source of the asset object. The source for assets from the Dataphin data mid-end is Dataphin, which contains only logical tables. The source for API assets is a DataService Studio project. The source for Quick BI dashboards is a Quick BI workspace.
- Status: For assets with a status of Listing Failed, you can hover over the icon next to the status to view the reason for the failure. After you make the necessary changes, you can list the asset again.
- Completeness: Indicates whether the required attributes of the asset are complete and valid.
- Previously Listed: Indicates whether the asset was delisted and then listed again.
(Optional) You can filter assets by metric type, asset source, BI workspace or directory, latest status, catalog, information completeness, whether the asset was previously listed, asset import time, latest data timestamp, or last update time. You can also search for assets that match specific criteria.

In the Actions column of the target asset, you can perform the following operations. The available operations are the same for different asset types. This topic uses a table asset as an example. You can select up to 10,000 assets for a single batch operation.

Operation	Description
Edit	Modify the basic information and usage instructions of the asset, and configure the visibility permissions. For more information, see Edit asset information.
List	Click List, or select one or more assets and click List at the bottom, to list the assets in the asset catalog. If an approval rule is configured for an asset, the listing request must be approved. The approval comments cannot exceed 100 characters. After the request is approved, the asset is listed in the asset catalog. If no approval rule is configured for an asset, it can be listed directly. Note Only assets with all required information configured can be listed. After a table asset is listed, the custom metric assets under the table can be listed. Only users and roles with asset maintenance permissions can list assets. Only prospective assets with a status of Unlisted or Listing Failed can be listed. The names of listed business metrics must be unique within the tenant.
Unlisted	Click Private and enter a reason to change the asset status to Private. Private assets are not displayed in the asset catalog. To edit a private asset, first change its status to prospective. Note Making a table asset private also applies to its custom metrics, but skips metrics for which you do not have maintenance permissions. When you list a custom metric, if its parent table is private, you must change the table asset's status to prospective before you can list the metric asset.
Set Maintenance Permissions	This operation is not supported for business metrics. Single operation: Click Set maintenance permissions to configure the maintenance personnel for the asset. They are responsible for daily maintenance, including modifying information and managing listing status. Batch operation: Click Set maintenance permissions at the bottom to add or modify maintenance personnel in batches. Modify: Replaces the maintenance personnel of the selected assets with the personnel specified in this operation. Append: Keeps the existing maintenance personnel of the selected assets and adds the personnel specified in this operation.
View Change Records	Displays the change records of a single asset for the last 30 days, including attribute and status changes, for traceability. Note For custom metrics, changes to the statistic granularity correspond to changes in fields defined as dimensions in the parent table. These changes take effect when the table is listed.
Delete	This operation is supported only for business metrics. When the status of a business metric is Unlisted, Private Failed, or Listing Failed, you can delete the business metric. This also removes the associations between the business metric and any related technical metrics.
Modify Attributes	After selecting assets, click Modify attributes at the bottom to modify the attributes of the assets on the batch modification page. Compared to editing a single asset, some attributes support more flexible configuration. Add all required attributes: Click to quickly add all attributes that must be configured before the current asset type can be listed. Table display name/Description: Supports referencing DDL comments and custom settings. You can choose to apply this setting only to assets with an empty display name. If you do not select this option, the configured display names of the selected tables are overwritten. Reference DDL Comment: Uses the table's comment as the asset's display name or description. The display name or description is automatically updated when the DDL comment changes. Custom: Lets you select Table/Column Name or DDL Comment as the asset's display name. You can also select DDL Comment as the asset's description or set the description to Empty. Field display name/Description: Supports referencing DDL comments and custom settings. You can choose to apply this setting only to assets with an empty display name. If you do not select this option, the configured display names of the selected fields are overwritten. Reference DDL Comment: If you select Apply only to assets with an empty display name, this setting takes effect for all fields in the current table that have an empty display name or description. It uses the data field's comment as the asset's display name or description. The display name or description is automatically updated when the DDL comment changes. Custom: If you select Apply only to assets with an empty display name, this setting takes effect for a single field in the current table that has an empty display name or description. Lets you select Column Name or DDL Comment as the asset's display name. You can also select DDL Comment as the asset's description or set the description to Empty. Note The display name and description of fields must be uniformly configured for all fields in the table. You can either reference DDL comments or use custom settings for all fields. If you change the setting for the field display name or description from Reference DDL comment to Custom and select Apply only to assets with an empty display name, the setting takes effect only if the DDL comments for all fields in the current table are empty. If you change the setting for the field display name or description from Custom to Custom and select Apply only to assets with an empty display name, the setting takes effect if any single field in the current table is empty. Catalog/Asset tags/Related business metrics: Supports appending updates to existing configurations, or modifying existing configurations according to the latest current configuration. If your account has Listing Management-Manage permissions, click the Tag Management button to go to the Asset > Catalog Management > Other Settings > Basic Settings page and create new tags. Business owner: This setting can be modified only for business metrics. Visibility scope/Data exploration report: Controls whether to display the corresponding content on the asset details page in the asset catalog. Atomic metric/Business filter/Statistical period/Measurement unit: These settings can be modified only for custom technical metrics. Is additive/Associated business metrics: These settings can be modified only for technical metrics. Lineage/Quality overview: These settings can be modified only for table and metric assets. They control whether to display the corresponding content on the asset details page in the asset catalog. Metric relationship diagram: This setting can be modified only for metric assets from standardized modeling. It controls whether to display the corresponding content on the asset details page in the asset catalog. Metadata change records: This setting can be modified only for table assets. It controls whether to display the corresponding content on the asset details page in the asset catalog. Other custom attributes: You can configure other custom attributes for assets in Planning > Attribute Management to enrich asset information. Note For API and dashboard assets, you can modify the system attributes for catalog, asset tags, and visibility scope. For business metric assets, you can modify the catalog, asset tags, business owner, visibility scope, and related business metrics. When the table type is physical table, physical view, materialized view, or data source table, the display names and descriptions of the table and its fields can reference DDL comments as asset attributes.
Intelligent Generation	This operation is supported only for table and technical metric assets. Intelligent generation is only applicable to editable assets. Select the assets for which you want to generate information, click Intelligent generation at the bottom, and configure the information in the Create Intelligent Generation Task dialog box. For more information, see Intelligent generation.
Export Assets	Click Export assets at the bottom to batch export the selected assets. The system automatically skips assets for which you do not have maintenance permissions. If you export many assets, file generation may take some time. You can view the export operation details and download the file in Batch Management - Batch Operation Records.

Note

Some attribute changes, such as to catalogs and tags, require you to relist the asset for the changes to appear in the asset catalog. Changes to other attributes, such as fields and dashboard chart information, do not require relisting. The asset catalog always displays the latest attributes.
If a listed asset is deleted, the Relisting Required column displays Yes. You must relist the asset to maintain data consistency and availability.
If an asset is deleted, you can only view it.

Edit asset information

Note

When you save a table asset, corresponding metric assets are automatically generated.
If you select Save And List Related Metrics at the bottom, the table asset and its related metric assets are listed simultaneously.
List the table before you list its custom metrics.
When the table type is physical table, physical view, materialized view, or data source table, the display names and descriptions of the table and its fields can use DDL comments as their asset attributes.

Table assets

Parameter		Description
Basic information	Name	Displays the name of the asset. You cannot modify the name.
	Display Name	Enter the display name for the asset. You can reference a DDL comment or define a custom name. Reference DDL Comment: Uses the 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 use the asset's name or description as its display name.
	Catalog	Select one or more published folders under the table subject.
	Tag	Select up to 20 tags. If your account has Listing Management-Manage permissions, click the Tag Management button to go to the Asset > Catalog Management > Other Settings > Basic Settings page and create new tags.
	Description	You can reference a DDL comment or define a custom description. Reference DDL Comment: Uses the 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 Attribute/Management Attribute/Technical Attribute	Displays the system and custom attributes of the asset. You can select Hide read-only attributes in the upper-right corner to focus on the attributes that you need to edit. System attributes: Business attributes: Includes subject area information. Management attributes: Includes system information. Technical attributes: Includes asset source, section or project, database type, project, table type, asset import name, collection adapter type, and collection adapter information. Custom attributes: The required format depends on the configuration of the table attributes. For example, if the input method for Change Management is a drop-down list with the options Yes and No, then when you edit a table asset, this attribute is a drop-down list with Yes and No as the available enumeration values. For more information about attribute configuration, see Create and manage development object attributes. If the attribute value is a hyperlink, the link prefix must be `http://` or `https://` for the link to be effective. Entering only spaces is not supported. The character length depends on the attribute configuration and cannot exceed 10,000 characters.
Field information	Ordinal Number	You can click the Sort icon next to the ordinal number to sort the fields by their ordinal number.
	Field Name	You can click the Sort icon next to the field name to sort the fields by their name.
	Data Type	Displays the data type of the field.
	Field Display Name	Enter the display name for the field. You can reference a DDL comment or define a custom name. Reference 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. The name can be up to 512 characters long. You can hover over Quick Fill and select Use Description or Use Name to quickly use the field's name or description as its display name.
	Description	You can reference a DDL comment or define a custom description. Reference 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. The description can be up to 2,048 characters long.
	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 business type of the field is dimension, you can select a published business entity from the data section. If no suitable business entity is available, click Create Business Entity to create one. For more information, see Create and manage business entities. If the field is already associated with a business entity, you must reselect the business entity after changing the data section. If the table type is logical dimension table or logical fact table, the associated entities configured for the associated dimensions on the logical table editing page in Developer > Develop are displayed. Click the View icon next to an associated entity to view its information, including role name (such as buyer or seller), entity name (code), description, section, and subject area. You can also perform the following operations: View details: Click to go to the business entity tab on the Planning > Data Architecture page to view detailed information. View Entity Relationship Diagram: Click to open the Entity Relationship Diagram panel and view the entity relationship diagram centered on this business entity.
	Data Class	You must activate the Data Security module to view the data classification information of the field.
	Data Sensitivity Level	You must activate the Data Security module to view the data sensitivity level information of the field. You can click the Sort icon next to the data sensitivity level to sort the fields by their data sensitivity level.
	Operation	Batch Edit: Click the Batch Edit button. In the Batch Edit panel, modify the field display name, description, business type, and associated entity in batches. Then, click the OK button to apply the changes to the field information list. The field display name and description support referencing DDL comments and custom settings. The configuration is the same as for a single field. Batch set dimension/metric: In the field list, select the target fields and set them as dimensions or metrics in batches.
Related metrics		When you set the business type of some fields to Metric, you can view the related metrics list. This list displays the metric's name, listing status, catalog, tags, atomic metric, business filter, statistical period, and measurement unit. You can perform the following operations on the metrics. You must have maintenance permissions for the metric assets to perform these operations. Batch edit: Click the Batch Edit button. In the Batch Edit panel, select the metrics that you want to modify, click the batch operation at the bottom to modify the information in batches, and then click OK to apply the changes to the related metrics list. Catalog/Tags: Supports batch appending or modifying published metric catalogs or tags. You can add up to 20 tags. Atomic Metric/Business Filter: Supports batch modifying the atomic metric or business filter of metrics. The input can be up to 128 characters long. Statistical Date: Supports batch configuring the statistical period of metrics. Measurement Unit: Supports batch configuring the measurement unit of metrics. The unit can be modified and can be up to 32 characters long. Modify catalog: Supports selecting published folders under the metric subject. Modify tags: Supports adding up to 20 tags to a metric. Atomic metric/Business filter: Supports entering the atomic metric or business filter of the metric. The input can be up to 128 characters long. Statistical period: Supports selecting the statistical period of the metric. For more information, see Create a statistical period. View business entity: In the upper-left corner of the related metrics list, click the view icon to view business entity information. Click View Details to go to the Planning > Data Architecture page for more information. When dimensions change, the update type (new or deleted) of the statistic granularity is highlighted. In the upper-right corner of the related metrics list, select Table Attributes Overwrite Unlisted Metric Attributes. Then, when you save the table asset, the display name, description, visibility scope, data exploration report attributes, lineage, quality overview, and asset maintenance personnel of unlisted metrics will use the configuration of the table asset.
Usage instructions	Enable	This feature is disabled by default. When enabled, you can view the usage instructions on the asset details page in the asset catalog. You can add usage instructions for the asset to provide an introduction and guidance for data viewers, and to help users evaluate asset availability and request consumption permissions. Note The link prefix must be `https://` or `http://` for the link to be effective. Each image or video uploaded for an asset must be no larger than 100 MB.
Access control	Visible To	Affects whether the asset is visible in the asset catalog. Three visibility scopes are supported: Visible To All: All users under the tenant can view the asset. Visible To Specific Users/Invisible To Specific Users: Only specified users or user groups can view the asset. You can specify members by user or user group. Select by user: Select users with a Normal status under the current tenant. Select by user group: You can select user groups with a Normal and Enabled status. Members are automatically updated with changes in the user group. For more information, see Create and manage user groups.
	Data Exploration Report	You must enable data exploration in the asset checklist to view the data exploration report. This requires activating the Data Quality feature. Three visibility scopes are supported: Visible To All, Visible To Specific Users, and Not Visible To All Users. The configuration is the same as for the visibility scope.
	Lineage	When enabled, you can view the complete direct lineage on the asset details page in the asset catalog. This includes unlisted objects and objects for which you do not have view permissions. However, you cannot view the detailed information of these objects.
	Quality Overview	When enabled, you can view the six quality scores (completeness, uniqueness, timeliness, validity, consistency, and stability) and monitoring rule statistics on the asset details page in the asset catalog. If you select Hide Quality Rule Validation Details, you cannot view the quality rule validation details in the quality overview on the asset details page in the asset catalog.
	Metadata Change Records	You must enable metadata change version recording on the Metadata > Metadata Change Records page before you can configure it here. When enabled, you can view the version change records of metadata on the asset details page in the asset catalog. To modify the maximum number of versions that can be retained, see Metadata change records.
Associated row-level permissions		If you have activated the row-level permissions feature, you can view the row-level permission information associated with the asset, including permission name, control rules, and foreign key fields. You can view control rules and go to the editing page. View control rules: Click the View icon next to the number of control rules to view the control rule information under the permission. Go To Edit: Click Go To Edit to go to the Management Center > Permission Management > Row-level Permission Management page. The system filters for the row-level permission information associated with the asset, which you can then modify. For more information, see Add and manage row-level permissions.

Business metrics

Business metrics serve as a bridge between development and business requirements, providing a standardized way for developers to better understand business needs. The relationship between business and technical metrics can also offer insights for metric analysis, which makes it easier for business personnel to understand and use metrics.

On the prospective assets page, click the Create Business Metric button to create a business metric. The creation and editing process is the same.

Parameter		Description
Basic information	Name	Enter the name of the business metric. The name must be globally unique and can contain English letters, digits, and the following special characters: `-_/\·#$^&*()%+-=`. The name can be up to 256 characters long.
	Display Name	Enter the display name of the asset. The name can be up to 1,000 characters long. You can click Use Asset Name or Use Asset Description to quickly use the asset's name or description as its display name.
	Catalog	Select one or more published folders under the metric subject.
	Tag	Select up to 20 tags. If your account has Listing Management-Manage permissions, click the Tag Management button to go to the Asset > 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.
Metric definition	Metric Definition	Define the metric to help business personnel understand it. You can add a definition in two ways: Custom input: Enter a definition up to 2,000 characters long. Reference Business Metrics: Click Reference Business Metrics to add a metric. You can also type the at sign (@) in the configuration box to search for metrics by name or display name, or type keywords to search. Use operators in the configuration box to define the relationships between metrics. Supported operators include plus (+), minus (-), multiply (*), divide (/), parentheses (), the percent sign (%), and sum (∑).
	Related Business Metrics	Related business metrics: Click the Add Related Business Metrics button to add other business metrics related to the current one. This provides a more complete understanding of the business meaning and data relationships. Related business metrics list: Displays information about 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 ones, including Positive Correlation, Negative Correlation, and Other. You can also edit and delete the relationships. Edit: Click to go to the editing page for that metric at Asset > Catalog Management > Business Metrics to modify the metric information. Delete: This also deletes the metric object from the relational expression, which may make the expression incomplete. This operation cannot be undone. Proceed with caution. Business metrics that are automatically parsed from the metric definition cannot be deleted from this list. You can delete them in the metric definition configuration box. Note You can associate up to 100 business metrics.
	Metric Relationship Diagram	Supports configuring a relationship diagram based on the added related business metrics. This diagram can clearly and intuitively break down the processing logic of the business metric. This feature is disabled by default. When enabled, click the Edit icon. In the Configure Metric Relationship Diagram dialog box, a diagram starting from the current metric node is displayed. You can configure the processing logic of related business metrics on the right. Click OK to complete the configuration. You can view the configured diagram when editing the business metric. Canvas: The first layer of the metric relationship on the left canvas is automatically updated as the logic on the right changes. From the second layer onwards, the most recently saved relationship diagram starting from the current metric (the second-layer metric) is displayed. Metric configuration area: In the Metric Relational Expression configuration box on the right, configure the metric processing logic and click OK. The system automatically parses business metrics and operators from the metric definition. You can also select a metric from the Business Metrics Area to add it. Alternatively, in the configuration box, enter the at sign (@) to perform a fuzzy search by metric name or display name, or enter metric keywords to search directly. Use operators to define the relationships between the selected metrics in the configuration box. Supported operators include plus (+), minus (-), multiply (), divide (/), parentheses (), the percent sign (%), and sum (∑). Note* You must configure at least one related business metric to enable the metric relationship diagram. You can only edit the processing logic of the current metric. By default, the metric relationship diagram expands to 10 layers. You can manually expand it further. If there are duplicate nodes in the diagram, only the downstream of the first occurrence of the node can be expanded. Other duplicate nodes cannot be expanded to avoid content confusion or repetition.
Attribute information	Business Attribute	Displays the system and custom attributes of the asset. You can select Hide read-only attributes in the upper-right corner to focus on the attributes that you need to edit. System attributes: Business attributes - Business owner: Select a tenant with a Normal status under the current tenant. Custom attributes: The required format depends on the configuration of the business metric attributes. For example, if the input method for Change Management is a drop-down list with the options Yes and No, then when you edit a table asset, this attribute is a drop-down list with Yes and No as the available enumeration values. For more information about attribute configuration, see Create and manage development object attributes. If the attribute value is a hyperlink, the link prefix must be `http://` or `https://` for the link to be effective. Entering only spaces is not supported. The character length depends on the attribute configuration and cannot exceed 10,000 characters.
Associated technical metrics	Associated Technical Metrics	Associated technical metrics: You can select technical metrics that have been created under the current tenant. A technical metric cannot be associated more than once. You can associate up to 100 technical metrics. You can search by the technical metric's name, display name, or description, or click the Filter icon to filter by asset source and status. Associated technical metrics list: Displays information about the selected associated technical metrics, including the metric's name, statistic granularity, statistical period, description, parent aggregate table, and data type. You can also perform the following operations on the metrics. View aggregate table: Hover the mouse pointer over the View icon next to the aggregate table name to view its related information. Delete: If the metric does not meet business requirements, click the Delete icon to delete it.
Usage instructions	Enable	This feature is disabled by default. When enabled, you can view the usage instructions on the asset details page in the asset catalog. You can add usage instructions for the asset to provide an introduction and guidance for data viewers, and to help users evaluate asset availability and request consumption permissions. Note The link prefix must be `https://` or `http://` for the link to be effective. Each image or video uploaded for an asset must be no larger than 100 MB.
Access control	Visibility Scope	Affects whether the asset is visible in the asset catalog, but does not affect whether the metric is visible in the aggregate table. Three visibility scopes are supported: Visible To All: All users under the tenant can view the asset. Visible To Specific Users/Invisible To Specific Users: Only specified users or user groups can view the asset. You can specify members by user or user group. Select by user: Select users with a Normal status under the current tenant. Select by user group: You can select user groups with a Normal and Enabled status. Members are automatically updated with changes in the user group. For more information, see Create and manage user groups.

Technical metrics

Parameter		Description
Basic information	Name	Displays the name of the asset. You cannot modify the name.
	Display Name	Enter the display name of the asset. The name can be up to 1,000 characters long. You can click Use Asset Name or Use Asset Description to quickly use the asset's name or description as its display name.
	Catalog	Select one or more published folders under the metric subject.
	Tag	Select up to 20 tags. If your account has Listing Management-Manage permissions, click the Tag Management button to go to the Asset > Catalog Management > Other Settings > Basic Settings page and create new tags.
	Metric Definition	This is displayed only for modeling metrics. It shows the metric definition entered in Developer > Develop > Metrics.
	Description	Enter a description for the asset. The description can be up to 1,000 characters long.
Attribute information	Business Attribute/Technical Attribute	Displays the system and custom attributes of the asset. You can select Hide read-only attributes in the upper-right corner to focus on the attributes that you need to edit. System attributes: Business attributes: Includes subject area and associated business metrics information. Associated business metrics: You can select business metrics that have been created under the current tenant. Click the View icon next to the selection box to view the related information of the metric in a dialog box. Then, click View details. For listed assets, you are redirected to Business Metrics > Listed Assets to view details. For unlisted assets, you are redirected to Business Metrics > Prospective Assets to view details. Technical attributes: Includes metric type (requires Intelligent Development Edition), asset source, aggregate table, data section, business filter, atomic metric, statistic granularity, statistical period, data type, measurement unit, whether the metric is additive, asset import name, collection adapter type, and collection adapter information. Aggregate Table: The name of the table from which the metric is sourced. You can click Edit Table Information to go to the table asset editing page. This requires table asset maintenance permission. Atomic Metric/Business Condition: If it is a metric or business filter from standardized modeling, it cannot be modified. If it is a custom metric or business filter, the input can be up to 128 characters long. Statistic Granularity: For custom metrics, you can click to view the name, code, description, and section information of the related business object. For modeling metrics, you can also click View Details to go to the data section page at Planning > Data Architecture, which filters for the business entity information of the statistic granularity. Note The statistic granularity of custom metrics is specified during the editing of the parent table and takes effect automatically after the table is listed. If the statistic granularity is updated but not listed, you can click Go To List to list the aggregate table of the metric, and then view the latest statistic granularity. Statistical Period: If it is a statistical period from standardized modeling, it cannot be modified. If it is a custom statistical period, you can select the statistical period of the metric. For more information, see Create a statistical period. Measurement Unit: If it is a modeling metric, it cannot be modified. If it is a custom metric, you can select and modify the metric's measurement unit. The input can be up to 32 characters long. Is Additive: Indicates whether adding the metric (derived metric) under the same statistic granularity has business meaning or conforms to business rules. You can select additive, semi-additive, or non-additive. Modeling metrics automatically inherit the "is additive" attribute of the associated atomic metric. Additive: Supports direct summation across all dimensions, such as time, location, and product category. Examples include sales amount, order quantity, and inventory quantity. Semi-additive: Supports addition only on certain dimensions. For example, inventory level can be added across different products or locations, but not across the time dimension, because inventory level typically represents a state at a specific moment, not a cumulative value. Non-additive: The overall value cannot be obtained by simple summation. Examples include percentages, averages, and interest rates. Calculating the average customer satisfaction for a month cannot be done by simply adding the daily average satisfaction values and dividing by the number of days. It must be calculated with daily weighting. Custom attributes: The required format depends on the configuration of the technical metric attributes. For example, if the input method for Change Management is a drop-down list with the options Yes and No, then when you edit a table asset, this attribute is a drop-down list with Yes and No as the available enumeration values. For more information about attribute configuration, see Create and manage development object attributes. If the attribute value is a hyperlink, the link prefix must be `http://` or `https://` for the link to be effective. Entering only spaces is not supported. The character length depends on the attribute configuration and cannot exceed 10,000 characters.
Usage instructions	Enable	This feature is disabled by default. When enabled, you can view the usage instructions on the asset details page in the asset catalog. You can add usage instructions for the asset to provide an introduction and guidance for data viewers, and to help users evaluate asset availability and request consumption permissions. Note The link prefix must be `https://` or `http://` for the link to be effective. Each image or video uploaded for an asset must be no larger than 100 MB.
Access control	Visibility Scope	Controls whether the asset is visible in the asset catalog, but does not affect whether the metric is visible in the aggregate table. Three visibility scopes are supported: Visible To All: All users under the tenant can view the asset. Visible To Specific Users/Invisible To Specific Users: Only specified users or user groups can view the asset. You can specify members by user or user group. Select by user: Select users with a Normal status under the current tenant. Select by user group: You can select user groups with a Normal and Enabled status. Members are automatically updated with changes in the user group. For more information, see Create and manage user groups.
	Data Exploration Report	You must enable data exploration in the asset checklist to view the data exploration report. This requires activating the Data Quality feature. Three visibility scopes are supported: Visible To All, Visible To Specific Users, and Not Visible To All Users. The configuration is the same as for the visibility scope.
	Lineage	When enabled, you can view the complete direct lineage on the asset details page in the asset catalog. This includes unlisted objects and objects for which you do not have view permissions. However, you cannot view the detailed information of these objects.
	Metric Relationship Diagram	When enabled, you can view a breakdown diagram of the metric relationship with this metric as the root node on the asset details page in the asset catalog. This helps clarify the metric processing logic. If you select Hide SQL Calculation Logic, you cannot view the calculation logic in the metric details dialog box on the asset details page in the asset catalog.
	Quality Overview	When enabled, you can view the six quality scores (completeness, uniqueness, timeliness, validity, consistency, and stability) and monitoring rule statistics on the asset details page in the asset catalog. If you select Hide Quality Rule Validation Details, you cannot view the quality rule validation details in the quality overview on the asset details page in the asset catalog.

API assets

Parameter		Description
Basic information	API_ID	Displays the ID of the asset. You cannot modify the ID.
	API Name	Displays the name of the asset. You cannot modify the name.
	Catalog	Select one or more published folders under the API subject.
	Tag	Select up to 20 tags. If your account has Listing Management-Manage permissions, click the Tag Management button to go to the Asset > Catalog Management > Other Settings > Basic Settings page and create new tags.
	Description	By default, this displays the description provided when the API was created. You can modify it. The description can be up to 128 characters long.
Attribute information	Business Attribute/Management Attribute/Technical Attribute	Displays the system and custom attributes of the asset. You can select Hide read-only attributes in the upper-right corner to focus on the attributes that you need to edit. System attributes: Technical attributes: Includes asset source, API group, API type, operation type, data volume, maximum input entries, protocol, invocation mode, return type, data update frequency (only for GET and LIST operations), cache settings (only for GET and LIST operations), timeout, execution timeout (only for asynchronous invocation), collection adapter type, and collection adapter information. Custom attributes: The required format depends on the configuration of the API attributes. For example, if the input method for Change Management is a drop-down list with the options Yes and No, then when you edit a table asset, this attribute is a drop-down list with Yes and No as the available enumeration values. For more information about attribute configuration, see Create and manage development object attributes. If the attribute value is a hyperlink, the link prefix must be `http://` or `https://` for the link to be effective. Entering only spaces is not supported. The character length depends on the attribute configuration and cannot exceed 10,000 characters.
Business parameter request list, Common parameter request list, Return parameter list		Displays the business parameter requests, common parameter requests, and return parameter information for when the current API is called. You can view more details on the Service > Marketplace > API tab by selecting the target API Document.
Row-level permission list		Displays the row-level permission information that is currently associated with and enabled for the API. You can view more details on the Service > Develop > API page by selecting the target API.
Usage instructions	Enable	This feature is disabled by default. When enabled, you can view the usage instructions on the asset details page in the asset catalog. You can add usage instructions for the asset to provide an introduction and guidance for data viewers, and to help users evaluate asset availability and request consumption permissions. Note The link prefix must be `https://` or `http://` for the link to be effective. Each image or video uploaded for an asset must be no larger than 100 MB.
Access control	Visibility Scope	Affects whether the asset is visible in the asset catalog. Three visibility scopes are supported: Visible To All: All users under the tenant can view the asset. Visible To Specific Users/Invisible To Specific Users: Only specified users or user groups can view the asset. You can specify members by user or user group. Select by user: Select users with a Normal status under the current tenant. Select by user group: You can select user groups with a Normal and Enabled status. Members are automatically updated with changes in the user group. For more information, see Create and manage user groups.

Dashboard assets

Parameter		Description
Basic information	Dashboard Name	Displays the name of the asset. You cannot modify the name.
	Catalog	Select one or more published folders under the dashboard subject. The root folder is not included.
	Tag	Select up to 20 tags. If your account has Listing Management-Manage permissions, click the Tag Management button to go to the Asset > 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 of the asset. You can select Hide read-only attributes in the upper-right corner to focus on the attributes that you need to edit. System attributes: Management attributes: Includes asset source, BI workspace, BI directory, owner, last updater, last update time, collaboration authorization policy, whether it is public, and public expiration date information. 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 configuration of the dashboard attributes. For example, if the input method for Change Management is a drop-down list with the options Yes and No, then when you edit a table asset, this attribute is a drop-down list with Yes and No as the available enumeration values. For more information about attribute configuration, see Create and manage development object attributes. If the attribute value is a hyperlink, the link prefix must be `http://` or `https://` for the link to be effective. Entering only spaces is not supported. The character length depends on the attribute configuration and cannot exceed 10,000 characters.
Chart information		Displays the chart details of the current dashboard. You can view detailed information on the Administration > Metadata > Metadata Checklist > Dashboard tab. Chart Display Name: Enter the display name of the chart. The name can be up to 256 characters long. You can click Quick Fill Name to quickly use the dashboard's name as the display name. Chart Description: Enter the description of the chart. The description can be up to 1,000 characters long. You can click Quick Fill Name to quickly use the dashboard's name as the description.
Usage instructions	Enable	This feature is disabled by default. When enabled, you can view the usage instructions on the asset details page in the asset catalog. You can add usage instructions for the asset to provide an introduction and guidance for data viewers, and to help users evaluate asset availability and request consumption permissions. Note The link prefix must be `https://` or `http://` for the link to be effective. Each image or video uploaded for an asset must be no larger than 100 MB.
Access control	Visibility Scope	Affects whether the asset is visible in the asset catalog. Three visibility scopes are supported: Visible To All: All users under the tenant can view the asset. Visible To Specific Users/Invisible To Specific Users: Only specified users or user groups can view the asset. You can specify members by user or user group. Select by user: Select users with a Normal status under the current tenant. Select by user group: You can select user groups with a Normal and Enabled status. Members are automatically updated with changes in the user group. For more information, see Create and manage user groups.

Intelligent generation

Dataphin uses large language models (LLMs) to intelligently generate basic information for tables and fields. This feature can discover metrics with business value from table assets and generate comprehensive information for metric assets, which greatly improves data configuration efficiency.

Note

The first row on the intelligent generation page displays the existing configuration information. The second row displays the intelligently generated configuration information. You can only modify the intelligently generated information.
Intelligently generating many fields or technical metrics may take a long time. Please be patient.

On the Pending tab, click the Edit icon in the Actions column of the target asset to go to the asset editing page.

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

Table assets

Parameter		Description
Basic information	Display Name	The system intelligently generates a display name if you use the custom setting. You can modify the generated name. The name can be up to 256 characters long.
	Catalog	The system intelligently recommends published folders under the table subject. You can select multiple folders.
	Tag	The system intelligently recommends tags. You can select up to 20 tags.
	Description	The system intelligently generates a description if you use the custom setting. You can modify the generated description. The description can be up to 1,000 characters long.
Field Information	Field Display Name	The system intelligently generates a display name for the field if you use the custom setting. You can modify the generated name. The name can be up to 512 characters long.
	Description	The system intelligently generates a description for the field if you use the custom setting. You can modify the generated description. The description can be up to 2,048 characters long.
	Business Type	You can select dimension, metric, or statistical period as the business type. You can click Clear to clear all business type information at once. Dimension: If the field name is `id` (case-insensitive), the system sets the business type of the field to dimension by default. You can modify this setting. Metric: For non-measure fields, the system determines the business type based on the field name, display name, and description. It sets the business type to metric by default. You can modify this setting. Examples include refund rate, total refund amount, and top 3 purchase volume per capita. For measure fields, if the data type of the field is `bigint, double, int, smallint, tinyint, or float`, the system sets the business type to metric by default. You can modify this setting. Statistical Period: If the data type of the field is `date, datetime, or timestamp`, the system sets the business type to statistical period by default. You can modify this setting.
	Associated Entity	Only when the business type of the field is dimension, the system defaults to filling in the business entity under the data section. You can modify this setting. If the field is already associated with a business entity, the business entity changes accordingly when you change the data section.
	Intelligently Generate Related Metrics	You can click the Intelligently Generate Related Metrics button only when the field's business type includes metric. If the field's business type also includes dimension, you must first select a Business Unit in the field information area before clicking the Intelligently Generate Related Metrics button. Clicking the button generates the related metrics list.
Intelligently Generate Related Metrics	Metric	Fields with a business type of metric are synchronized as metric information. You can modify them on the metric editing page.
	Catalog	The system intelligently recommends five published folders under the table subject, including any already added folders. You can select multiple folders.
	Tag	The system intelligently recommends eight tags, including any already created tags. You can select up to 20 tags.

Technical metrics

Parameter		Description
Basic information	Display Name	The system intelligently generates the display name of the metric. You can modify it. The name can be up to 256 characters long.
	Catalog	The system intelligently recommends published folders under the metric subject. You can select multiple folders.
	Tag	The system intelligently recommends tags. You can select up to 20 tags.
	Description	The system intelligently generates a description for the asset. You can modify it. The description can be up to 1,000 characters long.

After you confirm that the intelligently generated metric information is correct, click Save. After saving, if the information does not meet your requirements, you can click Clear in the upper-right corner to clear the metric's catalog and tag information in a single operation.
After you confirm that all information is correct, click Apply to automatically populate the Asset editing page with the information.
You can perform the following operations on the generated information, which includes related metrics and other recommendations.
- Retry: Regenerate the related metrics or all information.
- Discard: Do not use the related metrics or all information from this generation.
- Stop: Stop the generation of related metrics or all information.
- Continue Generating: Continue generating the stopped related metrics or all information.