Versions Compared

Old Version 58

changes.mady.by.user admin

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 to Report module

The Reports 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. This page 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

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

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

Module Highlights

  • PDF and Text Reports: Generate visually appealing and informative reports in PDF or text format

    with FactoryStudio

    .

    These reports

    Reports come complete with charts, tables, and other graphical elements, allowing users to effectively communicate insights from

    your

    their data.

  • Forms: Design customizable and interactive forms

    with FactoryStudio

    to display real-time or historical data and capture user input. This

    feature streamlines

    allows you to streamline data presentation and management.

  • WebData:

    With FactoryStudio, users

    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

    FactoryStudio and

    external systems. This module supports importing and exporting information in plain text files, or in standard XML

    and

    , HTML, or JSON formats, facilitating seamless data integration and management across various systems.

  • Web Services Integration:

    FactoryStudio's Report module

    The Reports Module offers robust capabilities to interact with external applications or systems. This integration allows

    FactoryStudio

    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

    in FactoryStudio

    . These automated processes ensure the timely delivery of reports, providing recipients with essential insights and updates.

  • Template Customization:

    FactoryStudio's Report module

    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:

    FactoryStudio's

    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

    . It also

    and addresses the unique requirements of each project, paving the way for a scalable and modular approach to system design.

Configuring the

Report

Reports Module

Anchor
Configuration Workflow
Configuration Workflow
Configuration Workflow

Reports module configuration workflow

Action

Where 

Create Report Forms

Reports → Forms. Learn more at 

Report

Reports Forms.

Manage WebData Definitions

Reports → WebData. Learn more at 

Report

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.

You can also manage and control report entries in the Reports Monitor page. 

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


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

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@self
spacesV10

...