General

The Report Module in DataTalk enables users to generate automated, customizable reports based on project data. It provides a powerful and flexible interface for designing templates, defining triggers, and distributing reports via notifications or file storage. The system is suitable for use cases such as shift reports, production summaries, or maintenance logs.

Key Features

  • Report Name and Unique ID
    • When creating a new report, users must specify a name and a unique identifier (ID).
    • This ID can be used to trigger report generation via API or custom scripts.
  • Template and Editor Interface
    • After creation, a dual-pane editor opens:
      • Left pane: A pre-filled sample template (.docx) demonstrating basic functionality (fully customizable).
      • Right pane: An online drag-and-drop editor used to build the report layout.
    • Users can import external templates in .docx or .xlsx formats.
    • The top menu allows you to define the input/output file formats for the report.
  • Storage and Folder Structure
    • Define a destination folder for the generated report.
    • Optionally enable automatic folder structuring based on time (e.g., daily/monthly/yearly structure).
    • File names can include dynamic variables, such as inserting the current date using {yyyy.MM.dd hh:mm:ss} via the “Add date to name” option.
  • Notification Delivery
    • Reports can be sent as file attachments via configured notification services (e.g., email, Discord).
    • Note: Not all services support attachments or may have file size limits. Always verify with the provider.
    • If enabled, a file will be sent each time a report is generated.

Report Generation Methods

Users can choose how and when reports should be generated:

  • Timer
    • Generates a report at regular time intervals, e.g., every 30 minutes after the last save.
  • Scheduler
    • Triggers report generation at specific times, such as every full hour (e.g., 11:00, 12:00), or on specific days.
  • Tag Trigger
    • Generates a report when a specific tag reaches a defined value.
    • Example: When a production line finishes, a PLC sets a tag to “0”, which triggers a report for that production period.
  • Tag Value Change
    • Generates a report whenever a specified tag’s value changes, regardless of what value it changes to.
  • On Start
    • A report is generated when the DataTalk runtime starts.
  • None
    • The report is not generated automatically, but can still be triggered via API or script.

Chart Templates

A crucial part of report configuration is creating Chart Templates.
These are pre-built chart components that can be inserted into the report to visualize tag data, trends, or production metrics.

More on Chart Templates can be found [in the dedicated section].

Editor Modes: Drag & Drop vs. Script

The report editor supports two modes:

  • Drag and Drop Editor (Default)
    • Allows users to build reports visually by dragging elements into the layout.
  • Script Mode (Advanced)
    • Enables power users to write custom logic and structure the report manually using code.

Important: Once a report is switched from Drag & Drop to Script Mode, you cannot revert back to the visual editor. This change is permanent for that report.

With this rich set of features, the DataTalk Report Module is ideal for automating insights, streamlining communication, and delivering operational visibility to the right users at the right time.


Updated on July 7, 2025