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

Adapter Configuration Utility

RDBMS

  • Last UpdatedJun 24, 2026
  • 3 minute read

Select on the Optional Settings tab to configure additional data sources for the RDBMS adapter.

Parameter

Description

Stream Id Prefix

Specifies what prefix is used for stream Ids. The naming convention is {StreamIdPrefix}{StreamId}. An empty string means no prefix will be added to the stream Ids and names. A null value defaults to ComponentId followed by a period.

Example: RDBMS1.TBD

Note: If you change the StreamIdPrefix of a configured adapter (like when you delete and add a data source), you must restart the adapter for the changes to take place. New streams are created on adapter restart and pre-existing streams are no longer updated.

Default Stream Id Pattern

Specifies the default stream Id pattern to use. An empty or null value results in the default value. For example, QueryId, ValueColumn, SelectValue, SelectColumn, and SourceId.

Note: {SourceId} in the DefaultStreamIdPattern evaluates the same as SourceId in the stream metadata. For selection items with a non-empty SelectValue, {SourceId} is equivalent to {QueryId}.{SelectValue}.{ValueColumn}. For selection items with an empty SelectValue, {SourceId} is equivalent to {QueryId}.{ValueColumn}.

Secondary Connect String

The connection string that points to the secondary or backup server. This value is required if enableServerFailover is set to true.

Windows User

Optional username to use with Windows Authentication.

Note: You must add your domain to the WindowsUser.

Example: DomainName\\UserName

Note: The user should be configured to have the minimum permissions needed to read the desired data from your database. It is not recommended to use an admin user or even a user with write permissions.

Windows Password

Optional password to be used with Windows Authentication.

Command Timeout

Optional timeout for running queries on the data source. The required format for this parameter is HH:MM:SS.###

Request Interval

Specifies the query interval for history recovery. This will be used to replace the ?ST? and ?ET? parameters in your query.

For example, if the Request Interval is set to 01:00:00, the difference between ?ST? and ?ET? in each query will be 1 hour. For more information, see also Automatic history recovery and Configure queries in the RDBMS user guide.

Max History Events Per Second

Specifies the maximum number of events per second that the adapter will collect during history recovery.

This can be used to limit the adapter to prevent overwhelming the data source or network. Setting this property to 0 allows historical data to be collected without throttling.

UTC

Select the check box if timestamps from the data source should be interpreted as UTC time.

If the check box is not enabled, local time relative to the adapter is assumed.

Data Collection Mode

Specifies the data collection mode the adapter is in. The following data collection modes are available:

  • HistoryOnly - The adapter component does not get started and history recovery on-demand is enabled. For more information, see On-demand history recovery configuration.

  • CurrentOnly - The adapter component operates normally and on-demand history recovery is disabled.

  • CurrentWithBackfill - The adapter component operates normally, but will automatically recover intervals during the Shutdown device status. History recovery backfills data once device status is good. On-demand history recovery is disabled. For more information, see Automatic history recovery.

    Changing the mode requires a restart of the adapter component.

Enable Server Failover

Select the check box if the server-side failover should be used.

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