Page 3 - Finding the latest updates on the Nortel Web site
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...
Page 5 - How to get help; Getting help from the Nortel web site; download software, documentation, and product bulletins; Getting help over the phone from a Nortel Solutions Center
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 Su...
Page 6 - Getting help from a specialist by using an Express Routing Code
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...
Page 7 - Open Provisioning Interface; Topics in this chapter; Open Provisioning Interface introduction; Machine-to-machine interface for provisioning tasks
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 met...
Page 8 - Third party client development; Figure 1 Logical view of OPI interactions; Get the WSDL
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 (...
Page 9 - By definition, all the OPI commands (methods) are listed in; Generate stubs; Stub
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...
Page 10 - Refer to the chapter; Implement interface accessing stubs; Refer to; Access stubs from the third-party application; Authentication and authorization; Authentication
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...
Page 11 - Authorization
Open Provisioning Interface Reference Guide 11 Copyright © Nortel Networks Limited 2006 system. These administrators can be added/modified through both the Provisioning Client and the OPI itself. Utilizing, the standard HTTP basic authentication enables OPI to be interoperable with the common web se...
Page 12 - Provisioning Interface; Provisioning Client User; Success indication on remove methods
NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006 12 Copyright © Nortel Networks Limited 2006 OPI authorizes each request to verify the incoming credentials have the appropriate role to perform the given action. Provisioning Interface The following list is a summary of the provisioning object t...
Page 13 - Example; Deprecated methods and method fields; Table 1 Deprecated methods; addPooledResource
Open Provisioning Interface Reference Guide 13 Copyright © Nortel Networks Limited 2006 (domain and devices) that are not pre-existing in the database when the remove method is invoked. Example An invocation of "removeUser using ([email protected])" will return an error indication, "Invalid ...
Page 15 - The elements
Open Provisioning Interface Reference Guide 15 Copyright © Nortel Networks Limited 2006 addUser(see note) voiceMailvoiceMailServer chargeIdvpnblendedAliasesroutesipcmProperties addUsersToDomain(see note) voiceMailvoiceMailServer chargeIdvpnblendedAliasesroutesipcmProperties modifyUser(see note) voic...
Page 17 - Building OPI clients; Building OPI Stubs Clients; Requirements; working knowledge of Java application development; Downloading the AXIS toolkit
Open Provisioning Interface Reference Guide Copyright © Nortel Networks Limited 2006 Building OPI clients Topics in this chapter • Building OPI Stubs Clients • Writing a client to perform some specific OPI operations • Two examples • A special note on .NET authentication headers Building OPI Stubs C...
Page 18 - Procedure 1 Downloading the AXIS toolkit; Setting the Classpath; On the PC
NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006 18 Copyright © Nortel Networks Limited 2006 Procedure 1 Downloading the AXIS toolkit On the PC 1 In your web browser, navigate to the Axis toolkit page on the Apache web site. ws.apache.org/axis The 1.1 final version is recommended. 2 Download t...
Page 19 - Downloading the WSDL file; Compiling the stubs
Open Provisioning Interface Reference Guide 19 Copyright © Nortel Networks Limited 2006 Downloading the WSDL file Download the Web Server Description Language (WSDL) from the Provisioning Server. Procedure 3 Downloadin the WSDL file On the PC 1 In your web browser, navigate to the URL: http://<we...
Page 20 - OPISoapBindingStub.java; javac; classes
NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006 20 Copyright © Nortel Networks Limited 2006 This creates the client stubs under d:\opiclient\com\client\opi\service and the client data objects (beans) under d:\opiclient\com\nortelnetworks\ims\opi . The namespace mapping from OPI to com.client....
Page 21 - The Client classes are now ready to be used.; Writing a client to perform some specific OPI operations; Instantiate the OPIServiceLocator.
Open Provisioning Interface Reference Guide 21 Copyright © Nortel Networks Limited 2006 The Client classes are now ready to be used. Writing a client to perform some specific OPI operations Once the OPI stubs have been generated and compiled, the real OPI client can be constructed and OPI method cal...
Page 22 - An example is shown below. In the example, this class is placed under
NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006 22 Copyright © Nortel Networks Limited 2006 5 Make the OPI method call (for example, getUser) by invoking the same on the OPI instance from step 3. An example is shown below. In the example, this class is placed under D:\opiclient . The client c...
Page 23 - Two examples; Example - creating a user route to screen two numbers
Open Provisioning Interface Reference Guide 23 Copyright © Nortel Networks Limited 2006 Two examples The following two examples illustrate the creation of the two different routes that execute OPI calls: • Example - creating a user route to screen two numbers • Example - creating a route using simul...
Page 26 - Example - creating a route using simultaneous ringing
NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006 26 Copyright © Nortel Networks Limited 2006 Example - creating a route using simultaneous ringing The following example illustrates the creation of a route. It travels during "after-hours" and will first ring two given phone numbers simu...
Page 28 - A special note on .NET authentication headers
NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006 28 Copyright © Nortel Networks Limited 2006 A special note on .NET authentication headers The authentication headers for AXIS toolkit generated stubs are set on the client stub as described in the preceeding example. In that scenario, the client...
Page 29 - Error codes and messages; The error messages are classified into following categories:
Open Provisioning Interface Reference Guide Copyright © Nortel Networks Limited 2006 Error codes and messages This section lists the error codes and their associated messages that may be returned during a OPI provisioning session. The error messages are classified into following categories: • Data-A...
Page 30 - Error Code
NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006 30 Copyright © Nortel Networks Limited 2006 • IPCMMgrImpl error messages (016000) • UserTimeMgrImpl error messages (033000) Data-Access error messages (000000) Error Code Error Message 000000 The field(s): {0} must be unique 000001 Numeric value...
Page 31 - Constraint violated. Please consult documentation.
Open Provisioning Interface Reference Guide 31 Copyright © Nortel Networks Limited 2006 DirectoriesImpl error messages (001000) 000017 Data unavailable (Connection terminated). Please try again later. 000018 Constraint violated. Please consult documentation for these fields: {0} 000019 Constraint vi...
Page 32 - Adding banned user failed, banned username cannot be null.
NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006 32 Copyright © Nortel Networks Limited 2006 001008 Group information retrieval failed, Data access error please contact support for more information. 001009 Adding groups failed, no groups were found for adding for user {0}. 001010 Groups could ...
Page 33 - The addressbook was not found for the user{0}
Open Provisioning Interface Reference Guide 33 Copyright © Nortel Networks Limited 2006 AddressBookImpl error messages (002000) Error Code Error Message 002000 The addressbook was not found for the user{0} 002001 The address book information could not be retrieved for user:{0} : {1} 002002 The addre...
Page 35 - The Maximum Friends parameter could not be retrieved.
Open Provisioning Interface Reference Guide 35 Copyright © Nortel Networks Limited 2006 002032 Initialization failure of data for Addressbook: This process is recoverable later. 002033 Failed to initialize data access components. Unable to proceed further. 002034 Data initialization for Addressbook ...
Page 36 - The addresss book information could not be retrieved :
NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006 36 Copyright © Nortel Networks Limited 2006 002050 The addresss book information could not be retrieved : Data Access Error, Please contact logs for more information. 002051 Failed to send notification of modification of addressbook, please cont...
Page 37 - UserServicePkgImpl error messages (003000); Error retrieving global addressbook information {0}
Open Provisioning Interface Reference Guide 37 Copyright © Nortel Networks Limited 2006 UserServicePkgImpl error messages (003000) 002066 Error retrieving personal addressbook information for user {0} : {1} 002067 Error retrieving global addressbook information {0} 002068 Error retrieving addressboo...
Page 38 - Error: Please contact your next level of support.; Password cannot be null. Please provide a password.
NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006 38 Copyright © Nortel Networks Limited 2006 UserMgrImpl error messages (004000) 003012 Required field not found. Please provide the 'User Name' and 'Service Object'. 003013 Error: Please contact your next level of support. 003014 Error: Failed t...
Page 40 - Required field not found. Please provide the Domain name.
NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006 40 Copyright © Nortel Networks Limited 2006 DomainMgrImpl error messages (005000) RouteMgrImpl error messages (024000) 004029 Unable to add/modify user {0}. Voicemail ID specified without a valid Voicemail Server. 004030 Username cannot be the w...
Page 41 - Reject Reason information is required for this operation.
Open Provisioning Interface Reference Guide 41 Copyright © Nortel Networks Limited 2006 024005 Reject Reason information is required for this operation. 024006 Adding new routes information failed: {0} 024007 Route Names information is required. 024008 Route Name information is required for this ope...
Page 42 - AddressBookGroupCondMgr error messages (006000)
NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006 42 Copyright © Nortel Networks Limited 2006 AddressBookGroupCondMgr error messages (006000) GlobalAddrBookCondMgr error messages (014000) PersonalAddrBookCondMgr error messages (018000) Error Code Error Message 006000 Address Book Group names in...
Page 43 - PhoneNumberCondMgr error messages (019000); Banned Subscriber information is required.
Open Provisioning Interface Reference Guide 43 Copyright © Nortel Networks Limited 2006 PhoneNumberCondMgr error messages (019000) TimeBlockGroupCondMgr error messages (029000) BannedSubscriberMgrImpl error messages (008000) Error Code Error Message 019000 Telephone Number information is necessary f...
Page 44 - Banned subscribers to be deleted information is required.; Domain information is required.
NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006 44 Copyright © Nortel Networks Limited 2006 DomainCosMgrImpl error messages (011000) 008005 Retrieving banned subscriber information failed. There was a problem with the data store while trying to retrieve the information. 008006 Banned subscrib...
Page 45 - DomainProfileMgrImpl error messages (012000)
Open Provisioning Interface Reference Guide 45 Copyright © Nortel Networks Limited 2006 DomainProfileMgrImpl error messages (012000) TimeZoneMgrImpl error messages (030000) Error Code Error Message 012000 Removal of domain profile failed: {0} 012001 Domain information is required. 012002 Profile inf...
Page 46 - StatusReasonMgrImpl error messages (027000)
NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006 46 Copyright © Nortel Networks Limited 2006 StatusReasonMgrImpl error messages (027000) 030010 Failed to refresh caches: Unable to proceed further. 030011 Failed to initialize data access components: Unable to proceed further. Please contact you...
Page 47 - Could not retrieve domain information.; Service name needs to be specified.
Open Provisioning Interface Reference Guide 47 Copyright © Nortel Networks Limited 2006 ServiceMgrImpl error messages (025000) 027015 Could not retrieve domain information. 027016 Failed to refresh caches. Unable to proceed further. 027017 Failed to refresh Status Reason cache: Unable to proceed fur...
Page 48 - Data retrieval failed for domain services.
NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006 48 Copyright © Nortel Networks Limited 2006 025012 This service expects {0} number of entries.The entries to be made are: {1} 025013 Adding new domain services information failed. {0} 025014 Modifying domain services information failed. {0} 0250...
Page 49 - UserPropertiesServlet error messages (036000); Failed to refresh caches. Unable to proceed further.; No picture file uploaded.
Open Provisioning Interface Reference Guide 49 Copyright © Nortel Networks Limited 2006 UserPropertiesServlet error messages (036000) 025028 The parameter value for the {0} parm cannot be assigned at this stage.It can only be changed while customizing a service package for a user. Please try again w...
Page 50 - Adding reject reason failed: Reason cannot be null; Domain information cannot be null
NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006 50 Copyright © Nortel Networks Limited 2006 UserDataMgrImpl error messages (032000) VoicemailMgrImpl error messages (034000) Error Code Error Message 032001 Adding reject reason failed: Reason cannot be null 032002 Adding reject reason failed: {...
Page 51 - Retrieving device information failed.
Open Provisioning Interface Reference Guide 51 Copyright © Nortel Networks Limited 2006 DeviceMgrImpl error messages (010000) Error Code Error Message 010000 Retrieving device information failed. 010001 Cannot add/modify device as the device does not have a macaddress.Please provide a macaddress. 01...
Page 53 - Retrieving IPCM information failed.
Open Provisioning Interface Reference Guide 53 Copyright © Nortel Networks Limited 2006 UserTimeMgrImpl error messages (033000) 016004 Cannot assign user to IPCM {0} as it is not assigned to Domain {1} 016005 Cannot assign users to IPCM as there are no IPCMs assigned to this Domain {0} 016006 Retrie...
Page 55 - Retrieving Timeblock Group failed.
Open Provisioning Interface Reference Guide 55 Copyright © Nortel Networks Limited 2006 033031 Error retrieving time block information for Timeblock Group {0}. Root cause: {1} 033032 Retrieving Timeblock Group failed: {0} 033033 Error retrieving Timeblock Group Information for user {0}. 033034 Retri...
Page 58 - Multimedia Communication Server
Multimedia Communication Portfolio Multimedia Communication Server Open Provisioning Interface Copyright © Nortel Networks Limited 2006 All Rights Reserved Information is subject to change without notice. Nortel Networks reserves the right to make changes in design or components as progress in engi-...
Nortel ELO ES24
Manual
Nortel BSG12aw
Manual
Nortel 2332
Manual
Nortel M 901
Manual
Nortel NN43001-307
Manual
Nortel 60-12T
Manual
Nortel 5580
Manual
Nortel NN43113-106
Manual
Nortel 3456
Manual
Nortel 1100 Series
Manual
Nortel 10396EA
Manual
Nortel 3395A
Manual
Nortel IP 560
Manual
Nortel BSR252
Manual
Nortel 5399
Manual
Nortel P0941753 02
Manual