Batch import and export assets

Prerequisites

• Before you export configuration files, we recommend completing your asset catalog planning and defining asset properties. For more information about catalog planning and property definition, see Create and manage asset topics and Create and manage properties for development and data service objects.

• When you export table and dashboard assets, the output is a compressed file. The file for table assets includes tables, fields, and technical metrics. The file for dashboard assets includes dashboards and charts.

Limitations

• The maximum number of concurrent tasks for file import or export is 2.

• The system retains the 50 most recent import or export records for each asset type.

• You can download files only for export tasks that completed successfully.

• For fields, you can either use a custom display name and description or inherit them from the DDL comment. This setting applies to all fields within a table.

Permissions

• A super administrator, an operations administrator, or a custom global role with launch management-Manage permissions can view import details and download export records.

• Regular members can import and export assets for which they have maintenance permissions.

Batch import assets

1. In the top navigation bar of the Dataphin homepage, choose Asset > Catalog Management.

2. In the left-side navigation pane, choose Manual Launch > select the asset type, and go to the Candidate Assets tab.

3. On the Candidate Assets tab, click Batch Management > Batch Import Assets in the upper-right corner. The import process is the same for all asset types. The following steps use a table asset as an example.

4. In the Batch Import Assets dialog box, configure the parameters.

   Parameter	Description
   Import Content	This parameter is available only when the asset type is table or dashboard. Table: You can choose to import a Table or a Field. We recommend importing tables before fields. Dashboard: You can choose to import a Dashboard or a Chart. We recommend importing dashboards before charts.
   Upload File	Only .xlsx files are supported. If the file contains multiple worksheets, the system parses only the first worksheet. The file size cannot exceed 100 MB. When you fill out the template, follow the provided instructions. The system performs uniqueness and standardization checks during the import process. Worksheet details: Do not delete the instruction or header rows. The system starts parsing from the third row. Do not modify or delete column names, as this can cause parsing and import failures. Delete the example rows before you fill out the template. Handling of empty column values: If a required property is left empty, the update for that property fails, and the existing configuration is retained. If an optional property is left empty, its existing configuration is cleared. To avoid updating a specific column, keep its original value or delete the column. Failures on some properties do not affect updates to other valid properties. Before you launch an asset, check its latest configuration and make corrections based on the exception messages in the import record. If the import content is Table, also note the following guidelines when you fill in the configuration file. The system parses the file row by row. We recommend that you import tables before fields or technical metrics. To prevent configuration conflicts or data overwrites, place all fields for the same table in consecutive rows. If the import content is Field, also note the following guidelines when you fill in the configuration file. The system parses the file row by row. We recommend that you import tables before fields. To prevent configuration conflicts or data overwrites, place all fields for the same table in consecutive rows. For the same table, the Dataphin data module for business entities associated with dimension fields must be the same. The statistical period must be predefined in the Planning > Common Definitions section. If the import content is Technical Metric, also note the following guidelines when you fill in the configuration file. The system parses the file row by row. If you need to update information such as statistical granularity, we recommend that you import the table before the technical metric. If the import content is Business Metric, also note the following guidelines when you fill in the configuration file. You can use batch import to create business metrics in bulk. If the GUID for a business metric in a row is empty, the record is treated as a new business metric. If the import content is Dashboard, also note the following guidelines when you fill in the configuration file. The system parses the file row by row. We recommend that you import dashboards before charts. To prevent configuration conflicts or data overwrites, place all charts for the same dashboard in consecutive rows.

5. After you upload the file, the system validates its format. After successful validation, click Start Import. The system then performs specific checks based on the asset type.

   • Table:

     • Table GUID: Checks whether the table GUIDs in the import file exist and are not empty.

     • Asset Information: Validates the configuration information in the import file, including display name, display name value configuration, description, description value configuration, catalog ID, asset tags, custom properties (such as referenced system property values and hyperlinks), whether usage instructions are enabled, and permission controls (such as visibility scope, data discovery report, data lineage, quality overview, metadata change records, and data consumption).

   • Field:

     • Field GUID: Checks whether the field GUIDs in the import file exist and are not empty.

     • Asset Information: Validates the configuration information in the import file, including display name, field display name value configuration, description, field description value configuration, business type, the Dataphin data module of the associated entity, associated entity name, and custom properties (such as referenced system property values and hyperlinks).

   • Technical Metric:

     • Technical Metric GUID: Checks whether the technical metric GUIDs in the import file exist and are not empty.

     • Asset Information: Validates the configuration information in the import file, including display name, description, catalog ID, asset tags, custom properties (such as referenced system property values and hyperlinks), technical properties, whether usage instructions are enabled, and permission controls (such as visibility scope, data discovery report, data lineage, quality overview, and metric relationship diagram).

   • Business Metric:

     • Business Metric GUID: Checks whether the business metric GUIDs in the import file exist. If a GUID is empty, the record is treated as a new metric.

     • Asset Information: Validates the configuration information in the import file, including name, display name, catalog ID, asset tags, description, metric definition, related business metrics, whether the metric relationship diagram is enabled, metric relationship expression, business owner, custom properties (such as referenced system property values and hyperlinks), associated technical metrics, whether usage instructions are enabled, and permission controls (such as visibility scope).

   • API:

     • API ID: Checks whether the API IDs in the import file exist and are not empty.

     • Asset Information: Validates the configuration information in the import file, including API ID, catalog ID, asset tags, description, whether usage instructions are enabled, and permission controls (such as visibility scope).

   • Dashboard:

     • Dashboard GUID: Checks whether the dashboard GUIDs in the import file exist and are not empty.

     • Asset Information: Validates the dashboard's configuration information, including catalog ID, asset tags, description, whether usage instructions are enabled, and permission controls (such as visibility scope).

     • Chart's Parent Dashboard GUID: Verifies that the parent dashboard GUID for each chart exists and is not empty.

     • Asset Information: Validates the chart's configuration information, including chart ID, display name, and description.

6. When validation passes, the import result page is displayed.

   Parameter	Description
   Import Result	Displays the import progress, result, and execution time.
   Exception Records	Displays asset records that failed validation and could not be imported. Table/Field/Technical Metric: Includes the row number from the original file, type (for business metrics only), name of the table/field/technical metric/business metric, its GUID, parent table name (for field and technical metric assets only), and an exception message. API: Includes the row number from the original file, API name, API ID, and an exception message. Dashboard: Includes the row number from the original file, the name of the dashboard or the parent dashboard of the chart, dashboard GUID (for dashboards only), chart ID (for charts only), chart name (for charts only), and an exception message. On the Exception Records tab, you can click Download Exception Records to download the original records that failed validation. The downloaded file automatically includes an Exception Message column. You can correct the errors based on the messages and re-import the file.

   After the import begins, you can close the configuration dialog box without interrupting the task. To view the results, go to the Candidate Assets tab, click Batch Management > Batch Operation Records, and select the import record that you want to view.

Batch export assets

1. On the Candidate Assets tab, click Batch Management > Export All Assets, or select assets from the list and click Export Assets at the bottom. The export process is the same for all asset types. The following steps use a table asset as an example.

2. In the Batch Export Assets dialog box, configure the parameters.

   Parameter	Description
   Asset Source	You can select assets that are collected by scheduled metadata collection tasks or automatically collected from project compute sources. As a special case, the Dataphin data module contains only logical tables and modeling metrics, and you can select multiple items. This parameter is not applicable to business metrics.
   Asset Status	Select the scope of assets to export. You can choose from candidate assets, launched assets, or unlaunched assets. You can also select individual assets for export.

3. Click OK to export the assets.

   If you are exporting a large number of assets, it may take some time to generate the file. You can view the export task information and download the file from Batch Management > Batch Operation Records.

Batch operation records

You can view details of batch import and export operations.

1. On the Candidate Assets tab, click Batch Management > Batch Operation Records. The process for viewing batch operations is the same for all asset types. The following steps use a table asset as an example.

2. In the Batch Operation Records panel, view the import and export records for your assets.

   • Batch Import: Displays the details of asset import operations, including serial number, creator, asset type (for table and dashboard assets only), import status, creation time, and end time. You can also click the View icon in the Actions column to see import details.

   • Batch Export: Displays the details of asset export operations, including serial number, creator, export scope (for table, technical metric, API, and dashboard assets), export status, creation time, and end time. You can also click the Download icon in the Actions column to download the exported file.