RedundantDIObject attributes
- Last UpdatedJul 19, 2024
- 8 minute read
The following table describes the RedundantDIObject’s attributes. These attributes are provided to optimize the performance of the RedundantDIObject and should be reserved for advanced users.
Attributes that are common to all objects are not included in the following attribute table. For information on common attributes, see the Configuration Help. To access this Help file, click the Configuration Help link, which is located in the fixed header area that appears at the top of this Help file window.
Hidden attributes are not included in the following attribute table. Hidden attribute names are prefixed with an underscore ( _ ) and may be visible within certain applications, such as the Object Viewer. Hidden attributes are generally used for internal ArchestrA functionality, and should be ignored.
Table Legend
The Config column specifies whether the attribute can be configured using an option in the object editor.
The RT Access column describes how the attribute value can be accessed at runtime. Values for this column include:
-
Supervisory- The attribute value can be changed using a script.
-
User- The attribute value can be modified by the user.
-
Read-Only- The attribute value cannot be changed.
-
None- The feature is being deployed; however, the attribute is not deployed at runtime (package only).
Attribute
Description
Config
RT Access
AlarmDSCnt
The total number of disabled and silenced alarms in the object. Sub-areas or sub-notification-distributors are not included.
No
Read-Only
AlarmInhibit
This attribute, when true, disables alarms in the RedundantDIObject.
No
Read-Only
AlarmMode
Contains the current alarm mode of the RedundantDIObject. The mode is based on the object's commanded mode if its area and container are enabled. Otherwise, the most disabled state of the container or parent area applies. "Disabled" is considered the most disabled mode, then "silenced," and then "enabled."
No
Read-Only
AlarmModeCmd
Currently commanded alarm mode of the RedundantDIObject.
No
Read-Only
AlarmOnCnt
The number of active alarms in the distributor. Does not include sub-areas or sub-notification-distributors.
No
Read-Only
AlarmUnAckCnt
The number of unacknowledged alarms in the distributor (including unacknowledged return-to-normal). Does not include sub-areas or sub-notification-distributors.
No
Read-Only
<Block Name.>AccessPath
The address path (maps to scan group). The path syntax is specific to the type of DIObject data source. This attribute reflects the same attribute value in the current Active DI source.
No
None
<Block Name.>AliasDatabase
Used to store pairs of alias attribute names and the corresponding item references. Item references are not editable in the RedundantDIObject. At runtime, each item reference will reflect the same item reference value in the current Active DI source.
No
Read-Only
<Block Name.>ItemCnt
The total number of items in the group that are on advise by a client application.
No
Read-Only
<Block Name.>ItemErrorCnt
The current number of items within the group that have data quality other than GOOD. This value is calculated.
No
Read-Only
<Block Name.>ItemErrorCntAlarm
If TRUE, the current error count is not zero. This value can be alarmed.
No
Read-Only
<Block Name.>ItemErrorCntLast
The error count immediately prior to the current error count.
No
Read-Only
<Block Name.>ItemErrorCntLastEnd
The last time the error count returned to zero. The date format reflects the current locale setting for the operating system.
No
Read-Only
<Block Name.>ItemErrorCntLastStart
The last time that the error count changed from zero to non-zero, not including the most recent change. The date format reflects the current locale setting for the operating system.
No
Read-Only
<Block Name.>ItemErrorCntStart
The time that the error count most recently changed from zero to non-zero. The date format reflects the current locale setting for the operating system.
No
Read-Only
<Block Name.>ItemList
The list of user-defined names for item references. Normally, use the "Copy Attributes..." buttons to copy attributes from either of the DI source objects.
Yes
None
<Block Name.>StatsReset
If TRUE, reset all statistics during runtime.
No
Supervisory, User
<Block Name.>TransactionComplete
If TRUE, the transaction has completed.
No
Read-Only
<Block Name.>TransactionEnd
The time the last transaction ended. The date format reflects the current locale setting for the operating system.
No
Read-Only
<Block Name.>TransactionsCnt
The total number of transactions since the last statistics reset.
No
Read-Only
<Block Name.>TransactionStart
The time the last transaction started. The date format reflects the current locale setting for the operating system.
No
Read-Only
<Block Name.>TransactionStatus
The status of the transaction. Valid values are: InActive, Processing, and Completed.
No
Read-Only
<Block Name.>TransactionTimeAvg
The average amount of time required to process this group since the last statistics reset.
No
Read-Only
<Block Name.>TransactionTimeMax
The longest amount of time required to process this group since the last statistics reset.
No
Read-Only
<Block Name.>TransactionTimeMin
The shortest amount of time required to process this group since the last statistics reset.
No
Read-Only
<Block Name.>TransactionTimeout
The amount of time, in milliseconds, allowed for the block transaction to complete. If this value is 0, then there is no transaction timeout. The default value is 0. This attribute reflects the same attribute value in the current Active DI source.
No
None
<Block Name.>TransactionTimeoutAlarm
If TRUE, the transaction timeout has been exceeded.
No
Read-Only
<Block Name.>TransactionTrigger
If TRUE, the transaction will be started.
No
Supervisory, User
BlockReadList
The list of names of all configured block read groups. When a set is made with new values, it should contain a unique name for the block read group, from which data will be received.
No
None
BlockWriteList
The list of names of all configured block write groups. When a set is made with new values, it should contain a unique name for the block write group, from which data will be received.
No
None
ConnectionAlarm
If set to TRUE, one of the following has occurred: both DI source objects are in Bad state or the SwitchMax value has been reached.
Yes
Read-Only
ConnectionStatus
The status of the connection between the object and the Active DIObject data source. Possible values are Connected and Disconnected. Disconnected means both DI source objects are in Bad state, the Active DI source is in Bad state and no switchover can occur because SwitchMax has been reached, or the object is set to Offscan. If none of these has occurred, this attribute’s value is Connected.
No
Read-Only
DISourceActive
Contains the name of the current Active DIObject data source.
No
Read-Only
DISourceBackup
Contains the name of the DIObject that is configured as the backup source of I/O points.
Yes
Supervisory, User
DISourcePrimary
Contains the name of the DIObject that is configured as the primary source of I/O points.
Yes
Supervisory, User
DISourceStandby
Contains the name of the current standby DIObject data source.
No
Read-Only
ForceFailoverCmd
Trigger for causing a failover operation, the process of switching between the Active and Standby DIObjects. This operation occurs only if the Switch attempts count has not been reach or if the Switch attempts value is -1 (unlimited switches).
Yes
Supervisory, User
InAlarm
Contains the RedundantDIObject’s alarm state. It represents the alarm condition, except when alarming is disabled (in which case InAlarm is set to Off).
No
Read-Only
PingItems
A string containing ScanGroupName,PingItem pairs
Yes
Read-Only
<Scan Group Name.>Active
If set to TRUE, the object will register all of the data items in the group. If FALSE, all attributes in the scan group will be unregistered.
No
Supervisory, User
<Scan Group Name.>ItemCnt
The total number of items in the group that are on advise by a client application.
No
Read-Only
<Scan Group Name.>ItemErrorCnt
The current number of items within the group that have data quality other than GOOD. This value is calculated.
No
Read-Only
<Scan Group Name.>ItemErrorCntAlarm
If TRUE, the current error count is not zero. This value can be alarmed.
No
Read-Only
<Scan Group Name.>ItemErrorCntLast
The error count immediately prior to the current error count.
No
Read-Only
<Scan Group Name.>ItemErrorCntLastEnd
The last time the error count returned to zero. The date format reflects the current locale setting for the operating system.
No
Read-Only
<Scan Group Name.>ItemErrorCntLastStart
The last time that the error count changed from zero to non-zero, not including the most recent change. The date format reflects the current locale setting for the operating system.
No
Read-Only
<Scan Group Name.>ItemErrorCntStart
The time that the error count most recently changed from zero to non-zero. The date format reflects the current locale setting for the operating system.
No
Read-Only
<Scan Group Name.>ItemList
The list of user-defined names for item references. Normally, use the "Copy Attributes from Primary" or "Copy Attributes from Backup" buttons to copy attributes from either of the DI source objects.
Yes
None
<Scan Group Name.>ItemUpdateCnt
The number of items whose values were updated during the most recent scan cycle. For the RedundantDIObject, the value of this attribute is always equal to ItemCnt. To get the actual ItemUpdateCnt value from the field device, subscribe to the ItemUpdateCnt attribute of the Active source DIObject.
No
Read-Only
<Scan Group Name.>PingItem
Name of item used to monitor the connection status between the DI source object and the PLC device
No
Read-Only
<Scan Group Name.>ScanMode
The scanning mode for the scan group, either ActiveOnDemand, Active, or ActiveAll. For the ActiveOnDemand mode, attributes that are not actively being referenced by any client or object are not scanned. For the Active mode, an attribute is always in the active scanning state. When the last reference to the attribute is unregistered (unadvised) , the attribute is deleted. For ActiveAll, an attribute is always in the active scanning state, but when the last reference to the attribute is unregistered (unadvised), the attribute is not deleted.
No
Supervisory, User
<Scan Group Name.>UpdateRateCmd
The rate, in milliseconds, at which the object will receive updated data values for the Scan Group. This attribute reflects the same attribute value in the current Active DI source.
No
None
ScanGroupList
The list of names of all configured scan groups. When a set is made with new values, it should contain a unique name for the scan group, from which data will be received.
No
Read-Only
StatusBackupDISource
Contains the current status of the backup DIObject as observed from the RedundantDIObject. Possible values are Connected, Disconnected, Offscan, Unknown: Config Error (DISource not accessible), and Unknown: Comm Error (DISource not accessible). Unknown indicates the RedundantDIObject cannot communicate with the backup DIObject and therefore cannot provide its status.
No
Read-Only
StatusPrimaryDISource
Contains the current status of the primary DIObject as observed from the RedundantDIObject. Possible values are Connected, Disconnected, Offscan, Unknown: Config Error (DISource not accessible), and Unknown: Comm Error (DISource not accessible). Unknown indicates the RedundantDIObject cannot communicate with the primary DIObject and therefore cannot provide its status.
No
Read-Only
SwitchCnt
The number of times the RedundantDIObject has switched from Active to Standby DIObject data sources.
No
Read-Only
SwitchMax
The maximum number of switches allowed between Active and Standby DIObjects. Default value is unlimited (-1). Only integer values are valid. Minimum value is -1 (unlimited switches), zero means switch is not allowed, and all other integer values represent the total number of switches allowed before the ConnectionAlarm is raised. The attribute that tracks the number of switches between Active and Standby DIObjects is SwitchCnt. When SwitchCnt reaches the value of SwitchMax, the ConnectionAlarm is raised, and no more switches are allowed until SwitchCnt is reset.
Yes
Supervisory, User
SwitchoverAlarm
Alarm raised whenever a switchover occurs.
Yes
Read-Only
SwitchReason
Contains the reason for the last switch between Active and Standby DI sources. Possible values are Disconnected, Offscan, ForceFailover, ActiveDISourceChanged, Unknown: Config Error (DISource not accessible), and Unknown: Comm Error (DISource not accessible).
No
Read-Only
SwitchReasonPrevious
Contains the reason for the previous switch between Active and Standby DI sources. Possible values are Disconnected, Offscan, ForceFailover, ActiveDISourceChanged, Unknown: Config Error (DISource not accessible), and Unknown: Comm Error (DISource not accessible).
No
Read-Only
SwitchReset
Trigger that sets the SwitchCnt attribute to zero (0) and the SwitchAlarm.Alarmed to false.
Yes
Supervisory, User
SwitchTime
Contains the date and time of the last switch between Active and Standby DI sources.
No
Read-Only
SwitchTimePrevious
Contains the date and time of the previous switch between Active and Standby DI sources.
No
Read-Only