About the Report module
The Reports module is as a comprehensive feature, enabling users to create, configure, and manage various types of reports. This module allows users to generate PDF and text reports, create and read XML and JSON files, consume web services, and provide data to external applications. Seamlessly integrated with other modules, it offers advanced features and options for efficient reporting and data handling.
Designed to offer an intuitive experience, the Reports module includes a configuration workflow for creating report forms, saving and visualizing reports, and generating WebData definitions. Furthermore, it promotes data exchange between systems by enabling users to publish and consume WebData objects. The module's usability extends to runtime execution, integration with other modules such as PDF viewers and web services, and customizable advanced features and options.
To ensure smooth operation, the software platform includes a dedicated section on troubleshooting and best practices for the Reports module. This section provides guidance on common issues and solutions, best practices and recommendations, and dataset report runtime attributes. Its goal is to equip users with the necessary knowledge and resources to address potential challenges and optimize their report management experience.
On this page:
Key Concepts and Terminology
Form
Content
Web Data
Content
How the Report module works
Tópico
Conteúdo
Tópico
Conteúdo
Features Highlights
Generating PDF and Text reports
Conteúdo
Creating and reading XML and JSON files
Conteúdo
Consuming Web Services
External application data providing
Conteúdo
Architecture implementation
Conteúdo
Configuring the Report Module
Configuration Workflow
Conteúdo
Creating Report Forms
Conteúdo
Saving and visualizing Reports
Conteúdo
Creating WebData definitions
Conteúdo
Publishing and Consuming WebData Objects
Conteúdo
Working with the Report module
Runtime execution
Conteúdo
Advanced features and settings
Conteúdo
Report module integrations
PDF viewer on Displays
Conteúdo
Using Web Services from Displays
Conteúdo
Troubleshooting and best practices
Common issues and solutions
Conteúdo
Best practices and recommendations
Conteúdo
Dataset Report runtime attributes
Conteúdo
The Report Attributes
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 Attributes. |
This section describes only some commonly used properties, for the full list properties and methods, go to the Namespaces Reference.
In this section...
NEW ORGANIZATION
About the Report Module
Key Concepts and Terminology
* Forms
* WebData
How the Report Module Works
Features Highlights
Generating PDF and Text reports
Creating and readnig XML and JSON files
Consuming Web Services
Provinding Data to External Application
Implementation Architecture
Configuring the Report Module
* Configuration Workflow
* Creating Report Forms
* Saving and Visualizaing Reports
* Creating WebData Definitons
* Publlising and Consuming WebData Objects
Working with the Report Module
* Runtime Execution
* Integration with Other Modules
** PDF viewer on Displays
** Using Web Services from Displays
* Advanced Features and Options
Troubleshooting and Best Practices
* Common Issues and Solutions
* Best Practices and Recommendations
* Dataset Report Runtime Attributes
The Remote Module can generate reports on the fly. This can even be done on client displays or for saving in files like XPS, HTML, Unicode, ASCII, and PDF.
These reports can have multiple graphical components like tables, tags, grids, trends, etc. All of these components have the ability to update data when a report is generated. This provides users with the most up-to-date data in their reports.
Creating Reports
This section allows you to configure and save a report's basic properties. Standard content can be added with the report editor. Then, application users can run reports.
To create or edit a report:
- Go to Edit → Reports → Reports.
- Select a report name or select the insert row (first row) to create a new report.
- Enter or select information, as needed.
Report Configuration Properties | |
|---|---|
Field | Description |
Name | Enter a name for the report. The system allows you to know if the name is not valid. |
Padding | Select padding when replacing a tag name with its value (the field for a tag will have the same number of spaces as the tag name is long).
|
SaveFormat | Select the report format:
|
SaveFileName | Enter a string and {ObjectProperties}. Use the full path. |
SaveTrigger | Enter an object property that will be the trigger. |
Append | Enter the file to append the report |
Size | Report size configuration. |
EditSecurity | Check what user groups can edit the report |
Header | Choose another report to be the Header. |
Footer | Choose another report to be the Footer. |
Legacy | Read-only. Show if the report is a legacy. |
Description | Enter a description of this report. |
To change the report format between “portrait” and “landscape”, you need to change it in both NovaPDF (printer used by our Platform ) and the target printer. |
Using the Report Editor
You create text, formatting, and values using the text editor.
To use the text editor:
- Go to Edit → Reports → TextEditor.
- Create the text, tags, and formatting for the report.
- Click Save.
- Configure the report properties for the display dynamics or script that will run the report.
Examples:
Dataset Module Properties examples | ||
|---|---|---|
Property | Type | Description |
Dataset.IsStarted | Boolean | Flag indicating if the Module Dataset has started |
Dataset.OpenStatusMessage | String | Message OK or error when initiating the Module |
Dataset.Query.Query1.SelectCommand() | DataTable | Executes the Query1 return a DataTable object the values |