Ignition 8.1
Ignition 7.9
Ignition 7.8
Sepasoft - MES Modules
Cirrus Link - MQTT Modules
Inductive University
Ignition Demo Project
Knowledge Base Articles
Forum
IA Support
SDK Documentation
SDK Examples
You're currently browsing the Ignition 8.0 docs. Click here to view the latest docs.
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.
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.
| Tag | Format or Example Value | Data Type |
|---|---|---|
| Network Folder | ||
| GatewayAddress | Gateway URL address. | string |
| GatewayRedundancyRole | Redundancy State of the Gateway that the client is connected to. Independent, Master, Backup. | string |
| Hostname | Hostname (name) of the computer that the Client is running on. | string |
| IPAddress | IP Address of the computer that the Client is running on. | string |
| MACAddress | MAC Address of the computer that the Client is running on. | string |
| System Folder | ||
| CurrentDateTime | Current system date and time. Format is yyyy-mm-dd hh:mm:ss a. | DateTime |
| DefaultDatabase | Name of the default database connection used by the project. | string |
| DefaultTagProvider | Name of the default Tag Provider used by the project. | string |
| FPMIVersion | Current Ignition version in use. | string |
| JavaVersion | Current Java version in use by the client. | string |
| OperatingSystem | Operating system of the computer that the Client is running on. | string |
LastProjectUpdate |
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. | DateTime |
| ProjectDescription | Description field for the current project. | string |
| ProjectName | Name field for the current project. | string |
| ProjectTitle | Title field for the current project. | string |
| SystemFlags | A byte array of flags for the current state of the Client. | integer |
| UserSource | Name of the user source for the current Client. | string |
| User Folder | ||
| Country | Two letter country code according to OS. for example: US. | string |
| CurrentWindow | The current main window open in the project (top most Floating, Maximized window). | string |
| DateFormatFull | Full date format according to the OS. Format: EEEE, MMMM d, y | string |
| DateFormatLong | Long date format: MMMM d, y | string |
| DateFormatMedium | Medium date format: MMM d, y | string |
| DateFormatShort | Short date format: M/d/yy | string |
| DateTimeFormatFull | Full date and time format: EEEE, MMMM d, y 'at' h:mm:ss a zzzz | string |
| DateTimeFormatLong | Long date and time format: MMMM d, y 'at' h:mm:ss a | string |
| DateTimeFormatMedium | Medium date and time format: MMM d, y, h:mm:ss a zzzz | string |
| DateTimeFormatShort | Short date and time format: M/d/y, h:mm a | string |
| HomeFolder | Home folder according to OS. For example: C:\Users\psmith. | string |
| Language | Language according to OS. For example: "en" for English. | string |
| OSUsername | OS user name, for example: PSmith | string |
| RolesDataSet | Dataset with Roles for currently logged in user. For example: Dataset[2R x 1C]. | dataset |
| RolesString | Comma separated string with Roles for currently logged in user. For example: Administrator, Operator. | string |
| TimeFormatFull | Full time format according to OS. Format: h:mm:ss a zzzz | string |
| TimeFormatLong | Long time format: h:mm:ss a z | string |
| TimeFormatMedium | Medium time format: h:mm:ss a | string |
| TimeFormatShort | Sort time format: h:mm a | string |
| Timezone | Current timezone, for example, America/Los Angeles. | string |
| Username | Currently logged in username, for example, PSmith. | string |
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.
| Tag | Value | Data Type |
|---|---|---|
| CurrentDateTime | Current system date and time. Format is yyyy-mm-dd hh:mm:ss a. | DateTime |
| SystemName | Computer name where the Gateway ins installed. | String |
| Timezone | Timezone on the Gateway computer. For example, America/Los Angeles. | String |
| UptimeSeconds | Number of seconds since Ignition was started. | Long |
| Alarming Folder | ||
| Active and Acked | Number of alarms currently active and acknowledged. | Integer |
| Active and Unacked | Number of alarms currently active and unacknowledged. | Integer |
| Clear and Acked | Number of alarms cleared and acknowledged. | Integer |
| Clear and Unacked | Number 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. | ||
| ActiveConnections | Number of active connections in the pool to this database connection. | Integer |
| Available | Indicates whether this datasource is available. | Boolean |
| AvailableThroughFailover | Indicates if any database along the failover chain attached to this data source can be reached. | Boolean |
| AvgQueryTime | Average time, in seconds, that it is taking database queries to run. | Integer |
| ConnectionSaturation | Percentage of possible query throughput that is being used (ratio of currently active connections to maximum possible connections). | Double |
| QueriesPerSecond | Number 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
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. | ||
| Description | Description of the device connection as configured on the device connection on the Gateway. | String |
| Enabled | Boolean representing whether or not the device connection is enabled. | Boolean |
| Name | Name 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 | ||
| IsAvailable | Whether the remote gateway is available or not. | Boolean |
| LastComm | A 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. | ||
| Connected | Whether the OPC UA server is connected to Ignition. | Boolean |
| Enabled | Whether the OPC UA server connection is enabled. | Boolean |
| State | The 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 Usage | CPU Utilization as reported to the Java Virtual Machine. | Double |
| Disk Utilization | Percentage of hard disk that is in use. | Double |
| Max Memory | Maximum amount of RAM the Gateway can use, in megabytes. | Long |
| Memory Usage | Amount of RAM currently in use by the Gateway, in megabytes. | Long |
| Memory Utilization | Current memory useage/maximum memory usage. | Double |
| Redundancy Folder | ||
| Connection, Is Connected | Whether this Gateway is connected to another for redundancy. | Boolean |
| Connection, PeerId | The ID of the Gateway connected to, empty string if not connected. | String |
| ActivityLevel | Indicates where the Gateway is in the redundant state. Can be undecided, cold, warm, hot, or active. | String |
| IsActive | Whether the Gateway is running. | Boolean |
| IsMaster | Whether the Gateway is the master. False if the backup is in control. | Boolean |
| Role | Named role of the Gateway. Options: Independent, Master, Backup. | String |
| Sessions Folder | ||
| SessionCount | Number of active sessions on this Gateway. Designers, Clients, and Sessions. | Integer |
