OPC UA Client Endpoint Properties

nodeId (string)

String of the exact location of the endpoint. Either nodeId or browsePath are required. A nodeId value is encoded as an xs:string with the syntax ns=<namespaceIndex>;<type>=<value>. The fields have the following meaning: <namespaceIndex> is an integer number such as 0 or 10, denoting the namespace. <type> is a flag that specifies the identifier type and can be: i for numeric (integer), s for string, g for guid, or b for opaque (byte string). <value> is the identifier itself, encoded as a string and in the format according to the identifierType. Examples of nodeIds: i=13 , ns=10;i=-1 , ns=10;s=Hello:World . See also https://reference.opcfoundation.org/v104/Core/docs/Part6/5.3.1 section 5.3.1.10

Examples: "i=2258", "ns=2;s=StepUp"

browsePath (string)

String containing the relative path to the endpoint. Either nodeId or browsePath are required.

Examples: "0:CurrentTime", "2:StepUp"

nodeType (string, enum)

The node type: Whether the node is a variable, object or method. For methods, this property is mendatory.

This element must be one of the following enum values:

• Object

• Variable

• Method

fields (array)

array of browsenames to variables defined in the Eventtype

The object is an array with all elements of the type string.

Additional restrictions:

• Unique items: true

eventTypes (array)

lists node ids of OPC UA defined eventtypes in the server namespace as nodeId definition strings

The object is an array with all elements of the type string.

Additional restrictions:

• Unique items: true

browsePathPrefix (string)

Optional, can be used to set a prefix for the browsePath. Both strings will be concatenated using a forward slash /.

publishInterval (integer)

Time interval (in milliseconds) in which the server should publish its node values within the subscription (but in any case the actual value updates are published usually only on change of values).

Default: 1000

samplingInterval (integer)

Time interval (in milliseconds) in which the published values from the server should be sampled for a particular node subscription. All nodes (=monitored items) with the same samplingInterval will be combined into one monitored item group.

Default: 1000

maxNotificationsPerPublish (integer)

Sets the maximum number of monitor notifications that are in a single publish message of the OPC UA subscription. Setting this to a lower value will lead to more network traffic.

Default: 100

priority (integer)

Default: 10

requestedLifetimeCount (integer)

Default: 30

requestedMaxKeepAliveCount (integer)

Default: 10

retryMonitorTimeout (integer)

Default: 300000

Additional restrictions:

• Minimum: 10000

trigger (string, enum)

Data change filter option for monitoring - the type of data change that triggers the server to send data change notifications.

This element must be one of the following enum values:

• Status

• StatusValue

• StatusValueTimestamp

deadbandType (string, enum)

Data change filter option for monitoring - the type of deadband to apply to the value changes

This element must be one of the following enum values:

• None

• Absolute

• Percent

deadbandValue (number)

Data change filter option for monitoring - the value of the deadband to apply to the value changes.