Subreports
A subreport is a reusable report template designed to be embedded inside a master report. The master report provides context (a list of entities); the subreport renders once per entity, producing a dedicated section for each.
Subreports are not scheduled or generated independently — they only exist as components within a master report.
Prerequisites: Familiarity with the Report Builder.
When to use subreports
Section titled “When to use subreports”| Scenario | Why subreports help |
|---|---|
| Per-entity sections | Generate one alarm table, chart, or summary block per device or asset in a single run |
| Reusable layout blocks | Define a standard section once and embed it in multiple master reports |
| Divided responsibilities | Teams can own individual subreport templates independently of the master layout |
Entity aliases for subreports
Section titled “Entity aliases for subreports”In addition to standard entity aliases, subreport templates support two special aliases that resolve to the entity passed from the master report. See Subreport aliases for details.
| Alias | Resolves to |
|---|---|
| Entity from master report | The entity passed to this subreport by the master report. One subreport instance is generated per entity if the master’s datasource returns multiple. |
| Owner of entity from master report | The customer or tenant that owns the entity passed by the master report |
Step 1. Create the subreport template
Section titled “Step 1. Create the subreport template”- Navigate to Reporting ⇾ Templates.
- Click + Add report template ⇾ Create new report template.
- Enter a report template name (e.g. Daily Device Alarms (Subreport)).
- Select:
• Format: PDF or CSV.
• Type: Subreport. - Click Add to open the Report Builder.
- Build the subreport content using the Entity from master report alias:
- Add a Rich text component — use
${Name}(mapped to thenameentity field) to display the entity name as a section header. - Add an Alarm table component — datasource: Entity from master report, time window: Current day, title:
${entityName} Alarms. - Add a Divider component to separate sections visually.
- Add a Rich text component — use
- Save the subreport template.
The template opens in the Report Builder — a drag-and-drop editor where you compose the layout.
Step 2. Create the master report
Section titled “Step 2. Create the master report”- Click + Add report template — Format: PDF, Type: Report.
- Name the master report (e.g. Daily Device Alarms Report).
- Add a Heading component with the report title.
- Drag a Subreport component into the content area.
- Data tab:
- Datasource: an alias returning all target devices (e.g. All devices).
- Subreport template: select Daily Device Alarms (Subreport).
- Save the master report.
Example
Section titled “Example”Daily Alarm Report per Device Using Subreports — step-by-step walkthrough: create a subreport template and a master report that generates one alarm section per device in a single PDF.