Clients access the Hyper Alarm Logger through the internal FWX interface. OPC DA, OPC AE, OPC UA or other standardized interfaces are not implemented by the Hyper Alarm Logger specifically, but some (OPC DA for example) are implemented at the FrameWorX server level and encompass all Point Managers.
The address space is just the ServerInfo folder and a flat list of the Collections, as illustrated by the screenshot:
Each Collection is exposed as a single point in the address space and the AlarmWorX64 Viewer can connect to one of them or to multiple.
Each Collection point exposes a slightly different Alarms & Events type hierarchy. The first three levels of the hierarchy are always the same, while the last is different and exposes the actual fields configured for the specific Collection:
The BaseEventType and BaseConditionType together with their fields are defined by the FrameWorX server.
The AlmlBaseType contains fields statically defined by the Hyper Alarm Logger. Currently, only one field is defined: SubscriptionName – String – the subscription name as configured in Workbench. See The Subscriptions tab.
The AlmlCollectionType combines with the Collection name to form a type name like AlmlCollectionType:Collection1. This type contains all the additional fields configured in Workbench for the Collection, see The Fields tab.
And while the type hierarchy above is shown by the AlarmWorX64 Viewer and used internally when it communicates with the Logger, the BaseEventType.EventType field of logged alarms / events does not respect it and contains the original value sent by the alarm source.
The ServerInfo folder exposes basic server and redundancy related information. When no redundancy is configured, only information about the local server is provided. With redundancy enabled, both the local and remote servers appear under the ServerInfo folder, as seen in the screenshot.
The Remote folder tunnels to the Local folder of the other computer in the pair. It can be used to verify that communication is functioning between the two computers.
The MakeActive method can be used to manually switch a server from the standby mode to active.
Individual real-time data points have the following meaning:
|
Point name |
Data type |
Description |
|
Active |
Boolean |
True when the server is active in the redundant pair. ServerStateName is Active. |
|
CanMakeActive |
Boolean |
True when the MakeActive method may succeed. |
|
ConfigStatusCode |
StatusCode |
Informs whether the configuration database was loaded successfully. It can have any of the following status codes:
|
|
CurrentTime |
DateTime |
The current system time in UTC. |
|
LicenseStatusCode |
StatusCode |
Informs whether the Hyper Alarm Logger was able to obtain the application license bit. All possible values cannot be listed here. |
|
MachineName |
String |
The computer NETBIOS name. |
|
Online |
Boolean |
True when server is ready to serve data. ServerStateName is Active or Standby. |
|
RedundancyEnabled |
Boolean |
True when redundancy is enabled. |
|
ServerStateName |
String |
The current state of redundancy, values are not localized. For possible values, see the following table. |
|
StartTime |
DateTime |
The system time in UTC when the Hyper Alarm Logger started. |
|
Version |
String |
The Hyper Alarm Server DLL file version. |
Individual states of the ServerStateName point:
|
Value |
Description |
|
Offline |
Server doesn't have resources to run (license failure, logger severe error, etc.). |
|
Startup |
Server is pending for communication with peer server. |
|
Active |
Active server, main source of data. |
|
Standby |
Standy server, receives data from Active server. |
The Local (and Remote) folders of ServerInfo contain a folder named In-process primary collector and if redundancy is configured, they also contain a folder named In-process secondary collector.
These folders expose basic information about the collectors, and individual real-time data points have the following meaning:
|
Point name |
Data type |
Description |
|
Active |
Boolean |
True when the collector is active in the redundant collector pair. |
|
CurrentTime |
DateTime |
The current system time in UTC. |
|
LoggerMachineName |
String |
The NETBIOS name of the computer that is currently connected to the collector. This should be either the name of the primary or secondary computers, or empty if no logger is connected currently. If this contains the name of another computer, than a problem may be at hand, as only one logger can be connected to a collector at a time. |
|
Online |
Boolean |
True when collector is ready to serve data. |
|
BufferSize (MB) |
Double |
The size of the Store & Forward buffer, in MiB. |
|
StartTime |
DateTime |
The system time in UTC when the collector started. |