ExDesc Keyword: [UI_SCINFO] Update Interval: Once at interface startup and each performance summary interval.
Description: The Scan Class Information Tag is a string tag that contains the number of scan classes used by the interface and their associated scan rates. The Heartbeat scan rate is also included in the string. The tag is updated once at interface startup and at each performance interval.
As an example, the value for the Scan Class Information tag for an interface with three scan class of 5 seconds, 10 seconds and 60 seconds will be “3 | 5 | 5 | 10 | 60”. The first number is the number of scan classes and the second number is the Heartbeat update rate. The numbers that follow the Heartbeat depend on the rate and number of scan classes defined. Each scan class rate will be written in seconds.
Device Status
ExDesc Keyword: [UI_DEVSTAT] Update Interval:On startup, on change, and shutdown.
Description: The device status tag stores communication information about the interface and the foreign device. This tag will be evaluated only while the heartbeat tag is updating. The device status tag is a string type PI point. During normal shutdown of the interface, the string text of “4 | Intf Shutdown” will be written to this tag.
Format: n | uniint provided string text | interface specific text (when provided).
The ‘n’ value in the text and the pipe separator are formatting devices which may be used to quickly parse and analyze the value of the device status tag.
The update values and meaning of this tag are as follows.
System Digital State “Good” – the interface is properly communicating with the foreign device and is able to read/write data to the device as required. When in this state, the system digital state of “Good” will be written to the Device Status tag.
“1 | Starting” – the interface is starting.
“2 | Connected / No Data” – the interface is connected to the foreign device. While in this state, the interface is not capable or reading or writing data to the foreign device. Optional text that may be provided by the interface is appended to the UniInt provided string value.
“3 | n device(s) in error” – the interface is not able to communicate with n device(s). Optional text that may be provided by the interface is appended to the UniInt provided string value.
“4 | Intf Shutdown” – the interface is shutting down.
“5 | interface_spcific_message” – Text provided by the interface will be the only text following the “5 |”.