Dictionary field

Written by Анатолій
Updated 5 days ago

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

This field can be added to structured and PDF documents.

How to add a dictionary field to the document?

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

../../../../../../../../_images/dictionaryTile.png

The field creation form will appear, where you should set field attributes

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

  1. Name - this is the name of a field

  2. Role name - this is a role which will be assigned 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 the 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 the dictionary name, and the available dictionaries list will appear

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

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

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

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

Value from this column will be used to find a matching row in a column selected in the dictionary during the 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 the column selected in column name (13)

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

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

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

If this field contains a link in the envelope, it will be rendered as 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).
Did this answer your question?