Dynamic Document Generation Reference

🤔 Fields not showing in your document?

When adding merge fields to your Word document, it's important to add an equals sign in front of the available references that are listed below.

As an example, referencing the project name in a Word document as "project_name" will not work, you must refer to it as "=project_name".

Available To All Dynamic Documents

Project Information

project_name - Name of the project
project_number - Project reference number
total_budget - Total project budget with currency formatting
start_date - Project start date (DD Month YYYY format)
end_date - Project end date (DD Month YYYY format)

Company Details

company_name - Company name
company_trading_name - Company trading name
company_legal_name - Company legal name
company_* - Any custom company fields (replace * with field name in snake_case)

Project Custom Fields

Any custom project fields will be available using their label in snake_case

Project Roles

Each project role is available using its name in snake_case
For single-user roles: access first_name and last_name
For multi-user roles: iterate through the array of users with first_name and last_name

System Information

date - Current date (DD Month YYYY format)
user_name - Current user's full name
user_email - Current user's email address

For Progress Claims

Progress Claim Details

name - Progress claim name
description - Progress claim description
start_date - Claim period start date
end_date - Claim period end date
issued_date - Date the claim was issued
approved_date - Date the claim was approved
status - Current claim status
approved_by - Name of the person who approved the claim

Financial Totals

approved_total - Total approved amount including tax
approved_total_excluding_tax - Total approved amount excluding tax
requested_total - Total requested amount including tax
requested_total_excluding_tax - Total requested amount excluding tax
previously_claimed_total - Total amount previously claimed
approved_budget - Approved budget amount

Claim Items

Use these fields within a claim_items loop:

description - Item description
project_procedure - Associated procedure name
approved_amount - Approved amount with tax
approved_amount_excluding_tax - Approved amount without tax
requested_amount - Requested amount with tax
requested_amount_excluding_tax - Requested amount without tax
claim_percentage - Percentage claimed
total_budget_excluding_tax- Budget for this item
costs_in_period - Costs incurred during the claim period

😵‍💫 Looping through lists in your Word document

A progress claim in Drum potentially has many claim items associated with it.

This means you have to "loop" through each claim item to display it within your Word document (e.g. in a table or list).

In the case of claim items, your document will look something like:

<< claim_items:each(item) >>

<< =item.name >> - << =item.approved_amount_excluding_tax >>

<< claim_items:endEach >>

Each of the dynamic fields above are a "Merge Field" in Word, so the above cannot be copy and pasted directly to a Word document, you have to manually insert merge fields as required.

Remember to reference the video at the top of this article for additional detail!

For Invoices

Invoice-Specific Fields

invoice_number - Unique invoice identifier
invoice_date - Date invoice was issued (DD Month YYYY format)
due_date - Invoice payment due date (DD Month YYYY format)
description - Invoice description
reference - Invoice reference number
total - Total invoice amount including tax
total_excluding_tax - Total invoice amount excluding tax
amount_paid - Amount already paid
status - Current invoice status
currency_code - Invoice currency
sent_to - Invoice recipient

Line Items

Use these fields within a line_items loop:

name - Item name
description - Item description
quantity example_drum_claim_template.docx- Item quantity
price - Unit price with currency formatting
total - Line item total
total_excluding_tax - Line item total excluding tax
tax_amount - Tax amount
tax_rate - Applied tax rate percentage
discount - Applied discount with currency formatting
position - Line item position/order

All monetary values are automatically formatted with currency symbols and decimal places.

Reference Documents

example_drum_claim_template.docx

example_drum_project_template.docx

example_drum_invoice_template.docx

Adding Costs to Projects

Quote Templates and Quote Document Templates in Drum

Drum Onboarding #1 - Welcome to Drum 👋