OPC-UA-Read node

Use the OPC-UA-Read node to read OPC UA data from your OPC UA Server.

Purpose

Use the OPC-UA-Read node to connect your OPC UA Server to your IBM® Integration Bus applications that require tag data from the OPC UA Server. When the OPC-UA-Read node is driven by an input node, the OPC-UA-Read node connects and reads data from the OPC UA Server.

The OPC-UA-Read node is contained within the Manufacturing drawer of the message flow palette, and is represented in the IBM Integration Toolkit by the following image:

OPC-UA-Read node

Using the OPC-UA-Read node in a message flow

The OPC-UA-Read node is a mid-flow node.

In the Properties view, specify the OPC UA Server that you want to connect to, and the tags for which you want to receive data.

For any tags that you add to the Tags property, the node outputs data in an XML format. To access or update the values under TagData, you must address it with its namespace. For more information, see XML schema.

If you wire the InvalidTags terminal, a message is sent from the InvalidTags terminal that contains information about any tags that could not be read and another message is sent from the Out terminal about any tags that could be read. If you do not wire the InvalidTags terminal and any of the specified tags could not be read, an exception is thrown and no message is sent from the Out terminal.

You can route or transform this data by using the nodes that are in the IBM Integration Toolkit palette. For example, you can publish the data by using an MQTTPublish node, and then subscribe to the data by using an MQTTSubscribe node, see MQTTPublish node and MQTTSubscribe node.

Configuring the OPC-UA-Read node

Configure the OPC-UA-Read node by modifying the properties.

All mandatory properties for which you must enter a value (properties that do not have a default value defined) are marked with an asterisk in the user interface.

To discover your tags, enter your server name then click Discovery or add them manually.
Restriction: Do not specify tag containers or folders, because these elements result in no data in the TagData output.

Security

To configure keystores, truststores, passwords, and certificates to enable SSL communication, you can set up a public key infrastructure (PKI) at integration node level, see Setting up a public key infrastructure in the IBM Integration Bus documentation.

Terminals and properties

The OPC-UA-Read node terminals are described in the following table.
Terminal Description
In The input terminal that accepts a message for processing by the node.
Failure The output terminal to which a message is routed if an error occurs during processing.
InvalidTags The output terminal to which a message that contains information about any tags that could not be read is routed.
Out The output terminal to which any successful tag readings are routed.

The following tables describe the node properties. The column headed M indicates whether the property is mandatory (a mandatory property is marked with an asterisk if you must enter a value when no default is defined); the column headed C indicates whether the property is configurable (you can change the value when you add the message flow to the broker archive (BAR) file to deploy it).

The Description properties for the OPC-UA-Read node are described in the following table.
Property M C Default Description
Node name Yes No The node type, OPC-UA-Read. The name of the node.
Short description No No   A brief description of the node.
Long description No No   Text that describes the purpose of the node in the message flow.
The Basic properties for the OPC-UA-Read node are described in the following table.
Property M C Default Description
Server Yes Yes The TCP/IP connection for the destination application, in the form opc.tcp://host_name:port/UAServer_name, where host_name is the fully qualified name of the host, port is the number of the port, and UAServer_name is the name of the OPC UA Server.
Note: You must use the exact discovery endpoint URL as specified on the OPC UA Server.
Tags Yes Yes   The browse paths of the tags that contain the data that you want to receive. You can add and delete tag values.

You can discover tags from your OPC UA Server. For more information, see Selecting tags to use in your message flows.

You can add multiple tags by using a comma separated list of values.

The Security properties for the OPC-UA-Read node are described in the following table.
Property M C Default Description
SSL client authentication key alias No Yes   This property specifies an SSL authentication alias for the client-side of an HTTP connection. SSL client authentication key alias must be set to a valid key in the keystore.
Message security No Yes None The type of message security. The following values are available:
  • None
  • Sign
  • Sign And Encrypt
Security policy No Yes None The name of the security policy. The following values are available:
  • None
  • BASIC128RSA15
Message encoding No No Binary The type of message encoding. The following value is available:
  • Binary
The Advanced properties for the OPC-UA-Read node are described in the following table.
Property M C Default Description
Output location No Yes Message The location for the output data. The following locations are available:
  • Message. This option replaces your message headers and body with the TagData.
  • LocalEnvironment. This option writes the data to LocalEnvironment/Variables, and preserves your message unchanged.
Notices | Trademarks | Downloads | Library | Support

Copyright IBM Corporation 2016 Copyright IBM Corporation 2016.

		
		Last updated
		
	Last updated : 2016-07-30 06:30:51


Reference topicReference topic | Version 1.0.0.2 | ma00460