Skip to main content

How to Use Variables in a Form

Learn how to insert variables into a form template so details like submitter, client, and submission information can appear automatically.

Written by Catalino Jr Basaka

Before You Start

Variables allow a form to automatically pull saved information into a field or text area.

You can use variables to show details such as:

  • Submitter name

  • Submitter email

  • Client name

  • Client date of birth

  • Client phone

  • Submission details

You need access to Registers and permission to create or edit form templates.

Available Variables

Use the table below as a reference when adding variables to a form.

Submitter Variables

Field

Variable

First name

{{ submitter.firstName }}

Last name

{{ submitter.lastName }}

Full name

{{ submitter.name }}

Email

{{ submitter.email }}

Phone

{{ submitter.phone }}

Position

{{ submitter.position }}

Branch

{{ submitter.branch }}

Address

{{ submitter.address }}

Client Variables

Field

Variable

First name

{{ client.firstName }}

Last name

{{ client.lastName }}

Full name

{{ client.name }}

Date of birth

{{ client.dob }}

Pronouns

{{ client.pronouns }}

Phone

{{ client.phone }}

Email

{{ client.email }}

Address

{{ client.address }}

Cultural identity

{{ client.culturalIdentity }}

Site

{{ client.site }}

Case manager

{{ client.caseManager }}

Submission Variables

Field

Variable

Submission ID

{{ submission.id }}

Created on

{{ submission.createdAt }}

Organisation Variables

Field

Variable

Organization name

{{ org.name }}

ABN

{{ org.abn }}

Open the Form Template Editor

Go to Registers from the left menu.

Open an existing register template or select Create Form to create a new one.

This will open the Template Editor.

Add or Select a Field

Add the field where you want to use a variable.

For example, you can drag a Date field into the form section.

Once the field is added, select it so the field settings open on the right side.

Step 3: Open the Insert Variable Menu

In the field settings panel, look for the Insert variable option.

The variable menu shows available data grouped by category, such as:

  • Submitter

  • Client

  • Submission

Click the variable you want to insert.

Insert a Variable into a Field Description

Select the field where you want the variable to appear.

Click inside the field’s Description box.

Open the Insert variable menu and choose the variable you need.

For example, selecting Client date of birth inserts a variable like:

{{ client.dob }}

The variable will appear in the field description area.

Step 5: Add a Static Text Field

You can also use variables inside a Static Text field.

Drag the Static Text field into the form section.

Select the Static Text field to open its settings panel.

Step 6: Insert Variables into Static Text

Click inside the Static Text content box.

Use the Insert variable option to choose the information you want to display.

For example, you can insert:

{{ submitter.name }}

or

{{ client.name }}

These variables will display the relevant person’s details when the form is used.

{{ submitter.name }} 

and

{{ client.name }}.

Step 7: Review the Form

After adding variables, review the form layout.

Check that each variable has been placed in the correct field or text area.

Use Preview if you want to check how the form will appear before saving.

Step 8: Save the Form

Once the variables are added and reviewed, select Save Draft.

The form template will keep the variables in place and use them when the form is completed.

Important Notes

  • Variables must be inserted exactly as shown by the system.

  • Do not manually change the variable formatting unless you are sure of the correct value.

  • Variables usually use double curly brackets, for example:

    {{ client.name }}
  • A variable only works if the related data exists in the system.

  • For example, a client date of birth variable will only show a value if the client record has a date of birth saved.

  • Static Text supports basic formatting and markdown, so variables can be used alongside normal instructions or helper text.

Troubleshooting

  • If the variable does not appear correctly, check that it was selected from the Insert variable menu.

  • If the variable shows as blank, the related record may not have that information saved.

  • If the variable is in the wrong place, click the field again and move or remove it from the settings panel.

  • If the variable menu is not showing, make sure your cursor is inside a field that supports variables, such as a description or Static Text content box.

  • If the form does not save, check that all required field settings are completed before selecting Save Draft.

Did this answer your question?