Document Outline

• 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.5.1 SOAP Envelope
      • 2.5.1.1 W3C Namespaces Supported in Version 4.0
    • 2.5.2 SOAP Header
    • 2.5.3 SOAP Body
      • 2.5.3.1 Fault Messages (Application Layer)
      • 2.5.3.2 Fault Messages (SOAP Layer)
      • 2.5.3.3 Error Codes
    • 2.5.4 Namespace
    • 2.5.5 SOAP Message Schema
    • 2.5.6 SOAP Function Types
    • 2.5.7 SOAP Message Attributes
    • 2.5.8 Using xSelect Statements in SOAP Message Requests
      • 2.5.8.1 xsi Types
  • 2.6 Data Point References
  • 2.7 UCPTcurrentConfig
  • 2.8 Fault Structure
  • 2.9 LonString type
  • 2.10 SOAP Message Examples
    • 2.10.1 Configuration Data
    • 2.10.2 Web Binding
    • 2.10.3 Data Log Read
• 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.3.1 Standard Network Variable Type (SNVT) Device Resource Files
    • 3.3.2 Standard Configuration Property Type (SCPT) Device Resource Files
    • 3.3.3 User Defined Network Variable Type (UNVT) Device Resource Files
    • 3.3.4 User Defined Configuration Property Type (UCPT) Device Resource Files
    • 3.3.5 Data Point Templates
    • 3.3.6 Data Formatting
  • 3.4 SOAP Functions
    • 3.4.1 List Functions
    • 3.4.2 Get Functions
    • 3.4.3 Set Functions
    • 3.4.4 Read Functions
    • 3.4.5 Write Functions
    • 3.4.6 Delete 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.3.1 Using the List Function on the Data Server
    • 4.3.2 Using the Get Function on the Data Server
    • 4.3.3 Using the Set Function on the Data Server
    • 4.3.4 Using the Read Function on the Data Server
      • 4.3.4.1 Setting the Maximum Age of Data Point Values
    • 4.3.5 Using the Write Function on the Data Server
      • 4.3.5.1 Writing Formatted Values to a Data Point
      • 4.3.5.2 Writing Presets to a Data Point
      • 4.3.5.3 Writing Raw Values to a Data Point
      • 4.3.5.4 Writing Values to Structured Data Points
      • 4.3.5.5 Writing Priority Levels
      • 4.3.5.6 Data Server Write Function Examples
    • 4.3.6 Using the Invoke Function to Reset Data Point Priorities
    • 4.3.7 Data Point Values and Priority Levels
    • 4.3.8 Using the Delete Function on the Data Server
  • 4.4 Using the Web Binder Application
    • 4.4.1 Using the List Function on a Web Connection
    • 4.4.2 Using the Get Function on a Web Connection
    • 4.4.3 Using the Set Function on a Web Connection
    • 4.4.4 Using the Delete Function on a Web Connection
• 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
    • 5.3.1 Using the List Function on a Data Logger
    • 5.3.2 Using the Get Function on a Data Logger
    • 5.3.3 Using the Set Function on a Data Logger
    • 5.3.4 Using the Read Function on a Data Logger
      • 5.3.4.1 Local Times and Coordinated Universal Time
    • 5.3.5 Using the Clear Function on a Data Logger
    • 5.3.6 Using the Delete Function on a Data Logger
• 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
    • 6.3.1 Using the List Function on an Alarm Generator
    • 6.3.2 Using the Get Function on an Alarm Generator
      • 6.3.2.1 Alarm Priority Levels
      • 6.3.2.2 Comparison Functions
      • 6.3.2.3 Hysteresis Levels and Offset Limits
    • 6.3.3 Using the Set Function on an Alarm Generator
    • 6.3.4 Using the Delete Function on an Alarm Generator
• 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
    • 7.3.1 Using the List Function on an Alarm Notifier
    • 7.3.2 Using the Get Function on an Alarm Notifier
      • 7.3.2.1 Input Data Points
      • 7.3.2.2 E mail Profiles
      • 7.3.2.3 Active and Passive Alarm Conditions
      • 7.3.2.4 Active and Passive Alarm Destinations
    • 7.3.3 Using the Set Function on an Alarm Notifier
    • 7.3.4 Using the Read Function on an Alarm Notifier
    • 7.3.5 Using the Write Function on an Alarm Notifier Log File
    • 7.3.6 Using the Clear Function on an Alarm Notifier Log File
    • 7.3.7 Using the Delete Function on an Alarm Notifier
• 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
    • 8.3.1 Using the List Function on an Analog Functional Block
    • 8.3.2 Using the Get Function on an Analog Functional Block
      • 8.3.2.1 Output Functions
    • 8.3.3 Using the Set Function on an Analog Functional Block
    • 8.3.4 Using the Delete Function on an Analog Function Block
• 9 Scheduler
  • 9.1 Overview of the Scheduler XML File
  • 9.2 Creating and Modifying the Scheduler XML File
  • 9.3 Scheduler SOAP Interface
    • 9.3.1 Using the List Function on a Scheduler
    • 9.3.2 Using the Get Function a Scheduler
      • 9.3.2.1 Creating a Day Based Schedule
      • 9.3.2.2 Creating a Date Based Schedule
      • 9.3.2.3 Creating Events
    • 9.3.3 Using the Read Function on a Scheduler
    • 9.3.4 Using the Set Function on a Scheduler
    • 9.3.5 Using the Delete Function on a Scheduler
• 10 Calendar
  • 10.1 Overview of the Calendar XML File
  • 10.2 Creating and Modifying the Calendar XML File
  • 10.3 Calendar SOAP Interface
    • 10.3.1 Using the List Function on a Calendar
    • 10.3.2 Using the Get Function a Calendar
      • 10.3.2.1 Creating an Exception
      • 10.3.2.2 Defining Exception Dates
      • 10.3.2.3 Daily Recursions
      • 10.3.2.4 Monthly Recursions
      • 10.3.2.5 Exception Examples
    • 10.3.3 Using the Set Function on a Calendar
    • 10.3.4 Using the Read Function on a Calendar
    • 10.3.5 Using the Delete Function on a Calendar
• 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
    • 11.3.1 Using the List Function on a Real Time Clock
    • 11.3.2 Using the Get Function on a Real Time Clock
    • 11.3.3 Using the Set Function on a Real Time Clock
    • 11.3.4 Using the Delete Function on a Real Time Clock
• 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
    • 12.3.1 Using the List Function on a Type Translator
    • 12.3.2 Using the Get Function on a Type Translator
    • 12.3.3 Using the Set Function on a Type Translator
    • 12.3.4 Pre Defined Type Translator Rules
      • 12.3.4.1 16xSNVT_switch_TO_SNVT_state
      • 12.3.4.2 SNVT_lev_disc_TO_SNVT_occupancy
      • 12.3.4.3 SNVT_lev_disc_TO_SNVT_switch
      • 12.3.4.4 SNVT_occupancy_TO_SNVT_setting
      • 12.3.4.5 SNVT_scene_TO_SNVT_setting
      • 12.3.4.6 SNVT_scene_TO_SNVT_switch
      • 12.3.4.7 SNVT_setting_TO_SNVT_switch
      • 12.3.4.8 SNVT_state_TO_16xSNVT_switch
      • 12.3.4.9 SNVT_switch_TO_SNVT_lev_disc
• 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
    • 13.3.1 Using the List Function on a Type Translator Rule
    • 13.3.2 Using the Get Function on a Type Translator Rule
      • 13.3.2.1 Creating a Case Structure
      • 13.3.2.2 Case Rules
    • 13.3.3 Using the Set Function on a Type Translator Rule
    • 13.3.4 Using the Delete Function on a Type Translator Rule
• 14 LonWorks Driver
  • 14.1 LonWorks Networks
    • 14.1.1 Using the List Function on a LonWorks Network
    • 14.1.2 Using the Get Function on a LonWorks Network
    • 14.1.3 Using the Set Function on a LonWorks Network
      • 14.1.3.1 Issuing Network Synchronization Commands
      • 14.1.3.2 Issuing Network Scan Commands to Discover Devices
    • 14.1.4 Using the Delete Function on a LonWorks Network
  • 14.2 LonWorks Channels
    • 14.2.1 Using the List Function on a LonWorks Channel
    • 14.2.2 Using the Get Function on a LonWorks Channel
    • 14.2.3 Using the Set Function on a LonWorks Channel
    • 14.2.4 Using the Delete Function on a LonWorks Channel
  • 14.3 LonWorks Devices
    • 14.3.1 Using the List Function on a LonWorks Device
    • 14.3.2 Using the Get Function on a LonWorks Device
    • 14.3.3 Using the Set Function on a LonWorks Device
      • 14.3.3.1 Issuing Network Management Commands
      • 14.3.3.2 Issuing Debugging Commands
    • 14.3.4 Using the Delete Function on a LonWorks Device
  • 14.4 Routers
  • 14.5 Remote Network Interface
  • 14.6 LonWorks Functional Blocks
    • 14.6.1 Using the List Function on a LonWorks Functional Block
    • 14.6.2 Using the Get Function on a LonWorks Functional Block
    • 14.6.3 Using the Set Function on a LonWorks Functional Block
    • 14.6.4 Using the Delete Function on a LonWorks Functional Block
  • 14.7 Network Variables (LonWorks Data Points)
    • 14.7.1 Using the List Function on Network Variables
    • 14.7.2 Using the Get Function on Network Variables
    • 14.7.3 Using the Set Function on a Network Variable
    • 14.7.4 Using the Delete Function on a Network Variable
  • 14.8 Configuration Properties (LonWorks Data Points)
  • 14.9 LonWorks Connections
• 15 Modbus Driver
  • 15.1 Modbus Channels
    • 15.1.1 Using the List Function on Modbus Channels
    • 15.1.2 Using the Get Function on Modbus Channels
    • 15.1.3 Using the Set Function on Modbus Channels
    • 15.1.4 Using the Delete Function on Modbus Channels
  • 15.2 Modbus Devices
    • 15.2.1 Using the List Function on Modbus Devices
    • 15.2.2 Using the Get Function on Modbus Devices
    • 15.2.3 Using the Set Function on Modbus Devices
    • 15.2.4 Using the Delete Function on Modbus Devices
  • 15.3 Modbus Virtual Functional Blocks
  • 15.4 Modbus Data Points
    • 15.4.1 Using the List Function on Modbus Data Points
    • 15.4.2 Using the Get Function on Modbus Data Points
    • 15.4.3 Using the Set Function on Modbus Data Points
    • 15.4.4 Using the Delete Function on Modbus Data Points
• 16 M Bus Driver
  • 16.1 M Bus Channels
    • 16.1.1 Using the List Function on M Bus Channels
    • 16.1.2 Using the Get Function on M Bus Channels
    • 16.1.3 Using the Set Function on M Bus Channels
    • 16.1.4 Using the Delete Function on M Bus Channels
  • 16.2 M Bus Devices
    • 16.2.1 Using the List Function on M Bus Devices
    • 16.2.2 Using the Get Function on M Bus Devices
    • 16.2.3 Using the Set Function on M Bus Devices
    • 16.2.4 Using the Delete Function on M Bus Devices
  • 16.3 M Bus Virtual Functional Blocks
  • 16.4 M Bus Data Points
    • 16.4.1 Using the List Function on M Bus Data Points
    • 16.4.2 Using the Get Function on M Bus Data Points
    • 16.4.3 Using the Set Function on M Bus Data Points
    • 16.4.4 Using the Delete Function on M Bus Data Points
• 17 Virtual Driver
  • 17.1 Virtual Channels
    • 17.1.1 Using the List Function on Virtual Channels
    • 17.1.2 Using the Get Function on Virtual Channels
    • 17.1.3 Using the Set Function on Virtual Channels
    • 17.1.4 Using the Delete Function on a Virtual Channel
  • 17.2 Virtual Devices
    • 17.2.1 Using the List Function on Virtual Devices
    • 17.2.2 Using the Get Function on Virtual Devices
    • 17.2.3 Using the Set Function on Virtual Devices
    • 17.2.4 Using the Delete Function on Virtual Devices
  • 17.3 Virtual Functional Blocks
  • 17.4 Virtual Data Points
    • 17.4.1 Using the List Function on Virtual Data Points
    • 17.4.2 Using the Get Function on Virtual Data Points
    • 17.4.3 Using the Set Function on Virtual Data Points
    • 17.4.4 Using the Delete Function on 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.1.1 TCP/IP Settings
    • 19.1.2 Time Settings
    • 19.1.3 Security Settings
    • 19.1.4 Static System Information
    • 19.1.5 Real Time System Information
    • 19.1.6 E Mail Settings
    • 19.1.7 IP 852 Router Settings
    • 19.1.8 IP 852 Router Statistics
    • 19.1.9 LonScanner Protocol Analyzer
    • 19.1.10 Reboot
  • 19.2 System Test Methods
    • 19.2.1 SMTP E Mail Server Test
    • 19.2.2 IP 852 Configuration Server Test
    • 19.2.3 Connection Test
• 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.2.1 Instantiating the Web Service Client in Visual C# .NET 3.5
    • 20.2.2 Instantiating the Web Service Client in Visual C# .NET 2.0
    • 20.2.3 Instantiating the Web Service Client in Visual Basic .NET 3.5
  • 20.3 Calling Web Services Methods
    • 20.3.1 Reading and Writing Data Point Values in Visual C# .NET 3.5
    • 20.3.2 Reading and Writing Data Point Values in Visual C# .NET 2.0
    • 20.3.3 Reading and Writing Data Point Values in Visual Basic .NET 3.5
  • 20.4 Accepting a Web Binding From a SmartServer
• 21 Programming Examples
  • 21.1 Visual C#.NET Examples
    • 21.1.1 Reading and Writing Data Point Values in Visual C# .NET
    • 21.1.2 Creating and Reading a Data Logger in Visual C# .NET
      • 21.1.2.1 Creating a Data Logger
      • 21.1.2.2 Reading a Data Logger
    • 21.1.3 Creating a Scheduler and Calendar in Visual C# .NET
    • 21.1.4 Creating and Installing a LonWorks Device in Visual C# .NET
    • 21.1.5 Commissioning External Devices in Visual C# .NET
    • 21.1.6 Discovering and Installing External Devices in Visual C# .NET
    • 21.1.7 Configuring the SmartServer in Visual C# .NET
  • 21.2 Visual Basic.NET Examples
    • 21.2.1 Reading and Writing Data Point Values in Visual Basic.NET
    • 21.2.2 Creating and Reading a Data Logger in Visual Basic. NET
      • 21.2.2.1 Creating a Data Logger
      • 21.2.2.2 Reading a Data Logger
    • 21.2.3 Creating a Scheduler and Calendar in Visual Basic.NET
    • 21.2.4 Creating and Installing a LonWorks Device in Visual Basic.NET
    • 21.2.5 Commissioning External Devices in Visual Basic.NET
    • 21.2.6 Discovering and Installing External Devices in Visual Basic.NET
    • 21.2.7 Configuring the SmartServer in Visual Basic.NET
• 22 Programming the SmartServer with Java
  • 22.1 Setting up the Java Programming Environment
    • 22.1.1 Installing Echelon SmartServer JAX-ES Programming Example
    • 22.1.2 Installing Eclipse IDE for Java EE Developers
    • 22.1.3 Installing the Java Development Kit
    • 22.1.4 Installing Maven 2.2.1
    • 22.1.5 Setting System Environment Variables
  • 22.2 Creating a JAX-WS Client
  • 22.3 Java Programming Examples
    • 22.3.1 Reading and Writing Data Point Values in Java
    • 22.3.2 Creating and Reading a Data Logger in Java
      • 22.3.2.1 Creating a Data Logger
      • 22.3.2.2 Reading a Data Logger
    • 22.3.3 Creating and Installing a LonWorks Device in Java
    • 22.3.4 Discovering and Installing External Devices in JAVA
• Appendix A: SOAP Tester Example