Report template creation and report generation
- Last UpdatedAug 15, 2023
- 2 minute read
- PI System
- RtReports 5.0
- Visualization
You generate a report by running a report template against a data context, a process that first retrieves data from sources processed by the RtReports server and then formats the data into a report.
The report template uses a set of rules to retrieve data that you define in the data template. When you run the report template, the data retrieved by the data template is written to a file called the data journal. The report template then uses a set of rules to format the data that you define in the format template. When you generate the report, the rules set in the format template are applied to objects in the data journal to create the finished report.
The process of building a report requires that you complete the following tasks.
-
Create or edit report templates
In RtReports editor, create a new report template or edit an existing report template.
-
Include data
Map external data to the report template using RtBaseline Services and create relational and web service data sets to include in the report template.
-
Pass the report template review cycle
Mark the report template ready for review and gather reviewer approvals, comments, and electronic signatures.
-
Release the report template
Release the report template for production by completing the review cycle.
Once released, the report template is available to generate reports in RtReports generator.
-
Generate a report
Choose a report template and apply a data context to generate a report.
A released report displays in the list of available reports in the RtReports generator. Any users in the designated groups can generate the report. The report is ready to be approved.
-
Insert comments
Comment on report sections (requires sufficient privilege). Each comment has an electronic signature and date and time stamp.
-
Verify report sections
Verify report sections (requires sufficient privilege). Every verification includes an electronic signature and a date and time stamp. Section verifications enable you to utilize real-time reviews of your production reports.
-
Pass the approval cycle
Gather the necessary report section verifications and electronic signatures to approve the report and the report is ready to be generated as a PDF and viewed.
-
Print a report
Generate a PDF file in the assigned file folder. Open the PDF file in a window on the client computer where it can be viewed and printed.
Note: With the release of RtReports 4.0, the ability to print to physical printers has been deprecated. Printing is only supported to Adobe PDF. If you need to print a report to a physical printer, you must first print to Adobe PDF, and then use that copy to print to a physical printer.
-
Generate an official report
Use the official report feature to generate reports with an official watermark and to track users who generate official reports, the dates and times the official reports were generated, and the number of times a report is officially generated.
Note: RtReports editor only uses * for PI relative time in the Start and Endtime. It does not use "y" or "t."