Reports Module (Concept) 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.

In this page:


Reports → Tutorial | Concept | How-to Guide | Reference


Understanding Report Generation

Industrial automation requires comprehensive documentation and data exchange capabilities. The Reports Module bridges operational data with business systems by providing:

  • Formatted documentation for compliance and analysis
  • Data exchange interfaces for enterprise integration
  • Automated distribution of critical information
  • Real-time data snapshots in professional formats

Key Concepts

  • Forms: Rich text documents with embedded real-time tag values, tables, and charts that generate PDF, text, or CSV output
  • WebData: Data exchange definitions for JSON, XML, and HTML communication with external systems via REST APIs
  • Templates: Reusable report layouts with dynamic content placeholders
  • Scheduling: Automated report generation based on time or events
  • Isolated Processing: Report generation in separate processes to protect real-time operations

What It Does

The Reports Module provides comprehensive reporting and integration:

  • 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

Architecture Overview

Report Generation Flow

  1. Template definition with placeholders
  2. Data collection from tags and queries
  3. Content rendering and formatting
  4. Output generation (PDF, text, HTML)
  5. Distribution or storage

Data Exchange Pattern

  1. WebData template configuration
  2. Tag binding for dynamic values
  3. API request/response handling
  4. Data parsing and mapping
  5. Integration with solution logic

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.

Integration Points

  • 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
  • Databases: Query results incorporated into reports

Feature Highlights

  • PDF and Text Reports - Professional documents with charts, tables, and graphics
  • Interactive Forms - Real-time data display with user input capture
  • WebData Exchange - HTTP and RESTful API integration
  • Multi-Format Support - JSON, XML, HTML, and plain text
  • Web Services Integration - ERP, BI, and custom application connectivity
  • Scheduling and Notifications - Automated generation and email distribution
  • Template Customization - Reusable layouts for consistency
  • SOA and Microservices - Modern architecture patterns support
  • Built-in Report Designer - Visual layout editor
  • Data Access Toolkit - .NET library and REST API for custom integrations
  • Dynamic Symbols - Real-time display elements in reports
  • Isolated Processing - Protected real-time operations


In this section...