Info: This article is work in progress and subject to change.
A Field reads or edits a single metadata value on the selected asset or collection. Thirteen field types are available, each with its own configuration options. This article is the complete reference for every type and every option — use it as a lookup, not a read-through.
For the conceptual material on what a Field is and how it relates to Actions and Notifications, see 02b — Component types: Fields, Actions, and Notifications. For the conditions used in disable, required, and visibility settings, see 02d — How conditions work and the appendices in section 12.
Options shared by every field type
Every field type, regardless of which one you choose, has the same baseline set of options. The reference for each type below lists only the type-specific options; assume the shared set is also available.
| Option | Purpose |
|---|---|
| Display name | The label the user sees on the field. Free text. Does not need to match the technical Assets metadata field name |
| Field name | The technical metadata field in Assets that this field reads from and writes to. Autocompletes from the available fields of the matching type. An incorrect field name causes the Workflow Assistant to error when an end user opens the panel |
| Hint | The tooltip text shown when the user hovers the field. Defaults vary by type when left blank |
| Suppress hint | When on, hides every hint on the field except the Disabled overlay message |
| Disabled | When on, the field is non-editable regardless of any other condition. Acts as a hard override |
| Disable condition | A Lucene query against the selected asset’s metadata. When the query is true, the field is non-editable |
| Disabled overlay message | The text the user sees when hovering a non-editable field. Always set this when you set a disable condition |
| Required | When on, the field must hold a value before publish. Acts as a hard override |
| Required condition | A Lucene query. When true, the field is required |
| Required message | The error text shown when a required field is empty. Always set this when you require the field |
| Applies to (visibility checklist) | The asset kinds for which the field appears. Tick the kinds that apply, plus No asset if the field should appear with nothing selected |
Note: Both Disabled and Disable condition can be set at the same time. Disabled wins — if it is on, the field is non-editable regardless of the condition. Use Disabled for permanent restrictions and Disable condition for state-dependent ones.
Text
A free-form short-text field. Use it for titles, codes, names, and other single-line values.
| Option | Purpose |
|---|---|
| Visible rows | The minimum number of visible rows in the text area. The area expands as the user types and shrinks back when not editing |
| Keep pattern | A regex of characters allowed while typing. Anything that does not match is dropped silently. Example: [A-Za-z ] to allow only letters and spaces |
| Pattern | A regex defining a valid final value. The field shows a validation error if the user’s value does not match |
| Pattern message | The error text shown when the value does not match Pattern. Always set this |
Note: Keep pattern filters as the user types. Pattern validates the result. The two are independent: a Keep pattern that is too narrow can prevent the user from ever typing a valid value, so always test both together.
Rich text
A free-form text field with bold and italic formatting, stored as Markdown. Use it for briefs, longer descriptions, and instructions.
The user sees a small editor with a Markdown source view and a formatted preview. The value is stored as Markdown text in the Assets metadata field.
Rich text takes the same options as Text above, including Keep pattern and Pattern, with one practical caveat: regex on a Markdown-bearing field is rarely what you want, because the value contains formatting characters. Use Pattern only for shape-checking the formatted text — for length limits, for example.
Decimal
A floating-point number field. Use it for prices, ratios, or any value that needs fractional precision.
| Option | Purpose |
|---|---|
| Minimum value | Optional lower bound. Leave blank if no lower bound applies |
| Maximum value | Optional upper bound |
| Step size | Optional value granularity. Set to 0.5 to allow only half-step values, for example |
| Keep pattern | Regex of characters allowed while typing. A default expression for numbers is already applied |
| Pattern | Regex of valid final values. Example: [0-9]+\\.[0-9]{2} for prices to two decimal places |
| Pattern message | The error text shown when the value does not match Pattern |
Number (Integer)
A whole-number field. Use it for counts, IDs, and any value that should be an integer.
Takes the same options as Decimal, with the implicit constraint that decimal points are not allowed.
Note: A legacy Number type may also appear in older configurations. Treat it as the same as Number (Integer) — use the new name in new panels.
Date
A day-month-year picker.
| Option | Purpose |
|---|---|
| Format | A Moment.js format string controlling how the date is displayed. Example: DD MMM YYYY displays 07 May 2026. See 12c — Moment.js date and time tokens for the full vocabulary |
Underneath the display format, the value is stored as a real Assets date — so sorting, filtering, and queries work on the date value, not on the formatted string.
Datetime
A day-month-year-hour-minute-second picker. Behaves the same as Date with the addition of time.
| Option | Purpose |
|---|---|
| Format | A Moment.js format string. Example: dddd, MMMM Do YYYY, h:mm:ss a displays Thursday, May 7th 2026, 2:15:30 pm
|
Dropdown
A single-value pick from a list you define.
| Option | Purpose |
|---|---|
| Values | The list the user can pick from. Use the + Add another value control to add entries; arrow keys to reorder; the X to remove |
| Restrict to values | When on, the user can pick only from your list. When off, the user can pick from your list or type a free-text value |
Note: When the Assets metadata schema for this field has its own values list (defined in the Custom asset info file), your Dropdown values list and the schema’s list can disagree. With Restrict to values on, the Configurator’s list wins. To keep them in sync, mirror them — or let the user pick from either by leaving Restrict to values off.
Tags
A multi-value text field. The user adds and removes tags one by one. Behaves the same as the Tags field elsewhere in Assets.
| Option | Purpose |
|---|---|
| Values | An optional list of suggested values. The user sees these as suggestions while typing |
| Restrict to values | When on, the user can only add tags that are in your list. When off, free-form tags are allowed alongside your suggestions |
Link to external page
A free-form text field whose value, if it starts with http:// or https://, is rendered as a clickable hyperlink. Clicking the link opens the URL in a new browser tab.
Takes the shared options. No type-specific options.
Tip: Use the Hint to tell users that the value should be a full URL including the scheme. Common mistake — pasting example.com and not understanding why the link does not become clickable.
Navigate to asset by ID
A free-form text field whose value is treated as an Assets asset ID. Clicking the rendered value navigates to that asset and changes the panel context to it.
| Option | Purpose |
|---|---|
| Include thumbnail | When on, the asset’s thumbnail is shown next to the field if a value is set. The thumbnail comes from the Assets system itself |
This field type is the way to build cross-references between assets — for example, a relatedBriefId field on an image that points at the brief it was created for.
Formatted
A read-only field for system-formatted values such as file size and duration. Assets stores these as raw numeric values; the Formatted field type displays them in a readable form (12.4 MB, 1m 35s).
Formatted fields are typically paired with Disabled: on, because the underlying value is system-managed and not user-editable.
The most common Formatted fields you will use are fileSize and duration. Pick them from the Field-name autocomplete; the Formatted type only appears for fields the autocomplete recognises as formatted.
Milli-to-time
A specialised field that takes a millisecond timestamp from a metadata field and displays it as a human-readable time. Useful for video timecodes and system-generated durations.
Takes the shared options. No type-specific options.
Note: Milli-to-time is a display transformation. The underlying value remains the millisecond integer; only the rendering changes. Sorting and Lucene queries continue to work on the integer value.
External data source
A field that draws its values from an external data source defined separately in the Configurator. Two display modes are available — a tree view for hierarchical sources, and a searchable dropdown for flat or large sources.
| Option | Purpose |
|---|---|
| Data source | The external data source to pull from. Defined in the External Data Sources area of the Configurator. See 07 — External data sources for setup |
| Display method |
Tree for hierarchical data, Dropdown for searchable flat lists |
| Display keys | The fields from the source data used as labels for the user |
| Default mapping field | The source field whose value is written to the Assets metadata when the user picks an entry |
| Multi-select | When on, the user can pick more than one entry. The combined values are written to the metadata field |
| Read only | When on, the field is non-editable but renders the current value |
| Start minimised | When on, the field renders collapsed when the user opens the panel, expanding on click |
External-data-source fields have the most options of any field type because they connect to outside systems. Plan the source carefully — the page on External Data Sources covers the lifecycle.
A note on Lucene-driven options
Several of the options above accept a Lucene query — Disable condition and Required condition in particular. The query runs against the selected asset’s metadata and decides the option’s outcome. See 02d — How conditions work for the primer and 12a — Lucene query quick reference for the full vocabulary.
A common pattern, repeated for clarity:
| Setting | Value | Effect |
|---|---|---|
| Disable condition on a Title field | status:"Final" |
The Title cannot be edited once the asset is Final |
| Required condition on a Credit field | status:"Awaiting publish" |
The Credit field must hold a value before the asset moves into Awaiting publish |
| Display condition on a Notification | NOT credit:* |
The Notification appears whenever the Credit field is empty |
Cross-references
Each field type’s behaviour is anchored in shared concepts elsewhere in the manual:
- 02b — Component types — what a Field is, what an Action is, what a Notification is
- 02c — Asset kinds and visibility — the Applies to checklist
- 02d — How conditions work — Lucene and regex primer
- 05b — Actions and buttons reference — the verbs that pair with these fields
- 05c — Notifications reference — for surfacing field state to users
- 06b — Disabling components and writing disable conditions
- 06c — Requiring values and validating input
- 07 — External data sources — full coverage of the External-data-source field type
- 12a — Lucene query quick reference
- 12b — Regex quick reference for field validation
- 12c — Moment.js date and time tokens
Revisions
- 8 May 2026: First publication of the manual
Comments
0 comments