Data source parameters
- Last UpdatedJan 13, 2026
- 3 minute read
- PI System
- Adapter for DNP3 1.2
- Adapters
The data source configuration parameters are split into four main parent-level arrays:
-
MasterStationBehavior - Parameters defining the adapter's behavior as a DNP3 master station
-
OutstationBehavior - Parameters defining general behaviors of the DNP3 outstations
-
TCPChannel - Parameters defining connection information for a TCP channel
-
Outstation - Parameters defining the connection information for a specific outstation
TLS Configuration
When the adapter is initialized, a certificate directory is created adjacent to the configuration directory.
-
When running the adapter on Windows, the directory can be found at C:\ProgramData\OSIsoft\Adapters\DNP3\Certificates
-
When running the adapter on Linux, the directory can be found at /usr/share/OSIsoft/Adapters/DNP3/Certificates
The adapter administrator is responsible for adding certificates, and key files to this directory. TLS properties in the configuration referencing certificate and key files can specify either full path name or just the file name. If only the file name is specified, the adapter looks in the certificate directory.
The following parameters are available to configure a DNP3 data source:
|
Parameter |
Required |
Type |
Description |
|---|---|---|---|
|
streamIdPrefix |
Optional |
string |
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: DNP3-1.{OutstationId}.{DNPPointType}.{Index} Note: If you change the StreamIdPrefix of a configured adapter, for example when you delete and add a data source, you need to restart the adapter for the changes to take place. New streams are created on adapter restart and pre-existing streams are no longer updated. |
|
defaultStreamIdPattern |
Optional |
string |
Specifies the default stream ID pattern to use. An empty or null value results in the default value. Possible parameters: {OutstationId},{DNPPointType}, {Index}, {Group}, and {Variation}. Allowed value: any string |
|
linkStatusRequestInterval |
Optional |
number |
The time interval, measured in seconds, in which the adapter sends a DNP3 Link Status Request to each configured data source when operating in warm failover mode. These periodic requests allow the adapter to confirm that TCP channels and outstations remain reachable, ensuring accurate device status reporting during failover scenarios. Note: This parameter works only with warm failover. Default value: 60 |
|
tlsClientPublicKey |
Optional |
string |
The file name or full path of the unencrypted Privacy Enhanced Mail (PEM) file that contains the certificate the adapter presents to the peer. |
|
tlsClientPrivateKey |
Optional |
string |
The file name or full path of the PEM file containing the encrypted or plaintext private key corresponding to the public key in the presented certificate. Only PKCS #8 v2 encrypted files are supported. |
|
tlsPrivateKeyPassword |
Optional |
string |
Password used to decrypt the private key file. If the file is not encrypted, leave this field empty. |
|
masterStationBehaviors |
Optional |
array |
A main configuration list that sets how the adapter works as a DNP3 master station. The parameter configures communication characteristics and reliability settings for the master station role in DNP3 protocol operations. |
|
outstationBehaviors |
Optional |
array |
Defines reusable behavior profiles for DNP3 outstations. This parameter configure operational characteristics for outstations, such as time synchronization, unsolicited message handling, and integrity/event scans |
|
tcpChannels |
Optional |
array |
Defines the TCP/IP communication channels used to connect the DNP3 master station to one or more outstations. The parameter manages TCP-based connections between the master station and outstations. |