Nortel NN42020-123 User manual

NN42020-123
Multimedia Communication Portfolio
Multimedia Communication
Server
Open Provisioning Interface
MCS 5100 3.5 Standard 4.0 January 2006

Open Provisioning Interface Reference Guide
Copyright © Nortel Networks Limited 2006
Finding the latest updates on the Nortel Web site
The content of this documentation was current at the time the product was released. To
check for updates to the latest documentation and software for MCS 5100, click one of
the following links:
Link to Takes you directly to the
Latest Software Nortel page for MCS 5100 software located at
www130.nortelnetworks.com/cgi-bin/eserv/cs/
main.jsp?cscat=SOFTWARE&resetFilter=1&tranProduct=124
82
Latest Documentation Nortel page for MCS 5100 documentation located at
www130.nortelnetworks.com/cgi-bin/eserv/cs/
main.jsp?cscat=DOCUMENTATION&resetFilter=1&tranProdu
ct=12482

NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006
4
Copyright © Nortel Networks Limited 2006

Open Provisioning Interface Reference Guide
Copyright © Nortel Networks Limited 2006
How to get help
This section explains how to get help for Nortel products and services.
Getting help from the Nortel web site
The best way to get technical support for Nortel products is from the Nortel Technical Support
web site:
www.nortel.com/support
This site provides quick access to software, documentation, bulletins, and tools to address
issues with Nortel products. From this site, you can:
• download software, documentation, and product bulletins
• search the Technical Support Web site and the Nortel Knowledge Base for answers
to technical issues
• sign up for automatic notification of new software and documentation for Nortel
equipment
• open and manage technical support cases
Getting help over the phone from a Nortel Solutions Center
If you do not find the information you require on the Nortel Technical Support web site, and
you have a Nortel support contract, you can also get help over the phone from a Nortel Solu-
tions Center.
In North America, call 1-800-4NORTEL (1-800-466-7835).
Outside North America, go to the following web site to obtain the phone number for your
region:
www.nortel.com/callus

NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006
6
Copyright © Nortel Networks Limited 2006
Getting help from a specialist by using an Express Routing Code
To access some Nortel Technical Solutions Centers, you can use an Express Routing Code
(ERC) to quickly route your call to a specialist in your Nortel product or service. To locate the
ERC for your product or service, go to:
www.nortel.com/erc
Getting help through a Nortel distributor or reseller
If you purchased a service contract for your Nortel product from a distributor or authorized
reseller, contact the technical support staff for that distributor or reseller.

Open Provisioning Interface Reference Guide
Copyright © Nortel Networks Limited 2006
Open Provisioning Interface
Topics in this chapter
•Open Provisioning Interface introduction
•Third party client development
•Authentication and authorization
•Provisioning Interface
•Deprecated methods and method fields
Open Provisioning Interface introduction
The Open Provisioning Interface (OPI) is used to remotely provision the
Multimedia Communication Server (MCS) system. OPI is based on the
Simple Object Access Protocol (SOAP) 1.1 and the emerging web
services standard. SOAP is a cross-platform, cross-language text
based protocol utilizing the benefits of XML (extensible Markup
Language). SOAP is commonly used as a tool in distributed
applications named web services. While SOAP in itself is not transport
dependent, OPI relies on HTTP (Hyper Text Transfer Protocol) as its
transport.
OPI gives the service provider the means to integrate MCS provisioning
with their own applications by allowing:
• Machine-to-machine interface for provisioning tasks
• Pass-through provisioning from existing provisioning systems
• Support for the Bulk Provisioning Tool
For information on the BPT, refer to the Bulk Provisioning Tool
Reference Guide.
Web Services Description Language (WSDL) 1.1
OPI supports the industry standard Web Services Description
Language (WSDL) 1.1. WSDL allows the service provider to provision
their MCS system with existing and custom applications. By supporting
the WSDL standard, service providers can rapidly develop client side
code with standard toolsets.

NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006
8
Copyright © Nortel Networks Limited 2006
WSDL is an XML language that contains information about the
interface, semantics and administration of a call to a web service. A
detail description of the WSDL standard is available online at the W3C
(World Wide Web Consortium) web site at the following URL:
www.w3.org/TR/wsdl
Third party client development
The goal of OPI is to allow customer third party applications to interface
with the MCS provisioning system. Once developed, the third party
application will pass an object to a generated stub. The stub will
translate the object into a SOAP message and pass it along to the
skeleton in the Provisioning Module. The skeleton translates the SOAP
message back to an object, and sends it to the Provisioning Module
data store processes. The data store then interfaces with the Oracle
Database. The translations happen in reverse from the Database to the
third party application.
Figure 1 Logical view of OPI interactions
The development of third party provisioning clients involves the
following steps:
• Get the WSDL
• Generate Stub using supported toolkit that supports complex type
• Implement interface to access stubs
• Access stubs from the third party application
Skeleton
Provisioning Module
Oracle
Database
3rd party
application
Stub
Data Store
WSDL
file

Open Provisioning Interface Reference Guide
9
Copyright © Nortel Networks Limited 2006
Get the WSDL
The WSDL file for MCS is stored on the server hosting the Provisioning
Module. You can view and download the WSDL using a web browser.
Note: By definition, all the OPI commands (methods) are listed in
the WSDL.
From a workstation
1Open a web browser
2To display the WSDL in the web browser, navigate to the
following URL
http://<provclientIP>/prov/services/OPI?WSDL
Where:
<provclientIP> is the IP address used by the Provisioning Client
3Download the WSDL file
Generate stubs
The stub is basically a translator. It takes the “user” object (whatever
type of object) from the interface and converts it to a SOAP message
and sends it to the Provisioning Module. Likewise, a SOAP message
from the Provisioning Module is translated back to the object. HTTP is
used as the transport for OPI. The Provisioning Module listens on port
80 for the SOAP over HTTP messages.
Figure 2 Interactions of the stub
Stubs are generated using a supported toolset. Currently, only the
Apache AXIS 1.0 (Apache extensible Interaction System
http://ws.apache.org/axis) toolset has been tested and approved. AXIS
is Java specific and creates a Java stub. The OPI WSDL may work with
other toolsets, but thorough testing has not yet been completed. Other
Stub
Provisioning
Module
Third Party
Application
object
SOAP over HTTP port 80

NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006
10
Copyright © Nortel Networks Limited 2006
toolsets may be supported in subsequent releases once testing has
been completed.
Refer to the chapter Building OPI clients for an example of generating
a Java stub.
Implement interface accessing stubs
An interface must be developed that will access the stubs. The interface
must support authentication on each OPI request.
If the credentials are not present, or fail validation, a SOAP fault will be
sent back indicating the failure and the action will not be performed.
Refer to Error codes and messages on page 29 for a complete list of
error messages.
Access stubs from the third-party application
When the interface accesses/invokes the stubs, the stub will generate
a SOAP message that will be sent to the Provisioning Module on port
80. The stub is basically a translator. It takes the “user” object (whatever
type of object) from the interface and converts it to a SOAP message
and sends it to the Provisioning Module. The skeleton on the server
with the Provisioning Module does the reverse. It takes the SOAP
message and translates it back to a “user” object (whatever type of
object) and sends it to the Provisioning Module’s Data Store that stores
it in the database.
Authentication and authorization
Authentication and authorization of OPI requests are briefly described
in the following sections:
•Authentication
•Authorization
For more information on this topic, please refer to the Provisioning
Client User Guide.
Authentication
Each OPI request is authenticated using HTTP basic authentication.
Each request is required to pass a username and password before
gaining access to the interface. Therefore, there is no login/logout
interface as the request is authenticated on each request. If the
credentials are not present, or fail validation, a SOAP fault will be sent
back indicating the failure and the action will not be performed. The
credentials are verified against any active administrator in the MCS