Object runtime attributes

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

CPULoad

The current percentage of CPU utilization.

For extra quality handling, see Quality handling.

Read-Only

CPULoadAvg

The average CPU utilization in percentage of the total.

For extra quality handling, see Quality handling.

Read-Only

CPULoadHiAlarm.Condition

Set to TRUE if the average CPU load exceeds the Hi limit. This value can be alarmed.

Read-Only

CPULoadMax

The maximum percentage of CPU utilization since the last statistics reset. A statistics reset causes the maximum CPU load to be reset to the current CPU load.

For extra quality handling, see Quality handling.

Read-Only

CPULoadMin

The minimum percentage of CPU utilization since the last statistics reset. A statistics reset causes the minimum CPU load to be reset to the current CPU load.

For extra quality handling, see Quality handling.

Read-Only

DiskBytesReadAvg

The average number of bytes transferred from the disk per read operation.

For extra quality handling, see Quality handling.

Read-Only

DiskBytesWriteAvg

The average number of bytes transferred to the disk per write operation.

For extra quality handling, see Quality handling.

Read-Only

DiskReadsAvg

The average number of disk reads per second, for all disks.

For extra quality handling, see Quality handling.

Read-Only

DisksLogicalNames

A listing of disk drive names on the computer.

Read-Only

DiskSpaceFree

The amount, in MB, of free disk space.

For extra quality handling, see Quality handling.

Read-Only

DiskSpaceFreeLoAlarm.Condition

The alarm condition flag for the disk space low alarm. This value is set to FALSE when the object is offscan. If the amount of free disk space (for any single logical disk) is less than the disk space Lo alarm limit, the DiskSpaceFreeLoAlarm.Condition is set to TRUE.

Read-Only

DiskWritesAvg

The average number of bytes written to disk per second.

For extra quality handling, see Quality handling.

Read-Only

Engine.AlarmsThrottled

The number of alarms that have been throttled in the prior scan. The limit for the number of alarms per second that can be raised by this object before throttling occurs is set using the alarm throttle limit.

Read-Only

Engine.AsyncScriptsRunningCnt

The total number of asynchronous scripts that are currently executing on the object.

Read-Only

Engine.AsyncScriptsWaitingCnt

The total number of asynchronous scripts that are currently queued to execute on the object, but are not yet executing because they are waiting for a free thread.

Read-Only

Engine.CheckPointFailed.Condition

Used to indicate whether the checkpointer failed to checkpoint the last attempt.

Read-Only

Engine.DataNotifyFailureConsecMax

The number of consecutive data change notification failures that will be allowed before the subscription is stopped by the publisher engine.

Supervisory, User

Engine.EngineAlarmRate

The number of alarms raised on this object during the prior scan by all objects running on this object, calculated as alarms per second. When alarm throttling occurs, the maximum value is the alarm throttle limit. This value is updated by the Notification Distributor.

Read-Only

Engine.ExternalReferenceCnt

The number of registered external references.

For extra quality handling, see Quality handling.

Read-Only

Engine.ExternalReferenceCntUnbound

The number of registered external references that are unbound.

For extra quality handling, see Quality handling.

Read-Only

Engine.Folding.Condition

Set to TRUE when Message Exchange folding is currently active, which means that this object is overloaded with regards to publishing throughput. Folding occurs when the object detects that a target object is receiving more data than it can process in a timely manner.

Read-Only

Engine.GlobalAdviseOnlyActiveEnabled

If set to TRUE, Galaxy-wide advising of only active items is enabled.

Read-Only

Engine.Historian.BufferCount

Obsolete. Do not use. Use the BufferSize attribute instead.

Read-Only

Engine.Historian.ConnectionPartner

The name of the partner Historian Server, if one is configured for the Historian. If no partner Historian is detected, the value of this attribute is an empty string.

Read-Only

Engine.Historian.ConnectState

The physical state of the connection between HCAL and the historian. This value should remain TRUE as long as HCAL is able to communicate with the historian, regardless of whether it is historizing data or not. A network failure, for example, will cause the ConnectState attribute to be set to FALSE. Even if the ConnectState attribute is FALSE, the AppEngine may still be connected to the historian and appear listed as a client in the historian System Management Console. In a redundant historian setup, the connect state is TRUE if the connection is good for at least one of the historians. To determine state of an individual historian in a redundant setup, use the ConnectStateMask attribute.

Read-Only

Engine.Historian.ConnectStateCmd

The ConnectStateCmd attribute is used to control the state of historization between the engine and the historian. If this value is set to FALSE, the engine will stop sending updates to HCAL, and HCAL will disconnect from the historian to ensure that a gap is displayed on a history trend. HCAL will disconnect from the historian even though it is able to communicate with it, as reflected by the ConnectState attribute.

Supervisory, User

Engine.Historian.ConnectStateMask

A bitmask where the lowest order bit represents the connection state of the primary Historian and the second bit represents the connection state of the partner. If no partner is configured, the second bit will always be 0.

Read-Only

Engine.Historian.ForwardingChunkSize

Obsolete. Do not use.

Read-Only

Engine.Historian.ForwardingDelay

Obsolete. Do not use.

Read-Only

Engine.Historian.InStoreForward

If set to TRUE, HCAL is in store-and-forward mode. In a redundant historian setup, the InStoreForward attribute is TRUE if either one of the historians is in store-and-forward mode. To determine state of an individual historian in a redundant setup, use the InStoreForwardMask attribute.

Read-Only

Engine.Historian.InStoreForwardMask

A bitmask where the lowest order bit represents the store-and-forward state of the primary Historian and the second bit represents the store-and-forward of the partner. If no partner is configured, the second bit will always be 0.

Read-Only

Engine.Historian.ProcessInterval

Obsolete. Do not use.

Read-Only

Engine.Historian.StoreForwardProblem

If set to TRUE, the HCAL on the active engine is unable to store data while in store-and-forward mode. In a redundant historian setup, the StoreForwardProblem attribute is TRUE if either one of the historians has a store-and-forward issue.

Read-Only

Engine.Historian.StoreForwardSpaceAvailable

The available storage space, in MB, for the HCAL of the active engine.

Read-Only

Engine.Historian.StoreFwdDataLost

Set to TRUE when HCAL is in store-and-forward mode, the store-and-forward deletion threshold has been exceeded, and history data has been lost. This value remains TRUE until the connection to the historian has been re-established and store-and-forward is no longer in effect.

Read-Only

Engine.IssuedExternalGetsCnt

The number of off-engine gets (initiated from AutomationObjects on this object).

For extra quality handling, see Quality handling.

Read-Only

Engine.IssuedExternalSetsCnt

The number of off-engine sets (initiated from AutomationObjects on this object).

For extra quality handling, see Quality handling.

Read-Only

Engine.IssuedInternalGetsCnt

The number of on-engine gets (initiated from AutomationObjects on this object).

For extra quality handling, see Quality handling.

Read-Only

Engine.IssuedInternalSetsCnt

The number of on-engine sets (initiated from AutomationObjects on this object).

For extra quality handling, see Quality handling.

Read-Only

Engine.ObjectQuarantined.Condition

Set to TRUE when at least one hosted object is in a quarantined state, indicating a software exception has occurred on the object. If all quarantined objects are later undeployed, the alarm will be disabled.

Read-Only

Engine.Objects

An array containing the names of all objects hosted by this object.

Read-Only

Engine.ProcessCPULoad

The current processor load that the engine is consuming.

Read-Only

Engine.ProcessIODataBytes

The current rate, in bytes per second, that the engine is reading and writing I/O bytes. I/O bytes include network bytes, file bytes, and all device I/O bytes.

Read-Only

Engine.ProcessPageFaults

The current page fault rate, per second, for the engine.

Read-Only

Engine.ProcessPrivateBytes

The current private bytes of memory that the engine has allocated.

Read-Only

Engine.ProcessWorkingSet

The current number of bytes in the working set of the engine. The working set is the amount of memory that the operating system has dedicated for the engine process.

Read-Only

Engine.PublisherDataNotifyFailureCnt

The total number of times that the engine, acting as a publisher, failed to send data change notifications to a subscriber.

Read-Only

Engine.PublishPacketsRcvdCnt

The number of publish packets received on this engine from other engines.

For extra quality information, see Quality handling.

Read-Only

Engine.PublishPacketsSentCnt

The number of publish packets sent from this engine to other engines.

For extra quality information, see Quality handling.

Read-Only

Engine.RcvdExternalGetsCnt

The number of incoming external gets (received from other engine objects that do not exist on this object).

For extra quality handling, see Quality handling.

Read-Only

Engine.RcvdExternalSetsCnt

The number of incoming external sets (received from other engine objects that do not exist on this object).

For extra quality handling, see Quality handling.

Read-Only

Engine.StartingFromCheckpoint

If set to TRUE, an engine is starting and restoring a checkpoint file.

Read-Only

Engine.StartupReason

Indicates whether an engine is starting after deployment, from a checkpoint, or from standby (failover). Valid values are: Starting_AfterDeploy, Starting_FromCheckpoint, Starting_FromStandby.

Read-Only

Engine.StatsReset

Used to reset all statistics during run time.

Supervisory, User

Engine.SubscribedAttrCnt

The number of attributes on this engine, including the attributes of all objects hosted on this engine, that are being subscribed to (read) by other engines and their hosted objects and anonymous engines, such as the Object Viewer and InTouch.

Read-Only

Engine.SubscribedObjectCnt

The number of objects on this engine that have one or more attributes that are subscribed to by other engines.

Read-Only

Engine.SubscriberEngineCnt

The number of other engines that are subscribing to attributes on this engine. For example, if InTouch View is displaying 10 attributes from this engine, and objects hosted on another AppEngine are reading data from five objects on this engine, then the value is 2.

Read-Only

Engine.SubscriptionAttemptCnt

The total number of subscriptions initiated by this engine.

Read-Only

Engine.SubscriptionCancelledCnt

The total number of subscriptions initiated by this engine that were cancelled by the publisher.

Read-Only

Engine.SubscriptionFailureCnt

The total number of subscription failures detected by this engine.

Read-Only

Engine.SubscriptionFailureCommsCnt

The number of subscription failures detected by this engine that resulted from platform or engine communications errors.

Read-Only

Engine.SubscriptionFailureConfigCnt

The total number of times that the engine, acting as a publisher, failed to send data change notifications to a subscriber.

Read-Only

Engine.SubscriptionLocalCnt

The current number of active subscriptions to an engine on the local platform.

Read-Only

Engine.SubscriptionRemoteCnt

The current number of active subscriptions to an engine on a remote platform.

Read-Only

Engine.SuspendedAttributeCnt

The number of attributes on this engine that are currently in a suspended (or inactive) state.

Read-Only

EngineFailureAlarm.Condition

The alarm flag indicating that an AppEngine object has unexpectedly failed. This value is set to TRUE when any AppEngine object fails. This value is set to FALSE when a failed AppEngine object has been successfully started back up and is running onscan or offscan. This value can be alarmed.

Read-Only

EngineFailureAlarm.Desc

The message associated with the AppEngine object failure alarm condition. The name of the AppEngine object that failed is embedded in the message.

Read-Only

GR.BindCnt

The number of bind requests since the last statistics reset.

Read-Only

GR.BindFailCnt

The number of bind failures since the last statistics reset.

Read-Only

GR.BindReference

The platform used to bind references.

Read-Only

GR.StatsReset

Used to reset all accumulated statistics.

Supervisory, User

GR.TimeOfLastConfigChange

For name-binding optimization, this value indicates the time of the most recent check-in. The date format reflects the current locale for the operating system.

Read-Only

GR.TimeOfLastDeploy

For name-binding optimization, this value indicates the time of the most recent object deployment. The date format reflects the current locale for the operating system.

Read-Only

InterruptsAvg

The average number of WinPlatform object interrupts. Interrupts are instances when data is stored, rather than sent to the intended recipient.

For extra quality handling, see Quality handling.

Read-Only

LMXProtocolVersion

The protocol version of Local Message Exchange (LMX).protocol version of Local Message Exchange (LMX).

Read-Only

NetNMXBytesRcvdAvg

The average network bytes received per second.

For extra quality handling, see Quality handling.

Read-Only

NetNMXBytesSentAvg

The average network bytes sent per second.

For extra quality handling, see Quality handling.

Read-Only

NetNMXDisconnectCnt

The number of times that the primary messaging communications channel has been disconnected.

For extra quality handling, see Quality handling.

Read-Only

NetNMXDisconnected

If set to TRUE, the primary network messaging channel is currently disconnected.

For extra quality handling, see Quality handling.

Read-Only

NetNMXHeartbeatsMissedCnt

The total number of heartbeats missed for the primary messaging channel for all remote platforms.

For extra quality handling, see Quality handling.

Read-Only

NetNMXHeartbeatsMissedConsecCnt

The number of consecutive heartbeats currently missed for the primary messaging channel for all remote platforms. When two heartbeats are missed in a row, the value of the NetNMXHeartbeatsMissedConsecCnt attribute is incremented by 1. The value of the NetNMXHeartbeatsMissedConsecCnt attribute (if greater than 0) will always be at least 1 less than the value of the NetNMXHeartbeatsMissedCnt attribute.

For extra quality handling, see Quality handling.

Read-Only

NetRMCDisconnectCnt

The number of times that the redundancy messaging communications channel has been disconnected.

For extra quality handling, see Quality handling.

Read-Only

NetRMCDisconnected

If set to TRUE, the redundancy network messaging channel (RMC) is currently disconnected.

For extra quality handling, see Quality handling.

Read-Only

NMXLocalMsgsCnt

The number of local messages (between engines located only on this WinPlatform) since the last statistics reset. (This value is set to 0 when the object goes offscan.)

For extra quality handling, see Quality handling.

Read-Only

NMXProtocolVersion

The protocol version of Network Message Exchange (NMX).

Read-Only

NMXRequestsRcvdOffNodeAccumSize

The total size, in KB, of requests received from other platforms.

For extra quality handling, see Quality handling.

Read-Only

NMXRequestsRcvdOffNodeCnt

The total number of requests received from other platforms.

For extra quality handling, see Quality handling.

Read-Only

NMXRequestsRcvdOffNodeSizeMax

The largest request message, in bytes, received from any other platform.

For extra quality handling, see Quality handling.

Read-Only

NMXRequestsSentOffNodeAccumSize

The total size, in KB, of requests sent to other platforms.

For extra quality handling, see Quality handling.

Read-Only

NMXRequestsSentOffNodeCnt

The total number of requests sent to other platforms.total number of requests sent to other platforms.

For extra quality handling, see Quality handling.

Read-Only

NMXRequestsSentOffNodeSizeMax

The largest request message, in bytes, sent to any other platform.

For extra quality handling, see Quality handling.

Read-Only

NMXResponsesRcvdOffNodeAccumSize

The total size, in KB, of responses received from other platforms.

For extra quality handling, see Quality handling.

Read-Only

NMXResponsesRcvdOffNodeCnt

The total number of responses received from other platforms.

For extra quality handling, see Quality handling.

Read-Only

NMXResponsesRcvdOffNodeSizeMax

The largest response message, in bytes, received from any other platform.

For extra quality handling, see Quality handling.

Read-Only

NMXResponsesSentOffNodeAccumSize

The total size, in KB, of responses sent to other platforms.

For extra quality handling, see Quality handling.

Read-Only

NMXResponsesSentOffNodeCnt

The total number of responses sent to other platforms.

For extra quality handling, see Quality handling.

Read-Only

NMXResponsesSentOffNodeSizeMax

The largest response message, in bytes, sent to any other platforms.

For extra quality handling, see Quality handling.

Read-Only

PageFaultsAvg

The average amount of page faults occurring on this computer. A page fault is the process of accessing data in virtual memory (in the swap file of the hard drive) when RAM does not or cannot contain the data.

For extra quality handling, see Quality handling.

Read-Only

PageFaultsHiAlarm.Condition

The alarm condition flag for the PageFaultsAvgHi alarm. This value is set to FALSE when the object is offscan. If the average number of page faults is greater than the Hi alarm limit and not within the deadband, then the PageFaultsHiAlarm.Condition is set to TRUE.a

Read-Only

PlatformInfo

The processor and operating system configuration for the computer.

For extra quality handling, see Quality handling.

Read-Only

PlatformRestartNeeded

If set to TRUE, a change in the GlobalAdviseOnlyActiveEnabled attribute is detected. All engines on this Platform should be restarted. Set to FALSE when the Platform restarts.

Read-Only

ProcessCnt

The number of Windows 32-bit processes (ArchestrA components and otherwise) running on this computer.

For extra quality handling, see Quality handling.

Read-Only

RAM

The actual amount of RAM on the computer, in MB. This value is calculated only once at startup.

For extra quality handling, see Quality handling.

Read-Only

RAMAvailableAvg

The average amount of free RAM available on the computer.

For extra quality handling, see Quality handling.

Read-Only

RAMAvailableLoAlarm.Condition

The alarm condition flag for the RAMAvailableAvgLo alarm. This value is set to FALSE when the object is offscan. If the average amount of RAM available is less than the Lo alarm limit and not within the deadband, this value is set to TRUE. This value can be alarmed.

Read-Only

Scheduler.CheckpointPeriodAvg

The average number of milliseconds between checkpoints for the averaging period.

For extra quality handling, see Quality handling.

Read-Only

Scheduler.ExecInterruptsTimeAvg

The average number of milliseconds required to perform execution interrupts per engine scan cycle.

For extra quality information, see Quality handling.

Read-Only

Scheduler.ExecutionTimeAvg

The average number of milliseconds required to execute all objects per cycle.

For extra quality handling, see Quality handling.

Read-Only

Scheduler.HousekeepingTimeAvg

The average number of milliseconds required for this object to do housekeeping tasks per cycle.

For extra quality handling, see Quality handling.

Read-Only

Scheduler.InputMsgSizeAvg

The average size of an input message, in bytes, for this averaging period.

For extra quality handling, see Quality handling.

Read-Only

Scheduler.InputMsgsProcessedAvg

The average number of input messages, in total bytes, in the input queue per scan period (including deferred and processed messages).

For extra quality handling, see Quality handling.

Read-Only

Scheduler.InputMsgsQueuedAvg

The average number of messages queued, including processed and deferred messages, per scan period. The value is calculated for the averaging period.

For extra quality handling, see Quality handling.

Read-Only

Scheduler.InputMsgsQueuedMax

The maximum value of the average number of queued input messages since the last statistics reset.

For extra quality handling, see Quality handling.

Read-Only

Scheduler.InputQueueSizeAvg

The average size, in bytes, of the input queue during the averaging period.

For extra quality handling, see Quality handling.

Read-Only

Scheduler.InputQueueSizeMax

The maximum value of the average input queue size since the statistics were last reset.

For extra quality handling, see Quality handling.

Read-Only

Scheduler.ObjectCnt

For a WinPlatform object, this value is always 1.

Read-Only

Scheduler.ObjectsOffScanCnt

For a WinPlatform object, this value is 0.

Read-Only

Scheduler.ScanCyclesCnt

The number of execution cycles since the statistics were last reset.

Read-Only

Scheduler.ScanOverrun.Condition

A Boolean condition alarm flag indicating a scan overrun condition. This value is set to FALSE when the object goes offscan.

Read-Only

Scheduler.ScanOverrunsCnt

The number of scan overruns since the last time statistics were reset.

Read-Only

Scheduler.ScanOverrunsConsecCnt

The number of consecutive scan overruns. This value increments by 1 when a scan overrun occurs. This value is set to 0 when the object goes offscan.

Read-Only

Scheduler.ScanTime

The current, local, system time for a given scan of the AppEngine that contains this scheduler. The date format reflects the current locale setting for the operating system.

For extra quality handling, see Quality handling.

Read-Only

Scheduler.StatsReset

Used reset all statistics during run time.

Supervisory, User

Scheduler.TimeIdleAvg

The average number of milliseconds per scan period that the object is idle (for example, receiving data, or sending data).

For extra quality handling, see Quality handling.

Read-Only

Scheduler.TimeIdleMax

The maximum value for the TimeIdleAvg attribute since statistics were reset or since the engine went onscan.

For extra quality handling, see Quality handling.

Read-Only

Scheduler.TimeIdleMin

The minimum value for the TimeIdleAvg attribute since statistics were reset or since the engine went onscan.

For extra quality handling, see Quality handling.

Read-Only

Scheduler.TimeInputAvg

The average number of milliseconds required to process input messages per scan period.

For extra quality handling, see Quality handling.

Read-Only

Scheduler.TimeOutputAvg

The average number of milliseconds required to process output messages per scan period.

For extra quality handling, see Quality handling.

Read-Only

StandbyEngines

The names of engines running as standby engines on this platform.

Read-Only

StoreFwdDirInvalid

If set to TRUE, the store-and-forward directory could not be created, and thus the store-and-forward data will be stored into the default directory.

Read-Only

StatsReset

Used to reset accumulated statistics. All accumulated counts, maximums, and minimums will be reset.

User

SystemStartupTime

Thetime that the WinPlatform object was last started. The date format reflects the current locale for the operating system.

Read-Only

ThreadCnt

The number of threads running on this WinPlatform object.

For extra quality handling, see Quality handling.

Read-Only