Wiring a dictionary data source

Eximee allows feeding form components with data coming from dictionaries – that is predefined lists of values maintained in Library of the platform. Dictionaries are convenient for drop-down lists or groups of radio buttons because they centrally manage sets of options (e.g., country list, document type list). Updating a dictionary in one place can automatically affect all requests using it.

Step-by-step configuration:

1. Preparing the dictionary: You should make sure that 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 to be fed from the dictionary. These can be: Value picker from a list (Combobox), Text field, Radio group or Checkbox group – all these types support dictionary sources.

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

   

   Illustration 1. Window for selecting an external data source 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 on which the dictionary content depends (e.g., a Cities dictionary dependent on the selected Province). In such a case you should assign appropriate components to the parameters, analogous 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 request execution the component will be automatically populated with data from the dictionary. For a conditional dictionary the list of values will be refreshed automatically after changing the field it depends on (e.g., changing the Province will reload the list of Cities).

Attaching a script

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

Illustration 3. Example script returning a dictionary with input parameters