Dataphin:Manage prospective assets

Parameter

Description

Basic information

Name

Displays the name of the asset. The name cannot be modified.

Display Name

The display name for the asset. You can reference a Data Definition Language (DDL) comment or define a custom display name.

• Reference DDL Comment: Uses the data table's comment as the asset's display name. The display name is automatically updated if the DDL comment changes.

• Custom: Enter a custom display name of up to 256 characters. You can also click Use Asset Name or Use Asset Description to use the asset's name or description as the display name.

Parent Folder

Select one or more published folders under the table subject.

Tag

You can select up to 20 tags. If your account has Listing Management-Manage permissions, click the Tag Management button to open the Asset > Catalog Management > Other Settings > Basic Settings page, where you can create new tags.

Description

You can reference a DDL comment or enter a custom description.

• Reference DDL Comment: Uses the data table's comment as the asset's description. The description is automatically updated if the DDL comment changes.

• Custom: Enter a custom description for the asset. The description can contain up to 1,000 characters.

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 editable information.

• System attributes:

  • Business attributes: Includes subject area information.

  • Management attributes: Includes system info.

    • Data source table: Identifies the source system for the collection task.

    • Dataphin table: Displays a hyphen (-).

  • Technical attributes: Includes information such as asset source, section or project, database type, project, table type, asset import name, collection adapter type, and collection adapter.

    • Asset source:

      • Data source table: The source path is Source system > Data source name > Schema of the table.

      • Dataphin table: The source path is Dataphin > Project type (logical tables are in the intermediate layer) > Project name or Board name (boards contain only logical tables).

    • Asset import name:

      • Data source table: The name of the data source table collection node.

      • Dataphin table: Displayed as -.

• Custom attributes: The required format depends on the table attribute configuration. For example, if the input method for a Change Management attribute is a drop-down list with Yes and No options, this attribute appears as a drop-down list with Yes and No as the enumeration values when you edit a table asset. For more information about attribute configuration, see Create and manage development object attributes.

  If an attribute value is a hyperlink, the prefix must be http:// or https:// for the link to work. Entering only spaces is not allowed. The maximum length is determined by the attribute configuration and cannot exceed 10,000 characters.

Field information

Serial Number

Click the Sort icon to sort the fields by serial number.

Field Name

Click the Sort icon to sort the fields by name.

Data Type

Displays the data type of the field.

Field Display Name

The display name for the field. You can reference a DDL comment or enter a custom name.

• Reference DDL Comment: Uses the field's comment as its display name. The display name is automatically updated if the DDL comment changes.

• Custom: Enter a custom display name of up to 512 characters. You can hover over Quick Fill and select Use Description or Use Name to use the field's description or name as the display name.

Description

You can reference a DDL comment or enter a custom description.

• Reference DDL Comment: Uses the field's comment as its description. The description is automatically updated if the DDL comment changes.

• Custom: Enter a custom description for the field. The description can contain up to 2,048 characters.

Business Type

Select a business type: dimension, metric, or statistical period.

Associated Entity

• If the table is a physical table, physical view, or view, and the field is a 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 if you change the data section.

• If the table type is a logical dimension table or logical fact table, the associated entities that are configured for the associated dimensions on the logical table editing page in Developer > Develop are displayed. You can click the View icon next to an associated entity to view its information, which includes 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 under Planning > Data Architecture.

  • View Entity Relationship Diagram: Click to open the Entity Relationship Diagram panel, which displays the entity relationship diagram centered on the current business entity.

Data Classification

To view data classification for fields, you must enable the data security module.

Data Sensitivity Level

The data sensitivity level of the field. This information is available only if you have activated the Data Security module. You can click the Sort icon to sort the fields by data sensitivity level.

Operation

• Batch Edit: Click the Batch Edit button to open the Batch Edit panel. In the panel, you can modify the display name, description, business type, and associated entity. Click OK to apply the changes.

  The field display name and description can reference DDL comments or be customized, similar to the configuration for a single field.

• Batch set dimension/metric: In the field list, you can select multiple fields and set them as dimensions or metrics in a batch operation.

Related metrics

If you set the business type of one or more fields to Metric, a list of related metrics appears. 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 if you have the required maintenance permissions for the metric assets.

• Batch edit: Click the Batch Edit button. In the Batch Edit panel, select the metrics you want to modify, click a batch operation at the bottom of the panel, and then click OK to apply the changes.

  • Catalog/Tags: Allows you to batch append or modify published metric catalogs or tags. You can add up to 20 tags.

  • Atomic Metric/Business Filter: Allows you to batch modify the atomic metric or business filter of metrics. The input can contain up to 128 characters.

  • Statistical Period: Allows you to batch configure the statistical period of metrics.

  • Measurement Unit: Allows you to batch configure the measurement unit of metrics. The unit can be modified and can contain up to 32 characters.

• Modify catalog: Allows you to select published folders under the metric subject.

• Modify tags: Allows you to add up to 20 tags to a metric.

• Atomic metric/Business filter: Allows you to enter the atomic metric or business filter for the metric. The input can contain up to 128 characters.

• Statistical period: Allows you to select the statistical period for 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 information about the business entity. Click View Details to go to the Planning > Data Architecture page for more details.

  When dimensions change, the update type (new or deleted) for the statistic granularity is highlighted.

• In the upper-right corner of the related metrics list, you can select Table Attributes Overwrite Unlisted Metric Attributes. If you select this option, when you save the table asset, the configurations for the display name, description, visibility scope, data exploration report attributes, lineage, quality overview, and asset maintenance personnel of the table asset will be applied to any unlisted metrics.

Usage instructions

Enable

This feature is disabled by default. If you enable it, the usage instructions are displayed on the asset details page in the asset catalog. You can add usage instructions to provide an introduction and guidance for data viewers, which helps them evaluate asset availability and request permissions.

Access control

Visible To

Determines the visibility of the asset in the asset catalog. The following three visibility scopes are supported:

• Visible To All: All users within 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 individual user or by user group.

  • Select by user: Select users who have a Normal status within the current tenant.

  • Select by user group: Select user groups that have a Normal and Enabled status. The members of the group are automatically updated when the user group changes. For more information, see Create and manage user groups.

Data Exploration Report

To view the data exploration report, you must enable data exploration in the asset checklist. This requires you to activate 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 performed by selecting one of these visibility scopes.

Lineage

If enabled, the complete direct lineage is displayed 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 details of these objects.

Quality Overview

If 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, the quality rule validation details are hidden from the quality overview on the asset details page.

Metadata Change Records

You must enable version recording for metadata changes on the Metadata > Metadata Change Records page before you can configure the settings here. When enabled, you can view metadata version change records on the asset details page in the asset catalog. To modify the maximum number of retained versions, 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. This includes the permission name, control rules, and foreign key fields. You can view the control rules or navigate to the editing page.

• View control rules: Click the View icon next to the number of control rules to view the information for the control rules associated with the permission.

• Go To Edit: Click Go To Edit to go to the Management Center > Permission Management > Row-level Permission Management page. The page is automatically filtered to show the row-level permissions for the asset, which you can then modify. For more information, see Add and manage row-level permissions.

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.

Parent Folder

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

You can add metric definitions using custom input or by referencing business metrics. This helps business users understand the meaning of each metric.

• 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.

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 (∑).

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.

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.

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.

Parent Folder

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.

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.

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.

Parent Folder

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.

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.

Parameter

Description

Basic information

Dashboard Name

Displays the name of the asset. You cannot modify the name.

Parent Folder

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.

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.