<style>
.text-span-6 {
    background-image: linear-gradient(99deg, rgba(170, 163, 239, .5), rgba(125, 203, 207, .5));
    border-radius: 50px;
    padding-left: 15px;
    padding-right: 15px;
}

#title-text {
display: none;
}

.panelgradient {
    background-image: linear-gradient(180deg, #d5def0, whitesmoke);
    border-radius: 8px;
    flex-direction: column;
    justify-content: center;
    align-items: center;
    padding: 4rem;
    display: flex;
    position: relative;
}

</style>


<div class ="panelgradient">

<h1 style="text-align: center;">Reports <br> (Forms and WebData)</h1>

</div>



Introduction to the Reports Module

The reports module simplifies the creation, saving, and visualization of reports, as well as the generation of WebData definitions. It supports runtime execution, integrates with PDF viewers and web services, and offers customizable advanced features. 

The Reports Module Enables Users to:

  • Generate PDF and Text Reports
  • Interact with XML and JSON Files
  • Consume Web Services
  • Provide Data to External Applications

On this page:



Key Concepts and Terms

The purpose of the Reports Module is to provide resources for data-driven decision-making. The following concepts are key to understanding the Reports Module:


Forms

Report Forms are Rich Text documents that can be saved to disk or visualized on displays. The content can include real-time tag values, tables, and symbols. These forms can be saved as Text or PDF files.


WebData

WebData encapsulates everything needed to exchange JSON, XML, or HTML data with other applications or save its contents to a file. Web Data objects can also be used in displays, enabling interaction with web services and REST APIs.




Understanding the Reports Module

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

Module Highlights

  • 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 your data.
  • Forms: Design customizable and interactive forms to display real-time or historical data and capture user input. This will allow you to streamline data presentation and management.
  • WebData: With users can exchange data between external applications or services using web-based communication protocols like HTTP and RESTful APIs.
  • XML and JSON Support: Easily exchange data between and external systems. This module supports importing and exporting information in standard XML and JSON formats, facilitating seamless data integration and management across various systems.
  • Web Services Integration: The Reports module offers robust capabilities to interact with external applications or systems. This integration allows users to access, manipulate, and share data in real-time using standardized communication protocols like HTTP and RESTful APIs. It ensures compatibility with diverse software systems such as ERP, BI tools, and custom applications, thereby enhancing data sharing and collaboration.
  • 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. It also addresses the unique requirements of each project, paving the way for a scalable and modular approach to system design.



Configuring the Reports Module

Configuration Workflow

Reports module configuration workflow

Action

Where 

Create Report Forms

Reports → Forms. Learn more at Reports Forms.

Manage WebData Definitions

Reports → WebData. Learn more at Reports WebData.

Customize Report Forms

Reports → Forms Editor. Learn more at Forms Editor.

Manage WebData scripts

Reports → WebData Code Editor. Learn more at WebData Editor.


Read more about the Reports Monitor. 



Working with the Reports Module

Runtime Execution

Monitoring the Reports Module

Intra-Module Interaction

External Systems Interaction

Best Practices and Troubleshooting

Troubleshooting and Common Issues

The Report module may encounter some issues in its operation. Here are some common issues and their troubleshooting:

Best Practices and #Recommendations

To ensure the smooth operation of the Report module, follow these best practices:



Report Runtime Attributes

The Reports Namespace exposes properties and methods of the .NET objects used by the Dataset Module execution. For more information on namespaces and objects, go to Objects and Namespaces.

Report Module Properties examples

Property

Type

Description

T.Modules.Report

RunObj

Class for Report operation.

ReportItem.Append

int

Indicates whether the report will be overwritten or appended on Save commands

ReportItem.Category

string

ReadOnly property with categories configured on Report object.




In this section: