Object configuration General tab

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 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 Windows operating system standard. 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 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 runtime will be Galaxy_<GalaxyName>. If disabled, the value will be Galaxy.

Use this calculated value to determine at runtime, 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

Thetime 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