Using merge tags and conditional blocks
Merge tags
What are merge tags?
Merge tags are placeholders that you insert into your report content. When a report is generated, each merge tag is replaced with the actual data from the review.
For example, a merge tag for the purchase price will display the actual purchase price. A merge tag for the property address will display the actual address.
Inserting a merge tag
- Place your cursor where you want the data to appear in the item editor.
- Click the Insert field... dropdown in the toolbar.
- Browse or search for the field you want.
- Click the field to insert it.
How merge tags appear
In the editor, merge tags appear as highlighted chips showing the field name - making them easy to spot and distinguish from regular text. When previewing an item in the template editor, merge tags display sample values so you can see how the content will read in a real report.
In the final report, the chips are replaced with the actual values from the review.
Examples
Here are some examples of merge tags you might use:
- Purchase price - the purchase price
- Property address - the land/property address
- Vendor name - the name(s) of the vendor
- Purchaser name - the name(s) of the purchaser
- Date for Completion - the settlement date
- Deposit amount - the deposit amount
The full list of available fields is accessible through the merge tag picker, organised by category (e.g. Property, Exchange, Parties).
Special merge tags
In addition to review data fields, there are several special merge tags that serve a specific purpose:
- Table of Contents - generates an automatic table of contents based on the sections in your template. Only sections with "Show Section Name" turned on will appear in the table of contents. This tag is typically placed in its own item at the beginning of the template.
- Logo - inserts your account's logo image as configured in the Branding settings. This is useful for placing the logo within the report content itself, separate from the header/footer logo controlled by document settings.
- Amendment Requests - inserts a compiled list of all amendment requests that the reviewer has flagged during the review. Each request is listed automatically - you don't need to add them individually.
These special merge tags are available in the merge tag picker alongside the standard review data fields.
When a merge tag has no data
If the field linked to a merge tag is empty or has no value, the merge tag is removed from the report and the surrounding text flows together. This means you should write your template content so that it reads naturally both with and without the data present.
Conditional blocks
What are conditional blocks?
Conditional blocks let you include content that only appears when certain conditions are met. For example, you might want to show a specific paragraph only when the property is connected to the main sewer, or display different text depending on the method of exchange.
Inserting a conditional block
- Place your cursor where you want the conditional content.
- Click the Insert conditional... dropdown in the toolbar.
- Search or browse the list to find the condition you want.
The dropdown shows all available conditions. There are two types:
- Presence-based conditions check whether something exists - for example, "Has Strata Plan" or "Has Pool"
- Value-based conditions check for specific options - for example, "Method of Exchange" shows the available choices (Auction, Private Treaty, Unknown) directly in the dropdown
Simply select the condition you want and the block is inserted with all of its branches.
How conditional blocks appear in the editor
Conditional blocks appear as visually distinct coloured regions in the editor. Each block shows all branches, labelled with the condition they represent.
Branches
Every conditional block includes all possible branches for that condition. For example, a "Method of Exchange" block will always show branches for Auction, Private Treaty, and Unknown.
Write your content inside each branch that is relevant. If a particular branch doesn't need any specific content, leave it blank - when the report is generated, only the branch that matches the review data will render. Blank branches produce no output.
For example, a "Method of Exchange" conditional block:
- Auction - "The property is being sold by public auction..."
- Private Treaty - "The property is being sold by private treaty..."
- Unknown - (left blank - nothing will render if the method is unknown)
Nesting conditional blocks
You can place a conditional block inside a branch of another conditional block. This lets you create more specific content for combinations of conditions.
For example, you might insert a "Method of Exchange" conditional block, and inside the "Private Treaty" branch, add a nested "Has Strata Plan" conditional block. This lets you write content that only appears when both conditions are true - the method of exchange is private treaty and the property has a strata plan.
You can nest up to 5 levels deep, though keeping it simple is recommended for readability.
Testing conditional blocks
Use the Preview tab in the item editor to see how your conditional content behaves with different data. The preview includes toggle controls that let you change field values and immediately see which content appears or disappears.
The following screenshots show the same item previewed with different toggle settings. Notice how the rendered content changes as you switch between options:
This is especially useful for verifying that your conditional blocks produce the right output for every scenario.