Data Dictionary

Overview

The Data Dictionary module is designed to manage and maintain standardized definitions of various data elements used across the system. Its primary purpose is to ensure data consistency, readability, and reusability within the warehouse control and management ecosystem.

By clearly defining key data codes, names, descriptions, and hierarchical relationships, the Data Dictionary acts as a central metadata repository, supporting logic configuration, system integration, and user comprehension.

The data dictionary interface is divided into two panes: parent dictionary on the left and child dictionary entries on the right pane. The following sections explain these two dictionaries separately.

Parent Dictionary Entries

This interface displays dictionary entries where parent_id = 0, i.e., top-level dictionary categories.

Search

It supports search by Data Code and Data Name. Upon performing a search, matching top-level entries will be listed in the left pane, and the right pane will be cleared to await a new selection. The associated data item will appear upon selecting the parent data.

Add New Data Dictionary

1. Go to Data Dictionary > + Create Data Dictionary.

2. Enter the Data Code and Data Name.

3. Optionally fill in a comment.

4. Click Save to complete this creation.

Edit/Delete Existing Data Dictionary

1. Locate the target data dictionary in the list.

2. If you want to remove it, please click on Delete.

3. If you want to update any information, please click on Edit to continue.

4. Modify the data name or comment.

   Note: Data Code is not editable.

5. Click Save to apply the changes.

Child Data Dictionary

When the parent entry is selected on the left, this pane displays child dictionary entries (data item) where parent_id equals the selected ID. It supports users to add, edit or delete data item under the selected parent.

Add New Date Item

1. Select the parent data dictionary following the search section.

2. Click Create Data Item to start.

3. Enter the data code, date name, and comment of the data item.

4. Click Save to complete the creation.

Edit/Delete Existing Data Item

1. Select the first-level entry, then locate the data item.

2. If you want to remove the entry, please directly click Delete action button.

3. If you want to update any fields, please click on Edit to proceed.

4. Modify the necessary info.

5. Click Save to apply the changes.