Siemens HiPath optiPoint 410 Bedienungsanleitung

HiPath

optiPoint application module

XML Applications

Developer’s Guide

For internal distribution only

May 18, 2006

1optiPoint application module - XML Applications, Developer’s Guide

bkIVZ.fm

1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

1.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

1.2 Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

2 Functions and Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

2.1 Infrastructure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

2.2 Basic Functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

2.3 Push Technology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

2.4 Using Predefined Images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

3 Installation and Starting the Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

3.1 Generating a Program on the Telephone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

3.2 Starting the Program. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

4 XML Object Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

4.1 Phone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

4.2 Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

4.3 Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

4.4 Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

4.5 Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

4.6 Alert. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

4.7 List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

4.8 TextBox. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

4.9 Ticker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

4.10 Hidden. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

4.11 Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

4.12 Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

5 Push Technology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

6 Appendix. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

6.1 Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

6.2 XML Schema. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

c01.fm

18. May 2006

optiPoint application module - XML Applications, Developer’s Guide 2

Introduction

Overview

1 Introduction

1.1 Overview

In conjunction with the optiPoint application module, users of Siemens optiPoint 410/420 410/

420 IP telephones have simple access to many applications.

In addition to local services such as the integrated address book, these applications also in-

clude those that can live anywhere on the network and which can be just as easily accessed

thanks to the existing IP connection.

The optiPoint application module uses not only a standard WAP browser for Internet or intranet

contents conforming to the WML standard, it can also be integrated with numerous application-

specific solutions.

The application platform for the Siemens optiPoint telephones described here represents a new

angle in the convergence between telephony and web applications. An XML interface makes it

possible, using only a suitably-equipped telephone, to interact with applications in the back of-

fice. Since XML and HTTP serve as interfaces, technologies normally used for web applications

can also be used for server-side applications: Apache, Microsoft IIS, Tomcat, Java servlets,

J S P, P H P, e t c .

An important characteristic of convergence is that the server-side application can initiate the

transfer of data to the application platform of the telephone, just as a phone not only makes calls

but also receives them.

In this way, you can extend the range of application of your optiPoint IP phone considerably and,

at the same time, optimize access to your applications using a highly available gateway – inde-

pendent of or as an addition to your other access options such as computer installations.

The XML communication interface is available in the firmware for the device types

optiPoint 410/420 standard and advance in the corenet IP variant (HFA). The application type

described here distinguishes itself in terms of installation, basic functionality and range of ap-

plication from Java MIDlets, which always function as stand-alone applications.

This document describes the XML interface as well as error handling for invalid XML data. In

view of this, note that error handling is not visible to the user. If some of the elements in an ob-

ject are missing, the existing elements are displayed anyway. When developing applications,

validation of the XML documents using an XML schema is recommended (see Section 6.2,

"XML Schema").

This document is meant for use by Siemens internal developers as well as by third party appli-

cation developers. It contains the following sections:

• Functions and Features

• Installation and Starting the Program

Introduction

18. May 2006

3optiPoint application module - XML Applications, Developer’s Guide

c01.fm

Prerequisites

• XML Object Reference

• Push Technology

• Appendix

1.2 Prerequisites

The following components and tools are required for developing applications for the application

platform:

1. optiPoint phone, type optiPoint 410 standard/advance or optiPoint 420 standard/advance

2. A DSM (display module) or APM (application module) must be connected to the telephone.

3. Infrastructure:

• IP network to which the IP phone is connected

• Web browser for creating programs for the telephone using the Web Based Manager

(e. g., Internet Explorer, Firefox, Opera)

• Web server for sending the XML data to the IP phone (e. g., Microsoft IIS, Apache,

Tomcat). It is important that the server is configured with the MIME type text/xml.

• For interactive applications: Application platform on the server for dynamically gener-

ating XML data (e. g., Java servlet, ASP, CGI, PHP).

4. XML editor:

An XML editor that can validate the documents using XML schema is recommended (e. g.,

Oxygen, XMLWriter, EditiX, XMLSpy).

5. For developing Java servlets: A suitable development environment, e. g., Eclipse, Net-

Beans, IBM Websphere Studio.

c01.fm

18. May 2006

optiPoint application module - XML Applications, Developer’s Guide 4

Functions and Features

Infrastructure

2 Functions and Features

2.1 Infrastructure

The following diagram shows the lines of communication between the various components:

LAN

optiPoint optiPoint

optiPoint

Application Server /

Web Server

optiPoint

application module

Functions and Features

18. May 2006

5optiPoint application module - XML Applications, Developer’s Guide

c01.fm

Basic Functionality

2.2 Basic Functionality

The following diagram shows the basic functions of the application:

The functional process of an application can be described as follows:

1. The user installs an application on the optiPoint phone.

2. The user calls an application from the list of programs installed.

3. The phone calls the URL of the program on the server.

4. The server-side program generates an XML document that corresponds to the specified

XML schema (see Section 6.2, "XML Schema"). The web server sends the XML document

to the phone via an HTTP connection.

5. The XML document is parsed and shown on the display of the DSM or the APM.

6. The user enters commands and data via the touchscreen or the keyboard of the DSM or

the APM.

7. The user’s commands and entries are detected by listeners in the telephone software.

8. The phone passes the user entries as key/value pairs on to the server-side program.

>When the program starts, the HTTP GET request that requests the XML document

from the server also contains the IP address and the telephone number of the IP

phone, e.g., ipaddress=137.223.238.174&phonenumber=2256.

IP Phone 410/420

DSM or APM

Display

Keypad XML

Parser

Java

Environment

XML

Application

Business

Logic

XML

HTTP/HTTPS Webserver

Server

c01.fm

18. May 2006

optiPoint application module - XML Applications, Developer’s Guide 6

Functions and Features

Push Technology

2.3 Push Technology

Push technology makes it possible for the program to be started and, therefore, the data to be

pushed from the server-side.

With Push technology, a program on the server calls a specified URL for the IP phone and

prompts it to load a specific XML document from a specific server. After this, the XML document

is also parsed and displayed as in normal operation.

2.4 Using Predefined Images

In addition to being able to link any images saved on a server within an XML document, prepre-

pared images, for example, for buttons, are also available. These images are already included

in the telephone software. One advantage of this is reduced data traffic and, therefore, in-

creased application speed. For more information about linking images, see Section 4.12, "Im-

age".

Installation and Starting the Program

18. May 2006

7optiPoint application module - XML Applications, Developer’s Guide

c01.fm

Generating a Program on the Telephone

3 Installation and Starting the Program

3.1 Generating a Program on the Telephone

Programs for the application platform described here are generated using the Web Based Man-

ager. For this, the following steps are necessary:

1. Enter the IP address of the telephone in the web browser. The introduction page appears.

2. Go to Administration and enter the administrator password. In the Administration menu,

select New Program. The following input screen is displayed:

3. Now enter the following information:

•Display Name: The name of the program as it appears in the program menu on the

APM or the DSM. The display name must meet the following criteria:

• It must be a unique name on the telephone.

• It cannot contain ’^’ characters.

• It cannot be empty.

• It cannot be longer than 100 characters.

•Application Name: This is used internally by the application to identify the program

running on the telephone. The application name must meet the following criteria:

• It must be a unique name on the telephone.

• It cannot contain any non-alphanumeric characters.

• The first character must be a letter.

• It cannot be empty.

c01.fm

18. May 2006

optiPoint application module - XML Applications, Developer’s Guide 8

Installation and Starting the Program

Generating a Program on the Telephone

• It cannot be longer than 20 characters.

•Server Address: The IP address or domain/host name of the server (example,

www.domain.de) that provides the application or the XML document.

•Server Port Number: The number of the port that the server uses to provide the ap-

plication or the XML document.

•Program Name on Server: The relative path to the servlet or to the first XML page of

the application on the server. The relative path refers to the root directory for docu-

ments on the web server, e. g., for Apache htdocs. For instance, if an XML document

is saved in C:\programs\Apache Group\Apache\htdocs\ipp\ippTest.xml, the entry

is ipp/ippTest.xml. The information cannot be longer than 100 characters.

•Use Proxy: This specifies whether a proxy should be used. If Yes has been set, the

program uses the default Java proxy. This can be configured in the Web Based Man-

ager under Administration > Applications > Java. In order to use a proxy, not only

must the telephone be visible to the proxy but also the server.

4. Click the Create Program button to start generating the program.

3.1.1 Configuring and Deleting Programs Using the Web Based Man-

ager

Complete the following steps to configure or delete a program:

1. Enter the IP address of the telephone in the web browser. The introduction page appears.

2. Go to Administration and enter the administrator password. In the Administration menu,

select Configure/Delete Program. The following input screen is displayed:

>The information entered is validated after being sent. If the information is incorrect,

the program is not generated and an error message is returned.

Installation and Starting the Program

18. May 2006

9optiPoint application module - XML Applications, Developer’s Guide

c01.fm

Starting the Program

select the program that you would like to configure or delete from the Program List pull-

down menu.

If you would like to reconfigure the program, change the respective parameters. For more

information about these parameters, see Section 3, "Installation and Starting the Program".

Click the Submit Changes button to confirm the changes.

If you would like to delete the program, click the Delete Program button.

3.2 Starting the Program

If the user starts a program on the telephone, the application calls the URL of the program from

its end on the server.

The telephone tells the server its IP address and telephone number using key/value pairs within

the URL. The key/value pairs are sent in the following format:

ipaddress=<telephone-IP-address>&phonenumber=<telephone number>

Dieses Handbuch passt für folgende Modelle

Inhaltsverzeichnis

Andere Siemens Steuereinheit Handbücher

Siemens

Siemens SIMATIC NET MM900 Series Administratorhandbuch

Siemens

Siemens 6EP1935-6MC01 Bedienungsanleitung

Siemens

Siemens SINUMERIK 828D Turning Bedienungsanleitung

Siemens

Siemens SIRIUS 3TK2834 Bedienungsanleitung

Siemens

Siemens ASIC SIM 1-2 Stücklistenhandbuch

Siemens

Siemens SINAMICS S120 Bedienungsanleitung

Siemens

Siemens LFE1 Series Bedienungsanleitung

Siemens

Siemens VAG61 Series Bedienungsanleitung

Siemens

Siemens SIMOTICS CONNECT 400 Bedienungsanleitung

Siemens

Siemens SIMATIC 6ES7135-4MB02-0AB0 Bedienungsanleitung

Siemens

Siemens NIM-1W Bedienungsanleitung

Siemens

Siemens WF 723 C Betriebsanleitung

Siemens

Siemens LOGO! Series Bedienungsanleitung

Siemens

Siemens LFL Series Betriebsanleitung

Siemens

Siemens SIRIUS ACT 3SU14 Bedienungsanleitung

Siemens

Siemens ET 200S 1SI Stücklistenhandbuch

Siemens

Siemens SIMATIC ET 200SP Bedienungsanleitung

Siemens

Siemens MXG461B Series Betriebsanleitung

Siemens

Siemens Simatic S7-1500 Technisches Dokument

Siemens

Siemens Flowrite 599 Series Betriebsanleitung

Siemens

Siemens SIMATIC TI505 386/ATM Bedienungsanleitung

Siemens

Siemens 550-818B Bedienungsanleitung

Siemens

Siemens SIRIUS 3SB3 Bedienungsanleitung

Siemens

Siemens SINUMERIK 840D Bedienungsanleitung

Beliebte Steuereinheit Handbücher anderer Marken

Festo

Festo Compact Performance CP-FB6-E Stücklistenhandbuch

Elo TouchSystems

Elo TouchSystems DMS-SA19P-EXTME Bedienungsanleitung

JS Automation

JS Automation MPC3034A Bedienungsanleitung

JAUDT

JAUDT SW GII 6406 Series Kurzanleitung

Spektrum

Spektrum Air Module System Bedienungsanleitung

BOC Edwards

BOC Edwards Q Series Bedienungsanleitung

KHADAS

KHADAS BT Magic Bedienungsanleitung

Etherma

Etherma eNEXHO-IL Bedienungsanleitung

PMFoundations

PMFoundations Attenuverter Bedienungsanleitung

GEA

GEA VARIVENT Bedienungsanleitung

Walther Systemtechnik

Walther Systemtechnik VMS-05 Bedienungsanleitung

Altronix

Altronix LINQ8PD Montageanleitung

Eaton

Eaton Powerware Series Bedienungsanleitung

WAGO

WAGO 750-407/040-000 Bedienungsanleitung

Sony

Sony CCU-590 Bedienungsanleitung

Graco

Graco 25D614 Bedienungsanleitung

Task Force Tips

Task Force Tips YE-RF-900 Programmierhandbuch

Shini

Shini SPV-U Series Bedienungsanleitung