Dictionary Configuration


The Data Dictionary is the core module for configuring compliance questionnaires and ScoreCards. By abstracting common fields (checkboxes, dropdowns, text inputs, file uploads ) into "dictionary items," you maximize field reuse across multiple questionnaires and ensure the backend consistently receives data via standardized API Field Keys or Alias Names.

System Dictionary

System-preset high-frequency compliance fields (e.g. company name, registration number, company email). Available for direct use or as templates for derivation.

Custom Dictionary

Fully custom-built dictionary items created by your team from scratch to meet specific business scenarios.

Managing Dictionary Items

Go to Configuration → Dictionary. The list has two tabs:

TabContents
ActiveAll dictionaries in Draft, Published, or Published (Modified) states
ArchivedDeactivated dictionaries only (no Status filter available)

Search and filter options:

  • Enter at least 4 characters of the Display Name for fuzzy search
  • Filter by Class (Standard / Custom) and Status (Draft / Published)

Creating Dictionary Items

Click + Create in the Dictionary list. Two creation paths are available:

Path A: From System Dictionary

  1. Click From System Dictionary in the modal.

  2. Select a preset standard item (e.g. Company Role Type) and click Confirm — only one item can be selected at a time.

  3. The API Field Key is inherited and non-editable, but you can freely modify the Display Name, description, and add/remove option values.

  4. The item Class is labeled System.

Path B: Custom Dictionary

  1. Click Custom Dictionary in the modal to open a blank form.

  2. Fill in: Display Name → Type (e.g. Short Text, Dropdown) → Category (Individual / Company) → Description → Save.

  3. Alias Name auto-generates from the Display Name (lowercase, spaces → dots, special chars removed).
  4. Once first published, the Alias Name is permanently locked and cannot be changed.

⚠️

For custom Short/Long Text dictionary items, use the Configuration section to set character length limits (min 0 / max 255), input mode (digits only, all uppercase, all lowercase, or mixed), and allowed character sets. A real-time validation test tool is available to verify your rules before publishing.



Did this page help you?