All Products
Search
Document Center

Dataphin:Create and manage root items

Last Updated:Apr 15, 2025

Root items are instrumental in managing business terms, physical tables, field standard naming, and their standardized translations. A unified root item library is essential for consistent asset management and clear data flow. This topic explains the process of creating and managing root items.

Permission Restrictions

Support for creating no more than 100000 roots.

Permission description

All members can batch export root items.

Scenarios

For naming fields in Data Development > Table Management, you can create root items. The system will automatically match the created fields with those in Data Standard > Root Items (such as amount, account, etc.) to standardize field naming.

Root item list

On the Business Term list page, you can view the configured root item information and perform operations like searching, editing, or deleting root items.

image.png

Area

Description

Search Area

Supports searching by root item name, full name, and abbreviation.

Root Item List

Displays the name, full name, abbreviation, description, last updated by, and last updated time of the root items. You can also edit or delete root items.

  • Edit: Modify the information of the root item.

  • Delete: Deletion is irreversible. Please proceed with caution.

Create a new root item

  1. On the Dataphin home page, select Administration > Standard from the top menu bar.

  2. In the left-side navigation pane, select Reference Data > Business Term. On the Business Term page, click the + New Root Item button.

  3. In the New Root Item dialog box, enter the required parameters.

    Parameter

    Description

    Root Item Name

    The name of the root item, such as: amount. No more than 128 characters.

    Full Name

    The full name of the root item, such as: amount. No more than 64 characters.

    Abbreviation

    The abbreviation of the root item, such as: amt. No more than 64 characters.

    Description

    You can add descriptions of the root item's meaning and usage scenarios, no more than 256 characters.

  4. Click OK to finalize the creation of the root item.

Batch import root items

  1. On the Business Term list page, click Batch Import/Export in the upper right corner and select Batch Import Root Items.

  2. In the Batch Import Root Items dialog box, configure the necessary parameters.

    Parameter

    Description

    Import Scenario

    Different import scenarios correspond to different configuration templates. The downloaded update template file will contain root item information. You only need to modify the information that needs to be revised and then re-import it. Supports Add and Update two import scenarios.

    The import scenario only affects the generation of the configuration template. During the actual import process, whether to add or update is determined based on whether the root item name exists.

    STEP 1 Download Configuration Template--Add

    Configuration Template

    If there is no template, you can click the file name or download the image.png icon to download the .xlsx file. If there is already a template, you can directly upload the configuration file and import it.

    Note

    Importing root items requires permission to create or edit root items. Otherwise, permission verification will fail, and import cannot be performed.

    STEP 1 Download Configuration Template--Update

    Update Scope

    Select the root items that need to be updated. You can choose to update all or specify the root items that need to be updated. The number of root items selected at one time does not exceed 10,000.

    Configuration Template

    Generated based on the selected root item range. If the update scope is selected as all, you can directly download the template. If the update scope is selected as specified, click Generate Template to generate a .xlsx format template file and then download it.

    Note
    • If there is no template, you can click the file name or download the image.png icon to download the .xlsx file. If there is already a template, you can directly upload the configuration file and import it.

    • Importing root items requires permission to create or edit root items. Otherwise, permission verification will fail, and import cannot be performed.

    STEP 2 Upload Configuration File

    Upload File

    • Import up to 10,000 root items in a single .xlsx file. The size of a single file does not exceed 20 MB.

    • If the file types are inconsistent, or there are multiple worksheets, or the root item information exceeds 10,000 rows, it cannot be imported. If the field names are modified, or fields are added or deleted, it may cause the template to be unparseable, resulting in import failure.

    • When filling in the template, please follow the template instructions. During the import process, uniqueness and standardization verification will be performed based on the root item name. If the verification fails, the import will fail.

    • Root Item Name: Required, globally unique, up to 128 characters. During import, the root item object will be identified based on the root item name. If the root item name already exists, it will be considered an update root item operation, and the import will be executed based on the conflict policy configuration. If the root item name does not exist, it will be considered a new root item operation.

    • Full Name: Required, can be repeated; up to 64 characters, supports input of Chinese characters, English letters, numbers, and special characters -、_、()、space、’.

    • Abbreviation: Required, up to 64 characters, supports input of English letters, numbers, and any half-width symbols.

    • Description: Optional, up to 256 characters.

    STEP 3 Conflict Resolution Policy

    Verification Field

    Root item name (globally unique, case insensitive).

    Handling Policy

    The handling policy when the root item name imported this time is the same as the existing root item name. Supports selecting Skip If Conflict or Overwrite And Update If Conflict.

    • Skip If Conflict: If the imported root item name is the same as the existing root item name, skip the record without processing.

    • Overwrite And Update If Conflict: If the imported root item name is the same as the existing root item name, update the other information of the existing root item online based on the content imported this time, such as root item name, description, etc.

    Note

    The root item name is globally unique. If the imported root item name is the same as the existing root item name, or if there are multiple records with the same root item name in a single import, the record will be skipped without processing or the original object will be overwritten with the new record according to the handling policy.

  3. Click Start Import. In the View Root Item Import Records dialog box, you can view the import results, download abnormal records, and more.

    Parameter

    Description

    Import Results

    You can view the import progress, import results, and execution time.

    Abnormal Records

    • Displays root item records that cannot be imported due to verification failure, including the corresponding row number, root item name, abbreviation, abnormal field, and abnormal prompt in the original file.

    • Click the Abnormal Records tab, and then click Download Abnormal Records to download the corresponding original records as an Excel file.

    Skipped Records

    • If the conflict policy is configured to skip if conflict, the records with names that already exist in the specified root items will be skipped and displayed in the skipped records list, including the corresponding row number, root item name abbreviation, and short name in the original file.

    • Click the Skipped Records tab, and then click Download Skipped Records to download the corresponding original records as an Excel file.

    Execution Log

    You can view and copy the execution log of the import process.

    After the import is complete, you can quickly view the import results by closing the import configuration dialog box, which does not stop the import task. View the import records in the root item list by clicking View Import Records and selecting the historical import records you want to see.

Batch export root items

  1. On the Business Term list page, click Batch Import/Export in the upper right corner and select Batch Export Root Items.

  2. In the Batch Export Root Items dialog box, you can export root items according to the specified export scope.

    Export Scope: Choose the scope of root items for export. Options include exporting all root items or only selected ones, with support for up to 10,000 root items.

  3. Click OK to complete the export of root items.

View root item import records

  1. On the Business Term list page, click Batch Import/Export in the upper right corner and select View Import Records .

  2. In the Root Batch Operation Record dialog box, you can see the records of root import operations, which include details such as ordinal number, creator, import status, import scenario, creation time, and end time. Additionally, by clicking the View icon in the operation column, you can access the detailed import information for the roots.