Dictionary Builder
Last updated
Last updated
Dictionary is a type of information management asset available in the platform—a tool designed for tabular entry and retrieval of structured data without the need to call an external database.
To work with this asset type, go to the Explorer panel and open the Assets section. It contains a tree of all assets in the project, including dictionaries.
Double-clicking on any Dictionary entry opens a tab with the Dictionary builder panel.
The dictionary name should be longer than 1 symbol and shorter than 100. It can contain the letters (Latin a-z A-Z), numbers 0-9, $, and an underscore. Beginning from a letter or underscore character. The name of the dictionary must be unique within the level where it is created (folders or tree root).
Regardless of which dictionary type is used, based on the columns added to it, a new backing data structure will be automatically generated. You can find it in the Structures section of the Explorer panel. Also, a user can reassign the structure to be used for this dictionary. When changing the field structure in the dictionary settings, the referenced structure will also change.
In the platform, there are 2 types of dictionaries available:
Reason code — provides information about the source of problems with a description. It is used when working with scorecards where the ‘Use reason code’ option is active.
Custom — provides information about user data in an arbitrary structure.
To continue working with a specific type of dictionary, select the type in the dictionary settings section.
To add a description to the dictionary settings, click on the description section and enter the value.
Preservation occurs when starting/switching work with another entity or closing a tab.
After a dictionary is created, it is classified as Custom type by default. it is possible to add additional fields and change their types.
The parameter’s name should be longer than 1 symbol and shorter than 255. It can contain letters (Latin a-z A-Z), numbers 0-9, $, and an underscore. Beginning from a letter or underscore character.
Supported data types for dictionary properties:
Boolean — value “true” or “false”;
String — text, for example, “Peter Petenson”;
Integer — whole number, for example, “22”;
Float — real number which allows the fractional part, for example, “0.1234”;
Date — specify the date value in the format yyyy-mm-dd, for example, ‘'1993-05-31’'.
After changing the parameters’ composition or their type, the same changes are applied to the auto-generated structure.
It is possible to change the use of an auto-generated structure in the dictionary to another one in the Structure drop-down list at the top of the Parameters section in the dictionary builder.
After cloning a dictionary, it will refer to the same structure as the main dictionary. The structure used can be changed if necessary.
Select a parameter on the Dictionary settings section. By clicking the right mouse button, a context menu opens through which a number of commands are available.
Here is the list of available commands:
Add — allows you to add a new parameter.
Clone — allows you to create a clone of the parameter. The cloned flow will have the same name as the Name of the parent parameter + Clone(n).
Delete — allows you to delete the parameter.
After the type of dictionary Reason code has been chosen, a list of parameters that you must work with appears. Adding additional parameters is possible but changing the type of required parameters will result in errors.
Required parameters:
Rank (integer) — error rank.
Name (string) — error name.
Code (integer) — error code.
Message (string) — error message.
In the central part of the Dictionary builder, it is possible to enter the necessary data into the table according to the types of parameters.
To create a new Dictionary, select the Assets icon on the left-hand side of the Project Explorer panel. Next, create a new dictionary by clicking on the Add icon on the Explorer panel and selecting New Dictionary command from the menu.
To create an asset in a folder, select or create the desired folder first, then click on the Add icon. In the pop-up window, enter the dictionary name and click on the CREATE button.
To add a new parameter, click on the Add icon in the parameters section, then click on the data type dropdown and select the desired data type as required. Click on the name of the field and change the name (optional).
To add an additional row above, click on the Add Row Above icon in the panel above the table.
To add an additional row below, click on the Add Row Below icon in the panel above the table.
To Remove a row, select the row and click on the Remove Row icon in the panel above the table.
To Cut a row, select the row and click on the Cut Row icon in the panel above the table.
To Paste a row, select the row and click on the Paste Row icon in the panel above the table. This is not available unless you have previously used the Cut options.
To Add a column before, select the column and click on the Add column before icon in the panel above the table. Then create a new parameter and select its type. (Available only for dictionary type Custom).
To Add a column after, select the column and click on the Add column after icon in the panel above the table. Then create a new parameter and select its type. (Available only for dictionary type Custom).
To Remove a column, select the column and click on the Remove Column icon in the panel above the table. (Available only for dictionary type Custom).
