Dictionary field

This field allows you to create dropdown menu selector of records from dictionary (table), e.g. list of employees (First name, last name, age, address).

Hint

This field can be added to structured and PDF documents.

How to add dictionary field to the document

  1. To add field to the document, use one of field adding methods with field icon in the Fields tab of template editor menu

../../../../../../../../_images/dictionaryIcon.png

  1. Field creation form will appear, where you should set field attributes

../../../../../../../../_images/dictionaryCreate.png

  1. Name - this is a name of a field

  2. Role name - this is a role which will be assgined to fill this field

  3. Placeholder - this text will be shown inside the field before it is filled in (can be left empty; field`s name will be used instead)

  4. Optional - this attribute specifies if this field is mandatory to fill

  5. Allow custom values - this attribute specifies if field will allow free text input besides selection from predefined values

  6. Search - this attribute specifies if this field should be eligible for mailbox page search

  7. Dictionary - input for desired dictionary selection. Start typing dictionary name and available dictionaries list will appear

  8. Column name (appears after dictionary is selected) - dropdown selector of a desired column

  9. Filtering (icon in dictionary name field) - opens filtered access options menu. Appears only if filtered access is allowed for selected dictionary

../../../../../../../../_images/filteringModal.png

  1. Column name - name of a column in a dictionary which will be used for filtering

Note

Value from this column will be used to find a matching row in a column selected in dictionary during envelope processing flow.

  1. Filter by role mailbox - this attribute specifies if filtering should be applied by role (if enabled) or by field value (if disabled)

  2. Field name (changes to role name if previous attribute is enabled) - field which will be used to specify a row by value from column selected in column name (13)

Note

If filtering by role is enabled and field becomes role name selector, it selects a role mailbox UUID of which will be used to find a matching row in dictionary. In this case, column with mailbox UUIDs should be selected in column name (13) field for matching.

When all attributes are set, you can click Save button and field will be added. You can click field to see its properties and update them. Also you can delete the field in same menu.

../../../../../../../../_images/dictionaryEdit.png

Hint

If this field contains a link in the envelope, it will be rendered a standard link in the browser (blue font with an underline). You can follow this link from the right-click context menu (any role) or directly click it (only if the field is inactive).