> For the complete documentation index, see [llms.txt](https://help.tillit.cloud/tillit/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.tillit.cloud/tillit/knowledge-base/setting-up-tillit/configuration/creating-and-using-report-templates.md). # Report Templates ## Overview {% hint style="info" %} * A Report Template generates PDF (and HTML) reports from data in TilliT — from an order, a shift, or one or more boards. Common uses include an end-of-order report for auditing, a certificate of analysis, an end-of-shift compliance report, or a scheduled summary pulled from board records. * A Report Template can also incorporate images from submitted activities, and lets you format the report layout to your liking. * Building a Report Template is a two-step process: 1. Filter the data the report should draw on — which activities, order attributes, or boards to read from. 2. Build an HTML template that formats the final PDF — add your company logo, fonts, and colours. {% endhint %} This guide covers creating and managing Report Templates, and how each of the three data types — ORDER, SHIFT, and BOARD — is used. ## Navigation Navigate to ***Settings > Configuration > Report Template*** to open the configuration page.

## Creating a Report Template Click **Create** to open the creation modal.

Name	Desc
Name	The name of the report.
Description	A description of the report.
Data type	ORDER, SHIFT, or BOARD — determines what the report draws data from. See Order Reports, Shift Reports, and Board Reports below.
Asset Classes	Which asset classes are included in the report. Not shown for BOARD type templates.
HTML Template	Create a new HTML template or use an existing one. Options are Blank, Order Starter Template, or Shift Starter Template. Choose Blank for a completely empty template. If you don't have HTML or handlebars scripting experience, use one of the Starter Templates — it matches the Data type you selected.
Attributes	Which attributes are included in the report. Not shown for BOARD type templates.
Activities	Which activities are included in the report. Not shown for BOARD type templates.
Operations	Which order template operations are included in the report, as a comma-separated list. Not shown for BOARD type templates.
Include Images	Whether to include activity images in the report. Not shown for BOARD type templates.
Sort By	Sorts the Activities in the report by Completed At date or Issued At date. Not shown for BOARD type templates — board sorting is configured per board, see Configuring board data.
Sort Direction	Sort direction for the chosen Sort By field.

For this example, we'll create an **Order Report** of type **ORDER**. After filling out the details, click **Save and Open**.

## Selecting Report Content ### Order and Shift reports Besides the fields in the creation modal, you can filter which activities — and which of their activity items — are included. #### Include All Activities When enabled, newly added activities are automatically included. Choosing activities individually instead allows for activity item filtering. You'll see a list of all available activities for visibility.

#### Choosing individual activities and items Turn off Include All Activities to choose which activities are included in the report. Each activity has an expansion panel giving finer control over which items are included. Settings save on change.

### Board reports BOARD type templates configure their content per board rather than by activity — see [Configuring board data](#configuring-board-data) under Board Reports below. ## Building the HTML Template Use the HTML editor to design and lay out your report. TilliT uses the [Mustache](https://mustache.github.io/mustache.5.html) templating engine, which inserts data dynamically using curly braces, e.g. `{{order.order_number}}`. {% hint style="warning" %} If an HTML Template is used by more than one Report Template, editing it displays a warning listing the other Report Templates that share it. Review the list before saving, to avoid unintended changes to other reports. {% endhint %}

{% hint style="warning" %} **Referencing activity items' values** To reference an activity item's value, use: ```handlebars {{#if this.stringValue}} {{this.stringValue}} {{else if this.numericValue}} {{this.numericValue}} {{else if this.booleanValue}} {{this.booleanValue}} {{else}} {{this.value}} {{/if}} ``` Referencing `this.value` alone displays the item's raw value, which might not be nicely formatted. {% endhint %} ## Previewing Your Template Use the Preview Panel to see what your template will render. It has three views: * **Preview HTML** shows what the HTML in the editor renders as, in a single scrolling page.

* **Preview PDF** renders a PDF formatted with your HTML, which can be saved and viewed like any other PDF.

* **Order Data** shows the data available — from the chosen preview order plus the assets, attributes, and activities you selected earlier — so you can work out how to reference it in your data insertion.

For SHIFT type templates, the preview panel shows an **Asset** and **Shift Instance** selector instead of an order, and the data view is labelled **Report Data** instead of **Order Data**. Board reports use their own preview flow — see [Previewing a board report](#previewing-a-board-report) below.

Preview for a SHIFT type report template

## Order Reports Order Reports produce a PDF using data from a single order. Once your template is created, go to **Orders**, choose an order, and click **Details**. Next to the order name is a printer icon button.

Clicking it opens a dialog letting you download the report.

## Shift Reports Report Templates with **Data type** set to **SHIFT** are scoped to a shift instance rather than an order. Use this to generate a report for a complete shift, even when no order was running — for example, an end-of-shift compliance report. When creating a Report Template, choose the **Shift Starter Template** option to start from a template already set up for shift data.

Choosing between Order Starter Template and Shift Starter Template

{% hint style="info" %} To have a shift report generated automatically when a shift ends, select this Report Template on a subscription with Event Type **Shift Ended**. See [User Subscriptions](https://gitlab.com/tillit-do/documentation/tillit-docs/-/tree/main/lang/en-au/help/users/manage/user-subscriptions.md). {% endhint %} ## Board Reports Report Templates with **Data type** set to **BOARD** pull data directly from one or more boards instead of an order or shift. Use this for reports built from reference data, or that summarise records logged against a board over a period of time. ### Configuring board data Add up to four boards to the template. Each board's data is fetched and reported independently — there's no automatic matching between boards.

For each board, configure:

| Field | Description | | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Alias** | The name used to reference this board's data when writing the report layout. | | **Related records to include** | Pulls in linked record details (e.g. a name) instead of just an internal ID. Including more of these increases the report's size. | | **Date field** (optional) | Which of the board's date fields the report's date range applies to. Leave unset to include the whole board regardless of dates — useful for reference/lookup boards. | | **Asset scope** (optional) | Restricts this board's rows to the report's selected asset, via a relationship field you choose. | | **Sort field and direction** | Determines which rows are kept if the board has more matching rows than the maximum. | | **Maximum rows** | A safety limit. If more rows match, the report uses the first batch (by the configured sort) and is marked as incomplete. | While configuring, review the live record count and summary line shown under each board, to confirm the setup matches something before saving. The count greys out temporarily right after an edit, until the change is saved. {% hint style="info" %} **Zero records?** This can mean the board itself is empty, nothing falls inside the selected date range, or nothing matches the selected asset. {% endhint %} {% hint style="warning" %} **Report size warnings** appear as you approach the overall report size limit, and a stronger warning appears if it's exceeded. If you see one, try in this order: turn off unneeded related records, narrow the date range, lower a board's row limit, then remove a board as a last resort. {% endhint %} {% hint style="warning" %} If a board's structure changes after the template was set up (a field is renamed or removed), any setting pointing at that field shows a "this field is no longer on the board" error. The template still works, but should be corrected. If the board itself is deleted, the template shows a warning and can't generate correctly until the reference is fixed. {% endhint %} Once your boards are configured, write the report layout referencing the board aliases and fields, the same way as for ORDER and SHIFT type templates. ### Previewing a board report Set a preview date range (and asset, if the template scopes by asset), then use the preview panel to check your work before finishing the layout:

* **Report Data** shows the raw data available, so you can confirm field names and structure.

* **Preview HTML** or **Preview PDF** renders the visual result using the same data as a real run — what you see is what you get.

### Generating an ad-hoc report from a board Open a board and click **Generate report**:

Choose a report template — different templates may show different data:

Set a date range if the template has a date field configured — this filters the report to data within that window. If no date range is set, all rows are pulled until the row limit is hit. If the template requires it, select an asset to narrow the report to that asset's data. {% hint style="info" %} If no templates exist for a board yet, no report can be generated — an admin needs to create one first in **Settings > Configuration > Report Template**. {% endhint %} Start generation and wait for it to complete — this runs in the background, so you can navigate away and check back later:

Once ready, download the finished report. If generation fails, try again; contact support if it keeps failing. ### Viewing previously generated reports Open the report dialog for a board and switch to the history view. Each entry shows when that report was generated (not when the underlying data was captured — the data range is set separately, at generation time). Download any previous report directly from the list.