UniInt End User
Download 1.93 Mb.
|
PI BASemAPI
- Navigate this page:
- Extended Descriptor Requirements
- Invalid: no square brackets around the keyword
- General Interface Health Tags
- Heartbeat
Extended Descriptor RequirementsAll of the keywords entered into the ExDesc must adhere to the following rules. The keywords must be the very first thing in the ExDesc with no spaces before the keyword, the keyword must be surrounded by square brackets ([ ]) with no spaces between the brackets and the keyword, and the keywords are all case sensitive. Additional text, such as a more detailed description of the tag, can be added to the ExDesc after the keyword if the PI administrator would like a more detailed description or some other text that may help with the administration of these PI tags. The additional text is not required, has no standard format and would serve no purpose other than helping a user or PI administrator determine a tag’s purpose from looking at the exdesc where the keywords are found. For example, the following is a valid extended descriptor for an IO Rate Health Point. [UI_IORATE] Number of events per second for interface PIIFC The following extended descriptors are examples of invalid keyword entries for an Interface Health point. If the keyword is not specified exactly, the interface will try to load the point as a regular interface point. This most likely will result in a message stating the point was not loaded by the interface. This may also result in the point being loaded by the interface and collecting unexpected data. Invalid: no square brackets around the keywordUI_IORATE Number of events per second for interface xyz Invalid: spaces between the opening square bracket and the keyword [ UI_IORATE] Events per second Invalid: missing closing square bracket [UI_IORATE Invalid: keyword is in the wrong case [ui_iorate] Number of events per second for interface xyz General Interface Health TagsThe general interface health tags pertain to the operation of the interface in general. A list of scan class health tags follows. The scan class health tags require a valid scan class be configured in Location4 of the PI tag. The general Interface Health tags do not consider the Location4 value. HeartbeatExDesc Keyword: [UI_HEARTBEAT] Update Interval: Once a second or based on scan class as described below. Description: The heartbeat tag is the primary tag used to determine if the interface is running. If the value of the heartbeat tag is updating, then the interface is running but not necessarily connected to and collecting data from a data source. The default update interval is 1 second if there are no scan classes defined for the interface. If the interface has defined scan classes, the update interval will be set to the highest frequency (lowest value) scan rate with the following limitations. If the scan rate is less than 1 second, the update interval will be set to 1 second. If the scan rate for the highest frequency scan class is greater than 1 minute, the update interval will be set to 60 seconds. The value written to the heartbeat tag increments from a value starting at 1, increments to a value of 15 and then restarts at 1. The heartbeat tag will stop updating if the interface is shut down or if the interface is in a deadlock situation. Note: The Interface Health Heartbeat tag is completely separate from the UniInt Failover Heartbeat tag. An interface can have both an Interface Health Heartbeat tag and a UniInt Failover Heartbeat tag loaded simultaneously. Download 1.93 Mb. Share with your friends:
|