Reports Module (Reference) provides comprehensive report generation capabilities including formatted documents, web data integration, and multi-format output support. The Reports Module enables::
- Text and PDF report generation
- Web API data integration
- Dynamic content with tags
- Multiple output formats
- Scheduled generation
- Real-time monitoring
In this page:
Table of Contents maxLevel 2 minLevel 2 indent 10px exclude Steps style none
Module Components
Configuration Sections
| Section | Path | Purpose |
|---|---|---|
| Forms | Reports → Forms | Report templates and formatting |
| WebData | Reports → WebData | API integration and data exchange |
| Forms Editor | Reports → Forms Editor | Visual report design |
| WebData Editor | Reports → WebData Editor | Data structure editing |
| Monitor | Reports → Monitor | Runtime status tracking |
Configuration Workflow
| Step | Action | Location | Purpose |
|---|---|---|---|
| 1 | Create Forms | Reports → Forms | Define report templates |
| 2 | Configure WebData | Reports → WebData | Setup API connections |
| 3 | Design Content | Reports → Forms Editor | Visual report layout |
| 4 | Map Data | Reports → WebData Editor | Configure data bindings |
Runtime Display
Windows WPF Clients
- ReportViewer Control - Native report rendering
- PdfViewer Control - PDF document display
Web HTML5 Clients
- PdfViewer Control - Browser-based PDF viewing
Control Examples
xml
<ReportViewer ReportName="ProductionReport" />
<PdfViewer Source="@Report.Form.DailyReport.SavedFileName" />Report Namespace
Access report objects at runtime:
Common Properties
| Property | Type | Description |
|---|---|---|
@Report.Form.<Name> | ReportItem | Report form object |
@Report.WebData.<Name> | WebDataItem | WebData object |
@Report.Form.<Name>.Append | int | Append mode (0/1) |
@Report.Form.<Name>.Category | string | Report category |
@Report.Form.<Name>.SavedFileName | string | Output file path |
Runtime Methods
csharp
// Generate report
@Report.Form.ProductionReport.Generate();
// Save report
@Report.Form.ProductionReport.Save();
// Execute WebData request
await @Report.WebData.APIData.GetRequestAsync();Report Generation
Manual Trigger
csharp
public void GenerateReport()
{
// Set report data
@Tag.ReportDate = DateTime.Today;
// Generate and save
@Report.Form.DailyReport.Generate();
@Report.Form.DailyReport.Save();
}Scheduled Generation
Using SaveTrigger property:
csharp
// Configure trigger
@Report.Form.ShiftReport.SaveTrigger = "Tag.ShiftEnd";
// Trigger generation
@Tag.ShiftEnd = 1; // Triggers reportOutput Formats
| Format | Extension | Features | Use Case |
|---|---|---|---|
| Full formatting, professional | Distribution | ||
| XPS | .xps | Windows native format | Internal use |
| HTML | .html | Web-ready, hyperlinks | Online viewing |
| Unicode | .txt | International characters | Multi-language |
| ASCII | .txt | Plain text | Data export |
WebData Integration
API Configuration
csharp
// Configure endpoint
@Report.WebData.Weather.DefaultURL =
"https://api.weather.com/data";
// Set authentication
@Report.WebData.Weather.Headers["Authorization"] =
"Bearer {{Tag.APIToken}}";Data Exchange
csharp
// GET request
string data = await @Report.WebData.Weather.GetRequestAsync();
// POST request
await @Report.WebData.Weather.PostRequestAsync();Monitoring
Access Reports → Monitor during runtime:
- Generation status
- Error tracking
- File operations
- Server-side only
Monitor properties:
csharp
string status = @Report.Form.MyReport.LastStatus;
string error = @Report.Form.MyReport.LastStatusMessage;Best Practices Checklist
- Test templates - Preview before production
- Validate data - Check tags before generation
- Handle errors - Monitor LastStatus
- Manage storage - Archive old reports
- Schedule wisely - Avoid peak times
- Secure APIs - Protect credentials
- Document reports - Clear descriptions
Troubleshooting
Report not generating:
- Check trigger conditions
- Verify data availability
- Review file permissions
- Monitor error messages
WebData fails:
- Verify API endpoint
- Check authentication
- Review network access
- Validate data format
Format issues:
- Match output to viewer
- Check font availability
- Review margins/spacing
- Test encoding
In this section...
| Page Tree | ||||
|---|---|---|---|---|
|
| 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
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.
On this page:
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
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
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
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 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 | ||||
|---|---|---|---|---|
|