Runtime object attributes
- Last UpdatedJul 19, 2024
- 5 minute read
This topic and the following topics describe the runtime only attributes for the object.
Note: Configurable runtime attributes are described in the configuration sections. For more information, see OPCClient object configuration.
For a list of common attributes, click Attributes Help in the Help file header.
|
Attribute |
Description |
runtime Access (Supervisory, User, Read-Only, None) |
|---|---|---|
|
AlarmDSCnt |
The total number of disabled and silenced alarms in the object. Sub-areas or sub-notification-distributors are not included. |
Read-Only |
|
AlarmOnCnt |
The number of active alarms in the distributor. Does not include sub-areas or sub-notification-distributors. |
Read-Only |
|
AlarmUnAckCnt |
The number of unacknowledged alarms in the distributor (including unacknowledged return-to-normals). Does not include sub-areas or sub-notification-distributors. |
Read-Only |
|
BlockRead.AliasDatabase |
Used to store pairs of alias attribute names and the corresponding item references. |
Read-Only |
|
BlockRead.ItemCnt |
The total number of items in the group that are on advise by a client application. |
Read-Only |
|
BlockRead.ItemErrorCnt |
The current number of items that have been successfully added to this group and have data quality other than GOOD. This value is calculated. |
Read-Only |
|
BlockRead.ItemErrorCntAlarm |
Set to TRUE if the current error count is not zero. This value can be alarmed. |
Read-Only |
|
BlockRead.ItemErrorCntLast |
The error count immediately prior to the current error count. |
Read-Only |
|
BlockRead.ItemErrorCntLastEnd |
The last time the error count returned to zero. The date format reflects the current locale setting for the operating system. |
Read-Only |
|
BlockRead.ItemErrorCntLastStart |
The last time that the error count changed from zero to non-zero, not including the most recent change to the error count. The date format reflects the current locale setting for the operating system. |
Read-Only |
|
BlockRead.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. |
Read-Only |
|
BlockRead.StatsReset |
Used to reset all statistics during run time. |
Supervisory, User |
|
BlockRead.TransactionComplete |
Set to TRUE when the transaction has completed. |
Read-Only |
|
BlockRead.TransactionEnd |
The time the last transaction ended. The date format reflects the current locale setting for the operating system. |
Read-Only |
|
BlockRead.TransactionsCnt |
The total number of transactions since the last statistics reset. |
Read-Only |
|
BlockRead.TransactionStart |
The time the last transaction started. The date format reflects the current locale setting for the operating system. |
Read-Only |
|
BlockRead.TransactionStatus |
Used to indicate the status of the transaction. Valid values are: InActive, Processing, and Completed. |
Read-Only |
|
BlockRead.TransactionTimeAvg |
The average amount of time required to process this group since the last statistics reset. |
Read-Only |
|
BlockRead.TransactionTimeMax |
The longest amount of time required to process this group since the last statistics reset. |
Read-Only |
|
BlockRead.TransactionTimeMin |
The shortest amount of time required to process this group since the last statistics reset. |
Read-Only |
|
BlockRead.TransactionTimeoutAlarm |
Set to TRUE if the transaction timeout has been exceeded. |
Read-Only |
|
BlockRead.TransactionTrigger |
If TRUE, the transaction will be started. |
Supervisory, User |
|
BlockWrite.AliasDatabase |
Used to store pairs of alias attribute names and the corresponding item references. |
Read-Only |
|
BlockWrite.ItemCnt |
The total number of items in the group that are on advise by a client application. |
Read-Only |
|
BlockWrite.ItemErrorCnt |
The current number of items that have been successfully added to this group and have data quality other than GOOD. This value is calculated. |
Read-Only |
|
BlockWrite.ItemErrorCntAlarm |
Set to TRUE if the current error count is not zero. This value can be alarmed. |
Read-Only |
|
BlockWrite.ItemErrorCntLast |
The error count immediately prior to the current error count. |
Read-Only |
|
BlockWrite.ItemErrorCntLastEnd |
The last time the error count returned to zero. The date format reflects the current locale setting for the operating system. |
Read-Only |
|
BlockWrite.ItemErrorCntLastStart |
The last time that the error count changed from zero to non-zero, not including the most recent change to the error count. The date format reflects the current locale setting for the operating system. |
Read-Only |
|
BlockWrite.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. |
Read-Only |
|
BlockWrite.StatsReset |
Used to reset all statistics during run time. |
Supervisory, User |
|
BlockWrite.TransactionComplete |
Set to TRUE when the transaction has completed. |
Read-Only |
|
BlockWrite.TransactionEnd |
The time the last transaction ended. The date format reflects the current locale setting for the operating system. |
Read-Only |
|
BlockWrite.TransactionsCnt |
The total number of transactions since the last statistics reset. |
Read-Only |
|
BlockWrite.TransactionStart |
The time the last transaction started. The date format reflects the current locale setting for the operating system. |
Read-Only |
|
BlockWrite.TransactionStatus |
Used to indicate the status of the transaction. Valid values are: InActive, Processing, and Completed. |
Read-Only |
|
BlockWrite.TransactionTimeAvg |
The average amount of time required to process this group since the last statistics reset. |
Read-Only |
|
BlockWrite.TransactionTimeMax |
The longest amount of time required to process this group since the last statistics reset. |
Read-Only |
|
BlockWrite.TransactionTimeMin |
The shortest amount of time required to process this group since the last statistics reset. |
Read-Only |
|
BlockWrite.TransactionTimeoutAlarm |
Set to TRUE if the transaction timeout has been exceeded. |
Read-Only |
|
BlockWrite.TransactionTrigger |
If TRUE, the transaction will be started. |
Supervisory, User |
|
ConnectionAlarm |
Set to TRUE if the OPCClient object can no longer communicate with the OPC communications driver. |
Read-Only |
|
ConnectionStatus |
The status of the link between the OPCClient object and the OPC communications driver. Valid values: CONNNECTED, DISCONNECTED. |
Read-Only |
|
RestartAlarm |
Set to TRUE if the number of attempts to start the OPC communications driver has exceeded the allowed maximum within the restart period. |
Read-Only |
|
RestartCnt |
The number of times the OPC communications driver has been restarted during the restart period. |
Read-Only |
|
RestartReset |
If TRUE, the restart count will be set back to zero. The RestartAlarm attribute (if enabled) will be turned off. |
Supervisory, User |
|
ScanGroup.Active |
If the Active attribute is set to TRUE, and the ScanMode attribute is set to Active or ActiveAll, the object attempts to scan all of the data items in the group. If the Active attribute is set to TRUE, and the ScanMode attribute is set to ActiveOnDemand, the object attempts to scan data items in the group individually according to demand. If the Active attribute is set to FALSE, no scanning occurs, regardless of the setting of the ScanMode attribute. |
Supervisory, User |
|
ScanGroup.AliasDatabase |
Used to store pairs of alias attribute names and the corresponding item references. |
Read-Only |
|
ScanGroup.ItemCnt |
The total number of items in the group that are on advise by a client application. |
Read-Only |
|
ScanGroup.ItemErrorCnt |
The current number of items that have been successfully added to this group and have data quality other than GOOD. This value is calculated. |
Read-Only |
|
ScanGroup.ItemErrorCntAlarm |
Set to TRUE if the current error count is not zero. This value can be alarmed. |
Read-Only |
|
ScanGroup.ItemErrorCntLast |
The error count immediately prior to the current error count. |
Read-Only |
|
ScanGroup.ItemErrorCntLastEnd |
The last time the error count returned to zero. The date format reflects the current locale setting for the operating system. |
Read-Only |
|
ScanGroup.ItemErrorCntLastStart |
The last time that the error count changed from zero to non-zero, not including the most recent change to the error count. The date format reflects the current locale setting for the operating system. |
Read-Only |
|
ScanGroup.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. |
Read-Only |
|
ScanGroup.ItemUpdateCnt |
The number of items whose values were updated during the most recent scan cycle. |
Read-Only |
|
ScanGroup.PingItem |
The item quality of this item is checked on each scan to determine the scan group status. |
Read-Only |
|
SlowPollInterval |
The slow poll interval, in milliseconds, in which the OPCClient object periodically retries the connection to the disconnected OPC communications driver after it goes into slow poll mode. This occurs after the "restart attempts" have been reached when certain connectivity problems, such as an unplugged network cable, prevent the OPCClient object from connecting to the OPC Server. When the OPCClient object achieves connectivity again with the OPC communications driver, it exits the slow poll mode and returns to normal operations. Slow polling is turned off if the value of this attribute is set to 0 (the default). The minimum value for slow poll is 6,000 milliseconds (6 seconds) to account for the time to confirm a broken network connection. |
Supervisory, User |