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

PI Connector for OPC UA Gen 2

Transformational Rules

  • Last UpdatedJun 10, 2025
  • 3 minute read

The following table provides detail on settings for transformational rule options:

Settings

Definitions

SourceId Pattern

[ datasource.ns.identifier ]

This pattern defines a new unique identifier for an OPC UA variable that is used as a PI Point name. The SourceId Pattern defines a combination of the following keywords that are dynamically populated on runtime:

  • datasource will be replaced by the name of the data source defined in the connector

  • ns will be replaced by the NameSpaceIndex part of a NodeId of an OPC UA variable

  • identifier will be replaced by the Identifier part of a NodeId of an OPC UA variable

  • path will be replaced by the path to the variable from an OPC UA hierarchy

    Example 1:

    Defined SourceId Pattern: datasource.ns.identifier

    Data source: TestDS

    NodeId: ns=5;s=Boiler1Temperature

    Result (PI point name): TestDS.5.Boiler1Temperature

    Example 2:

    Defined SourceId Pattern: datasource.path

    Data source: TestDS

    OPC UA hierarchy path: Boilers\Boiler1 Variable DisplayName: Temperature

    Result (PI point name): TestDS.Boilers.Boiler1.Temperature

    Note: When, as in the Example 2, the SourceId Pattern contains just the path keyword, the resulting PI point name will not contain the variable NodeId at all. This is useful in cases when the NodeId is numeric, GUID or even ByteString.

Object Separator

Some OPC UA servers express the hierarchical structure of their underlying systems in a string form. This delimited string is usually placed in the DisplayName attribute of an OPC UA variable.

If this is true, the Variable Separator allows for parsing the DisplayName and building a PI AF hierarchy. When left empty, no parsing of the DisplayName occurs and the PI AF hierarchy is built out of the OPC UA hierarchy.

Example:

DisplayName: Factory|Boilers|Boiler1.Temperature

Object Separator: |

Result (AF hierarchy): Factory\Boilers\Boiler1

Variable Separator

Variable Separator is used to identify a variable name in a DisplayName string.

Note: See the description of the Object separator.

Example:

DisplayName:

Factory|Boilers|Boiler1.Temperature

Variable Separator: .

Result (AF attribute name): Temperature

Create Area Asset in AF

Select this setting to enable the creation of a PCS 7 Area asset in PI AF.

Note: This setting only displays when the Mapping Type is set to PCS7.

Create Data Source Asset in AF

Select this setting to enable the creation of a top-most asset in PI AF. The name will be identical to the Data source name.

Enable Deep Browse

Select this setting to enable creation of a PI AF asset for an OPC UA variable, provided this variable has a child variable. The default behavior for this setting is to ignore the child OPC UA variable.

Enable Expanded NodeId

Select this setting to enable 'Expanded NodeId' instead of 'NodeId'.

Note: This setting mostly applies to OPC UA wrappers put on top of OPC DA servers. We recommend consulting with technical support about your use scenario before activating this marker.

Ignore Bad_WaitingForInitialData Status

Some OPC UA servers send this status right after start-up, which causes out of order data in PI. Select this setting instructs the connector to ignore this status event.

Enumeration as Integer

Select this setting to maps the OPC UA Enumeration data type and applies it to an Int32 PI point.

By default, the connector maps the OPC UA Enumeration data type to a Digital PI point.

MultiState as Integer

Select this setting to maps the OPC UA MultiState and TwoState types and applies them to an Int32 PI point.

By default, the connector maps the OPC UA Enumeration data type to a Digital PI point.

Variant as String

Select this setting to converts the OPC UA Variant type to a String PI point. Otherwise, the resulting PI point type reflects the mapping described in the table in the Introduction chapter.

Disable Variable Description Synchronization

Select this setting to disable unwanted OPC UA server synchronization that results in the Descriptor PI tag attribute value being overridden.

Disable Variable Engineering Units Synchronization

Select this setting to disable unwanted OPC UA server synchronization, that results in the Eng Units PI tag attribute value being overridden.

Disable Variable EURange Synchronization

Select this setting to disable unwanted OPC UA server synchronization that results in the Zero and Span PI tag attributes values being overridden.

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