Rockwell Automation FactoryTalk Historian SE 3.0 UniInt Interface User Guide - Manual (Page 46)

Interface Health Points
40
The third type of points used to monitor interfaces is the Interface Information point. This
point is different than any of the other points used for monitoring the health of an interface.
There can be only one Interface Information point on a Historian Server and the pointsource
does not match the /ps startup parameter for an interface.
UniInt supports collecting a variety of information about the health of an interface. The
points that collect data pertaining to the performance of an interface are collectively referred
to as Interface Health Points. The following paragraphs describe the supported Interface
Health points, including configuration requirements and update intervals.
The non Scan Class Health points update either on change or at the heartbeat rate. The
heartbeat rate is determined by the scan classes defined for the interface. If there are no scan
classes defined, the heartbeat will update once per second. If there is at least one valid scan
class defined for the interface, the heartbeat will update at the rate of the scan class with the
highest frequency (smallest value). The other non Scan Class Health points will be updated
when the heartbeat is updated. All of the Scan Class Health points will be updated when the
class is scanned. For the Scan Class Health points, Location4 must be set to a valid scan
class. It cannot be less than zero or greater than the number of valid scan classes specified in
the list of startup parameters.
The following table lists the Interface Health Points, the keyword that must be specified in
exdesc, the type of data written to the tag, when the point is updated and when it is reset to 0.
The table is followed by a detailed description of the points. The rate at which the heartbeat
tag is updated is dependant on the scan classes defined for the interface. Please see the
detailed description of the heartbeat tag for the details on when the heartbeat tag is updated.
Some of the other Health tags are updated when the heartbeat tag is updated. These tags are
marked ‗Heartbeat‘ in the updated column of the table. Some of the Health tags act as
accumulators and keep a running total of events until they are reset to 0. When the reset
occurs, the total is reset to a value of 0 and the accumulating of events start over. For a tag
that is never reset to 0 until the interface is stopped and restarted, the tags will be marked as
‗na‘ in the reset column. Several tags have their value reset to zero at the ―Reporting Period‖.
The reporting period for the tag is based on the performance summary interval. The default
performance summary period is 8 hours. The performance summary period may be modified
with the
/perf=interval command-line parameter. During normal shutdown of the
interface, the system digital state of ―Intf Shut‖ will be written to all health tags loaded by
the interface.
Health Point Exdesc Keyword Data Type Updated Reset
Heartbeat [UI_HEARTBEAT] Integer Variable na
Device Status [UI_DEVSTAT] String On Change na
Scan Class Information [UI_SCINFO] String Perf Interval na
Interface Point Count [UI_POINTCOUNT] Integer On Change na
IO Rate [UI_IORATE] Integer Heartbeat Heartbeat
Message Count [UI_MSGCOUNT] Integer 60 seconds na
Output Rate [UI_OUTPUTRATE] Integer Heartbeat Reporting Period
Output Bad Value Rate [UI_OUTPUTBVRATE] Integer Heartbeat Reporting Period