Reporting

ThingsBoard PE Feature Only ThingsBoard Professional Edition supports Reporting feature. See ThingsBoard PE Installation Options to install ThingsBoard PE.

• Overview
• Video tutorial
• Reports Server
• Generate Report from Dashboard
• Generate Report by schedule
• Generate Report Rule Chain
• Reports Widget
• Next steps

Overview

ThingsBoard allows you to generate reports using existing dashboards.

Reports can be generated either from the currently opened dashboard or scheduled using the Scheduler capabilities.

Video tutorial

See video tutorial below for step-by-step instruction how to use this feature.

Reports Server

The Reports Server is a standalone service used to generate reports by rendering dashboards in a headless browser.

On each generate report request, ThingsBoard node sends a request to the Reports Server using the configured endpoint URL.

The Reports Server opens a web page with the target dashboard URL in the headless browser and waits until the page renders, then it captures the dashboard web page into the specified format (PDF | PNG | JPEG) and sends the captured data as a response to ThingsBoard.

The system administrator can configure the Reports Server endpoint URL using thingsboard.yml.

The following is a sample configuration:

# Reports parameters
reports:
  server:
    endpointUrl: "${REPORTS_SERVER_ENDPOINT_URL:http://localhost:8383}"

Generate Report from Dashboard

The Tenant Administrator or Customer User can generate a report from the currently opened dashboard.

• Click the Export Dashboard button located at the right side of the dashboard toolbar

• In the expanded drop-down menu, select the desired dashboard export option

• The report generation will start.

• And finally, the report file will be automatically downloaded in the format selected.

Generate Report by schedule

Report generation can be invoked by a schedule using the Generate Report Scheduler Event.

Generate Report Rule Chain

Scheduled reports generation is supported by the default Root Rule Chain of ThingsBoard PE. By default, a message of type Generate Report is routed to the Generate Report Rule Chain.

The Generate Report Rule Chain has a Generate Report Rule Node that performs the report generation according to the report configuration retrieved from the message body.

If the message body has a field sendEmail and its value is set to true, the message with a report file reference in the attachments field of the metadata will be routed to the email related Rule Nodes. The Email Rule Nodes will prepare the email message with a report file in the attachments and send it to the configured recipients.

Reports Widget

ThingsBoard provides access to the generated report files via the Reports Widget that is a part of the Files Widgets Bundle.

The widget has the ability to filter the reports using the time range component.

Also, the widget has the ability to search the reports by name.

Each report can be downloaded by clicking on the Download file button.

Next steps

• 入门指南 - 这些指南提供了ThingsBoard主要功能的快速概述。

• 安装指南 - 了解如何在各种操作系统上安装ThingsBoard。

• 设备连接 - 了解如何根据您的连接方式或解决方案连接设备。

• 数据看板 - 这些指南包含有关如何配置复杂的ThingsBoard仪表板的说明。

• 数据处理 - 了解如何使用ThingsBoard规则引擎。

• 数据分析 - 了解如何使用规则引擎执行基本的分析任务。

• 硬件样品 - 了解如何将各种硬件平台连接到ThingsBoard。

• 开发指南 - 了解ThingsBoard中的贡献和开发。