Reports, Forms and WebData

Introduction

The Reports module is a comprehensive feature designed for creating, configuring, and managing a variety of reports. Seamlessly integrated with other modules, it 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. To assist users in overcoming potential challenges and optimizing their report management experience, the platform 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:

Purpose and Key Concepts

Forms

WebData

Understanding the Report Module

Features Highlights

Generating PDF and Text 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). Compact—Removes any extra characters and displays only the tag value. PadRight—Puts extra space for each character to the right of the tag value. PadLeft—Puts extra space for each character to the left of the tag value.
SaveFormat	Select the report format: XPS HTML Unicode ASCII PDF
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.

Reading and Writing XML and JSON

Interfacing with Web Services

External Application Data Exchange

Architecture Implementation

Configuring Report Module

Configuration Workflow

Report Forms Configuration

Forms RichText 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

Check Dynamic Cell Colors in Reports for additional information.

Creating WebData Definitions

WebData Contents Editor

Working with the Report Module

Runtime Execution

Saving and Visualizing Report Forms

Exchanging Data using XML and JSON files

GET and POST WebData to Web Services

Using WebData on Scripts

Using WebData from Displays

Report Module 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.

Space shortcuts

Page tree