Dataphin:Manage staging assets

Parameter

Description

Basic information

Name

Displays the name of the asset. This parameter is read-only.

Display name

Specify a display name for the asset. You can reference a DDL comment or provide a custom display name.

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

• Custom: Enter a custom display name of up to 256 characters. You can also click Fill in Asset Name or Fill in Asset Description to quickly fill this field with the asset's name or description.

DataWorks category

When the asset source is DataWorks, this field displays the default category configured in the DataWorks data map.

Listing directory

Select one or more published directories under the table topic.

DataWorks tag

When the asset source is DataWorks, this field displays the description configured in the DataWorks data map.

Tag

Select up to 20 tags. If your account has the Listing Management-Manage permission, you can click Tag Management to navigate to the Asset > Directory Management > Other Settings > Basic Settings page to create new tags.

Description

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

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

• Custom: Enter a description for the asset, 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 Attribute: Includes the subject domain information.

  • Management Attribute: Includes owning system, associated DataWorks workspace, and DataWorks table owner information.

    Owning System:

    • Data source table: The source system of the collection task.

    • Dataphin table: Displayed as "-".

  • Technical Attribute: Includes asset source, associated section/workspace/data source type, database type, associated project, table type/subtype, asset import name, collector adapter type, and collector adapter information.

    • Asset Source:

      • Data source table: The source path is Source System > Data Source > Table Schema. For a DataWorks asset, the source path is Source System > DataWorks Application System > workspace > Data Source.

      • Dataphin table: The source path is Dataphin > workspace Type (logical tables are identified as intermediate layer) > Associated Project/Section (sections contain only logical tables).

    • Asset Import Name:

      • Data source table: The name of the collection task for the data source table. For a DataWorks asset, this is the name of the DataWorks collection task.

      • Dataphin table: Displayed as "-".

• Custom Attribute: The input format depends on the attribute's configuration. For example, if a Change Management attribute is configured as a single-select dropdown with "Yes" and "No" as options, the editor for that attribute will be a dropdown list with those two choices. For more information on attribute configuration, see Create and manage R&D object attributes.

  If an attribute's value is a hyperlink, the URL must start with http:// or https:// to be a valid link. Entering only spaces is not allowed. The maximum length is determined by the attribute's configuration, up to 10,000 characters.

Field information

No.

Click the Sort icon next to the column header to sort the fields by their number.

Field name

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

Specify a display name for the field. You can reference a DDL comment or provide a custom name.

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

• Custom: Enter a custom display name, up to 512 characters. You can hover over Quick Fill and select Fill in Description or Fill in Name to quickly fill this field with the field's description or name.

Description

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

• Reference DDL Comment: Uses the field's comment from the DDL 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 the following business types: Dimension, Metric, or Statistical Period.

Associated entity

• When 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 data section. If no suitable business entity exists, click Create Business Entity to create one. For more information, see Create and manage business entities.

  If a field is already associated with a business entity and you change the data section, you must reselect the business entity.

• When the table type is dimension logical table or fact logical table, this field displays the associated entity configured on the logical table's edit page in R&D > Develop. Click the View icon next to an associated entity to view its information, including role name (e.g., buyer, seller), entity name (code), description, associated section, and subject domain. You can also perform the following actions:

  • View Details: Click to go to the business entity's tab on the Planning > Data Architecture page for more information.

  • View Entity Relationship Diagram: Click to open the Entity Relationship Diagram panel and view a diagram centered on this business entity.

Data category

You must enable the data security module to view the data category information of a field.

Data security level

You must enable the data security module to view the data security level information of a field. You can click the Sort icon next to the column header to sort fields by their data security level.

Custom attribute

The input format depends on the attribute's configuration. Click Quick Edit to open the Batch Edit Attributes dialog box, where you can paste or enter attribute values in bulk. The system parses the input based on the attribute's data type. You can enter up to 5,000 lines, with each line containing up to 2,000 characters. Click OK to save your changes. To delete all values for an attribute, click Clear. For more information, see Create and manage R&D object attributes.

• If the attribute type is Custom Input, the system parses each line as a value for a corresponding field. Blank lines are ignored.

• If the attribute type is Single-select, the system parses each line as a value. Lines with values that are not in the enumerated list are ignored.

• If the attribute type is Multi-select, the system parses each line as a value set for a field. Use commas (,) to separate multiple values on the same line. Values that are not in the enumerated list or are duplicates on the same line are ignored.

• If the attribute type is Hyperlink, use a comma (,) to separate the display text and the link URL in the format text,link. If no comma is present, the entire line is treated as display text, and the link URL remains empty.

Actions

• Batch Edit: Click Batch Edit to open the Batch Edit panel. Modify the display name, description, business type, associated entity, and custom attributes for multiple fields at once, then click OK to apply the changes to the field list.

  Editing field display names, descriptions, and custom attributes in bulk follows the same rules as editing them for a single field.

• Batch set as dimension/metric: Select multiple fields in the list and set them as dimensions or metrics at once.

Related metrics

When you set the business type of one or more fields to Metric, a list of related metrics appears. This list shows each metric's name, listing status, directory, tags, atomic metric, business qualifier, statistical period, and unit of measure. You can perform the following actions on the metrics if you have maintenance permissions for the metric assets.

• Batch Edit: Click Batch Edit to open the Batch Edit panel. Select the metrics you want to modify, use the bulk actions at the bottom to make changes, and click OK to apply them to the related metrics list.

  • Directory/Tag: Bulk append or replace the directories and tags for the selected metrics. You can add up to 20 tags.

  • Atomic metric/Business qualifier: Bulk modify the atomic metric or business qualifier. The input can be up to 128 characters.

  • Statistical Period: Bulk configure the statistical period for the metrics.

  • Unit of Measure: Bulk configure the unit of measure for the metrics. The input can be up to 32 characters.

• Modify Directory: Select a published directory under the metric topic.

• Modify tags: Add up to 20 tags to a metric.

• Atomic metric/Business qualifier: Enter an atomic metric or business qualifier, up to 128 characters.

• Statistical Period: Select a statistical period for the metric. To create a new one, see Create statistical periods.

• View Business Entity: In the upper-left corner of the related metrics list, click the view icon to see business entity information. Click View Details to go to the Planning > Data Architecture page for more information.

  When a dimension changes, the update type (added or deleted) for the statistical granularity is highlighted.

• Select Table attributes overwrite attributes of unlisted metrics in the upper-right corner of the related metrics list. When you save the table asset, the system overwrites the display name, description, visibility, data profiling report attributes, data lineage, quality profile, and asset maintainer of any unlisted metrics with the table's configuration.

Instructions

Enable

This feature is disabled by default. When enabled, the instructions are displayed on the asset's details page in the asset catalog. You can add instructions to introduce the asset and guide users, helping them assess its usability and apply for consumption permissions.

Permission control

Visibility

Controls whether the asset is visible in the asset catalog. The following options are available:

• All users can view: All users in the tenant can view the asset.

• Visible to some users/Not visible 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 users in the Normal state in the current tenant.

  • Select by user group: Select user groups enabled and in the Normal state. Membership is automatically updated based on changes to the user group. To create a user group, see Create and manage user groups.

Data profiling report

You must enable data profiling in the asset inventory to view the data profiling report. This requires the data quality feature. You can set the visibility to All users can view, Visible to some users, or Not visible to any users. The configuration is the same as for Visibility.

Data lineage

When enabled, the complete direct data lineage, including unlisted objects and objects for which you lack view permissions, is displayed on the asset's details page. However, you cannot view the details of those objects.

Quality profile

When enabled, the six data quality dimensions (completeness, uniqueness, timeliness, validity, consistency, and stability) and monitoring rule statistics are displayed on the asset's details page.

If you select Hide quality rule validation details, the quality profile on the asset's details page will not display validation details.

Metadata change log

You must enable metadata versioning on the Metadata > Metadata Change Log page before you can configure this setting. When enabled, the metadata version history is displayed on the asset's details page. To modify the maximum number of versions to retain, see Metadata Change Log.

Data consumption

When enabled, users can apply for consumption permissions for the asset from its details page in the asset catalog.

Associated row-level permissions

If you have enabled the row-level permission feature, you can view the row-level permissions associated with this asset, including permission names, control rules, and associated fields. You can view control rules and go to the edit page.

• View Control Rules: Click the View icon next to the number of control rules to view the rules under that permission.

• Go to Edit: Click Go to Edit to navigate to the Management Center > Permission Management > Row-Level Permission Management page. The system automatically filters for the permissions associated with this asset, allowing you to modify them. For more information, see Add and manage row-level permissions.

Parameter

Description

Basic information

Name

Enter a globally unique name for the business metric. The name can contain English letters, digits, and the following special characters: -_/\·#$^&*()%+-=. The name must not exceed 256 characters.

Display name

Enter a display name for the asset, up to 1,000 characters. Click Fill in Asset Name or Fill in Asset Description to use the asset's name or description as the display name.

Listing catalog

Select one or more published catalogs under the metric topic.

Tag

Select up to 20 tags. If your account has the Listing Management-Manage permission, click Tag Management to navigate to the Asset > Catalog Management > Other Settings > Basic Settings page and create new tags.

Description

Enter a description for the asset, up to 1,000 characters.

Metric definition

Metric definition

You can add a metric definition in two ways: custom input or by referencing a business metric. This helps business users understand the current metric.

• Custom Input: Enter a definition for the metric, up to 2,000 characters.

• Reference Business Metric: Click Reference Business Metric to select and add business metrics. Alternatively, type @ in the configuration box to perform a fuzzy search for metrics by name or display name, or enter metric keywords to search directly.

In the configuration box, use operators to define the calculation logic for the selected metrics. Supported operators include the plus sign (+), minus sign (-), asterisk (*), slash (/), parentheses (), percent sign (%), and sum (∑).

Related business metrics

• Related business metrics: Click Add Related Business Metrics to associate other relevant business metrics. This provides a more complete understanding of the business context and data relationships.

• Related business metrics list: This 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 as Positive Correlation, Negative Correlation, or Other. You can also edit or delete them.

  • Edit: Opens the metric's edit page at Asset > Catalog Management > Business Metrics, where you can modify its information.

  • Delete: This action removes the metric from the relationship expression, which can render it incomplete. This action is irreversible, so proceed with caution. Metrics automatically parsed from the metric definition cannot be deleted here. You must remove them in the metric definition configuration box.

Metric relationship diagram

You can configure a relationship diagram based on the added related business metrics to clearly visualize the metric's calculation logic. This feature is disabled by default. When enabled, click the Edit icon to open the Configure Metric Relationship Diagram dialog box. This displays a diagram starting from the current metric node. You can configure the calculation logic for the related business metrics on the right and click OK to finish. The configured diagram is available during subsequent edits.

• Canvas: On the canvas to the left, the first-level relationships update automatically based on changes to the definition on the right. Beyond the first level, the diagram shows the last saved relationships for all downstream metrics.

• Metric Configuration Area: In the Metric Relationship Expression Configuration box on the right, configure the metric's calculation 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, or type @ in the configuration box to perform a fuzzy search for metrics by name or display name. You can also search directly by entering metric keywords. In the configuration box, use operators to process the relationships between the selected metrics. Supported operators include the plus sign (+), minus sign (-), asterisk (*), slash (/), parentheses (), percent sign (%), and sum (∑).

Attribute information

Business attributes

This section 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 information.

• System attributes:

  Business Attributes - Business Owner: Select an active user within the current tenant.

• Custom attributes: The required input depends on how the business metric attributes are configured. For example, if a Change Management attribute is configured as a single-select dropdown with "Yes" and "No" as options, the editor for that attribute will be a dropdown list with those two choices when you edit a business metric asset. For more information on attribute configuration, see Create and manage development object attributes.

  When the value of an attribute is a hyperlink, it must start with http:// or https:// to be valid. The value cannot consist of only spaces. The character length depends on the attribute's configuration, with a maximum of 10,000 characters.

Associated technical metrics

Associated technical metrics

• Associate technical metrics: You can select existing technical metrics within the current tenant. A technical metric can only be associated once. You can associate up to 100 technical metrics. You can search for technical metrics by name, display name, or description, or click the Filter icon to filter by asset source or asset status.

• Associated technical metrics list: Displays information about the selected technical metrics, including their name, granularity, period, description, associated summary table, and data type. You can also perform the following actions on the metrics:

  • View Summary Table: Hover over the View icon next to a summary table name to see its details.

  • Delete: If a metric is irrelevant to your business, click the Delete icon to remove it.

Usage guide

Enable

This feature is disabled by default. When enabled, the usage guide is displayed on the asset's details page in the asset catalog. You can add a usage guide to introduce the asset to data viewers, helping them evaluate its usability and decide whether to request access.

Access control

Visibility scope

This setting determines the asset's visibility in the asset catalog. It does not affect the metric's visibility in a summary table. The following options are available:

• Visible to All Users: All users in the tenant can view the asset.

• Visible to Some Users/Invisible to Some Users: This setting allows you to show or hide the asset for specific users or user groups. You can specify members by user or user group.

  • Select by User: Select active users within the current tenant.

  • Select by User Group: Select active and enabled user groups. Group membership is dynamic and reflects any changes made to the user group. To create a user group, see Create and manage user groups.

Parameter

Description

Basic information

Name

The name of the asset. This field is read-only.

Display name

Enter a display name for the asset, up to 1,000 characters long. Click Fill in Asset Name or Fill in Asset Description to quickly populate this field with the asset's name or description.

Listing catalog

Select one or more published catalogs under an indicator topic. Multiple selections are supported.

Tag

You can select up to 20 tags. To create new tags, you must have the Listing Management - Manage permission. If you do, click Tag Management to go to the Asset > Catalog Management > Other Settings > Basic Settings page.

Indicator definition

This field is displayed only for modeling indicators. It shows the indicator definition you entered in R&D > Develop > Indicators.

Description

Enter a description for the asset, up to 1,000 characters long.

Attribute information

Business attribute/Technical attribute

Displays the system attributes and custom information of the asset. You can select Hide Read-only Attributes in the upper-right corner to focus on editable information.

• System attributes:

  • Business attribute: Includes information about the subject domain and associated business indicators.

    Associated business indicators: Select business indicators created in the current tenant. Click the View icon next to the selection box to view information about the indicator in a dialog box. Then, click View Details. For a listed asset, you are redirected to the Business Indicators > Listed Assets page to view its details. For an unlisted asset, you are redirected to the Business Indicators > Staging Assets page.

  • Technical attribute: Includes the indicator type (requires Intelligent R&D Edition), asset source, associated summary table, associated data board, business qualifier, atomic indicator, statistical granularity, statistical period, data type, measure, additivity, asset import name, collection adapter type, and collection adapter information.

    • Associated summary table: The name of the indicator's source table. You can click Edit Table Information (requires table asset maintenance permission) to go to the table asset information editing page.

    • Atomic indicator/Business qualifier: Standardized modeling indicators and business qualifiers are read-only. If it is a custom indicator or business qualifier, you can enter a value of up to 128 characters.

    • Statistical granularity: For custom indicators, you can click to view the name, code, description, and associated data board of the related business objects. For modeling indicators, you can also click View Details to navigate to the Planning > Data Architecture page, where the system filters for the business entity information of the statistical granularity.

      Note

      • The statistical granularity of a custom indicator is specified when editing its associated table and takes effect automatically after the table is listed.

      • If the statistical granularity is pending update because the table is not listed, click Go to List to list the summary table of the indicator. Then, you can view the latest statistical granularity.

    • Statistical period: Standardized modeling statistical periods are read-only. If it is a custom statistical period, you can select one for the indicator. To create one, see Create a statistical period.

    • Measure: For modeling indicators, this is read-only. For custom indicators, you can select and modify the indicator's measure, with a limit of 32 characters.

    • Additivity: Specifies whether summing the indicator (or derived indicators) at the same statistical granularity is meaningful from a business perspective. You can select additive, semi-additive, or non-additive. For modeling indicators, this property is automatically inherited from the associated atomic indicator.

      • Additive: Can be aggregated across all dimensions, such as time, geography, or product category. Examples: sales revenue, order quantity, and inventory level.

      • Semi-additive: Can be aggregated across some, but not all, dimensions. Example: inventory level can be aggregated across products or locations, but not across time, because it represents a point-in-time state, not a cumulative value.

      • Non-additive: Cannot be meaningfully aggregated by simple summation. Examples: percentages, averages, and interest rates. To calculate the average customer satisfaction for a month, for instance, you cannot simply sum the daily averages and divide by the number of days; you must compute a weighted average.

• Custom attributes: The input format depends on the configuration of the technical indicator attribute. For example, if a Change Management attribute is configured as a single-select dropdown list with Yes and No as options, the editor for that attribute is a dropdown list with those two choices. For more information about attribute configuration, see Create and manage R&D object attributes.

  If an attribute value is a hyperlink, it must start with http:// or https:// to be a valid link. Entering only spaces is not allowed. The attribute's configuration determines the maximum length, up to 10,000 characters.

Usage guide

Enable

This feature is disabled by default. When enabled, the usage guide is displayed on the asset details page in the asset catalog. You can add a usage guide to introduce the asset, helping users evaluate its usability and apply for consumption permissions.

Access control

Visibility scope

Controls whether the asset is visible in the asset catalog. This setting does not affect the indicator's visibility in its summary table. The following options are available:

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

  • By user: Select users that are in the Normal state within the current tenant.

  • By user group: Select user groups in the Normal and Enabled state. Membership updates automatically based on changes to the user group. To create a user group, see Create and manage user groups.

Data exploration report

To view the data exploration report, you must enable data exploration in the asset list (this requires the data quality feature). You can set the visibility to Visible to all users, Visible to some users, or Invisible to all users. The configuration is the same as for the visibility scope.

Data lineage

When enabled, the complete direct data lineage is displayed on the asset details page in the asset catalog. This includes unlisted objects and objects for which you lack view permissions. However, you cannot view the details of those objects.

Indicator relationship diagram

When enabled, an indicator relationship decomposition diagram rooted at this indicator appears on the asset details page. This provides a clearer understanding of the indicator's calculation logic.

If you select Hide SQL calculation logic, the calculation logic is hidden in the indicator details dialog on the asset details page.

Quality profile

When enabled, the asset's quality score across six dimensions (completeness, uniqueness, timeliness, validity, consistency, and stability) and the monitoring rule statistics are displayed on the asset details page.

If you select Hide quality rule validation details, the validation details are hidden in the Quality Profile section on the asset details page.

Parameter

Description

Basic information

API_ID

Displays the unique identifier for the asset. This parameter is read-only.

API name

Displays the name of the asset. This parameter is read-only.

Listed directory

Select one or more published directories for the API.

Tag

Select up to 20 tags. To create a new tag, click Tag Management on the Asset > Directory Management > Other Settings > Basic Settings page. This action requires the Listing Management-Manage permission.

Description

The description of the API. You can modify this description, and its length must not exceed 128 characters.

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 view only editable attributes.

• System attributes:

  Technical attributes: Includes attributes such as asset source, API group name, API type, operation type, data volume, maximum number of input entries, protocol, call mode, return type, update frequency and cache settings (displayed only for GET and LIST operations), timeout, execution timeout (displayed only for asynchronous call mode), collection adapter type, and collection adapter information.

• Custom attributes: The input format depends on the API attribute's configuration. For example, if a change management attribute is configured as a single-select dropdown with "Yes" and "No" as options, that attribute appears as a dropdown list with "Yes" and "No" as its options. For more information on attribute configuration, see Create and manage R&D object attributes.

  For hyperlink attributes, the value must start with http:// or https:// to be a valid link. The value cannot consist only of spaces. The maximum length is determined by the attribute's configuration, up to 10,000 characters.

Business parameter request list, Public parameter request list, Response parameter list

Displays the business, public, and response parameters for the API. For more details, see the API Document on the Services > Marketplace > API tab.

Row-level permission list

Displays the enabled row-level permissions associated with the API. For more details, go to the Services > Development > API page and select the target API.

Usage instructions

Enabled

This feature is disabled by default. When enabled, the usage guide is displayed on the asset's details page in the asset catalog. You can add a usage guide to introduce the asset, provide guidance to users, and help them evaluate its value and request access.

Access control

Visibility Scope

Controls whether the asset is visible 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/Not visible to some users: Only specified users or user groups can view the asset.

  • Select by user: Select active users within the current tenant.

  • Select by user group: Select active and enabled user groups. The membership updates automatically when the user group changes. To create a user group, see Create and manage user groups.

Parameter

Description

Basic information

Dashboard name

Displays the name of the asset. This parameter is read-only.

Listing directory

Select one or more published directories under the dashboard topic. You cannot select the root directory.

Tag

Select up to 20 tags. If your account has the Listing Management-Manage permission, you can click Tag Management to open the Assets > Catalog Management > Other Settings > Basic Settings page and create a new tag.

Description

Enter a description for the asset, 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 show only editable attributes.

• System attribute:

  • Management attribute: Includes asset source, BI workspace, BI directory, owner, last updated by, last updated time, collaborative authorization policy, public status, and public expiration date.

  • Technical attribute: Includes source dataset, total number of charts, third-party embedding status, collection adapter type, and collection adapter information.

• Custom attribute: The input format depends on the dashboard attribute's configuration. For example, if a change management attribute is configured as a single-select dropdown with "Yes" and "No" as options, that attribute will appear as a dropdown list with those two choices. For more information on attribute configuration, see Create and manage R&D object attributes.

  Values for hyperlink attributes must start with http:// or https://. These values cannot consist only of spaces. The attribute's configuration determines the maximum length, up to 10,000 characters.

Chart information

Displays details about the charts in the current dashboard. For more details, go to the Dashboard tab under Governance > Metadata > Metadata Inventory.

• Chart display name: Enter a display name for the chart, up to 256 characters. You can click Quick Fill Name to populate this field with the dashboard's name.

• Chart description: Enter a description for the chart, up to 1,000 characters. You can click Quick Fill Name to populate this field with the dashboard's name.

Usage instructions

Enabled

This feature is disabled by default. When enabled, the usage instructions are displayed on the asset's details page in the asset catalog. You can add instructions to introduce the asset and provide guidance for data viewers. These instructions help users evaluate the asset's usability and apply for consumption permissions.

Access control

Visibility Scope

Controls whether the asset is visible 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/Invisible to Some Users: Makes the asset visible only to specified users and user groups, or hides it from them. You can specify members by user or user group.

  • Select by User: Select active users within the current tenant.

  • Select by User Group: Select active and enabled user groups. Membership updates automatically when the user group changes. To create a user group, see Create and manage user groups.