Interface running mode is used to set the running mode of the Interface. There are four available modes:
Realtime(default)/Recovery – The Interface will perform realtime processing. This mode is also used for historical data recovery. To activate recovery mode, /rst switch has to be defined in command line parameters. In Recovery mode, if the /ret switch was not defined; the interface is going to recover data until current time, then switch to realtime processing automatically. If /ret switch was defined, then the interface is going to stop on completion of the recovery process. (/Mode=, no mode is written for Realtime or Recovery)
Statistics (Stat) – In this mode, the interface only compares source data with the PI server data. Note, the interface does not write or modify any data on the PI Server. On completion the interface reports results and stops. (/Mode=Stat)
Preprocess (NoData) – This mode is designed for situations when the source data needed to be written to PI archives which are earlier than the primary PI archive. Due to the nature of the PI Server, the newly added tags, units and modules are indexed (referenced) only in the primary PI archive. Any older archive will not have any knowledge of these modules, units and tags. In /mode=NoData the interface creates only modules, units, tags and tag aliases without processing batch data and pushing events into the tags. On completion, the interface stops and the user has to reprocess older archives with offline archive utility. The manual archive reprocessing creates indexes for newly added units, modules, tags in each reprocessed archive. This mode should be always used before writing new batch data to older PI archives (other than Primary). (/mode=NoData)
Delete (Delete) – In this mode the interface cleans PI archives based on specified source data only, leaving data from all other sources intact. This mode should be used only if the interface is unable to synchronize source batch data with the PI server. This modes is used only in conjunction with Recovery mode switches (/rst and /ret). (/Mode=Delete)
Start Time
The Recovery Start Time (/rst) parameter is used to set the target start time of the history data recovery process. The Recovery Start Time is approximate and the interface will recover all batches which start time after Recovery Start Time. In the boundary case when the batch start time is before Recovery Start Time and the batch end time is after Recovery Start Time, the interface is going to perform recovery for such batches as well. The should be provided in local interface node time format.
End Time
This command must be used in conjunction with the optional parameter Recovery Start Time. The Recovery End Time /ret parameter is used to set the target end time of the history data recovery process. The Recovery End Time is approximate and interface is going to recover all batches with start time before Recovery End Time even though its end time might be beyond Recovery End Time. The should be provided in local interface node time format.
Note: This parameter requires specification of Recovery Start Time /rst=
This parameter forces the interface to perform only one scan and stop. (/singlerun)
Debug level
The /db=[#] parameter specifies the Interface debug logging message level. There are three levels that may be assigned:
0 – Log only errors and warnings.
1 – Log errors, warnings and major success messages
2 – Log ALL messages.
Log level two (2) is the most verbose setting; while level zero reports the least detail (it logs only error messages). The default logging level is 0, to log errors and warnings only. When testing the Interface, it may be necessary to use a more verbose setting (1 or 2).
PI User Name
The /PIUser parameter is used to explicitly specify the user name to establish a connection to the PI Server. If this parameter is not specified, the Interface will try to use the trust table.
The /PIPswd parameter is used to explicitly specify the user password to establish the connection to the PI Server. If this parameter is not specified, the Interface will try to use the trust table.
Note: The /PIPswd parameter must be used in conjunction with the /PIUser parameter.
Numeric Settings
Numeric Settings (/ns) allows the interface to perform proper numerical conversions based on the “Regional and Language Options” setting on local system or based on user defined language.
This parameter is particularly useful when the numerical conventions differ (example a comma is used instead of a decimal etc) from the default settings.
The default for this parameter is to use the “Regional and Language Options” settings specified on the Windows machine where the interface is running. If the language specification is passed as a value (/ns=lang), then the interface will use that value as internal regional/language setting to perform numerical conversions regardless of local system “Regional and Language Options” setting.
If the switch contains invalid language, .i.e /ns=, then the interface will exit.
INI File
This read-only field displays the full path to the INI file the interface will use.