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

Adapter Configuration Utility

OPC UA

  • Last UpdatedJun 24, 2026
  • 3 minute read

Configure the OPC UA data source to let the adapter connect to your OPC UA server, browse nodes, and collect data from selected variables.

Required parameters

The following parameters are required to configure the OPC UA data source:

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

Optional parameters

The following parameters are optional to configure the OPC UA data source:

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: 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.

Default Stream Id Pattern

Specifies the default StreamId pattern to use.

For example, {NamespaceIndex} 1 , {Identifier}.

Use Secure Connection

Select the check box to have the adapter connect to a secure endpoint using OPC UA certificate exchange operation..

Otherwise, 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.

User Name

User name for accessing the OPC UA server.

Password

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.

Server Failover Enabled

Select the check box if you want to enable server-side failover.

Backup Endpoint Urls

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

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

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

Incoming Timestamp

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.

    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.

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 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 in the OPC UA user guide. Changing the mode requires a restart of the adapter component.

Default Event Stream Id Pattern

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

Example: {EventTypeNamespaceIndex}3 , {EventTypeIdentifier},{EventTypeDisplayName}

In This Topic
Related Links
TitleResults for “How to create a CRG?”Also Available in