MasterCode

note

You need the admin rights to use this feature.

MasterCode allows administrators to define reusable code lists for values that are used across applications, forms, and system configurations. A MasterCode contains one or more items, and each item can include display text, translation values, status, priority, icon, and effective dates.

Administrators can create, search, import, and export MasterCode configurations for configuration management, backup, or migration across environments.

Manage the MasterCode

To manage the MasterCode, perform the following:

1. In the KAIZEN studio console, on the left panel, click System Configuration > MasterCode.

   The System Configuration/ MasterCode page displays.

   

2. From here, you can create new MasterCodes, import or export MasterCodes, and export all MasterCodes. Each row in the table provides the following actions under the Actions column:

   • View: Opens the user details in read-only mode.
   • Edit: Opens the user details for editing.
   • More: Expands a dropdown with additional actions: Cascade, Deactivate, and Export.

Create MasterCode

1. In System Configuration/ MasterCode, click Create.

2. In the Create MasterCode window, provide the details:

   

   The following table describes each field from the window above:

   Field	Required	Description
   User Domain	Yes	Displays the user domain for the MasterCode.
   MasterCode Name	Yes	Enter a unique name for the MasterCode.
   Status	Yes	Sets whether the MasterCode is active or inactive.
   Description	No	Enter optional details about the MasterCode.

3. Click Create Item to add an item to the MasterCode.

4. In the Create MasterCode Item window, provide the details:

   

   The following table describes each field from the window above:

   Field	Required	Description
   Item Code	Yes	Enter a unique code for the item.
   Short Description	Yes	Enter a short display description for the item.
   Translation	No	Add translated display values for different languages.
   Priority	No	Enter the display order or priority of the item.
   Status	Yes	Sets whether the item is active or inactive.
   Icon	No	Select an icon to represent the item.
   Start Time	No	Select the date when the item becomes effective.
   End Time	No	Select the date when the item is no longer effective.

5. Click Save to save the MasterCode item.

6. Click Save to create the MasterCode.

Search MasterCodes

To search for MasterCodes, perform the following:

1. In System Configuration/ MasterCode, enter or select the search criteria.

   Field	Description
   User Domain	Displays the user domain for the current session.
   MasterCode Name	Search for MasterCodes by their name.
   Status	Filter MasterCodes by their status.
   Description	Search for MasterCodes by description.

2. Click Search to find the result.

Cascade MasterCode

Cascade MasterCode allows administrators to create a parent-child relationship between MasterCode items. This is useful when the available values in one list depend on the selected value from another list, such as showing only the relevant child options after a parent option is selected.

To cascade a MasterCode, perform the following:

1. In System Configuration/ MasterCode, select the MasterCode you want to use as the parent MasterCode.

2. Click More, then click Cascade.

   The Master Code Cascade window opens. The Parent Master Code field displays the selected MasterCode.

3. Enter or select the cascade information.

   Field	Required	Description
   Parent Master Code	Yes	Displays the selected parent MasterCode.
   Parent Master Code Item	Yes	Select the parent item that the child values depend on.
   Child Master Code	Yes	Select the child MasterCode to cascade from the parent item.
   Child Master Code Item	No	Assign the child items that should be available for the selected parent item.

4. In Child Master Code Item, select one or more items from Pending Assign, then click the right arrow > to move them to Assigned.

   You can use the search fields in Pending Assign or Assigned to find specific child items.

5. To remove assigned child items, select the items from Assigned, then click the left arrow < to move them back to Pending Assign.

6. Click Save.

   The selected child MasterCode items are cascaded under the selected parent MasterCode item.

note

In KAIZEN 5.3.0, Cascade MasterCode supports exporting and importing. The exported XML file contains all the Cascade relationships, which can be imported subsequently.

Deactivate MasterCode

To deactivate a MasterCode, perform the following:

1. Click More on the same row as the MasterCode, then click Deactivate.

2. In the confirmation dialog, click OK.

   A success message will confirm that the MasterCode has been deactivated. The MasterCode status will change from Active to Inactive.

note

After the deactivation, you have the option to reactivate it by clicking More > Activate.

Export MasterCodes

To export a MasterCode, perform the following:

1. In System Configuration/ MasterCode, select the MasterCode you want to export.

2. Open the Export function using one of the following methods:

   • Click Export at the top of the page.
   • Click More on the same row as the MasterCode, then click Export.

3. The Confirm window pops up, asking for confirmation. Click OK.

   A file in XML format will be downloaded in your browser.

Export all MasterCodes

To export all MasterCodes, perform the following:

1. In System Configuration/ MasterCode, click Export All.

2. The Confirm window pops up, asking for confirmation. Click OK.

   A file in XML format will be downloaded in your browser, containing the information of all MasterCodes.

Import MasterCodes

To import a MasterCode from an existing XML file, perform the following:

1. In System Configuration/ MasterCode, click Import. The File Explorer window opens.

2. Navigate to the XML file that contains the MasterCode information. Click Open.

   The Select Overwrite Fields window displays.

3. Select the fields to overwrite when an imported MasterCode matches an existing MasterCode.

   You can use Select All Or Not to quickly select or clear all fields.

   Category	Fields
   MasterCode details	Description, Editable, Status
   Item details	Short Description(item), Priority(item), ItemStatus(item), Icon(item)
   Item effective period	Start Time(item), End Time(item)
   Translation	Value(translation)

4. Click Import.

   A message will pop up, showing the import is successful.

Last updated on 21 Sep 2026