Table Of Contents
Preparing to Deploy Cisco IP Communicator
Installation Prerequisites
Network Requirements
Cisco Unified CallManager Configuration Requirements
Client PC Requirements
Platform Requirements
Hardware Requirements
Installing a Hotfix for USB Audio Devices
Deployment and Configuration Checklist
Adding Devices to the Cisco Unified CallManager Database
Adding Devices with Auto-Registration
Adding Devices with Auto-Registration and TAPS
Adding Devices with Cisco Unified CallManager Administration
Adding Devices with BAT
Collecting Device Names Before Adding Devices
Running the Cisco IP Communicator Administration Tool
Preparing to Deploy Cisco IP Communicator
This chapter outlines the required and recommended tasks involved in deploying Cisco IP Communicator, and provides instructions for adding Cisco IP Communicator devices to the Cisco Unified CallManager database.
This chapter includes the following topics:
•
Installation Prerequisites
•
Deployment and Configuration Checklist
•
Adding Devices to the Cisco Unified CallManager Database
•
Running the Cisco IP Communicator Administration Tool
Tip
Cisco Unified CallManager documentation is available from the Help menu in the Cisco Unified CallManager Administration web application, or on the web:
http://www.cisco.com/en/US/products/sw/voicesw/ps556/tsd_products_support_series_home.html
Installation Prerequisites
Before deploying the Cisco IP Communicator application to users, read the requirements in these sections:
•
Network Requirements
•
Cisco Unified CallManager Configuration Requirements
•
Client PC Requirements
Network Requirements
For Cisco IP Communicator to successfully operate as an endpoint in your network, your network must meet the following requirements:
•
Voice over IP (VoIP) configured on your Cisco routers and gateways
•
Cisco CallManager Release 3.3(3) SR 3 or higher installed in your network and configured to handle call processing
•
If you wish to use Cisco Unified Video Advantage version 2.0 to interoperate with Cisco IP Communicator 2.0, then you must have Cisco Unified CallManager Release 4.1(3)SR1 or higher.
If you want Cisco IP Communicator to auto-locate its TFTP server, you also need an IP network that supports DHCP with Cisco Option 150 configured with the address of your TFTP servers.
If you want to use Cisco Emergency Responder (CER), you need an available ethernet port on a Cisco ethernet switch. For details, see the Cisco Emergency Responder Administrator Guide.
Note
If the computer on which Cisco IP Communicator is running is plugged into the PC port on the back of a Cisco Unified IP Phone, Cisco IP Communicator will not be discovered by Cisco Emergency Responder (CER) software. In this case, Cisco IP Communicator's CDP (Cisco Discovery Protocol) is blocked and cannot be detected by CER. Connecting directly to a switch port prevents this problem.
Related Topics
•
How Cisco IP Communicator Interacts with Cisco Unified CallManager, page 1-11
•
Cisco Unified CallManager Configuration Requirements
•
Client PC Requirements
•
Deployment and Configuration Checklist
Cisco Unified CallManager Configuration Requirements
Cisco IP Communicator requires Cisco Unified CallManager to handle call processing. Before you deploy Cisco IP Communicator to users, see the the Cisco Unified CallManager Administration Guide or context-sensitive help in the Cisco Unified CallManager Administration web application to ensure that Cisco Unified CallManager is set up properly to manage Cisco IP Communicator devices and to route and process calls.
For an overview of configuration and deployment tasks involving Cisco Unified CallManager, see the "Deployment and Configuration Checklist" section.
Note
If Cisco IP Communicator does not appear in the Phone Type drop-down list in Cisco Unified CallManager Administration, go to the following URL and install the latest support patch for your version of Cisco Unified CallManager: http://www.cisco.com/public/sw-center/sw-voice.shtml
Related Topics
•
How Cisco IP Communicator Interacts with Cisco Unified CallManager, page 1-11
•
Network Requirements
•
Client PC Requirements
Client PC Requirements
Personal computers (PCs) on which you want to install Cisco IP Communicator should meet the requirements outlined in these sections:
•
Platform Requirements
•
Hardware Requirements
Platform Requirements
Cisco IP Communicator has certain minimum requirements of the PC and operating system on which it runs. In the minimum configuration, Cisco IP Communicator consumes a substantial portion of the PC's CPU during calls. With additional CPU and RAM, the application will be more responsive and launch faster. See Table 2-1 and Table 2-2 for details.
Note
•
Cisco IP Communicator does not support Windows XP Fast User Switching.
•
Cisco IP Communicator requires a 128 Kbps minimum network connection.
Table 2-1 Cisco IP Communicator Only
Requirements
|
Operating System
|
Minimum CPU
|
Minimum RAM
|
Screen Resolution
|
Minimum Configuration
|
• Windows 2000 Professional with service pack 3.0 or later
• Windows XP Professional with service pack 1.0 or later
|
450 MHz Pentium III or equivalent
|
128 MB
|
800 x 600
|
Recommended Configuration
|
• Windows 2000 Professional with service pack 3.0 or later
• Windows XP Professional with service pack 1.0 or later
|
733 MHz Pentium III or equivalent
|
192 MB
|
1024 x 768
|
Table 2-2 Cisco IP Communicator Interoperating with Cisco VT Advatage.
Requirements
|
Operating System
|
Minimum CPU
|
Minimum RAM
|
Screen Resolution
|
Minimum Configuration
|
• Windows 2000 Professional with service pack 4.0 or later
• Windows XP Professional with service pack 1.0 or later
|
2.5 GHz Pentium IV or equivalent
|
256 MB
|
800 x 600
|
Recommended Configuration
|
• Windows 2000 Professional with service pack 4.0 or later
• Windows XP Professional with service pack 1.0 or later
|
2.8 GHz Pentium IV or equivalent
|
512 MB
|
1024 x 768
|
Related Topics
•
Network Requirements
•
Cisco Unified CallManager Configuration Requirements
•
Hardware Requirements
•
Installing a Hotfix for USB Audio Devices
Hardware Requirements
Cisco IP Communicator requires the following of the client PC and its peripherals:
•
A minimum of 100 MB free disk space
•
A Non-ISA full-duplex sound card (integrated or PCI-based) or USB sound device
•
A 10/100 Mbit Ethernet network interface card
•
SVGA Video Card
Related Topics
•
Network Requirements
•
Cisco Unified CallManager Configuration Requirements
•
Platform Requirements
Installing a Hotfix for USB Audio Devices
Caution 
If you are using Cisco IP Communicator with a USB audio device, you may need to install the specified Microsoft hotfix to avoid system crashes.
You must install a Microsoft Windows hotfix if you use Cisco IP Communicator with both of the following:
•
Windows 2000 Service Pack 3 or later releases
•
USB audio devices
To get the hotfix for your locale, access the file called cipc-Admin-ffr.1-1-1.zip from this website:
http://www.cisco.com/pcgi-bin/tablebuild.pl/ip-comm
Unzip the W2KUSBHotfix.zip file to access the appropriate locale folder.
If you are installing the English version of Cisco IP Communicator Release 1.1(5), then run the Windows2000-KB832339-x86-ENU.EXE file.
If you are installing the French version of Cisco IP Communicator Release 1.1(5), then run the Windows200-KB832339-x86-FRA.EXE file.
Deployment and Configuration Checklist
Table 2-3 is designed to give you an overview all of the administrative tasks involved in preparing for, deploying, and configuring Cisco IP Communicator.
The table is broken into three sections:
•
Gathering information and adding devices to Cisco Unified CallManager
•
Configuring features and settings in Cisco Unified CallManager Administration
•
Deploying and configuring the Cisco IP Communicator application
Some of the tasks in the table are not specific to Cisco IP Communicator, but apply to any Cisco Unified CallManager-supported phone device. Required tasks are noted.
Note
In general, it is preferable to configure the settings in Cisco Unified CallManager Administration before deploying Cisco IP Communicator to ensure that features are set up properly for the user at first launch and will remain consistent thereafter.
Table 2-3 Pre-Deployment and Configuration Checklist
Task
|
Notes
|
For details, see...
|
Gathering information and adding devices to Cisco CallManager
|
1. For each device, gather the following information:
• User(s) in the Cisco Unified CallManager database to associate with it
• Lines and directory numbers to assign to it
• Features to be added to and configured for it
• The device pool, calling search space, and other data for the Device Information field (if applicable)
|
Optional. You can use this information to configure devices in Cisco Unified CallManager Administration web application.
The Device Information fields in the Device Configuration page will auto-populate if information is relevant and available. Edit fields only if you want to override system settings on a per-device basis.
|
• Configuring Features and Services
• Cisco Unified CallManager System Guide
• Cisco Unified CallManager Administration Guide
|
2. Decide which method you want to use to add devices to the Cisco Unified CallManager database (see the far right column for details):
• Auto-registration
• Cisco Unified CallManager Administration only
• Bulk Administration Tool (BAT) only
• BAT and the Tool for Auto-Registered Phones Support (TAPS)
|
Adding devices is required. The method that you use to add devices to Cisco Unified CallManager determines how the directory number is assigned and whether you need to obtain a MAC address from a network interface, or you need to use a free-form device name. Note that if you want to use a free-form device name, you must be registered with at least version 5.0(1) of Cisco Unified CallManager.
If you do not use auto-registration or TAPS to add a devices, you must add the device to Cisco Unified CallManager before deploying the application.
|
• Adding Devices to the Cisco Unified CallManager Database
• Collecting Device Names Before Adding Devices
• Cisco Unified CallManager Administration Guide
• Bulk Administration Tool User Guide for Cisco Unified CallManager
|
3. Choose a method to gather the device name for each client PC. You may use the MAC address from the appropriate network interface on the client PC. Alternatively, if you are connecting to a Cisco Unified CallManager version 5.0(1) or later, you have the option of using a free-form device name instead of a MAC address.
|
Not necessary if you use auto-registration or TAPS.
|
Collecting Device Names Before Adding Devices
|
Configuring features and settings in Cisco CallManager Administration
|
1. Configure Cisco CallManager telephony features such as call waiting, call forward, Call Park, Call Pickup; establish a voice messaging system.
|
As needed. Provides enhanced telephony functionality.
|
• Telephony Features Available for Cisco IP Communicator
• Cisco Unified CallManager Administration Guide
• Cisco Unified CallManager Features and Services Guide
|
2. Modify button templates.
|
As needed. Provides softkeys.
|
Modifying Phone Button Templates
|
3. Configure Cisco Unified IP Phone services.
|
Recommended. Gives users access to information such as stock quotes and weather reports, which are displayed on the phone as interactive content with text and graphics.
|
• Setting Up Services
• Cisco Unified CallManager Administration Guide
• Cisco Unified CallManager Features and Services Guide
|
4. Run the Cisco IP Communicator Administration Tool and optionally enable HTTP access.
|
You must run the tool in order to install the Directory Wizard (used to configure the Quick Search and Dialing Rules features). Additionally, you must select the option to enable HTTP access if any users in your network rely on unsupported VPN clients (the tool sets up an IP reflector web page to resolve audio IP auto-detection problems). Enabling HTTP access also improves AutoUpdate performance for remote users.
|
• Running the Cisco IP Communicator Administration Tool
• Updating the Application, page 3-10
• Resolving Audio IP Address Auto-Detection Problems
• Configuring Corporate and Personal Directories
|
5. Set up directories, including configuration files for the Quick Search and Dialing Rules features.
|
Recommended. Quick Search can search both corporate and personal directories; use Dialing Rules to apply a dialing plan. If you are integrating with a Cisco Unified CallManager directory, you can use the Directory Wizard to set up configuration files. First, run the Administration Tool (see the previous step).
|
• Running the Cisco IP Communicator Administration Tool
• Configuring Corporate and Personal Directories
• Cisco Unified CallManager Administration Guide
|
6. Add users to Cisco Unified CallManager.
|
Recommended. Associates users with device IDs to enable access to the User Options web pages; includes users and their phone numbers in relevant Quick Search results (when integrating with a Cisco Unified CallManager directory).
|
• Adding Users to Cisco Unified CallManager
• Cisco Unified CallManager Administration Guide
|
Deploying and configuring the Cisco IP Communicator application
|
1. Decide which of the following methods you want to use to deploy Cisco IP Communicator:
• Place an installer package on a shared location where you or a user can run it
• Perform installation for an entire enterprise by using a software distribution tool
• Deploy directly on an individual's computer
|
Users must have administrative privileges on their PCs in order for you to deploy software using the first option.
If you use a Microsoft Windows installer package, you can provide command line options to specify values during deployment. See the topic at right for details.
|
Deploying the Application, page 3-3
|
2. Set up a web site or use another method to tell users how to: install and configure the application, obtain user documentation, and access the User Options web pages.
|
Recommended. Providing users with this information can improve their success with the product.
|
Providing Information to Users Via a Website
|
3. Install audio devices on each client PC or provide installation information to users.
|
You or the user will need to install audio devices that rely on drivers such as a USB headset and USB handset. Ideally, this task should be performed before the application is installed on the client PC.
|
• Installing Headsets and Other Audio Devices, page 3-1
• Selecting and Tuning Audio Devices
|
4. Configure, or help users configure, the installed application as necessary.
|
Some configuration tasks may be required before the application will function at initial startup.
|
Configuring the Application
|
Related Topics
•
Adding Devices to the Cisco Unified CallManager Database
•
Deploying the Application, page 3-3
•
Updating the Application, page 3-10
•
An Overview of Post-Installation Configuration Tasks
Adding Devices to the Cisco Unified CallManager Database
Before installing the Cisco IP Communicator application, you must decide how you want to add devices to the Cisco Unified CallManager database.
Choose one of the methods described in the sections below:
•
Adding Devices with Auto-Registration
•
Adding Devices with Auto-Registration and TAPS
•
Adding Devices with Cisco Unified CallManager Administration
•
Adding Devices with BAT
Table 2-4 provides an overview of your options for adding devices to the Cisco Unified CallManager database. These options are described in detail in the topics listed above.
Table 2-4 An overview of options for adding devices to Cisco Unified CallManager
Method for Adding Devices
|
Requires Device Name?
|
Notes
|
Auto-registration
|
No
|
Results in automatic assignment of directory numbers.
|
Auto-registration with TAPS
|
No
|
Requires auto-registration and the Bulk Administration Tool (BAT); updates information in both the Cisco IP Communicator application and in the Cisco Unified CallManager Administration.
|
Using the Cisco Unified CallManager Administration
|
Yes
|
Requires devices to be added individually; you must add the device to Cisco Unified CallManager before installing the application on the client PC.
|
Using BAT
|
Yes
|
Allows for bulk registration of devices; you must add the device to Cisco Unified CallManager before installing the application on the client PC.
|
Adding Devices with Auto-Registration
You can use this method without first gathering device names from client PCs.
When auto-registration is enabled, Cisco Unified CallManager provides a directory number as soon as you run the Cisco IP Communicator application after installation. During auto-registration, Cisco Unified CallManager automatically assigns the next available sequential directory number to the device.
You can use auto-registration to quickly submit devices into the Cisco Unified CallManager database. You can then modify settings, such as the directory numbers, from Cisco Unified CallManager. Additionally, you can move auto-registered devices to new locations and assign them to different device pools without affecting their directory numbers.
For information about enabling and configuring auto-registration, see the Cisco Unified CallManager Administration Guide.
Related Topics
•
Adding Devices with Auto-Registration and TAPS
•
Adding Devices with Cisco Unified CallManager Administration
•
Adding Devices with BAT
•
Deployment and Configuration Checklist
Adding Devices with Auto-Registration and TAPS
You can use this method without first gathering MAC addresses from client PCs.
TAPS, the Tool for Auto-Registered Phones Support, works in conjunction with the Bulk Administration Tool (BAT) to update devices that were previously added to the Cisco Unified CallManager database using dummy device names. Use TAPS to update MAC addresses and download pre-defined configurations for Cisco IP Communicator devices.
To implement TAPS, you or the user dial a TAPS directory number and follow voice prompts. When the process is complete, the Cisco IP Communicator device downloads its directory number and other settings, and the device is updated in Cisco Unified CallManager Administration with the correct device name.
You must make sure that Auto-registration is enabled in Cisco Unified CallManager Administration (System > Cisco Unified CallManager) for TAPS to function.
See the the Bulk Administration Tool User Guide for Cisco Unified CallManager for detailed instructions about both BAT and TAPS.
Using a Version of TAPS that is Included with Cisco CallManager 3.3.3
If you want to use a version of TAPS that is included with Cisco CallManager 3.3.3 to add a Cisco IP Communicator device to the database for a user who already has a hardware Cisco IP Phone, and if the Cisco IP Communicator device will use the same phone number as the hardware phone, then you need to take the following steps:
1.
Use a different external phone mask to add Cisco IP Communicator.
2.
After TAPS registration is complete, change back to the original external phone mask.
Related Topics
•
Adding Devices with Auto-Registration
•
Adding Devices with Cisco Unified CallManager Administration
•
Adding Devices with BAT
•
Deployment and Configuration Checklist
Adding Devices with Cisco Unified CallManager Administration
Use this method to add devices individually to the Cisco Unified CallManager database using Cisco Unified CallManager Administration web pages.
To do so, you need to first collect the appropriate device name for each client on which you want the Cisco IP Communicator application installed. You may use the MAC address form the network interface on the client PC. Alternatively, if you are connecting to Cisco Unified CallManager 5.0(1) or later, you may use a free-form device name instead of the MAC address. See the "Collecting Device Names Before Adding Devices" section for more information.
After you have collected device names, choose Device > Add a New Device in Cisco Unified CallManager Administration. For complete instructions and conceptual information about Cisco Unified CallManager, see the the Cisco Unified CallManager Administration Guide and the Cisco Unified CallManager System Guide.
Tip
To get context-sensitive help in Cisco Unified CallManager, choose Help > For this page from the main menu bar.
Related Topics
•
Adding Devices with Auto-Registration
•
Adding Devices with Auto-Registration and TAPS
•
Adding Devices with BAT
•
Deployment and Configuration Checklist
Adding Devices with BAT
The Cisco Bulk Administration Tool (BAT) is a plug-in application for Cisco Unified CallManager that enables system administrators to perform batch operations, including registration, on large numbers of devices, including Cisco IP Phones and Cisco IP Communicator devices.
To add devices using BAT only (meaning, not in conjunction with TAPS), you need to first collect the appropriate device name for each client on which you want the Cisco IP Communicator application installed. See the "Collecting Device Names Before Adding Devices" section for more information.
For detailed instructions about using BAT, see the Cisco Unified CallManager Administration Guide and the Bulk Administration Tool User Guide for Cisco Unified CallManager.
Related Topics
•
Adding Devices with Auto-Registration
•
Adding Devices with Auto-Registration and TAPS
•
Adding Devices with Cisco Unified CallManager Administration
•
Deployment and Configuration Checklist
Collecting Device Names Before Adding Devices
You need to collect device names before adding devices to the database individually, using Cisco Unified CallManager Administration, or in bulk, using BAT only (not in conjunction with Tool for Auto-Registered Phones Support).
You do not need to collect device names before adding devices with auto-registration only or when using BAT in conjunction with TAPS.
There are two ways to collect Device Names. The first is to use the MAC address of one of the network interfaces on the client PC. The second way is to use a free-form device name. In order to use a free-form device name, you must be connecting to Cisco Unified CallManager version 5.0(1) or later. If you choose to use a MAC address, you need to get it from the network interface of the client PC on which you want the Cisco IP Communicator application installed.
If there is more than one network interface on the client PC, use the MAC address from the interface that is most likely to provide permanent connectivity, or from the interface that is always enabled—even if it is inactive. (For example, use the integrated Ethernet card rather than the wireless card, docking station, or PC card.)
This criteria also pertains to choosing a network interface to associate with the application during initial startup (if such a choice is necessary.) For more information about choosing an interface if prompted at startup, see the "Selecting a Device Name" section. If you choose to use a free-form device name, you must be connecting to a Cisco Unified CallManager version 5.0(1) or later. You may choose any device name you want as long as it is unique across the Cisco Unified CallManager cluster. The maximum number of characters in the string is 15 and the string is limited to ASCII characters only.
Related Topics
•
Deployment and Configuration Checklist
•
Adding Devices with Cisco Unified CallManager Administration
•
Adding Devices with BAT
Running the Cisco IP Communicator Administration Tool
As part of your deployment preparations, it is highly recommended that you:
•
Run the Cisco IP Communicator Administration Tool on the Cisco Unified CallManager publisher
•
Select the option in the Tool to enable HTTP access—Required if you have any users in your network who rely on an unsupported VPN client. (See the "What Software VPN Clients are Supported?" section.)
You can get the Administration Tool from the same Cisco IP Communicator software download web site:
http://www.cisco.com/pcgi-bin/tablebuild.pl/ip-comm
Table 2-5 summarizes the benefits of running the Administration Tool.
Tip
•
Typically, the Cisco Unified CallManager publisher is the TFTP server where phone loads will be installed. Running the Administration Tool on the publisher allows the Directory Wizard to auto-detect configuration values. (See the "How to Configure Quick Search Using the Directory Wizard" section for details.)
•
If you have already run the Cisco IP Communicator Administration Tool but have not enabled the HTTP option, you can run the tool again and select the option in order to enable this feature. (However, in order to disable HTTP access once selected, you must uninstall and re-install the tool.)
Table 2-5 Using the Cisco IP Communicator Administration Tool
Use the Administration Tool to...
|
How to do this
|
Notes
|
Install the Directory Wizard on your server
|
Run the Administration Tool on the Cisco Unified CallManager publisher.
|
The Administration Tool installs DirectoryWizard.exe and LdapDirectories.README.txt in this folder: <TFTPPath>\Communicator.
Running the Tool on the Cisco Unified CallManager publisher allows the Directory Wizard to auto-detect configuration values. See the "How to Configure Quick Search Using the Directory Wizard" section for details.
Use the Directory Wizard to configure Quick Search and Dialing Rules. See the "Configuring Corporate and Personal Directories" section.
|
Enable HTTP access
|
Run the Administration Tool and select the Enable HTTP Access setting.
|
Enabling HTTP access can:
• Improve the performance of AutoUpdate for remote users.
Note that users must have administrator privileges on their PCs to use AutoUpdate. See the "Updating the Application" section on page 3-10.
• Resolve audio IP address auto-detection problems for users who rely on unsupported VPN clients.
Note that if you are enabling HTTP for this purpose, you also need to specify the URL of getIP.asp web page in Cisco Unified Cisco IP Communicator Administration Guide for Cisco Unified CallManager Administration. See the "Resolving Audio IP Address Auto-Detection Problems" section.
|
Access the Directory Wizard and the Administration Tool ReadMe file
|
Run the Administration Tool and select the appropriate check boxes.
|
Alternately, you can launch the Directory Wizard and ReadMe file from the Cisco IP Communicator program group.
|
Related Topics
•
Deployment and Configuration Checklist
•
An Overview of Post-Installation Configuration Tasks
•
Configuring Features and Services