Versions Compared

Old Version 43

changes.mady.by.user user-55475

Saved on

compared with

New Version Current

changes.mady.by.user Paulo Tsuchiya

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


HTML
<style>
.text-span-6 {
    background-image: linear-gradient(99deg, rgba(170, 163, 239, .5), rgba(125, 203, 207, .5));
    border-radius: 50px;
    padding-left: 15px;
    padding-right: 15px;
}

#title-text {
display: none;
}

.panelgradient {
    background-image: linear-gradient(180deg, #d5def0, whitesmoke);
    border-radius: 8px;
    flex-direction: column;
    justify-content: center;
    align-items: center;
    padding: 4rem;
    display: flex;
    position: relative;
}

</style>


<div class ="panelgradient">

<h1 style="text-align: center;">Reports <br> (Forms and WebData)</h1>

</div>



Introduction to the Reports Module

Image Added

The Reports Module simplifies the creation, saving, and visualization of text and PDF reports, as well as the generation of WebData definitions to manipulate JSON, HTML, text, and XML data. It supports runtime server execution and client-side web service requests, offering customizable advanced features

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:

Table of Contents
maxLevel3
minLevel2
stylenone

The Reports Module enables users to:

  • Generate PDF and text report files with built-in PDF viewers for Windows and web pages
  • Interact with XML, text, HTML, and JSON files
  • Consume web services
  • Provide data to external applications

Image Added

Key Concepts and Terms

The purpose of the Reports Module

Purpose and Key Concepts

The Reports module's purpose is to provide resources for data-driven decision-making. The following concepts in the following ease the Reports module understandingare key to understanding the Reports Module:

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 Encapsulates data exchange via JSON, XML, or HTML data with other applications, or save its contents saves content to a file. Web Data objects It can also be used in displays , enabling for interaction with web services and REST APIs.

Understanding the

Report module

Reports 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:

Module Highlights

  • PDF and Text Reports: Generate visually appealing and informative reports in PDF or text format, . Reports come complete with charts, tables, and other graphical elements, allowing users to effectively communicate insights from their data.

  • Forms: Design customizable and interactive forms to display real-time or historical data and capture user input, streamlining . This allows you to streamline data presentation and management.

  • WebData: Exchange Users can exchange data between external applications or services using web-based communication protocols like HTTP and RESTful APIs.

  • XML, HTML, and JSON Support: Import and export data Easily exchange data between external systems. This module supports importing and exporting information in plain text files, or in standard XML and , HTML, or JSON formats, enabling facilitating seamless data integration and management across various systems.

  • Web Services Integration: Interact with external applications or systems through HTTP and RESTful APIs, allowing This integration allows users to access, manipulate, and share data in real-time using protocols like HTTP and RESTful APIs. It also ensures compatibility with diverse software systems such as ERP, BI tools, and custom applications, thereby enhancing data sharing and collaboration.

  • Scheduling and Notifications: Set Keep stakeholders informed by setting up report schedules and email notifications to automatically deliver reports to stakeholders, keeping them informed of . These automated processes ensure the timely delivery of reports, providing recipients with essential insights and updates.

  • Template Customization: Create The Reports Module also offers a feature to create and modify report templates to . This capability ensures that users can meet specific project requirements, ensuring guaranteeing 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

  • : The web services integration

supports

  • is designed to support various architectural implementations,

such as

  • including Service-Oriented Architecture (SOA) and microservices. This

flexibility

  • adaptability allows for

seamless

  • easy integration within existing IT infrastructures

, accommodating

  • and addresses the unique requirements of each project

and promoting

  • , paving the way for a scalable

,

  • and 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:

Reports Module

Anchor
Configuration Workflow
Configuration Workflow

Configuration Workflow

Reports module configuration workflow

Action

Where 

Create Report Forms

Reports

→ Forms

Manage WebData Definitions

Reports → WebData

Customize Report Forms

Reports → Forms Editor

/ Forms. Learn more at Reports Forms.

Manage WebData

scripts

Definitions

Reports

→ WebData Code Editor
AnchorReport Forms ConfigurationReport Forms ConfigurationReport Forms Configuration

You create text, formatting, and values using the text editor. To create or edit a report:

Go toReports → 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

    NameEnter a name for the report. The system allows you to know if the name is not valid.PaddingSelect 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.
    SaveFormatSelect the report format:
    • XPS
    • HTML
    • Unicode
    • ASCII
    • PDF
    SaveFileNameEnter a string and {ObjectProperties}. Use the full path.SaveTriggerEnter an object property that will be the trigger.AppendEnter the file to append the reportSizeReport size configuration.EditSecurityCheck what user groups can edit the reportHeaderChoose another report to be the Header.FooterChoose another report to be the Footer.LegacyRead-only. Show if the report is a legacy.DescriptionEnter 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.

    AnchorForms RichText EditorForms RichText EditorForms 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.

    AnchorCreating WebData DefinitionsCreating WebData DefinitionsCreating 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:

    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.

    AnchorWebData Contents EditorWebData Contents EditorWebData 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 information.

    AnchorReports MonitorReports MonitorReports 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:

    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

    The runtime execution of the Report Module refers to the process of generating, viewing, and managing reports during system operation. The Reports Module has been designed to seamlessly integrate with the rest of the system, ensuring smooth runtime execution of all processes related to reports. This includes gathering data, transforming it into useful information, configuring reports, managing report forms, and even troubleshooting any issues that might arise during the runtime. Moreover, the Reports Module provides a range of functionalities to facilitate runtime execution such as runtime attributes, scheduling, notifications, and integration with PDF viewers and web services.

    Saving and visualizing Report Forms

    Report forms, created using the rich text editor, are an essential element of the Reports Module. They can incorporate real-time tag values, tables, symbols, and other components. Users have the ability to save these forms as text or PDF files on the hard drive or visualize them in displays. To save a report form, users need to input the necessary information, select the desired format (e.g., PDF, Text), and specify the save file name.

    For effective visualization, saved report forms can be viewed directly within the platform or through a PDF viewer. Moreover, for direct visualization on the display, the use of the Report Viewer Component is recommended. This can be accessed through Display Drawing > Drawing and inserting the Report Viewer Component. To configure, simply insert the desired Report and print.

    • Report: Select the Report Item
    • Print: Tag element is added, and the OS printer configuration will be triggered with its value changes

    Users also have the ability to configure the properties of reports to adjust the display dynamics or specify a script that will run the report. This includes the ability to assemble a PDF with all the alarm information, configure a tag trigger, and save the PDF with all alarm details. Users can configure the directory where the PDF will be saved and can choose the desired report formats, such as XML and PDF.

    An example of how this can be accomplished is by inserting a tag into the report. This method allows for greater customization and control over the generated reports. This ultimately allows users to maximize the effectiveness of the Reports Module, tailoring it to their specific needs.

    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

    Table of Contents
    maxLevel4
    minLevel3
    include#

    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

    / WebData. Learn more at Reports WebData.

    Customize Report Forms

    Reports / Forms Editor. Learn more at Forms Editor.

    Manage WebData scripts

    Reports / WebData Editor. Learn more at WebData Editor.


    Working with the Reports Module

    Showing Reports on Displays

    When using Windows WPF clients, you can use the following visualization controls. 

    When using Web HTML5, or portable displays, you can use the following visualization control:

    Monitoring the Reports Module Execution

    → Read more about the Reports Monitor. 

    Report Runtime Attributes

    The Reports Namespace

    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.


    For more information on namespaces and objects, go to Objects and Namespaces.

    In this section

    ...

    :

    Page Tree
    root@parent@self
    spacesV10