Intension
This document is intended as a discussion base for topics and solutions around Reporting in general and specifically the Integrity Gateway and the Integrity Reports.
Status
Although the PTC world speaks in between with ThingWorx and PTC Navigate (including reporting Apps), I still believe that Integrity Build-In Reporting has its place in the product.
Related Use Case
As a user, I want the system to provide a single interface to generate predefined reports without having to switch to different tools.
I need different formats depending on my goal for the information processing, either in MS Word, MS Excel, HTML or PDF format.
Standard Integrity Functionality
Integrity Gateway: Create standardized Output - mainly in Word Format - for any stakeholder or auditors.
Integrity Reports: Ad Hoc Reporting for any kind of business need in HTML or XML format.
1. Integrity Gateway (Client)
The Integrity Gateway is a Java client application that can be run with user interaction or in silent mode.
The user can select one of the provided templates (export configurations) and the target file name. Then, the gateway reads and transforms the Integrity data to create MS Word output.
2. Integrity Reports (Server)
Integrity Reports are a server-based way to create HTML pages or XML files from Integrity. The layout is based on HTML templates, which are enriched with certain Integrity tags. Such tags allow, for example, to create repetitive sections based on the data provided (for data tables). Integrity reports are very powerful, although we have seen problems when complicated rich text or specific image types are involved.
Comparison Matrix:
| Feature | Integrity Gateway | Custom Gateway* | Reporting Engine* | Integrity Reports | Report Gateway* |
|---|---|---|---|---|---|
| Supports Output in Word Format | Yes | Yes | - | - | Yes |
| Supports Output in Excel Format | - | Yes | Yes | - | Yes |
| Supports Output in HTML Format | - | - | - | Yes | Yes |
| Supports Output in XML Format | - | - | - | Yes | Yes |
| Supports direct PDF Export | - | Yes | - | - | Partially |
| Supports Scheduling | - | - | - | - | Planned |
| Supports E-Mail Distribution | - | - | - | - | Planned |
| Supports configurable Output File Names | - | Yes | - | Planned | |
| Supports Archiving | - | - | - | - | Planned |
We see that Integrity provides different techniques for different purposes (standard and non-standard*). All are valid approaches for the respective business case.
Reporting Customizations
The most common customization is the Custom Gateway, but the Reporting Engine is also very often used. The Report Gateway is brand new and combines the functionalities of Reports and the Gateway on Server.
The Custom Gateway is a local Java Application which sits on top of the Gateway and offers mainly the following:
- Flexible Output Path and configurable File Names
- PDF Generator
- Baseline Picker
In addition, the Custom Gateway can add Java functionality to any export. Herewith you can get almost all data from any location in Integrity and enrich your data export. Examples are: trace listing, administration configuration export, audit trail listing, test document export with test session and detailed test results. All this is done with additional API calls directly before the document generation process.
The Custom Gateway also works with Excel. A similar template concept with tags as in Word was implemented. This allows you to create professional looking preconfigured Excel files directly from Integrity including Excel charts.
The Reporting Engine is an ad-hoc reporting tool to create Trace listings in Excel. It is a stand-alone Java-based solution that is not related to the Integrity Gateway. The layout is template-based and the trace data to be listed can be configured in specific XML files.
The Integrity Report Gateway is one of the latest customizations that bring the Custom Gateway functionality to the server. It was created on customer request to avoid local Java files completely. This solution already replaces the local Integrity Gateway. To further develop this solution, additional sponsors are required (current state: conceptual study, but very stable, re-use possible on request).
At the moment, we do not have a common solution to meet automated report scheduling, e-mailing or archiving. Although Integrity offers all of these elements, we only have to put everything together.
Report Scheduling
Use Case: As a user, I want to create a report (one or multiple times) automatically from the system at a particular time or day, for example, for my own internal or external meetings with my clients as a preparation. The report should be generated automatically, that I do not have to log into the system and have to run it by hand entering the selection criteria again and again.
Report e-Mailing
Use Case: As a user, I would like to have a system generated report automatically sent to me or a definable user group, for example, for my own internal or external review meetings with my customers. The report should be automatically sent, so I do not have to log into the system, to select and send it manually.
Report Archiving
Use Case: As a user I would like that specific reports are automatically archived by the system when I have requested this. For example, I want the reports generated by the system sent to my clients to be archived, so I can keep track of them. A different example relates to audit-related reports I have prepared, which I must hold for several years.
Next Steps
I am interested in your approaches to solve today's Integrity internal reporting requirements. I am also interested in how you have implemented scheduling, emailing, and report archiving.
Thank you
(Known professional or semi-professional solutions in use by our clients: PTC ThingWorx Apps, BIRT, Oracle BI Publisher)