-alarm=filename
Required for alarm processing
|
Specifies the name of the buffer alarm file the interface will read the alarm messages from. To ensure that the interface will be checking the correct location, it is recommended that the absolute path to the file is specified.
Example:
-alarm=/lg/scada/dat/his/msgdata.his.1.PI.dat
|
-CacheMode
Required when using disconnected startup
Default: Not Defined
|
Required for disconnected startup operation. If defined, the
-CacheMode startup parameter indicates that the interface will be configured to utilize the disconnected startup feature.
|
-CachePath=path
Optional
Default: Not Defined
|
Used to specify a directory in which to create the point caching files. The directory specified must already exist on the target machine. By default, the files are created in the same location as the interface executable.
If the path contains any spaces, enclose the path in quotes.
Examples:
-CachePath=/opt/piapi/interfaces/CacheFiles
-CachePath=/opt/piapi/interfaces/CacheFiles/
Example with space in path name:
-CachePath="/opt/piapi/Cache Files/MyFiles"
-CachePath="/opt/piapi/Cache Files/MyFiles/"
|
-CacheSynch=#
Optional
Default: 250 ms
|
NOTE: Care must be taken when modifying this parameter. This value must be less than the smallest scan class period defined with the -f parameter. If the value of the -CacheSynch parameter is greater than the scan class value, input scans will be missed while the point cache file is being synchronized.
The optional -CacheSynch=# startup parameter specifies the time slice period in milliseconds (ms) allocated by UniInt for synchronizing the interface point cache file with the PI Server. By default, the interface will synchronize the point cache if running in the disconnected startup mode. UniInt allocates a maximum of # ms each pass through the control loop synchronizing the interface point cache until the file is completely synchronized.
Synchronization of the point cache file can be disabled by setting the value -CacheSynch=0. The minimum synchronization period when cache synchronization is enabled is 50ms Whereas, the maximum synchronization period is 3000ms (3s). Period values of 1 to 49 will be changed by the interface to the minimum of 50ms and values greater than 3000 will be set to the maximum interval value of 3000ms.
Default: 250 ms
Range: {0, 50 – 3000} time in milliseconds
Example: -CacheSynch=50 (use a 50ms interval)
-CacheSynch=3000 (use a 3s interval)
-CacheSynch=0 (do not synchronize the cache)
|
-data=filename
Required for data processing
|
Specifies the name of the buffer data file the interface will read the events from. To ensure that the interface will be checking the correct location, it is recommended that the absolute path to the file is specified.
Example:
-data=/lg/scada/dat/his/measdata.his.1.PI.dat
|
-debug=x
Optional
|
The debug parameter specifies a list of debug message types that can be logged to help with troubleshooting the interface. The types are
I – Initialization
L – Load tags
F – File handling
D – Power TG data processing
A – Power TG alarm processing
P – PI point processing
R – Removing tags
N – New Tag added after initial point loading
Q – Interface quitting
X – All of the above (equivalent to ILFDAPRQ)
V – verbose (show more detail)
The messages will be logged in the PIHOME/dat/pimesslogfile file.
For example, to log messages to show the raw values of the events from the data file and the values sent to PI, use the parameter
-debug=DP
|
-ec=#
Optional
|
The first instance of the -ec parameter on the command-line is used to specify a counter number, #, for an I/O Rate point. If the # is not specified, then the default event counter is 1. Also, if the /ec parameter is not specified at all, there is still a default event counter of 1 associated with the interface. If there is an I/O Rate point that is associated with an event counter of 1, every interface that is running without -ec=# explicitly defined will write to the same I/O Rate point. Either explicitly define an event counter other than 1 for each instance of the interface or do not associate any I/O Rate points with event counter 1. Configuration of I/O Rate points is discussed in the section called I/O Rate Point.
|
-host=host:port
Required for Windows and UNIX
|
The -host parameter is used to specify the PI Home node. Host is the IP address of the PI Server node or the domain name of the PI Server node. Port is the port number for TCP/IP communication. The port is always 5450. It is recommended to explicitly define the host and port on the command-line with the
-host parameter. Nevertheless, if either the host or port is not specified, the interface will attempt to use defaults.
Examples:
The interface is running on an interface node, the domain name of the PI home node is Marvin, and the IP address of Marvin is 206.79.198.30. Valid -host parameters would be:
-host=marvin
-host=marvin:5450
-host=206.79.198.30
-host=206.79.198.30:5450
|
-id=x
Highly Recommended
|
The -id parameter is used to specify the interface identifier.
The interface identifier is a string that is no longer than 9 characters in length. UniInt concatenates this string to the header that is used to identify error messages as belonging to a particular interface. See Appendix A Error and Informational Messages for more information.
UniInt always uses the -id parameter in the fashion described above. This interface also uses the -id parameter to identify a particular interface instance number that corresponds to an integer value that is assigned to one of the Location code point attributes, most frequently Location1. For this interface, use only numeric characters in the identifier. For example,
-id=1
|
-onlyconnected
Optional
|
When the -onlyconnected parameter given, the interface will only process files when the connection to the PI server is good. If the connection is lost then the interface will stop processing files.
By default the interface will process files regardless of the connection status and if the connection is down then the events sent will be buffered by bufserv.
The default configuration is recommended when sending data to a collective because even though one PI server may not be available, other members of the collectives should be available to receive the events.
|
-ps=x
Required
|
The -ps parameter specifies the point source for the interface. X is not case sensitive and can be any multiple character string. For example, -ps=P and -ps=p are equivalent. The length of X is limited to 100 characters by UniInt. X can contain any character except ‘*’ and ‘?’.
The point source that is assigned with the -ps parameter corresponds to the PointSource attribute of individual PI Points. The interface will attempt to load only those PI points with the appropriate point source.
|
-qualcodefile=x
Required for data quality code processing
|
Specifies the name of the Power TG data qualities definition file. The interface reads the data quality priorities from this file and uses the priorities when processing data quality points (Location2=0, InstrumentTag suffix .QUAL).
To ensure that the interface will be checking the correct location, it is recommended that the absolute path to the file is specified.
Example:
-qualcodefile=/lg/scada/fg/en_US/
data_qualities.ini
Note: the en_US directory of the above path is the locale of the system. This is likely to be different for systems outside the US. For example, in Mexico the locale is likely to be es_MX.
|
-renamealarm=x
Optional
|
Specifies the filename that the interface to rename the alarm file to, after it has finished processing it. This is to allow other applications to process the same file. If there is already a file existing with the same name, the interface will wait until the other file has been removed.
By default, the alarm file is deleted after the interface has finished processing it.
|
-renamedata=x
Optional
|
Specifies the filename that the interface to rename the data file to, after it has finished processing it. This is to allow other applications to process the same file. If there is already a file existing with the same name, the interface will wait until the other file has been removed.
By default, the data file is deleted after the interface has finished processing it.
|
-stopstat=
digstate
or
-stopstat
-stopstat only is equivalent to
-stopstat="Intf Shut"
Optional
Default = no digital state written at shutdown.
|
If -stopstat=digstate is present on the command line, then the digital state, digstate, will be written to each PI point when the interface is stopped. For a PI3 Server, digstate must be in the system digital state table. . UniInt will use the first occurrence of digstate found in the table.
If the -stopstat parameter is present on the startup command line, then the digital state Intf Shut will be written to each PI point when the interface is stopped.
If neither -stopstat nor -stopstat=digstate is specified on the command line, then no digital states will be written when the interface is shut down.
Note: When using interfaces in a failover or redundant configuration, the -stopstat parameter should not be used as it would interrupt the data streams for the points, when no data was actually lost.
Examples:
-stopstat=shutdown
-stopstat="Intf Shut"
The entire digstate value must be enclosed within double quotes when there is a space in digstate.
|
-uht_id=#
Optional
Required when using failover
|
The -uht_id=# command-line parameter is used to specify a unique ID for interfaces that are run in a redundant mode without using the UniInt failover mechanism. There are several OSIsoft interfaces that are UniInt based and implement their own version of failover. In order for health tag(s) to be configured to monitor a single copy of the Interface, an additional parameter is required. If the -uht_id=# is specified; only health tags with a Location3 value equal to # will be loaded.
|
