Version: 7.9

system.tag

Tag Functions

The following functions give you access to interact with Ignition Tags.

📄️ addTag

Adds a new tag in Ignition.

📄️ browseConfiguration

Browses a folder path or UDT and returns Tag configuration information for each Tag within the specified path.

📄️ browseHistoricalTags

Will browse for any historical Tags at the provided historical path.

📄️ browseTags

Returns an array of tags from a specific folder. The function supports filtering and recursion.

📄️ browseTagsSimple

Returns a sorted array of tags from a specific folder.

📄️ editAlarmConfig

Edit the alarm configuration of multiple existing tags in Ignition with a single call.

📄️ editTag

Edits an existing Tag in Ignition.

📄️ editTags

Edit multiple existing Tags in Ignition with a single call.

📄️ exists

Checks whether or not a tag with a given path exists.

📄️ getAlarmStates

Returns an array of alarm definitions for a specific tag.

📄️ isOverlaysEnabled

Returns whether or not the current client's quality overlay system is currently enabled.

📄️ loadFromFile

This function locates an exported tag file and loads the tags into the specified tag provider.

📄️ 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.

📄️ read

Reads the value of the tag at the given tag path.

📄️ readAll

Reads the values of each tag in the tag path list.

📄️ removeTag

Removes a tag from Ignition.

📄️ removeTags

Removes multiple tags from Ignition with a single call.

📄️ scan

Forces execution of a scan class. On a leased scan class, if both the fast and slow rate are set to 0, this will not execute.

📄️ setOverlaysEnabled

Enables or disables the component quality overlay system.

📄️ storeTagHistory

Inserts data into the tag history system, allowing Tag history to be recorded via scripting.

📄️ write

Writes a value to a tag.

📄️ writeAll

Performs an asynchronous bulk write.

📄️ writeAllSynchronous

Performs a synchronous write to multiple tags.

📄️ writeSynchronous

Performs a write to a tag, synchronously.

Functions by Scope

Gateway

Vision

Designer

Tag Functions​