Apply the filter based on OPC UA Type Definitions
- Last UpdatedJan 27, 2025
- 3 minute read
In this mode, upon startup the connector browses the OPC UA address space in order to acquire the OPC UA information model. The scope of the initial browse can be limited by listing a set of comma-separated NodeIds from the point at which the browse-calls start. In other words, the initial browse is applied to the listed set of NodeIds (see the Root NodeIds section under Add data sources to the PI Connector for OPC UA) and all their child objects. If nothing is specified, the whole OPC UA address space is browsed.
After browsing the OPC UA address space, users have an option to export the discovered OPC UA type definitions and their attributes into a .csv file. Consequently, the desired attributes can be marked by placing or removing an "x" marker at the beginning of the rows, comparable to the technique used in the AVEVA Tag Configurator Excel Plug-In. The file is then uploaded back to the connector. This allows users to select only a subset of OPC UA objects and their attributes, which will end up being replicated to the PI System. For each selected OPC UA type definition (refer to the Template Name column), the connector will create the corresponding PI AF template. If the OPC UA type definition is incomplete or missing, the PI AF template name is generated as FolderType.Id. The Id suffix represents a hash code created of all attribute names of the given type and makes sure the template name is unique. Employing such a mechanism allows the connector to generate PI AF template names automatically.
|
Select (x) |
Template name |
Attribute name |
|---|---|---|
|
x |
FB_SteamFlow |
ns=4;s=MAIN.fbBoiler1.Pipe1002.FT1002 |
|
x |
DataItem |
|
|
x |
rGetSteamFlow |
|
|
x |
rSetSteamFlow |
|
|
x |
FolderType.E5BE28D2 |
ns=4;s=PLC1.ParameterSet |
|
x |
bAutoMode |
|
|
x |
Counter |
|
|
x |
rMaxFeedwaterPressure |
|
|
x |
rMaxFillLevel |
|
|
x |
rMaxValveState |
-
If the "x" marker on the line with the template name is removed, the template will not be created.
-
Do not modify the template name once the template has been created in PI AF.
-
The NodeId (for example: ns=4;s=PLC1.ParameterSet) in the AttributeName column is for internal use only. Do not modify the NodeId, or change the individual attribute names.
Note: The list of template names with attributes does not represent the actual objects in the OPC UA address space, which are visible when using an OPC UA client like the UA Expert (from Unified Automation GmbH). In the filter file, there is a list of implemented types.
If the connector is started without a filter file, it will not browse the UA hierarchy. It creates only one PI AF element, names it according to the configured data source, and adds four PI points, which reflect the status of the OPC UA Server object. In PI AF, the outcome looks like this:

Note: It is a good practice to start the connector for the first time without the filter file to verify that the OPC UA Server object has been created (in PI AF). Browsing the whole OPC UA address space might potentially take longer, or even time-out.