Nortel 5100 Series Release 2.3.3 Programming Reference Manual

PDF
Document
Nortel Multimedia Communication Server 5100
Application Programming
Interfaces Reference
NN42020-146
.
Document status: Standard
Document version: 01.07
Document date: 19 October 2007
Copyright &copy; 2007, Nortel Networks
All Rights Reserved.
Sourced in Canada
The information in this document is subject to change without notice. The statements, configurations, technical
data, and recommendations in this document are believed to be accurate and reliable, but are presented without
express or implied warranty. Users must take full responsibility for their applications of any products specified in this
document. The information in this document is proprietary to Nortel Networks.
Nortel, Nortel (Logo), and the Globemark are trademarks of Nortel Networks.
All other trademarks are the property of their respective owners.
3
Revision History
October 2007
Standard 01.07. This document is up-issued to support Multimedia
Communication Server 5100 Release 4.0. This document addresses CR
Q01619033.
July 2007
Standard 01.06. This document is up-issued to support Multimedia
Communication Server 5100 Release 4.0. This document addresses CR
Q01670119.
June 2007
Standard 01.05. This document is up-issued to support Multimedia
Communication Server 5100 Release 4.0. This document addresses CR
Q01676724.
March 2007
Standard 01.04. This document is up-issued to support Multimedia
Communication Server 5100 Release 4.0. This document addresses CRs
Q01564258 and Q01543719.
January 2007
Standard 01.01. This document is issued to support Multimedia
Communication Server 5100 Release 4.0. This document contains
information previously contained in the following legacy documents, now
retired:
•
Open Provisioning Interface (NN42020-123)
•
Bulk Provisioning Tool Reference Guide (NN42020-501)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
4 Revision History
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
5
Contents
New in this release
23
Feature changes 23
Subscriber OPI productization 23
SSL for web and SOAP interface 23
Password management 23
Language support 24
Multiple login restrictions 24
Other changes 24
How to get help
25
Finding the latest updates on the Nortel web site 25
Getting help from the Nortel web site 25
Getting help over the phone from a Nortel Solutions Center 25
Getting help from a specialist by using an Express Routing Code 26
Getting help through a Nortel distributor or reseller 26
Application Programming Interfaces overview
27
Audience 28
Related documents 28
Open Provisioning Interface overview
Open Provisioning Interface introduction 29
Web Services Description Language 1.1 29
Security 30
Import a CA Certificate into BPT 30
Third-party client development 31
Get the WSDL 31
Generate stubs 32
Implement interface accessing stubs 32
Access stubs from the third-party application 33
Authentication and authorization 33
Authentication 33
Authorization 33
Provisioning interface 34
Success indication on remove methods 35
Provisioning data visibility 35
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
29
6 Contents
PROV606 logs 36
Open Provisioning Interface clients
37
Open Provisioning Interface client stubs 37
Requirements 37
Download the Axis toolkit 37
Configure the classpath 38
Download the WSDL file 39
Compile the stubs 39
Write a client to perform some specific OPI operations 41
Two examples 44
Example: creating a user route to screen two numbers 44
Example: creating a route using simultaneous ringing 46
Recommended methods 48
.NET authentication headers 49
Bulk Provisioning Tool introduction
51
Overview 51
Why use the BPT? 52
BPT requirements 52
Limitations 52
Install and launch the BPT 53
Install the BPT on a workstation 53
Launch the BPT on a workstation 54
Launch the BPT on the provisioning server 55
BPT Main Menu 56
Commands 57
Files and scripts 58
Files 58
Scripts 59
BPT limitations 59
PROV606 logs 59
Mapping between Provisioning Client and BPT 59
Batch processing 59
Resource use 60
Provisioning data visibility 60
Bulk Provisioning Tool conventions and examples
Method and file syntax conventions 61
Optional syntax 62
Brackets 63
Angle brackets 63
Square brackets 63
Bar 64
Comma separated strings 64
Using fully qualified user names 65
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
61
Contents 7
Success indication on remove methods 65
Unknown error messages 65
Example - adding a new provisioning role 65
Mapping of the addRole method to the Provisioning Client window fields 65
Defining a new role to add 66
Performing the add method 68
Viewing the details of the new role 69
Deleting the role 71
New, changed, and deleted methods for OPI and BPT
73
Methods added in this release 73
Methods changed in this release 78
Methods removed from this release 78
Methods for OPI and BPT
Domain Operations 80
Domain Locale Operations 81
Status Reasons Operations 84
Domain Class of Service Operations 87
Domain Profile Operations 88
Banned Subscriber Operations 89
Converged Desktop Service Data 92
Add a root domain (addRootDomain) 97
Add a sub domain (addSubDomain) 98
Modify a domain (modifyDomain) 98
Remove a domain (removeDomain) 98
Get all root domain parameters (getAllRootDomainParms) 99
Get all sub domain parameters (getAllSubDomainParms) 99
Get all possible values for a domain parameter (getDomainParmValues) 99
Get all domains (getAllDomains) 99
Get a domain by name (getDomain) 100
Get all child domains of a domain (getChildrenDomains) 100
Get the parent domain of a domain (getParentDomain) 100
Get the root domain of a domain (getRootDomain) 101
Add a foreign domain (addForeignDomain) 101
Get a foreign domain (getForeignDomain) 102
Modify a foreign domain (modifyForeignDomain) 102
Remove a foreign domain (removeForeignDomain) 102
Get domains subset (getDomains) 103
Get all the root domain names (getAllRootDomainNames) 103
Get all the children domain names for a domain (getAllChildrenDomainNames) 103
Get the domain count in the system (getNumberOfDomains) 104
Device Operations 104
Add a device (addDevice) 104
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
79
8 Contents
Add devices (addDevices) 105
Modify a device (modifyDevice) 106
Remove a device (removeDevice) 106
Remove devices (removeDevices) 107
Get a device (getDevice) 107
Get a list of devices (getDevices) 107
Get devices by domain (getDevicesInDomain) 108
Get devices by User name (getCurrentDevices) 108
Get devices by MAC address (getDeviceByMacAddress) 108
get SubDomain For Device (getSubDomainForDevice) 109
IPCM Operations 109
Add a single IPCM (addIPCM) 109
Modify a single IPCM (modifyIPCM) 110
Get a single IPCM (getIPCM) 110
Remove a single IPCM (removeIPCM) 110
Get available capacity for an IPCM (getIPCMAvailCapacity) 111
Get assigned IPCMs for a domain (getAssignedIPCMs) 111
Get IPCM capacity for domain (getIPCMCapacityByDomain) 111
Remove Physical IPCM (deletePhysicalIPCM) 112
User Operations 112
User Data Operations 113
User Call Log Operations 117
User Times Operations 119
Route Operations 122
User Service Operations 135
User Meet Me Conferencing Operations 137
User Watcher Operations 140
User Converged Desktop Operations 141
User SIP Line Data Operations 144
Assistant Support Operations 149
User Search Operations 153
User Management Operations 157
User Voicemail Operations 167
User Direct to Gateway Operations 168
Logout all user contacts (sendUnRegister) 170
Get clientRedirectServlet login authorization (getClientRedirectLogin) 170
Admin Operations 170
Role Operations 170
Add an Admin (addAdmin) 173
Modify an Admin (modifyAdmin) 174
Remove an Admin (removeAdmin) 174
Get an Admin (getAdmin) 174
Get all Admins (getAllAdmins) 175
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Contents 9
Get all children Admins (getAllChildrenAdmins) 175
Change password (changeAdminPassword) 175
Reset password (resetAdminPassword) 176
Service Operations 176
Service Package Operations 177
Get all services assigned to a domain (getServicesByDomain) 181
Add services to a domain (addServicesToDomain) 181
Remove all services assigned to a domain (removeServicesByDomain) 181
Modify services assigned to a domain (modifyDomainServices) 182
Add services to multiple domains (addServicesToDomains) 182
Modify services of multiple domains (modifyServicesToDomains) 182
Modify the acceptable parameter values for a service (modifyServiceParm) 183
Set a parameter value as default value for a service (setServiceParmAsDefault) 183
Get all service names (getAllServiceNames) 183
Get parameter names for a service (getParmNamesByService) 184
Get parameter names for all services (getParmNamesForAllServices) 184
Get all acceptable values for given parameter (getServiceParmValues) 184
Get Parameter Display Name By Parameter Name (getParameterDisplayNameByParameterName) 185
Get Parameter Name By Parameter Display Name (getParameterNameByParameterDisplayName) 185
Get Service Display Name By Service Name (getServiceDisplayNameByServiceName) 185
Get Service Name By Service Display Name (getServiceNameByServiceDisplayName) 186
Pooled Entity 186
Services 186
Node Operations 200
Get all Node Type Names (getAllNodeTypeNames) 201
Add a node (addNode) 201
Add multiple nodes (addNodes) 202
Modify a node (modifyNode) 202
Remove a node (removeNode) 203
Get a Node (getNode) 203
Get all Nodes (getAllNodes) 204
Get node count (getNodeCount) 204
Add a single logical entity (addLogicalEntity) 204
Add multiple Logical Entitys (addLogicalEntitys) 205
Modify a Logical Entity (modifyLogicalEntity) 205
Remove a Logical Entity (removeLogicalEntity) 206
Get a Logical Entity (getLogicalEntity) 206
Get All Logical Entitys (getAllLogicalEntitys) 206
Get Logical Entity Count (getLogicalEntityCount) 207
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
10 Contents
Add node to root domains (assignDomainsToNode) 207
Assign node to sub domains (assignNodeToSubDomains) 207
Get root domains for a node (getNodeDomains) 208
Get sub domains for a node (getNodeSubDomains) 208
Get all node names for sub domains (getAllNodeNamesForDomain) 208
Get all Nodes for the root domain (getDomainNodes) 209
Get all Routing Algorithms (getAllRoutingAlgorithms) 209
Get all Routable Services (getAllRoutableServices) 209
Get all Routable Service Groups (getAllRoutableServiceGroups) 209
Pool Management 210
Get all Nodes By Routable Service (getAllNodesByRoutableService) 210
Get all Nodes By Routable Service Groups (getAllNodesByRoutableServiceGroup) 211
Get Assigned Domain Routing Node (getAssignedNodeByDomainByServiceGroup) 211
Get Assigned Location Routing Node (getAssignedNodeByLocationByServiceGroup) 211
Get Routing Locations By Service Group (getAllLocationsForNodeByServiceGroup) 212
Get All Locations By Service Group (getAllAvailableLocationsByServiceGroup) 212
Assign Node to Domain Routable Service (assignNodeToDomain) 213
Assign Node to Location Routable Service (assignNodeToLocation) 213
Assign Node to Location Routable Services (assignNodeToLocations) 213
Alias Routing 214
Add, Modify or Delete Alias Routing Information (modifyRoutableServiceAlias) 214
Get a list of Aliases Providing a Service (getRoutableServiceAliases) 215
Get Aliases Information for an Alias (getRoutableServiceAliasInfo) 215
Get Aliases All Information for an Alias Providing a Specified Service
(getAliasInfoByService) 215
Remove routable service alias (deleteRoutableServiceAlias) 216
Routable Service Parameter 216
Get Domain Service Parms for a Service (getDomainRoutingServiceParms) 217
Get Location Service Parms for a Service (getLocationRoutingServiceParms) 217
Get Alias Service Parms for a Service (getAliasServiceParms) 217
Set Domain Service Parms for a Service (setDomainRoutingServiceParms) 218
Set Location Service Parms for a Service (setLocationRoutingServiceParms) 218
Set Alias Service Parms for a Service (setAliasServiceParms) 219
Location Services 219
Add Location (addLocation) 220
Add Locations (addLocations) 220
Modify Location (modifyLocation) 221
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Contents 11
Remove Location (removeLocation) 221
Get Location (getLocation) 222
Get Locations for Domain (getLocations) 222
Get Locations by Parent (getLocationsByParent) 222
Add ERL (addErl) 223
Get ERL (getErl) 223
Modify ERL (modifyErl) 223
Remove ERL (removeErl) 224
List ANI for Domain (getAniList) 224
List of Valid ANI Registration Times in Seconds (getValidAniRegTimes) 225
List Deprecated Locations for Domain (getDeprecatedLocations) 225
Purge Deprecated Locations for Domain (purgeDeprecatedLocations) 225
Telephony Routes Operations 225
Number Qualifier Operations 226
Pre-Translation Operations 229
Add a new Telephony route (addTelephonyRoute) 232
Add multiple Telephony routes (addTelephonyRoutes) 233
Modify a telephony route (modifyTelephonyRoute) 234
Remove a telephony route (removeTelephonyRoute) 234
Remove multiple telephony routes (removeTelephonyRoutes) 235
Get telephony route types (getTelephonyRouteTypes) 235
Get a telephony route in a domain (getTelephonyRoutesByDomain) 235
Get a telephony route (getTelephonyRoute) 236
Add a route list (addRouteList) 236
Add multiple route list (addRouteLists) 236
Modify a route list (modifyRouteList) 237
Remove a route list (removeRouteList) 237
Remove multiple route lists (removeRouteLists) 238
Remove all telephony routes from a route list (removeAllTelephonyRoutesFromRouteList) 238
Remove a telephony route from route list (removeTelephonyRouteFromRouteList) 238
Get route lists by domain (getRouteListByDomain) 239
Get a route list by name (getRouteListByName) 239
Get a route list by Class Of Service (getRouteListByClassOfService) 239
Get route list actions (getRouteListActions) 240
Get translation destinations (getDestinations) 240
Add Direct To Gateway service prefix for a domain (assignDirectToGatewayPrefixData) 240
Get Direct To Gateway service prefix for a domain (getDirectToGWPrefixData) 241
Remove Direct To Gateway service prefix for a domain (removeDirectToGWPrefixData) 241
Voicemail Operations 241
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
12 Contents
Add a Voicemail Server Host (addVoicemailServerHost) 242
Modify a Voicemail Server Host (modifyVoicemailServerHost) 243
Remove a Voicemail Server Host (removeVoicemailServerHost) 243
Get Voicemail Servers Host (getVoicemailServerHost) 243
Get all Voicemail Server Hosts (getAllVoicemailServerHosts) 244
Get all Voicemail Server Host Types (getAllVoicemailServerHostTypes) 244
Add a SIP Voicemail Server (addSIPVoicemailServer) 244
Modify a SIP Voicemail Server (modifySIPVoicemailServer) 245
Remove a SIP Voicemail Server (removeSIPVoicemailServer) 246
Get all SIP Voicemail Servers (getAllSIPVoicemailServers) 246
Get all SIP Voicemail Servers for a domain (getAllSIPVoicemailServersByDomain) 246
Add a Trunk Voicemail Server (addTrunkVoicemailServer) 247
Modify a Trunk Voicemail Server (modifyTrunkVoicemailServer) 248
Remove a Trunk Voicemail Server (removeTrunkVoicemailServer) 249
Get all Trunk Voicemail Servers of a particular trunk type (getAllTrunkVoicemailServers) 249
Get Trunk Voicemail Servers by domain (getTrunkVoicemailServerByDomain) 249
Add a Line Voicemail Server (addLineVoicemailServer) 250
Modify a Line Voicemail Server (modifyLineVoicemailServer) 251
Remove a Line Voicemail Server (removeLineVoicemailServer) 253
Get Line Voicemail Servers for a domain (getLineVoicemailServerByDomain) 253
Get all Line Voicemail Server (getAllLineVoicemailServers) 253
Get all Voicemail Servers (getAllVoicemailServers) 253
Get all Voicemail Servers for a domain (getAllVoicemailServersByDomain) 254
Get all users for Voicemail Server (getUsersForVoicemailServer) 254
Addressbook Operations 254
Add address book entry for a User (addAddressBookEntry) 256
Add multiple address book entries for a User (addAddressBookEntries) 257
Modify an address book entry for a User (modifyAddressBookEntry) 258
Modify address book entries for a User (modifyAddressBookEntries) 258
Remove address book entries for a User (removeAddressBookEntries) 259
Remove an address book entry for a User (removeAddressBookEntry) 260
Remove address book for a User (removeUserAddressBook) 260
Remove address book for a User (removeAddressBook) 260
Get address book for a User (getAddressBook) 261
Remove a buddy from a users address book (removeBuddy) 261
Get buddies from the address book of a User (getBuddies) 261
Add a banned user (addBannedUser) 262
Add banned users (addBannedUsers) 262
Modify a banned user (modifyBannedUser) 262
Get the banned users for a User (getBannedUsers) 263
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Contents 13
Remove a banned user for a User (removeBannedUser) 263
Remove all banned users for a User (removeAllBannedUsers) 263
Get all address book groups for a User (getAddressBookGroups) 264
Add new group to the address book of a User (addAddressBookGroup) 264
Add new groups to the address book of a User (addAddressBookGroups) 264
Modify address book group names for a User (modifyAddressBookGroups) 265
Remove address book group of a User (removeAddressBookGroup) 265
Rename address book group of a User (renameAddressBookGroup) 265
Add users to the address book of a User (addUsersToAddressBook) 266
Get an addressbook entry (getAddressBookEntry) 266
Get address book for a User with photo urls (getAddressBookWithPhoto) 267
Get an addressbook entry with photo url (getFullAddressBookEntry) 267
Get address book for a User without photo urls (getLightWeightAddressBook) 267
Make this entry a buddy (makeBuddy) 268
Time Zone Operations 268
Get a Time Zone by ID (getTimeZoneByID) 268
Get a Time Zone by name (getTimeZoneByName) 269
Get all Time Zone IDs (getAllTimeZoneIds) 269
Get all Time Zones (getAllTimeZones) 269
Add a Time Zone (addTimeZone) 270
Remove a Time Zone (removeTimeZone) 270
Modify a Time Zone (modifyTimeZone) 270
Emergency Number Operations 271
Add Emergency Number (addEmergencyNumber) 271
Add Emergency Numbers (addEmergencyNumbers) 271
Get all Emergency Numbers (getAllEmergencyNumbers) 272
Get Emergency Aliases (getEmergencyAlias) 272
Remove all Emergency Numbers (removeAllEmergencyNumbers) 272
Remove an Emergency Number (removeEmergencyNumber) 272
Update Emergency Alias List (updateEmergencyAlias) 273
Media Portal Group and Route Operations 273
Add a new Media Portal Group (addMediaPortalGroup) 274
Add multiple Media Portal Groups (addMediaPortalGroups) 274
Modify a Media Portal Group (modifyMediaPortalGroup) 275
Remove a Media Portal Group (removeMediaPortalGroup) 276
Remove multiple Media Portal Groups (removeMediaPortalGroups) 276
Get a Media Portal Group data (getMediaPortalGroupByName) 276
Get all Media Portal Groups (getAllMediaPortalGroups) 277
Get available domains and locations not assigned to any MP Group
(getAvailableDomainLocations) 277
Get all existing configured Media Portal IP addresses (getAllMediaPortalResourceIPs) 277
Add a new Media Portal Route (addMpRoutabilityGroup) 277
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
14 Contents
Add multiple Media Portal Routes (addMpRoutabilityGroups) 278
Modify a Media Portal Route (modifyMpRoutabilityGroup) 278
Remove a Media Portal Route (removeMpRoutabilityGroup) 279
Remove multiple Media Portal Routes (removeMpRoutabilityGroups) 279
Get a Media Portal Route data (getMpRoutabilityGroupByName) 279
Get all Media Portal Routes (getAllMpRoutabilityGroups) 280
Get all domains and locations in the system (getAllDomainLocations) 280
Modify domain locations by Media Portal Group (modifyDomainLocationsByMPGroup) 280
Modify domain locations by Route Name (modifyDomainLocationsByRTGroup) 281
Resource Management 281
Add Domain Resource (setDomainResource) 281
Modify Domain Resource (modifyDomainResource) 282
Remove Domain Resource By Service (removeDomainResource) 282
Remove All Domain Resources (removeAllDomainResources) 282
Get Domain Resources (getDomainResourcesByDomain) 283
Get Domain Resource by Service Name (getDomainResourceByService) 283
LicenseKey Usage 283
Get License Key Usage for a Given Keycode (getLicenseKeyUsage) 284
LDAP Syncing 284
Add LDAP Schema (addLdapSchema) 285
Add LDAP Info (addLdapInfo) 285
Add LDAP Time Block (addLdapTimeBlock) 286
Add LDAP User Defaults (addLdapUserDefaults) 287
Add LDAPSyncFilterCriteria (setLDAPSyncFilterCriteria) 287
Remove LDAP Info for Domain (removeLdapInfo) 287
Remove LDAP Schema for Domain (removeLdapSchema) 288
Remove LDAP Time Block for Domain (removeLdapTimeBlock) 288
Remove LDAP User Defaults (removeLdapUserDefaults) 288
Remove LdapSyncFilterCriteria for Domain (removeLdapSyncFilterCriteria) 289
Get LDAP Schema for Domain Name (getLdapSchema) 289
Get LDAP Information for Domain Name (getLdapInfo) 289
Get LDAP Time block for Domain Name (getLdapTimeBlock) 290
Get LDAP User Defaults for Domain Name (getLdapUserDefaults) 290
Get Ldap Sync Filter Criteria for Domain Name (getLdapsyncFilterCriteria) 290
Start LDAP Synchronization Now (startLdapSyncNow) 291
Password Policy Operations 291
Get a Password Policy by name (getPasswordPolicy) 291
Get all Password Policies (getAllPasswordPolicies) 291
Add a Password Policy (addPasswordPolicy) 292
Modify a Password Policy (modifyPasswordPolicy) 292
Remove a Password Policy (removePasswordPolicy) 293
Parm Definition 293
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Contents 15
Get all Parm Types (getAllParmTypes) 293
Get all Parm Validation Types (future method) getAllParmValidationTypes 294
Get all Parm Owners (getAllParmOwners) 294
Get all Parm Definitions (getAllParmDefinitions) 294
Get all Parm Definitions By Owner (getParmDefinitionByOwner) 294
Get Parm Definition By Name (getParmDefinitionByName) 295
Get all Parm Definition Data (future method) (getParmDefinitionDataForParm) 295
Add Parm Definition (addParmDefinition) 295
Remove Parm Definition (removeParmDefinition) 296
Assign Parm Definition To Owner (assignParmDefinitionToOwner) 296
Remove Parm Definition To Owner (removeParmDefinitionFromOwner) 296
Release, Version Information 297
Get the current version of OPI (getCurrentOPIVersion) 297
Get the versions of OPI supported (getSupportedOPIVersions) 297
Get the name of the current release (getReleaseName) 297
Groups 297
Add a group (addGroup) 298
Add groups (addGroups) 298
Modify a group (modifyGroup) 299
Remove a group (removeGroup) 299
Remove groups (removeGroups) 299
Get a group (getGroup) 299
Get a group by user name (getGroupByUsername) 300
Get groups for domain (getAllGroupsForDomain) 300
Get users in a group (getUsersByGroup) 300
Assign users to a group (assignGroupsToUser) 300
Remove user from group (removeGroupByUser) 301
Get groups for a user (getUserGroups) 301
Get a group (getGroupsByUsersByType) 301
Get all group types (getAllGroupTypes) 301
Remove all groups for user (removeAllUserGroups) 301
SIP Lines 302
Get SIP Line Audit Data By EndpointId (getSIPLineAuditData) 302
Get SIP Line Audit Data By UserName (getSIPLineAuditDataByUserName) 302
Get SIP Line Audit Data By Domain (getSIPLineAuditDataByDomain) 303
Get SIP Line Audit Data By Domain And VMG (getSIPLineAuditDataByDomainByVMG) 303
Get Domains By VMG (getDomainsForVMG) 303
Get VMGs for Domain (getVMGForDomain) 303
Get Users By Registration State (getUsersByRegistrationState) 304
Get Users By Registration State And Client Type (getUsersByRegStateAndClientType) 304
Methods available only in OPI 304
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
16 Contents
getAliasesForExpressMsging 305
getAliasesForMsgRetrieval 305
getAssistantTypes 305
getChairAccessURL 305
getConfDialUpNumbers 305
getWebCollabURL 305
getUserPicture 306
addUserPicture 306
modifyUserPicture 306
Subscriber Open Provisioning Interface overview
307
Security 307
Building SOPI clients 307
Building SOPI stub clients 307
Writing a client 308
Client sample code 310
Subscriber Open Provisioning Interface methods
User personal information 314
authenticateUser 314
changePassword 315
getUserPersonalData 315
modifyUserPersonalData 315
User time block groups 315
addTimeBlockGroup 315
addTimeBlockGroups 316
getTimeBlockGroupByName 316
getTimeBlockGroupsByUser 316
modifyTimeBlockGroup 316
Personalized call settings 316
getNotesByUserName 317
getRejectReasonsByUserName 317
getSubjectsByUserName 317
getUserData 317
modifyUserData 317
modifyUserNotes 317
modifyUserReasons 317
modifyUserSubjects 318
removeAllCallSubjects 318
removeAllRejectReasons 318
removeAllUserNotes 318
removeUserData 318
Address book 318
addAddressBookEntries 319
addAddressBookEntry 319
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
313
Contents 17
getAddressBook 319
getAddressBookEntry 319
getAddressBookWithPhoto 320
getBuddies 320
getFullAddressBookEntry 320
getLightWeightAddressBook 320
makeBuddy 320
modifyAddressBookEntries 320
modifyAddressBookEntry 320
removeUserAddressBook 320
removeAddressBookEntries 321
removeAddressBookEntry 321
removeBuddy 321
Address book groups 321
addAddressBookGroup 321
addAddressBookGroups 322
addUsersToAddressBook 322
getAddressBookGroups 322
modifyAddressBookGroups 322
removeAddressBookGroup 322
renameAddressBookGroup 322
Global address book search 322
searchGABByFirstName 323
searchGABByFirstNameRange 323
searchGABByLastName 323
searchGABByLastNameRange 323
searchGABByName 324
searchGABByNameRange 324
searchGABByPhoneNumber 324
searchGABByPhoneNumberRange 324
searchGABByUserName 324
searchGABByUserNameRange 324
Call screening and routes 325
activateRoutes 325
addRoute 326
addRoutes 326
deactivateRoutes 326
getAllRouteParmNames 326
getRoute 326
getRouteNames 326
getRoutes 326
modifyRoute 326
removeAllRoutes 327
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
18 Contents
removeRoute 327
reorderRoutes 327
setActiveRoutes 327
Service preferences 327
getAllUserPreferences 328
getUserServicePackage 328
modifyAllUserPreferences 328
modifyUserPreferences 328
removeAllUserPreferences 328
Service information 328
getParameterDisplayNameByParameterName 329
getParameterNameByParameterDisplayName 329
getServiceDisplayNameByServiceName 329
getServiceNameByServiceDisplayName 329
Meet Me service data 329
addMeetMeConfUser 330
getMeetMeConfData 330
modifyMeetMeConfUser 330
getConfDialUpNumbers 330
getWebCollabURL 330
getChairAccessURL 330
removeMeetMeConfUser 331
Call logs 331
deleteCallLogs 331
getCallLogs 331
getIncomingCallLogs 331
getOutgoingCallLogs 331
Time zones 332
getAllTimeZones 332
Locales 332
getSystemLocalesList 332
Password policy 332
getPasswordPolicyDescription 332
E911 location list 333
getLocationList 333
User picture 333
addUserPicture 333
getUserPicture 333
modifyUserPicture 334
removeUserPicture 334
Banned user 334
addBannedUser 334
addBannedUsers 334
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Contents 19
getBannedUsers 334
modifyBannedUser 335
removeAllBannedUsers 335
removeBannedUser 335
Assistant user manager 335
getAssistedUsers 335
Click To Call 335
clickToCall 336
I200x 336
logoutUserFromDevice 336
SOPI version 336
getCurrentSOPIVersion 336
getSupportedSOPIVersions 337
Error codes and messages
Data access error codes and messages (000000) 341
Directories error codes and messages (001000) 343
Address book error codes and messages (002000) 344
User Service Package error codes and messages (003000) 348
User Operation error codes and messages (004000) 350
Resource Management Exceptions error codes and messages (004100)
Subscriber OPI error codes and messages (004150) 356
Prefix error codes and messages (004200) 356
Domain error codes and messages (005000) 357
Address Book Group error codes and messages (006000) 359
Domain bulletins error codes and messages (007000) 359
Banned subscriber error codes and messages (008000) 359
Resource Management error codes and messages (009000) 360
Device error codes and messages (010000) 362
Domain COS error codes and messages (011000) 363
Domain Profile error codes and messages (012000) 364
Domain locale error codes and messages (013000) 364
Global Address Book error codes and messages (014000) 365
Foreign domain error codes and messages (015000) 365
IPCM error codes and messages (016000) 367
Network call logs error codes and messages (017000) 368
Personal Address Book error codes and messages (018000) 368
Phone Number error codes and messages (019000) 368
Trunk and Gateway error codes and messages (020000) 369
Route error codes and messages (024000) 369
Service error codes and messages (025000) 372
Telephony Route error codes and messages (026000) 375
Status reason error codes and messages (027000) 378
Number qualifier error codes and messages (028000) 379
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
339
355
20 Contents
Time block group and Presence condition error codes and messages (029000) 380
Time zone error codes and messages (030000) 380
User Data error codes and messages (032000) 381
User time and Click to call error codes and messages (033000) 381
Voicemail error codes and messages (034000) 383
Reserved addresses error codes and messages (035000) 384
User properties error codes and messages (036000) 384
Music on Hold error codes and messages (037000) 384
Branding error codes and messages (038000) 385
Treatment error codes and messages (039000) 386
Assistant error codes and messages (040000) 387
User picture error codes and messages (041000) 389
Location error codes and messages (042000) 389
ErlInfo error codes and messages (043000) 391
Emergency alias error codes and messages (044000) 393
Emergency numbers error codes and messages (045000) 393
Meet Me Audio Conferencing related error codes and messages (046000) 394
Media Portal Group error codes and messages (046100) 395
Media Portal Routability Group error codes and messages (047000) 398
Auto ID error codes and messages (048000) 400
LDAP error codes and messages (049000) 400
Pooled Entity related error messages (050000) 402
Converged Desktop feature error messages (051000) 404
Voicemail server provisioning related error codes and messages (052000) 405
Password policy error codes and messages (055000) 408
SMS subscriber, SMPP configuration and interworking domain error codes and
messages (056000) 409
Voicemail error codes and messages (057000) 410
Global address book error codes and messages (058000) 410
Service node error codes and messages (059000) 410
Admin and role related error codes and messages (060000) 414
Parm Definition error codes and messages (061000) 415
Out of band REFER error codes and messages (062000) 416
Ringback error codes and messages (063000) 416
Domain CLI error codes and messages (064000) 417
Translation tool error codes and messages (070000) 418
Presence error codes and messages (072000) 418
Group error codes and messages (089000) 418
System-specific exceptions and authorization error codes and messages
(099000) 420
Generic exceptions (099999) 421
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Contents 21
Index
422
Figures
Figure 1
Figure 2
Figure 3
Figure 4
Figure 5
Figure 6
Figure 7
Figure 8
Figure 9
Figure 10
Figure 11
Figure 12
Figure 13
Figure 14
Figure 15
Figure 16
Figure 17
Figure 18
Figure 19
Figure 20
Logical view of OPI interactions 31
Interactions of the stub 32
Sample folder for client stubs 39
Compiling the client stubs sample 40
Client stub class files sample 41
Client code example 43
Client compilation example 44
Client code example - creating a user route 45
Client code example - creating a route 47
Authentication header sample 49
BPT download window 53
BPT Main menu 56
Accessing the Domain Operations submenu 57
Invoking a help command in the BPT 62
Add a New Role in the Provisioning Client 66
Provisioning Client field mapping to the addRole method 68
BPT showing a successful add 69
getRole method invoked in the BPT 69
GetRole results as viewed in the Provisioning Client 70
removeRole method invoked on the BPT 71
Procedures
Procedure
Procedure
Procedure
Procedure
Procedure
Procedure
Procedure
Procedure
Procedure
Procedure
Procedure
1
2
3
4
5
6
7
8
9
10
11
Importing a CA Certificate into BPT 30
Downloading the Axis toolkit 38
Configuring the classpath 38
Compiling the stubs 39
Writing a client to perform specific OPI operations 41
Downloading the BPT on a workstation 53
Launching the BPT on a workstation 54
Correcting Java errors in the Windows environment 54
Launching the BPT on the Provisioning server 55
Downloading the Axis toolkit 308
Building the client stub 308
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
22 Contents
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
23
New in this release
This chapter describes the changes to this book for Multimedia
Communication Server (MCS) 5100 Release 4.0.
Feature changes
The following new features affect this book:
•
&quot;Subscriber OPI productization&quot; (page 23)
•
&quot;SSL for web and SOAP interface&quot; (page 23)
•
&quot;Password management&quot; (page 23)
•
&quot;Language support&quot; (page 24)
•
&quot;Multiple login restrictions&quot; (page 24)
For information about all the MCS 5100 Release 4.0 features, see MCS
5100 New in this Release (NN42020-404).
Subscriber OPI productization
The Subscriber Open Provisioning Interface (SOPI) provides an Application
Programming Interface (API) for access to Personal Agent and Multimedia
PC Client operations. Third-party clients and customer web portals can be
built using SOPI, which is based on Java. Access to SOPI functionality is
controlled with service packages.
SSL for web and SOAP interface
This feature adds the ability to use Hypertext Transport Protocol (HTTP)
over Transport Layer Security (TLS), known as HTTPS. This feature
provides new command line options for the Bulk Provisioning Tool (BPT).
The Denial of Service (DoS) attack protection is applicable to the Open
Provisioning Interface (OPI) and Bulk Provisioning Tool.
Password management
This feature enables passwords to be exported using the BPT in encrypted
form. Passwords are imported using the BPT in clear text or encrypted text.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
24 New in this release
Language support
Support of various languages is added to the BPT.
Multiple login restrictions
This feature restricts the number of simultaneous logons for an MCS user.
In this document, the feature enables the configuration of the maximum
number of times a user can log on to Session Initiation Protocol (SIP)
endpoints through the BPT.
Other changes
Some methods have been removed for Release 4.0. Lists of new, changed,
and deleted OPI and BPT methods are contained in &quot;New, changed, and
deleted methods for OPI and BPT&quot; (page 73).
This document merges the following MCS 5100 Release 3.5 books:
•
Open Provisioning Interface (NN42020-123)
•
Bulk Provisioning Tool Reference Guide (NN42020-501)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
25
How to get help
This chapter explains how to get help for Nortel products and services.
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 for Multimedia
Communication System (MCS) 5100, go to www.nortel.com and navigate to
the Technical Documentation page for MCS 5100.
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 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
•
arrange 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 telephone from a Nortel Solutions Center.
In North America, call 1-800-4NORTEL (1-800-466-7835).
Outside North America, go to the following web site to obtain the telephone
number for your region:
www.nortel.com/callus
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
26 How to get help
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.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
27
Application Programming Interfaces
overview
MCS 5100 provides Application Programming Interface (API) support.
There are two main APIs and one tool:
•
Open Provisioning Interface (OPI)
•
Subscriber Open Provisioning Interface (SOPI)
•
Bulk Provisioning Tool (BPT)
OPI is the foundation for the BPT, as well as an API for third-party
applications. OPI is used to provision the MCS. SOPI provides an API for
third-party client applications that access Personal Agent and Multimedia
PC Client operations. The BPT can retrieve large amounts of data from the
MCS, and can configure the MCS with large amounts of data.
This document describes OPI, SOPI, and BPT in the following sections.
•
Open Provisioning Interface
— &quot;Open Provisioning Interface overview&quot; (page 29)
— &quot;Open Provisioning Interface clients&quot; (page 37)
•
Bulk Provisioning Tool
— &quot;Bulk Provisioning Tool introduction&quot; (page 51)
— &quot;Bulk Provisioning Tool conventions and examples&quot; (page 61)
•
OPI and BPT
— &quot;New, changed, and deleted methods for OPI and BPT&quot; (page 73)
— &quot;Methods for OPI and BPT&quot; (page 79)
•
Subscriber Open Provisioning Interface
— &quot;Subscriber Open Provisioning Interface overview&quot; (page 307)
— &quot;Subscriber Open Provisioning Interface methods&quot; (page 313)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
28 Application Programming Interfaces overview
•
&quot;Error codes and messages&quot; (page 339)
Audience
This document is for programmers and administrators. For the APIs,
this document assumes that the reader is familiar with object-oriented
programming.
Related documents
The following MCS documents contain related material:
•
Personal Agent User Guide (NN42020-100)
•
Provisioning Client User Guide (NN42020-105)
•
Session Manager Fundamentals (NN42020-107)
•
System Management Console User Guide (NN42020-110)
•
Provisioning Manager Fundamentals (NN42020-114)
•
Alarm and Log Reference (NN42020-703)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
29
Open Provisioning Interface overview
This chapter provides information about the following topics:
•
&quot;Open Provisioning Interface introduction&quot; (page 29)
•
&quot;Security&quot; (page 30)
•
&quot;Third-party client development&quot; (page 31)
•
&quot;Authentication and authorization&quot; (page 33)
•
&quot;Provisioning interface&quot; (page 34)
Open Provisioning Interface introduction
The Open Provisioning Interface (OPI) can 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 Extensible Markup Language (XML). SOAP is
commonly used as a tool in distributed applications named web services.
SOAP, in itself, is not transport dependent, so OPI relies on Hyper Text
Transfer Protocol (HTTP) as its transport protocol.
OPI enables service providers to integrate MCS provisioning with their own
applications by allowing:
•
Machine-to-machine interface for provisioning tasks
•
Pass-through provisioning from existing provisioning systems
Web Services Description Language 1.1
OPI supports the industry-standard Web Services Description Language
(WSDL) 1.1. WSDL enables service providers to provision their MCS system
with existing and custom applications. By supporting the WSDL standard,
service providers rapidly develop client-side code with standard toolsets.
WSDL is an XML language that contains information about the interface,
semantics and administration of a call to a web service. A detailed
description of the WSDL standard is available online at the W3C (World
Wide Web Consortium) web site at www.w3.org/TR/wsdl.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
30 Open Provisioning Interface overview
Security
OPI supports security through the use of:
•
opicert.cer—Secure Socket Layer (SSL) certificate file
•
opitruststore—key store file
The files are required when connecting to the Provisioning Server through
HTTP Secure (HTTPS). You use the following command line parameters:
-Djavax.net.ssl.trustStore=opitruststore
-Djavx.net.ssl.trustStorePassword=opitruststore
Import a CA Certificate into BPT
When you have a Certificate Authority (CA) Certificate, you need to import it
into the opitruststore using the following procedure.
Procedure 1
Importing a CA Certificate into BPT
Step
Action
On the PC
1
Copy the NorlockPKI.cer certificate file to the D:\temp folder.
2
Open a command prompt in the DOS window.
3
Enter the following command (on one line):
keytool -import -alias NorlockPKI -file
D:\temp\NorlockPKI.cer -keystore opitruststore
The tool presents details about the certificate and gives the
fingerprint of the certificate for validation.
The tool prompts Trust this certificate?
[no]:
4
If the certificate is correct, enter:
yes
OR
If the certificate is not correct, enter:
no
5
To verify that the certificate is now in the BPT trust store, enter the
following command (on one line)
keytool -list -v -keystore opitruststore
The tool displays the contents of the BPT trust store.
—End—
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Third-party client development 31
Third-party client development
OPI provides customer-specific applications with an interface into the MCS
provisioning system. Once developed, the customer application passes an
object to a generated stub. The stub translates the object into a SOAP
message and passes it to the skeleton in the Provisioning Manager. The
skeleton translates the SOAP message back to an object, and sends it
to the Provisioning Manager data access processes. The data access
processes communicate with the Oracle Database. The translations happen
in reverse from the Provisioning Manager to the customer application.
Figure 1
Logical view of OPI interactions
OPI connections are made using port 8443 (default) or port 8080.
The development of third-party provisioning clients involves the following
steps:
•
&quot;Get the WSDL&quot; (page 31)
•
&quot;Generate stubs&quot; (page 32)
•
&quot;Implement interface accessing stubs&quot; (page 32)
•
&quot;Access stubs from the third-party application&quot; (page 33)
Get the WSDL
The WSDL file for MCS is stored on the System Manager server. Retrieve
the file from the loads directory on the System Manager server, located at
/var/mcp/loads/&lt;loadname&gt;/clientAPI/wsdl/opi/opi.wsdl
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
32 Open Provisioning Interface overview
Generate stubs
The stub is basically a translator. It takes the &quot;user&quot; object (whatever
type of object) from the interface, converts it to a SOAP message and
sends it to the Provisioning Manager. Likewise, a SOAP message from the
Provisioning Manager is translated back to the object. HTTP and HTTPS
are used as the transport for OPI. The Provisioning Module listens on port
8080 for the SOAP over HTTP messages, and port 8443 for the SOAP
over HTTPS messages.
Figure 2
Interactions of the stub
You generate stubs using a supported toolset. Currently, only the 1.1
final version of the Apache Axis (Apache Extensible Interaction System
ws.apache.org/axis) toolsets are 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 been completed.
&quot;Open Provisioning Interface clients&quot; (page 37) contains an example of
generating a Java stub.
Implement interface accessing stubs
An interface must be developed to access the stubs. The interface must
support authentication on each OPI request.
If the credentials are not present or validation fails, a SOAP fault is sent
back to indicate the failure and the action is not performed.
&quot;Error codes and messages&quot; (page 339) contains a complete list of error
messages.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Authentication and authorization
33
Access stubs from the third-party application
When the interface accesses or invokes the stubs, the stub generates a
SOAP message that is sent to the Provisioning Manager on port 8443 or
8080. The stub is basically a translator. It takes the &quot;user&quot; object (whatever
type of object) from the interface, converts it to a SOAP message, and
sends it to the Provisioning Manager. The skeleton on the server with
the Provisioning Manager does the reverse, taking the SOAP message,
translating it back to a user object (whatever type of object), and sending it
to the Provisioning Manager data store, which stores it in the database.
Authentication and authorization
The following sections briefly describe authentication and authorization
of OPI requests:
•
&quot;Authentication&quot; (page 33)
•
&quot;Authorization&quot; (page 33)
For more information about authentication and authorization, see
Provisioning Client User Guide (NN42020-105).
Authentication
Each OPI request authenticates using HTTP and HTTPS basic
authentication. Each request must pass in a username and password
before gaining access to the interface. Therefore, there is no log on or log
off interface. If the credentials are not present, or fail validation, a SOAP
fault is sent back, indicating the failure, and the action is not performed. The
credentials are verified against any active administrator in the MCS system.
These administrators are added or modified through the Provisioning Client
and the OPI.
The standard HTTP and HTTPS 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. Within the MCS system, the authentication is performed
locally (in memory) to alleviate the recurring authentication. In addition,
the authentication and authorization are kept in synchronization with the
Provisioning Client, so changes to the administrator profile from either the
Provisioning Client or the OPI are immediately effective.
Authorization
Authentication is the first step in processing the incoming request. After
the request is authenticated, the administrator must clear authorization
before performing the action. The authorization includes both domain-level
authorization and provisioning-level authorization. If either authorization
fails validation, a SOAP fault is sent back, indicating the reason for failure,
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
34 Open Provisioning Interface overview
and the action is not performed. For more information on administration
privileges and domain access rules, see Provisioning Client User Guide
(NN42020-105).
Domain-level authorization
Each administrator is assigned one or more domains for access and
control, which can be overridden by the All domain access in role
creation. For instance, the MCS system might consist of three separate
domains, Widget.com, Gadget.com, and Sprocket.com. An administrator,
WidgetAdmin, can be created with only Widget.com in the list of
provisionable domains. This limits WidgetAdmin to provisioning activities
inside the Widget.com domain only, and does not permit access to the other
domains. Therefore, if a request from WidgetAdmin comes in to modify
a user outside of the Widget.com domain, it is rejected because it failed
authorization. In addition, attempts to list domain information can only
return Widget.com information.
Provisioning-level authorization
The Provisioning Manager of the MCS system is broken into various
major categories (Domains, Users, Telephony Routes, and so on). The
provisioning system enables the creation of various administrator roles
across these categories. Upon creation, the administrator is assigned
to a particular role. This enables the service provider to create various
administrator roles to suit specific needs. In each category, the role can
have any combination of the following rights: Read, Write, and Delete. For
example, a user admin role can be created which gives the ability to read
domain information, and to read, modify, and delete user information. The
administrators given this role cannot manipulate the telephony routes, or
other areas of the MCS system. OPI authorizes each request to verify that
the incoming credentials have the appropriate role to perform the given
action.
Provisioning interface
The following list is a summary of the provisioning object types contained
within the WSDL. Detailed information on the provisioning objects and their
types can be found in the WSDL file.
•
simple types:
— Boolean
— Byte
— Double
— Float
— Integer
— Long
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Provisioning interface 35
— Short
— String
•
complex types (for example, Domain, User, Route)
•
Type[] = Array of Type (for example, String[] = Array of Strings)
•
method summaries consist of method description with return type
•
return type of void implies no response
This document does not cover the actions that can be performed through
the OPI interface. It is not intended to cover in detail the effect these
changes make to the MCS system. This document is intended to give an
overview of the OPI. The Provisioning Client User Guide (NN42020-105)
describes the provisionable entities and their role in the MCS system.
Success indication on remove methods
Some OPI methods that provide the ability to remove data return an
indication of success even though the data did not preexist in the database.
This mirrors the functionality of the database. Basically, a success indication
for a remove OPI method indicates that the associated data no longer exists
in the database.
When possible, OPI methods provide additional indication (in the form of an
error message) about specific data elements (domain and devices) that are
not preexisting in the database when the remove method is invoked.
Example
If the domain nn.com does not exist, an invocation of
removeUser using ([email protected])
returns the error indication
Invalid Data: Domain Not found ’nn.com’
because the domain is not valid.
If the domain is valid and the user is not preexisting, then a success
indication is returned because the user is not provisioned on the system.
Provisioning data visibility
Provisioning data added using the OPI is immediately available to other
provisioning clients connected to the same instance of the Provisioning
Manager. However, it can take up to 5 minutes before the same data is
visible to clients connected to a second instance of a Provisioning Manager
running in the system.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
36 Open Provisioning Interface overview
PROV606 logs
PROV606 logs capture all provisioning activity performed using the OPI,
including the administrator performing the task. The logs generated by OPI
clients display the request type OPI. The logs are viewed in the System
Management Console log browser and are described in the Provisioning
Module Fundamentals (NN42020-111) document.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
37
Open Provisioning Interface clients
This chapter provides information about the following topics:
•
&quot;Open Provisioning Interface client stubs&quot; (page 37)
•
&quot;Write a client to perform some specific OPI operations&quot; (page 41)
•
&quot;Two examples&quot; (page 44)
•
&quot;Recommended methods&quot; (page 48)
•
&quot;.NET authentication headers&quot; (page 49)
Open Provisioning Interface client stubs
The following sections describe the requirements and steps performed to
generate Open Provisioning Interface (OPI) client programs (called client
stubs). The process uses the Axis toolkit.
•
&quot;Requirements&quot; (page 37)
•
&quot;Download the Axis toolkit&quot; (page 37)
•
&quot;Configure the classpath&quot; (page 38)
•
&quot;Download the WSDL file&quot; (page 39)
•
&quot;Compile the stubs&quot; (page 39)
Requirements
The following are required to perform the steps in this examples:
•
working knowledge of Java application development
•
comfort with DOS commands
•
JDK (Java Developer Kit) 1.4.2.x.x
•
Java executable available in the system path
•
Axis toolkit version 1.1 final
Download the Axis toolkit
The steps in this chapter use the Axis toolkit 1.1 final version. The Axis
toolkit is a free download from the Apache Web site.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
38 Open Provisioning Interface clients
Procedure 2
Downloading the Axis toolkit
Step
Action
On the PC
1
In your web browser, navigate to the Axis toolkit page on the Apache
web site at ws.apache.org.axis.
Nortel recommends the 1.1 final version.
2
Download the 1.1 final version file, axis-1_1.zip, to your PC.
3
Unzip the files to a drive on the PC.
In this document, the Axis files are extracted to the folder
D:\axis-1_1.
—End—
Configure the classpath
Configure the classpath for specific jar files in the Axis toolkit.
Procedure 3
Configuring the classpath
Step
Action
On the PC
1
Open a command prompt in the DOS window.
2
Configure the classpath for all the jar files found in the directory
D:\axis-1_1\webapps\axis\WEB-INF\lib.
For example:
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-d
iscovery.jar;D:\axis-1_1\webapps\axis\WEB-INF\lib\commo
ns-logging.jar;D:\axis-1_1\webapps\axis\WEB-INF\lib\jax
rpc.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\wsdl4j.jar
3
Create a folder for the generated client stubs.
In this example, the folder D:\opiclient is used.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Open Provisioning Interface client stubs
39
Figure 3
Sample folder for client stubs
—End—
Download the WSDL file
The WSDL file for MCS is stored in the System Manager server. Retrieve
the file from the loads directory on the System Manager server at
/var/mcp/loads/&lt;loadname&gt;/clientAPI/wsdl/opi/opi.wsdl.
Compile the stubs
Use the following procedure to compile the stubs.
Procedure 4
Compiling the stubs
Step
Action
On the PC
1
Open a command prompt and navigate to the directory containing
the downloaded WSDL file.
For example: D:\opiclient
2
Run the WSDL2JAVA tool on the WSDL file.
For example:
java org.apache.axis.wsdl.WSDL2Java -O -1 -d Session
-Nurn:OPI com.client.opi.service opi.wsdl
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
40 Open Provisioning Interface clients
This creates the client stubs under
D:\opiclient\com\client\opi\service
The stubs contain all the methods that are exposed by the OPI
service, and the same methods that can be seen in the WSDL. For a
list of methods, see&quot;Methods for OPI and BPT&quot; (page 79).
The arguments provided to these methods are generated in the
directory D:\opiclient\com\nortelnetworks\ims\opi
All the methods are Java Bean objects and are used to configure
and retrieve data for different functionality. Each element in the data
object is of a type specified in the OPI.
The name space mapping from OPI to com.client.opi.service can
be changed to another mapping.
Figure 4
Compiling the client stubs sample
Note: The OPISoapBindingStub.java, generated under
com\client\opi\service, has a large static block that will
not compile. You must edit this file by hand to split the large static
block into two or three smaller ones so that it compiles. This
is a known issue due to the fact that the code is automatically
generated.
3
Compile the files that are generated in the previous step using either
the command line command javac or an Interactive Development
Environment (IDE) such as netbeans or eclipse, and put them into
a separate folder.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Write a client to perform some specific OPI operations
41
In the example (shown in the following screen capture), javac is
used. A folder named classes is created in this example, and the
generated class files are put into it.
Figure 5
Client stub class files sample
The Client classes are now ready for use.
—End—
Write a client to perform some specific OPI operations
After the OPI stubs are generated and compiled, the real OPI client is
constructed and OPI method calls are made. To accomplish this, you must
perform the following steps in the code.
Procedure 5
Writing a client to perform specific OPI operations
Step
Action
1
Instantiate the OPIServiceLocator.
2
Instantiate a URL object that points to the Provisioning Server
location and the OPI service running on it.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
42 Open Provisioning Interface clients
3
Invoke the getOPI call on the OPIServiceLocator instance with the
URL created in step 2. This action results in an instance of the OPI
object, which is used to make OPI calls.
4
Configure the authentication information on the OPI object from
step 3. Perform this action by down-casting the OPI object as an
org.apache.axis.client.Stub object.
5
Configure the OPI Client Version number in a SOAP header,
using the setHeader method. This number is used by the server
to determine the client version and to return data that the client
understands.
6
Make the OPI method call (for example, getUser) by invoking the
method on the OPI instance from step 3.
The arguments for this method are the data objects generated during
the stub generation process. For example, for the addUser method,
pass in the domainName and the User object (populated with the
user data). For the details of the addUser method, see &quot;Methods for
OPI and BPT&quot; (page 79).
—End—
An example is shown below. In the example, this class is placed under
D:\opiclient.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Write a client to perform some specific OPI operations
43
Figure 6
Client code example
The client class is compiled in the same manner as 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, as shown in the following
figure.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
44 Open Provisioning Interface clients
Figure 7
Client compilation example
Two examples
The following two examples illustrate the creation of the different routes
that execute OPI calls:
•
&quot;Example: creating a user route to screen two numbers&quot; (page 44)
•
&quot;Example: creating a route using simultaneous ringing&quot; (page 46)
Example: creating a user route to screen two numbers
The following example illustrates the creation of a user route that screens
on two numbers and forwards them straight to voice.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Two examples 45
Figure 8
Client code example - creating a user route
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
46 Open Provisioning Interface clients
Example: creating a route using simultaneous ringing
The following example illustrates the creation of a route. It travels during
after-hours, rings two given phone numbers simultaneously, and then rolls
over to voice mail.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Two examples 47
Figure 9
Client code example - creating a route
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
48 Open Provisioning Interface clients
Recommended methods
The getDomains method is used to get a subset of domains present in
the system.
The parameters to getDomains are:
•
start index
•
stop index
The method returns the domain array, or an empty array if no domains are
found. ProvisionException provides for error scenarios (throws).
The getDomains method is accompanied by three helper methods:
•
public String[] getAllRootDomainNames() throws
ProvisionException;
Use this method to get all the root domain names in the system. It
returns a String[] array of root domain names in alphabetical order.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
.NET authentication headers
•
49
public String[] getAllChildrenDomainNames(String
rootDomain) throws ProvisionException;
Use this method to get all the child domain names for a given root
domain in the system. It returns a String[] array of all child domain
names.
•
public int getNumberOfDomains() throws ProvisionException;
Use this method to get the number of domains in the system. It returns
an integer.
.NET authentication headers
The authentication headers for Axis toolkit-generated stubs are configured
in the client stub, as described in the preceding example. In that scenario,
the client stub is cast down to an org.apache.axis.client.Stub object. For a
.NET client, this must be done differently. The MCS OPI currently supports
HTTP and HTTPS authentication and the authentication headers must be
configured to Base64-encoded authentication on the client side.
Figure 10 &quot;Authentication header sample&quot; (page 49) shows how to configure
the authentication headers for a .NET client. The code must be added in the
stub class so that it can hijack the request and add the headers to it.
Figure 10
Authentication header sample
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
50 Open Provisioning Interface clients
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
51
Bulk Provisioning Tool introduction
This chapter provides information about the following topics:
•
&quot;Overview&quot; (page 51)
•
&quot;Why use the BPT?&quot; (page 52)
•
&quot;Install and launch the BPT&quot; (page 53)
•
&quot;BPT Main Menu&quot; (page 56)
•
&quot;Commands&quot; (page 57)
•
&quot;Files and scripts&quot; (page 58)
•
&quot;BPT limitations&quot; (page 59)
Overview
The Bulk Provisioning Tool (BPT) application enables administrators to
provision Multimedia Communication Server (MCS) services from outside
the Provisioning Client. It enables both bulk transactions and individual
requests. The BPT application is built on the Open Provisioning Interface
(OPI), and accesses all the commands available through the OPI.
Communications between the BPT and the Provisioning server use the OPI.
OPI itself is the Simple Object Access Protocol (SOAP) over HTTP.
ATTENTION
Do not use BPT for large transactions during regular business hours.
In deployments where the BPT uses the same network (LAN) as the LAN
processing sessions, large BPT transactions may impact network performance.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
52 Bulk Provisioning Tool introduction
Why use the BPT?
The BPT is extremely useful for provisioning systems with numerous
subscribers. Some of the scenarios where administrators benefit from using
the BPT are:
•
adding a large number of subscribers. The BPT provides bulk imports
of provisioning data from text files. The files can be generated from
other applications.
•
exporting provisioning data. The BPT provides bulk exports of
provisioning data, writing it to files. The files can then be used with
other applications.
•
modifying a large number of subscribers. The BPT enables bulk
modifications, such as modifying subscriber service packages when
new features are added.
•
extracting information from the database for reporting purposes. For
example, a list of provisioned subscribers can be extracted from the
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.
BPT requirements
The following table lists the requirements to run the BPT.
Table 1
Bulk Provisioning Tool requirements
Minimum PC or
terminal requirements
Java 1.4 + JRE in the system classpath
For telnet remote
access
Compatible (tested) telnet terminals:
•
Windows Telnet client
•
Putty
•
Hummingbird Telnet
•
KevTerm
Non-compatible telnet terminals:
•
Log on requirement
CRT
To begin a BPT session, the administrator needs to be,
at minimum, a provisioned general administrator
Limitations
The Bulk Provisioning Tool only works with Java version 1.4.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Install and launch the BPT
53
Install and launch the BPT
The BPT is either downloaded from the Provisioning Client to run remotely
on a workstation, or run locally on the Provisioning server. The use of the
BPT and available methods is the same for both access methods.
Nortel recommends that administrators use the BPT on a workstation,
allowing easier use of files and scripts, without affecting the performance
of the server hosting the Provisioning Manager.
Install the BPT on a workstation
Use this procedure to download the BPT to a workstation.
Procedure 6
Downloading the BPT on a workstation
Step
Action
1
Log on to the Provisioning Client.
2
Open the System folder.
3
Click on Tools.
The BPT download window appears.
Figure 11
BPT download window
4
Follow the instructions on the download window to install the
required files onto the local workstation.
—End—
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
54 Bulk Provisioning Tool introduction
Launch the BPT on a workstation
Use this procedure to launch the BPT on a workstation.
Procedure 7
Launching the BPT on a workstation
Step
Action
1
Execute the bpt.bat (Windows) or bpt.sh (Solaris) script.
The BPT application launches.
2
Enter your administrator username and password.
The &quot;BPT Main Menu&quot; (page 56) appears.
—End—
Troubleshooting BPT execution in Windows
If you have trouble launching the BPT in the Windows environment, the
following procedure helps you find and correct a common problem with
the version of Java.
Procedure 8
Correcting Java errors in the Windows environment
Step
Action
1
Select Start &gt; Run.
The Run window appears.
2
In the Open box, type cmd and click OK.
A command window displays.
3
Enter the following command:
java - version
The operating system queries the default version of Java on your
computer.
4
If the version number starts with 1.5, do the following steps.
a. Navigate to C:\Program Files\Java.
b. Open the folder that contains 1.4 in the name.
For example, the folder can be j2re1.4.2_05.
c. Open the bin folder and verify that the file java.exe is in this
folder.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Install and launch the BPT
55
For example, this file can reside in C:\Program
Files\Java\j2re1.4.2_05\bin.
d. Open the folder that you installed the BPT into during Procedure
6 &quot;Downloading the BPT on a workstation&quot; (page 53).
e. Edit the bpt.bat file with Notepad.
Notepad opens and displays the file contents. The first word you
see in the file is java.
f.
Before the word java, enter the path to your Java 1.4 exe file.
For example, the first line might start C:\Program
Files\Java\j2re1.4.2_05\bin\java. Any folder in
the path to the java.exe file that contains spaces must be
enclosed in quotation marks. For example, C:\&quot;Program
Files&quot;\Java\j2re1.4.2_05\bin\java.
g. Save and close the file.
5
Close the command window by clicking on the X in the top right
corner.
—End—
Launch the BPT on the provisioning server
Use this procedure to run the BPT on the server hosting the Provisioning
Manager.
ATTENTION
Use the BPT on the server for small transactions only.
Session and network performance may be affected when large provisioning files
are processed using the BPT residing on the server. For more information, see
&quot;Resource use&quot; (page 60).
Administrators require server logon access to use the BPT in this manner.
Procedure 9
Launching the BPT on the Provisioning server
Step
Action
1
Using SSH, connect to the provisioning server.
2
Log on as nortel.
3
Navigate to the directory /var/mcp/run/MCP_9.1/PROV&lt;NE_instance&gt;/wars/prov/downloads
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
56 Bulk Provisioning Tool introduction
4
Execute the script bpt.sh
The BPT launches.
5
Enter your administrator username and password.
The &quot;BPT Main Menu&quot; (page 56) appears.
—End—
BPT Main Menu
After successfully logging on, the BPT Main Menu appears. The Main Menu
lists the categories for the available provisioning operations.
Note: This document, and the BPT help, only describe the syntax of the
methods and file content. For details of the categories and parameters,
and their role in system provisioning, see Provisioning Client User Guide
(NN42020-105).
Figure 12
BPT Main menu
The arrow following a menu item indicates a submenu. Choose the
submenu by entering the menu item number at the prompt.
For example, to access the Domain Operations submenu, type 1 and press
Enter. The BPT displays the Domain Operations menu selections.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Commands 57
Figure 13
Accessing the Domain Operations submenu
Entering 0 (zero) returns you to the parent of a submenu.
The method name is displayed inside the parentheses following the method
description in the menu. The menu structure is only for usability. Any
method command can be entered at the prompt, regardless of the menu
opened. For example, if you want to execute the getRootDomain method,
you do not need to be in the Domain Operations menu.
Commands
The following table lists the available BPT commands. All methods are
described in the subsequent chapters and in the BPT user interface.
Table 2
BPT commands
BPT command
Description
0
Return to the previous menu.
1 - 97
Execute the given method or continue to a submenu.
For information about BPT method syntax conventions and examples, see &quot;Bulk Provisioning Tool
conventions and examples&quot; (page 61).
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
58 Bulk Provisioning Tool introduction
BPT command
Description
98 &lt;file name&gt;
Execute all methods inside the specified file. Each line in
the file must be a method in a valid format.
99
Exit the BPT.
quit
Exit the BPT.
help
Display this list of commands.
help &lt;method name&gt;
Display the usage for a given method.
&lt;method name&gt; using
(&lt;parm a&gt;, &lt;parm b&gt;)
Execute the given method with the required parameters.
The parameter list must be separated by commas and must
adhere to the order presented in the syntax description. If
no parameters are required, this can be left blank.
&lt;method name&gt; using file
&lt;file name&gt;
Execute the given method with the parameters contained in
the specified file. This command is useful for bulk additions
(for example, users, telephones), allowing the separation of
the definition and execution of the method.
&lt;method name&gt; using * into
&lt;file name&gt;
Execute the given method (using either command line
options or parameters from a file) and inserts the returned
value into the specified file. This is useful when exporting
bulk data, such as 1000 users, and you want to save the
output.
execute &lt;file name&gt;
Execute all the methods contained in the specified file.
Each line in the file must be a method in the valid format.
execute &lt;file name&gt; into
&lt;file name&gt;
Execute all the methods contained in the specified file and
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 method syntax conventions and examples, see &quot;Bulk Provisioning Tool
conventions and examples&quot; (page 61).
Files and scripts
Files and scripts are important when performing bulk provisioning
transactions. Files enable the import and export of many database entries.
Scripts enable administrators to execute multiple BPT methods in one step.
Files
Most of the methods have the option of using text files. Provisioning data
can be imported from a file and put into the database. Likewise, provisioning
data from the database can be exported and written to text files.
The contents of the text files (*.txt) use the comma separated value (CSV)
format. By using this format, files can be generated by, or imported into,
third-party applications that recognize the CSV file content.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
BPT limitations 59
Files must use the specific syntax for a method to be invoked successfully.
The required file syntax is available by using the help option in the BPT and
is also described in &quot;Methods for OPI and BPT&quot; (page 79).
Scripts
A script is basically a text file, where each line of the file consists of a
single method. When executed, each method is invoked sequentially. Each
method in the script can reference a separate file for importing or exporting
data.
Each method and its referenced file must use the correct syntax for the
script to be executed successfully.
The exclamation mark (!) is used at the start of a line to add a comment
line in the script file. For example:
! - script updated 2003.11.09
BPT limitations
The following sections describe BPT limitations.
PROV606 logs
PROV606 logs capture all provisioning activity performed using the BPT.
However, because BPT is built on the OPI, all the logs show the request
type as OPI.
The logs are viewed in the System Management Console log browser and
are described in Provisioning Manager Fundamentals (NN42020-111),
System Management Console User Guide (NN42020-110), and Alarm and
Log Reference (NN42020-703).
Mapping between Provisioning Client and BPT
There is not a one-to-one mapping between BPT methods and Provisioning
Client screens. Most, but not all, individual BPT methods map to a
provisioning screen in the Provisioning Client.
Batch processing
A maximum of 1000 entries are processed together at a time. All bulk
processing is on an all-or-none basis.
For example, you can do a bulk add of 3000 subscribers to the system
from a file. Each subscriber is one line in the file. The BPT processes the
information in three steps of 1000 entries each. If an error occurs in a block
of 1000 entries, such as a user name already in use, the complete 1000
entries are not processed.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
60 Bulk Provisioning Tool introduction
Resource use
The BPT processes the provisioning information before uploading it to the
database. During the processing, the BPT uses all available CPU resources,
whether the processing is performed on the server or workstation. CPU
bandwidth declines as the provisioning data is uploaded to the database.
When performing bulk provisioning using files with a large number of entries,
use a BPT residing on a workstation. Performing the task on a server
can affect the performance of in-progress sessions using the component
services running on the server.
Nortel recommends using the BPT during off-peak times or maintenance
windows when large amounts of information are being added.
Provisioning data visibility
Provisioning data added using the BPT is immediately available to other
provisioning clients connected to the same instance of the Provisioning
Manager. However, it can take up to five minutes before the same data is
visible to clients connected to a second instance of a Provisioning Manager
running in the system.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
61
Bulk Provisioning Tool conventions and
examples
This chapter provides information about the following topics:
•
&quot;Method and file syntax conventions&quot; (page 61)
•
&quot;Example - adding a new provisioning role&quot; (page 65)
Method and file syntax conventions
Both the command line entry of the Bulk Provisioning Tool (BPT) method
and input file must use the correct syntax to be successfully invoked.
Use the BPT help option to view the required syntax of a method and its
associated file.
For example, to view the help on the addRole method, enter:
help addRole
or, if using the number shortcut, enter:
help 1
The BPT displays the BPT method syntax, followed by the required file
syntax, as shown in the following figure.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
62 Bulk Provisioning Tool conventions and examples
Figure 14
Invoking a help command in the BPT
In most cases, variables and properties used by the BPT methods map to
the fields in the Provisioning Client. For field descriptions, see Provisioning
Client User Guide (NN42020-105) or the Provisioning Client online help.
For example, the addRole method maps to the Add a New Role window of
the Provisioning Client (Admins &gt; Add Roles). Note that the mapping is not
always one method per Provisioning Client window.
Optional syntax
The [optional] in the BPT method syntax 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 the [optional]
when entering the syntax. For example, the following is the complete syntax
for the getSysRoles method:
getSysRoles [optional] into &lt;file name&gt;
To write the returned information to the screen, you use the syntax:
getSysRoles
To write the returned information to a file named roles.txt, you use the
syntax:
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Method and file syntax conventions 63
getSysRoles into roles.txt
Note 1: The system creates the file with the name entered in the BPT
command line.
Note 2: When the get command is not limited to a specific instance (for
example, getSysRoles or getAllRights), you cannot use the number
shortcut. You must enter the BPT method syntax into the BPT command
line. If you use the shortcut number, the returned information is written
to the screen.
Brackets
Brackets () are required around the parameters when shown in the BPT
method syntax. For example, the following is the syntax for the method
getRole:
getRole using (Role name) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
With this method, brackets are required around the provisioning Role name.
For example, to retrieve the definition for the configured SuperUser role,
you use the following syntax:
getRole using (SuperUser)
Angle brackets
Angle brackets (&lt;&gt;) in the syntax indicate a variable. You replace the
variable name and angle brackets with the specific variable when you
invoke the method. For example, the following is the syntax for the method
getSysRoles:
getSysRoles [optional] into &lt;file name&gt;
With this method, the angle brackets indicate that file name is a variable,
replaced when using the method. For example, if you want to write the
returned values to a file name called roles.txt, you use the syntax:
getSysRoles into roles.txt
Square brackets
Square brackets ([ ]) in the syntax indicate a list of variables, separated by
commas. The square brackets must be included when shown in the BPT
method syntax. For example, the following is the syntax for the method
addRole:
addRole using ([Name of the Provisioning Role,Description of
the Role,[[The Provisioning Right Type,The Read privilege,The
write privilege,The delete privilege], .. ,[The Provisioning
Right Type,The Read privilege,The write privilege,The delete
privilege]]]) | file &lt;file name&gt; [optional] into &lt;file name&gt;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
64 Bulk Provisioning Tool conventions and examples
With this method, the square brackets separate fields of the role description
being added. For example, if you are adding a role called AddExample,
the syntax looks like:
addRole using ([AddExample,BPT add example,[[Domain
Management,true,true,false],[Device Management,true,false,
false],[Admin,true,true,true]]])
Bar
A bar (|) in the syntax means that there are two ways of entering the
required method information. Typically, the bar is used for the data entry
option—entering the data in the command line or using data in a file. For
example, the following is the syntax for the method getRole:
getRole using (Role name) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
With this method, you can enter the Role name in the BPT command line,
or enter it using a file. For example, if there is a provisioning role called
SuperUser, you invoke the method by entering the Role name in the BPT
command line as follows:
getRole using (SuperUser)
The option is to invoke the method using the Role name listed in a file.
For example, the following is the syntax to invoke the method using a file
called SuperUser_role.txt:
getRole using file SuperUser_role.txt
Note: The contents of the file must be in the correct format. Use the
help command to display the BPT required file format. In this example,
the role name in the file is not enclosed in brackets.
Comma separated strings
The syntax of some methods include a string of variables separated with
commas. For example, the following is the syntax for the method addAdmin:
addAdmin using ([The Admin user name,Password,Admin First
Name,Admin Last Name,Admin Status,Admin Email Address,Office
Phone Number,Home Phone Number,Cell Phone Number,Pager
Number,Fax Number,Voicemail Number,VPN Number,System defined
role,Time Zone,Locale,Provisioning Role,[The list of Domains
that he is assigned to, .. ,The list of Domains that he is
assigned to]]) | file &lt;file name&gt; [optional] into &lt;file name&gt;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Example - adding a new provisioning role 65
Follow the required format when invoking the method from the BPT
command line or using a file. If nothing appears between two commas, the
associated field is left as is in the database. For example, the following
addAdmin method contains minimal administrator information, but still
requires the commas to denote the blank fields:
addAdmin using ([newguy,mysecret,John,Edwards,Active,,,,
,,,,,Default Admin,,English,Devices only,[yourcompany.com]])
Using fully qualified user names
Some methods require a fully qualified user name—a user name that is
complete with the domain name (for example, [email protected]). This
information is available in the Provisioning Client field descriptions.
Success indication on remove methods
Some BPT methods can remove data, and return a success indication even
if the data did not preexist in the database. This mirrors the functionality of
the database. A success indication for a &quot;remove method indicates that the
associated data no longer exists in the database.
When possible, BPT methods provide additional indication (in the form of an
error message) regarding specific data elements (domain and devices) that
are not preexisting in the database when the remove method is invoked.
This information is written to the BPT screen.
For example, if the domain nn.com does not exist, an invocation of
removeUser using ([email protected]) returns an error indication,
Invalid Data: Domain Not found ’nn.com’, because the domain
is not valid.
If the domain is valid and the user is not preexisting, then a success
indication is returned because the user is not configured on the system.
Unknown error messages
If an unknown error occurs when invoking a method, the BPT prompts the
administrator to check the logs for more information. The logs are not
accessible to the BPT user. If you see this error message and cannot
proceed with the BPT provisioning task, contact your next level of support.
Example - adding a new provisioning role
This example demonstrates adding a new provisioning role using the BPT,
and shows how BPT methods map to fields in the Provisioning Client.
Mapping of the addRole method to the Provisioning Client window fields
The BPT method for adding a new role has the following syntax:
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
66 Bulk Provisioning Tool conventions and examples
addRole using ([Name of the Provisioning Role,Description of
the Role,[[The Provisioning Right Type,The Read privilege,The
write privilege,The delete privilege], .. ,[The Provisioning
Right Type,The Read privilege,The write privilege,The delete
privilege]]]) | file &lt;file name&gt; [optional] into &lt;file name&gt;
In the Provisioning Client, adding an administrator role is performed in the
window Admins &gt; Add Roles, shown in Figure 15 &quot;Add a New Role in the
Provisioning Client&quot; (page 66).
Figure 15
Add a New Role in the Provisioning Client
The properties required for the addRole method map to the fields in the
Provisioning Client Add a New Role window.
Refer to Provisioning Client User Guide (NN42020-105) for all field
descriptions.
Defining a new role to add
If you want to add a new role with the following properties:
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Example - adding a new provisioning role 67
Role name:
ExampleRole
Role Description:
BPT Add example
Domain Management privileges:
R, W
Device Management privileges:
R
Admin privileges:
R,W,D
For this example, the role details are entered into a file (addexample.txt)
located in the workstation local directory D:\prov. The contents of the file
(on one line in the file) are:
[AddExample,BPT add example,[[Domain
Management,true,true,false],[Device
Management,true,false,false],[Admin,true,true,true]]]
The same task performed in the Provisioning Client involves the fields
highlighted in the following figure.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
68 Bulk Provisioning Tool conventions and examples
Figure 16
Provisioning Client field mapping to the addRole method
Performing the add method
To invoke the method, enter the following in the BPT command line:
addRole using file D:\prov\addexample.txt
The BPT indicates whether the method succeeded or failed, as shown in
the following figure.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Example - adding a new provisioning role 69
Figure 17
BPT showing a successful add
Viewing the details of the new role
To view the new role in the BPT, use the getRole method with the following
syntax:
getRole using (AddExample)
Figure 18
getRole method invoked in the BPT
The BPT returns the following information. It is identical to the file contents
used to create the new role.
[AddExample,BPT add example,[[Domain
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
70 Bulk Provisioning Tool conventions and examples
Management,true,true,false],[Device
Management,true,false,false],[Admin,true,true,true]]]
If you perform the same task using the Provisioning Client, you navigate to
Admins &gt; List Roles &gt; View Details. The Provisioning Client displays the
following (the affected fields are highlighted).
Figure 19
GetRole results as viewed in the Provisioning Client
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Example - adding a new provisioning role 71
Deleting the role
To delete the new role, use the method removeRole with the following
syntax:
removeRole using (AddExample)
The BPT indicates whether the method succeeded or failed, as shown in
the following figure.
Figure 20
removeRole method invoked on the BPT
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
72 Bulk Provisioning Tool conventions and examples
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
73
New, changed, and deleted methods for
OPI and BPT
The methods available in the Bulk Provisioning Tool (BPT) and the Open
Provisioning Interface (OPI) change as features and services are added
and improved. New methods are added, method parameters change, and
methods are deleted.
For the changes in this release, see the following sections:
•
&quot;Methods added in this release&quot; (page 73)
•
&quot;Methods changed in this release&quot; (page 78)
•
&quot;Methods removed from this release&quot; (page 78)
Methods added in this release
The following table lists the new methods introduced in the BPT and OPI
for this release.
Table 3
New methods
New method
Located in the following BPT menu:
addAddressBookGroups
&quot;Addressbook Operations&quot; (page 254)
addBannedUser
&quot;Addressbook Operations&quot; (page 254)
addBannedUsers
&quot;Addressbook Operations&quot; (page 254)
addClientType
&quot;User SIP Line Data Operations&quot; (page 144),
submenu &quot;Client Type Information&quot; (page 144)
addClientTypes
&quot;User SIP Line Data Operations&quot; (page 144),
submenu &quot;Client Type Information&quot; (page 144)
addDomainCLI
not supported in MCS 5100 Release 4.0
addLogicalEntity
&quot;Node Operations&quot; (page 200)
addLogicalEntitys
&quot;Node Operations&quot; (page 200)
addNode
&quot;Node Operations&quot; (page 200)
addNodes
&quot;Node Operations&quot; (page 200)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
74 New, changed, and deleted methods for OPI and BPT
New method
Located in the following BPT menu:
addOOBReferAccessCodes
&quot;Domain Operations&quot; (page 80)
addParmDefinition
&quot;Parm Definition&quot; (page 293)
addVoicemailServerHost
&quot;Voicemail Operations&quot; (page 241)
assignCrbt
not supported in MCS 5100 Release 4.0
assignDirectToGatewayPrefixData
&quot;Telephony Routes Operations&quot; (page 225)
assignDomainMCPrefixData
&quot;Domain Operations&quot; (page 80), submenu &quot;Converged
Desktop Service Data&quot; (page 92)
assignDomainsToNode
&quot;Node Operations&quot; (page 200)
assignNodeToDomain
&quot;Pool Management&quot; (page 210)
assignNodeToLocation
&quot;Pool Management&quot; (page 210)
assignNodeToLocations
&quot;Pool Management&quot; (page 210)
assignNodeToSubDomains
&quot;Node Operations&quot; (page 200)
assignParmDefinitionToOwner
&quot;Parm Definition&quot; (page 293)
assignUserDirectToGWPrefixData
&quot;Telephony Routes Operations&quot; (page 225)
assignUserMCPrefixData
&quot;Route Operations&quot; (page 122), submenu &quot;User
Converged Desktop Operations&quot; (page 141)
changeUserPassword
&quot;User Operations&quot; (page 112)
getAliasesForExpressMsging
&quot;Methods available only in OPI&quot; (page 304)
getAliasesForMsgRetrieval
&quot;Methods available only in OPI&quot; (page 304)
getAllAvailableLocationsByServiceGroup
&quot;Pool Management&quot; (page 210)
getAllChildrenDomainNames
&quot;Domain Operations&quot; (page 80)
getAllDomainProfiles
&quot;Domain Operations&quot; (page 80), submenu &quot;Domain
Profile Operations&quot; (page 88)
getAllLocationsForNodeByServiceGroup
&quot;Pool Management&quot; (page 210)
getAllLogicalEntitys
&quot;Node Operations&quot; (page 200)
getAllNodeNamesForDomain
&quot;Node Operations&quot; (page 200)
getAllNodes
&quot;Node Operations&quot; (page 200)
getAllNodesByRoutableService
&quot;Pool Management&quot; (page 210)
getAllNodesByRoutableServiceGroup
&quot;Pool Management&quot; (page 210)
getAllNodeTypeNames
&quot;Node Operations&quot; (page 200)
getAllParmDefinitions
&quot;Parm Definition&quot; (page 293)
getAllParmOwners
&quot;Parm Definition&quot; (page 293)
getAllParmTypes
&quot;Parm Definition&quot; (page 293)
getAllParmValidationTypes
&quot;Parm Definition&quot; (page 293)
getAllRootDomainNames
&quot;Domain Operations&quot; (page 80)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Methods added in this release 75
New method
Located in the following BPT menu:
getAllRoutableServiceGroups
&quot;Node Operations&quot; (page 200)
getAllRoutableServices
&quot;Node Operations&quot; (page 200)
getAllVoicemailServerHosts
&quot;Voicemail Operations&quot; (page 241)
getAllVoicemailServerHostTypes
&quot;Voicemail Operations&quot; (page 241)
getAssignedCrbt
not supported in MCS 5100 Release 4.0
getAssignedCrbtPool
not supported in MCS 5100 Release 4.0
getAssignedNodeByDomainByServiceGro
up
&quot;Pool Management&quot; (page 210)
getAssignedNodeByLocationByServiceGro
up
&quot;Pool Management&quot; (page 210)
getAssistantTypes
&quot;Methods available only in OPI&quot; (page 304)
getAvailableCrbtFiles
not supported in MCS 5100 Release 4.0
getBanServiceOptionNames
&quot;Domain Operations&quot; (page 80), submenu &quot;Banned
Subscriber Operations&quot; (page 89)
getChairAccessURL
&quot;Methods available only in OPI&quot; (page 304)
getClientTypeByName
&quot;User SIP Line Data Operations&quot; (page 144),
submenu &quot;Client Type Information&quot; (page 144)
getClientTypes
&quot;User SIP Line Data Operations&quot; (page 144),
submenu &quot;Client Type Information&quot; (page 144)
getConfDialUpNumbers
&quot;Methods available only in OPI&quot; (page 304)
getCrbtFiles
not supported in MCS 5100 Release 4.0
getCurrentOPIVersion
&quot;Release, Version Information&quot; (page 297)
getDeprecatedLocations
&quot;Location Services&quot; (page 219)
getDirectToGWPrefixData
&quot;Telephony Routes Operations&quot; (page 225)
getDomainCLIByDomain
&quot;Domain Operations&quot; (page 80)
getDomainMCPrefixData
&quot;Converged Desktop Service Data&quot; (page 92)
getDomainNodes
&quot;Node Operations&quot; (page 200)
getDomains
&quot;Domain Operations&quot; (page 80)
getEmergencyAlias
&quot;Emergency Number Operations&quot; (page 271)
getLightWeightAddressBook
&quot;Addressbook Operations&quot; (page 254)
getLogicalEntity
&quot;Node Operations&quot; (page 200)
getLogicalEntityCount
&quot;Node Operations&quot; (page 200)
getNode
&quot;Node Operations&quot; (page 200)
getNodeCount
&quot;Node Operations&quot; (page 200)
getNodeDomains
&quot;Node Operations&quot; (page 200)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
76 New, changed, and deleted methods for OPI and BPT
New method
Located in the following BPT menu:
getNodeSubDomains
&quot;Node Operations&quot; (page 200)
getNumberOfDomains
&quot;Domain Operations&quot; (page 80)
getOOBReferAccessCodesByDomain
&quot;Domain Operations&quot; (page 80)
getParameterDisplayNameByParameterN
ame
&quot;Service Operations&quot; (page 176)
getParameterNameByParameterDisplayN
ame
&quot;Service Operations&quot; (page 176)
getParmDefinitionByName
&quot;Parm Definition&quot; (page 293)
getParmDefinitionByOwner
&quot;Parm Definition&quot; (page 293)
getParmDefinitionDataForParm
&quot;Parm Definition&quot; (page 293)
getReleaseName
&quot;Release, Version Information&quot; (page 297)
getServiceDisplayNameByServiceName
&quot;Service Operations&quot; (page 176)
getServiceNameByServiceDisplayName
&quot;Service Operations&quot; (page 176)
getSIPLineData
&quot;User SIP Line Data Operations&quot; (page 144)
getSIPLineDataByDomain
&quot;User SIP Line Data Operations&quot; (page 144)
getSIPLineDataByDomainByVMG
&quot;User SIP Line Data Operations&quot; (page 144)
getSIPLineDataByUserName
&quot;User SIP Line Data Operations&quot; (page 144)
getSupportedOPIVersions
&quot;Release, Version Information&quot; (page 297)
getUserByDN
&quot;User Operations&quot; (page 112)
getUserByEndPointId
&quot;User SIP Line Data Operations&quot; (page 144)
getUserCountInDomain
&quot;User Operations&quot; (page 112)
getUserCountInSubDomain
&quot;User Operations&quot; (page 112)
getUserDirectToGWPrefixData
&quot;User Operations&quot; (page 112)
getUserMCPrefixData
&quot;User Operations&quot; (page 112), submenu &quot;User
Converged Desktop Operations&quot; (page 141)
getValidAniRegTimes
&quot;Location Services&quot; (page 219)
getVoicemailServerHost
&quot;Voicemail Operations&quot; (page 241)
getWebCollabURL
&quot;Methods available only in OPI&quot; (page 304)
makeBuddy
&quot;Addressbook Operations&quot; (page 254)
modifyClientType
&quot;User SIP Line Data Operations&quot; (page 144),
submenu &quot;Client Type Information&quot; (page 144)
modifyDomainCLI
&quot;Domain Operations&quot; (page 80)
modifyLogicalEntity
&quot;Node Operations&quot; (page 200)
modifyNode
&quot;Node Operations&quot; (page 200)
modifyOOBReferAccessCodes
&quot;Domain Operations&quot; (page 80)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Methods added in this release 77
New method
Located in the following BPT menu:
modifyVoicemailServerHost
&quot;Voicemail Operations&quot; (page 241)
purgeDeprecatedLocations
&quot;Location Services&quot; (page 219)
removeAllCrbtFiles
not supported in MCS 5100 Release 4.0
removeBannedUser
&quot;Addressbook Operations&quot; (page 254)
removeClientType
&quot;User SIP Line Data Operations&quot; (page 144),
submenu &quot;Client Type Information&quot; (page 144)
removeCrbtFile
not supported in MCS 5100 Release 4.0
removeDirectToGWPrefixData
&quot;Telephony Routes Operations&quot; (page 225)
removeDomainCLI
&quot;Domain Operations&quot; (page 80)
removeDomainMCPrefixData
&quot;Telephony Routes Operations&quot; (page 225)
removeLogicalEntity
&quot;Node Operations&quot; (page 200)
removeNode
&quot;Node Operations&quot; (page 200)
removeOOBReferAccessCodes
&quot;Domain Operations&quot; (page 80)
removeParmDefinition
&quot;Parm Definition&quot; (page 293)
removeParmDefinitionFromOwner
&quot;Parm Definition&quot; (page 293)
removeSIPLineData
&quot;User SIP Line Data Operations&quot; (page 144)
removeUserAddressBook
&quot;Addressbook Operations&quot; (page 254)
removeUserDirectToGWPrefixData
&quot;Telephony Routes Operations&quot; (page 225)
removeUserMCPrefixData
&quot;User Operations&quot; (page 112), submenu &quot;User
Converged Desktop Operations&quot; (page 141)
removeUsersVoicemailServer
&quot;User Operations&quot; (page 112)
removeVoicemailServerHost
&quot;Voicemail Operations&quot; (page 241)
resetAdminPassword
&quot;Admin Operations&quot; (page 170)
searchGABByFirstNameRange
&quot;User Operations&quot; (page 112), submenu &quot;User Search
Operations&quot; (page 153)
searchGABByLastNameRange
&quot;User Operations&quot; (page 112), submenu &quot;User Search
Operations&quot; (page 153)
searchGABByNameRange
&quot;User Operations&quot; (page 112), submenu &quot;User Search
Operations&quot; (page 153)
searchGABByPhoneNumberRange
&quot;User Operations&quot; (page 112), submenu &quot;User Search
Operations&quot; (page 153)
searchGABByUserNameRange
&quot;User Operations&quot; (page 112), submenu &quot;User Search
Operations&quot; (page 153)
setCrbtFiles
not supported in MCS 5100 Release 4.0
setSIPLineData
&quot;User SIP Line Data Operations&quot; (page 144)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
78 New, changed, and deleted methods for OPI and BPT
Methods changed in this release
The following table lists the methods that have changed, with their old and
new declarations.
Table 4
Old and new declarations
Old declaration
New declaration
getServicePackage(java.lang.String name,
java.lang.String domain)
getServicePackage(java.lang.String domain,
java.lang.String name)
modifyServicePackage(java.lang.String name,
java.lang.String domain, com.nortelnetwork
s.ims.base.prov.opi.shared.ServicePackage
servicePackage)
modifyServicePackage(java.lang.String domain,
java.lang.String name, com.nortelnetworks
.ims.base.prov.opi.shared.ServicePackage
servicePackage)
setDefaultServicePackageToDomain(java.lang
.String name, java.lang.String domain)
setDefaultServicePackageToDomain(java.lang
.String domain, java.lang.String name)
Methods removed from this release
The following table lists the methods deleted from this release.
Table 5
Deleted methods
Deleted method
addCLIWhiteList
addCLIWhiteLists
addPooledResource
deletePooledResource
getAllPooledResources
getAllPooledResourceTypes
getCLIWhiteList
getCLIWhiteListsByDomain
getDeviceQoSPriority
getPooledResource
modifyCLIWhiteList
modifyPooledResource
removeCLIWhiteList
removeCLIWhiteLists
setDeviceQoSPriority
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
79
Methods for OPI and BPT
This chapter contains the methods available to the Bulk Provisioning
Tool (BPT) and the Open Provisioning Interface (OPI). The methods are
described in the order and hierarchy in which they are displayed in the BPT
user interface.
•
&quot;Domain Operations&quot; (page 80)
•
&quot;Device Operations&quot; (page 104)
•
&quot;IPCM Operations&quot; (page 109)
•
&quot;User Operations&quot; (page 112)
•
&quot;Admin Operations&quot; (page 170)
•
&quot;Service Operations&quot; (page 176)
•
&quot;Pooled Entity&quot; (page 186)
•
&quot;Node Operations&quot; (page 200)
•
&quot;Pool Management&quot; (page 210)
•
&quot;Alias Routing&quot; (page 214)
•
&quot;Routable Service Parameter&quot; (page 216)
•
&quot;Location Services&quot; (page 219)
•
&quot;Telephony Routes Operations&quot; (page 225)
•
&quot;Voicemail Operations&quot; (page 241)
•
&quot;Addressbook Operations&quot; (page 254)
•
&quot;Time Zone Operations&quot; (page 268)
•
&quot;Emergency Number Operations&quot; (page 271)
•
&quot;Media Portal Group and Route Operations&quot; (page 273)
•
&quot;Resource Management&quot; (page 281)
•
&quot;LicenseKey Usage&quot; (page 283)
•
&quot;LDAP Syncing&quot; (page 284)
•
&quot;Password Policy Operations&quot; (page 291)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
80 Methods for OPI and BPT
•
&quot;Parm Definition&quot; (page 293)
•
&quot;Release, Version Information&quot; (page 297)
•
&quot;Groups&quot; (page 297)
•
&quot;SIP Lines&quot; (page 302)
Some methods are available in the OPI only, and they are described in
&quot;Methods available only in OPI&quot; (page 304).
Unless otherwise noted, the methods are defined in the file opi.java.
Domain Operations
This section contains the following:
•
&quot;Domain Locale Operations&quot; (page 81)
•
&quot;Status Reasons Operations&quot; (page 84)
•
&quot;Domain Class of Service Operations&quot; (page 87)
•
&quot;Domain Profile Operations&quot; (page 88)
•
&quot;Banned Subscriber Operations&quot; (page 89)
•
Domain CLI Operations (not supported by MCS 5100)
•
&quot;Converged Desktop Service Data&quot; (page 92)
•
&quot;Add a root domain (addRootDomain)&quot; (page 97)
•
&quot;Add a sub domain (addSubDomain)&quot; (page 98)
•
&quot;Modify a domain (modifyDomain)&quot; (page 98)
•
&quot;Remove a domain (removeDomain)&quot; (page 98)
•
&quot;Get all root domain parameters (getAllRootDomainParms)&quot; (page 99)
•
&quot;Get all sub domain parameters (getAllSubDomainParms)&quot; (page 99)
•
&quot;Get all possible values for a domain parameter (getDomainParmValues)&quot;
(page 99)
•
&quot;Get all domains (getAllDomains)&quot; (page 99)
•
&quot;Get a domain by name (getDomain)&quot; (page 100)
•
&quot;Get all child domains of a domain (getChildrenDomains)&quot; (page 100)
•
&quot;Get the parent domain of a domain (getParentDomain)&quot; (page 100)
•
&quot;Get the root domain of a domain (getRootDomain)&quot; (page 101)
•
&quot;Add a foreign domain (addForeignDomain)&quot; (page 101)
•
&quot;Get a foreign domain (getForeignDomain)&quot; (page 102)
•
&quot;Modify a foreign domain (modifyForeignDomain)&quot; (page 102)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Domain Operations 81
•
&quot;Remove a foreign domain (removeForeignDomain)&quot; (page 102)
•
&quot;Get domains subset (getDomains)&quot; (page 103)
•
&quot;Get all the root domain names (getAllRootDomainNames)&quot; (page 103)
•
&quot;Get all the children domain names for a domain (getAllChildrenDomainNames)&quot; (page 103)
•
&quot;Get the domain count in the system (getNumberOfDomains)&quot; (page
104)
Domain Locale Operations
This section contains the following:
•
&quot;Add a domain locale (addDomainLocale)&quot; (page 81)
•
&quot;Add a list of domain locales (addDomainLocales)&quot; (page 81)
•
&quot;Get list of locales (getAvailableLocales)&quot; (page 82)
•
&quot;Get the default locale for a domain (getDefaultDomainLocale)&quot; (page
82)
•
&quot;Get the list of locales for a domain (getDomainLocales)&quot; (page 82)
•
&quot;Modify the domain locales (modifyDomainLocales)&quot; (page 83)
•
&quot;Remove a domain locale (removeDomainLocale)&quot; (page 83)
•
&quot;Set the domain locale default (setDefaultDomainLocale)&quot; (page 83)
Add a domain locale (addDomainLocale)
BPT Method Syntax
addDomainLocale using (Domain name, Locale description) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Locale description
OPI method
public void addDomainLocale(java.lang.String domainName,
java.lang.String localeDescription) throws java.rmi.Remote
Exception, com.nortelnetworks.ims.base.prov.opi.shared.Pro
visionException;
Add a list of domain locales (addDomainLocales)
BPT Method Syntax
addDomainLocales using (Domain name,[Locale descriptions,
.. , Locale descriptions]) | file &lt;file name&gt; [optional]
into &lt;file name&gt;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
82 Methods for OPI and BPT
BPT Required file format
Domain name, [Locale descriptions, ..
descriptions]
, Locale
OPI method
public void addDomainLocales(java.lang.String domainName,
java.lang.String[] localeDescriptions) throws java.rmi.Rem
oteException, com.nortelnetworks.ims.base.prov.opi.share
d.ProvisionException;
Get list of locales (getAvailableLocales)
BPT Method Syntax
getAvailableLocales [optional] into &lt;file name&gt;
OPI method
public java.lang.String[] getAvailableLocales() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get the default locale for a domain (getDefaultDomainLocale)
BPT Method Syntax
getDefaultDomainLocale using (Domain name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.DomainLo
cale getDefaultDomainLocale(java.lang.String domainName)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Get the list of locales for a domain (getDomainLocales)
BPT Method Syntax
getDomainLocales using (Domain name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Domain Operations 83
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.DomainLo
cale[] getDomainLocales(java.lang.String domainName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException
Modify the domain locales (modifyDomainLocales)
BPT Method Syntax
modifyDomainLocales using (Domain name,[Locale
descriptions, .. , Locale descriptions]) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name,[Locale descriptions, ..
descriptions]
, Locale
OPI method
public void modifyDomainLocales(java.lang.String
domainName, java.lang.String[] localeDescriptions) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Remove a domain locale (removeDomainLocale)
BPT Method Syntax
removeDomainLocale using (Domain name, Locale description)
| file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Locale description
OPI method
public void removeDomainLocale(java.lang.String
domainName, java.lang.String localeDescription) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Set the domain locale default (setDefaultDomainLocale)
BPT Method Syntax
setDefaultDomainLocale using (Domain name, Locale
description) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Locale description
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
84 Methods for OPI and BPT
OPI method
public void setDefaultDomainLocale(java.lang.String
domainName, java.lang.String localeDescription) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Status Reasons Operations
This section contains the following:
•
&quot;Add a status reason to a domain (addStatusReason)&quot; (page 84)
•
&quot;Add a list of status reasons to a domain (addStatusReasons)&quot; (page 85)
•
&quot;Get status reasons for a domain (getStatusReasonsByDomain)&quot; (page
85)
•
&quot;Get all status names (getAllStatusNames)&quot; (page 85)
•
&quot;Remove a status reason from a domain (removeStatusReason)&quot; (page
86)
•
&quot;Remove all status reasons from a domain (removeAllStatusReasons)&quot;
(page 86)
•
&quot;Modify a status reason for a domain (modifyStatusReason)&quot; (page 86)
Add a status reason to a domain (addStatusReason)
BPT Method Syntax
addStatusReason using (Domain name,Status name,[Status
Reason Name,Status Reason Description,Status Reason URL]) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name,Status name,[Status Reason Name,Status Reason
Description,Status Reason URL]
OPI method
public void addStatusReason(java.lang.String domain,
java.lang.String status, com.nortelnetworks.ims.b
ase.prov.opi.shared.StatusReason newObj) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Note: The Status Reason URL parameter is reserved for future use.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Domain Operations 85
Add a list of status reasons to a domain (addStatusReasons)
BPT Method Syntax
addStatusReasons using (Domain name,Status name,[[Status
Reason Name,Status Reason Description,Status Reason URL],
.. ,[Status Reason Name,Status Reason Description,Status
ReasonURL]]) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name,Status name,[[Status Reason Name,Status
Reason Description,Status Reason URL], .. ,[Status Reason
Name,Status Reason Description,Status Reason URL]]
OPI method
public void addStatusReasons(java.lang.String domain,
java.lang.String status, com.nortelnetworks.ims.b
ase.prov.opi.shared.StatusReason[] newObj) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Note: The Status Reason URL parameter is reserved for future use.
Get status reasons for a domain (getStatusReasonsByDomain)
BPT Method Syntax
getStatusReasonsByDomain using (Domain name, Status name) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Status name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.StatusRe
ason[] getStatusReasonsByDomain(java.lang.String domain,
java.lang.String status) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Get all status names (getAllStatusNames)
BPT Method Syntax
getAllStatusNames [optional] into &lt;file name&gt;
OPI method
public java.lang.String[] getAllStatusNames() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
86 Methods for OPI and BPT
Remove a status reason from a domain (removeStatusReason)
BPT Method Syntax
removeStatusReason using (Domain name,Status name, Reason
name) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name,Status name, Reason name
OPI method
public void removeStatusReason(java.lang.String domain,
java.lang.String status, java.lang.String name) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Remove all status reasons from a domain (removeAllStatusReasons)
BPT Method Syntax
removeAllStatusReasons using (Domain name, Status name) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name,Status name
OPI method
public void removeAllStatusReasons(java.lang.String domain,
java.lang.String status) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Modify a status reason for a domain (modifyStatusReason)
BPT Method Syntax
modifyStatusReason using (Domain name,Status name, Reason
name,[Status Reason Name,Status Reason Description,Status
Reason URL]) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name,Status name, Reason name,[Status Reason
Name,Status Reason Description,Status Reason URL]
OPI method
public void modifyStatusReason(java.lang.String
domain, java.lang.String status, java.lang.String name,
com.nortelnetworks.ims.base.prov.opi.shared.StatusReason
updateObj) throws java.rmi.RemoteException, com.nortelnetwo
rks.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Domain Operations 87
Note: The Status Reason URL parameter is reserved for future use.
Domain Class of Service Operations
This section contains the following:
•
&quot;Get all Class of Services for a domain (getAllDomainCos)&quot; (page 87)
•
&quot;Modify Class of Service for a domain (modifyDomainCos)&quot; (page 87)
•
&quot;Remove Class of Service for a domain (removeDomainCos)&quot; (page 88)
Get all Class of Services for a domain (getAllDomainCos)
BPT Method Syntax
getAllDomainCos using (Domain name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Doma
inCos[] getAllDomainCos(java.lang.String domain) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Modify Class of Service for a domain (modifyDomainCos)
BPT Method Syntax
modifyDomainCos using (Domain name,[[Class of Service,Class
of Service Description], .. ,[Class of Service,Class of
Service Description]]) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
BPT Required file format
Domain name,[[Class of Service,Class of Service
Description], .. ,[Class of Service,Class of Service
Description]]
OPI method
public void modifyDomainCos(java.lang.String domain,
com.nortelnetworks.ims.base.prov.opi.shared.DomainCos[]
newCos) throws java.rmi.RemoteException, com.nortelnetworks
.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
88 Methods for OPI and BPT
Remove Class of Service for a domain (removeDomainCos)
BPT Method Syntax
removeDomainCos using (Domain name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public void removeDomainCos(java.lang.String domain) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Domain Profile Operations
This section contains the following:
•
&quot;Get domain profile for a domain (getDomainProfile)&quot; (page 88)
•
&quot;Get all profiles for a root domain (getAllDomainProfiles)&quot; (page 88)
•
&quot;Remove domain profile for a domain (removeDomainProfile)&quot; (page 89)
•
&quot;Modify domain profile for a domain (modifyDomainProfile)&quot; (page 89)
Get domain profile for a domain (getDomainProfile)
BPT Method Syntax
getDomainProfile using (Domain name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public java.lang.String getDomainProfile(java.lang.String
domain) throws java.rmi.RemoteException, com.nortelnetworks
.ims.base.prov.opi.shared.ProvisionException;
Get all profiles for a root domain (getAllDomainProfiles)
BPT Method Syntax
getAllDomainProfiles using (Domain name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Domain Operations 89
OPI method
public java.lang.String[] getAllDomainProfiles(java.lang.St
ring rootDomainName) throws java.rmi.RemoteException, com.n
ortelnetworks.ims.base.prov.opi.shared.ProvisionException;
Remove domain profile for a domain (removeDomainProfile)
BPT Method Syntax
removeDomainProfile using (Domain name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public void removeDomainProfile(java.lang.String domain)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Modify domain profile for a domain (modifyDomainProfile)
BPT Method Syntax
modifyDomainProfile using (Domain name, Profile) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Profile
OPI method
public void modifyDomainProfile(java.lang.String domain,
java.lang.String newProf) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Banned Subscriber Operations
This section contains the following:
•
&quot;Add a banned subscriber to a domain (addBannedSubscriber)&quot; (page
90)
•
&quot;Add multiple banned subscribers to a domain (addBannedSubscribers)&quot;
(page 90)
•
&quot;Get all banned subscribers in a domain (getBannedSubscribersByDomain)&quot; (page 91)
•
&quot;Get all banned service options names (getBanServiceOptionNames)&quot;
(page 91)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
90 Methods for OPI and BPT
•
&quot;Remove a banned subscriber from a domain (removeBannedSubscriber)&quot; (page 91)
•
&quot;Remove all banned subscribers from a domain (removeAllBannedSubscribers)&quot; (page 92)
•
&quot;Remove several banned subscribers from a domain
(removeBannedSubscribers)&quot; (page 92)
Add a banned subscriber to a domain (addBannedSubscriber)
BPT Method Syntax
addBannedSubscriber using (Domain name,[Party address,Descr
iption (eg. reason for banning),Banned service]) | file
&lt;file name&gt; [optional] into &lt;filename&gt;
BPT Required file format
Domain name,[Party address,Description (eg.
banning),Banned service]
reason for
OPI method
public void addBannedSubscriber(java.lang.String domain,
com.nortelnetworks.ims.base.prov.opi.shared.BannedSubscribe
r newObj) throws java.rmi.RemoteException, com.nortelnetwor
ks.ims.base.prov.opi.shared.ProvisionException;
Add multiple banned subscribers to a domain (addBannedSubscribers)
BPT Method Syntax
addBannedSubscribers using (Domain name,[[Party
address,Description (eg. reason for banning),Banned
service]), .. ,[Party address,Description (eg. reason for
banning),Banned service])]) | file &lt;file name&gt; [optional]
into &lt;filename&gt;
BPT Required file format
Domain name,[Party address,Description (eg.
banning),Banned service])
reason for
OPI method
public void addBannedSubscribers(java.lang.String domain,
com.nortelnetworks.ims.base.prov.opi.shared.BannedSubscribe
r[] newObj) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Domain Operations 91
Get all banned subscribers in a domain (getBannedSubscribersByDomain)
BPT Method Syntax
getBannedSubscribersByDomain using (Domain name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.BannedSu
bscriber[] getBannedSubscribersByDomain(java.lang.String
domain) throws java.rmi.RemoteException, com.nortelnetworks
.ims.base.prov.opi.shared.ProvisionException;
Get all banned service options names (getBanServiceOptionNames)
BPT Method Syntax
getBanServiceOptionNames [optional] into &lt;file name&gt;
OPI method
public java.lang.String[] getBanServiceOptionNames() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Remove a banned subscriber from a domain (removeBannedSubscriber)
BPT Method Syntax
removeBannedSubscriber using (Domain name, Banned
Subscriber UserName) |file &lt;file name&gt; [optional] into
&lt;file name&gt;
BPT Required file format
Domain name, Banned Subscriber UserName
OPI method
public void removeBannedSubscriber(java.lang.String domain,
java.lang.String party) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
92 Methods for OPI and BPT
Remove all banned subscribers from a domain
(removeAllBannedSubscribers)
BPT Method Syntax
removeAllBannedSubscribers using (Domain name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public void removeAllBannedSubscribers(java.lang.String
domain) throws java.rmi.RemoteException, com.nortelnetworks
.ims.base.prov.opi.shared.ProvisionException;
Remove several banned subscribers from a domain
(removeBannedSubscribers)
BPT Method Syntax
removeBannedSubscribers using (Domain name,[Banned
Subscriber UserNameslist, .. , Banned Subscriber UserNames
list]) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Banned Subscriber UserNames list
OPI method
public void removeBannedSubscribers(java.lang.String
domain, java.lang.String[] parties) throws java.rmi.Remote
Exception, com.nortelnetworks.ims.base.prov.opi.shared.Pro
visionException;
Converged Desktop Service Data
This section contains the following:
•
&quot;Add the Converged Desktop Service Data to a domain
(addConvDesktopServiceData)&quot; (page 93)
•
&quot;Update the Converged Desktop Service Data to a domain
(modifyConvDesktopServiceData)&quot; (page 93)
•
&quot;Get the Converged Desktop Service data associated with a domain
(getConvDesktopServiceData)&quot; (page 94)
•
&quot;Remove the Converged Desktop Service data from a domain
(removeConvDesktopServiceData)&quot; (page 94)
•
&quot;Add Mobile converged audio device prefix for a domain
(assignDomainMCPrefixData)&quot; (page 95)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Domain Operations 93
•
&quot;Get Mobile converged audio device prefix for a domain
(getDomainMCPrefixData)&quot; (page 95)
•
&quot;Remove Mobile converged audio device prefix for a domain
(removeDomainMCPrefixData)&quot; (page 95)
•
&quot;Add the Out of Band REFER Access Codes for a domain
(addOOBReferAccessCodes)&quot; (page 96)
•
&quot;Update the Out of Band REFER Access Codes for a domain
(modifyOOBReferAccessCodes)&quot; (page 96)
•
&quot;Get the Out of Band REFER Access Codes associated with a domain
(getOOBReferAccessCodesByDomain)&quot; (page 97)
•
&quot;Remove the Out of Band REFER Access Codes from a domain
(removeOOBReferAccessCodes)&quot; (page 97)
Add the Converged Desktop Service Data to a domain
(addConvDesktopServiceData)
BPT Method Syntax
addConvDesktopServiceData using (Domain name,[Service DN is
the digits needed to route a call to a PRI Gateway,Number
Qualifier entry needed to qualify the Service DN]) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name,[Service DN is the digits needed to route a
call to a PRI Gateway,Number Qualifier entry needed to
qualify the Service DN]
OPI method
public void addConvDesktopServiceData(java.lang.String
domainName, com.nortelnetworks.ims.base.prov.op
i.shared.ConvDesktopService serviceData) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Update the Converged Desktop Service Data to a domain
(modifyConvDesktopServiceData)
BPT Method Syntax
modifyConvDesktopServiceData using (Domain name,[Service
DN is the digits needed to route a call to a PRI
Gateway,Number Qualifier entry needed to qualify the
Service DN]) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
94 Methods for OPI and BPT
Domain name,[Service DN is the digits needed to route a
call to a PRI Gateway,Number Qualifier entry needed to
qualify the Service DN]
OPI method
public void modifyConvDesktopServiceData(java.lang.String
domainName, com.nortelnetworks.ims.base.prov.opi.shared.Co
nvDesktopService newData) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Get the Converged Desktop Service data associated with a
domain (getConvDesktopServiceData)
BPT Method Syntax
getConvDesktopServiceData using (Domain name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.ConvD
esktopService getConvDesktopServiceData(java.lang.String
domainName) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Remove the Converged Desktop Service data from a domain
(removeConvDesktopServiceData)
BPT Method Syntax
removeConvDesktopServiceData using (Domain name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public void removeConvDesktopServiceData(java.lang.String
domainName) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Domain Operations 95
Add Mobile converged audio device prefix for a domain
(assignDomainMCPrefixData)
BPT Method Syntax
assignDomainMCPrefixData using (Domain name, Prefix) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Prefix
OPI method
public void assignDomainMCPrefixData(java.lang.String
domain, java.lang.String domPrefixData) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get Mobile converged audio device prefix for a domain
(getDomainMCPrefixData)
BPT Method Syntax
getDomainMCPrefixData using (Domain name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public java.lang.String getDomainMCPrefixData(java.lang.Str
ing domain) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Remove Mobile converged audio device prefix for a domain
(removeDomainMCPrefixData)
BPT Method Syntax
removeDomainMCPrefixData using (Domain name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public void removeDomainMCPrefixData(java.lang.String
domain) throws java.rmi.RemoteException, com.nortelnetworks
.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
96 Methods for OPI and BPT
Add the Out of Band REFER Access Codes for a domain
(addOOBReferAccessCodes)
BPT Method Syntax
addOOBReferAccessCodes using (Domain name,[Public Access
Code is the digits needed to access the Click to Dial
feature for public terminations,Private Access Code is
the digits needed to access the Click to Dial feature for
private terminations]) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
BPT Required file format
Domain name,[Public Access Code is the digits needed
to access the Click to Dial feature for public
terminations,Private Access Code is the digits needed to
access the Click to Dial feature for private terminations]
OPI method
public void addOOBReferAccessCodes(java.lang.String
domainName, com.nortelnetworks.ims.base.prov.opi.shared.OOB
ReferService serviceData) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Update the Out of Band REFER Access Codes for a domain
(modifyOOBReferAccessCodes)
BPT Method Syntax
modifyOOBReferAccessCodes using (Domain name, [Public
Access Code is the digits needed to access the Click to
Dial feature for public terminations,Private Access Code
is the digits needed to access the Click to Dial feature
for private terminations]) | file &lt;file name&gt; [optional]
into &lt;file name&gt;
BPT Required file format
Domain name,[Public Access Code is the digits needed
to access the Click to Dial feature for public
terminations,Private Access Code is the digits needed to
access the Click to Dial feature for private terminations]
OPI method
public void modifyOOBReferAccessCodes(java.lang.String
domainName, com.nortelnetworks.ims.base.prov.opi.shared.O
OBReferService newData) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Domain Operations 97
Get the Out of Band REFER Access Codes associated with a
domain (getOOBReferAccessCodesByDomain)
BPT Method Syntax
getOOBReferAccessCodesByDomain using (Domain name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.OOBRefe
rService getOOBReferAccessCodesByDomain(java.lang.String
domainName) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Remove the Out of Band REFER Access Codes from a domain
(removeOOBReferAccessCodes)
BPT Method Syntax
removeOOBReferAccessCodes using (Domain name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public void removeOOBReferAccessCodes(java.lang.String
domainName) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Add a root domain (addRootDomain)
BPT Method Syntax
addRootDomain using ([Domain name,Domain Class of
service,[[Name,Value],.. ,[Name,Value]]]) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name,Domain Class of service,[[Name,Value],..
,[Name,Value]]
OPI method
public void addRootDomain(com.nortelnetworks.ims.base.prov
.opi.shared.Domain domain) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
98 Methods for OPI and BPT
Add a sub domain (addSubDomain)
BPT Method Syntax
addSubDomain using (Parent name,[Domain name,Domain
Class of service,[[Name,Value],.. ,[Name,Value]],[Domain
aliases, .. , Domain aliases],Location]) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Parent name,[Domain name,Domain Class of service,[[Name
,Value],.. ,[Name,Value]],[Domain aliases, .. , Domain
aliases],Location]
OPI method
public void addSubDomain(java.lang.String parent,
com.nortelnetworks.ims.base.prov.opi.shared.Domain domain)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Modify a domain (modifyDomain)
BPT Method Syntax
modifyDomain using (Domain name,[Domain name,Domain Class
of Service,[[Name,Value], .. ,[Name,Value]],[Domain
alises, .. ,Domain aliases],Location]) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name,[Domain name,Domain Class of Service,[[Name
,Value], .. ,[Name,Value]],[Domain alises, .. ,Domain
aliases],Location]
OPI method
public void modifyDomain(java.lang.String domainName,
com.nortelnetworks.ims.base.prov.opi.shared.Domain domain)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Remove a domain (removeDomain)
BPT Method Syntax
removeDomain using (Domain name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Domain Operations 99
OPI method
public void removeDomain(java.lang.String domain) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get all root domain parameters (getAllRootDomainParms)
BPT Method Syntax
getAllRootDomainParms [optional] into &lt;file name&gt;
OPI method
public java.lang.String[] getAllRootDomainParms() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get all sub domain parameters (getAllSubDomainParms)
BPT Method Syntax
getAllSubDomainParms [optional] into &lt;file name&gt;
OPI method
public java.lang.String[] getAllSubDomainParms() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get all possible values for a domain parameter (getDomainParmValues)
BPT Method Syntax
getDomainParmValues using (Parameter name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Parameter name
OPI method
public java.lang.String[] getDomainParmValues(java.lang.Str
ing parm) throws java.rmi.RemoteException, com.nortelnetwor
ks.ims.base.prov.opi.shared.ProvisionException;
Get all domains (getAllDomains)
BPT Method Syntax
getAllDomains [optional] into &lt;file name&gt;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
100 Methods for OPI and BPT
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Domain[]
getAllDomains() throws java.rmi.RemoteException, com.nortel
networks.ims.base.prov.opi.shared.ProvisionException;
Get a domain by name (getDomain)
BPT Method Syntax
getDomain using (Domain name) | file &lt;file name&gt; [optional]
into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Domain
getDomain(java.lang.String domainName) throws java.rmi.Rem
oteException, com.nortelnetworks.ims.base.prov.opi.share
d.ProvisionException;
Get all child domains of a domain (getChildrenDomains)
BPT Method Syntax
getChildrenDomains using (Domain name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Domain[]
getChildrenDomains(java.lang.String parentName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get the parent domain of a domain (getParentDomain)
BPT Method Syntax
getParentDomain using (Domain name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Domain Operations 101
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Domain
getParentDomain(java.lang.String subDomainName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get the root domain of a domain (getRootDomain)
BPT Method Syntax
getRootDomain using (Domain name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Domain
getRootDomain(java.lang.String domainName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Add a foreign domain (addForeignDomain)
BPT Method Syntax
addForeignDomain using ([Name of the Foreign Domain,[The
Foreign Routes associated with this Domain, .. ,The
Foreign Routes associated with this Domain],[The Aliases
associated with this Domain, .. ,The Aliases associated
with this Domain]]) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
BPT Required file format
[Name of the Foreign Domain,[The Foreign Routes associated
with this Domain, ..,The Foreign Routes associated with
this Domain],[The Aliases associated with this Domain, ..
,The Aliases associated with this Domain]]
OPI method
public void addForeignDomain(com.nortelnetworks.ims
.base.prov.opi.shared.ForeignDomain forDomain) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
102 Methods for OPI and BPT
Get a foreign domain (getForeignDomain)
BPT Method Syntax
getForeignDomain using (Foreign Domain name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Foreign Domain name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.ForeignD
omain getForeignDomain(java.lang.String forDomains) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Modify a foreign domain (modifyForeignDomain)
BPT Method Syntax
modifyForeignDomain using (Foreign Domain name,[Name of
the Foreign Domain,[The Foreign Routes associated with
this Domain, .. ,The Foreign Routes associated with this
Domain],[The Aliases associated with this Domain, .. ,The
Aliases associated with this Domain]]) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Foreign Domain name,[Name of the Foreign Domain,[The
Foreign Routes associated with this Domain, .. ,The
Foreign Routes associated with this Domain].[The Aliases
associated with this Domain, .. ,The Aliases associated
with this Domain]]
OPI method
public void modifyForeignDomain(java.lang.String name,
com.nortelnetworks.ims.base.prov.opi.shared.ForeignDomain
forDomain) throws java.rmi.RemoteException, com.nortelnetwo
rks.ims.base.prov.opi.shared.ProvisionException;
Remove a foreign domain (removeForeignDomain)
BPT Method Syntax
removeForeignDomain using (Foreign Domain name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Foreign Domain name
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Domain Operations 103
OPI method
public void removeForeignDomain(java.lang.String name)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Get domains subset (getDomains)
BPT Method Syntax
getDomains using (Start Index, Stop Index) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Start Index, Stop Index
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Domain[]
getDomains(int start, int stop) throws java.rmi.RemoteExce
ption, com.nortelnetworks.ims.base.prov.opi.shared.Provisi
onException;
Get all the root domain names (getAllRootDomainNames)
BPT Method Syntax
getAllRootDomainNames [optional] into &lt;file name&gt;
OPI method
public java.lang.String[] getAllRootDomainNames() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get all the children domain names for a domain (getAllChildrenDomainNames)
BPT Method Syntax
getAllChildrenDomainNames using (Domain name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public java.lang.String[] getAllChildrenDomainNames(java
.lang.String rootDomain) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
104 Methods for OPI and BPT
Get the domain count in the system (getNumberOfDomains)
BPT Method Syntax
getNumberOfDomains [optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public int getNumberOfDomains() throws java.rmi.RemoteExce
ption, com.nortelnetworks.ims.base.prov.opi.shared.Provisi
onException;
Device Operations
This section contains the following:
•
&quot;Add a device (addDevice)&quot; (page 104)
•
&quot;Add devices (addDevices)&quot; (page 105)
•
&quot;Modify a device (modifyDevice)&quot; (page 106)
•
&quot;Remove a device (removeDevice)&quot; (page 106)
•
&quot;Remove devices (removeDevices)&quot; (page 107)
•
&quot;Get a device (getDevice)&quot; (page 107)
•
&quot;Get a list of devices (getDevices)&quot; (page 107)
•
&quot;Get devices by domain (getDevicesInDomain)&quot; (page 108)
•
&quot;Get devices by User name (getCurrentDevices)&quot; (page 108)
•
&quot;Get devices by MAC address (getDeviceByMacAddress)&quot; (page 108)
•
&quot;get SubDomain For Device (getSubDomainForDevice)&quot; (page 109)
Add a device (addDevice)
BPT Method Syntax
addDevice using (Domain name,[Device Label,Active
Proxy(TRUE/FALSE),Allow All Codecs(TRUE/FALSE),Behind
Firewall(TRUE/FALSE),Alpha(TRUE/FALSE),MacAddress,Default
Proxy Host,Default Proxy Port,Contrast,Packet Time,PDIL
Timer,PSEIZ Timer,Rtp Port,Vocoder,DateFormat,Time
Format,Idle Display,Location,Locale,Time Zone,IPCM
name,[The users on this Device, .. ,The users on this
Device]]) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Device Operations 105
Domain name,[Device Label,Active Proxy(TRUE/FALSE),Allow
All Codecs(TRUE/FALSE),Behind Firewall(TRUE/FALSE),
Alpha(TRUE/FALSE),MacAddress,Default Proxy Host,Default
Proxy Port,Contrast,Packet Time,PDIL Timer,PSEIZ
Timer,Rtp Port,Vocoder,Date Format,Time Format,Idle
Display,Location,Locale,Time Zone,IPCM name,[The users on
this Device, .. ,The users on this Device]]
OPI method
public void addDevice(java.lang.String domainName,
com.nortelnetworks.ims.base.prov.opi.shared.Device device)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Add devices (addDevices)
BPT Method Syntax
addDevices using (Domain name,[[Device Label,Active
Proxy(TRUE/FALSE),Allow All Codecs(TRUE/FALSE),Behind
Firewall(TRUE/FALSE),Alpha(TRUE/FALSE),MacAddress,Default
Proxy Host,Default Proxy Port,Contrast,Packet Time,PDIL
Timer,PSEIZ Timer,Rtp Port,Vocoder,Date Format,Time
Format,Idle Display,Location,Locale,TimeZone,IPCM name,[The
users on this Device, .. ,The users on this Device]], ..
,[Device Label,Active Proxy
(TRUE/FALSE),Allow All Codecs(TRUE/FALSE),Behind
Firewall(TRUE/FALSE),Alpha(TRUE/FALSE),MacAddress,Default
ProxyHost,Default Proxy Port,Contrast,Packet Time,PDIL
Timer,PSEIZTimer,Rtp Port,Vocoder,Date Format,Time
Format,Idle Display,Location,Locale,Time Zone,IPCM
name,[The users on this Device, ..,The users on this
Device]]]) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name,[Device Label,Active Proxy(TRUE/FALSE),Allow
All Codecs(TRUE/FALSE),Behind Firewall(TRUE/FALSE),
Alpha(TRUE/FALSE),MacAddress,Default Proxy Host,Default
Proxy Port,Contrast,Packet Time,PDIL Timer,PSEIZ
Timer,Rtp Port,Vocoder,Date Format,Time Format,Idle
Display,Location,Locale,Time Zone,IPCM name,[The userson
this Device, .. ,The users on this Device]]
OPI method
public void addDevices(java.lang.String domainName,
com.nortelnetworks.ims.base.prov.opi.shared.Device[]
devices) throws java.rmi.RemoteException, com.nortelnetwork
s.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
106 Methods for OPI and BPT
Modify a device (modifyDevice)
BPT Method Syntax
modifyDevice using (Domain name, MAC Address,[Device
Label,Active Proxy(TRUE/FALSE),Allow All Codecs(TRUE/
FALSE),Behind Firewall(TRUE/FALSE),Alpha(TRUE/FALSE),MacAdd
ress,Default Proxy Host,Default Proxy Port,Contrast,Packet
Time,PDIL Timer,PSEIZ Timer,Rtp Port,Vocoder,Date
Format,Time Format,Idle Display,Location,Locale,Time
Zone,IPCM name,[The users on this Device, .. ,The users
on this Device]]) | file &lt;file name&gt; [optional] into &lt;file
name&gt;
BPT Required file format
Domain name, MAC Address,[Device Label,Active Prox
y(TRUE/FALSE),Allow All Codecs(TRUE/FALSE),Behind
Firewall(TRUE/FALSE),Alpha(TRUE/FALSE),MacAddress,Default
Proxy Host,Default Proxy Port,Contrast,Packet Time,PDIL
Timer,PSEIZ Timer,Rtp Port,Vocoder,Date Format,Time
Format,Idle Display,Location,Locale,Time Zone,IPCM
name,[The users on this Device, .. ,The users on this
Device]]
OPI method
public void modifyDevice(java.lang.String domainName,
java.lang.String macaddress, com.nortelnetworks
.ims.base.prov.opi.shared.Device device) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Remove a device (removeDevice)
BPT Method Syntax
removeDevice using (Domain name, MAC Address) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, MAC Address
OPI method
public void removeDevice(java.lang.String domainName, java
.lang.String macaddress) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Device Operations 107
Remove devices (removeDevices)
BPT Method Syntax
removeDevices using (Domain name,[ MAC Addresses, .. , MAC
Addresses]) |file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, MAC Addresses
OPI method
public void removeDevices(java.lang.String domainName,
java.lang.String[] macaddressess) throws java.rmi.RemoteEx
ception, com.nortelnetworks.ims.base.prov.opi.shared.Pro
visionException;
Get a device (getDevice)
BPT Method Syntax
getDevice using (Domain name, MAC Address) | file &lt;file
name&gt; [optional]into &lt;file name&gt;
BPT Required file format
Domain name, MAC Address
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Device
getDevice(java.lang.String domainName, java.lang.String
macaddress) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Get a list of devices (getDevices)
BPT Method Syntax
getDevices using (Domain name,[ MAC Addresses, .. , MAC
Addresses]) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name,[ MAC Addresses, ..
, MAC Addresses]
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Device[]
getDevices(java.lang.String domainName, java.lang.String[]
macaddr) throws java.rmi.RemoteException, com.nortelnetwork
s.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
108 Methods for OPI and BPT
Get devices by domain (getDevicesInDomain)
BPT Method Syntax
getDevicesInDomain using (Domain name, Start Index, Stop
Index) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Start Index, Stop Index
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Device[]
getDevicesInDomain(java.lang.String domain, int start, int
end) throws java.rmi.RemoteException, com.nortelnetworks.im
s.base.prov.opi.shared.ProvisionException;
Get devices by User name (getCurrentDevices)
BPT Method Syntax
getCurrentDevices using (User name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
User name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Device[]
getCurrentDevices(java.lang.String username) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get devices by MAC address (getDeviceByMacAddress)
BPT Method Syntax
getDeviceByMacAddress using (MAC Address) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
MAC Address
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.NameVa
lue[] getDeviceByMacAddress(java.lang.String macAddress)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
IPCM Operations 109
get SubDomain For Device (getSubDomainForDevice)
BPT Method Syntax
getSubDomainForDevice using (MAC Address) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
MAC Address
OPI method
public java.lang.String getSubDomainForDevice(java.lang.Str
ing macAddress) throws java.rmi.RemoteException, com.nortel
networks.ims.base.prov.opi.shared.ProvisionException;
IPCM Operations
This section contains the following:
•
&quot;Add a single IPCM (addIPCM)&quot; (page 109)
•
&quot;Modify a single IPCM (modifyIPCM)&quot; (page 110)
•
&quot;Get a single IPCM (getIPCM)&quot; (page 110)
•
&quot;Remove a single IPCM (removeIPCM)&quot; (page 110)
•
&quot;Get available capacity for an IPCM (getIPCMAvailCapacity)&quot; (page 111)
•
&quot;Get assigned IPCMs for a domain (getAssignedIPCMs)&quot; (page 111)
•
&quot;Get IPCM capacity for domain (getIPCMCapacityByDomain)&quot; (page
111)
•
&quot;Remove Physical IPCM (deletePhysicalIPCM)&quot; (page 112)
Add a single IPCM (addIPCM)
BPT Method Syntax
addIPCM using ([Name of the IPCM,The IPCM Capacity,[[IPCM
capacity assigned to this Domain,Domain Name,Activation
Key], .. ,[IPCM capacity assigned to this Domain,Domain
Name,Activation Key]]]) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
BPT Required file format
[Name of the IPCM,The IPCM Capacity,[[IPCM capacity
assigned to this Domain,Domain Name,Activation Key],
.. ,[IPCM capacity assigned to this Domain,Domain
Name,Activation Key]]]
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
110 Methods for OPI and BPT
OPI method
public void addIPCM(com.nortelnetworks.ims.base.prov.opi.sh
ared.IPCM ipcm) throws java.rmi.RemoteException, com.nortel
networks.ims.base.prov.opi.shared.ProvisionException;
Modify a single IPCM (modifyIPCM)
BPT Method Syntax
modifyIPCM using (IPCM name,[Name of the IPCM,The IPCM
Capacity,[[IPCM capacity assigned to this Domain,Domain
Name,Activation Key], .. ,[IPCM capacity assigned to this
Domain,Domain Name,Activation Key]]]) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
IPCM name,[Name of the IPCM,The IPCM Capacity,[[IPCM
capacity assigned to this Domain,Domain Name,Activation
Key], .. ,[IPCM capacity assigned to this Domain,Domain
Name,Activation Key]]]
OPI method
public void modifyIPCM(java.lang.String ipcmName,
com.nortelnetworks.ims.base.prov.opi.shared.IPCM ipcm)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Get a single IPCM (getIPCM)
BPT Method Syntax
getIPCM using (IPCM name) | file &lt;file name&gt; [optional]
into &lt;file name&gt;
BPT Required file format
IPCM name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.IPCM
getIPCM(java.lang.String name) throws java.rmi.RemoteExcept
ion, com.nortelnetworks.ims.base.prov.opi.shared.Provisi
onException;
Remove a single IPCM (removeIPCM)
BPT Method Syntax
removeIPCM using (IPCM name) | file &lt;file name&gt; [optional]
into &lt;file name&gt;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
IPCM Operations 111
BPT Required file format
IPCM name
OPI method
public void removeIPCM(java.lang.String ipcm) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get available capacity for an IPCM (getIPCMAvailCapacity)
BPT Method Syntax
getIPCMAvailCapacity using (IPCM name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
IPCM name
OPI method
public int getIPCMAvailCapacity(java.lang.String name)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Get assigned IPCMs for a domain (getAssignedIPCMs)
BPT Method Syntax
getAssignedIPCMs using (Domain name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain Name
OPI method
public java.lang.String[] getAssignedIPCMs(java.lang.String
domain) throws java.rmi.RemoteException, com.nortelnetworks
.ims.base.prov.opi.shared.ProvisionException;
Get IPCM capacity for domain (getIPCMCapacityByDomain)
BPT Method Syntax
getIPCMCapacityByDomain using (IPCM name, Domain name) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
IPCM name, Domain name
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
112 Methods for OPI and BPT
OPI method
public int getIPCMCapacityByDomain(java.lang.String ipcm,
java.lang.String domain) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Remove Physical IPCM (deletePhysicalIPCM)
BPT Method Syntax
deletePhysicalIPCM using (Physical IPCM IP Address) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Physical IPCM IP Address
OPI method
public void deletePhysicalIPCM(java.lang.String ipAddress)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
User Operations
This section contains the following:
•
&quot;User Data Operations&quot; (page 113)
•
&quot;User Call Log Operations&quot; (page 117)
•
&quot;User Times Operations&quot; (page 119)
•
&quot;Route Operations&quot; (page 122)
•
&quot;User Service Operations&quot; (page 135)
•
&quot;User Meet Me Conferencing Operations&quot; (page 137)
•
&quot;User Watcher Operations&quot; (page 140)
•
User Unified Communications Operations (not supported by MCS 5100)
•
&quot;User Converged Desktop Operations&quot; (page 141)
•
&quot;User SIP Line Data Operations&quot; (page 144)
•
&quot;Assistant Support Operations&quot; (page 149)
•
&quot;User Search Operations&quot; (page 153)
•
&quot;User Management Operations&quot; (page 157)
•
&quot;User Voicemail Operations&quot; (page 167)
•
&quot;User Direct to Gateway Operations&quot; (page 168)
•
&quot;Logout all user contacts (sendUnRegister)&quot; (page 170)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Operations 113
•
&quot;Get clientRedirectServlet login authorization (getClientRedirectLogin)&quot;
(page 170)
User Data Operations
This section contains the following:
•
&quot;Modify subjects for a user (modifyUserSubjects)&quot; (page 113)
•
&quot;Remove all subjects for a user (removeAllCallSubjects)&quot; (page 113)
•
&quot;Get all subjects for a user (getSubjectsByUserName)&quot; (page 114)
•
&quot;Modify reasons for a user (modifyUserReasons)&quot; (page 114)
•
&quot;Remove all reasons for a user (removeAllRejectReasons)&quot; (page 114)
•
&quot;Get all reasons for a user (getRejectReasonsByUserName)&quot; (page 115)
•
&quot;Modify user data for a user (modifyUserData)&quot; (page 115)
•
&quot;Remove user data (removeUserData)&quot; (page 115)
•
&quot;Get user data for a user (getUserData)&quot; (page 116)
•
&quot;Modify presence notes for a user (modifyUserNotes)&quot; (page 116)
•
&quot;Remove all presence notes for a user (removeAllUserNotes)&quot; (page
116)
•
&quot;Get all presence notes for a user (getNotesByUserName)&quot; (page 117)
Modify subjects for a user (modifyUserSubjects)
BPT Method Syntax
modifyUserSubjects using (User name,[Subjects, .. ,
Subjects]) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name,[Subjects, ..
, Subjects]
OPI method
public void modifyUserSubjects(java.lang.String userName,
java.lang.String[] subjects) throws java.rmi.RemoteExcepti
on, com.nortelnetworks.ims.base.prov.opi.shared.ProvisionE
xception;
Remove all subjects for a user (removeAllCallSubjects)
BPT Method Syntax
removeAllCallSubjects using (User name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
114 Methods for OPI and BPT
User name
OPI method
public void removeAllCallSubjects(java.lang.String
userName) throws java.rmi.RemoteException, com.nortelnetwor
ks.ims.base.prov.opi.shared.ProvisionException;
Get all subjects for a user (getSubjectsByUserName)
BPT Method Syntax
getSubjectsByUserName using (User name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
User name
OPI method
public java.lang.String[] getSubjectsByUserName(java.lang.S
tring userName) throws java.rmi.RemoteException, com.nortel
networks.ims.base.prov.opi.shared.ProvisionException;
Modify reasons for a user (modifyUserReasons)
BPT Method Syntax
modifyUserReasons using (User name,[Reasons, .. ,
Reasons]) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name,[Reasons, ..
, Reasons]
OPI method
public void modifyUserReasons(java.lang.String userName,
java.lang.String[] reasons) throws java.rmi.RemoteExcept
ion, com.nortelnetworks.ims.base.prov.opi.shared.Provisi
onException;
Remove all reasons for a user (removeAllRejectReasons)
BPT Method Syntax
removeAllRejectReasons using (User name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
User name
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Operations 115
OPI method
public void removeAllRejectReasons(java.lang.String
userName) throws java.rmi.RemoteException, com.nortelnetwor
ks.ims.base.prov.opi.shared.ProvisionException;
Get all reasons for a user (getRejectReasonsByUserName)
BPT Method Syntax
getRejectReasonsByUserName using (User name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name
OPI method
public java.lang.String[] getRejectReasonsByUserName(java.l
ang.String userName) throws java.rmi.RemoteException, com.n
ortelnetworks.ims.base.prov.opi.shared.ProvisionException;
Modify user data for a user (modifyUserData)
BPT Method Syntax
modifyUserData using (User name,[[The subject information
for a user, ..,The subject information for a user],[The
reason information for a user, .. ,The reason information
for a user],[The presence notes information for a user, ..
,The presence notes information for a user]]) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name,[[The subject information for a user, ..,The
subject information for a user],[The reason information
for a user, .. ,The reason information for a user],[The
presence notes information for a user, .. ,The presence
notes information for a user]
OPI method
public void modifyUserData(java.lang.String userName,
com.nortelnetworks.ims.base.prov.opi.shared.UserData
userData) throws java.rmi.RemoteException, com.nortelnetwor
ks.ims.base.prov.opi.shared.ProvisionException;
Remove user data (removeUserData)
BPT Method Syntax
removeUserData using (User name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
116 Methods for OPI and BPT
BPT Required file format
User name
OPI method
public void removeUserData(java.lang.String userName)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Get user data for a user (getUserData)
BPT Method Syntax
getUserData using (User name) | file &lt;file name&gt; [optional]
into &lt;file name&gt;
BPT Required file format
User name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.UserData
getUserData(java.lang.StringuserName) throws java.rmi.Remot
eException, com.nortelnetworks.ims.base.prov.opi.shared.Pro
visionException;
Modify presence notes for a user (modifyUserNotes)
BPT Method Syntax
modifyUserNotes using (User name,[Notes, .. , Notes]) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name,[Notes, ..
, Notes]
OPI method
public void modifyUserNotes(java.lang.String userName,
java.lang.String[] notes) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Remove all presence notes for a user (removeAllUserNotes)
BPT Method Syntax
removeAllUserNotes using (User name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
User name
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Operations 117
OPI method
public void removeAllUserNotes(java.lang.String userName)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Get all presence notes for a user (getNotesByUserName)
BPT Method Syntax
getNotesByUserName using (User name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
User name
OPI method
public java.lang.String[] getNotesByUserName(java.lang.Stri
ng userName) throws java.rmi.RemoteException, com.nortelnet
works.ims.base.prov.opi.shared.ProvisionException;
User Call Log Operations
This section contains the following:
•
&quot;Get all user call logs (getCallLogs)&quot; (page 117)
•
&quot;Get all incoming user call logs (getIncomingCallLogs)&quot; (page 118)
•
&quot;Get all outgoing user call logs (getOutgoingCallLogs)&quot; (page 118)
•
&quot;Delete call logs with the provided call ids (deleteCallLogs)&quot; (page 118)
Get all user call logs (getCallLogs)
BPT Method Syntax
getCallLogs using (User name) | file &lt;file name&gt; [optional]
into &lt;file name&gt;
BPT Required file format
User name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Ca
llLog[] getCallLogs(java.lang.String username) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
118 Methods for OPI and BPT
Get all incoming user call logs (getIncomingCallLogs)
BPT Method Syntax
getIncomingCallLogs using (User name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
User name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.CallLog
[] getIncomingCallLogs(java.lang.String username) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get all outgoing user call logs (getOutgoingCallLogs)
BPT Method Syntax
getOutgoingCallLogs using (User name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
User name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.CallLog
[] getOutgoingCallLogs(java.lang.String username) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Delete call logs with the provided call ids (deleteCallLogs)
BPT Method Syntax
deleteCallLogs using (User name, [ Call ID, ..
| file &lt;file name&gt; [optional] into &lt;file name&gt;
, Call ID])
BPT Required file format
User name, [ Call ID, ..
, Call ID]
OPI method
public void deleteCallLogs(java.lang.String username, java
.lang.String[] callIds) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Operations 119
User Times Operations
This section contains the following:
•
&quot;Add a new Time Block Group for user (addTimeBlockGroup)&quot; (page
119)
•
&quot;Add Time Block Groups user (addTimeBlockGroups)&quot; (page 120)
•
&quot;Remove a Time Block Group for a user (removeTimeBlockGroup)&quot;
(page 120)
•
&quot;Remove all Time Block Groups for a user (removeTimeBlockGroups)&quot;
(page 121)
•
&quot;Modify Time Block Group for a user (modifyTimeBlockGroup)&quot; (page
121)
•
&quot;Retrieve a Time Block Group for user (getTimeBlockGroupByName)&quot;
(page 122)
•
&quot;Retrieve all Time Block Groups for user (getTimeBlockGroupsByUser)&quot;
(page 122)
Add a new Time Block Group for user (addTimeBlockGroup)
BPT Method Syntax
addTimeBlockGroup using (User name,[The name of the time
block for this user,[[The time that begins this time
block.,The time that ends this time block.,[The days of
the week that the time range applies., .. ,The days of
the week that the time range applies.]], .. ,[The time
that begins this time block.,The time that ends this time
block.,[The days of the week that the time range applies.,
.. ,The days of the week that the time range applies.]]]])
| file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name,[The name of the time block for this user,[[The
time that begins this time block.,The time that ends this
time block.,[The days of the week that the time range
applies, .. ,The days of the week that the time range
applies.]], .. ,[The time that begins this time block.,The
time that ends this time block.,[The days of the week that
the time range applies, .. ,The days of the week that the
time range applies.]]]]
OPI method
public void addTimeBlockGroup(java.lang.String userName,
com.nortelnetworks.ims.base.prov.opi.shared.TimeBlockGroup
timeBlockGrp) throws java.rmi.RemoteException, com.nortelne
tworks.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
120 Methods for OPI and BPT
Add Time Block Groups user (addTimeBlockGroups)
BPT Method Syntax
addTimeBlockGroups using (User name,[[The name of the
time block for this user,[[The time that begins this time
block.,The time that ends this time block.,[The days of
the week that the time range applies, .. ,The days of
the week that the time range applies.]], .. ,[The time
that begins this time block.,The time that ends this time
block.,[The days of the week that the time range applies,
.. ,The days of the week that the time range applies.]]]],
.. ,[The name of the time block for this user,[[The time
that begins this time block.,The time that ends this time
block.,[The days of the week that the time range applies,
.. ,The days of the week that the time range applies.]],
.. ,[The time that begins this time block.,The time that
ends this time block.,[The days of the week that the time
range applies, .. ,The days of the week that the time
range applies.]]]]]) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
BPT Required file format
User name,[[The name of the time block for this user,[[The
time that begins this time block.,The time that ends this
time block.,[The days of the week that the time range
applies, .. ,The days of the week that the time range
applies.]], .. ,[The time that begins this time block.,The
time that ends this time block.,[The days of the week that
the time range applies., .. ,The days of the week that the
time range applies.]]]], .. ,[The name of the time block
for this user,[[The time that begins this time block.,The
time that ends this time block.,[The days of the week that
the time range applies., .. ,The days of the week that the
time range applies.]], .. ,[The time that begins this time
block.,The time that ends this time block.,[The days of the
week that the time range applies., .. ,The days of the
week that the time range applies.]]]]]
OPI method
public void addTimeBlockGroups(java.lang.String userName,
com.nortelnetworks.ims.base.prov.opi.shared.TimeBlockGroup
[] timeBlockGrps) throws java.rmi.RemoteException, com.nort
elnetworks.ims.base.prov.opi.shared.ProvisionException;
Remove a Time Block Group for a user (removeTimeBlockGroup)
BPT Method Syntax
removeTimeBlockGroup using (User name, Time Block Group
name) | file &lt;file name&gt; [optional] into &lt;file name&gt;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Operations 121
BPT Required file format
User name, Time Block Group name
OPI method
public void removeTimeBlockGroup(java.lang.String
userName, java.lang.String timeBlockGrpName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Remove all Time Block Groups for a user (removeTimeBlockGroups)
BPT Method Syntax
removeTimeBlockGroups using (User name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
User name
OPI method
public void removeTimeBlockGroups(java.lang.String
userName) throws java.rmi.RemoteException, com.nortelnetwor
ks.ims.base.prov.opi.shared.ProvisionException;
Modify Time Block Group for a user (modifyTimeBlockGroup)
BPT Method Syntax
modifyTimeBlockGroup using (User name, Time Block Group
name,[The name of the time block for this user,[[The time
that begins this time block.,The time that ends this time
block.,[The days of the week that the time range applies.,
.. ,The days of the week that the time range applies.]],
.. ,[The time that begins this time block.,The time that
ends this time block.,[The days of the week that the time
range applies., .. ,The days of the week that the time
range applies.]]]]) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
BPT Required file format
User name, Time Block Group name,[The name of the time
block for this user,[[The time that begins this time
block.,The time that ends this time block.,[The days of
the week that the time range applies., .. ,The days of
the week that the time range applies.]], .. ,[The time
that begins this time block.,The time that ends this time
block.,[The days of the week that the time range applies.,
.. ,The days of the week that the time range applies.]]]]
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
122 Methods for OPI and BPT
OPI method
public void modifyTimeBlockGroup(java.lang.String userName,
java.lang.String timeBlockGrpName, com.nortelnetworks.ims.b
ase.prov.opi.shared.TimeBlockGroup timeBlockGroup) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Retrieve a Time Block Group for user (getTimeBlockGroupByName)
BPT Method Syntax
getTimeBlockGroupByName using (User name, Time Block Group
name) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name, Time Block Group name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Ti
meBlockGroup getTimeBlockGroupByName(java.lang.String
userName, java.lang.String timeBlockGrpName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Retrieve all Time Block Groups for user (getTimeBlockGroupsByUser)
BPT Method Syntax
getTimeBlockGroupsByUser using (User name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Time
BlockGroup[] getTimeBlockGroupsByUser(java.lang.String
userName) throws java.rmi.RemoteException, com.nortelnetwor
ks.ims.base.prov.opi.shared.ProvisionException;
Route Operations
This section contains the following:
•
&quot;Activate routes for a user (activateRoutes)&quot; (page 123)
•
&quot;Add a new route for a user (addRoute)&quot; (page 124)
•
&quot;Add multiple routes for a user (addRoutes)&quot; (page 125)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Operations 123
•
&quot;Deactivate routes for a user (deactivateRoutes)&quot; (page 128)
•
&quot;Retrieve a particular route for a user (getRoute)&quot; (page 129)
•
&quot;Retrieve all route parameter names (getAllRouteParmNames)&quot; (page
129)
•
&quot;Retrieve all route names for a user (getRouteNames)&quot; (page 129)
•
&quot;Retrieve all routes for a user (getRoutes)&quot; (page 130)
•
&quot;Modify a route for a user (modifyRoute)&quot; (page 130)
•
&quot;Remove all routes for a user (removeAllRoutes)&quot; (page 132)
•
&quot;Remove all static routes for a user (removeAllStaticRoutes)&quot; (page 132)
•
&quot;Get static routes for a user (getStaticRoutesByUserName)&quot; (page 132)
•
&quot;Modify user static routes for a user (modifyUserStaticRoutes)&quot; (page
133)
•
&quot;Add static routes for a user (addUserStaticRoutes)&quot; (page 133)
•
&quot;Remove a particular route for a user (removeRoute)&quot; (page 133)
•
&quot;Reorder routes for a user (reorderRoutes)&quot; (page 134)
•
&quot;Set routes to active for a user (setActiveRoutes)&quot; (page 134)
•
&quot;Generate CPL for a user (generateCPL)&quot; (page 134)
•
&quot;Get CPL for a user (getCPL)&quot; (page 135)
•
Set Ringtone—not supported in MCS 5100 Release 4.0
•
Remove Ringtone—not supported in MCS 5100 Release 4.0
•
Get Ringtone—not supported in MCS 5100 Release 4.0
Activate routes for a user (activateRoutes)
BPT Method Syntax
activateRoutes using (User name,[Route Names list, .. ,
Route Names list]) | file &lt;file name&gt; [optional] into &lt;file
name&gt;
BPT Required file format
User name,[Route Names list, ..
, Route Names list]
OPI method
public void activateRoutes(java.lang.String userName, java
.lang.String[] routeNames) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
124 Methods for OPI and BPT
Add a new route for a user (addRoute)
BPT Method Syntax
addRoute using (User name,[The name of a route defined
by this user,Specify if this particular route is active
or inactive,[The set of actions that would trigger this
route, .. ,The set of actions that would trigger this
route],[[The type of route condition or exception,[The
values associated with this condition or exception, ..
,The values associated with this condition or exception]],
.. ,[The type of route condition or exception,[The values
associated with this condition or exception, .. ,The
values associated with this condition or exception]]],
[[The type of route condition or exception,[The values
associated with this condition or exception, .. ,The
values associated with this condition or exception]],
.. ,[The type of route condition or exception,[The
values associated with this condition or exception,
.. ,The values associated with this condition or
exception]]],[Name,[[The number of times that the
destination will ring before another call route is chosen
for this user,[The different routes that are there in a
user’s call manager routelist, .. ,The different routes
that are there in a user’s call manager routelist],
The instant message to be sent out on termination
to this route.,The web page url to be pushed out on
termination to this route,The ring back tone associated
to this route that callers hear], .. ,[The number of
times that the destination will ring before another
call route is chosen for this user,[The different routes
that are there in a user’s call manager routelist, ..
,The different routes that are there in a user’s call
manager routelist],The instant message to be sent out
on termination to this route.,The web page url to be
pushed out on termination to this route,The ring back
tone associated to this route that callers hear]]]
-or- [Name,[[Name,Value], .. ,[Name,Value]]]]) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name,[The name of a route defined by this user,Specify
if this particular route is active or inactive,[The set
of actions that would trigger this route, .. ,The set of
actions that would trigger this route],[[The type of route
condition or exception,[The values associated with this
condition or exception, .. ,The values associated with
this condition or exception]], .. ,[The type of route
condition or exception,[The values associated with this
condition or exception, .. ,
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Operations 125
The values associated with this condition or excepti
on]]],[[The type of route condition or exception,[The
values associated with this condition or exception,
.. ,The values associated with this condition or
exception]], .. ,[The type of route condition or
exception,[The values associated with this condition or
exception, .. ,The values associated with this condition
or exception]]],[Name,[[The number of times that the
destination will ring before another call route is chosen
for this user,[The different routes that are there in a
user’s call manager routelist, .. ,
The different routes that are there in a user’s call
manager routelist],The instant message to be sent out
on termination to this route.,The web page url to be
pushed out on termination to this route,The ring back
tone associated to this route that callers hear], ..
,[The number of times that the destination will ring
before another call route is chosen for this user,[The
different routes that are there in a user’s call manager
routelist, .. ,The different routes that are there in a
user’s call manager routelist],The instant message to be
sent out on termination to this route.,The web page url
to be pushed out on termination to this route,The ring
back tone associated to this route that callers hear]]]
-or- [Name,[[Name,Value], .. ,[Name,Value]]]]
OPI method
public void addRoute(java.lang.String userName,
com.nortelnetworks.ims.base.prov.opi.shared.Route route)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Add multiple routes for a user (addRoutes)
BPT Method Syntax
addRoutes using (User name,[[The name of a route defined
by this user,Specify if this particular route is active
or inactive,[The set of actions that would trigger this
route, .. ,The set of actions that would trigger this
route],[[The type of route condition or exception,[The
values associated with this condition or exception, ..
,The values associated with this condition or exception]],
.. ,[The type of route condition or exception,[The values
associated with this condition or exception, .. ,The
values associated with this condition or exception]]],[[The
type of route condition or exception,[The values associated
with this condition or exception, .. ,
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
126 Methods for OPI and BPT
The values associated with this condition or exception]],
.. ,[The type of route condition or exception,[The values
associated with this condition or exception, .. ,The values
associated with this condition or exception]]],[Name,[[The
number of times that the destination will ring before
another call route is chosen for this user,[The different
routes that are there in a user’s call manager routelist,
.. ,The different routes that are there in a user’s call
manager routelist],The instant message to be sent out
on termination to this route.,The web page url to be
pushed out on termination to this route,The ring back
tone associated to this route that callers hear], ..
,[The number of times that the destination will ring
before another call route is chosen for this user,[The
different routes that are there in a user’s call manager
routelist, .. ,The different routes that are there in a
user’s call manager routelist],The instant message to
be sent out on termination to this route.,
The web page url to be pushed out on termination to
this route,The ring back tone associated to this route
that callers hear]]] -or- [Name,[[Name,Value], ..
,[Name,Value]]]], .. ,[The name of a route defined by
this user,Specify if this particular route is active
or inactive,[The set of actions that would trigger this
route, .. ,The set of actions that would trigger this
route],[[The type of route condition or exception,[The
values associated with this condition or exception, .. ,The
values associated with this condition or exception]], ..
,[The type of route condition or exception,[The values
associated with this condition or exception, .. ,The values
associated with this condition or exception]]],[[The type
of route condition or exception,[The values associated with
this condition or exception, .. ,The values associated
with this condition or exception]], .. ,[The type of
route condition or exception,[The values associated
with this condition or exception, .. ,
The values associated with this condition or
exception]]],[Name,[[The number of times that the
destination will ring before another call route is chosen
for this user,[The different routes that are there in a
user’s call manager routelist, .. ,The different routes
that are there in a user’s call manager routelist],The
instant message to be sent out on termination to this
route.,The web page url to be pushed out on termination
to this route,The ring back tone associated to this
route that callers hear], .. ,[The number of times
that the destination will ring before another call
route is chosen for this user,[The different routes
that are there in a user’s call manager routelist, ..
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Operations 127
,The different routes that are there in a user’s call
manager routelist],The instant message to be sent out
on termination to this route.,The web page url to be
pushed out on termination to this route,The ring back
tone associated to this route that callers hear]]]
-or- [Name,[[Name,Value], .. ,[Name,Value]]]]]) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name,[[The name of a route defined by this
user,Specify if this particular route is active or
inactive,[The set of actions that would trigger this
route, .. ,The set of actions that would trigger this
route],[[The type of route condition or exception,[The
values associated with this condition or exception, ..
,The values associated with this condition or exception]],
.. ,[The type of route condition or exception,[The values
associated with this condition or exception, .. ,The
values associated with this condition or exception]]],[[The
type of route condition or exception,[The values associated
with this condition or exception, .. ,The values
associated with this condition or exception]], .. ,[The
type of route condition or exception,[The values associated
with this condition or exception, .. ,The values
associated with this condition or exception]]],[Name,[[The
number of times that the destination will ring before
another call route is chosen for this user,[The different
routes that are there in a user’s call manager routelist,
.. ,
The different routes that are there in a user’s call
manager routelist],The instant message to be sent out
on termination to this route.,The web page url to be
pushed out on termination to this route,The ring back
tone associated to this route that callers hear], ..
,[The number of times that the destination will ring
before another call route is chosen for this user,[The
different routes that are there in a user’s call manager
routelist, .. ,The different routes that are there in a
user’s call manager routelist],The instant message to
be sent out on termination to this route.,The web page
url to be pushed out on termination to this route,The
ring back tone associated to this route that callers
hear]]] -or- [Name,[[Name,Value], .. ,[Name,Value]]]],
.. ,[The name of a route defined by this user,Specify if
this particular route is active or inactive,[The set of
actions that would trigger this route, .. ,
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
128 Methods for OPI and BPT
The set of actions that would trigger this route],[[The
type of route condition or exception,[The values associated
with this condition or exception, .. ,The values
associated with this condition or exception]], .. ,[The
type of route condition or exception,[The values associated
with this condition or exception, .. ,The values
associated with this condition or exception]]],[[The type
of route condition or exception,[The values associated with
this condition or exception, .. ,The values associated
with this condition or exception]], .. ,[The type of route
condition or exception,[The values associated with this
condition or exception, .. ,The values associated with
this condition or exception]]],[Name,[[The number of times
that the destination will ring before another call route is
chosen for this user,[The different routes that are there
in a user’s call manager routelist, .. ,
The different routes that are there in a user’s call
manager routelist],The instant message to be sent out
on termination to this route.,The web page url to be
pushed out on termination to this route,The ring back
tone associated to this route that callers hear], ..
,[The number of times that the destination will ring
before another call route is chosen for this user,[The
different routes that are there in a user’s call manager
routelist, .. ,The different routes that are there in a
user’s call manager routelist],The instant message to be
sent out on termination to this route.,The web page url
to be pushed out on termination to this route,The ring
back tone associated to this route that callers hear]]]
-or- [Name,[[Name,Value], .. ,[Name,Value]]]]]
OPI method
public void addRoutes(java.lang.String userName,
com.nortelnetworks.ims.base.prov.opi.shared.Route[] routes)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Deactivate routes for a user (deactivateRoutes)
BPT Method Syntax
deactivateRoutes using (User name,[ Route Names list, .. ,
Route Names list]) | file &lt;file name&gt; [optional] into &lt;file
name&gt;
BPT Required file format
User name,[ Route Names list, ..
, Route Names list]
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Operations 129
OPI method
public void deactivateRoutes(java.lang.String userName,
java.lang.String[] routeNames) throws java.rmi.RemoteExcept
ion, com.nortelnetworks.ims.base.prov.opi.shared.Provisi
onException;
Retrieve a particular route for a user (getRoute)
BPT Method Syntax
getRoute using (User name, Route Name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
User name, Route Name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Route
getRoute(java.lang.String userName, java.lang.String
routeName) throws java.rmi.RemoteException, com.nortelnetwo
rks.ims.base.prov.opi.shared.ProvisionException;
Retrieve all route parameter names (getAllRouteParmNames)
BPT Method Syntax
getAllRouteParmNames [optional] | file &lt;file name&gt;
[optional] into &lt;file name&gt;
OPI method
public java.lang.String[] getAllRouteParmNames() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Retrieve all route names for a user (getRouteNames)
BPT Method Syntax
getRouteNames using (User name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
User name
OPI method
public java.lang.String[] getRouteNames(java.lang.String
userName) throws java.rmi.RemoteException, com.nortelnetwor
ks.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
130 Methods for OPI and BPT
Retrieve all routes for a user (getRoutes)
BPT Method Syntax
getRoutes using (User name) | file &lt;file name&gt; [optional]
into &lt;file name&gt;
BPT Required file format
User name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Route[]
getRoutes(java.lang.String userName) throws java.rmi.Remote
Exception, com.nortelnetworks.ims.base.prov.opi.shared.Pro
visionException;
Modify a route for a user (modifyRoute)
BPT Method Syntax
modifyRoute using (User name, Route Name,[The name of a
route defined by this user,Specify if this particular
route is active or inactive,[The set of actions that
would trigger this route, .. ,The set of actions that
would trigger this route],[[The type of route condition or
exception,[The values associated with this condition or
exception, .. ,The values associated with this condition
or exception]], .. ,[The type of route condition or
exception,[The values associated with this condition or
exception, .. ,
The values associated with this condition or excepti
on]]],[[The type of route condition or exception,[The
values associated with this condition or exception,
.. ,The values associated with this condition or
exception]], .. ,[The type of route condition or
exception,[The values associated with this condition or
exception, .. ,The values associated with this condition
or exception]]],[Name,[[The number of times that the
destination will ring before another call route is chosen
for this user,[The different routes that are there in a
user’s call manager routelist, .. ,
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Operations 131
The different routes that are there in a user’s call
manager routelist],The instant message to be sent out
on termination to this route.,The web page url to be
pushed out on termination to this route], .. ,[The
number of times that the destination will ring before
another call route is chosen for this user,[The different
routes that are there in a user’s call manager routelist,
.. ,The different routes that are there in a user’s
call manager routelist],The instant message to be sent
out on termination to this route.,The web page url
to be pushed out on termination to this route]]] -or[Name,[[Name,Value], .. ,[Name,Value]]]]) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name, Route Name,[The name of a route defined by
this user,Specify if this particular route is active
or inactive,[The set of actions that would trigger this
route, .. ,The set of actions that would trigger this
route],[[The type of route condition or exception,[The
values associated with this condition or exception, ..
,The values associated with this condition or exception]],
.. ,
[The type of route condition or exception,[The values
associated with this condition or exception, .. ,The
values associated with this condition or exception]]],[[The
type of route condition or exception,[The values associated
with this condition or exception, .. ,The values
associated with this condition or exception]], .. ,[The
type of route condition or exception,[The values associated
with this condition or exception, .. ,The values
associated with this condition or exception]]],[Name,[[The
number of times that the destination will ring before
another call route is chosen for this user,[The different
routes that are there in a user’s call manager routelist,
.. ,
The different routes that are there in a user’s call
manager routelist],The instant message to be sent out
on termination to this route.,The web page url to be
pushed out on termination to this route], .. ,[The
number of times that the destination will ring before
another call route is chosen for this user,[The different
routes that are there in a user’s call manager route
list, .. ,The different routes that are there in a
user’s call manager routelist],The instant message to be
sent out on termination to this route.,The web page url
to be pushed out on termination to this route]]] -or[Name,[[Name,Value], .. ,[Name,Value]]]]
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
132 Methods for OPI and BPT
OPI method
Remove all routes for a user (removeAllRoutes)
BPT Method Syntax
removeAllRoutes using (User name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
User name
OPI method
public void modifyRoute(java.lang.String userName,
java.lang.String routeName, com.nortelnetworks.i
ms.base.prov.opi.shared.Route newRoute) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Remove all static routes for a user (removeAllStaticRoutes)
BPT Method Syntax
removeAllStaticRoutes using (User name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
User name
OPI method
public void removeAllStaticRoutes(java.lang.String
userName) throws java.rmi.RemoteException, com.nortelnetwor
ks.ims.base.prov.opi.shared.ProvisionException;
Get static routes for a user (getStaticRoutesByUserName)
BPT Method Syntax
getStaticRoutesByUserName using (User name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name
OPI method
public java.lang.String[] getStaticRoutesByUserName(java.la
ng.String userName) throws java.rmi.RemoteException, com.no
rtelnetworks.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Operations 133
Modify static routes for a user (modifyUserStaticRoutes)
BPT Method Syntax
modifyUserStaticRoutes using (User name,[ Route name, ..
Route name&gt; [optional] into &lt;file name&gt;
,
BPT Required file format
User name,[ Route name, ..
, Route name]
OPI method
public void modifyUserStaticRoutes(java.lang.String
userName, java.lang.String[] routes) throws java.rmi.Remote
Exception, com.nortelnetworks.ims.base.prov.opi.shared.Pro
visionException;
Add static routes for a user (addUserStaticRoutes)
BPT Method Syntax
addUserStaticRoutes using (User name,[ Route name, .. ,
Route name]) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name,[ Route name, ..
, Route name]
OPI method
public void addUserStaticRoutes(java.lang.String userName,
java.lang.String[] routes) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Remove a particular route for a user (removeRoute)
BPT Method Syntax
removeRoute using (User name, Route Name) | file &lt;file
name&gt; [optional] into &lt;filename&gt;
BPT Required file format
User name, Route Name
OPI method
public void removeRoute(java.lang.String userName, java.lan
g.String routeName) throws java.rmi.RemoteException, com.no
rtelnetworks.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
134 Methods for OPI and BPT
Reorder routes for a user (reorderRoutes)
BPT Method Syntax
reorderRoutes using (User name,[Route names list, .. ,
Route names list]) | file &lt;file name&gt; [optional] into &lt;file
name&gt;
BPT Required file format
User name,[Route names list, ..
, Route names list]
OPI method
public void reorderRoutes(java.lang.String userName, java.l
ang.String[] routeNames) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Set routes to active for a user (setActiveRoutes)
BPT Method Syntax
setActiveRoutes using (User name,[Route names list, .. ,
Route names list]) | file &lt;file name&gt; [optional] into &lt;file
name&gt;
BPT Required file format
User name,[Route names list, ..
, Route names list]
OPI method
public void setActiveRoutes(java.lang.String userName, java
.lang.String[] routeNames) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Generate CPL for a user (generateCPL)
CPL is Call Processing Language, and is documented in Session Manager
Fundamentals (NN42020-107).
BPT Method Syntax
generateCPL using (User name) | file &lt;file name&gt; [optional]
into &lt;file name&gt;
BPT Required file format
User name
OPI method
public void generateCPL(java.lang.String userName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Operations 135
Get CPL for a user (getCPL)
BPT Method Syntax
getCPL using (User name) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
BPT Required file format
User name
OPI method
public java.lang.String getCPL(java.lang.String userName)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
User Service Operations
This section contains the following:
•
&quot;Get Users Service Package (getUserServicePackage)&quot; (page 135)
•
&quot;Get all user preferences (getAllUserPreferences)&quot; (page 136)
•
&quot;Get all detailed user preferences (getAllDetailedUserPreferences)&quot;
(page 136)
•
&quot;Modify Preference for a service for a user (modifyUserPreferences)&quot;
(page 136)
•
&quot;Modify all preferences for a user (modifyAllUserPreferences)&quot; (page
137)
•
&quot;Remove all preferences for a user (removeAllUserPreferences)&quot; (page
137)
Get Users Service Package (getUserServicePackage)
BPT Method Syntax
getUserServicePackage using (User name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
userName
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Service
Package getUserServicePackage(java.lang.String userName)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
136 Methods for OPI and BPT
Get all user preferences (getAllUserPreferences)
BPT Method Syntax
getAllUserPreferences using (User name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
userName
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Service
[] getAllUserPreferences(java.lang.String userName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get all detailed user preferences (getAllDetailedUserPreferences)
BPT Method Syntax
getAllDetailedUserPreferences using (User name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
userName
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Detailed
Service[] getAllDetailedUserPreferences(java.lang.String
userName) throws java.rmi.RemoteException, com.nortelnetwor
ks.ims.base.prov.opi.shared.ProvisionException;
Modify Preference for a service for a user (modifyUserPreferences)
BPT Method Syntax
modifyUserPreferences using (User name,xxx) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Username, Service data
OPI method
public void modifyUserPreferences(java.lang.String userN
ame, com.nortelnetworks.ims.base.prov.opi.shared.Service
service) throws java.rmi.RemoteException, com.nortelnetwork
s.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Operations 137
Modify all preferences for a user (modifyAllUserPreferences)
BPT Method Syntax
modifyAllUserPreferences using (Username,[[name of the
service,[[Name,Value], .. ,[Name,Value]]], .. ,[Name of
the service,[[Name,Value], .. ,[Name,Value]]]]) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Username,[[name of the service,[[Name,Value], ..
,[Name,Value]]], .. ,[Name of the service,[[Name,Value],
.. ,[Name,Value]]]]
OPI method
public void modifyAllUserPreferences(java.lang.String userN
ame, com.nortelnetworks.ims.base.prov.opi.shared.Service[]
services) throws java.rmi.RemoteException, com.nortelnetwor
ks.ims.base.prov.opi.shared.ProvisionException;
Remove all preferences for a user (removeAllUserPreferences)
BPT Method Syntax
removeAllUserPreferences using (Username) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Username
OPI method
public void removeAllUserPreferences(java.lang.String
userName) throws java.rmi.RemoteException, com.nortelnetwor
ks.ims.base.prov.opi.shared.ProvisionException;
User Meet Me Conferencing Operations
This section contains the following:
•
&quot;Add Meet Me Conferencing data for a user (addMeetMeConfUser)&quot;
(page 138)
•
&quot;Modify Meet Me Conferencing data for a user (modifyMeetMeConfUser)&quot;
(page 138)
•
&quot;Remove Meet Me Conferencing data for a user (removeMeetMeConfUser)&quot; (page 139)
•
&quot;Get Meet Me Conferencing data for a user (getMeetMeConfData)&quot;
(page 139)
•
&quot;Get Meet Me Conferencing data for a domain (getMeetMeConfDataByDomain)&quot; (page 140)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
138 Methods for OPI and BPT
•
&quot;Get Users with no Meet Me Conferencing data, for a domain
(getUsersWithNoMeetMeData)&quot; (page 140)
Add Meet Me Conferencing data for a user (addMeetMeConfUser)
BPT Method Syntax
addMeetMeConfUser using (User name,[Denotes whether the
user is an active or inactive Meet Me user,4-10 digit
unique numeric access code,4-10 digit numeric random chair
pin,Denotes whether conf ends when the chair leaves,Denotes
whether conf can start w/o the chair Reserved for future
use.,4-10 digit numeric random public pin Reserved for
future use.]) | file &lt;file name&gt; [optional] into &lt;file
name&gt;
BPT Required file format
User name,[Denotes whether the user is an active or
inactive Meet Me user,4-10 digit unique numeric access
code,4-10 digit numeric random chair pin,Denotes whether
conf ends when the chair leaves,Denotes whether conf can
start w/o the chair Reserved for future use.,4-10 digit
numeric random public pin Reserved for future use.]
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Meet
MeConfData addMeetMeConfUser(java.lang.String userName,
com.nortelnetworks.ims.base.prov.opi.shared.MeetMeConfData
meetmeConfData) throws java.rmi.RemoteException, com.nortel
networks.ims.base.prov.opi.shared.ProvisionException;
Modify Meet Me Conferencing data for a user (modifyMeetMeConfUser)
BPT Method Syntax
modifyMeetMeConfUser using (User name,[Denotes whether
the user is an active or inactive Meet Me user,4-10
digit unique numeric access code,4-10 digit numeric
random chair pin,Denotes whether conf ends when the
chair leaves,Denotes whether Instant Messaging is
enabled or not,Denotes whether conf can start without
the chair. Reserved for future use.,4-10 digit numeric
random public pin. Reserved for future use.,Play an
audible tone when participants enter and leave my
conference(tones/none),Allow AudioEmot Icons for this
user’s conferences (true/false).,E-mail address where
recorded conferences will be sent.]) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Operations 139
User name,[Denotes whether the user is an active or
inactive Meet Me user,4-10 digit unique numeric access
code,4-10 digit numeric random chair pin,Denotes whether
conf ends when the chair leaves,Denotes whether Instant
Messaging is enabled or not,Denotes whether conf can
start without the chair. Reserved for future use.,4-10
digit numeric random public pin. Reserved for future
use.,Play an audible tone when participants enter and
leave my conference(tones/none),Allow AudioEmot Icons for
this user’s conferences (true/false).,E-mail address
where recorded conferences will be sent.]
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.MeetMe
ConfData modifyMeetMeConfUser(java.lang.String userName,
com.nortelnetworks.ims.base.prov.opi.shared.MeetMeConfData
meetmeConfData) throws java.rmi.RemoteException, com.nortel
networks.ims.base.prov.opi.shared.ProvisionException;
Remove Meet Me Conferencing data for a user (removeMeetMeConfUser)
BPT Method Syntax
removeMeetMeConfUser using (User name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
User name
OPI method
public void removeMeetMeConfUser(java.lang.String userName)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Get Meet Me Conferencing data for a user (getMeetMeConfData)
BPT Method Syntax
getMeetMeConfData using (User name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
User name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.MeetMeCo
nfData getMeetMeConfData(java.lang.String userName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
140 Methods for OPI and BPT
Get Meet Me Conferencing data for a domain (getMeetMeConfDataByDomain)
BPT Method Syntax
getMeetMeConfDataByDomain using (Domain name, start, stop)
| file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, start, stop
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.MeetMeCo
nfData[] getMeetMeConfDataByDomain(java.lang.String domain
Name, int start, int end) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Get Users with no Meet Me Conferencing data, for a domain
(getUsersWithNoMeetMeData)
BPT Method Syntax
getUsersWithNoMeetMeData using (Domain name, start, stop) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, start, stop
OPI method
public java.lang.String[] getUsersWithNoMeetMeData(ja
va.lang.String domainName, int start, int end) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
User Watcher Operations
This section contains the following:
•
&quot;Get user watchers list (getUserWatchers)&quot; (page 140)
•
&quot;Get user presence (getUserPresence)&quot; (page 141)
Get user watchers list (getUserWatchers)
BPT Method Syntax
getUserWatchers using (UserName) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
UserName
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Operations 141
OPI method
Get user presence (getUserPresence)
BPT Method Syntax
getUserPresence using (User name, requested username) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
userName, requested username
OPI method
User Converged Desktop Operations
This section contains the following:
•
&quot;Add Converged Desktop data for a user (addConvDesktopUserData)&quot;
(page 141)
•
&quot;Modify Converged Desktop data for a user (modifyConvDesktopUserData)&quot; (page 142)
•
&quot;Remove Converged Desktop data for a user (removeConvDesktopUserData)&quot; (page 142)
•
&quot;Get Converged Desktop data for a user (getConvDesktopUserData)&quot;
(page 143)
•
&quot;Add Mobile converged audio device prefix for a user
(assignUserMCPrefixData)&quot; (page 143)
•
&quot;Get Mobile converged audio device prefix for a user
(getUserMCPrefixData)&quot; (page 143)
•
&quot;Remove Mobile converged audio device prefix for a user
(removeUserMCPrefixData)&quot; (page 144)
Add Converged Desktop data for a user (addConvDesktopUserData)
BPT Method Syntax
addConvDesktopUserData using (User name,[User Alias is a
digit string alias,The digits required to route the call
to this private preferred device,Network IN serving this
user, either USP or M1]) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
BPT Required file format
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
142 Methods for OPI and BPT
User name,[User Alias is a digit string alias,The digits
required to route the call to this preferred device,Network
IN serving this user, either USP or M1]
OPI method
public void addConvDesktopUserData(java.lang.String
userName, com.nortelnetworks.ims.base.prov.opi.shared.ConvD
esktopUser blenderData) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Modify Converged Desktop data for a user (modifyConvDesktopUserData)
BPT Method Syntax
modifyConvDesktopUserData using (User name,[User Alias is a
digit string alias,The digits required to route the call to
this preferred device,Network IN serving this user, either
USP or M1,Whether Click To Dial is Enabled) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name,[User Alias is a digit string alias,The digits
required to route the call to this preferred device,Network
IN serving this user, either USP or M1,Whether Click To
Dial is Enabled]
OPI method
public void modifyConvDesktopUserData(java.lang.String
userName, com.nortelnetworks.ims.base.prov.opi.shared.ConvD
esktopUser newData) throws java.rmi.RemoteException, com.no
rtelnetworks.ims.base.prov.opi.shared.ProvisionException;
Remove Converged Desktop data for a user (removeConvDesktopUserData)
BPT Method Syntax
removeConvDesktopUserData using (User name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name
OPI method
public void removeConvDesktopUserData(java.lang.String
userName) throws java.rmi.RemoteException, com.nortelnetwor
ks.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Operations 143
Get Converged Desktop data for a user (getConvDesktopUserData)
BPT Method Syntax
getConvDesktopUserData using (User name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
User name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.ConvDes
ktopUser getConvDesktopUserData(java.lang.String userName)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Add Mobile converged audio device prefix for a user
(assignUserMCPrefixData)
BPT Method Syntax
assignUserMCPrefixData using (User name, Prefix) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
userName, Prefix
OPI method
public void assignUserMCPrefixData(java.lang.String
username, java.lang.String userPrefixData) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get Mobile converged audio device prefix for a user
(getUserMCPrefixData)
BPT Method Syntax
getUserMCPrefixData using (User name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
userName
OPI method
public java.lang.String getUserMCPrefixData(java.lang.Strin
g username) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
144 Methods for OPI and BPT
Remove Mobile converged audio device prefix for a user
(removeUserMCPrefixData)
BPT Method Syntax
removeUserMCPrefixData using (User name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
userName
OPI method
public void removeUserMCPrefixData(java.lang.String
username) throws java.rmi.RemoteException, com.nortelnetwor
ks.ims.base.prov.opi.shared.ProvisionException;
User SIP Line Data Operations
This section contains the following:
•
&quot;Client Type Information&quot; (page 144)
•
&quot;Set SIP Line Data (setSIPLineData)&quot; (page 147)
•
&quot;Get SIP Line Data (getSIPLineData)&quot; (page 147)
•
&quot;Get SIP Line Data for a user by user name (getSIPLineDataByUserName)&quot; (page 148)
•
&quot;Get SIP Line Data by domain (getSIPLineDataByDomain)&quot; (page 148)
•
&quot;Get SIP Line Audit Data By Domain And VMG (getSIPLineAuditDataByDomainByVMG)&quot; (page 303)
•
&quot;Get username by End Point Id (getUserByEndPointId)&quot; (page 149)
•
&quot;Remove SIP Line data for a user (removeSIPLineData)&quot; (page 149)
Client Type Information
This section contains the following:
•
&quot;Add a Client Type (addClientType)&quot; (page 144)
•
&quot;Add multiple Client Types (addClientTypes)&quot; (page 145)
•
&quot;Modify a Client Type (modifyClientType)&quot; (page 145)
•
&quot;Remove a Client Type (removeClientType)&quot; (page 146)
•
&quot;Get All Client Types (getClientTypes)&quot; (page 146)
•
&quot;Get a Client Type by name (getClientTypeByName)&quot; (page 146)
Add a Client Type (addClientType)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Operations 145
BPT Method Syntax
addClientType
be associated
client, Gives
dynamic one])
name&gt;
using ([The name of the client which can
to the user,Description about the type of
information if the client is a static or a
| file &lt;file name&gt; [optional] into &lt;file
BPT Required file format
[The name of the client which can be associated to
the user,Description about the type of client, Gives
information if the client is a static or a dynamic one]
OPI method
public void addClientType(com.nortelnetworks.ims.b
ase.prov.opi.shared.ClientType clientType) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Add multiple Client Types (addClientTypes)
BPT Method Syntax
addClientTypes using ([[The name of the client which can
be associated to the user,Description about the type of
client, Gives information if the client is a static or
a dynamic one],.. ,[The name of the client which can
be associated to the user,Description about the type of
client, Gives information if the client is a static or a
dynamic one]]) | file &lt;file name&gt; [optional] into &lt;file
name&gt;
BPT Required file format
[The name of the client which can be associated to
the user,Description about the type of client, Gives
information if the client is a static or a dynamic one]
OPI method
public void addClientTypes(com.nortelnetworks.ims.ba
se.prov.opi.shared.ClientType[] clientTypes) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Modify a Client Type (modifyClientType)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
146 Methods for OPI and BPT
BPT Method Syntax
modifyClientType using (Client Type Name, [The name of the
client which can be associated to the user,Description
about the type of client, Gives information if the
client is a static or a dynamic one]) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Client Type Name, [The name of the client which can be
associated to the user,Description about the type of
client, Gives information if the client is a static or a
dynamic one]
OPI method
public void modifyClientType(java.lang.String clientTypeNa
me, com.nortelnetworks.ims.base.prov.opi.shared.ClientType
clientType) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Remove a Client Type (removeClientType)
BPT Method Syntax
removeClientType using (Client Type Name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Client Type Name
OPI method
public void removeClientType(java.lang.String clientType)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Get All Client Types (getClientTypes)
BPT Method Syntax
getClientTypes [optional] into &lt;file name&gt;
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Client
Type[] getClientTypes() throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Get a Client Type by name (getClientTypeByName)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Operations 147
BPT Method Syntax
getClientTypeByName using (clientType) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
clientType
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.ClientTy
pe getClientTypeByName(java.lang.String clientType) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Set SIP Line Data (setSIPLineData)
BPT Method Syntax
setSIPLineData using (User name, [The End Point Id
associated to the user, The virtual media gateway
associated to the user,[ The type of client associated to
the user , .. , The type of client associated to the user
]]) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name, [The End Point Id associated to the user, The
virtual media gateway associated to the user,[ The type of
client associated to the user , .. , The type of client
associated to the user ]]
OPI method
public void setSIPLineData(java.lang.String userName,
com.nortelnetworks.ims.base.prov.opi.shared.SIPLineData
sipLineData) throws java.rmi.RemoteException, com.nortelnet
works.ims.base.prov.opi.shared.ProvisionException;
Get SIP Line Data (getSIPLineData)
BPT Method Syntax
getSIPLineData using (End Point Id) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
End Point Id
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.SIPLin
eData getSIPLineData(java.lang.String endPointId) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
148 Methods for OPI and BPT
Get SIP Line Data for a user by user name (getSIPLineDataByUserName)
BPT Method Syntax
getSIPLineDataByUserName using (User name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
userName
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.SIPLine
Data getSIPLineDataByUserName(java.lang.String userName)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Get SIP Line Data by domain (getSIPLineDataByDomain)
BPT Method Syntax
getSIPLineDataByDomain using (Domain name, start, stop) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, start, stop
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.SIPLine
Data[] getSIPLineDataByDomain(java.lang.String domain, int
start, int stop) throws java.rmi.RemoteException, com.norte
lnetworks.ims.base.prov.opi.shared.ProvisionException;
getSIPLineDataByDomainByVMG
VMG means Voice Mail Gateway.
BPT Method Syntax
getSIPLineDataByDomainByVMG using (Domain name, vmg, start,
stop) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, vmg, start, stop
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.SIPL
ineData[] getSIPLineDataByDomainByVMG(java.lang.String
domain, java.lang.String vmg, int start, int stop) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Operations 149
Get username by End Point Id (getUserByEndPointId)
BPT Method Syntax
getUserByEndPointId using (End Point Id) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
End Point Id
OPI method
public java.lang.String getUserByEndPointId(java.lang.Strin
g endPointId) throws java.rmi.RemoteException, com.nortelne
tworks.ims.base.prov.opi.shared.ProvisionException;
Remove SIP Line data for a user (removeSIPLineData)
BPT Method Syntax
removeSIPLineData using (User name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
userName
OPI method
public void removeSIPLineData(java.lang.String userName)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Assistant Support Operations
This section contains the following:
•
&quot;Add assistants for a user (addAssistants)&quot; (page 150)
•
&quot;Retrieve assistants for a user by assistant type (getAssistantsForUserByType)&quot; (page 150)
•
&quot;Retrieve all assistants for a user (getAllAssistantsForUser)&quot; (page 150)
•
&quot;Retrieve assisted users ordered by priority for an assistant
(getAssistedUsers)&quot; (page 151)
•
&quot;Modify priority of assisted users for an assistant (modifyAssistedUserOrder)&quot; (page 151)
•
&quot;Determine if an assistant is provisioned for a user (isAssistantForUser)&quot;
(page 151)
•
&quot;Remove assisted users for an assistant (removeAssistedUsers)&quot; (page
152)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
150 Methods for OPI and BPT
•
&quot;Remove all assisted users for an assistant (removeAllAssistedUsers)&quot;
(page 152)
•
&quot;Remove assistants for a user (removeAssistants)&quot; (page 152)
•
&quot;Remove all assistants for a user (removeAllAssistants)&quot; (page 153)
Add assistants for a user (addAssistants)
BPT Method Syntax
addAssistants using (Username,[ List of assistants, .. ,
List of assistants], type) | file &lt;file name&gt; [optional]
into &lt;file name&gt;
BPT Required file format
Username,[ List of assistants, ..
type
, List of assistants],
OPI method
public void addAssistants(java.lang.String user,
java.lang.String[] assistants, java.lang.String type)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Retrieve assistants for a user by assistant type
(getAssistantsForUserByType)
BPT Method Syntax
getAssistantsForUserByType using (User, Type) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User, Type
OPI method
public java.lang.String[] getAssistantsForUserByType
(java.lang.String user, java.lang.String type) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Retrieve all assistants for a user (getAllAssistantsForUser)
BPT Method Syntax
getAllAssistantsForUser using (User) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
User
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Operations 151
OPI method
public java.lang.String[] getAllAssistantsForUser(java.lang
.String user) throws java.rmi.RemoteException, com.nortelne
tworks.ims.base.prov.opi.shared.ProvisionException;
Retrieve assisted users ordered by priority for an assistant
(getAssistedUsers)
BPT Method Syntax
getAssistedUsers using (Assistant) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Assistant
OPI method
public java.lang.String[] getAssistedUsers(java.lang.String
assistant) throws java.rmi.RemoteException, com.nortelnetwo
rks.ims.base.prov.opi.shared.ProvisionException;
Modify priority of assisted users for an assistant
(modifyAssistedUserOrder)
BPT Method Syntax
modifyAssistedUserOrder using (Assistant,[ List of assisted
users, .. , List of assisted users]) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Assistant,[ List of assisted users, ..
users]
, List of assisted
OPI method
public void modifyAssistedUserOrder(java.lang.String
assistant, java.lang.String[] users) throws java.rmi.Remote
Exception, com.nortelnetworks.ims.base.prov.opi.shared.Pro
visionException;
Determine if an assistant is provisioned for a user
(isAssistantForUser)
BPT Method Syntax
isAssistantForUser using (User,Assistants) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User, Assistants
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
152 Methods for OPI and BPT
OPI method
public boolean isAssistantForUser(java.lang.String user,
java.lang.String assistant) throws java.rmi.RemoteExcept
ion, com.nortelnetworks.ims.base.prov.opi.shared.Provisi
onException;
Remove assisted users for an assistant (removeAssistedUsers)
BPT Method Syntax
removeAssistedUsers using (Assistant,[ List of assisted
users, .. , List of assisted users]) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Assistant,[ List of assisted users, ..
users]
, List of assisted
OPI method
public void removeAssistedUsers(java.lang.String assistant,
java.lang.String[] users) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Remove all assisted users for an assistant (removeAllAssistedUsers)
BPT Method Syntax
removeAllAssistedUsers using (Assistant) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Assistant
OPI method
public void removeAllAssistedUsers(java.lang.String
assistant) throws java.rmi.RemoteException, com.nortelnetwo
rks.ims.base.prov.opi.shared.ProvisionException;
Remove assistants for a user (removeAssistants)
BPT Method Syntax
removeAssistants using (User,[ List of assistants, .. ,
List of assistants]) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
BPT Required file format
User,[ List of assistants, ..
, List of assistants]
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Operations 153
OPI method
public void removeAssistants(java.lang.String user, java.la
ng.String[] assistants) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Remove all assistants for a user (removeAllAssistants)
BPT Method Syntax
removeAllAssistants using (User) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
User
OPI method
public void removeAllAssistants(java.lang.String user)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
User Search Operations
This section contains the following:
•
&quot;Retrieve users from the users domain that have a matching first name
(searchGABByFirstName)&quot; (page 154)
•
&quot;Retrieve users from the users domain that have a matching last name
(searchGABByLastName)&quot; (page 154)
•
&quot;Retrieve users from the users domain that have a matching first and
last name (searchGABByName)&quot; (page 154)
•
&quot;Retrieve users from the users domain that have a matching phone
number (searchGABByPhoneNumber)&quot; (page 155)
•
&quot;Retrieve users from the users domain that have a matching username
(searchGABByUserName)&quot; (page 155)
•
&quot;Retrieve users from the users domain that have a matching first name
(searchGABByFirstNameRange)&quot; (page 156)
•
&quot;Retrieve users from the users domain that have a matching last name
(searchGABByLastNameRange)&quot; (page 156)
•
&quot;Retrieve users from the users domain that have a matching first and
last name (searchGABByNameRange)&quot; (page 156)
•
&quot;Retrieve users from the users domain that have a matching phone
number (searchGABByPhoneNumberRange)&quot; (page 157)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
154 Methods for OPI and BPT
•
&quot;Retrieve users from the users domain that have a matching username
(searchGABByUserNameRange)&quot; (page 157)
Retrieve users from the users domain that have a matching first
name (searchGABByFirstName)
BPT Method Syntax
searchGABByName using (Username, First Name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Username, First Name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.FullA
ddressBookEntry[] searchGABByFirstName(java.lang.String
userName, java.lang.String firstName) throws java.rmi.Remot
eException, com.nortelnetworks.ims.base.prov.opi.shared.Pro
visionException;
Retrieve users from the users domain that have a matching last
name (searchGABByLastName)
BPT Method Syntax
searchGABByLastName using (Username, Last Name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Username, Last Name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Full
AddressBookEntry[] searchGABByLastName(java.lang.String
userName, java.lang.String lastName) throws java.rmi.Remote
Exception, com.nortelnetworks.ims.base.prov.opi.shared.Pro
visionException;
Retrieve users from the users domain that have a matching first
and last name (searchGABByName)
BPT Method Syntax
searchGABByName using (Username, Name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Username, Name
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Operations 155
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.FullAdd
ressBookEntry[] searchGABByName(java.lang.String userName,
java.lang.String name) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Retrieve users from the users domain that have a matching
phone number (searchGABByPhoneNumber)
BPT Method Syntax
searchGABByPhoneNumber using (Username, Phone Number) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Username, Phone Number
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.FullAd
dressBookEntry[] searchGABByPhoneNumber(java.lang.String
userName, java.lang.String phoneNumber) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Retrieve users from the users domain that have a matching
username (searchGABByUserName)
BPT Method Syntax
searchGABByUserName using (Username, Username) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
userName, userName
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Full
AddressBookEntry[] searchGABByUserName(java.lang.String
userName, java.lang.String searchUserName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
156 Methods for OPI and BPT
Retrieve users from the users domain that have a matching first
name (searchGABByFirstNameRange)
BPT Method Syntax
searchGABByFirstNameRange using (Username, First Name,
Start Index, Stop Index) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
BPT Required file format
Username, First Name, Start Index, Stop Index
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.FullAdd
ressBookEntry[] searchGABByFirstNameRange(java.lang.String
userName, java.lang.String firstName, int start, int stop)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Retrieve users from the users domain that have a matching last
name (searchGABByLastNameRange)
BPT Method Syntax
searchGABByLastNameRange using (Username, Last Name, Start
Index, Stop Index) | file &lt;file name&gt; [optional] into &lt;file
name&gt;
BPT Required file format
Username, Last Name, Start Index, Stop Index
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.FullAddr
essBookEntry[] searchGABByLastNameRange(java.lang.String
userName, java.lang.String lastName, int start, int stop)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Retrieve users from the users domain that have a matching first
and last name (searchGABByNameRange)
BPT Method Syntax
searchGABByNameRange using (Username, Name, Start Index,
Stop Index) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Username, Name, Start Index, Stop Index
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Operations 157
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.FullA
ddressBookEntry[] searchGABByNameRange(java.lang.String
userName, java.lang.String name, int start, int stop)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Retrieve users from the users domain that have a matching
phone number (searchGABByPhoneNumberRange)
BPT Method Syntax
searchGABByPhoneNumberRange using (Username, Phone Number,
Start Index, Stop Index) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
BPT Required file format
Username, Phone Number, Start Index, Stop Index
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.FullAddr
essBookEntry[] searchGABByPhoneNumberRange(java.lang.String
userName, java.lang.String phoneNumber, int start, int
stop) throws java.rmi.RemoteException, com.nortelnetworks.i
ms.base.prov.opi.shared.ProvisionException;
Retrieve users from the users domain that have a matching
username (searchGABByUserNameRange)
BPT Method Syntax
searchGABByUserNameRange using (Username, Username, Start
Index, Stop Index) | file &lt;file name&gt; [optional] into &lt;file
name&gt;
BPT Required file format
Username, Username, Start Index, Stop Index
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.FullAddr
essBookEntry[] searchGABByUserNameRange(java.lang.String
userName, java.lang.String searchUserName, int start, int
stop) throws java.rmi.RemoteException, com.nortelnetworks.i
ms.base.prov.opi.shared.ProvisionException;
User Management Operations
This section contains the following:
•
&quot;Add a single user (addUser)&quot; (page 158)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
158 Methods for OPI and BPT
•
&quot;Add multiple users (addUsersToDomain)&quot; (page 159)
•
&quot;Modify a single user (modifyUser)&quot; (page 160)
•
&quot;Change User Password (changeUserPassword)&quot; (page 161)
•
&quot;Get a single user (getUser)&quot; (page 161)
•
&quot;Remove a single user (removeUser)&quot; (page 161)
•
&quot;Remove multiple users (removeUsers)&quot; (page 162)
•
&quot;Get users in a domain (getUsersByDomain)&quot; (page 162)
•
&quot;Get users by name in a domain (getUsersByName)&quot; (page 162)
•
&quot;Get users by status (getUsersByStatus)&quot; (page 163)
•
&quot;Get username by Directory Number (getUserByDN)&quot; (page 163)
•
&quot;Remove user picture (removeUserPicture)&quot; (page 163)
•
&quot;Get user count in actual (sub) domain (getUserCountInSubDomain)&quot;
(page 164)
•
&quot;Get user count in Domain tree (getUserCountInDomain)&quot; (page 164)
•
&quot;Move User from one domain to another domain (moveUser)&quot; (page 164)
•
&quot;Move Users from one domain to another domain (moveUsers)&quot; (page
165)
•
&quot;Move all users from one domain to another domain (moveAllUsers)&quot;
(page 165)
•
&quot;Get subdomain for a user (getSubDomainForUser)&quot; (page 165)
•
&quot;Get Users by alias (getUsersByAlias)&quot; (page 166)
•
&quot;Get User Count for the domain (getUserCountInDomain)&quot; (page 166)
•
&quot;Get User count in the actual Sub Domain (getUserCountInSubDomain)&quot;
(page 166)
Add a single user (addUser)
BPT Method Syntax
addUser using (Domain name,[The user name,Users
first name,Users last name,Password,Home phone,Cell
phone,Pager,Fax,Email,Office phone number,,User
picture,Status,status reason,,Charge ID,Private Charge
ID,Public Charge ID,VPN Number,Class of service,Redirection
Class of service,Time zone,User Locale,User service
package,[List of User aliases, .. ,List of User
aliases],[List of blended aliases, .. ,List of blended
aliases],[User routes, .. ,User routes],[Display
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Operations 159
name,Registration timer give in seconds,Name of the IPCM]])
| file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name,[The user name,Users first name,Users last
name,Password,Home phone,Cell phone,Pager,Fax,Email,Office
phone number,,User picture,Status,status reason,,Charge
ID,Private Charge ID,Public Charge ID,VPN Number,Class
of service,Redirection Class of service,Time zone,User
Locale,User service package,[List of User aliases,
.. ,List of User aliases],[List of blended aliases,
.. ,List of blended aliases],[User routes, .. ,User
routes],[Display name,Registration timer give in
seconds,Name of the IPCM]]
OPI method
public void addUser(java.lang.String domain, com.nort
elnetworks.ims.base.prov.opi.shared.User user) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Add multiple users (addUsersToDomain)
BPT Method Syntax
addUsersToDomain using (Domain name,[The user name,Users
first name,Users last name,Password,Home phone,Cell
phone,Pager,Fax,Email,Office phone number,,User
picture,Status,status reason,,Charge ID,Private Charge
ID,Public Charge ID,VPN Number,Class of service,Redirection
Class of service,Time zone,User Locale,User service
package,[List of User aliases, .. ,List of User
aliases],[List of blended aliases, .. ,List of blended
aliases],[User routes, .. ,User routes],[Display
name,Registration timer give in seconds,Name of the
IPCM]], .. ,[The user name,Users first name,Users last
name,Password,Home phone,Cell phone,Pager,Fax,Email,Office
phone number,,User picture,Status,status reason,,Charge
ID,Private Charge ID,Public Charge ID,VPN Number,Class
of service,Redirection Class of service,Time zone,User
Locale,User service package,[List of User aliases,
.. ,List of User aliases],[List of blended aliases,
.. ,List of blended aliases],[User routes, .. ,User
routes],[Display name,Registration timer give in
seconds,Name of the IPCM]]]]) | file &lt;file name&gt; [optional]
into &lt;file name&gt;
BPT Required file format
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
160 Methods for OPI and BPT
Domain name,[The user name,Users first name,Users last
name,Password,Home phone,Cell phone,Pager,Fax,Email,Office
phone number,,User picture,Status,status reason,,Charge
ID,Private Charge ID,Public Charge ID,VPN Number,Class
of service,Redirection Class of service,Time zone,User
Locale,User service package,[List of User aliases,
.. ,List of User aliases],[List of blended aliases,
.. ,List of blended aliases],[User routes, .. ,User
routes],[Display name,Registration timer give in
seconds,Name of the IPCM]]
OPI method
public void addUsersToDomain(java.lang.String domain,
com.nortelnetworks.ims.base.prov.opi.shared.User[] users)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Modify a single user (modifyUser)
BPT Method Syntax
modifyUser using (User name,[The user name,Users
first name,Users last name,Password,Home phone,Cell
phone,Pager,Fax,Email,Office phone number,,User
picture,Status,status reason,,Charge ID,Private Charge
ID,Public Charge ID,VPN Number,Class of service,Redirection
class of service,Time zone,User Locale,User service
package,[List of User aliases, .. ,List of User
aliases],[List of blended aliases, .. ,List of blended
aliases],[User routes, .. ,User routes],[Display
name,Registration timer give in seconds,Name of the
IPCM],Location,Directory Number of the user]) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name,[The user name,Users first name,Users last
name,Password,Home phone,Cell phone,Pager,Fax,Email,Office
phone number,,User picture,Status,status reason,,Charge
ID,Private Charge ID,Public Charge ID,VPN Number,Class
of service,Redirection class of service,Time zone,User
Locale,User service package,[List of User aliases,
.. ,List of User aliases],[List of blended aliases,
.. ,List of blended aliases],[User routes, .. ,User
routes],[Display name,Registration timer give in
seconds,Name of the IPCM],Location,Directory Number of the
user]
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Operations 161
OPI method
public void modifyUser(java.lang.String username,
com.nortelnetworks.ims.base.prov.opi.shared.User user)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Change User Password (changeUserPassword)
BPT Method Syntax
changeUserPassword using (User name, New Password) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name, New Password
OPI method
public void changeUserPassword(java.lang.String
userName, java.lang.String newPassword) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get a single user (getUser)
BPT Method Syntax
getUser using (User name) | file &lt;file name&gt; [optional]
into &lt;file name&gt;
BPT Required file format
User name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.User
getUser(java.lang.String user) throws java.rmi.RemoteExcept
ion, com.nortelnetworks.ims.base.prov.opi.shared.Provisi
onException;
Remove a single user (removeUser)
BPT Method Syntax
removeUser using (User name) | file &lt;file name&gt; [optional]
into &lt;file name&gt;
BPT Required file format
User name
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
162 Methods for OPI and BPT
OPI method
public void removeUser(java.lang.String username) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Remove multiple users (removeUsers)
BPT Method Syntax
removeUsers using (Domain name,[ User names, .. , User
names]) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, User names
OPI method
public void removeUsers(java.lang.String domain,
java.lang.String[] users) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Get users in a domain (getUsersByDomain)
BPT Method Syntax
getUsersByDomain using (Domain name, Start Index, Stop
Index) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Start Index, Stop Index
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.User[]
getUsersByDomain(java.lang.String domain, int start, int
stop) throws java.rmi.RemoteException, com.nortelnetworks.i
ms.base.prov.opi.shared.ProvisionException;
Get users by name in a domain (getUsersByName)
BPT Method Syntax
getUsersByName using (Domain name, User name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, User name
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Operations 163
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.User[]
getUsersByName(java.lang.String domain, java.lang.String
name) throws java.rmi.RemoteException, com.nortelnetworks.i
ms.base.prov.opi.shared.ProvisionException;
Get users by status (getUsersByStatus)
BPT Method Syntax
getUsersByStatus using (Domain name,Status, Start Index,
Stop Index) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name,Status, Start Index, Stop Index
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.User[]
getUsersByStatus(java.lang.String domain, java.lang.String
status, int start, int stop) throws java.rmi.RemoteExcepti
on, com.nortelnetworks.ims.base.prov.opi.shared.ProvisionE
xception;
Get username by Directory Number (getUserByDN)
DN means Directory Number.
BPT Method Syntax
getUserByDN using (Directory Number) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Directory Number
OPI method
public java.lang.String getUserByDN(java.lang.String dN)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Remove user picture (removeUserPicture)
BPT Method Syntax
removeUserPicture using (User name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
User name
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
164 Methods for OPI and BPT
OPI method
public void removeUserPicture(java.lang.String userName)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Get user count in actual (sub) domain (getUserCountInSubDomain)
BPT Method Syntax
getUserCountInSubDomain using (domain name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
domain name
OPI method
public int getUserCountInSubDomain(java.lang.String
subDomainName) throws java.rmi.RemoteException, com.norteln
etworks.ims.base.prov.opi.shared.ProvisionException;
Get user count in Domain tree (getUserCountInDomain)
BPT Method Syntax
getUserCountInDomain using (domain name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
domain name
OPI method
public int getUserCountInDomain(java.lang.String
domainName) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Move User from one domain to another domain (moveUser)
BPT Method Syntax
moveUser using (From Domain name,To Domain name, User name)
| file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
From Domain name,To Domain name, User name
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Operations 165
OPI method
public void moveUser(java.lang.String fromDomain,
java.lang.String toDomain, java.lang.String userName)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Move Users from one domain to another domain (moveUsers)
BPT Method Syntax
moveUsers using (From Domain name,To Domain name,[ User
names, .. , User names]) | file &lt;file name&gt; [optional]
into &lt;file name&gt;
BPT Required file format
From Domain name,To Domain name,[ User names]
OPI method
public void moveUsers(java.lang.String fromDomain,
java.lang.String toDomain, java.lang.String[] userNames)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Move all users from one domain to another domain
(moveAllUsers)
BPT Method Syntax
moveAllUsers using (From Domain name,To Domain name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
From Domain name,To Domain name
OPI method
public void moveAllUsers(java.lang.String fromDomain,
java.lang.String toDomain) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Get subdomain for a user (getSubDomainForUser)
BPT Method Syntax
getSubDomainForUser using (User name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
User name
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
166 Methods for OPI and BPT
OPI method
public java.lang.String getSubDomainForUser(java.lang.Strin
g username) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Get Users by alias (getUsersByAlias)
BPT Method Syntax
getUsersByAlias using (Domain name, alias) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, alias
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.User[]
getUsersByAlias(java.lang.String domainName, java.lang.Stri
ng alias) throws java.rmi.RemoteException, com.nortelnetwor
ks.ims.base.prov.opi.shared.ProvisionException;
Get User Count for the domain (getUserCountInDomain)
BPT Method Syntax
getUserCountInDomain using (Domain name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public int getUserCountInDomain(java.lang.String
domainName) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Get User count in the actual Sub Domain (getUserCountInSubDomain)
BPT Method Syntax
getUserCountInSubDomain using (Domain name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Operations 167
OPI method
public int getUserCountInSubDomain(java.lang.String
subDomainName) throws java.rmi.RemoteException, com.norteln
etworks.ims.base.prov.opi.shared.ProvisionException;
User Voicemail Operations
This section contains the following:
•
&quot;Add voicemail server for user (addUsersVoicemailServer)&quot; (page 167)
•
&quot;Modify users voicemail server (modifyUsersVoicemailServer)&quot; (page
167)
•
&quot;Get voicemail server for user (getUsersVoicemailServer)&quot; (page 168)
•
&quot;Remove voicemail server for user (removeUsersVoicemailServer)&quot;
(page 168)
Add voicemail server for user (addUsersVoicemailServer)
BPT Method Syntax
addUsersVoicemailServer using (Domain name, User
name,[Voice mail,Voicemail server]) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name, User name,[Voice mail,Voicemail server]
OPI method
public void addUsersVoicemailServer(java.lang.String
domainName, java.lang.String userName, com.nortelnetwork
s.ims.base.prov.opi.shared.UserVoicemail userVM) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Modify users voicemail server (modifyUsersVoicemailServer)
BPT Method Syntax
modifyUsersVoicemailServer using (Domain name,User
name,[Voice mail,Voicemail server]) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name,User name,[Voice mail,Voicemail server]
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
168 Methods for OPI and BPT
OPI method
public void modifyUsersVoicemailServer(java.lang.String
domainName, java.lang.String userName, com.nortelnetwork
s.ims.base.prov.opi.shared.UserVoicemail userVM) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get voicemail server for user (getUsersVoicemailServer)
BPT Method Syntax
getUsersVoicemailServer using (Domain name,User name) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, User name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.UserVoic
email getUsersVoicemailServer(java.lang.String domainName,
java.lang.String userName) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Remove voicemail server for user (removeUsersVoicemailServer)
BPT Method Syntax
removeUsersVoiceMailServer using (User name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name
OPI method
public void removeUsersVoicemailServer(java.lang.String
userName) throws java.rmi.RemoteException, com.nortelnetwor
ks.ims.base.prov.opi.shared.ProvisionException;
User Direct to Gateway Operations
This section contains the following:
•
&quot;Add Direct to Gateway service prefix for a user (assignUserDirectToGWPrefixData)&quot; (page 169)
•
&quot;Get Direct to Gateway service prefix for a user (getUserDirectToGWPrefixData)&quot; (page 169)
•
&quot;Remove Direct to Gateway service prefix for a user
(removeUserDirectToGWPrefixData)&quot; (page 169)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Operations 169
Add Direct to Gateway service prefix for a user
(assignUserDirectToGWPrefixData)
BPT Method Syntax
assignUserDirectToGWPrefixData using (User name, Prefix) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name, Prefix
OPI method
public void assignUserDirectToGWPrefixData(java.lang.String
username, java.lang.String userPrefixData) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get Direct to Gateway service prefix for a user
(getUserDirectToGWPrefixData)
BPT Method Syntax
getUserDirectToGWPrefixData using (User name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name
OPI method
public java.lang.String getUserDirectToGWPrefixData(java.la
ng.String username) throws java.rmi.RemoteException, com.no
rtelnetworks.ims.base.prov.opi.shared.ProvisionException;
Remove Direct to Gateway service prefix for a user
(removeUserDirectToGWPrefixData)
BPT Method Syntax
removeUserDirectToGWPrefixData using (User name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name
OPI method
public void removeUserDirectToGWPrefixData(java.lang.String
username) throws java.rmi.RemoteException, com.nortelnetwor
ks.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
170 Methods for OPI and BPT
Logout all user contacts (sendUnRegister)
BPT Method Syntax
sendUnRegister using (User name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
User name
OPI method
public void sendUnRegister(java.lang.String userName)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Get clientRedirectServlet login authorization (getClientRedirectLogin)
Note: not contained in opi.java.
BPT Method Syntax
getClientRedirectLogin using (User name, Password) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name, Password
OPI method
Admin Operations
This section contains the following:
•
&quot;Role Operations&quot; (page 170)
•
&quot;Add an Admin (addAdmin)&quot; (page 173)
•
&quot;Modify an Admin (modifyAdmin)&quot; (page 174)
•
&quot;Remove an Admin (removeAdmin)&quot; (page 174)
•
&quot;Get an Admin (getAdmin)&quot; (page 174)
•
&quot;Get all Admins (getAllAdmins)&quot; (page 175)
•
&quot;Get all children Admins (getAllChildrenAdmins)&quot; (page 175)
•
&quot;Change password (changeAdminPassword)&quot; (page 175)
•
&quot;Reset password (resetAdminPassword)&quot; (page 176)
Role Operations
This section contains the following:
•
&quot;Add a new Role (addRole)&quot; (page 171)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Admin Operations 171
•
&quot;Modify a Role (modifyRole)&quot; (page 171)
•
&quot;Remove a Role (removeRole)&quot; (page 172)
•
&quot;Get provisioning role (getRole)&quot; (page 172)
•
&quot;Get all system roles (getSysRoles)&quot; (page 172)
•
&quot;Get all provisioning roles (getRoles)&quot; (page 173)
•
&quot;Get all rights (getAllRights)&quot; (page 173)
Add a new Role (addRole)
BPT Method Syntax
addRole using ([Name of the Provisioning Role,Description
of the Role,[[The Provisioning Right Type,The Read
privilege,The write privilege,The delete privilege], ..
,[The Provisioning Right Type,The Read privilege,The write
privilege,The delete privilege]]]) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
[Name of the Provisioning Role,Description of the
Role,[[The Provisioning Right Type,The Read privilege,The
write privilege,The delete privilege], .. ,[The
Provisioning Right Type,The Read privilege,The write
privilege,The delete privilege]]]
OPI method
public void addRole(com.nortelnetworks.ims.base.prov.opi.sh
ared.Role role) throws java.rmi.RemoteException, com.nortel
networks.ims.base.prov.opi.shared.ProvisionException;
Modify a Role (modifyRole)
BPT Method Syntax
modifyRole using (Role name,[Name of the Provisioning
Role,Description of the Role,[[The Provisioning Right
Type,The Read privilege,The write privilege,The delete
privilege], .. ,[The Provisioning Right Type,The Read
privilege,The write privilege,The delete privilege]]]) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Role name,[Name of the Provisioning Role,Description
of the Role,[[The Provisioning Right Type,The Read
privilege,The write privilege,The delete privilege], ..
,[The Provisioning Right Type,The Read privilege,The write
privilege,The delete privilege]]]
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
172 Methods for OPI and BPT
OPI method
public void modifyRole(java.lang.String roleName,
com.nortelnetworks.ims.base.prov.opi.shared.Role role)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Remove a Role (removeRole)
BPT Method Syntax
removeRole using (Role name) | file &lt;file name&gt; [optional]
into &lt;file name&gt;
BPT Required file format
Role name
OPI method
public void removeRole(java.lang.String role) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get provisioning role (getRole)
BPT Method Syntax
getRole using (Role name) | file &lt;file name&gt; [optional]
into &lt;file name&gt;
BPT Required file format
Role name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Role
getRole(java.lang.String role) throws java.rmi.RemoteExcept
ion, com.nortelnetworks.ims.base.prov.opi.shared.Provisi
onException;
Get all system roles (getSysRoles)
BPT Method Syntax
getSysRoles [optional] into &lt;file name&gt;
OPI method
public java.lang.String[] getSysRoles() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Admin Operations 173
Get all provisioning roles (getRoles)
BPT Method Syntax
getRoles [optional] into &lt;file name&gt;
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Role[]
getRoles() throws java.rmi.RemoteException, com.nortelnetwo
rks.ims.base.prov.opi.shared.ProvisionException;
Get all rights (getAllRights)
BPT Method Syntax
getAllRights [optional] into &lt;file name&gt;
OPI method
public java.lang.String[] getAllRights() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Add an Admin (addAdmin)
BPT Method Syntax
addAdmin using ([The Admin user name,Password,Admin
First Name,Admin Last Name,Admin Status,Admin Email
Address,Office Phone Number,Home Phone Number,Cell Phone
Number,Pager Number,Fax Number,Voicemail Number,VPN
Number,System defined role,Time Zone,Locale,Provisioning
Role,[The list of Domains that he is assigned to, .. ,The
list of Domains that he is assigned to]]) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
[The Admin user name,Password,Admin First Name,Admin
Last Name,Admin Status,Admin Email Address,Office Phone
Number,Home Phone Number,Cell Phone Number,Pager Number,Fax
Number,Voicemail Number,VPN Number,System defined role,Time
Zone,Locale,Provisioning Role,[The list of Domains that
he is assigned to, .. ,The list of Domains that he is
assigned to]]
OPI method
public void addAdmin(com.nortelnetworks.ims.base.prov.opi.s
hared.Admin admin) throws java.rmi.RemoteException, com.nor
telnetworks.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
174 Methods for OPI and BPT
Modify an Admin (modifyAdmin)
BPT Method Syntax
modifyAdmin using (Admin name,[The Admin user name,Passw
ord,Admin First Name,Admin Last Name,Admin Status,Admin
Email Address,Office Phone Number,Home Phone Number,Cell
Phone Number,Pager Number,Fax Number,Voicemail Number,VPN
Number,System defined role,Time Zone,Locale,Provisioning
Role,[The list of Domains that he is assigned to, .. ,The
list of Domains that he is assigned to]]) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Admin name,[The Admin user name,Password,Admin First
Name,Admin Last Name,AdminStatus,Admin Email Address,Office
Phone Number,Home Phone Number,Cell Phone Number,Pager
Number,Fax Number,Voicemail Number,VPN Number,System
defined role,TimeZone,Locale,Provisioning Role,[The list of
Domains that he is assigned to, .. ,The list of Domains
that he is assigned to]]
OPI method
public void modifyAdmin(java.lang.String adminName,
com.nortelnetworks.ims.base.prov.opi.shared.Admin admin)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Remove an Admin (removeAdmin)
BPT Method Syntax
removeAdmin using (Admin name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Admin name
OPI method
public void removeAdmin(java.lang.String admin) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get an Admin (getAdmin)
BPT Method Syntax
getAdmin using (Admin name) | file &lt;file name&gt; [optional]
into &lt;file name&gt;
BPT Required file format
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Admin Operations 175
Admin name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Admin
getAdmin(java.lang.String admin) throws java.rmi.RemoteExce
ption, com.nortelnetworks.ims.base.prov.opi.shared.Provisi
onException;
Get all Admins (getAllAdmins)
BPT Method Syntax
getAllAdmins [optional] into &lt;file name&gt;
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Admin[]
getAllAdmins() throws java.rmi.RemoteException, com.norteln
etworks.ims.base.prov.opi.shared.ProvisionException;
Get all children Admins (getAllChildrenAdmins)
BPT Method Syntax
getAllChildrenAdmins using (Parent admin name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Parent admin name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Admin[]
getAllChildrenAdmins(java.lang.String parentName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Change password (changeAdminPassword)
BPT Method Syntax
changeAdminPassword using (New password) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
New password
OPI method
public void changeAdminPassword(java.lang.String
newPassword) throws java.rmi.RemoteException, com.nortelnet
works.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
176 Methods for OPI and BPT
Reset password (resetAdminPassword)
BPT Method Syntax
resetAdminPassword using (adminName, newPassword) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
adminName, newPassword
OPI method
public void resetAdminPassword(java.lang.String
adminName, java.lang.String newPassword) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Service Operations
This section contains the following:
•
&quot;Service Package Operations&quot; (page 177)
•
&quot;Get all services assigned to a domain (getServicesByDomain)&quot; (page
181)
•
&quot;Add services to a domain (addServicesToDomain)&quot; (page 181)
•
&quot;Remove all services assigned to a domain (removeServicesByDomain)&quot;
(page 181)
•
&quot;Modify services assigned to a domain (modifyDomainServices)&quot; (page
182)
•
&quot;Add services to multiple domains (addServicesToDomains)&quot; (page 182)
•
&quot;Modify services of multiple domains (modifyServicesToDomains)&quot;
(page 182)
•
&quot;Modify the acceptable parameter values for a service
(modifyServiceParm)&quot; (page 183)
•
&quot;Set a parameter value as default value for a service
(setServiceParmAsDefault)&quot; (page 183)
•
&quot;Get all service names (getAllServiceNames)&quot; (page 183)
•
&quot;Get parameter names for a service (getParmNamesByService)&quot; (page
184)
•
&quot;Get parameter names for all services (getParmNamesForAllServices)&quot;
(page 184)
•
&quot;Get all acceptable values for given parameter (getServiceParmValues)&quot;
(page 184)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Service Operations 177
•
&quot;Get Parameter Display Name By Parameter Name (getParameterDisplayNameByParameterName)&quot; (page 185)
•
&quot;Get Parameter Name By Parameter Display Name (getParameterNameByParameterDisplayName)&quot; (page 185)
•
&quot;Get Service Display Name By Service Name (getServiceDisplayNameByServiceName)&quot; (page 185)
•
&quot;Get Service Name By Service Display Name (getServiceNameByServiceDisplayName)&quot; (page 186)
Service Package Operations
This section contains the following:
•
&quot;Add a service package (addServicePackage)&quot; (page 177)
•
&quot;Get a service package in a domain (getServicePackage)&quot; (page 178)
•
&quot;Get all service packages in a domain (getServicePackagesByDomain)&quot;
(page 178)
•
&quot;Modify a service package (modifyServicePackage)&quot; (page 178)
•
&quot;Remove a service package (removeServicePackage)&quot; (page 179)
•
&quot;Remove multiple service packages (removeServicePackages)&quot; (page
179)
•
&quot;Set a service package as default (setDefaultServicePackageToDomain)&quot;
(page 180)
•
&quot;Assign service package to domain (assignPackage)&quot; (page 180)
•
&quot;getDefaultServicePackageByDomain&quot; (page 180)
Add a service package (addServicePackage)
BPT Method Syntax
addServicePackage using (Domain name,[Name of the
Service Package,[[Name of the service,[[Name,Value], ..
,[Name,Value]]], .. ,[Name of the service,[[Name,Value],
.. ,[Name,Value]]]]]) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
BPT Required file format
Domain name,[Name of the Service Package,[[Name of the
service,[[Name,Value], .. ,[Name,Value]]], .. ,[Name of
the service,[[Name,Value], .. ,[Name,Value]]]]]
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
178 Methods for OPI and BPT
OPI method
public void addServicePackage(java.lang.String domain,
com.nortelnetworks.ims.base.prov.opi.shared.ServicePackage
servicePackage) throws java.rmi.RemoteException, com.nortel
networks.ims.base.prov.opi.shared.ProvisionException;
Get a service package in a domain (getServicePackage)
BPT Method Syntax
getServicePackage using (Domain name, Package name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Package name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Ser
vicePackage getServicePackage(java.lang.String domain,
java.lang.String name) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Get all service packages in a domain (getServicePackagesByDomain)
BPT Method Syntax
getServicePackagesByDomain using (Domain name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Servi
cePackage[] getServicePackagesByDomain(java.lang.String
domain) throws java.rmi.RemoteException, com.nortelnetworks
.ims.base.prov.opi.shared.ProvisionException;
Modify a service package (modifyServicePackage)
BPT Method Syntax
modifyServicePackage using (Domain name, Service
package name,[Name of the Service Package,[[Name of the
service,[[Name,Value], .. ,[Name,Value]]], .. ,[Name of
the service,[[Name,Value], .. ,[Name,Value]]]]]) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Service Operations 179
BPT Required file format
Domain name, Service package name,[Name of the Service
Package,[[Name of the service,[[Name,Value], ..
,[Name,Value]]], .. ,[Name of the service,[[Name,Value],
.. ,[Name,Value]]]]]
OPI method
public void modifyServicePackage(java.lang.String domain,
java.lang.String name, com.nortelnetworks.ims.base.p
rov.opi.shared.ServicePackage servicePackage) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Remove a service package (removeServicePackage)
BPT Method Syntax
removeServicePackage using (Domain name, Service package) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Service package
OPI method
public void removeServicePackage(java.lang.String domain,
java.lang.String name) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Remove multiple service packages (removeServicePackages)
BPT Method Syntax
removeServicePackages using (Domain name,[ Service package
names, .. , Service package names]) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name,[ Service package names, ..
names]
, Service package
OPI method
public void removeServicePackages(java.lang.String domain,
java.lang.String[] names) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
180 Methods for OPI and BPT
Set a service package as default (setDefaultServicePackageToDomain)
BPT Method Syntax
setDefaultServicePackageToDomain using (Domain name,
Service package name) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
BPT Required file format
Domain name, Service package name
OPI method
public void setDefaultServicePackageToDomain(java
.lang.String domain, java.lang.String name) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Assign service package to domain (assignPackage)
BPT Method Syntax
assignPackage using (child domain name, parent domain name,
service package name, service pacakge will be default or
not in child domain) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
BPT Required file format
child domain name, parent domain name, service package
name, service pacakge will be default or not in child
domain
OPI method
public void assignPackage(java.lang.String domain, java.lan
g.String parentDomain, java.lang.String servicePackageName,
boolean isDefault) throws java.rmi.RemoteException, com.nor
telnetworks.ims.base.prov.opi.shared.ProvisionException;
getDefaultServicePackageByDomain
BPT Method Syntax
DefaultServicePackageByDomain
BPT Required file format
OPI method
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Service Operations 181
Get all services assigned to a domain (getServicesByDomain)
BPT Method Syntax
getServicesByDomain using (Domain name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Servi
ce[] getServicesByDomain(java.lang.String domain) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Add services to a domain (addServicesToDomain)
BPT Method Syntax
addServicesToDomain using (Domain name, Services list&gt;) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Services list
OPI method
public void addServicesToDomain(java.lang.String domain,
com.nortelnetworks.ims.base.prov.opi.shared.Service[]
services) throws java.rmi.RemoteException, com.nortelnetwor
ks.ims.base.prov.opi.shared.ProvisionException;
Remove all services assigned to a domain (removeServicesByDomain)
BPT Method Syntax
removeServicePackage using (Domain name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public void removeServicesByDomain(java.lang.String domain)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
182 Methods for OPI and BPT
Modify services assigned to a domain (modifyDomainServices)
BPT Method Syntax
modifyDomainServices using (Domain name list, Services
list) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name list, Services list
OPI method
public void modifyDomainServices(java.lang.String domain,
com.nortelnetworks.ims.base.prov.opi.shared.Service[]
service) throws java.rmi.RemoteException, com.nortelnetwork
s.ims.base.prov.opi.shared.ProvisionException;
Add services to multiple domains (addServicesToDomains)
BPT Method Syntax
addServicesToDomains using ([Domain names list, .. ,
Domain names list],[[Name of the service,[[Name,Value], ..
,[Name,Value]]], .. ,[Name of the service,[[Name,Value],
.. ,[Name,Value]]]]) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
BPT Required file format
[Domain names list, .. ,Domain names list],[[Name of the
service,[[Name,Value], .. ,[Name,Value]]], .. ,[Name of
the service,[[Name,Value], .. ,[Name,Value]]]]
OPI method
public void addServicesToDomains(java.lang.String[] domain
s, com.nortelnetworks.ims.base.prov.opi.shared.Service[]
services) throws java.rmi.RemoteException, com.nortelnetwor
ks.ims.base.prov.opi.shared.ProvisionException;
Modify services of multiple domains (modifyServicesToDomains)
BPT Method Syntax
modifyServicesToDomains using ([Domain name list, ..
,Domain name list],[[Name of the service,[[Name,Value], ..
,[Name,Value]]], .. ,[Name of the service,[[Name,Value],
.. ,[Name,Value]]]]) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
BPT Required file format
[Domain name list, .. ,Domain name list],[[Name of the
service,[[Name,Value], .. ,[Name,Value]]], .. ,[Name of
the service,[[Name,Value], .. ,[Name,Value]]]]
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Service Operations 183
OPI method
public void modifyServicesToDomains(java.lang.String[] doma
ins, com.nortelnetworks.ims.base.prov.opi.shared.Service[]
services) throws java.rmi.RemoteException, com.nortelnetwor
ks.ims.base.prov.opi.shared.ProvisionException;
Modify the acceptable parameter values for a service
(modifyServiceParm)
BPT Method Syntax
modifyServiceParm using (Service name, Parameter name,[
Parameter values, .. , Parameter values]) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Service name, Parameter name,[ Parameter values, ..
Parameter values]
,
OPI method
public void modifyServiceParm(java.lang.String servicename,
java.lang.String parmname, java.lang.String[] parmvalues)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Set a parameter value as default value for a service (setServiceParmAsDefault)
BPT Method Syntax
setServiceParmAsDefault using (Service name, Parameter
name, Default value) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
BPT Required file format
Service name, Parameter name, Default value
OPI method
public void setServiceParmAsDefault(java.lang.String
serviceName, java.lang.String parmName, java.lang.String
defaultValue) throws java.rmi.RemoteException, com.nortelne
tworks.ims.base.prov.opi.shared.ProvisionException;
Get all service names (getAllServiceNames)
BPT Method Syntax
getAllServiceNames [optional] into &lt;file name&gt;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
184 Methods for OPI and BPT
OPI method
public java.lang.String[] getAllServiceNames() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get parameter names for a service (getParmNamesByService)
BPT Method Syntax
getParmNamesByService using (Service name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Service name
OPI method
public java.lang.String[] getParmNamesByService(java.lang.S
tring service) throws java.rmi.RemoteException, com.norteln
etworks.ims.base.prov.opi.shared.ProvisionException;
Get parameter names for all services (getParmNamesForAllServices)
BPT Method Syntax
getParmNamesForAllServices [optional] into &lt;file name&gt;
OPI method
public com.nortelnetworks.ims.base.prov.opi.shar
ed.Service[] getParmNamesForAllServices() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get all acceptable values for given parameter (getServiceParmValues)
BPT Method Syntax
getServiceParmValues using (Service name, Parameter name) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Service name, Parameter name
OPI method
public java.lang.String[] getServiceParmValues(java.lang.St
ring serviceName, java.lang.String parmDisplayName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Service Operations 185
Get Parameter Display Name By Parameter Name (getParameterDisplayNameByParameterName)
BPT Method Syntax
getParameterDisplayNameByParameterName using (Parameter
Name) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Parameter Name
OPI method
public java.lang.String getParameterDisplayNameByPa
rameterName(java.lang.String parameterName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get Parameter Name By Parameter Display Name (getParameterNameByParameterDisplayName)
BPT Method Syntax
getParameterNameByParameterDisplayName using (Parameter
Display Name) | file &lt;file name&gt; [optional] into &lt;file
name&gt;
BPT Required file format
Parameter Display Name
OPI method
public java.lang.String getParameterNameByParameterDis
playName(java.lang.String parameterDisplayName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get Service Display Name By Service Name (getServiceDisplayNameByServiceName)
BPT Method Syntax
getServiceDisplayNameByServiceName using (Service Name) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Service Name
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
186 Methods for OPI and BPT
OPI method
public java.lang.String getServiceDisplayNameByS
erviceName(java.lang.String serviceName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get Service Name By Service Display Name (getServiceNameByServiceDisplayName)
BPT Method Syntax
getServiceNameByServiceDisplayName using (Service Display
Name) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Service Display Name
OPI method
public java.lang.String getServiceNameByServiceDisp
layName(java.lang.String serviceDisplayName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Pooled Entity
This section contains the following:
•
&quot;Services&quot; (page 186)
Services
This section contains the following:
•
&quot;Music On Hold &quot; (page 186)
•
&quot;Branding&quot; (page 190)
•
Crbt—not supported by MCS 5100 Release 4.0
•
&quot;Treatment&quot; (page 194)
Music On Hold
This section contains the following:
•
&quot;Add Music on Hold folder to a pooled resource (addMusicOnHoldFolder)&quot;
(page 187)
•
&quot;Add Music on Hold folders (addMusicOnHoldFolders)&quot; (page 187)
•
&quot;Assign Music on Hold folder and pooled resource to domain
(assignMusicOnHoldFolder)&quot; (page 187)
•
&quot;Get Music on Hold folders (getMusicOnHoldFolders)&quot; (page 188)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Pooled Entity
187
•
&quot;Get the assigned Music on Hold folder (getAssignedMusicOnHoldFolder)&quot; (page 188)
•
&quot;Get the assigned Music Pool (getAssignedMusicOnHoldPool)&quot; (page
188)
•
&quot;Rename Music On Hold Folder (renameMusicOnHoldFolder)&quot; (page
189)
•
&quot;Remove Music On Hold Folder (removeMusicOnHoldFolder)&quot; (page
189)
•
&quot;Remove All Music On Hold Folders (removeAllMusicOnHoldFolders)&quot;
(page 189)
Add Music on Hold folder to a pooled resource (addMusicOnHoldFolder)
BPT Method Syntax
addMusicOnHoldFolder using (Domain name, Pool Name, Folder
Name) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Pool Name, Folder name
OPI method
public void addMusicOnHoldFolder(java.lang.String domain,
java.lang.String poolName, java.lang.String folderName)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Add Music on Hold folders (addMusicOnHoldFolders)
BPT Method Syntax
addMusicOnHoldFolders using (Domain name, Pool Name,[
Folders list, .. , Folders list]) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name, Pool Name,[ Folders list, ..
, Folders list]
OPI method
public void addMusicOnHoldFolders(java.lang.String domain,
java.lang.String poolName, java.lang.String[] folders)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Assign Music on Hold folder and pooled resource to domain
(assignMusicOnHoldFolder)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
188 Methods for OPI and BPT
BPT Method Syntax
assignMusicOnHoldFolder using (Domain name, Pool Name,
Folders list) | file &lt;file name&gt; [optional] into &lt;file
name&gt;
BPT Required file format
Domain name, Pool Name, Folders list
OPI method
public void assignMusicOnHoldFolder(java.lang.String
domain, java.lang.String poolName, java.lang.String
folderName) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Get Music on Hold folders (getMusicOnHoldFolders)
BPT Method Syntax
getMusicOnHoldFolders using (Domain name, Pool Name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Pool Name
OPI method
public java.lang.String[] getMusicOnHoldFolders(java
.lang.String domain, java.lang.String poolName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get the assigned Music on Hold folder (getAssignedMusicOnHoldFolder)
BPT Method Syntax
getAssignedMusicOnHoldFolder using (Domain name, Pool Name)
| file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Pool Name
OPI method
public java.lang.String getAssignedMusicOnHoldFolder(jav
a.lang.String domain, java.lang.String poolName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get the assigned Music Pool (getAssignedMusicOnHoldPool)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Pooled Entity
189
BPT Method Syntax
getAssignedMusicOnHoldPool using (Domain name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public java.lang.String getAssignedMusicOnHoldPool(java.lan
g.String domain) throws java.rmi.RemoteException, com.norte
lnetworks.ims.base.prov.opi.shared.ProvisionException;
Rename Music On Hold Folder (renameMusicOnHoldFolder)
BPT Method Syntax
renameMusicOnHoldFolder using (Domain name, Pool Name, Old
Folder Name, New Folder Name) | file &lt;file name&gt; [optional]
into &lt;file name&gt;
BPT Required file format
Domain name, Pool Name, Old Folder Name, New Folder Name
OPI method
public void renameMusicOnHoldFolder(java.lang.String
domain, java.lang.String poolName, java.lang.String
oldFolderName, java.lang.String newFolderName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Remove Music On Hold Folder (removeMusicOnHoldFolder)
BPT Method Syntax
removeMusicOnHoldFolder using (Domain name, Pooled Resource
Name, Folder Name) | file &lt;file name&gt; [optional] into &lt;file
name&gt;
BPT Required file format
Domain name, Pooled Resource Name, Folder Name
OPI method
public void removeMusicOnHoldFolder(java.lang.String
domain, java.lang.String poolName, java.lang.String
folderName) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Remove All Music On Hold Folders (removeAllMusicOnHoldFolders)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
190 Methods for OPI and BPT
BPT Method Syntax
removeAllMusicOnHoldFolders using (Domain name, Pooled
Resource Name) | file &lt;file name&gt; [optional] into &lt;file
name&gt;
BPT Required file format
Domain name, Pooled Resource Name
OPI method
public void removeAllMusicOnHoldFolders(java.lang.String
domain, java.lang.String poolName) throws java.rmi.RemoteEx
ception, com.nortelnetworks.ims.base.prov.opi.shared.Pro
visionException;
Branding
This section contains the following:
•
&quot;Add branding file to a pooled resource (addBrandingFile)&quot; (page 190)
•
&quot;Add branding files (addBrandingFiles)&quot; (page 191)
•
&quot;Assign branding files and pooled resource to domain (assignBranding)&quot;
(page 191)
•
&quot;Get branding object (getBranding)&quot; (page 192)
•
&quot;Get all branding files for a pooled resource (getBrandingFiles)&quot; (page
192)
•
&quot;Get the assigned branding pool for a domain (getAssignedBrandingPool)&quot; (page 192)Get the assigned branding pool for a domain
(getAssignedBrandingPool)
•
&quot;Get the available branding files for a domain and pool
(getAvailableBrandingFiles)&quot; (page 193)
•
&quot;Remove a branding file in a pooled resource (removeBrandingFile)&quot;
(page 193)
•
&quot;Remove all branding files in a pooled resource (removeAllBrandingFiles)&quot; (page 193)
Add branding file to a pooled resource (addBrandingFile)
BPT Method Syntax
addBrandingFile using (Domain name, Pool Name, File Name) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Pool Name, File Name
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Pooled Entity
191
OPI method
public void addBrandingFile(java.lang.String domain,
java.lang.String poolName, java.lang.String fileName)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Add branding files (addBrandingFiles)
BPT Method Syntax
addBrandingFiles using (Domain name, Pool Name,[ Files
list, .. , Files list]) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
BPT Required file format
Domain name, Pool Name,[ Files list, ..
, Files list]
OPI method
public void addBrandingFiles(java.lang.String domain,
java.lang.String poolName, java.lang.String[] fileNames)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Assign branding files and pooled resource to domain
(assignBranding)
BPT Method Syntax
assignBranding using (Domain name, Pool Name,[[Collection
of branding files to be played within a domain, ..
,Collection of branding files to be played within a
domain],Number of times the branding announcement files
need to be played before the announcement terminates.
Valid Values &lt;1-9, infinite&gt;,Selection to play branding
announcement to users within the same domain. Can be
true/false]) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Pool Name,{{Collection of branding files to
be played within a domain, .. ,Collection of branding
files to be played within a domain],Number of times
the branding announcement files need to be played
before the announcement terminates. Valid Values &lt;1-9,
infinite&gt;,Selection to play branding announcement to users
within the same domain. Can be true/false]
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
192 Methods for OPI and BPT
OPI method
public void assignBranding(java.lang.String domain,
java.lang.String poolName, com.nortelnetworks.ims.base.prov
.opi.shared.Branding obj) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Get branding object (getBranding)
BPT Method Syntax
getBranding using (Domain name, Pool Name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Pool Name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Branding
getBranding(java.lang.String domain, java.lang.String
poolName) throws java.rmi.RemoteException, com.nortelnetwor
ks.ims.base.prov.opi.shared.ProvisionException;
Get all branding files for a pooled resource (getBrandingFiles)
BPT Method Syntax
getBrandingFiles using (Domain name, Pool Name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Pool Name
OPI method
public java.lang.String[] getBrandingFiles(java.lang.String
domain, java.lang.String poolName) throws java.rmi.RemoteEx
ception, com.nortelnetworks.ims.base.prov.opi.shared.Pro
visionException;
Get the assigned branding pool for a domain (getAssignedBrandingPool)
BPT Method Syntax
getAssignedBrandingPool using (Domain name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Pooled Entity
193
OPI method
public java.lang.String getAssignedBrandingPool(java.lang.S
tring domain) throws java.rmi.RemoteException, com.nortelne
tworks.ims.base.prov.opi.shared.ProvisionException;
Get the available branding files for a domain and pool
(getAvailableBrandingFiles)
BPT Method Syntax
getAvailableBrandingFiles using (Domain name, Pool Name) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Pool Name
OPI method
public java.lang.String[] getAvailableBrandingFiles(jav
a.lang.String domain, java.lang.String poolName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Remove a branding file in a pooled resource (removeBrandingFile)
BPT Method Syntax
removeBrandingFile using (Domain name, Pooled Resource
Name, File Name) | file &lt;file name&gt; [optional] into &lt;file
name&gt;
BPT Required file format
Domain name, Pooled Resource Name, File Name
OPI method
public void removeBrandingFile(java.lang.String domain,
java.lang.String poolName, java.lang.String fileName)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Remove all branding files in a pooled resource (removeAllBrandingFiles)
BPT Method Syntax
removeAllBrandingFiles using (Domain name, Pooled Resource
Name) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Pooled Resource Name
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
194 Methods for OPI and BPT
OPI method
public void removeAllBrandingFiles(java.lang.String domain,
java.lang.String poolName) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Treatment
This section contains the following:
•
&quot;Add treatment file to a pooled resource (addTreatmentFile)&quot; (page 194)
•
&quot;Add treatment files to a pooled resource (addTreatmentFiles)&quot; (page
195)
•
&quot;Add treatment group to a pooled resource (addTreatmentGroup)&quot; (page
195)
•
&quot;Assign a pooled resource with treatment group to a domain
(assignedTreatmentPool)&quot; (page 196)
•
&quot;Get names of all treatment groups in a domain (getTreatmentGroupNames)&quot; (page 196)
•
&quot;Get all treatment files for a pooled resource (getTreatmentFiles)&quot; (page
197)
•
&quot;Get all treatment groups in a domain (getTreatmentGroups)&quot; (page 197)
•
&quot;Get the assigned treatment pool in a domain (getAssignedTreatmentPool)&quot; (page 197)
•
&quot;Get names of all treatment files that are available in a group
(getAvailableTreatmentFiles)&quot; (page 197)
•
&quot;Get names of all treatment reasons available in a domain
(getAvailableTreatmentReasons)&quot; (page 198)
•
&quot;Modify treatment group parameters for a pooled resource and domain
(modifyTreatmentGroup)&quot; (page 198)
•
&quot;Remove a treatment file in a pooled resource (removeTreatmentFile)&quot;
(page 199)
•
&quot;Remove a treatment group in a domain (removeTreatmentGroup)&quot;
(page 199)
•
&quot;Remove all treatment files in a pooled resource (removeAllTreatmentFiles)&quot; (page 200)
Add treatment file to a pooled resource (addTreatmentFile)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Pooled Entity
195
BPT Method Syntax
addTreatmentFile using (Domain name, Pool Name, File Name)
| file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Pool Name, File Name
OPI method
public void addTreatmentFile(java.lang.String domain,
java.lang.String poolName, java.lang.String fileName)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Add treatment files to a pooled resource (addTreatmentFiles)
BPT Method Syntax
addTreatmentFiles using (Domain name, Pool Name,[ Files
list, .. , Files list]) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
BPT Required file format
Domain name, Pool Name,[ Files list, ..
, Files list]
OPI method
public void addTreatmentFiles(java.lang.String domain,
java.lang.String poolName, java.lang.String[] fileNames)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Add treatment group to a pooled resource (addTreatmentGroup)
BPT Method Syntax
addTreatmentGroup using (Domain name, Pool Name,
[[Collection of files associated with a treatment group,
.. ,Collection of files associated with a treatment
group],Number of times the treatment files need to be
played before the announcement terminates. Valid Values
&lt;1-9, infinite&gt;,Name of the treatment group,[Collection of
reasons associated with a treatment group, .. ,Collection
of reasons associated with a treatment group],Route to
be taken if the call needs to be re-routed after the
announcement has been played.]) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
196 Methods for OPI and BPT
Domain name, Pool Name,[[Collection of files associated
with a treatment group, .. ,Collection of files associated
with a treatment group],Number of times the treatment files
need to be played before the announcement terminates.
Valid Values &lt;1-9, infinite&gt;,Name of the treatment
group,[Collection of reasons associated with a treatment
group, .. ,Collection of reasons associated with a
treatment group],Route to be taken if the call needs to be
re-routed after the announcement has been played.]
OPI method
public void addTreatmentGroup(java.lang.String domain,
java.lang.String poolName, com.nortelnetworks.ims
.base.prov.opi.shared.TreatmentGroup group) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Assign a pooled resource with treatment group to a domain
(assignedTreatmentPool)
BPT Method Syntax
assignTreatmentPool using (Domain name, Pool Name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Pool Name
OPI method
public void assignTreatmentPool(java.lang.String domain,
java.lang.String poolName) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Get names of all treatment groups in a domain (getTreatmentGroupNames)
BPT Method Syntax
getTreatmentGroupNames using (Domain name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public java.lang.String[] getTreatmentGroupNames(java.lang
.String domain) throws java.rmi.RemoteException, com.nortel
networks.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Pooled Entity
197
Get all treatment files for a pooled resource (getTreatmentFiles)
BPT Method Syntax
getTreatmentFiles using (Domain name, Pool Name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Pool Name
OPI method
public java.lang.String[] getTreatmentFiles(java.la
ng.String domain, java.lang.String poolName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get all treatment groups in a domain (getTreatmentGroups)
BPT Method Syntax
getTreatmentGroups using (Domain name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Treatmen
tGroup[] getTreatmentGroups(java.lang.String domain) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get the assigned treatment pool in a domain (getAssignedTreatmentPool)
BPT Method Syntax
getAssignedTreatmentPool using (Domain name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public java.lang.String getAssignedTreatmentPool(java.lang
.String domain) throws java.rmi.RemoteException, com.nortel
networks.ims.base.prov.opi.shared.ProvisionException;
Get names of all treatment files that are available in a group
(getAvailableTreatmentFiles)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
198 Methods for OPI and BPT
BPT Method Syntax
getAvailableTreatmentFiles using (Domain name, Pool
Name,Treatment Group Name) | file &lt;file name&gt; [optional]
into &lt;file name&gt;
BPT Required file format
Domain name, Pool Name,Treatment Group Name
OPI method
public java.lang.String[] getAvailableTreatmentFiles(java.l
ang.String domain, java.lang.String poolName, java.lang.Str
ing groupName) throws java.rmi.RemoteException, com.norteln
etworks.ims.base.prov.opi.shared.ProvisionException;
Get names of all treatment reasons available in a domain
(getAvailableTreatmentReasons)
BPT Method Syntax
getAvailableTreatmentReasons using (Domain name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public java.lang.String[] getAvailableTreatmentReasons(java
.lang.String domain) throws java.rmi.RemoteException, com.n
ortelnetworks.ims.base.prov.opi.shared.ProvisionException;
Modify treatment group parameters for a pooled resource and domain
(modifyTreatmentGroup)
BPT Method Syntax
modifyTreatmentGroup using (Domain name, Pool Name, Old
Treatment Group Name,[[Collection of files associated with
a treatment group, .. ,Collection of files associated
with a treatment group],Number of time the treatment files
need to be played before the announcement terminates.
Valid Values &lt;1-9, infinite&gt;,Name of the treatment
group,[Collection of reasons associated with a treatment
group, .. ,Collection of reasons associated with a
treatment group],Route to be taken if the call needs to be
re-routed after the announcement has been played.]) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Pooled Entity
199
Domain name, Pool Name, Old Treatment Group Name,
[[Collection of files associated with a treatment group,
.. ,Collection of files associated with a treatment
group],Number of times the treatment files need to be
played before the announcement terminates. Valid Values
&lt;1-9, infinite&gt;, Name of the treatment group,[Collection of
reasons associated with a treatment group, .. ,Collection
of reasons associated with a treatment group],Route to
be taken if the call needs to be re-routed after the
announcement has been played.]
OPI method
public void modifyTreatmentGroup(java.lang.String domain,
java.lang.String poolName, java.lang.String oldGroupName,
com.nortelnetworks.ims.base.prov.opi.shared.TreatmentGroup
newGroup) throws java.rmi.RemoteException, com.nortelnetwor
ks.ims.base.prov.opi.shared.ProvisionException;
Remove a treatment file in a pooled resource (removeTreatmentFile)
BPT Method Syntax
removeTreatmentFile using (Domain name, Pooled Resource
Name, File Name) | file &lt;file name&gt; [optional] into &lt;file
name&gt;
BPT Required file format
Domain name, Pooled Resource Name, File Name
OPI method
public void removeTreatmentFile(java.lang.String domain,
java.lang.String poolName, java.lang.String fileName)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Remove a treatment group in a domain (removeTreatmentGroup)
BPT Method Syntax
removeTreatmentGroup using (Domain name, Treatment Group
Name) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Treatment Group Name
OPI method
public void removeTreatmentGroup(java.lang.String domain,
java.lang.String groupName) throws java.rmi.RemoteExcept
ion, com.nortelnetworks.ims.base.prov.opi.shared.Provisi
onException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
200 Methods for OPI and BPT
Remove all treatment files in a pooled resource (removeAllTreatmentFiles)
BPT Method Syntax
removeAllTreatmentFiles using (Domain name, Pooled Resource
Name) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Pooled Resource Name
OPI method
public void removeAllTreatmentFiles(java.lang.String
domain, java.lang.String poolName) throws java.rmi.RemoteEx
ception, com.nortelnetworks.ims.base.prov.opi.shared.Pro
visionException;
Node Operations
This section contains the following:
•
&quot;Get all Node Type Names (getAllNodeTypeNames)&quot; (page 201)
•
&quot;Add a node (addNode)&quot; (page 201)
•
&quot;Add multiple nodes (addNodes)&quot; (page 202)
•
&quot;Modify a node (modifyNode)&quot; (page 202)
•
&quot;Remove a node (removeNode)&quot; (page 203)
•
&quot;Get a Node (getNode)&quot; (page 203)
•
&quot;Get all Nodes (getAllNodes)&quot; (page 204)
•
&quot;Get node count (getNodeCount)&quot; (page 204)
•
&quot;Add a single logical entity (addLogicalEntity)&quot; (page 204)
•
&quot;Modify a Logical Entity (modifyLogicalEntity)&quot; (page 205)
•
&quot;Remove a Logical Entity (removeLogicalEntity)&quot; (page 206)
•
&quot;Get a Logical Entity (getLogicalEntity)&quot; (page 206)
•
&quot;Get All Logical Entitys (getAllLogicalEntitys)&quot; (page 206)
•
&quot;Get Logical Entity Count (getLogicalEntityCount)&quot; (page 207)
•
&quot;Add node to root domains (assignDomainsToNode)&quot; (page 207)
•
&quot;Assign node to sub domains (assignNodeToSubDomains)&quot; (page 207)
•
&quot;Get root domains for a node (getNodeDomains)&quot; (page 208)
•
&quot;Get sub domains for a node (getNodeSubDomains)&quot; (page 208)
•
&quot;Get all node names for sub domains (getAllNodeNamesForDomain)&quot;
(page 208)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Node Operations 201
•
&quot;Get all Nodes for the root domain (getDomainNodes)&quot; (page 209)
•
&quot;Get all Routing Algorithms (getAllRoutingAlgorithms)&quot; (page 209)
•
&quot;Get all Routable Services (getAllRoutableServices)&quot; (page 209)
•
&quot;Get all Routable Service Groups (getAllRoutableServiceGroups)&quot;
(page 209)
Get all Node Type Names (getAllNodeTypeNames)
BPT Method Syntax
getAllNodeTypeNames [optional] into &lt;file name&gt;
OPI method
public java.lang.String[] getAllNodeTypeNames() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Add a node (addNode)
BPT Method Syntax
addNode using ([Node Name,Node Address information,Node
Address Type: IP or DNS,Node type information,Node
Location Information,[[Name,Value], .. , [Name,Value]]]) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
[Node Name,Node Address information,Node Address
Type: IP or DNS,Node type information,Node Location
Information,[[Name,Value], .. ,[Name,Value]]]
OPI method
public void addNode(com.nortelnetworks.ims.base.prov.opi.sh
ared.Node node) throws java.rmi.RemoteException, com.nortel
networks.ims.base.prov.opi.shared.ProvisionException;
Note:
1. If you use a Node Address Type of IP, the Address Name parameter
must be an Informational Element (as displayed in the System
Management Console). The new node is displayed to the Address
name tab in the System Manager Console.
2. If you use a Node Address Type of DNS, the Address Name
parameter can be any value. You use the DNS type to add nodes to
the external domain.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
202 Methods for OPI and BPT
Add multiple nodes (addNodes)
BPT Method Syntax
addNodes using ([[Node Name,Node Address information,Node
Address Type: IP or DNS,Node type information,Node
Location Information,[[Name,Value], .. , [Name,Value]]],
.. ,[Node Name,Node Address information,Node Address
Type: IP or DNS ,Node type information,Node Location
Information,[[Name,Value], .. ,[Name,Value] ]]]) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
[[Node Name,Node Address information,Node Address
Type: IP or DNS,Node type info rmation,Node Location
Information,[[Name,Value], .. ,[Name,Value]]], ..
,[Node N ame,Node Address information,Node Address
Type: IP or DNS,Node type information, Node Location
Information,[[Name,Value], .. ,[Name,Value]]]]
OPI method
public void addNodes(com.nortelnetworks.ims.base.prov.opi.s
hared.Node[] nodes) throws java.rmi.RemoteException, com.no
rtelnetworks.ims.base.prov.opi.shared.ProvisionException;
Note:
1. If you use a Node Address Type of IP, the Address Name parameter
must be an Informational Element (as displayed in the System
Management Console). The new node is displayed to the Address
name tab in the System Manager Console.
2. If you use a Node Address Type of DNS, the Address Name
parameter can be any value. You use the DNS type to add nodes to
the external domain.
Modify a node (modifyNode)
BPT Method Syntax
modifyNode using (Node name,[Node Name,Node Address
information,Node Address Type: IP or DNS,Node type
information,Node Location Information,[[Name,Value
], .. ,[Name,Value]]]) | file &lt;file name&gt; [optional]
into &lt;file name&gt;
BPT Required file format
Node name,[Node Name,Node Address information,Node Address
Type: IP or DNS,Node type information,Node Location
Information,[[Name,Value], .. ,[Name,Value]]]
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Node Operations 203
OPI method
public void modifyNode(java.lang.String nodeName,
com.nortelnetworks.ims.base.prov.opi.shared.Node node)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Note:
1. If you use a Node Address Type of IP, the Address Name parameter
must be an Informational Element (as displayed in the System
Management Console). The new node is displayed to the Address
name tab in the System Manager Console.
2. If you use a Node Address Type of DNS, the Address Name
parameter can be any value. You use the DNS type to add nodes to
the external domain.
Remove a node (removeNode)
BPT Method Syntax
removeNode using (Node name) | file &lt;file name&gt; [optional]
into &lt;file name&gt;
BPT Required file format
Node name
OPI method
public void removeNode(java.lang.String nodeName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get a Node (getNode)
BPT Method Syntax
getNode using (Node name) | file &lt;fuke bane&gt; [optional]
into &lt;file name&gt;
BPT Required file format
Node name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Node
getNode(java.lang.String nodeName) throws java.rmi.RemoteEx
ception, com.nortelnetworks.ims.base.prov.opi.shared.Pro
visionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
204 Methods for OPI and BPT
Get all Nodes (getAllNodes)
BPT Method Syntax
getAllNodes [optional] into &lt;file name&gt;
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Node[]
getAllNodes() throws java.rmi.RemoteException, com.nortelne
tworks.ims.base.prov.opi.shared.ProvisionException;
Get node count (getNodeCount)
BPT Method Syntax
getNodeCount [optional] into &lt;file name&gt;
OPI method
public int getNodeCount() throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Add a single logical entity (addLogicalEntity)
BPT Method Syntax
addLogicalEntity using ([Logical Entity Name,Routing
Algorithm: Currently
only Weighted Average
supported,[Pooled Entity Services, .. ,Pooled Entity
Serv ices],[[Route Name,Node Name,[[Name,Value], ..
,[Name,Value]],Routing Weight: 0- 10], .. ,[Route
Name,Node Name,[[Name,Value], .. ,[Name,Value]],Routing
Weight: 0-10]]]) | file &lt;file name&gt; [optional]
into ,file name&gt;
BPT Required file format
[Logical Entity Name,Routing Algorithm: Currently only
Weighted Average supported,[Pooled Entity Services,
.. ,Pooled Entity Services],[[Route Name,Node
Name,[[Name,Value], .. ,[Name,Value]],Routing Weight:
0-10], .. ,[Route Name,Node Name, [[Name,Value], ..
,[Name,Value]],Routing Weight: 0-10]]]
OPI method
public void addLogicalEntity(com.nortelnetworks.im
s.base.prov.opi.shared.LogicalEntity node) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Node Operations 205
Add multiple Logical Entitys (addLogicalEntitys)
BPT Method Syntax
addLogicalEntitys using ([[Logical Entity Name,Routing
Algorithm: Currently only Weighted Average
supported,[Pooled Entity Services, .. ,Pooled Entity
Services],[[Route Name,Node Name,[[Name,Value], ..
,[Name,Value]],Routing Weight: 0-10], .. ,[Route Name,Node
Name,[[Name,Value], .. ,[Name,Value]],Routing Weight:
0-10]]], .. ,[Logical Entity Name,Routing Algorithm:
Currently only Weighted Average supported,[Pooled Entity
Services, .. ,Pooled Entity Services],[[Route Name,Node
Name,[[Name,Value], .. ,[Name,Value]],Routing Weight:
0-10], .. ,[Route Name,Node Name,[[Name,Value], ..
,[Name,Value]],Routing Weight: 0-10]]]]) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
[[Logical Entity Name,Routing Algorithm: Currently
only Weighted Average supported,[Pooled Entity
Services, .. ,Pooled Entity Services],[[Route Name,Node
Name,[[Name,Value], .. ,[Name,Value]],Routing Weight:
0-10], .. ,[Route Name,Node Name,[[Name,Value], ..
,[Name,Value]],Routing Weight: 0-10]]], .. ,[Logical
Entity Name,Routing Algorithm: Currently only
Weighted Average supported,[Pooled Entity Services,
.. ,Pooled Entity Services],[[Route Name,Node
Name,[[Name,Value], .. , [Name,Value]],Routing Weight:
0-10], .. ,[Route Name,Node Name,[[Name,Value], ..
,[Name,Value]],Routing Weight: 0-10]]]]
OPI method
public void addLogicalEntitys(com.nortelnetworks.ims
.base.prov.opi.shared.LogicalEntity[] nodes) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Modify a Logical Entity (modifyLogicalEntity)
BPT Method Syntax
modifyLogicalEntity using (Logical Entity name,[Logical
Entity Name, Routing Algorithm: Currently only Weighted
Average supported,[Pooled Entity Services,
.. ,Pooled
Entity Services],[[Route Name,Node Name,[[Name,Value], .. ,
[Name,Value]],Routing Weight: 0-10], .. ,[Route Name,Node
Name,[[Name,Value], .. , [Name,Value]],Routing Weight:
0-10]]]) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
206 Methods for OPI and BPT
Logical Entity name,[Logical Entity Name,Routing Algorithm:
Currently only Weighted Average supported,[Pooled Entity
Services, .. ,Pooled Entity Services], [[Route Name,Node
Name,[[Name,Value], .. ,[Name,Value]],Routing Weight:
0-10], .. ,[Route Name,Node Name,[[Name,Value], ..
,[Name,Value]],Routing Weight: 0-10]]]
OPI method
public void modifyLogicalEntity(java.lang.String
logicalEntityName, com.nortelnetworks.ims.base.prov.opi.sha
red.LogicalEntity node) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Remove a Logical Entity (removeLogicalEntity)
BPT Method Syntax
removeLogicalEntity using (Logical Entity name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Logical Entity name
OPI method
public void removeLogicalEntity(java.lang.String
logicalEntityName) throws java.rmi.RemoteException, com.nor
telnetworks.ims.base.prov.opi.shared.ProvisionException;
Get a Logical Entity (getLogicalEntity)
BPT Method Syntax
getLogicalEntity using (Logical Entity name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Logical Entity name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.LogicalE
ntity getLogicalEntity(java.lang.String logicalEntityName)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Get All Logical Entitys (getAllLogicalEntitys)
BPT Method Syntax
getAllLogicalEntitys [optional] into &lt;file name&gt;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Node Operations 207
OPI method
public com.nortelnetworks.ims.base.prov.opi.shar
ed.LogicalEntity[] getAllLogicalEntitys() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get Logical Entity Count (getLogicalEntityCount)
BPT Method Syntax
getLogicalEntityCount [optional] into &lt;file name&gt;
OPI method
public int getLogicalEntityCount() throws java.rmi.RemoteEx
ception, com.nortelnetworks.ims.base.prov.opi.shared.Pro
visionException;
Add node to root domains (assignDomainsToNode)
BPT Method Syntax
assignDomainsToNode using (Node name,[ Root Domains,
.. , Root Domains]) | file &lt;file name&gt; [optional]
into &lt;file name&gt;
BPT Required file format
Node name,[ Root Domains, ..
, Root Domains]
OPI method
public void assignDomainsToNode(java.lang.String nodeName,
java.lang.String[] domains) throws java.rmi.RemoteExcept
ion, com.nortelnetworks.ims.base.prov.opi.shared.Provisi
onException;
Assign node to sub domains (assignNodeToSubDomains)
BPT Method Syntax
assignNodeToSubDomains using (Parent Domain Name, Node
Name,[ Sub domains , .. , Sub domains]) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Parent Domain Name, Node Name,[ Sub domains, ..
domains]
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
, Sub
208 Methods for OPI and BPT
OPI method
public void assignNodeToSubDomains(java.lang.String parentD
omainName, java.lang.String nodeName, java.lang.String[]
subdomains) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Get root domains for a node (getNodeDomains)
BPT Method Syntax
getNodeDomains using (Node name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Node name
OPI method
public java.lang.String[] getNodeDomains(java.lang.String
nodeName) throws java.rmi.RemoteException, com.nortelnetwor
ks.ims.base.prov.opi.shared.ProvisionException;
Get sub domains for a node (getNodeSubDomains)
BPT Method Syntax
getNodeSubDomains using (Domain name, Node name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Node name
OPI method
public java.lang.String[] getNodeSubDomains(java.lang
.String domainName, java.lang.String nodeName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get all node names for sub domains (getAllNodeNamesForDomain)
BPT Method Syntax
getAllNodeNamesForDomain using (Domain Name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Node Operations 209
OPI method
public java.lang.String[] getAllNodeNamesForDomain(java.lan
g.String domainName) throws java.rmi.RemoteException, com.n
ortelnetworks.ims.base.prov.opi.shared.ProvisionException;
Get all Nodes for the root domain (getDomainNodes)
BPT Method Syntax
getDomainNodes using (Domain name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public java.lang.String[] getDomainNodes(java.lang.String
domainName) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Get all Routing Algorithms (getAllRoutingAlgorithms)
BPT Method Syntax
getAllRoutingAlgorithms [optional] into &lt;file name&gt;
OPI method
public java.lang.String[] getAllRoutingAlgorithms() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get all Routable Services (getAllRoutableServices)
BPT Method Syntax
getAllRoutableServices [optional] into &lt;file name&gt;
OPI method
public java.lang.String[] getAllRoutableServices() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get all Routable Service Groups (getAllRoutableServiceGroups)
BPT Method Syntax
getAllRoutableServiceGroups [optional] into &lt;file name&gt;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
210 Methods for OPI and BPT
OPI method
public java.lang.String[] getAllRoutableServiceGroups()
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Pool Management
This section contains the following:
•
&quot;Get all Nodes By Routable Service (getAllNodesByRoutableService)&quot;
(page 210)
•
&quot;Get all Nodes By Routable Service Groups (getAllNodesByRoutableServiceGroup)&quot; (page 211)
•
&quot;Get Assigned Domain Routing Node (getAssignedNodeByDomainByServiceGroup)&quot; (page 211)
•
&quot;Get Assigned Location Routing Node (getAssignedNodeByLocationByServiceGroup)&quot; (page 211)
•
&quot;Get Routing Locations By Service Group (getAllLocationsForNodeByServiceGroup)&quot; (page 212)
•
&quot;Get All Locations By Service Group (getAllAvailableLocationsByServiceGroup)&quot; (page 212)
•
&quot;Assign Node to Domain Routable Service (assignNodeToDomain)&quot;
(page 213)
•
&quot;Assign Node to Location Routable Service (assignNodeToLocation)&quot;
(page 213)
•
&quot;Assign Node to Location Routable Services (assignNodeToLocations)&quot;
(page 213)
Get all Nodes By Routable Service (getAllNodesByRoutableService)
BPT Method Syntax
getAllNodesByRoutableservice using (Domain name, Routable
Service name) | file &lt;file name&gt; [optional] into &lt;file
name&gt;
BPT Required file format
Domain name, Routable Service name
OPI method
public java.lang.String[] getAllNodesByRoutableService(j
ava.lang.String domain, java.lang.String service) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Pool Management
211
Get all Nodes By Routable Service Groups (getAllNodesByRoutableServiceGroup)
BPT Method Syntax
getAllNodesByRoutableServiceGroup using (Domain name,
Routable Service Group name) | file &lt;file name&gt; [optional]
into &lt;file name&gt;
BPT Required file format
Domain name, Routable Service Group name
OPI method
public java.lang.String[] getAllNodesByRoutableServiceGroup
(java.lang.String domain, java.lang.String serviceGroup)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Get Assigned Domain Routing Node (getAssignedNodeByDomainByServiceGroup)
BPT Method Syntax
getAssignedNodeByDomainByServiceGroup using (Domain name,
Routable Service Group name) | file &lt;file name&gt; [optional]
into &lt;file name&gt;
BPT Required file format
Domain name, Routable Service Group name
OPI method
public java.lang.String getAssignedNodeByDomainByServiceGro
up(java.lang.String domain, java.lang.String serviceGroup)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Get Assigned Location Routing Node (getAssignedNodeByLocationByServiceGroup)
BPT Method Syntax
getAssignedNodeByLocationByServiceGroup using (Domain name,
Location Name, Routable Service Group name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Location Name, Routable Service Group name
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
212 Methods for OPI and BPT
OPI method
public java.lang.String getAssignedNodeByLocationByS
erviceGroup(java.lang.String domain, java.lang.String
location, java.lang.String serviceGroup) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get Routing Locations By Service Group (getAllLocationsForNodeByServiceGroup)
BPT Method Syntax
getAllLocationsForNodeByServiceGroup using (Domain name,
Node name, Routable Service Group name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name, Node name, Routable Service Group name
OPI method
public java.lang.String[] getAllLocationsForNodeBySe
rviceGroup(java.lang.String domain, java.lang.String
nodeName, java.lang.String serviceGroup) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get All Locations By Service Group (getAllAvailableLocationsByServiceGroup)
BPT Method Syntax
getAllAvailableLocationsByServiceGroup using (Domain name,
Routable Service Group name) | file &lt;file name&gt; [optional]
into &lt;file name&gt;
BPT Required file format
Domain name, Routable Service Group name
OPI method
public java.lang.String[] getAllAvailableLocationsByService
Group(java.lang.String domain, java.lang.String service)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Pool Management
213
Assign Node to Domain Routable Service (assignNodeToDomain)
BPT Method Syntax
assignNodeToDomain using (Domain Name, Node name, Routable
Service Group Name) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
BPT Required file format
Domain Name, Node name, Routable Service Group Name
OPI method
public void assignNodeToDomain(java.lang.String domain,
java.lang.String nodeName, java.lang.String serviceGroup)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Assign Node to Location Routable Service (assignNodeToLocation)
BPT Method Syntax
assignNodeToLocation using (Domain Name, Location Name,
Node name, Routable Service Group Name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain Name, Location Name, Node name, Routable Service
Group Name
OPI method
public void assignNodeToLocation(java.lang.String
domain, java.lang.String location, java.lang.String
nodeName, java.lang.String serviceGroup) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Assign Node to Location Routable Services (assignNodeToLocations)
BPT Method Syntax
assignNodeToLocations using (usage=Domain Name, Location
Names, Node name, Routable Service Group Name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
usage=Domain Name, Location Names, Node name, Routable
Service Group Name
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
214 Methods for OPI and BPT
OPI method
public void assignNodeToLocations(java.lang.String
domain, java.lang.String[] location, java.lang.String
nodeName, java.lang.String serviceGroup) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Alias Routing
This section contains the following:
•
&quot;Add, Modify or Delete Alias Routing Information (modifyRoutableServiceAlias)&quot; (page 214)
•
&quot;Get a list of Aliases Providing a Service (getRoutableServiceAliases)&quot;
(page 215)
•
&quot;Get Aliases Information for an Alias (getRoutableServiceAliasInfo)&quot;
(page 215)
•
&quot;Get Aliases All Information for an Alias Providing a Specified Service
(getAliasInfoByService)&quot; (page 215)
•
&quot;Remove routable service alias (deleteRoutableServiceAlias)&quot; (page
216)
Add, Modify or Delete Alias Routing Information (modifyRoutableServiceAlias)
BPT Method Syntax
modifyRoutableServiceAlias using (Domain Name, Alias Name,
Routing Info,[Routing Alias Identifier,Pooled Entity which
provides service for this Routing Alias,[[Name of the
Service Parameter,[List of parameter values, .. ,List of
parameter values],Display label], .. ,[Name of the Service
Parameter,[List of parameter values, .. ,List of parameter
values],Display label]]]]) | file &lt;file name&gt; [optional]
into &lt;file name&gt;
BPT Required file format
Domain Name, Alias Name, Routing Info,[Routing Alias
Identifier,Pooled Entity which provides service for this
Routing Alias,[[Name of the Service Parameter,[List of
parameter values, .. ,List of parameter values],Display
label], .. ,[Name of the Service Parameter,[List of
parameter values, .. ,List of parameter values],Display
label]]]]
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Alias Routing 215
OPI method
public void modifyRoutableServiceAlias(java.lang.String
domain, java.lang.String alias, java.lang.String service,
com.nortelnetworks.ims.base.prov.opi.shared.AliasRouting
ar) throws java.rmi.RemoteException, com.nortelnetworks.ims
.base.prov.opi.shared.ProvisionException;
Get a list of Aliases Providing a Service (getRoutableServiceAliases)
BPT Method Syntax
getRoutableServiceAliases using (Domain Name, Service Name)
| file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain Name, Service Name
OPI method
public java.lang.String[] getRoutableServiceAliases(java.la
ng.String domainName, java.lang.String serviceName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get Aliases Information for an Alias (getRoutableServiceAliasInfo)
BPT Method Syntax
getRoutableServiceAliasInfo using (Domain Name, Alias) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain Name, Alias
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.AliasRou
ting getRoutableServiceAliasInfo(java.lang.String domainNam
e, java.lang.String alias) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Get Aliases All Information for an Alias Providing a Specified Service
(getAliasInfoByService)
BPT Method Syntax
getAliasInfoByService using (Domain Name, Service Name) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
216 Methods for OPI and BPT
Domain Name, Service Name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.AliasRo
uting[] getAliasInfoByService(java.lang.String domainName,
java.lang.String service) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Remove routable service alias (deleteRoutableServiceAlias)
BPT Method Syntax
deleteRoutableServiceAlias using (Domain Name, Alias Name)
| file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain Name, Alias Name
OPI method
public void deleteRoutableServiceAlias(java.lang.String
domain, java.lang.String alias) throws java.rmi.RemoteExce
ption, com.nortelnetworks.ims.base.prov.opi.shared.Provisi
onException;
Routable Service Parameter
This section contains the following:
•
&quot;Get Domain Service Parms for a Service (getDomainRoutingServiceParms)&quot; (page 217)
•
&quot;Get Location Service Parms for a Service (getLocationRoutingServiceParms)&quot; (page 217)
•
&quot;Get Alias Service Parms for a Service (getAliasServiceParms)&quot; (page
217)
•
&quot;Set Domain Service Parms for a Service (setDomainRoutingServiceParms)&quot; (page 218)
•
&quot;Set Location Service Parms for a Service (setLocationRoutingServiceParms)&quot; (page 218)
•
&quot;Set Alias Service Parms for a Service (setAliasServiceParms)&quot; (page
219)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Routable Service Parameter
217
Get Domain Service Parms for a Service (getDomainRoutingServiceParms)
BPT Method Syntax
getDomainRoutingServiceParms using (Domain Name, Service
Name) | file &lt;file name [optional] into &lt;file name&gt;
BPT Required file format
Domain Name, Service Name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Service
_Parameter[] getDomainRoutingServiceParms(java.lang.String
domain, java.lang.String service) throws java.rmi.RemoteEx
ception, com.nortelnetworks.ims.base.prov.opi.shared.Pro
visionException;
Get Location Service Parms for a Service (getLocationRoutingServiceParms)
BPT Method Syntax
getLocationRoutingServiceParms using (Domain Name, Location
Name, Service name) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
BPT Required file format
Domain Name, Location Name, Service Name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Service_
Parameter[] getLocationRoutingServiceParms(java.lang.String
domain, java.lang.String location, java.lang.String
service) throws java.rmi.RemoteException, com.nortelnetwork
s.ims.base.prov.opi.shared.ProvisionException;
Get Alias Service Parms for a Service (getAliasServiceParms)
BPT Method Syntax
getAliasServiceParms using (Domain Name, Alias Name,
Service Name) | file &lt;file name&gt; [optional] into &lt;file
name&gt;
BPT Required file format
Domain Name, Alias Name, Service Name
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
218 Methods for OPI and BPT
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Ser
vice_Parameter[] getAliasServiceParms(java.lang.String
domainName, java.lang.String alias, java.lang.String
service) throws java.rmi.RemoteException, com.nortelnetwork
s.ims.base.prov.opi.shared.ProvisionException;
Set Domain Service Parms for a Service (setDomainRoutingServiceParms)
BPT Method Syntax
setDomainRoutingServiceParms using (Domain Name, Service
Name,[[Name of the Service Parameter,[List of parameter
values, .. , List of parameter values], Display label]],
.. , [Name of the Service Parameter, [List of parameter
values, .. , List of parameter values], Display label]]) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain Name, Service Name,[[Name of the Service
Parameter,[List of parameter values, .. ,List of
parameter values],Display label], .. ,[Name of the Service
Parameter,[List of parameter values, .. ,List of parameter
values],Display label]]
OPI method
public void setDomainRoutingServiceParms(java.lang.String
domain, java.lang.String service, com.nortelnetworks.ims
.base.prov.opi.shared.Service_Parameter[] parms) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Set Location Service Parms for a Service (setLocationRoutingServiceParms)
BPT Method Syntax
setLocationRoutingServiceParms using (Domain Name, Location
Name, Service Name,[[Name of the Service Parameter,[List of
parameter values, .. ,List of parameter values],Display
label], .. ,[Name of the Service Parameter,[List of
parameter values, .. ,List of parameter values, .. ,List
of parameter values],Display label]]) | &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Location Services
219
Domain Name, Location Name, Service Name,[[Name of the
Service Parameter,[List of parameter values, .. ,List
of parameter values],Display label]], .. ,[Name of the
Service Parameter,[List of parameter values, .. ,List of
parameter values],Display label]]
OPI method
public void setLocationRoutingServiceParms(java.lang.String
domain, java.lang.String location, java.lang.String
service, com.nortelnetworks.ims.base.prov.opi.shared.Servic
e_Parameter[] parms) throws java.rmi.RemoteException, com.n
ortelnetworks.ims.base.prov.opi.shared.ProvisionException;
Set Alias Service Parms for a Service (setAliasServiceParms)
BPT Method Syntax
setAliasServiceParms using (Domain Name, Alias Name,
Service Name,[[Name of the Service Parameter,[List of
parameter values, .. ,List of parameter values],Display
label], .. ,[Name of the Service Parameter,[List of
parameter values, .. ,List of parameter values],Display
label]]) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain Name, Alias Name, Service Name,[[Name of the
Service Parameter,[List of parameter values, .. ,List of
parameter values],Display label], .. ,[Name of the Service
Parameter,[List of parameter values, .. ,List of parameter
values],Display label]]
OPI method
public void setAliasServiceParms(java.lang.String
domainName, java.lang.String alias, java.lang.String
service, com.nortelnetworks.ims.base.prov.opi.shared.Servic
e_Parameter[] parms) throws java.rmi.RemoteException, com.n
ortelnetworks.ims.base.prov.opi.shared.ProvisionException;
Location Services
This section contains the following:
•
&quot;Add Location (addLocation)&quot; (page 220)
•
&quot;Add Locations (addLocations)&quot; (page 220)
•
&quot;Modify Location (modifyLocation)&quot; (page 221)
•
&quot;Remove Location (removeLocation)&quot; (page 221)
•
&quot;Get Location (getLocation)&quot; (page 222)
•
&quot;Get Locations for Domain (getLocations)&quot; (page 222)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
220 Methods for OPI and BPT
•
&quot;Get Locations by Parent (getLocationsByParent)&quot; (page 222)
•
&quot;Add ERL (addErl)&quot; (page 223)
•
&quot;Get ERL (getErl)&quot; (page 223)
•
&quot;Modify ERL (modifyErl)&quot; (page 223)
•
&quot;Remove ERL (removeErl)&quot; (page 224)
•
&quot;List ANI for Domain (getAniList)&quot; (page 224)
•
&quot;List of Valid ANI Registration Times in Seconds (getValidAniRegTimes)&quot;
(page 225)
•
&quot;List Deprecated Locations for Domain (getDeprecatedLocations)&quot;
(page 225)
•
&quot;Purge Deprecated Locations for Domain (purgeDeprecatedLocations)&quot;
(page 225)
Add Location (addLocation)
BPT Method Syntax
addLocation using (Domain name, String parentLocationName
,[Fully qualified location name,Full location description])
| file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, String parentLocationName,[Fully qualified
location name,Full location description]
OPI method
public void addLocation(java.lang.String domainName,
java.lang.String parentLocationName, com.nortelnetworks
.ims.base.prov.opi.shared.LocationInfo location) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Add Locations (addLocations)
BPT Method Syntax
addLocations using (Domain name, String parentLocati
onName,[[Fully qualified location name,Full location
description], .. ,[Fully qualified location name,Full
location description]]) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
BPT Required file format
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Location Services
221
Domain name, String parentLocationName,[[Fully qualified
location name,Full location description], .. ,[Fully
qualified location name,Full location description]]
OPI method
public void addLocations(java.lang.String domainName,
java.lang.String parentLocationName, com.nortelnetworks.i
ms.base.prov.opi.shared.LocationInfo[] locations) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Modify Location (modifyLocation)
BPT Method Syntax
modifyLocation using (Domain name, String locationName,[Ful
ly qualified location name,Full location description]) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, String locationName,[Fully qualified location
name,Full location description]
OPI method
public void modifyLocation(java.lang.String domainName,
java.lang.String locationName, com.nortelnetworks.im
s.base.prov.opi.shared.LocationInfo location) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Remove Location (removeLocation)
BPT Method Syntax
removeLocation using (Domain name, String locationName) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, String locationName
OPI method
public void removeLocation(java.lang.String domainName,
java.lang.String locationName) throws java.rmi.RemoteExcept
ion, com.nortelnetworks.ims.base.prov.opi.shared.Provisi
onException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
222 Methods for OPI and BPT
Get Location (getLocation)
BPT Method Syntax
getLocation using (Domain name, String locationName) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, String locationName
OPI method
public com.nortelnetworks.ims.base.prov.opi.sh
ared.LocationInfo getLocation(java.lang.String
domainName, java.lang.String locationName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get Locations for Domain (getLocations)
BPT Method Syntax
getLocations using (Domain name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Locatio
nInfo[] getLocations(java.lang.String domainName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get Locations by Parent (getLocationsByParent)
BPT Method Syntax
getLocationsByParent using (Domain name, String
locationName) | file &lt;file name&gt; [optional] into &lt;file
name&gt;
BPT Required file format
Domain name, String locationName
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.L
ocationInfo[] getLocationsByParent(java.lang.String
domainName, java.lang.String parentLocationName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Location Services
223
Add ERL (addErl)
BPT Method Syntax
addErl using (Domain name, String locationName,[Gateway
Route,ERL Type,SIP address to send an OSN IM when emergency
call is made,[The list of ANIs used for emergency callback
to this ERL, .. ,The list of ANIs used for emergency
callback to this ERL]]) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
BPT Required file format
Domain name, String locationName,[Gateway Route,ERL
Type,SIP address to send an OSN IM when emergency call is
made,[The list of ANIs used for emergency callback to this
ERL, .. ,The list of ANIs used for emergency callback to
this ERL]]
OPI method
public void addErl(java.lang.String domainName,
java.lang.String locationName, com.nortelnetworks
.ims.base.prov.opi.shared.ErlInfo erlInfo) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get ERL (getErl)
BPT Method Syntax
getErl using (Domain name, String locationName) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, String locationName
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.ErlInfo
getErl(java.lang.String domainName, java.lang.String
locationName) throws java.rmi.RemoteException, com.nortelne
tworks.ims.base.prov.opi.shared.ProvisionException;
Modify ERL (modifyErl)
BPT Method Syntax
modifyErl using (Domain name, String locationName,[Gateway
Route,ERL Type,SIP address to send an OSN IM when emergency
call is made,[The list of ANIs used for emergency callback
to this ERL, .. ,The list of ANIs used for emergency
callback to this ERL]]) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
224 Methods for OPI and BPT
BPT Required file format
Domain name, String locationName,[Gateway Route,ERL
Type,SIP address to send an OSN IM when emergency call is
made,[The list of ANIs used for emergency callback to this
ERL, .. ,The list of ANIs used for emergency callback to
this ERL]]
OPI method
public void modifyErl(java.lang.String domainName,
java.lang.String locationName, com.nortelnetworks
.ims.base.prov.opi.shared.ErlInfo erlInfo) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Remove ERL (removeErl)
BPT Method Syntax
removeErl using (Domain name, String locationName) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, String locationName
OPI method
public void removeErl(java.lang.String domainName, java.la
ng.String locationName) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
List ANI for Domain (getAniList)
BPT Method Syntax
getAniList using (Domain name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public java.lang.String getAniList(java.lang.String
domainName) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Telephony Routes Operations 225
List of Valid ANI Registration Times in Seconds (getValidAniRegTimes)
BPT Method Syntax
getValidAniRegTimes [optional] into &lt;file name&gt;
OPI method
public java.lang.String getValidAniRegTimes() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
List Deprecated Locations for Domain (getDeprecatedLocations)
BPT Method Syntax
getDeprecatedLocations using (Domain name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Location
Info[] getDeprecatedLocations(java.lang.String domainName)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Purge Deprecated Locations for Domain (purgeDeprecatedLocations)
BPT Method Syntax
purgeDeprecatedLocations using (Domain name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public void purgeDeprecatedLocations(java.lang.String
domainName) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Telephony Routes Operations
This section contains the following:
•
&quot;Number Qualifier Operations&quot; (page 226)
•
&quot;Pre-Translation Operations&quot; (page 229)
•
&quot;Add a new Telephony route (addTelephonyRoute)&quot; (page 232)
•
&quot;Add multiple Telephony routes (addTelephonyRoutes)&quot; (page 233)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
226 Methods for OPI and BPT
•
&quot;Modify a telephony route (modifyTelephonyRoute)&quot; (page 234)
•
&quot;Remove a telephony route (removeTelephonyRoute)&quot; (page 234)
•
&quot;Remove multiple telephony routes (removeTelephonyRoutes)&quot; (page
235)
•
&quot;Get telephony route types (getTelephonyRouteTypes)&quot; (page 235)
•
&quot;Get a telephony route in a domain (getTelephonyRoutesByDomain)&quot;
(page 235)
•
&quot;Get a telephony route (getTelephonyRoute)&quot; (page 236)
•
&quot;Add a route list (addRouteList)&quot; (page 236)
•
&quot;Add multiple route list (addRouteLists)&quot; (page 236)
•
&quot;Modify a route list (modifyRouteList)&quot; (page 237)
•
&quot;Remove a route list (removeRouteList)&quot; (page 237)
•
&quot;Remove multiple route lists (removeRouteLists)&quot; (page 238)
•
&quot;Remove all telephony routes from a route list (removeAllTelephonyRoutesFromRouteList)&quot; (page 238)
•
&quot;Remove a telephony route from route list (removeTelephonyRouteFromRouteList)&quot; (page 238)
•
&quot;Get route lists by domain (getRouteListByDomain)&quot; (page 239)
•
&quot;Get a route list by name (getRouteListByName)&quot; (page 239)
•
&quot;Get a route list by Class Of Service (getRouteListByClassOfService)&quot;
(page 239)
•
&quot;Get route list actions (getRouteListActions)&quot; (page 240)
•
&quot;Get translation destinations (getDestinations)&quot; (page 240)
•
&quot;Add Direct To Gateway service prefix for a domain (assignDirectToGatewayPrefixData)&quot; (page 240)
•
&quot;Get Direct To Gateway service prefix for a domain (getDirectToGWPrefixData)&quot; (page 241)
•
&quot;Remove Direct To Gateway service prefix for a domain
(removeDirectToGWPrefixData)&quot; (page 241)
Number Qualifier Operations
This section contains the following:
•
&quot;Add a new Number Qualifier (addNumberQualifier)&quot; (page 227)
•
&quot;Add multiple new Number Qualifiers (addNumberQualifiers)&quot; (page 227)
•
&quot;Get all Number Qualifiers for a domain (getNumberQualifiers)&quot; (page
228)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Telephony Routes Operations 227
•
&quot;Modify a Number Qualifier (modifyNumberQualifier)&quot; (page 228)
•
&quot;Remove a Number Qualifier (removeNumberQualifier)&quot; (page 228)
•
&quot;Remove all Number Qualifiers for a domain (removeAllNumberQualifiers)&quot; (page 229)
Add a new Number Qualifier (addNumberQualifier)
BPT Method Syntax
addNumberQualifier using (Root domain name,[Name of the
Number Qualifier used by the Gateways,Further description
of the Format. TON=?? and NPI=??]) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Root domain name,[Name of the Number Qualifier used by the
Gateways,Further description of the Format. TON=?? and
NPI=??]
OPI method
public void addNumberQualifier(java.lang.String rootDomain,
com.nortelnetworks.ims.base.prov.opi.shared.NumberQualifier
PE numberQualifier) throws java.rmi.RemoteException, com.no
rtelnetworks.ims.base.prov.opi.shared.ProvisionException;
Add multiple new Number Qualifiers (addNumberQualifiers)
BPT Method Syntax
addNumberQualifiers using (Root domain name,[[Name of the
Number Qualifier used by the Gateways,Further description
of the Format. TON=?? and NPI=??], .. ,[Name of the
Number Qualifier used by the Gateways,Further description
of the Format. TON=?? and NPI=??]]) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Root domain name,[Name of the Number Qualifier used by the
Gateways,Further description of the Format. TON=?? and
NPI=??]
OPI method
public void addNumberQualifiers(java.lang.String
rootDomain, com.nortelnetworks.ims.base.prov.opi.s
hared.NumberQualifierPE[] numberQualifiers) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
228 Methods for OPI and BPT
Get all Number Qualifiers for a domain (getNumberQualifiers)
BPT Method Syntax
getNumberQualifiers using (Root domain name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Root domain name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Num
berQualifierPE[] getNumberQualifiers(java.lang.String
rootDomain) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Modify a Number Qualifier (modifyNumberQualifier)
BPT Method Syntax
modifyNumberQualifier using (Root domain name, Number
Qualifier name,[Name of the Number Qualifier used by the
Gateways,Further description of the Format. TON=?? and
NPI=??]) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Root domain name, Number Qualifier name,[Name of the Number
Qualifier used by the Gateways,Further description of the
Format. TON=?? and NPI=??]
OPI method
public void modifyNumberQualifier(java.lang.String
rootDomain, java.lang.String oldNumberQualifierName, com.n
ortelnetworks.ims.base.prov.opi.shared.NumberQualifierPE
numberQualifier) throws java.rmi.RemoteException, com.norte
lnetworks.ims.base.prov.opi.shared.ProvisionException;
Remove a Number Qualifier (removeNumberQualifier)
BPT Method Syntax
removeNumberQualifier using (Root domain name, Number
Qualifier name) | file &lt;file name&gt; [optional] into &lt;file
name&gt;
BPT Required file format
Root domain name, Number Qualifier name
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Telephony Routes Operations 229
OPI method
public void removeNumberQualifier(java.lang.String
rootDomain, java.lang.String numberQualifierName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Remove all Number Qualifiers for a domain (removeAllNumberQualifiers)
BPT Method Syntax
removeAllNumberQualifiers using (Root domain name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Root domain name
OPI method
public void removeAllNumberQualifiers(java.lang.String
rootDomain) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Pre-Translation Operations
This section contains the following:
•
&quot;Add a new Pre-translator (addPreTranslator)&quot; (page 229)
•
&quot;Add multiple new Pre-translators (addPreTranslators)&quot; (page 230)
•
&quot;Get Pre-translators for a domain (getPreTranslators)&quot; (page 230)
•
&quot;Modify a Pre-translator (modifyPreTranslator)&quot; (page 231)
•
&quot;Remove a Pre-translator (removePreTranslator)&quot; (page 231)
•
&quot;Remove all Pre-translators for a domain (removeAllPreTranslators)&quot;
(page 231)
Add a new Pre-translator (addPreTranslator)
BPT Method Syntax
addPreTranslator using (Domain name,[Name of the Number
Qualifier used by the Gateways,Length of incoming digits
of the RequestURI,Digits to prepend to the Request URI]) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name,[Name of the Number Qualifier used by the
Gateways,Length of incoming digits of the RequestURI,Digits
to prepend to the Request URI]
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
230 Methods for OPI and BPT
OPI method
public void addPreTranslator(java.lang.String domain,
com.nortelnetworks.ims.base.prov.opi.shared.PreTranslatorPE
preTranslator) throws java.rmi.RemoteException, com.norteln
etworks.ims.base.prov.opi.shared.ProvisionException;
Add multiple new Pre-translators (addPreTranslators)
BPT Method Syntax
addPreTranslators using (Domain name,[[Name of the Number
Qualifier used by the Gateways,Length of incoming digits of
the RequestURI,Digits to prepend to the Request URI], ..
,[Name of the Number Qualifier used by the Gateways,Length
of incoming digits of the RequestURI,Digits to prepend to
the Request URI]]) | file &lt;file name&gt; [optional] into &lt;file
name&gt;
BPT Required file format
Domain name,[Name of the Number Qualifier used by the
Gateways,Length of incoming digits of the RequestURI,Digits
to prepend to the Request URI]
OPI method
public void addPreTranslators(java.lang.String domain, com
.nortelnetworks.ims.base.prov.opi.shared.PreTranslatorPE[]
preTranslators) throws java.rmi.RemoteException, com.nortel
networks.ims.base.prov.opi.shared.ProvisionException;
Get Pre-translators for a domain (getPreTranslators)
BPT Method Syntax
getPreTranslators using (Domain name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file form
Domain name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.PreTrans
latorPE[] getPreTranslators(java.lang.String domain) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Telephony Routes Operations 231
Modify a Pre-translator (modifyPreTranslator)
BPT Method Syntax
modifyPreTranslator using (Domain name, Number Qualifier
name, digit length,[Name of the Number Qualifier
used by the Gateways,Length of incoming digits of the
RequestURI,Digits to prepend to the Request URI]) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Number Qualifier name, digit length,[Name
of the Number Qualifier used by the Gateways,Length of
incoming digits of the RequestURI,Digits to prepend to the
Request URI]
OPI method
public void modifyPreTranslator(java.lang.String
domain, java.lang.String oldNumberQualifierName,
int oldDigitLength, com.nortelnetworks.ims.base.pro
v.opi.shared.PreTranslatorPE preTranslator) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Remove a Pre-translator (removePreTranslator)
BPT Method Syntax
removePreTranslator using (Domain name, Number Qualifier
name, Pretranslator digit length) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name, Number Qualifier name, Pretranslator digit
length
OPI method
public void removePreTranslator(java.lang.String domain,
java.lang.String numberQualifierName, int digitLength)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Remove all Pre-translators for a domain (removeAllPreTranslators)
BPT Method Syntax
removeAllPreTranslators using (Domain name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
232 Methods for OPI and BPT
Domain name
OPI method
public void removeAllPreTranslators(java.lang.String
domain) throws java.rmi.RemoteException, com.nortelnetworks
.ims.base.prov.opi.shared.ProvisionException;
Add a new Telephony route (addTelephonyRoute)
BPT Method Syntax
addTelephonyRoute using (Domain name,[The name of the
telephony route,The description describing the function
of the telephony route,The digits from which translation
will be carried out for this telephony route,The digits to
which translation will be carried out for this telephony
route,The minimum number of digits that will be used in
the translations,The maximum number of digits that can
be used in the translations,The number of digits that
will be removed after a translation loop,The prefix used
while translating a number,Specify if the translation
process is to be carried out recursively,[[Name,Value], ..
,[Name,Value]],The type of telephony route Gateway, SIP or
Private]) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name,[The name of the telephony route,The
description describing the function of the telephony
route,The digits from which translation will be carried
out for this telephony route,The digits to which
translation will be carried out for this telephony
route,The minimum number of digits that will be used in
the translations,The maximum number of digits that can
be used in the translations,The number of digits that
will be removed after a translation loop,The prefix used
while translating a number,Specify if the translation
process is to be carried out recursively,[[Name,Value], ..
,[Name,Value]],The type of telephony route Gateway, SIP or
Private]
OPI method
public void addTelephonyRoute(java.lang.String domainName,
com.nortelnetworks.ims.base.prov.opi.shared.TelephonyRoute
teleRoute) throws java.rmi.RemoteException, com.nortelnetwo
rks.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Telephony Routes Operations 233
Add multiple Telephony routes (addTelephonyRoutes)
BPT Method Syntax
addTelephonyRoutes using (Domain name,[[The name of the
telephony route,The description describing the function
of the telephony route,The digits from which translation
will be carried out for this telephony route,The digits to
which translation will be carried out for this telephony
route,The minimum number of digits that will be used in
the translations,The maximum number of digits that can
be used in the translations,The number of digits that
will be removed after a translation loop,The prefix used
while translating a number,Specify if the translation
process is to be carried out recursively,[[Name,Value],
.. ,[Name,Value]],The type of telephony route Gateway,
SIP or Private], .. ,[The name of the telephony
route,The description describing the function of the
telephony route,The digits from which translation will
be carried out for this telephony route,The digits to
which translation will be carried out for this telephony
route,The minimum number of digits that will be used in
the translations,The maximum number of digits that can
be used in the translations,The number of digits that
will be removed after a translation loop,The prefix used
while translating a number,Specify if the translation
process is to be carried out recursively,[[Name,Value], ..
,[Name,Value]],The type of telephony route Gateway, SIP or
Private]]) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name,[The name of the telephony route,The
description describing the function of the telephony
route,The digits from which translation will be carried
out for this telephony route,The digits to which
translation will be carried out for this telephony
route,The minimum number of digits that will be used in
the translations,The maximum number of digits that can
be used in the translations,The number of digits that
will be removed after a translation loop,The prefix used
while translating a number,Specify if the translation
process is to be carried out recursively,[[Name,Value], ..
,[Name,Value]],The type of telephony route Gateway, SIP or
Private]
OPI method
public void addTelephonyRoutes(java.lang.String domainName,
com.nortelnetworks.ims.base.prov.opi.shared.TelephonyRoute
[] teleRoutes) throws java.rmi.RemoteException, com.norteln
etworks.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
234 Methods for OPI and BPT
Modify a telephony route (modifyTelephonyRoute)
BPT Method Syntax
modifyTelephonyRoute using (Domain name,Telephony Route
name,[The name of the telephony route,The description
describing the function of the telephony route,The digits
from which translation will be carried out for this
telephony route,The digits to which translation will be
carried out for this telephony route,The minimum number of
digits that will be used in the translations,The maximum
number of digits that can be used in the translations,The
number of digits that will be removed after a translation
loop,The prefix used while translating a number,Specify
if the translation process is to be carried out
recursively,[[Name,Value], .. ,[Name,Value]],The type of
telephony route Gateway, SIP or Private]) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name,Telephony Route name,[The name of the telephony
route,The description describing the function of the
telephony route,The digits from which translation will
be carried out for this telephony route,The digits to
which translation will be carried out for this telephony
route,The minimum number of digits that will be used in
the translations,The maximum number of digits that can
be used in the translations,The number of digits that
will be removed after a translation loop,The prefix used
while translating a number,Specify if the translation
process is to be carried out recursively,[[Name,Value], ..
,[Name,Value]],The type of telephony route Gateway, SIP or
Private]
OPI method
public void modifyTelephonyRoute(java.lang.String
domainName, java.lang.String routeName, com.nortelnetworks
.ims.base.prov.opi.shared.TelephonyRoute teleRoute) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Remove a telephony route (removeTelephonyRoute)
BPT Method Syntax
removeTelephonyRoute using (Domain name,Route name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name,Route name
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Telephony Routes Operations 235
OPI method
public void removeTelephonyRoute(java.lang.String
domainName, java.lang.String routeName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Remove multiple telephony routes (removeTelephonyRoutes)
BPT Method Syntax
removeTelephonyRoutes using (Domain name,[Route names,
.. ,Route names])| file &lt;file name&gt; [optional] into &lt;file
name&gt;
BPT Required file format
Domain name,Route names
OPI method
public void removeTelephonyRoutes(java.lang.String
domainName, java.lang.String[] routeNames) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get telephony route types (getTelephonyRouteTypes)
BPT Method Syntax
getTelephonyRouteTypes [optional] into &lt;file name&gt;
OPI method
public java.lang.String[] getTelephonyRouteTypes() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get a telephony route in a domain (getTelephonyRoutesByDomain)
BPT Method Syntax
getTelephonyRoutesByDomain using (domain name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
domain name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Telep
honyRoute[] getTelephonyRoutesByDomain(java.lang.String
domainName) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
236 Methods for OPI and BPT
Get a telephony route (getTelephonyRoute)
BPT Method Syntax
getTelephonyRoute using (Domain name, Telephony Route name)
| file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Telephony Route name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.T
elephonyRoute[] getTelephonyRoute(java.lang.String
domainName, java.lang.String routeName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Add a route list (addRouteList)
BPT Method Syntax
addRouteList using (Domain name, Route List) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Route List
OPI method
public void addRouteList(java.lang.String domainName,
com.nortelnetworks.ims.base.prov.opi.shared.RouteList
routeList) throws java.rmi.RemoteException, com.nortelnetwo
rks.ims.base.prov.opi.shared.ProvisionException;
Add multiple route list (addRouteLists)
BPT Method Syntax
addRouteLists using (Domain name, Route Lists) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
domain name, Route list
OPI method
public void addRouteLists(java.lang.String domainName,
com.nortelnetworks.ims.base.prov.opi.shared.RouteList[]
routeList) throws java.rmi.RemoteException, com.nortelnetwo
rks.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Telephony Routes Operations 237
Modify a route list (modifyRouteList)
BPT Method Syntax
modifyRouteList using (Domain Name,Route List name,[The
name of the routelist,The description describing the
function of the routelist,The action to be taken for
calls coming into this routelist from a local domain,The
action to be taken for calls coming into this routelist
from a foreign domain,The class of service for the
routelist,[The names of the telephony routes that belong to
this routelist, .. ,The names of the telephony routes that
belong to this routelist]]) | file &lt;file name&gt; [optional]
into &lt;file name&gt;
BPT Required file format
Domain Name,Route List name,[The name of the routelist,The
description describing the function of the routelist,The
action to be taken for calls coming into this routelist
from a local domain,The action to be taken for calls coming
into this routelist from a foreign domain,The class of
service for the routelist,[The names of the telephony
routes that belong to this routelist, .. ,The names of the
telephony routes that belong to this routelist]]
OPI method
public void modifyRouteList(java.lang.String domainName,
java.lang.String routeListName, com.nortelnetworks.i
ms.base.prov.opi.shared.RouteList routeList) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Remove a route list (removeRouteList)
BPT Method Syntax
removeRouteList using (Domain name,Route List Name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name,Route List Name
OPI method
public void removeRouteList(java.lang.String domainName,
java.lang.String routeListName) throws java.rmi.RemoteExce
ption, com.nortelnetworks.ims.base.prov.opi.shared.Provisi
onException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
238 Methods for OPI and BPT
Remove multiple route lists (removeRouteLists)
BPT Method Syntax
removeRouteLists using (Domain name,[Route List Names,
.. ,Route List Names]) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
BPT Required file format
Domain name,Route List Names
OPI method
public void removeRouteLists(java.lang.String domainName,
java.lang.String[] routeListNames) throws java.rmi.RemoteEx
ception, com.nortelnetworks.ims.base.prov.opi.shared.Pro
visionException;
Remove all telephony routes from a route list (removeAllTelephonyRoutesFromRouteList)
BPT Method Syntax
removeAllTelephonyRoutesFromRouteList using (Domain
name,Route List name) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
BPT Required file format
Domain name,Route List name
OPI method
public void removeAllTelephonyRoutesFromRouteList(java.lang
.String domainName, java.lang.String routeListName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Remove a telephony route from route list (removeTelephonyRouteFromRouteList)
BPT Method Syntax
removeTelephonyRouteFromRouteList using (Domain name,Route
List name,RouteName) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
BPT Required file format
Domain name,Route List name,RouteName
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Telephony Routes Operations 239
OPI method
public void removeTelephonyRouteFromRouteList(java.lang.Str
ing domainName, java.lang.String routeListName, java.lang.S
tring routeName) throws java.rmi.RemoteException, com.norte
lnetworks.ims.base.prov.opi.shared.ProvisionException;
Get route lists by domain (getRouteListByDomain)
BPT Method Syntax
getRouteListByDomain using (Domain name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Route
List[] getRouteListByDomain(java.lang.String domainName)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Get a route list by name (getRouteListByName)
BPT Method Syntax
getRouteListByName using (Domain name,RouteList name) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name,RouteList name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shar
ed.RouteList getRouteListByName(java.lang.String
domainName, java.lang.String routeName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get a route list by Class Of Service (getRouteListByClassOfService)
BPT Method Syntax
getRouteListByClassOfService using (Domain name,Class of
service) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name,Class of service
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
240 Methods for OPI and BPT
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Rou
teList[] getRouteListByClassOfService(java.lang.String
domainName, java.lang.String classOfService) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get route list actions (getRouteListActions)
BPT Method Syntax
getRouteListActions [optional] into &lt;file name&gt;
OPI method
public java.lang.String[] getRouteListActions() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get translation destinations (getDestinations)
BPT Method Syntax
getDestinations using () | file &lt;file name&gt; [optional] into
&lt;file name&gt;
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.XLAToolD
ata getDestinations(java.lang.String uri, java.lang.String
to, java.lang.String from) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Add Direct To Gateway service prefix for a domain (assignDirectToGatewayPrefixData)
BPT Method Syntax
assignDirectToGatewayPrefixData using (Domain name, Prefix)
| file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Prefix
OPI method
public void assignDirectToGatewayPrefixData(java.lang
.String domain, java.lang.String domPrefixData) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Voicemail Operations 241
Get Direct To Gateway service prefix for a domain (getDirectToGWPrefixData)
BPT Method Syntax
getDirectToGWPrefixData using (Domain name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain Name
OPI method
public java.lang.String getDirectToGWPrefixData(java.lang.S
tring domain) throws java.rmi.RemoteException, com.nortelne
tworks.ims.base.prov.opi.shared.ProvisionException;
Remove Direct To Gateway service prefix for a domain
(removeDirectToGWPrefixData)
BPT Method Syntax
removeDirectToGWPrefixData using (Domain name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
DomainName
OPI method
public void removeDirectToGWPrefixData(java.lang.String
domain) throws java.rmi.RemoteException, com.nortelnetworks
.ims.base.prov.opi.shared.ProvisionException;
Voicemail Operations
This section contains the following:
•
&quot;Add a Voicemail Server Host (addVoicemailServerHost)&quot; (page 242)
•
&quot;Modify a Voicemail Server Host (modifyVoicemailServerHost)&quot; (page
243)
•
&quot;Remove a Voicemail Server Host (removeVoicemailServerHost)&quot; (page
243)
•
&quot;Get Voicemail Servers Host (getVoicemailServerHost)&quot; (page 243)
•
&quot;Get all Voicemail Server Hosts (getAllVoicemailServerHosts)&quot; (page
244)
•
&quot;Get all Voicemail Server Host Types (getAllVoicemailServerHostTypes)&quot;
(page 244)
•
&quot;Add a SIP Voicemail Server (addSIPVoicemailServer)&quot; (page 244)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
242 Methods for OPI and BPT
•
&quot;Modify a SIP Voicemail Server (modifySIPVoicemailServer)&quot; (page 245)
•
&quot;Remove a SIP Voicemail Server (removeSIPVoicemailServer)&quot; (page
246)
•
&quot;Get all SIP Voicemail Servers (getAllSIPVoicemailServers)&quot; (page 246)
•
&quot;Get all SIP Voicemail Servers for a domain (getAllSIPVoicemailServersByDomain)&quot; (page 246)
•
&quot;Add a Trunk Voicemail Server (addTrunkVoicemailServer)&quot; (page 247)
•
&quot;Modify a Trunk Voicemail Server (modifyTrunkVoicemailServer)&quot; (page
248)
•
&quot;Remove a Trunk Voicemail Server (removeTrunkVoicemailServer)&quot;
(page 249)
•
&quot;Get all Trunk Voicemail Servers of a particular trunk type
(getAllTrunkVoicemailServers)&quot; (page 249)
•
&quot;Get Trunk Voicemail Servers by domain (getTrunkVoicemailServerByDomain)&quot; (page 249)
•
&quot;Add a Line Voicemail Server (addLineVoicemailServer)&quot; (page 250)
•
&quot;Modify a Line Voicemail Server (modifyLineVoicemailServer)&quot; (page
251)
•
&quot;Remove a Line Voicemail Server (removeLineVoicemailServer)&quot; (page
253)
•
&quot;Get Line Voicemail Servers for a domain (getLineVoicemailServerByDomain)&quot; (page 253)
•
&quot;Get all Line Voicemail Server (getAllLineVoicemailServers)&quot; (page 253)
•
&quot;Get all Voicemail Servers (getAllVoicemailServers)&quot; (page 253)
•
&quot;Get all Voicemail Servers for a domain (getAllVoicemailServersByDomain)&quot; (page 254)
•
&quot;Get all users for Voicemail Server (getUsersForVoicemailServer)&quot;
(page 254)
Add a Voicemail Server Host (addVoicemailServerHost)
BPT Method Syntax
addVoicemailServerHost using (Voicemail Server Host) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Voicemail Server Host
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Voicemail Operations 243
OPI method
public void addVoicemailServerHost(com.nortelnetwo
rks.ims.base.prov.opi.shared.VMHost vmHost) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Modify a Voicemail Server Host (modifyVoicemailServerHost)
BPT Method Syntax
modifyVoicemailServerHost using (Hostname, Voicemail Server
Host) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Hostname, Voicemail Server Host
OPI method
public void modifyVoicemailServerHost(java.lang.String host
Name, com.nortelnetworks.ims.base.prov.opi.shared.VMHost
vmHost) throws java.rmi.RemoteException, com.nortelnetworks
.ims.base.prov.opi.shared.ProvisionException;
Remove a Voicemail Server Host (removeVoicemailServerHost)
BPT Method Syntax
removeVoicemailServerHost using (Hostname) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Hostname
OPI method
public void removeVoicemailServerHost(java.lang.String
hostName) throws java.rmi.RemoteException, com.nortelnetwor
ks.ims.base.prov.opi.shared.ProvisionException;
Get Voicemail Servers Host (getVoicemailServerHost)
BPT Method Syntax
getVoicemailServerHost using (Hostname) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Hostname
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
244 Methods for OPI and BPT
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.VMHost
getVoicemailServerHost(java.lang.String hostName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get all Voicemail Server Hosts (getAllVoicemailServerHosts)
BPT Method Syntax
getAllVoicemailServerHosts [optional] into &lt;file name&gt;
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.VMHost[]
getAllVoicemailServerHosts() throws java.rmi.RemoteExcepti
on, com.nortelnetworks.ims.base.prov.opi.shared.ProvisionE
xception;
Get all Voicemail Server Host Types (getAllVoicemailServerHostTypes)
BPT Method Syntax
getAllVoicemailServerHostTypes using [optional] into &lt;file
name&gt;
OPI method
public java.lang.String[] getAllVoicemailServerHostTypes()
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Add a SIP Voicemail Server (addSIPVoicemailServer)
BPT Method Syntax
addSIPVoicemailServer using ([The name of the voicemail
server,the type of voicemail server,The client contact
for the voicemail, right now the string voicemail is
used,The address of the appserver which will be used by
the voicemail server in an n+m scenario,The maximum amount
of time that the call will be tried before rolling off to
voicemail,[The domains that the voicemail server would
serve, .. ,The domains that the voicemail server would
serve],[The host of the SIP voicemail server, .. ,The
host of the SIP voicemail server]]) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Voicemail Operations 245
[The name of the voicemail server,the type of voicemail
server,The client contact for the voicemail, right now the
string voicemail is used,The address of the appserver which
will be used by the voicemail server in an n+m scenario,The
maximum amount of time that the call will be tried before
rolling off to voicemail,[The domains that the voicemail
server would serve, .. ,The domains that the voicemail
server would serve],[The host of the SIP voicemail server,
.. ,The host of the SIP voicemail server]]
OPI method
public void addSIPVoicemailServer(com.nortelnetworks.ims
.base.prov.opi.shared.SIPVoicemailServer sipVms) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Modify a SIP Voicemail Server (modifySIPVoicemailServer)
BPT Method Syntax
modifySIPVoicemailServer using (Server name,[The name of
the voicemail server,the type of voicemail server,The
client contact for the voicemail, right now the string
voicemail is used,The address of the appserver which will
be used by the voicemail server in an n+m scenario,The
maximum amount of time that the call will be tried before
rolling off to voicemail,[The domains that the voicemail
server would serve, .. ,The domains that the voicemail
server would serve],[The host of the SIP voicemail server,
.. ,The host of the SIP voicemail server]]) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Server name,[The name of the voicemail server,the type of
voicemail server,The client contact for the voicemail,
right now the string voicemail is used,The address of the
appserver which will be used by the voicemail server in
an n+m scenario,The maximum amount of time that the call
will be tried before rolling off to voicemail,[The domains
that the voicemail server would serve, .. ,The domains
that the voicemail server would serve],[The host of the
SIP voicemail server, .. ,The host of the SIP voicemail
server]]
OPI method
public void modifySIPVoicemailServer(java.lang.String
serverName, com.nortelnetworks.ims.base.prov.opi.shared.SIP
VoicemailServer sipVms) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
246 Methods for OPI and BPT
Remove a SIP Voicemail Server (removeSIPVoicemailServer)
BPT Method Syntax
removeSIPVoicemailServer using (Server name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Server name
OPI method
public void removeSIPVoicemailServer(java.lang.String
serverName) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Get all SIP Voicemail Servers (getAllSIPVoicemailServers)
BPT Method Syntax
getAllSIPVoicemailServers [optional] into &lt;file name&gt;
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.SI
PVoicemailServer[] getAllSIPVoicemailServers() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get all SIP Voicemail Servers for a domain (getAllSIPVoicemailServersByDomain)
BPT Method Syntax
getAllSIPVoicemailServersByDomain using (Domain name) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.SIPVoice
mailServer[] getAllSIPVoicemailServersByDomain(java.lang.St
ring domainName) throws java.rmi.RemoteException, com.norte
lnetworks.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Voicemail Operations 247
Add a Trunk Voicemail Server (addTrunkVoicemailServer)
BPT Method Syntax
addTrunkVoicemailServer using ([The name of the voicemail
server,the type of voicemail server,The client contact
for the voicemail, right now the string voicemail is
used,The address of the appserver which will be used by
the voicemail server in an n+m scenario,The maximum amount
of time that the call will be tried before rolling off to
voicemail,[The domains that the voicemail server would
serve, .. ,The domains that the voicemail server would
serve],The username which will be used for opening a telnet
session to the SMDI Server,The password which will be
used for opening a telnet session to the SMDI Server,The
terminal server name,The port onto which the telnet
session is opened to on the terminal server,The address of
the terminal server,The version of SMDI on the terminal
server,[The host of the trunk voicemail server, .. ,The
host of the trunk voicemail server]]) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
[The name of the voicemail server,the type of voicemail
server,The client contact for the voicemail, right now the
string voicemail is used,The address of the appserver which
will be used by the voicemail server in an n+m scenario,The
maximum amount of time that the call will be tried before
rolling off to voicemail,[The domains that the voicemail
server would serve, .. ,The domains that the voicemail
server would serve],The username which will be used for
opening a telnet session to the SMDI Server,The password
which will be used for opening a telnet session to the
SMDI Server,The terminal server name,The port onto which
the telnet session is opened to on the terminal server,The
address of the terminal server,The version of SMDI on the
terminal server,[The host of the trunk voicemail server, ..
,The host of the trunk voicemail server]]
OPI method
public void addTrunkVoicemailServer(com.nortelnetworks.ims
.base.prov.opi.shared.TrunkVoicemailServer trunkVms) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
248 Methods for OPI and BPT
Modify a Trunk Voicemail Server (modifyTrunkVoicemailServer)
BPT Method Syntax
modifyTrunkVoicemailServer using (Server name,[The name
of the voicemail server,the type of voicemail server,The
client contact for the voicemail, right now the string
voicemail is used,The address of the appserver which will
be used by the voicemail server in an n+m scenario,The
maximum amount of time that the call will be tried before
rolling off to voicemail,[The domains that the voicemail
server would serve, .. ,The domains that the voicemail
server would serve],The username which will be used for
opening a telnet session to the SMDI Server,The password
which will be used for opening a telnet session to the
SMDI Server,The terminal server name,The port onto which
the telnet session is opened to on the terminal server,The
address of the terminal server,The version of SMDI on the
terminal server,[The host of the trunk voicemail server,
.. ,The host of the trunk voicemail server]]) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Server name,[The name of the voicemail server,the type of
voicemail server,The client contact for the voicemail,
right now the string voicemail is used,The address of the
appserver which will be used by the voicemail server in an
n+m scenario,The maximum amount of time that the call will
be tried before rolling off to voicemail,[The domains that
the voicemail server would serve, .. ,The domains that the
voicemail server would serve],The username which will be
used for opening a telnet session to the SMDI Server,The
password which will be used for opening a telnet session
to the SMDI Server,The terminal server name,The port onto
which the telnet session is opened to on the terminal
server,The address of the terminal server,The version
of SMDI on the terminal server,[The host of the trunk
voicemail server, .. ,The host of the trunk voicemail
server]]
OPI method
public void modifyTrunkVoicemailServer(java.lang.String
serverName, com.nortelnetworks.ims.base.prov.op
i.shared.TrunkVoicemailServer trunkVms) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Voicemail Operations 249
Remove a Trunk Voicemail Server (removeTrunkVoicemailServer)
BPT Method Syntax
removeTrunkVoicemailServer using (Server name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Server name
OPI method
public void removeTrunkVoicemailServer(java.lang.String
serverName) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Get all Trunk Voicemail Servers of a particular trunk type
(getAllTrunkVoicemailServers)
BPT Method Syntax
getAllTrunkVoicemailServers using (Trunk type) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Trunk type
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.TrunkVoi
cemailServer[] getAllTrunkVoicemailServers(java.lang.String
trunkType) throws java.rmi.RemoteException, com.nortelnetwo
rks.ims.base.prov.opi.shared.ProvisionException;
Get Trunk Voicemail Servers by domain (getTrunkVoicemailServerByDomain)
BPT Method Syntax
getTrunkVoicemailServerByDomain using (Domain name, Server
type) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Server type
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.TrunkVoi
cemailServer[] getTrunkVoicemailServerByDomain(java.lang.S
tring domainName, java.lang.String trunkServerName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
250 Methods for OPI and BPT
Add a Line Voicemail Server (addLineVoicemailServer)
BPT Method Syntax
addLineVoicemailServer using ([The name of the voicemail
server,the type of voicemail server,The client contact
for the voicemail, right now the string voicemail is
used,The address of the appserver which will be used
by the voicemail server in an n+m scenario,The maximum
amount of time that the call will be tried before rolling
off to voicemail,[The domains that the voicemail server
would serve, .. ,The domains that the voicemail server
would serve],The username which will be used for opening
a telnet session to the SMDI Server,The password which
will be used for opening a telnet session to the SMDI
Server,The terminal server name,The port onto which the
telnet session is opened to on the terminal server,The
address of the terminal server,The version of SMDI on
the terminal server,[[The host that the voicemail server
resides,[[The line number for the line used in the line
based voicemail server,message desk for the line voicemail
server,position number for the line in the set of lines
for the line voicemail server], .. ,[The line number for
the line used in the line based voicemail server,message
desk for the line voicemail server,position number for the
line in the set of lines for the line voicemail server]]],
.. ,[The host that the voicemail server resides,[[The
line number for the line used in the line based voicemail
server,message desk for the line voicemail server,position
number for the line in the set of lines for the line
voicemail server], .. ,[The line number for the line used
in the line based voicemail server,message desk for the
line voicemail server, position number for the line in the
set of lines for the line voicemail server]]]]]) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
[The name of the voicemail server,the type of voicemail
server,The client contact for the voicemail, right now the
string voicemail is used,The address of the appserver which
will be used by the voicemail server in an n+m scenario,The
maximum amount of time that the call will be tried before
rolling off to voicemail,[The domains that the voicemail
server would serve, .. ,The domains that the voicemail
server would serve],The username which will be used for
opening a telnet session to the SMDI Server,The password
which will be used for opening a telnet session to the
SMDI Server,The terminal server name,The port onto which
the telnet session is opened to on the terminal server,The
address of the terminal server,The version of SMDI on
the terminal server,[[The host that the voicemail server
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Voicemail Operations 251
resides,[[The line number for the line used in the line
based voicemail server,message desk for the line voicemail
server,position number for the line in the set of lines
for the line voicemail server], .. ,[The line number for
the line used in the line based voicemail server,message
desk for the line voicemail server,position number for the
line in the set of lines for the line voicemail server]]],
.. ,[The host that the voicemail server resides,[[The
line number for the line used in the line based voicemail
server,message desk for the line voicemail server,position
number for the line in the set of lines for the line
voicemail server], .. ,[The line number for the line used
in the line based voicemail server,message desk for the
line voicemail server,position number for the line in the
set of lines for the line voicemail server]]]]]
OPI method
public void addLineVoicemailServer(com.nortelnetworks.im
s.base.prov.opi.shared.LineVoicemailServer lineVms) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Modify a Line Voicemail Server (modifyLineVoicemailServer)
BPT Method Syntax
modifyLineVoicemailServer using (Server name,[The name
of the voicemail server,the type of voicemail server,The
client contact for the voicemail, right now the string
voicemail is used,The address of the appserver which will
be used by the voicemail server in an n+m scenario,The
maximum amount of time that the call will be tried before
rolling off to voicemail,[The domains that the voicemail
server would serve, .. ,The domains that the voicemail
server would serve],The username which will be used for
opening a telnet session to the SMDI Server,The password
which will be used for opening a telnet session to the
SMDI Server,The terminal server name,The port onto which
the telnet session is opened to on the terminal server,The
address of the terminal server,The version of SMDI on
the terminal server,[[The host that the voicemail server
resides,[[The line number for the line used in the line
based voicemail server,message desk for the line voicemail
server,position number for the line in the set of lines
for the line voicemail server], .. ,[The line number for
the line used in the line based voicemail server,message
desk for the line voicemail server,position number for the
line in the set of lines for the line voicemail server]]],
.. ,[The host that the voicemail server resides,[[The
line number for the line used in the line based voicemail
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
252 Methods for OPI and BPT
server,message desk for the line voicemail server,position
number for the line in the set of lines for the line
voicemail server], .. ,[The line number for the line used
in the line based voicemail server,message desk for the
line voicemail server,position number for the line in the
set of lines for the line voicemail server]]]]]) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Server name,[The name of the voicemail server,the type of
voicemail server,The client contact for the voicemail,
right now the string voicemail is used,The address of the
appserver which will be used by the voicemail server in
an n+m scenario,The maximum amount of time that the call
will be tried before rolling off to voicemail,[The domains
that the voicemail server would serve, .. ,The domains
that the voicemail server would serve],The username which
will be used for opening a telnet session to the SMDI
Server,The password which will be used for opening a telnet
session to the SMDI Server,The terminal server name,The
port onto which the telnet session is opened to on the
terminal server,The address of the terminal server,The
version of SMDI on the terminal server,[[The host that
the voicemail server resides,[[The line number for the
line used in the line based voicemail server,message desk
for the line voicemail server,position number for the
line in the set of lines for the line voicemail server],
.. ,[The line number for the line used in the line based
voicemail server,message desk for the line voicemail
server,position number for the line in the set of lines
for the line voicemail server]]], .. ,[The host that the
voicemail server resides,[[The line number for the line
used in the line based voicemail server,message desk for
the line voicemail server,position number for the line in
the set of lines for the line voicemail server], .. ,[The
line number for the line used in the line based voicemail
server,message desk for the line voicemail server,position
number for the line in the set of lines for the line
voicemail server]]]]]
OPI method
public void modifyLineVoicemailServer(java.lang.String
serverName, com.nortelnetworks.ims.base.prov.opi.shared.Lin
eVoicemailServer lineVms) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Voicemail Operations 253
Remove a Line Voicemail Server (removeLineVoicemailServer)
BPT Method Syntax
removeLineVoicemailServer using (Server name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Server name
OPI method
public void removeLineVoicemailServer(java.lang.String
serverName) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Get Line Voicemail Servers for a domain (getLineVoicemailServerByDomain)
BPT Method Syntax
getLineVoicemailServerByDomain using (Domain name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.LineVoic
emailServer[] getLineVoicemailServerByDomain(java.lang.Stri
ng domain) throws java.rmi.RemoteException, com.nortelnetwo
rks.ims.base.prov.opi.shared.ProvisionException;
Get all Line Voicemail Server (getAllLineVoicemailServers)
BPT Method Syntax
getAllLineVoicemailServers [optional] into &lt;file name&gt;
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Lin
eVoicemailServer[] getAllLineVoicemailServers() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get all Voicemail Servers (getAllVoicemailServers)
BPT Method Syntax
getAllVoicemailServers [optional] into &lt;file name&gt;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
254 Methods for OPI and BPT
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared
.VoicemailServer[] getAllVoicemailServers() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get all Voicemail Servers for a domain (getAllVoicemailServersByDomain)
BPT Method Syntax
getAllVoicemailServersByDomain using (Domain name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Voicema
ilServer[] getAllVoicemailServersByDomain(java.lang.String
domainName) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Get all users for Voicemail Server (getUsersForVoicemailServer)
BPT Method Syntax
getUsersForVoicemailServer using (Voicemail server name) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Voicemail server name
OPI method
public java.lang.String[] getUsersForVoicemailS
erver(java.lang.String voicemailServers) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Addressbook Operations
This section contains the following:
•
&quot;Add address book entry for a User (addAddressBookEntry)&quot; (page 256)
•
&quot;Add multiple address book entries for a User (addAddressBookEntries)&quot;
(page 257)
•
&quot;Modify an address book entry for a User (modifyAddressBookEntry)&quot;
(page 258)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Addressbook Operations 255
•
&quot;Modify address book entries for a User (modifyAddressBookEntries)&quot;
(page 258)
•
&quot;Remove address book entries for a User (removeAddressBookEntries)&quot;
(page 259)
•
&quot;Remove an address book entry for a User (removeAddressBookEntry)&quot;
(page 260)
•
&quot;Remove address book for a User (removeUserAddressBook)&quot; (page
260)
•
&quot;Remove address book for a User (removeAddressBook)&quot; (page 260)
•
&quot;Get address book for a User (getAddressBook)&quot; (page 261)
•
&quot;Remove a buddy from a users address book (removeBuddy)&quot; (page
261)
•
&quot;Get buddies from the address book of a User (getBuddies)&quot; (page 261)
•
&quot;Add a banned user (addBannedUser)&quot; (page 262)
•
&quot;Add banned users (addBannedUsers)&quot; (page 262)
•
&quot;Modify a banned user (modifyBannedUser)&quot; (page 262)
•
&quot;Get the banned users for a User (getBannedUsers)&quot; (page 263)
•
&quot;Remove a banned user for a User (removeBannedUser)&quot; (page 263)
•
&quot;Remove all banned users for a User (removeAllBannedUsers)&quot; (page
263)
•
&quot;Get all address book groups for a User (getAddressBookGroups)&quot;
(page 264)
•
&quot;Add new group to the address book of a User (addAddressBookGroup)&quot;
(page 264)
•
&quot;Add new groups to the address book of a User (addAddressBookGroups)&quot; (page 264)
•
&quot;Modify address book group names for a User (modifyAddressBookGroups)&quot; (page 265)
•
&quot;Remove address book group of a User (removeAddressBookGroup)&quot;
(page 265)
•
&quot;Rename address book group of a User (renameAddressBookGroup)&quot;
(page 265)
•
&quot;Add users to the address book of a User (addUsersToAddressBook)&quot;
(page 266)
•
&quot;Get an addressbook entry (getAddressBookEntry)&quot; (page 266)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
256 Methods for OPI and BPT
•
&quot;Get address book for a User with photo urls (getAddressBookWithPhoto)&quot; (page 267)
•
&quot;Get an addressbook entry with photo url (getFullAddressBookEntry)&quot;
(page 267)
•
&quot;Get address book for a User without photo urls (getLightWeightAddressBook)&quot; (page 267)
•
&quot;Make this entry a buddy (makeBuddy)&quot; (page 268)
Add address book entry for a User (addAddressBookEntry)
BPT Method Syntax
addAddressBookEntry using (User name,[The nickname for the
entry,Users first name,Users last name,Home phone,Business
phone,Business phone extension,Fax,Mobile phone
number,Pager,Home address street information,Home address
city information,Home address state information,Home
address zip information,Email address of the user,Web
address of the user,Primary contact for the user,Notes
on the user,Specify the group user belongs to in the
addressbook,Specify if user is buddy or not]) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name,[The nickname for the entry,Users first
name,Users last name,Home phone,Business phone,Business
phone extension,Fax,Mobile phone number,Pager,Home address
street information,Home address city information,Home
address state information,Home address zip information,
Email address of the user,Web address of the user,Primary
contact for the user,Notes on the user,Specify the group
user belongs to in the addressbook,Specify if user is buddy
or not]
OPI method
public void addAddressBookEntry(java.lang.String userName,
com.nortelnetworks.ims.base.prov.opi.shared.AddressBookEntr
y addrBookEntry) throws java.rmi.RemoteException, com.norte
lnetworks.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Addressbook Operations 257
Add multiple address book entries for a User (addAddressBookEntries)
BPT Method Syntax
addAddressBookEntries using (User name,[[The nickname
for the entry,Users first name,Users last name,Home
phone,Business phone,Business phone extension,Fax,
Mobile phone number,Pager,Home address street informa
tion,Home address city information,Home address state
information,Home address zip information,Email address
of the user,Web address of the user,Primary contact for
the user,Notes on the user,Specify the group user belongs
to in the addressbook,Specify if user is buddy or not],
.. ,[The nickname for the entry,Users first name,Users
last name,Home phone,Business phone,Business phone
extension,Fax,Mobile phone number,Pager,Home address street
information,Home address city information,Home address
state information,Home address zip information,Email
address of the user,Web address of the user,Primary contact
for the user,Notes on the user,Specify the group user
belongs to in the addressbook,Specify if user is buddy or
not]]) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name,[The nickname for the entry,Users first
name,Users last name,Home phone,Business phone,Business
phone extension,Fax,Mobile phone number,Pager,Home address
street information,Home address city information,Home
address state information,Home address zip information,
Email address of the user,Web address of the user,Primary
contact for the user,Notes on the user,Specify the group
user belongs to in the addressbook,Specify if user is buddy
or not]
OPI method
public void addAddressBookEntries(java.lang.String
userName, com.nortelnetworks.ims.base.prov.opi.s
hared.AddressBookEntry[] addrBookEntries) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
258 Methods for OPI and BPT
Modify an address book entry for a User (modifyAddressBookEntry)
BPT Method Syntax
modifyAddressBookEntry using (User name, Nick name,[The
nickname for the entry,Users first name,Users last
name,Home phone,Business phone,Business phone extension,
Fax,Mobile phone number,Pager,Home address street
information,Home address city information,Home address
state information,Home address zip information,Email
address of the user,Web address of the user,Primary contact
for the user,Notes on the user,Specify the group user
belongs to in the addressbook,Specify if user is buddy or
not]) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name, Nick name,[The nickname for the entry,Users
first name,Users last name,Home phone,Business
phone,Business phone extension,Fax,Mobile phone
number,Pager,Home address street information,Home address
city information,Home address state information,Home
address zip information,Email address of the user,Web
address of the user,Primary contact for the user,Notes
on the user,Specify the group user belongs to in the
addressbook,Specify if user is buddy or not]
OPI method
public void modifyAddressBookEntry(java.lang.String
userName, java.lang.String nickName, com.nortelnetworks.i
ms.base.prov.opi.shared.AddressBookEntry addrBookEntry)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Modify address book entries for a User (modifyAddressBookEntries)
BPT Method Syntax
modifyAddressBookEntries using (User name,[ Nick names,
.. , Nick names],[[The nickname for the entry,Users first
name,Users last name,Home phone,Business phone,Business
phone extension,Fax,Mobile phone number,Pager,Home address
street information,Home address city information,Home
address state information,Home address zip information,
Email address of the user,Web address of the user,Primary
contact for the user,Notes on the user,Specify the
group user belongs to in the addressbook,Specify if
user is buddy or not], .. ,[The nickname for the
entry,Users first name,Users last name,Home phone,Business
phone,Business phone extension,Fax,Mobile phone
number,Pager,Home address street information,Home address
city information,Home address state information,Home
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Addressbook Operations 259
address zip information,Email address of the user,Web
address of the user,Primary contact for the user,Notes
on the user,Specify the group user belongs to in the
addressbook,Specify if user is buddy or not]]) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name,[ Nick names, .. , Nick names],[[The nickname
for the entry,Users first name,Users last name,Home
phone,Business phone,Business phone extension,
Fax,Mobile phone number,Pager,Home address street
information,Home address city information,Home address
state information,Home address zip information,Email
address of the user,Web address of the user,Primary
contact for the user,Notes on the user,Specify the
group user belongs to in the addressbook,Specify if
user is buddy or not], .. ,[The nickname for the
entry,Users first name,Users last name,Home phone,Business
phone,Business phone extension,Fax,Mobile phone
number,Pager,Home address street information,Home address
city information,Home address state information,Home
address zip information,Email address of the user,Web
address of the user,Primary contact for the user,Notes
on the user,Specify the group user belongs to in the
addressbook,Specify if user is buddy or not]]
OPI method
public void modifyAddressBookEntries(java.lang.String
userName, java.lang.String[] nickNames, com.norteln
etworks.ims.base.prov.opi.shared.AddressBookEntry[]
addrBookEntries) throws java.rmi.RemoteException, com.norte
lnetworks.ims.base.prov.opi.shared.ProvisionException;
Remove address book entries for a User (removeAddressBookEntries)
BPT Method Syntax
removeAddressBookEntries using (User name,[ Nick names, ..
, Nick names]) | file &lt;file name&gt; [optional] into &lt;file
name&gt;
BPT Required file format
User name,[ Nick names, ..
, Nick names]
OPI method
public void removeAddressBookEntries(java.lang.String
userName, java.lang.String[] nickNames) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
260 Methods for OPI and BPT
Remove an address book entry for a User (removeAddressBookEntry)
BPT Method Syntax
removeAddressBookEntry using (User name, Nick name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name, Nick name
OPI method
public void removeAddressBookEntry(java.lang.String
userName, java.lang.String nickName) throws java.rmi.Remote
Exception, com.nortelnetworks.ims.base.prov.opi.shared.Pro
visionException;
Remove address book for a User (removeUserAddressBook)
BPT Method Syntax
removeAddressBook using ([User names, .. ,User names]) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
[User names, ..
,User names]
OPI method
public void removeAddressBook(java.lang.String[] userNames)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Remove address book for a User (removeAddressBook)
BPT Method Syntax
removeAddressBook using (User name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
userName
OPI method
public void removeAddressBook(java.lang.String[] userNames)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Addressbook Operations 261
Get address book for a User (getAddressBook)
BPT Method Syntax
getAddressBook using (User name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
User name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.AddressB
ookEntry[] getAddressBook(java.lang.String userName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Remove a buddy from a users address book (removeBuddy)
BPT Method Syntax
removeBuddy using (User name, buddy name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name, buddy name
OPI method
public void removeBuddy(java.lang.String userName, java.lan
g.String buddyName) throws java.rmi.RemoteException, com.no
rtelnetworks.ims.base.prov.opi.shared.ProvisionException;
Get buddies from the address book of a User (getBuddies)
BPT Method Syntax
getBuddies using (User name) | file &lt;file name&gt; [optional]
into &lt;file name&gt;
BPT Required file format
User name
OPI method
public java.lang.String[] getBuddies(java.lang.String
userName) throws java.rmi.RemoteException, com.nortelnetwor
ks.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
262 Methods for OPI and BPT
Add a banned user (addBannedUser)
BPT Method Syntax
addBannedUser using (User name, Banned user name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name, Banned user name
OPI method
public void addBannedUser(java.lang.String userName, java.l
ang.String bannedUserName) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Add banned users (addBannedUsers)
BPT Method Syntax
addBannedUsers using (User name, Banned user names) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name, Banned user names
OPI method
public void addBannedUsers(java.lang.String userName,
java.lang.String[] bannedUserNames) throws java.rmi.Remote
Exception, com.nortelnetworks.ims.base.prov.opi.shared.Pro
visionException;
Modify a banned user (modifyBannedUser)
BPT Method Syntax
modifyBannedUser using (User name, Banned user name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name, Banned user name
OPI method
public void modifyBannedUser(java.lang.String userName,
java.lang.String bannedUserName) throws java.rmi.RemoteExce
ption, com.nortelnetworks.ims.base.prov.opi.shared.Provisi
onException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Addressbook Operations 263
Get the banned users for a User (getBannedUsers)
BPT Method Syntax
getBannedUsers using (User name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
User name
OPI method
public java.lang.String[] getBannedUsers(java.lang.String
userName) throws java.rmi.RemoteException, com.nortelnetwor
ks.ims.base.prov.opi.shared.ProvisionException;
Remove a banned user for a User (removeBannedUser)
BPT Method Syntax
removeBannedUser using (User name, Banned User name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name, Banned User name
OPI method
public void removeBannedUser(java.lang.String userName,
java.lang.String bannedUserName) throws java.rmi.RemoteExce
ption, com.nortelnetworks.ims.base.prov.opi.shared.Provisi
onException;
Remove all banned users for a User (removeAllBannedUsers)
BPT Method Syntax
removeAllBannedUsers using (User name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
User name
OPI method
public void removeAllBannedUsers(java.lang.String userName)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
264 Methods for OPI and BPT
Get all address book groups for a User (getAddressBookGroups)
BPT Method Syntax
getAddressBookGroups using (User name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
User name
OPI method
public java.lang.String[] getAddressBookGroups(java.lang.St
ring userName) throws java.rmi.RemoteException, com.norteln
etworks.ims.base.prov.opi.shared.ProvisionException;
Add new group to the address book of a User (addAddressBookGroup)
BPT Method Syntax
addAddressBookGroup using (User name, group name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name, group name
OPI method
public void addAddressBookGroup(java.lang.String userName,
java.lang.String groupName) throws java.rmi.RemoteExcept
ion, com.nortelnetworks.ims.base.prov.opi.shared.Provisi
onException;
Add new groups to the address book of a User (addAddressBookGroups)
BPT Method Syntax
addAddressBookGroups using (User name, group names) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name, group names
OPI method
public void addAddressBookGroups(java.lang.String
userName, java.lang.String[] groupNames) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Addressbook Operations 265
Modify address book group names for a User (modifyAddressBookGroups)
BPT Method Syntax
modifyAddressBookGroups using (User name,[ group names, ..
, group names]) | file &lt;file name&gt; [optional] into &lt;file
name&gt;
BPT Required file format
User name,[ group names, ..
, group names]
OPI method
public void modifyAddressBookGroups(java.lang.String
userName, java.lang.String[] groupName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Remove address book group of a User (removeAddressBookGroup)
BPT Method Syntax
removeAddressBookGroup using (User name, group name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name, group name
OPI method
public void removeAddressBookGroup(java.lang.String
userName, java.lang.String groupName) throws java.rmi.Remot
eException, com.nortelnetworks.ims.base.prov.opi.shared.Pro
visionException;
Rename address book group of a User (renameAddressBookGroup)
BPT Method Syntax
renameAddressBookGroup using (User name, group name,updated
group name) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name, group name,updated group name
OPI method
public void renameAddressBookGroup(java.lang.String
userName, java.lang.String groupName, java.lang.String
updatedGroupName) throws java.rmi.RemoteException, com.nort
elnetworks.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
266 Methods for OPI and BPT
Add users to the address book of a User (addUsersToAddressBook)
BPT Method Syntax
addUsersToAddressBook using (User name,[[The user
name,Users first name,Users last name,Password,Home
phone,Cell phone,Pager,Fax,Email,Office phone number,Voice
mail,User picture,Status,status reason,Voicemail
server,Charge ID,Private Charge ID,Public Charge
ID,VPN,Class of service,Time zone,User Locale,User
service package,[List of User aliases, .. ,List of
User aliases],[List of blended aliases, .. ,List of
blended aliases],[User routes, .. ,User routes],[Display
name,Registration timer give in seconds,Name of the
IPCM]], .. ,[The user name,Users first name,Users last
name,Password,Home phone,Cell phone,Pager,Fax,Email,Office
phone number,Voice mail,User picture,Status,status
reason,Voicemail server,Charge ID,Private Charge ID,Public
Charge ID,VPN,Class of service,Time zone,User Locale,User
service package,[List of User aliases, .. ,List of
User aliases],[List of blended aliases, .. ,List of
blended aliases],[User routes, .. ,User routes],[Display
name,Registration timer give in seconds,Name of the
IPCM]]]) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name,[The user name,Users first name,Users last
name,Password,Home phone,Cell phone,Pager,Fax,Email,Office
phone number,Voice mail,User picture,Status,status
reason,Voicemail server,Charge ID,Private Charge ID,Public
Charge ID,VPN,Class of service,Time zone,User Locale,User
service package,[List of User aliases, .. ,List of
User aliases],[List of blended aliases, .. ,List of
blended aliases],[User routes, .. ,User routes],[Display
name,Registration timer give in seconds,Name of the IPCM]]
OPI method
public void addUsersToAddressBook(java.lang.String
userName, java.lang.String[] userNames) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get an addressbook entry (getAddressBookEntry)
BPT Method Syntax
getAddressBookEntry using (User name, Nick name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name, Nick name
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Addressbook Operations 267
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Address
BookEntry getAddressBookEntry(java.lang.String userName,
java.lang.String nickName) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Get address book for a User with photo urls (getAddressBookWithPhoto)
BPT Method Syntax
getAddressBookWithPhoto using (User name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
userName
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.FullAdd
ressBookEntry[] getAddressBookWithPhoto(java.lang.String
userName) throws java.rmi.RemoteException, com.nortelnetwor
ks.ims.base.prov.opi.shared.ProvisionException;
Get an addressbook entry with photo url (getFullAddressBookEntry)
BPT Method Syntax
getFullAddressBookEntry using (User name, Nick name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name, Nick name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.FullA
ddressBookEntry getFullAddressBookEntry(java.lang.String
userName, java.lang.String nickName) throws java.rmi.Remote
Exception, com.nortelnetworks.ims.base.prov.opi.shared.Pro
visionException;
Get address book for a User without photo urls (getLightWeightAddressBook)
BPT Method Syntax
getLightWeightAddressBook using (User name, Nick name) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
268 Methods for OPI and BPT
User name, Nick name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Addre
ssBookEntry[] getLightWeightAddressBook(java.lang.String
userName) throws java.rmi.RemoteException, com.nortelnetwor
ks.ims.base.prov.opi.shared.ProvisionException;
Make this entry a buddy (makeBuddy)
BPT Method Syntax
makeBuddy using (User name, Nick name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
User name, Nick name
OPI method
public void makeBuddy(java.lang.String userName, java.lang
.String buddyName) throws java.rmi.RemoteException, com.nor
telnetworks.ims.base.prov.opi.shared.ProvisionException;
Time Zone Operations
This section contains the following:
•
&quot;Get a Time Zone by ID (getTimeZoneByID)&quot; (page 268)
•
&quot;Get a Time Zone by name (getTimeZoneByName)&quot; (page 269)
•
&quot;Get all Time Zone IDs (getAllTimeZoneIds)&quot; (page 269)
•
&quot;Get all Time Zones (getAllTimeZones)&quot; (page 269)
•
&quot;Add a Time Zone (addTimeZone)&quot; (page 270)
•
&quot;Remove a Time Zone (removeTimeZone)&quot; (page 270)
•
&quot;Modify a Time Zone (modifyTimeZone)&quot; (page 270)
Get a Time Zone by ID (getTimeZoneByID)
BPT Method Syntax
getTimeZoneByID using (Time Zone Id) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Time Zone Id
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Time Zone Operations 269
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.TimeZone
getTimeZoneByID(java.lang.String id) throws java.rmi.Remote
Exception, com.nortelnetworks.ims.base.prov.opi.shared.Pro
visionException;
Get a Time Zone by name (getTimeZoneByName)
BPT Method Syntax
getTimeZoneByName using (Time Zone Name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Time Zone Name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.TimeZone
getTimeZoneByName(java.lang.String name) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get all Time Zone IDs (getAllTimeZoneIds)
BPT Method Syntax
getAllTimeZoneIds [optional] into &lt;file name&gt;
OPI method
public java.lang.String[] getAllTimeZoneIds() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get all Time Zones (getAllTimeZones)
BPT Method Syntax
getAllTimeZones [optional] into &lt;file name&gt;
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.TimeZone
[] getAllTimeZones() throws java.rmi.RemoteException, com.n
ortelnetworks.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
270 Methods for OPI and BPT
Add a Time Zone (addTimeZone)
BPT Method Syntax
addTimeZone using ([TimeZone ID,TimeZone Name]) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
[TimeZone ID,TimeZone Name]
OPI method
public void addTimeZone(com.nortelnetworks.ims
.base.prov.opi.shared.TimeZone timeZone) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Remove a Time Zone (removeTimeZone)
BPT Method Syntax
removeTimeZone using (Time Zone name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Time Zone name
OPI method
public void removeTimeZone(java.lang.String name) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Modify a Time Zone (modifyTimeZone)
BPT Method Syntax
modifyTimeZone using (Existing Time Zone name,[TimeZone
ID,TimeZone Name]) | file &lt;file name&gt; [optional] into &lt;file
name&gt;
BPT Required file format
Existing Time Zone name,[TimeZone ID,TimeZone Name]
OPI method
public void modifyTimeZone(java.lang.String name,
com.nortelnetworks.ims.base.prov.opi.shared.TimeZone newTZ)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Emergency Number Operations 271
Emergency Number Operations
This section contains the following:
•
&quot;Add Emergency Number (addEmergencyNumber)&quot; (page 271)
•
&quot;Add Emergency Numbers (addEmergencyNumbers)&quot; (page 271)
•
&quot;Get all Emergency Numbers (getAllEmergencyNumbers)&quot; (page 272)
•
&quot;Get Emergency Aliases (getEmergencyAlias)&quot; (page 272)
•
&quot;Remove all Emergency Numbers (removeAllEmergencyNumbers)&quot;
(page 272)
•
&quot;Remove an Emergency Number (removeEmergencyNumber)&quot; (page
272)
•
&quot;Update Emergency Alias List (updateEmergencyAlias)&quot; (page 273)
Add Emergency Number (addEmergencyNumber)
BPT Method Syntax
addEmergencyNumber using (String emergencyNumber) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
String emergencyNumber
OPI method
public void addEmergencyNumber(java.lang.String
emergencyNumber) throws java.rmi.RemoteException, com.norte
lnetworks.ims.base.prov.opi.shared.ProvisionException;
Add Emergency Numbers (addEmergencyNumbers)
BPT Method Syntax
addEmergencyNumbers using ([String emergencyNumber, ..
,String emergencyNumber]) | file &lt;file name&gt; [optional]
into &lt;file name&gt;
BPT Required file format
[String emergencyNumber, ..
,String emergencyNumber]
OPI method
public void addEmergencyNumbers(java.lang.String[]
emergencyNumbers) throws java.rmi.RemoteException, com.nort
elnetworks.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
272 Methods for OPI and BPT
Get all Emergency Numbers (getAllEmergencyNumbers)
BPT Method Syntax
getAllEmergencyNumbers [optional] into &lt;file name&gt;
OPI method
public java.lang.String[] getAllEmergencyNumbers() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get Emergency Aliases (getEmergencyAlias)
BPT Method Syntax
getEmergencyAlias using (String emergencyNumber) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
String emergencyNumber
OPI method
public java.lang.String[] getEmergencyAlias(java.lang.Strin
g emergencyNumber) throws java.rmi.RemoteException, com.nor
telnetworks.ims.base.prov.opi.shared.ProvisionException;
Remove all Emergency Numbers (removeAllEmergencyNumbers)
BPT Method Syntax
removeAllEmergencyNumbers [optional] into &lt;file name&gt;
OPI method
public void removeAllEmergencyNumbers() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Remove an Emergency Number (removeEmergencyNumber)
BPT Method Syntax
removeEmergencyNumber using (String emergencyNumber) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
String emergencyNumber
OPI method
public void removeEmergencyNumber(java.lang.String
emergencyNumber) throws java.rmi.RemoteException, com.norte
lnetworks.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Media Portal Group and Route Operations 273
Update Emergency Alias List (updateEmergencyAlias)
BPT Method Syntax
updateEmergencyAlias using (String emergencyNumber,[
String[] aliasList, .. , String[] aliasList]) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
String emergencyNumber,[ String[] aliasList, ..
aliasList]
, String[]
OPI method
public void updateEmergencyAlias(java.lang.String
emrgNum, java.lang.String[] emergencyAlias) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Media Portal Group and Route Operations
This section contains the following:
•
&quot;Add a new Media Portal Group (addMediaPortalGroup)&quot; (page 274)
•
&quot;Add multiple Media Portal Groups (addMediaPortalGroups)&quot; (page 274)
•
&quot;Modify a Media Portal Group (modifyMediaPortalGroup)&quot; (page 275)
•
&quot;Remove a Media Portal Group (removeMediaPortalGroup)&quot; (page 276)
•
&quot;Remove multiple Media Portal Groups (removeMediaPortalGroups)&quot;
(page 276)
•
&quot;Get a Media Portal Group data (getMediaPortalGroupByName)&quot; (page
276)
•
&quot;Get all Media Portal Groups (getAllMediaPortalGroups)&quot; (page 277)
•
&quot;Get available domains and locations not assigned to any MP Group
(getAvailableDomainLocations)&quot; (page 277)
•
&quot;Get all existing configured Media Portal IP addresses
(getAllMediaPortalResourceIPs)&quot; (page 277)
•
&quot;Add a new Media Portal Route (addMpRoutabilityGroup)&quot; (page 277)
•
&quot;Add multiple Media Portal Routes (addMpRoutabilityGroups)&quot; (page
278)
•
&quot;Modify a Media Portal Route (modifyMpRoutabilityGroup)&quot; (page 278)
•
&quot;Remove a Media Portal Route (removeMpRoutabilityGroup)&quot; (page
279)
•
&quot;Remove multiple Media Portal Routes (removeMpRoutabilityGroups)&quot;
(page 279)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
274 Methods for OPI and BPT
•
&quot;Get a Media Portal Route data (getMpRoutabilityGroupByName)&quot;
(page 279)
•
&quot;Get all Media Portal Routes (getAllMpRoutabilityGroups)&quot; (page 280)
•
&quot;Get all domains and locations in the system (getAllDomainLocations)&quot;
(page 280)
•
&quot;Modify domain locations by Media Portal Group (modifyDomainLocationsByMPGroup)&quot; (page 280)
•
&quot;Modify domain locations by Route Name (modifyDomainLocationsByRTGroup)&quot; (page 281)
Add a new Media Portal Group (addMediaPortalGroup)
BPT Method Syntax
addMediaPortalGroup using ([Name of Media Portal
Group,[MediaPortal Resources IPaddress, .. ,MediaPortal
Resources IPaddress],[[Domain Name,[Location Names, ..
,Location Names]], .. ,[Domain Name,[Location Names,
.. ,Location Names]]],Specify if Group is globally
addressable]) | file &lt;file name&gt; [optional] into &lt;file
name&gt;
BPT Required file format
[Name of Media Portal Group,[MediaPortal Resources
IPaddress, .. ,MediaPortal Resources IPaddress],[[Domain
Name,[Location Names, .. ,Location Names]], .. ,[Domain
Name,[Location Names, .. ,Location Names]]],Specify if
Group is globally addressable]
OPI method
public void addMediaPortalGroup(com.nortelnetworks.ims
.base.prov.opi.shared.MediaPortalGroup mpgroup) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Add multiple Media Portal Groups (addMediaPortalGroups)
BPT Method Syntax
addMediaPortalGroups using ([[Name of Media Portal
Group,[MediaPortal Resources IPaddress, .. ,MediaPortal
Resources IPaddress],[[Domain Name,[Location Names, ..
,Location Names]], .. ,[Domain Name,[Location Names,
.. ,Location Names]]],Specify if Group is globally
addressable], .. ,[Name of Media Portal Group,[MediaPortal
Resources IPaddress, .. ,MediaPortal Resources
IPaddress],[[Domain Name,[Location Names, .. ,Location
Names]], .. ,[Domain Name,[Location Names, ..,Location
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Media Portal Group and Route Operations 275
Names]]],Specify if Group is globally addressable]]) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
[[Name of Media Portal Group,[MediaPortal Resources
IPaddress, .. ,MediaPortal Resources IPaddress],[[Domain
Name,[Location Names, .. ,Location Names]], .. ,[Domain
Name,[Location Names, .. ,Location Names]]],Specify if
Group is globally addressable], .. ,[Name of Media Portal
Group,[MediaPortal Resources IPaddress, .. ,MediaPortal
Resources IPaddress],[[Domain Name,[Location Names, ..
,Location Names]], .. ,[Domain Name,[Location Names,
.. ,Location Names]]],Specify if Group is globally
addressable]]
OPI method
public void addMediaPortalGroups(com.nortelnetworks.ims.b
ase.prov.opi.shared.MediaPortalGroup[] mpgroups) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Modify a Media Portal Group (modifyMediaPortalGroup)
BPT Method Syntax
modifyMediaPortalGroup using (Existing Group Name,[Name of
Media Portal Group,[MediaPortal Resources IPaddress, ..
,MediaPortal Resources IPaddress],[[Domain Name,[Location
Names, .. ,Location Names]], .. ,[Domain Name,[Location
Names, .. ,Location Names]]],Specify if Group is globally
addressable]) | file &lt;file name&gt; [optional] into &lt;file
name&gt;
BPT Required file format
Existing Group Name,[Name of Media Portal Group,[Media
Portal Resources IPaddress, .. ,MediaPortal Resources
IPaddress],[[Domain Name,[Location Names, .. ,Location
Names]], .. ,[Domain Name,[Location Names, .. ,Location
Names]]],Specify if Group is globally addressable]
OPI method
public void modifyMediaPortalGroup(java.lang.String
groupName, com.nortelnetworks.ims.base.prov.opi.shared.Me
diaPortalGroup mpgroup) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
276 Methods for OPI and BPT
Remove a Media Portal Group (removeMediaPortalGroup)
BPT Method Syntax
removeMediaPortalGroup using (Media Portal Group name) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Media Portal Group name
OPI method
public void removeMediaPortalGroup(java.lang.String
groupName) throws java.rmi.RemoteException, com.nortelnetwo
rks.ims.base.prov.opi.shared.ProvisionException;
Remove multiple Media Portal Groups (removeMediaPortalGroups)
BPT Method Syntax
removeMediaPortalGroups using ([Media Portal Groups
names, .. ,Media Portal Groups names]) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
[Media Portal Groups names, ..
,Media Portal Groups names]
OPI method
public void removeMediaPortalGroups(java.lang.String[]
groupNames) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Get a Media Portal Group data (getMediaPortalGroupByName)
BPT Method Syntax
getMediaPortalGroupByName using (Media Portal Group name) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Media Portal Group name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Medi
aPortalGroup getMediaPortalGroupByName(java.lang.String
groupName) throws java.rmi.RemoteException, com.nortelnetwo
rks.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Media Portal Group and Route Operations 277
Get all Media Portal Groups (getAllMediaPortalGroups)
BPT Method Syntax
getAllMediaPortalGroups [optional] into &lt;file name&gt;
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.M
ediaPortalGroup[] getAllMediaPortalGroups() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get available domains and locations not assigned to any MP Group
(getAvailableDomainLocations)
BPT Method Syntax
getAvailableDomainLocations [optional] into &lt;file name&gt;
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.D
omainLocation[] getAvailableDomainLocations() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get all existing configured Media Portal IP addresses
(getAllMediaPortalResourceIPs)
BPT Method Syntax
getAllMediaPortalResourceIPs [optional] into &lt;file name&gt;
OPI method
public java.lang.String[] getAllMediaPortalResourceIPs()
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Add a new Media Portal Route (addMpRoutabilityGroup)
BPT Method Syntax
addMpRoutabilityGroup using ([Name of the Routability
Group,[[Domain Name,[Location Names, .. ,Location Names]],
.. ,[Domain Name,[Location Names, .. ,Location Names]]]])
| file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
[Name of the Routability Group,[[Domain Name,[Location
Names, .. ,Location Names]], .. ,[Domain Name,[Location
Names, .. ,Location Names]]]]
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
278 Methods for OPI and BPT
OPI method
public void addMpRoutabilityGroup(com.nortelnetworks.ims.b
ase.prov.opi.shared.MpRoutabilityGroup routeroup) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Add multiple Media Portal Routes (addMpRoutabilityGroups)
BPT Method Syntax
addMpRoutabilityGroups using ([[Name of the Routability
Group,[[Domain Name,[Location Names, .. ,Location Names]],
.. ,[Domain Name,[Location Names, .. ,Location Names]]]],
.. ,[Name of the Routability Group,[[Domain Name,[Location
Names, .. ,Location Names]], .. ,[Domain Name,[Location
Names, .. ,Location Names]]]]]) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
[[Name of the Routability Group,[[Domain Name,[Location
Names, .. ,Location Names]], .. ,[Domain Name,[Location
Names, .. ,Location Names]]]], .. ,[Name of the
Routability Group,[[Domain Name,[Location Names, ..
,Location Names]], .. ,[Domain Name,[Location Names, ..
,Location Names]]]]]
OPI method
public void addMpRoutabilityGroups(com.nortelnetworks.ims.b
ase.prov.opi.shared.MpRoutabilityGroup[] routeroups) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Modify a Media Portal Route (modifyMpRoutabilityGroup)
BPT Method Syntax
modifyMpRoutabilityGroup using (Existing Route Name,[Name
of the Routability Group,[[Domain Name,[Location Names,
.. ,Location Names]], .. [Domain Name,[Location Names,
.. ,Location Names]]]]) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
BPT Required file format
Existing Route Name,[Name of the Routability Group,
[[Domain Name,[Location Names, .. ,Location Names]], ..
,[Domain Name,[Location Names, .. ,Location Names]]]]
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Media Portal Group and Route Operations 279
OPI method
public void modifyMpRoutabilityGroup(java.lang.String
routeGroupName, com.nortelnetworks.ims.base.prov
.opi.shared.MpRoutabilityGroup routeroup) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Remove a Media Portal Route (removeMpRoutabilityGroup)
BPT Method Syntax
removeMpRoutabilityGroup using (Media Portal Route name) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Media Portal Route name
OPI method
public void removeMpRoutabilityGroup(java.lang.String
routeGroupName) throws java.rmi.RemoteException, com.nortel
networks.ims.base.prov.opi.shared.ProvisionException;
Remove multiple Media Portal Routes (removeMpRoutabilityGroups)
BPT Method Syntax
removeMpRoutabilityGroups using ([Media Portal Routes
names, .. ,Media Portal Routes names]) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
[Media Portal Routes names, ..
,Media Portal Routes names]
OPI method
public void removeMpRoutabilityGroups(java.lang.String[]
routeGroupNames) throws java.rmi.RemoteException, com.norte
lnetworks.ims.base.prov.opi.shared.ProvisionException;
Get a Media Portal Route data (getMpRoutabilityGroupByName)
BPT Method Syntax
getMpRoutabilityGroupByName using (Media Portal Route name)
| file &lt;filename&gt; [optional] into &lt;file name&gt;
BPT Required file format
Media Portal Route name
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
280 Methods for OPI and BPT
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.MpRouta
bilityGroup getMpRoutabilityGroupByName(java.lang.String
routegroup) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Get all Media Portal Routes (getAllMpRoutabilityGroups)
BPT Method Syntax
getAllMpRoutabilityGroups [optional] into &lt;file name&gt;
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Mp
RoutabilityGroup[] getAllMpRoutabilityGroups() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get all domains and locations in the system (getAllDomainLocations)
BPT Method Syntax
getAllDomainLocations [optional] into &lt;file name&gt;
OPI method
public com.nortelnetworks.ims.base.prov.opi.share
d.DomainLocation[] getAllDomainLocations() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Modify domain locations by Media Portal Group (modifyDomainLocationsByMPGroup)
BPT Method Syntax
modifyDomainLocationsByMPGroup using (Group Name,[Domain
Name,[Location Names, .. ,Location Names]]) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Group Name,[Domain Name,[Location Names, ..
Names]]
,Location
OPI method
public void modifyDomainLocationsByMPGroup(java.lang.String
groupName, com.nortelnetworks.ims.base.prov.opi.shared.Doma
inLocation domLoc) throws java.rmi.RemoteException, com.nor
telnetworks.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Resource Management
281
Modify domain locations by Route Name (modifyDomainLocationsByRTGroup)
BPT Method Syntax
modifyDomainLocationsByRTGroup using (Route Name,[Domain
Name,[Location Names, .. ,Location Names]]) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Route Name,[Domain Name,[Location Names, ..
Names]]
,Location
OPI method
public void modifyDomainLocationsByRTGroup(java.lang.String
routeName, com.nortelnetworks.ims.base.prov.opi.shared.Doma
inLocation domLoc) throws java.rmi.RemoteException, com.nor
telnetworks.ims.base.prov.opi.shared.ProvisionException;
Resource Management
This section contains the following:
•
&quot;Add Domain Resource (setDomainResource)&quot; (page 281)
•
&quot;Modify Domain Resource (modifyDomainResource)&quot; (page 282)
•
&quot;Remove Domain Resource By Service (removeDomainResource)&quot;
(page 282)
•
&quot;Remove All Domain Resources (removeAllDomainResources)&quot; (page
282)
•
&quot;Get Domain Resources (getDomainResourcesByDomain)&quot; (page 283)
•
&quot;Get Domain Resource by Service Name (getDomainResourceByService)&quot; (page 283)
Add Domain Resource (setDomainResource)
BPT Method Syntax
setDomainResource using (domainName, serviceName,
maxCountForThisDomain) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
BPT Required file format
domainName, serviceName, maxCountForThisDomain
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
282 Methods for OPI and BPT
OPI method
public void setDomainResource(java.lang.String domainName,
java.lang.String serviceName, int maxCountForThisDomain)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Modify Domain Resource (modifyDomainResource)
BPT Method Syntax
modifyDomainResource using (domainName, serviceName,
maxChangeCount) | file &lt;file name&gt; [optional] into &lt;file
name&gt;
BPT Required file format
domainName, serviceName, maxChangeCount
OPI method
public void modifyDomainResource(java.lang.String domainNam
e, java.lang.String serviceName, int maxChangeCount) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Remove Domain Resource By Service (removeDomainResource)
BPT Method Syntax
removeDomainResource using (domainName, serviceName) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
domainName, serviceName
OPI method
public void removeDomainResource(java.lang.String
domainName, java.lang.String serviceName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Remove All Domain Resources (removeAllDomainResources)
BPT Method Syntax
removeAllDomainResources using (domainName) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
domainName
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
LicenseKey Usage
283
OPI method
public void removeAllDomainResources(java.lang.String
domainName) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Get Domain Resources (getDomainResourcesByDomain)
BPT Method Syntax
getDomainResourcesByDomain using (domainName) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
domainName
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Domai
nResource[] getDomainResourcesByDomain(java.lang.String
domainName) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Get Domain Resource by Service Name (getDomainResourceByService)
BPT Method Syntax
getDomainResourceByService using (String domainName, String
serviceName) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
String domainName, String serviceName
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Doma
inResource getDomainResourceByService(java.lang.String
domainName, java.lang.String serviceName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
LicenseKey Usage
This section contains the following method:
•
&quot;Get License Key Usage for a Given Keycode (getLicenseKeyUsage)&quot;
(page 284)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
284 Methods for OPI and BPT
Get License Key Usage for a Given Keycode (getLicenseKeyUsage)
BPT Method Syntax
getLicenseKeyUsage using (String keycode) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
String keycode
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.LicenseK
eyUsage getLicenseKeyUsage(java.lang.String keycode) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
LDAP Syncing
This section contains the following:
•
&quot;Add LDAP Schema (addLdapSchema)&quot; (page 285)
•
&quot;Add LDAP Info (addLdapInfo)&quot; (page 285)
•
&quot;Add LDAP Time Block (addLdapTimeBlock)&quot; (page 286)
•
&quot;Add LDAP User Defaults (addLdapUserDefaults)&quot; (page 287)
•
&quot;Add LDAPSyncFilterCriteria (setLDAPSyncFilterCriteria)&quot; (page 287)
•
&quot;Remove LDAP Info for Domain (removeLdapInfo)&quot; (page 287)
•
&quot;Remove LDAP Schema for Domain (removeLdapSchema)&quot; (page 288)
•
&quot;Remove LDAP Time Block for Domain (removeLdapTimeBlock)&quot; (page
288)
•
&quot;Remove LDAP User Defaults (removeLdapUserDefaults)&quot; (page 288)
•
&quot;Remove LdapSyncFilterCriteria for Domain (removeLdapSyncFilterCriteria)&quot; (page 289)
•
&quot;Get LDAP Schema for Domain Name (getLdapSchema)&quot; (page 289)
•
&quot;Get LDAP Information for Domain Name (getLdapInfo)&quot; (page 289)
•
&quot;Get LDAP Time block for Domain Name (getLdapTimeBlock)&quot; (page
290)
•
&quot;Get LDAP User Defaults for Domain Name (getLdapUserDefaults)&quot;
(page 290)
•
&quot;Get Ldap Sync Filter Criteria for Domain Name (getLdapsyncFilterCriteria)&quot; (page 290)
•
&quot;Start LDAP Synchronization Now (startLdapSyncNow)&quot; (page 291)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
LDAP Syncing
285
Add LDAP Schema (addLdapSchema)
BPT Method Syntax
addLdapSchema using (Domain name,[Example of DN is
CN=Steve Kille, 0=Isode Limited, C=USA,Term UID is used
in LDAP standards uid may be an employee id,givenName
as defined in ldap standard,Surname or sn as defined
in ldap standards,telephoneNumber as defined in ldap
standards,facsimileTelephoneNumber as defined in ldap
standards,homePhone as defined in ldap standards.,mobile
as defined in ldap standards,mail as defined in ldap
standards,jpegPhoto as defined in ldap standards,pager as
defined in ldap standards,Special attribute set when need
a special user sync]) | file &lt;file name&gt; [optional] into
&lt;file name&gt;
BPT Required file format
Domain name,[Example of DN is CN=SteveKille, 0=Isode
Limited, C=USA,Term UID is used in LDAP standards uid may
be an employee id,givenName as defined in ldap standard,
Surname or sn as defined in ldap standards,telephoneNumber
as defined in ldap standards,facsimileTelephoneNumber as
defined in ldap standards,homePhone as defined in ldap
standards.,mobile as defined in ldap standards,mail as
defined in ldap standards,jpegPhoto as defined in ldap
standards,pager as defined in ldap standards,Special
attribute set when need a special user sync]
OPI method
public void addLdapSchema(java.lang.String domainName,
com.nortelnetworks.ims.base.prov.opi.shared.LDAPSchema
ldapSchema) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Add LDAP Info (addLdapInfo)
BPT Method Syntax
addLdapInfo using (Domain name,[Server type valid
values are P for Primary S for Secondary,IP Address
of Primary Ldap Server,Port number of Primary LDAP
server&lt;wellknown port is 389&gt;,IP Address of Secondary Ldap
Server,Port number for Secondary LDAP server&lt;wellknown
port of 389&gt;,Password require to login&lt;default N&gt; valid
values Y,N,Login name for primary User,Password for
Primary user,Password require to login&lt;default N&gt;valid
values Y,N,Login name for secondary User,Password for
secondary user,Connect using secure connection for Primary
Server&lt;default N&gt;valid values Y,N,Connect using secure
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
286 Methods for OPI and BPT
connection for Secondary Server&lt;default N&gt;valid values
Y,N]) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name,[Server type valid values are P for Primary
S for Secondary,IP Address of Primary Ldap Server,Port
number of Primary LDAP server&lt;wellknown port is 389&gt;,IP
Address of Secondary Ldap Server,Port number for Secondary
LDAP server&lt;wellknown port of 389&gt;,Password require
to login&lt;default N&gt; valid values Y,N,Login name for
primary User,Password for Primary user,Password require
to login&lt;default N&gt;valid values Y,N,Login name for
secondary User,Password for secondary user,Connect using
secure connection for Primary Server&lt;default N&gt;valid
values Y,N,Connect using secure connection for Secondary
Server&lt;default N&gt;valid values Y,N]
OPI method
public void addLdapInfo(java.lang.String domainName,
com.nortelnetworks.ims.base.prov.opi.shared.LDAPInfo
ldapInfo) throws java.rmi.RemoteException, com.nortelnetwor
ks.ims.base.prov.opi.shared.ProvisionException;
Add LDAP Time Block (addLdapTimeBlock)
BPT Method Syntax
addLdapTimeBlock using (Domain name,[The Hour Sync Begins
Valid ranges are 1-12,The minute sync begins Valid Range
are 00,15,30,45,Time represents AM or PM Valid values AM or
PM,Sync Frequency example D for Daily M for Monthly,[The
days of the week valid range is 0-6 for weekly or 1-31 if
start frequency set for Monthly, .. ,The days of the week
valid range is 0-6 for weekly or 1-31 if start frequency
set for Monthly],valid values are Y or N]) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name,[The Hour Sync Begins Valid ranges are 1-12,The
minute sync begins Valid Range are 00,15,30,45,Time
represents AM or PM Valid values AM or PM,Sync Frequency
example D for Daily M for Monthly,[The days of the week
valid range is 0-6 for weekly or 1-31 if start frequency
set for Monthly, .. ,The days of the week valid range
is 0-6 for weekly or 1-31 if start frequency set for
Monthly],valid values are Y or N]
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
LDAP Syncing
287
OPI method
public void addLdapTimeBlock(java.lang.String domainName,
com.nortelnetworks.ims.base.prov.opi.shared.LdapTimeBlock
timeBlock) throws java.rmi.RemoteException, com.nortelnetwo
rks.ims.base.prov.opi.shared.ProvisionException;
Add LDAP User Defaults (addLdapUserDefaults)
BPT Method Syntax
addLdapUserDefaults using (Domain name,[Default User
Password,User Status valid values are Active/Inactive,Class
of Service,Example of locale are English,French etc...,Some
of the valid time zones are Mountain Standard Time.Central
Standard Time,Service Package]) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name,[Default User Password,User Status valid values
are Active/Inactive,Class of Service,Example of locale
are English,French etc...,Some of the valid time zones
are Mountain Standard Time.Central Standard Time,Service
Package]
OPI method
public void addLdapUserDefaults(java.lang.String
domainName, com.nortelnetworks.ims.base.prov.opi
.shared.LDAPUserDefaults ldapUserDefaults) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Add LDAPSyncFilterCriteria (setLDAPSyncFilterCriteria)
BPT Method Syntax
setLDAPSyncFilterCriteria using (Domain name, LDAPSyncFilte
rCriteria) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, LDAPSyncFilterCriteria
OPI method
Remove LDAP Info for Domain (removeLdapInfo)
BPT Method Syntax
removeLdapInfo using (Domain name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
288 Methods for OPI and BPT
BPT Required file format
Domain name
OPI method
public void removeLdapInfo(java.lang.String domainName, jav
a.lang.String serverType) throws java.rmi.RemoteException,
com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce
ption;
Remove LDAP Schema for Domain (removeLdapSchema)
BPT Method Syntax
removeLdapSchema using (Domain name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public void removeLdapSchema(java.lang.String domainName)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Remove LDAP Time Block for Domain (removeLdapTimeBlock)
BPT Method Syntax
removeLdapTimeBlock using (Domain name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public void removeLdapTimeBlock(java.lang.String
domainName) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Remove LDAP User Defaults (removeLdapUserDefaults)
BPT Method Syntax
removeLdapUserDefaults using (Domain name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
LDAP Syncing
289
OPI method
public void removeLdapUserDefaults(java.lang.String
domainName) throws java.rmi.RemoteException, com.nortelnetw
orks.ims.base.prov.opi.shared.ProvisionException;
Remove LdapSyncFilterCriteria for Domain (removeLdapSyncFilterCriteria)
BPT Method Syntax
removeLdapSyncFilterCriteria using (Domain name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
Get LDAP Schema for Domain Name (getLdapSchema)
BPT Method Syntax
getLdapSchema using (Domain name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.LDAPS
chema getLdapSchema(java.lang.String domainName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get LDAP Information for Domain Name (getLdapInfo)
BPT Method Syntax
getLdapInfo using (Domain name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.LDAP
Info[] getLdapInfo(java.lang.String domainName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
290 Methods for OPI and BPT
Get LDAP Time block for Domain Name (getLdapTimeBlock)
BPT Method Syntax
getLdapTimeBlock using (Domain name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.LdapTime
Block getLdapTimeBlock(java.lang.String domainName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get LDAP User Defaults for Domain Name (getLdapUserDefaults)
BPT Method Syntax
getLdapUserDefaults using (Domain name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.LDAPUse
rDefaults getLdapUserDefaults(java.lang.String domainName)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Get Ldap Sync Filter Criteria for Domain Name (getLdapsyncFilterCriteria)
BPT Method Syntax
getLdapsyncFilterCriteria using (Domain name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
domainName
OPI method
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Password Policy Operations 291
Start LDAP Synchronization Now (startLdapSyncNow)
BPT Method Syntax
startLdapSyncNow using (Domain name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
public void startLdapSyncNow(java.lang.String domainName)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Password Policy Operations
This section contains the following:
•
&quot;Get a Password Policy by name (getPasswordPolicy)&quot; (page 291)
•
&quot;Get all Password Policies (getAllPasswordPolicies)&quot; (page 291)
•
&quot;Add a Password Policy (addPasswordPolicy)&quot; (page 292)
•
&quot;Modify a Password Policy (modifyPasswordPolicy)&quot; (page 292)
•
&quot;Remove a Password Policy (removePasswordPolicy)&quot; (page 293)
Get a Password Policy by name (getPasswordPolicy)
BPT Method Syntax
getPasswordPolicy using (Password Policy Name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Password Policy Name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.Passwo
rdPolicy getPasswordPolicy(java.lang.String name) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get all Password Policies (getAllPasswordPolicies)
BPT Method Syntax
getAllPasswordPolicies [optional] into &lt;file name&gt;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
292 Methods for OPI and BPT
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared
.PasswordPolicy[] getAllPasswordPolicies() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Add a Password Policy (addPasswordPolicy)
BPT Method Syntax
addPasswordPolicy using ([Password Policy Name,Minimum
Length of Password, Minimum Number of Digits in
Password,Minimum Number of Characters in Password]) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
[Password Policy Name,Minimum Length of Password,Minimum
Number of Digits in Password,Minimum Number of Characters
in Password]
OPI method
public void addPasswordPolicy(com.nortelnetworks.i
ms.base.prov.opi.shared.PasswordPolicy pp) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Modify a Password Policy (modifyPasswordPolicy)
BPT Method Syntax
modifyPasswordPolicy using (Existing Password Policy nam
e,[Password Policy Name,Minimum Length of Password,Minimum
Number of Digits in Password,Minimum Number of Characters
in Password]) | file &lt;file name&gt; [optional] into &lt;file
name&gt;
BPT Required file format
Existing Password Policy name,[Password Policy
Name,Minimum Length of Password,Minimum Number of Digits in
Password,Minimum Number of Characters in Password]
OPI method
public void modifyPasswordPolicy(java.lang.String name,
com.nortelnetworks.ims.base.prov.opi.shared.PasswordPolicy
pp) throws java.rmi.RemoteException, com.nortelnetworks.ims
.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Parm Definition 293
Remove a Password Policy (removePasswordPolicy)
BPT Method Syntax
removePasswordPolicy using (Password Policy name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Password Policy name
OPI method
public void removePasswordPolicy(java.lang.String name)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Parm Definition
This section contains the following:
•
&quot;Get all Parm Types (getAllParmTypes)&quot; (page 293)
•
&quot;Get all Parm Validation Types (future method) getAllParmValidationTypes&quot; (page 294)
•
&quot;Get all Parm Owners (getAllParmOwners)&quot; (page 294)
•
&quot;Get all Parm Definitions (getAllParmDefinitions)&quot; (page 294)
•
&quot;Get all Parm Definitions By Owner (getParmDefinitionByOwner)&quot; (page
294)
•
&quot;Get Parm Definition By Name (getParmDefinitionByName)&quot; (page 295)
•
&quot;Get all Parm Validation Types (future method) getAllParmValidationTypes&quot; (page 294)
•
&quot;Add Parm Definition (addParmDefinition)&quot; (page 295)
•
&quot;Remove Parm Definition (removeParmDefinition)&quot; (page 296)
•
&quot;Assign Parm Definition To Owner (assignParmDefinitionToOwner)&quot;
(page 296)
•
&quot;Remove Parm Definition To Owner (removeParmDefinitionFromOwner)&quot;
(page 296)
Get all Parm Types (getAllParmTypes)
BPT Method Syntax
getAllParmTypes [optional] into &lt;file name&gt;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
294 Methods for OPI and BPT
OPI method
public java.lang.String[] getAllParmTypes() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get all Parm Validation Types (future method) getAllParmValidationTypes
BPT Method Syntax
getAllParmValidationTypes [optional] into &lt;file name&gt;
OPI method
public java.lang.String[] getAllParmValidationTypes()
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Get all Parm Owners (getAllParmOwners)
BPT Method Syntax
getAllParmOwners [optional] into &lt;file name&gt;
OPI method
public java.lang.String[] getAllParmOwners() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get all Parm Definitions (getAllParmDefinitions)
BPT Method Syntax
getAllParmDefinitions [optional] into &lt;file name&gt;
OPI method
public com.nortelnetworks.ims.base.prov.opi.share
d.ParmDefinition[] getAllParmDefinitions() throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Get all Parm Definitions By Owner (getParmDefinitionByOwner)
BPT Method Syntax
getParmDefinitionByOwner using (owner name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
owner name
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Parm Definition 295
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.ParmDef
inition[] getParmDefinitionByOwner(java.lang.String owner)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Get Parm Definition By Name (getParmDefinitionByName)
BPT Method Syntax
getParmDefinitionByName using (Parm Name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Parm Name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.ParmDef
inition getParmDefinitionByName(java.lang.String parmName)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Get all Parm Definition Data (future method) (getParmDefinitionDataForParm)
BPT Method Syntax
getParmDefinitionDataForParm using (Parm Name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Parm Name
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.ParmDefi
nitionData[] getParmDefinitionDataForParm(java.lang.String
parmName) throws java.rmi.RemoteException, com.nortelnetwor
ks.ims.base.prov.opi.shared.ProvisionException;
Add Parm Definition (addParmDefinition)
BPT Method Syntax
addParmDefinition using (Parm Definition) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Parm Definition
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
296 Methods for OPI and BPT
OPI method
public void addParmDefinition(com.nortelnetworks.im
s.base.prov.opi.shared.ParmDefinition pDef) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
Remove Parm Definition (removeParmDefinition)
BPT Method Syntax
removeParmDefinition using (Parm Name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file formatParm Name
Parm Name
OPI method
public void removeParmDefinition(java.lang.String parmName)
throws java.rmi.RemoteException, com.nortelnetworks.ims.bas
e.prov.opi.shared.ProvisionException;
Assign Parm Definition To Owner (assignParmDefinitionToOwner)
BPT Method Syntax
assignParmDefinitionToOwner using (Owner name, Parm name) |
file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Owner name, Parm name
OPI method
public void assignParmDefinitionToOwner(java.lang.String
owner, java.lang.String parmName) throws java.rmi.RemoteEx
ception, com.nortelnetworks.ims.base.prov.opi.shared.Pro
visionException;
Remove Parm Definition To Owner (removeParmDefinitionFromOwner)
BPT Method Syntax
removeParmDefinitionFromOwner using (Owner name, Parm name)
| file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Owner name, Parm name
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Groups 297
OPI method
public void removeParmDefinitionFromOwner(java.lang.String
owner, java.lang.String parmName) throws java.rmi.RemoteEx
ception, com.nortelnetworks.ims.base.prov.opi.shared.Pro
visionException;
Release, Version Information
This section contains the following:
•
&quot;Get the current version of OPI (getCurrentOPIVersion)&quot; (page 297)
•
&quot;Get the versions of OPI supported (getSupportedOPIVersions)&quot; (page
297)
•
&quot;Get the name of the current release (getReleaseName)&quot; (page 297)
Get the current version of OPI (getCurrentOPIVersion)
BPT Method Syntax
getCurrentOPIVersion [optional] into &lt;file name&gt;
OPI method
Public java.lang.String getCurrentOPIVersion()
throwsjava.rmi.RemoteException;
Get the versions of OPI supported (getSupportedOPIVersions)
BPT Method Syntax
getSupportedOPIVersions [optional] into &lt;file name&gt;
OPI method
Public java.lang.String[] getSupportedOPIVersions() throws
java.rmi.RemoteException;
Get the name of the current release (getReleaseName)
BPT Method Syntax
getReleaseName [optional] into &lt;file name&gt;
OPI method
public java.lang.String getReleaseName() throws
java.rmi.RemoteException;
Groups
This section contains the following:
•
&quot;Add a group (addGroup)&quot; (page 298)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
298 Methods for OPI and BPT
•
&quot;Add groups (addGroups)&quot; (page 298)
•
&quot;Modify a group (modifyGroup)&quot; (page 299)
•
&quot;Remove a group (removeGroup)&quot; (page 299)
•
&quot;Remove groups (removeGroups)&quot; (page 299)
•
&quot;Get a group (getGroup)&quot; (page 299)
•
&quot;Get a group by user name (getGroupByUsername)&quot; (page 300)
•
&quot;Get groups for domain (getAllGroupsForDomain)&quot; (page 300)
•
&quot;Get users in a group (getUsersByGroup)&quot; (page 300)
•
&quot;Assign users to a group (assignGroupsToUser)&quot; (page 300)
•
&quot;Remove user from group (removeGroupByUser)&quot; (page 301)
•
&quot;Get groups for a user (getUserGroups)&quot; (page 301)
•
&quot;Get a group (getGroupsByUsersByType)&quot; (page 301)
•
&quot;Get all group types (getAllGroupTypes)&quot; (page 301)
•
&quot;Remove all groups for user (removeAllUserGroups)&quot; (page 301)
Add a group (addGroup)
BPT Method Syntax
addGroup using (domain name, Group) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
domain name, Group
OPI method
Add groups (addGroups)
BPT Method Syntax
addGroups using (domain name, Groups) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
domain name, Groups
OPI method
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Groups 299
Modify a group (modifyGroup)
BPT Method Syntax
modifyGroup using (domain name, group name, Group) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
domain name, group name, Group
OPI method
Remove a group (removeGroup)
BPT Method Syntax
removeGroup using (Domain name, Group Name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Group Name
OPI method
Remove groups (removeGroups)
BPT Method Syntax
removeGroups using (Domain name, Group Names) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Group Names
OPI method
Get a group (getGroup)
BPT Method Syntax
getGroup using (Domain name, Group Name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
Domain name, Group Name
OPI method
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
300 Methods for OPI and BPT
Get a group by user name (getGroupByUsername)
BPT Method Syntax
getGroupByUsername using (User name, Group Name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name, Group Name
OPI method
Get groups for domain (getAllGroupsForDomain)
BPT Method Syntax
getAllGroupsForDomain using (Domain name) | file &lt;file
name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name
OPI method
Get users in a group (getUsersByGroup)
BPT Method Syntax
getUsersByGroup using (Domain name, Group Name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, Group Name
OPI method
Assign users to a group (assignGroupsToUser)
BPT Method Syntax
assignGroupsToUser using (User name, Group Names) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name, Group Names
OPI method
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Groups 301
Remove user from group (removeGroupByUser)
BPT Method Syntax
removeGroupByUser using (User name, Group Name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name, Group Name
OPI method
Get groups for a user (getUserGroups)
BPT Method Syntax
getUserGroups using (User name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
userName
OPI method
Get a group (getGroupsByUsersByType)
BPT Method Syntax
getGroupsByUsersByType using (User name, Group Type) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name, Group Type
OPI method
Get all group types (getAllGroupTypes)
BPT Method Syntax
getAllGroupTypes [optional] into &lt;file name&gt;
OPI method
Remove all groups for user (removeAllUserGroups)
BPT Method Syntax
removeAllUserGroups using (User name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
302 Methods for OPI and BPT
BPT Required file format
userName
OPI method
SIP Lines
This section contains the following:
•
&quot;Get SIP Line Audit Data By EndpointId (getSIPLineAuditData)&quot; (page
302)
•
&quot;Get SIP Line Audit Data By UserName (getSIPLineAuditDataByUserName)&quot; (page 302)
•
&quot;Get SIP Line Audit Data By Domain (getSIPLineAuditDataByDomain)&quot;
(page 303)
•
&quot;Get SIP Line Audit Data By Domain And VMG (getSIPLineAuditDataByDomainByVMG)&quot; (page 303)
•
&quot;Get Domains By VMG (getDomainsForVMG)&quot; (page 303)
•
Undefined Resource
•
&quot;Get Users By Registration State (getUsersByRegistrationState)&quot; (page
304)
•
&quot;Get Users By Registration State And Client Type (getUsersByRegStateAndClientType)&quot; (page 304)
VMG means voice mail gateway.
Get SIP Line Audit Data By EndpointId (getSIPLineAuditData)
BPT Method Syntax
getSIPLineAuditData using (EndPointId) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
EndPointId
OPI method
Get SIP Line Audit Data By UserName (getSIPLineAuditDataByUserName)
BPT Method Syntax
getSIPLineAuditDataByUserName using (User name) | file
&lt;file name&gt; [optional] into &lt;file name&gt;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
SIP Lines
303
BPT Required file format
userName
OPI method
Get SIP Line Audit Data By Domain (getSIPLineAuditDataByDomain)
BPT Method Syntax
getSIPLineAuditDataByDomain using (Domain name, start,
stop) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
Domain name, start, stop
OPI method
Get SIP Line Audit Data By Domain And VMG (getSIPLineAuditDataByDomainByVMG)
BPT Method Syntax
getSIPLineAuditDataByDomainByVMG using (Domain name, VMG
Name, start, stop) | file &lt;file name&gt; [optional] into &lt;file
name&gt;
BPT Required file format
Domain name, VMG Name, start, stop
OPI method
Get Domains By VMG (getDomainsForVMG)
BPT Method Syntax
getDomainsForVMG using (VMG nam) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
VMG nam
OPI method
Get VMGs for Domain (getVMGForDomain)
BPT Method Syntax
getVMGForDomain using (Domain Name) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
304 Methods for OPI and BPT
BPT Required file format
Domain Name
OPI method
Get Users By Registration State (getUsersByRegistrationState)
BPT Method Syntax
getUsersByRegistrationState using (User name, registration
state) | file &lt;file name&gt; [optional] into &lt;file name&gt;
BPT Required file format
User name, registration state
OPI method
Get Users By Registration State And Client Type (getUsersByRegStateAndClientType)
BPT Method Syntax
getUsersByRegStateAndClientType using (User name,
registration state, client type) | file &lt;file name&gt;
[optional] into &lt;file name&gt;
BPT Required file format
User name, registration state, client type
OPI method
Methods available only in OPI
This section describes the methods that are available through the OPI and
not through the BPT. The methods are
•
&quot;getAliasesForExpressMsging&quot; (page 305)
•
&quot;getAliasesForMsgRetrieval&quot; (page 305)
•
&quot;getAssistantTypes&quot; (page 305)
•
&quot;getChairAccessURL &quot; (page 305)
•
&quot;getConfDialUpNumbers&quot; (page 305)
•
&quot;getWebCollabURL&quot; (page 305)
•
&quot;getUserPicture&quot; (page 306)
•
&quot;addUserPicture&quot; (page 306)
•
&quot;modifyUserPicture&quot; (page 306)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Methods available only in OPI 305
getAliasesForExpressMsging
OPI Method
public java.lang.String[] getAliasesForExpressMsging(java.lang.String
userName) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.pr
ov.opi.shared.ProvisionException;
getAliasesForMsgRetrieval
OPI Method
public java.lang.String[] getAliasesForMsgRetrieval(java.lang.String
userName) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.pr
ov.opi.shared.ProvisionException;
getAssistantTypes
OPI Method
public java.lang.String[] getAssistantTypes() throws java.rmi.RemoteExcep
tion, com.nortelnetworks.ims.base.prov.opi.shared.ProvisionException;
getChairAccessURL
OPI Method
public java.lang.String getChairAccessURL(java.lang.String userName)
throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov.opi.sha
red.ProvisionException;
getConfDialUpNumbers
OPI Method
public java.lang.String[] getConfDialUpNumbers(java.lang.String userName)
throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov.opi.sha
red.ProvisionException;
getWebCollabURL
OPI Method
public java.lang.String getWebCollabURL(java.lang.String userName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov.opi.shared.Pro
visionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
306 Methods for OPI and BPT
getUserPicture
OPI method
public com.nortelnetworks.ims.base.prov.opi.shared.UserP
icture getUserPicture(java.lang.String userName) throws
java.rmi.RemoteException, com.nortelnetworks.ims.base.prov
.opi.shared.ProvisionException;
addUserPicture
OPI method
public void addUserPicture(java.lang.String userName,
com.nortelnetworks.ims.base.prov.opi.shared.UserPicture
picture) throws java.rmi.RemoteException, com.nortelnetwork
s.ims.base.prov.opi.shared.ProvisionException;
modifyUserPicture
OPI method
public void modifyUserPicture(java.lang.String userName,
com.nortelnetworks.ims.base.prov.opi.shared.UserPicture
picture) throws java.rmi.RemoteException, com.nortelnetwork
s.ims.base.prov.opi.shared.ProvisionException;
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
307
Subscriber Open Provisioning Interface
overview
This chapter provides information about the following topics:
•
&quot;Security&quot; (page 307)
•
&quot;Building SOPI clients&quot; (page 307)
Security
The Subscriber Open Provisioning Interface (SOPI) supports security
through the use of:
•
opicert.cer: the Secure Socket Layer (SSL) certificate file
•
opitruststore: the key store file
These files are required when connecting to the Provisioning Server through
HTTPS. Use the following command line parameters:
-Djavax.net.ssl.trustStore=opitruststore -Djavx.net.ssl.trust
StorePassword=opitruststore
Building SOPI clients
This section provides information about the following topics:
•
&quot;Building SOPI stub clients&quot; (page 307)
•
&quot;Writing a client&quot; (page 308)
•
&quot;Client sample code&quot; (page 310)
Building SOPI stub clients
The following sections outline the process of building SOPI Stub Clients.
The Apache Axis toolkit is used for this example. Other toolkits are available
that can be used to develop client stubs using the WSDL file.
SOPI connects to the web server using port 80 or port 443.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
308 Subscriber Open Provisioning Interface overview
Minimum requirements
You need:
•
working knowledge of Java application development
•
comfort using DOS commands
•
JDK 1.4.2.x
•
Java executable available in the system path
•
Axis toolkit version 1.1 final
Writing a client
This section contains the following:
•
Procedure 10 &quot;Downloading the Axis toolkit&quot; (page 308)
•
Procedure 11 &quot;Building the client stub&quot; (page 308)
Procedure 10
Downloading the Axis toolkit
Step
Action
On the PC
1
Using a web browser, connect to ws.apache.org/axis.
2
Download the 1.1 final version file, axis-1_1.zip.
3
Unzip the files to a drive on the PC.
For example, extract the Axis files to folder D:\axis-1_1.
—End—
Procedure 11
Building the client stub
Step
Action
On the PC
1
Configure the classpath to contain the directories where all the jar
files are found.
For example, if the path D:\axis-1_1\webapps\axis\WEB-INF\lib
contains jar files, you would configure
CLASSPATH= D:\axis-1_1\webapps\axis\WEB-INF\lib\axis.ja
r;D:\axis-1_1\webapps\axis\WEB-INF\lib\axis-ant.jar;D:
\axis-1_1\webapps\axis\WEB-INF\lib\commons-discovery.ja
r;D:\axis-1_1\webapps\axis\WEB-INF\lib\commons-logging
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Building SOPI clients
309
.jar;D:\axis-1_1\webapps\axis\WEB-INF\lib\jaxrpc.jar;D:
\axis-1_1\webapps\axis\WEB-INF\lib\log4j-1.2.8.jar;D:\a
xis-1_1\webapps\axis\WEB-INF\lib\saaj.jar;D:\axis-1_1\w
ebapps\axis\WEB-INF\lib\wsdl4j.jar
2
Create a folder into which the client stubs can be generated.
For example, D:\sopiclient
3
Obtain the WSDL for the web service.
For example, the user personal information is PersData.wsdl. The
SOPI WSDL files are stored in the MCS System Manager.
4
Open a command prompt window.
a. Change directory to the one in which the WSDL was placed.
For example, D:\sopiclient
b. Run the WSDL2JAVA tool on the WSDL file.
For example, java org.apache.axis.wsdl.WSDL2Java -O -1 -d
Session PersData.wsdl
This creates the client stub classes in the D:\sopiclient directory.
5
Create a directory called classes in the stub directory.
For example, create D:\sopiclient\ directory.
6
Write a client that uses the client stubs to make the SOPI method
calls and obtain the information.
7
Save the client sample in the D:\sopiclient folder.
8
Compile the client and run the program.
—End—
Note:
•
During execution of the client classes, the SSL certificates must be
present in the classpath.
•
For error scenarios, an AxisFault is generated with an error code.
The AxisFault object must be processed to get the error code and the
error message corresponding to the error scenario. This error code
is used to generate custom error messages. For internationalized
error messages, the user’s locale can be passed in the SOPI SOAP
request message by configuring the locale attribute (for example,
locale) in the SOAP header. The value of this attribute should be
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
310 Subscriber Open Provisioning Interface overview
equal to the user’s locale. For example, if English is the user’s locale,
then the value of locale attribute has to be configured to en_US.
Client sample code
The following sample code makes a call to retrieve the user’s personal
information. It calls the getPersData() method, passing in the fully qualified
username, for example, [email protected]. After getting the user’s personal
information, the client makes a call to modifyPersonalData() to change the
user’s office and cellphone numbers. Notice that the user’s office and
cellphone numbers are changed after the second method call.
import org.apache.axis.client.Stub;
import com.nortelnetworks.ims.opi.user.*;
import java.net.URL;
import org.apache.axis.message.SOAPHeaderElement;
public class UserPersonalDataClient {
public static void main(String[] args) {
try
{
String sourceServer = &quot;xx.xx.xx.xx&quot;;
String userName = &quot;[email protected]&quot;;
String password = &quot;1234&quot;;
// Create URL for Provisioning Server
URL sourceurl = new URL (&quot;https://&quot; + sourceServer +
&quot;:443/sopi/services/PersData&quot;);
// Instantiate the OPIServiceLocator
UserPersonalDataMgrServiceLocator serviceLocator = new
UserPersonalDataMgrServiceLocator ();
// Obtain an instance of the SOPI Stub
UserPersonalDataMgr persDataMgr = serviceLocator.getPersData (sourceurl);
// Set the authentication details (username and
password)
((Stub) persDataMgr).setUsername (userName);
((Stub) persDataMgr).setPassword (password);
(Stub) persDataMgr).setHeader(new SOAPHeaderElement(&quot;version&quot;,&quot;3.x&quot;));
((Stub) persDataMgr).setHeader(new SOAPHeaderElement(&quot;locale&quot;,&quot;English&quot;));
//To get the user personal information
UserPersonalData upd = persDataMgr.getUserPersonalData(userName);
if(upd != null)
{
//Print the User Information
System.out.println(&quot; First Name :&quot;+upd.getFirstName());
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Building SOPI clients
311
System.out.println(&quot; Last Name :&quot;+upd.getLastName());
System.out.println(&quot; Email Address :&quot;+upd.getEmail());
System.out.println(&quot; Office Phone :&quot;+upd.getOfficePhone());
System.out.println(&quot; CellPhone :&quot;+upd.getCellPhone());
System.out.println(&quot; E911 Location :&quot;+upd.getLocation());
System.out.println(&quot; Time Zone :&quot;+upd.getTimezone());
System.out.println(&quot; Locale :&quot;+upd.getLocale());
}
//to modify the user personal information.
if(upd != null)
{
upd.setCellPhone(&quot;1234567890&quot;);
upd.setOfficePhone(&quot;987654321&quot;);
persDataMgr.modifyUserPersonalData(userName, upd);
upd = persDataMgr.getUserPersonalData(userName);
//Verify if the user information has been updated
//Print the User Information
System.out.println(&quot; After Calling the update
methods&quot;);
System.out.println(&quot; First Name :&quot;+upd.getFirstName());
System.out.println(&quot; Last Name :&quot;+upd.getLastName());
System.out.println(&quot; Email Address :&quot;+upd.getEmail());
System.out.println(&quot; Office Phone :&quot;+upd.getOfficePhone());
System.out.println(&quot; CellPhone :&quot;+upd.getCellPhone());
System.out.println(&quot; E911 Location :&quot;+upd.getLocation());
System.out.println(&quot; Time Zone :&quot;+upd.getTimezone());
System.out.println(&quot; Locale :&quot;+upd.getLocale());
}
}catch (java.rmi.RemoteException ex)// Catch Exception
from remote server
{
System.out.println (ex.getMessage ());
}catch (java.net.MalformedURLException ex)// Bad URL
exception
{
System.out.println(&quot;Invalid URL&quot;);
}
catch (javax.xml.rpc.ServiceException ex)// Unable to
get ServiceLocator
{}catch(Exception e)
{}
}
}
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
312 Subscriber Open Provisioning Interface overview
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
313
Subscriber Open Provisioning Interface
methods
The SOPI commands are grouped as follows:
•
&quot;User personal information&quot; (page 314)
•
&quot;User time block groups&quot; (page 315)
•
&quot;Personalized call settings&quot; (page 316)
•
&quot;Address book&quot; (page 318)
•
&quot;Address book groups&quot; (page 321)
•
&quot;Global address book search&quot; (page 322)
•
&quot;Call screening and routes&quot; (page 325)
•
&quot;Service preferences&quot; (page 327)
•
&quot;Service information&quot; (page 328)
•
&quot;Meet Me service data&quot; (page 329)
•
&quot;Call logs&quot; (page 331)
•
&quot;Time zones&quot; (page 332)
•
&quot;Locales&quot; (page 332)
•
&quot;Password policy&quot; (page 332)
•
&quot;E911 location list&quot; (page 333)
•
&quot;User picture&quot; (page 333)
•
&quot;Banned user&quot; (page 334)
•
&quot;Assistant user manager&quot; (page 335)
•
&quot;Click To Call&quot; (page 335)
•
&quot;I200x &quot; (page 336)
•
&quot;SOPI version&quot; (page 336)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
314 Subscriber Open Provisioning Interface methods
Note:
•
The username in the following sections always refer to the fully
qualified username (for example, user@domain) unless specifically
mentioned in the respective section.
•
Unified Communications Service Data methods are available, but
these methods are not supported in MCS 5100 Release 4.0.
•
See &quot;Methods for OPI and BPT&quot; (page 79) for more information on
provisionable entities.
User personal information
These methods are used to access and manage the user’s personal
information (for example, e-mail, business telephone number, home
telephone number). These methods are available for all the users and are
not service package controlled. The UserPersonalData object has the user
name, aliases, first name, last name, e-mail address, business telephone
number, home telephone number, cellphone number, pager, fax, time zone,
and locale information. The username and alias cannot be modified through
this interface. First and last names can be modified through this interface.
At least one of these (that is, first name or last name) must be provided
because they are used by some of the features that are provided by MCS.
Certain fields of the user personal data are synchronized through the
LDAP server. The list of fields that are synchronized by the LDAP server is
provisioned at the domain level by the administrator. The Personal Agent
restricts the ability to modify these fields. To maintain the same behavior, a
method returns the fields that are synchronized by the LDAP server for a
user, which enables the clients to make these fields read-only. A check on
the server side prevents the modification of these fields through SOPI.
The methods are:
•
&quot;authenticateUser&quot; (page 314)
•
&quot;changePassword&quot; (page 315)
•
&quot;getUserPersonalData&quot; (page 315)
•
&quot;modifyUserPersonalData&quot; (page 315)
Complex Data Type (Provisionable Entity)
UserPersonalData
WebService Name
PersData
Required ServicePackage Service
None
authenticateUser
void authenticateUser(java.lang.String userName, java.lang.String
password)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User time block groups
315
This method authenticates the user.
changePassword
void changePassword(java.lang.String userName, java.lang.String
oldPassword, java.lang.String newPassword)
This method changes the user’s password.
getUserPersonalData
void getUserPersonalData(java.lang.String userName)
This method retrieves the user’s personal information.
modifyUserPersonalData
void modifyUserPersonalData(java.lang.String userName,
com.nortelnetworks.ims.base.prov.opi.shared.user.UserPersonalData upd)
This method modifies the user’s personal information.
User time block groups
These methods are used to access and manage the user’s time block
groups. These methods are available for all users and are not service
package controlled. These time blocks are used by the advanced screening
and routing functionality and are only useful if the user has the Advanced
Screening service.
The methods are:
•
&quot;addTimeBlockGroup&quot; (page 315)
•
&quot;addTimeBlockGroups&quot; (page 316)
•
&quot;getTimeBlockGroupByName&quot; (page 316)
•
&quot;getTimeBlockGroupsByUser&quot; (page 316)
•
&quot;modifyTimeBlockGroup&quot; (page 316)
Complex Data Type (Provisionable Entity)
TimeBlockGroup
WebService Name
TimeBlock
Required ServicePackage Service
None
addTimeBlockGroup
void addTimeBlockGroup(java.lang.String userName, TimeBlockGroup
timeBlockGrp)
This method creates a new TimeBlockGroup, using the information
provided, for the user.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
316 Subscriber Open Provisioning Interface methods
addTimeBlockGroups
void addTimeBlockGroups(java.lang.String userName, TimeBlockGroup[]
timeBlockGrps)
This method creates one or more new TimeBlockGroups, using the
information provided, for the user.
getTimeBlockGroupByName
TimeBlockGroup getTimeBlockGroupByName(java.lang.String userName,
java.lang.String timeBlockGrpName)
This method retrieves the particular TimeBlockGroup, specified by the time
block group name, for the user.
getTimeBlockGroupsByUser
TimeBlockGroup[] getTimeBlockGroupsByUser(java.lang.String userName)
This method retrieves the TimeBlockGroups for a user.
modifyTimeBlockGroup
void modifyTimeBlockGroup(java.lang.String userName, java.lang.String
timeBlockGrpName, TimeBlockGroup timeBlockGroup)
This method modifies the timeblock group.
Personalized call settings
These methods are used to access and manage the user’s personalized call
notes (for example, subjects, reasons, and personalized presence notes).
These methods are available for all users and are not service package
controlled. For more information on call settings, see Personal Agent User
Guide (NN42020-100) .
The methods are:
•
&quot;getNotesByUserName&quot; (page 317)
•
&quot;getRejectReasonsByUserName&quot; (page 317)
•
&quot;getSubjectsByUserName&quot; (page 317)
•
&quot;getUserData&quot; (page 317)
•
&quot;modifyUserData&quot; (page 317)
•
&quot;modifyUserNotes&quot; (page 317)
•
&quot;modifyUserReasons&quot; (page 317)
•
&quot;modifyUserSubjects&quot; (page 318)
•
&quot;removeAllCallSubjects&quot; (page 318)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Personalized call settings 317
•
&quot;removeAllRejectReasons&quot; (page 318)
•
&quot;removeAllUserNotes&quot; (page 318)
•
&quot;removeUserData&quot; (page 318)
Complex Data Type (Provisionable Entity)
UserData
WebService Name
UserData
Required ServicePackage Service
None
getNotesByUserName
java.lang.String[] getNotesByUserName(java.lang.String userName)
This method retrieves the list of notes associated with the user.
getRejectReasonsByUserName
java.lang.String[] getRejectReasonsByUserName(java.lang.String
userName)
This method retrieves the list of reasons associated with the user.
getSubjectsByUserName
java.lang.String[] getSubjectsByUserName(java.lang.String userName)
This method retrieves the list of subjects associated with the user.
getUserData
UserData getUserData(java.lang.String userName)
This method retrieves the user’s UserData.
modifyUserData
void modifyUserData(java.lang.String userName, UserData userData)
This method updates the UserData, associated with the user, with the
UserData information.
modifyUserNotes
void modifyUserNotes(java.lang.String userName, java.lang.String[] notes)
This method updates the notes, associated with the user, with the notes
list information.
modifyUserReasons
void modifyUserReasons(java.lang.String userName, java.lang.String[]
reasons)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
318 Subscriber Open Provisioning Interface methods
This method updates the reasons, associated with the user, with the
reasons list information.
modifyUserSubjects
void modifyUserSubjects(java.lang.String userName, java.lang.String[]
subjects)
This method updates the subjects, associated with the user, with the
subjects list information.
removeAllCallSubjects
void removeAllCallSubjects(java.lang.String userName)
This method removes all the subjects associated with the user.
removeAllRejectReasons
void removeAllRejectReasons(java.lang.String userName)
This method removes all the reasons associated with the user.
removeAllUserNotes
void removeAllUserNotes(java.lang.String userName)
This method removes all the notes associated with the user.
removeUserData
void removeUserData(java.lang.String userName)
This method removes the UserData associated with the user.
Address book
These methods are used to access and manage the address book and
directory information of a user.
The methods are:
•
&quot;addAddressBookEntries&quot; (page 319)
•
&quot;addAddressBookEntry&quot; (page 319)
•
&quot;getAddressBook&quot; (page 319)
•
&quot;getAddressBookEntry&quot; (page 319)
•
&quot;getAddressBookWithPhoto&quot; (page 320)
•
&quot;getBuddies&quot; (page 320)
•
&quot;getFullAddressBookEntry&quot; (page 320)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Address book 319
•
&quot;getLightWeightAddressBook&quot; (page 320)
•
&quot;makeBuddy&quot; (page 320)
•
&quot;modifyAddressBookEntries&quot; (page 320)
•
&quot;modifyAddressBookEntry&quot; (page 320)
•
&quot;removeUserAddressBook&quot; (page 320)
•
&quot;removeAddressBookEntries&quot; (page 321)
•
&quot;removeAddressBookEntry&quot; (page 321)
•
&quot;removeBuddy&quot; (page 321)
Complex Data Type (Provisionable Entity)
AddressBookEntry
WebService Name
AddrBook
Required ServicePackage Service
None
Note: Although no service is required for the address book methods,
the number of address book entries that the user can have, the ability to
have friends, and the number of friends is controlled by the Maximum
Number of Address Book entries and the Presence service, respectively.
addAddressBookEntries
void addAddressBookEntries(java.lang.String userName, AddressBookEntry[] addrBookEntries)
This method creates new entries in the user’s address book.
addAddressBookEntry
void addAddressBookEntry(java.lang.String userName, AddressBookEntry
addrBookEntry)
This method creates a new entry in the user’s address book.
getAddressBook
AddressBookEntry[] getAddressBook(java.lang.String userName)
This method retreives the user’s address book.
getAddressBookEntry
AddressBookEntry getAddressBookEntry(java.lang.String userName,
java.lang.String nickName)
This method retrieves the entry identified by the nickname from the user’s
address book. The address book retrieved contains information on the
user’s buddies, banned users, and groups.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
320 Subscriber Open Provisioning Interface methods
getAddressBookWithPhoto
FullAddressBookEntry[] getAddressBookWithPhoto(java.lang.String
userName)
This method retrieves the address book and picture of a user.
getBuddies
java.lang.String[] getBuddies(java.lang.String userName)
This method retrieves the buddies for the user.
getFullAddressBookEntry
FullAddressBookEntry getFullAddressBookEntry(java.lang.String
userName, java.lang.String nickName)
This method retrieves the full entry of a particular entry in the user’s address
book.
getLightWeightAddressBook
AddressBookEntry[] getLightWeightAddressBook(java.lang.String
userName)
This method retrieves the address book for a user. A subset of the
information for each entry is returned.
makeBuddy
void makeBuddy(java.lang.String userName, java.lang.String buddyName)
This method marks an entry in the user’s address book as a buddy (friend).
modifyAddressBookEntries
void modifyAddressBookEntries(java.lang.String userName,
java.lang.String[] nickName, AddressBookEntry[] addrBookEntry)
This method updates an entry in the user’s address book.
modifyAddressBookEntry
void modifyAddressBookEntry(java.lang.String userName, java.lang.String
nickName, AddressBookEntry addrBookEntry)
This method updates an entry in the user’s address book.
removeUserAddressBook
void removeUserAddressBook(java.lang.String userName)
This method deletes the user’s address book.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Address book groups
321
removeAddressBookEntries
void removeAddressBookEntries(java.lang.String userName,
java.lang.String[] nickName)
This method deletes multiple entries, identified by the nicknames, from the
user’s address book.
removeAddressBookEntry
void removeAddressBookEntry(java.lang.String userName, java.lang.String
nickName)
This method deletes the entry, identified by the nickname, from the user’s
address book.
removeBuddy
void removeBuddy(java.lang.String userName, java.lang.String buddyName)
This method removes the address book entry, identified as a buddy in this
user’s address book, from the Friends list. The entry becomes a normal
address book entry.
Address book groups
The methods are:
•
&quot;addAddressBookGroup&quot; (page 321)
•
&quot;addAddressBookGroups&quot; (page 322)
•
&quot;addUsersToAddressBook&quot; (page 322)
•
&quot;getAddressBookGroups&quot; (page 322)
•
&quot;modifyAddressBookGroups&quot; (page 322)
•
&quot;removeAddressBookGroup&quot; (page 322)
•
&quot;renameAddressBookGroup&quot; (page 322)
Complex Data Type (Provisionable Entity)
None
WebService Name
AddrBookGroup
Required ServicePackage Service
None
addAddressBookGroup
void addAddressBookGroup(java.lang.String userName, java.lang.String
groupName)
This method adds a group to the user’s address book. Examples of groups
are Family, Friends, and Work.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
322 Subscriber Open Provisioning Interface methods
addAddressBookGroups
void addAddressBookGroups(java.lang.String userName, java.lang.String[]
groupNames)
This method adds a list of groups to the user’s address book.
addUsersToAddressBook
void addUsersToAddressBook(java.lang.String userName, java.lang.String[]
users)
This method adds the list of users to the user’s address book. The nickname
for the user is configured to be the user name.
getAddressBookGroups
java.lang.String[] getAddressBookGroups(java.lang.String userName)
This method retrieves all the groups in a user’s address book.
modifyAddressBookGroups
void modifyAddressBookGroups(java.lang.String userName,
java.lang.String[] groupName)
This method adds more groups for the user. If there is an existing group in
this list, the group is not added. If the group does not exist, it is added to
the user’s groups list.
removeAddressBookGroup
void removeAddressBookGroup(java.lang.String userName, java.lang.String
groupName)
This method removes an address book group identified by the group name
from the user’s address book.
renameAddressBookGroup
void renameAddressBookGroup(java.lang.String userName,
java.lang.String groupName, java.lang.String updatedGroupName)
This method renames an address book group identified by the group name
from the user’s address book.
Global address book search
The global address book search functions are included in this interface.
The methods are:
•
&quot;searchGABByFirstName&quot; (page 323)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Global address book search 323
•
&quot;searchGABByFirstNameRange&quot; (page 323)
•
&quot;searchGABByLastName&quot; (page 323)
•
&quot;searchGABByLastNameRange&quot; (page 323)
•
&quot;searchGABByName&quot; (page 324)
•
&quot;searchGABByNameRange&quot; (page 324)
•
&quot;searchGABByPhoneNumber&quot; (page 324)
•
&quot;searchGABByPhoneNumberRange&quot; (page 324)
•
&quot;searchGABByUserName&quot; (page 324)
•
&quot;searchGABByUserNameRange&quot; (page 324)
Complex Data Type (Provisionable Entity)
FullAddressBookEntry
WebService Name
GlobalAddrBook
Required ServicePackage Service
None
searchGABByFirstName
FullAddressBookEntry[] searchGABByFirstName(java.lang.String
userName, java.lang.String firstName)
This method retrieves the users in the global address book that match the
search criteria.
searchGABByFirstNameRange
FullAddressBookEntry[] searchGABByFirstNameRange(java.lang.String
userName, java.lang.String firstName, int start, int stop)
This method retrieves the users in the global address book that match the
search criteria.
searchGABByLastName
FullAddressBookEntry[] searchGABByLastName(java.lang.String
userName, java.lang.String lastName)
This method retrieves the users in the global address book that match the
search criteria.
searchGABByLastNameRange
FullAddressBookEntry[] searchGABByLastNameRange(java.lang.String
userName, java.lang.String lastName, int start, int stop)
This method retrieves the users in the global address book that match the
search criteria.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
324 Subscriber Open Provisioning Interface methods
searchGABByName
FullAddressBookEntry[] searchGABByName(java.lang.String userName,
java.lang.String name)
This method retrieves the users in the global address book that match the
search criteria.
searchGABByNameRange
FullAddressBookEntry[] searchGABByNameRange(java.lang.String
userName, java.lang.String name, int start, int stop)
This method retrieves the users in the global address book that match the
search criteria.
searchGABByPhoneNumber
FullAddressBookEntry[] searchGABByPhoneNumber(java.lang.String
userName, java.lang.String phoneNumber)
This method retrieves the users in the global address book that match the
search criteria.
searchGABByPhoneNumberRange
FullAddressBookEntry[] searchGABByPhoneNumberRange(java.lang.String userName, java.lang.String phoneNumber, int start,
int stop)
This method retrieves the users in the global address book that match the
search criteria.
searchGABByUserName
FullAddressBookEntry[] searchGABByUserName(java.lang.String
userName, java.lang.String searchUserName)
This method retrieves the users in the global address book that match the
search criteria.
searchGABByUserNameRange
FullAddressBookEntry[] searchGABByUserNameRange(java.lang.String
userName, java.lang.String searchUserName, int start, int stop)
This method retrieves the users in the global address book that match the
search criteria.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Call screening and routes
325
Call screening and routes
These methods are used to access and manage the user routes information
that is used to generate the call processing language (CPL) of a user.
These methods are controlled by the Advanced Screening service. If the
Advanced Screening service is not enabled in the user’s service package,
then these methods cannot be accessed.
The methods are:
•
&quot;activateRoutes&quot; (page 325)
•
&quot;addRoute&quot; (page 326)
•
&quot;addRoutes&quot; (page 326)
•
&quot;deactivateRoutes&quot; (page 326)
•
&quot;getAllRouteParmNames&quot; (page 326)
•
&quot;getRoute&quot; (page 326)
•
&quot;getRouteNames&quot; (page 326)
•
&quot;getRoutes&quot; (page 326)
•
&quot;modifyRoute&quot; (page 326)
•
&quot;removeAllRoutes&quot; (page 327)
•
&quot;removeRoute&quot; (page 327)
•
&quot;reorderRoutes&quot; (page 327)
•
&quot;setActiveRoutes&quot; (page 327)
Complex Data Type (Provisionable Entity)
Route
WebService Name
Routes
Required ServicePackage Service
•
for advanced routing options:
AdvancedScreening and Routing
•
for the IM Routing options: Instant Messaging
•
for the Send WebPage option: Client
Collaboration/WebPush service or parm
activateRoutes
void activateRoutes(java.lang.String userName, java.lang.String[]
routeNames)
This method configures the status of the routes specified in the input list
to Active.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
326 Subscriber Open Provisioning Interface methods
addRoute
void addRoute(java.lang.String userName, Route route)
This method creates a new route list with the information provided for the
user.
addRoutes
void addRoutes(java.lang.String userName, Route[] routes)
This method creates a new RouteList with the information provided for the
user.
deactivateRoutes
void deactivateRoutes(java.lang.String userName, java.lang.String[]
routeNames)
This method configures the status of the routes specified in the input list
to Inactive.
getAllRouteParmNames
java.lang.String[] getAllRouteParmNames()
This method retrieves the valid names to be used in the parms attribute
of the route.
getRoute
Route getRoute(java.lang.String userName, java.lang.String routeName)
This method retrieves the route using the name of the route and the user.
getRouteNames
java.lang.String[] getRouteNames(java.lang.String userName)
This method retrieves the names of the routes for the user.
getRoutes
Route[] getRoutes(java.lang.String userName)
This method retrieves all the routes for the user.
modifyRoute
void modifyRoute(java.lang.String userName, java.lang.String routeName,
Route newRoute)
This method modifies a route for the user with the route information provided.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Service preferences 327
removeAllRoutes
void removeAllRoutes(java.lang.String userName)
This method deletes all routes identified by the userName to whom these
routes belong.
removeRoute
void removeRoute(java.lang.String userName, java.lang.String routeName)
This method deletes the route identified by the route name and the
userName.
reorderRoutes
void reorderRoutes(java.lang.String userName, java.lang.String[]
routeNames)
This method reorders the routes specified in the input.
setActiveRoutes
void setActiveRoutes(java.lang.String userName, java.lang.String[]
routeNames)
This method configures the routes specified in the input to the active status
and configures the status of all the remaining routes (if any) to inactive.
Service preferences
These methods access and manage the service package information of a
user. The methods are controlled by the different services present in the
user’s service package. For example, if Presence is not enabled in the
user’s service package, then the user preferences for that service cannot be
configured. The banlist methods are controlled by the Presence service.
The methods are:
•
&quot;getAllUserPreferences&quot; (page 328)
•
&quot;getUserServicePackage&quot; (page 328)
•
&quot;modifyAllUserPreferences&quot; (page 328)
•
&quot;modifyUserPreferences&quot; (page 328)
•
&quot;removeAllUserPreferences&quot; (page 328)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
328 Subscriber Open Provisioning Interface methods
Complex Data Type (Provisionable Entity)
ServicePackage, Service
WebService Name
ServPref
Required ServicePackage Service
None. But the users can only access the
preferences for the services in their configured
service packages.
getAllUserPreferences
Service[] getAllUserPreferences(java.lang.String userName)
This method retrieves the user preferences for the configured services.
getUserServicePackage
ServicePackage getUserServicePackage(java.lang.String userName)
This method retreives the ServicePackage object to which the user belongs.
modifyAllUserPreferences
void modifyAllUserPreferences(java.lang.String userName, Service[]
services)
This method adds or modifies user preferences. Use this method only when
adding or modifying the user preferences for the configured services.
modifyUserPreferences
void modifyUserPreferences(java.lang.String userName, Service service)
This method adds or modifies the user preferences for a specific service.
removeAllUserPreferences
void removeAllUserPreferences(java.lang.String userName)
This method removes all the user preferences.
Service information
This interface contains the methods that are used to retrieve the service and
parameter display and internal names.
The methods are:
•
&quot;getParameterDisplayNameByParameterName&quot; (page 329)
•
&quot;getParameterNameByParameterDisplayName&quot; (page 329)
•
&quot;getServiceDisplayNameByServiceName&quot; (page 329)
•
&quot;getServiceNameByServiceDisplayName&quot; (page 329)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Meet Me service data
Complex Data Type (Provisionable Entity)
None
WebService Name
ServPrefConv
Required ServicePackage Service
None
329
getParameterDisplayNameByParameterName
java.lang.String getParameterDisplayNameByParameterName(java.lang.String userName, java.lang.String parameterName)
This method retrieves the parameter display name using the parameter
internal name.
getParameterNameByParameterDisplayName
java.lang.String getParameterNameByParameterDisplayName(java.lang.String userName, java.lang.String parameterDisplayName)
This method retrieves the parameter internal name using the parameter
display name.
getServiceDisplayNameByServiceName
java.lang.String getServiceDisplayNameByServiceName(java.lang.String
userName, java.lang.String serviceName)
This method retrieves the service display name using the service internal
name.
getServiceNameByServiceDisplayName
java.lang.String getServiceNameByServiceDisplayName(java.lang.String
userName, java.lang.String serviceDisplayName)
This method retrieves the service internal name using the service display
name.
Meet Me service data
This interface contains the methods that are used to access the Meet Me
conference service data of a user. These methods are controlled by the
Meet Me Conferencing service. If this service is not in the user’s service
package, then the user cannot execute these methods. In addition, if the
Meet Me service is not properly configured for the user’s domain, then these
methods cannot be executed and an error message is returned.
The methods are:
•
&quot;addMeetMeConfUser&quot; (page 330)
•
&quot;getMeetMeConfData&quot; (page 330)
•
&quot;modifyMeetMeConfUser&quot; (page 330)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
330 Subscriber Open Provisioning Interface methods
•
&quot;getConfDialUpNumbers&quot; (page 330)
•
&quot;getWebCollabURL&quot; (page 330)
•
&quot;getChairAccessURL&quot; (page 330)
•
&quot;removeMeetMeConfUser&quot; (page 331)
Complex Data Type (Provisionable Entity)
MeetMeConfData
WebService Name
MeetMe
Required ServicePackage Service
Meet Me Conferencing
addMeetMeConfUser
MeetMeConfData addMeetMeConfUser(java.lang.String userName,
MeetMeConfData meetmeConfData)
This method adds a new Meet Me Conference user.
getMeetMeConfData
MeetMeConfData getMeetMeConfData(java.lang.String userName)
This method retrieves Meet Me Conference data for a particular user.
modifyMeetMeConfUser
MeetMeConfData modifyMeetMeConfUser(java.lang.String userName,
MeetMeConfData meetmeConfData)
This method updates an existing Meet Me Conference user.
getConfDialUpNumbers
String[] getConfDialUpNumbers(String userName) throws
ProvisionException
This method retrieves a list of numbers that a Meet Me Conference user has
to dial to access the Meet Me conference service.
getWebCollabURL
String getWebCollabURL(String userName) throws ProvisionException
This method returns the web collaboration URL for a particular user.
getChairAccessURL
String getChairAccessURL(String userName)
This method retreives the chairperson access URL for a web collaboration
session, if it is already started.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Call logs
331
removeMeetMeConfUser
void removeMeetMeConfUser(java.lang.String userName)
This method deletes an existing Meet Me conference user from the system.
Call logs
This interface contains the methods that are used to access the call log
information of a user. These methods are controlled by the Network Call
Logs service. If the user does not have this service in the service package,
then the methods cannot be executed.
The methods are:
•
&quot;deleteCallLogs&quot; (page 331)
•
&quot;getCallLogs&quot; (page 331)
•
&quot;getIncomingCallLogs&quot; (page 331)
•
&quot;getOutgoingCallLogs&quot; (page 331)
Complex Data Type (Provisionable Entity)
CallLog
WebService Name
CallLog
Required ServicePackage Service
NetworkCall Logs
deleteCallLogs
void deleteCallLogs(java.lang.String username, java.lang.String[] callIds)
This method removes a set of call logs for the specified user.
getCallLogs
CallLog[] getCallLogs(java.lang.String username)
This method retrieves a list of call logs (incoming or outgoing) for a user.
getIncomingCallLogs
CallLog[] getIncomingCallLogs(java.lang.String username)
This method retrieves a list of incoming call logs for a user.
getOutgoingCallLogs
CallLog[] getOutgoingCallLogs(java.lang.String username)
This method retrieves a list of outgoing call logs for a user.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
332 Subscriber Open Provisioning Interface methods
Time zones
The method is:
•
&quot;getAllTimeZones&quot; (page 332)
Complex Data Type (Provisionable Entity)
TimeZone
WebService Name
TimeZone
Required ServicePackage Service
None
getAllTimeZones
getAllTimeZones
This method retrieves all the TimeZones existing in the system. Each time
zone object is identified by a name. For example, Central Standard Time
for CST.
Locales
The method is:
•
&quot;getSystemLocalesList&quot; (page 332)
Complex Data Type (Provisionable Entity)
LocaleData
WebService Name
Locale
Required ServicePackage Service
None
getSystemLocalesList
LocaleData[] getSystemLocalesList()
This method retrieves all the locales existing in the system. Each locale
object is identified by a name.
Password policy
The method is:
•
&quot;getPasswordPolicyDescription&quot; (page 332)
Complex Data Type (Provisionable Entity)
NONE
WebService Name
UserPwd
Required ServicePackage Service
None
getPasswordPolicyDescription
java.lang.String getPasswordPolicyDescription(java.lang.String userName)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User picture 333
This method retrieves the password policy description for the user’s domain,
as configured by the domain administrator.
E911 location list
The method is:
•
&quot;getLocationList&quot; (page 333)
Complex Data Type (Provisionable Entity)
LocList
WebService Name
E911Loc
Required ServicePackage Service
None
getLocationList
LocList getLocationList(long timestamp, boolean forceDownload,
java.lang.String domainName)
This method retrieves the location list for a particular domain to send to a
client. This location identifies the user’s physical location and is used for
callback purposes on Emergency 911 calls.
User picture
The methods are:
•
&quot;addUserPicture&quot; (page 333)
•
&quot;getUserPicture&quot; (page 333)
•
&quot;modifyUserPicture&quot; (page 334)
•
&quot;removeUserPicture&quot; (page 334)
Complex Data Type (Provisionable Entity)
UserPicture
WebService Name
UserPicture
Required ServicePackage Service
None
addUserPicture
void addUserPicture(java.lang.String userName, UserPicture picture)
This method adds a picture to be associated with the userName.
getUserPicture
UserPicture getUserPicture(java.lang.String userName)
This method retrieves the picture associated with the userName.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
334 Subscriber Open Provisioning Interface methods
modifyUserPicture
void modifyUserPicture(java.lang.String userName, UserPicture picture)
This method modifies the picture associated with the userName.
removeUserPicture
void removeUserPicture(java.lang.String userName)
This method removes the picture associated with the userName.
Banned user
The methods are:
•
&quot;addBannedUser&quot; (page 334)
•
&quot;addBannedUsers&quot; (page 334)
•
&quot;getBannedUsers&quot; (page 334)
•
&quot;modifyBannedUser&quot; (page 335)
•
&quot;removeAllBannedUsers&quot; (page 335)
•
&quot;removeBannedUser&quot; (page 335)
Complex Data Type (Provisionable Entity)
None
WebService Name
BanUser
Required ServicePackage Service
None
addBannedUser
void addBannedUser(java.lang.String userName, java.lang.String
bannedUserName)
This method adds a user to the ban list of a user’s address book, which
prevents the banned user from subscribing to this user’s presence
information.
addBannedUsers
void addBannedUsers(java.lang.String userName, java.lang.String[]
bannedUserNames)
This method adds multiple users to the ban list of a user’s address book
which would prevent the banned user from subscribing to this user’s
presence information.
getBannedUsers
java.lang.String[] getBannedUsers(java.lang.String userName)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Click To Call
335
This method retrieves a list of all the users banned from subscribing to this
user’s presence information from the ban list in the address book.
modifyBannedUser
void modifyBannedUser(java.lang.String userName, java.lang.String
bannedUserName)
This method adds a user to the ban list of a user’s address book, which
prevents the banned user from subscribing to this user’s presence
information.
removeAllBannedUsers
void removeAllBannedUsers(java.lang.String userName)
This method removes all users banned from subscribing to this user’s
presence information from the ban list in the address book.
removeBannedUser
void removeBannedUser(java.lang.String userName, java.lang.String
bannedUserName)
This method removes a user from the list of users banned from subscribing
to this user’s presence information from the ban list in the address book.
Assistant user manager
The method is:
•
&quot;getAssistedUsers&quot; (page 335)
Complex Data Type (Provisionable Entity)
None
WebService Name
AsstUser
Required ServicePackage Service
Assistant Console
getAssistedUsers
java.lang.String[] getAssistedUsers(java.lang.String userName)
This method retrieves the userNames of the users who are assisted by the
given user.
Click To Call
The method is:
•
&quot;clickToCall&quot; (page 336)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
336 Subscriber Open Provisioning Interface methods
Complex Data Type (Provisionable Entity)
None
WebService Name
CTCall
Required ServicePackage Service
None
clickToCall
void clickToCall(java.lang.String userName, java.lang.String password,
java.lang.String ctcFromParty, java.lang.String ctcToParty)
This method establishes a call between two parties.
I200x
The method is:
•
&quot;logoutUserFromDevice&quot; (page 336)
Complex Data Type (Provisionable Entity)
None
WebService Name
IPCM200X
Required ServicePackage Service
None
logoutUserFromDevice
void logoutUserFromDevice(java.lang.String userName, java.lang.String
Macaddress)
This method logs out a user from the IP Phone in an MCS configuration
where the IPCM is supported.
SOPI version
This interface contains the methods that query the supported SOPI version
number. This enables the MCS to return release-specific information and
is used for backwards compatibility.
The methods are:
•
&quot;getCurrentSOPIVersion&quot; (page 336)
•
&quot;getSupportedSOPIVersions&quot; (page 337)
Complex Data Type (Provisionable Entity)
None
WebService Name
sopi
Required ServicePackage Service
None
getCurrentSOPIVersion
java.lang.String getCurrentSOPIVersion()
This method retrieves the current SOPI version number.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
SOPI version
getSupportedSOPIVersions
java.lang.String[] getSupportedSOPIVersions()
This method retrieves the currently-supported SOPI version numbers.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
337
338 Subscriber Open Provisioning Interface methods
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
339
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:
•
&quot;Data access error codes and messages (000000)&quot; (page 341)
•
&quot;Directories error codes and messages (001000)&quot; (page 343)
•
&quot;Address book error codes and messages (002000)&quot; (page 344)
•
&quot;User Service Package error codes and messages (003000)&quot; (page 348)
•
&quot;User Operation error codes and messages (004000)&quot; (page 350)
•
&quot;Resource Management Exceptions error codes and messages
(004100)&quot; (page 355)
•
&quot;Prefix error codes and messages (004200)&quot; (page 356)
•
&quot;Domain error codes and messages (005000)&quot; (page 357)
•
&quot;Address Book Group error codes and messages (006000)&quot; (page 359)
•
&quot;Domain bulletins error codes and messages (007000)&quot; (page 359)
•
&quot;Banned subscriber error codes and messages (008000)&quot; (page 359)
•
&quot;Resource Management error codes and messages (009000)&quot; (page
360)
•
&quot;Device error codes and messages (010000)&quot; (page 362)
•
&quot;Domain COS error codes and messages (011000)&quot; (page 363)
•
&quot;Domain Profile error codes and messages (012000)&quot; (page 364)
•
&quot;Domain locale error codes and messages (013000)&quot; (page 364)
•
&quot;Global Address Book error codes and messages (014000)&quot; (page 365)
•
&quot;Foreign domain error codes and messages (015000)&quot; (page 365)
•
&quot;IPCM error codes and messages (016000)&quot; (page 367)
•
&quot;Network call logs error codes and messages (017000)&quot; (page 368)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
340 Error codes and messages
•
&quot;Personal Address Book error codes and messages (018000)&quot; (page
368)
•
&quot;Phone Number error codes and messages (019000)&quot; (page 368)
•
&quot;Trunk and Gateway error codes and messages (020000)&quot; (page 369)
•
&quot;Route error codes and messages (024000)&quot; (page 369)
•
&quot;Service error codes and messages (025000)&quot; (page 372)
•
&quot;Telephony Route error codes and messages (026000)&quot; (page 375)
•
&quot;Status reason error codes and messages (027000)&quot; (page 378)
•
&quot;Number qualifier error codes and messages (028000)&quot; (page 379)
•
&quot;Time block group and Presence condition error codes and messages
(029000)&quot; (page 380)
•
&quot;Time zone error codes and messages (030000)&quot; (page 380)
•
&quot;User Data error codes and messages (032000)&quot; (page 381)
•
&quot;User time and Click to call error codes and messages (033000)&quot; (page
381)
•
&quot;Voicemail error codes and messages (034000)&quot; (page 383)
•
&quot;Reserved addresses error codes and messages (035000)&quot; (page 384)
•
&quot;User properties error codes and messages (036000)&quot; (page 384)
•
&quot;Music on Hold error codes and messages (037000)&quot; (page 384)
•
&quot;Branding error codes and messages (038000)&quot; (page 385)
•
&quot;Treatment error codes and messages (039000)&quot; (page 386)
•
&quot;Assistant error codes and messages (040000)&quot; (page 387)
•
&quot;User picture error codes and messages (041000)&quot; (page 389)
•
&quot;Location error codes and messages (042000)&quot; (page 389)
•
&quot;ErlInfo error codes and messages (043000)&quot; (page 391)
•
&quot;Emergency alias error codes and messages (044000)&quot; (page 393)
•
&quot;Emergency numbers error codes and messages (045000)&quot; (page 393)
•
&quot;Meet Me Audio Conferencing related error codes and messages
(046000)&quot; (page 394)
•
&quot;Media Portal Group error codes and messages (046100)&quot; (page 395)
•
&quot;Media Portal Routability Group error codes and messages (047000)&quot;
(page 398)
•
&quot;Auto ID error codes and messages (048000)&quot; (page 400)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Data access error codes and messages (000000) 341
•
&quot;LDAP error codes and messages (049000)&quot; (page 400)
•
&quot;Pooled Entity related error messages (050000)&quot; (page 402)
•
&quot;Converged Desktop feature error messages (051000)&quot; (page 404)
•
&quot;Voicemail server provisioning related error codes and messages
(052000)&quot; (page 405)
•
&quot;Password policy error codes and messages (055000)&quot; (page 408)
•
&quot;SMS subscriber, SMPP configuration and interworking domain error
codes and messages (056000)&quot; (page 409)
•
&quot;Voicemail error codes and messages (057000)&quot; (page 410)
•
&quot;Global address book error codes and messages (058000)&quot; (page 410)
•
&quot;Service node error codes and messages (059000)&quot; (page 410)
•
&quot;Admin and role related error codes and messages (060000)&quot; (page 414)
•
&quot;Parm Definition error codes and messages (061000)&quot; (page 415)
•
&quot;Out of band REFER error codes and messages (062000)&quot; (page 416)
•
&quot;Ringback error codes and messages (063000)&quot; (page 416)
•
&quot;Domain CLI error codes and messages (064000)&quot; (page 417)
•
&quot;Presence error codes and messages (072000)&quot; (page 418)
•
&quot;Group error codes and messages (089000)&quot; (page 418)
•
&quot;System-specific exceptions and authorization error codes and
messages (099000)&quot; (page 420)
•
&quot;Generic exceptions (099999)&quot; (page 421)
Data access error codes and messages (000000)
Data access error codes and messages (000000)
Error Code
Error Message
000000
The field(s): {0} must be unique
000001
Numeric value is too large. Please try with a smaller value.
000002
Entry cannot be empty. Please provide a value.
000003
Entry cannot be empty. Please provide a value.
000004
Value is too large. Please try with a smaller value.
000005
Value must be an integer. Please correct the entry and retry.
000006
Data unavailable (Data shutdown forcing disconnection). Please
try again later.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
342 Error codes and messages
Error Code
Error Message
000007
Data unavailable (Unable to connect to listener). Please try
again later.
000008
Data unavailable (Internal error). Please try again later.
000009
Data unavailable (Connection refused – dispatcher is full).
Please try again later.
000010
Data unavailable. Please try again later.
000011
Data unavailable. Please try again later.
000012
Data unavailable. Please try again later.
000013
Data unavailable (Unexpected end of channel). Please try again
later.
000014
Data unavailable (Not connected). Please try again later.
000015
Data unavailable (Could not connect). Please try again later.
000016
Data unavailable (Lost primary connection). Please try again
later.
000017
Data unavailable (Connection terminated). Please try again
later.
000018
Constraint violated. Please consult documentation for these
fields: {0}
000019
Constraint violated. Please consult documentation.
000020
Parent not found for {0}
000021
Unable to delete entry because other components are
referencing {0}.
000022
Voicemail entry already exists. Please use a different value
000023
Cannot add device because there is no capacity left for this
IPCM:Domain relation
000025
Constraint violated during trigger execution: {0}
000026
Unable to add service alias. Alias conflicts with existing pooled
entity, user, alias or service
000027
Service Alias constraint violated on {0}
000028
Data size bigger than max size for this entry. Please reduce the
size of the entry.
000029
Could not generate keys for the data as requested. Please
contact your next level of support.
000040
Unable to create a transaction. Please contact your next level
of support.
000041
Unable to rollback transaction. Please contact your next level
of support.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Directories error codes and messages (001000) 343
Error Code
Error Message
000042
Unable to commit transaction. Please contact your next level
of support.
000999
A data access error occurred. Please try later or contact your
next level of support. Code = {0}
Directories error codes and messages (001000)
Directories error codes and messages (001000)
Error Code
Error Message
001000
Adding group for user {0} failed. Please provide a group name.
001001
Adding address book group Failed: {0}.
001002
Failed to create notify message for address book group change,
please contact support for more information.
001003
Address book group information retrieval failed for user {0} : {1}
001004
The address book group information could not be retrieved.
Data Access error. Please contact next level of support for more
information.
001005
Address book banned user information retrieval failed for user
{0} : {1}
001006
The banned user information could not be retrieved for the
user {0}. Data Access Error. Please contact support for more
information.
001007
Address book group name information retrieval failed: {0}
001008
Group information retrieval failed. Data access error. Please
contact support for more information.
001009
Adding groups failed, no groups were found for adding to user
{0}.
001010
Groups could not be updated; Another group(s) with the same
name(s) {0} exists.
001011
Updating group information failed. Data access error: {0}
001012
Adding banned user failed. Banned username cannot be null.
001013
Adding banned entry failed: {0}.
001014
Adding banned users failed. No entries were found for adding
to ban list for user {0}.
001015
The banned user information could not be deleted: {0}
001016
Cannot modify group information, Group to be updated {0},
updated Group is {1}.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
344 Error codes and messages
Error Code
Error Message
001017
Groups could not be updated: Another group(s) with the same
name(s) {0} exists.
001018
Updating group information failed. Data access error {0}.
001019
Failed to create notify message for address book change.
Please contact support for more information.
001020
Initialization of data for address book failed. Unable to retrieve
data.
001021
Removing group information failed. Data access error {0}.
001022
Adding banned user(s) failed; you cannot ban yourself.
001023
Adding users to addressbook failed\: {0}
001024
Failed to send notification of modification of address book.
Please contact support for more information.
001025
Unable to delete the address book group because the following
routes reference it: {0}
001026
User cannot be a member of more than {0} MADN groups. User:
{1}, Groups: {2}
Address book error codes and messages (002000)
Address book error codes and messages (002000)
Error Code
Error Message
002000
The address book was not found for the user{0}
002001
The address book information could not be retrieved for user:{0}
: {1}
002002
The address book information could not be retrieved: Data
access error. Please contact support for more information
002003
Address book friend information retrieval failed for user {0}: {1}
002004
Address book friend information retrieval failed for user {0}: Data
access error. Please contact support for more information
002005
The address book information could not be retrieved for user:{0}
: {1}
002006
Address book friend information retrieval failed for user {0}. Data
access error. Please contact support for more information
002007
The address book Entry {0} to be deleted was not found.
002008
The address book entry information could not be deleted, {0}
002009
Failed to create notify message for address book change.
Please contact support for more information.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Address book error codes and messages (002000) 345
Error Code
Error Message
002010
Cannot perform requested operation on entry. Information on
maximum number of friends and entries allowed could not be
retrieved. Please make sure you have Presence service as a
part of your package
002011
Cannot add entry {0} to list of friends. Maximum number of
friends allowed is {1}
002012
Removing friend information failed: {0}
002013
Removing friend information failed. Please contact support for
more information.
002014
{0} cannot be added to list of friends; maximum number of
friends allowed is {1}
002015
Cannot add entries: Maximum number of friends allowed could
not be retrieved
002016
Adding entries failed; no entries were found for adding to
address book for user {0}
002017
Adding address book entry information failed: Another entry
with the nickname(s) {0} exists.
002018
Adding address book entry Failed for user {0} : {1}
002019
Failed to create notify message for address book change.
Please contact support for more information.
002020
Address book address information retrieval failed : {0}
002021
Address book address information retrieval failed: Data access
error. Please contact support for more information.
002023
Group information retrieval failed, Data access error. Please
contact support for more information.
002024
Address book information was not found for the user with
nickname {0}
002025
Address book entry information retrieval failed for user {0} : {1}
002026
Address book ID information retrieval for user with nickname
{0} failed: Data Access Error. Please contact support for more
information.
002027
Address book entry information retrieval failed: {0}.
002028
Address book ID information retrieval for user failed: Data
Access Error. Please contact support for more information.
002029
Address book nickname information for the user with Id
information {0} was not found.
002030
Address book nickname information retrieval failed: {0}.
002031
Address book nickname information retrieval for user with Id
{0} failed: Data Access Error. Please contact support for more
information.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
346 Error codes and messages
Error Code
Error Message
002032
Initialization failure of data for Address book: This process is
recoverable later.
002033
Failed to initialize data access components. Unable to proceed
further.
002034
Data initialization for Address book information failed. Cannot
proceed further.
002035
Primary Contact and Nickname are required fields for an address
book entry.
002036
Primary Contact cannot have - in it.
002037
The Maximum Number of Friends parameter could not be
retrieved.
002038
Cannot modify address book entries: nickname and address
book entry information cannot be null.
002039
Cannot modify address book entries: number of nickname(s)
and address book entries must be same.
002040
The AddressBook Entry {0} to be updated was not found.
002041
Cannot add entry {0} as friend: Maximum number of friends
allowed is {0}.
002042
Updating address book entry failed: Another entry with the same
nickname exists for the user {0}
002043
Updating address book entry failed: Data access error. Please
contact support for more information.
002044
Address book entry photo information retrieval failed: Data
access error. Please contact support for more information.
002045
Address book entry information retrieval for user failed: Data
Access Error. Please contact support for more information.
002046
The address book information could not be deleted: {0}
002047
Address book group name information retrieval failed: {0}
002048
Group information retrieval failed. Data access error, Please
contact support for more information.
002049
Address book information retrieval failed for user {0} : {1}
002050
The address book information could not be retrieved: Data
Access Error. Please contact logs for more information.
002051
Failed to send notification of modification of address book.
Please contact support for more information.
002052
You are allowed to have a maximum of {0} entries in your
address book with your current service, please contact your
provider for a service upgrade if you need to add more entries.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Address book error codes and messages (002000) 347
Error Code
Error Message
002053
Cannot add more than {0} to friend list: current number of friends
is {1}, number of friends requested to be added is {2}
002054
Cannot add entries: Maximum number of friends allowed could
not be retrieved.
002055
Address book information retrieval failed for user {0} : {1}
002056
The address book information could not be retrieved :
002057
Address book nickname information retrieval failed: {0}
002058
Address book entry information retrieval for user {0} failed: Data
Access Error. Please contact support.
002059
Data access error. Please contact support for more information.
002060
Adding friend information failed, {0}
002061
Invalid nickname provided cannot be null
002062
You have exceeded the maximum number of entries allowed in
your address book with your current service. Please contact
your provider for a service upgrade if you need to add more
entries than {0}.
002063
Error retrieving address book information for the groups provided
{0}
002064
Error retrieving screened address book information for the user
{0} and route {1} provided
002065
Error retrieving screened global address book information for the
user {0} and for the route {1} provided
002066
Error retrieving personal address book information for user {0}
: {1}
002067
Error retrieving global address book information {0}
002068
Error retrieving address book entry information based on
information provided {0}
002069
Updating address book entry failed: Cannot add group(s) named
{0} because a similar group name already exists. Be sure to use
the correct case when specifying the group name.
002070
Adding address book entry failed: Cannot add group(s) named
{0} because a similar group name already exists. Be sure to use
the correct case when specifying the group name.
002071
Address book operation failed: Address book entry cannot be
null
002072
Primary Contact, Nickname, Primary Contact and Nickname are
required fields for an address book entry
002073
An error occurred while performing the requested operation\: {0}
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
348 Error codes and messages
Error Code
Error Message
002075
Updating address book entry failed: Home Phone number entry
must be 50 characters or less.
002076
Updating address book entry failed: Business Phone number
entry must be 50 characters or less.
002077
Updating address book entry failed: Fax number entry must
be 50 characters or less.
002078
Updating address book entry failed: Mobile Phone number entry
must be 50 characters or less.
002079
Updating address book entry failed: Pager number entry must
be 50 characters or less.
002099
Unable to delete address book entry because the following
routes are still referencing it. Please remove the address book
entry from the following routes: {0}
User Service Package error codes and messages (003000)
User Service Package error codes and messages (003000)
Error Code
Error Message
003000
Required field not found. Please provide the ’User Name’.
003001
Cannot find a Service Package for user {0}.
003003
Data retrieval failed: ServicePackage Information not found {0}.
003004
Invalid Service. User {0} does not have the service {1} in his/her
service package. Please check the user service package.
003005
Invalid Parameter. User {0} does not have the service parameter
{1} for the service {2} in his/her service package. Please check
the user service package.
003006
Cannot modify user preferences because the Service Parameter
{0} has a null value. Please provide a value.
003007
Cannot modify user preferences because the Service Parameter
{0} has invalid value {1}. The valid values are {2}.
003008
Cannot modify user preferences because the Service Parameter
{0} has a null value. Please provide a value.
003009
Cannot modify user preferences because the Service Parameter
{0} is invalid.
003010
Operation failed. Root cause: {0}
003011
Operation failed. Cannot delete User Preferences, Root cause:
{0}
003012
Required field not found. Please provide the ’User Name’ and
’Service Object’.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Service Package error codes and messages (003000) 349
Error Code
Error Message
003013
Error: Please contact your next level of support.
003014
Error: Failed to send Service Package change notification.
003015
Service {0} does not have any user preferences.
003016
Service {0} not available.
003017
Service package name {0} is already in use. Service package
name should be unique under a root domain. Please try another
name.
003018
The parameter {0} is required for the service {1}. Please provide
a value.
003019
Deleting Service Package Information Failed: Dependent data
exists.{0}
003020
The parameter {0} cannot be set because it has not be
customized at the domain level.
003021
Please provide all the required properties, {0} to perform the
operation.
003022
Cannot add/modify the Service Package because the Service
{0} is not assigned to Domain {1}
003023
Cannot add/modify the Service Package because the Service
Parameter {0} is invalid.
003024
Cannot add/modify the Service Package because the Service
Parameter {0} is not assigned to Service {1}
003025
Cannot add/modify the Service Package because the Service
Parameter {0} has invalid value of {1}. The valid values are {2}
003026
Add/modify service package failed: {0}
003027
Cannot add/modify the Service Package because the Service {0}
is not assigned to domain {1}. Please try again after assigning
services present.
003028
Cannot find a Service Package with name {0} in domain {1}
003029
Unable to assign package to domain: {0}
003030
Unable to retrieve default service package information for
domain {0}: {1}
003031
Service package information retrieval failed: {0}
003032
Deleting Service Package Information failed: {0}
003033
Invalid Data:Service Packages {0} not Found
003034
Cannot find a Parameter with name {0} in Service {1}
003035
Addition of Service Package failed: {0}
003036
Modification of Service Package failed: {0}
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
350 Error codes and messages
Error Code
Error Message
003037
Service Package name not found. Please specify a Service
Package name.
003038
Required attributes to generate the Service Package Notify
message body are null. Please provide the required attributes.
003039
Required field not found. Please provide the ’Service Name’.
003040
Please provide the required attribute ’Parameter Name’ for
Service {0}.
003041
The parameter {0} is not User-modifiable for Service {1}.
003042
The value {0} for priority is too large. Please try with a smaller
value.
003043
Deleting Service Package Information failed: There are users
associated with the service package being deleted. Please
remove the users and then delete the package(s).
003050
Domain names for child and parent domain are required for
assigning service packages.
003051
Domain names for child and parent domain should not be the
same while assigning service packages.
003052
Domain {0} is not a child of the domain {1}. Cannot assign
service package to given domain.
003053
Cannot modify the Service Package: Number of {0} units
available is less than the number of users in the domain with
the package.
User Operation error codes and messages (004000)
User Operation error codes and messages (004000)
Error Code
Error Message
004000
Invalid User Name {0}. Please provide the fully qualified ’User
Name’ (i.e. user@domain).
004001
Invalid User. User {0} not found.
004002
Password cannot be null. Please provide a password.
004003
Invalid Password. Password cannot be greater than 20
characters.
004004
Invalid Password. Character: {0} is not allowed in password.
004005
Error.Please contact support for more information.
004006
Cannot perform operation because the user has an invalid
username {0} in domain {1}.
004007
Cannot add/modify user without Status. Please provide the
required value.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Operation error codes and messages (004000) 351
Error Code
Error Message
004008
Cannot add/modify user without Locale. Please provide the
required value.
004009
Cannot add/modify user without Time Zone. Please provide
the required value.
004010
Cannot add/modify user without Service Package. Please
provide the required value.
004011
Cannot add/modify user without First Name and Last Name.
Please provide the required values.
004012
Cannot add/modify user without User Name. Please provide
the required value.
004013
The number of users requested/found is greater than the system
limit {0}. Please change your search criteria to narrow down
search.
004014
Required attributes are null. Please provide the required
attributes.
004015
The query for Global Address Book cannot be completed. {0}
004016
Cannot perform query with the current parameters. Please verify
choices again.
004017
Deleting user information failed because dependent data exists
{0}. Please delete the child information.
004018
Deleting user information failed. Please contact support for
more information.
004019
Invalid Password.
004020
Cannot modify User Information. {0}
004021
Cannot perform operation because User Name should be unique
in a domain. Please use a different user name.
004022
Cannot perform operation because Status Reason {0} is invalid
for user {1}.
004023
Cannot perform operation because Status {0} is invalid for user
{1}.
004024
Cannot perform operation because Voicemail Server {0} is
invalid for user {1}.
004025
Cannot perform operation because Class of Service {0} in invalid
for user {1}.
004026
Cannot perform operation. {0}
004027
Cannot perform operation because Locale {0} in invalid for user
{1}.
004028
Unable to add/modify user {0}. Voicemail Server specified
without a valid Voicemail ID.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
352 Error codes and messages
Error Code
Error Message
004029
Unable to add/modify user {0}. Voicemail ID specified without a
valid Voicemail Server.
004030
Unable to add voicemail server for user {0}. A voicemail server
is already assigned to the user.
004031
Unable to add voicemail server for user {0} due to the following
error: {1}
004032
The username {0} in the method does not match the
authenticated user {1}.
004033
Cannot modify User Name.
004040
Invalid data for user {0}. Username, Alias, BlendedAlias and
Directory Number should be unique for a user. Ensure there
are no duplicates.
004041
Move User operation failed. Voicemail numbers should be
unique in a domain.
004042
Operation failed. Voicemail number should be unique in a
domain. The following users have voicemail numbers that are
already in use in {0}: {1}
004043
Voicemail number already exists in the {0}. Please enter a
different value.
004044
Cannot perform operation because Status {0} is invalid for user
{1}. Status does not match the status in status reason {2}
004045
UserId cannot be null {0}
004046
Invalid Username {0}. Username cannot be greater than 64
characters.
004047
Invalid Username, cannot authenticate. Username must be of
the form user@domain.
004048
User’s status unknown, cannot authenticate.
004049
User not active, cannot authenticate.
004050
Invalid Status or Reason provided {0}
004051
Service package {0} provided was not found
004052
Invalid Characters in user name {0}.The valid character’s are
A-Z, a-z, 0-9, &quot;-&quot;, &quot;_&quot; and &quot;.&quot;
004053
Data required to carry out user operation has not been loaded.
Please verify availability of data source(s).
004054
Account Lockout
004056
Cannot perform add multiple users operation. Following
usernames/aliases are used for several users {0}
004057
Invalid Character in user’s First Name or Last Name. Character
&quot; (double quotation mark) cannot be used for these fields.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User Operation error codes and messages (004000) 353
Error Code
Error Message
004058
Unable to get User count in domain {0}. Please contact your
next level of support.
004060
The required attributes are null. Please provide the required
attributes {0} {1} {2}.
004061
The required attributes are null. Please provide the required
attributes {0} {1}.
004062
Cannot add more than {0} users for the domain {1}. Either delete
existing users to add users or contact next level of support for
increasing maximum number of users that can be provisioned
for this domain.
004063
Cannot add users to this domain because a user limit has not
been set.
004064
Cannot add/modify user because user’s service package has
the {0} service. This is a licensed service with no limit set for this
domain. Please try again with a service package without this
service or assign a limit for this service for the domain {1}.
004065
Cannot add/modify user because users service package has the
{0} service. {1} service limit of {2} has been exceeded for the
domain {3}. Please try again with a service package without this
service or increase the limit for this service for this domain.
004066
The email address provided is invalid, should be in the form
user@domain.
004067
The given email address is invalid. It contains invalid characters.
Email address should be in the form username@domain.
004068
Character:{0} is not allowed in a {1}. Please try again without
this character in the string.
004069
The IP address {0} is invalid. IP address should be in the form
47.103.22.22.
004070
Not enough resources available for adding the user. Service
package chosen has a service which cannot be given out until
the number of units of the service is increased for this domain.
Please view resources for the domain and make sure you have
enough resources.
004071
Parsing of the time into data format building rule cpl failed.
Please contact support for more information.
004072
An error occurred. Please contact your next level of support.
004073
Unable to register CPL at this time. Please contact your next
level of support.
004080
The domain {0} does not have a default service package.Please
create a service package and try again
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
354 Error codes and messages
Error Code
Error Message
004065
Cannot add/modify user as users service package has the
{0} service. {1} service limit of {2} has been exceeded for the
domain {3}. Please try again with a service package without this
service or increase the limit for this service for this domain.
004066
The email address provided is invalid, should be of the form
user@domain.
004067
The given email address is invalid. It contains invalid characters.
Email address should be of the form username@domain.
004068
Character:{0} is not allowed in a {1}. Please try again without
this character in the string.
004069
The IP address {0} is invalid. IP address should be of the form
47.103.22.22.
004070
Not enough resources available for adding the user. Service
package chosen has a service which cannot be given out until
the number of units of the service is increased for this domain.
Please view resources for the domain and make sure you have
enough resources.
004071
Parsing of the time into data format building rule cpl failed,
please contact support for more information
004072
An error occurred, please contact your next level of support.
004073
Unable to register CPL at this time, please contact your next
level of support.
004080
The domain {0} does not have a default service package.Please
create a service package and try again
004081
The user account is inactive.
004082
Not enough resources available for carrying out user operation.
Service package has one of {0} services. Operation cannot be
completed until the number of units of the service is increased
for the domain.Please view resources for the domain and verify
domain resource counts.
004083
Blended Alias validation failed, {0}
004084
The Service Package provided, {0}, was not found.
004085
Error occurred in sending user move event to interested parties.
Please contact your next level of support.
004086
Error occurred in getting user count. Please contact your next
level of support.
004087
Error occurred in getting user count : {0}
004088
Cannot change user password. {0}
004089
Directory Number entered is already in use. Please provide
another value for this field.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Resource Management Exceptions error codes and messages (004100) 355
Error Code
Error Message
004090
Unable to retrieve user information. {0}
004091
Invalid {0} {1}. {0} of the user cannot be greater than 30
characters.
004092
User search will return too many entries. Please refine your
criteria.
004094
The following values are reserved and cannot be used because
usernames/alias or blended alias. {0}. Please use a different
value.
004095
Cannot delete {0} because it is an E911 ANI.
004096
Invalid Directory Number {0}. Directory number cannot be
greater than 64 digits.
004097
Invalid Directory Number {0}. Directory number should be a
number of maximum length 64 digits.
004098
Operation failed. User does not have the service {0} in the
service package {1}.
004099
Unable to carry out search, {0}.
Resource Management Exceptions error codes and messages
(004100)
Resource Management Exceptions error codes and messages (004100)
Error Code
Error Message
004100
Unable to get User resource info. Please contact your next level
of support.
004101
Cannot add the required number i.e. {0} users to domain {1}
because it exceeds the remaining limit i.e. {2} .
004102
Resource {0} not found in the system.
004103
Service {0} is a licensed service and is not assigned to this
domain {1}. Please contact your next level of support to assign
this service to the domain.
004104
Unable to get License key resource info. Please contact your
next level of support.
004105
Error deleting resource information for domain {0}. Please
contact your next level of support.
004106
Unknown error occurred in resource management. Please
contact your next level of support.
004107
Unable to add resource to domain {0} because the maximum
limit has been reached for service {1}.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
356 Error codes and messages
Error Code
Error Message
004108
Cannot add the required number i.e. {0} users to domain {1}
because it exceeds the assigned limit.
004109
Error renaming the partition name for domain {0}. Please
provide the new name.
004110
Error renaming the partition name for domain {0}.
Subscriber OPI error codes and messages (004150)
Subscriber OPI error codes and messages (004150)
Error Code
Error Message
004150
The user {0} does not have the subscriber opi service. The
subscriber opi service must be present to perform subscriber
opi operations.
004151
Required attributes are null. Please provide the username, old
password and new password.
004152
Required attributes are null. Please provide the username and
password.
004153
Required attributes are not set in the header. Please provide
the username and password.
004154
The user {0} does not have the {1} service. The service must be
present to perform these operations.
004155
Required attribute is null. Please provide the password.
004156
Authentication failed. Invalid username/password combination.
Please try again.
004157
Invalid old password. Please try again.
004158
User Password Expired. Please change your password using
the changePassword method.
Prefix error codes and messages (004200)
Prefix error codes and messages(004200)
Error Code
Error Message
004200
Required attributes are null. Please provide the required
attributes ’User Name’ and ’Prefix Data’.
004201
Null attributes provided. Please provide the required attribute
’User Name’.
004202
User prefix data removal for user {0} failed: {1}
004203
Prefix validation failed.The prefix should contain only numeric
values and should be less than or equal to 16 digits in length.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Domain error codes and messages (005000) 357
Error Code
Error Message
004204
Assigning prefix data to user failed. {0}
004205
Getting user prefix data information failed. {0}
004206
Cannot assign Audio Device Prefix to the user because the user
{0} does not have &quot;MobileConverged&quot; service parameter in his
service package.
004207
Cannot assign Direct To Gateway prefix to the user because
the user {0} does not have &quot;Direct To Gateway&quot; service in his
service package.
Domain error codes and messages (005000)
Domain error codes and messages (005000)
Error Code
Error Message
005000
Required field not found. Please provide the Domain name.
005001
Data retrieval failed: Domain Information not found {0}.
005002
Error: Please contact your next level of support.
005002
Invalid Domain. Domain {0} not found.
005003
Required attributes are null. Please provide the required
attributes.
005004
Required attribute(s) not provided. Please provide the following:
{0}
005005
Adding domain failed {0}. (Similar data exists for the following
fields: {1})
005006
A data access error occurred while {0} domain: {1}
005007
Error occurred while sending notification of domain operation to
interested parties.
005008
Invalid class of service {0} provided for domain {1}
005009
Modification of domain failed {0}. (Similar data exists for the
following fields: {1})
005010
The {0} domain is a read/write only domain, and cannot be
deleted.
005011
Deletion of domain failed, dependent data still exists (e.g.
sub-domains, routable services, users associated with groups,
etc.)
005012
Cannot find a domain parameter with name {0}.
005013
Cannot add/modify domain {0} because it does not have domain
parameters.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
358 Error codes and messages
Error Code
Error Message
005014
Cannot add/modify domain {0} because it has an invalid value
for the domain parameter {1}. {2}.
005015
Cannot add/modify domain {0} because it does not have the
required domain parameter {1} {2}.
005016
Cannot assign a Cos when creating the domain {0}
005017
Invalid Sub Domain name {0}. {1}
005018
Error loading domain data. Please contact your next level of
support.
005019
A data access error occurred while loading domain data, please
contact your next level of support.
005020
Unable to create root domain cache: {0}
005021
Invalid Domain Parameter Value &quot;{0}&quot; for domain Parameter
&quot;{1}&quot; . {2}
005022
Cannot add domain, no such location, &quot;{0}&quot;
005023
Invalid domain parameter: {0}.
005024
Unable to create Device Parameters Cache. Please contact
your next level of support.
005025
Invalid Characters in domain name. {0}
005026
Location not valid in root domain for this domain.
005027
Server Home is a required field. Please provide a valid URL or
IP address for this field
005028
A data access error occurred while retrieving descendents of
domain {0} : {1}
005029
Modification of domain name is not allowed. Please ensure
domain names are identical.
005030
Required attributes ’Domain Name’ and/or ’Profile’ are null.
Please provide the required attributes.
005031
Unable to set domain profile. Domain Profile should be unique.
Please use a different value because profile {0} already exists.
005032
Unable to set domain profile.Please contact your support for
more information.
005033
Cannot add/modify sub-domain {0} because domain parameter
{1} can only be set on root domains. {2}.
005041
An error occurred when trying to add/modify Domain {0}. {1}
005042
The number of domains found is greater than the system limit
{0}. Please use the other alternative methods to get the domain
information.
005043
The number of domains requested is greater than the system
limit {0}. Please change your search criteria.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Banned subscriber error codes and messages (008000) 359
Error Code
Error Message
005044
The required attributes &quot;Start&quot; and &quot;Stop&quot; are null. Please
provide the required attributes.
005045
The required attributes &quot;Start&quot; and &quot;Stop&quot; are invalid. Please
provide numbers greater than zero.
005046
Cannot add domain because the existing domain count has
reached the system limit of 10000. Delete an existing domain
to add a new domain.
Address Book Group error codes and messages (006000)
Address Book Group error codes and messages (006000)
Error Code
Error Message
006000
Address Book Group names information is necessary for an
Address Book Group {0}.
006001
Retrieval of Address Book Group information failed. There
was a problem with the data store while trying to retrieve the
information.
006002
Failed to initialize data access components: Unable to proceed
further. Please contact your next level of support.
Domain bulletins error codes and messages (007000)
Domain bulletins error codes and messages (007000)
Error Code
Error Message
007000
Unable to load bulletins for domain {0}. A Data Access error
occurred. Please contact your next level of support.
007001
Unable to load bulletins for domain {0}: {1}
007002
The bulletins must be unique in domain {0}. Please provide
distinct bulletins.
007003
Unable to update bulletins: {0}
007004
This operation cannot be performed on sub-domains; they can
be done only on root domains.
Banned subscriber error codes and messages (008000)
Banned subscriber error codes and messages (008000)
Error Code
Error Message
008000
Banned Subscriber information is required.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
360 Error codes and messages
Error Code
Error Message
008001
Domain information is required.
008002
Removing banned subscriber information failed: {0}
008003
Banned Subscriber Party information is required for this
operation.
008004
Adding new banned subscriber information failed: {0}
008005
Retrieving banned subscriber information failed. There was
a problem with the data store while trying to retrieve the
information.
008006
Banned subscribers to be deleted information is required.
008007
Removing banned subscriber information failed: {0}
008008
Failed to initialize data access components: Unable to proceed
further.Please contact your next level of support.
008009
Cannot add/modify banned users because the user {0} does
not have the presence service.
008010
Invalid banned party information. Valid examples are:
&quot;user@domain&quot; for banning an individual. &quot;*@domain&quot; for
banning users in a domain. &quot;*&quot; or &quot;*@domain&quot; for banning users
in current domain.
Resource Management error codes and messages (009000)
Resource Management error codes and messages (009000)
Error Code
Error Message
009000
Domain resource operation failed, domain name cannot be
empty. Please provide a domain name.
009001
Domain resource operation failed, service name cannot be
empty. Please provide a service name.
009003
Domain resource operation failed, domain provided cannot be
found.
009004
Domain resource operation failed. No License key service
corresponding to {0} was found.
009005
Domain resource operation failed. Requested number of units
for the resource {0} for domain {1} is more than the remaining
number of units in the system {2}. Please try with a lower value.
009006
Adding domain resource failed. Cannot add resource to domain
{0}. Service {1} already exists.
009007
Adding domain resource failed: {0}
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Resource Management error codes and messages (009000) 361
Error Code
Error Message
009008
Modifying domain resource information failed for domain {0}
and service {1}. Requested number of units {2} is more than
Remaining Licenses {3}
009009
Modifying domain resource failed: {0}
009010
Removing resource failed: {0}
009011
Domain resource information retrieval failed for domain {0}: {1}
009012
Domain resource information could not be retrieved. Please
contact next level of support for more information
009013
Retrieving license key information failed: license key {0} not
present in the database, service cannot be provisioned.
009014
License key{0} is not activated, service cannot be provisioned
009015
Modifying domain resource failed. Total number of resources for
this domain cannot be {0}. Please choose a value that makes
the number of resources greater than or equal to the current
usage ({1}).
009016
Cannot set the value of user count for the domain to be {0}. The
domain {1} already has {2} users. To reduce the user count
please delete users if required.
009017
Unable to get license key resource information, please make
sure there is a valid license key installed on the system
009018
Domain resource operations cannot be performed on
sub-domains.
009019
Setting domain resource information failed. Please note that the
number of units for the resource cannot exceed the license key
enforced system remaining limit of {0} and has to be equal to or
more than the current usage which is {1}.
009020
Assigned resources cannot be {0}. Please choose a value
between the current usage ({1}) and the maximum remaining for
the system ({2}) plus the actual partition size of this domain ({2}).
009021
Required Attributes are null. Please provide the required
attribute &quot;Domain Name&quot;
009022
Domain resource limit has not been set for the domain {0}.
009023
Could not reset the domain resource values: {0}
009100
Unable to retrieve License Key usage information. Please
contact your next level of support.
009101
Required Attributes are null. Please provide the required
attribute &quot;KeyCode Name&quot;
009102
Unable to retrieve License Key usage information for {0}. Please
contact your next level of support.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
362 Error codes and messages
Device error codes and messages (010000)
Device error codes and messages (010000)
Error Code
Error Message
010000
Retrieving device information failed.
010001
Cannot add/modify device because the device does not have a
MAC address. Please provide a MAC address.
010002
Cannot add/modify device because the device has an invalid
MAC address {0}. MAC address should be less than 12
characters in length.
010003
Cannot add/modify device because the device with mac address
{0} does not have the required attributes. Please provide the
required attributes.
010004
Invalid Data. Device with MAC address {0} not found. Please
check the device MAC address.
010005
Required Attributes are null. Please provide the required
attributes.
010006
User {0} not logged into device.
010007
The number of devices requested/found is greater than the
system limit {0}. Please change your search criteria or increase
your system limit.
010008
Deleting device information failed because dependent data
exists {0}. Please delete the child information.
010009
Deleting device information failed. Please contact support for
more information.
010010
Modifying device information failed. Please contact support for
more information.
010011
Cannot modify device because there is no capacity left on the
IPCM:Domain relation i.e. {0}:{1} to which this device belongs to.
010012
Invalid Data. MAC Address {0} already in use. Please use a
different one because MAC address should be unique.
010013
Cannot assign user {0} to device with mac address {1} because
the User does not belong to the IPCM:Domain relation to which
the device belongs.
010014
Invalid Data. Invalid device contrast {0}. The valid values are {1}.
010015
Invalid Data. Invalid device Vocoder {0} or Packet Time {1}.
010016
Invalid Data. Invalid device Time Format {0}. The valid values
are {1}.
010017
Invalid Data. Invalid device Date Format {0}. The valid values
are {1}.
010018
Invalid Data. Invalid device Locale {0}. The valid values are {1}.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Domain COS error codes and messages (011000) 363
Error Code
Error Message
010019
Cannot add/modify device with MAC address {0} because there
exists no relation between the domain {1} and device IPCM {2}.
010020
Cannot modify device because the device MAC address {0} and
the given MAC address {1} do not match.
010021
Add device failed. Please contact support for more information.
010022
Cannot add device because there is no capacity left on the
IPCM:Domain relation to which this device belongs to.
010023
Cannot assign user {0} to device with mac address {1} because
the user does not belong to the IPCM:Domain relation to which
the device belongs.
010024
Cannot assign user(s) to device {0} because the device is an
Assistant Console for user {1}.
010025
Cannot add/modify device because the device has more than
6 users assigned to it. A device can have maximum 6 users
assigned to it.
010026
Invalid username provided. Please enter username(s) of valid
user(s) in this domain, in the form user or user@domain.
010027
Modifying device information failed. Invalid data found in the
data provided for the device. Please verify the data provided.
010028
Error loading the device capacity of the domain {0}. Please
contact your next level of support.
010029
Cannot add devices in domain {0} because there is not enough
capacity.
010030
Unable to get User Device information.
010031
Invalid action type for the IPCM Forwarding Service. Please
contact your next level of support.
010032
A data access error occurred while updating the IPCM
Forwarding data: {0}
010033
Error building the IPCM Service ID cache. Please contact your
next level of support.
010034
Unable to get IPCM Service information
Domain COS error codes and messages (011000)
Domain COS error codes and messages (011000)
Error Code
Error Message
011000
Domain information is required.
011001
Class of Service information is required.
011002
Class of Service Name information is required for this operation.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
364 Error codes and messages
Error Code
Error Message
011003
Modification of domain COS information failed: {0}
011004
Removal of domain COS information failed: {0}
011005
Retrieving domain COS information failed. There was a problem
with the data store while trying to retrieve the information.
011006
Initialization of Domain COS information data failed. There
was a problem with the data store while trying to retrieve the
information.
011007
Invalid Data: Domain not found: {0}
011008
Could not retrieve domain information
011009
Failed to refresh caches: Unable to proceed further.
011010
Failed to initialize. Unable to proceed further.Please contact
your next level of support.
011011
Unable to retrieve Cos Info. Please contact your next level of
support
011012
Unable to load Cos Info: {0}
Domain Profile error codes and messages (012000)
Domain Profile error codes and messages (012000)
Error Code
Error Message
012000
Removal of domain profile failed: {0}
012001
Domain information is required.
012002
Profile information is required for this operation.
012003
Modification of domain profile failed: {0}
012004
Data retrieval failed: DomainProfile was not found.
012005
Failed to initialize data access components: Unable to proceed
further. Please contact your next level of support.
012006
Root domain name is invalid. The name provided, {0}, must
be a root domain.
012007
Unable to remove Domain profile: Domain profile {0} is used by
ERLs of locations: {1}.
Domain locale error codes and messages (013000)
Domain locale error codes and messages (013000)
Error Code
Error Message
013000
The locale description provided, {0}, is not a valid one.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Foreign domain error codes and messages (015000) 365
Error Code
Error Message
013001
The given locale has already been added to this domain.
013002
A data access error occurred: {0}
013003
A data access error occurred, unable to load locale information.
Please contact your next level of support.
013004
Both domain name and locale name are required to perform
this operation.
013005
Error occurred while deleting domain locale: {0}
013006
Error occurred while setting the default locale: {0}
013007
Error occurred while updating domain locales: {0}
013008
{0} must be provided to perform this operation.
013009
Only one of the locales can be selected as the default.
013010
Unable to load locale information. Please contact your next
level of support.
013011
This operation cannot be performed on sub-domains; they can
be done only on root domains.
013012
Critical failure: Unable to load system locales. Contact your
next level of support.
013013
Unable to perform operation. Please provide the following
required data: {0}
Global Address Book error codes and messages (014000)
Global Address Book error codes and messages (014000)
Error Code
Error Message
014000
User Name information is necessary for a Global Address Book
{0}.
014001
Retrieval of Global Address Book information failed. There
was a problem with the data store while trying to retrieve the
information.
014002
Failed to initialize data access components: Unable to proceed
further. Please contact your next level of support.
Foreign domain error codes and messages (015000)
Foreign domain error codes and messages (015000)
Error Code
Error Message
015000
Cannot perform operation. Please provide the following data: {0}
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
366 Error codes and messages
Error Code
Error Message
015001
An error occurred when trying to add/modify Foreign Domain
{0}. {1}
015002
Addition of foreign Domain failed: Invalid data (Similar data
exists for fields {0} )
015003
Data access error while adding foreign domain: {0}
015004
Modification of foreign domain failed. the following field(s) must
be unique: {0}
015005
Modification of foreign Domain failed: Invalid data (Similar data
exists for fields {0} )
015006
Data access error while modifying foreign domain: {0}
015007
Unable to remove foreign domain {0}: {1}
015008
Invalid Foreign Domain {0}, no such domain found.
015009
A data access error occurred while retrieving foreign domain
data. Please contact your next level of support.
015010
Cannot assign a existing foreign domain name as a foreign
domain alias
015550
The fully qualified username of the user and the SIP Line data
are required information. Please provide this information.
015551
The end point id {0} is already in use. Please provide another
end point id for user {1}.
015552
Error setting SIP Line Data for user {0}. {1}
015553
Unable to remove SIP Line Data for user {0}. {1}
015554
Unable to retrieve SIP Line Data for user. {1}
015555
Adding client type information failed. {0}
015556
Invalid client type information. Client type cannot be null.
015557
Unable to remove client type information. {0}
015558
Client type name is a required field. Please provide this
information.
015559
{0} field cannot be greater than {1} characters in length.
015560
Field {0} does not follow required format. Format:
SITE/FFF/G/TTtt; where SITE = 1-4 Alphanumeric characters,
corresponds to provisioned SITE name in the XACore; FFF =
000-511 corresponds to the frame number used in the logical
group name in the XACore; G = 0-9 corresponds to the group
number used in the logical group name in the XACore; TTtt=
0000-1022 corresponds to the circuit numbers (upper and lower)
in the LENs defined against the logical group in the XACore
valid characters are [Aa-Zz][0-9][/].
015561
Unable to retrieve SIP Line Data requested. {0}
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
IPCM error codes and messages (016000) 367
Error Code
Error Message
015562
Unable to modify client type information. {0}
015563
Unable to delete client type information. Please ensure it is not
being used for any user SIP Line data.
015564
SIP Line data operation failed. Please contact support for more
information.
015565
SIP Line data operation failed. {0} is missing. Please provide
this information.
015566
Invalid client type information provided. Client type {0} is not
valid client type.
015567
Invalid virtual media gateway information provided, {0}. Please
enter a valid virtual media gateway name.
015568
Multiple client types provided. Only one client type can be
associated with a user. Please try again by providing only one
client type.
015569
Error carrying out operation. Could not get virtual media
gateway information for the user’s domain {0}. Please ensure
virtual media gateways are available in the system before
carrying out the operation.
IPCM error codes and messages (016000)
IPCM error codes and messages (016000)
Error Code
Error Message
016000
Unable to perform operation, please provide the following
required attributes : {0}
016001
Invalid Data.IPCM with name {0} not found.
016002
Invalid Data.IPCM with ID {0} not found.
016003
Retrieving IPCM information failed. {0}
016004
Cannot assign user to IPCM {0} because it is not assigned to
Domain {1}
016005
Cannot assign users to IPCM because there are no IPCMs
assigned to this Domain {0}
016006
Retrieving IPCM information failed.
016007
Invalid data. Domain with name {0} not found.
016008
Invalid data: IPCM:Domain Activation Key should be unique.
Activation key &quot;{0}&quot; already in use for the &quot;{1} : {2}&quot; .
016009
Unable to load IPCM information. Please contact your next level
of support.
016010
Add/Update of IPCM data failed: {0}
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
368 Error codes and messages
Error Code
Error Message
016011
Add/Update of IPCM failed due to a data access error: {0}
016012
A data access error occurred while loading IPCM data. Please
contact your next level of support.
016013
Removal of IPCM failed, dependent data exists: {0}
016014
Removal of IPCM failed due to a data access error: {0}
Network call logs error codes and messages (017000)
Network call logs error codes and messages (017000)
Error Code
Error Message
017000
Unable to save call logs. Please contact your next level of
support.
017001
A data access error occurred while saving call logs: {0}
017002
No call logs to delete. Please provide the call ids to delete.
017003
A data access error occurred while deleting call logs: {0}
017004
A data access error occurred while retrieving call logs. Please
contact your next level of support.
017005
A data access error occurred while retrieving call logs: {0}
Personal Address Book error codes and messages (018000)
Personal Address Book error codes and messages (018000)
Error Code
Error Message
018000
Nickname information is necessary for a Personal Address Book
{0}.
018001
Retrieval of Personal Address Book information failed. There
was a problem with the data store while trying to retrieve the
information.
018002
Failed to initialize data access components: Unable to proceed
further. Please contact your next level of support.
Phone Number error codes and messages (019000)
Phone Number error codes and messages (019000)
Error Code
Error Message
019000
Telephone Number information is necessary for a Phone
Number {0}.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Route error codes and messages (024000) 369
Error Code
Error Message
019001
Retrieval of Phone Number information failed. There was
a problem with the data store while trying to retrieve the
information.
019002
Failed to initialize data access components: Unable to proceed
further. Please contact your next level of support.
Trunk and Gateway error codes and messages (020000)
Trunk and Gateway error codes and messages (020000)
Error Code
Error Message
020000
Cannot perform operation. Please provide the following data: {0}
020001
Adding Trunk group failed. Another Trunk group with the same
information {0} exists.
020002
{0} failed due to a data access error: {1}
020003
{0} failed due to a data access error. Please contact your next
level of support.
020004
{0} cannot have &quot;|&quot; in it.
020005
Adding Gateway failed. Another Gateway with the same
information {0} exists.
020006
Adding Gateway route failed. Another Gateway route with the
same information {0} exists.
020007
The trunk groups must be of the form Gateway Host|Gateway
Type|Trunk in order for them to be reordered
020008
The {0} {1} was not found in the domain specified.
020009
The gateway with host {0} and type {1} was not found.
Route error codes and messages (024000)
Route error codes and messages (024000)
Error Code
Error Message
024000
Route information is required.
024001
User Name information is required.
024002
Route Name, Action information are required for this operation.
024003
Call Destination information is incomplete. Number of rings and
destination addresses must be specified.
024004
Call Destination information is incomplete. Number of rings and
destination addresses must be specified.
024005
Reject Reason information is required for this operation.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
370 Error codes and messages
Error Code
Error Message
024006
Adding new routes information failed: {0}
024007
Route Names information is required.
024008
Route Name information is required for this operation.
024009
Modification of Route information failed: {0}
024010
Retrieving route information failed: There was a problem with
the data store while trying to retrieve the information.
024011
New Route information is required.
024012
Modifying new routes information failed: {0}
024013
Removing route information failed: {0}
024014
Failed to initialize data access components. Unable to proceed
further. Please contact your next level of support.
024015
({0}) is not a valid Term Action Name. The valid names are: {1}
024016
Term Action name is null.
024017
Retrieving reject reason information failed: There was a problem
with the data store while trying to retrieve the information.
024018
Call Destination information is incomplete. Number of rings and
destination addresses must be specified.
024019
Retrieving call destination information failed: There was
a problem with the data store while trying to retrieve the
information.
024020
Retrieving trigger actions information failed: There was
a problem with the data store while trying to retrieve the
information.
024021
The route name provided ({0}) does not exist. Please provide
the name of an existing route.
024022
{0} is not a valid Condition/Exception. The valid types are {1}
024023
Parameter name {0} is not valid.
024024
The user {0} does not have the advanced screening service.
The advanced screening service must be present to perform
route operations on a user.
024025
The user {0} does not have the instant messaging service. The
instant messaging service must be present to use the &quot;Reply
with IM&quot; option.
024026
The user {0} does not have the client collaboration service. The
client collaboration service must be present to use the &quot;Push
Webpage&quot; option.
024027
The user {0} does not have the web push service parameter.
The web push service parameter must be present to use the
&quot;Push Webpage&quot; option.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Route error codes and messages (024000) 371
Error Code
Error Message
024028
Unable to retrieve CPL for user {0}.
024029
The user {0} does not have the instant messaging service. The
instant messaging service must be present to use the &quot;When an
IM is received&quot; route trigger option.
024030
A route trigger action must be specified for all routes. Please
provide a route trigger action.
024031
Unknown time block group name provided in a condition. Please
provide a valid time block group name. ;
024032
Unknown address book group name provided in a condition or
exception.
024033
Unknown personal address book nickname provided in a
condition or exception.
024034
UC greeting {0} specified with the {1} parameter is not valid.
024035
Please specify a name and value for route parameter at index {0}
024036
Please specify a name for route parameter at index {0} ;
024037
Please specify a value for route parameter at index {0} ;
024038
The user {0} does not have the Colorful Ringback Tones service.
Colorful Ringback Tones service must be present in user’s
service package to use a ringtone in route definition.
024039
Addition of assisted user route(s) failed: User {0} is not an
assistant of user {1}.
024040
Modification of assisted user route(s) failed: User {0} is not an
assistant of user {1}.
024041
Activation of assisted user route(s) failed: User {0} is not an
assistant of user {1}.
024042
Deactivation of assisted user route(s) failed: User {0} is not an
assistant of user {1}.
024043
Reordering of assisted user routes failed: User {0} is not an
assistant of user {1}.
024044
Retrieval of assisted user route information failed: User {0} is not
an assistant of user {1}.
024045
Removal of assisted user route(s) failed: User {0} is not an
assistant of user {1}.
024046
Setting assisted user active routes failed: User {0} is not an
assistant of user {1}.
024047
Route operation failed: User {0} is not an assistant of user {1}.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
372 Error codes and messages
Service error codes and messages (025000)
Service error codes and messages (025000)
Error Code
Error Message
025000
Service name needs to be specified.
025001
Invalid Parameter value: {0} for parameter: {1}. Please refer to
the list of acceptable values for this parameter.
025002
Adding new domain services information failed for domain: {0}.
{1}
025003
Removing domain services information failed for domain: {0}.{1}
025004
Service name is not valid: {0}
025005
Modifying domain services information failed for domain:{0}. {1}
025006
Unable to update Service Definition. Only parameters with
multiple values can be updated.
025007
Unable to update Service Definition. The following parameters
values are in use by some domains: {0}. These entries must be
either removed from use or added to the update list.
025008
Modifying services information failed for service:{0}.{1}
025009
The parameter value {0} does not exist for this parameter {1}.
025010
Unable to delete parameter {0} from domain. It is assigned to
subdomain(s) {1} .
025011
Updating parameter default value failed for service: {0},
parameter: {1}. {2}
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}
025015
Retrieving parameter names information failed. There was
a problem with the data store while trying to retrieve the
information.
025016
Initialization of service names data failed. There was a problem
with the data store while trying to retrieve the information.
025017
Data retrieval failed for domain services.
025018
Retrieving domain services information failed. There was
a problem with the data store while trying to retrieve the
information.
025019
Retrieving parmlistdata information failed. There was a problem
with the data store while trying to retrieve the information.
025020
Initialization of service parms data failed. There was a problem
with the data store while trying to retrieve the information.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Service error codes and messages (025000) 373
Error Code
Error Message
025021
Cannot find a service with name {0}.
025022
Cannot find a parameter with name {0}.
025023
{0} is not a valid service name. The valid service names are: {1}
025024
Service Name is null.
025025
{0} is not a valid parameter name. The valid parameter names
for the service {1} are: {2}
025026
Initialization of services + parameter names data failed. There
was a problem with the data store while trying to retrieve the
information.
025027
{0} is not a valid parameter name.
025028
The parameter value for the {0} parameter cannot be assigned
at this stage. It can only be changed while customizing a service
package for a user. Please try again with a blank parameter
value.
025029
The value for {0} is invalid. Please provide a value between
{1} - {2}
025030
Failed to refresh caches. Unable to proceed further.
025031
Failed to initialize data access components: Unable to proceed
further.Please contact your next level of support.
025032
Parameter information must be entered in the correct format.
025033
Domain information is required.
025034
The service(s):{0}cannot be assigned to this sub-domain. Only
services that are assigned to the parent domain can be assigned
to the child domain. The valid services are: {1}
025035
To enable Inactivity feature, Report Inactivity has to be enabled
with an Inactivity timer (in minutes) value
025036
Service {0} is required for service {1}
025037
Service {0} should not be selected when service {1} is selected.
{2}
025038
Parameter {0} should have value equal to the value of parameter
{1}. {2}
025039
Parameter {0} is required for parameter {1}. {2}
025040
Parameter {0} should be selected if parameter {1} is selected. {2}
025041
Parameter {0} should not be selected when parameter {1} is
selected. {2}
025042
The value for parameter {0} should be {1}. The value for the
parameter {2}. {2}
025043
Required parameter which is {0}, the parameter {1} was not
provided. {2}
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
374 Error codes and messages
Error Code
Error Message
025044
Parameter {0} is required for service {1}. {2}
025045
Parameter {0} should not be selected when service {1} is
selected. {2}
025046
Service {0} is required for parameter {1}. {2}
025047
Service {0} should not be selected when parameter{1} is
selected or has a value. {2}
025048
Cannot remove the service {0} from the domain because there
are {1} users associated with the service. Please move the
users to another service package without this service and then
try removing the service.
025049
The service {0} does not have any parameters.
025050
Initialization of Service information data failed:There was
a problem with the data store while trying to retrieve the
information.
025051
Unable to retrieve parmlist data for the parameters in the system
{0}.
025052
Unable to update parameter value list for parameter {0}: {1}.
025053
The Length of {0} exceeds the length {1}
025054
Parameter {0} cannot include characters ~ or ^ or |
025055
The Preferred Audio Device field cannot be empty.
025056
{0} field cannot be left blank.
025057
Parameter value entry already exists for parameter {0}. Please
use a different value
025058
Parameter {0} should have value equal to {1} when service {2}
is selected
025059
The dependency rules for {0} are {1}
025060
Unable to delete parameter {0} from domain. It is assigned to
service packages {1} used by domain(s) {2} .
025061
Service(s) {0} cannot be removed from domain {1}. These
services are used in the service package(s) {2}. Please remove
them from the package before unassigning.
025099
Parameter {0} cannot be selected when parameter {1} is set
to {2}.
025100
Service {0} cannot be selected when parameter {1} is set to {2}.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Telephony Route error codes and messages (026000) 375
Telephony Route error codes and messages (026000)
Telephony Route error codes and messages (026000)
Error Code
Error Message
026000
Adding Route List failed: Route List information cannot be null.
026001
Adding Telephony Route failed: Telephony Route information
cannot be null.
026002
Adding Route Lists failed: Route List information cannot be null.
026003
Adding of Telephony Route information failed: The combination
of telephony route name, route type, from, to, min, max and
domain should be unique. Duplicate data found {0}.
026004
Adding of Telephony Route information failed: {0}.
026005
Class of Service {0} was not found. Class of Service name is
required for retrieving Route List information by class of service
name.
026006
Route List name was not provided. A domain name and a Route
List name are required for retrieving Route List information by
name.
026007
Route Type information retrieval failed: {0}.
026008
Retrieving Route type information failed: Data Access error.
Please contact support for more information.
026009
Route {0} was not found. Route Name is required for retrieving
Route List information by name.
026010
Deleting Route List failed: Route List information cannot be null.
026011
Route List {0} was not found. Route List name is required for
removing Telephony Routes information from Route List.
026012
Deleting Telephony Route information failed: {0}
026013
Deleting Telephony Route failed: Telephony Route information
cannot be null.
026014
Route {0} was not found. Route Name is required for removing
Telephony Route information from Route List.
026015
Route List {0} was not found. Route List name is required for
removing Telephony Route information from Route List.
026016
Deleting Telephony Route information failed: {0}.
026017
Modifying Route List failed: Route List information cannot be
null.
026018
Route List {0} was not found. Route List name is required for
updating Route List information.
026019
The Route List to update was not found.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
376 Error codes and messages
Error Code
Error Message
026020
Updating of Route List information failed: Another Route List
with the name {0} exists for domain {1}.
026021
Updating of Route List information failed: {0}.
026022
Modify Telephony Route failed, Telephony Route information
cannot be null.
026023
Route {0} was not found. Route name is required for updating
Telephony Route information.
026024
The Route to update {0} was not found.
026025
Updating of Telephony Route information failed: Another
Telephony Route with the same name {0} exists for the domain
{1}.
026026
Updating of Telephony Route information failed: {0}.
026027
The Route List {0} was not found for domain specified.
026028
Routelist information retrieval failed: {0}.
026029
Retrieving Route action information failed: Data Access error.
Please contact support for more information.
026030
Route name is required for adding Telephony Routes for Route
Lists.
026031
Route name {0} was not found.
026032
Telephony Route information retrieval failed: {0}.
026033
Retrieval of Telephony Route information failed: Data Access
error. Please contact support for more information.
026034
Telephony Route information retrieval failed: {0}
026035
Retrieval of Telephony Route information failed: Data Access
error. Please contact support for more information.
026036
Route List Telephony Route information retrieval failed: {0}.
026037
Data Retrieval Failed: The Telephony Route information was
not found. Please contact support for more information.
026038
Null Attributes provided. Please provide the required attributes.
026039
Unable to modify Telephony Route and Route List associations.
{0}
026040
Invalid Telephony Route Type {0}. The valid Route types are
’SIP’,’PRIVATE’ and ’GATEWAY’.
026041
Telephony Route information retrieval failed: {0}
026042
The Telephony Route information could not be retrieved: Data
Access error. Please contact support for more information.
026043
Route List information retrieval failed: {0}
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Telephony Route error codes and messages (026000) 377
Error Code
Error Message
026044
The Route List information could not be retrieved: Data Access
error. Please contact support for more information.
026045
SIP Route Parameter cannot be null.
026046
The override charge value can’t be more than 24 digits.
026047
The override charge value must only contain digits.
026048
Route List Telephony Route information retrieval failed: {0}
026049
Data Retrieval Failed: The Telephony Route information was
not found, please contact support for more information.
026050
Initialization of Route type data for Telephony Routes failed.
026051
Initialization of Route action data for Telephony Routes failed.
026052
Initialization of options data for Telephony Routes failed.
026053
Telephony Route operation will fail: Telephony Route
information cannot be null.
026054
Route Name, description, from, to, min, max digits, remove,
route type are required for adding Telephony Route information.
026055
Route List operation will fail: Route List information cannot be
null.ation will fail: routelist information cannot be null.
026056
Route List name is required for adding Route List information.
026057
Class of Service is required for adding Route List information.
026058
Failed to initialize data access components: Unable to proceed
further.
026059
Data initialization for Telephony Routes failed, cannot proceed
further.
026060
Adding Route Lists failed. Route List information cannot be null.
026061
Adding of Route List information failed: The combination of
routelist name and domain should be unique, duplicate data
found {0}.
026062
Adding of Route List information failed: {0}
026063
Route List {0} was not found. Route List name is required for
removing Route List information.
026064
Deleting Route List(s) failed. Route List information cannot be
null.
026065
Deleting Route List information failed: {0}.
026066
Route {0} was not found. Route name is required when
removing Telephony Route information.
026067
Deleting Telephony Routes failed. Telephony Route information
cannot be null.
026068
Deleting Telephony Route information failed: {0}
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
378 Error codes and messages
Error Code
Error Message
026069
Route List information retrieval failed: {0}
026070
Unable to retrieve the cos information for Route List.
026071
Initialization of routeaction data for Telephony Routes failed.
026072
Unable to parse result set for RouteList.
026073
Unable to list Route List: {0}.
026104
Unable to add/modify Telephony Route because the value
of remove field is more than the minimum number of digits.
Remove cannot be more than the minimum number of digits.
026105
Unable to add/modify Telephony Route. FROM and TO digits
length should match.
026106
Unable to add/modify Telephony Route. FROM and TO digits
can not have more than 32 digits.
026107
Unable to add/modify Telephony Route. FROM digits should be
less than or equal to TO digits.
026108
Unable to add/modify Telephony Route. Either both FROM and
TO digits should start with a &quot;+&quot; or both should start with a digit.
026109
Unable to add/modify Telephony Route. Prefix cannot be null if
Remove Digits is equal to Min Digits.
026110
Unable to add/modify Telephony Route. Digit manipulations
may cause number to exceed 32 digits in length.
026111
Unable to add/modify Telephony Route. FROM digit, TO digit or
Prefix is not a number.
026112
Unable to add/modify Telephony Route. Prefix and FROM
digits/TO digits form invalid results.
026113
Unable to add/modify Telephony Route. MIN and MAX digits
can only be between 1 and 32.
Status reason error codes and messages (027000)
Status reason error codes and messages (027000)
Error Code
Error Message
027000
Status Reason information is required
027001
Removing status reason information failed: {0}
027002
Domain information is required.
027003
Status information is required.
027004
Status Reason Name information is required for this operation.
027005
Status Reason not found. Please retrieve the list of acceptable
values and try again.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Number qualifier error codes and messages (028000) 379
Error Code
Error Message
027006
No Status Reasons found for this domain.
027007
Modification of status reason information failed: {0}
027008
Status Reason Name is null. Please enter a valid value.
027009
Adding new status reason information failed: {0}
027010
Null Status.The valid values for Status are: {0}
027011
Invalid Data.The valid values for Status are: {0}
027012
Retrieving status reason information failed. There was a problem
with the data store while trying to retrieve the information.
027013
Invalid Data: Status not found: {0}
027014
Initialization of Status information data failed. There was
a problem with the data store while trying to retrieve the
information.
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
further.
027018
Failed to initialize data access components: Unable to proceed
further.Please contact your next level of support.
027019
Status Reason cannot be added to a subdomain.
Number qualifier error codes and messages (028000)
Number qualifier error codes and messages (028000)
Error Code
Error Message
028000
Number Qualifier {0} failed: {1}
028001
The Number Qualifier information could not be retrieved. Data
Access error. Please contact your next level of support for more
information.
028002
Number Qualifier Name is required for replacing Number
Qualifiers.
028003
{0} is too long, length must be less than {1} characters.
028100
Pre-Translator information {0} failed: {1}
028101
The Pre-Translator information could not be retrieved. Data
Access error. Please contact your next level of support for more
information.
028102
Number Qualifier Name: {0} was not found within the list of valid
Number Qualifiers.
028103
PreTranslator Prefix is too long; must be less than 32 characters.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
380 Error codes and messages
Error Code
Error Message
028104
PreTranslator Prefix {0} contains invalid characters. The valid
characters are 0-9 and ’+’.
028105
PreTranslator length is not within the range of 0 - {0}
028106
The character ’+’ is allowed only at the beginning of the prefix
field.
028200
Number qualifier operations can be performed only on root
domains. The domain given is not a root.
Time block group and Presence condition error codes and
messages (029000)
Time block group and Presence condition error codes and messages (029000)
Error Code
Error Message
029000
TimeGroup names information is necessary for a Time Block {0}.
029001
Retrieval of Time Block information failed. There was a problem
with the data store while trying to retrieve the information.
029002
Failed to initialize data access components: Unable to proceed
further. Please contact your next level of support.
029010
Presence information is necessary for a Presence {0}.
029011
Retrieval of Presence information failed. There was a problem
with the data store while trying to retrieve the information.
029012
Presence state {0} is not a supported presence state in a route
{1}.
029013
Presence note {0} is not a supported presence note in a route {1}.
029014
Invalid presence state and note: {0}. Please provide a valid
presence state and note.
029015
Unable to save route because user does not have Presence
Based Routing service.
Time zone error codes and messages (030000)
Time zone error codes and messages (030000)
Error Code
Error Message
030000
TimeZone Name information is required.
030001
TimeZone ID information is required.
030002
TimeZone ID and Name information is required.
030003
Adding new time zone information failed:{0}
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
User time and Click to call error codes and messages (033000) 381
Error Code
Error Message
030004
Removing time zone information failed: {0}
030005
Existing TimeZone Name information is required.
030006
Modifying time zone information failed: {0}
030007
Retrieving time zone information failed. There was a problem
with the data store while trying to retrieve the information.
030008
Invalid Data: TimeZone not found:{0}
030009
Initialization of time zone information failed. There was a problem
with the data store while trying to retrieve the information.
030010
Failed to refresh caches: Unable to proceed further.
030011
Failed to initialize data access components: Unable to proceed
further. Please contact your next level of support.
030012
Please provide the required attribute ’Time Zone Name’
User Data error codes and messages (032000)
User Data error codes and messages (032000)
Error Code
Error Message
032001
Adding reject reason failed: Reason cannot be null
032002
Adding reject reason failed: {0}
032003
User data information retrieval failed: {0}
032004
Retrieve operation failed: Data access error. Please contact
support for more information.
032005
Deleting user data failed for user {0}: {1}
032006
Deleting reject reason failed for user {0}: {1}
032007
Updating user data failed: User data cannot be null
032008
The maximum number of presence notes allowed is five. Please
edit the entries as required.
032009
Length of presence note cannot be greater than 32 characters.
032010
Updating user data failed for user {0}: {1}
032011
{0} is not a valid character. Please try again.
User time and Click to call error codes and messages (033000)
User time and Click to call error codes and messages (033000)
Error Code
Error Message
033001
Adding Time block Group information for user {0} failed: {1}
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
382 Error codes and messages
Error Code
Error Message
033002
Removing Time block Group for user {0} failed. Time block
Group name cannot be null.
033003
Removing Time block Group {0} failed. User name cannot be
null.
033004
Removing Time block Group {0} failed. The Time block Group is
referenced in route(s) {1}.
033005
Removing Time block Group {0} for user {1} failed: {2}
033006
Removing Time block Groups failed. User name cannot be null.
033007
Removing Time block Groups for user {0} failed: {1}
033008
Modifying Time block Group {0} failed. Time block Group
information cannot be null.
033009
Modifying Time block Group failed. Time block Group name
cannot be null.
033010
Modifying Time block Group {0} failed. User name cannot be
null.
033011
Modifying Time block Group {0} for user {1} failed: {2}
033012
Retrieving Time block Group for user {0} failed. Time block
Group name cannot be null.
033013
Retrieving Time block Group failed. User name cannot be null.
033014
Retrieving Time block Group {0} for user {1} failed: {2}
033015
Retrieving Time block Groups for user {0} failed: {1}
033016
Retrieving Time block Groups failed. User name cannot be null.
033017
Adding Time block Group information failed. User name cannot
be null.
033018
Adding Time block Group information for user {0} failed. Time
block Group information cannot be null.
033019
Adding time blocks for Time Block Group {0} failed. Please verify
that the time blocks were specified properly.
033020
Adding time blocks for Time Block Group {0} failed. Time block
information cannot be null.
033021
Adding time blocks for Time Block Group {0} failed: {1}
033022
Unable to process request for Time Block Group: {0}
033023
Time block Group {0} was not found for user {1}.
033024
Error retrieving Time block Group Information for user {0}. Root
cause: {1}
033025
Adding time block failed. At least one day of the week must be
specified for time block.
033026
Adding time block failed. Time block start time cannot be null.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Voicemail error codes and messages (034000) 383
Error Code
Error Message
033027
Adding time block failed. Time block stop time cannot be null.
033028
Adding time block failed. The minute value in the start time must
be either 0, 15, 30, or 45.
033029
Adding time block failed. The minute value in the stop time must
be either 0, 15, 30, or 45.
033030
Adding time block failed. The start and stop time should
correspond to valid intervals on the same day.
033031
Error retrieving time block information for Time block Group {0}.
Root cause: {1}
033032
Retrieving Time block Group failed: {0}
033033
Error retrieving Time block Group Information for user {0}.
033034
Retrieving Time block Group(s) for user {0} failed.
033035
Error retrieving time block information for Time block Group {0}.
033036
Retrieving Time block Group failed.
033037
Timeblock Group information could not be added for user {0}.
Time block Group(s) already exists using name(s) {1}
033038
Timeblock Group information could not be modified for user {0}.
A Time block Group already exists using name {1}
033039
Adding Time block Group information for user {0} failed. Time
block Group name cannot be null.
033040
Removing Time block Groups for user {0} failed. The following
Time block Groups are referenced by the listed routes: {1}
033050
Call to {0} failed with error: {1}
033051
Unable to complete call to {0}.
033052
Adding Predefined Time block Group information failed: {0}
Voicemail error codes and messages (034000)
Voicemail error codes and messages (034000)
Error Code
Error Message
034001
Domain information cannot be null.
034002
Voicemail server information retrieval failed for domain {0}: {1}
034003
The voicemail server could not be retrieved: Data access error.
Please contact support for more information.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
384 Error codes and messages
Reserved addresses error codes and messages (035000)
Reserved addresses error codes and messages (035000)
Error Code
Error Message
035000
Invalid Reserved Addresses provided.
035001
Add Reserved Address failed: {0}
035002
Remove all reserved Address failed: {0}
035003
Data retrieval failed: Reserved Address data was not found.
User properties error codes and messages (036000)
User properties error codes and messages (036000)
Error Code
Error Message
036000
Error uploading file. File size for {0} (size= {1}KB) exceeds
picture file size limit of {2}KB.
036001
Error uploading file. Empty file: {0}.
036002
No picture file uploaded.
036003
Error in modifying picture. Please contact your next level of
support.
036004
The user picture content type must be image/png, image/jpg
or image/jpeg.
Music on Hold error codes and messages (037000)
Music on Hold error codes and messages (037000)
Error Code
Error Message
037000
Domain information is required.
037001
Folder Name information is required.
037002
Pool Name information is required.
037003
Modifying music folder information failed for domain : {0}, pooled
resource:{1}. {2}
037004
Modifying music folder information failed for domain : {0}, pooled
resource:{1}. {2}
037005
Assigning music folder information failed for domain: {0}. {1}
037006
Folder Name: {0} is not valid.
037007
Retrieving music folder information failed.
037008
Old Folder Name information is required.
037009
New Folder Name information is required.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Branding error codes and messages (038000) 385
Error Code
Error Message
037010
Renaming music folder information failed for domain: {0}, pooled
resource: {1}, Folder: {2}. {3}
037011
Failed to initialize data access components: Unable to proceed
further. Please contact your next level of support.
037012
Invalid Folder Name. Character {0} is not allowed in folder name.
037013
Folders can be added only at the root domain level. The root
domain for this domain is: {0}.
037014
Folders can be removed only at the root domain level. The root
domain for this domain is: {0}.
037015
Folders can be renamed only at the root domain level. The root
domain for this domain is: {0}.
037016
Null Service. The valid values for Service are: {0}
037017
Folder Name cannot exceed 32 characters.
037018
Folder Name must be unique.
037019
Invalid Pool Name. Please select a valid Pool for this domain
and service.
037020
Add Folder(s) operation failed: {0}
037021
Rename Folder operation failed: {0}
Branding error codes and messages (038000)
Branding error codes and messages (038000)
Error Code
Error Message
038000
Domain information is required.
038001
Pool Name information is required.
038002
Failed to initialize data access components: Unable to proceed
further. Please contact your next level of support.
038003
File Name information is required.
038004
Modifying Branding files information failed for domain: {0},
pooled resource:{1}. {2}
038005
Modifying Branding files information failed for domain : {0}. {1}
038006
Branding information is required.
038007
At least one file must be selected.
038008
Assigning Branding information failed for domain: {0}, pooled
resource: {1}. {2}
038009
Modifying Branding information failed for domain: {0}, pooled
resource: {1}, Files: {2}. {3}
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
386 Error codes and messages
Error Code
Error Message
038010
File Name is not valid. Please retrieve list of branding files in this
pool and select from it.
038011
Invalid File Name. Character: {0} is not allowed in file name.
038012
The current selection of branding files is not all valid. The valid
file names are: {0}. Please remove the invalid files and try again.
038013
Repeat can only be 1-9 or infinite.
038014
At least one file must be selected.
038015
Files can be added only at the root domain level. The root
domain for this domain is: {0}.
038016
File Name cannot exceed 32 characters.
038017
Unable to delete branding file {0} because it is part of the domain
pool assignment for the following domain(s): {1}.
038018
Invalid Pool Name. Please select a valid Pool for this domain
and service.
038019
Unable to list Branding Pool\: {0}
Treatment error codes and messages (039000)
Treatment error codes and messages (039000)
Error Code
Error Message
039000
Domain information is required.
039001
Pool Name information is required.
039002
Failed to initialize data access components: Unable to proceed
further. Please contact your next level of support.
039003
File Name information is required.
039004
Modifying Treatment files information failed for domain: {0},
pooled resource:{1}.
039005
Modifying Treatment files information failed for domain: {0}. {1}
039006
Files can be added only at the root domain level. The root
domain for this domain is: {0}.
039007
Files can only be removed at the root domain level. The root
domain for this domain is: {0}.
039008
Treatment Group information is required.
039009
Adding new Treatment Group failed for domain: {0}, pooled
resource:{1}. {2}
039010
Existing Treatment Group Name information is required.
039011
New Treatment Group information is required.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Assistant error codes and messages (040000) 387
Error Code
Error Message
039012
Updating Treatment Group failed for domain: {0}, pooled
resource:{1}. {2}
039013
Removing Treatment Group failed for domain: {0}. {1}
039014
Assigning Treatment Pool failed for domain: {0}. {1}
039015
File Name: {0} is not valid. Please retrieve list of treatment files
in this pool and select from them.
039016
Group Name: {0} is not valid. Please retrieve list of group names
in this domain and select from it.
039017
Invalid File Name. Character: {0} is not allowed in file name.
039018
The current selection of group files is not valid. The valid file
names are: {0}. Please try again.
039019
Repeat can only be 1-9 or infinite.
039020
The current selection of group reasons is not valid. The valid
reasons are: {0}. Please try again.
039021
At least one reason must be selected.
039022
File or route information is required.
039023
Repeat value cannot be infinite if route is present. Please
remove the route and try again.
039024
File Name cannot exceed 32 characters.
039025
Reason: {0} is already in use. Please remove this reason and
try again.
Assistant error codes and messages (040000)
Assistant error codes and messages (040000)
Error Code
Error Message
040001
Unable to add assistants for user {0}. User {1} is not a valid
assistant for the user. An assistant and assisted user must be
provisioned in the same root domain.
040002
Unable to add assistants for user {0}. Users {1} are not valid
assistants. A user must have the ’Assistant Console’ service in
their service package to be considered an assistant.
040003
Unable to add assistants for user {0}. User {0} is not a valid
assisted user. A user must have the ’Assistant Support’ service
in their service package to be considered an assisted user.
040004
Data access error while validating service packages for
’Assistant Support’ or ’Assistant Console’ services.
040005
Unable to add assistants for user {0}. The following users are
already provisioned as assistants: {1}
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
388 Error codes and messages
Error Code
Error Message
040006
Unable to add assistants for user {0} due to the following error:
{1}
040007
Unable to retrieve assistants. User name cannot be null.
040008
Unable to retrieve assistants for user {0} due to the following
error: {1}
040009
Unable to retrieve assistants for user {0}.
040010
Unable to retrieve users. The user name for the assistant
cannot be null.
040011
Unable to retrieve users for assistant {0} due to the following
error: {1}
040012
Unable to retrieve users for assistant {0}.
040013
Unable to retrieve users for assistant {0}. The following error
occurred while updating assistant service data: {1}
040014
Unable to retrieve users for assistant {0}. Data access error
occurred while updating assistant service data.
040015
Unable to update users for assistant {0} due to the following
error: {1}
040016
Unable to remove users for assistant {0} due to the following
error: {1}
040017
Unable to remove assistants for user {0} due to the following
error: {1}
040018
Unable to determine if assistant is provisioned for user.
Assistant user name cannot be null.
040019
Unable to determine if assistant {0} is provisioned for user. User
name cannot be null;
040020
Unable to determine if assistant {0} is provisioned for user {1}
due to the following error: {2}
040021
Unable to determine if assistant {0} is provisioned for user {1}.
040022
Unable to process request for assistant service function due to
the following error: {0}
040023
Unable to determine if users have valid service packages with
’Assistant Support’ or ’Assistant Console’ services.
040024
Unable to add assistants for user {0}. A user cannot be an
assistant for himself / herself.
040025
Unable to retrieve all assisted users.
040026
Unable to retrieve all assistants.
040027
Error removing users for assistant {0}. You must specify users
to remove.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Location error codes and messages (042000) 389
Error Code
Error Message
040028
Unable to update users for assistant {0} because specified user
{1} is not a provisioned user for the assistant.
040029
Unable to update users for assistant {0}.
040030
Unable to add assistants for user {0}. User {1} is not a valid
assistant because user {0} is an assistant for user {1}.
040031
Unable to add assistants for user {0}.
040032
Unable to process request for assistant service function. Please
contact your next level of support.
040033
Unable to remove users for assistants due to the following
error: {0}
040034
Unable to remove assistants for users due to the following
error: {0}
User picture error codes and messages (041000)
User picture error codes and messages (041000)
Error Code
Error Message
041001
Getting picture failed for user {0}. Details: {1}
041002
Adding picture failed for user {0}. Details: {1}
041003
Modifying picture failed for user {0}. Details: {1}
041004
Removing picture failed for user {0}. Details: {1}
041005
Getting picture failed for user {0}.
041006
Failed to get users that need their pictures transferred. Details:
{0}
041007
Failed to get users that need their pictures transferred.
041008
The user picture is empty. Please provide a picture.
041009
The user picture provided is larger than the maximum size of
{0}KB. Please use a smaller picture.
Location error codes and messages (042000)
Location error codes and messages (042000)
Error Code
Error Message
042000
Unable to perform operation. The {0} parameter cannot be null.
042001
Unable to create location. Location {0} is limited to {1}
characters. Please use a shorter location {0}.
042002
Unable to create location. Location name {0} is reserved.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
390 Error codes and messages
Error Code
Error Message
042003
Unable to retrieve location. No Location Info was found for
location {0}.
042004
Unable to retrieve locations. No Locations were found for
domain {0}.
042005
Unable to create location. Child Locations of Root Location
’Other’ are prohibited.
042006
Unable to create location. Location already exists {0}.
042007
Unable to create location. Location already exists. Details: {0}.
042008
Unable to create location. Details: {0}
042009
Unable to retrieve child locations. No Location Info was found
for parent location {0}.
042010
Unable to remove location. Location name {0} is reserved.
042011
Unable to modify location. Location {0} is limited to {1}
characters. Please use a shorter location {0}.
042012
Unable to modify location. Root Location ’Other’ is reserved
and cannot be modified.
042013
Unable to modify location. ERL Locations must have a location
description (MSAG).
042014
Unable to modify location. Location already exists. Details: {0}.
042015
Unable to modify location. Details: {0}.
042016
Unable to remove location. Details: {0}.
042017
Unable to remove location. Dependent data exists:{0}
042018
Unable to create Location Cache. Details: {0}
042019
Data access error occurred: Location data was not retrieved.
042020
Location &quot;{0}&quot; cannot be deleted because it has dependent
data. {1}
042021
Data retrieval failed: Count data was not found.
042022
Data access error occurred, please contact your next level of
support.
042023
treeDepth = 0:: should be greater than 0
042024
Data retrieval failed: LOCUPDATEHIST data was not found
042025
Unable to create location. Parent Location was logically deleted
042026
Unable to modify location. Location name {0} is reserved.
042100
Add LocUpdateHists failed: {0}
042101
Update LocUpdateHists failed: {0}
042102
Remove LocUpdateHists failed: {0}
042103
Data retrieval failed: LOCUPDATEHIST data was not found
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
ErlInfo error codes and messages (043000) 391
ErlInfo error codes and messages (043000)
ErlInfo error codes and messages (043000)
Error Code
Error Message
043000
Unable to create Emergency Response Location. {0} is limited
to {1} characters. Please use a shorter {0}.
043001
Unable to create Emergency Response Location. At least 1
ANI is required.
043002
Unable to create Emergency Response Location. ANI length is
a minimum of {0} characters. Please use a longer ANI instead
of {1}.
043003
Unable to create Emergency Response Location. ANI must be
numeric characters only: {0}.
043004
Unable to modify Emergency Response Location. {0} is limited
to {1} characters. Please use a shorter {0}.
043005
Unable to modify Emergency Response Location. At least 1
ANI is required.
043006
Unable to modify Emergency Response Location. ANI length is
a minimum of {0} characters. Please use a longer ANI instead
of {1}.
043007
Unable to modify Emergency Response Location. ANI must be
numeric characters only: {0}.
043008
Unable to retrieve Emergency Response Location. No
Emergency Info was found for location {0}.
043009
Unable to retrieve Emergency Response Location. Failed to find
the Location Info for location {0}.
043010
Unable to create Emergency Response Location. Please Modify
the Location and add a Description.
043011
Unable to create Emergency Response Location. ANI already
defined on another ERL.
043012
Unable to create Emergency Response Location. Location
already exists. Details: {0}
043013
Unable to create Emergency Response Location. Details: {0}
043014
Unable to modify Emergency Response Location. The {0}
parameter cannot be null.
043015
Unable to modify Emergency Response Location. Failed to find
the Location Info for location {0}.
043016
Unable to modify Emergency Response Location. Failed to find
the ANI List for location.
043017
Unable to modify Emergency Response Location. Location
already exists. Details: {0}
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
392 Error codes and messages
Error Code
Error Message
043018
Unable to modify Emergency Response Location. Details: {0}
043019
Unable to delete Emergency Response Location. Details: {0}
043020
Unable to delete Emergency Response Location. Location is
not an Emergency Response Location {0}.
043021
Unable to delete Emergency Response Location. The {0}
parameter cannot be null.
043022
Unable to retrieve Emergency Response Location. No
Emergency Info was found for domain {0}.
043023
Unable to create Emergency Response Location. ERL type is
invalid. Please select from: {0}
043024
Unable to retrieve ERL List. Details: {0}
043025
Unable to retrieve ANI List. Details: {0}
043026
Unable to create Emergency Response Location. ANIs not
allowed on Residential ERLs
043027
Unable to modify Emergency Response Location. ANIs not
allowed on Residential ERLs
043028
Unable to create Emergency Response Location. Invalid ERL
Type: {0}. Please select from: {1}
043029
Unable to modify Emergency Response Location. Invalid ERL
Type: {0}. Please select from: {1}
043030
A data access error occurred while loading emergency alias
data. Please contact your next level of support.
043031
A data access error occurred while loading ERL Info. Please
contact your next level of support.
043032
A data access error occurred while loading ANI Info. Please
contact your next level of support.
043033
Data retrieval failed: Gateway Route was not found.
043034
A data access error occurred while loading Gateway Route data.
Please contact your next level of support.
043035
Data access error while adding data: {0}
043036
Cannot create ERL without an ERLInfo data.
043037
Unable to create Emergency Response Location. ERL already
exists in this branch of the location hierarchy.
043038
Unable to create Emergency Response Location. Parent
Location was logically deleted
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Emergency numbers error codes and messages (045000) 393
Emergency alias error codes and messages (044000)
Emergency alias error codes and messages (044000)
Error Code
Error Message
044000
Unable to create emergency alias. Details: {0}
044001
Unable to delete emergency alias. Details: {0}
044002
Unable to create emergency alias. Alias is limited to {0}
characters. Please use a shorter alias.
044003
Unable to create emergency alias. The {0} parameter is invalid.
044004
Unable to create emergency alias. The emergency number is
not found.
044005
Unable to create emergency alias. The emergency number
already exists. Details: {0}
044006
Unable to retrieve emergency alias. Emergency data was not
found for {0}. Details: {1}
044007
Unable to create emergency alias. The alias conflicts with an
existing {0}.
Emergency numbers error codes and messages (045000)
Emergency numbers error codes and messages (045000)
Error Code
Error Message
045000
Unable to create emergency number. Details: {0}
045001
Unable to delete emergency number. Details: {0}
045002
Unable to create emergency number. Number is limited to {0}
characters. Please use a shorter number.
045003
Unable to create emergency number. The {0} parameter is
invalid.
045004
Unable to create emergency number. The emergency number
is not found.
045005
Unable to create emergency number. The emergency number
already exists. Details: {0}
045006
Unable to retrieve emergency number. Emergency data was
not found for {0}. Details: {1}
045007
Unable to create emergency number. The number conflicts with
an existing {0}.
045008
A data access error occurred while loading Emergency
Numbers. Please contact your next level of support.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
394 Error codes and messages
Error Code
Error Message
045009
Failed to Add/Update Emergency Number. The following value
is Reserved: {0}
045010
Cannot perform operation. Please provide all of the following
data: {0}
Meet Me Audio Conferencing related error codes and messages
(046000)
Meet Me Audio Conferencing related error codes and messages (046000)
Error Code
Error Message
046000
Error: Meet Me Conferencing service is not properly configured
for {0}. Please contact your next level of support.
046001
Error updating Meet Me Conferencing data for the User: Access
Code should be present and should be between {0} and {1}
digits in length (inclusive).
046002
Error updating Meet Me Conferencing data for the User: Access
Code should only contain numeric digits.
046003
Error updating Meet Me Conferencing data for the User: Chair
and Public Pins should be between {0} and {1} digits in length
(inclusive).
046004
Error updating Meet Me Conferencing data for the User: Chair
and Public Pins should only contain numeric digits.
046005
Error updating Meet Me Conferencing data for the User:
Required fields for Meet Me Conferencing data not found.
046006
Error processing request for Meet Me Conferencing data: Data
Access Unavailable. Please contact your next level of support.
046007
Error processing request: Meet Me Conferencing service is not
provided in User’s service package.
046008
Unable to add Meet Me domain properties. Please contact your
next level of support.
046009
Error updating Meet Me Conferencing data for the User: Access
Code {0} is already in use in the user’s domain. Please try again
with a different Access Code.
046019
Error removing Meet Me Conferencing data for the User: {0}
046020
Error removing Meet Me Conferencing data for the User. Please
try again later.
046021
Error retrieving Meet Me Conferencing data for the User: {0}.
Please contact your next level of support.
046022
Error retrieving Meet Me Conferencing data for the User. Please
contact your next level of support.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Media Portal Group error codes and messages (046100) 395
Error Code
Error Message
046023
Valid Meet Me Conferencing data not found for the User {0}.
Please contact your next level of support.
046024
Error updating Meet Me Conferencing data for the User. Please
try again later.
046025
Error removing Meet Me Conferencing data for the User. Please
contact your next level of support.
046027
An Unexpected error has occurred while updating Meet Me User
data. Please contact your next level of support.
046028
Error has occurred while trying to find the lock status. Please
contact your next level of support.
046029
Unable to process the request. Meet Me Conferencing Service
in user’s svc package doesn’t have valid value for {0} field.
Please provide a valid value and try again.
046030
MeetMeEventHandler: Unable to update Meet Me service
package customizations. User {0} does not have UC Service.
046031
MeetMeEventHandler: Unable to update Meet Me service
package customizations for user {0}. Reason: {1}
046032
Please provide the required attributes &quot;DomainName&quot;, &quot;Start&quot;
and &quot;End&quot;. Both &quot;Start&quot; and &quot;End&quot; should be greater than zero.&quot;
046033
Error: The number of users requested {0} is more than the
system specified limit &quot;{1}&quot; . Please adjust your criteria.
046034
Service Parameter(s) Not found: {0}
046035
UCEventHandler: Unable to update UC service package
customizations. User {0} does not have UC Service.
046036
UCEventHandler: Unable to update UC service package
customizations for user {0}. Reason: {1}
Media Portal Group error codes and messages (046100)
Media Portal Group error codes and messages (046100)
Error Code
Error Message
046100
Unable to add or modify MPGroup. MPGroup information is
required.
046101
Unable to add or modify MPGroup. MPGroup Name is required.
046102
Unable to add or modify MPGroup. MPGroup Name contains
white space {0}
046103
Group Name contains special char. The valid characters are
A-Z, a-z, 0-9, ’.’, ’-’ and ’_’.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
396 Error codes and messages
Error Code
Error Message
046104
Unable to add or modify MPGroup. MPGroup Name is not valid
{0}
046106
Unable to add MPGroup. MPGroup Name is not valid.
046107
Unable to add MPGroup. MPGroup Name already exists for {0}
046108
Unable to add MPGroup. MP Resource is required for {0}
046110
Failed to add MPGroup {0}. Data Access Error: {1}
046111
Unable to add MPGroup. Group Location Maps required for {0}
046112
Unable to add MPGroup. Invalid Domain name {0}
046113
Unable to add MPGroup. Invalid Foreign Domain name {0}
046115
Invalid Media Portal Group Resource IP address.
046116
Failed to addResourceMap. Data Access Error: {0}
046117
Unable to add MPGroup: {0}
046118
Failed to modify MPGroup: {0}
046119
Unable to add MPGroup: {0}. Duplicate data found: Group
name and DomainLocation name(s) should be unique across all
groups. Resource Address should be unique in a group.
046121
Failed to add MPResourceToGroup. Data Access Error: {0}
046122
Failed to add MPResourceToGroup. Data Retrieval Error: {0}
046131
Failed to add LocationsToGroup. Data Access Error: {0}
046132
Failed to add LocationsToGroup. Data Retrieval Error: {0}
046202
Unable to modify MPGroup. MP Resource is required for {0}
046204
Unable to modify MPGroup. Existing cache data not found (0)
046205
Failed to modify MPGroup. Data Access Error: {0}
046206
Unable to modifyBase MPGroup. Existing Group Name is
required.
046207
Unable to modifyBase MPGroup. Existing cache data not found.
046208
Unable to modifyBase MPGroup. Existing Group Name is
required.
046209
Unable to modifyBase MPGroup. Data and Name required.
046210
Unable to modifyBase MPGroup. MP Resource is required
for {0}
046211
Unable to modifyBase MPGroup. No cache data for {0}
046212
Unable to modifyBase MPGroup. Existing cache data not found
for {0}
046213
Failed to modifyBase MPGroup. Data Access Error: {0}
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Media Portal Group error codes and messages (046100) 397
Error Code
Error Message
046216
Unable to modify DomainLocs MPGroup. Existing Group Name
is required.
046217
Unable to modify DomainLocs MPGroup. Domain Location
required.
046218
Unable to modify DomainLocs MPGroup. No cache data for {0}
046219
Unable to modify DomainLocs MPGroup. Existing cache data
not found for {0}
046220
Failed to modify DomainLocs MPGroup. Data Access Error: {0}
046301
Unable to remove MPGroup. MPGroup Names required.
046302
Unable to remove MPGroup. MPGroup Name is required.
046303
Unable to remove MPGroup. MPGroup Name is required.
046304
Unable to remove MPGroup. No cache data for {0}
046305
Unable to remove MPGroup. Group data not found for {0}
046306
Failed to remove MPGroup. Data Access Error: {0}
046401
Unable to get MPGroup. MPGroup Name is required.
046402
Unable to get MPGroup. No cache data for {0}
046403
Unable to get MPGroup. Existing data not found for {0}
046405
Failed to getAllDomainLocations. Error: {0}
046406
Unable to getDomainWithAssignedLocs. Group name invalid {0}
046407
Unable to getDomainWithAssignedLocs. Group data not found
for {0}
046408
Unable to getAvailLocsForDomainInMPGroup. Group or
Domain name invalid {0}
046409
Unable to getAvailLocsForDomainInMPGroup. Group data not
found for {0}
046411
Unable to getAssignedLocsForDomainInMPGroup. Group or
Domain name invalid {0}
046412
Unable to getAssignedLocsForDomainInMPGroup. Group data
not found for {0}
046420
Unable to getGrayedLocsForDomainInMPGroup. Group or
Domain name invalid {0}
046421
Unable to getGrayedLocsForDomainInMPGroup. Group data
not found for {0}
046430
Failed to getAvailableDomainLocations. Error: {0}
046440
Failed to getAllMediaPortalResourceIPs. Data Access Error: {0}
046441
Failed to getAllMediaPortalResourceIPs. Data Retrieval Error:
{0}
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
398 Error codes and messages
Error Code
Error Message
046450
Failed to create cacheMPGroupHashMap. Data Access Error:
{0}
046451
Failed to create cacheMPGroupHashMap. Data Retrieval Error:
{0}
Media Portal Routability Group error codes and messages (047000)
Media Portal Routability Group error codes and messages (047000)
Error Code
Error Message
047000
Unable to add MPRoute. MPRoute information is required.
047001
Unable to add or modify MPRoute. Route information is
required.
047002
Unable to add or modify MPRoute. Route Name is required.
047003
Unable to add or modify MPRoute. Route Name contains white
space {0}
047004
Route Name contains special char. The valid characters are
A-Z, a-z, 0-9, ’.’, ’-’ and ’_’.
047005
Unable to add or modify MPRoute. Route Name is not valid {0}
047006
Unable to add MPRoute. Route Name is not valid.
047007
Unable to add MPRoute. Route Name already exists {0}
047010
Failed to add MPRoute (0). Data Access Error: {1}
047111
Unable to add MPRoute. Route Location Maps required for {0}
047112
Unable to add MPRoute. Invalid Domain name {0}
047113
Unable to add MPRoute. Invalid Foreign Domain name {0}
047131
Failed to add LocationsToRoute. Data Access Error: {0}
047132
Failed to add LocationsToRoute. Data Retrieval Error: {0}
047202
Unable to modify MPRoute. Route Location Maps required
for {0}
047203
Unable to modify MPRoute. Existing cache data not found for {0}
047204
Failed to modify MPRoute. Data Access Error: {0}
047206
Unable to modifyBase RTGroup. Existing Route Name is
required.
047207
Unable to modifyBase RTGroup. Existing cache data not found
for {0}
047208
Unable to modifyBase RTGroup. Existing Route Name is
required.
047209
Unable to modifyBase RTGroup. Data and Name required.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Media Portal Routability Group error codes and messages (047000) 399
Error Code
Error Message
047210
Unable to modifyBase RTGroup. No cache data for {0}
047211
Unable to modifyBase RTGroup. Existing cache data not found
for {0}
047213
Failed to modifyBase RTGroup. Data Access Error: {0}
047216
Unable to modify DomainLocs RTGroup. Existing Route Name
is required.
047217
Unable to modify DomainLocs RTGroup. Domain Location
required.
047218
Unable to modify DomainLocs RTGroup. No cache data for {0}
047219
Unable to modify DomainLocs RTGroup. Existing cache data
not found for {0}
047220
Failed to modify DomainLocs RTGroup. Data Access Error: {0}
047301
Unable to remove MPRoutes. MPRoute Names required.
047302
Unable to remove MPRoute. MPRoute Name is required.
047303
Unable to remove MPRoute. MPRoute Name is required.
047304
Unable to remove MPRoute. No cache data for {0}
047305
Unable to remove MPRoute. Route data not found for {0}
047306
Failed to remove MPRoute. Data Access Error: {0}
047401
Unable to get MPRoute. MPRoute Name is required.
047402
Unable to get MPRoute. No cache data for {0}
047403
Unable to get MPRoute. Existing data not found for {0}
047405
Failed to getAllDomainLocations. Error: {0}
047406
Unable to getDomainWithAssignedLocs. Route name invalid {0}
047407
Unable to getDomainWithAssignedLocs. Route data not found
for {0}
047408
Unable to getAvailLocsForDomainInRTGroup. Route or Domain
name invalid {0}
047409
Unable to getAvailLocsForDomainInRTGroup. Route data not
found for {0}
047411
Unable to getAssignedLocsForDomainInRTGroup. Route or
Domain name invalid {0}
047412
Unable to getAssignedLocsForDomainInRTGroup. Route data
not found for {0}
047420
Failed to create cacheMPRouteHashMap. Data Access Error:
(0)
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
400 Error codes and messages
Error Code
Error Message
047421
Failed to create cacheMPRouteHashMap. Data Retrieval Error:
(0)
047422
Invalid zone ID provided {0}. Zone ID should be a integer.
Auto ID error codes and messages (048000)
Auto ID error codes and messages (048000)
Error Code
Error Message
048056
{0} Auto ID Address cannot be deleted because it is your user
name.
048058
Error adding Auto ID data for the UC user: Please provide a
numeric Auto ID Address and between {0} and {1} digits long.
LDAP error codes and messages (049000)
LDAP error codes and messages (049000)
Error Code
Error Message
049000
LDAP Server configuration is required for domain {0}
049001
LDAP Server cannot be found for domain {0}. Please configure
server using Server Configuration link.
049002
LDAP Server cannot be deleted for domain {0}. Please delete
the dependent data (Syncing Scheduler, User Defaults and
Schema Configuration in order) before deleting the LDAP server.
049003
Invalid Parameter error {0}
049004
The User Defaults password does not match policy for domain
{0}. The User Defaults password must be updated to match
policy: {1}.
049005
An error occurred while performing LDAP operation in domain
{0}. Please contact your next level of support.
049006
An error occurred while performing LDAP operation in domain
{0}: {1}
049007
Unable to bind to Primary/Secondary LDAP Server defined in
domain {0}
049008
LDAP Schema not configured correctly in domain {0}
049009
LDAP User Defaults not configured correctly in domain {0}
049010
Invalid DN Syntax for domain {0}
049011
Connection Closed with the LDAP server in domain {0} and
LDAP syncing halted
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
LDAP error codes and messages (049000) 401
Error Code
Error Message
049012
NamingException Caught in domain {0} - {1}
049013
The Server Type can only be P or S. Please provide a valid
Server type.
049014
The Primary Server address cannot be null for server type
Primary Server.
049015
The Secondary Server address cannot be null for server type
Secondary Server.
049016
The Address {0} provided for the LDAP Server is not valid.
Please provide a valid LDAP Server name.
049017
The Sync Frequency can only be D or M. Please provide a valid
Frequency type.
049018
The Enable Scheduler input can only be Y or N. Please provide
a valid value.
049019
The hour of sync must be between 1 and 12. Please provide
a valid sync hour.
049020
The IP Address provided for the LDAP Server is not valid.
Please provide a valid IP Address.
049021
An error occurred while performing LDAP operation in domain
{0}: An LDAP operation is currently in progress.
049022
LDAP Schema not configured correctly in domain {0}
049023
LDAP Sync Filter criteria cannot be deleted for domain {0}.
Please try later or contact your next level of support.
049024
LDAP Sync Filter criteria not configured correctly in domain {0}
049025
LDAP Schema cannot be deleted/updated for domain {0}.
Delete LDAP Sync Filter Criteria data first.
049026
LDAP server user name cannot be more than 128 characters.
049027
LDAP Sync Filter Criteria is already assigned for domain {0}.
049028
Invalid Characters in Special Character(s) field. {0}
049029
An error occurred while performing LDAP operation in domain
{0}. Duplicate Users: {1}.
049030
An error occurred while performing LDAP search operation for
filter {0} in domain {1} - {2}
049031
LDAP Search operation timed out for filter {0}. Connection
closed with LDAP server and syncing halted.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
402 Error codes and messages
Pooled Entity related error messages (050000)
Pooled Entity related error messages (050000)
Error Code
Error Message
050000
Unable to create new pooled entity {0} in domain {1}. {2}.
050001
Unable to create new routable service alias {0} in domain {1}.
{2}.
050002
Unable to delete pooled entity {0} in domain {1}. {2}.
050003
Unable to modify pooled entity {0} in domain {1}. {2}.
050004
Pooled Entity Name not provided.
050005
Pooled Entity Name contains invalid character: {0}
050006
Pooled Entity Name contains invalid characters: {0}
050007
No Services Groups Specified.
050008
No Routes Specified.
050009
Unable to create/modify Pooled Entity. Route {0} specified more
than once.
050010
Unable to create/modify Entity. System location {0} does not
exist. Verify location specified exists and is a system location
rather than a domain location.
050011
Invalid Service Specified: {0}
050012
Invalid Service Group Specified: {0}
050013
Invalid Data: Pool Not found : {0}
050014
Service name not provided
050015
Invalid service name\: {0}
050016
Service: {0} already provisioned on Pooled Entity: {1}
050017
Domain Not found: {0}
050018
Unable to List Pooled Entities: {0}
050019
More than one pooled resource returned.
050020
Unable to parse routes result set.
050021
Unable to parse services result set.
050022
Unable to find the pooled resource {0} in domain {1}.
050023
Unable to delete pooled resource: {0} {1} \nReason: {2}
050024
Unable to retrieve: {0} {1}
050025
Unable to retrieve PooledEntity Id: {0}
050026
Unable to retrieve Pools in: {0} for service: {1}
050027
Unable to retrieve Pools in: {0} for service group: {1}
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Pooled Entity related error messages (050000) 403
Error Code
Error Message
050028
Unable to retrieve Pools in: {0} for location: {1} providing
service: {2}.
050029
Unable to add route assignment: {0}
050030
Unknown service or service group: {0}
050031
More than one pooled resource returned.
050032
Unable to parse pooled entities.
050033
Retrieving servicing pool information failed. {0}
050034
Unable to resolve location for: {0} location: {1}.
050035
Unable to process location assignment.
050036
Unable to parse get locations.
050037
Unable to obtain Location list.
050038
Unable to process route assignment.
050039
Unable to parse result set for Pooled Services.
050040
Unable to list Pooled Services: {0}
050041
Unable to parse result set for Domain Routing Map.
050042
Unable to list Domain Routing Map: {0}.
050043
Unable to parse result set for Location Routing Map.
050044
Unable to list Location Routing Map: {0}.
050045
Unable to parse result set for Domain Routing Parameters.
050046
Unable to list Domain Routing Parameters: {0}
050100
Unable to add Service Alias. Alias: {0} already in use.
050200
Domain not found: {0}
050201
There needs to be at least one service package in the domain
before you can add a Pooled Resource.
050202
Unable to add pooled resource. A pooled resource with the
same name already exists.
050203
Data access error: {0} pooled resource: {1}
050204
Unable to list Pooled Resources: {0}
050205
More than one pooled resource returned.
050206
Unable to load pooled resource data. Please contact your next
level of support.
050207
Unable to find the pooled resource {0} in domain {1}.
050208
Currently the type Ad-hoc resource can only be named
&quot;conference&quot;.
050209
The name &quot;conference&quot; is reserved only for Ad-hoc type
resource.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
404 Error codes and messages
Error Code
Error Message
050210
A weight of &quot;{0}&quot; is not valid for the route &quot;{1}&quot;. Please use a
value between 0 and 10.
050300
Cannot perform operation; valid {0} not provided.
050301
Error occurred while loading data. Please contact your next
level of support.
050302
Alias: {0} already in use by service: {1}
050303
An error occurred while {0}: {1}
050304
Pooled Service Alias contains invalid character(s).
050305
Unknown Service: {0}
050306
Unknown locale: {0}. Valid locale names are: {1} .
050307
Alias {0} not found in domain {1}.
050308
Service Parameter does not exist: {0}
Converged Desktop feature error messages (051000)
Converged Desktop feature error messages (051000)
Error Code
Error Message
051000
Setting converged alias {0} failed because the alias is already in
use by another user. Please use a different value.
051001
IInvalid Data: Service Data not found for domain {0}
051002
Adding service DN {0} failed because the value is already in use
as a {1}. Please use a different value.
051003
Setting converged alias {0} failed because the alias is already in
use as a Converged Desktop Service DN. Please use a different
value.
051004
The Preferred Audio Device cannot be the same as User Name
{0}. Please choose a different value.
051005
The {0} field cannot be empty. Please provide a value.
051006
This Converged Desktop Alias field must contain only digits.
051007
The entry for {0} field is too long; it has a maximum length of {1}.
051008
Converged User Type must be SimRing, Enterprise, or Carrier.
051009
Adding of Converged User Data failed: {0}
051010
Converged Desktop User information retrieval failed: {0}
051011
Converged Desktop User information could not be retrieved.
Data Access error. Please contact support for more information.
051012
Adding of Converged User Data failed: {0}
051013
Modifying Converged User Data failed: {0}
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Voicemail server provisioning related error codes and messages (052000) 405
Error Code
Error Message
051014
Converged Desktop Alias Search retrieval failed: {0}
051015
Converged Desktop Alias Search could not be completed. Data
Access error. Please contact support for more information.
051016
A data access error occurred while adding Converged User
data: {0}
051017
A data access error occurred while updating Converged User
data: {0}
051018
Desktop User information Removal failed: {0}
051019
Service DN validation failed, {0}
051020
Converged Desktop User information retrieval failed: {0}
051021
Converged Desktop User information retrieval failed. Please
contact your next level of support.
051022
Domain name is invalid. Assign valid domain name.
051023
Converged Desktop PAD field before ’@’, must contain only
digits.
051024
Either add the domain name or delete ’@’ from Converged
Desktop Preferred Audio Device field to use the default domain.
051050
Required attributes are null. Please provide the required
attributes ’Domain Name’ and ’Prefix Data’.
051051
Null attributes provided.Please provide the required attribute
’DomainName’ .
051052
Mobile Converged domain prefix data removal for domain {0}
failed: {1}
051053
Prefix validation failed.The prefix should contain only numeric
values and should be less than or equal to 16 digits in length.
051054
Assigning prefix data to domain failed. {0}
051055
Getting domain prefix data information failed. {0}
Voicemail server provisioning related error codes and messages
(052000)
Voicemail server provisioning related error codes and messages (052000)
Error Code
Error Message
052000
There was no voicemail server data provided. Please provide
the server information.
052001
The ’Name’ field is empty. Please provide the name for the
server.
052002
The ’type’ field provided is invalid, the valid type(s) are {0}.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
406 Error codes and messages
Error Code
Error Message
052003
The ’App. Svr. Address’ provided, {0}, is not a valid IP address.
Please provide a valid IP address.
052004
The ’Address’ for the terminal server provided, {0}, is not a valid
IP address. Please provide a valid IP address.
052005
The ’SMDI version’ for the server is not an acceptable length.
The SMDI version must be of the form x.x (eg 2.0)
052006
The ’User name’ is too long. Please provide a value of length
less than or equal to 25.
052007
The ’Password’ is too long. Please provide a value of length
less than or equal to 15.
052008
The ’Name’ field is too long. The server name cannot exceed
200 characters in length.
052009
The ’Client contact’ field was not provided. Please provide a
value.
052010
The ’Client contact’ field has invalid characters. Please provide
alpha-numeric characters.
052011
The ’Domains’ must have at least one entry associated with the
voicemail server. Please provide at least one domain name.
052012
The Line Number associated with a line cannot be empty.
052013
Adding the {0} Voicemail Server {1} failed: {2}
052014
{0} Voicemail server information retrieval failed for domain {1}:
{2}
052015
The {0} voicemail server information could not be retrieved:
Data Access Error, please contact your next level of support for
more information.
052016
Cannot perform operation, the following values must be
provided: {0}
052017
Removing the {0} voicemail server {1} failed: {2}
052018
The Voicemail Server to be deleted was not found.
052019
Updating {0} Voicemail Server {1} failed. Voicemail Server and
domain mapping cannot be removed because users in domains
{2} are assigned to this voicemail server
052020
Updating {0} Voicemail Server {1} failed: {2}
052021
Setting base server information failed. Voicemail server not
found: {0}
052022
The voicemail server {0} was not found.
052023
Voicemail server information retrieval failed: {0}
052024
Voicemail server route information retrieval failed: {0}
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Voicemail server provisioning related error codes and messages (052000) 407
Error Code
Error Message
052025
The voicemail server route information could not be retrieved.
Data Access error. Please contact support for more information.
052026
Line information for line voicemail server {0} failed: {1}
052027
The Line information for the voicemail server could not be
retrieved. Data Access error. Please contact next level of
support for more information
052028
Voicemail server domain information retrieval failed: {0}
052029
The voicemail server domain information could not be retrieved.
Data Access error. Please contact support for more information.
052030
The user information for the voicemail servers could not be
retrieved: {0}
052031
Data Access error: Unable to retrieve user information. Please
contact support for more information.
052032
Voicemail server VMDOMAINMAP information retrieval failed:
{0}
052033
Voicemail server Host information retrieval failed: {0}
052034
Updating {0} Voicemail Server failed. Invalid data (Unique
constraint violated for fields {1})
052035
Voicemail server TERMINAL SVR INFO information retrieval
failed: {0}
052036
Line information for line voicemail server failed: {0}
052037
The Line information for the Voicemail server could not be
retrieved. Data Access error. Please contact support for more
information.
052038
Cannot carry out the voicemail operation for the user {0}. The
user’s service package does not contain the voicemail service.
052050
Unable to retrieve Voicemail Server Hosts due to {0}.
052051
Unable to retrieve Voicemail Server Host for {0} due to {1}.
052052
The Voicemail Server Host name cannot be null. Please provide
a valid value.
052053
Unable to find a Voicemail Server Host with name {0}. Please
provide a valid host name.
052054
Unable to delete Voicemail Server Host {0}. The host is in use
by Voicemail Servers.
052055
Unable to delete Voicemail Server Host {0} due to {1}.
052056
The Voicemail Server Host cannot be null. Please provide a
valid value.
052057
The Voicemail Server Host Type can only be NODE or DOMAIN.
Please provide a valid value.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
408 Error codes and messages
Error Code
Error Message
052058
The Host name {0} already exists. Please provide a different
host name.
052059
Unable to add Voicemail Server Host due to {0}.
052060
An error occurred when trying to add/modify Voicemail Server
Host {0}. {1}
Password policy error codes and messages (055000)
Password policy error codes and messages (055000)
Error Code
Error Message
055000
Unable to load Password Policy Information.
055001
Password Policy not found. Invalid Policy Name {0}. Please
verify that the policy exists or the policy name is valid by listing
or by doing a search because it could have been changed.
055002
Null Data. Please provide a name for the password policy.
055003
Invalid minimum length for the policy {0}. The valid range is
{1} to {2}.
055004
Name {0} already in use. Please use a different name.
055005
Null Data. Please provide the minimum number of digits for
the policy {0}.
055006
Null Data. Please provide the minimum number of characters
for the policy {0}.
055007
Invalid minimum number of digits or characters for the policy {0}.
Minimum number of digits and characters should be greater
than or equal to zero and the sum of both these values should
be less than or equal to minimum length {1}.
055008
Adding password policy information failed. {0}
055009
Modifying password policy information failed. {0}
055010
Removing password policy information failed. {0}
055011
Invalid Password. Password should be {0} to {1} characters
in length.
055012
Invalid Password. Password should have at least {0} digits.
055013
Invalid Password. Password should have at least {0} characters.
055014
User {0}. {1}
055015
{0}
055016
Invalid minimum number of digits or characters for the policy {0}.
The sum of both these values should be less than the minimum
length {1}.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
SMS subscriber, SMPP configuration and interworking domain error codes and messages
(056000) 409
Error Code
Error Message
055017
Cannot remove password policy {0} because it is assigned to
domains {1}.
055018
Cannot modify/delete the system defined &quot;Existing&quot; policy.
055019
Cannot delete the system defined &quot;Default&quot; policy.
055020
Invalid name {0} for a policy. The name should be less than
{1} characters.
055021
Invalid data. Please provide numerical values for Minimum
Length, Minimum number of Digits and Minimum number of
characters.
055022
Cannot modify the name of the system defined &quot;Default&quot; policy.
055023
Invalid minimum number of {0} for the policy {1}. Minimum
number of digits and characters should be greater than or equal
to zero and the sum of both these values should be less than or
equal to minimum length {2}.
055024
Invalid character {0} used in password. Please use a valid
character. The valid characters are A-Z, a-z and !, &amp;, (, ), \’’ ,
-, ., ,, ?, @, ^, _ .
055025
Data retrieval failed: Data was not found.
055026
The operation cannot be performed. Please provide the
following required data: {0}
SMS subscriber, SMPP configuration and interworking domain error
codes and messages (056000)
SMS subscriber, SMPP configuration and interworking domain error codes
and messages (056000)
Error Code
Error Message
056000
Invalid Interworking Domain. The Interworking domain must be
one of the foreign domains configured on the system.
056001
Invalid Interworking Domain field domainName {0}. The
Interworking domain must be one of the foreign domains
configured on the system.
056002
Invalid Interworking Domain field serviceType {0}. The only valid
serviceType is SMSIW in this release.
056003
Domain Name is not a valid Foreign Domain. The Interworking
domain must be one of the foreign domains configured on the
system.
056010
Invalid SMSSubscriber. The subscriber must be subscribed to
the SMS Interworking service.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
410 Error codes and messages
Error Code
Error Message
056011
Invalid SMSSubscriber field userName {0}. The user name field
of the SMSSubscriber must be a fully qualified username.
056012
Invalid SMSSubscriber field Address {0}. Address cannot be
null or empty.
056013
User not found {0}. User not found in system.
056014
Domain not found {0}.
056015
Invalid start/end parameter ({0},{1}). The start parameter must
be non-negative and smaller than the end parameter.
056021
Invalid SMPPConfigInfo field {0}. Please consult the SMS
Interworking Service section of the Provisioning Guide.
056050
Data retrieval failed: please contact your next level of support.
056051
Data update failed: please contact your next level of support.
056052
Addition of SMPP Config Info failed: Invalid data {0}
Voicemail error codes and messages (057000)
Voicemail error codes and messages (057000)
Error Code
Error Message
057000
Invalid Characters in Client contact. The valid characters are
A-Z, a-z, 0-9, and ’_’.
057001
Invalid Client contact. Client contact cannot be null.
Global address book error codes and messages (058000)
Global address book error codes and messages (058000)
Error Code
Error Message
058000
The global address book has been disabled by the network
administrator.
Service node error codes and messages (059000)
Service node error codes and messages (059000)
Error Code
Error Message
059000
Node Name cannot be null. Please provide a valid node name.
059001
Logical Entity Name cannot be null. Please provide a valid
logical entity name.
059002
Logical Entity Route information cannot be null. Please provide
a valid value.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Service node error codes and messages (059000) 411
Error Code
Error Message
059003
Node Information cannot be null. Please provide valid values.
059004
Node Address type can only be IP or DNS. Please provide a
valid value for node {0}.
059005
Node address {0} is invalid. Please provide a valid address for
node {1}.
059006
Node {0} is not assigned to the requested domain.
059007
Invalid node type {0} provided for node {1}. Please provide
a valid value.
059008
Logical Entity with {0} name does not exist. Please provide
a valid name.
059009
Invalid node name {0} provided for node type {1}.
059010
Node name cannot be null for Logical Entity Route {0}.
059011
Domain name should be a root domain. {0} is not a root domain.
059012
Unable to delete node {0}. The node is assigned to domains.
059013
Unable to delete Logical Entity {0}. The Logical Entity is
assigned to domains.
059014
Node {0} is already assigned to root domain {1}. Please provide
sub domains for {2}.
059015
Domain {0} is not a sub domains of {1}. Please provide a valid
sub domain.
059016
Unable to delete node {0}. The node is associated with Logical
Entities.
059017
Unable to delete node {0}. The node is associated with
Voicemail Servers.
059018
Unable to delete node {0}. The node is associated with ERLs.
059019
Unable to delete node {0}. The node is associated with Gateway
Routes.
059020
Unable to delete node {0}. {1}
059021
Unable to delete Logical Entity {0}. The entity is associated with
Voicemail Servers.
059022
Unable to delete Logical Entity {0}. The entity is associated with
ERLs.
059023
Unable to delete Logical Entity {0}. The entity is associated with
Gateway Routes.
059024
Unable to delete Logical Entity {0}. {1}
059025
The Address {0} for node {1} cannot contain IP address. Please
provide a valid address.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
412 Error codes and messages
Error Code
Error Message
059026
Cannot remove node/ logical entity {0}. Gateway Routes are
associated with the node/ entity.
059027
Cannot remove node/ logical entity {0}. ERLs are associated
with the node/ entity.
059028
Cannot remove node/ logical entity {0}. Music Folders are
associated with the node/ entity.
059029
Cannot remove node/ logical entity {0}. Branding Files are
associated with the node/ entity.
059030
Cannot remove node/ logical entity {0}. Branding Pools are
associated with the node/ entity.
059031
Cannot remove node/ logical entity {0}. Treatment Groups are
associated with the node/ entity.
059032
Logical Entity information cannot be null. Please provide a valid
value.
059033
The Routing Algorithm can only be: Weighted Average or
Sequential.
059034
Routes cannot be null for logical entity {0}.
059035
Logical Entity Route weight can only be between 0 and 10.
059036
A logical entity with {0} name already exists. Please enter a
different name.
059037
A DB constraint exception occurred while adding/ modifying
Logical Entity. {0}
059038
Unable to modify LogicalEntity {0}. Music On Hold Service is in
use by domains and cannot be unassigned.
059039
Unable to modify LogicalEntity {0}. Branding Service is in use
by domains and cannot be unassigned.
059040
Unable to modify LogicalEntity {0}. Treatment Service is in use
by domains and cannot be unassigned.
059041
Unable to modify LogicalEntity {0}. Service being unassigned is
in use by domains.
059042
Unable to modify LogicalEntity {0}. Adhoc Conference is in use
by domains and cannot be unassigned.
059043
Cannot remove node/ logical entity {0}. Treatment Files are
associated with the node/ entity.
059044
Cannot remove node/ logical entity {0}. Routable Services are
associated with the node/ entity.
059045
A node with {0} name already exists. Please enter a different
name.
059046
A DB constraint exception ocurred while adding/ modifying
Node. {0}
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Service node error codes and messages (059000) 413
Error Code
Error Message
059047
Cannot remove node/ logical entity {0}. Routable Aliases are
associated with the node/ entity.
059048
Cannot unassign node {0} from Domain {1}. Sub-domains for
this domain are associated with the node.
059049
Cannot remove node/logical entity {0}. Sub-domains are
associated with the node/entity.
059050
The route {0} for node {1} does not form a valid URL. Please
enter valid values.
059051
The route {0} for logical entity route {1} does not form a valid
URL. Please enter valid values.
059052
059053
059054
A DB Exception occurred while trying to get Logical Entity {0}.
059055
A DB Exception occurred while trying to get Node {0}.
059056
A DB Exception occurred while trying to get Node Names {0}.
059057
A DB Exception occurred while trying to get nodes for domain
{0}.
059058
A DB Exception occurred while trying to get node count.
059059
An exception occurred trying to get Node Domains. {0}
059060
Cannot unassign node {0} from Domain {1}. Gateway Routes
are associated with the node in the domain.
059061
Cannot unassign node {0} from Domain {1}. ERLs are
associated with the node in the domain.
059062
Cannot unassign node {0} from Domain {1}. Music Folders are
associated with the node in the domain.
059063
Cannot unassign node {0} from Domain {1}. Branding Files are
associated with the node in the domain.
059064
Cannot unassign node {0} from Domain {1}. Branding Pools are
associated with the node in the domain.
059065
Cannot unassign node {0} from Domain {1}. Treatment Groups
are associated with the node in the domain.
059066
Cannot unassign node {0} from Domain {1}. Treatment Files are
associated with the node in the domain.
059067
Cannot unassign node {0} from Domain {1}. Routable Aliases
are associated with the node in the domain.
059068
Cannot unassign node {0} from Domain {1}. Routable Services
are associated with the node in the domain.
059069
Cannot unassign node {0}. {1}
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
414 Error codes and messages
Error Code
Error Message
059070
Route Name cannot be null for Logical Entity.
059071
Cannot assign domains to node: At least one domain should be
provided.
059072
The {0} must be between {1}-{2} characters in length.
059073
Cannot assign domains to node: Duplicate domains are
provided.
Admin and role related error codes and messages (060000)
Admin and role related error codes and messages (060000)
Error Code
Error Message
060000
System defined ’SuperUser’ role cannot be modified or deleted.
060001
You are not allowed to modify your own role.
060002
You are not allowed to delete your own role.
060003
Invalid Domain {0}. Domain not found or the domain provided is
not a local domain. {1}
060004
Addition of admin failed: {0}
060005
Modification of admin failed: {0}
060006
Cannot perform operation without required attributes: {0}
060007
Data required to carry out administrator operation has not been
loaded. Please verify availability of data source(s).
060008
No admin was found with name {0}
060009
Cannot add/modify admin because the parent admin does not
have enough privileges. The parent admin does not have the
{0} privilege on the {1} .
060010
Deletion of admin(s) failed : {0}
060011
Cannot add/modify admin because the parent admin does not
have enough privileges . The parent admin does not have the
domain {0} assigned.
060012
Addition of Role(s) failed: {0}
060013
Modification of Role(s) failed: {0}
060014
Deletion of Role(s) failed: {0}
060015
Cannot find a role with name {0}
060016
Invalid Data: Prov Role Not found {0}
060017
Invalid Data: System Role Not found {0}
060018
A data retrieval error occurred. Please try later or contact your
next level of support.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Parm Definition error codes and messages (061000) 415
Error Code
Error Message
060019
Invalid Data: Invalid Right Type {0}
060020
Error: No such admin found, {0}
060021
Cannot add/modify admin because the parent does not enough
privileges. The parent admin is not authorized to assign the
{0} role.
060022
Cannot add administrator. {0}
060023
Cannot change administrator password. {0}
060024
Unable to add/modify Admin. The domain list for the admin has
duplicate entries.
Parm Definition error codes and messages (061000)
Parm Definition error codes and messages (061000)
Error Code
Error Message
061000
No parameter with parameter name {0} exists in the system.
Please provide a valid parameter name.
061001
Parameter Name cannot be null. Please provide a valid
parameter name.
061002
Parameter Value cannot be null for parameter {0}.
061003
The parameter value for a boolean parameter can only be true
or false.
061004
Parameter {0} is not owned by owner {1}. Please provide a valid
parameter name.
061005
Unable to load Parameter Definition Cache. Please contact
support.
061006
Unable to load Parameter Definition Owners Cache. Please
contact support.
061007
Owner cannot be null. Please provide a valid owner name.
061008
Parameter Definition cannot be null. Please provide valid values.
061009
Parameter Display Name cannot be null. Please provide a valid
parameter display name.
061010
Parameter Type can only be boolean or text.
061011
The parameter name {0} or parameter display name {1} already
exists in the system.
061012
An unknown error occurred while adding Parameter Definition
{0}. {1}.
061013
Unable to delete parameter {0}. The parameter is in use.
061014
Unable to delete parameter {0}. {1}
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
416 Error codes and messages
Error Code
Error Message
061015
Parameter {0} is already assigned to owner {1}.
061016
Unable to assign parameter {0} to owner {1}. {2}
061017
Unable to remove parameter {0} from owner {1}. The parameter
is in use for Service Nodes.
061018
Unable to remove parameter {0} from owner {1}. The parameter
is in use for Logical Entity Routes.
061019
Unable to remove parameter {0} from owner {1}. {2}
061020
Unable to get parameter definition data for owner {1}.
Out of band REFER error codes and messages (062000)
Out of band REFER error codes and messages (062000)
Error Code
Error Message
062000
Invalid Data: Service Data not found for domain {0}
062001
Unable to create Access Codes. The Access Codes already
exist. Details: {0}
062002
The Out of Band REFER Access Code field must contain only
digits.
062003
The entry is too long; it has a maximum length of 4.
062004
Adding of Out Of Band REFER Access Code Data failed: {0}
062005
Out of Band REFER Access Code information retrieval failed:
{0}
062006
The Out of Band REFER Access Code information could not
be retrieved. Data Access error. Please contact support for
more information.
062007
Modifying Out of Band REFER Access Codes failed: {0}
062008
A data access error occurred while adding Out of Band REFER
Access Codes data: {0}
062009
Out of Band REFER Access Code information removal failed:
{0}
Ringback error codes and messages (063000)
Ringback error codes and messages (063000)
Error Code
Error Message
063000
Domain information is required.
063001
Pool Name information is required.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Domain CLI error codes and messages (064000) 417
Error Code
Error Message
063002
Failed to initialize data access components: Unable to proceed
further. Please contact your next level of support.
063003
File Name information is required.
063004
Modifying Ringback files information failed for domain: {0},
pooled resource:{1}. {2}
063005
Modifying Ringback files information failed for domain: {0}. {1}
063006
File Name cannot exceed 64 characters.
063007
Display Name cannot exceed 100 characters.
063008
Assigning Ringback information failed for domain: {0}, pooled
resource: {1}. {2}
063009
Display Name information is required.
063010
File Name is not valid. Please retrieve list of Ringback files in
this pool and select from it.
063011
CRBT information is required.
063012
At least one file must be selected.
063013
Files can be removed only at the root domain level. The root
domain for this domain is: {0}.
063014
Files can be added only at the root domain level. The root
domain for this domain is: {0}.
063015
Unable to delete Ringback file {0} because it is part of the
domain pool assignment for the following domain(s): {1}. Please
remove this file from the Ringback assignment and try again.
063016
Invalid media file format. Please select from: {0}
063018
Invalid Pool Name. Please select a valid Pool for this domain
and service.
063019
A DB Exception occurred while trying to retrieve data {0}.
063020
Files can be provisioned only at the root domain level. The root
domain for this domain is: {0}.
Domain CLI error codes and messages (064000)
Domain CLI error codes and messages (064000)
Error Code
Error Message
064001
Error adding Domain CLI data to the database. {0}
064002
Adding Domain CLI Data failed: {0}
064003
Retrieving Domain CLI data failed: {0}
064004
Modifying Domain CLI data failed: {0}
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
418 Error codes and messages
Error Code
Error Message
064005
Removing Domain CLI data failed: {0}
064006
Domain information is required to carry out delete operation.
064007
{0} {1} is invalid. {0} should contain only numeric values.
064008
{0} {1} is invalid. {0} should contain only alphanumeric values.
064009
Domain information is null. Please provide the required attribute.
064010
Domain CLI Service data is null. Please provide the required
attributes.
Translation tool error codes and messages (070000)
Translation tool error codes and messages (070000)
Error Code
Error Message
070000
You have to datafill URI and FROM in username@domain
format
Presence error codes and messages (072000)
Presence error codes and messages (072000)
Error Code
Error Message
072000
Could not retrieve the user watchers for the user {0}.
072001
Could not retrieve the user presence for the user {0}.
072002
Operation failed. User {0} does not have Presence service in
their service package.
Group error codes and messages (089000)
Group error codes and messages (089000)
Error Code
Error Message
089100
Adding group information failed. {0}.
089101
Adding group information failed. No group information provided.
089102
Assigning group information to user failed. Please provide a
fully qualified username in the form user@domain.
089103
Modifying group information failed. {0}.
089104
Modifying group information failed. Modifying group information
not provided.
089105
Group operation failed. Type information not provided for group
{0} in domain {1}.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Group error codes and messages (089000) 419
Error Code
Error Message
089106
Assigning groups to user {0} failed. No group information was
provided to assign to.
089107
Assigning group information to user failed. {0}
089108
Removing group information failed. No domain information
provided.
089109
Removing group information failed. No group information
provided.
089110
Removing group information failed. There are users associated
with the group. Please retry after removing users from the group.
089111
Removing group information failed. {0}.
089112
Removing user {0} from group {1} failed. {2}.
089113
Assigning user {0} to groups failed. User belongs to domain {1}
which cannot inherit group {2}.
089114
Invalid value {0} provided for the parameter {1}.
089115
Could not retrieve group information. {0}.
089116
Group {0} is not available for domain {1} to modify. This domain
does not own the group.
089117
Parameter {0} is not a parameter for group {1}. Please provide
valid parameters and try again.
089118
Could not retrieve user information for group {0}.{1}.
089119
Assigning user {0} to groups failed. User’s service package {1}
does not have either {2} or {3} enabled.
089120
Could not carry out group operation. Group name is a required
field.
089121
Could not carry out group operation. Group name {0}
cannot exceed 30 characters in length and can contain only
alphanumeric characters including an underscore.
089122
Unable to retrieve user group name information. {0}.
089123
Service {0} is required for the group {1} to be assigned to the
user {2}. User’s service package {3} does not have this service.
089124
The user {0} does not belong to a domain that is a child of the
domain {1}.
089125
Assignment of user to groups failed. A user can be associated
with only {0} call pickup groups.
089126
Could not determine the parameter information for the group.{0}.
089127
Could not determine the user information for the group.{0}.
089128
Group {0} is not available to domain {1}, cannot get details.
089129
Group operation failed. Group alias is already in use as a {0}.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
420 Error codes and messages
Error Code
Error Message
089130
Removing groups from user {0} failed. {1}.
089131
Group operation failed. Group {0} is not available to domain
{1} to use.
089132
Group name and user name are required to carry out this
operation.
089133
Group name and domain name are required to carry out this
operation.
089134
Domain name is required to carry out this operation.
089135
User name is required to carry out this operation.
089136
User name and group type are required to carry out this
operation.
089137
Group operation failed. Type information not provided.
089138
Invalid group type provided {0}. Valid group types are {1}.
System-specific exceptions and authorization error codes and
messages (099000)
System-specific exceptions and authorization error codes and messages
(099000)
Error Code
Error Message
099000
Authorization failed: {0}
099001
The user name was not provided. Cannot perform the task
requested.
099002
User name is invalid. Must be in the form user@domain
099003
The password for the administrator {0} cannot be reset. This
administrator was not created by the administrator {1}.
099004
Exception occurred while Comparing User Aliases with
Converged Desktop PAD. Please contact system administrator.
099005
The same converged Private PAD exists for other user in this
domain. converged Private PAD should be unique across the
domain.
099006
Converged Desktop Private PAD is matching with alias. User
Converged Desktop Private PAD and alias should be unique
across the domain.
099007
Alias is matching with Converged Desktop Private PAD. User
alias and Converged Desktop Private PAD should be unique
across the domain.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Generic exceptions (099999) 421
Generic exceptions (099999)
Generic exceptions (099999)
Error Code
Error Message
099999
{0}
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
422
Index
A
activateRoutes 123, 325
addAddressBookEntries 257, 319
addAddressBookEntry 256, 319
addAddressBookGroup 264, 321
addAddressBookGroups 264, 322
addAdmin 173
addAssistants 150
addBannedSubscriber 90
addBannedSubscribers 90
addBannedUser 262, 334
addBannedUsers 262, 334
addBrandingFile 190
addBrandingFiles 191
addClientType 144
addClientTypes 145, 145
addConvDesktopServiceData 93
addConvDesktopUserData 141, 141
addDevice 104
addDevices 105
addDomainLocale 81
addDomainLocales 81
addEmergencyNumber 271
addEmergencyNumbers 271
addErl 223
addForeignDomain 101
addGroup 298
addGroups 298
addIPCM 109
addLdapInfo 285
addLdapSchema 285
addLdapTimeBlock 286
addLdapUserDefaults 287
addLineVoicemailServer 250
addLocation 220
addLocations 220
addLogicalEntity 204
addLogicalEntitys 205
addMediaPortalGroup 274
addMediaPortalGroups 274
addMeetMeConfUser 138, 330
addMpRoutabilityGroup 277
addMpRoutabilityGroups 278
addMusicOnHoldFolder 187
addMusicOnHoldFolders 187
addNode 201
addNodes 202
addNumberQualifier 227
addNumberQualifiers 227
addOOBReferAccessCodes 96
addParmDefinition 295
addPasswordPolicy 292, 292
addPreTranslator 229
addPreTranslators 230
address book 265, 266, 266, 267, 267, 267
banned user 262, 262, 263, 263, 263
buddy 261, 261, 268
group 264, 265, 265
search 154, 154, 154, 155, 155, 156,
156, 156, 157, 157
user 256, 257, 258, 258, 259, 260, 260,
260, 261
address Book
group 264, 264
Address book
error codes 344
Address book group
error codes 359
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Index 423
addRole 171
addRootDomain 97
addRoute 124, 326
addRouteList 236
addRouteLists 236
addRoutes 125, 326
addServicePackage 177
addServicesToDomain 181
addServicesToDomains 182
addSIPVoicemailServer 244
addStatusReason 84
addStatusReasons 85
addSubDomain 98
addTelephonyRoute 232
addTelephonyRoutes 233
addTimeBlockGroup 119, 315
addTimeBlockGroups 120, 316
addTimeZone 270
addTreatmentFile 194
addTreatmentFiles 195
addTreatmentGroup 195
addTrunkVoicemailServer 247
addUser 158
addUserPicture 306, 333
addUserStaticRoutes 133
addUsersToAddressBook 266, 322
addUsersToDomain 159
addUsersVoicemailServer 167
addVoicemailServerHost 242
Admin
error codes 414
role 170
admin 173, 174, 174, 174, 175
children 175
password 175, 176
role 171, 171, 172, 172, 172, 173, 173
ANI
domain 225
ANI list
domain 224
assignBranding 191
assignDirectToGatewayPrefixData 240
assignDomainMCPrefixData 95
assignDomainsToNode 207
assignedTreatmentPool 196
assignGroupsToUser 300
assignMusicOnHoldFolder 187
assignNodeToDomain 213
assignNodeToLocation 213
assignNodeToLocations 213
assignNodeToSubDomains 207
assignPackage 180
assignParmDefinitionToOwner 296
assignUserDirectToGWPrefixData 169
assignUserMCPrefixData 143, 143
Assistant 150, 150, 150, 151, 151, 151,
152, 152, 152, 153
error codes 387
authenticateUser 314
Authorization
error codes 420
Auto ID
error codes 400
B
Banned Subscriber
domain 90, 90, 91, 91, 92, 92
Banned subscriber
error codes 359
Banned User 334, 334, 334, 335, 335, 335
BPT
Address book operations 254
Add a banned user 262
Add address book entry for a User 256
Add banned users 262
Add multiple address book entries for
a User 257
Add new group to the address book of
a User 264
Add new groups to the address book of
a User 264
Add users to the address book of a
User 266
Get address book for a User 261
Get address book for a User with photo
urls 267
Get address book for a User without
photo urls 267
Get all address book groups for a
User 264
Get an addressbook entry 266
Get an addressbook entry with photo
url 267
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
424 Index
Get buddies from the address book of
a User 261
Get the banned users for a User 263
Make this entry a buddy 268
Modify a banned user 262
Modify address book entries for a
User 258
Modify address book group names for
a User 265
Modify an address book entry for a
User 258
Remove a banned user for a User 263
Remove a buddy from a users address
book 261
Remove address book entries for a
User 259
Remove address book for a User 260,
260
Remove address book group of a
User 265
Remove all banned users for a
User 263
Remove an address book entry for a
User 260
Rename address book group of a
User 265
Admin operations 170
Add a new Role 171
Add an Admin 173
Change password 175
Get all Admins 175
Get all children Admins 175
Get all provisioning roles 173
Get all rights 173
Get all system roles 172
Get an Admin 174
Get provisioning role 172
Modify a Role 171
Modify an Admin 174
Remove a Role 172
Remove an Admin 174
Reset password 176
Role operations 170
Alias routing 214
domain 214
Get a list of Aliases Providing a
Service 215
Get Aliases All Information for an Alias
Providing a Specified Service 215
Get Aliases Information for an Alias 215
Remove routable service alias 216
Device Operations 104
Device operations
Add a device 104
Add devices 105
Get a device 107
Get a list of devices 107
Get devices by domain 108
Get devices by MAC address 108
Get devices by User name 108
get SubDomain For Device 109
Modify a device 106
Remove a device 106
Remove devices 107
Domain operations 80, 87
Add a banned subscriber to a
domain 90
Add a foreign domain 101
Add a list of domain locales 81
Add a list of status reasons to a
domain 85
Add a root domain 97
Add a status reason to a domain 84
Add a sub domain 98
Add Mobile converged audio device
prefix for a domain 95
Add multiple banned subscribers to a
domain 90
Add the Converged Desktop Service
Data to a domain 93
Add the Out of Band REFER Access
Codes for a domain 96
Banned Subscriber operations 89
Converged Desktop Service Data 92
Domain Profile operations 88
Get a domain by name 100
Get a foreign domain 102
Get all banned service options
names 91
Get all banned subscribers in a
domain 91
Get all child domains of a domain 100
Get all Class of Services for a
domain 87
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Index 425
Get all domains 99
Get all possible values for a domain
parameter 99
Get all profiles for a root domain 88
Get all root domain parameters 99
Get all status names 85
Get all sub domain parameters 99
Get all the children domain names for
a domain 103
Get all the root domain names 103
Get domain profile for a domain 88
Get domains subset 103
Get Mobile converged audio device
prefix for a domain 95
Get status reasons for a domain 85
Get the Converged Desktop Service
data associated with a domain 94
Get the domain count in the system 104
Get the list of locales for a domain 82
Get the Out of Band REFER Access
Codes associated with a
domain 97
Get the parent domain of a domain 100
Get the root domain of a domain 101
Modify a domain 98
Modify a foreign domain 102
Modify a status reason for a domain 86
Modify Class of Service for a domain 87
Modify domain profile for a domain 89
Modify the domain locales 83
Out of Band REFER Access Codes 97
Remove a banned subscriber from a
domain 91
Remove a domain 98
Remove a domain locale 83
Remove a foreign domain 102
Remove a status reason from a
domain 86
Remove all banned subscribers from
a domain 92
Remove all status reasons from a
domain 86
Remove Class of Service for a
domain 88
Remove domain profile for a domain 89
Remove Mobile converged audio
device prefix for a domain 95
Remove several banned subscribers
from a domain 92
Remove the Converged Desktop
Service data from a domain 94
Set the domain locale default 83
Status Reason operations 84
Update the Converged Desktop
Service Data to a domain 93
Update the Out of Band REFER
Access Codes for a domain 96
Domain Operations
Add a domain locale 81
Domain Locale 81
Get list of locales 82
Get the default locale for a domain 82
Emergency number operations 271
Add Emergency Number 271
Add Emergency Numbers 271
Get all Emergency Numbers 272
Get Emergency Aliases 272
Remove all Emergency Numbers 272
Remove an Emergency Number 272
Update Emergency Alias List 273
Groups 297
Add a group 298
Add groups 298
Assign users to a group 300
Get a group 299, 301
Get a group by user name 300
Get all group types 301
Get groups for a user 301
Get groups for domain 300
Get users in a group 300
Modify a group 299
Remove a group 299
Remove all groups for user 301
Remove groups 299
Remove user from group 301
IPCM
Add a single IPCM 109
Get a single IPCM 110
Get assigned IPCMs for a domain 111
Get available capacity for an IPCM 111
Get IPCM capacity for domain 111
Modify a single IPCM 110
Remove a single IPCM 110
Remove Physical IPCM 112
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
426 Index
IPCM Operations 109
LDAP 284
Add LDAP Info 285
Add LDAP Schema 285
Add LDAP Time Block 286
Add LDAP User Defaults 287
Add LDAPSyncFilterCriteria 287
Get LDAP Information for Domain
Name 289
Get LDAP Schema for Domain
Name 289
Get Ldap Sync Filter Criteria for
Domain Name 290
Get LDAP Time block for Domain
Name 290
Get LDAP User Defaults for Domain
Name 290
Remove LDAP Info for Domain 287
Remove LDAP Schema for
Domain 288
Remove LDAP Time Block for
Domain 288
Remove LDAP User Defaults 288
Remove LdapSyncFilterCriteria for
Domain 289
Start LDAP Synchronization Now 291
License Key Usage 283
Get License Key Usage for a Given
Keycode 284
Location services 219
Add ERL 223
Add Location 220
Add Locations 220
Get ERL 223
Get Location 222
Get Locations by Parent 222
Get Locations for Domain 222
List ANI for Domain 224
List Deprecated Locations for
Domain 225
List of Valid ANI Registration Times in
Seconds 225
Modify ERL 223
Modify Location 221
Purge Deprecated Locations for
Domain 225
Remove ERL 224
Remove Location 221
Media Portal Group and Route
operations 273
Add a new Media Portal Group 274
Add a new Media Portal Route 277
Add multiple Media Portal Groups 274
Add multiple Media Portal Routes 278
Get a Media Portal Group data 276
Get a Media Portal Route data 279
Get all domains and locations in the
system 280
Get all existing configured Media Portal
IP addresses 277
Get all Media Portal Groups 277
Get all Media Portal Routes 280
Get available domains and locations not
assigned to any MP Group 277
Modify a Media Portal Group 275
Modify a Media Portal Route 278
Modify domain locations by Media
Portal Group 280
Modify domain locations by Route
Name 281
Remove a Media Portal Group 276
Remove a Media Portal Route 279
Remove multiple Media Portal
Groups 276
Remove multiple Media Portal
Routes 279
Node operations 200
Add a node 201
Add a single logical entity 204
Add multiple logical entitys 205
Add multiple nodes 202
Add node to root domains 207
Assign node to sub domains 207
Get a Logical Entity 206
Get a node 203
Get All Logical Entitys 206
Get all node names for sub
domains 208
Get all Node Type Names 201
Get all Nodes 204
Get all Nodes for the root domain 209
Get all Routable Service Groups 209
Get all Routing Algorithms 209
Get Logical Entity Count 207
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Index 427
Get node count 204
Get root domains for a node 208
Get sub domains for a node 208
Modify a Logical Entity 205
Modify a node 202
Remove a Logical Entity 206
Remove a node 203
Parm Definition 293
Add Parm Definition 295
Assign Parm Definition To Owner 296
Get all Parm Definition Data (future
method) 295
Get all Parm Definitions 294
Get all Parm Definitions By Owner 294
Get all Parm Owners 294
Get all Parm Types 293
Get all Parm Validation Types (future
method) 294
Get Parm Definition By Name 295
Remove Parm Definition 296
Remove Parm Definition To Owner 296
Password policy operations 291, 291
Add a Password Policy 292
Get all Password Policies 291
Modify a Password Policy 292
Remove a Password Policy 293
Pool Management 210
Assign Node to Domain Routable
Service 213
Assign Node to Location Routable
Service 213
Assign Node to Location Routable
Services 213
Get All Locations By Service Group 212
Get all Nodes By Routable Service 210
Get all Nodes By Routable Service
Groups 211
Get Assigned Domain Routing
Node 211
Get Assigned Location Routing
Node 211
Get Routing Locations By Service
Group 212
Pooled entity 186
Add branding file to a pooled
resource 190
Add branding files 191
Add Music on Hold folder to a pooled
resource 187
Add Music on Hold folders 187
Add treatment file to a pooled
resource 194
Add treatment files to a pooled
resource 195
Add treatment group to a pooled
resource 195
Assign a pooled resource with
treatment group to a domain 196
Assign branding files and pooled
resource to domain 191
Assign Music on Hold folder and pooled
resource to domain 187
Branding 190
Get all branding files for a pooled
resource 192
Get all treatment files for a pooled
resource 197
Get all treatment groups in a
domain 197
Get branding object 192
Get Music on Hold folders 188
Get names of all treatment files that
are available in a group 197
Get names of all treatment groups in a
domain 196
Get names of all treatment reasons
available in a domain 198
Get the assigned branding pool for a
domain 192
Get the assigned Music on Hold
folder 188
Get the assigned Music Pool 188
Get the assigned treatment pool in a
domain 197
Get the available branding files for a
domain and pool 193
Modify treatment group parameters
for a pooled resource and
domain 198
Music on Hold 186
Remove a branding file in a pooled
resource 193
Remove a treatment file in a pooled
resource 199
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
428 Index
Remove a treatment group in a
domain 199
Remove all branding files in a pooled
resource 193
Remove All Music On Hold Folders 189
Remove all treatment files in a pooled
resource 200
Remove Music On Hold Folder 189
Rename Music On Hold Folder 189
Services 186
Treatment 194
Release, Version Information 297
Get the current version of OPI 297
Get the name of the current release 297
Get the versions of OPI supported 297
Resource Management 281
Add Domain Resource 281
Get Domain Resource by Service
Name 283
Get Domain Resources 283
Modify Domain Resource 282
Remove All Domain Resources 282
Remove Domain Resource By
Service 282
Routable service parameter 216
Get Alias Service Parms for a
Service 217
Get Domain Service Parms for a
Service 217
Get Location Service Parms for a
Service 217
Set Domain Service Parms for a
Service 218
Set Location Service Parms for a
Service 218
Routable services parameter 219
Service operations 176
Add a service package 177
Add services to a domain 181
Add services to multiple domains 182
Assign service package to domain 180
Get a service package in a domain 178
Get all acceptable values for given
parameter 184
Get all service names 183
Get all service packages in a
domain 178
Get all services assigned to a
domain 181
Get default service package assigned
to a domain 180
Get Parameter Display Name By
Parameter Name 185
Get Parameter Name By Parameter
Display Name 185
Get parameter names for a service 184
Get parameter names for all
services 184
Get Service Display Name By Service
Name 185
Get Service Name By Service Display
Name 186
Modify a service package 178
Modify services assigned to a
domain 182
Modify services of multiple
domains 182
Modify the acceptable parameter
values for a service 183
Remove a service package 179
Remove all services assigned to a
domain 181
Remove multiple service packages 179
Service Package Operations 177
Set a parameter value as default value
for a service 183
Set a service package as default 180
SIP Lines 302
Get Domains By VMG 303
Get SIP Line Audit Data By Domain 303
Get SIP Line Audit Data By Domain
And VMG 303
Get SIP Line Audit Data By
EndpointId 302
Get SIP Line Audit Data By
UserName 302
Get Users By Registration State 304
Get Users By Registration State And
Client Type 304
Get VMGs for Domain 303
Telephony Routes Operations 225
Telephony Routes operations
Add a new Number Qualifier 227
Add a new Telephony route 232
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Index 429
Add a route list 236
Add Direct To Gateway service prefix
for a domain 240
Add multiple new Number
Qualifiers 227
Add multiple route list 236
Add multiple Telephony routes 233
Get a route list by Class Of Service 239
Get a route list by name 239
Get a telephony route 236
Get a telephony route in a domain 235
Get all Number Qualifiers for a
domain 228
Get Direct To Gateway service prefix
for a domain 241
Get route list actions 240
Get route lists by domain 239
Get telephony route types 235
Get translation destinations 240
Modify a Number Qualifier 228
Modify a route list 237
Modify a telephony route 234
Number Qualifier Operations 226
Pre-translation Operations 229, 229,
230, 230, 231, 231, 231
Remove a Number Qualifier 228
Remove a route list 237
Remove a telephony route 234
Remove a telephony route from route
list 238
Remove all Number Qualifiers for a
domain 229
Remove all telephony routes from a
route list 238
Remove Direct To Gateway service
prefix for a domain 241
Remove multiple route lists 238
Remove multiple telephony routes 235
Time zone operations 268
Add a Time Zone 270
Get a Time Zone by ID 268
Get a Time Zone by name 269
Get all Time Zone IDs 269
Get all Time Zones 269
Modify a Time Zone 270
Remove a Time Zone 270
User
Get all presence notes for a user 117
Get all reasons for a user 115
Get all subjects for a user 114
Get user data for a user 116
Modify presence notes for a user 116
Modify reasons for a user 114
Modify subjects for a user 113
Modify user data for a user 115
Remove all presence notes for a
user 116
Remove all reasons for a user 114
Remove all subjects for a user 113
Remove user data 115
User Data Operations 113
User Operations 112, 140, 140, 141,
157, 167, 168
Activate routes for a user 123
Add a Client Type 144
Add a new route for a user 124
Add a new Time Block Group for
user 119
Add a single user 158
Add assistants for a user 150
Add Converged Desktop data for a
user 141
Add Direct to Gateway service prefix
for a user 169
Add Meet Me Conferencing data for a
user 138
Add Mobile converged audio device
prefix for a user 143
Add multiple Client Types 145
Add multiple routes for a user 125
Add multiple users 159
Add static routes for a user 133
Add Time Block Groups user 120
Add voicemail server for user 167
Assistant Support operations 149
Change User Password 161
Client Type Information 144
Converged Desktop 141
Deactivate routes for a user 128
Delete call logs with the provided call
ids 118
Determine if an assistant is provisioned
for a user 151
Generate CPL for a user 134
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
430 Index
Get a Client Type by name 146
Get a single user 161
Get All Client Types 146
Get all detailed user preferences 136
Get all incoming user call logs 118
Get all outgoing user call logs 118
Get all user call logs 117
Get all user preferences 136
Get clientRedirectServlet login
authorization 170
Get Converged Desktop data for a
user 143
Get CPL for a user 135
Get Direct to Gateway service prefix for
a user 169
Get Meet Me Conferencing data for a
domain 140
Get Meet Me Conferencing data for a
user 139
Get Mobile converged audio device
prefix for a user 143
get SIP Line Data 147
Get SIP Line Data by domain 148
Get SIP Line data by domain and
vmg 148
Get SIP Line Data for a user by user
name 148
Get static routes for a user 132
Get subdomain for a user 165
Get User Count for the actual Sub
Domain 166
Get User Count for the domain 166
Get user count in actual
(sub)domain 164
Get user count in Domain tree 164
Get username by Directory
Number 163
Get username by End Point Id 149
Get Users by alias 166
Get users by name in a domain 162
Get users by status 163
Get users in a domain 162
Get Users Service Package 135
Get Users with no Meet Me
Conferencing data, for a
domain 140
Get voicemail server for user 168
Logout all user contacts 170
Modify a Client Type 145
Modify a route for a user 130
Modify a single user 160
Modify all preferences for a user 137
Modify Converged Desktop data for a
user 142
Modify Meet Me Conferencing data for
a user 138
Modify Preference for a service for a
user 136
Modify priority of assisted users for an
assistant 151
Modify Time Block Group for a user 121
Modify user static routes for a user 133
Modify users voicemail server 167
Move all users from one domain to
another domain 165
Move User from one domain to another
domain 164
Move Users from one domain to
another domain 165
Remove a Client Type 146
Remove a particular route for a
user 133
Remove a single user 161
Remove a Time Block Group for a
user 120
Remove all assistants for a user 153
Remove all assisted users for an
assistant 152
Remove all preferences for a user 137
Remove all routes for a user 132
Remove all static routes for a user 132
Remove all Time Block Groups for a
user 121
Remove assistants for a user 152
Remove assisted users for an
assistant 152
Remove Converged Desktop data for a
user 142
Remove Direct to Gateway service
prefix for a user 169
Remove Meet Me Conferencing data
for a user 139
Remove Mobile converged audio
device prefix for a user 144
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Index 431
Add a Trunk Voicemail Server 247
Remove multiple users 162
Add a Voicemail Server Host 242
Remove SIP Line data for a user 149
Get all Line Voicemail Server 253
Remove user picture 163
Get all SIP Voicemail Servers 246
Remove voicemail server for user 168
Get all SIP Voicemail Servers for a
Reorder routes for a user 134
domain 246
Retrieve a particular route for a
Get all Trunk Voicemail Servers of a
user 129
particular trunk type 249
Retrieve a Time Block Group for
Get all users for Voicemail Server 254
user 122
Get all Voicemail Server Host
Retrieve all assistants for a user 150
Types 244
Retrieve all route names for a user 129
Get all Voicemail Server Hosts 244
Retrieve all route parameter
Get all Voicemail Servers 253
names 129
Retrieve all routes for a user 130
Get all Voicemail Servers for a
Retrieve all Time Block Groups for
domain 254
user 122
Get Line Voicemail Servers for a
Retrieve assistants for a user by
domain 253
assistant type 150
Get Trunk Voicemail Servers by
Retrieve assisted users ordered by
domain 249
priority for an assistant 151
Get Voicemail Servers Host 243
Retrieve users from the users domain
Modify a Line Voicemail Server 251
that have a matching first and last
Modify a SIP Voicemail Server 245
name 154, 156
Modify a Trunk Voicemail Server 248
Retrieve users from the users domain
Modify a Voicemail Server Host 243
that have a matching first
Remove a Line Voicemail Server 253
name 154, 156
Remove a SIP Voicemail Server 246
Retrieve users from the users domain
Remove a Trunk Voicemail Server 249
that have a matching last
Remove a Voicemail Server Host 243
name 154, 156
Branding 192
Retrieve users from the users domain
error codes 385
that have a matching phone
file 190, 191, 191, 192, 193, 193, 193
number 155, 157
pool 192
Retrieve users from the users
domain that have a matching
username 155, 157
call
Route operations 122
incoming
Set routes to active for a user 134
logs 331
Set SIP Line Data 147
logs 331, 331
User call logs 117
outgoing
User Meet Me 137
logs 331
User Search 153
Call Processing Language (CPL) 134, 135
User Service Operations 135
changeAdminPassword 175
User SIP Line Data 144
changePassword 315
User Time operation 119
changeUserPassword 161
Voice mail operations 241
Class of Service
Add a Line Voicemail Server 250
domain 87, 87, 88
Add a SIP Voicemail Server 244
C
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
432 Index
location 220, 220, 221, 221, 222, 222,
222, 225, 225
Media Portal 280, 280
Meet Me 140, 140
Music on Hold 187, 187, 187, 188, 188,
188, 189, 189, 189
node 207, 207, 208, 208, 208, 209
number qualifier 228, 229
Out of Band REFER Access Codes 96,
96, 97, 97
parent
100
Data access
pre-translator 231
error codes 341
profile 88, 88, 89, 89
deactivateRoutes 128, 326
resource 281, 282, 282, 282, 283
deleteCallLogs 118, 331
root 97, 99, 101, 103
deletePhysicalIPCM 112
routable service 216
deleteRoutableServiceAlias 216
route 281
device 108, 108
route list 239
domain 104, 105, 106, 106, 107, 107,
service 180, 181, 181, 181, 182, 182,
107, 108
182, 215, 215, 215, 217, 217, 217,
error codes 362
218, 218, 219, 283
sub domain 109
service
package 177, 178, 178, 178,
Directories
179,
179, 180, 180
error codes 343
SIP
Line
303, 303
domain 98, 98, 99, 99, 100, 103, 104, 148,
status reason 84, 85, 85, 86, 86, 86
148, 280, 281, 283
sub domain 98, 99
Alias Service
telephony route 235
Set Alias Service Parms for a
Treatment 194, 195, 195, 196, 196, 197,
Service 219
199, 200
ANI 225
Treatment
group 197, 197, 198, 198, 199
ANI list 224
Treatment
pool 197
banned subscriber 90, 90, 91, 91, 92, 92
user
159,
162, 162, 162, 164, 164, 164,
Branding 190, 191, 191, 192, 192, 192,
165, 165, 165, 166, 166
193, 193, 193
voice
mail 254, 303, 303, 303
child 100, 103
voice
mail server 246, 249, 253
Class of Service 87, 87, 88
Domain
Converged Desktop 93, 93, 94, 94, 95,
error codes 357
95, 95
device 104, 105, 106, 106, 107, 107, Domain bulletins
error codes 359
107, 108, 109
Domain
Class of Service 87
foreign 101, 102, 102, 102
error
codes
363
group 298, 298, 299, 299, 299, 299, 300
Domain CLI
IPCM 111, 111
LDAP 285, 285, 286, 287, 287, 287, 288, error codes 417
288, 288, 289, 289, 289, 290, 290, Domain local
error codes 364
290, 291
Domain profile
locale 81, 81, 82, 82, 82, 83, 83, 83
error codes 364
route 239
Click to call
error codes 381
clickToCall 336
Converged Desktop 94, 95, 95, 95, 141,
141, 142, 142, 143, 143, 143, 144
domain 93, 93, 94
error codes 404
D
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Index 433
E
E911
getLocationList 333
Emergency
alias 272
error codes 393
alias list 273
number 271, 271, 272, 272, 272
Response Location 223, 223, 223, 224
error codes 391
Emergency numbers
error codes 393
Emergency Response Location (ERL) 223,
223, 223, 224
error codes 391
Error codes
000000 341
001000 343
002000 344
003000 348
004000 350
004100 355
004150 356
004200 356
005000 357
006000 359
007000 359
008000 359
009000 360
010000 362
011000 363
012000 364
013000 364
014000 365
015000 365
016000 367
017000 368
018000 368
019000 368
020000 369
024000 369
025000 372
026000 375
027000 378
028000 379
029000 380
030000 380
032000 381
033000 381
034000 383
035000 384
036000 384
037000 384
038000 385
039000 386
040000 387
041000 389
042000 389
043000 391
044000 393
045000 393
046000 394
046100 395
047000 398
048000 400
049000 400
050000 402
051000 404
052000 405
055000 408
056000 409
057000 410
058000 410
059000 410
060000 414
061000 415
062000 416
063000 416
064000 417
070000 418
072000 418
089000 418
099000 420
099999 421
Address book 344
Address book group 359
Admin and role 414
Assistant 387
authorization 420
Auto ID 400
Banned subscriber 359
Branding 385
Click to call 381
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
434 Index
Converged Desktop 404
Data access 341
Device 362
Directories 343
Domain 357
Domain bulletins 359
Domain Class of Service 363
Domain CLI 417
Domain locale 364
Domain profile 364
Emergency
numbers 393
Emergency alias 393
ErlInfo 391
Foreign domain 365
Gateway 369
generic 421
Global Address Book 365
Global address book 410
Group 418
Interworking domain 409
IPCM 367
LDAP 400
location 389
Media Portal Group 395
Media Portal Routability Group 398
Meet Me audio conferencing 394
Music on Hold 384
Network call logs 368
Number qualifier 379
Out of band REFER 416
Parm Definition 415
password policy 408
Personal Address Book 368
Phone number 368
Pooled Entity 402
Prefix error codes and messages 356
Presence 418
Presence condition 380
Reserved addresses 384
Resource management 360
Resource management exceptions 355
Ringback 416
Route 369
Service 372
Service node 410
SMPP 409
SMS 409
SOPI 356
Status reason 378
system-specific 420
Telephony route 375
Time block group 380
Time zone 380
Translation tool 418
Treatment 386
Trunk 369
User data 381
User operation 350
User picture 389
User properties 384
user service package 348
User time 381
Voicemail 383
voicemail 410
Voicemail server provisioning 405
F
Foreign Domain
error codes 365
G
gateway
user 169, 169, 169, 170
Gateway
error codes 369
generateCPL 134
Generic exceptions 421
Get a Password Policy by name 291
Get user presence 141
Get user watchers list 140
getAddressBook 261, 319
getAddressBookEntry 266, 319
getAddressBookGroups 264, 322
getAddressBookWithPhoto 267, 320
getAdmin 174
getAliasesForExpressMsging 305
getAliasesForMsgRetrieval 305
getAliasInfoByService 215
getAliasServiceParms 217
getAllAdmins 175
getAllAssistantsForUser 150
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Index 435
getAllAvailableLocationsByServicegetAllVoicemailServersByDomain 254
Group 212
getAniList 224
getAllChildrenAdmins 175
getAssignedBrandingPool 192
getAllChildrenDomainNames 103
getAssignedIPCMs 111
getAllDetailedUserPreferences 136
getAssignedMusicOnHoldFolder 188
getAllDomainCos 87
getAssignedMusicOnHoldPool 188
getAllDomainLocations 280
getAssignedNodeByDomainByServicegetAllDomainProfiles 88
Group 211
getAllDomains 99
getAssignedNodeByLocationByServicegetAllEmergencyNumbers 272
Group 211
getAllGroupsForDomain 300
getAssignedTreatmentPool 197
getAllGroupTypes 301
getAssistantsForUserByType 150
getAllLineVoicemailServers 253
getAssistantTypes 305
getAllLocationsForNodeByServicegetAssistedUsers 151, 335
Group 212
getAvailableBrandingFiles 193
getAllLogicalEntitys 206
getAvailableDomainLocations 277
getAllMediaPortalGroups 277
getAvailableLocales 82
getAllMediaPortalResourceIPs 277
getAvailableTreatmentFiles 197
getAllMpRoutabilityGroups 280
getAvailableTreatmentReasons 198
getAllNodeNamesForDomain 208
getBannedSubscribersByDomain 91
getAllNodesByRoutableService 210
getBannedUser 334
getAllNodesByRoutableServiceGroup 211 getBannedUsers 263
getAllNodeTypeNames 201
getBanServiceOptionNames 91
getAllParmDefinitions 294
getBranding 192
getAllParmOwners 294
getBrandingFiles 192
getAllParmTypes 293
getBuddies 261, 320
getAllParmValidationTypes 294
getCallLogs 117, 331
getAllPasswordPolicies 291, 291
getChairAccessURL 305, 330
getAllRights 173
getChildrenDomains 100
getAllRootDomainNames 103
getClientRedirectLogin 170
getAllRootDomainParms 99
getConfDialUpNumbers 305, 330
getAllRoutableServiceGroups 209
getConvDesktopServiceData 94
getAllRoutableServices 209
getConvDesktopUserData 143, 143
getAllRouteParmNames 129, 326
getCPL 135
getAllRoutingAlgorithms 209
getCurrentDevices 108
getAllServiceNames 183
getCurrentOPIVersion 297
getAllSIPVoicemailServers 246
getCurrentSOPIVersions 336
getAllSIPVoicemailServersByDomain 246 getDefaultDomainLocale 82
getAllStatusNames 85
getDefaultServicePackageByDomain 180
getAllSubDomainParms 99
getDeprecatedLocations 225
getAllTimeZoneIds 269
getDestinations 240
getAllTimeZones 269, 332
getDevice 107
getAllTrunkVoicemailServers 249
getDeviceByMacAddress 108
getAllUserPreferences 136, 328
getDevices 107
getAllVoicemailServerHosts 244
getDevicesInDomain 108
getAllVoicemailServerHostTypes 244
getDirectToGWPrefixData 241
getAllVoicemailServers 253
getDomain 100
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
436 Index
getDomainLocales 82
getDomainNodes 209
getDomainParmValues 99
getDomainProfile 88
getDomainResourceByService 283
getDomainResourcesByDomain 283
getDomainRoutingServiceParms 217
getDomains 103
getDomainsForVMG 303
getEmergencyAlias 272
getErl 223
getForeignDomain 102
getFullAddressBookEntry 267, 320
getGroup 299
getGroupByUsername 300
getGroupsByUsersByType 301
getIncomingCallLogs 118, 331
getIPCM 110
getIPCMAvailCapacity 111
getIPCMCapacityByDomain 111
getLdapInfo 289
getLdapSchema 289
getLdapsyncFilterCriteria 290
getLdapTimeBlock 290
getLdapUserDefaults 290
getLicenseKeyUsage 284
getLightWeightAddressBook 267, 320
getLineVoicemailServerByDomain 253
getLocation 222
getLocationList 333
getLocationRoutingServiceParms 217
getLocations 222
getLocationsByParent 222
getLogicalEntity 206
getLogicalEntityCount 207
getMediaPortalGroupByName 276
getMeetMeConfData 139, 330
getMeetMeConfDataByDomain 140
getMpRoutabilityGroupByName 279
getMusicOnHoldFolders 188
getNode 203
getNodeCount 204
getNodeDomains 208
getNodes 204
getNodeSubDomains 208
getNotesByUserName 117, 317
getNumberOfDomains 104
getNumberQualifiers 228
getOOBReferAccessCodesByDomain 97
getOutgoingCallLogs 118, 331
getParameterDisplayNameByParameterName 185, 329
getParameterNameByParameterDisplayName 185, 329
getParentDomain 100
getParmDefinitionByName 295
getParmDefinitionByOwner 294
getParmDefinitionDataForParm 295
getParmNamesByService 184
getParmNamesForAllServices 184
getPasswordPolicy 291
getPasswordPolicyDescription 332
getPreTranslators 230
getRejectReasonsByUserName 115, 317
getReleaseName 297
getRole 172
getRoles 173
getRootDomain 101
getRoutableServiceAliases 215
getRoutableServiceAliasInfo 215
getRoute 129, 326
getRouteListActions 240
getRouteListByClassOfService 239
getRouteListByDomain 239
getRouteListByName 239
getRouteNames 129, 326
getRoutes 130, 326
getServiceDisplayNameByServiceName 185, 329
getServiceNameByServiceDisplayName 186, 329
getServicePackage 178
getServicePackagesByDomain 178
getServiceParmValues 184
getServicesByDomain 181
getSIPLineAuditData 302
getSIPLineAuditDataByDomain 303
getSIPLineAuditDataByDomainByVMG 303
getSIPLineAuditDataByUserName 302
getSIPLineData 147, 147
getSIPLineDataByDomain 148
getSIPLineDataByDomainByVMG 148
getSIPLineDataByUserName 148
getStaticRoutesByUserName 132
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Index 437
getStatusReasonsByDomain 85
getSubDomainForDevice 109
getSubDomainForUser 165
getSubjectsByUserName 114, 317
getSupportedOPIVersions 297
getSupportedSOPIVersions 337
getSysRoles 172
getSystemLocalesList 332
getTelephonyRoute 236
getTelephonyRoutesByDomain 235
getTelephonyRouteTypes 235
getTimeBlockGroupByName 122, 316
getTimeBlockGroupsByUser 122, 316
getTimeZoneByID 268
getTimeZoneByName 269
getTreatmentFiles 197
getTreatmentGroupNames 196
getTreatmentGroups 197
getTrunkVoicemailServerByDomain 249
getUser 161
getUserByDN 163
getUserByEndPointId 149
getUserCountInDomain 164, 166
getUserCountInSubDomain 164, 166
getUserData 116, 317
getUserDirectToGWPrefixData 169
getUserGroups 301
getUserMCPrefixData 143, 143
getUserPersonalData 315
getUserPicture 306, 333
getUserPresence 141
getUsersByAlias 166
getUsersByDomain 162
getUsersByGroup 300
getUsersByName 162
getUsersByRegistrationState 304
getUsersByRegStateAndClientType 304
getUsersByStatus 163
getUserServicePackage 135, 328
getUsersForVoicemailServer 254
getUsersVoicemailServer 168
getUsersWithNoMeetMeData 140
getUserWatchers 140
getValidAniRegTimes 225
getVMGForDomain 303
getVoicemailServerHost 243
getWebCollabURL 305, 330
Global address book 321, 322, 322, 322,
322, 322, 322, 323, 323, 323, 323,
324, 324, 324, 324, 324, 324
error codes 410
Global Address Book
error codes 365
group
domain 298, 298, 299, 299, 299, 299,
300
user 300, 300, 300, 301, 301, 301, 301,
301
Group
error codes 418
I
Interworking domain
error codes 409
IPCM 109, 110, 110, 110, 111, 111, 111,
112
error codes 367
isAssistantForUser 151
K
keycode 284
L
LDAP
data 285
domain 285, 285, 286, 287, 287, 287,
288, 288, 288, 289, 289, 289, 290,
290, 290, 291
error codes 400
filter 287, 289, 290
info 287
schema 285, 288
synchronization 291
time block 286, 288, 290
user 287, 288
user default 290
license key 284
Locales 332
location 220, 220, 221, 221, 222, 222, 222
Location
error codes 389
logical entity 204, 205, 205, 206, 206, 206,
207
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
438 Index
logoutUserFromDevice 336
logs
call 117, 118, 118, 118
modifyGroup 299
modifyIPCM 110
modifyLineVoicemailServer 251
modifyLocation 221
modifyLogicalEntity 205
modifyMediaPortalGroup 275
makeBuddy 268, 320
modifyMeetMeConfUser 138, 330
Media Portal
modifyMpRoutabilityGroup 278
domain 280, 280
modifyNode 202
domains 277
group 274, 274, 275, 276, 276, 276, 277,modifyNumberQualifier 228
modifyOOBReferAccessCodes 96
277, 279, 280, 280
modifyPasswordPolicy 292, 292
IP address 277
modifyPreTranslator 231
locations 277
route 277, 278, 278, 279, 279, 279, 280 modifyRole 171
modifyRoutableServiceAlias 214
Media Portal Group
modifyRoute 130, 326
error codes 395
modifyRouteList 237
Media Portal Routability Group
modifyServicePackage 178
error codes 398
modifyServiceParm 183
Meet Me
modifyServicesToDomains 182
user 138, 138, 139, 139, 140, 140
modifySIPVoicemailServer 245
Meet Me audio conferencing
modifyStatusReason 86
error codes 394
modifyTimeBlockGroup 121, 316
Meet Me conference
modifyTimeZone 270
user 330, 330, 330, 330, 331
modifyTreatmentGroup 198
modify User Preferences 136
modifyTrunkVoicemailServer 248
modifyAddressBookEntries 258, 320
modifyUser 160
modifyAddressBookEntry 258, 320
modifyUserData 115, 317
modifyAddressBookGroups 265, 322
modifyUserNotes 116, 317
modifyAdmin 174
modifyUserPersonalData 315
modifyAllUserPreferences 137, 328
modifyUserPicture 306, 334
modifyAssistedUserOrder 151
modifyUserPreferences 328
modifyBannedUser 262, 335
modifyUserReasons 114, 317
modifyConvDesktopServiceData 93
modifyUserStaticRoutes 133
modifyConvDesktopUserData 142, 142
modifyUserSubjects 113, 318
modifyDevice 106
modifyUsersVoicemailServer 167
modifyDomain 98
modifyVoicemailServerHost 243
modifyDomainCos 87
moveAllUsers 165
modifyDomainLocales 83
modifyDomainLocationsByMPGroup 280 moveUser 164
modifyDomainLocationsByRTGroup 281 moveUsers 165
Music on Hold
modifyDomainProfile 89
Error codes 384
modifyDomainResource 282
folder 187, 187, 187, 188, 188, 189, 189,
modifyDomainServices 182
189
modifyErl 223
pool
188
modifyForeignDomain 102
M
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Index 439
N
name 329
Network call logs
error codes 368
node 201, 202, 202, 203, 203, 204, 204,
210, 211, 211, 211, 212, 212, 213,
213, 213
domain 207, 208, 208, 209
sub domain 207, 208
type 201
number qualifier 227, 227, 228, 228, 229
domain 228
Number qualifier
error codes 379
O
OIP
User
assignUserDirectToGWPrefixData 169
getClientRedirectLogin 170
getUserCountInDomain 166
getUserCountInSubDomain 166
getUserDirectToGWPrefixData 169
getUsersByAlias 166
removeUserDirectToGWPrefixData 169
removeUsersVoicemailServer 168
sendUnRegister 170
OPI
Address book 254
addAddressBookEntries 257
addAddressBookEntry 256
addAddressBookGroup 264
addAddressBookGroups 264
addBannedUser 262
addBannedUsers 262
addUsersToAddressBook 266
getAddressBook 261
getAddressBookEntry 266
getAddressBookGroups 264
getAddressBookWithPhoto 267
getBannedUsers 263
getBuddies 261
getFullAddressBookEntry 267
getLightWeightAddressBook 267
makeBuddy 268
modifyAddressBookEntries 258
modifyAddressBookEntry 258
modifyAddressBookGroups 265
modifyBannedUser 262
removeAddressBook 260
removeAddressBookEntries 259
removeAddressBookEntry 260
removeAddressBookGroup 265
removeAllBannedUsers 263
removeBannedUser 263
removeBuddy 261
removeUserAddressBook 260
renameAddressBookGroup 265
addUserPicture 306
Admin 170
addAdmin 173
addRole 171
changeAdminPassword 175
getAdmin 174
getAllAdmins 175
getAllChildrenAdmins 175
getAllRights 173
getRole 172
getRoles 173
getSysRoles 172
modifyAdmin 174
modifyRole 171
removeAdmin 174
removeRole 172
resetAdminPassword 176
Role 170
Alias routing 214
deleteRoutableServiceAlias 216
getAliasInfoByService 215
getRoutableServiceAliases 215
getRoutableServiceAliasInfo 215
modifyRoutableServiceAlias 214
Device 104
addDevice 104
addDevices 105
getCurrentDevices 108
getDevice 107
getDeviceByMacAddress 108
getDevices 107
getDevicesInDomain 108
getSubDomainForDevice 109
modifyDevice 106
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
440 Index
removeDevice 106
removeDevices 107
Domain 80
addBannedSubscriber 90
addBannedSubscribers 90
addConvDesktopServiceData 93
addDomainLocale 81
addDomainLocales 81
addForeignDomain 101
addOOBReferAccessCodes 96
addRootDomain 97
addStatusReason 84
addStatusReasons 85
addSubDomain 98
assignDomainMCPrefixData 95
Banned Subscriber 89
Converged Desktop 92
Domain COS 87
Domain Local 81
Domain Profile 88
getAllChildrenDomainNames 103
getAllDomainCos 87
getAllDomainProfiles 88
getAllDomains 99
getAllRootDomainNames 103
getAllRootDomainParms 99
getAllStatusNames 85
getAllSubDomainParms 99
getAvailableLocales 82
getBannedSubscribersByDomain 91
getBanServiceOptionNames 91
getChildrenDomains 100
getConvDesktopServiceData 94
getDefaultDomainLocale 82
getDomain 100
getDomainLocales 82
getDomainParmValues 99
getDomainProfile 88
getDomains 103
getForeignDomain 102
getNumberOfDomains 104
getOOBReferAccessCodesByDomain 97
getParentDomain 100
getRootDomain 101
getStatusReasonsByDomain 85
modifyConvDesktopServiceData 93
modifyDomain 98
modifyDomainCos 87
modifyDomainLocales 83
modifyDomainProfile 89
modifyForeignDomain 102
modifyOOBReferAccessCodes 96
modifyStatusReason 86
removeAllBannedSubscribers 92
removeAllStatusReasons 86
removeBannedSubscriber 91
removeBannedSubscribers 92
removeConvDesktopServiceData 94,
95, 95
removeDomain 98
removeDomainCos 88
removeDomainLocale 83
removeDomainProfile 89
removeForeignDomain 102
removeOOBReferAccessCodes 97
removeStatusReason 86
setDefaultDomainLocale 83
Status Reasons 84
Emergency number 271
addEmergencyNumber 271
addEmergencyNumbers 271
getAllEmergencyNumbers 272
getEmergencyAlias 272
removeAllEmergencyNumbers 272
removeEmergencyNumber 272
updateEmergencyAlias 273
getAliasesForExpressMsging 305
getAliasesForMsgRetrieval 305
getAssistantTypes 305
getChairAccessURL 305
getConfDialUpNumbers 305
getUserPicture 306
getWebCollabURL 305
Groups 297
addGroup 298
addGroups 298
assignGroupsToUser 300
getAllGroupsForDomain 300
getAllGroupTypes 301
getGroup 299
getGroupByUsername 300
getGroupsByUsersByType 301
getUserGroups 301
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Index 441
getUsersByGroup 300
modifyGroup 299
removeAllUserGroups 301
removeGroup 299
removeGroupByUser 301
removeGroups 299
IPCM 109
addIPCM 109
deletePhysicalIPCM 112
getAssignedIPCMs 111
getIPCM 110
getIPCMAvailCapacity 111
getIPCMCapacityByDomain 111
modifyIPCM 110
removeIPCM 110
LDAP 284
addLdapInfo 285
addLdapSchema 285
addLdapTimeBlock 286
addLdapUserDefaults 287
getLdapInfo 289
getLdapSchema 289
getLdapsyncFilterCriteria 290
getLdapTimeBlock 290
getLdapUserDefaults 290
removeLdapInfo 287
removeLdapSchema 288
removeLdapSyncFilterCriteria 289
removeLdapTimeBlock 288
removeLdapUserDefaults 288
setLDAPSyncFilterCriteria 287
startLdapSyncNow 291
License key
getLicenseKeyUsage 284
License key usage 283
Location services 219
addErl 223
addLocation 220
addLocations 220
getAniList 224
getDeprecatedLocations 225
getErl 223
getLocation 222
getLocations 222
getLocationsByParent 222
getValidAniRegTimes 225
modifyErl 223
modifyLocation 221
purgeDeprecatedLocations 225
removeErl 224
removeLocation 221
Media Portal group 273
addMediaPortalGroup 274
addMediaPortalGroups 274
getAllDomainLocations 280
getAllMediaPortalGroups 277
getAllMpRoutabilityGroups 280
getAvailableDomainLocations 277
getMediaPortalGroupByName 276
getMpRoutabilityGroupByName 279
modifyDomainLocationsByMPGroup 280
modifyDomainLocationsByRTGroup 281
modifyMediaPortalGroup 275
removeMediaPortalGroup 276
removeMediaPortalGroups 276
Media Portal route 273, 280
addMpRoutabilityGroup 277
addMpRoutabilityGroups 278
getAllMediaPortalResourceIPs 277
modifyMpRoutabilityGroup 278
removeMpRoutabilityGroup 279
removeMpRoutabilityGroups 279
modifyUserPicture 306
Node operations 200
addLogicalEntity 204
addLogicalEntitys 205
addNode 201
addNodes 202
assignDomainsToNode 207
assignNodeToSubDomains 207
getAllLogicalEntitys 206
getAllNodeNamesForDomain 208
getAllNodeTypeNames 201
getAllRoutableServiceGroups 209
getAllRoutableServicesBPT 209
getAllRoutingAlgorithms 209
getDomainNodes 209
getLogicalEntity 206
getLogicalEntityCount 207
getNode 203
getNodeCount 204
getNodeDomains 208
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
442 Index
getNodes 204
getNodeSubDomains 208
modifyLogicalEntity 205
modifyNode 202
removeLogicalEntity 206
removeNode 203
Parm Definition 293
addParmDefinition 295
assignParmDefinitionToOwner 296
getAllParmDefinitions 294
getAllParmOwners 294
getAllParmTypes 293
getAllParmValidationTypes 294
getParmDefinitionByName 295
getParmDefinitionByOwner 294
getParmDefinitionDataForParm 295
removeParmDefinition 296
removeParmDefinitionFromOwner 296
Password policy operations 291, 291
addPasswordPolicy 292
getAllPasswordPolicies 291
modifyPasswordPolicy 292
removePasswordPolicy 293
Pool Management 210
assignNodeToDomain 213
assignNodeToLocation 213
assignNodeToLocations 213
getAllAvailableLocationsByServiceGroup 212
getAllLocationsForNodeByServiceGroup 212
getAllNodesByRoutableService 210
getAllNodesByRoutableServiceGroup 211
getAssignedNodeByDomainByServiceGroup 211
getAssignedNodeByLocationByServiceGroup 211
Pooled entity 186
addBrandingFile 190
addBrandingFiles 191
addMusicOnHoldFolder 187
addMusicOnHoldFolders 187
addTreatmentFile 194
addTreatmentFiles 195
addTreatmentGroup 195
assignBranding 191
assignedTreatmentPool 196
assignMusicOnHoldFolder 187
Branding 190
getAssignedBrandingPool 192
getAssignedMusicOnHoldFolder 188
getAssignedMusicOnHoldPool 188
getAssignedTreatmentPool 197
getAvailableBrandingFiles 193
getAvailableTreatmentFiles 197
getAvailableTreatmentReasons 198
getBranding 192
getBrandingFiles 192
getMusicOnHoldFolders 188
getTreatmentFiles 197
getTreatmentGroupNames 196
getTreatmentGroups 197
modifyTreatmentGroup 198
Music on Hold 186
removeAllBrandingFiles 193
removeAllMusicOnHoldFolders 189
removeAllTreatmentFiles 200
removeBrandingFile 193
removeMusicOnHoldFolder 189
removeTreatmentFile 199
removeTreatmentGroup 199
renameMusicOnHoldFolder 189
Services 186
Treatment 194
release 297
Release, Version Information 297
getCurrentOPIVersion 297
getReleaseName 297
getSupportedOPIVersions 297
Resource 281
getDomainResourceByService 283
getDomainResourcesByDomain 283
modifyDomainResource 282
removeAllDomainResources 282
removeDomainResource 282
setDomainResource 281
Routable service 216
getAliasServiceParms 217
getDomainRoutingServiceParms 217
getLocationRoutingServiceParms 217
setAliasServiceParms 219
setDomainRoutingServiceParms 218
setLocationRoutingServiceParms 218
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Index 443
Service 176
addServicePackage 177
addServicesToDomain 181
addServicesToDomains 182
assignPackage 180
getAllServiceNames 183
getDefaultServicePackageByDomain 180
getParameterDisplayNameByParameterName 185
getParameterNameByParameterDisplayName 185
getParmNamesByService 184
getParmNamesForAllServices 184
getServiceDisplayNameByServiceName 185
getServiceNameByServiceDisplayName 186
getServicePackage 178
getServicePackagesByDomain 178
getServiceParmValues 184
getServicesByDomain 181
modifyDomainServices 182
modifyServicePackage 178
modifyServiceParm 183
modifyServicesToDomains 182
removeServicePackage 179
removeServicePackages 179
removeServicesByDomain 181
Service Package 177
setDefaultServicePackageToDomain 180
setServiceParmAsDefault 183
SIP Lines 302
getDomainsForVMG 303
getSIPLineAuditData 302
getSIPLineAuditDataByDomain 303
getSIPLineAuditDataByDomainByVMG 303
getSIPLineAuditDataByUserName 302
getUsersByRegistrationState 304
getUsersByRegStateAndClientType 304
getVMGForDomain 303
Telephony route 225
Telephony routes
addNumberQualifier 227
addNumberQualifiers 227
addRouteList 236
addRouteLists 236
addTelephonyRoute 232
addTelephonyRoutes 233
assignDirectToGatewayPrefixData 240
getDestinations 240
getDirectToGWPrefixData 241
getNumberQualifiers 228
getRouteListActions 240
getRouteListByClassOfService 239
getRouteListByDomain 239
getRouteListByName 239
getTelephonyRoute 236
getTelephonyRoutesByDomain 235
getTelephonyRouteTypes 235
modifyNumberQualifier 228
modifyPreTranslator 231
modifyRouteList 237
modifyTelephonyRoute 234
Number qualifier 226
Pre-translation 229, 229, 230, 230,
231, 231
removeAllNumberQualifiers 229
removeAllTelephonyRoutesFromRouteList 238
removeDirectToGWPrefixData 241
removeNumberQualifier 228
removeRouteList 237
removeRouteLists 238
removeTelephonyRoute 234
removeTelephonyRouteFromRouteList 238
removeTelephonyRoutes 235
Time Zone 268
addTimeZone 270
getAllTimeZones 269
getTimeZoneByID 268
getTimeZoneByName 269
modifyTimeZone 270
removeTimeZone 270
ZoneIds 269
User 112, 141, 141, 142, 142, 143, 143,
143, 144
activateRoutes 123
addAssistants 150
addClientType 144
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
444 Index
addClientTypes 145, 145
addMeetMeConfUser 138
addRoute 124
addRoutes 125
addTimeBlockGroup 119
addTimeBlockGroups 120
addUser 158
addUserStaticRoutes 133
addUsersToDomain 159
addUsersVoicemailServer 167
Assistant Support 149
changeUserPassword 161
Client Type Information 144
deactivateRoutes 128
deleteCallLogs 118
generateCPL 134
getAllAssistantsForUser 150
getAllDetailedUserPreferences 136
getAllRouteParmNames 129
getAllUserPreferences 136
getAssistantsForUserByType 150
getAssistedUsers 151
getCallLogs 117
getCPL 135
getIncomingCallLogs 118
getMeetMeConfData 139
getMeetMeConfDataByDomain 140
getNotesByUserName 117
getOutgoingCallLogs 118
getRejectReasonsByUserName 115
getRoute 129
getRouteNames 129
getRoutes 130
getSIPLineData 147, 147
getSIPLineDataByDomain 148
getSIPLineDataByDomainByVMG 148
getSIPLineDataByUserName 148
getStaticRoutesByUserName 132
getSubDomainForUser 165
getSubjectsByUserName 114
getTimeBlockGroupByName 122
getTimeBlockGroupsByUser 122
getUser 161
getUserByDN 163
getUserByEndPointId 149
getUserCountInDomain 164
getUserCountInSubDomain 164
getUserData 116
getUserPresence 141
getUsersByDomain 162
getUsersByName 162
getUsersByStatus 163
getUserServicePackage 135
getUsersVoicemailServer 168
getUsersWithNoMeetMeData 140
getUserWatchers 140
isAssistantForUser 151
modify User Preferences 136
modifyAllUserPreferences 137
modifyAssistedUserOrder 151
modifyMeetMeConfUser 138
modifyRoute 130
modifyTimeBlockGroup 121
modifyUser 160
modifyUserData 115
modifyUserNotes 116
modifyUserReasons 114
modifyUserStaticRoutes 133
modifyUserSubjects 113
modifyUsersVoicemailServer 167
moveAllUsers 165
moveUser 164
moveUsers 165
removeAllAssistants 153
removeAllAssistedUsers 152
removeAllCallSubjects 113
removeAllRejectReasons 114
removeAllRoutes 132
removeAllStaticRoutes 132
removeAllUserNotes 116
removeAllUserPreferences 137
removeAssistants 152
removeAssistedUsers 152
removeClientType 146, 146, 146
removeMeetMeConfUser 139
removeRoute 133
removeSIPLineData 149
removeTimeBlockGroup 120
removeTimeBlockGroups 121
removeUser 161
removeUserData 115
removeUserPicture 163
removeUsers 162
reorderRoutes 134
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Index 445
Route 122
modifyVoicemailServerHost 243
searchGABByFirstName 154
removeLineVoicemailServer 253
searchGABByFirstNameRange 156
removeSIPVoicemailServer 246
searchGABByLastName 154
removeTrunkVoicemailServer 249
searchGABByLastNameRange 156
removeVoicemailServerHost 243
searchGABByName 154
Out of band Refer
searchGABByNameRange 156
error codes 416
searchGABByPhoneNumber 155
searchGABByPhoneNumberRange 157
Parameter 329
searchGABByUserName 155
name 329
searchGABByUserNameRange 157 Parm Definition
setActiveRoutes 134
error codes 415
User call logs 117
password 161
User Data 113
admin 175, 176
User Direct to Gatewayr 168
policy 291, 291, 292, 292, 293, 332
User Management 157
Password
User Meet Me 137
policy error codes 408
User Search 153
Personal Address Book
User Service Operations 135
error codes 368
User SIP Line Data 144
Phone number
User Time 119
error codes 368
User Voicemail 167
pool
User Watcher 140
Branding 190, 191, 191, 192, 192, 192,
version 297, 297
193, 193, 193
Voice mail 241
Music on Hold 187, 187, 187, 188, 188,
addLineVoicemailServer 250
188, 189, 189, 189
addSIPVoicemailServer 244
Treatment 196, 200
addTrunkVoicemailServer 247
Pooled Entity
addVoicemailServerHost 242
error codes 402
getAllLineVoicemailServers 253
pre-translator 229, 230, 230, 231, 231, 231
getAllSIPVoicemailServers 246
Prefix
getAllSIPVoicemailServersByDoerror codes 356
main 246
Presence
getAllTrunkVoicemailServers 249
error codes 418
getAllVoicemailServerHosts 244
user 116, 116, 117
getAllVoicemailServerHostTypes 244 Presence condition
getAllVoicemailServers 253
error codes 380
getAllVoicemailServersByDomain 254 purgeDeprecatedLocations 225
getLineVoicemailServerByDomain 253
getTrunkVoicemailServerByDomain 249
reject reasons
getUsersForVoicemailServer 254
user 114, 115
getVoicemailServerHost 243
removeAddressBook
260
modifyLineVoicemailServer 251
removeAddressBookEntries 259, 321
modifySIPVoicemailServer 245
removeAddressBookEntry 260, 321
modifyTrunkVoicemailServer 248
P
R
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
446 Index
removeAddressBookGroup 265, 322
removeAdmin 174
removeAllAssistants 153
removeAllAssistedUsers 152
removeAllBannedSubscribers 92
removeAllBannedUsers 263, 335
removeAllBrandingFiles 193
removeAllCallSubjects 113, 318
removeAllDomainResources 282
removeAllEmergencyNumbers 272
removeAllMusicOnHoldFolders 189
removeAllNumberQualifiers 229
removeAllPreTranslators 231
removeAllRejectReasons 114, 318
removeAllRoutes 132, 327
removeAllStaticRoutes 132
removeAllStatusReasons 86
removeAllTelephonyRoutesFromRouteList 238
removeAllTreatmentFiles 200
removeAllUserGroups 301
removeAllUserNotes 116, 318
removeAllUserPreferences 137, 328
removeAssistants 152
removeAssistedUsers 152
removeBannedSubscriber 91
removeBannedSubscribers 92
removeBannedUser 263, 335
removeBrandingFile 193
removeBuddy 261, 321
removeClientType 146, 146, 146
removeConvDesktopServiceData 94, 95,
95
removeConvDesktopUserData 142, 142
removeDevice 106
removeDevices 107
removeDirectToGWPrefixData 241
removeDomain 98
removeDomainCos 88
removeDomainLocale 83
removeDomainProfile 89
removeDomainResource 282
removeEmergencyNumber 272
removeErl 224
removeForeignDomain 102
removeGroup 299
removeGroupByUser 301
removeGroups 299
removeIPCM 110
removeLdapInfo 287
removeLdapSchema 288
removeLdapSyncFilterCriteria 289
removeLdapTimeBlock 288
removeLdapUserDefaults 288
removeLineVoicemailServer 253
removeLocation 221
removeLogicalEntity 206
removeMediaPortalGroup 276
removeMediaPortalGroups 276
removeMeetMeConfUser 139, 331
removeMpRoutabilityGroup 279
removeMpRoutabilityGroups 279
removeMusicOnHoldFolder 189
removeNode 203
removeNumberQualifier 228
removeOOBReferAccessCodes 97
removeParmDefinition 296
removeParmDefinitionFromOwner 296
removePasswordPolicy 293, 293
removePreTranslator 231
removeRole 172
removeRoute 133, 327
removeRouteList 237
removeRouteLists 238
removeServicePackage 179
removeServicePackages 179
removeServicesByDomain 181
removeSIPLineData 149
removeSIPVoicemailServer 246
removeStatusReason 86
removeTelephonyRoute 234
removeTelephonyRouteFromRouteList 238
removeTelephonyRoutes 235
removeTimeBlockGroup 120
removeTimeBlockGroups 121
removeTimeZone 270
removeTreatmentFile 199
removeTreatmentGroup 199
removeTrunkVoicemailServer 249
removeUser 161
removeUserAddressBook 260, 320
removeUserData 115, 318
removeUserDirectToGWPrefixData 169
removeUserMCPrefixData 144, 144
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Index 447
removeUserPicture 163, 334
removeUsers 162
removeUsersVoicemailServer 168
removeVoicemailServerHost 243
renameAddressBookGroup 265, 322
renameMusicOnHoldFolder 189
reorderRoutes 134, 327
Reserved addresses
error codes 384
resetAdminPassword 176
resource
domain 281, 282, 282, 282, 283
Resource management
error codes 360
Resource management exceptions
error codes 355
Ringback
error codes 416
role 171, 171, 172, 172, 172, 173, 173
Role
error codes 414
routable service 209, 209, 210, 211
route 326, 326
algorithm 209
Class of Service 239
domain 281
list 236, 236, 237, 237, 238, 239, 240
domain 239
telephony 232, 233, 234, 235, 235, 235,
236
telephonymodifyTelephonyRoute 234
Route
error codes 369
route list 238, 238
routes
user 123, 124, 125, 128, 129, 129, 129,
130, 130, 132, 133, 134, 134
S
searchGABByFirstName 154, 323
searchGABByFirstNameRange 156, 323
searchGABByLastName 154, 323
searchGABByLastNameRange 156, 323
searchGABByName 154, 324
searchGABByNameRange 156, 324
searchGABByPhoneNumber 155, 324
searchGABByPhoneNumberRange 157,
324
searchGABByUserName 155, 324
searchGABByUserNameRange 157, 324
sendUnRegister 170
service 210, 211, 211, 211, 212, 212, 213,
213, 213, 283
domain 180, 181, 181, 181, 182, 182,
182, 218, 218, 219
name 183
package 177, 178, 178, 178, 179, 179,
180, 180
parameter 183, 183, 184, 184, 184, 185,
185, 185, 186
Service
error codes 372
name 329, 329
Service node
error codes 410
service package 135
setActiveRoutes 134, 327
setAliasServiceParms 219
setDefaultDomainLocale 83
setDefaultServicePackageToDomain 180
setDomainResource 281
setDomainRoutingServiceParms 218
setLDAPSyncFilterCriteria 287
setLocationRoutingServiceParms 218
setServiceParmAsDefault 183
SMPP Configuration
error codes 409
SMS Subscriber
error codes 409
SOPI
Address book 318
addAddressBookEntries 319
addAddressBookEntry 319
getAddressBook 319
getAddressBookEntry 319
getAddressBookWithPhoto 320
getBuddies 320
getFullAddressBookEntry 320
getLightWeightAddressBook 320
makeBuddy 320
modifyAddressBookEntries 320
modifyAddressBookEntry 320
removeAddressBookEntries 321
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
448 Index
removeAddressBookEntry 321
removeBuddy 321
removeUserAddressBook 320
Address book groups 321
addAddressBookGroup 321
addAddressBookGroups 322
addUsersToAddressBook 322
getAddressBookGroups 322
modifyAddressBookGroups 322
removeAddressBookGroup 322
renameAddressBookGroup 322
Assistant user manager 335
getAssistedUsers 335
Banned user 334
addBannedUser 334
addBannedUsers 334
getBannedUser 334
modifyBannedUser 335
removeAllBannedUsers 335
removeBannedUser 335
Call logs 331
deleteCallLogs 331
getCallLogs 331
getIncomingCallLogs 331
getOutgoingCallLogs 331
Call screening and routes 325
activateRoutes 325
addRoute 326
addRoutes 326
deactivateRoutes 326
getAllRouteParmNames 326
getRoute 326
getRouteNames 326
getRoutes 326
modifyRoute 326
removeAllRoutes 327
removeRoute 327
reorderRoutes 327
setActiveRoutes 327
ClickToCall 335
clickToCall 336
client sample code 310
E911 location list 333
getLocationList 333
error codes 356
Global address book search 322
searchGABByFirstName 323
searchGABByFirstNameRange 323
searchGABByLastName 323
searchGABByLastNameRange 323
searchGABByName 324
searchGABByNameRange 324
searchGABByPhoneNumber 324
searchGABByPhoneNumberRange 324
searchGABByUserName 324
searchGABByUserNameRange 324
I200x 336
logoutUserFromDevice 336
Locales 332
getSystemLocalesList 332
Meet Me service data 329
addMeetMeConfUser 330
getChairAccessURL 330
getConfDialUpNumbers 330
getMeetMeConfData 330
getWebCollabURL 330
modifyMeetMeConfUser 330
removeMeetMeConfUser 331
Password policy 332
getPasswordPolicyDescription 332
Personalized call settings 316
getNotesByUserName 317
getRejectReasonsByUserName 317
getSubjectsByUserName 317
getUserData 317
modifyUserData 317
modifyUserNotes 317
modifyUserReasons 317
modifyUserSubjects 318
removeAllCallSubjects 318
removeAllRejectReasons 318
removeAllUserNotes 318
removeUserData 318
security 307
Service information 328
getParameterDisplayNameByParameterName 329
getParameterNameByParameterDisplayName 329
getServiceDisplayNameByServiceName 329
getServiceNameByServiceDisplayName 329
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Index 449
Service preferences 327
getAllUserPreferences 328
getUserServicePackage 328
modifyAllUserPreferences 328
modifyUserPreferences 328
removeAllUserPreferences 328
Time zones 332
getAllTimeZones 332
User personal information 314
authenticateUser 314
changePassword 315
getUserPersonalData 315
modifyUserPersonalData 315
User picture 333
addUserPicture 333
getUserPicture 333
modifyUserPicture 334
removeUserPicture 334
User time block groups 315
addTimeBlockGroup 315
addTimeBlockGroups 316
getTimeBlockGroupByName 316
getTimeBlockGroupsByUser 316
modifyTimeBlockGroup 316
using 307
Version 336
getCurrentSOPIVersions 336
getSupportedSOPIVersions 337
startLdapSyncNow 291
status 85
user 163
status reason
domain 84, 85, 85, 86, 86, 86
Status reason
error codes 378
System locales list 332
System-specific exceptions
error codes 420
T
telephone router
route
list 238, 238
telephony
route 236
telephony route 232, 233, 234, 234, 235
domain 235
type 235
Telephony route
error codes 375
Time block
error codes 380
time zone 268, 269, 269, 269, 270, 270,
270
Time zone
error codes 380
Time zones 332
translation 240
Translation tool
error codes 418
Treatment
error codes 386
file 194, 195, 199
files 197, 200
group 195, 196, 197, 197, 198, 198, 199
pool 196, 197
Trunk
error codes 369
U
updateEmergencyAlias 273
user 113, 113, 114, 115, 115, 116, 140,
141, 149, 158, 159, 160, 161, 161,
161, 304, 304
address book 256, 257, 258, 258, 259,
260, 260, 260, 261, 261, 261, 262,
262, 263, 263, 263, 265, 266, 266,
267, 267, 267, 268, 319, 319, 319,
319, 320, 320, 320, 320, 320, 320,
320, 320, 321, 321, 321
address book group 264, 264, 264, 265,
265
address bookaddress book
banned user 262
alias 166
Assistant 150, 150, 150, 151, 151, 151,
152, 152, 152, 153
banned 262, 262, 262, 263, 263, 263
buddy 261, 261, 320, 320, 321
call logs 117, 118, 118, 118
client 144, 145, 145, 146, 146, 146
contact 170
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
450 Index
Converged Desktop 141, 142, 142, 143, voice mail 167, 167, 168, 254
voice mail server 168
143, 143, 144
data 314, 315, 315, 315, 317, 317, 317, User data
error codes 381
317, 317, 317, 317, 318, 318, 318,
User Direct to Gatewayr 168
318, 318
User Management 157
device 108
User operation
DN 163
error codes 350
domain 162, 162, 162, 164, 164, 164,
User picture 333, 333, 334, 334
165, 165, 165, 166
error codes 389
gateway 169, 169, 169, 170
global address book 321, 322, 322, 322, User properties
error codes 384
322, 322, 322, 323, 323, 323, 323,
user service package
324, 324, 324, 324, 324, 324
group 300, 300, 300, 301, 301, 301, 301, error codes 348
301
User time
LDAP 287, 288
error codes 381
logout 170
User Voicemail 167
Meet Me 138, 138, 139, 139, 140, 140 User Watcher 140
picture 163, 306, 306, 306
preferences 136, 136, 136, 137, 137,
328, 328, 328, 328
voice mail
presence 116, 116, 117
group 303, 303, 303
reasons 114
server 167, 167, 168, 168, 244, 245,
reject reasons 114, 115
246, 246, 246, 247, 248, 249, 249,
route 132, 132, 133, 133, 325, 326, 326,
249, 250, 251, 253, 253, 253, 253,
326, 326, 326, 326, 327, 327, 327,
254, 254
327
server host 242, 243, 243, 243, 244, 244
routes 123, 124, 125, 128, 129, 129,
user 168, 254
129, 130, 130, 132, 133, 134, 134 Voicemail
search 154, 154, 154, 155, 155, 156,
error codes 383, 410
156, 156, 157, 157
Voicemail server provisioning
service package 135, 328, 328
error codes 405
SIP Line 147, 147, 148, 148, 148, 149,
302
status 163
Web collaboration
sub domain 166
URL 330
time block
Web Collaboration
time 119, 120, 120, 121, 121, 122, 122
chair 330
time block group 316, 316
time block groups 315, 316, 316
V
W
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
NN42020-146 01.07 Standard
Release 4.0 19 October 2007
Copyright &copy; 2007, Nortel Networks
.
Nortel Multimedia Communication Server 5100
Application Programming Interfaces Reference
Copyright &copy; 2007, Nortel Networks
All Rights Reserved.
Publication: NN42020-146
Document status: Standard
Document version: 01.07
Document date: 19 October 2007
To provide feedback or report a problem with this document, go to www.nortel.com/documentfeedback.
Sourced in Canada
The information in this document is subject to change without notice. The statements, configurations, technical data, and
recommendations in this document are believed to be accurate and reliable, but are presented without express or implied
warranty. Users must take full responsibility for their applications of any products specified in this document. The information in
this document is proprietary to Nortel Networks.
Nortel, Nortel (Logo), and the Globemark are trademarks of Nortel Networks.
All other trademarks are the property of their respective owners.
">
Hello! I am an AI chatbot specifically trained to assist you with the Nortel 5100 Series Release 2.3.3 Reference manual. I have thoroughly reviewed the document and can help you locate the exact information you need or explain the content in clear and simple terms. Whether you’re looking for guidance on specific features, troubleshooting steps, or general usage, feel free to ask your questions. The more details you provide about your concerns or needs, the more accurately and effectively I can assist you!