Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Introduction to the

Reports Module Overview

The Reports Module simplifies the creation, saving, and visualization of text and PDF reports, as well as the generation of WebData definitions to manipulate JSON, HTML, text, and XML data. It supports runtime server execution and client-side web service requests, offering customizable advanced featuresmodule generates PDF and text reports, creates interactive forms, and manages data exchange with external systems through JSON, XML, HTML, and web service interfaces.

On this Page:

Table of Contents
maxLevel2
minLevel2
excludeIntroductionOverview


Key Concepts

and Terms

    • *Forms*: Rich

Text
    • text documents
that can include
    • with real-time tag values, tables, and
symbols, saved as Text CSV or PDF files.WebData: Encapsulates data exchange via
    • charts for PDF/CSV output
    • *WebData*: Data exchange definitions for JSON, XML,
or HTML with other applications, or saves content to a file. It can also be used in
    • 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

Module Configuration Workflow

Step

Action

Where 

Description

Create Report Forms

Reports / Forms. Learn more at Reports Forms.

Create WebData Definitions

Reports / WebData. Learn more at Reports WebData.

Manage WebData scripts

Use Scripts, Displays or others module to active (save, load) the reports

This module gathers data from several sources and levels coming from different locations. This data is organized and transformed into relevant information, providing a valuable resource for the decision-making process.

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.

Runtime Execution

Providing Query Results

The Reports Module enables the solution to interact with Reports configuration seamlessly, acting as a Service to other modules.

The data retrieved or saved can be utilized in various ways throughout your solution. For example:

In the
  • *Displays
Module
  • *:
Visualization tools like
  • DataGrids
can
  • show JSON
and
  • /CSV data
. PDF can be visualized on displays. 
  • In the Scripts Module: Custom scripts can activate reports triggers and contents.
  • Devices:  Getting data from field equipments to save, or loading JSON/XML recipes to send to controllers
  • Visualization and Interaction 

    During runtime, the DataGrid component can show JSON data, Components to visualize  PDF are available:

    • , 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

    Features Highlights

    The Reports Module simplifies the creation, saving, and visualization of text and PDF reports, as well as the generation of WebData definitions to manipulate JSON, HTML, text, and XML data. It supports runtime server execution and client-side web service requests, offering customizable advanced features.

    PDF and Text Reports: Generate visually appealing and informative reports in PDF or text format. Reports come complete
    • with charts, tables, and
    other
    • graphical elements
    , allowing users to effectively communicate insights from their data.Forms: Design customizable
    • for effective data communication
    • *Interactive Forms* - Design
    and interactive
    • forms to display real-time
    or
    • /historical data and capture user input
    . This allows you to streamline data presentation and management.WebData: Users can exchange data between external applications or services using web-based communication protocols like
    • *WebData Exchange* - Share data with external applications via HTTP and RESTful APIs
    .XML, HTML, and JSON Support: Easily exchange data between external systems. This module supports importing and exporting information in plain text files, or in standard
    • *Multi-Format Support* - Import/export data in JSON, XML, HTML,
    or JSON formats, facilitating seamless data integration and management across various systems.Web Services Integration: This integration allows users to access, manipulate, and share data in real-time using protocols like HTTP and RESTful APIs. It also ensures compatibility with diverse software systems such as
    • and plain text formats
    • *Web Services Integration* - Connect with ERP, BI tools, and custom applications
    , thereby enhancing data sharing and collaboration.
    • using standard protocols
    • *Scheduling and Notifications
    : Keep stakeholders informed by setting up report schedules and email notifications. These automated processes ensure the timely delivery of reports, providing recipients with essential insights and updates.
  • Template Customization: The Reports Module also offers a feature to create and modify report templates. This capability ensures that users can meet specific project requirements, guaranteeing consistent and accurate data presentation.

  • Architecture Implementation: The web services integration is designed to support various architectural implementations, including Service-Oriented Architecture (SOA) and microservices. This adaptability allows for easy integration within existing IT infrastructures and addresses the unique requirements of each project, paving the way for a scalable and modular approach to system design.

  • Manage WebData

    WebData encompasses all functionalities necessary for exchanging JSON, XML, Text, or HTML data with external applications or saving data contents to a file.

    External Application Data Exchange: Utilize web services to interact with external applications or systems, enabling our platform to access, modify, and share data using standardized communication protocols like HTTP and RESTful APIs. This facilitates integration with diverse software systems such as ERP, BI tools, and custom applications, enhancing data sharing and collaboration.

    Architecture Implementation: Our platform’s web services integration supports various architectural implementations, including Service-Oriented Architecture (SOA) and microservices. This adaptability enables seamless integration within existing IT infrastructures, catering to the specific needs of each project and fostering a scalable, modular approach to system design.

    Built-in Report Designer

    Our platform offers a straightforward Report layout editor seamlessly integrated with the engineering workspace. Easily create visually appealing and informative reports in PDF or text format, featuring charts, tables, and other graphical elements.

    Scheduling and Notifications

    Schedule report generation and set up email notifications to automatically deliver reports to stakeholders. This ensures they stay informed of crucial insights and updates without manual intervention.

    Data Access Toolkit

    Using our platform, you have access to a comprehensive .NET Data Access library, which you can utilize to develop tailored reporting solutions or integrate with various tools like Microsoft Office, SQL Server Reporting Services, or other vendors' tools. Additionally, a Rest API is available for integration with Web Services.

    Create Forms

    Create customizable and interactive forms to showcase real-time or historical data and gather user input, simplifying data presentation and administration.

    You can incorporate any symbol from the real-time displays into the report. These symbols retain their dynamic behavior, such as color, text output, and rotation, by updating them with the current tag values during report creation. User controls like Trend and Bar charts can also be included. You can also add contents from database tables and queries to the reports. These queries and report generation processes operate in isolated processes, ensuring they don't disrupt real-time processing.
    • * - 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