system.tag.browseConfiguration(path, recursive) String path - The path that will be browsed, typically to a folder or UDT instance. 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. When browsing UDTs, specifying the UDT path will browse the Tags inside the UDT. To browse the UDT instance, specify the parent of the instance. 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. TagConfiguration[] - A list of TagConfiguration objects. Attributes on the object may be read by calling tag.get(propertyObject). 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. All Warning |
---|
If called in the gateway scope, a tag provider must be specified. |
TagConfiguration Method SummaryMethod | Description |
---|
getAlarms() | Returns a list of AlarmDefinition objects. Calling getProperties() on the object will return a list of non-default alarm properties. | getFolderPath() | Returns the path to the folder the Tag resides in. | getFullPath() | Returns the Tag path. | getName() | Returns the name of the Tag. | getParameters() | Returns a BasicPropertySet of UDT parameters. Returns an empty list if called on a Folder. Parameters and their values may be accessed with '.property' and '.value' | getProperties() | Returns a Java Hashmap of properties that have non-default values. Individual values may be specified by calling tag.get(propertyObject). | getSubTags() | If called on a folder and the recursive parameter is True, returns a list of TagConfiguration objects pertaining to the nested nodes. Returns an empty list if called on a UDT instance or recursive is False. | getTagType() | Returns the type of the node.Possible Possible values are: , DB, and UDT_INST The DB type is unique in that it is a parent type to several other types. If the TagConfiguration has a property named expressionType, then it can be examined to determine its type. If it does not contain an expressionType property, then it is a Memory tag. The other types are listed below:
- SQL_Query
- Expression
- DERIVED
|
|