Skip to main content
Version: 7.9

system.opc.browse

This function is used in Python Scripting.

Description​

Allows browsing of the OPC servers in the runtime, returning a list of tags.

Client Permission Restrictions​

This scripting function has no Client Permission restrictions.

Syntax​

tip

This function accepts keyword arguments.

system.opc.browse(opcServer, device, folderPath, opcItemPath)

Parameters​

TypeParameterDescription
StringopcServerThe name of the OPC server to browse
StringdeviceThe name of the device to browse
StringfolderPathFilters on a folder path. Use * as a wildcard for any number of characters and a ? for a single character.
StringopcItemPathFilters on a OPC item path. Use * as a wildcard for any number of characters and a ? for a single character.

Returns​

OPCBrowseTag[] - An array of OPCBrowseTag objects. OPCBrowseTag has the following functions:

  • getOpcServer()
  • getOpcItemPath()
  • getType()
  • getDisplayName()
  • getDisplayPath()
  • getDataType()

Scope​

All

Code Examples​

Code Snippet
# Example 1: Browse every OPC server

tags = system.opc.browse()
for row in tags:
print row.getOpcServer(), row.getOpcItemPath(), row.getType(),
print row.getDisplayName(), row.getDisplayPath(), row.getDataType()
Code Snippet
# Example 2: Browse Ignition OPC-UA

tags = system.opc.browse(opcServer="Ignition OPC-UA Server")
Code Snippet
# Example 3: Browse Specific Device

server = "Ignition OPC-UA Server"
tags = system.opc.browse(opcServer=server, device="Dairy Demo Simulator")
Code Snippet
# Example 4: Browse Specific Folder Path (not OPC item path)

server = "Ignition OPC-UA Server"
tags = system.opc.browse(opcServer=server, folderPath="*Overview/AU 1*")