Reports

icon-report Generate PDF reports using your data for download on-demand or schedule for email delivery.

Note

The reporting feature is currently a pre-release version that is subject to change without notice and is only available to limited accounts. This documentation will also be updated prior to final release to expand on reporting features with examples.


Quick start

This documentation is intended as a quick introduction to the reporting feature but will be replaced with comprehensive documentation prior to final release.

Creating a report

  1. Using the Create menu in the workspaces tree, select Report. The report node will be created and the report editor will open with a blank report template.
  2. Click (or drag) a report element from the editor toolbar to insert it.
  3. Drag nodes from the Workspaces tree to quickly insert them into the report template. eg. Drag an image attachment node or chart node to insert as an image in the report.
  4. Remove an element by clicking the x next to the item in the CONTENT menu (on the right-hand side of the screen) or selecting the element(s) in the editor and pressing the delete key.
  5. Insert page break elements to split content over multiple pages.
  6. To increase the height of the template page area (for editing only), select the DOCUMENT PROPERTIES menu and enter a value in the Content height field. eg. 1000.
  7. Click on the name of a linked node (automatically added after drag-drop from Workspaces tree) in the TAGS menu to display all of its available attributes.
  8. Use expressions directly inside report element content to control the output of the content and its formatting. A common scenario is to apply the time expression filter to format the display of timestamps. eg. {{report_time | time}} or {{report_time | time: "DD MMMM YYYY"}}
  9. Select Preview from the editor toolbar to generate a preview of the PDF report using the latest data.

Note

The report editor will automatically save changes made to the template.

Report editor

../../_images/report_editor.jpg


Report preview

../../_images/report_preview.jpg


Downloading or editing a report

  1. Locate the Report node in the Workspaces tree or from the Reports List content view.
  2. To edit an existing report, select Edit from the context menu.
  3. Alternatively select Download to generate a PDF report using the latest data.
  4. Enable Public access to get a public URL to a report that will be generated on demand.
  5. Use the HTTP API to generate a PDF report on demand.

Scheduling a report

  1. Open the report properties from the Workspaces tree context menu.
  2. From the Schedule section, click the checkbox to enable a schedule and select either Daily, Weekly or Monthly.
  3. The report will be generated at the scheduled time (check debug level Events).
  4. Users must be subscribed to the report node to receive the report at the scheduled time (the same way users and groups are subscribed to receive sms/email notifications). See notification subscriptions for details.
  5. Use the Events view with debug detail level to audit when scheduled reports are generated and sent to subscribed users.

Report properties - schedule

../../_images/report_schedule.jpg


Note

Dashboards currently can not be displayed as images on the report. Historic table data display will be available at a later time.

PDF HTML Epub Powered by Read The Docs