The primary purpose of the Reporting interface is to generate analytical output that cannot be easily obtained directly from the User Interface or via other Data Export functions.
There are 3 Components to the Reporting Interface:
Report Component
Description
Report Definition file
This is a BIRT .rptdesign file which is created using the BIRT Report Editor. The .rptdesign files defines the layout and structure of the Report output.
This is the final component and displays the resulting output based upon the selected Report Definition File and Report Configuration. Once the output is generated, it can be downloaded via the Web Client. It also saves a copy into Global Console as an historical record allowing the user to download, archive, remove, or schedule the report run at a future date.
The above stages are typically handled by different people in an organization:
Report Definition files are created by report design engineers who are familiar with both the BIRT reporting system and IRM REST API Schema.
IRM provides a number of pre-built report definitions to meet most organizations' reporting needs, minimizing the need to create new report definitions.
Existing Report Definitions can be copied and used as the starting point for any customized report.
Planet Associates can provide assistance with defining or modifying Report Definition files
Planet Associates provides a Report Validation program to confirm whether a report is structured correctly and fully optimized.
Report Configurations are typically set up by IRM system administrators.
Report Configurations can be executed by any IRM user with correct permissions.
Report Output can be downloaded by IRM users or by managers and executives via the Global Console Interface.
Note: Even though IRM reporting is in most respects administratively similar to the various Export functions (Area iiPDF, Elevation iiPDF, etc.), Reporting does not use Templates, while all of the Export operations do use Templates. The reporting equivalent of a Template is the Report Definition file, as described above.
Report Outputs can be accessed from the following two Interfaces:
Global Console - by selecting the Reporting navigation menu
Site - by clicking on the Report button , which is above the Object Grid in the IRM Web Client.
While a Report Configuration is created for a specific Site using the IRM Web Client, it is transferred to and owned by the IRM Global Console, which knows which Site it came from.
Note: the Report Definition and other actual asset files are stored and owned by the Global Console, and additional files can be uploaded from the Site Master to the Global Console.
, which is above the Object Grid in the IRM Web Client.