Quick start

To get started, the first step is to install the required NuGet package "Beckhoff.TwinCAT.HMI.Reporting".

Installation of a NuGet package

1. Create or open an existing HMI project.
2. Right-click on the References folder.
3. Select Manage NuGet packages.
A new window opens with the Package Manager.
4. Select Beckhoff Offline Packages (1.14) as the package source if the corresponding TcPkg has been installed or nuget.org.
5. Switch to the Browse tab.
You will receive an overview of the available packages.
6. Select the required package.
An overview opens on the right side.
7. Select the version you want to install and install it.
The package is now available to you.

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

Installing a package with TcPkg

1. Close all Visual Studio instances.
2. Start the command line or PowerShell with administrator rights.
3. Use the command "tcpkg install <package name>" to install the latest version of the package.
The newly installed function is now available to you.

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.

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.