Embedding Dashboards in Reports
The Dashboard component captures a snapshot of a ThingsBoard dashboard and embeds it as an image in the report. The snapshot uses the same data and widget configuration as the live dashboard, rendered at a fixed point in time.
This is useful when you want to:
- include dashboards in scheduled reports,
- archive dashboard data for historical reference,
- share a dashboard snapshot without exposing live data access.
Prerequisites: A report template and at least one dashboard must exist.
Add a dashboard component
Section titled “Add a dashboard component”- Open the report template in the Report Builder.
- Drag the Dashboard component from the Components library into the content area.
- Configure the Datasource, Target dashboard and Layout (see below).
- Click Save.
Configuration
Section titled “Configuration”Datasource
Section titled “Datasource”Widgets on the embedded dashboard may:
- have their own data source defined in the widget settings,
- have no data source (e.g., a static info card),
- or be configured to display data from the entity defined in the Dashboard component.
If widgets are set up to use the entity from the component:
- Select a Datasource — a specific device or an entity alias.
- Optionally, configure Filters to narrow which entities are included.
Target dashboard
Section titled “Target dashboard”- Select the dashboard to embed in the report.
- Optionally, specify a Dashboard state to open the snapshot in a particular view.
- Optionally, configure a custom Time window and Time zone for the snapshot.
Layout
Section titled “Layout”Adjust the appearance of the component:
| Setting | Description |
|---|---|
| Width | Horizontal size of the component in the report. |
| Alignment | Horizontal positioning — left, center, or right. |
| Padding | Internal spacing between the dashboard image and the component’s border. |
| Margin | External spacing between the component and the surrounding report content. |
| Background style | Background color or fill rendered behind the dashboard image. |
| Border style | Border width, style, and color drawn around the component. |
Example
Section titled “Example”Embed a Dashboard Snapshot in a Report — step-by-step walkthrough: configure a Dashboard component to snapshot the Environmental Monitor dashboard and include it in a scheduled report.