Quick start

To start, create or open a TwinCAT HMI project.

Installation

Install the NuGet package "Beckhoff.TwinCAT.HMI.Reporting" via the NuGet Package Manager.

The TwinCAT Reporting Server (TwinCAT.XAR.ReportingServer) is required to use the Reporting Extension. Install this using TcPkg if it is not available.

Configuring the Reporting Extension

1. Open the configuration page of the Reporting Extension in Visual Studio or separately in the browser.
2. Go to the Reporting tab.
You can configure the Reporting Extension here.

The basic configuration of the report is carried out in the General area.

Creating a new runtime:

1. Adjust the connection of the existing runtime or create a new one.
2. Connect this to a TwinCAT Reporting Server via the AMS Net Id of the target system. If it is an external TwinCAT Reporting Server, pay attention to the router configuration.
3. Create a new configuration.
4. Enter the desired name.
You have now created a basic configuration for the Reporting Server.

Creating a new report:

1. Create a new report.
2. Enter the desired name and connect the report with an associated runtime and configuration.
3. Create a new entry under Text fields.
4. Enter a name and the symbol to be read.
This provides you with a basic configuration for creating a report. You can add elements such as tables, text fields or HTML containers to the report at any time.
Quick start 1:

To create a report, at least one text field, table or HTML element must be included in the report.

Quick start 2:

The PDF is created directly after the HTML page has been created. Anything delayed will result in an incorrect display.

Example: If CSS animations are present in the background, they may not have been completed when the PDF is created. This results in an image being created at some point during the animation that does not correspond to the final result. This behavior can be found, for example, in the integration of charting libraries with animation.

Creating a report file (HTML, PDF, JSON)

You have the option of creating a report in the User-defined configuration area.

1. Under Reports, select the runtime of the TwinCAT Report Server on which you want to create the report.
2. Under Report generation, select the report to be created.
3. Click on the Create button in the Report generation group.
The report is generated and displayed as an HTML file under Last report, if this has been configured. If no "Export path" is set, you will find the files on the Reporting Server system at
C:\Program Files (x86)\Beckhoff\TwinCAT\Functions\Reporting-Server\Reports.