Versions Compared

Old Version 10

changes.mady.by.user Paulo Tsuchiya

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.

About the Report module

The Reports module is as a comprehensive feature, enabling users to create, configure, and manage various types of reports. This module allows users to generate PDF and text reports, create and read XML and JSON files, consume web services, and provide data to external applications. Seamlessly integrated with other modules, it offers advanced features and options for efficient reporting and data handling.

Designed to offer an intuitive experience, the Reports module includes a configuration workflow for creating report forms, saving and visualizing reports, and generating WebData definitions. Furthermore, it promotes data exchange between systems by enabling users to publish and consume WebData objects. The module's usability extends to runtime execution, integration with other modules such as PDF viewers and web services, and customizable advanced features and options.

To ensure smooth operation, the software platform includes a dedicated section on troubleshooting and best practices for the Reports module. This section provides guidance on common issues and solutions, best practices and recommendations, and dataset report runtime attributes. Its goal is to equip users with the necessary knowledge and resources to address potential challenges and optimize their report management experience.

On this page:

Table of Contents
maxLevel23
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 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: 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: 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 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

Key Concepts and Terminology

Form

Content

Web Data

Content

How the Report module works

Tópico

Conteúdo

Tópico

Conteúdo

Features Highlights

Generating PDF and Text reports

Conteúdo

Creating and reading XML and JSON files

Conteúdo

Consuming Web Services

External application data providing

Conteúdo

Architecture implementation

Conteúdo

Configuring the Report Module

Configuration Workflow

Conteúdo

Creating Report Forms

Conteúdo

Saving and visualizing Reports

Conteúdo

Creating  WebData definitions

Conteúdo

Publishing and Consuming WebData Objects

Conteúdo

Working with the Report module

Runtime execution

Conteúdo

Report module integrations

PDF viewer on Displays

Conteúdo

Using Web Services from Displays

Conteúdo

Report in-depth

Advanced features and settings

Conteúdo

Tópico

Conteúdo

Troubleshooting and best practices

Common issues and solutions

Conteúdo

Best practices and recommendations

Conteúdo

Dataset Report runtime attributes

Conteúdo

NEW ORGANIZATION

About the Report Module

Key Concepts and Terminology

* Forms* WebData

How the Report Module Works

Features Highlights Generating PDF and Text reports Creating and readnig XML and JSON files Consuming Web Services

         Provinding Data to External Application

         Implementation Architecture

   Configuring the Report Module

        * Configuration Workflow

        * Creating Report Forms

* Saving and Visualizaing Reports* Creating  WebData Definitons* Publlising and Consuming WebData Objects

Working with the Report Module

* Runtime Execution

        * Integration with Other Modules

** PDF viewer on Displays** Using Web Services from Displays       * Advanced Features and Options

Troubleshooting and Best Practices

* Common Issues and Solutions* Best Practices and Recommendations* Dataset Report Runtime Attributes

The Remote Module can generate reports on the fly. This can even be done on client displays or for saving in files like XPS, HTML, Unicode, ASCII, and PDF.

These reports can have multiple graphical components like tables, tags, grids, trends, etc. All of these components have the ability to update data when a report is generated. This provides users with the most up-to-date data in their reports. 

Creating Reports

This section allows you to configure and save a report's basic properties. Standard content can be added with the report editor. Then, application users can run reports.

To create or edit a report:

  1. Go to Edit → Reports → Reports.
  2. Select a report name or select the insert row (first row) to create a new report.
  3. 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.

Note

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.

Using the Report 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

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

The Report Namespace

The Report namespace exposes properties and methods of the .NET objects used by the Dataset Module execution.

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.

info


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

...

:

Page Tree
root@self
spacesV10

...