Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

PI Interface for Relational Database RDBMS via ODBC

Optional parameters tab for PI Interface for RDBMS

  • Last UpdatedAug 19, 2025
  • 2 minute read

Field

Description

Close ODBC link (seconds)

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. (/CLOSE_LINK=<seconds>)

REM: this setting only works when Direct SQL Execution is enabled.

Synchronization time interval

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. (/SYNC_TIME=<+/- time interval>)

Maximum Log (# of Files)

Maximum number of log files in the circular buffer. The interface starts overwriting the oldest log files when the MAXLOG has been reached. By default, log files are never overwritten. (/MaxLog=#, Optional)

Maximum Log File Size (MB)

Maximum size of the log file in MB. If this parameter is omitted, the default maximum is 20 MB. (/MaxLogSize=#, Default: 20, Optional)

Consecutive Errors to Reconnect

Number of consecutive errors that causes the interface to deallocate all ODBC statements and attempt to reconnect to the RDBMS. (/ERC=#, Optional)

Failover Timeout (seconds)

Specifies how long to wait for query results to return before failing over to the backup copy of the interface. (/Failover_Timeout=#, Optional)

Direct SQL Execution

All SQL statements are prepared, bound and executed each time they are scheduled for execution. By default, statements are prepared and bound only once, before the first execution.

/ExecDirect

Optional

Laboratory Caching

Bulk-write events directly to the archive. When this option is enabled, the Location5 setting is ignored. Event handling is faster when this option is enabled, and archive mode is ARCREPLACE. (/lb, Optional)

Times are UTC

Handle timestamps as UTC. If the timestamps in the RDBMS are stored in UTC format, you must enable this setting. (/UTC, Optional)

No Input Errors

Disable writing of the BAD_INPUT, IO_TIMEOUT digital states when an error occurs.

/NO_INPUT_ERROR

Optional

Read Before Overwrite

Check the archive to see if value already exists at the same timestamp. If so, do not overwrite with new value. Affects points where Location5=1 or Location5=2.

/RBO

Optional

Exit Before Reconnect

Exit if connection error occurs. By default, the interface tries to reconnect. (/EBR, Optional)

Distribute Outside Point Source

Enable interface to update points with point source other than the one configured for the interface instance. (/DOPS, Optional)

Ignore Nulls

Ignore events retrieved from the RDBMS if value is NULL. Prevents writing of the "No Data" system digital state for tag group and RxC distributions when the value column is NULL. (/Ignore_Nulls, Optional)

Scan Class - I/O Rate Tag

Configure an I/O rate tag and assign a scan class to it. (/TF, Optional)

TitleResults for “How to create a CRG?”Also Available in