Alcatel-Lucent XML Web Services

Frequently Asked Questions

1 1.1 1.2 1.3 1.4 1.5 2

GENERAL QUESTIONS ABOUT XML WHAT IS XML? IS XML HTML? WHAT IS THE DIFFERENCE BETWEEN XML AND C OR C++? WHAT IS SOAP? WHAT IS A WEB SERVICE? TECHNICAL QUESTIONS ABOUT ALCATEL XML WEB SERVICES

2 2 2 2 3 3 4

2.1 HOW DO THE ALCATEL XML WEB SERVICES WORK? 4 2.2 HOW DO I GET ACCESS TO THE ALCATEL XML WEB SERVICES? 4 2.3 WHAT DEVELOPMENT ENVIRONMENT IS NEEDED TO USE ALCATEL APIS? 4 2.4 WHAT ARE EXACTLY ALCATEL XML WEB SERVICES? 4 2.5 HOW ARE THE ALCATEL WEB SERVICES IMPLEMENTED? 5 2.6 WHAT IS THE PURPOSE OF WSDL FILE? 6 2.7 WHERE CAN I GET ARCHITECTURE & SERVICE DESCRIPTIONS OF ALCATEL SOLUTIONS USING WEB SERVICES? 6 2.8 WHAT'S IN THE DEVELOPER'S KIT? 6 2.9 WHAT PROGRAMMING LANGUAGES DO YOU SUPPORT? 6 2.10 WHAT CAN I DO WITH THE WSDL FILE? 6 2.11 HOW CAN I VALIDATE OR TEST MY APPLICATION? 6 3 3.1 3.2 3.3 3.4 XML PHONE WEB SERVICES 7

WHAT IS A CALLREF? 7 WHAT IS AN ASSOCIATED DATA? 7 COULD YOU EXPLAIN THE EVENTS MECHANISM? 7 I HAVE AN OTUC INSTALLATION OR AN API FRAMEWORK 2.0 INSTALLATION WITH A LICENSE FILE CONTAINING THE XMLTELEPHONY LICENSE. HOWEVER I CANT GIVE THE XMLTELEPHONY RIGHT TO THE USERS. 7 MY IP TOUCH XML SERVICES DO I NEED AN OMNIPCX PLATFOM TO VALIDATE/TEST MY IP TOUCH APPLICATION? CAN I USE IN MY APPLICATION IP TOUCH WITH ANOTHER XML WEB SERVICES 8 8 8

4 4.1 4.2

Alcatel-Lucent Application Partner Program (AAPP)

1 General questions about XML

1.1 What is XML?
XML belongs to the family of script oriented programming languages like HTML, the wellknown language at the origin of the web technologies. It has has been introduced in order to extend and enrich the capabilities of HTML in the domain of web information publishing. Since then, Its great flexibility and independency from the technologies and heterogeneous proprietary solutions have set XML one of the key reference languages in all the aspects of the Enterprise Application Integration market: description and publishing of services & functions born by server applications, description of protocols and messages exchanged between applications, description and structure of documents held by applications & clients etc... XML is the basis of web services principles which encompass SOAP, UDDI etc... XML stands for Extensible Markup Language. XML is a system for defining, validating, and sharing document formats. XML uses tags (for example <em>emphasis</em> for emphasis), to distinguish document structures, and attributes (for example, in <A HREF="http://www.xml.com/">, HREF is the attribute name, and http://www.xml.com/ is the attribute value) to encode extra document information. XML will look very familiar to those who know about SGML and HTML.

1.2 Is XML HTML?

No. An XML processor can read clean, valid, HTML, and with a few small changes an HTML browser like Netscape Navigator or Microsoft Internet Explorer would be able to read XML (the designers of XML would really like the authors of Navigator and Internet Explorer to make those changes). The biggest difference between XML and HTML is that in XML, you can define your own tags for your own purposes, and if you want, share those tags with other users.

1.3 What is the difference between XML and C or C++?

C and C++ (and other languages like FORTRAN, or Pascal, or BASIC, or Java or dozens more) are programming languages with which you specify calculations, actions, and decisions to be carried out in order: mod curconfig[if left(date,6) = "01-Apr", t.put "April Fool!", fput days('31102002','DDMMYYYY')-days(sdate,'DDMMYYYY') " shopping days to Samhain"]; XML is a markup specification language with which you can design ways of describing information (text or data), usually for storage, transmission, or processing by a program: it says nothing about what you should do with the data (although your choice of element names may hint at what they are for): <part num="DA42" models="LS AR DF HG KJ" update="2001-11-22"> <name>Camshaft end bearing retention circlip</name> <image drawing="RR98-dh37" type="SVG" x="476" y="226"/> <maker id="RQ778">Ringtown Fasteners Ltd</maker> <notes>Angle-nosed insertion tool <tool id="GH25"/> is
AAPP XML Web Services FAQ
Copyright 2006 Alcatel-Lucent, All rights reserved

Edition 2.1 Page 2

required for the removal and replacement of this item.</notes> </part> On its own, an SGML or XML file (including HTML) doesn't do anything. It's a data format which just sits there until you run a program which does something with it.

1.4 What is SOAP?

Communicating with and controlling systems across a network is an essential part of computing. The Simple Object Access Protocol (SOAP) follows the typical client/server model and is designed to use standard technologies, like the extensible markup language (XML), to transmit small amounts of information across a network using a standardized language and format. SOAP represents a specification of communication between web services based on exchange of messages written in XML format. The SOAP protocol has been introduced in order to manage transport of messages over the web with a simple and easy implementation in web or application servers. One of the assets of SOAP is to be independent from the programming language used or the operating system running on the server where the web service is active. This was one of objective of the founder of SOAP to keep the representation of SOAP as generic and neutral as possible from the communication protocol principles while inspiring from RPC services. The definition of SOAP protocol, messages and dialogue between client and servers is written in XML language associated to Namespaces and XML Schemas. More information can be found at: Development or SOAP FAQ: http://www.soaprpc.com/faqs/SoapFAQ.html W3C specifications: http://www.w3.org/TR/SOAP/

1.5 What is a Web service?

A Web service is a piece of software that you can interact with using an XML message format. This message format is usually SOAP (Simple Object Access Protocol), though alternatives exist (e.g. XML-RPC, REST). Other than SOAP, there a number of other standards that can be used by your Web service and their clients. The interface provided by a Web service is often defined using another XML format called WSDL. A WSDL description can be shared with a Web service client in many ways, but the recommended way is to use a registry to publish it. UDDI (Universal Discovery Description and Integration) is a specification of a Web service registry that is industry accepted. UDDI registries can be hosted internal to a company or a group of companies and used for looking up Web services, much the same way a LDAP directory is. There is also a global UDDI registry, called a UBR (Universal Business Registry), that is hosted by IBM, Microsoft, SAP and Fujitsu. Interestingly, a UDDI registry is itself a Web service- searching and publishing to the registry can be done using SOAP messages. Besides WSDL and UDDI, there are a number of other Web service standards and specifications that deal with issues like security, composing Web services, Transactions etc.

AAPP XML Web Services FAQ

Copyright 2006 Alcatel-Lucent, All rights reserved

Edition 2.1 Page 3

2 Technical questions about Alcatel-Lucent XML Web Services

2.1 How do the Alcatel-Lucent XML web services work?
Developers write software programs that communicate to Alcatel-Lucent OmniPCX platforms. Communication is performed via the Simple Object Access Protocol (SOAP), an XML-based mechanism for exchanging typed information

2.2 How do I get access to the Alcatel-Lucent XML Web Services?

You must first agree to the terms and conditions of the Alcatel-Lucent Web Service and register as an Open Developer. Then you will be able to download documentations, examples and WSDL

2.3 What development environment is needed to use AlcatelLucent APIs?

All standard environment supporting Web Services like J2EE or Microsoft .Net can be used with Alcatel-Lucent APIs provided they are able to produce interface stubs based on Alcatel-Lucent WSDL files. The environment is independent of the programming language: C, C++, C#, Java, etc... However we recommend to work with our partner: Systinet . See http://www.systinet.com/

2.4 What are exactly Alcatel-Lucent XML Web Services?

Alcatel-Lucent XML Web services are structured in 2 families: Application Phone XML Services My IP Touch XML Services Communication Web Services - XML Phone Web Services - XML Assistant Web Services - XML Messaging Web Services - XML UDA Web Services - XML Pbx Management Web Services - XML Phone Set Programming Web Services In addition, two specific web services are provided: XML Framework Management Web Services to administrate XML Web Services users (creation, deletion, modification)

AAPP XML Web Services FAQ

Copyright 2006 Alcatel-Lucent, All rights reserved

Edition 2.1 Page 4

XML API Framework Web Services which is the entry point for all web service and allows to open a session with the Framework My IP Touch XML Services provides means for an application to interact with users of OmniPCX Enterprise or Office communication servers through their IP Touch terminal. Thanks to this openness, an application is able to take the control of an IP Touch terminal. This lets the application build screens and collect user actions. Screen control is granted when a user activates an application on his terminal. If the user has not activated an application, My IP Touch XML Services still allow the application to issue notifications to the terminal. XML Phone WS available on the both platforms are made of 2 subsets of features: Call control Services : to manage calls on the users business phone set Advanced phone Services : to access OmniPCX Directories and to manage users nomad mode and users Call Log information XML Phone Set Programming WS available on the both platforms allows customizing the behaviour of the users phone set and the phone set associated resources XML Assistant WS (only for OmniPCX Enterprise) provide, to an external application, the ability to set and review the rules that route incoming calls of an user. XML UDA WS provide search facilities to access Phone book directory or any external LDAP directories. XML Messaging WS (only for OmniPCX Enterprise) are used to interact with an AlcatelLucent Voicemail 4635 or an Alcatel-Lucent Voice Mail 4645 or VXML voice mail of OmniTouch Unified Communication. My Messaging Web Services allow to : List of voice messages Play a voice message on the phone (with Pause, resume and stop) Forward the message to another phone set Record a voice message from the phone (with Pause, Resume, stop, play for verify) and Send to one or more persons Delete a voice message Callback the sender XML Pbx Management WS (only for OmniPCX Enterprise) are designed to help the development of a Global Enterprise Identity Management solution. The aim of My Management Web Services is to offer the capability of managing part of the OmniPCX configuration data, particularly information related to subscribers and subscribers phone sets..

2.5 How are the Alcatel-Lucent Web Services implemented?

Alcatel-Lucent Web Services are implemented as a web service. The service supports several SOAP methods; these are described in an accompanying WSDL file that can be imported into your favorite web services programming environment

AAPP XML Web Services FAQ

Copyright 2006 Alcatel-Lucent, All rights reserved

Edition 2.1 Page 5

2.6 What is the purpose of WSDL file?

WSDL stands for Web Service Description Language. It provides a formal description of a web service, much like CORBA's IDL. The WSDL file is all you need to know how to call the web service; toolkits can generate proxy code from a WSDL file directly. WSDL release 1.0 has been issued in september 2000 after a first proposition to W3C by Ariba, IBM & Microsoft. It represents the description format of web services based on XML. The web services are represented in WSDL like a set of terminations acting on messages embedding information related to documents and procedures. This may appear as a very generic definition of the web services. The main asset of WSDL is to be independent from transport protocol messages and can be used directly on top of any of HTTP, SOAP or MIME. SOAP has become since then the most common transport protocol layer used even though it may also be run on top of legacy middleware like MQSeries from IBM, MSMQ from Microsoft, IIOP from Corba or RMI from Java models. The official WSDL definition is at http://www.w3.org/TR/wsdl.

2.7 Where can I get architecture & service descriptions of AlcatelLucent Solutions using Web Services?
See the XML Web Services White Paper. Available on the web.

2.8 What's in the developer's kit?

The kit contains WSDL files describing the Alcatel-Lucent XML Web services, documentation on how to use the services and examples with source code in Java

2.9 What programming languages do you support?

The service has been tested with Java (Apache SOAP and Apache Axis), PHP, C# and C++ in MS Visual Studio .NET. The service has not been tested with clients in other languages but it should work with any language with web services support.

2.10 What can I do with the WSDL file?

Many web services toolkits can take a WSDL file and automatically generate a clientside proxy to call the Alcatel-Lucent XML Web Services.

2.11 How can I validate or test my application?

By registering into AAPP program as Member you will be able to download the server software package. This package provides the link between your application and the Alcatel-Lucent OmniPCX platforms. Obviously you need also an OmniPCX platform.

AAPP XML Web Services FAQ

Copyright 2006 Alcatel-Lucent, All rights reserved

Edition 2.1 Page 6

3 XML Phone Web Services

3.1 What is a CallRef?
A callref is a number defined to identify a call established between two parties. A Callref can only be managed using the telephonic events mechanism (see Tutorials document to not how to implement it).

3.2 What is an Associated Data?

It is a string character (30 maximum) which might be associate to a call. A typical scenario is an Interactive Voice Response (IVR) which will transfer the call to an agent with the customer identification (included in the associated data) of the caller party in order to be able to popup the customer data into the agents desktop in parallel with the communication.

3.3 Could you explain the events mechanism?

When the application client subscribes to telephonic events, he must give to the framework the URL where notifications are sent and handled by the application which include a server part. See the APIs Tutorials to get detailed explanations how it works.

3.4 I have an OTUC installation or an API Framework 2.0 installation with a license file containing the XMLTelephony license. However I cant give the XMLTelephony right to the users.
In order to be able to give the right to the XMLTelephony service to a user, you should first enable the XMLTelephony proxy in the configuration for the API Framework service. This configuration can be accessed through the list of the services declared in the webAdmin.

AAPP XML Web Services FAQ

Copyright 2006 Alcatel-Lucent, All rights reserved

Edition 2.1 Page 7

4 My IP Touch XML Services

4.1 Do I need an OmniPCX platfom to validate/test my IP Touch application?
No by registering into AAPP program as a member you can download the SINOX tool which simulate the OmniPCX platform. Obviously IP Touch phones are mandatory.

4.2 Can I use in my application IP Touch with another XML Web Services
Yes of course, you can develop an application which provides, for examples, telephonic features in addition to graphical presentation. The same server platform will embed the framework for XML Web Services and the PRS (Presentation Server) for My IP Touch XML Services.

AAPP XML Web Services FAQ

Copyright 2006 Alcatel-Lucent, All rights reserved

Edition 2.1 Page 8