beautypg.com

3 type translator soap interface, 1 using the list function on a type translator, Type translator soap interface -2 – Echelon i.LON SmartServer 2.0 User Manual

Page 174: Using the list function on a type translator -2, Type translator soap interface

background image

i.LON SmartServer 2.0 Programmer’s Reference

12-2

12.2

Creating and Modifying the Type Translator XML File

You can create and manage the #8000010128000000[4].UFPTtypeTranslator.xml file with the Set
SOAP function. The following section, Type Translator SOAP Interface, describes how to use Set and
the other SOAP functions provided for the Type Translator application.

Alternatively, you can create and manage the #8000010128000000[4].UFPTtypeTranslator.xml file
manually with an XML editor and download it to the SmartServer via FTP. Echelon does not
recommend this, as the SmartServer will require a reboot to read the configuration of the downloaded
file. Additionally, the SmartServer 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 Type Translator’s configuration.

12.3

Type Translator SOAP Interface

You can use the SOAP interface to perform the following functions on a type translator:

Function Description

List

Generate a list of the type translators on the SmartServer.

Get

Retrieve the configuration of the type translators on the SmartServer.

Set

Create a new type translator, or overwrite the configuration of an
existing type translators.

Delete

Delete a type translators.

12.3.1

Using the List Function on a Type Translator

You can use the List function to retrieve a list of the type translators that you have added to the
SmartServer. The List function takes an element that includes an xSelect statement
querying items of UFPTtypeTranslator_Cfg type as its input, as shown in the example below. The
List function returns an element for each type translator that you have added to the
SmartServer. The next section describes the properties included in each of these elements.

You could use the list of elements returned by this function as input for the Get function. The
Get function would then return the configuration of each type translator included in the list.

Request



//Item[@xsi:type="

UFPTtypeTranslator_Cfg"]



Response



0
4.0

Net/LON/iLON

App/Type

Translator[0]

#8000010128000000[4].UFPTtypeTranslator;xsi:type=”LON_Fb_Cfg”

0