Type translator rule soap interface, Type translator rule soap interface -3, 1 type translator rule soap interface – Echelon i.LON 100 e2 Internet Server User Manual

Page 196

LON 100 Internet Server Programmer’s Reference

13-3

pe Translator Rule SOAP

Interface

13.2 Creating and Modifying the Type Translator Rule XML Files

You can create and modify the XML files for your Type Translator Rules with the
TypeTranslatorRuleSet function. The following section, Ty

, describes how to use TypeTranslatorRuleSet and the other SOAP functions

provided for use with Type Translator Rules.
Alternatively, you can create the XML files for your Type Translator Rules manually, with

an XML editor, and download them to the

LON 100 via FTP sessions. Echelon does not

recommend this, as the

LON 100 will require a reboot to read the configuration of the

downloaded file. Additionally, the

LON 100 performs error checking on all SOAP messages

it receives before writing to the 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 files for your Type Translator Rules
manually, you should review the rest of this chapter first, as it describes the elements and

properties that define each Type Translator Rule. For instructions on creating or modifying

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

13.2.1

Type Translator Rule SOAP Interface

The SOAP interface for the Type Translator Rule application includes four functions. Table

69 lists and describes these functions. For more information on any of these functions, see
the sections following Table 69.

Table 69 Type Translator Rule SOAP Functions

Function Description

TypeTranslatorRuleList

Use this function to retrieve a list of the Type Translators
Rules that you have added to the

LON 100. For more

information, see T

on page 13-4.

ypeTranslatorRuleList

TypeTranslatorRuleGet

Use this function to retrieve the configuration of any Type

Translator Rule that you have added to the

LON 100. For

more information, see TypeTranslatorRuleGet on page 13-5.

TypeTranslatorRuleSet

Use this function to create a Type Translator Rule, or to
overwrite the configuration of an existing Type Translator

Rule. For more information, see TypeTranslatorRuleSet on

page 13-12.

TypeTranslatorRuleDelete

Use this function to delete a Type Translator Rule. For more
information, see T

on page 13-14.

ypeTranslatorRuleDelete