Download
Share
Print this page
Nortel NN42020-123 Manual
  1. Manuals
  2. Brands
  3. Nortel Manuals
  4. Server
  5. NN42020-123
  6. Manual
Nortel NN42020-123 Manual

Nortel NN42020-123 Manual

Nortel networks multimedia communication server specification sheet
Hide thumbs

Advertisement

Quick Links

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

Advertisement

loading
Need help?

Need help?

Do you have a question about the NN42020-123 and is the answer not in the manual?

Questions and answers

Related Manuals for Nortel NN42020-123

Summary of Contents for Nortel NN42020-123

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

  • Page 3: Finding The Latest Updates On The Nortel Web Site

    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...
  • Page 4 Copyright © Nortel Networks Limited 2006 NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006...

  • Page 5: How To Get Help

    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...
  • Page 6 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. NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006...
  • Page 7 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.

  • Page 8: Third Party Client Development

    • Generate Stub using supported toolkit that supports complex type • Implement interface to access stubs • Access stubs from the third party application NN42020-123 MCS 5100 3.5 Standard 4.0 Provisioning Module Skeleton Data Store WSDL file 4.0 January 2006...
  • Page 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.

  • Page 10: Authentication And Authorization

    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”...
  • Page 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 services toolsets. Typically, the toolsets allow for simple inclusion of username and password adhering to this standard.

  • Page 12: Provisioning Interface

    "remove" OPI Interface method indicates that the associated data no longer exists in the database. When possible, OPI Interface methods provide additional indication (in the form of an error message) regarding specific data elements NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006...
  • Page 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 (jimbob@nn.com)" will return an error indication, "Invalid Data: Domain Not found 'nn.com'", since the domain is not valid.
  • Page 14 Table 2 Deprecated method elements (Sheet 1 of 2) Affected method addDevice addDevices modifyDevice Note: The elements voiceMail, routes, and blendedAliases have been added as methods associated with user operations. NN42020-123 MCS 5100 3.5 Standard 4.0 Deprecated method element activeProxy defaultProxyHost defaultProxyPort ipcm rtpPort...
  • Page 15 Copyright © Nortel Networks Limited 2006 Table 2 Deprecated method elements (Sheet 2 of 2) Affected method addUser (see note) addUsersToDomain (see note) modifyUser (see note) Note: The elements voiceMail, routes, and blendedAliases have been added as methods associated with user operations.
  • Page 16 Copyright © Nortel Networks Limited 2006 NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006...
  • Page 17 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 Clients The following sections describes the requirements and steps tasks performed to generate Open Provisioning Interface (OPI) client stubs.
  • Page 18 Set the classpath for all the jar files found in the directory D:\axis-1_1\webapps\axis\WEB-INF\lib. set CLASSPATH= D:\axis-1_1\webapps\axis\WEB-INF \lib\axis.jar;D:\axis-1_1\webapps\axis\WEB-INF \lib\axis-ant.jar;D:\axis-1_1\webapps\axis\WEB -INF\lib\commons-discovery.jar;D:\axis-1_1\web apps\axis\WEB-INF\lib\commons-logging.jar;D:\a xis-1_1\webapps\axis\WEB-INF\lib\jaxrpc.jar;D: \axis-1_1\webapps\axis\WEB-INF\lib\log4j-1.2.8 .jar;D:\axis-1_1\webapps\axis\WEB-INF\lib\saaj .jar;D:\axis-1_1\webapps\axis\WEB-INF\lib\wsdl 4j.jar Create a folder for the generated client stubs. In this example, we use the folder D:\opiclient. NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006...
  • Page 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 In your web browser, navigate to the URL: http://<web-server-host-ip>/prov/services/OPI?wsdl where <web-server-host-ip>...
  • Page 20 In the example javac is used (shown in the following screenshot). A folder called classes was created in this example, and the generated class files put into it. NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006...

  • Page 21: Writing A Client To Perform Some Specific Opi Operations

    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 calls can be made. To accomplish this, the following steps must be performed in code.
  • Page 22 The client class can be compiled similarly to the compilation of the OPI Stubs and executed. During execution the OPI Stub classes and the AXIS toolkit jars must be present in the classpath. This occurrence appears in the following figure. NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006...

  • Page 23: Two Examples

    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 simultaneous ringing...
  • Page 24 Copyright © Nortel Networks Limited 2006 Example - creating a user route to screen two numbers The following example illustrates creation of a user route that screens on two numbers and forwards them straight to voice. NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006...
  • Page 25 Copyright © Nortel Networks Limited 2006 Open Provisioning Interface Reference Guide...
  • Page 26 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 simultaneously and then will roll over to voice mail. NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006...
  • Page 27 Copyright © Nortel Networks Limited 2006 Open Provisioning Interface Reference Guide...
  • Page 28 The sample code below shows how to set the authenication headers for a .NET client. The code must be added in the stub class so that it may hijack the request and add the headers to it. NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006...

  • Page 29: Error Codes And Messages

    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-Access error messages (000000) •...
  • Page 30 000012 000013 000014 000015 000016 NN42020-123 MCS 5100 3.5 Standard 4.0 Error Message The field(s): {0} must be unique Numeric value is too large. Please try with a smaller value. Entry can not be empty. Please provide a value. Entry can not be empty. Please provide a value.
  • Page 31 Copyright © Nortel Networks Limited 2006 Error Code 000017 000018 000019 000020 000021 000022 000023 DirectoriesImpl error messages (001000) Error Code 001000 001001 001002 001003 001004 001005 001006 001007 Open Provisioning Interface Reference Guide Error Message Data unavailable (Connection terminated). Please try again later.
  • Page 32 001017 001018 001019 001020 001021 001022 NN42020-123 MCS 5100 3.5 Standard 4.0 Error Message Group information retrieval failed, Data access error please contact support for more information. Adding groups failed, no groups were found for adding for user {0}. Groups could not be updated: Another group(s) with the same name(s) {0} exists.
  • Page 33 Copyright © Nortel Networks Limited 2006 AddressBookImpl error messages (002000) Error Code 002000 002001 002002 002003 002004 002005 002006 002007 002008 002009 002010 002011 002012 002013 Open Provisioning Interface Reference Guide Error Message The addressbook was not found for the user{0}...
  • Page 34 002027 002028 002029 002030 002031 NN42020-123 MCS 5100 3.5 Standard 4.0 Error Message {0} Cannot be added to list of friends, maximum number of friends allowed is {1} Cannot add entries: Maximum number of friends allowed could not be retrieved...
  • Page 35 Copyright © Nortel Networks Limited 2006 Error Code 002032 002033 002034 002035 002036 002037 002038 002039 002040 002041 002042 002043 002044 002045 002046 002047 002048 002049 Open Provisioning Interface Reference Guide Error Message Initialization failure of data for Addressbook: This process is recoverable later.
  • Page 36 002061 002062 002063 002064 002065 NN42020-123 MCS 5100 3.5 Standard 4.0 Error Message The addresss book information could not be retrieved : Data Access Error, Please contact logs for more information. Failed to send notification of modification of addressbook, please contact support for more information.
  • Page 37 Copyright © Nortel Networks Limited 2006 Error Code 002066 002067 002068 UserServicePkgImpl error messages (003000) Error Code 003000 003001 003003 003004 003005 003006 003007 003008 003009 003010 003011 Open Provisioning Interface Reference Guide Error Message Error retrieving personal addressbook information for user...
  • Page 38 004007 004008 004009 004010 004011 NN42020-123 MCS 5100 3.5 Standard 4.0 Error Message Required field not found. Please provide the 'User Name' and 'Service Object'. Error: Please contact your next level of support. Error: Failed to send Service Package change notification.
  • Page 39 Copyright © Nortel Networks Limited 2006 Error Code 004012 004013 004014 004015 004016 004017 004018 004019 004020 004021 004022 004023 004024 004025 004026 004027 004028 Open Provisioning Interface Reference Guide Error Message Cannot add/modify user without User Name. Please provide the required value.
  • Page 40 Error Code 024000 024001 024002 024003 024004 NN42020-123 MCS 5100 3.5 Standard 4.0 Error Message Unable to add/modify user {0}. Voicemail ID specified without a valid Voicemail Server. Username cannot be the word voicemail, please try another username Error Message Required field not found.
  • Page 41 Copyright © Nortel Networks Limited 2006 Error Code 024005 024006 024007 024008 024009 024010 024011 024012 024013 024014 024015 024016 024017 024018 024019 Open Provisioning Interface Reference Guide Error Message Reject Reason information is required for this operation. Adding new routes information failed: {0} Route Names information is required.
  • Page 42 PersonalAddrBookCondMgr error messages (018000) Error Code 018000 018001 018002 NN42020-123 MCS 5100 3.5 Standard 4.0 Error Message Address Book Group names information is necessary for an Address Book Group {0}. Retrieval of Address Book Group information failed. There was a problem with the data store while trying to retrieve the information.
  • Page 43 Copyright © Nortel Networks Limited 2006 PhoneNumberCondMgr error messages (019000) Error Code 019000 019001 019002 TimeBlockGroupCondMgr error messages (029000) Error Code 029000 029001 029002 BannedSubscriberMgrImpl error messages (008000) Error Code 008000 008001 008002 008003 008004 Open Provisioning Interface Reference Guide...
  • Page 44 011006 011007 011008 011009 011010 NN42020-123 MCS 5100 3.5 Standard 4.0 Error Message Retrieving banned subscriber information failed. There was a problem with the data store while trying to retrieve the information. Banned subscribers to be deleted information is required.
  • Page 45 Copyright © Nortel Networks Limited 2006 DomainProfileMgrImpl error messages (012000) Error Code 012000 012001 012002 012003 012004 012005 TimeZoneMgrImpl error messages (030000) Error Code 030000 030001 030002 030003 030004 030005 030006 030007 030008 030009 Open Provisioning Interface Reference Guide Error Message Removal of domain profile failed: {0} Domain information is required.
  • Page 46 027010 027011 027012 027013 027014 NN42020-123 MCS 5100 3.5 Standard 4.0 Error Message Failed to refresh caches: Unable to proceed further. Failed to initialize data access components: Unable to proceed further. Please contact your next level of support. Error Message...
  • Page 47 Copyright © Nortel Networks Limited 2006 Error Code 027015 027016 027017 027018 ServiceMgrImpl error messages (025000) Error Code 025000 025001 025002 025003 025004 025005 025006 025007 025008 025009 025011 Open Provisioning Interface Reference Guide Error Message Could not retrieve domain information.
  • Page 48 025022 025023 025024 025025 025026 025027 NN42020-123 MCS 5100 3.5 Standard 4.0 Error Message This service expects {0} number of entries.The entries to be made are: {1} Adding new domain services information failed. {0} Modifying domain services information failed. {0} Retrieving parm names information failed.
  • Page 49 Copyright © Nortel Networks Limited 2006 Error Code 025028 025029 025030 025031 025032 025033 025034 025035 UserPropertiesServlet error messages (036000) Error Code 036000 036001 036002 036003 036004 Open Provisioning Interface Reference Guide Error Message The parameter value for the {0} parm cannot be assigned at this stage.It can only be changed while customizing a...
  • Page 50 VoicemailMgrImpl error messages (034000) Error Code 034001 034002 034003 NN42020-123 MCS 5100 3.5 Standard 4.0 Error Message Adding reject reason failed: Reason cannot be null Adding reject reason failed: {0} UserData information retrieval failed: {0} Retrieve operation failed: Data access error, please contact...
  • Page 51 Copyright © Nortel Networks Limited 2006 DeviceMgrImpl error messages (010000) Error Code 010000 010001 010002 010003 010004 010005 010006 010007 010008 010009 010010 010011 010012 010013 Open Provisioning Interface Reference Guide Error Message Retrieving device information failed. Cannot add/modify device as the device does not have a macaddress.Please provide a macaddress.
  • Page 52 IPCMMgrImpl error messages (016000) Error Code 016000 016001 016002 016003 NN42020-123 MCS 5100 3.5 Standard 4.0 Error Message Invalid Data. Invalid device contrast {0}. The valid values are {1}. Invalid Data. Invalid device Vocoder {0} or Packet Time {1}. Invalid Data. Invalid device Time Format {0}. The valid values are {1}.
  • Page 53 Copyright © Nortel Networks Limited 2006 Error Code 016004 016005 016006 UserTimeMgrImpl error messages (033000) Error Code 033001 033002 033003 033004 033005 033006 033007 033008 033009 033010 033011 033012 Open Provisioning Interface Reference Guide Error Message Cannot assign user to IPCM {0} as it is not assigned to...
  • Page 54 033025 033026 033027 033028 033029 033030 NN42020-123 MCS 5100 3.5 Standard 4.0 Error Message Retrieving Timeblock Group failed. User name cannot be null. Retrieving Timeblock Group {0} for user {1} failed: {2} Retrieving Timeblock Groups for user {0} failed: {1} Retrieving Timeblock Groups failed.
  • Page 55 Copyright © Nortel Networks Limited 2006 Error Code 033031 033032 033033 033034 033035 033036 033037 033038 033039 033040 Open Provisioning Interface Reference Guide Error Message Error retrieving time block information for Timeblock Group {0}. Root cause: {1} Retrieving Timeblock Group failed: {0} Error retrieving Timeblock Group Information for user {0}.
  • Page 56 Copyright © Nortel Networks Limited 2006 NN42020-123 MCS 5100 3.5 Standard 4.0 4.0 January 2006...
  • Page 58 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- neering and manufacturing may warrant.