Release notes
- Last UpdatedAug 16, 2023
- 6 minute read
- PI System
- RtReports 5.0
- Visualization
RtReports 5.0
Overview
RtReports 5.0 is a powerful, fully-configurable enterprise reporting application used with a PI System for generating electronic reports. RtReports 5.0 adds additional options for result definitions, and enhanced support for report parameters when using assets and event frames. It includes a new printing engine that utilizes the Chrome browser directly, and replaces the previous third-party printing engine ABCpdf. It also addresses several issues around automatic report generation and includes security enhancements, bug fixes, and other improvements.
For more information on product features and functions, including system requirements and installation/uninstallation instructions, see RtReports installation requirements.
Enhancements
This release includes a new printing engine that utilizes the Chrome browser directly and replaces the previous third-party printing engine ABCpdf.
The following features were added:
|
Work Item |
Description |
|---|---|
|
106348 |
Added Event Details result definition to allow retrieval of event frame acknowledgment, severity, and annotations. |
|
106349 |
Added support for report parameters for Asset Name, Template, and Root Path when creating Asset Context Template. |
|
280309 |
Added a verification step to RtReports installation that will prevent RtReports Editor from being installed if RtReports Sever is already installed. |
|
288641 |
Added option to sort spanning unit/subbatches by start time instead of creation time. |
|
310931 |
Added the option to disable autocomplete on authentication pages. |
|
312760 |
Added a warning when a user creates a new version of a report template off of a version that is not the current version. |
|
334249 |
Added option to retrieve PI Property, EVT Interface, and BIF for event frames on any level of batch report. |
|
355835 |
Added support for PI Data Archive with limited/trial license. |
|
358197 |
Added option for custom formatting to the Duration object. |
|
368052 |
Added the option to retrieve captured values to the AFAttribute result definition. |
|
378723 |
Added support for AF Element version when using Asset Context Template. |
Fixes
This section lists items that were resolved in this release:
|
Work Item |
Description |
|---|---|
|
43392 |
Fixed an issue where Performance Equations with time parameter aliases will not have timestamps converted to client time when the RtReports Server is configured to use client time zones. |
|
247506 |
Fixed an issue where Descriptors 12 (Description), 14 (TagName), or 17 (EngUnits) were missing in certain cases for Profile or Summary Value result definitions. |
|
247614 |
Fixed an issue where Descriptors 12 (Description) and 17 (EngUnits) were not set based on the underlying PI point for AF/EF Attribute result definitions when using an AF/EF Attribute without a description/default UOM. |
|
255436 |
Fixed an issue where generating time reports with Asset Context Template and AFAttribute Action Parameters in the RtReports Editor may hang or crash if there is a significant number of matching elements. |
|
259011 |
Fixed an issue where Calculation Time Value does not work in some cases when using a PE involving string comparison. |
|
259029 |
Fixed an issue where the Profile Journal Action Result Definition does not work with relative AF Attributes. |
|
259127 |
Fixed an issue where Calculation Time Value and Calculation Record do not work with DigitalTags. |
|
261928 |
Fixed an issue with several result definitions while using an AFAttribute specified by relative path. |
|
266095 |
Fixed an issue where comments/verifications were sometimes shown on incorrect sections when using Asset Context Template. |
|
267182 |
Fixed an issue where RtReports showed a shorthand version of a user's identity in certain cases. |
|
270456 |
Fixed an issue where a Result Definition's description was not shown in the resulting data journal. |
|
270465 |
Fixed an issue where the description of result definitions was missing when upgrading from RtReports 2.2.3. |
|
273788 |
Fixed an issue with date handling while using ARG to generate Time Reports in certain locales. |
|
275598 |
Fixed an issue where IIS Application Pool Identities were reset on upgrade installations. |
|
275599 |
Fixed an issue where RtReports Domain Group Privileges were reset on upgrade installations. |
|
275777 |
Fixed an issue where Time based reports failed to generate with a weekly recurrence when using Client timezone. |
|
285583 |
Fixed an issue where some event frames were not being automatically detected when using Automatic Report Generation. |
|
286987 |
Fixed an issue where users were removed from the RtReportsAdmin Group on upgrade installations. |
|
300900 |
Fixed an issue where numbers from PE would sometimes be shown incorrectly if a Numeric Format was specified and the report was generated in an environment with dot as the digit grouping symbol. |
|
306637 |
Fixed an issue where the dropdown list for a report parameter may be covered by a tooltip in certain browsers. |
|
310947 |
Fixed an issue where cached copies of certain pages could be accessed after logging out. |
|
311759 |
Fixed an issue where an error is thrown in the RtReports Generator when using Equipment View to view unit batches that are missing product or procedure. |
|
312636 |
Fixed an issue where an incorrect report would be loaded when loading a cached report generated using report parameters. |
|
319762 |
Fixed an error being logged when PI RtReports Remoting Host Services is restarted. |
|
319769 |
Changed type of several log messages related to Automatic Report Generation to Warning instead of Error. |
|
323834 |
Fixed an issue with report parameters when using non-English characters. |
|
325389 |
Fixed an issue where FontSize specified in Web.config was not being applied. |
|
334111 |
Fixed an issue where an empty action state was created when evaluating state transition equations with AF Attributes. |
|
336445 |
Fixed an issue where trends sometimes failed to generate in the RtReports Editor if the locale was different from the RtReports server. |
|
344914 |
Fixed an issue where an error is thrown when entering certain characters into input fields. |
|
346609 |
Fixed an issue where a "Requested Clipboard operation did not succeed" error was thrown while using the RtReports Editor. |
|
356951 |
Fixed an issue where AF Element and Event Frame attributes based on the same PI tag may be different in certain cases. |
|
372822 |
Fixed an issue where trends were generated using a different time zone than the corresponding AF/PI data in some cases. |
|
380548 |
Fixed an issue where generated report header size could be incorrect when images were specified with an absolute source path. |
|
385407 |
Fixed an issue where the Compressed Values result definition would show an error if "Bad Value" is found. |
|
392496 |
Fixed an issue with subseconds precision when using Client time zone. |
|
411768 |
Fixed an issue with the RtReports Editor when the current user does not have permission to access the default AF Server. |
Known Issues
This section lists problems and/or enhancements that have been deferred until a future release:
|
Work Items |
Description |
|---|---|
|
43807 |
Expansive batch search results hold up consequent batch search results. |
|
43993 |
Words that word-wrap at hyphens in PDFs created in prior versions are not word-wrapped in PDFs created in 4.1 and later. |
|
44207 |
Minimum line height is higher in RtReports 4.0 and higher. |
|
66590 |
Table cell content may be split across multiple pages in converted PDF. |
|
68136 |
The RtReports Generator Batch Search redirects to an error page when a PIBatch is selected whose BatchID or Product field contains reserved HTML characters (e.g. the less-than "<" or greater-than ">" characters). |
|
106300 |
When PI Modules in the MDB exceed 95 MB corruption is likely to occur in the module that exceeds 95 MB and the RtReports index. |
|
106316 |
Batch report list can contain old versions of released templates and allow generation of new reports using the old version. |
|
106325 |
Retired Time-Based Reports can be unofficially printed. |
|
106338 |
Saved reports that utilize RtBaseline datasets within Action States are unable to be opened and used. |
|
106339 |
Batch search is slower when Report Name is specified as criteria. |
|
106340 |
RtReports does not display who prints an unofficial RtReports and the time of the print. |
|
255330 |
RtReports does not support PI Batch Properties created using the root level option of the BIF interface. |
|
393878 |
Report history record is unique for each unit/sub context unless ‘UseBatchGUIDOnly’ is set to true. |
|
435671 |
Resulting data journal may have inaccurate start/end times when using event frames with subseconds. |
|
453899 |
Trends intermittently fail to generate in certain environments. |
Security information and guidance
We are committed to releasing secure products. This section is intended to provide relevant security-related information to guide your installation or upgrade decision.
We proactively disclose aggregate information about the number and severity of security vulnerabilities addressed in each release. The tables below provide an overview of security issues addressed and their relative severity based on standard scoring.
RtReports creates a number of modules in the module database, see Module database security.
Overview of New Vulnerabilities Fixed or Mitigated since version 4.1.4
|
Severity Category and CVSS Base Score Range |
Number of Fixed Vulnerabilities |
|
|---|---|---|
|
Critical |
9-10 |
|
|
High |
7.0-8.9 |
|
|
Medium |
4.0-6.9 |
1 |
|
Low |
0-3.9 |
|
Security Disclosures
The following security disclosures apply to this release of RtReports.
-
RtReports uses a web control. This control does not display internet content, so the associated risk is believed to be minimal.
-
The web server on RtReports is deployed as localhost and should not be exposed externally.
Distribution Kit Files
-
RtReports Server_5.0_.exe
-
RtReports Editor_5.0_.exe
RtReports 5.0 distributes the following major components as part of the installation:
-
OSIsoft MS VB Runtime Redistributables, (1.0.1)
-
Microsoft Visual C++ 2019 Redistributables (x86 and x64), (14.26.28720)
-
OSIsoft PI Network Subsystem Support (PINS), (3.4.435.538)
-
OSIsoft PI Software Development Kit 2018 SP1 Patch 3 (x86 and x64), (1.4.7.620)
-
OSIsoft PI AF Client 2018 SP3 Patch 4, (2.10.10.2539)
-
OSIsoft PI BatchView 3.1.5.0, (3.1.5.0)