Echelon i.LON 100 e2 Internet Server - Manual (Page 110)

8.2 Creating and Modifying the AlarmNotifier.XML File
You can create and manage the AlarmNotifier.XML file with the AlarmNotifierSet SOAP
function. The following section, Alarm Notifier SOAP Interface, describes how to use
AlarmNotifierSet and the other SOAP functions provided for the Alarm Notifier application.
Alternatively, you can create and manage the AlarmNotifier.XML file manually with an
XML editor and download it to the
i. LON 100 via FTP. Echelon does not recommend this, as
the i. LON 100 will require a reboot to read the configuration of the downloaded file.
Additionally, the i. LON 100 performs error checking on all SOAP messages it receives before
writing to the XML file. It will not perform error checking on any XML files you download via
FTP, and thus the application may not boot properly.
If you plan to create the XML file manually, you should review the rest of this chapter first,
as it describes the elements and properties in the XML file that define each Alarm Notifier’s
configuration. For instructions on creating or modifying an XML file manually, see Manually
Modifying an XML Configuration File on page 15-1.
8.2.1 Alarm Notifier SOAP Interface
The SOAP interface for the Alarm Notifier application includes seven functions. Table 30
lists and describes these functions. For more information on each function, see the sections
following Table 30.
Table 30 Alarm Notifier SOAP Functions
Function Description
AlarmNotifierList Use this function to generate a list of the Alarm Notifiers that you
have added to the i. LON 100. For more information, see
AlarmNotifierList on page 8-5.
AlarmNotifierGet Use this function to return the configuration of an Alarm Notifier. For
more information, see AlarmNotifierGet on page 8-6.
AlarmNotifierSet Use this function to create an Alarm Notifier, or to overwrite the
configuration of an exisiting Alarm Notifier. For more information, see
AlarmNotifierSet on page 8-19.
AlarmNotifierRead Each time an Alarm Notifier causes an alarm notification, it will
record a log entry for that notification. Use this function to retrieve
some or all of the log entries that an Alarm Notifier has recorded. For
more information, see AlarmNotifierRead on page 8-20.
AlarmNotifierWrite Use this function to acknowledge an alarm notification, or group of
alarm log notifications, made by the Alarm Notifier. You optionally
insert comments into the log entry for each alarm notification with
this function. For more information, see AlarmNotifierWrite on page
8-26.
AlarmNotifierClear Use this function to clear log entries from an Alarm Notifier’s log file.
For more information, see AlarmNotifierClear on page 8-29.
AlarmNotifierDelete Use this function to delete an Alarm Notifier. For more information,
see AlarmNotifierDelete on page 8-31.
i. LON 100 Internet Server Program 8-4 mer’s Reference