Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

PI Event Frames Generator

Operational settings tab

  • Last UpdatedMay 30, 2025
  • 3 minute read

Runtime mode (/MODE=<mode>)

The Operational Settings tab provides a drop-down menu from which you select the mode in which you want the interface to operate. Options are described in the following table. You can also use the /MODE command to set the runtime mode from a command line.

PI EFGen supports these modes:

Mode

/MODE flag

Description

Realtime (default)

REALTIME

Scan active points and generate event frames according to the configuration.

Recovery

REALTIME with /RST specified

Scan active point history and generate or correct events accordingly. PI EFGen always starts in recovery mode, then switches to Realtime mode.

Statistics

STAT

Compare active point history against events and report results without updating any data.

Preprocess

NODATA

Source data is written to PI Data Archives with a timestamp earlier than that of the primary PI Data Archive.

Delete

DELETE with /RST and /RET specified

Delete events for a specified period.

Note: Disable spot deletion. If you select "Delete mode", you can only specify a start time. In the GUI the end time is always specified as '*'. An RET for delete mode can still be specified in the INI file, but the GUI will always disable spot deletion.

Perform one scan then stop (/SINGLERUN)

The interface performs one scan of active points, then exits.

Print result of first scan to file (/PRINT=<file name>)

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\aperson\Documents\PIWPASXBatch1_stat.dat). You have the option of selecting Select file to browse to the file path.

Debug level (/DB=<#>)

Specifies level of detail for logging as follows:

  • 0: Log errors and warnings (default)

  • 1: Log errors, warnings and major successes

  • 2: Verbose logging

  • 3: Log all messages including Unirecord diagnostic messages

Numeric settings (/NS=<lang>)

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_UnitedStates".

  • Interface ID (/ID=<#>)

    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. The default point source is PIEFGEN.

Associate all reference elements with child Event Frames (/DPRETC=<lang>)

Associate all reference elements with 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 the icon 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=<seconds>)

    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.

TitleResults for “How to create a CRG?”Also Available in