WinPlatform Object

The WinPlatform AutomationObject represents a deployed Windows computer in an ArchestrA Galaxy. Before you can deploy a WinPlatform object, you must install the ArchestrA Bootstrap software on the target computer.

Click one of the following Help topics to navigate to information about that topic.

Overview

The WinPlatform object is a key member of the core set of AutomationObjects within the ArchestrA system infrastructure. The WinPlatform object can be further classified as a System Object and as a Platform Object.

For general information on objects, including relationships, deployment, and alarm distribution, see the Integrated Development Environment (IDE) documentation.

For information on configuration options of object scripts, attributes, or features, click Object Help in the Help file header.

Run-Time Behavior

Run-time behavior pertains to the running state of a deployed WinPlatform object. Once deployed and operating, WinPlatform objects can assume one of several states:

State Change	Behavior
Startup	During this transition state, AppEngine objects hosted by the WinPlatform object and with a startup type of Semiautomatic or Automatic are started when the WinPlatform starts up.
Going onscan	During this transition state, for data that have calculated quality, the quality property is updated. When going onscan, data quality is set to INITIALIZING. Data quality is subsequently set to GOOD during execution.
Running onscan	In this state, all statistics are calculated.
Going offscan	During this transition state, for data that have calculated quality, the quality property is updated. When going offscan, data quality is set to BAD.
Offscan	In this state the WinPlatform object and all hosted objects are passive.
Shutdown	During this transition state, AppEngine objects hosted by the WinPlatform object are shut down upon shutdown of the WinPlatform object.

Important! Since the WinPlatform must be onscan for any of its hosted objects to be onscan, it is important that the Windows computer to which the WinPlatform is deployed to always be running in order for the system to function properly.

Configuration

The following sections describe the object editor options for configuration and the associated attributes:

For general information on objects, including relationships, deployment, and alarm distribution, see the Integrated Development Environment (IDE) documentation.

For information on configuration options of object scripts, attributes, or features, click Attributes Help in the Help file header.

General Configuration

Topic Category	Topic Subcategory	Topic Details
Configuration	General Configuration
Engine Configuration
Alarms Configuration
Platform History Configuration
Scheduler History Configuration
Engine History Configuration

Use the General tab to configure general properties for the WinPlatform object.


Editor Option	Associated Attribute	Description	Run-Time Access (Supervisory, User, Read-Only, None)
Network address	NodeName	The network address of the computer hosting this WinPlatform object. This designation can be either host name or IP address.	Read-Only
History store forward directory	StoreFwdDir	The base path used by the ArchestrA historian Historian Access Client Layer (HCAL) store-and-forward mechanism to store its data on disk. The data is always stored in a specific subdirectory of this location, based on the tagname of the object hosting the WinPlatform or AppEngine object. If this value is blank or invalid, the directory corresponding to CSIDL_COMMON_APPDATA is used as the base root as per the standard for the Windows XP operating system. For example, C:\Documents and Settings\All Users\Application Data\ArchestrA. The name of the object is always appended to the specified store-and-forward directory. For example, if you specify the store-and-forward location as C:\SFData\, then the actual folder that will be created is C:\SFData\<objectname>. Store-and-forward will not work properly if two or more processes specify the same location. For more information on HCAL, see the ArchestrA Historian documentation.	Read-Only
Minimum RAM	RAMMin	The minimum allowable amount of RAM, in MB, for the computer on which the platform will be deployed. You cannot specify a value lower than 512 MB. The default is 1024 MB.	Read-Only
InTouch alarm provider	ITAlarmProvider.Enabled	If enabled, this WinPlatform object will act as an alarm provider to the InTouch distributed alarm system.	None
Register Using GalaxyName	ITAlarmProvider.ProviderNameAsGalaxyNameEnabled	If enabled, this WinPlatform object will register to Alarm Manager. Format is Galaxy_<GalaxyName>. Default is disabled.	None
N/A	ITAlarmProvider.ProviderName	If ProviderNameasGalaxyName is enabled, the calculated value of this atrirbute in run time will be Galaxy_<GalaxyName>. If disabled, the value will be Galaxy. Use this calculated value to determine at run time, without returning to development, whether or not to use the Galaxy_<GalaxyName> format.	Read-Only
Alarm areas	ITAlarmProvider.Subscription	A space-separated list of areas to subscribe to. For example, "Area1 Area2 Area3". If blank, the platform will subscribe to all areas in the Galaxy and act as an InTouch alarm provider for the whole Galaxy.	Read-Only
Communication Failure Alarm Priority	ITAlarmProvider.CommFailureAlarmPriority	If InTouch alarm provider is enabled, you can configure the priority of communication failure alarms as an integer, 1—999.	Read-Only
Statistics average period	StatsAvgPeriod	The period, in milliseconds, for calculating all average statistics. If this value is less than or equal to the scan period for the object, then the statistics average period is set to every scan period. Valid range is 0 to 86,400.	Supervisory, User
Redundancy message channel IP address	NetRMCAddr	The redundancy message channel IP address is IP address of a network adapter that exists on a redundancy network. This redundancy network is used by redundancy-enabled engines to transmit redundancy information. For more information on configuring the redundant network, see the Integrated Development Environment (IDE) documentation.	Read-Only
Redundancy message channel port	PortRMC	The port used by the redundancy message channel to synchronize data with a standby engine.	Read-Only
Redundancy primary channel port	PortRPC	The port used by the failover service to manage heartbeats with the standby engine over the primary network.	Read-Only
Message timeout	NMXMsgMxTimeout	The time period, in milliseconds, allowed for a response message in cross-engine communications before a timeout will occur. Valid range is 1 to 300000. If timeouts persist, the object should be restarted. Default is 30,000 ms.	Supervisory, User
NMX heartbeat period	NetNMXHeartbeatPeriod	The time interval, in milliseconds, at which heartbeats are sent to other platforms. Heartbeats will only be established between platforms if a publish/subscribe relationship exists between engines on the platforms. For example, if an engine on WinPlatformA is subscribed to data from an engine on WinPlatformB, then heartbeats will be sent between WinPlatformA and WinPlatformB. WinPlatformA will send heartbeats to WinPlatformB at the rate specified by the WinPlatformA NetNMXHeartbeatPeriod attribute. WinPlatformB will send heartbeats to WinPlatformA at the rate specified by the WinPlatformB NetNMXHeartbeatPeriod attribute. Recommended (Small System default) value is 2000 ms.	Supervisory, User
Consecutive number of missed NMX heartbeats allowed	NetNMXHeartbeatsMissedConsecMax	The maximum number of consecutive heartbeats that are allowed to be missed from a platform before a "platform communication error" is generated for that platform. For example, assume an engine on WinPlatformA is subscribed to data from an engine on WinPlatformB. If the NetNMXHeartbeatsMissedConsecMax attribute on WinPlatformB has a value of 5, then WinPlatformA will generate a "platform communication error" when it misses six consecutive heartbeats from WinPlatformB. If the NetNMXHeartbeatsMissedConsecMax attribute on WinPlatformA has a value of 2, then WinPlatformB will generate a "platform communication error" when it misses three consecutive heartbeats from WinPlatformA. Specifying a value of 0 is not recommended, as it may trigger false communication errors that would deteriorate the system performance. Recommended values: Small System (default): 3 Medium-Large System: 6 Very Large System: 6	Supervisory, User
Message exchange port	PortNMX	The port used by Message Exchange when communicating with other platforms.	Read-Only

Engine Configuration

Use the Engine tab to configure engine-related aspects of the WinPlatform object, such as startup options, historian options, and scripting options


Editor Option	Associated Attribute	Description	Run-Time Access (Supervisory, User, Read-Only, None)
Engine startup type	Engine.StartupType	The type of startup for the object the next time startup occurs: Auto or Manual. For an automatic startup, the WinPlatform starts automatically in the last check-pointed scan state. For a manual start, the WinPlatform must be started using the System Management Console.	Supervisory, User
Restart the engine when it fails	Engine.RestartOnFailure	If selected the object will automatically attempt to restart if a failure occurs. A failure to start is defined as an object failing within five minutes of startup. Therefore, if an object operates longer than five minutes and then fails, and this option has been selected, three subsequent attempts will be made to start the object. If an object fails to start three times in a row, within five minutes, no more attempts are made to start it.	Supervisory, User
Scan period	Scheduler.ScanPeriod	The period of time, in milliseconds, at which the WinPlatform object updates the statistics that it monitors.	Supervisory, User
Enable storage to historian	Engine.Historian.Enabled	If enabled, the values for attributes that have historization enabled will be stored to the specified historian.	None
Enable Tag Hierarchy	Engine.Historian.EnableTagHierarchy	If enabled, the model view is automatically replicated to the Wonderware Historian node associated with the Galaxy. You can control this behavior at run time without undeploying and redeploying the engine of any affected objects.	Supervisory, User
Historian	Engine.Historian.Connection	The string to use for the connection to the historian. For the Wonderware Historian, this is the node name. If two Historian Servers are configured as partners, the node identified by this string becomes the primary historian for this engine. The partner information is configured and maintained on the Historian Server. Click the ellipse button to browse for the historian on the network.	Read-Only
TCP Port	Engine.Historian.ConnectionTCPPort	The TCP port on the Historian Server node to which history data will be sent. The TCP port is configured when the Historian Server is installed. The default is 32568.	Read-Only
Enable compression	Engine.Historian.CompressionEnable	If enabled, history data is compressed before it is sent over the network to the Historian Server. This is used to reduce network utilization, but enabling this setting will increase the CPU load.	Read-Only
Throttling network bandwidth	Engine.Historian.BandwidthLimit	Specifies limit of bandwidth usage, in kbps, for network communication used by HCAL when communicating with the Wonderware Historian. A value of 0 disables this feature (default). For more information on estimating your bandwidth needs, see the performance and sizing recommendations for the Historian Server in the Wonderware System Platform Installation Guide. On networks with limited bandwidth (for example, 256 kbps) you may want keep half of the bandwidth available for other traffic, so you would set this value to 128 kbps. Consider when the historian connection is lost, and store-and-forward data has accumulated on AppEngine nodes. When the connection between an AppEngine node and historian is restored, all the store-and-forward data is sent at once, and may use the entire network bandwidth (on a slow network) and cause the AppEngines to again lose communication with the Historian and go into store-and-forward data again. By setting a limit here of 2/3 the total bandwidth, this problem of AppEngines going in and out of store-and-forward can be avoided. This limit applies to all history-related communication, including tag creation, sending real-time data, sending late data, and sending store-and-forward data.	Read-Only
Wait to send incomplete packets	Engine.Historian.BufferAgeLimit	Specifies the maximum time, in milliseconds, for keeping a partially-filled Historian Client Access Layer (HCAL) buffer before sending it to the Historian Server. If the buffer is full, then it is sent immediately, regardless of any value configured in this field. If you have fast-changing data, this setting is irrelevant. If you have slow-changing data and limited network bandwidth, you might want to increase this value so that you have less "chatter" on the network. The default is 1,000 milliseconds. Valid values are between 1,000 and 30,000 milliseconds.	Read-Only
Pre-processing buffer size	Engine.Historian.BufferSize	The total size, in MB, of all buffers used by Historian Client Access Layer (HCAL). The default and minimum value is 8. If you have very high data bursts, then you should increase this value. If this is too low, data loss occurs and error messages related to buffer overflows appear in the ArchestrA Logger. Increase this value in increments of 10 MB.	Supervisory, User
Store forward threshold	Engine.Historian.StoreForwardDeletionThreshold	The size, in MB, of free space to reserve on the HCAL store-and-forward disk. The space designated will not be used during store-and-forward. This value cannot be a negative number.	Read-Only
Store forward minimum duration	Engine.Historian.StoreForwardMinDuration	The minimum duration, in seconds, for HCAL to function in store-and-forward mode. HCAL will function in store-and-forward mode for this length of time even if the condition that caused HCAL to function in store-and-forward mode no longer exists.	Supervisory, User
Maximum time for scripts to execute	Engine.ScriptExecuteTimeout.Limit	The allowed time, in milliseconds, for any synchronous script to execute before an alarm is triggered. This timeout applies to scripts attached directly to the WinPlatform object. If the configuration security symbol is displayed in the shield, then this element can only change when the object is set to offscan. This allows for the optimization of the script engine, since it needs to read this setting only once when the WinPlatform object goes onscan.	Supervisory, User
Maximum asynchronous thread count	Engine.AsyncScriptThreadMax	The maximum number of asynchronous script threads that can be executing simultaneously.	Read-Only
Checkpoint period	Scheduler.CheckpointPeriod	The interval, in milliseconds, at which checkpointing should be performed. If set to 0, checkpointing will be performed as fast as possible as a background task.	Supervisory, User
Checkpoint directory location	Engine.CheckpointPath	The path where the checkpoint files will be located. If you do not specify a location, the system default path will be used. If the specified location is not accessible, a warning will be logged. If the location you specify does not currently exist, it will be created. You cannot use a virtual drive or a UNC path for the checkpoint directory location.	Read-Only
Alarm throttle limit	Engine.AlarmThrottleLimit	The limit for the number of alarms per second that can be raised by the object before throttling occurs. If set to 0, alarm throttling is disabled.	Supervisory, User
Statistics average period	Scheduler.StatsAvgPeriod	The frequency, in milliseconds, that averaged attribute values are updated. This value must be greater than or equal to the scan period. The average is a running average; that is, values are accumulated for an attribute over the period of time set for this attribute. The value of this attribute affects the run-time values at any given time of all other attributes of the same type of object that are averaged and can be used to "slow down" the updating of the cycle-oriented statistics.	Supervisory, User
Maximum input queue size	Scheduler.InputQueueSizeMaxAllowed	The maximum size for the object input queue. The default is 16 MB. An object's input queue receives all system level messages, such as publish packets, heartbeats, gets, sets, and so on. These messages are then processed by the system. The input queue size grows and shrinks over time. Should the input queue grow to its maximize size, messages are not queued until messages in the queue are processed, making room for additional ones. Valid values are 2 through 128.	Read-Only
Engine failure timeout	Engine.EngineFailureTimeout	The amount of time, in milliseconds, that the engine can run without notifying the bootstrap of its health. After this time elapses, the EngineFailureAlarm attribute is set TRUE in the WinPlatform object. Be sure that you specify a time long enough to accommodate the completion of any engine-related actions that might prevent or delay the bootstrap notification (for example, cascade deployment of objects with a large number of scripts). Internally, the system will triple the value that you specify for this attribute.	Supervisory, User
Maximum number of consecutive data notification failures allowed	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

Alarms Configuration

Use the Alarms tab to enable alarming for various platform-related conditions.

Platform History Configuration

Editor Option	Associated Attribute	Description	Run-Time Access (Supervisory, User, Read-Only, None)
Report excess CPU load alarm	CPULoadHiAlarm.Alarmed	If enabled, an alarm will be triggered when the load on the computer CPU becomes excessive.	None
Alarm limit	CPULoadHiAlarm.Limit	The alarm limit for the average CPU load.	Supervisory, User
Value deadband	CPULoadHiAlarm.Deadband	The amount that the average CPU load must go below the Hi alarm limit before the alarm is cancelled. The value for this deadband must be between 0 and 100 and be less than the alarm limit.	Supervisory, User
Priority	CPULoadHiAlarm.Priority	See Alarm Attributes.	Supervisory, User
Report low disk space alarm	DiskSpaceFreeLoAlarm.Alarmed	If enabled, an alarm will be triggered when the amount of hard drive space on the computer is too low.	None
Alarm limit	DiskSpaceFreeLoAlarm.Limit	The Lo alarm limit for free disk space, for any disk.	Supervisory, User
Priority	DiskSpaceFreeLoAlarm.Priority	See Alarm Attributes.	Supervisory, User
Report excessive page faults alarm	PageFaultsHiAlarm.Alarmed	If enabled, an alarm will be triggered when the amount of times the computer has to access data in virtual memory (in the swap file of the hard drive) becomes excessive. If the process of accessing virtual memory (called a page fault) becomes excessive, this condition generally indicates a need to increase the amount of RAM.	None
Alarm limit	PageFaultsHiAlarm.Limit	The Hi alarm limit for the average number of page faults.	Supervisory, User
Value deadband	PageFaultsHiAlarm.Deadband	The amount that the average number of page faults must go below the Hi alarm limit before the alarm is cancelled. This deadband must be between 0 and 100 and be less than the alarm limit.	Supervisory, User
Priority	PageFaultsHiAlarm.Priority	See Alarm Attributes.	Supervisory, User
Report low memory alarm	RamAvailableLoAlarm.Alarmed	If enabled, an alarm will be triggered when the average amount of free RAM is too low.	None
Alarm limit	RamAvailableLoAlarm.Limit	The Lo alarm limit for amount of available RAM.	Supervisory, User
Value deadband	RamAvailableLoAlarm.Deadband	The amount that the average amount of available RAM must go above the Lo limit before the alarm is cancelled.	Supervisory, User
Priority	RamAvailableLoAlarm.Priority	See Alarm Attributes.	Supervisory, User
Report engine failure alarm	EngineFailureAlarm.Alarmed	If enabled, an alarm will be triggered when an engine running on this WinPlatform has unexpectedly failed. This alarm terminates when the failed engine has successfully restarted and is running onscan or offscan.	None
Priority	EngineFailureAlarm.Priority	See Alarm Attributes.	Supervisory, User
Report checkpoint failure alarm	Engine.CheckpointFailed.Alarmed	If enabled, an alarm will be triggered when the checkpoint operation fails to checkpoint the last object condition.	None
Priority	Engine.CheckpointFailed.Priority	See Alarm Attributes.	Supervisory, User
Report object quarantined condition	Engine.ObjectQuarantined.Alarmed	If enabled, an alarm will be triggered 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.	None
Priority	Engine.ObjectQuarantined.Priority	See Alarm Attributes.	Supervisory, User
Report subscription folding condition	Engine.Folding.Alarmed	If enabled, an alarm will be triggered 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.	None
Priority	Engine.Folding.Priority	See Alarm Attributes.	Supervisory, User
Report scan overrun condition	Scheduler.ScanOverrun.Alarmed	If enabled, an alarm will be triggered when a scan overrun condition occurs.	None
Consecutive scan overrun limit	Scheduler.ScanOverrun.HiLimit	The maximum number of consecutive scan overruns that are allowed before an alarm is raised. A value of -1 will prevent overruns from being checked against a limit.	Supervisory, User
Priority	Scheduler.ScanOverrun.Priority	See Alarm Attributes.	Supervisory, User

Use the Platform History tab to enable historization for various status averages and counts that are monitored by the WinPlatform object.

Scheduler History Configuration

Editor Option	Associated Attribute	Description	Run-Time Access (Supervisory, User, Read-Only, None)
Historize cpu load of platform	CPULoadAvg.Historized	If enabled, the system will historize the average CPU utilization in percentage of the total.	None
Historize average interrupts of platform	InterruptsAvg.Historized	If enabled, the system will historize the average number of WinPlatform object interrupts. Interrupts are instances when data is stored, rather than sent to the intended recipient.	None
Historize average bytes received by platform	NetNMXBytesRcvdAvg.Historized	If enabled, the system will historize the average network bytes received per second.	None
Historize average bytes sent by platform	NetNMXBytesSentAvg.Historized	If enabled, the system will historize the average network bytes sent per second.	None
Historize average page faults on platform	PageFaultsAvg.Historized	If enabled, the system will historize 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.	None
Historize process count on platform	ProcessCnt.Historized	If enabled, the system will historize the number of Windows 32-bit processes (ArchestrA components and otherwise) running on this computer.	None
Historize available ram on platform	RamAvailableAvg.Historized	If enabled, the system will historize the average amount of free RAM available on the computer.	None
Historize number of threads running on platform	ThreadCnt.Historized	If enabled, the system will historize the number of threads running on this WinPlatform object.	None
Historize network messages sent count	NMXRequestsSentOffNodeCnt.Historized	If enabled, the system will historize the total number of requests sent to other platforms.	None
Historize network messages received count	NMXRequestsRcvdOffNodeCnt.Historized	If enabled, the system will historize the total number of requests received from other platforms.	None
Historize local messages count	NMXLocalMsgsCnt.Historized	If enabled, the system will historize 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.)	None
Force storage period	<AttributeName>.ForceStoragePeriod	See History Attributes.	Supervisory, User
Value deadband	<AttributeName>.Deadband	See History Attributes.	Supervisory, User
Trend high	<AttributeName>.TrendHi	See History Attributes.	Supervisory, User
Trend low	<AttributeName>.TrendLo	See History Attributes.	Supervisory, User
Interpolation Type	<AttributeName>.InterpolationType	See History Attributes.	Supervisory, User
Sample Count	<AttributeName>.SampleCount	See History Attributes.	Supervisory, User
Rollover Value	<AttributeName>.RolloverValue	See History Attributes.	Supervisory, User
Enable Swinging Door	<AttributeName>.EnableSwingingDoor	See History Attributes.	Supervisory, User
Rate DeadBand	<AttributeName>.RateDeadBand	See History Attributes.	Supervisory, User

Use the Scheduler History tab to enable historization for various status averages and counts that are generated by the internal scheduler of the WinPlatform object.

Engine History Configuration

Editor Option	Associated Attribute	Description	Run-Time Access (Supervisory, User, Read-Only, None)
Historize check point period average	Scheduler.CheckpointPeriodAvg.Historized	If enabled, the system will historize the average number of milliseconds between checkpoints for the averaging period.	None
Historize execution time average	Scheduler.ExecutionTimeAvg.Historized	If enabled, the system will historize the average number of milliseconds required to execute all objects per cycle.	None
Historize housekeeping time average	Scheduler.HousekeepingTimeAvg.Historized	If enabled, the system will historize the average number of milliseconds required for this object to do housekeeping tasks per cycle.	None
Historize time idle average	Scheduler.TimeIdleAvg.Historized	If enabled, the system will historize the average number of milliseconds per scan period that the object is idle (for example, receiving data, or sending data).	None
Historize input message size average	Scheduler.InputMsgSizeAvg.Historized	If enabled, the system will historize the average size of an input message, in bytes, for this averaging period.	None
Historize input messages processed average	Scheduler.InputMsgsProcessedAvg.Historized	If enabled, the system will historize the average number of input messages, in total bytes, in the input queue per scan period (including deferred and processed messages).	None
Historize input messages queued average	Scheduler.InputMsgsQueuedAvg.Historized	If enabled, the system will historize the average number of messages queued, including processed and deferred messages, per scan period. The value is calculated for the averaging period.	None
Historize input queue size average	Scheduler.InputQueueSizeAvg.Historized	If enabled, the system will historize the average size, in MB, of the input queue during the averaging period.	None
Historize time input average	Scheduler.TimeInputAvg.Historized	If enabled, the system will historize the average number of milliseconds required to process input messages per scan period.	None
Historize time output average	Scheduler.TimeOutputAvg.Historized	If enabled, the system will historize the average number of milliseconds required to process output messages per scan period.	None
Historize scan overrun count	Scheduler.ScanOverrunsCnt.Historized	If enabled, the system will historize the number of scan overruns since the last time statistics were reset.	None
Historize R/W Interrupts time average	Scheduler.ExecInterruptsTimeAvg.Historized	If enabled, the system will historize the average number of milliseconds required to perform execution interrupts per engine scan cycle.	None
Force storage period	<AttributeName>.ForceStoragePeriod	See History Attributes.	Supervisory, User
Value deadband	<AttributeName>.Deadband	See History Attributes.	Supervisory, User
Trend high	<AttributeName>.TrendHi	See History Attributes.	Supervisory, User
Trend low	<AttributeName>.TrendLo	See History Attributes.	Supervisory, User
Interpolation Type	<AttributeName>.InterpolationType	See History Attributes.	Supervisory, User
Sample Count	<AttributeName>.SampleCount	See History Attributes.	Supervisory, User
Rollover Value	<AttributeName>.RolloverValue	See History Attributes.	Supervisory, User
Enable Swinging Door	<AttributeName>.EnableSwingingDoor	See History Attributes.	Supervisory, User
Rate DeadBand	<AttributeName>.RateDeadBand	See History Attributes.	Supervisory, User

Use the Engine History tab to enable historization for various engine-related status counts that are generated by the WinPlatform object.

Run-Time Object Attributes

Editor Option	Associated Attribute	Description	Run-Time Access (Supervisory, User, Read-Only, None)
Historize external reference count	Engine.ExternalReferenceCnt.Historized	If enabled, the system will historize the number of registered external references.	None
Historize external reference count unbound	Engine.ExternalReferenceCntUnbound.Historized	If enabled, the system will historize the number of registered external references that are unbound.	None
Historize issued external gets count	Engine.IssuedExternalGetsCnt.Historized	If enabled, the system will historize the number of off-engine gets (initiated from AutomationObjects on this object).	None
Historize issued external sets count	Engine.IssuedExternalSetsCnt.Historized	If enabled, the system will historize the number of off-engine sets (initiated from AutomationObjects on this object).	None
Historize issued internal gets count	Engine.IssuedInternalGetsCnt.Historized	If enabled, the system will historize the number of on-engine gets (initiated from AutomationObjects on this object).	None
Historize issued internal sets count	Engine.IssuedInternalSetsCnt.Historized	If enabled, the system will historize the number of on-engine sets (initiated from AutomationObjects on this object).	None
Historize received external gets count	Engine.RcvdExternalGetsCnt.Historized	If enabled, the system will historize the number of incoming external gets (received from other engine objects that do not exist on this object).	None
Historize received external sets count	Engine.RcvdExternalSetsCnt.Historized	If enabled, the system will historize the number of incoming external sets (received from other engine objects that do not exist on this object).	None
Historize alarms throttled	Engine.AlarmsThrottled.Historized	If enabled, the system will historize 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.	None
Historize publish packets received count	Engine.PublishPacketsRcvdCnt.Historized	If enabled, the system will historize the number of publish packets received on this engine from other engines.	None
Historize publish packets sent count	Engine.PublishPacketsSentCnt.Historized	If enabled, the system will historize the number of publish packets sent from this engine to other engines.	None
Force storage period	<AttributeName>.ForceStoragePeriod	See History Attributes.	Supervisory, User
Value deadband	<AttributeName>.Deadband	See History Attributes.	Supervisory, User
Trend high	<AttributeName>.TrendHi	See History Attributes.	Supervisory, User
Trend low	<AttributeName>.TrendLo	See History Attributes.	Supervisory, User
Interpolation Type	<AttributeName>.InterpolationType	See History Attributes.	Supervisory, User
Sample Count	<AttributeName>.SampleCount	See History Attributes.	Supervisory, User
Rollover Value	<AttributeName>.RolloverValue	See History Attributes.	Supervisory, User
Enable Swinging Door	<AttributeName>.EnableSwingingDoor	See History Attributes.	Supervisory, User
Rate DeadBand	<AttributeName>.RateDeadBand	See History Attributes.	Supervisory, User

Topic Category	Topic Subcategory	Topic Details
Run-Time Object Attributes	Alarm Aggregation Attributes
History Attributes
Alarm Attributes

Note Configurable run-time attributes are described in the configuration sections. For more information, see Configuration.


Attribute	Description	Run-Time 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
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).	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. 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.	Read-Only
PlatformInfo	The processor and operating system configuration for the computer. For extra quality handling, see Quality Handling.	Read-Only
PlatformRestartNeeded	The 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 MB, 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 to 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	The time 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

Alarm Aggregation Attributes

The following attributes are available for all Objects. If alarm aggregation is enabled on the Area, the following attributes aggregate their respective alarm status values for the Area, for all sub-Areas, contained objects, and their descendants assigned to the Area. If alarm aggregation is disabled, these attributes remain at their default values. Alarm aggregation attributes behave similarly to alarm aggregation of individual attributes.

History Attributes

If a historization Feature is enabled, then the following additional history-related attributes become available. None of these attributes can be alarmed.

Alarm Attributes

If an alarm attribute is enabled, then the following additional alarm attributes become available. None of these attributes can be alarmed.

Redeploying WinPlatform Objects

You can redeploy a WinPlatform object without redeploying other objects hosted on WinPlatform in the ArchestrA IDE. When you make changes in an application while testing, you can check the changes by redeploying WinPlatform. Earlier, the redeploying process would undeploy and then redeploy all objects hosted on WinPlatform. Now, you can redeploy only the configured or modified platform object and not the other objects hosted on WinPlatform.

Attribute	Description	Run-Time Access (Supervisory, User, Read-Only, None)
<Attribute>.AlarmCntsBySeverity	Array of counts of all alarms that are in UNACK_ALM, ACK_ALM, or UNACK_RTN states on the object, aggregated by severity levels 1-4.	Read-Only
<Attribute>.AlarmMostUrgentAcked	TRUE (default) indicates that no alarms are in the InAlarm state or waiting to be Acked. A value of TRUE also indicates that the most urgent alarm(s) on the object and its descendants in the InAlarm state have been acknowledged, whether or not they are currently InAlarm.	Read-Only
<Attribute>.AlarmMostUrgentIn Alarm	FALSE (default) indicates that no alarms are in the InAlarm state or waiting to be Acked. A value of FALSE indicates whether the most urgent alarm(s) on the object and its descendants are in the InAlarm state, whether or not they have been acknowledged.	Read-Only
<Attribute>.AlarmMostUrgentMode	The AlarmMode of the most urgent alarm(s) on this Object and its descendants. If no alarms are in the InAlarm state or waiting to be Acked, the value is the same as the AlarmMode for the Object.	Read-Only
<Attribute>.AlarmMostUrgent Severity	Severity level expressed as an integer 1-4 of the most urgent alarm(s) on the object and its descendants. If no alarm is in the InAlarm state or waiting to be Acked, the value is 0 (zero).	Read-Only
<Attribute>.AlarmMostUrgent Shelved	The Shelved status as a Boolean value for the “most urgent” alarm(s) on this Object and its descendants. A value of FALSE indicates that no alarms have been Shelved for the "most urgent" alarm(s) on this Object and its descendants.	Read-Only

Attributes	Description
<Attribute>.ForceStoragePeriod	The time interval, in milliseconds, at which the value must be stored, even if the value has not changed. A value of 0 disables this feature. As an example, a setting of 3600000 indicates the value must be stored once per hour (measured from the time the object was last put onscan). If this value is less than the scan period of the host object, forced storage will occur every scan period (effectively equivalent to setting a value deadband of 0).
<Attribute>.TrendHi	The default top of the trend scale for clients. This value must be greater than or equal to the low value for the trend. If this value is changed at run time, the maximum engineering unit change is not reflected in the historian until you redeploy the object. This attribute only applies to numeric data types.
<Attribute>.TrendLo	The default bottom of the trend scale for clients. This value must be less than or equal to the high value for the trend. If this value is changed at run time, the minimum engineering unit change is not reflected in the historian until you redeploy the object. This attribute only applies to numeric data types.
<Attribute>.ValueDeadBand	The amount in engineering units by which a value referenced by the attribute must change to force a storage. A value of 0 means it is unused, and thus any value change forces a storage. Also, a quality change in the attribute always forces a storage regardless of this setting. This attribute only applies to numeric data types.
<Attribute>.Description	The brief description for the attribute that is stored to history. You can use descriptive text or a reference to another string attribute containing the history description. If an attribute reference is used, it must be in the form: "me.AttrName". If you do not provide a description, the object description is used.
<Attribute>.InterpolationType	The method used by the Historian to interpolate analog historical data. The interpolation type determines which analog value is selected during a Historian data retrieval cycle. Interpolation types include System Default, Stairstep, or Linear. The default interpolation type is System Default. For Stairstep, the last known value is returned with the given cycle time. If no valid value can be found, a NULL is returned to the Historian. For Linear, Historian calculates a new value at the given cycle time by interpolating between the last known value prior to the cycle time and the first value after the cycle time. For System Default, the Wonderware Historian system-wide interpolation setting is used. The system-wide setting must be either stairstep or linear interpolated.
<Attribute>.SampleCount	Obsolete. Do not use.
<Attribute>.RolloverValue	A positive integer value that represents a tag’s reset limit when the Historian operates in counter retrieval mode. In counter retrieval mode the Historian uses a tag's rollover value to calculate and return the delta change between consecutive retrieval cycles. The default value is 0.0. The rollover value applies only to numeric attributes. The rollover value is disabled if the historical attribute data type is Boolean or a string.
<Attribute>.EnableSwingingDoor	Enables or disables the swinging door rate deadband. The default is disabled. The swinging door deadband is not applicable to Boolean or string data types. If you provide a valid swinging door rate deadband, the force storage period is now the deadband override period.
<Attribute>.RateDeadBand	The percentage rate of change deadband based on the change in the slope of incoming data values to the Historian. For example, specifying a swinging door rate deadband of 10 percent means that data is saved to the Historian if the percentage change in slope of consecutive data values exceeds 10 percent. The default is 0.0, which indicates a swinging door rate deadband is not applied. Any percentage greater than 0.0 can be assigned to the rate deadband.

Attribute	Description
<Attribute>.Acked	Used to specify whether an alarm has been acknowledged. This attribute is updated when the AckMsg attribute is set. This attribute is always set to FALSE when a new alarm condition is detected (when the InAlarm attribute changes from FALSE to TRUE).
<Attribute>.AckMsg	The operator comment at the time the alarm is acknowledged. Any received text is stored, and the Acked attribute is set to TRUE. Also, the TimeAlarmAcked attribute is set to the current time. The maximum length is 256 characters.
<Attribute>.AlarmMode	The current alarm mode setting. Valid values are: Enable, Disable, Silence.
<Attribute>.AlarmModeCmd	The command to set the alarm mode. Valid values are: Enable, Disable, Silence.
<Attribute>.Category	The category of the alarm. The label of each alarm category is fixed.
<Attribute>.DescAttrName	The description of the alarm. The description must be of type String or InternationalizedString, with a maximum length of 329 characters. The DescAttrName attribute can contain a static alarm description or a reference to another string attribute within the same object containing the alarm description. The reference must be in the form: "me.AttrName". If the reference is invalid, the actual reference string is used for the description. If nothing is supplied for the DescAttrName attribute, the object’s ShortDesc attribute is used at run time.
<Attribute>.InAlarm	The alarm state. This is exactly the same as the attribute in the host primitive that represents the alarm condition, except when the alarm state is disabled, in which case, InAlarm is set to Off, regardless of the actual condition state. The quality is set during execute to the quality of the attribute, except when the alarm is disabled, in which case the quality is always GOOD.
<Attribute>.Inhibit	If true, the alarm is disabled. This attribute is intended to be written to by a script, a user, or an input feature. Only the individual alarm is disabled. No other alarms are disabled in the same object or in any objects that are assigned to or contained by this object.
<Attribute>.Priority	The value for the urgency of the alarm. Valid values are 1 through 999, with 1 being the most urgent.
<Attribute>.TimeAlarmAcked	The timestamp indicating the last time this alarm was acknowledged. The date format reflects the current locale setting for the operating system.
<Attribute>.TimeAlarmOff	The timestamp indicating the last time this alarm (as represented by the InAlarm attribute) went off. The date format reflects the current locale setting for the operating system.
<Attribute>.TimeAlarmOn	The timestamp indicating the last time this alarm (as represented by the InAlarm attribute) went on. The date format reflects the current locale setting for the operating system.

To redeploy the WinPlatform objects only, you must clear the Cascade Deploy check box in the Deploy dialog box. However, to redeploy all the objects (hosted objects and configured or modified platform objects) on WinPlatform, you need to select to the Cascade Deploy check box during deployment.

You will not be able to redeploy a configured or modified platform object if an object hosted on WinPlatform is in the pending state.

For more information on redeploying WinPlatform without redeploying all other hosted objects, see the AppServer User’s Guide, topic “Redeploying WinPlatform Objects.”

Quality Handling

For the following attributes, the quality is set to BAD when the object goes offscan, set to INITIALIZING when the object goes onscan, and set to GOOD when the object is updated during an execute:

For the following attributes, the quality is set to BAD when the object goes offscan, set to INITIALIZING when the object goes onscan, and set to GOOD when the object is updated during an execute. Also, quality is set to BAD if the information cannot be obtained from the operating system:

For the following attributes, the quality is set to BAD only if the information cannot be obtained from the operating system: