# Dictionary Field

Use **Dictionary field** to pick a value from a dictionary.

Example: select an employee from a list (first name, last name, age, address).

You can place this field in:

* structured documents
* PDF documents

{% hint style="info" %}
To learn more, see [How to Create and Manage Dictionaries](/user/dictionaries/how-to-create-and-manage-dictionaries.md)
{% endhint %}

### Add a dictionary field

<figure><img src="/files/GMxgTy8i9tkbD4xTcksF" alt=""><figcaption></figcaption></figure>

1. Open the template in edit mode.
2. Find **Dictionary field** in the **Fields panel** and add it to the template.\
   — Input dictionary name and choose column with required information
3. Click **Save**.

### Field settings

Click on the placed field to reopen settings menu.

{% columns %}
{% column width="58.333333333333336%" %}

* **Name** — field name shown in the document
* **Role name** — role that fills the field
* **Placeholder** — hint text shown before input (if empty, **Name** is used)
* **Tooltip** — additional hint shown on hover
* **Optional** — whether filling the field is required
* **Allow custom values** — allows free text input in addition to dictionary values
* **Search** — makes the field available for search/filtering in the mailbox UI (if enabled in your setup)
* **Dictionary** — select a dictionary by typing its name
* **Column name** — select the dictionary column used as the field value
  {% endcolumn %}

{% column width="41.666666666666664%" %}

<figure><img src="/files/p03gIzPxx30BceSoITkJ" alt="" width="312"><figcaption></figcaption></figure>
{% endcolumn %}
{% endcolumns %}

#### Filtering

Filtering is available only if filtered access is enabled for the selected dictionary.

To configure filtering, click **Filtering** <img src="/files/nIRrZf14njtdWhzJje6G" alt="" data-size="line"> icon inside the **Dictionary** input.

{% columns %}
{% column width="58.333333333333336%" %}
**Filtering settings:**

* **Column name** — dictionary column used for matching rows
* **Filter by role mailbox** — switches the filter source
* **Field name** — field used as the filter source (changes to a role selector if **Filter by role mailbox** is enabled)

{% hint style="info" %}
If **Filter by role mailbox** is enabled, the system uses the role mailbox UUID to find a matching row.

In this case, select a dictionary **Column name** that contains mailbox UUIDs.
{% endhint %}
{% endcolumn %}

{% column width="41.666666666666664%" %}

<figure><img src="https://docs.docstudio.com/en/latest/_images/filteringModal.png" alt="Filtering modal" width="375"><figcaption></figcaption></figure>
{% endcolumn %}
{% endcolumns %}

### Links inside a dictionary field

If the selected value contains a URL, it is rendered as a normal browser link (blue + underline).

* You can open the link from the right-click context menu (any role).
* You can open the link with a direct click only if the field is inactive.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://support.docstudio.com/user/template-builder/template-dynamic-fields/dictionary-field.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.