Learn about command line parameters for PI Interface for RDBMS

/BAD1= #

Default: 0 (Optional)

The beginning of the range in the system digital state table that contains Bad Input status strings.

/BAD2= #

Default: 0 (Optional)

The end of the range in the system digital state table that contains Bad Input status strings.

/DEB= #

Default: 1 (Optional)

Set logging (debugging) level. The message in the file is prefixed with the [DEB- # ] marker where # is the debug level. Error and warning messages are always printed, regardless of logging level. Use with caution, as verbose logging can bloat log files.

Valid levels:

• 0: No debug output.

• 1: (Default) Log information about the interface operation, PI and ODBC connections, defined SQL queries, actions taken during the ODBC link re-creation, output tags recovery, and so on.

• 2: Informs about events deleted from Data Archive. See section Full synchronization of time series from RDB tables to PI Data Archive for more details.

• 3: Log raw values received by ODBC fetch calls per tag and scan, to help trace data type conversion issues.

• 4: Log the actual values just before sending them to the PI System.

/CLOSE_LINK= #

Optional

Defines the timeout of "execution inactivity" in seconds after which the ODBC link gets closed. The ODBC link will automatically be reopened before the consequent SQL statement execution.

If the timeout is shorter than the period between the individual executions, the ODBC connection will remain open as if this parameter was not specified.

/DOPS

(Optional)

Enables the interface to distribute events to tags with point sources other than the point source configured for the instance.

By default, rows with tag names that are different from the point source are skipped. Applies only to the tag distribution and RxC strategies. Does not process any alias configured in the ExDesc tag attribute.

/DSN= dsn_name

(Required)

ODBC data source name. If the interface is installed as a Windows service, you must specify a SYSTEM data source, not a FILE data source. On 64-bit operating systems for 32-bit RDBMSPI, the DSN must be configured using the 32-bit ODBC Administrator, which is located in the following directory:

%systemroot%\syswow64\odbcad32.exe

For 64-bit RDBMSPI, use the 64-bit ODBC Administrator:

%systemroot%\system32\odbcad32.exe

/EBR

(Optional)

Exit if network problem occurs, do not loop trying to reconnect. By default, the interface attempts to reconnect once a minute.

If Windows Services Recovery is enabled, the operating system automatically restarts the interface and the interface performs history recovery to collect any missed data.

This approach avoids event queue overflow if the RDBMS is unavailable for long time. However, output recovery reads compressed values from the archive, not snapshots, which means that fewer events are forwarded than during normal data collection.

/ERC= #

(Optional)

Configures the interface to close all ODBC statements and attempt to re-create the whole ODBC link if the specified number of consecutive errors occurs. Implemented because of the inconsistent behavior of some ODBC drivers with regard to error codes returned.

/ExecDirect

(Optional)

Execute queries using direct execution. If this option is enabled, all SQL statements are prepared and bound before each execution. By default, queries are prepared and bound once.

/Failover_Timeout= #

(Optional)

Specify query timeout: fail over to secondary RDBMS if query execution takes longer than the specified time.

/Global= FilePath

(Optional)

Specify the file that contains the definitions of the global variables. (Optional)

/HOST= host:port (Required)

Specifies the host and port of the PI Server to which the interface sends data.

• Host: Node name of the host node

• Port: 5450

/Ignore_Nulls

(Optional)

Do not write the No Data system digital state for tags populated through the tag group and RxC distribution strategies. By default, the interface writes the No Data state if the value column is null.

/LB

(Optional)

Bulk-write events to the archive. More efficient than per-event writing, which is the default, but exception reporting is not performed.

/MaxLog= #

(Optional)

Specifies the maximum number of log files. When the specified number of files has been created, the interface starts overwriting the oldest log files. By default, there is no limit on the number of log files.

/MaxLogSize= #

Default: 20 (Optional)

Maximum size of the log file in MB. When the log file grows to the specified maximum, a new log file is created.

/No_Input_Error

(Optional)

Suppresses writing IO_TIMEOUT and BAD_INPUT status for input tags when a runtime error occurs or the ODBC connection is lost. By default, the interface writes I/O Timeout and uses the current time as the timestamp. Ensures that the interface can use the last timestamp to recover data written after the last scan.

/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:

• Stop the interface.

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

• Start the interface.

• 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.

/OOO_Option=" optionlist"

(Optional)

For output tags, specifies what kind of out-of-order events trigger SQL query execution. Valid options are append, replace and remove. Specify multiple options as a comma-separated list; for example:

/OOO_Option="append,replace"

The remove option functions only during interface startup, not during normal operation.

/Output= UNC_Path

(Required)

Specify the interface log file name, including its full path. If the path contains spaces, specify the argument in double quotes.

/Output= "c:\program files\...\rdbmspi.log "

To avoid overwriting log files from previous sessions, the interface renames the previous log file to log-file.log;n during startup. To conserve disk space, periodically delete old log files.

/Pass_ODBC= password

(Optional)

Specify the password for the ODBC connection. If no password is configured, the user is prompted to enter it before the interface connects to the data source. The password is encrypted and stored locally. To ensure that the password file is loaded, start the interface interactively before configuring it as a Windows service. If the RDBMS does not require a username/password login (for example Microsoft Access), configure a dummy password.

Note: This parameter is obsolete and AVEVA does not recommend storing passwords in plain text in the interface startup file.

/RBO

(Optional)

Read Before Overwrite: Overwrite existing event with same timestamp only if the new value is different. Tag must have Location5 set to 1 or 2.

• If RBO is enabled, Loc5=1 or Loc5=2, and the incoming value from the interface is the same as the one in the archive, it will be discarded.

• If RBO is enabled, Loc5=1, and the incoming value from the interface is different from the one in the archive, the value is substituted. It is sent to PI with write mode = ARCREPLACE.

• If RBO is enabled, Loc5=2, and the incoming value from the interface is different from the one in the archive, the value is appended; it will be sent to PI with write mode = ARCAPPEND

/Recovery_Step= # unit

Default: 1d (Optional)

To manage workload when performing input recovery, specifies the length of time for each chunk that is to be recovered. Specify as a number following by unit (d=days, h=hours, m=minutes, s=seconds). Default is one day. Examples:

• 10d

• 5h

• 30m

/Recovery_Time=start-time [,end-time ]

/Recovery_Time=start-tag [, end-tag]

(Optional)

For recovery, specifies the oldest (and, optionally, the most recent) timestamp to be retrieved from the archive. Specify absolute or relative time in PI System format. Enclose in double quotes if the string contains spaces. You can use PI tags to specify start and end times.

Examples:

/Recovery_Time="*-8 h"

/Recovery_Time=*-1d

/Recovery_Time=*-1h,*

/Recovery_Time="01-Jan-05 15:00:00, 31-Jan-05 15:00:00"

/Recovery= option

Default: NO_REC (Optional)

Specifies how to handle output tags during start- up, if recovery is enabled. Valid options are as follows:

• TS: Depends on how out-of-order recovery is configured for tag:

  • Location5=0: Perform in-order recovery .Starts the recovery from

  • /Recovery_Time="stime time"

  • or from the last snapshot of the output tag, whichever is later.

  • Location5=1: Perform enhanced out-of-order recovery. Recovery starts from the time specified by

  • /Recovery_Time

  • and the interface compares the source and output tag values looking for additions, changes and deletions to the SourceTag. The

  • /OOO_Option

  • parameter specifies the types of SourceTag modifications that are to be processed.

• NO_REC: No recovery is performed (Default)

  Note: Editing an output tag triggers recovery for the tag.

/SQL= Filepath

(Optional)

Specifies the location of the SQL statement files. If there are spaces in the file path, specify it in double quotes. If this parameter is omitted, the interface requires the query to be specified in the ExDesctag attribute.

/SUCC1= #

Default: 0 (Optional)

Specifies the beginning of the range in the system digital state table that contains the "OK value" strings.

/SUCC2= #

Default: 0 (Optional)

Specifies the end of the range in the system digital state table that contains the "OK value" strings.

/SYNC_TIME= start time, end time

(Optional)

Defines the relative start and end-times for the full synchronization mode. See section Full synchronization of time series from RDB tables to PI Data Archive for more details.

/User_ODBC= username

(Optional)

Specifies the username for the ODBC connection. If the RDBMS does not require login (for example, Microsoft Access), specify a dummy username.

/UTC

(Optional)

Handle timestamps using the Universal Time Coordinated (UTC) format.

/WD= #

Default: 10 (Optional)

If bulk writing (/LB) is enabled, how many milliseconds, to wait between bulk writes to the archive. Used for performance tuning.

/WS= #

Default: 10240 (Optional)

If bulk writing (/LB) is enabled, the maximum number of values writing in a single bulk write to the archive. Used for performance tuning.