RtReports server reporting settings
- Last UpdatedAug 15, 2023
- 4 minute read
- PI System
- RtReports 5.0
- Visualization
Report processing
Reporting settings control reporting processes that occur at the server level.
Configurations for the reporting settings in the %PIHOME%\RtReports\web.config, within the <appSettings> section.
|
Setting name |
Controls |
Default |
Setting options |
|---|---|---|---|
|
AllowCommentAfterApprove |
Whether users can comment on an approved report |
False |
True, False |
|
AllowCommentAndVerify |
Whether comments and verifications are enabled for the system |
True |
True, False |
|
AllSectionVerifiedToApprove |
Whether all sections of a report must be verified prior to approval |
False |
True, False |
|
AllowMultipleVerification |
Whether users can verify the same section of a report |
True |
True, False |
|
AllowHtmlMarkup |
Allows users to insert HTML formatting into the display of the RtReports Editor |
False |
True, False |
|
ARGSenderEmail |
The email account from which reports are sent to other users |
N/A |
Email address |
|
ARGQueryInterval |
How often to check for closed batches/Event Frames |
30 |
Number, in seconds |
|
ARGVerboseLogging |
The amount of detail written to the Event Viewer logs |
False |
True, False |
|
CheckUnitClasses |
Whether to skip an empty report's unit class for the report's section. When the setting is true, the empty unit class criteria is skipped. If the report has only the equipment criteria, the selected batch is matched based only on the equipment criteria. When this setting is false, the empty unit class criteria is not skipped. If the report has only the equipment criteria, the selected batch is matched based on the equipment criteria, and always matches an empty report class criteria. |
False |
True, False |
|
CompletedBatchOnly |
If this is true, only completed batches will be returned in Event Frame searches |
False |
True, False |
|
DefaultStartTime |
Default query time used in the generator |
*-8h |
PI time syntax |
|
DisplayOfficialMark |
Allows the official mark to be printed on all reports |
True |
True, False |
|
eMailErrorTo |
Email address for the RtReports system administrator |
rtreports@hotmail.com |
e-Mail address or alias for the actual address |
|
ErrorSuppressionTime |
Error Suppression |
0 |
0 (default) - no suppression. 1 thru x - duplicate errors are suppressed for a number of minutes. -1 - errors are completely suppressed. |
|
FontSize |
Default font size 10, maximum font size 15 |
10 (default), 15 (max) |
Number, in points |
|
InitialBatchSearch |
Whether generator automatically runs a batch search on opening the batch search page in the generator |
True |
True, False |
|
InitialPage |
Default web page that opens when starting RtReports |
Batch |
Batch, Report |
|
LegacyDescriptors |
|
False |
True, False |
|
LegacyPrint |
This setting emulates RtReports 3.3 printing settings. Table headers will not be shown on every page and text in tables will be shown in black (and not inherit colors from a parent table) if this setting is set to true. |
True |
True, False |
|
ParsePhaseName |
Whether the phase-level sub batch names have the operation name removed before applying the name matching for the corresponding sub batch template |
True |
True, False True = phasename False = Operation(phasename) |
|
PreferredSearchMode |
Allows the user to configure the batch search settings for Event Frames |
Default |
Default, EF |
|
RefreshInterval |
How often to refresh the report status phase page |
30 |
Time, in seconds |
|
RefreshStatus |
Whether the status page is refreshed by the RefreshInterval setting |
True |
True, False |
|
ReportPropertyTagPrefix |
PI tag prefix for tags created to store report properties |
__ ReportProperties$ |
[ReportPropertyTagPrefix][ReportName] |
|
ReportRequestInterval |
Refresh interval for the report page |
15 |
Time, in seconds |
|
RootPath |
URL location to the virtual directory that has RtReports generator |
https://[localhostname]/RtReports |
URL pointing to virtual directory for RtReports generator |
|
SaveCredentials |
User name is autocompleted if it was entered before |
True |
True, False If it is false, the user name is not autocompleted |
|
Server |
PI Server name for location of batch data, report templates, and time series data |
PI Server detected during installation |
Valid PI Server name |
|
ShowTimeZoneAbbreviations |
Whether the time zone information is shown with the date/time (Batch Search, Report Search, Cache Management Pages) |
False |
True, False |
|
SnapshotDelayTime |
The amount of time that must pass before a report is considered complete, in seconds |
180 |
Time, in seconds |
|
SortUnitSubBatch |
Sorting unit batches/sub-batches for spanning |
True |
True/False If it is false, the unit batches/sub-batches are used in the order they were created. This only applies to PI batches |
|
SupportTrendTimeZone |
Time zone for trend data |
True |
True/False The trend data is shown in the report’s time zone. If it is false, it preserves old behavior |
|
UseBatchGUIDOnly |
What context is stored in the RtReports History tag |
False |
True, False By default, this setting is set to false, so that RtReports mimics previous versions behavior. If this setting is set to true then only the top level batch GUID will be stored in the report history tag, regardless of which batch context was selected to run the report against. It will still preserve previously generated reports that were run against unit batch and subbatch contexts. Additionally, if this setting is set to true, then in order to not be empty, the report is required to have at least one of the recipe and/or product criteria. |
|
TemplatePath |
The path in the PI Module Database used to store report templates |
\%OSI\RtReports |
Valid file path within PI Module Database |
|
ThreadPoolSize |
Number of Reports to run. Only accepts 1 |
1 |
1 |
|
TrendErrorImagePath |
The path and image used for errors within RtReports generator |
//RtReports/Images/TrendError.gif |
Valid file path to image file |
|
UpdateRunTimeSummary |
The setting controls whether the Report execution times are updated. When this setting is true, a run-time summary is provided on the report listing page and updated each time the report is run. Otherwise, the summary is not updated |
True |
True / False |
|
UserAthenticationRoot |
The name of the computer used to look up group security attributes. |
WinNT://localhost,computer |
Computer name |