Alarm Server

Purpose:

Data-Basics Alarm Server enables external alarms to be received by the SAM Pro system and used to create web logs. In addition to the topics discussed below, specific registry entries sys-email and term entries must be created. It is recommended that you discuss these topics with your Data-Basics support representative.

Usage: Starting Alarm Server

Currently, the AlarmService must be started from a transcript window by entering and executing the following text:

server := AlarmServer new.
server openServer.

General Notes:

When the Alarm Server is running, it checks its email box (defined by the sys-email registry entry pop3user) every cycle (defined by pop3secondswait) to see if it has any email to process. If it finds something, it can do one of the following:

If the email is bogus or invalid, display an error message. This is currently displayed in the DOS window where the alarm server is running, but in the future it may be written to the error log.

If the email is valid, the software will create a web log for the equipment. Typically, an escalation profile would be attached to the equipment specifying that an e-mail notification immediately be sent to the appropriate party (e.g., a service provider).

Email Format:

Subject
Subject must start with the word ALARM in caps followed by a space, and then EID=clntsteeqpmnt_id

Example: ALARM EID=1234fred

Note that in order for this to work, the client site equipment id must be unique, not just the combination of client site and client site equipment id.

Contents
The contents can be blank or contains semi-colon separated key value pairs; extra spaces past 1 are trimmed.

If the contents is blank, an alarm will be entered for this equipment.

Key value pairs, if included, can be used to pass any additional information: key1=value1;key2=value2;...

See Also

Registry Entry Terms for Alarm Server Registry Entry System Email