PI-Read node

Use the PI-Read node to read tag data from your PI Server. The data is emitted from the node in the form of an XML message that conforms to the TagData.xsd schema.

You can deply the PI-Read node on Windows only.

The PI-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:

Before you can use the PI-Read node, you must install a supported version of the PI SDK, see OSIsoft and IBM Integration Bus system requirements.

Before you can connect your integration server to your PI Server, you must configure your PI Server to trust your integration server. To configure the PI Server, click PI System Management Tools > Security > Mappings and Trusts > Trusts and add an entry for the DataFlowEngine.exe file.

The PI-Read node is a mid-flow node.

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.

In the Properties view, specify the PI connection that you want to use, 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.

You can route or transform the 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.

Configure the PI-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.

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 in the user interface 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).