Purpose and Key Concepts

The Report module offers powerful data presentation and exchange capabilities through Forms and WebData, allowing users to visualize and interact with their industrial data efficiently.

Forms

Forms are customizable, interactive templates used to create reports and capture user input in FactoryStudio. They can be designed to display real-time or historical data, and may include a variety of UI components such as text boxes, drop-down lists, radio buttons, and more. Forms can be used for various purposes, such as generating equipment performance reports, logging operator actions, or submitting maintenance requests.

WebData

WebData  enables the exchange of data between the SCADA system and external applications or services using web-based communication protocols like HTTP and RESTful APIs. With WebData, users can access and visualize their industrial data in a web browser or integrate it with other software systems such as enterprise resource planning (ERP) or business intelligence (BI) tools. This facilitates data sharing and collaboration across different departments and platforms, ultimately streamlining operations and decision-making processes.

Understanding the Report Module

Features Highlights

The Report module in FactoryStudio offers various 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 FactoryStudio and 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 FactoryStudio to 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

Content

Report Forms Configuration

You create text, formatting, and values using the text editor.

To create or edit a report:

1. Go to Reports → Forms.
2. Select a report name or select the insert row (first row) to create a new report.
3. Enter or select information, as needed.

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:

1. Go to Reports → Forms Editor.
2. Create the text, tags, and formatting for the report.
3. Click Save.
4. 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

1. Go to Reports → Web Data.
2. Click the "Add" button to create a new Web Data entry, and fill in the following columns:
   • 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.

1. Go to Reports → Web Data Editor.
2. Select the WebData entry you want to edit from the list

Check the WebAccess REST API page for additional in formation.

Reports Monitor

The Reports Monitor allows you to manage and control report entries, providing an overview of the status and results of each report.

1. Go to Reports → Reports Monitor.
2. The Reports Monitor displays a list of report entries with the following columns:
   • 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.
3. 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.
4. 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 <<<<Executable Process, ports, Diagram, data flow>>>>

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

In this section...