MS Word Reports: Field ID Syntax Guide
Field ID Definition
A field ID has the following structure:
{FieldID.Extension}
- Extension is OPTIONAL
- Dot (.) is reserved exclusively for extensions
- Extensions are lowercase
Examples: Age_num.v Age_num.vc Age_num.f Age_num_1.v
Field ID Constraints
Field ID are autogenerated but can be overwritten manually.
- Maximum length: 10 characters
- Letters only (A–Z, a–z)
- No spaces or separators
Field ID Type Abbreviations
The following suffixes are used when Field IDs are autogenerated:
Suffix | Field Type |
|---|---|
_txt | Text field |
_num | Number field |
_rad | Single choice / Single-select dropdown |
_chk | Multi-choice / Multi-select dropdown |
_cal | Calculated field |
_ins | Static content (instructions) |
_dat | Date & TIme field) |
Field ID Extensions
Syntax: {FieldID.Extension}
Code | Meaning | Notes |
|---|---|---|
v | Value | Main field value (text/number/selection/date-time, depending on control) |
c | Color | Uses the color set in the inspection (commonly seen as vc, vnlc, vblc, etc.) |
a | Flag | Alert flag indicator (prints the flag marker when active) |
t | Mark | Tick/mark indicator (ex: v1t for single-choice / multi-select markers) |
m | Media | Media output (photo/video/audio). Current behavior is photo-focused; video/audio listed as future. |
f | Files | Files output (media + documents) |
r | Documents (record/reference) | Likely not introduced. Use .f with a filter instead (planned). |
nt | Note | Associated note text (if presen |
Syntax by Control
Text Control
Syntax | Description |
|---|---|
{FieldID} | Alias of {FieldID.v} |
{FieldID.v} | Displays text value |
{FieldID.a} | Displays ⚑ if flagged (alert) |
{FieldID.vc} | Displays text value using the color set in the inspection |
{FieldID.nt} | Displays the associated text note (if present) |
Number Control
Syntax | Description |
|---|---|
{FieldID} | Alias of {FieldID.v} |
{FieldID.v} | Displays number value |
{FieldID.a} | Displays ⚑ if flagged (alert) |
{FieldID.vc} | Displays number value using the color set in the inspection |
{FieldID.nt} | Displays the associated text note (if present) |
Media Annotation (if enabled on the control)
Syntax | Description |
|---|---|
{FieldID.m1} | First media item (defaults: sz=md, aln=ct, note hidden) |
{FieldID.m1(sz=lg, nt, aln=lt)} | First media item with options |
{FieldID.m(col=3, sz=lg, nt, aln=lt)} | Media grid with options |
Date/Time Control
Syntax | Description |
|---|---|
{FieldID} | Alias of {FieldID.v} |
{FieldID.v} | Displays date + time (if time not enabled, same as {FieldID.vd}) |
{FieldID.a} | Displays ⚑ if flagged (alert) |
{FieldID.vt} | Displays time only |
{FieldID.vd} | Displays date only |
{FieldID.vc} | Displays value using the color set in the inspection |
{FieldID.sco} | Displays score |
{FieldID.nt} | Displays the associated text note (if present) |
Single-Choice Control
Syntax | Description |
|---|---|
{FieldID} | Alias of {FieldID.v} |
{FieldID.v} | Selected choice text (empty if no selection) |
{FieldID.vc} | Same as {FieldID.v} but uses the color set in the inspection |
{FieldID.v1} | Text of the 1st choice (1-based) |
{FieldID.v1t} | ✓ if 1st choice is selected, otherwise empty (1-based) |
{FieldID.v1t(unsc='☐', sc='☑')} | Custom selected/unselected marker (1-based). Example: {FieldID.v1t(unsc='☐', sc='☑')} |
{FieldID.v1a} | ⚑ if 1st choice is selected and flagged (1-based) |
{FieldID.nt} | Associated text note (if present) |
Dropdown (Single-Select) Control
Same as Single-Choice control.
Multi-Select Control
Syntax | Description |
|---|---|
{FieldID} | Alias of {FieldID.v} |
{FieldID.v} | Selected items, comma-separated (empty if none) |
{FieldID.vnl} | Selected items, new line per item (empty if none) |
{FieldID.vc} | Same as {FieldID.v} but uses the color set per choice |
{FieldID.vnlc} | Same as {FieldID.vnl} but uses the color set per choice |
{FieldID.v1} | Text of the 1st choice (1-based) |
{FieldID.v1t} | ✓ if 1st choice is selected (1-based) |
{FieldID.v1a} | ⚑ if 1st choice is selected and flagged (1-based) |
{FieldID.nt} | Associated text note (if present) |
{FieldID.vbl} | Bullet list using • |
{FieldID.vbl(bc='-')} | Bullet list with custom bullet char/string (bc) |
{FieldID.vblc} | Bullet list using color per choice |
{FieldID.vblc(bc='-')} | Colored bullet list with custom bullet (bc) |
{FieldID.vnum} | Numbered list |
{FieldID.vnumc} | Numbered list using color per choice |
Dropdown (Multi-Select) Control
Same as Multi-Select control.
Signature Control
Syntax | Description |
|---|---|
{FieldID} | Alias of {FieldID.m} |
{FieldID.m} | Signature image |
{FieldID.dt} | Date/time signature was captured |
{FieldID.u} | Name of the user who signed |
Media Control
Syntax | Description |
|---|---|
{FieldID} | Alias for {FieldID.m(col=3, sz=md, aln=ct)} |
{FieldID.m1} | Alias for {FieldID.m[0](sz=md, aln=ct)} |
{FieldID.m1(sz=lg, nt, aln=lt)} | First image with options |
{FieldID.m(col=3, sz=lg, nt, aln=lt)} | All media in a grid with options |
Media Options
Option | Values | Notes |
|---|---|---|
col | number | Grid columns (default 3) |
sz | lg / md / sm | Size (default md) |
nt | (flag) | Include nt to show media note; omit to hide |
aln | lt / ct / rt | Alignment (default ct) |
ord | nw / ol | Order pictures are displayed. Allowed values: “nw” (newest shown first)(Default), “ol” (oldest shown first) |
Repeatable Sections
Approach | Syntax | Example |
|---|---|---|
Loop-based (recommended) | {#SectionFieldID} … {/SectionFieldID} | {#MechanSystem_sec_1} {Location_txt_1} {/MechanSystem_sec_1} |
Index-based | {SectionFieldID[Index].PropertyFieldID} | {MechanSystem_sec_1[1].Location_txt_1} |
Check-in Control
Same as Text control.
Calculated Field Control
Same as Number control.
Contact us at [email protected] or submit a help ticket for any additional help.