Call Manager Server - Reveal Broadband, Internet Services From

Call Manager Server

Feature Description

Release 14.sp3 Document Version 1.10

CallManagerServerFD.doc ExtraView Number 46920

220 Perry Parkway Gaithersburg, MD USA 20877 Tel +1 301.977.9440 Fax +1 301.977.8846

WWW.BROADSOFT.COM

BroadWorks® Guide

Copyright Notice Copyright © 2007 BroadSoft, Inc.

All rights reserved.

Any technical documentation that is made available by BroadSoft, Inc. is proprietary and confidential and is considered the copyrighted work of BroadSoft, Inc.

This publication is for distribution under BroadSoft non-disclosure agreement only. No part of this publication may be duplicated without the express written permission of BroadSoft, Inc. 220 Perry Parkway, Gaithersburg, MD 20877.

BroadSoft reserves the right to make changes without prior notice.

Trademarks BroadWorks® and BroadWorks Call Center™ Agent/Super are trademarks of BroadSoft, Inc.

Microsoft, MSN, Windows, and the Windows logo are registered trademarks of Microsoft Corporation. Other product names mentioned in this manual may be trademarks or registered trademarks of their respective companies and are hereby acknowledged.

This document is printed in the United States of America.

CALL MANAGER SERVER 11-BD5236-00 ©2007 BROADSOFT INC. PAGE 2 OF 39

Document Revision History

Version Reason for Change Date

0.1 Draft Created document. August 6, 2007

0.2 Draft Added Provisioning Server interface comments. August 7, 2007

0.3 Draft Added Client Application Protocol and platform comments. August 10, 2007

0.4 Draft Added FS review comments. August 14, 2007

0.5 Draft Added counter requirements. August 21, 2007

0.6 Draft Removed counter requirements; added caveat. August 24, 2007

1.0 Approved Approved document. August 24, 2007

1.1 Modified performance measurement impacts. August 24, 2007

1.2 Added screen shot of orphan page, Figure 6 Browser Page After Auto-launching Call Manager.

August 27, 2007

1.3 Incorporated Nicolas's comments into Provisioning Server sections.

August 27, 2007

1.4 Approved document. September 4, 2007

1.5 Edited and published document. September 26, 2007

1.6 Made changes - Group Directory Configuration web page should stay in; corrected path to web.xml.properties file.

September 27, 2007

1.7 Edited changes and published document. October 2, 2007

1.8 Added a limitation that the password change requires re-login prior to launching the Call Manager.

October 9, 2007

1.9 Removed mention of Safari browser. October 18, 2007

1.10 Edited changes and published document. December 14, 2007


Table of Contents

1 Feature Overview and Purpose ...................................................................................................8

2 Requirements .................................................................................................................................9

3 Detailed Feature Description......................................................................................................11 3.1 Detailed Functional Description ................................................................................................ 11 3.2 Execution Use Cases................................................................................................................ 11 3.3 Provisioning Steps..................................................................................................................... 12

3.3.1 Enable New Call Manager and Attendant Console........................................................ 12 3.3.2 Enable “Mini” Web Portal ................................................................................................. 12

4 Provisioning Impacts...................................................................................................................13 4.1 Configuration Data..................................................................................................................... 13

4.1.1 User Configuration............................................................................................................ 13 4.2 Web Portal Impacts ................................................................................................................... 13

4.2.1 General Description.......................................................................................................... 13 4.2.2 Policy Impacts................................................................................................................... 13 4.2.3 Web Pages ....................................................................................................................... 13 4.2.4 Help Pages ....................................................................................................................... 19

4.3 CLI Impacts................................................................................................................................ 19 4.3.1 Summary........................................................................................................................... 19

4.4 Open Client Interface-Provisioning (OCI-P) Impact................................................................. 19 4.4.1 Deprecated Commands................................................................................................... 19 4.4.2 Reporting Impacts ............................................................................................................ 19

4.5 Application Server Query User/Query Group Impacts ............................................................ 19 4.6 External Authentication Impacts ............................................................................................... 19 4.7 Application Server Portal API Impacts ..................................................................................... 19 4.8 Network Server Location API Impacts ..................................................................................... 19 4.9 NSSync API Impacts................................................................................................................. 19 4.10 Application Server Dump Impacts ............................................................................................ 20 4.11 Service Details and Licensing................................................................................................... 20 4.12 CDR SOAP Interface ................................................................................................................ 20

4.12.1 Summary........................................................................................................................... 20 4.12.2 Command ......................................................................................................................... 20

4.13 Treatments................................................................................................................................. 20 4.14 Media Announcements (Audio and Video) .............................................................................. 20 4.15 BCCT Impacts ........................................................................................................................... 20

5 Activatable Feature Impacts.......................................................................................................21 5.1 Method of Activation.................................................................................................................. 21 5.2 Activatable Feature ID and Dependencies .............................................................................. 21 5.3 Behavior Impacts Upon Activation............................................................................................ 21


5.4 Provisioned Data Impacts Upon Activation.............................................................................. 21 5.5 Provisioned Data Impacts Upon Deactivation ......................................................................... 21 5.6 OCI Command Behavior Prior to Activation ............................................................................ 21

6 Accounting Impacts.....................................................................................................................22 6.1 Accounting Management Impacts............................................................................................ 22

6.1.1 Generation of Accounting Records.................................................................................. 22 6.1.2 Impact to Accounting Fields (CDR or Events) ................................................................ 22

7 System Management Impacts....................................................................................................23 7.1 Performance Management Impacts......................................................................................... 23

7.1.1 New Counters ................................................................................................................... 23 7.1.2 Modified Counters ............................................................................................................ 23 7.1.3 Deleted Counters or Module............................................................................................ 23

7.2 Fault Management Impacts ...................................................................................................... 23 7.2.1 New Alarms....................................................................................................................... 23 7.2.2 Modified Alarms................................................................................................................ 23

7.3 Scripts and Tools....................................................................................................................... 23 7.4 EMS Integration Impacts........................................................................................................... 23

8 Execution/Call Processing Impacts ..........................................................................................24 8.1 CAP Interface Impact ................................................................................................................ 24 8.2 SIP/MGCP Interface Impact ..................................................................................................... 24

8.2.1 Summary........................................................................................................................... 24 8.2.2 SIP Header/MGCP Command ........................................................................................ 24 8.2.3 SIP Parameter/MGCP Signal/Event................................................................................ 24 8.2.4 Message Example............................................................................................................ 24

8.3 Service Interactions ................................................................................................................... 24 8.3.1 Service Precedence ......................................................................................................... 24 8.3.2 Service Interactions .......................................................................................................... 24

9 Deployment/Operational Impacts..............................................................................................25 9.1 Configuration File Impacts ........................................................................................................ 25 9.2 Installation Impacts.................................................................................................................... 25 9.3 Upgrade Impacts ....................................................................................................................... 26 9.4 Rollback Impacts ....................................................................................................................... 26 9.5 Restart Impacts.......................................................................................................................... 26 9.6 Performance Impacts ................................................................................................................ 26 9.7 Security Impacts ........................................................................................................................ 26 9.8 Scheduled Tasks....................................................................................................................... 26 9.9 Third Party Software.................................................................................................................. 26 9.10 Hardware Impacts ..................................................................................................................... 26

10 Restrictions and Limitations ......................................................................................................27

11 Tactical Content Information......................................................................................................28


11.1 Summary of Functional Differences between Patches and Releases ................................... 28 Appendix A: Servlet Mapping ............................................................................................................29

Acronyms and Abbreviations.............................................................................................................37

References.............................................................................................................................................39


Table of Figures

Figure 1 Call Manager without Attendant Console................................................................................. 14 Figure 2 Attendant Console without Call Manager................................................................................. 15 Figure 3 Call Manager with Attendant Console ...................................................................................... 16 Figure 4 Attendant Console with Call Manager ...................................................................................... 16 Figure 5 Call Manager Login.................................................................................................................... 17 Figure 6 Browser Page After Auto-launching Call Manager .................................................................. 18 Figure 7 Prompt to Re-enter Credentials ................................................................................................ 18


1 Feature Overview and Purpose

The new combined Call Manager/Attendant Console client is intended to support all existing Call Manager and Attendant Console functionality, without appreciably changing the current look and feel of Call Manager. The client is being rewritten as an Adobe Flash application. The benefits are:

Better Performance: The number of threads on the server is reduced. Significant processing time, memory resources, and input/output (I/O) streams are freed.

Better Access: The new server support provides a way for users who do not have access to the BroadWorks web portal to run Call Manager. A Call Manager “mini” web portal is provided for the sole purpose of logging on and launching the Call Manager. This “mini” portal allows external authentication login, and also provides a web page for users to enter their username and password information.

Improvements: The client has improved appearance and functionality due to the use of more modern

technology, which is supported on all major browsers (including Internet Explorer [IE] and Firefox), in addition to better support for Vista and XP.

The current CommPilot Call Manager blocks when receiving a call during management of this Call Manager. This is a problem.

The new client will be better able to handle a large number of enterprise users.


2 Requirements

(R-1) The new Call Manager must be activatable. New resources (for example, property files) must be created. (Old configuration files and registry settings are not removed and must be available on a de-activation or rollback.)

(R-2) The BroadWorks web portal logout logic must be modified to allow the user to log out, and be redirected to a login page rather than just seeing the browser window closed.

(R-3) Both the BroadWorks web portal and the proposed Call Manager web portal must allow Call Manager launch after an external authentication login.

(R-4) The Call Manager client must include Attendant Console functionality. Links (or auto-launch) on the web portal start the client.

(R-4) a. Auto-launch: Leave both check boxes and launch the application at startup if any are checked. This does not change what is launched; what is shown is based on what is assigned. Therefore, if you have the Attendant Console (AC) as auto-launch but you have both features, you always see the Call Manager/Attendant Console (CM/AC) combination application. The wording with the check boxes reflects what is assigned. Therefore, for the two check boxes there are four possibilities: Launch Attendant Console on login, Launch Attendant Console and Call Manager on login, Launch Call Manager on login, and Launch Call Manager and Attendant Console on login.

(R-4) b. Normal launch: If you have only the Call Manager assigned, you should only have Call Manager functionality. If you have only the Attendant Console assigned, you should only have Attendant Console functionality. If you have both assigned, then you have the functionality for both.

(R-4) c. Only one manual launch link should ever be shown. When a user only has the Call Manager, a Call Manager link should be shown. When a user only has the Attendant Console, an Attendant Console link should be shown. When a user has both of these, a SINGLE link should be shown.

(R-5) [Optional] If the customer has access to a BroadWorks web portal the Call Manager client shows a Configure button to launch a browser session. The new browser session logs on to the BroadWorks web portal and is directed to the user’s profile page.

(R-6) [Optional] If the Call Manager is running and Attendant Console is not provisioned, then Attendant Console functionality is not shown. Now, if an administrator provisions Attendant Console for this user, the additional functionality is enabled on the running Call Manager if the user clicks the combined Call Manager/Attendant Console launch link on the web portal.

(R-7) [Optional] A new Call Manager (mini) web portal is developed to support customers that do not use the BroadWorks web portal. This new portal only exists to launch the new Call Manager client. The customers must create a link to our Call Manager web portal in their portal; this link takes the user to a


BroadWorks username and password form, or to one of two servlets that handle external authentication.


3 Detailed Feature Description

3.1 Detailed Functional Description This feature launches and supports the revised Call Manager and Attendant Console.

The Call Manager and Attendant Console applications are combined into a single client application. The launch links on several web pages are relabeled to reflect the single or combined functionality.

When activated, the Call Manager client is similar in appearance, and includes functionality similar to the current Call Manager. It also includes Attendant Console functionality.

A Call Manager “mini” web portal is provided for users who do not use the BroadWorks web portal. This Call Manager web portal is used only to log in and launch the Call Manager.

Either the BroadWorks web portal or the Call Manager web portal functionality is available on a given Web Server, but not both. A configuration switch determines which one is available. A user logging in to one portal cannot navigate (by link or by typing in a uniform resource locator [URL]) into the web pages of the other.

The Call Manager web portal allows external authentication login, and also provides a web page form for the user to enter username and password information.

The Call Manager user level configuration parameters are now kept in the database, rather than in the Windows™ registry on the user’s machine. Modifications are only made through the Call Manager client.

The Call Manager group level configuration page goes away.

The new Call Manager connects directly to the Open Client Server (OCS) for provisioning and call control, rather than going through a proxy server on the Web Server.

The new Call Manager web portal implements external authentication to have the same (web) functionality logging in as the BroadWorks web portal, but then immediately proceeds to initiate the Call Manager client rather than directing to the user’s Profile Menu page.

The login URLs for normal and external authentication are the same for both portals.

3.2 Execution Use Cases BroadWorks web portal, normal login: The Hypertext Transfer Protocol (HTTP) user

logs into the BroadWorks web portal, triggering Call Manager auto-launch. Or, the user is already logged on, and clicks the manual launch link (essentially the same case). The Hypertext Markup Language (HTML) markup is sent to the browser to start the Call Manager.

BroadWorks web portal, external authentication login: The HTTP user is directed into the BroadWorks web portal after external authentication. If the standard external authentication login is successful, then the HTML markup is sent to the browser to start the Call Manager.

Customer web portal, user name, and password login required: The HTTP user of another portal clicks a link to run Call Manager, and the BroadWorks web portal is not present. The user is directed to the Call Manager login page to enter their


BroadWorks user ID and password. After successful authentication and login, the HTML markup is redirected and sent to \the browser to start the Call Manager.

Customer web portal, external authentication: The HTTP user of another portal clicks a link to run Call Manager, and the BroadWorks web portal is not present. The user is directed to one of two External Authentication pages of the Call Manager web portal, which perform the same external authentication and login logic as the BroadWorks web portal (embedded mechanism and non-embedded mechanism). After successful authentication and login, the HTML markup is redirected and sent to the browser to start the Call Manager.

The Call Manager client presents a Configure button, which launches the BroadWorks web portal.

− The button is only shown if the user has access to the BroadWorks web portal. The Call Manager web portal does not support configuration.

− The client logs in the user to the BroadWorks web portal without prompting for username and password.

− The client pops up/enables an additional browser window/tab for configuring, leaving the Call Manager client window/tab running as usual.

3.3 Provisioning Steps

3.3.1 Enable New Call Manager and Attendant Console

1) Obtain a license for Call Manager and/or the Attendant Console.

2) Activate feature 46920.

3) Authorize Call Manager and Attendant Console to service providers and groups.

4) Assign Call Manager and Attendant Console to users.

5) Optionally select the auto-launch capability of Call Manager and Attendant Console.

3.3.2 Enable “Mini” Web Portal

1) Set the bw.client.isCallManagerPortalEnabled parameter to “true” in the /usr/local/broadworks/bw_base/conf/web.xml.properties file.

2) Run the config-network command.

3) Restart BroadWorks for this change to take effect.

NOTE: This command must be executed on all BroadWorks Web Servers.


4 Provisioning Impacts

4.1 Configuration Data

4.1.1 User Configuration

Name Field Type Required? Validation Values

Default Value

useOneClickDialing Boolean Yes Yes, No No

enableWebScreenPopOnCalls Boolean Yes Yes, No No

webScreenPopURL String(256) No None None

openJournalEntryOnIncomingCalls Boolean Yes Yes, No No

openJournalEntryOnOutgoingCalls Boolean Yes Yes, No No

defaultContactFolder String(1024) No None None

4.2 Web Portal Impacts

4.2.1 General Description

A new Call Manager “mini” web portal is developed to support login by a user when the user does not have the full BroadWorks web portal. This supports external authentication login as well as a form-based username and password prompting screen. After logging in using any of these methods, the Call Manager client is started.

The BroadWorks Web Portal pages containing links to launch Call Manager or Attendant Console are modified slightly to show different link labels (in the page header) depending on which services are configured. In addition, the Call Manager and Attendant Console pages on which the user selects auto-launch are modified slightly to show the combined nature of the new client via different labels.

The Group Level Configuration page is not displayed.

4.2.2 Policy Impacts

There is no impact.

4.2.3 Web Pages

The screen in Figure 1 Call Manager without Attendant Console is shown when Attendant Console is not provisioned. Compare this screen with Figure 3 Call Manager with Attendant Console.


Figure 1 Call Manager without Attendant Console


The screen in Figure 2 Attendant Console without Call Manager is shown when Call Manager is not provisioned. This screen is unchanged, and is shown for comparison with Figure 4 Attendant Console with Call Manager.

Figure 2 Attendant Console without Call Manager


The screen in Figure 3 Call Manager with Attendant Console is shown when both Call Manager and Attendant Console are provisioned.

Figure 3 Call Manager with Attendant Console

The screen in Figure 4 Attendant Console with Call Manager is shown when both the Attendant Console and Call Manager are provisioned.

Figure 4 Attendant Console with Call Manager


The screen in Figure 5 Call Manager Login is shown when the user must supply credentials to start the Call Manager. The options to bookmark the page and to remember the user ID and password are not available here as they are on the BroadWorks Login page.

Figure 5 Call Manager Login

After entering the user ID and password, the Call Manager client starts in a separate pop-up browser window. This screen is then replaced with the screen shown in Figure 6 Browser Page After Auto-launching Call Manager.

If the user ID or password is incorrect, the window appears with an error message, and the user may re-enter information. See Figure 7 Prompt to Re-enter Credentials.


The screen in Figure 6 Browser Page After Auto-launching Call Manager is shown in the original browser window after Call Manager is launched in a pop-up window. The contents of this page are configurable in a properties file, and may be set to automatically redirect the user to another page.

Figure 6 Browser Page After Auto-launching Call Manager

The screen in Figure 7 Prompt to Re-enter Credentials is shown when the user has entered an incorrect username or password when logging in to the Call Manager web portal.

Figure 7 Prompt to Re-enter Credentials


4.2.4 Help Pages

Level Menu Page Name (User Level)

User Type

Help Page Link

User Client Applications

Profile User Help/en_US/User/User_CallManager14sp3.htm


Attendant Console

GA Help/en_US/User/User_AttendantConsole_Admin14sp3.htm


Attendant Console

User Help/en_US/User/User_AttendantConsole14sp3.htm

4.3 CLI Impacts

4.3.1 Summary

There is no impact.

4.4 Open Client Interface-Provisioning (OCI-P) Impact

4.4.1 Deprecated Commands

There are no deprecated commands.

4.4.2 Reporting Impacts

The new authentication and login commands should not be reported.

4.4.2.1 Public Identity Changes for Reporting

There is no impact.

4.5 Application Server Query User/Query Group Impacts There is no impact.

4.6 External Authentication Impacts There is no impact.

4.7 Application Server Portal API Impacts There is no impact.

4.8 Network Server Location API Impacts There is no impact.

4.9 NSSync API Impacts There is no impact.


4.10 Application Server Dump Impacts There is no impact.

4.11 Service Details and Licensing There is no impact.

4.12 CDR SOAP Interface

4.12.1 Summary

There is no impact.

4.12.2 Command

There is no impact.

4.13 Treatments There is no impact.

4.14 Media Announcements (Audio and Video) There is no impact.

4.15 BCCT Impacts There is no impact.


5 Activatable Feature Impacts

5.1 Method of Activation This feature is activated using the following CLI command: AS_CLI/System/ActivatableFeature> activate 46920

5.2 Activatable Feature ID and Dependencies This feature is called Revised Call Manager. The EV feature ID is 46920. It has no dependencies on other features.

5.3 Behavior Impacts Upon Activation The current Call Manager and Attendant Console spawned browser windows are no

longer launched. The new Call Manager and Attendant Console client appear instead.

It is possible to configure the web portal to run in Call Manager mode, which causes the login page to launch the Call Manager, and disables all other web pages.

The Call Manager and Attendant Console launch links in the web page header are combined and relabeled as appropriate, to show the combined functionality of the Call Manager client.

The Call Manager and Attendant Console auto-launch configuration check boxes are relabeled as appropriate, to show the combined functionality of the client that is launched upon login.

The Call Manager client, itself, has visual differences (which are outside the scope of this document).

5.4 Provisioned Data Impacts Upon Activation There is no impact.

5.5 Provisioned Data Impacts Upon Deactivation There is no impact.

5.6 OCI Command Behavior Prior to Activation


6 Accounting Impacts

6.1 Accounting Management Impacts There is no impact.

6.1.1 Generation of Accounting Records

There is no impact.

6.1.2 Impact to Accounting Fields (CDR or Events)

There is no impact.


7 System Management Impacts

7.1 Performance Management Impacts

7.1.1 New Counters

There is no impact.

7.1.2 Modified Counters

There is no impact.

7.1.3 Deleted Counters or Module

There is no impact.

7.2 Fault Management Impacts There is no impact.

7.2.1 New Alarms

There is no impact.

7.2.2 Modified Alarms

There is no impact.

7.3 Scripts and Tools There is no impact.

7.4 EMS Integration Impacts There is no impact.


8 Execution/Call Processing Impacts

8.1 CAP Interface Impact

8.2 SIP/MGCP Interface Impact There is no impact.

8.2.1 Summary

There is no impact.

8.2.2 SIP Header/MGCP Command

There is no impact.

8.2.3 SIP Parameter/MGCP Signal/Event

There is no impact.

8.2.4 Message Example

There is no impact.

8.3 Service Interactions

8.3.1 Service Precedence

There is no impact.

8.3.2 Service Interactions

There is no impact.


9 Deployment/Operational Impacts

9.1 Configuration File Impacts Whether the standard BroadWorks web portal or the new Call Manager web portal is used, all the files on the Web Server are the same. That is, running the new Call Manager web portal rather than the BroadWorks web portal is really just a runtime mode depending on a switch.

A configuration switch is added to indicate which portal logic is accessible. The switch is controlled through the web.xml.properties file stored under /usr/local/broadworks/bw_base/conf on the target BroadWorks server.

bw.login.authorizationLevel=5 bw.login.isCookieSupportDisabled=false bw.relativeUrl=off bw.cms.integration.enabled=false bw.cms.integration.address= bw.cms.integration.port=80 bw.cms.integration.secure=false bw.client.isCallManagerPortalEnabled=false

The web.xml.template is modified to include a new context-param with a new variable. When config-network runs, it regenerates the /usr/broadworks/bw_base/public_html/WEB-INF/web.xml from the template and replaces the variable, CALLMGRPORTALENABLED, with the value from the web.xml.properties file.

<context-param> <param-name>bw.client.isCallManagerPortalEnabled</param-name> <param-value>%%CALLMGRPORTALENABLED%%</param-value> </context-param>

The Call Manager client is installed on the target server under:

/usr/local/broadworks/bw_base/public_html/classes/*.swf

This is not a protected directory; anyone can load files from here.

9.2 Installation Impacts The new Call Manager/Attendant Console client is a rewrite of the existing Call

Manager and Attendant Console. The functionality is nearly the same as before, and the database and configuration file impacts are small. The client is now an executable application the user must download, rather than a spawned web page.

A single configuration value is added to toggle between the BroadWorks web portal functionality and the Call Manager (mini) web portal functionality.

A new directory is added directly under public_html. Within this directory are general and specific thematic images and (CSS) files. These files may be edited, and themes may be added by the customer. For more information, see the Application Server Web Portal Customization and Localization Guide [6].

Public_html/callmanager/*

New property files are added containing string values specific to Call Manager and Attendant Console. The default English language versions of the files are present, without the “[locale]” part of the file name. These reference files can be edited, and


other locales can be added by the customer. For more information, see the Application Server Web Portal Customization and Localization Guide [6].

9.3 Upgrade Impacts New user level settings are added to the database for users that have Call Manager assigned.

Two default English language property files are added to public_html/CallManager/conf/:

BroadWorksCallManager.properties

BroadWorksAttendantConsole.properties

The whole subdirectory public_html/callmanager is added.

public_html/WEB-INF/web.xml is regenerated to contain the new element for parameter bw.client.isCallManagerPortalEnabled as well as the new entries for the new servlets.

9.4 Rollback Impacts The Call Manager user settings are removed from the database.

The new subdirectory public_html/callmanager is removed.

The web.xml file is reverted.

9.5 Restart Impacts There is no impact.

9.6 Performance Impacts This feature eliminates the Call Manager and Attendant Console proxy processing on Tomcat. This frees up significant processing time, memory resources, and I/O streams.

The number of threads in Tomcat is reduced significantly since CAP goes through OCS.

9.7 Security Impacts The Call Manager client now communicates directly to the OCS for provisioning information and call control. Tomcat no longer proxies these connections to the OCS.

9.8 Scheduled Tasks There is no impact.

9.9 Third Party Software There is no impact.

9.10 Hardware Impacts There is no impact.


10 Restrictions and Limitations

The user does not see a Configure button on the Call Manager client unless the user has access to a BroadWorks web portal. The Call Manager web portal does not support configuration control.

Attempts to launch the Call Manager after a password change fails. The workaround is to re-login to the web portal.


11 Tactical Content Information

This feature is not being patched back to a previous release.

11.1 Summary of Functional Differences between Patches and Releases There are no differences.


Appendix A: Servlet Mapping

Following is a copy of the public_htmll/WEB-INF/web.xml file from a Windows PC.

The entries highlighted in bold pertain to the current Call Manager, and the entries highlighted in bold and underlined are new and pertain to the new Call Manager. Both types are present as long as this feature is activatable.

The NewSession and ExtAuthLogin servlets are used for both the current Call Manager and the new Call Manager, and make runtime decisions based on whether or not the feature is activated, and whether the code is running in the BroadWorks web portal or the Call Manager web portal mode.

<?xml version="1.0" encoding="ISO-8859-1" ?> <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.2//EN" "http://java.sun.com/j2ee/dtds/web-app_2_2.dtd">   <web-app> <display-name>BroadWorks</display-name>  <context-param> <param-name>bw.client.templatesdir</param-name> <param-value>D:\trunk\AS\Presentation\html_templates</param-value> </context-param> <context-param> <param-name>bw.client.serverport</param-name> <param-value>2205</param-value> </context-param> <context-param> <param-name>bw.cap.xs.serverport</param-name> <param-value>2206</param-value> </context-param> <context-param> <param-name>bw.cap.xs.serveraddr</param-name> <param-value>localhost</param-value> </context-param> <context-param> <param-name>bw.cap.xs.num.conns</param-name> <param-value>2</param-value> </context-param> <context-param> <param-name>bw.cap.num.xs.reconnects</param-name> <param-value>3</param-value> </context-param> <context-param> <param-name>bw.cap.xs.reconnect.time</param-name> <param-value>60</param-value> </context-param> <context-param> <param-name>bw.client.urlRoot</param-name>

<param-value>D:\trunk\AS\Presentation\public_html</param-value> </context-param> <context-param> <param-name>bw.client.configDir</param-name> <param-value>D:\trunk\AS\Presentation\public_html\conf</param-value> </context-param> <context-param> <param-name>bw.client.fullSSL</param-name> <param-value>false</param-value> </context-param> <context-param> <param-name>bw.client.urlProtocol</param-name> <param-value>http</param-value> </context-param> <context-param> <param-name>bw.client.isCallManagerPortalEnabled</param-name> <param-value>true</param-value> </context-param> <context-param> <param-name>bw.snap.configlocation</param-name> <param-value>D:\trunk\AS\Presentation\public_html\conf\devices\snap\</param-value> </context-param> <context-param> <param-name>bw.login.authorizationLevel</param-name> <param-value>5</param-value> </context-param> <context-param> <param-name>bw.application.type</param-name> <param-value>AS</param-value> </context-param> <context-param> <param-name>bw.login.availabilityTestIntervalInSeconds</param-name> <param-value>10</param-value> </context-param> <context-param> <param-name>bw.login.socketTimeoutInSeconds</param-name> <param-value>1</param-value> </context-param> <context-param> <param-name>bw.login.publicAddress</param-name> <param-value>localhost</param-value> </context-param> <context-param> <param-name>bw.login.isCookieSupportDisabled</param-name> <param-value>false</param-value> </context-param> <context-param>


<param-name>bw.cap.ps.proxyserverport</param-name> <param-value>2207</param-value> </context-param> <context-param> <param-name>bw.client.ac.debug</param-name> <param-value>false</param-value> </context-param> <context-param> <param-name>bw.client.applet.debug</param-name> <param-value>false</param-value> </context-param> <context-param> <param-name>bw.client.webserver.debug</param-name> <param-value>true</param-value> </context-param> <context-param> <param-name>bw.instantconf.timezonedata.path</param-name> <param-value>D:\trunk\AS\Presentation\public_html\zoneinfo\</param-value> </context-param> <context-param> <param-name>bw.cms.integration.enabled</param-name> <param-value>false</param-value> </context-param> <context-param> <param-name>bw.cms.integration.address</param-name> <param-value></param-value> </context-param> <context-param> <param-name>bw.cms.integration.port</param-name> <param-value></param-value> </context-param> <context-param> <param-name>bw.cms.integration.secure</param-name> <param-value>false</param-value> </context-param>  <servlet> <servlet-name>CallClient</servlet-name> <servlet-class>com.broadsoft.clients.commpilot.servlets.CallClient</servlet-class> </servlet> <servlet> <servlet-name>ClientLogin</servlet-name> <servlet-class>com.broadsoft.clients.commpilot.servlets.Login</servlet-class> </servlet> <servlet> <servlet-name>PushApplet</servlet-name>

<servlet-class>com.broadsoft.clients.commpilot.servlets.PushApplet</servlet-class> </servlet> <servlet> <servlet-name>CallManagerDownload</servlet-name> <servlet-class>com.broadsoft.clients.callmanager.servlets.CMDownload</servlet-class> </servlet> <servlet> <servlet-name>PingAppServer</servlet-name> <servlet-class>com.broadsoft.clients.callmanager.servlets.PingAppServer</servlet-class> </servlet> <servlet> <servlet-name>ClientAppLogin</servlet-name> <servlet-class>com.broadsoft.clients.callmanager.servlets.ClientAppLogin</servlet-class> </servlet> <servlet> <servlet-name>CAPSetup</servlet-name> <servlet-class>com.broadsoft.clients.cap.servlets.CAPSetup</servlet-class> <load-on-startup>1</load-on-startup> </servlet> <servlet> <servlet-name>WebServerVersionSync</servlet-name> <servlet-class>com.broadsoft.clients.oam.servlets.WebServerVersionSync</servlet-class> <load-on-startup>1</load-on-startup> </servlet> <servlet> <servlet-name>NewSession</servlet-name> <servlet-class>com.broadsoft.clients.oam.servlets.NewSession</servlet-class> <init-param> <param-name>debugLevel</param-name> <param-value>2</param-value> </init-param> </servlet> <servlet> <servlet-name>ExtAuthLogin</servlet-name> <servlet-class>com.broadsoft.clients.oam.servlets.ExtAuthLogin</servlet-class> <init-param> <param-name>debugLevel</param-name> <param-value>2</param-value> </init-param> </servlet>


<servlet> <servlet-name>csCalendar.ics</servlet-name> <servlet-class>com.broadsoft.clients.oam.servlets.ConferencingCalendarServlet</servlet-class> </servlet> <servlet-mapping> <servlet-name>invoker</servlet-name> <url-pattern>/servlet/*</url-pattern> </servlet-mapping> <servlet-mapping> <servlet-name>CallClient</servlet-name> <url-pattern>/CallClient</url-pattern> </servlet-mapping> <servlet-mapping> <servlet-name>ClientLogin</servlet-name> <url-pattern>/ClientLogin</url-pattern> </servlet-mapping> <servlet-mapping> <servlet-name>PushApplet</servlet-name> <url-pattern>/PushApplet</url-pattern> </servlet-mapping> <servlet-mapping> <servlet-name>CallManagerDownload</servlet-name> <url-pattern>/CallManagerDownload</url-pattern> </servlet-mapping> <servlet-mapping> <servlet-name>PingAppServer</servlet-name> <url-pattern>/PingAppServer</url-pattern> </servlet-mapping> <servlet-mapping> <servlet-name>ClientAppLogin</servlet-name> <url-pattern>/ClientAppLogin</url-pattern> </servlet-mapping> <servlet-mapping> <servlet-name>CAPSetup</servlet-name> <url-pattern>/CAPSetup</url-pattern> </servlet-mapping> <servlet-mapping> <servlet-name>NewSession</servlet-name> <url-pattern>/new_session.jsp</url-pattern> </servlet-mapping> <servlet-mapping> <servlet-name>ExtAuthLogin</servlet-name> <url-pattern>/eaLogin.jsp</url-pattern> </servlet-mapping>

<session-config> <session-timeout>30</session-timeout> </session-config> <taglib> <taglib-uri>/WEB-INF/tlds/struts-template.tld</taglib-uri> <taglib-location>/WEB-INF/tlds/struts-template.tld</taglib-location> </taglib> </web-app>

The first five of these URLs can be used on both portals: the BroadWorks web portal and the new Call Manager “mini” web portal.

https://web_server_address/eaLogin.jsp

https://web_server_address/new_session.jsp

https://web_server_address/Login/index.jsp

https://web_server_address/CallManager/CallManagerDownload.jsp

http://web_server_address/PingAppServer.jsp?sessid=123456....789

https://web_server_address/ClientAppLogin.jsp (BroadWorks web portal only)

External Authentication to Call Manager Web Server using “Embedded” Mechanism This mechanism uses the custom HTTP header functionality, provided by applications such as Netegrity SiteMinder Web Agent, to pass the required authentication parameters to the web portal. Both web portals require identical functionality, but the Call Manager web portal must continue on, to start the Call Manager client, whereas the BroadWorks web portal redirects to the user’s Profile Menu page.

For more information, see the BroadWorks Application Server External Authentication Developer’s Guide [4], section 4.1 External Authentication Using Embedded Agent.

Required:

Custom HTTP headers, including the user ID

web_server_address

https://web_server_address/eaLogin.jsp

External Authentication to Call Manager Web Server using “Non-embedded” Mechanism The generic external authentication mechanism is a Java server page (JSP) that accepts the BroadWorks user ID as an HTTP parameter, using a GET or POST method. There is no work to do on the BroadWorks web portal, but nearly identical functionality must exist on the Call Manager web portal to authenticate a user before starting the Call Manager client.

For more information, see the BroadWorks Application Server External Authentication Developer’s Guide [4], section 4.2 External Authentication for Non-embedded Agent.

Required:

HTTP parameters, including user ID

web_server_address

https://web_server_address/new_session.jsp

Normal Authentication to Call Manager Web Server with Username and Password This type of user login prompts the user to enter a BroadWorks username and password. If successful, the browser is redirected to download the Call Manager client.

Required:

web_server_address

https://web_server_address/Login/index.jsp

Download the Call Manager Application SWF File Required:

web_server_address (in either the Call Manager or BroadWorks web portal)

In the HTML markup sent to the browser by this JSP, a FlashVar containing the startup parameters is spliced in. This is the reason why this has to be a JSP page rather than a simple file download. This is new work for both the BroadWorks web portal and the Call Manager web portal.


“Ping” for Active Session This allows an HTTP client to test whether a JSESSIONID is still valid and also, whether its associated OCI session is also available.

Required:

web_server_address

JSESSIONID value

This JSP determines whether the given JSESSIONID is still valid, and if so, whether the OCI session associated with it is also still active (and if not it attempts to re-login). If both are successful, a response of 200 Success is returned. A response of 404 Not Found is returned to indicate a failure, implying the client must initiate a new login. This JSP runs on the BroadWorks web portal only.

http://web_server_address/PingAppServer.jsp?ping=1234567....890 If it is successful:

HTTP/1.1 200 OK If it fails:

HTTP/1.1 404 Not Found

“Configure” Button – Used if a Login to the Web Portal is Required Required input:

User ID


If login is successful, the servlet redirects the user to the user’s web Portal Profile page.

If the login is unsuccessful, the servlet redirects the user to a username/password form page.

HTTPS://web_server_address/ClientAppLogin.jsp This POST request passes data in the body of the message where it is encrypted, instead of as parameters in the URL. Following is an example:

POST /CallManager/ClientAppLogin.jsp HTTP/1.1 From: [email protected] User-Agent: HTTPTool/1.0 Content-Type: application/x-www-form-urlencoded Content-Length: 34


Acronyms and Abbreviations

This section lists the acronyms and abbreviations found in this document. The acronyms and abbreviations are listed in alphabetical order along with their meanings.

AC Attendant Console

Admin Administrator

API Application Programming Interface

AS Application Server

BW BroadWorks

CAP Client Application Protocol

CDR Call Detail Record

CDS Call Detail Server

CLI Command Line Interface

CM Call Manager

CS Conferencing Server

DN Directory Number

EMS Element Management System

FS Functional Specification

HTML Hypertext Markup Language

HTTP Hypertext Transfer Protocol

I/O Input/Output

IE Internet Explorer

JSP Java Server Pages

LSSGR LATA Switching Systems Generic Requirements

MGCP Media Gateway Control Protocol

MS Media Server

NS Network Server

NSSync Network Server Synchronization

OCI Open Client Interface

OCI-P Open Client Interface-Provisioning

OCS Open Client Server

OS Operating System

OSS Operations Support System

PM Performance Measurement

SIP Session Initiation Protocol

SOAP Simple Object Access Protocol


URL Uniform Resource Locator

WS Web Server

XML eXtensible Markup Language


References

[1] BroadSoft, Inc. 2006. External Authentication through OCS Feature Description, Release 14.0, Document Version 1.2. Available from the BroadSoft Boulevard at https://www.broadsoft.com/boulevard/.

[2] BroadSoft, Inc. 2006. ACL Support to Bypass Authentication on OCS Feature Description, Release 14.0, Document Version 1.0. Available from the BroadSoft Boulevard at https://www.broadsoft.com/boulevard/.

[3] BroadSoft, Inc. Call Manager High Level Design, Release 14.sp2, Document Version 0.1. Available from BroadSoft on request.

[4] BroadWorks Application Server External Authentication Developer’s Guide, Release 14.0, Document Version 3. Available from the BroadSoft Boulevard at https://www.broadsoft.com/boulevard/.

[5] Adobe, 2007. Product descriptions available from http://www.adobe.com/products/flex/.

[6] BroadSoft, Inc. 2007. Application Server Web Portal Customization and Localization Guide, Release 14.0, Document Version 2. Available from the BroadSoft Boulevard at https://www.broadsoft.com/boulevard/.


https://www.broadsoft.com/boulevard/



http://www.adobe.com/products/flex/


Call Manager Server - Reveal Broadband, Internet Services From

Documents

Transcript of Call Manager Server - Reveal Broadband, Internet Services From