Add an Alarm Server Process
- Last UpdatedJul 18, 2023
- 3 minute read
An alarm server process is responsible for evaluating the conditions that define an alarm (for more information, see Alarm Server Process in the section on Alarms).
Refer to the default server port numbers under Server Processes.
Note: The Alarm server reuses the Alarm Properties port. As a result alarm properties are now published for configured alarm servers.
To add an alarm server process:
-
In the Topology activity, select Edit.
-
From the drop down menu below the Command Bar, select Alarm Server.
-
Add a new row to the grid.
-
Type the required information in each column, or in the Property Grid (see below for a description of the properties).
-
Click Save.
Alarm Server Properties
General Properties
|
Property |
Description |
|---|---|
|
Server Name |
The name of the server. The name needs to be unique to the project and any included projects, and not contain spaces. |
|
Mode |
The mode for this server, either Primary or Standby. If this property is left blank, the default value will be Primary. The Primary and Standby servers need to run on different computers, and only one Primary and one Standby can be defined per cluster. Mode determines which server will be assigned the highest arbitration priority. The arbitration priority is used to work out which server will continue to be 'main' after a 'main-main' situation has occurred (see Alarm Server Side Synchronization). |
|
Cluster Name |
The name of the cluster to which this Alarm Server will belong. If there is only one cluster defined in the project, you can leave this field blank. The Alarm Server will default to the defined cluster |
|
Comment |
Any useful comment. This property is optional and is not used at runtime. |
Security Properties
|
Property |
Description |
|---|---|
|
Allow RPC |
Determines if the server process will execute remote MsgRPC and ServerRPC calls. Select TRUE or FALSE. If this field is left blank it will default to FALSE and the following compiler warning will be generated: "'Allow RPC' permission is not defined for server (defaulting to FALSE) (W1038)". |
Communication Properties
|
Property |
Description |
|---|---|
|
Network Addresses |
The network address(es) of the server being configured. To specify dual network connections to the server, use a comma delimited list. See Network Redundancy. |
|
Port |
The port this server will listen on. You can leave this field blank if you are running only one Alarm Server on the machine, in which case the default port number will be used. |
|
Database Port |
The port the server database will listen on. You can leave this field blank if you are running only one Alarm Server on the machine, in which case the default port number will be used. |
Other Properties
|
Property |
Description |
|---|---|
|
Extended Memory |
Determines whether the alarm server operates in Extended Memory mode (64-bit). Select TRUE to use Extended Memory Mode (see Alarm Server Process). |
|
Highest Priority Order |
Determines the order in which alarms are sorted. Select the required algorithm from the drop-down list. If no algorithm is selected, the alarms will be listed according to "Priority, Alarm State" by default. For example: P1 Unacknowledged + Active Select "Alarm State, Priority" to change the algorithm. The order of the example above would change to the following: P1 Unacknowledged + Active Note: Alarm servers across the system need to have the same algorithm selected. A compiler error will occur if they are different. If you want to create a customized sort order for alarms in a Situational Awareness project, you can use the parameter [Workspace]AlarmSortOrder. |
|
Archive Interval (Days) |
Schedules archiving to occur every ' number' of days. If set, archiving will occur automatically. |
|
Archive Path |
Define where the archived data will be stored. Note: The volume where data is to be saved should be labeled. This includes any removable storage devices. If this is not the case, archiving will not succeed and a message will display on the SOE page. |
|
Archive Prefix |
Required prefix to the archive folder. |
Project Properties
|
Property |
Description |
|---|---|
|
Project |
The project in which the alarm server is configured. |