Echelon i.LON SmartServer 2.0 - Manual (Page 15)

i.LON SmartServer 2.0 Programmer’s Reference 2-1
2 SOAP Messages and the SmartServer WSDL File
This chapter contains general information about the SOAP/XML interface you will need to know
before using the SOAP functions described in this manual. It includes the following major topics:
• SmartServer Naming Structure. The section describes how the SmartServer’s data configuration
is organized.
• SmartServer WSDL File. This section describes the version 4.0 WSDL file, which defines the
SOAP/XML interface. When writing applications to use the SOAP interface, some tools can
import this file and automatically build a class structure for sending and receiving each message.
• Security. This section describes the security provided by the SmartServer for SOAP applications.
• SOAP Request/Response Structure. This section demonstrates the structure of the SOAP request
and response messages used by Version 4.0.
• SOAP Message Formats. This section describes the formats that must be used for all SOAP
messages that are sent to and from the SmartServer. A SOAP message is sent to the SmartServer
each time you invoke any of the functions described in this document.
• Data Point References. The section describes the SmartServer’s new method for referencing data
points on the SmartServer’s embedded applications.
• UCPTCurrentConfig. This section describes the new element included in
List response messages. This element indicates the namespace version of the client that last set the
configuration of an item.
• Fault Structure. This section describes the new structure, which combines the faultcode
and faultstring elements and enables a client to check only for the existence of a fault structure
instead of having to check for both elements.
• LonString Type. This section describes the E_LonString type that is used for enumerations or
element values that have format descriptions that depend on references to other data point formats.
• SOAP Examples. This section includes SOAP examples that demonstrate how to use the Version
4.0 SOAP interface to get the configuration of data point, write a value to a data point in a Web
connection, and read the data in a data logger.
2.1 SmartServer Naming Structure
The naming convention used for the SmartServer’s configuration and data items follows the
L
ON W ORKS network hierarchy (network/channel/device/functional block/data point).
When the SmartServer accesses a device, that device is attached to a given channel in a network. In
the same manner, a data point exists on a functional block that is part of the device. This structure is
reflected by the network/channel/device/functional block/data point naming scheme.
Assuming that there is a channel named “myChannel” on a network called “myNetwork”, the name of a
device accessed through “myChannel” must begin with “myChannel”. For example, the default
property of the internal automated system device on the SmartServer (i.LON App) is
Net/LON/i.LON App. This means that the SmartServer is located on a channel named LON on a
network named Net. Further consider that i.LON App has a Digital Input 1 functional block that
contains an nvoClsValue_1 data point. By default, the property of the nvoClsValue_1
data point is Net/LON/iLON App/Digital Input 1/nvoClsValue_1. Note that a
property has to have at least the size of one char and must be unique in the
network/channel/device/functional block/data point collection.