Operational Settings tab
- Last UpdatedNov 06, 2024
- 4 minute read
Modify the settings on the Operational Settings tab to configure the interface mode and other related settings.
Operational Settings
Realtime mode (/MODE=)
Interface modes are selected from the drop-down menu. Options are described in the table below.
For the Recovery, Statistics, Preprocess, and Delete options, you can identify a Start Time and an End Time. Select the calendar icon associated with each field to select dates and times.
|
Mode |
Description |
|---|---|
|
Realtime (default) |
Scan data source to collect data in realtime. |
|
Recovery |
Scan data source and generate or correct events accordingly. Always starts in recovery mode, then switches to realtime mode. |
|
Statistics |
Compare data source history against events and report results without updating any data. |
|
Preprocess |
Source data is written to the PI Data archives with timestamps earlier than those written to the primary PI archive. Note: This mode requires that you use the offline archive utility to reprocess older archives. This is done after completion when the interface stops. |
|
Delete |
Delete events for a specified period. Note: Selecting "Delete mode" limits you to specifying a Start Time only. In the GUI, the End Time is always specified with "*" asterisk symbol, a dereference operator pointed to by the variable's value. The interface allows for "spot deletion", meaning the deletion of event frames from
within a specific time window. For example, you may have a scenario where you have
received "junk data" from previous days. Spot deletion allows you to delete event
frames back to the date when you began receiving unusable data. The GUI does not provide
the means to specify both ends of the time window that you wish to delete. That can
be done through edits to the configuration file. |
Perform one scan then stop (/SINGLERUN)
The interface performs one scan of active points, then exits.
Print result of first scan to file (/PRINT=)
Print the results of the first scan to the specified text file. The results include the event frame hierarchy tree, the tag list, and the equipment tree. This parameter is designed primarily for troubleshooting and configuration testing when the interface is run in statistics mode. Enter a name for the scan in the field provided (for example, C:\Users\jdoe\Documents\PIWPASXBatch1_stat.dat). You have the option of selecting Select file to browse to the file path.
Log debug messages (/DB=<#>)
Specifies level of detail for logging as follows:
-
0: Log errors and warnings (default)
-
1: Log errors, warnings and major successes
-
2: Log all messages
-
3: Log all messages including Unirecord diagnostic messages
Numeric settings (/NS=)
Configures how numeric values are formatted by the interface, to enable the interface to properly interpret numeric values based on the machine's regional setting or a user-specified language. Default is "English (United States)".
Interface ID (/ID=x)
Specifies the numeric interface instance identifier (maximum nine digits). To detect PI points maintained by the interface instance, the interface matches this setting against the value in the points' Location1 attribute.
Point source (/PS=x)
Point source for the interface instance. Point source is not case sensitive. Corresponds to the PointSource attribute of individual PI points. The interface loads PI points with the same point source.
Check In Limit (/CHECKINLIMIT=)
This parameter sets the number of unirecords to process before performing a check-in operation to PI Asset Framework (PI AF). It is an integer type parameter with a range of 100 (minimum) to 50,000 (maximum). The default is set to 10,000.
Unirecord Buffer Limit (/UNIRECORDBUFFERLIMIT)
This parameter determines the maximum number of records that are queued for processing before data collection is paused. Data collection resumes when the number of queued records drops below this value. The value must be a positive integer number between 1 and 10 million records. The default is set to 300,000.
Associate all reference elements with child Event Frames (/PRETC=x)
Disable propagation of reference elements to children. By Default, the interface propagates each event frame element reference to its child event frames.
Failover settings
Failover tag (/FAILOVERTAG=x)
The failover tag coordinates failover by using a PI tag. You must create the PI tag on the PI Server before creating a failover tag. To create a PI tag, refer to the System Management Tools Point Builder. When creating a PI tag, you should use string for the point type.
To create a failover tag, select 
to open the Tag search window. In the Tag Mask field, enter the name of the tag.
The created tag displays in the Failover tag field of the PI Event Frames Interface Manager.
Failover identifier (/FAILOVERID=x)
A unique identifier for this interface instance, used to coordinate which instance is primary.
Failover swap time (/SWAPTIME=)
Select to specify how long an interface can be inactive before failover to another instance occurs. The default is 300 seconds.
Security settings
Specify point security (/PTSEC=x)
Override the default point security created by the interface. Select Change to open the Change security window. There you can select from or add to the options listed, and specify read/write authorizations for each. Select OK to change point security.
Specify data security (/DATASEC=x)
Override the default data security of PI points created by the interface. Select Change to open the Change security window.
Event frames inherit security setting from the primary reference element
The security model from the Reference Element will be applied to any corresponding Event Frames linked to it.