Report Guide

Version 4.1 by Hera Guo on 2025/09/15 09:48

Overview

In ThingsBoard, Reporting is a powerful and flexible tool for collecting, structuring, and automatically distributing data in the form of reports.

Reporting in ThingsBoard is built on two key components:

  • Configured report template – defines the structure, content, and format of the report. A template can be in PDF or CSV format and may include any supported components, such as tables, charts, text blocks, images, and more.
  • Scheduler event – automatically triggers report generation at the specified time and sends it to selected recipients via available delivery channels (such as emailSlack, and other integrations).

Key features:

  • Automated scheduling – preconfigured scheduler events can send reports on a set schedule without any user action.
  • Reusable templates – a single template can be used for different recipients by applying filters and parameters.
  • Event-based delivery – send reports when specific events occur (e.g., an active alarm on a device).
  • Rich content support – include text blocks, tables, charts, images, and more.
  • Notification integration – attach a generated report to system notifications (Email, Slack).

Where it's useful:

  • Regular monitoring of your device's metrics.
  • Sharing summary data with partners or management.
  • Archiving data in an easy-to-read format.
  • Automating communication during incidents.

报告形式:

  • PDF – visually styled reports that may include charts, tables, images, and company branding.
  • CSV – data-oriented tabular reports that are easy to analyze in Excel or BI tools.

Demo:

如何开始

  • Open the “Reporting” page from the left-hand sidebar. You'll automatically be taken to the “Templates” tab.
  • Click the “+ Add report template” button in the top-right corner.
  • Choose “Create new report template”.
  • In the popup, fill out the following:
    • Name – a descriptive name for the report template.
    • Format: Choose PDF or CSV report format.
    • Type:
      • Report - a complete standalone report template.
      • Subreport - a modular component that can be embedded inside another report.
    • Click “Add” to create the report template and open the Report Builder interface, where you can design the structure, layout, and content of your report.
    • Open the “Reporting” page from the left-hand sidebar. You'll automatically be taken to the “Templates” tab.
    • Click the “+ Add report template” button in the top-right corner.
    • Choose “Create new report template”.
    • In the popup, fill out the following:
      • Name – a descriptive name for the report template.
      • Format: Choose PDF or CSV report format.
      • Type:
        • Report - a complete standalone report template.
        • Subreport - a modular component that can be embedded inside another report.
      • Click “Add” to create the report template and open the Report Builder interface, where you can design the structure, layout, and content of your report.

1757899242101-256.png


1757899267136-753.png