Parameters and tags reference

Updated

Azumuta lets you insert live data, either a parameter you defined yourself or a value Azumuta already tracks, into work instructions, docx reports, and webhooks. The syntax for writing that reference is different in each place. This article covers your own parameters and Azumuta's core built-in tags. Module-specific docx tags, such as ticket, answer, variant, image, and recap tags, are covered in their own articles, linked from Related articles below.

Two kinds of values

  • Your own parameter: data you define and link to an article or product order, such as Color or Body Material. See Introduction to parameters
  • Built-in values: data Azumuta already has, like a product order's number, an operator's name, or a due date. You don't create these; you just reference them. The full list is below.

Where you can use them, and the exact syntax

The reference format depends on where you're writing it.

Work instruction steps: visual pages, calculations, and checks

Use ${...}, with the dollar sign, wherever you're adding a live value into a work instruction: a text box on a visual page, a step's description, or a calculation.

  • Your own parameter: ${Parameter_key}
  • A calculation: ${=Parameter_key + 3}

See Use parameters in a work instruction step, Use parameters on an image in a work instruction, and Performing calculations with parameters for the full walkthroughs, including the available math operators.

Exception: dedicated formula fields. A rule's Formula evaluates to true (advanced) condition is itself a formula field, not free text with a value embedded in it, so you type the expression directly with no ${...} wrapper at all: dateTime("12/05/2026 14:30", "dd/MM/yyyy HH:mm"), for example. See Rules: Advanced.

Docx / PDF report templates

Use plain curly braces, without the dollar sign, and a leading = for a built-in value:

  • Your own parameter: {p_Parameter_key}
  • A built-in value: {=identifier}, {=dueDate}, and so on
  • Show a parameter only if it has a value: {#p_Parameter_key}{p_Parameter_key}{/p_Parameter_key}, with {^p_Parameter_key}fallback text{/p_Parameter_key} for when it's empty

This applies to product order, work instruction, recording/audit, and issue docx reports alike. See Basic Tags on a Docx Report, Parameter Tags, and Conditional Parameter Tags.

Exception: answer and recap tag loops. Inside a {#answers}...{/answers} loop or a recap section, several built-in values drop the leading = and appear as a bare tag instead, for example {workinstructionName}. See Answer Tags (Basic) for that loop's own tag list.

Webhooks and export file/folder naming

Use ${...}, with the dollar sign, the same convention as work instructions since both go through the same engine:

  • Your own parameter: ${Parameter_key}
  • A built-in value: ${=identifier}

This applies to a trigger's webhook payload and URL, a peripheral integration's webhook, and the file name or destination folder path of an exported report. See Calling a Webhook from a Trigger.

Where Syntax
Work instruction steps (visual pages, calculations, checks) ${Parameter_key} / ${=expression}
Docx / PDF report templates {p_Parameter_key} / {=identifier}
Webhooks and export file/folder naming ${Parameter_key} / ${=expression}
A rule's advanced formula field the expression itself, no wrapper

Built-in values reference

These are supplied by Azumuta automatically. Availability depends on context: values from the Export column only resolve while generating that specific export (a work instruction PDF or a recording/audit report), not in a webhook or a live work instruction step.

Product order

Tag Value Available in
identifier The product order number Everywhere
amount The product order's target amount Everywhere
amountComplete The amount completed so far Everywhere
dueDate The product order's deadline Everywhere
executionDate The planned start date Everywhere
finishDate The date the product order was finished Everywhere

Dates

Tag Value Available in
today The current date Everywhere

today, dueDate, executionDate, and finishDate accept an optional date format, for example {=dueDate(dd/MM/yyyy)} in a docx report.

User and device

Tag Value Available in
userId The operator's user ID Everywhere
userFullName The operator's full name Everywhere
userEmail The operator's email address Everywhere
deviceId The device's ID Everywhere
deviceName The device's name Everywhere

Work instruction and export

Tag Value Available in
instructionUuid The instruction step's ID Everywhere
instructionDescription The instruction step's description Everywhere
stepNumber The instruction step's number Everywhere
workinstructionName The work instruction's name Export
workinstructionVersion The approved version number Work instruction PDF export
issueNumber The linked issue's number Work instruction PDF export
auditNumber The audit number Recording/audit export
treePath The folder path containing the work instruction, joined by / Export

treePath accepts an optional slice, for example {=treePath(-2)} for just the last folder, the same way Array.slice would.

issueNumber and auditNumber are also sent automatically as event fields in a trigger's webhook payload, separate from inserting them yourself with ${=...}. See What Azumuta Sends.

On this page