Configure a data source
- Last UpdatedJul 02, 2026
- 5 minute read
Adapters collect data from external systems, referred to as data sources, and deliver that data to downstream endpoints for processing and storage. Each adapter is designed to connect to a specific type of data source—such as files, databases, devices, or APIs—and therefore requires its own set of configuration settings to establish and manage that connection.
The Data Source Quick Start page allows you to configure the connection and data collection settings adapter component's data source.
When setting up a data source using Quick Start, it is only necessary to provide required data source parameters. Refer to the sections below for your adapter and the corresponding required parameters. You can also set up optional data source configurations for your adapter.
After you configure your data source, select Next to configure data selection.
Azure Event Hubs required parameters
The following parameters are required to configure the Azure Event Hubs data source. To review the optional data source configuration, see Azure Event Hubs.
|
Parameters |
Description |
|---|---|
|
Event Hub Namespace Connection String |
The connection string for the Event Hub namespace. |
|
Blob Storage Connection String |
The Azure Blob Storage account connection string used to save event hub checkpoints. |
|
Consumer Group Name |
The consumer group name that the adapter should use to establish a connection with Azure Event Hub. Note: The maximum allowed value for this parameter is 246 characters. |
|
Checkpoint Blob Container Name |
Name of the blob storage container used for checkpoint storage. Note: Per Azure restrictions, the name must be at least three character but no longer than 63. It should contains only letters, numbers, and dash characters, such as the hyphen ( - ) or em dash ( — ). When using Azure Blob Storage as a checkpoint store, Microsoft recommends the following:
|
BACnet required parameters
The following parameter is required to configure the BACnet data source. To review the optional data source configurations, see the BACnet optional parameters.
|
Required parameter |
Description |
|---|---|
|
Ip Address |
IPv4 address of BACnet device or BACnet router. |
DNP3 required parameters
The following parameters are required to configure the DNP3 data source. To review the optional data source configurations, see the DNP3 optional parameters.
|
Array |
Required parameters |
Description |
|---|---|---|
|
Master Station Behaviors |
Id |
Friendly identifier for the configuration. Must be unique among all MasterStationBehaviors. |
|
Master Address |
Address that the adapter uses when communicating on a channel. Must be an available address on the channel. Outstations can be configured to accept connections from this address. |
|
|
Outstation Behaviors |
Id |
Friendly identifier for the configuration. Must be unique among all Outstation Behaviors. Descriptions for the additional parameters can be found in the DNP3 - Outstation Behaviors section. |
|
TCP Channels |
Master Station Behavior Id |
Must match the Id of one of the configurations in the MasterStationBehaviors list. |
|
Host Name or Ip Address |
IPv4 address or hostname that can be resolved to an IPv4 address. The adapter establishes a connection to this address. |
|
|
Port |
TCP port that the outstations are listening on. |
|
|
Outstations |
List of outstations that the adapter connects to on the TCP Channel. Note: A TCPChannel is uniquely identified by the combination of its Host Name Or IP Address and Port properties. For valid configuration, each TCP Channel must have a unique combination of these properties. |
Configure the following required parameters to add an outstations for the TCP Channels array:
|
Parameter |
Description |
|---|---|
|
Id |
Friendly identifier of the outstation. Must be unique among all channels and Outstations. Can be referenced by a data selection item. |
|
Dnp Address |
Address of the Outstation on the channel. This is a 2-byte, unsigned integer. |
|
Outstation Behavior Id |
Must match the Id of one of the configurations in the OutstationBehaviors array. |
Modbus TCP required parameters
For Modbus TCP, the Devices parameter is the primary required configuration element for the data source. Devices specify the Modbus TCP devices that the adapter connects to when collecting data from this data source.
The following parameters are required to configure the Devices parameter for the Modbus TCP data source. To review the optional data source configurations, see the Modbus TCP optional parameters.
|
Required parameters |
Description |
|---|---|
|
Id |
The ID of the device that is used in data selection to associate a register with a device. |
|
Ip Address |
The IP address or hostname of the device from which the data is collected using the Modbus TCP protocol. |
MQTT and MQTT Sparkplug B required parameters
The following parameter is required to configure the MQTT or MQTT Sparkplug B data sources. To review the optional data source configurations, see the MQTT optional parameters.
|
Required parameter |
Description |
|---|---|
|
Host Name or Ip Address |
The host name or IP address of the MQTT server. |
OPC UA required parameters
The following parameter is required to configure the OPC UA data source. To review the optional data source configurations, see the OPC UA optional parameters.
|
Required parameter |
Description |
|---|---|
|
Endpoint URL |
The endpoint URL of the OPC UA server in opc.tcp format. For example: opc.tcp://172.28.0.1:62541/OSIsoftTestServer |
RDBMS required parameters
The following parameters are required to configure the RDBMS data source. To review the optional data source configurations, see the RDBMS optional parameters.
|
Required parameters |
Description |
|---|---|
|
Connect String |
Connection string to connect to the data source through the DataProvider. This string is encrypted when stored, so secrets such as passwords are safe to use in this string |
|
Data Provider |
Indicates which Data Provider the adapter should use to connect to the data source. Valid values are SQLServer or ODBC. Note: When connecting to Microsoft SQL Server, use SQLServer. When connecting to another relational database through ODBC, use ODBC. The SQLServer data provider does not require any additional software, but the ODBC data provider requires an ODBC driver. |
Structured Data Files required parameters
The following parameters are required to configure the Structured Data Files data source. To review the optional data source configurations, see the Structured Data Files optional parameters.
|
Required parameters |
Description |
|---|---|
|
Input Directory |
Location of the source files to process. FTP servers are not supported. Note: For the adapter to process data, the adapter service account must have read, write, and delete permissions for the input directory. |
|
Output Directory |
Location for the files to be moved to after being processed. FTP servers are not supported. Note: For the adapter to process data, the adapter service account must have read, write, and delete permissions for the output directory. |