Configuration
Creating a New Dynamic Code List
New Dynamic Code Lists always need to be created by the system user first, in order for other users (administrators with the ‘Application Data’ security profile) to start using/editing the newly created custom code list. Only a system user can add/delete a dynamic code list. A user with the ‘Application Data’ security profile can add/edit/remove list items to/from each of the available lists (navigate to Application Data > Lists > Code lists).
In order to create a new dynamic code list, log in to the AvantGard Trax platform as system/system, navigate to System > Gui > Code list and select the New action.
Figure 181 Creating a new dynamic code list as the system user
| Field | Required | Description |
|---|---|---|
| Code | Yes | Unique identification of the dynamic code list, used by AvantGard Trax and stored in the database. |
| Name | No | Meaningful name for the dynamic code list. |
| Description | No | Meaningful description of the dynamic code list. |
Table 181 Dynamic code list attributes
The ‘code list item’ tab, allows you to add/delete values to/from the newly created dynamic code list.
Figure 182 Creating new list code items
| Field | Required | Description |
|---|---|---|
| Code | Yes | Unique identification of the code list item, used by AvantGard Trax and stored in the database. |
| Name | No | Meaningful name for the code list item. This name will be shown to users in the GUI dropdown. |
| Description | No | Meaningful description of the code list item. |
| Tag list | No | A comma separated list of tags, serving as meaningful categories to which the code list item belongs. The XGL GUI widget will on filter code list items by referring to such (a) tag(s). The tagging system is very flexible: tag names can be chosen in a completely arbitrary way and denote completely arbitrary dimensions, or they can reflect important values of some other code list in order to build in the necessary dependencies when working with the XGL GUI widget. |
Table 182 List code item attributes
Lists (and therefore also list items) are audit-capable. This is disabled by default. When enabled, an inventory for pending code lists will become available in Application Data.
Using the Dynamic Code List GUI Widget
When developing custom payment entry screens, a new “configurable dropdown widget” can be used that takes its code list items from a dynamic code list and controls the content of a dropdown (that is offered to users in the AvantGard Trax GUI).
To enable the use of dynamic code lists in the AvantGard Trax GUI, a new native dataElement tag was added to XGL:
| Name | Type | Required | Description |
|---|---|---|---|
| list | String | Yes | The code of an existing code list in AvantGard Trax to display in the GUI screen. |
| useTags | String | No | A comma separated list of tag values, used to filter the code list. Usage of multiple tags is supported, i.e. only list items that have all the corresponding tags will be available (in other words AND operator should be used between the tags). |
Table 183 codeListData XGL widget attributes
The Name attribute of the code list item is used to display the items to the user. The Code attribute of the code list item is used in the data binding.
Furthermore, the “eval” event was extended with the extra attribute “useTags”. The eval event can be used to do generic logic in an XGL screen. The new useTags attribute allows you to dynamically change the displayed values of a dynamic code list in the GUI, depending on the values in one or more input fields (it is possible to use different input field types: combo-box, text field, etc).