Lists

Business goal

There are two types of lists in the application:

• Translatable lists: Those contain selectable items that can be translated.
  • Example: Country list, social states, document types, ...
• Lookup lists: Those lists map certain elements to a key that can be used for e.g. due diligence checks
  • Example: The country BE maps (looks up) to a LOW risk

Import/export

JSON format

Lists can be imported and exported in a technical JSON format for archival purposes.

CSV (translation) format

Lists can also be exported in CSV format. This format allows easier processing in applications such as Excel and can be shared with third parties (e.g. for translation). Once adapted, this format can also be imported again. Make sure to preserve all columns to ensure no translations or values are discarded.

List order

The order of the elements in the list can be changed by using the import/export functionality.

General

Every element consists out of an identifier and a value. The value is always in JSON format and depends on the list type.

Note that the identifier should be picked carefully. Use a clean and readable technical identifier. Don't change an identifier without considering possible usage. If the identifier is still used in e.g. dossiers or parties, those will show the identifier instead of the value.

• Good examples: SOME_IDENTIFIER, some_identifier
• Bad examples: some identifier, values, with non-text characters

Lists should only be removed after they are not referenced anymore in custom providers. Removing a list that is still in use will result in errors and missing functionality.

Translatable lists

When editing an element in a translatable list, use the following format:

{
  "translations": {
    "en": {
      "label": "label",
      "extra": {
        "description": "description",
        "infoText": "infoText"
      }
    }
  }
}

Translations can be added for every language supported by the system. The various fields use a similar format as the main Translations. See there for more information for extra.description and others.

Lookup lists

These lookup lists hold a value in a simple JSON-encoded string value:

"VALUE"