Dictionary is a table of records, e.g. list of employees (Name, Surname, Age, Address).
Creating a dictionary¶
This functionality is blocked if mailbox has no permission. Dictionary editing is available only to mailbox which is an owner of this dictionary.
Dictionary manage - allows to create new dictionaries, add columns, change columns order, edit columns, change name, description and access level of dictionaries. Dictionary delete - allow to delete dictionaries. Dictionary row manage - allow to create records and change values in records. Dictionary row delete - allow to delete records.
Navigate to https://platform_address_here/dictionary
Click on create dictionary button
New dictionary will be opened
New dictionary - default name of a dictionary. You can change it as needed (128 characters max)
Description - default description of a dictionary. You can change it as needed (256 characters max)
Allow filtered access - this attribute specifies if access to this dictionary will be filtered or full. If disabled - all records from a column will be available for choise in the envelope with dictionary field. If enabled - only values form matching rows will be returned. Values from other columns are used for row matching
Access level (mailbox by default) - specifies which mailboxes will have access to the dictionary
Mailbox - dictionary is visible to current mailbox only. In envelopes with this dictionary field records from this dictionary will be available to current mailbox only. Roles with other mailboxes will not be able to select data from this dictionary field. Account - dictionary is visible to all mailboxes in this account. In envelopes with this dictionary field records from this dictionary will be available to mailboxes in current account. Roles with mailboxes from other accounts will not be able to select data from this dictionary field. Public - dictionary is visible to all mailboxes. In envelopes with this dictionary field records from this dictionary will be available to any mailbox. Roles with any mailbox will be able to select data from this dictionary field.
Click on Add row button to add new row
You can select rows with a chechmark. If any rows are selected, Delete rows button will appear which allow you to remove rows
Click on Add column button to add new column
Enter a column name (64 characters max)
Hover over column header to see column edition options (copy column UUID, filter, rename and delete)
If column is less then 300 px in width these options will be truncated to a single dropdown menu.
Columns can be rearrenged via drag & drop by this icon (same order will be used in dictionary field creation menu)
Editing a record¶
Click on a table cell and enter a value (256 characters max)
Click checkmark to apply new value (also you can click outside of a cell)
Click cancel to revert changes
Multiple filters connected by ‘OR’. Filter types: Contains, Does not contain, Is equal, Is not equal, Is empty, Is not empty.
Click on a filter icon (appears on column header hover)
Select filter and enter value
Click on Add button
Column name with active filter will have the same color as filter
Filters are sorted by column order
Deleting a dictionary¶
Click on a delete icon on according dictionary on a dictionary list page
Confirm your action
Dictionary field behavior after dictionary or dictionary column deletion¶
When dictionary or dictionary column is deleted, such template will become invalid (new dictionary or dictionary column should be selected in dictionary field properties).
When dictionary or dictionary column is deleted, dictionary field will be disabled in processing envelopes and envelope with such field will be expired automatically after expiration date. Exception is case where custom value are allowed. In such case dictionary field will work as text field and custom text value can be entered in it.