Failover status points and attributes
- Last UpdatedApr 03, 2023
- 3 minute read
UniInt uses PI points to track the statuses of the interface instances paired for failover. Configure failover using PI ICU to create the active ID, heartbeat, state, and device status PI points on the Failover tab.
Failover status points
The failover points used by the interface instances are:
-
Active ID point
-
Heartbeat point for instance 1
-
Heartbeat point for instance 2
-
Optional:
-
State point for instance 1 and state point for instance 2
-
Device status point for instance 1 and device status point for instance 2
-
Failover point attributes
OSIsoft suggests the following point name (tag) syntax for UniInt failover points:
|
Failover point tag attribute |
Attribute syntax |
|---|---|
|
Active ID point tag |
PIDataArchiveName-InterfaceGenericName_InstanceID_PointSource_UFO2_ActiveID |
|
Heartbeat point tag |
PIDataArchiveName-InterfaceGenericName_InstanceID_PointSource_UFO2_UFO2_Heartbeat_ID |
|
State point tag |
PIDataArchiveName-InterfaceGenericName_InstanceID_PointSource_UFO2_UFO2_State_ID |
|
Device status point tag |
PIDataArchiveName-InterfaceGenericName_InstanceID_PointSource_UFO2_UFO2_DeviceStatus_ID |
The extended descriptor (exdesc) attribute defines UniInt failover control points. Values must be contained in square brackets and require the following syntax:
|
Failover point extended descriptor attribute |
Attribute syntax |
|---|---|
|
Active ID exdesc |
[UFO2_ActiveID] or [UFO2_ActiveID:failoverID] When configuring redundant data sources, each failover pair will utilize a unique Active ID point to monitor which instance within the failover pair is active. Therefore, two Active ID points will be defined for redundant pairs; one for each pair. The failoverID assigned to the[UFO2_ActiveID:failoverID] must be one of the failover IDs configured for the failover pair. |
|
Heartbeat point exdesc |
[UFO2_Heartbeat:failoverID] |
|
Device status point exdesc |
[UFO2_DeviceStat:failoverID] |
|
State point exdesc |
[UFO2_State:failoverID] |
Additionally, set the following attributes for all UniInt failover points:
|
Additional failover point attributes |
Description |
|---|---|
|
compmax |
Set to 0. |
|
location1 |
Set to the interface ID. |
|
location3 |
For cold failover only. Sets the delay for the primary interface instance with a good device status to stay in the primary state before allowing the backup interface instance with the bad device status a chance to become primary. To enable this delay, set location3 to a positive value, in minutes, for the amount of time the primary interface instance with a GOOD status will stay in the primary state before allowing the backup interface instance with the bad device status a chance to become primary. The backup interface instance must actively be reporting a good heartbeat in order for the primary interface instance to allow the backup interface instance to become primary. To disable this delay, set location3 to 0. |
|
location4 |
For cold failover only. Sets the delay for the backup interface instance to allow the interface instance assuming primary role to clear a bad device status by using a delay. Only valid when location3 is set for delay. To configure this delay, set location4 to a positive value, in minutes, for the backup interface instance with a good device status to stay in backup-ready state before reverting to normal failover operation. If the primary interface instance did not update to a good device status during the delay, the backup attempts to resume primary role. Default: location4 value of 0, which is a 5-minute delay. |
|
location5 |
For cold failover only. Sets the delay for the backup interface instance to attempt to assume primary role when both primary and backup interface instances have equally bad device status. Only valid when location3 is set for delay. To configure this delay, set location5 to a positive value, in minutes, for the backup interface instance to wait for the primary interface instance to update to a better device status before attempting to assume primary role. Default: location5 value of 0, which is a 10-minute delay. |
|
pointsource |
Set to the point source for all points maintained by this interface instance. |
|
pointtype |
Must be set to Int32. |
|
shutdown |
Must be set to 0. |
|
step |
Must be set to 1. |