Command-line parameter reference

/abto =<#days>

(Optional) Specifies how long, in addition to the CACHETIME setting, the interface waits before closing a batch for which no end event has arrived. When an abandoned batch is closed, the interface uses the timestamp of its last event as the end time and logs an "Abandoned batch found" message. Default is 100 days, minimum is .042 days (approximately one hour), and maximum is 365 days.

/AFAUTOCHECKIN

(Optional) This setting specifies what behavior the interface should take if it encounters checked out Event Frames upon interface startup or reconnection. The options for this are:

• None: The interface will do nothing with checked out Event Frames on a restart/reconnection.

• Checkin: The interface will check in any checked out Event Frames on a restart/reconnection.

• Rollback: The interface will undo any checked out Event Frames on a restart/reconnection.

/bidm =<list>

(Optional) Override the incoming batch ID by selecting a substring. Specify one or more masks composed of text and wildcards, to be used to compose the desired batch ID from the contents of the source BatchID field. The resulting batch ID is used for the Batch ID field of the top-level procedure and for the [BATCHID] placeholder. By default, the batch ID field in unit procedures contain the full batch ID from the data source. To use the truncated batch ID instead, configure the TBID setting.

Valid wildcards are as follows:

For example, if the incoming Batch ID is: lot30112 / 90dev123 / 12345stp / ld567

The following list shows example masks and resulting data.

In the last example, the first and second masks do not match, so the third mask is used.

/cachetime=<days>

(Optional) Batches are cached in memory to enable the interface to capture events sent by the BES after the batch has closed. This setting specifies how long (in days) completed batches are cached. To specify fractions of a day, use decimal values. For example, /cachetime=7.5 releases completed batches when their end time is more than 7 days and 12 hours from the current time. The default value is 1 day, minimum is .042 days (approximately one hour), and maximum is 60 days.

/datasec=<string>

(Optional) Specifies the security settings to be assigned to interface-generated tags. For PI Data Archive 3.4.375.99 or earlier, use owner, group, world format. Example: /datasec="o:rw g:r w:r" For PI Data Archive 3.4.380.36 or later, specify an access control list (ACL). Example: /datasec="piadmin: A(r,w) | PIEngineers: A(r)"

/db =[#]

(Optional) Enabled debugging output:

• 0: Log only errors and warnings (default)

• 1: Log errors, warnings and major success messages

• 2: Log all messages (most verbose)

/dpretc

(Optional – event frames only) Disable propagation of referenced elements to children. By default, the interface propagates each event frame element reference to its children event frames.

/failoverID =<string>

(Optional) Configure a unique failover ID for the interface instance. Must be used with the /FailOverTag parameter.

Example: /FailOverID="intf1"

/failovertag =<tag name>

(Optional) Specifies the PI tag to be used to track the primary interface instance. Must be used with the /FailOverID parameter.

Example: /FailOverTag="Batch_FailoverTag"

/host =host:port

(Required) Specifies the PI Data server or PI Collective where data is to be stored. Host is the IP address or domain name of the server node. Port is the port number for TCP/IP communication. The port is always 5450.

Examples: /host=marvin /host=marvin:5450 /host=206.79.198.30 /host=206.79.198.30:5450

/id =<identifier>

(Required) Specify a one- to nine-number identifier for the interface instance. Assigned to the Location1 attribute of tags that are updated by the interface instance.

/includeincompletedata

(Optional) Enables the collection of all unit procedures without and associated UNIT. Without this option unit procedures that do not have phase state that associated with a particular UNIT will not be shown as events in PI AF.

/includelist=<list>

(Optional - For Siemens SIMATIC Batch only) Recover additional specified manufacturing orders during normal recovery.

This is primarily used to include specific long running manufacturing orders that start far earlier than the specified time range. Specify a comma-separated list of unique IDs for the manufacturing orders to be recovered.

Example: /includelist=MOKey#1, MOKey#2

/inifile =<path>

(Optional) Override the default location and name for the initialization file. By default, the .ini file resides in the interface installation directory and has the same file name and the .bat file.

/link =<AF element path>

(Deprecated, see /readlink and /writelink.) Combine event frames from different interface instances. Useful when you have an MES controlling multiple BESs. Configure an interface instance for each BES, specifying the same linkage element. The BES interface instances create event frame references under the MES event frames that refer to the BES interface instances. For Emerson Syncade systems, the AutomationBatchID field must match the batchID of the batch created by the BES.

/maxqtf =<days>

(Optional) Sets the maximum number of days for which a query can return data. Used to break a large query into a set of smaller queries, to ensure that the system doesn't run out of memory. The value can be fractional.

• Minimum: 0.001

• Maximum: 180

• Default: 30

/maxstoptime =<seconds>

(Optional) Specifies (in seconds) the maximum time allowed for the interface to properly shutdown. If shutdown takes longer than the specified time, the interface is forced to terminate immediately.

Default: 120 seconds

/merge

(Optional) Enable merging of multiple source batches with same ID. The original data for each batch merged is stored in PI properties under a node named using the ID of the original batch. The data includes the original batch ID, start time (UTC), end time (UTC), product and formula name. The interface merges only batches that are cached in local memory. The time frame for merging is configured using the /cachetime switch.

If the IDs of the batches you want to merge are different, use the /bidm flag to override incoming IDs.

Example: Given the following five batches running within the cache time frame:

• Test12345_1

• Test_12345_2

• CleaningTest

• USPO12345_test

• CleaningTest

  With merging enabled, only the Cleaningtest batches are merged. To merge the other three batches, which have IDs containing the string "12345", specify /bidm=#####.

/mode =<mode>

(Optional) Valid modes are as follows:

Realtime: (Default) Real-time data collection. If a recovery start time is specified (/rst), the interface recovers data before starting realtime collection.

Stat: Statistics mode. Compare source data with the corresponding PI System batch data. The interface does not write to or modify any data PI batch data. On completion, the interface reports results and stops.

Delete: Delete batch data from PI archives for specified period, leaving data from all other sources intact. Use only if the interface is unable to synchronize source batch data with the PI System. Must be used in conjunction with the recovery mode switches (/rst and /ret).

NoData: Newly-added tags, units and modules are indexed (referenced) in the primary PI archive, but older archives do not have entries for these modules, units and tags. In NoData mode, the interface creates modules, units, tags and tag aliases without processing batch data and writing events to the tags. To recover batch data for a period prior to the one in the primary archive, you must reprocess older archives with the offline archive utility. Manual archive reprocessing creates indexes for newly-added units, modules, tags. Always run the interface in this mode before writing new batch data to older PI archives (that is, archives other than the primary archive).

/mop

(Optional) Merge identically-named operations under the same parent unit procedure. The start time of the combined operation is the start of the earliest operation and the end time is the end time of the latest or longest operation that was merged.

/mup

(Optional) Merge identically-named sequential unit procedures running on the same unit into a single unit procedure. Unit procedures are not merged if the unit was used by another recipe between candidates for merging. The start time of the resulting merged unit procedure is the start of the earliest unit procedure, and the end time is the end time of the latest or longest unit procedure that was merged.

/ns[=lang] 1

(Optional) Perform numerical conversions using the specified language’s conventions. Useful when the numerical conventions differ from the default settings (for example, comma instead of decimal point).

Default = "English_UnitedStates"

Note: If you omit the language parameter, the interface uses the "Regional and Language Options" settings in effect for the interface node.1

/piconnto =<seconds>

(Optional) Override the default SDK setting for PI connection timeout.

/pidato =<seconds>

(Optional) Override the default SDK setting for PI data access timeout.

/pipswd =<password>

(Optional) Specify the user password to be used to connect to the PI Data Archive. By default, the interface uses PI trusts for authentication.

/piuser =<name>

(Optional) Specify the user name to be used to connect to the PI Data Archive. By default, the interface uses PI trusts for authentication.

/print =<filename>

(Optional) Prints the results of first scan to specified text file. The results include the batch tree, tag list, and equipment tree. Used for troubleshooting.

/ps =pointsource

Specifies the point source for the points maintained by the interface.

/ptsec =<string>

(Optional) Specifies the access security settings to be assigned to interface-generated tags. For PI Data Archive version 3.4.375.99 or earlier, use owner, group, world format.

Example: /ptsec="o:rw g:r w:r"

For PI Data Archive version 3.4.380.36 or later, specify an access control list (ACL). Example: /ptsec="piadmin: A(r,w) | PIEngineers: A(r)"

/readlink= <AFelementpath>

Combine event frames from different interface instances. For an MES controlling one or more BES systems, configure /readlink on the MES interface and configure an interface instance for each BES, specifying the same linkage element in the BES /writelink setting. The BES interface instances will then create event frame references under the MES event frames that refer to the BES event frames. For Emerson Syncade systems, the AutomationBatchID field must match the batchID of the batch created by the BES.

For a BES interface controlling one or more MES systems, configure /readlink on the MES interface and configure an interface instance for each BES, specifying the same linkage element in the BES /writelink setting. The MES interface will then create event frame references under the BES event frames that refer to the MES event frames. Link templates must also be configured to define which events specify a link.

/restef

(Optional) Enables an event frame with references to inherit security settings from its primary reference element.

/ret =<datetime>

(Optional) Specifies the end time for data recovery. The interface recovers batches that start before the specified time, including batches that end after the specified end time. Specify the time using the interface node format and time zone.

/retry =<seconds>

(Optional) Specifies how often the interface retries a failed attempt to write data.

Default: 60 seconds

/retryto =<seconds>

Specifies how long the interface retries a failed attempt to write data before timing out. By default, the interface never times out. If you configure a timeout setting, be advised that you risk losing data.

/rst =<datetime>

(Optional) Specifies recovery start time. The interface recovers batches that start after the specified time, as well as batches that start before the specified time but end after it. Specify the time using the interface node format and time zone.

/scan =<seconds>

(Optional) Specifies, in seconds, how often to scan the data source for new data. The default is 60 seconds. A scan that returns a large amount of data can cause the interface to skip the subsequent scan.

/singlerun

(Optional) Perform one scan and stop.

/smp ="equipment path"

(Optional) Specifies an alternate PI Module path or PI AF element path for a particular equipment hierarchy. By default, the interface scans starting at the root level. Use the following syntax:

\\<RootModule>\<SubModule>\<…>

/swaptime =<seconds>

(Optional) Specifies, in seconds, how long the current primary interface must be unavailable before failover occurs. Default: 300 seconds.

/tbid

(Optional) Use the truncated batch ID in the batch ID field of unit procedures. Incoming batch IDs are reformatted using the mask defined in the /bidm parameter.

/ts=GMT | LCL

(Optional) Specifies how the interface interprets event timestamps from an SQL data source. Options are local time or GMT.

Default = GMT.

/uidlist=<list>

(Optional) Recover specified manufacturing orders, then exit. Specify a comma-separated list of unique IDs for the manufacturing orders to be recovered. This parameter overrides any settings specified for the /rst and /ret recovery switches.

Example: /uidlist=MOKey#1, MOKey#2

/writelink= <AFelementpath>

Combine event frames from different interface instances. For an MES controlling one or more BES systems, configure /writelink on the MES interface and configure an interface instance for each BES, specifying the same linkage element in the BES /readlink setting. The BES interface instances will then create event frame references under the MES event frames that refer to the BES event frames. For Emerson Syncade systems, the AutomationBatchID field must match the batchID of the batch created by the BES.

For a BES interface controlling one or more MES systems, configure /readlink on the MES interface and configure an interface instance for each BES, specifying the same linkage element in the BES /writelink setting. The MES interface will then create event frame references under the BES event frames that refer to the MES event frames. Link templates must also be configured to define which events specify a link.