beautypg.com

Creating and modifying the alarmgenerator.xml file, Alarm generator soap interface, Alarm generator soap interface -3 – Echelon i.LON 100 e2 Internet Server User Manual

Page 92: 1 alarm generator soap interface

background image

i.

LON 100 Internet Server Programmer’s Reference

7-3

7.2 Creating and Modifying the AlarmGenerator.XML File

You can create and modify the AlarmGenerator.XML file with the AlarmGeneratorSet SOAP
function. The following section, Alarm Generator SOAP Interface, describes how to use

AlarmGeneratorSet, and the other SOAP functions provided for the Alarm Generator

application.

Alternatively, you can create and modify the AlarmGenerator.XML file manually using an

XML editor, and download the file 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.
However, if you plan to create and manage 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 Generator’s configuration. For instructions on creating or modifying an

XML file manually, see Manually Modifying an XML Configuration File on 15-1.

7.2.1 Alarm Generator SOAP Interface

The SOAP interface for the Alarm Generator application includes four functions. Table 21

lists and describes these functions. For more information, see the sections following Table 21.

Table 21 Alarm Generator SOAP Functions

Function Description

AlarmGeneratorList

Use this function to generate a list of the Alarm Generators that

you have added to the

i.

LON 100. For more information, see

AlarmGeneratorList on page 7-4.

AlarmGeneratorGet

Use this function to retrieve the configuration of an Alarm
Generator. For more information, see AlarmGeneratorGet on page

7-5.

AlarmGeneratorSet

Use this function to create a new Alarm Generator, or to overwrite

the configuration of an exisiting Alarm Generator. For more

information, see AlarmGeneratorSet on page 7-16.

AlarmGeneratorDelete Use this function to delete an Alarm Generator. For more

information, see AlarmGeneratorDelete on page 7-17.