RtReports generator search pages
- Last UpdatedJan 24, 2023
- 2 minute read
- PI System
- RtReports 5.0
- Visualization
The RtReports generator has two types of search pages: the Batch Search page and the Report Search page.
After you sign in, the default search screen opens. You can select an alternative search screen from the Quick Links list on the RtReports toolbar.
Optionally, you can apply an immediate filter to the search screen by specifying an attribute from the Search Attribute list on the toolbar. The list of available search attributes depends on the search screen specified in the Quick Links list.
For instance, if you select Report from the Quick Links list, select Name from the Search Attribute list, and enter ACME* in the text field, then the report search page opens with the initial search defined as .
Search batches and generate RtReports based on time zone
When the ReportTimeZone configuration is set to "client", users search for batches and generate RtReports based on the client time zone. In this case, a time zone must be specified in the URL parameter during login. To login use the client mode URL .
The time zone specified must be both a valid Windows time zone, and also match one of the <StandardName> values defined in WindowsShortName.xml. For time zones that are not supported, or when users try and login without a time zone, an error message similar to the following will appear: URL time zone context is not recognized. Please contact your administrator for the correct URL. See Configure ReportTimezone.
When the ReportTimeZone configuration options is set to "server" (the default value,) users search for batches and generate RtReports based on the PI data server time zone.
To login use the server mode URL: .
When you view report search results in the Search page, reports will have a status.
Report status options
|
Status |
Meaning |
|---|---|
|
Running |
RtReports report generator is generating the report. You cannot view a report when it is running. When complete, the report can be viewed and, depending on the report status and context, might be cached. |
|
Pending |
A report is waiting to run. RtReports generates only one report at a time. A request to generate or view a report while a report is running is assigned the status Pending as it waits for its turn to run. You cannot view a report when it is pending. |
|
Available |
A report has been generated and is available to be retrieved from the file cache and viewed. |
|
Done |
A report that can not be cached after it has been generated and can be viewed. This occurs when only the View check box is selected in the RtReports Report Search page for a report that cannot be cached. You can view a report in the report viewer when it is done. You must rerun the report if you close the report viewer window. |
|
Error |
A report that generated an error when it ran. The report error is accessible in the Report Error tab of the Cache Management page for a short time after the attempted generation. For information on accessing the Cache Management page, see Manage memory and file caches. |