Skip to end of metadata
Go to start of metadata


System Tags provide status about the Ignition system, such as memory usage, performance metrics, and so on. System Tags cannot be deleted or modified. To view the System Tags in the Tag Browser, go to the Tag Provider Selector and select System

The System Tags folders are displayed: Client and Gateway. The scope for each is slightly different.  

On this page ...


IULocgo


System Tags



System Client Tags (Vision Only)

Client-scoped System Tags provide status information about the client's system. They can be used with the Vision module for any Vision Client.  Every individual client is going to have their own values, such as IP address, host name, username, and more. There are three folders within the System > Client folder: Network, System, and User. You cannot modify Client System Tags. 


Vision System Client Tags

TagDescription Data 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

LastProjectUpdate

Date of the last received update notification.

DateTime

OperatingSystemOperating system of the computer that the Client is running on.string

LastProjectUpdate

Date of the last received update notification.

DateTime

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 operating system. for example: US.string
CurrentWindowThe current main window open in the project (top most Floating, Maximized window).string
DateFormatFullFull date format according to the operating system. Format: EEEE, MMMM d, y.string
DateFormatLongLong date format: MMMM d, y.string
DateFormatMediumMedium date format: MMM d, y.string
DateFormatShortShort date format: M/d/yy.string
DateTimeFormatFull

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

string
DateTimeFormatLongLong date and time format: MMMM d, y 'at' h:mm:ss a.string
DateTimeFormatMediumMedium date and time format: MMM d, y, h:mm:ss a zzzz.string
DateTimeFormatShortShort date and time format: M/d/y, h:mm a.string
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: PSmith.string
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 the operating system. Format: h:mm:ss a zzzz.string
TimeFormatLongLong time format: h:mm:ss a z.string
TimeFormatMediumMedium time format: h:mm:ss a.string
TimeFormatShortSort time format: h:mm a.string
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 several folders within the Gateway Tags folder which report metrics on various gateway level systems.


The following Gateway-scoped System Tags are available. 

TagDescriptionData Type
CurrentDateTimeCurrent system date and time. Format is yyyy-mm-dd hh:mm:ss a.DateTime
SystemNameReturns the name of the system where the Ignition Gateway is installed.String
TimezoneTimezone on the Gateway computer. For example, America/Los Angeles.String
UptimeSecondsNumber of seconds since Ignition was started.Long
Alarming
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

Note: 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

Devices

Note: 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

Note: Each system connected over the gateway network receives a special folder, containing the following Tags:

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

OPC

Note: There will be a subfolder for each OPC UA Server. Each subfolder will have the following 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
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.
Double
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 usage/maximum memory usage.Double
Redundancy
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
SessionCountNumber of active sessions on this Gateway. Designers, Clients, and Sessions.Integer
Store and Forward

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

The Store and Forward System Tags were added in version 8.1.2

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

Database Storage

Database storage for this Store and Forward engine. 

 Click to see Database Storage Tags...
TagDescription Data Type
AvailableIndicates whether Database Storage is available for this Store and Forward engine. Boolean
isStoreIndicates if the data storage sink is able to store records. This data store is used for the optimization of the records before they are forwarded to the database and no data is technically stored in it. For this reason, this tag's value will always be false. Boolean

Local Cache
Local cache for this Store and Forward engine. 

 Click to see Local Cache Tags...
Tag DescriptionData Type
ForwardMetrics Folder
TagDescriptionData Type
AverageDurationThe average duration for records to be forwarded to the data sink from the local cache. Double
MaxDurationThe maximum duration for records to be forwarded to the data sink from the local cache. Double
MinDurationThe minimum duration for records to be forwarded to the data sink from the local cache. Double
ThroughputNumber of records forwarded to the data sink per second. Throughput will be -1 if idle. Double
TimeUnitUnit of time for this variable. The unit of time for this variable is seconds. String
TotalTotal number of records forwarded to the data sink from the local cache. Long

StorageMetrics Folder
TagDescriptionData Type
AverageDurationThe average duration for records to be forwarded to the data sink from the local cache. Double
MaxDurationThe maximum duration for records to be forwarded to the data sink from the local cache. Double
MinDurationThe minimum duration for records to be forwarded to the data sink from the local cache. Double
ThroughputNumber of records forwarded to the data sink per second. Throughput will be -1 if idle. Double
TimeUnitUnit of time for this variable. The unit of time for this variable is seconds. String
TotalTotal number of records forwarded to the data sink from the local cache. Long

TakeMetrics Folder
TagDescriptionData Type
AverageDurationThe average duration to read a record from the local cache. Double
MaxDurationThe maximum duration to read a record from the local cache. Double
MinDurationThe minimum duration to read a record from the local cache. Double
ThroughputThe number of records read from the local cache per second. Throughput will be -1 if idle. Double
TimeUnitUnit of time for this variable. The unit of time for this variable is seconds.String
TotalTotal number of records read from the local cache. Long

AvailableIndicates if the local cache for this Store and Forward engine is available.Boolean
CanQuarantineIndicates if this local cache can quarantine records. If the local cache cannot quarantine a record, the record will be dropped and lost forever. Boolean
DroppedRecordsIndicates the number of dropped records for this local cache. A record is considered dropped if it can not be added to one of the buffers, (i.e., when a buffer is full and the Store and Forward engine can no longer accept new records).Integer
IsStoreIndicates if the local cache is able to store records. Boolean
MaxRecordsMaximum number of records this local cache can accept. Integer
PendingRecordsNumber of pending records for this local cache. Integer
QuarantinedRecordsNumber of quarantined records in this local cache. Quarantined data is data that has erred-out multiple times during attempts to forward it, or data that could not be stored because of some configuration issues.Integer

Memory Buffer

Memory Buffer Folder Tags

 Click to see Memory Buffer Tags...
Tag DescriptionData Type
ForwardMetrics Folder
TagDescriptionData Type
AverageDurationThe average duration for records to be forwarded to the data sink from the memory buffer. Double
MaxDurationThe maximum duration for records to be forwarded to the data sink from the memory buffer. Double
MinDurationThe minimum duration for records to be forwarded to the data sink from the memory buffer. Double
ThroughputNumber of records forwarded to the data sink per second. Throughput will be -1 if idle. Double
TimeUnitUnit of time for this variable. The unit of time for this variable is seconds.String
TotalTotal number of records forwarded to the data sink from the memory buffer. Long

StorageMetrics Folder
TagDescriptionData Type
AverageDurationThe average duration to store and record into the memory buffer. Double
MaxDurationThe maximum duration to store a record into the memory buffer. Double
MinDurationThe minimum duration to store a record into the memory buffer. Double
ThroughputThe number of records that go through the memory buffer per second. Throughput will be -1 if idle. Double
TimeUnitUnit of time for this variable. The unit of time for this variable is seconds.String
TotalTotal number of records stored in the memory buffer. Long

TakeMetrics Folder
TagDescriptionData Type
AverageDurationThe average duration to read a record from the memory buffer. Double
MaxDurationThe maximum duration to read a record from the memory buffer.Double
MinDurationThe minimum duration to read a record from the memory buffer.Double
ThroughputThe number of records read from the memory buffer per second. Throughput will be -1 if idle. Double
TimeUnitUnit of time for this variable. The unit of time for this variable is seconds.String
TotalTotal number of records read from the memory buffer. Long

AvailableIndicates if the memory buffer for this Stored and Forward engine is available. Boolean
CanQuarantineIndicates if this memory buffer can quarantine records. The memory buffer cannot quarantine records so this will always be false. Boolean
DroppedRecordsIndicates the number of dropped records for this memory buffer. A record is considered dropped if it can not be added to one of the buffers, (i.e., when a buffer is full and the Store and Forward engine can no longer accept new records).Integer
IsStoreIndicates if the memory buffer is able to store records. Boolean
MaxRecordsMaximum number of records this memory buffer can accept. Integer
PendingRecordsNumber of pending records for this memory buffer.Integer
QuarantinedRecordsNumber of quarantined records for this memory buffer. Quarantined data is data that has erred-out multiple times during attempts to forward it, or data that could not be stored because of some configuration issues.Integer

AvailableIndicates if this database engine is available. Boolean
DroppedNumber of quarantined records for this Store and Forward engine.Integer
QuarantineNumber of quarantined records for this Store and Forward engine.Integer



Related Topics ...

  • No labels