Summary of the content on the page No. 1
Nortel AS 5300
Nortel Application Server 5300
Application Programming
Interfaces Reference
Release: 1.0
Document Revision: 01.01
www.nortel.com
NN42040-110
.
Summary of the content on the page No. 2
Nortel AS 5300 Release: 1.0 Publication: NN42040-110 Document status: Standard Document release date: 11 June 2008 Copyright © 2008 Nortel Networks All Rights Reserved. Sourced in Canada LEGAL NOTICE While the information in this document is believed to be accurate and reliable, except as otherwise expressly agreed to in writing NORTEL PROVIDES THIS DOCUMENT "AS IS" WITHOUT WARRANTY OR CONDITION OF ANY KIND, EITHER EXPRESS OR IMPLIED. The information and/or products described in this document ar
Summary of the content on the page No. 3
3 . Contents New in this release 5 Other changes 5 Introduction 7 Audience 7 Related documents 7 Application Programming Interface fundamentals 9 Open Provisioning Interface fundamentals 9 Bulk Provisioning Tool fundamentals 10 Why use the Bulk Provisioning Tool 10 Bulk Provisioning Tool requirements 11 Using the Bulk Provisioning Tool 13 Install and launch the BPT 13 BPT main menu 13 BPT provisioning methods 16 BPT files and scripts 16 Files 16 Scripts 17 BPT conventions and examples 17 Method
Summary of the content on the page No. 4
4 Get the WSDL 33 Generate stubs 33 Implement interface accessing stubs 34 Access stubs from the third-party application 34 Starting the Bulk Provisioning Tool 35 Downloading the Bulk Provisioning Tool to a workstation 36 Launching the BPT on a workstation 36 Creating Open Provisioning Interface clients 39 Downloading the Axis toolkit 41 Retrieving the error codes 41 Configuring the class path 41 Downloading the WSDL file 42 Compiling the client stubs 42 Writing a client to perform some specific
Summary of the content on the page No. 5
5 . New in this release This chapter details what’s new in Nortel AS 5300 Application Programming Interface Reference, NN42040-110 for Nortel Application Server (AS) 5300 Release 1.0. This document is new for Nortel AS 5300 Release 1.0. Other changes Table 1 Revision history June 11, 2008 Standard 01.01. This document is new for Nortel AS 5300 Release 1.0. Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright
Summary of the content on the page No. 6
6 New in this release Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks .
Summary of the content on the page No. 7
7 . Introduction This document discusses the Nortel Application Server (AS) 5300 Application Programming Interface (API) available to third party clients for provisioning and administering the AS 5300 system from a remote workstation. Attention: Some services/features referred to in this document are not supported in AS 5300 Release 1.0. For more information about what services/features are supported in AS 5300 Release 1.0, see Nortel Application Server 5300 Overview, (NN42040-100). Navigation
Summary of the content on the page No. 8
8 Introduction Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks .
Summary of the content on the page No. 9
9 . Application Programming Interface fundamentals The Application Server (AS) 5300 provides Application Programming Interface (API) support for third-party client applications. This support consists of one main API and one tool: Open Provisioning Interface (OPI) Bulk Provisioning Tool (BPT) Open Provisioning Interface (OPI) is an API for third-party client applications, and is the foundation for the Bulk Provisioning Tool (BPT). The BPT facilitates the provisioning of the AS 5300 system wit
Summary of the content on the page No. 10
10 Application Programming Interface fundamentals standard, service providers rapidly develop client-side code with standard toolsets. A detailed description of the WSDL standard is available online at the World Wide Web Consortium (W3C) web site at www.w3.org/TR/wsdl. The goal of OPI is to allow customer-specific applications to interface with the AS provisioning system. Once developed, the application passes an object to a generated stub. The stub translates the object into a SOAP message and
Summary of the content on the page No. 11
Bulk Provisioning Tool fundamentals 11 database with the BPT and compared against active subscribers listed in the Internet Protocol Detail Record (IPDR) accounting records. As another example, a list of gateways can be extracted and imported into a downstream billing application. Bulk Provisioning Tool requirements The following table lists the requirements to run the BPT. Table 2 Bulk Provisioning Tool requirements Minimum PC or terminal Java 1.6 + JRE in the system classpath requirements For
Summary of the content on the page No. 12
12 Application Programming Interface fundamentals Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks .
Summary of the content on the page No. 13
13 . Using the Bulk Provisioning Tool This chapter contains all of the information you need to use the AS 5300 Bulk Provisioning Tool (BPT). Navigation "Install and launch the BPT" (page 13) "BPT main menu" (page 13) "BPT provisioning methods" (page 16) "BPT files and scripts" (page 16) "BPT conventions and examples" (page 17) "BPT Help option" (page 24) "BPT limitations" (page 25) Install and launch the BPT For procedures on downloading, installing, and launching the BPT, see "Sta
Summary of the content on the page No. 14
14 Using the Bulk Provisioning Tool Figure 1 BPT main menu An arrow following a menu item indicates a submenu. Choose the submenu by entering the menu item number at the prompt. For example, to access theDomainOperations submenu, type1 and press Enter. The BPT displays the Domain Operations submenu. Figure 2 Accessing the Domain Operations submenu Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 No
Summary of the content on the page No. 15
BPT main menu 15 Entering 0 (zero) returns you to the parent of a submenu. The provisioning method name appears inside the parentheses that follow the provisioning method description in the menu. The menu structure is only for usability. Any provisioning method can be entered at the prompt, regardless of the menu opened. For example, if you want to execute the getRootDomain provisioning method, you do not need to be in the Domain Operations menu. The following table lists the available BPT main
Summary of the content on the page No. 16
16 Using the Bulk Provisioning Tool Table 3 BPT main menu commands (cont’d.) Command Description execute Execute all the methods contained in the specified file. Each line in the file must be a method in the valid format. execute into writes the output to a second file instead of writing the output to the screen. Each line in the input file must be a method in the valid format. For information about BPT
Summary of the content on the page No. 17
BPT conventions and examples 17 Files must use a specific syntax for a BPT provisioning method to be invoked successfully on the Provisioning Server. You can view the required file syntax by using the BPT Help option ("BPT Help option" (page 24)). Scripts A script is basically a text file, where each line of the file consists of a single provisioning method. When executed, each provisioning method in the script is invoked sequentially and can reference a separate file for importing or exporting
Summary of the content on the page No. 18
18 Using the Bulk Provisioning Tool Optional syntax In BPT provisioning method syntax, the word [optional] indicates that what follows is optional and is not needed to invoke the method. Typically, the option is the writing of the returned values to a text file. You do not include [optional] when entering the syntax. For example, the following is the complete syntax for thegetSysRoles method: getSysRoles [optional]into To write the returned information to the screen, you use the synta
Summary of the content on the page No. 19
BPT conventions and examples 19 Square brackets Square brackets ([ ]) in the syntax indicate a string of variables, separated by commas. The square brackets must be included when shown in the BPT provisioning method syntax. For example, the following is the syntax for the addRole provisioning method: addRoleusing ([Nameofthe Provisioning Role,Description ofthe Role,[[TheProvisioning Right Type,The Read privilege,The writeprivilege,The deleteprivilege], .. ,[The Provisioning RightType,The Readpri
Summary of the content on the page No. 20
20 Using the Bulk Provisioning Tool Comma separated strings Provisioning method syntax can include a string of comma-separated variables. For example, the following is the syntax for the addAdmin provisioning method: addAdmin using ([TheAdminuser name,Password,Admin First Name,AdminLast Name,AdminStatus,Admin Email Address,Office PhoneNumber,HomePhone Number,CellPhone Number,Pager Number,Fax Number,VoicemailNumber,VPN Number,System definedrole,Time Zone,Locale,Provisioning Role,[The list ofDomai
