Command-line parameters for the PI UFL interface

/am=#

Optional: Archive mode.

If the laboratory mode is activated LB, you can specify the archive mode.

3: (ARCNOREPLACE) Add unless event(s) exist at same time (Data Archive 2.x)

4: (ARCAPPEND) Add event regardless of existing events

5: (ARCREPLACE) Default: Add event, replace if event at same time

6: (ARCREPLACEX) Replace existing event (fail if no event at time)

7: (ARCDELETE) Remove existing event

8: (ARCAPPENDX) Add event regardless of existing events, with no compression

This startup parameter does not apply when values sent to the Data Archive include annotations. If annotations are required, and you need this feature, you can modify the Location5 attribute for this purpose.

/cf=xxx.yyy

Required: Specifies the configuration file, including full path.

/des=#

Optional: Default error status, specified as the index of the desired state from the PI System digital set (specified by MSG(n).DIGITALSET).

This status is stored in Data Archive when the digital status string cannot be translated.

/disablecounters

Optional: Disable writing to performance counters.

/f=HH:MM:SS,hh:mm:ss

Required: The f parameter defines the time period between scans.

The scans can be scheduled to occur at discrete moments in time with an optional offset.

Define the time period or discrete time in terms of hours HH, minutes MM, and seconds SS.

Define the offset in terms of hours hh, minutes mm, and seconds ss.

If you do not specify the hours or minutes, the time period is assumed to be in seconds.

Discrete time scans are specified by adding the time plus offset to the default start time for the interface, which is midnight of the day the interface was started.

Note: Unlike other interfaces, the PI UFL interface supports only one scan class. If you specify multiple f flags, only the first one is recognized.

Examples:

• Time period scan class: /f=00:01:00 or /f=60

  Scans will occur every 60 seconds.

• Discrete time with offset: /f=00:01:00,00:00:05 or /f=60,5

  For an interface started at 05:06:06, scans start at 05:07:05, then occur at 05:08:05, 05:09:05, and so on.

/host=host:port

Required: The IP address or node name and port of the Data Archive.

Default is 5450. Examples:

/host=marvin

/host=marvin:5450

/host=206.79.198.30

/host=206.79.198.30:5450

/imt

Optional: Ignore missing points. Do not print error messages about missing points.

/lb

Optional: Laboratory mode. Write events to archive in bulk for efficiency (by default, events are sent one at a time) and suppresses exception reporting.

REM: default archive mode is ARCREPLACE.

/lbs

Optional: Laboratory mode. Write events to snapshot in bulk for efficiency (by default, events are sent one at a time) and suppresses the exception reporting.

/omf_clear

Clears the entries in the Windows Credential Manager for the corresponding service name and the Run-As account. To activate it, perform the following actions:

1. Stop the interface.

2. Add the /omf_clear command line option through the Additional Parameters input in ICU.

3. Start the interface.

4. Update the service-name.config file that is in the same directory as the interface executable, providing the desired username/password, or clientid/clientsecret, and restart the interface.

   Note: This parameter is only recognized when the interface is started as a service. After it finishes clearing the entries in the Windows Credential Manager, the interface service stops.

/perf=#

Optional: Specifies (in hours) how often performance summary information is written to performance counters.

Default: 8 hours

/ps=x

Optional: Specifies the point source for the points updated by the interface.

Not required by PI UFL interface. If configured, the interface loads only PI points with the specified point source.

/rbo

Optional: Read archive before writing value, to see if event already exists at same timestamp. Replace with a new value only if the value is different from existing value.

To enable this option, points must have Location5 set to 1, and neither the LB nor LBS flags can be configured. Does not work if values include annotation, which are written using the PI SDK.

/runonce

Optional: Process existing data and exit.

The ASCII file plug-in processes specified files and exits. For the POP3 plug-in, read and process emails and ASCII attachments and exit. Not applicable for serial port plug-in.

/tm=xxx*

or

/tm="xxx xxx*"

Optional: Tag mask. The interface loads all points matching this tag mask prior to run-time operation.

Useful when using the InstrumentTag attribute to identify target points to store data in, and you must limit the write operations to a subset of points. Wildcard characters are * or ?.

/uht_id=#

Optional: Enables different instances of the PI UFL interface to use different sets of health points.

The interface matches the numeric ID with the identifier configured in the Location3 attribute of the health points.

/utc

Optional: Incoming time stamps are UTC.

Note: If the date format is defined using SECONDS_GMT, you do not need to enable the /utc flag.

/wd=#

Optional: Write delay. This parameter specifies the write delay between bulk writes to the Data Archive, in milliseconds. The allowable range of values is between 0 and 10000. The default value if not otherwise specified is 10 milliseconds.

The parameter /wd is used to balance the workload on the Data Archive and the network. Also see the /ws parameter.

/ws=#

Optional: Write size. This parameter specifies the maximum number of values written in one (bulk) call to the Data Archive. The allowable range of values is between 1 and 102400. The default value if not otherwise specified is 10240 values.

The parameter /ws is used to balance the workload on the Data Archive and the network, for example, when loading files covering long time periods.