User Manual







Sepasoft - MES Modules
Cirrus Link - MQTT Modules


Inductive University
Ignition Demo Project
Knowledge Base Articles
IA Support
SDK Documentation
SDK Examples


Ignition 8.1
Ignition 7.9
Ignition 7.8

Deprecated Pages

Skip to end of metadata
Go to start of metadata

The following feature is new in Ignition version 8.0.10
Click here to check out the other new features

Report Module

The Report Module must be installed to use the Report Viewer component.

The Report Viewer component allows you to embed reports from the Reporting Module in a Perspective view, as well as view and print reports in PDF format. The Report Viewer located at the bottom of the Perspective Component palette in the Designer. To configure the Report Viewer, you must first create a report. 

To learn more about creating reports, refer to the Reporting section.

On this page ...

Configuring the Report Viewer

The Report Viewer component provides an easy way to view and print reports in a Perspective View. Let's configure the Report Viewer for a report.

This example requires that you already have a report created in your Gateway. You can learn more about creating reports here.

  1. Drag a Report Viewer component into a view.

  2. Enter the Path of the report you want to view in the 'source' property of the Property Editor. The data from your report will immediately load into the Report Viewer.
    Tip: You can right-click on any report in the designer Project Browser to Copy the full Path of the report.

  3. Parameters added during report creation are provided as properties in the Report Viewer. Add them under the 'params' object. (The example below uses the EndDate and StartDate parameters). The parameter names must match exactly to the parameters in your Report Resource, and will override any default values set in the Report Resource. The Report Viewer also allows you to bind your report parameters in your view.  

Report Viewer Properties

Once you are ready to view your report in the Report Viewer, set the 'source' property to your report. If you have parameters defined in the Report Source, you can configure them under the 'params' object, but the parameter names must match. The parameter values configured in the Report Viewer will override the values in the Report Source.

You can pick a starting page using the 'page' property. Each time another page is viewed, the 'page' property value will be updated.

You can specify a desired 'zoomLevel' and every time the zoomLevel changes, the property value will also be updated. 

You can customize the visual style of your report by creating a new style for your report such as changing the background colors of the viewer (not the report page), changing to a style class that was already defined in your project, or creating a new style. 

The 'allowDownload' and 'allowOpenInTab' properties allow you to view and print your report.  

To see the property descriptions, refer to the Perspective - Report Viewer page. 

Using the Report Viewer

Once you have your report designed, it can be viewed one page at a time using the navigational controls across the bottom of the component. You have the option to download a report to your local device or print a report to your local printer using these built-in controls. 

  • No labels