Create and manage root words

Quick start in 5 minutes

Permission description

Members can batch export roots.

Scenarios

When you name fields in Data Studio > Table Management, you can create business terms for those fields. The system automatically matches field names with terms created in Data Standard > Business Term, such as amount and account, to standardize naming.

Root List

On the Business Term list page, you can view, search for, edit, and delete configured business terms.

Create a new root

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

2. In the navigation pane on the left, choose Reference Data > Business Term. On the Business Term page, click +Create Business Term.

3. In the Create Business Term dialog box, configure the parameters.

   Parameter	Description
   Root Name	The name of the business term. For example, Amount. The name can be up to 128 characters long.
   Full Name	The full name of the root. For example, amount. The maximum length is 64 characters.
   Abbreviation	The abbreviation for the root, such as amt, can be up to 64 characters long.
   Description	A description of the business term's purpose and applicable scenarios. Limited to 256 characters.

4. Click OK to create the business term.

Batch import roots

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

2. In the Import Business Terms dialog box, configure the parameters.

   Parameter	Description
   Import Scenario	The configuration template varies based on the import scenario. The downloaded update template contains existing business term information. Modify only the information that requires revision and re-import the file. The supported scenarios are Add and Update. The import scenario only affects the generation of the configuration template. During the actual import, the system determines whether to add or update a business term based on whether its name already exists.
   STEP 1 Download Configuration Template -- Add
   Configuration Template	If you do not have a template, click the file name or the download icon to download the .xlsx file. If you already have a template, you can directly upload the configuration file and start the import. Note You must have the permission to create or edit business terms to import them. Otherwise, the import fails due to an access denied error.
   STEP 1 Download Configuration Template -- Update
   Update Scope	Select the business terms to update. You can select all business terms or specify the ones to update. You can select up to 10,000 business terms at a time.
   Configuration Template	The template is generated based on the selected scope. If you select **All** for the update scope, you can download the template directly. If you select **Specify**, click Generate Template to generate the .xlsx template file, and then download it. Note If you do not have a template, click the file name or the download icon to download the .xlsx file. If you already have a template, you can directly upload the configuration file and start the import. You must have the permission to create or edit business terms to import them. Otherwise, the import fails due to an access denied error.
   STEP 2 Upload Configuration File
   Upload File	You can import an .xlsx file containing up to 10,000 business terms at a time. The file size cannot exceed 20 MB. The import fails if the file type is incorrect, the file contains multiple worksheets, or the number of business terms exceeds 10,000 rows. Modifying field names or adding or deleting fields might cause parsing to fail, resulting in a failed import. When you fill in the template, follow the instructions. During the import, the system checks the uniqueness and format of each business term name. If a check fails, the import fails. Business Term Name: Required. Must be globally unique. Can be up to 128 characters long. During import, the system identifies the business term object by its name. If the name already exists, the operation is treated as an update and is processed based on the conflict policy. If the name does not exist, the operation is treated as an addition. Full Name: Required. Can be duplicated. Can be up to 64 characters long. Supports Chinese characters, letters, digits, and the following special characters: -, _, (), space, '. Abbreviation: Required. Can be up to 64 characters long. Supports letters, digits, and any single-byte symbols. Description: Optional. Can be up to 256 characters long.
   STEP 3 Conflict Resolution Policy
   Validation Field	Business Term Name (globally unique, case-insensitive).
   Handling Policy	Specifies how to handle name conflicts during import. You can select Skip on conflict or Overwrite on conflict. Skip on conflict: If an imported business term name is the same as an existing one, the record is skipped. Overwrite on conflict: If an imported business term name is the same as an existing one, the existing business term's information, such as its name and description, is updated with the imported content. Note Business term names are globally unique. If an imported business term name is the same as an existing one, or if multiple records in a single import have the same name, the system will either skip the record or overwrite the existing object based on the handling policy.

3. Click Start Import. In the View Business Term Import Records dialog box, you can view the import result and download abnormal records.

   Parameter	Description
   Import Result	View the import progress, import result, and running time.
   Abnormal Records	Displays business term records that failed to be imported due to failed validation. The information includes the row number in the original file, business term name, abbreviation, abnormal field, and error message. 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 set to **Skip on conflict**, records with names that already exist in the specified business terms are skipped and listed here. The information includes the row number in the original file, business term name, and abbreviation. Click the Skipped Records tab, and then click Download Skipped Records to download the corresponding original records as an Excel file.
   Execution Log	View and copy the execution log of the import process.

   After the import is complete, you can close the dialog box. Closing the dialog box does not stop the import task. On the business term list page, click View Import Records and select the import record that you want to view.

Export business terms in batches

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

2. In the Batch Export Roots dialog box, you can export roots by specifying an export scope.

   Export Scope: Select the business terms to export. You can export all business terms or only selected ones. You can select up to 10,000 business terms.

3. Click OK to export the business terms.

View root 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 Business Term Batch Operation Records panel, view the import records. Each record includes the ordinal number, creator, import status, import scenario, creation time, and end time. Click the View icon in the Actions column to view import details.