Versions Compared

Old Version 19

changes.mady.by.user user-dd014

Saved on

compared with

New Version Current

changes.mady.by.user admin

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.

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

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:

Table of Contents
maxLevel3

minLevel2
stylenone

Purpose and

Key Concepts and Terms

Forms

Content

WebData

Content

Understanding the Report Module

Features Highlights

Content

Generating PDF and Text Reports

Content

Reading and Writing XML and JSON

Content

Interfacing with Web Services

Content

External Application Data Exchange

Content

Architecture Implementation

Content

Configuring the Report Module

Configuration Workflow

Content

Report Forms Configuration

Content

Forms RichText Editor

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

    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.

    Check How to Use Reports for additional information.

    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.

    Examples:

    The purpose of the Reports Module is to provide resources for data-driven decision-making. The following concepts are key to understanding the Reports Module:

    Forms

    Rich Text documents that can include real-time tag values, tables, and symbols, saved as Text or PDF files.

    WebData

    Encapsulates data exchange via JSON, XML, or HTML with other applications, or saves content to a file. It can also be used in displays for interaction with web services and REST APIs.

    Understanding the Reports Module

    This module gathers data from several sources and levels coming from different locations. This data is organized and transformed into relevant information, providing a valuable resource for the decision-making process.

    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. This allows you to streamline data presentation and management.

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

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

    • Web Services Integration: The Reports Module offers robust capabilities to interact with external applications or systems. This integration allows users to access, manipulate, and share data in real-time using standardized communication protocols like HTTP and RESTful APIs. It ensures compatibility with diverse software systems such as ERP, BI tools, and custom applications, thereby enhancing data sharing and collaboration.

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

    • Template Customization: The Reports Module also offers a feature to create and modify report templates. This capability ensures that users can meet specific project requirements, guaranteeing consistent and accurate data presentation.

    • Architecture Implementation: The web services integration is designed to support various architectural implementations, including Service-Oriented Architecture (SOA) and microservices. This adaptability allows for easy integration within existing IT infrastructures and addresses the unique requirements of each project, paving the way for a scalable and modular approach to system design.

    Configuring the Reports Module

    Anchor
    Configuration Workflow
    Configuration Workflow
    Configuration Workflow

    Reports module configuration workflow

    Action

    Where 

    Create Report Forms

    Reports → Forms. Learn more at Reports Forms.

    Manage WebData Definitions

    Reports → WebData. Learn more at Reports WebData.

    Customize Report Forms

    Reports → Forms Editor. Learn more at Forms Editor.

    Manage WebData scripts

    Reports → WebData Code 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 exposes properties and methods of the .NET objects used by the Dataset Module execution. 

    Report

    Dataset

    Module Properties examples

    Property

    Type

    Description

    Dataset

    T.Modules.

    IsStarted

    Report

    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

    Content

    WebData Contents Editor

    Content

    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.

    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

    Report Module Attributes

    The Reportnamespace 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

    .

    Troubleshooting and Best Practices

    Best Practices and Recommendations

    Content

    Common Issues and Solutions

    Content

    In this section

    ...

    :

    Page Tree
    root@self
    spacesV10

    ...