Introduction to Report module
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
The Reports module's purpose is to provide resources for data-driven decision-making. The concepts in the following ease the Reports module understanding:
Forms
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.
WebData
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.
Understanding the Report module
Overview
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.
Features Highlights
The Report module provides several powerful features, including:
PDF and Text Reports: Generate visually appealing and informative reports in PDF or text format, complete with charts, tables, and other graphical elements.
Forms: Design customizable and interactive forms to display real-time or historical data and capture user input, streamlining data presentation and management.
WebData: Exchange data between external applications or services using web-based communication protocols like HTTP and RESTful APIs.
XML and JSON Support: Import and export data in standard XML and JSON formats, enabling seamless data integration and management across systems.
Web Services Integration: Interact with external applications or systems through HTTP and RESTful APIs, allowing access, manipulate, and share data in real-time.
Scheduling and Notifications: Set up report schedules and email notifications to automatically deliver reports to stakeholders, keeping them informed of essential insights and updates.
Template Customization: Create and modify report templates to meet specific project requirements, ensuring consistent and accurate data presentation.
Generating PDF and Text Reports
Create visually appealing and informative reports in PDF or text format, complete with charts, tables, and other graphical elements, to effectively communicate insights from your data.
Reading and Writing XML and JSON
Easily exchange data between FactoryStudio and external systems by importing and exporting information in standard XML and JSON formats, enabling seamless data integration and management.
Interfacing with Web Services
FactoryStudio's Report module enables seamless interaction with web services, facilitating data exchange with external applications and supporting various architectural implementations.
External Application Data Exchange
Leverage the power of web services to interact with external applications or systems, allowing FactoryStudio to access, manipulate, and share data through standardized communication protocols like HTTP and RESTful APIs. This enables integration with diverse software systems such as ERP, BI tools, and custom applications, enhancing data sharing and collaboration.
Architecture Implementation
FactoryStudio's web services integration supports various architectural implementations, such as Service-Oriented Architecture (SOA) and microservices. This flexibility allows for seamless integration within existing IT infrastructures, accommodating the unique requirements of each project and promoting a scalable, modular approach to system design.
Configuring the Report Module
Proper configuration of the Report module is essential to ensure efficient and reliable data presentation and exchange.
This section will guide you through the configuration process for each subtopic:
- Configuration Workflow
- Report Forms Configuration
- Forms RichTextEditor
- Creating WebDataDefinitions
- WebDataContentsEditor
- Reports Monitor
Configuration Workflow
Reports module configuration workflow | |
---|---|
Action | Where |
Create Report Forms | Reports → Forms |
Manage WebData Definitions | Reports → WebData |
Customize Report Forms | Reports → Forms Editor |
Manage WebData scripts | Reports → WebData Code Editor |
Report Forms Configuration
You create text, formatting, and values using the text editor. To create or edit a report:
- Go to Reports → Forms.
- 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.
Check How to Use Reports for additional information.
Forms RichText Editor
In the Forms Editor, you can design your form layout by dragging and dropping UI components (e.g., text boxes, drop-down lists, charts) from the toolbox onto the form canvas, and configure the properties of each UI component, such as data binding, appearance, and behavior.
To use the text editor:
- Go to Reports → Forms Editor.
- 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.
Check Dynamic Cell Colors in Reports for additional information.
Creating WebData Definitions
- Go to Reports → Web Data.
- Click the "Add" button to create a new Web Data entry, and fill in the following columns:
Report Configuration Properties | |
---|---|
Field | Description |
Name | Provide a unique name for your Web Data entry. |
Encoding | Select the appropriate encoding for the data exchange. |
DefaultURL | Enter the default URL for the data source. |
Authorization | Configure any required authorization settings. |
Headers | Specify any additional headers needed for the data request. |
SaveFileName | Define the file name for saving the data. |
TemplateID | Associate a template ID with the Web Data entry. |
Description | Add an optional description for the Web Data entry. |
WebData Contents Editor
In the Web Data Editor, you can create, modify, or delete data entries according to your project requirements.
- Go to Reports → Web Data Editor.
- Select the WebData entry you want to edit from the list
Check the WebAccess REST API page for additional information.
Reports Monitor
The Reports Monitor allows you to manage and control report entries, providing an overview of the status and results of each report.
- Go to Reports → Reports Monitor.
- The Reports Monitor displays a list of report entries with the following columns:
Report Configuration Properties | |
---|---|
Field | Description |
Name | The unique name of the report entry. |
Disable | A checkbox to enable or disable the report entry. |
SavedFileName | The file name of the saved report data. |
LastStatus | The last status of the report entry, such as "Success," "Running," or "Error." |
LastStatusMessage | A message providing additional information about the report entry's last status. |
Manage individual report entries using the "Play," "Pause," and "Stop" buttons located above the spreadsheet. These buttons allow you to manually start, pause, or stop report execution.
Review the status of each report entry to ensure successful execution and identify any issues that may require attention.
By utilizing the Reports Monitor, you can keep track of report execution and quickly identify and address any issues that may arise, ensuring smooth operation and accurate data presentation.
Working with the Report module
Runtime Execution
Content
Saving and visualizing Report Forms
Content
Exchanging Data using XML and JSON files
Content
GET and POST WebData to Web Services
Content
Using WebData on Scripts
Content
Using WebData from Displays
Content
Troubleshooting and Best Practices
Troubleshooting and Common #Issues
The Report module may encounter some issues in its operation. Here are some common issues and their troubleshooting:
#Issue
Solution
Best Practices and #Recommendations
To ensure the smooth operation of the Report module, follow these best practices:
#Best practice
Recommendations
Report Runtime 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.
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...