Connecting a dictionary data source

Eximee allows form components to be populated with data coming from dictionaries – that is predefined lists of values maintained in the Library of the platform. Dictionaries are convenient for dropdown lists or groups of radio/checkbox options because they centrally manage sets of options (e.g., list of countries, list of document types). Updating a dictionary in one place can automatically affect all applications that use it.

Step-by-step configuration:

1. Preparing a dictionary: Make sure the required dictionary has been created in the system (in the Dictionaries Eximee library module). Check that it contains up-to-date keys and values, and if necessary create a new dictionary according to requirements (e.g., CountryList with country codes and names).

2. Selecting the component: In Eximee Designer, select the component that should be fed from the dictionary. These can be: Dropdown field for selecting a value from a list (Combobox), Text field, Radio group or Checkbox group – all these types support dictionary sources.

3. Selecting a dictionary as an EDS: In the Properties GesCheckbox11.ariaLabel Interactions click in the component's External data source and select Select servicefield. On the list of available sources, find the name of the appropriate dictionary. The dictionary appears on the list just like services. After selecting the dictionary, its name will appear in the External data source field.

   

   Illustration 1. External data source selection window with the chosen dictionary
4. Parameter mapping (conditional dictionaries): For a standard dictionary (without conditions) no mapping is required – the component automatically retrieves all keys and values. However, if a conditional dictionary is used, parameters that need to be mapped will appear in the Input parameters tab. These are usually other form fields that the dictionary content depends on (e.g., a Cities dictionary dependent on the selected Province). In such a case, assign the appropriate components to the parameters, similarly to mapping service input.

   

   Illustration 2. Example of mapping input parameters for a dictionary with defined key display conditions
5. Save: After finishing the configuration, save the changes. During the application runtime the component will be automatically populated with data from the dictionary. For a conditional dictionary, the list of values will be refreshed automatically when the field it depends on changes (e.g., changing the Province will reload the list of Cities).

Attaching a script

The data source for a component fed by a dictionary source can also be a script service. This solution allows writing a script that can, for example, compute dictionary values dependent on an input parameter or return different values for different languages.

Illustration 3. Example script returning a dictionary with input parameters