System information

ManualsBrandsEchelon ManualsComputer equipmenti.LON SmartServer

Table Of Contents

Table of Contents
1 Introduction to the SmartServer SOAP/XML Interface
- 1.1 About This Document
- 1.2 Programming Samples
- 1.3 Getting Started
- 1.4 SmartServer SOAP/XML Interface Upgrades
  - 1.4.1 Version 4.0 SOAP Message Name Schema
    - 1.4.1.1 Version 3.0 Message Name Schema
    - 1.4.1.2 Version 4.0 Message Name Schema
2 SOAP Messages and the SmartServer WSDL File
- 2.1 SmartServer Naming Structure
- 2.2 SmartServer WSDL File
- 2.3 Security
- 2.4 SOAP Request and Response Message Structure
  - 2.4.1 SOAP Request
  - 2.4.2 SOAP Response
- 2.5 SOAP Messages Formats
- 2.6 Data Point References
- 2.7 UCPTcurrentConfig
- 2.8 Fault Structure
- 2.9 LonString type
- 2.10 SOAP Message Examples
3 SmartServer Applications and the SOAP/XML Interface
- 3.1 Overview of SmartServer Applications
- 3.2 SmartServer XML Configuration Files
  - 3.2.1 Modifying the XML Configuration Files
- 3.3 SmartServer Resource Files
- 3.4 SOAP Functions
- 3.5 Performance Issues
4 Using the SmartServer Data Server
- 4.1 Creating and Modifying the Data Point XML Files
- 4.2 Overview of the Data Point XML File
- 4.3 Data Server SOAP Interface
- 4.4 Using the Web Binder Application
5 Data Loggers
- 5.1 Overview of the Data Logger XML File
- 5.2 Creating and Modifying the Data Logger XML File
- 5.3 Data Logger SOAP Interface
6 Alarm Generator
- 6.1 Overview of the Alarm Generator XML File
- 6.2 Creating and Modifying the Alarm Generator XML File
- 6.3 Alarm Generator SOAP Interface
7 Alarm Notifier
- 7.1 Overview of the AlarmNotifier XML File
- 7.2 Creating and Modifying the Alarm Notifier XML File
- 7.3 Alarm Notifier SOAP Interface
8 Analog Function Block
- 8.1 Overview of the AnalogFB XML File
- 8.2 Creating and Modifying the Analog Functional Block XML File
- 8.3 Analog Functional Block SOAP Interface
9 Scheduler
- 9.1 Overview of the Scheduler XML File
- 9.2 Creating and Modifying the Scheduler XML File
- 9.3 Scheduler SOAP Interface
10 Calendar
- 10.1 Overview of the Calendar XML File
- 10.2 Creating and Modifying the Calendar XML File
- 10.3 Calendar SOAP Interface
11 Real Time Clock
- 11.1 Overview of the Real Time Clock XML File
- 11.2 Creating and Modifying the Real Time Clock XML File
- 11.3 Real Time Clock SOAP Interface
12 Type Translator
- 12.1 Overview of the Type Translator XML File
- 12.2 Creating and Modifying the Type Translator XML File
- 12.3 Type Translator SOAP Interface
13 Type Translator Rules
- 13.1 Type Translator Rule XML Files
- 13.2 Creating and Modifying the Type Translator Rule XML Files
- 13.3 Type Translator Rule SOAP Interface
14 LonWorks Driver
- 14.1 LonWorks Networks
- 14.2 LonWorks Channels
- 14.3 LonWorks Devices
- 14.4 Routers
- 14.5 Remote Network Interface
- 14.6 LonWorks Functional Blocks
- 14.7 Network Variables (LonWorks Data Points)
- 14.8 Configuration Properties (LonWorks Data Points)
- 14.9 LonWorks Connections
15 Modbus Driver
- 15.1 Modbus Channels
- 15.2 Modbus Devices
- 15.3 Modbus Virtual Functional Blocks
- 15.4 Modbus Data Points
16 M Bus Driver
- 16.1 M Bus Channels
- 16.2 M Bus Devices
- 16.3 M Bus Virtual Functional Blocks
- 16.4 M Bus Data Points
17 Virtual Driver
- 17.1 Virtual Channels
- 17.2 Virtual Devices
- 17.3 Virtual Functional Blocks
- 17.4 Virtual Data Points
18 File System Data
- 18.1 Using the List Function on File System Data
- 18.2 Using the Read Function on File System Data
- 18.3 Using the Write Function on File System Data
- 18.4 Using the Delete Function on File System Data
19 System Information Methods
- 19.1 System Service Methods
- 19.2 System Test Methods
20 Using the SOAP Interface as a Web Service
- 20.1 Referencing and Inheriting from the WSDL
  - 20.1.1 Referencing and Inheriting from the WSDL Using .NET 3.5 Framework
  - 20.1.2 Referencing and Inheriting from the WSDL Using .NET 2.0 Framework
- 20.2 Instantiating and Initializing the Web Service Client
- 20.3 Calling Web Services Methods
- 20.4 Accepting a Web Binding From a SmartServer
21 Programming Examples
- 21.1 Visual C#.NET Examples
- 21.2 Visual Basic.NET Examples
22 Programming the SmartServer with Java
- 22.1 Setting up the Java Programming Environment
- 22.2 Creating a JAX-WS Client
- 22.3 Java Programming Examples
Appendix A: SOAP Tester Example

i.LON SmartServer 2.0 Programmer’s Reference

1-3

introduced for the e2 release, and the version 3.0 namespace was introduced for the e3 release.

Support for the different namespaces as follows:

• i.LON 100 servers running the Release 1.0 software only support the version 1.0 namespace. This

means that a SmartServer running the Release 1.0 software can only respond to SOAP messages

from other SmartServers running the Release 1.0 software.

• i.LON 100 servers running the e2 software support the version 1.0 and 1.1 namespaces. This

means that an i.LON 100 server running the e2 software can respond to SOAP messages from

other i.LON 100 servers that are running the Release 1.0 or the e2 software.

• i.LON 100 servers running the e3 software support the version 1.1 and 3.0 namespaces. This

means that i.LON 100 servers running the e3 software can respond to SOAP messages sent from

other i.LON 100 servers that are running the e2 or e3 software.

• SmartServers running the SmartServer software support only the version 4.0 namespace. This

means that SmartServers running the SmartServer software can respond to SOAP messages sent

from other SmartServers. SmartServers running the SmartServer software cannot respond to

SOAP messages sent from i.LON 100 servers running the e3 software.

The following section,

Version 4.0 SOAP Message Name Schema, describes the changes made to the

SOAP/XML interface between SOAP namespace versions ‘3.0’ and ‘4.0’ (i.e. between the e3 and

SmartServer releases).

Note: This manual often refers to the i.LON 100 and SmartServer releases by the version numbers

used in their SOAP namespace. For example, the SmartServer release is referred to by its software

version number, which is ‘4.0’, and the i.LON 100 e3 release is referred to as ‘3.0’. For more

information on the SOAP namespace, see

Chapter 2 of this document.

1.4.1

Version 4.0 SOAP Message Name Schema

The SOAP/XML interface used for the SmartServer (version 4.0) uses a new message name schema.

It uses a common set of generic methods (List, Get, Set, Delete, Read, Write, Clear, and Invoke) for

retrieving and configuring the data of the various SmartServer applications. This section provides an

overview of the changes made to the SOAP message name schema from version 3.0.

1.4.1.1 Version 3.0 Message Name Schema

The message name schema used for version 3.0 was <Application>_<Message>_<Parameter>. The

Parameter was optional and normally not used. The Message was normally List, Get, Set or Delete.

The following provides examples of version 3.0 request messages:

TypeTranslator_List, TypeTranslator_Get_Rule, Read, DriverMOD_Set_Template

The response messages were identified by the message name plus the string <Response>.

The schema was: <Application>_<Message>_<Parameter>Response.

With the version 3.0 message name schema, there were numerous specialized SOAP messages and

SOAP structures, resulting in limited flexibility and intricate handling of a large number of Java or C#

proxy classes.

1.4.1.2 Version 4.0 Message Name Schema

Version 4.0 uses a single set of messages that are common to all applications. The messages for

retrieving and modifying configuration data consists of List, Get, Set, and Delete, and the messages for

retrieving and changing state information are Read and Write.