Dataphin lets you download an Excel template of your asset configurations, update the file, and import it back into the system. This process helps you update asset details in bulk, improving collaboration and asset inventory efficiency. This topic describes how to use the bulk import and export features.
Prerequisites
First, complete your asset catalog planning and define properties for your asset objects. For more information, see Create and manage asset topics and Create and manage properties for asset objects, APIs, and dashboards.
When you export table or dashboard assets, the output is a compressed file. The file for table assets includes table, field, and technical metric assets. The file for dashboard assets includes dashboard and chart assets.
Limitations
Only the Intelligent R&D, Asset Operations - Advanced, and Asset Operations - Standard editions support the bulk import and export of assets.
The maximum concurrency for import or export tasks is 2.
The system retains the 50 most recent import or export records for each asset type.
You can download files only for export records with a "Success" status.
You can set the display name and description for a field by either referencing its Data Definition Language (DDL) comment or by providing custom text. This setting must be applied uniformly to all fields within the same table.
Permissions
A super administrator, an operations administrator, and any custom global role with on-shelf management-Manage permissions can view import details and download export records.
Standard users can import and export only assets for which they have maintenance permissions.
Bulk Import Assets
In the top navigation bar of the Dataphin homepage, choose Assets > catalog management.
In the left-side navigation pane, choose Manual Launch > select the appropriate asset type, and go to the Quasi-Asset tab.
On the Quasi-Asset tab, click Bulk Management-Bulk Import Assets in the upper-right corner. This procedure uses a table asset as an example. The process is identical for business metric, technical metric, API, and dashboard assets.
In the Bulk 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 import table or field assets. We recommend that you import tables before importing fields.
Dashboard: You can import dashboard or chart assets. We recommend that you import dashboards before importing 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.
Follow the instructions in the template. The system performs uniqueness and format validation during the import process.
Worksheet details: Do not delete the instruction or header rows. The system begins parsing data from the third row. Do not modify or delete column names, as this can cause the import to fail. Delete the example rows before filling out the template.
Handling empty column values: If you leave a required property empty, the update fails, and the system retains the existing configuration. If you leave a non-required property empty, the system clears its existing value. If you do not need to update a specific column, you can either keep its original exported values or delete the entire column from the import file.
If some property updates fail, other valid property updates are still processed. Before you list an asset, check its latest configuration and make corrections based on the error messages in the import record.
If you are importing table content, note the following guidelines:
The system processes the file row by row in order. We recommend importing tables before importing fields or technical metrics. To ensure proper parsing and prevent conflicts, place fields belonging to the same table in consecutive rows. Otherwise, the system may not detect configuration conflicts in advance, and later records could overwrite previous settings.
If you are importing field content, note the following guidelines:
The system processes the file row by row in order. We recommend importing tables before importing fields. To ensure proper parsing and prevent conflicts, place fields belonging to the same table in consecutive rows. Otherwise, the system may not detect configuration conflicts in advance, and later records could overwrite previous settings.
For dimension fields within the same table, the associated business entities must belong to the same domain. You must predefine statistical periods in the Plan > Public Definition section.
If you are importing technical metric content, note the following guidelines:
The system processes the file row by row in order. If you need to update information such as statistical granularity, we recommend importing tables before importing technical metrics.
If you are importing business metric content, note the following guidelines:
You can create business metrics in bulk through an import. If a row's business metric GUID is empty, the system creates a new metric.
If you are importing dashboard content, note the following guidelines:
The system processes the file row by row in order. We recommend importing dashboards before importing charts. To ensure proper parsing and prevent conflicts, place charts belonging to the same dashboard in consecutive rows. Otherwise, the system may not detect configuration conflicts in advance, and later records could overwrite previous settings.
After you upload the file, the system validates its format and content. Once validation is successful, click Start Import. The system then performs specific checks based on the asset type being imported.
Table:
table GUID: Verifies that the table GUID in the import file exists and is not empty.
Asset information: Verifies that the configuration information in the import file is valid. This includes display name, display name value configuration, description, description value configuration, catalog ID, asset tag, custom properties (including referenced system property values and hyperlinks), usage instructions toggle, and permission controls (including visibility scope, data profiling report, data lineage, quality overview, metadata change logs).
Field:
field GUID: Verifies that the field GUID in the import file exists and is not empty.
Asset information: Verifies that the configuration information in the import file is valid. This includes display name, field display name value configuration, description, field description value configuration, business type, associated entity domain, and associated entity name.
Technical metric:
technical metric GUID: Verifies that the technical metric GUID in the import file exists and is not empty.
Asset information: Verifies that the configuration information in the import file is valid. This includes display name, description, catalog ID, asset tag, custom properties (including referenced system property values and hyperlinks), technical properties, usage instructions toggle, and permission controls (including visibility scope, data profiling report, data lineage, quality overview, and metric relationship diagram).
Business metric:
business metric GUID: Verifies that the business metric GUID in the import file exists. If it is empty, the system creates a new business metric.
Asset information: Verifies that the configuration information in the import file is valid. This includes asset name, display name, catalog ID, asset tag, description, metric definition, related business metrics, metric relationship diagram toggle, metric relationship expression, business owner, custom properties (including referenced system property values and hyperlinks), associated technical metrics, usage instructions toggle, and permission controls (including visibility scope).
API:
API ID: Verifies that the API ID in the import file exists and is not empty.
Asset information: Verifies that the configuration information in the import file is valid. This includes API ID, catalog ID, asset tag, description, usage instructions toggle, and permission controls (including visibility scope).
Dashboard:
dashboard GUID: Verifies that the dashboard GUID in the import file exists and is not empty.
Asset information: Verifies that the configuration information in the import file is valid. This includes catalog ID, asset tag, description, usage instructions toggle, and permission controls (including visibility scope).
chart's dashboard GUID: Verifies that the GUID for the chart's parent dashboard in the import file exists and is not empty.
Asset information: Verifies that the configuration information in the import file is valid. This includes chart ID, display name, and description.
After validation passes, the system automatically displays the import results page.
Parameter
Description
Import result
Displays the import progress, result, and execution time.
Exception records
Displays records for assets 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), the name of the table/field/technical metric/business metric, its GUID, parent table name (for field and technical metric assets only), and an error message.
API: Includes the row number from the original file, API name, API ID, and an error message.
Dashboard: Includes the row number from the original file, the name of the dashboard or the chart's parent dashboard, dashboard GUID (for dashboards only), chart ID (for charts only), chart name (for charts only), and an error message.
On the Exception Records tab, you can click Download Exception Records to download a file containing the original records that failed validation. This file includes an additional Error Message column. You can correct the entries based on the error messages and re-import the file.
After the import begins, you can close the import dialog box. Closing the dialog box does not stop the import task. To check the status, go to the quasi-asset tab, click Bulk Management-Bulk Operation Records, and select the historical import record you want to view.
Bulk export assets
You can export only assets for which you have maintenance permissions.
When you export table or dashboard assets, the output is a compressed file. The file for table assets includes table, field, and technical metric assets. The file for dashboard assets includes dashboard and chart assets.
On the quasi-asset tab, click Bulk Management-Export All Assets, or select assets from the list and click Export Assets at the bottom. This procedure uses a table asset as an example. The process is identical for business metric, technical metric, API, and dashboard assets.
In the Bulk Export Assets dialog box, configure the parameters.
Parameter
Description
Asset source
You can choose assets collected by scheduled metadata collection tasks or assets automatically collected from a project compute source. You can select multiple options. Note that the Dataphin data domain contains only logical tables and modeling-based metrics.
This parameter is not applicable to business metrics.
Asset status
Select the scope of assets to export. You can choose from quasi-assets, listed assets, and unlisted assets. You can also select assets at a more granular level.
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 details and download the file from Bulk Management-Bulk Operation Records.
Asset bulk operation records
You can view the detailed import and export operation records for each asset.
On the quasi-asset tab, click Bulk Management-Bulk Operation Records. This procedure uses a table asset as an example. The process for viewing bulk operation records is identical for business metric, technical metric, API, and dashboard assets.
In the Bulk Operation Records panel, view the import and export operation records for your assets.
Bulk Import: Displays detailed records of asset import operations, including ID 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.
Bulk Export: Displays detailed records of asset export operations, including ID number, creator, export scope (for table, technical metric, API, and dashboard assets only), export status, creation time, and end time. You can also click the Download icon in the Actions column to download the exported file.