The Reports enables users to generate PDF and text reports, interact with XML and JSON files, consume web services, and provide data to external applications. The intuitive configuration workflow simplifies the process of creating report forms, saving and visualizing reports, and generating WebData definitions.
In addition to promoting data exchange between systems by allowing users to publish and consume WebData objects, the Reports module also supports runtime execution, integration with PDF viewers and web services, and customizable advanced features. This page includes a dedicated section on troubleshooting and best practices for the Reports module, covering common issues, solutions, recommendations, and dataset report runtime attributes.
On this page:
The Reports module's purpose is to provide resources for data-driven decision-making. The concepts in the following ease the Reports module understanding:
Report Forms are Rich Text documents that can be saved to disk or visualized in displays. The content can include real-time tag values, tables, and symbols. These forms can be saved as Text or PDF files.
Web Data 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.
This module gathers data from several sources and levels coming from different locations. This data is organized and transformed from these data into relevant information, providing a valuable resource for the decision-making process.
Reports module configuration workflow | |
---|---|
Action | Where |
Create Report Forms | Reports → Forms. Learn more at Report Forms. |
Manage WebData Definitions | Reports → WebData. Learn more at WebData. |
Customize Report Forms | Reports → Forms Editor. Learn more at Forms Editor. |
Manage WebData scripts | Reports → WebData Code Editor. Learn more at WebData Editor. |
You can also manage and control report entries in the Reports Monitor page.
The Report module may encounter some issues in its operation. Here are some common issues and their troubleshooting:
Solution
To ensure the smooth operation of the Report module, follow these best practices:
Recommendations
The Report 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.
This section describes only some commonly used properties, for the full list properties and methods, go to the Namespaces Reference.
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: