User Manual






Sepasoft - MES Modules
Cirrus Link - MQTT Modules


Inductive University
Ignition Demo Project
Knowledge Base Articles
IA Support
SDK Documentation
SDK Examples


Ignition 8.1
Ignition 7.9
Ignition 7.8

Deprecated Pages


Sign In

Skip to end of metadata
Go to start of metadata

System Tags

System Tags provide status about the Ignition system, such as memory usage, performance metrics, and so on. System Tags cannot be deleted or modified.  In the Tag Browser, under the System folder, there two folders: Client and Gateway. The scope for each is slightly different.  

On this page ...


System Tags

System Client Tags for Vision

Client-scoped System Tags provide status information about the client's system.  Every individual client is going to have their own values like IP address, host name, and username. You cannot modify Client System Tags. 

There are three folders within the System > Client Tags folder: Network, System, and User. These Tags are provided with Ignition. They can be used with the Vision module for any Vision Client. They cannot be modified.

TagFormat or Example ValueData Type
Network Folder
GatewayAddressGateway URL address.string
GatewayRedundancyRoleRedundancy State of the Gateway that the client is connected to. Independent, Master, Backup.string
HostnameHostname (name) of the computer that the Client is running on.string
IPAddressIP Address of the computer that the Client is running on.string
MACAddressMAC Address of the computer that the Client is running on.string
System Folder
CurrentDateTimeCurrent system date and time. Format is yyyy-mm-dd hh:mm:ss a.DateTime
DefaultDatabaseName of the default database connection used by the project.string
DefaultTagProviderName of the default Tag Provider used by the project.string
FPMIVersionCurrent Ignition version in use.string
JavaVersionCurrent Java version in use by the client.string
OperatingSystemOperating system of the computer that the Client is running on.string

The following feature is new in Ignition version 8.0.4
Click here to check out the other new features

Date of the last received update notification.


ProjectDescriptionDescription field for the current project.string
ProjectNameName field for the current project.string
ProjectTitleTitle field for the current project.string
SystemFlagsA byte array of flags for the current state of the Client.integer
UserSourceName of the user source for the current Client.string
User Folder
CountryTwo letter country code according to OS. for example: US.string
CurrentWindowThe current main window open in the project (top most Floating, Maximized window).string
DateFormatFullFull date format according to the OS. Format: EEEE, MMMM d, ystring
DateFormatLongLong date format: MMMM d, ystring
DateFormatMediumMedium date format: MMM d, ystring
DateFormatShortShort date format: M/d/yystring

Full date and time format: EEEE, MMMM d, y 'at' h:mm:ss a zzzz

DateTimeFormatLongLong date and time format: MMMM d, y 'at' h:mm:ss astring
DateTimeFormatMediumMedium date and time format: MMM d, y, h:mm:ss a zzzzstring
DateTimeFormatShortShort date and time format: M/d/y, h:mm astring
HomeFolderHome folder according to OS. For example: C:\Users\psmith.string
LanguageLanguage according to OS. For example: "en" for English.string
OSUsernameOS user name, for example: PSmithstring
RolesDataSetDataset with Roles for currently logged in user. For example: Dataset[2R x 1C].dataset
RolesStringComma separated string with Roles for currently logged in user. For example: Administrator, Operator.string
TimeFormatFullFull time format according to OS. Format: h:mm:ss a zzzzstring
TimeFormatLongLong time format: h:mm:ss a zstring
TimeFormatMediumMedium time format: h:mm:ss astring
TimeFormatShortSort time format: h:mm astring
TimezoneCurrent timezone, for example, America/Los Angeles.string
UsernameCurrently logged in username, for example, PSmith.string

Gateway System Tags

Gateway System Tags exist in the Gateway scope. There are nine folders within the System > Gateway Tags folder: Alarming, Database, Devices, EAM, Gateway Network, OPC, Performance Redundancy and Sessions.

The following Gateway-scoped System Tags are provided with Ignition. They can be used anywhere within Ignition.

TagValueData Type
CurrentDateTimeCurrent system date and time. Format is yyyy-mm-dd hh:mm:ss a.DateTime
SystemNameComputer name where the Gateway ins installed.String
TimezoneTimezone on the Gateway computer. For example, America/Los Angeles.String
UptimeSecondsNumber of seconds since Ignition was started.Long
Alarming Folder
Active and AckedNumber of alarms currently active and acknowledged.Integer
Active and UnackedNumber of alarms currently active and unacknowledged.Integer
Clear and AckedNumber of alarms cleared and acknowledged.Integer
Clear and UnackedNumber of alarms cleared and unacknowledged.Integer

Database Folder

There will be a subfolder for each database connection, or none if there are no connections. Each subfolder will have the following Tags.

ActiveConnectionsNumber of active connections in the pool to this database connection.Integer
AvailableIndicates whether this datasource is available.Boolean
AvailableThroughFailoverIndicates if any database along the failover chain attached to this data source can be reached.Boolean
AvgQueryTimeAverage time, in seconds, that it is taking database queries to run.Integer
ConnectionSaturationPercentage of possible query throughput that is being used (ratio of currently active connections to maximum possible connections).Double
QueriesPerSecondNumber of queries running per second.Integer

The following feature is new in Ignition version 8.0.10
Click here to check out the other new features
Devices Folder

A "Devices" folder was added in 8.0.10. For each device configuration on the gateway, a separate subfolder will exist. The contents of each subfolder are listed below. 

DescriptionDescription of the device connection as configured on the device connection on the Gateway.String
EnabledBoolean representing whether or not the device connection is enabled.         Boolean
NameName of the device connection.  String
Status Status of the connection.      String

Gateway Network

Each system connected over the gateway network receives a special folder, containing the following two tags

IsAvailableWhether the remote gateway is available or not.Boolean
LastCommA timestamp representing the last known communication received from the remote gateway.DateTime

OPC Folder

There will be a subfolder for each OPC UA Server. Each subfolder will have the following three Tags.

ConnectedWhether the OPC UA server is connected to Ignition.Boolean
EnabledWhether the OPC UA server connection is enabled.Boolean
StateThe state name of the connection. For example: Connected, Faulted, Connecting.String
Performance Folder
Available Disk Space (MB)Available disk space on the computer Ignition is installed on, in megabytes.Long
CPU UsageCPU Utilization as reported to the Java Virtual Machine.Double
Disk UtilizationPercentage of hard disk that is in use.
Max MemoryMaximum amount of RAM the Gateway can use, in megabytes.Long
Memory UsageAmount of RAM currently in use by the Gateway, in megabytes.Long
Memory UtilizationCurrent memory useage/maximum memory usage.Double
Redundancy Folder
Connection, Is ConnectedWhether this Gateway is connected to another for redundancy.Boolean
Connection, PeerIdThe ID of the Gateway connected to, empty string if not connected.String
ActivityLevelIndicates where the Gateway is in the redundant state. Can be undecided, cold, warm, hot, or active.String
IsActiveWhether the Gateway is running.Boolean
IsMasterWhether the Gateway is the master. False if the backup is in control.Boolean
RoleNamed role of the Gateway. Options: Independent, Master, Backup.String
Sessions Folder
SessionCountNumber of active sessions on this Gateway. Designers, Clients, and Sessions.Integer


  • No labels