Data source parameters

endpointURL

Required

string

The endpoint URL of the OPC UA server in opc.tcp format. For example:

opc.tcp://OPCServerHost:Port/OpcUa/SimulationServerNote:

If you change the EndpointURL on a configured adapter that has ComponentID_DataSelection.json file exported, you need to remove the ComponentID_DataSelection.json file from the configuration directory to trigger a new browse (export).

Allowed value: well-formed opc.tcp address

useSecureConnection

Optional

boolean

When set to true, the adapter connects to a secure endpoint using OPC UA certificate exchange operation..

When set to false, the adapter connects to an unsecured endpoint of the server and certificate exchange operation is not required.

Note: We recommend setting this option to false for testing purposes only.

Allowed value: true or false
Default value: true

userName

Optional

string

User name for accessing the OPC UA server. Allowed value: any string Default value: null

password

Optional

string

Password for accessing the OPC UA server.

Note: We recommend using REST to configure the data source when the password must be specified because REST will encrypt the password. If you do not use REST, the plain text password will be stored on-disk.

Allowed value: any string Default value: null

incomingTimestamp

Optional

string

Specifies whether the incoming timestamp is taken from the source, from the OPC UA server, or should be created by the adapter instance.

Source - Default and recommended setting. The timestamp is taken from the source timestamp field. The source is what provides data for the item to the OPC UA server, such as a field device.

Server - In case the OPC UA item has an invalid source timestamp field, the Server timestamp can be used.

Adapter - The adapter generates a timestamp for the item upon receiving it from the OPC UA server.

Allowed value: Source, Server, or Adapter

Default value: Source

Note: We recommend using Server or Adapter when polling data from the data source where the source timestamp does not change frequently. This ensures that you will see an updated timestamp on the data endpoint.

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: OpcUa1.{NamespaceIndex}.{Identifier}

Note: Every time 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.

Allowed value: any string
Default value: null

defaultStreamIdPattern

Optional

string

Specifies the default StreamId pattern to use.

Possible parameters: {NamespaceIndex} 1 , {Identifier}.

Allowed value: any string
Default value: {NamespaceIndex}.{Identifier}

defaultEventStreamIdPattern

Optional

string

Specifies the default StreamId pattern to use for Event streams. This is only applicable when working with Event Types for Alarms and Conditions.

Possible parameters: {EventTypeNamespaceIndex}3 , {EventTypeIdentifier},{EventTypeDisplayName}

Allowed value: any string

Default value:

Events.{EventTypeNamespaceIndex}3.{EventTypeIdentifier}.{EventTypeDisplayName}

dataCollectionMode

Optional

string

Specifies the data collection mode the adapter is in.

The following data collection modes are available:

• HistoryOnly 2 - 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 2 - The adapter component operates normally, but disconnections are recorded based on 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.

serverFailoverEnabled

Optional

boolean

Specifies whether to use server-side failover.

Allowed value: true or false
Default value: false

backupEndpointUrls

Optional

string

An optional list of Endpoint URLs for servers that the adapter should use as the server-failover redundancy set.

If configured, the adapter creates the redundancy set by using the endpoints specified here as well as the one in the endpointURL above.

If not configured, the adapter gets the redundancy set from the server specified in endpointURL.