system.tag
Tag Functions
The following functions give you access to interact with Ignition Tags.
📄️ browse
Returns a list of nodes found at the specified path.
📄️ browseHistoricalTags
Will browse for any historical Tags at the provided historical path.
📄️ configure
Creates tags from a given list of Python dictionaries or from a JSON source string.
📄️ copy
Copies Tags from one folder to another.
📄️ deleteAnnotations
Removes stored annotations from the sqlth_annotations table.
📄️ deleteTags
Deletes multiple tags or tag folders.
📄️ exists
Checks whether or not a tag with a given path exists.
📄️ exportTags
Exports tags to a file on a local file system.
📄️ getConfiguration
Retrieves tags from the Gateway as Python dictionaries.
📄️ importTags
Imports a JSON tag file at the provided path.
📄️ isOverlaysEnabled
Returns whether or not the current client's quality overlay system is currently enabled.
📄️ move
Moves tags or folders to a new destination.
📄️ query
Queries a Tag Provider to produce a list of tags that meet the specified criteria.
📄️ queryAnnotations
Queries annotations stored in the Tag History system for a set of paths for a given time range.
📄️ queryTagCalculations
Queries various calculations (aggregations) for a set of tags over a specified range.
📄️ queryTagDensity
Queries the Tag History system for information about the density of data.
📄️ queryTagHistory
Issues a query to the Tag Historian.
📄️ readAsync
Asynchronously reads the value of the tags at the given paths.
📄️ readBlocking
Reads the value of the tags at the given paths.
📄️ rename
Renames a single tag or folder.
📄️ requestGroupExecution
Sends a request to the specified tag group to execute now.
📄️ setOverlaysEnabled
Enables or disables the component quality overlay system.
📄️ storeAnnotations
Stores annotations into the tag history system.
📄️ storeTagHistory
Inserts data into the tag history system, allowing Tag history to be recorded via scripting.
📄️ writeAsync
Asynchronously writes values to tags at specified paths.
📄️ writeBlocking
Writes values to tags at the given paths.
Functions by Scope
- browse
- browseHistoricalTags
- configure
- copy
- deleteAnnotations
- deleteTags
- exists
- exportTags
- getConfiguration
- importTags
- isOverlaysEnabled
- move
- queryAnnotations
- queryTagCalculations
- queryTagDensity
- queryTagHistory
- readAsync
- readBlocking
- rename
- requestGroupExecution
- setOverlaysEnabled
- storeAnnotations
- storeTagHistory
- writeAsync
- writeBlocking