Browse tag items

Note: This feature is only available for MQTT Sparkplug-based subscription model. You can only view the MQTT Browser tab from a GR (Application Server) node. You cannot view the MQTT Browser tab from a remote node.

The user who launches the OCMC must be part of the oiAdministrators Windows Local Users and Groups to access the MQTT Browser tab. Otherwise, an error message is displayed saying the user or the user group is not part of oiAdministrators group. If the user is not a part of the oiAdministrators group, you must add the user to the oiAdministrators group manually and re-login your computer. The user who installs the Communication Drivers Pack will be added to the oiAdministrators group automatically.

If you make any changes to the configuration of the System Management Server (SMS), you must restart the AVEVA Communications Backend Service in the Services console of your machine. In the Advanced Configuration of the System Management Server (SMS), if you change the HTTP Port or the HTTPS Port then you must run the following command as an administrator in the command prompt:

If you change the HTTP Port field

netsh http add urlacl url=http://localhost:<http port configured in SMS>/oi/ user="NT Authority\Network Service"

If you change the HTTPS Port field

netsh http add urlacl url=https://localhost:<https port configured in SMS>/oi/ user="NT Authority\Network Service"

If you do not run the above commands after changing the ports and try to access the MQTT browser functionality, you will get an HTTP 503 error saying the service is unavailable.

The MQTT Browser window displays the item reference, hierarchy, and the corresponding node details. The Sparkplug hierarchy is displayed, once you enter the correct broker IP address and select Save in the Broker Parameters tab. The MQTT Browser screen is divided into three sections.

Copy tag references to the system clipboard

To facilitate tag reference creations in Sparkplug format, you can use the MQTT Browser to copy selected tag references to the Windows Clipboard.

• Copy all tag references of a Sparkplug Edge Gateway or Device

  B

• Copy a tag reference of an attribute in a Sparkplug Gateway or Device

  

To export the tag references to a CSV file, select anywhere on the line Click here to export tag references of selected object to a file. For the procedure on exporting and importing tag references, see Export and import tag references. For more information on Device Items, see Configure MQTT device items. You can also drag a required node from the hierarchy and drop it to the Excel file. All the tags below the selected node in the hierarchy are exported to the Excel file.

Hierarchy/GeoLocation Browsing

Hierarchy

Displays the hierarchy from a broker that contains payloads from the AVEVA Edge devices that are Sparkplug encoded. The hierarchy includes:

• Broker address

• Sparkplug Namespace

• Sparkplug Group

• Edge Gateway

• Device Name

  

It displays a hierarchical browser that shows the topic hierarchy in the MQTT broker. If a node has children, then you can double-click the node to collapse or expand. Selecting a node displays the details of the node in the right pane. If any of the nodes in the hierarchy is not active or not available, the respective node will be greyed out. If you hover the cursor on a node, you can see the tooltip which briefs about that node.

GeoLocation

Select to display the GeoLocation, and select icon to display back the Hierarchy. The GeoLocation option displays the geographical location of an object, such as Edge Gateway and Device. For assets to be displayed in the GeoLocation Browser, the MQTT (sparkplug-based) payload must contain the GeoLocation latitude and longitude in the following format:

• Position/Latitude

• Position/Longitude

EdgeGateway Attributes

When you select EdgeGateway in the Sparkplug hierarchy on the left pane, the hierarchy of the Edge Gateway Attributes is displayed on the right pane. The same hierarchy is displayed in the MQTT publisher as well.

To view the detailed metrics of a node, expand the hierarchy by selecting the arrow button on the left of the node. Select the same button to minimize the metrics.

Device Attributes

When you select Device in the Sparkplug hierarchy on the left pane, the hierarchy of the Device Attributes is displayed on the right pane.

To view the detailed metrics of a node, expand the hierarchy by selecting the arrow button on the left of the node. Select the same button to minimize the metrics.

Delete an Edge Gateway or Device node

• To delete an edge gateway or a device node, right-click the required node, and select Remove Node.

  

  This cleans up publishing Edge Gateway node or Device nodes cached in the subscriber that are no longer in existence or used.

  Note: Any deleted node will re-appear in the screen if the publisher starts to publish any deleted nodes.