beautypg.com

3 data logger soap interface, 1 using the list function on a data logger, Data logger soap interface -3 – Echelon i.LON SmartServer 2.0 User Manual

Page 68: Using the list function on a data logger -3, Data logger soap interface

background image

i.LON SmartServer 2.0 Programmer’s Reference

5-3

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.

However, if you plan to create and manage the #8000010128000000[4].UFPTdataLogger.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 Data Logger’s configuration.

5.3

Data Logger SOAP Interface

You can use the SOAP interface to perform the following functions on a Data Logger application:

Function Description

List

Generate a list of the Data Loggers that you have added to the
SmartServer.

Get

Retrieve the configuration of any Data Logger that you have added to
the SmartServer.

Set

Create a new Data Logger, or overwrite the configuration of an
existing Data Logger.

Read

Read a portion or all of the entries stored in a Data Logger log file.

Clear

Remove a portion or all of the log entries stored in a Data Logger log
file.

Delete

Delete a Data Logger.

Note: Section 21.1.2, Creating and Reading a Data Logger in Visual C# NET, includes a C#
programming example demonstrating how to use the Data Logger SOAP interface to create and read a
data logger. Section 21.2.2, Creating and Reading a Data Logger in Visual Basic. NET, includes a
Visual Basic example demonstrating how to do this.

Section 22.3.2, Creating and Reading a Data Logger in Java, includes a Java example demonstrating
how to create and read a data logger.

5.3.1

Using the List Function on a Data Logger

Use the List function to retrieve a list of the Data Loggers that you have added to the SmartServer.
The List function takes an element that includes an xSelect statement querying items of a
UFPTdataLogger_Cfg type as its input, as shown in the example below. The List function returns an
element for each Data Logger 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 Data Logger included in the list.

Request



//Item[@xsi:type="UFPTdataLogger_Cfg"]

Response