system.tag.browseConfiguration

This feature is new in Ignition version 7.9.2
Click here to check out the other new features

Description

Browses a folder path and returns Tag configuration information for each Tag in the folder. This can be used to view event scripts, alarms, as well as any other configurable attribute on a Tag.

Syntax

system.tag.browseConfiguration(path, recursive)

Parameters

String path - The path that will be browsed. The path typically leads to a folder. Leave blank to browse the root folder. A Tag Provider may be specified as follows: "[TagProvider]". If the Tag Provider is omitted, client scoped calls will be made against the project's default provider. Gateway scoped calls must include a Tag Provider.

Boolean recursive - If true, will recursively search for Tags in folders. Each folder will return a 'tags' property containing the nested TagConfigurations in another list.

Returns

TagConfiguration[] - A list of TagConfiguration objects. Attributes on the object may be read by calling get("propertyName"). A list of attributes with configuration information can be obtained by calling getproperties(). Only attributes with non-default values will appear in the attribute list.

Scope

All

If called in the gateway scope, a tag provider must be specified.

Add this stuff above

Results of getProperties()

eventScripts, path, name, value (more potentially. List increases if "non-default" values exist on a property. Path, name, and value seem to always be present.

Code Examples

Code Snippet

#Browse for all tags at the root of the tag provider named 'default'
#Does some other cool stuff. Play with it more. 
configs = system.tag.browseConfiguration("[default]", False)
for item in configs:
	if str(item.tagType) == "Folder":
		for tag in item.subTags:
			print "Name: " + tag.name + ", Type: " + str(tag.tagType)
	else:
		print "Name: " + item.name + ", Type: " + str(item.tagType)

Contents

Strategic Partner Links

Resources

All Manual Versions