General health status points

The following health points track general interface status. These points do not require a scan class to be defined in the location4 attribute of the PI point. Health points that return strings use the pipe symbol | as a delimiter between fields.

Use the extended descriptor (exdesc) point attribute keyword to specify what type of information to gather. Use square brackets around the keyword.

General UniInt health status points include the following types:

• Heartbeat

  Keyword: [UI_HEARTBEAT]

  The heartbeat point indicates whether or not the interface is running. The heartbeat point is updated continuously unless the interface is shut down or in a deadlock situation. As long as the interface is running, the value of the point cycles incrementally from 1 to 15. The heartbeat point does not indicate whether the interface is connected to or collecting data from a data source.

  Note: The interface health heartbeat point is different than the UniInt failover heartbeat point. An interface can have both loaded simultaneously.

  If no scan classes are defined for the interface, the heartbeat is updated once a second. If the interface has scan classes defined, the update interval is set to the highest-frequency scan rate (no lower than once a second or higher than once a minute).

• Scan class information

  Keyword: [UI_SCINFO]

  This string point lists the scan rates, including the heartbeat scan rate, in seconds. The point is updated once at interface startup and again at each performance interval. The scan class information string uses the following format: # rates | heartbeat_rate | scan class 1 | … | scan class n.

  For example, for an interface with three scan classes of 5, 10, and 60 seconds, the point returns the following string: 3 | 5 | 5 | 10 | 60

• Device status

  Keyword: [UI_DEVSTAT]

  This string point contains information about communication between the interface and the data source. This point is evaluated only while the heartbeat point is updating and is updated on startup, on change, on shutdown, and on each performance summary interval.

  The point contains a string indicating status, formatted as follows: Status code | Description | Interface-specific text.

  For standard message strings, see UniInt device status messages.

• I/O rate

  Keyword: [UI_IORATE]

  Counts the number of all point values (inputs, outputs, triggered inputs) being sent to Data Archive before exception processing occurs. Can contain zero for update intervals during which no data was sent to Data Archive. If the value stops updating, the interface has stopped collecting data. Updated at the same rate as the heartbeat point.

• Message counter

  Keyword: [UI_MSGCOUNT]

  Tracks the number of messages that the interface has logged since start-up. A large number of log messages can indicate a problem that requires investigation. Updated every 60 seconds.

• Output rate

  Keyword: [UI_OUTPUTRATE]

  Tracks the number of output point events that are sent to Data Archive before exception processing. Updated according to the heartbeat point update interval and reset each performance summary interval. If no output points are defined, the digital state value NO RESULT is written to the health point.

• Output bad value rate

  Keyword: [UI_OUTPUTBVRATE]

  Counts number of output point events with non-GOOD status that are sent to Data Archive before exception processing. Output points update based on some event and cannot be scheduled for an update rate. These points are updated at the same rate as the heartbeat point and reset after the performance summary interval.

If no output points are defined, the digital state value of NO RESULT is written to the health point.

• Interface point count

  Keyword: [UI_POINTCOUNT]

  Counts number of PI points loaded by the interface. This count includes all input, output and triggered input points. This count does not include any interface health points or performance points. Updated on startup, on change, and shutdown.

• Trigger input rate

  Keyword: [UI_TRIGGERRATE]

  Counts number of triggered input point events that are sent to Data Archive before exception processing. Triggered input points update based on some event and cannot be scheduled for an update rate. Therefore, the value of these points is updated at the same rate as the heartbeat point and reset after the performance summary interval.

  If no trigger input points are defined, the digital state value of NO RESULT is written to the point.

• Trigger input bad value rate

  Keyword: [UI_TRIGGERBVRATE]

  Counts number of triggered input point events with non-GOOD values that are sent to Data Archive before exception processing. Triggered input points update based on some event and cannot be scheduled for an update rate. The value of these points is updated at the same rate as the heartbeat point and reset after the performance summary interval.

  If no trigger input points are defined, the digital state value of NO RESULT is written to the point.