Reports Module Overview

The Reports module generates PDF and text reports, creates interactive forms, and manages data exchange with external systems through JSON, XML, HTML, and web service interfaces.

Reports Module links: How-to Guide, Reference 



Key Concepts

  • *Forms*: Rich text documents with real-time tag values, tables, and charts for PDF/CSV output
  • *WebData*: Data exchange definitions for JSON, XML, HTML communication with external systems

What It Does

  • Creates PDF and text reports with charts, tables, and real-time data
  • Exchanges data with external systems via REST APIs and web services
  • Generates interactive forms for data collection and presentation
  • Schedules automatic report generation and email distribution
  • Integrates with ERP, BI tools, and custom applications
  • Supports SOA and microservices architectures

Configuration Workflow

Reports Module Configuration Workflow

Step

Action

Description

Create Report Forms

Design report layout

Add text, tables, charts, and tag placeholders

Define WebData

Configure data exchange

Set up JSON/XML templates for external systems

Configure Scheduling

Set automation rules

Define generation triggers and email recipients

Manage Scripts

Create activation logic

Use scripts or displays to trigger report



Runtime Behavior

Report Generation

Forms execute on-demand or by schedule, collecting current tag values and query results. Reports generate in isolated processes to avoid impacting real-time operations.

Data Exchange

WebData definitions handle bidirectional communication with external systems through REST APIs. The module acts as a service provider for other modules requiring formatted data.The data retrieved or saved can be utilized in various ways throughout your solution. For example:

  • *Displays*: DataGrids show JSON/CSV data, PDF viewers display reports
  • *Scripts*: Trigger report generation and process WebData responses
  • *Devices*: Exchange recipes and configuration data with controllers

Features Highlights

  • *PDF and Text Reports* - Generate reports with charts, tables, and graphical elements for effective data communication
  • *Interactive Forms* - Design forms to display real-time/historical data and capture user input
  • *WebData Exchange* - Share data with external applications via HTTP and RESTful APIs
  • *Multi-Format Support* - Import/export data in JSON, XML, HTML, and plain text formats
  • *Web Services Integration* - Connect with ERP, BI tools, and custom applications using standard protocols
  • *Scheduling and Notifications* - Automate report generation and email distribution to stakeholders
  • *Template Customization* - Create reusable report templates for consistent data presentation
  • *SOA and Microservices Support* - Integrate with existing IT architectures using modern patterns
  • *Built-in Report Designer* - Integrated layout editor for creating visual reports
  • *Data Access Toolkit* - .NET library and REST API for custom integrations with Office, SSRS, and other tools
  • *Dynamic Symbols in Reports* - Include real-time display symbols that update with current tag values
  • *Isolated Processing* - Report generation runs separately to protect real-time operations