Configuring Cisco Call Manager

Cisco CallManager Administration Guide
Release 3.0(9)
Corporate Headquarters Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA 95134-1706 USA http://www.cisco.com Tel: 408 526-4000 800 553-NETS (6387) Fax: 408 526-4100
Customer Order Number: DOC-7810450= Text Part Number: OL-1047-01
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS. THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY. The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCBs public domain version of the UNIX operating system. All rights reserved. Copyright 1981, Regents of the University of California. NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED AS IS WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE. IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. AccessPath, AtmDirector, Browse with Me, CCDA, CCDE, CCDP, CCIE, CCNA, CCNP, CCSI, CD-PAC, CiscoLink, the Cisco NetWorks logo, the Cisco Powered Network logo, Cisco Systems Networking Academy, the Cisco Systems Networking Academy logo, Discover All Thats Possible, Fast Step, Follow Me Browsing, FormShare, FrameShare, GigaStack, IGX, Internet Quotient, IP/VC, iQ Breakthrough, iQ Expertise, iQ FastTrack, the iQ Logo, iQ Net Readiness Scorecard, MGX, the Networkers logo, Packet, PIX, RateMUX, ScriptBuilder, ScriptShare, SlideCast, SMARTnet, TransPath, Voice LAN, Wavelength Router, WebViewer are trademarks of Cisco Systems, Inc.; Changing the Way We Work, Live, Play, and Learn, Empowering the Internet Generation, are service marks of Cisco Systems, Inc.; and Aironet, ASIST, BPX, Catalyst, Cisco, the Cisco Certified Internetwork Expert logo, Cisco IOS, the Cisco IOS logo, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Enterprise/Solver, EtherChannel, EtherSwitch, FastHub, FastSwitch, IOS, IP/TV, LightStream, MICA, Network Registrar, Post-Routing, Pre-Routing, Registrar, StrataView Plus, Stratm, SwitchProbe, TeleRouter, and VCO are registered trademarks of Cisco Systems, Inc. or its affiliates in the U.S. and certain other countries. All other brands, names, or trademarks mentioned in this document or Web site are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (0101R) Cisco CallManager Administration Guide Copyright 2001, Cisco Systems, Inc. All rights reserved.
C O N T E N T S
Preface xxi Purpose xxi Audience xxii Organization xxii Related Documentation xxv Conventions xxvi Obtaining Documentation xxvii World Wide Web xxvii Documentation CD-ROM xxviii Ordering Documentation xxviii Documentation Feedback xxviii Obtaining Technical Assistance xxix Cisco.com xxix Technical Assistance Center xxx Contacting TAC by Using the Cisco TAC Website xxx Contacting TAC by Telephone xxx
1
PART
System Description
1
CHAPTER
Introduction 1-1 Understanding Distributed Call Processing 2-1 Clusters 2-1
CHAPTER
Cisco CallManager Administration Guide OL-1047-01
iii
Contents
Configuring a Distributed System 2-3

3
CHAPTER
Understanding Redundancy 3-1 Groups and Clusters 3-1 Components of a Group 3-2 Combining Redundancy with Distributed Call Processing 3-3 Configuring Call Processing Redundancy 3-5
CHAPTER
Understanding Auto-Registration 4-1 Enabling Auto-Registration 4-2 Disabling Auto-Registration 4-6 Reusing Auto-Registration Numbers 4-7
CHAPTER
Understanding Call Admission Control 5-1 Locations 5-2 Gatekeepers 5-3
CHAPTER
Understanding Route Plans 6-1 Route Plan Overview 6-1 Understanding Route Pattern Wildcards and Special Characters 6-7 Understanding Closest-Match Routing 6-11 Understanding Discard Digits Instructions 6-12 Understanding Route Patterns 6-24 Understanding the External Route Plan Wizard 6-25 Generated Route Filters 6-26 Generated Route Groups 6-27 Generated Route Lists 6-27
iv
OL-1047-01
Contents
Generated Route Patterns 6-29

7
CHAPTER
Understanding Device Support 7-1 Using DHCP and TFTP 7-1 Understanding DHCP and TFTP 7-2 Accessing the TFTP Server 7-3 Understanding How Devices Identify the TFTP Server 7-4 Understanding Device Loads 7-6 Updating Device Loads 7-7 Updating a Load on a Cisco IP Phone 7-8 Updating the Load on a Cisco Gateway 7-9 Verifying the Load on Cisco IP Phones 7-9 Adding Devices to Cisco CallManager 7-10
CHAPTER
Understanding Cisco WebAttendant 8-1 Cisco WebAttendant Configuration Checklist 8-2 Configuring Cisco CallManager for Cisco WebAttendant 8-3 Cisco WebAttendant Users 8-4 Setting Up Cisco IP Phones for Use with Cisco WebAttendant 8-4 Understanding Pilot Points and Hunt Groups 8-6 Understanding the Cisco Telephony Call Dispatcher 8-9 Client Installation and Configuration 8-10 Cisco WebAttendant Client Requirements 8-10 Client Installation 8-11 Client Configuration 8-11 Sharing Default Directory Database Information 8-11 Cisco WebAttendant Redundancy 8-13
Contents
Tips and Troubleshooting 8-14 Viewing Cisco WebAttendant Performance Monitors 8-14 Troubleshooting 8-16
9
CHAPTER
Understanding the LDAP Directory 9-1 Cisco CallManager Directory 9-1 Using the Embedded Directory 9-2 Scenario 1: Using the Embedded Directory 9-3 Using the Embedded Directory 9-3 Managing User Entries in the Embedded Directory 9-4 Scenario 2: Using the Embedded Directory on a Pilot System 9-4 Managing Users in the Pilot System 9-5
CHAPTER
10
Understanding Service Parameters 10-1 Cisco CallManager Service Parameters 10-2 Cisco TFTP Service Parameters 10-20 Cisco Messaging Interface Service Parameters 10-22 Cisco IP Voice Media Streaming Service Parameters 10-28 Cisco Database Layer Service Parameters 10-29 Cisco Telephony Call Dispatcher Service Parameters 10-30
PART
System Configuration
11
CHAPTER
Server
11-1
Adding a Server 11-2 Updating a Server 11-3 Deleting a Server 11-4
vi
OL-1047-01
Contents
CHAPTER
12
Configuring Cisco CallManager 12-1 Adding a Cisco CallManager 12-1 Updating a Cisco CallManager 12-5 Deleting a Cisco CallManager 12-6
CHAPTER
13
Configuring Cisco CallManager Groups 13-1 Adding a Cisco CallManager Group 13-2 Updating a Cisco CallManager Group 13-4 Copying a Cisco CallManager Group 13-5 Deleting a Cisco CallManager Group 13-6
CHAPTER
14
Configuring Date/Time Groups 14-1 Adding a Date/Time Group 14-2 Updating a Date/Time Group 14-3 Deleting a Date/Time Group 14-4
CHAPTER
15
Setting Device Defaults 15-1 Updating Device Defaults 15-2
CHAPTER
16
Configuring Regions 16-1 Understanding Regions 16-1 Adding a Region 16-3 Updating a Region 16-4 Deleting a Region 16-5
CHAPTER
17
Configuring Device Pools 17-1 Adding a Device Pool 17-1
vii
Contents
Updating a Device Pool 17-3 Deleting a Device Pool 17-4

18
CHAPTER
Understanding Enterprise Parameters 18-1 Updating Enterprise Parameters 18-4
CHAPTER
19
Configuring Locations 19-1 Understanding Locations 19-2 Locations and Regions 19-3 Bandwidth Calculations 19-4 Adding a Location 19-5 Updating a Location 19-7 Deleting a Location 19-7
CHAPTER
20
Starting and Stopping Cisco CallManager 20-1 Using the Control Center 20-2 Using Windows Services 20-3 Using the Cisco CallManager Reset Button 20-4
PART
Route Configuration
21
CHAPTER
Configuring Partitions 21-1 Adding a Partition 21-1 Deleting a Partition 21-2
CHAPTER
22
Configuring Calling Search Spaces 22-1 Adding a Calling Search Space 22-1 Updating a Calling Search Space 22-3
viii
OL-1047-01
Contents
Copying a Calling Search Space 22-3 Deleting a Calling Search Space 22-4
23
CHAPTER
Configuring Route Filters 23-1 Understanding Route Filter Tags 23-2 Adding a Route Filter 23-5 Updating a Route Filter 23-7 Copying a Route Filter 23-7 Adding Route Filter Clauses 23-9 Removing Route Filter Clauses 23-10 Deleting a Route Filter 23-11
CHAPTER
24
Configuring Route Groups 24-1 Understanding Route Groups 24-2 Adding a Route Group 24-2 Adding Devices to a Route Group 24-3 Removing Devices from a Route Group 24-5 Updating a Route Group 24-6 Deleting a Route Group 24-7
CHAPTER
25
Configuring Route Lists 25-1 Understanding Calling Party Transform Settings 25-2 Understanding Called Party Transform Settings 25-4 Adding a Route List 25-6 Adding Route Groups to a Route List 25-8 Removing Route Groups from a Route List 25-10 Changing the Order of Route Groups in a Route List 25-11
ix
Contents
Deleting a Route List 25-12

26
CHAPTER
Configuring Route Patterns 26-1 Adding a Route Pattern 26-1 Updating a Route Pattern 26-4 Copying a Route Pattern 26-5 Deleting a Route Pattern 26-6
CHAPTER
27
Configuring Translation Patterns 27-1 Understanding Translation Patterns 27-1 Adding a Translation Pattern 27-2 Updating a Translation Pattern 27-4 Copying a Translation Pattern 27-5 Deleting a Translation Pattern 27-6
CHAPTER
28
Using the External Route Plan Wizard 28-1 Creating an External Route Plan 28-2 Setting the Routing Options 28-2 Providing Tenant Information 28-4 Entering Location Information 28-5 Selecting Gateways 28-6 Providing Gateway Information 28-8 Generating the External Route Plan 28-9 Confirming the External Route Plan 28-10 Finishing the External Route Plan 28-11 Deleting an External Route Plan 28-11
OL-1047-01
Contents
CHAPTER
29
Using Route Plan Report 29-1 Viewing All Route Plan Records 29-2 Viewing Route Plan Reports in a File 29-3
PART
Service Configuration
30
CHAPTER
Cisco Messaging Interface 30-1 Most Commonly Changed CMI Service Parameters 30-2 Adding Cisco Messaging Interface Service on the Cisco CallManager 30-5 Deleting Cisco Messaging Interface Service From a Server 30-6 Configuring Cisco Messaging Interface Service Parameters 30-8 Configuring Cisco Messaging Interface Trace Parameters 30-10
CHAPTER
31
Configuring Cisco TFTP 31-1 Inserting Cisco TFTP Service on a Server 31-2 Deleting Cisco TFTP Service From a Server 31-4 Configuring Cisco TFTP Command Line Parameters 31-5 Deleting Cisco TFTP Command Line Parameters 31-7 Configuring Cisco TFTP Trace Parameters 31-9
CHAPTER
32
Configuring Cisco WebAttendants 32-1 Configuring Pilot Points 32-2 Adding a Pilot Point 32-2 Viewing, Updating, or Deleting a Pilot Point 32-4 Configuring Hunt Groups 32-5 Adding Hunt Group Members 32-5 Viewing, Updating, or Deleting Hunt Group Members 32-9
xi
Contents
Configuring Cisco WebAttendant Users 32-10 Adding a Cisco WebAttendant User 32-10 Viewing, Updating, and Deleting Cisco WebAttendant Users 32-11 Installing the Cisco WebAttendant Client 32-13 Configuring Cisco WebAttendant Client Settings 32-14 Cisco WebAttendant Server Configuration 32-18 Setting Up the wauser Shared Directory for Cisco WebAttendant 32-19 Starting the Telephony Call Dispatcher 32-20
33
CHAPTER
Configuring Conference Bridges 33-1 Understanding Conference Devices 33-2 Two Types of Conferences: Meet-Me and Ad-Hoc 33-3 Using an Ad-Hoc Conference Bridge 33-4 Using a Meet-Me Conference Bridge 33-5 Adding a Software Conference Device 33-6 Adding a Hardware Conference Device 33-8 Updating a Conference Device 33-10 Deleting a Conference Device 33-11 Updating Conference Bridge Parameters 33-12 Adding a Meet-Me Number Pattern 33-14 Updating a Meet-Me Number Pattern 33-15 Deleting a Meet-Me Number Pattern 33-17
CHAPTER
34
Configuring Media Termination Point 34-1 Planning Your MTP Configuration 34-3 Avoiding Call Failure/User Alert 34-4 Adding a Media Termination Point 34-5
xii
OL-1047-01
Contents
Updating a Media Termination Point 34-7 Deleting a Media Termination Point 34-8
35
CHAPTER
Configuring Service Parameters 35-1 Service Parameter Restart Conditions 35-2 Adding a New Service on a Server 35-3 Deleting a Service From a Server 35-4 Adding a New Service Parameter 35-5 Updating a Service Parameter 35-7 Deleting a Service Parameter 35-9
CHAPTER
36
Configuring Trace
36-1
Understanding Trace Configuration 36-2 Trace Levels 36-2 Time 36-3 User Mask 36-3 Event Level 36-6 Components 36-7 Recommended Trace Settings 36-9 Adding a New Service and Trace Configuration 36-10 Updating a Trace Configuration 36-12 Deleting a Trace Configuration 36-13 Deleting a Service 36-14
37
CHAPTER
Configuring Transcoder
37-1
Configuring a Transcoder 37-3 Updating a Transcoder 37-4
xiii
Contents
Copying a Transcoder 37-5 Deleting a Transcoder 37-6

38
CHAPTER
Starting and Stopping Services Using the Control Center Starting and Stopping Services on a Single Server 38-2 Selecting Services to Start and Stop for All Servers 38-3
38-1
PART
Feature Configuration
39
CHAPTER
Configuring Call Park
39-1
Adding a Call Park Number 39-2 Updating a Call Park Number 39-3 Deleting a Call Park Number 39-4
40
CHAPTER
Configuring Call Pickup
40-1
Configuring Call Pickup 40-2 Adding a Call Pickup Group Number 40-2 Updating a Call Pickup Group Number 40-3 Deleting a Call Pickup Group Number 40-4 Assigning Directory Numbers to a Call Pickup Group 40-5
41
CHAPTER
Configuring Cisco IP Phone Services 41-1 Understanding Cisco IP Phone Services 41-2 Adding a Cisco IP Phone Service 41-3 Adding a Cisco IP Phone Service Parameter 41-5 Updating a Cisco IP Phone Service 41-6 Deleting a Cisco IP Phone Service 41-7 Updating a Cisco IP Phone Service Parameter 41-8
xiv
OL-1047-01
Contents
Deleting a Cisco IP Phone Service Parameter 41-9

6
PART
Configuring Devices in Cisco CallManager

42
CHAPTER
Configuring CTI Route Points 42-1 Adding a CTI Route Point 42-2 Modifying a CTI Route Point 42-3 Deleting a CTI Route Point 42-4 Finding and Listing CTI Route Points 42-5 Resetting a CTI Route Point 42-6
CHAPTER
43
Configuring Cisco uOne Voice Messaging 43-1 Cisco uOne Port Wizard 43-3 Adding a New Cisco uOne Server and Ports 43-3 Adding Ports to an Existing Cisco uOne Server 43-6 Deleting Ports from an Existing Cisco uOne Server 43-7 Configuring Cisco CallManager Service Parameters for Cisco uOne 43-8 Setting up the MWI Device 43-11 Adding Cisco uOne Ports 43-12 Deleting a Cisco uOne Port 43-16 Resetting a Cisco uOne Port 43-17 Updating a Cisco uOne Port 43-18 Copying an Existing Cisco uOne Port 43-19
CHAPTER
44
Configuring a Gatekeeper 44-1 Adding a Gatekeeper 44-1 Deleting the Gatekeeper 44-6
xv
Contents
Resetting or Restarting the Gatekeeper 44-6 Modifying the Gatekeeper 44-7

45
CHAPTER
Configuring Gateways 45-1 Understanding Supported Gateways 45-2 Understanding Cisco Access Gateways 45-3 Cisco Access Analog Gateways 45-3 Cisco Access Digital Trunk Gateways 45-4 Understanding Catalyst 6000 Gateways 45-4 Catalyst 6000 Family Analog Line Card 45-4 Catalyst 6000 Family T1/E1 Line Cards 45-5 Catalyst 6000 Family DSP Services Card 45-5 Cisco VG200 Gateway 45-6 Understanding Other H.323 Devices 45-6 Adding Gateways to Cisco CallManager 45-7 Adding an Analog Gateway 45-7 Adding Digital Gateways 45-9 Adding an MGCP Gateway 45-21 Adding an H.323 Gateway 45-23 Configuring Gateway Ports in Cisco CallManager 45-27 Configuring Ports on Analog Gateways 45-27 Configuring POTS Ports 45-27 Configuring Loop Start Ports 45-31 Configuring Ports on a Cisco MGCP Gateway 45-35 Configuring FXS Ports on a Cisco MGCP Gateway 45-35 Configuring FXO Ports on Cisco MGCP Gateways 45-38
Configuring Ground Start on an MGCP Gateway 45-38
xvi
OL-1047-01
Contents
Configuring Loop Start on MGCP Gateways 45-40

Modifying Gateways 45-41 Deleting Gateways 45-42 Resetting Gateways 45-42 Updating Gateways 45-43 Finding Specific Gateways 45-44 Searching by Device Name 45-44 Searching by Description 45-45 Searching by Directory Number 45-46
46
CHAPTER
Configuring Cisco IP Phones in Cisco CallManager 46-1 Understanding Cisco IP Phones 46-2 Cisco IP Phone 7900 Family 46-2 Cisco IP Phone 7960 46-3 Cisco IP Phone 7940 46-3 Cisco IP Phone 7910 46-4 Cisco IP Phone 12 SP+ 46-4 Cisco IP Phone 30 VIP 46-4 CTI Ports 46-5 H.323 Clients 46-5 Configuring Cisco IP Phones 46-5 Displaying the MAC Address of a Phone 46-6 Adding a Phone 46-7 Deleting a Phone 46-11 Resetting a Phone 46-12 Updating a Phone 46-13 Copying an Existing Phone 46-14
xvii
Contents
Finding a Phone 46-15 Tips for Finding a Phone 46-16 Configuring Phone Features 46-16 Configuring Call Waiting 46-17 Configuring Call Forward 46-17 Configuring Call Park 46-17 Configuring Call Pickup 46-18 Configuring Directory Numbers 46-18 Adding a Directory Number 46-19 Deleting a Directory Number 46-23 Updating a Directory Number 46-24 Shared Line Appearances 46-25
47
CHAPTER
Configuring Phone Button Templates 47-1 Understanding Default Phone Button Templates 47-1 Default Cisco IP Phone 7960 Template 47-2 Default Cisco IP Phone 7940 Templates 47-3 Default Cisco IP Phone 7910 Templates 47-3 Default Cisco IP Phone 30 SP+ Template 47-3 Default Cisco IP Phone 30 VIP Template 47-4 Default Cisco IP Phone 12-Series Template 47-4 Adding Phone Button Templates 47-5 Guidelines for Creating Custom Templates 47-7 Modifying Phone Button Templates 47-9 Renaming a Phone Button Template 47-10 Deleting a Phone Button Template 47-11 Updating a Phone Button Template 47-12
xviii
OL-1047-01
Contents
PART
User Configuration
48
CHAPTER
Adding a New User 48-1 How Cisco JTAPI uses the Directory 48-2 Using the Embedded Directory 48-2 Adding a User 48-2 Assigning Devices to a User 48-3
CHAPTER
49
Searching the Global Directory 49-1 Using Basic User Search 49-1 Using Advanced User Search 49-3
PART
Appendices
A
APPENDIX
Cisco TAPI Service Provider Installation and Configuration A-1 Installing the Cisco TAPI Service Provider A-1 Activating the Cisco TAPI Service Provider A-3 Configuring the Cisco TAPI Service Provider A-4 Uninstalling the Cisco TAPI Service Provider A-9 Installing the Wave Driver A-10 Uninstalling the Wave Driver A-12 Verifying the Cisco TAPI Service Provider Installation A-14 Setting up Client-Server Configuration A-16
APPENDIX
Cisco JTAPI Installation and Configuration B-1 Installing the Cisco JTAPI Software B-2 Verifying the Installation B-4
xix
Contents
Configuring Cisco JTAPI Tracing B-4 Trace Levels B-5 Debug Levels B-7 Log Destination B-8 Cisco CallManager B-11 Other JTAPI Preferences Settings B-12 JTAPI Preferences on non-Microsoft environments B-13 Administering User Information for JTAPI and TAPI Applications B-14
C
APPENDIX
Creating Custom Cisco IP Phone Rings C-1 Creating a Custom Phone Ring C-2 RingList.xml File Format C-2 PCM File Requirements for Custom Ring Types C-3
INDEX
xx
OL-1047-01
Preface
This preface describes the purpose, audience, organization, and conventions of this guide, and provides information on how to obtain related documentation. The preface covers these topics:

Purpose, page xxi Audience, page xxii Organization, page xxii Related Documentation, page xxv Conventions, page xxvi Obtaining Documentation, page xxvii Obtaining Technical Assistance, page xxix
Purpose
The Cisco CallManager Administration Guide provides instructions for administering the Cisco CallManager system. This guide includes descriptions of procedural tasks you complete using Cisco CallManager. It also provides references for commands and conceptual information to assist you in using Cisco CallManager.
xxi
Preface Audience
Audience
The Cisco CallManager Administration Guide is written for network administrators responsible for managing the Cisco CallManager system. This guide requires knowledge of telephony and IP networking technology.
Organization
This guide is organized as shown in the following table: Part Part 1 Description System Description Contains the following chapters, which describe general topics related to the configuration and operation of Cisco CallManager:

Chapter 1, Introduction Chapter 2, Understanding Distributed Call Processing Chapter 3, Understanding Redundancy Chapter 4, Understanding Auto-Registration Chapter 5, Understanding Call Admission Control Chapter 6, Understanding Route Plans Chapter 7, Understanding Device Support Chapter 8, Understanding Cisco WebAttendant Chapter 9, Understanding the LDAP Directory Chapter 10, Understanding Service Parameters
xxii
OL-1047-01
Preface Organization
Part Part 2
Description System Configuration Contains the following chapters, which explain how to configure the system parameters used by Cisco CallManager:

Chapter 11, Server Chapter 12, Configuring Cisco CallManager Chapter 13, Configuring Cisco CallManager Groups Chapter 14, Configuring Date/Time Groups Chapter 15, Setting Device Defaults Chapter 16, Configuring Regions Chapter 17, Configuring Device Pools Chapter 18, Understanding Enterprise Parameters Chapter 19, Configuring Locations Chapter 20, Starting and Stopping Cisco CallManager
Part 3
Route Configuration Contains the following chapters, which explain how to configure route plans in Cisco CallManager:

Chapter 21, Configuring Partitions Chapter 22, Configuring Calling Search Spaces Chapter 23, Configuring Route Filters Chapter 24, Configuring Route Groups Chapter 25, Configuring Route Lists Chapter 26, Configuring Route Patterns Chapter 27, Configuring Translation Patterns Chapter 28, Using the External Route Plan Wizard Chapter 29, Using Route Plan Report
xxiii
Preface Organization
Part Part 4
Description Service Configuration Contains the following chapters, which explain how to configure services used in conjunction with Cisco CallManager:

Chapter 30, Cisco Messaging Interface Chapter 31, Configuring Cisco TFTP Chapter 32, Configuring Cisco WebAttendants Chapter 33, Configuring Conference Bridges Chapter 34, Configuring Media Termination Point Chapter 35, Configuring Service Parameters Chapter 36, Configuring Trace Chapter 37, Configuring Transcoder Chapter 38, Starting and Stopping Services Using the Control Center
Part 5
Feature Configuration Contains the following chapters, which explain how to configure user features:

Chapter 39, Configuring Call Park Chapter 40, Configuring Call Pickup
Part 6
Configuring Devices in Cisco CallManager Contains the following chapters, which explain how to configure devices in Cisco CallManager:

Chapter 42, Configuring CTI Route Points Chapter 43, Configuring Cisco uOne Voice Messaging Chapter 44, Configuring a Gatekeeper Chapter 45, Configuring Gateways Chapter 46, Configuring Cisco IP Phones in Cisco CallManager Chapter 47, Configuring Phone Button Templates
xxiv
OL-1047-01
Preface Related Documentation
Part Part 7
Description User Configuration Contains the following chapters, which explain how to configure user and directory information:

Chapter 48, Adding a New User Chapter 49, Searching the Global Directory
Part 8
Appendices Contains the following chapters, which include additional information related to Cisco CallManager and IP telephony:

Appendix A, Cisco TAPI Service Provider Installation and Configuration Appendix B, Cisco JTAPI Installation and Configuration Appendix C, Creating Custom Cisco IP Phone Rings
Related Documentation
Refer to the following documents for further information about related Cisco IP Telephony applications and products:

Installing Cisco CallManager on the Cisco Media Convergence Server Release Notes for Cisco CallManager Release 3.0 Cisco CallManager v3.0 Remote Serviceability Users Guide Hardware Configuration Guide for the Cisco Voice Gateway 200 Software Configuration Guide for the Cisco Voice Gateway 200 Cisco IP Phone 7900 Family Administration Guide
xxv
Preface Conventions
Conventions
This document uses the following conventions: Convention boldface font italic font [ ] {x|y|z} [x|y|z] string Description Commands and keywords are in boldface. Arguments for which you supply values are in italics. Elements in square brackets are optional. Alternative keywords are grouped in braces and separated by vertical bars. Optional alternative keywords are grouped in brackets and separated by vertical bars. A nonquoted set of characters. Do not use quotation marks around the string or the string will include the quotation marks. font Terminal sessions and information the system displays are in screen font. Information you must enter is in boldface
screen
screen
boldface screen
font.
font italic screen font Arguments for which you supply values are in italic screen font. This pointer highlights an important line of text in an example. ^ The symbol ^ represents the key labeled Controlfor example, the key combination ^D in a screen display means hold down the Control key while you press the D key. Nonprinting characters, such as passwords, are in angle brackets.
< >
Notes use the following conventions:
Note
Means reader take note. Notes contain helpful suggestions or references to material not covered in the publication.
xxvi
OL-1047-01
Preface Obtaining Documentation
Timesavers use the following conventions:
Timesaver
Means the described action saves time. You can save time by performing the action described in the paragraph. Tips use the following conventions:
Tips
Means the information contains useful tips. Cautions use the following conventions:
Caution
Means reader be careful. In this situation, you might do something that could result in equipment damage or loss of data. Warnings use the following conventions:
Warning
This warning symbol means danger. You are in a situation that could cause bodily injury. Before you work on any equipment, you must be aware of the hazards involved with electrical circuitry and familiar with standard practices for preventing accidents.
Obtaining Documentation
The following sections provide sources for obtaining documentation from Cisco Systems.
xxvii
Preface Obtaining Documentation
World Wide Web

You can access the most current Cisco documentation on the World Wide Web at the following sites:

http://www.cisco.com http://www-china.cisco.com http://www-europe.cisco.com
Documentation CD-ROM
Cisco documentation and additional literature are available in a CD-ROM package, which ships with your product. The Documentation CD-ROM is updated monthly and may be more current than printed documentation. The CD-ROM package is available as a single unit or through an annual subscription.
Ordering Documentation
Cisco documentation is available in the following ways:
Registered Cisco Direct Customers can order Cisco Product documentation from the Networking Products MarketPlace: http://www.cisco.com/cgi-bin/order/order_root.pl
Registered Cisco.com users can order the Documentation CD-ROM through the online Subscription Store: http://www.cisco.com/go/subscription
Nonregistered Cisco.com users can order documentation through a local account representative by calling Cisco corporate headquarters (California, USA) at 408 526-7208 or, in North America, by calling 800 553-NETS(6387).
xxviii
OL-1047-01
Preface Obtaining Technical Assistance
Documentation Feedback
If you are reading Cisco product documentation on the World Wide Web, you can submit technical comments electronically. Click Feedback in the toolbar and select Documentation. After you complete the form, click Submit to send it to Cisco. You can e-mail your comments to bug-doc@cisco.com. To submit your comments by mail, use the response card behind the front cover of your document, or write to the following address: Attn Document Resource Connection Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA 95134-9883 We appreciate your comments.
Obtaining Technical Assistance

Cisco provides Cisco.com as a starting point for all technical assistance. Customers and partners can obtain documentation, troubleshooting tips, and sample configurations from online tools. For Cisco.com registered users, additional troubleshooting tools are available from the TAC website.
Cisco.com
Cisco.com is the foundation of a suite of interactive, networked services that provides immediate, open access to Cisco information and resources at anytime, from anywhere in the world. This highly integrated Internet application is a powerful, easy-to-use tool for doing business with Cisco. Cisco.com provides a broad range of features and services to help customers and partners streamline business processes and improve productivity. Through Cisco.com, you can find information about Cisco and our networking solutions, services, and programs. In addition, you can resolve technical issues with online technical support, download and test software packages, and order Cisco learning materials and merchandise. Valuable online skill assessment, training, and certification programs are also available.
xxix
Customers and partners can self-register on Cisco.com to obtain additional personalized information and services. Registered users can order products, check on the status of an order, access technical support, and view benefits specific to their relationships with Cisco. To access Cisco.com, go to the following website: http://www.cisco.com
Technical Assistance Center

The Cisco TAC website is available to all customers who need technical assistance with a Cisco product or technology that is under warranty or covered by a maintenance contract.
Contacting TAC by Using the Cisco TAC Website

If you have a priority level 3 (P3) or priority level 4 (P4) problem, contact TAC by going to the TAC website: http://www.cisco.com/tac P3 and P4 level problems are defined as follows:

P3Your network performance is degraded. Network functionality is noticeably impaired, but most business operations continue. P4You need information or assistance on Cisco product capabilities, product installation, or basic product configuration.
In each of the above cases, use the Cisco TAC website to quickly find answers to your questions. To register for Cisco.com, go to the following website: http://www.cisco.com/register/ If you cannot resolve your technical issue by using the TAC online resources, Cisco.com registered users can open a case online by using the TAC Case Open tool at the following website: http://www.cisco.com/tac/caseopen
xxx
OL-1047-01
Contacting TAC by Telephone

If you have a priority level 1(P1) or priority level 2 (P2) problem, contact TAC by telephone and immediately open a case. To obtain a directory of toll-free numbers for your country, go to the following website: http://www.cisco.com/warp/public/687/Directory/DirTAC.shtml P1 and P2 level problems are defined as follows:

P1Your production network is down, causing a critical impact to business operations if service is not restored quickly. No workaround is available. P2Your production network is severely degraded, affecting significant aspects of your business operations. No workaround is available.
xxxi
xxxii
OL-1047-01
A R T
System Description
The following chapters describe general topics related to the configuration and operation of Cisco CallManager: Chapter 1, Introduction Chapter 2, Understanding Distributed Call Processing Chapter 3, Understanding Redundancy Chapter 4, Understanding Auto-Registration Chapter 5, Understanding Call Admission Control Chapter 6, Understanding Route Plans Chapter 7, Understanding Device Support Chapter 8, Understanding Cisco WebAttendant Chapter 9, Understanding the LDAP Directory Chapter 10, Understanding Service Parameters
C H A P T E R
Introduction
Cisco CallManager is the software-based call-processing component of the Cisco IP Telephony solution, part of Cisco AVVID (Architecture for Voice, Video and Integrated Data). The Cisco Media Convergence Server serves as the high-availability server platform for Cisco CallManager call processing, services, and applications. The Cisco CallManager system extends enterprise telephony features and functions to packet telephony network devices such as IP phones, media processing devices, Voice-over-IP (VoIP) gateways, and multimedia applications. Additional data, voice, and video services such as unified messaging, multimedia conferencing, collaborative contact centers, and interactive multimedia response systems interact through Cisco CallManager's open telephony application programming interface (API).
Key Features and Benefits
The Cisco CallManager system includes a suite of integrated voice applications that perform voice conferencing and manual attendant console functions. Because this suite of voice applications exists, there is no need for special-purpose voice processing hardware. Supplementary and enhanced services such as hold, transfer, forward, conference, multiple line appearances, automatic route selection, speed dial, last-number redial, and other features extend to IP phones and gateways. Because Cisco CallManager is a software application, enhancing its capabilities in production environments only requires upgrading software on the server platform, thereby avoiding expensive hardware upgrade costs. Distribution of Cisco CallManager and all Cisco IP Phones, gateways, and applications across an IP network provides a distributed, virtual telephony network. This architecture improves system availability and scalability. Call
1-1
Chapter 1
Introduction
admission control ensures that voice Quality of Service (QoS) is maintained across constricted WAN link, and automatically diverts calls to alternate Public Switched Telephone Network (PSTN) routes when WAN bandwidth is not available. Cisco CallManager comes preinstalled on the Cisco Media Convergence Server. A web-browsable interface to the configuration database provides the capability for remote device and system configuration. This interface also provides access to HTML-based online help for users and administrators.
New for Cisco CallManager Release 3.0
Cisco CallManager Release 3.0 significantly enhances the scalability, distributability, and availability of the enterprise IP telephony solution. Multiple Cisco CallManager servers are clustered and managed as a single entity. Release 3.0 provides capability for up to 10,000 users on each cluster. By interlinking multiple clusters, the system capacity increases to tens of thousands of users for each multisite system. Clustering aggregates the power of multiple, distributed Cisco CallManagers, enhancing the scalability and accessibility of the servers to phones, gateways, and applications. Triple server redundancy improves overall system availability. Further enhancements in Cisco CallManager Release 3.0 include toll restriction by user group, database configuration changes without system restart, and system serviceability enhancements. Alterations to the Cisco CallManager Administration user interface reduce the administrative burden when managing a large network of devices and users. Users benefit from the new call pickup-group feature as well as from the support of the first of a new generation of Cisco IP phones, the Cisco IP Phone 7960. Finally, software-only voice and multimedia applications such as the Cisco Low-End Interactive Voice Response system, Cisco IP Contact Center, Cisco Automated Attendant, and Cisco SoftPhone interact with the Cisco CallManager through telephony APIs. These applications extend the Cisco CallManager systems capability and expand the applications space within Cisco AVVID. The benefits include readily available, distributed, next-generation applications that can interact with e-business applications.
1-2
OL-1047-01
C H A P T E R
Understanding Distributed Call Processing

Cisco CallManager (release 3.0 and later) provides the capability for distributed call processing. With this feature, you can distribute the call processing load of your system across multiple Cisco CallManagers in a cluster. Use the following procedure to configure a distributed call processing system:
Configuring a Distributed System, page 2-3
Clusters
A cluster is a set of Cisco CallManagers that share the same database. When you install the Cisco CallManager software on a server, you specify which servers and which Cisco CallManagers belong to the same cluster. You also specify which server is the publisher database for the cluster. The other servers in the cluster are all subscribers to the publisher database, but they also maintain their own backup copies of the publisher database. Figure 2-1 illustrates a simple cluster containing three Cisco CallManagers. During normal operation, all of the Cisco CallManagers in the cluster read data from and write data to the publisher database. Periodically, the backup copies of the database are updated automatically from the publisher. If the publisher database becomes unavailable for any reason (for example, if the network connection is broken), the various Cisco CallManagers in the cluster can continue to operate from their local backup copies of the database. When the publisher database is restored, normal operation resumes.
2-1
Chapter 2 Clusters
Figure 2-1
Example of a Cluster with Three Cisco CallManagers
Server (Database Publisher) Cisco CallManager
Publisher database
Server (Database Subscriber) Cisco CallManager
Server (Database Subscriber) Cisco CallManager
IP Network
Subscriber database
Subscriber database
34031
2-2
OL-1047-01
Chapter 2
Understanding Distributed Call Processing Configuring a Distributed System
Configuring a Distributed System

After installing the Cisco CallManagers that form a cluster, you must configure the publisher database to allow these Cisco CallManagers to work as a distributed system. This section describes some general steps and guidelines for configuring a distributed call processing system. In general, you create a distributed system by distributing the devices (such as phones and gateways) among the various Cisco CallManagers in a cluster. To distribute the devices, you configure Cisco CallManager groups and device pools, and then assign the devices to the device pools in a way that achieves the type of distribution you want. Cisco CallManager groups and device pools are logical groupings that may or may not relate to the physical locations of the Cisco CallManagers and devices on your network. You can use Cisco CallManager groups to establish redundancy (backup call processors) for the primary Cisco CallManager in the group. A Cisco CallManager group is an ordered list of up to three Cisco CallManager servers. During normal operation, all device pools and devices that use a particular Cisco CallManager group are controlled by the first (primary) Cisco CallManager in the group. If the primary Cisco CallManager in a group fails, control of the device pools and devices registered with the primary Cisco CallManager transfers to the next Cisco CallManager in the group list. For example, assume a simplified system consisting of three Cisco CallManagers in a cluster, with 300 existing Cisco IP Phones and provisions to auto-register new phones as they are added later. Figure 2-2 shows one possible way to configure the Cisco CallManager groups and device pools to distribute the call processing load for this system.
Four Cisco CallManager groups are configured. Cisco CallManager group G1 is assigned to device pool DP1, group G2 is assigned to device pool DP2, group G3 is assigned to device pool DP3, and group G4 is assigned to device pool DP4. Group G4 is configured as the default group for devices that auto-register. CCM1 serves as the primary Cisco CallManager for the devices in DP1 and DP2, first backup for DP3, and second backup for the devices in DP4. CCM2 serves as the primary Cisco CallManager for the devices in DP3 and DP4, first backup for DP1, and second backup for the devices in DP4. CCM3 is the first backup Cisco CallManager for the devices in DP2 and DP3, and second backup for the devices in DP1 and DP4.
OL-1047-01
2-3
Chapter 2 Configuring a Distributed System
Figure 2-2
Example of Cisco CallManager Groups and Device Pools
DP1
G1 Cisco CallManager Group CCM1 Primary CCM2 First Backup CCM3 Second Backup
Device pool (100 phones)
DP2
DP3
DP4
G4 Default Cisco CallManager Group CCM2 Primary CCM3 First Backup CCM1 Second Backup
2-4
OL-1047-01
47069
Device pool (Auto-registered phones)
Chapter 2
The following procedure describes general steps for configuring Cisco CallManager groups and device pools. The example shown in Figure 2-2 focuses on the Cisco IP Phones, but similar steps apply to other devices such as gateways.
Before You Begin
Install the Cisco Media Convergence Servers and Cisco CallManager software to form a cluster of Cisco CallManagers. For details, refer to the installation instructions that shipped with your Cisco CallManager. The example cluster in Figure 2-2 consists of Cisco CallManagers CCM1, CCM2, and CCM3.
Procedure
Step 1
In Cisco CallManager Administration, select System > Cisco CallManager, select a Cisco CallManager server, and enable its auto-registration option. This will allow new phones to auto-register with that Cisco CallManager as they are added to the system. In the example shown in Figure 2-2, auto-registration is enabled on CCM2.
a. b. c.
Enter the starting and ending directory numbers for the new phones that auto-register with the selected Cisco CallManager. If desired, enter the partition name and external phone number mask for the phones that auto-register. Uncheck the Auto-registration Disabled on this Cisco CallManager option. This enables auto-registration for the selected Cisco CallManager.
Caution
Auto-registration is disabled by default. Enabling auto-registration carries a security risk in that rogue phones can automatically register to the Cisco CallManager. Restrict your use of auto-registration to brief periods when bulk phone adds are required.
d.
Click Update to save the changes.
For details, see the Updating a Cisco CallManager section on page 12-5 and the Understanding Auto-Registration section on page 4-1.
2-5
Step 2
In Cisco CallManager Administration, select System > Cisco CallManager Group to configure groups.

A Cisco CallManager group is a prioritized list of up to three Cisco CallManagers. A Cisco CallManager group named Default is configured automatically when you install the Cisco CallManager software. This is the default group for devices that auto-register with Cisco CallManager. However, you can update this group to assign a particular Cisco CallManager to it, or you can select a different group as the default group for auto-registration. There can be only one default Cisco CallManager group for auto-registration for the entire cluster.
In the example shown in Figure 2-2, four groupsG1, G2, G3, and G4are configured, and G4 is the default Cisco CallManager auto-registration group. For details, see the Configuring Cisco CallManager Groups section on page 13-1.
Step 3
In Cisco CallManager Administration, select System > Device Pool to configure the device pools for the system.
a.
A device pool named Default is configured automatically when you install Cisco CallManager, and the Default Cisco CallManager group is assigned to it. This is the default device pool for devices that auto-register with Cisco CallManager. However, you can update this device pool to change its settings, or you can select a different device pool as the default for auto-registered devices. Configure the other device pools and assign the Cisco CallManager groups to the appropriate device pools to achieve the desired load balancing and redundancy.
b.
In the example shown in Figure 2-2, device pool DP4 is configured as the default device pool for auto-registered devices, Cisco CallManager group G1 is assigned to DP1, G2 is assigned to DP2, G3 is assigned to DP3, and G4 is assigned to DP4. For details, refer to the Configuring Device Pools section on page 17-1 and the Understanding Redundancy section on page 3-1.
2-6
OL-1047-01
Chapter 2
Step 4
In Cisco CallManager Administration, select System > Device Defaults to select the default device load, device pool, and template for each type of device. When a device auto-registers with a particular Cisco CallManager, it acquires the device defaults that apply to its device type on that Cisco CallManager. Refer to the Setting Device Defaults section on page 15-1 for more information.
Step 5
In Cisco CallManager Administration, select Device > Phone to configure the Cisco IP Phones and assign them to the appropriate device pools. As new phones are connected to the system, they auto-register with the default device pool until all the auto-registration directory numbers are consumed (see Step 1).
Note
After a phone auto-registers with a particular Cisco CallManager, you can update its configuration and assign it to a different device pool (and a different Cisco CallManager group). Similarly, you can reconfigure any device and assign it to a different device pool to achieve better load balancing for your system.
Step 6
After making your configuration changes and saving them in the database, restart all devices affected by those changes.
Related Topics

Understanding Redundancy, page 3-1 Configuring Cisco CallManager Groups, page 13-1 Configuring Device Pools, page 17-1 Setting Device Defaults, page 15-1
2-7
2-8
OL-1047-01
C H A P T E R
Understanding Redundancy
Cisco CallManager (release 3.0 and later) provides several forms of redundancy:

Database redundancyThe Cisco CallManagers in a cluster maintain backup copies of their shared database. See the Clusters section on page 2-1. Call processing redundancyUsing Cisco CallManager groups, you can designate backup Cisco CallManagers to handle call processing for a disabled Cisco CallManager.
The following procedure describes how to configure call processing redundancy using Cisco CallManager groups:
Configuring Call Processing Redundancy, page 3-5
Groups and Clusters

Groups and clusters are logical collections of Cisco CallManagers and their associated devices. Groups and clusters are not necessarily related to the physical locations of any of their members. A cluster is a set of Cisco CallManagers that share a common database. You specify which servers and which Cisco CallManagers belong to the same cluster and specify the publisher database location when you install and configure the Cisco CallManager software. For more information on clusters, refer to the installation and configuration instructions that shipped with your Cisco CallManager.
3-1
Chapter 3 Groups and Clusters
A group is a list of Cisco CallManagers that is assigned to one or more device pools to provide redundant call processing. You use Cisco CallManager Administration to define the groups, specify which Cisco CallManagers belong to each group, and to assign a Cisco CallManager group to each device pool.
Components of a Group
A Cisco CallManager group is a prioritized list of up to three Cisco CallManagers. Each group must contain a primary Cisco CallManager, and it may contain one or two standby Cisco CallManagers. The order that the Cisco CallManagers are listed in a group determines the failover order. Under normal operation, the primary Cisco CallManager in a group controls call processing for all the registered devices (such as phones and gateways) associated with a group. If the primary Cisco CallManager fails for any reason, the first standby Cisco CallManager takes control of the devices that were registered with the primary Cisco CallManager. If you specify a second standby Cisco CallManager for the group, it takes control of the devices if both the primary and the first standby Cisco CallManagers fail. You associate devices to a Cisco CallManager group by using device pools. Each device belongs to one device pool, and each device pool is associated with one Cisco CallManager group. You can combine the groups and device pools in various ways to achieve the desired level of redundancy. For example, Figure 3-1 shows a simple system with three redundant Cisco CallManagers controlling 800 devices.
3-2
OL-1047-01
Chapter 3
Understanding Redundancy Groups and Clusters
Figure 3-1
Example of a Cisco CallManager Group
DP1 Device pool (400 devices)
In Figure 3-1, Cisco CallManager group G1 is assigned to two device pools, DP1 and DP2. CCM1, as the primary Cisco CallManager in group G1, controls all 800 devices in DP1 and DP2 under normal operation. If CCM1 fails, control of all 800 devices transfers to CCM2. If CCM2 also fails, then control of all 800 devices transfers to CCM3.
Combining Redundancy with Distributed Call Processing

The configuration in Figure 3-1 provides call processing redundancy, but it does not distribute the call processing load very well among the three Cisco CallManagers in the example. In most cases, you would want to distribute the devices in a way that prevents a single Cisco CallManager from becoming overloaded if one of the other Cisco CallManagers in the group fails. Figure 3-2 shows one possible way to configure the Cisco CallManager groups and device pools to achieve both distributed call processing and redundancy for a system of three Cisco CallManagers and 800 devices.
47070
DP2 Device pool (400 devices)
3-3
Chapter 3 Groups and Clusters
Figure 3-2
Example of Redundancy Combined with Distributed Call Processing
G1 Cisco CallManager Group DP1 Device pool (100 devices) CCM1 Primary CCM2 First Backup CCM3 Second Backup
G4 Default Cisco CallManager Group DP4 Device pool (300 devices) CCM2 Primary CCM3 First Backup CCM1 Second Backup
3-4
OL-1047-01
47071
Chapter 3
Understanding Redundancy Configuring Call Processing Redundancy
In Figure 3-2, the Cisco CallManager groups are configured and assigned to device pools so that Cisco CallManager CCM1 is the primary controller in two groups, G1 and G2. If CCM1 fails, the 100 devices in device pool DP1 transfer to CCM2, and the 300 devices in DP2 transfer to CCM3. Similarly, CCM2 is the primary controller of groups G3 and G4. If CCM2 fails, the 100 devices in DP3 transfer to CCM1, and the 300 devices in DP4 transfer to CCM3. If CCM1 and CCM2 both fail, all devices transfer to CCM3. For more information on distributed call processing, see the Understanding Distributed Call Processing section on page 2-1.
Configuring Call Processing Redundancy

This section describes the general steps for configuring Cisco CallManager groups to provide call processing redundancy and distributed call processing as illustrated by the example in Figure 3-2.
Before You Begin
Install the Cisco Media Convergence Servers and Cisco CallManager software to form a cluster of Cisco CallManagers. A cluster is a set of Cisco CallManagers that share the same database. In Figure 3-2, the cluster consists of Cisco CallManagers CCM1, CCM2, and CCM3. For details, refer to the installation instructions that shipped with your Cisco CallManager.
Procedure
Step 1
In Cisco CallManager Administration, select System > Cisco CallManager and update the configuration for the Cisco CallManagers in a cluster. When you install the Cisco CallManager software, the database contains an initial configuration for each of the Cisco CallManagers in the cluster. However, you might want to update these configurations to change the settings for some of the parameters such as auto-registration. For details, see the Updating a Cisco CallManager section on page 12-5.
3-5
Chapter 3 Configuring Call Processing Redundancy
Step 2
In Cisco CallManager Administration, select System > Cisco CallManager Group to configure Cisco CallManager groups for the cluster. The Default group is configured automatically when you install the Cisco CallManager software, and devices that auto-register with Cisco CallManager are normally assigned to this Default group. However, you might want to change the configuration of the Default group or specify one of the other groups as the default group for auto-registration. For details, see the Configuring Cisco CallManager Groups section on page 13-1.
Step 3
In Cisco CallManager Administration, select System > Device Pool to configure device pools for your system.
a.
The Default device pool is configured automatically when you install Cisco CallManager. However, you might want to update its configuration to set the parameters such as region and to assign this pool to the appropriate Cisco Call Manager group. Cisco CallManager normally assigns the Default device pool to devices that auto-register with it, unless you specify a different default device pool through the Device Defaults (see the Setting Device Defaults section on page 15-1). Configure the other device pools and assign them to the appropriate Cisco CallManager groups. In this example, device pool DP1 is assigned to group G1, DP2 is assigned to G2, and so forth.
b.
For details, see the Configuring Device Pools section on page 17-1.
Step 4
In Cisco CallManager Administration, select the desired options under Device to configure the devices on your network and to assign them to the appropriate device pools. After making your configuration changes and saving them in the database, restart the devices affected by those changes.
Step 5
Related Topics
Cisco CallManager groups provide both call processing redundancy and distributed call processing. The way you distribute devices, device pools, and Cisco CallManagers among the groups is critical for maintaining the desired level of redundancy and load balancing in your system. For more information on distributed call processing, see:
Understanding Distributed Call Processing, page 2-1.
3-6
OL-1047-01
C H A P T E R
Understanding Auto-Registration
Use auto-registration if you want Cisco CallManager to assign directory numbers automatically to new devices when you plug these devices into your network.
Caution
Auto-registration is disabled by default. Enabling auto-registration carries a security risk in that rogue phones can automatically register to the Cisco CallManager. Auto-registration should only be enabled for brief periods when bulk phone adds are required. Auto-registration is disabled by default to prevent unauthorized connections to your network. Use the following procedures to enable or disable auto-registration and to reuse the auto-registration directory numbers:

Enabling Auto-Registration, page 4-2 Disabling Auto-Registration, page 4-6 Reusing Auto-Registration Numbers, page 4-7
When you enable auto-registration, you specify a range of directory numbers for Cisco CallManager to assign to new devices connected to your network. As new devices are connected to the network, Cisco CallManager assigns the next available directory number in the specified range. Once a directory number is assigned to an auto-registered device, you can move the device to a new location and its directory number remains the same. If all of the auto-registration directory numbers are consumed, no additional devices can auto-register with Cisco CallManager.
4-1
Chapter 4 Enabling Auto-Registration
Note
New devices auto-register with the primary Cisco CallManager in the Auto-Registration Cisco CallManager Group (see the Configuring Cisco CallManager Groups section on page 13-1). That Cisco CallManager automatically assigns each auto-registered device to a default device pool based on the device type (see the Setting Device Defaults section on page 15-1). After a device has auto-registered, you can update its configuration and assign it to a different device pool and a different Cisco CallManager (see the Configuring Device Pools section on page 17-1).
Related Topics

Enabling Auto-Registration, page 4-2 Disabling Auto-Registration, page 4-6 Reusing Auto-Registration Numbers, page 4-7
Enabling Auto-Registration
This section describes how to enable auto-registration for devices.
Procedure
Step 1 Step 2 Step 3
Open Cisco CallManager Administration. Select System > Cisco CallManager. From the list of Cisco CallManagers, select the Cisco CallManager where you want to enable auto-registration.
4-2
OL-1047-01
Chapter 4
Understanding Auto-Registration Enabling Auto-Registration
Step 4
Enter the following information in the section for Auto-registration Information. Field Name Starting Directory Number Description Enter the first directory number to use for auto-registration of devices. If you specify a range of directory numbers in the Starting Directory Number and Ending Directory Number fields, auto-registration is automatically enabled. If you set the starting and ending directory numbers to the same value, auto-registration is disabled. Ending Directory Number Enter the last directory number to use for auto-registration of devices. If you specify a range of directory numbers in the Starting Directory Number and Ending Directory Number fields, auto-registration is automatically enabled. If you set the starting and ending directory numbers to the same value, auto-registration is disabled. Partition Select the partition to which auto-registered directory numbers belong. If you are not using partitions, select None. You must select a valid range for auto-registration before you can select a partition and external phone number mask. The partition field is reset when auto-registration is disabled.
4-3
Chapter 4 Enabling Auto-Registration
Field Name External Phone Number Mask
Description Specify the mask used to format caller ID information for external (outbound) calls made from the auto-registered devices. The mask can contain up to 50 characters. Enter the literal digits that you want to appear in the caller ID information, and use Xs to represent the directory number of the auto-registered device. For example, if you specify a mask of 972813XXXX, an external call from extension 1234 displays a caller ID number of 9728131234 if the Use External Phone Number Mask option is checked on the route pattern used to make the external call. If you specify a mask of all literal digits such as 9728135000 to represent a main attendant number, then that literal number is the caller ID displayed for an external call from any auto-registered device.
Auto-registration is disabled by default to prevent Auto-registration unauthorized connections to the network. When Disabled on this Cisco CallManager auto-registration is disabled, you must configure the directory numbers manually whenever you add new devices to your network.

Uncheck the auto-registration Disabled option to enable auto-registration for this Cisco CallManager. Check the Auto-registration Disabled option to disable auto-registration for this Cisco CallManager.
You can disable auto-registration by setting the Starting Directory Number and Ending Directory Number to the same value. If starting and ending directory numbers are currently specified when you disable auto-registration by checking this option, Cisco CallManager sets the starting and ending directory numbers to the same value. The partition and external phone mask information fields are also reset when auto-registration is disabled.
Step 5
Click Update to save any changes in the database.
4-4
OL-1047-01
Chapter 4
Understanding Auto-Registration Enabling Auto-Registration
Step 6
Repeat Steps 3 through 5 for each Cisco CallManager where you want to enable auto-registration. There can be only one primary Cisco CallManager for auto-registration, but you can designate other Cisco Call Managers as backups for purposes of auto-registration. See the Understanding Redundancy section on page 3-1. Select System > Cisco CallManager Group. From the list of Cisco CallManager groups, select the group that is enabled for auto-registration. (In most systems, the name of this group is Default.) This is the default Cisco CallManager group for devices that auto-register. Make sure the Selected list for this group contains the Cisco CallManagers you configured for auto-registration in Step 3. If you made any changes to the group configuration, click Update to save the changes in the database. Select System > Device Pool. From the list of device pools, select one of the default device pools assigned in the Device Defaults (see the Setting Device Defaults section on page 15-1). Cisco CallManager assigns each auto-registered device to a default device pool based on the device type. From the drop-down list box for Cisco CallManager Group, select the Cisco CallManager group you configured for auto-registration in Step 8. This step assigns the default device pool to the default Cisco CallManager group for auto-registration. From the drop-down list box for Calling Search Space for Auto-Registration, select the calling search space to assign to the devices in this device pool that auto-register with Cisco CallManager. The calling search space specifies the route partitions used by the devices in the pool. Click Update to save the device pool changes in the database. Repeat Step 11 through Step 14 for each device pool listed in the Device Defaults.
Step 7 Step 8
Step 12
Step 13
Step 14 Step 15
Related Topics

Understanding Auto-Registration, page 4-1 Disabling Auto-Registration, page 4-6 Reusing Auto-Registration Numbers, page 4-7
4-5
Chapter 4 Disabling Auto-Registration
Disabling Auto-Registration
This section describes how to disable auto-registration for devices.
Procedure
Step 1 Step 2 Step 3 Step 4
Open Cisco CallManager Administration. Select System > Cisco CallManager. From the Cisco CallManager list, select the Cisco CallManager where you want to disable auto-registration. Click the Auto-registration Disabled option to disable auto-registration for this Cisco CallManager (when this box is checked, auto-registration is disabled).
Note
You can also disable auto-registration by setting the Starting Directory Number and Ending Directory Number to the same value.
Step 5 Step 6
Click Update to save the changes in the database. Repeat Steps 3 through 5 for each Cisco CallManager where you want to disable auto-registration.
Related Topics

Understanding Auto-Registration, page 4-1 Enabling Auto-Registration, page 4-2 Reusing Auto-Registration Numbers, page 4-7
4-6
OL-1047-01
Chapter 4
Understanding Auto-Registration Reusing Auto-Registration Numbers
Reusing Auto-Registration Numbers

When you connect a new device to the network, Cisco CallManager assigns the next available (unused) auto-registration directory number to that device. If you manually change the directory number of an auto-registered device, or if you delete that device from the database, Cisco CallManager can reuse the auto-registration directory number of that device. When a device attempts to auto-register, Cisco CallManager searches the range of auto-registration numbers you specified and tries to find the next available directory number to assign to the device. It begins the search with the next directory number in sequence after the last one assigned. If it reaches the ending directory number in the range, Cisco CallManager continues to search from the starting directory number in the range. You can use the following procedure to reset the range of auto-registration directory numbers and force Cisco CallManager to search from the starting number in the range.
Procedure
Step 1 Step 2 Step 3 Step 4 Step 5
Open Cisco CallManager Administration. Select System > Cisco CallManager. Select the Cisco CallManager where you want to reset auto-registration. Write down the current settings for Starting Directory Number and Ending Directory Number. Click Auto-registration Disabled on this Cisco CallManager.
Caution Step 6 Step 7 Step 8
New devices cannot auto-register while auto-registration is disabled. Click Update. Set the Starting Directory Number and Ending Directory Number to their previous values (or to new values if desired). Click Update.
4-7
Chapter 4 Reusing Auto-Registration Numbers
Related Topics

Understanding Auto-Registration, page 4-1 Enabling Auto-Registration, page 4-2 Disabling Auto-Registration, page 4-6
4-8
OL-1047-01
C H A P T E R
Understanding Call Admission Control

Use call admission control to maintain a desired level of voice quality over a WAN link. For example, you can use call admission control to regulate the voice quality on a T1 line connecting your main campus and a remote site. Voice quality can begin to degrade when there are too many active calls on a link and the amount of bandwidth is oversubscribed. Call admission control regulates voice quality by limiting the number of calls that can be active on a particular link at the same time. Call admission control does not guarantee a particular level of audio quality on the link, but it does allow you to regulate the amount of bandwidth consumed by active calls on the link. There are two types of call admission control that you can use with Cisco CallManager:

Locations, page 5-2 Gatekeepers, page 5-3
5-1
Chapter 5 Locations
Locations
The Locations feature, available in Cisco CallManager, provides call admission control for centralized call processing systems. A centralized system uses a single Cisco CallManager to control all the locations. Figure 5-1 illustrates call admission control using locations. For more information, refer to the Configuring Locations section on page 19-1 and to the Cisco IP Telephony Network Design Guide.
Figure 5-1 Call Admission Control Using Locations in a Centralized System
Hub location Cisco CallManager
IP WAN link
IP WAN link
Remote location A
Remote location B
5-2
OL-1047-01
38538
Chapter 5
Understanding Call Admission Control Gatekeepers
Gatekeepers
An H.323 gatekeeper, also known as a Multimedia Conference Manager (MCM), provides call admission control in a distributed system with a separate Cisco CallManager or Cisco CallManager cluster at each site. Figure 5-2 illustrates call admission control using gatekeeper technology. Only one gatekeeper can be registered per Cisco CallManager cluster. Refer to the Cisco IP Telephony Network Design Guide for more information about deployment of gatekeeper-based call admission control.
Figure 5-2 Call Admission Control Using H.323 Gatekeeper Technology in a Distributed System
Main campus Cisco CallManager (or cluster) Gatekeeper
IP WAN link Cisco CallManager (or cluster)
IP WAN link Cisco CallManager (or cluster)
Remote site A
Remote site B
38539
5-3
Chapter 5 Gatekeepers
5-4
OL-1047-01
C H A P T E R
Understanding Route Plans

The Route Plan drop-down list on the menu bar allows you to configure Cisco CallManager route plans using route patterns, route filters, route lists, and route groups. This section contains descriptions of the following route plan concepts:

Route Plan Overview, page 6-1 Understanding Route Pattern Wildcards and Special Characters, page 6-7 Understanding Closest-Match Routing, page 6-11 Understanding Discard Digits Instructions, page 6-12 Understanding the External Route Plan Wizard, page 6-25
Route Plan Overview

The Cisco CallManager uses the route plan to route both internal calls and external (Public Switched Telephone Network [PSTN]) calls. Route patterns, route filters, route lists, and route groups provide flexibility in network design. Route patterns work in conjunction with route filters to direct calls to specific devices and to include or exclude specific digit patterns. (Use route patterns to include and exclude digit patterns. Use route filters primarily to include digit patterns.) Route lists control the selection order of the route groups. Route groups set the selection order of the gateway devices.
6-1
Chapter 6 Route Plan Overview
Route patterns can be assigned to gateways, or to route lists and route groups.
Note
After adding or changing route pattern information, you must reset the gateway for the new or updated information to be recognized. Route groups determine the order of preference for gateway and port usage. Route groups allow overflows from busy or failed devices to alternate devices. Route lists determine the order of preference for route group usage. If a route list is configured, at least one route group must be configured. One or more route lists can point to one or more route groups. Route filters permit or restrict access to routing patterns. Tags are the core component of route filters. A tag applies a name to a portion of the dialed digits. For example, the North American Numbering Plan (NANP) number 972-555-1234 contains the LOCAL-AREA-CODE (972), OFFICE-CODE (555), and SUBSCRIBER (1234) tags.
Note
The NANP is the numbering plan for the PSTN in the United States and its territories, Canada, Bermuda, and many Caribbean nations. It includes any number that can be dialed and is recognized in North America. Route patterns represent all valid digit strings. When you assign a directory number to a Cisco IP Phone, you are assigning it a route pattern (the directory number is the route pattern). Cisco Access Analog Trunk Gateways, Cisco Access Digital Trunk Gateways, Cisco MGCP gateways, and H.323-compliant gateways also use route patterns. Cisco gateways can route ranges of numbers with complex restrictions and manipulate directory numbers before the Cisco CallManager passes them on to an adjacent system. The adjacent system can be a central office (CO), a private branch exchange (PBX), or a gateway on another Cisco CallManager system. A route pattern can be assigned directly to a Cisco Access Gateway, or it can be assigned to a route list for more flexibility. For example, in Figure 6-1 Cisco Access Digital Gateway 1 is designated as the first-choice for routing outgoing calls to the PSTN.
6-2
OL-1047-01
Chapter 6
Understanding Route Plans Route Plan Overview
Tips
If a gateway does not have a route pattern, it cannot place calls to the PSTN or to a PBX. To assign a route pattern to an individual port on a gateway, you must assign a route list and a route group to that port. Figure 6-1 shows the effects of using route patterns with Cisco Access Digital Gateways. In this example, the route pattern is assigned to a route list, and that route list is associated with a single route group. The route group supports a list of devices that are selected based on availability. If all ports on the first-choice gateway are busy or out of service, the call is routed to the second-choice gateway.
6-3
Figure 6-1
Route Plan Summary Diagram for Cisco Access Digital Gateways
User dials number
Route pattern
If the route pattern matches, perform digit manipulation and route to the route list.
Route list
Associate the route list with a single route group
Route group
Route to Cisco Access Digital Gateway devices in order of preference. Second-choice
First-choice
Cisco Access Digital Gateway 1
Cisco Access Digital Gateway 2
Route to PSTN.
6-4
OL-1047-01
32370
PSTN
Chapter 6
Understanding Route Plans Route Plan Overview
Figure 6-2 shows the effects of using route patterns with Cisco Access Analog Gateways. In this example, the route pattern is assigned to a route list, and that route list is associated with two route groups. Route group 1 is associated with ports 1 through 8 on gateway 1, which route all calls to interexchange carrier 1 (IXC 1). Route group 1 is also associated with ports 1 through 4 on gateway 2. Route group 2 is associated with ports 5 through 8 on gateway 2 and all ports on gateway 3. Each route group supports a list of devices that are selected based on availability. For route group 1, if ports 1 through 8 on the first-choice gateway are busy or out of service, calls are routed to ports 1 through 4 on the second-choice gateway. If all routes in route group 1 are unavailable, calls are routed to route group 2. For route group 2, if ports 5 through 8 on the first-choice gateway are busy or out of service, calls are routed to ports 1 through 8 on the second-choice gateway. If no ports on any gateway in either route group are available, the call is routed to an all trunks busy tone.
6-5
Figure 6-2
Route Plan Summary Diagram for Cisco Access Analog Gateways
User dials number
Route pattern
If the route pattern matches, perform digit manipulation and route to the route list.
Route list First choice
Associate the route list with a single route group. Second choice Route to Cisco Access Analog Gateway devices based on gateway and port number. Second-choice gateway 3 ports 1 to 8
Route group 1
Route Group 2
First-choice gateway 1 ports 1 to 8
Second-choice gateway 2 ports 1 to 4
First-choice gateway 2 ports 5 to 8
Cisco Access Analog Gateway 1
Cisco Access Analog Gateway 2
Cisco Access Analog Gateway 2 Route to an IXC.
IXC 1
IXC 2
IXC 3
Related Procedures

Adding a Route Filter, page 23-5 Adding a Route Group, page 24-2 Adding a Route Pattern, page 26-1 Adding a Route List, page 25-6
6-6
32371
OL-1047-01
Chapter 6
Understanding Route Plans Understanding Route Pattern Wildcards and Special Characters
Understanding Route Pattern Wildcards and Special Characters

Route pattern wildcards and special characters allow a single route pattern to match a range of numbers (addresses). These wildcards and special characters are also used to build instructions that enable the Cisco CallManager to manipulate a number before sending it to an adjacent system. Table 6-1 describes the wildcards and special characters supported by Cisco CallManager.
Table 6-1 Wildcards and Special Characters
Character @
Description The at symbol (@) wildcard matches all NANP numbers. Only one @ wildcard is allowed in each route pattern.
Examples The route pattern 9.@ routes or blocks all numbers recognized by the NANP. The following route patterns are examples of NANP numbers encompassed by the @ wildcard.

0 1411 19725551234 101028819725551234 01133123456789
The X wildcard matches any single digit in the range 0 through 9.
The route pattern 9XXX routes or blocks all numbers in the range 9000 through 9999.
The exclamation point (!) The route pattern 91! routes or wildcard matches one or more blocks all numbers in the range digits in the range 0 through 9. 910 through 91999999999999999999999.
6-7
Chapter 6 Understanding Route Pattern Wildcards and Special Characters
Table 6-1
Wildcards and Special Characters (continued)
Character ?
Description The question mark (?) wildcard matches zero or more occurrences of the preceding digit or wildcard value. The plus sign (+) wildcard matches one or more occurrences of the preceding digit or wildcard value.
Examples The route pattern 91X? routes or blocks all numbers in the range 91 through 91999999999999999999999. The route pattern 91X+ routes or blocks all numbers in the range 9100 through 91999999999999999999999.
[]
The square bracket ([ ]) The route pattern characters are used to enclose a 813510[012345] routes or blocks range of values. all numbers in the range 8135100 through 8135105. The hyphen (-) character is The route pattern 813510[0-5] used, with the square brackets, routes or blocks all numbers in to denote a range of values. the range 8135100 through 8135105. The circumflex (^) character is used, with the square brackets, to negate a range of values. It must be the first first character following the opening bracket ([). Only one ^ character is allowed in each route pattern. The route pattern 813510[^1-5] routes or blocks all numbers in the range 8135106 through 8135109.
6-8
OL-1047-01
Chapter 6
Understanding Route Plans Understanding Route Pattern Wildcards and Special Characters
Table 6-1
Wildcards and Special Characters (continued)
Character .
Description The dot (.) character is used as a delimiter to separate the Cisco CallManager access code from the directory number. This special character can be used, with the discard digits instructions, to strip off the Cisco CallManager access code before sending the number to an adjacent system. Only one . character is allowed in each route pattern.
Examples The route pattern 9.@ identifies the initial 9 as the Cisco CallManager access code in an NANP call.
The asterisk (*) character is available as an extra digit for special dialed numbers.
The route pattern *411 can be configured to provide access to the internal operator for directory assistance.
The octothorpe (#) character is The route pattern 901181910555# generally used to identify the routes or blocks an international number dialed from within the end of the dialing sequence. NANP. The # character after the The # character must be the last last 5 identifies this as the last character in the pattern. digit in the sequence.
Table 6-2 lists Cisco CallManager Administration fields that require route patterns and shows the valid entries for each field.
Table 6-2 Field Entries
Field Call Park Number/Range Calling Party Transform Mask Called Party Transform Mask
Valid entries [^0123456789-]X*# 0123456789X*# 0123456789X*#
6-9
Chapter 6 Understanding Route Pattern Wildcards and Special Characters
Table 6-2
Field Entries (continued)
Field Caller ID DN (Gateways) Directory Number External Phone Number Mask Forward All Forward Busy Forward No Answer Meet-Me Conference number Prefix Digits Prefix DN (Gateways) Route Filter tag values Route Pattern Translation Pattern
Valid entries 0123456789X*# [^0123456789-]+?!X*#+ 0123456789X*# 0123456789*# 0123456789*# 0123456789*# [^0123456789-]+?!X*#+ 0123456789*# 0123456789*# [^0123456789-]X*# [^0123456789-]+?!X*#+.@ [^0123456789-]+?!X*#+.@
Directory Number (Call Pickup Group) 0 1 2 3 4 5 6 7 8 9
6-10
OL-1047-01
Chapter 6
Understanding Route Plans Understanding Closest-Match Routing
Understanding Closest-Match Routing

Closest-match routing is the process of routing a call using the route pattern that most closely matches the dialed number. When the Cisco CallManager encounters a a dialed number that matches multiple route patterns, it uses closest-match routing to determine which route pattern matches the number most closely and directs the call using that route pattern. When two configured route patterns match exactly the same number of addresses in different partitions, Cisco CallManager chooses the route pattern based on order in which the partitions are listed in the calling search space. (Cisco CallManager chooses the route pattern from the partition that appears first in the calling search space.) If two configured route patterns match exactly the same number of addresses in a partition, the Cisco CallManager arbitrarily chooses one. The following paragraphs explain why such exact matches are an unusual occurrence. It is possible to configure several route patterns that match a single number. For instance, the number 8912 matches all of the following route patterns: 8912, 89XX, and 8XXX. In this example, the route pattern 8912 matches exactly one address. The route pattern 89XX matches 8912 plus 99 other addresses, and the route pattern 8XXX matches 8912 plus 999 other addresses. If the user dials 8913, the call routes differently. Using the preceding example, this address matches only the routing patterns 89XX and 8XXX. Since 89XX matches a narrower range of addresses than 8XXX, the Cisco CallManager delivers the call to the device assigned the routing pattern 89XX. Using the @ wildcard character in a route pattern requires additional consideration. The number 92578912 matches both of the following route patterns: 9.@ and 9.XXXXXXX. Even though both of these route patterns seem to equally match the address, the 9.@ route pattern actually provides the closest match. The @ wildcard character encompasses many different route patterns, and one of those route patterns is [2-9]XXXXXX. Since the number 2578912 more closely matches [2-9]XXXXXX than it does XXXXXXX, the 9.@ route pattern provides the closest match for routing.
6-11
Chapter 6 Understanding Discard Digits Instructions
Understanding Discard Digits Instructions

A discard digits instruction (DDI) removes a portion of the dialed digit string before passing the number on to the adjacent system. Portions of the digit string must be removed, for example, when an external access code is needed to route the call to the PSTN, but that access code is not expected by the PSTN switch. Table 6-3 lists DDIs and describes the effects of applying each DDI to a dialed number.
Table 6-3 Discard Digits Instructions
DDI 10-10-Dialing
Effect This DDI removes:
Example Route pattern: 9.@ Dialed digit string: 910102889728135000 After applying DDI: 99728135000
IXC access code
10-10-Dialing Trailing-#
This DDI removes:

Route pattern: 9.@ Dialed digit string: 9101028801181910555#
IXC access code
end-of-dialing character After applying DDI: for international calls 901181910555 Route pattern: 9.@ Dialed digit string: 919728135000 or 99728135000 After applying DDI: 98135000 long distance direct dialing code long distance operator assisted dialing code IXC access code area code local area code
11/10D->7D
This DDI removes:

This DDI creates a 7-digit local number from an 11- or 10-digit dialed number.
6-12
OL-1047-01
Chapter 6
Understanding Route Plans Understanding Discard Digits Instructions
Table 6-3
Discard Digits Instructions (continued)
DDI
Effect

Example Route pattern: 9.@ Dialed digit string: 919728135000 or 99728135000 After applying DDI: 98135000
11/10D->7D Trailing-# This DDI removes: long distance direct dialing code long distance operator assisted dialing code IXC access code area code local area code end-of-dialing character for international calls
This DDI creates a 7-digit local number from an 11- or 10-digit dialed number 11D->10D This DDI removes:

Route pattern: 9.@ Dialed digit string: 919728135000 After applying DDI: 99728135000 Route pattern: 9.@ Dialed digit string: 919728135000 After applying DDI: 99728135000
long distance direct dialing code long distance operator assisted dialing code IXC access code long distance direct dialing code long distance operator assisted dialing code end-of-dialing character for international calls IXC access code
11D->10D Trailing-#
This DDI removes:

6-13
Table 6-3
DDI Intl TollBypass
Example Route pattern: 9.@
international access code Dialed digit string: 901181910555 international direct After applying DDI: dialing code 9910555 country code

IXC access code international operator assisted dialing code Route pattern: 9.@
Intl TollBypass Trailing-#
This DDI removes:
international access code Dialed digit string: 901181910555# international direct After applying DDI: dialing code 9910555 country code

IXC access code international operator assisted dialing code end-of-dialing character Dialed digit string: 919728135000 After applying DDI: 919728135000
NoDigits
This DDI removes no digits. Route pattern: 9.@
Trailing-#
This DDI removes:
Route pattern: 9.@
end-of-dialing character Dialed digit string: 901181910555# for international calls After applying DDI: 901181910555
6-14
OL-1047-01
Chapter 6
Table 6-3
DDI PreAt
Effect
Example
This DDI removes all digits Route pattern: 8.9@ prior to the NANP portion of Dialed digit string: the route pattern, including: 899728135000 Cisco CallManager After applying DDI: external access code 9728135000 PBX external access code This DDI removes all digits Route pattern: 8.9@ prior to the NANP portion of Dialed digit string: the route pattern, including: 8901181910555# Cisco CallManager After applying DDI: external access code 01181910555 PBX external access code
PreAt Trailing-#
end-of-dialing character for international calls
PreAt 10-10-Dialing
This DDI removes all digits Route pattern: 8.9@ prior to the NANP portion of Dialed digit string: the route pattern, including: 8910102889728135000 Cisco CallManager After applying DDI: external access code 9728135000

PBX external access code IXC access code
6-15
Table 6-3
DDI PreAt 10-10-Dialing Trailing-#
Effect
Example
This DDI removes all digits Route pattern: 8.9@ prior to the NANP portion of Dialed digit string: the route pattern, including: 89101028801181910555# Cisco CallManager After applying DDI: external access code 01181910555 PBX external access code

IXC access code end-of-dialing character for international calls
PreAt 11/10D->7D
This DDI removes all digits Route pattern: 8.9@ prior to the NANP portion of Dialed digit string: the route pattern, including: 8919728135000 or 899728135000 Cisco CallManager external access code After applying DDI:

PBX external access code long distance direct dialing code long distance operator assisted dialing code IXC access code area code local area code
8135000
6-16
OL-1047-01
Chapter 6
Table 6-3
DDI PreAt 11/10D->7D Trailing-#
Effect
Example
This DDI removes all digits Route pattern: 8.9@ prior to the NANP portion of Dialed digit string: the route pattern, including: 8919728135000 or 899728135000 Cisco CallManager external access code After applying DDI: 8135000 PBX external access code

long distance direct dialing code long distance operator assisted dialing code IXC access code area code local area code end-of-dialing character for international calls
6-17
Table 6-3
DDI PreAt 11D->10D
Effect
Example
This DDI removes all digits Route pattern: 8.9@ prior to the NANP portion of Dialed digit string: the route pattern, including: 8919728135000 Cisco CallManager After applying DDI: external access code 9728135000 PBX external access code

long distance direct dialing code long distance operator assisted dialing code IXC access code
PreAt 11D->10D Trailing-#
This DDI removes all digits Route pattern: 8.9@ prior to the NANP portion of Dialed digit string: the route pattern, including: 8919728135000 Cisco CallManager After applying DDI: external access code 9728135000 PBX external access code

long distance direct dialing code long distance operator assisted dialing code IXC access code end-of-dialing character for international calls
6-18
OL-1047-01
Chapter 6
Table 6-3
DDI
Effect
Example
PreAt Intl TollBypass This DDI removes all digits Route pattern: 8.9@ prior to the NANP portion of Dialed digit string: the route pattern, including: 8901181910555 Cisco CallManager After applying DDI: external access code 910555 PBX external access code

international access code international direct dialing code country code IXC access code international operator assisted dialing code
PreAt Intl TollBypass This DDI removes all digits Route pattern: 8.9@ Trailing-# prior to the NANP portion of Dialed digit string: the route pattern, including: 8901181910555# Cisco CallManager After applying DDI: external access code 910555

PBX external access code international access code international direct dialing code country code IXC access code international operator assisted dialing code end-of-dialing character
6-19
Table 6-3
DDI PreDot
Example Route pattern: 8.9@ Dialed digit string: 899728135000 After applying DDI: 99728135000
Cisco CallManager external access code
PreDot Trailing-#
This DDI removes:

Route pattern: 8.9@ Dialed digit string: 8901181910555#
Cisco CallManager external access code
end-of-dialing character After applying DDI: 901181910555 for international calls Route pattern: 8.9@ Dialed digit string: 8910102889728135000 After applying DDI: 99728135000 Route pattern: 8.9@ Dialed digit string: 89101028801181910555# Cisco CallManager external access code IXC access code
PreDot 10-10-Dialing This DDI removes:

PreDot 10-10-Dialing This DDI removes: Trailing-# Cisco CallManager external access code
After applying DDI: 901181910555 end-of-dialing character for international calls IXC access code
6-20
OL-1047-01
Chapter 6
Table 6-3
DDI PreDot 11/10D->7D

Example Route pattern: 8.9@ Dialed digit string: 8919728135000 or 899728135000 After applying DDI: 98135000
Cisco CallManager external access code long distance direct dialing code long distance operator assisted dialing code IXC access code area code local area code
This DDI creates a 7-digit local number from an 11- or 10-digit dialed number. PreDot 11/10D->7D Trailing-# This DDI removes:

Route pattern: 8.9@ Dialed digit string: 8919728135000 or 899728135000 After applying DDI: 98135000
Cisco CallManager external access code long distance direct dialing code long distance operator assisted dialing code IXC access code area code local area code end-of-dialing character for international calls
6-21
Table 6-3
DDI PreDot 11D->10D

Example Route pattern: 8.9@ Dialed digit string: 8919728135000 After applying DDI: 99728135000
Cisco CallManager external access code long distance direct dialing code long distance operator assisted dialing code IXC access code
PreDot 11D->10D Trailing-#
This DDI removes:

Route pattern: 8.9@ Dialed digit string: 8919728135000 After applying DDI: 99728135000
Cisco CallManager external access code long distance direct dialing code long distance operator assisted dialing code IXC access code end-of-dialing character for international calls
6-22
OL-1047-01
Chapter 6
Table 6-3
DDI
Effect

Example Route pattern: 8.9@ Dialed digit string: 8901181910555
PreDot Intl TollBypass This DDI removes: Cisco CallManager external access code
international access code After applying DDI: 9910555 international direct dialing code

country code IXC access code international operator assisted dialing code Route pattern: 8.9@ Dialed digit string: 8901181910555#
PreDot Intl TollBypass This DDI removes: Trailing-# Cisco CallManager external access code
international access code After applying DDI: 9910555 international direct dialing code

country code IXC access code international operator assisted dialing code end-of-dialing character
6-23
Chapter 6 Understanding Route Patterns
Understanding Route Patterns

Cisco CallManager uses route patterns to route or block both internal and external calls. A directory number is a type of specific route pattern that is applied to a Cisco IP Phone. Gateways and Cisco IP Phones can also use more complex route patterns that can contain wildcards. Gateways can route ranges of numbers and manipulate directory numbers before the Cisco CallManager passes them onto an adjacent system such as a central office (CO) or private branch exchange (PBX).
Caution
If a gateway has no route pattern associated with it, or it doesnt belong to a route group, it cannot route/block any calls.
Tips
You must reset gateways in order for new or updated routing information to be recognized. Resetting the gateway may result in a dropped call. The simplest route pattern is just a set of one or more digits. For example, the number 8912 is a route pattern. When assigned to a Cisco Access gateway or a route list, the Cisco CallManager directs any calls to 8912 to the assigned device. If called party transformations are configured, the Cisco CallManager manipulates the dialed address before passing the call to the route list or gateway.
Considerations for Using Route Patterns

If the route pattern contains an at symbol (@), the Discard Digits field can specify any of the PreAt discard digits instructions (DDIs). When @ is used in a routing pattern, the octothorpe (#) is automatically recognized as an end-of-dialing character for international calls. For routing patterns that don't use @, you must include the # in the routing pattern to be able to use the # character to signal the end-of-dialing.
Related Topics
The following list contains additional information related to this section:

Route Plan Overview, page 6-1 Understanding Route Pattern Wildcards and Special Characters, page 6-7 Understanding Closest-Match Routing, page 6-11
6-24
OL-1047-01
Chapter 6
Understanding Route Plans Understanding the External Route Plan Wizard
Adding a Route Pattern, page 26-1 Updating a Route Pattern, page 26-4 Copying a Route Pattern, page 26-5 Deleting a Route Pattern, page 26-6
Understanding the External Route Plan Wizard

The external route plan wizard generates a single tenant, multi-location, partitioned route plan for the North American Numbering Plan (NANP) area using information provided by the administrator through a series of prompts. The route plan generated by the external route plan wizard includes the following elements:

route filters route groups route lists route patterns partitions calling search spaces calling party digit translations and transformations access code manipulation
The following topics describe the basic concepts used when you generate route plans with the external route plan wizard:

Generated Route Filters, page 6-26 Generated Route Groups, page 6-27 Generated Route Lists, page 6-27 Generated Route Patterns, page 6-29
6-25
Chapter 6 Understanding the External Route Plan Wizard
Generated Route Filters

A generated route filter permits or restricts access through a route list using route patterns. The external route plan wizard associates each route list with a particular route filter. It names route filters using the TenantLocationCalltype convention, and appends the suffix RF to each route filter for easy identification. Table 6-4 shows the seven types of route lists that use route filters. The examples shown in this table use specific route filter names and actual access and area codes for better readability.
Table 6-4 Route lists and associated route filters
Route list type 911 calls
Route filter name and content examples Name: CiscoDallas911RF Content: 9.@ where (SERVICE == 911)
Local calls with metro Name: CiscoDallasLocalRF (7- and 10-digit) dialing Content: 9.@ where (LOCAL-AREA-CODE == 972) OR (LOCAL-AREA-CODE == 214) Local calls with 10-digit Name: CiscoDallasLocal10DCallRF dialing Content: 9.@ where (LOCAL-AREA-CODE == 972) OR (LOCAL-AREA-CODE == 214) Local calls with 7-digit dialing Name: CiscoDallasLocal7DCallRF Content: 9.@ where (AREA-CODE DOES_NOT_EXIST)(LOCAL-AREA-CODE DOES_NOT_EXIST) Name: CiscoTollByPassToDallasRF Content: 9.@ where (AREA-CODE == 972) OR (AREA-CODE == 214) Long distance calls International calls Name: CiscoDallasLongDistanceRF Content: 9.@ where (AREA-CODE EXISTS) Name: CiscoDallasIntlRF Content: 9.@ where (INTERNATIONAL-ACCESS EXISTS)
Toll bypass calls
6-26
OL-1047-01
Chapter 6
Generated Route Groups

A generated route group sets the order of preference for gateway and port usage. The external route plan wizard assigns one gateway to each generated route group. The wizard uses all ports on the gateways. It does not support using partial resources for generated external route plans. The external route plan wizard names route filters using the TenantLocationGatewaytypeNumber convention for easy identification. The gateway type is abbreviated as shown in the following list:

AA: analog access DA: digital access HT: H.323 trunk MS: MGCP station MT: MGCP trunk
The external route plan wizard identifies route groups associated with multiple gateways of the same type by attaching a number suffix to all route groups. For example, if there are three MGCP trunk gateways at the Cisco Dallas location, the external route plan wizard names the associated route groups CiscoDallasMT1, CiscoDallasMT2, and CiscoDallasMT3. If a route list includes more than one route group and more than one gateway (with one gateway for each route group), the order in which the external route plan wizard lists the route groups is arbitrary. The only order imposed is that route groups associated with the local gateways are listed before the route groups associated with remote gateways. If needed, change the order manually after the route plan is generated.
Note
All gateways belonging to a location are shared resources for that location.
Generated Route Lists

A generated route list sets the order of preference for route group usage and defines the route filters applied to those route groups. The external route plan wizard creates between five and seven route lists for each location depending on
6-27
the types of local dialing choices available. Therefore, the total number of route lists depends on the local dialing scheme and the number of locations served by the route plan. The external route plan wizard names route lists using the TenantLocationCalltype convention, and appends the suffix RL to each route list for easy identification. Table 6-5 shows the eight types of route lists. The example shown in this table use specific route list names for better readability.
Table 6-5 Route list types
Route list type 911 calls
Example route list name and usage Name: CiscoDallas911RL Use: This route list type is used for 911 emergency calls.
Enterprise calls
Name: CiscoDallasEnterpriseRL Use: This route list type is used for route plans that include Cisco CallManager to adjacent PBX calls. If the route plan does not include routing to an adjacent PBX, the wizard does not generate this route list type.
Local calls with metro dialing
Name: CiscoDallasLocalRL Use: This route list type is used for route plans that encompass both 7- and 10-digit dialing areas. This route list type generates two route lists: one for 7-digit dialing and another for 10-digit dialing. If you chose to generate a route plan using metro route lists, you cannot also choose 7- or 10-digit dialing route lists.
Local calls with 10-digit Name: CiscoDallasLocal10DCallRL dialing Use: This route list type is used for route plans that use 10-digit dialing. This route list type generates one route list for 10-digit dialing. If you chose to generate a route plan using a 10-digit dialing route list, you cannot also choose 7-digit or metro dialing route lists.
6-28
OL-1047-01
Chapter 6
Table 6-5
Route list types
Route list type Local calls with 7-digit dialing
Example route list name and usage Name: CiscoDallasLocal7DCallRL Use: This route list type is used for route plans that use 7-digit dialing. This route list type generates one route list for 7-digit dialing. If you chose to generate a route plan using a 7-digit dialing route list, you cannot also choose 10-digit or metro dialing route lists. Name: CiscoTollByPassToDallasRL Use: This route list type is used for intracluster calls that originate from a remote location, and get routed out the local gateway as local calls.
Toll bypass calls
Long distance calls
Name: CiscoDallasLongDistanceRL Use: This route list type is used for long distance toll calls.
International calls
Name: CiscoDallasIntlRL Use: This route list type is used for international toll calls.
Generated Route Patterns

A generated route pattern directs calls to specific devices and either includes or excludes specific dialed-digit strings. The external route plan wizard only generates route patterns that require an access code prefix. The typical route pattern for routing a call to the PSTN has the prefix construction 9.@. The typical route pattern for routing a call to the PBX has the prefix construction 9.9@. The external route plan wizard associates a route list, a route filter, and a partition with each route pattern. The route pattern provides the appropriate calling party transform mask, called party transform mask, digit discard instructions, and prefix digits for the associated route list.
6-29
The wizard bases route patterns for calls to an adjacent PBX on the access code and the range of directory numbers served by that PBX. For example, if the access code used to direct calls to the adjacent PBX is 9 and the range of directory numbers served by that PBX is 1000 through 1999, then the external route plan wizard generates the route pattern 9.1XXX for enterprise calls.
6-30
OL-1047-01
C H A P T E R
Understanding Device Support

Cisco CallManager controls Cisco voice devices (such as IP telephones and gateways), allowing you to configure voice to ensure proper call routing. These sections provide general information about how Cisco CallManager interacts with voice devices in your network:

Using DHCP and TFTP, page 7-1 Understanding Device Loads, page 7-6 Adding Devices to Cisco CallManager, page 7-10
Using DHCP and TFTP

Cisco telephony devices require IP addresses that are assigned manually or by using Dynamic Host Configuration Protocol (DHCP). Devices also require access to a TFTP server that contains device loads and device configuration name files (.cnf file format). The .cnf files provide parameters for connecting to Cisco CallManager.
Related Topics

Understanding DHCP and TFTP, page 7-2 Accessing the TFTP Server, page 7-3 Understanding How Devices Identify the TFTP Server, page 7-4
7-1
Chapter 7 Using DHCP and TFTP
Understanding DHCP and TFTP

DHCP automatically assigns IP addresses to devices whenever you plug them in. For example, you can connect multiple Cisco IP Phones anywhere on the IP network and DHCP automatically assigns IP addresses to them. If DHCP is not enabled on a device, you must assign it an IP address.

Cisco IP Phones are DHCP-enabled by default. If you are not using DHCP, you need to disable DHCP on the phone and manually assign it an IP address. DHCP is always enabled for Cisco Analog Access and Cisco Digital Access gateways. For Cisco Catalyst 6000 8 Port Voice T1/E1 and Services Modules, the Network Management Processor (NMP) on the Catalyst 6000 may or may not have DHCP enabled. If DHCP is not enabled, you will need to configure the IP address through the Cisco IOS command-line interface on the Cisco Catalyst 6000.
Obtaining an IP Address
If the device is using DHCP to obtain an IP address, the device queries the DHCP server to obtain one. If not, the statically configured IP address is used.
Accessing the TFTP Server
If DHCP is enabled on the phone, in addition to assigning an IP address, the DHCP server also directs the device to a TFTP Server. If the device has a statically defined IP address, you must configure the TFTP server locally on the device and then it will go to the TFTP server directly.
Requesting the Configuration File
The TFTP server has configuration files (.cnf file format) for devices that define parameters for connecting to Cisco CallManager. If auto-registration is enabled in Cisco CallManager, the phones access a default configuration file (sepdefault.cnf) from the TFTP server. If a phone has been manually added into the Cisco CallManager database, the phone accesses a .cnf file corresponding to its device name. For Cisco IP Phone 7960 and 7940 models, the .cnf file also contains phone button URL information. Gateways and other devices do not have default configuration files and they do not auto-register. All devices except phones must be manually added to the Cisco CallManager configuration database.
7-2
OL-1047-01
Chapter 7
Understanding Device Support Using DHCP and TFTP
Contacting Cisco CallManager
The configuration file for a device specifies a list of Cisco CallManagers to contact, in priority order. After obtaining the configuration file from the TFTP server, the device next attempts to make a TCP connection to the highest priority Cisco CallManager on the list. If the device was manually added to the database, Cisco CallManager identifies the device. If the device is a phone that was not manually added to the database and auto-registration is enabled in Cisco CallManager, the phone attempts to auto-register itself in the Cisco CallManager database. When a device connects to a Cisco CallManager, it is informed of its device load ID. If the device load ID differs from the load ID that is currently executing on the device, the device requests the load associated with the new load ID from the TFTP server and resets itself.
Accessing the TFTP Server

You can enable the IP phones and gateways to discover the TFTP server IP address in one or more of the following ways, depending on the device type:
Gateways and phones can use DHCP custom option 150. This is the method Cisco recommends. The TFTP server IP address is configured as the option value.
Gateways and phones can use DHCP option 066. Either the DNS Host Name or IP address of the TFTP server may be configured as the option value.
Gateways and phones can query CiscoCM1. The Domain Name Server (DNS) must be able to resolve this name to the IP address of the TFTP server.
Phones can be configured with the IP address of the TFTP server. If DHCP is enabled on the phone, an alternate TFTP server IP address can still be configured locally on the phone that will override the TFTP address obtained through DHCP.
7-3
Chapter 7 Using DHCP and TFTP
Gateways and phones also accept the DHCP Optional Server Name (sname) parameter. The phone or gateway can use the value of Next-Server in the boot processes (siaddr).
The TFTP server address is saved in non-volatile memory. If one of the above methods was available at least once, but is not currently available, the address saved in memory will be used. The TFTP server must subscribe to the Cisco CallManager Publisher (master database). For small systems, the TFTP server can co-exist with a Cisco CallManager on the same server.
Related Topics

Understanding DHCP and TFTP, page 7-2 Understanding How Devices Identify the TFTP Server, page 7-4
Understanding How Devices Identify the TFTP Server

Phones and gateways have an order of precedence that they use for selecting the address of the TFTP server if they receive conflicting or confusing information from the DHCP server. The order of precedence is based on the method used to specify the TFTP server (method 1 in the following list has the highest precedence):
1.
The phone or Catalyst 6000 gateway uses a locally configured TFTP server address. This address overrides any TFTP address sent by the DHCP server.
2.
The phone or gateway queries the DNS name CiscoCM1 and it is resolved. The phone or gateway always tries to resolve the DNS name CiscoCM1. If this name is resolved, then it overrides all information sent by the DHCP server. It is not necessary to name the TFTP server CiscoCM1, but you must enter a DNS CName record to associate CiscoCM1 with the address or name of the TFTP server.
7-4
OL-1047-01
Chapter 7
Understanding Device Support Using DHCP and TFTP
3.
The phone or gateway uses the value of Next-Server in the boot processes. This DHCP configuration parameter has traditionally been used as the address of the TFTP server. When configuring BOOTP servers, this field is typically referred to as the address of the TFTP server. This information is returned in the siaddr (server IP address) field of the DHCP header. Use this option, if available, because some DHCP servers will place their own IP address in this field when it is not configured.
4.
The phone or gateway uses the site-specific option 150. This option resolves the issue that some servers do not allow the Next-Server configuration parameter. Some servers allow access to the Next-Server parameter only when IP addresses are statically assigned.
5.
The phone or gateway uses the Optional Server Name parameter. This DHCP configuration parameter is the DNS name of a TFTP server. Currently only a DNS name can be configured in this parameter; a dotted decimal IP address should not be used.
6.
The phone or gateway uses the 066 option, which is the name of the boot server. Option 066 is normally used to replace the sname (server name) field when option overloading occurs. This name field can contain a DNS name or a dotted decimal IP address. The 066 option should not be used with the 150 option. If they are sent together, then the device prefers the IP address over the name given by the 066 option. However, if both a dotted decimal IP address and a 150 option are sent, then order of preference is dependent on the order that they appear in the option list. The device chooses the last item in the option list. To reiterate, option 066 and option 150 are mutually exclusive.
Related Topics

Understanding DHCP and TFTP, page 7-2 Accessing the TFTP Server, page 7-3
7-5
Chapter 7 Understanding Device Loads
Understanding Device Loads

There are four types of loads: phone loads, gateway loads, MTP loads, and conference bridge loads. Loads are files that contain updated firmware for devices. During installation or upgrade, the latest loads are automatically provided. However, you can also receive a load between releases that can contain patches or other information important to the devices that use loads, such as phones or gateways. Loads are stored in the ...Cisco\TFTPPath subdirectory as *.bin files, for example, D501A022.bin. During installation or upgrade, the latest loads are stored in this location. New loads you receive between releases must be copied to this location for the system to access them. See Table 7-1 for a description of the loads for each device type.
Table 7-1 Device Load Descriptions
Device Cisco IP Phone models 12S, 12SP, 12SP+, and 30VIP
Description Loads for these devices begin with P002..., for example, P002K202.
Cisco IP Phone model 30SP+ Loads for these devices begin with P001..., for example, P001K202. Cisco IP Phone 7960, 7940, 7910 Cisco Analog Access gateways Cisco Digital Access gateways Cisco Voice Gateway 200 Loads for these devices begin with P003..., for example, P003AM30. Loads for these devices begin with A001..., for example, A001P022. Loads for these devices begin with D003..., for example, D003C202. Not applicable.
7-6
OL-1047-01
Chapter 7
Understanding Device Support Understanding Device Loads
Table 7-1
Device Load Descriptions (continued)
Device Cisco Catalyst 6000 8 Port T1/E1 and Services Module
Description Loads for these devices vary depending on how the device is being used:

Conference Bridge loads begin with C001. Digital Gateway loads begin with D004. Transcoder loads begin with M001.
Cisco Catalyst 6000 24 Port FXS Analog Interface Module

Related Topics

Loads for these devices begin with A002.
Updating Device Loads, page 7-7 Verifying the Load on Cisco IP Phones, page 7-9
Updating Device Loads

You can apply a new load to a single device before applying it as a system-wide default. This is useful for testing purposes. Remember, however, that only the device you have updated with the new load will use that load. All other devices of that type use the old load until you update the system-wide defaults for that device with the new load.
Related Topics

Updating a Load on a Cisco IP Phone, page 7-8 Updating the Load on a Cisco Gateway, page 7-9 Updating Device Defaults, page 15-2
7-7
Chapter 7 Understanding Device Loads
Updating a Load on a Cisco IP Phone

Follow these instructions to update a load on a particular Cisco IP phone.
Procedure
Step 1 Step 2
Open Cisco CallManager Administration. Select Devices > Phone. The Find and List Phones page displays.
Enter search criteria to locate a specific phone. A list of discovered devices appears. Click Device Name. The Phone Configuration window appears.
Step 6
Enter the appropriate load in the Load Information field. Use uppercase for letters. For example, a phone might use load P002K202.
Step 7
Click Update. The information is saved in Cisco CallManager Administration. For the change to take effect, you must reset the phone. Only the phone you updated with the new load uses that load.
Related Topics

Updating a Phone, page 46-13 Verifying the Load on Cisco IP Phones, page 7-9 Updating Device Defaults, page 15-2
7-8
OL-1047-01
Chapter 7
Understanding Device Support Understanding Device Loads
Updating the Load on a Cisco Gateway

Follow these steps to update a load on a particular Cisco gateway.
Procedure
Open Cisco CallManager Select Device > Gateway. Enter search criteria to locate a specific gateway. A list of discovered gateways appears. Click Device Name. The gateway configuration page displays.
Step 6 Step 7
In the Load Information field, enter the appropriate load. Click Update. The information is saved in Cisco CallManager Administration. For the change to take effect, you must reset the gateway. Only the gateway you updated with the new load uses that load. To update all gateways of a specific type with a new load, you must update the device defaults for that type of gateway.
Related Topics

Updating Device Defaults, page 15-2 Configuring Gateways, page 45-1
Verifying the Load on Cisco IP Phones

You can verify the load locally on the Cisco IP phones. Follow these procedures to verify the load on the different phone types.
Cisco IP Phone 7960/7940
Using the Cisco IP Phone 7960/7940, follow these steps to verify the load version.
7-9
Chapter 7 Adding Devices to Cisco CallManager
Procedure
Press settings. Scroll to select Status. Press the Select soft key. Scroll to Firmware Versions. Press Select. The Application Load ID indicates the current firmware version.
Related Topics
Updating a Load on a Cisco IP Phone, page 7-8
Cisco IP Phone Models 12 SP+ and 30 VIP
On the phone whose load has been changed, press *. The display shows the letter and the last three digits of the phone load in use. For example, if you configured the phone with load P002K202, the display would read k2.02.
Adding Devices to Cisco CallManager

Before you can use devices, such as gateways and IP phones in your IP telephony network, you must add them to the Cisco CallManager configuration database. Refer to these sections for assistance in adding telephony devices to the Cisco CallManagers configuration database:

Adding a Phone, page 46-7 Adding Phone Button Templates, page 47-5 Adding Cisco uOne Ports, page 43-12 Adding Gateways to Cisco CallManager, page 45-7
7-10
OL-1047-01
C H A P T E R
Understanding Cisco WebAttendant

Cisco WebAttendant client-server application enables you to set up Cisco IP Phones as attendant consoles. The Cisco WebAttendant client provides a graphical user interface for controlling a Cisco IP Phone as an attendant console, including speed dial buttons and quick directory access for looking up phone numbers, monitoring line status, and directing calls. A receptionist or administrative assistant can use Cisco WebAttendant to handle calls for a department or company or an individual can use it. The Cisco WebAttendant client, a plug-in application, installs on a PC that has IP connectivity to the Cisco CallManager system. The client works in conjunction with a Cisco IP Phone that is registered to a Cisco CallManager (one client for each phone that will be used as an attendant console). Multiple clients can connect to a single Cisco CallManager. The Cisco Telephony Call Dispatcher (TCD) service running on the Cisco CallManager communicates with Cisco WebAttendant clients for call routing and control, monitors and reports line state, and services client database requests. Administrative tasks such as adding users, configuring pilot points and hunt groups for call routing, and starting and stopping the TCD service are performed using Cisco CallManager Administration. This section covers the following topics:

Cisco WebAttendant Configuration Checklist, page 8-2 Configuring Cisco CallManager for Cisco WebAttendant, page 8-3 Client Installation and Configuration, page 8-10 Cisco WebAttendant Redundancy, page 8-13 Tips and Troubleshooting, page 8-14
OL-1047-01
8-1
Chapter 8 Cisco WebAttendant Configuration Checklist
Cisco WebAttendant Configuration Checklist

The following table provides an overview of the steps you will need to complete to set up Cisco WebAttendants. Task Cisco CallManager Administration
Step 1 Step 2
Related Procedures and Topics Adding a Cisco WebAttendant User, page 32-10 Setting Up Cisco IP Phones for Use with Cisco WebAttendant, page 8-4 Configuring Pilot Points, page 32-2 Configuring Hunt Groups, page 32-5 Understanding Pilot Points and Hunt Groups, page 8-6
Add Cisco WebAttendant users. Make sure that each Cisco WebAttendant users Cisco IP Phone is set up correctly for use with Cisco WebAttendant. Set up pilot points and hunt groups.
Step 3
Step 4
Make sure the Telephony Call Dispatcher service is running on all Cisco CallManagers in the cluster.
Starting the Telephony Call Dispatcher, page 32-20 Understanding the Cisco Telephony Call Dispatcher, page 8-9
On Each Cisco CallManager in the Cluster

Step 5
Setting Up the wauser Shared Create a wauser shared directory with read/write access for Cisco WebAttendant Directory for Cisco WebAttendant, page 32-19 users. You must perform this step to ensure Cisco WebAttendant clients can display directory information. Sharing Default Directory Database Information section on page 8-11
8-2
OL-1047-01
Chapter 8
Understanding Cisco WebAttendant Configuring Cisco CallManager for Cisco WebAttendant
Task Cisco WebAttendant Client PCs

Step 6
Related Procedures and Topics Installing the Cisco WebAttendant Client, page 32-13 Configuring Cisco WebAttendant Client Settings, page 32-14 Cisco WebAttendant Client Requirements, page 8-10
Install and configure the Cisco WebAttendant client on each Cisco WebAttendant users PC.
Related Topics

Configuring Cisco WebAttendants, page 32-1 Cisco WebAttendant Redundancy, page 8-13 Tips and Troubleshooting, page 8-14
Configuring Cisco CallManager for Cisco WebAttendant

The topics in this section provide an overview of the Cisco CallManager server components that must be configured within Cisco CallManager Administration to set up Cisco WebAttendants.

Cisco WebAttendant Users, page 8-4 Setting Up Cisco IP Phones for Use with Cisco WebAttendant, page 8-4 Understanding Pilot Points and Hunt Groups, page 8-6 Understanding the Cisco Telephony Call Dispatcher, page 8-9
8-3
Chapter 8 Configuring Cisco CallManager for Cisco WebAttendant
Cisco WebAttendant Users

Before a user can log in to a Cisco WebAttendant client to answer and direct calls, they must first be added as a Cisco WebAttendant user and assigned a password. Cisco WebAttendant users are special user accounts that are created in the Cisco WebAttendant User Configuration page in Cisco CallManager Administration.
Note
Cisco WebAttendant user IDs and passwords are not the same as Directory users and passwords entered in the User area of Cisco CallManager. The Cisco WebAttendant user and password database is completely separate from the Cisco CallManager Directory user database. The Cisco WebAttendant User Configuration pages also enable administrators to delete Cisco WebAttendant users or to modify user IDs and password information.
Related Topics
Adding a Cisco WebAttendant User, page 32-10
Setting Up Cisco IP Phones for Use with Cisco WebAttendant

Cisco WebAttendant works in conjunction with a Cisco IP Phone. The MAC address that is defined in the Settings dialog box of the Cisco WebAttendant application links the Cisco CallManager, Cisco WebAttendant client, and the Cisco IP Phone. Configure the Cisco WebAttendant client to connect to the same Cisco CallManager server as its associated Cisco IP Phone. This means that the IP Address or Host Name field in the Cisco Telephony Call Dispatcher Settings section of the client Settings dialog box should be the address of the Cisco CallManager server to which the Cisco IP Phone is normally registered.
8-4
OL-1047-01
Chapter 8
Cisco IP Phones used with Cisco WebAttendant must meet the following guidelines:

Use Cisco WebAttendan with any Cisco IP Phone 7960/7940 models, Cisco IP Phone 12-Series model, or Cisco IP Phone 30VIP. Ensure the Cisco IP Phone is added as a device in Cisco CallManager before it is used with Cisco WebAttendant. Do not use a shared line appearance on any phone that will be used with Cisco WebAttendant. Directory numbers assigned to a Cisco IP Phone that is used with Cisco WebAttendant must not appear on any other device in the system. Ensure the Cisco IP Phone has buttons for Hold and Transfer for Cisco WebAttendant to work properly. If a headset will be used, ensure the phone has a headset button (Cisco IP Phone 7960/740 models) or an Answer/Release button assigned on the phones button template (older Cisco IP Phone models). Configure a maximum of eight lines for use with Cisco WebAttendant. The number of Smart Lines (SLs) available on Cisco WebAttendant is the same as the number of lines configured on the phone button template for the Cisco IP Phone, up to eight. Disable call waiting and call forwarding for lines and directory numbers on Cisco IP Phones used as Cisco WebAttendant consoles. If a Cisco WebAttendant user will be logging in to Cisco WebAttendant at more than one phone, ensure each phone is set up according to these guideline and that each phone is registered with its own Cisco WebAttendant client.
Related Topics

Configuring Cisco WebAttendant Client Settings, page 32-14 Understanding Default Phone Button Templates, page 47-1 Configuring Cisco IP Phones, page 46-5
8-5
Understanding Pilot Points and Hunt Groups

The Cisco Telephony Call Dispatcher must establish pilot points and hunt groups for call routing.
A pilot point is a virtual directory number for which the Telephony Call Dispatcher receives and directs calls based on a list of hunt group members. Ensure the pilot point number is unique throughout the system (it cannot be a shared line appearance). A hunt group comprises a list of destinations that determine the call redirection order.
When a call comes in to a pilot point, the Telephony Call Dispatcher uses the hunt group list for that pilot point to determine the call destination. TCD goes through the members in the hunt group in order until it finds the first available destination for routing the call. Specify a hunt group member as a directory number (device member) or as a Cisco WebAttendant user plus a line number (user member):

If a directory number is specified, TCD checks whether the line is available (not busy) and if it is, routes the call. If a user and a line number are specified, TCD checks whether the user is logged in to a Cisco WebAttendant and online before checking whether the line is available. If the user is logged in and online, and the line is available, TCD routes the call. The advantage of specifying a user and line number instead of a directory number is that the Cisco WebAttendant user can be logged in and online at any Cisco IP Phone controlled by Cisco WebAttendant software in the cluster and receive calls.
8-6
OL-1047-01
Chapter 8
Caution
When creating pilot point and hunt groups, be sure to consider overflow conditions. For example, if you have a single pilot point called Support, with three directory numbers, all three directory numbers could be busy when a fourth call comes in. In that case, no additional directory numbers exist to which the call can be routed. To handle overflow conditions, configure one or more hunt groups that route calls to multiple Cisco WebAttendants with the final directory number being voice mail. Make sure that Always Route Member is enabled for this voice mail number if TCD can perceive its line state. Otherwise, this voice mail number will not receive more than one call at a time.
Caution
Disable call waiting and call forwarding for lines and directory numbers on Cisco IP Phones used with Cisco WebAttendant consoles. Do not use shared line appearances for any phone used with Cisco WebAttendant.
Example
Assume a pilot point named Support exists at directory number 4000. The hunt group for the Support pilot point contains the following members:

Support Admin, Line 1 and Support Admin, Line 2 (Support Admin is the Cisco WebAttendant login for the administrative assistant for Support) Three directory numbers for support staff, 1024, 1025, and 1026, listed in the hunt group in that order A voice mail number, 5060, which is the final member of the hunt group
8-7
Figure 8-1 shows this example configuration.

Figure 8-1 Pilot Point and Hunt Group Example
Support Pilot Point 4000
Hunt Group members for Support Pilot Point Support Admin: Line 1 Support Admin: Line 2 1024 1025 1026 5060 9201 9202 9203 9204 Cisco WebAttendant phone
5060 Voice mail
Support staff directory numbers 1024 1025 1026
Support Admin logged in to Cisco WebAttendant
The following example describes a simple call routing scenario for the configuration shown in Figure 8-1.
1. 2.
A call is received and directed to the Support Pilot Point, directory number 4000. Because 4000 is a pilot point, the Telephony Call Dispatcher (TCD) associated with that pilot point checks the members in the hunt group in order, beginning with Support Admin, Line 1. TCD determines that the Support Admin user is not online, directory number 1024 is busy, directory number 1025 is busy, and directory number 1026 is available. TCD routes the call to the first available directory number, which is 1026. Because 1026 is available, the TCD never checks the 5060 number.
3.
Related Topics

Configuring Pilot Points, page 32-2 Configuring Hunt Groups, page 32-5
8-8
47073
OL-1047-01
Chapter 8
Understanding the Cisco Telephony Call Dispatcher

The Cisco Telephony Call Dispatcher (TCD), a Cisco CallManager service, provides communication among Cisco CallManager servers, Cisco WebAttendant clients, and the IP phones used with Cisco WebAttendant clients.
Note
If you are using Cisco WebAttendant in a cluster environment, ensure all Cisco CallManagers within a cluster have the TCD service installed and running. This is required for Cisco WebAttendant redundancy to work properly; however, not all TCDs are required to have a route point. TCD handles Cisco WebAttendant client requests for

Call control (making calls, answering calls, redirecting calls, putting calls on and taking calls off hold, and disconnecting calls) Call dispatching from pilot point directory numbers to the appropriate destination based on hunt groups Line status (unknown, available, on-hook, or off-hook) User directory information (TCD caches and periodically updates directory information for fast lookup by the Cisco WebAttendant client)
TCD also provides the mechanism for automated recovery for Cisco WebAttendant if a Cisco CallManager fails.
Note
When you add a new Cisco WebAttendant user or modify user ID and password information for an existing user, it will take approximately 6 minutes before the changes will take effect and the user can log in to Cisco WebAttendant.
Note
No automated recovery for a TCD failure exists. If TCD stops running, all Cisco WebAttendant clients connected to that TCD do not work. Restart TCD to correct the problem.
8-9
Chapter 8 Client Installation and Configuration
Related Topics

Cisco WebAttendant Redundancy, page 8-13 Starting the Telephony Call Dispatcher, page 32-20
Client Installation and Configuration

The Cisco WebAttendant client is a plug-in application that is installed on a PC that has IP connectivity to the Cisco CallManager server. Access it through the Microsoft Internet Explorer browser (version 4.0 or later). The Cisco WebAttendant provides a web-based GUI for using a Cisco IP Phone as an attendant console. The Cisco WebAttendant client application registers with and receives call dispatching services from the Telephony Call Dispatcher (TCD) services on the Cisco CallManager. Multiple Cisco WebAttendant clients can simultaneously be registered with a Cisco CallManager to use these services. The rest of this section discusses the following topics:

Cisco WebAttendant Client Requirements, page 8-10 Client Installation, page 8-11 Client Configuration, page 8-11
Cisco WebAttendant Client Requirements

The following list gives Cisco WebAttendant PC client requirements:

Operating systemMicrosoft Windows 98, Windows 2000, or Windows NT 4.0 (Service Pack 3 or greater) workstation or server Microsoft Internet Explorer 4.0 or later web browser with Active X enabled Display adapter color palette setting minimum of 256 colors; select 16-bit color or greater for optimal display. Network connectivity to the Cisco CallManager
8-10
OL-1047-01
Chapter 8
Understanding Cisco WebAttendant Sharing Default Directory Database Information
Client Installation
Access and install the Cisco WebAttendant client from the Cisco CallManager Application Plug-In Installation page. To locate the client plug-in, open Cisco CallManager Administration and choose Application > Install Plugins.
Related Topics
Installing the Cisco WebAttendant Client, page 32-13
Client Configuration
Configure each Cisco WebAttendant client to meet the following criteria:

Provide the Cisco WebAttendant user and password Connect to the correct Cisco CallManager TCD server and directory database Associate the MAC address of the Cisco IP Phone being used with the Cisco WebAttendant client with the Cisco CallManager server
Note
Ensure the Cisco WebAttendant client TCD IP Address or Host Name setting points to the Cisco CallManager server where its associated Cisco IP Phone is normally registered.
Related Topics

Configuring Cisco WebAttendant Client Settings, page 32-14 Sharing Default Directory Database Information, page 8-11
Sharing Default Directory Database Information

The Cisco WebAttendant client displays user and line information in the Directory section of its user interface. The Cisco TCD Database Path field in the Cisco WebAttendant client Settings dialog box controls where the Cisco WebAttendant client looks for its directory information.
8-11
Chapter 8 Sharing Default Directory Database Information
By default, the client uses cached directory information from the Cisco CallManager Directory user database. You can also set up the client to point to an alternate database.
Default Setting for TCD Database Path
The default setting leaves this field blank, so that the client uses the default database from the TCD associated with the Cisco WebAttendant client. This ensures that the client directory information automatically updates within 24 hours as changes are made to the Cisco CallManager directory database. Cisco recommends this setting. To ensure that this default setting works properly, the Cisco CallManager administrator must rename the C:\Program Files\Cisco\Users folder to wausers and set network security and share permissions so that all Cisco WebAttendant users have read and write access. Ensure this is done on all Cisco CallManagers in the cluster. For more information on how to do this, refer to the Setting Up the wauser Shared Directory for Cisco WebAttendant section on page 32-19.
Specifying a Location for the TCD Database Path
As an alternative to using the default setting (leaving the field blank), copy the file on the Cisco CallManager server named C:\Program Files\Cisco\Users\UsersDB1.mdb or C:\Program Files\Cisco\UsersDB2.mdb to a different location. (This could be a file in a different shared directory on the network or a file on the Cisco WebAttendant users PC.) You must then point the Cisco WebAttendant client to this file by entering the path to the file in the Cisco TCD Database Path field in the client Settings dialog box. Choosing to do this makes any database changes made through Cisco CallManager not automatically available to the Cisco WebAttendant client:
You must manually copy a new version of the database file to the new location when you need to update Cisco WebAttendant client users with database changes. Also, if you manually specify a TCD Database Path in the Settings dialog for the client, the client will use that setting until you change it.
If you change the TCD Database Path setting for a Cisco WebAttendant client, you must restart the client for the change to take effect.
8-12
OL-1047-01
Chapter 8
Understanding Cisco WebAttendant Cisco WebAttendant Redundancy
Related Topics

Setting Up the wauser Shared Directory for Cisco WebAttendant, page 32-19 Configuring Cisco WebAttendant Client Settings, page 32-14
Cisco WebAttendant Redundancy

The TCD service provides the mechanism for Cisco WebAttendant redundancy. If a Cisco CallManager fails, the following events occur:
Another TCD service running on a Cisco CallManager within the cluster takes over servicing of the route points associated with the failed Cisco CallManager. The Cisco WebAttendant clients that were attached to the failed TCD service attempt to locate and connect to the TCD service on the Cisco CallManager server where their associated Cisco IP Phone registered after failover.
When the Cisco CallManager comes back up, its TCD will resume servicing its route points and Cisco WebAttendant clients.
Note
For Cisco WebAttendant redundancy to work correctly, ensure all Cisco CallManagers in the cluster have TCD installed and running. You do not need to have route points configured for TCD services running on backup (standby) Cisco CallManagers in the cluster.
Note
No automated recovery for a TCD failure exists. If only TCD fails (and Cisco CallManager is still running), all Cisco WebAttendant clients connected to that TCD stop working. Restart TCD to correct the problem.
8-13
Chapter 8 Tips and Troubleshooting
Tips and Troubleshooting

This section provides information about the following topics:

Viewing Cisco WebAttendant Performance Monitors, page 8-14 Troubleshooting, page 8-16
Viewing Cisco WebAttendant Performance Monitors

The ScmLineLinkState performance monitor for Cisco WebAttendant provides a quick way to check whether Cisco WebAttendant is functioning correctly:

If the ScmLineLinkState counter is 11, TCD is functioning normally. The leftmost digit of ScmLineLinkState indicates whether TCD is connected to and registered with the Cisco CallManager CTI. If this digit is 0, a problem may exist with the CTI or the directory. The rightmost digit of ScmLineLinkState indicates whether TCD can perceive line state information through Cisco CallManager. If this digit is 0, a problem probably exists with Cisco CallManager.
To view ScmLineLinkState and other performance monitoring information for Cisco WebAttendant and TCD, perform the following procedure.
Procedure
Step 1 Step 2 Step 3 Step 4 Step 5 Step 6
Log in to the Cisco CallManager server. Choose Start > Programs > Administrative Tools > Performance. Click the View report data icon. Click the + (Add counter) icon. Choose System Monitor, enable All Counters, and choose Cisco WebAttendant from the Object drop-down list box. Click Add.
Figure 8-2 shows a sample performance report for Cisco WebAttendant and TCD.
8-14
OL-1047-01
Chapter 8
Understanding Cisco WebAttendant Tips and Troubleshooting
Figure 8-2
Sample Performance Counter Report for Cisco WebAttendant
The following list gives other performance monitoring information provided for Cisco WebAttendant:

HeartbeatNumber of seconds TCD has been running StartTimePlatform-based start time for this TCD TotalActiveCallsTotal number of active calls for this TCD TotalActiveLinesTotal number of active lines for this TCD TotalCallsTotal of all calls handled by this TCD TotalClients Number of Cisco WebAttendant clients associated with this TCD TotalCtiRoutePointsNumber of pilot points (route points) for this TCD
OL-1047-01
8-15
TotalOnlineClientsNumber of Cisco WebAttendant clients currently logged in and online TotalRedirectedCallsTotal number of calls redirected by pilot points (route points) for this TCD TotalRegisteredClientsNumber of Cisco WebAttendant clients registered with this TCD VersionTCD version
Troubleshooting
This section addresses questions you may have or situations you may encounter when administering Cisco WebAttendant.
Avoid these common configuration mistakes.
The Cisco WebAttendant user and client PC must have read/write access to the wauser shared directory on the Cisco CallManager. See the Setting Up the wauser Shared Directory for Cisco WebAttendant section on page 32-19 for instructions. Make sure that phones and pilot points are set up correctly for use with Cisco WebAttendant:

Do not enable call waiting or call forwarding for any phone used as a Cisco WebAttendant console. Do not use shared line appearance for any lines on any phones that are used with Cisco WebAttendant. Do not place pilot points in a partition. Always choose None as the partition for a pilot point. The final member of a hunt group must be able to handle overflow conditions. Ensure the final member of a hunt group a number for voice mail, auto attendant, or other device that can handle multiple, simultaneous calls. If TCD can perceive the line state of the voice mail number, enable the Always Route Calls option for the number. Otherwise, the voice mail number will not receive more than one call at a time.
8-16
OL-1047-01
Chapter 8
Understanding Cisco WebAttendant Tips and Troubleshooting
A user cannot log in to Cisco WebAttendant client.
Make sure that Cisco CallManager and TCD are both running. Check to see that the user has been added in the Cisco WebAttendant User Configuration area of Cisco CallManager Administration and that the correct user name and password are specified in the client Settings dialog box. Cisco WebAttendant users and passwords configured in the Cisco WebAttendant User Configuration area in Cisco CallManager Administration are not the same as directory users and passwords entered in the User area of Cisco CallManager. The Cisco WebAttendant user and password database is completely separate from the Cisco CallManager directory user database.
No directory information exists for a Cisco WebAttendant client.
Check to make sure that the Cisco Webattendant client setting for the TCD Database Path is correct and that no network security or access problems exist for the directory shared as wausers or network issues that prevent connection. The Cisco WebAttendant user and client PC must have read/write access to the wauser shared directory on the Cisco CallManager. See the Setting Up the wauser Shared Directory for Cisco WebAttendant section on page 32-19 for instructions. If you have modified the Shared As properties for the wausers folder, have the Cisco WebAttendant users log out of the Cisco WebAttendant client, log out of Windows, then log back in to Windows to make sure that the new sharing and permission settings are in effect.
Directory information is available, but no user can log in to Cisco WebAttendant.
This can occur due to a problem during Cisco CallManager installation (CTI Framework user not created). Contact the TAC if you receive this error message.
No Cisco WebAttendant users can log in to Cisco WebAttendant; no line state information is available.
Make sure that Cisco CallManager and TCD are both running. Check ScmLineLinkState to see whether Cisco CallManager and TCD are functioning normally. Refer to Viewing Cisco WebAttendant Performance Monitors section on page 8-14.
8-17
Cisco WebAttendant user cannot see line state for a phone that is connected to a gateway.
TCD can only monitor the status of internal devices and phone lines. A phone that connects to a gateway and gets its connection to the Cisco CallManager through the gateway is considered outside the system.
8-18
OL-1047-01
C H A P T E R
Understanding the LDAP Directory

This chapter provides background information and deployment guidelines for using Cisco CallManager with the embedded Lightweight Directory Access Protocol (LDAP) directory. This chapter is written for the administrator of the LDAP directory. If you are not responsible for LDAP administration, you can skip this chapter. This chapter includes the following topics:

Cisco CallManager Directory, page 9-1 Using the Embedded Directory, page 9-2
Cisco CallManager Directory

Cisco CallManager uses an LDAP directory to store authentication and authorization information about telephony application users. Authentication establishes a users right to access the system, while authorization identifies the telephony resources a user is permitted to use, such as a specific telephone extension. In this section, the term embedded directory is used to refer to the directory product that is provided with Cisco CallManager Release 3.0, The following sections describe how Cisco CallManager works with the embedded directory.
9-1
Chapter 9 Using the Embedded Directory
Using the Embedded Directory

Figure 9-1 illustrates how the embedded directory works with the other components of Cisco CallManager.
Figure 9-1 Using the Cisco CallManager Embedded Directory
Configuration (devices & extensions) Cisco CallManager Configuration (application & user profile)
Cisco CallManager embedded database
CallManager Administration
After the LDAP directory configuration is complete, you can upload completed workflow application files to it. The application server downloads these files to run workflow applications when you use the Administration client to start a specific application. This design allows you to start workflow applications from anywhere in the network, and to run them on application servers throughout the enterprise network. This chapter describes using the embedded directory in two different situations:

Scenario 1: Using the Embedded Directory, page 9-3 Scenario 2: Using the Embedded Directory on a Pilot System, page 9-4
9-2
OL-1047-01
44521
Cisco AVVID embedded LDAP Directory
Chapter 9
Understanding the LDAP Directory Using the Embedded Directory
Scenario 1: Using the Embedded Directory

This section describes a scenario in which a small business, Startup.com, implements Cisco CallManager using only the embedded directory.This scenario illustrates the following issues:

Using the Embedded Directory, page 9-3 Managing User Entries in the Embedded Directory, page 9-4

Startup.com is a fast-growing Internet business that currently has only 20 employees, but plans to add a large number of employees in the coming months. It is implementing Cisco CallManager with the embedded directory.
Figure 9-2 Using the Embedded Directory
Startup.com Embedded Directory
In this scenario, the Cisco CallManager administrator does not need to know anything about the LDAP directory, as shown in Figure 9-2.
44522
9-3
Managing User Entries in the Embedded Directory

The system administrator uses the Cisco CallManager Administrator User pages to manage user information and telephony resources. For more information, see Part 7 of the Cisco CallManager Administration Guide.
Scenario 2: Using the Embedded Directory on a Pilot System

Acme Communications is implementing Cisco CallManager on a pilot system, using the embedded directory for testing a deployment of 100 phones with Cisco CallManager and the workflow framework.
Figure 9-3 Using the Embedded Directory for a Pilot System
Pilot server Cisco CallManager Embedded Directory
In this scenario, the administrator creates an LDIF file for adding each pilot user to the embedded directory, as shown in the following example:
9-4
44525
OL-1047-01
Chapter 9
Understanding the LDAP Directory Using the Embedded Directory
Example 9-1
LDIF File for Adding Users to Acme Communications Pilot System
dn: cn=jsmith-CCNProfile, ou=CCN, o=acme.com changeType: add cn: jsmith-CCNProfile objectclass: top objectclass: ciscoCCNocAppProfile ciscoatProfileOwner: John Smith ciscoCCNatAllDevices: false ciscoCCNatControlDevices: SEP0010EB001801 ciscoCCNatControlDevices: SEP0010EB001B01 ciscoCCNatControlDevices: SEP0010EB003CF0 ciscoCCNatControlDevices: SEP0010EB003EA3 ciscoCCNatControlDevices: SEP0010EB003EC4 dn: cn=jsmith-profile, ou=CCN, o=acme.com changeType: add cn: jsmith-profile objectclass: top objectclass: ciscoocUserProfile ciscoatProfileOwner: John Smith ciscoatAppProfile: cn=jsmith-CCNProfile, ou=CCN, o=acme.com dn: cn=John Smith, ou=CCN, o=acme.com changeType: add cn: John Smith givenName: John sn: Smith mail: jsmith userPassword: jsmith objectclass: top objectclass: inetOrgPerson objectclass: ciscoocUser ciscoatUserProfile: cn=jsmith-profile, ou=CCN, o=acme.com
Managing Users in the Pilot System

During the pilot phase, the Cisco CallManager administrator can also add or modify users for testing purposes with the Cisco CallManager Administrator User configuration page. This page allows the administrator to enter or change only that information required to manage telephony resources for specific users.
9-5
9-6
OL-1047-01
C H A P T E R
10
Understanding Service Parameters

The Service Parameters configuration pages for Cisco CallManager (release 3.0 and later) allow you to configure several different services on selected servers. With the Service Parameters application, you can insert, modify, and delete service parameters for those services. Refer to the Service Parameter Restart Conditions section on page 35-2 for information on when a Cisco CallManager restart is required for certain parameters.
Caution
You will never need to add or delete service parameters unless directed to do so by the Cisco Technical Assistance Center (TAC). Some changes to service parameters may cause system failure.
Related Topics

Cisco CallManager Service Parameters, page 10-2 Cisco TFTP Service Parameters, page 10-21 Cisco Messaging Interface Service Parameters, page 10-22 Cisco IP Voice Media Streaming Service Parameters, page 10-28 Cisco Database Layer Service Parameters, page 10-29 Cisco Telephony Call Dispatcher Parameters, page 10-31
10-1
Chapter 10 Cisco CallManager Service Parameters
Cisco CallManager Service Parameters

Caution
You will never need to add or delete service parameters unless directed by the Cisco Technical Assistance Center (TAC). Some changes to service parameters may cause system failure.
Note
If you must modify trace parameters, Cisco strongly recommends doing so from the Trace Configuration page. Refer to the Configuring Trace section on page 36-1 for more information. Table 10-1 provides service parameters configured for Cisco CallManager.
Table 10-1 Cisco CallManager Service Parameters
ParamName AbleToEstablishMF
Values Default: T
Description Used for certification testing. Cisco recommends that you do not change the default value. Valid values are T or F. This setting sends the SABME at startup instead of waiting for the distance end to do it. Specifies the mixer type to be used for AdHoc conferences. If the mixer type is set to Unicast Bridge, when a user presses the Conference button on the phone, the conference supplementary service allocates a Unicast Bridge resource to handle the conference.
AdHocConferenceMixerType
Default: 2
10-2
OL-1047-01
Chapter 10
Understanding Service Parameters Cisco CallManager Service Parameters
Table 10-1 Cisco CallManager Service Parameters (continued)
ParamName AdvancedCallForwardHopFlag
Values Default: F
Description When AdvancedCallForwardHopFlag = false: When selecting the next voicemail port, the Cisco CallManager call forward feature does not skip the busy or unregistered voicemail port; instead, the call is extended to the busy or unregistered voicemail port, is rejected, and is then forwarded to the next voicemail port. When AdvancedCallForwardHopFlag = true: When selecting the next voicemail port, the Cisco CallManager call forward feature skips the busy or unregistered voicemail port, the call is extended to the available voicemail port so that the voicemail ports are selected more efficiently.
AlwaysUsePrimeLine
Default: F
T = When phone goes offhook, or the speaker button is pressed, the first line becomes active; but not any additional lines. Example: If a call comes in on a users second line, going offhook makes only the first line active. The user must select the second line, in addition to going offhook to answer the call.
AnalogAccessUse729 AutoSelectHeldCallFlag
Default: F Default: F
Not supported for Cisco CallManager Release 3.0. Determines whether to automatically select the call on hold when the phone goes offhook if that call was the last signal sent to the phone.
CallAcceptTimer CallDiagnosticsEnabled
Default: 10 Specifies the maximum time an application has to accept a call offered at a CTI port or route point. Default: F Determines whether call diagnostic records are generated. Valid values are F = not generated T = generated
CallParkReversionTimeout
Default: 60 Designates the number of seconds to wait before reverting a parked party to the user who parked the call. Valid value is any numeric value.
OL-1047-01
10-3
ParamName CallWaitingEnable CallWaitingTimeout
Values Default: T Default: 180
Description Enables or disables call waiting for the entire system. Designates the number of seconds that a caller hear s ringback (alerting tone) if the person the caller is calling is in one of these states:

Internal to the Cisco AVVID (Architecture for Voice, Video, Integrated Data) system On the phone Has Call Waiting enabled Does not have Forward enabled
CcmPriorityClass
Default: 0
CcmPriorityClass = 0: Cisco CallManager process runs in normal priority class. CcmPriorityClass = 1: Cisco CallManager process switches between normal and high priority class every second. CcmPriorityClass = 2: Cisco CallManager process runs in high priority class.
CdrEnabled
Default: F
Determines whether Call Detail Records (CDRs) are generated. Valid values are T = CDRs are generated F = CDRs are not generated
CdrLogCallsWithZeroDuration Flag Default: F ClearCallsWhenDatalinkGoes Down Default: T
Enables logging of CDR records for calls that never connected or that lasted less than 1second. Determines whether calls to the phones terminate if the D-channel (datalink) terminates. Valid values are 0 = Do not clear calls when datalink goes down 1 = Clear calls when datalink goes down
10-4
OL-1047-01
Chapter 10
ParamName ConnectDisconnectTimer
Values Default: 7
Description Used for debugging purposes only. Cisco strongly recommends you do not change the default value. Parameter designates the maximum time allowed for a response from a connect or disconnect request. Valid value is any numeric value.
CtiApplicationHeartBeatTime CTINewCallAcceptTimeout
Default: 30 Specifies the interval at which CTI sends heartbeat polls to applications. Default: 4 (seconds) Specifies timeout interval. Timer ensures that, for calls made into CTI ports and CTI route points, the calls are not suspended, so that callers hear only silence; if the CTI application controlling the CTI ports/route points does not handle the call. After the Cisco CallManager notifies the application (using JTAPI/TAPI) of an incoming call at a CTI port or CTI route point, the Cisco CallManager waits for a configurable time for the application to handle the call (as in accept, answer, redirect, or disconnect). If the application does not respond within the set time, Cisco CallManager forwards the call to the call forward busy number configured for the CTI port or CTI route point. If no call forward busy is configured, caller receives a fast busy tone.
10-5
ParamName CTIRequestTimeout
Values Default: 5 (seconds)
Description Specifies timeout interval. Timer ensures responses to CTI requests are generated for situations where network or remote Cisco CallManager node problems prevent the normal processing of the CTI requests. This timer services the following specific CTI requests:

LINE_CALL_INITIATE_REQUEST CALL_ACCEPT_REQUEST CALL_ANSWER_REQUEST CALL_BLIND_TRANSFER_REQUEST CALL_DISCONNECT_REQUEST CALL_HOLD_REQUEST CALL_RETRIEVE_REQUEST CALL_SETUP_CONFERENCE_REQUEST CALL_SETUP_TRANSFER_REQUEST
DbNoActivityTimeout
Default: 30 Denotes the time to wait before closing the file after no database requests received. Valid value is any numeric value. Default: 300000 Denotes the time between two change of port status messages. Do not modify the default value.
DeviceStatusPollInterval_msec DialPlanPath
Notifies the digit analysis component where to Default: c:\Program find national dial plan files. Files\Cisc o\DialPlan Default: 6 Used for debugging purposes only. Cisco strongly recommends that you do not change the default value. Timer designates the maximum time allowed for a response from a digit analysis requests. Valid value is any numeric value.
DigitAnalysisTimer
10-6
OL-1047-01
Chapter 10
ParamName DisplayIEDeliveryFlag
Values Default: F
Description Enables the delivery of the display IE in SETUP and CONNECT messages for the calling and called party name delivery service when set to T. Designates whether silence plays. When this flag is set, the digital gateway does not play silence after receiving the Alert message. This may enable a full duplex path before the Connect message is received on ISDN calls. Enables the collection of SNMP data from the Cisco CallManager.
DtSilenceFlag
Default: F
EnableSNMP ForwardMaximumHopCount
Default: T
Default: 12 Designates maximum number of attempts to extend a forwarded call. Valid value is (Value >=1) Default: 12 Designates the number of seconds to wait before forwarding on No Answer Condition. Valid value is (Value >=1) Denotes H.323 Gatekeeper Control Registration Type. Cisco strongly recommends that you do not change this parameter unless you have a complete understanding of RAS registration.
ForwardNoAnswerTimeout
GatekeeperControlRegistration Type Default: F
GatekeeperRefresh GatewayKeepAliveTimeout GatewayPollTimeout
Default: 60 Designates the number of seconds between seconds gatekeeper refresh messages. Default: 25 Designates the number of seconds between gateway status messages. Default: 10 Designates the number of seconds to wait for a response from a GatewayOpenReq. Valid value is any numeric value. Default: 0 Determines, on an outgoing H.323/H.225 call, whether processing the open logical channel (when audio is transmitted) on the call proceeding, call alerting, or call connecting.
H225ConnectTime
10-7
ParamName HoldType
Values Default: F
Description Designates originator new hold type. Original Hold Type requires the user to press the hold button to retrieve a call from hold. The new hold type allows the user to press the line button on which the held call is stored to retrieve it. Applies only to the DMS100 protocol for the digital access gateway in the Channel Identification IE of the SETUP, CALL PROCEEDING, ALERTING, and CONNECT messages. This parameter interoperates with Nortel PBX when the PBX is configured to use the DMS100 protocol. Used by anyone who configures streaming, phones, media applications, etc. Cisco strongly recommends that this parameter never be changed. Controls class of service of IP traffic and signals between Cisco CallManager to Cisco CallManager.
InterfaceIdentifierPresentFlag
Default: F
IpPrecedence
Default: 0x000000 B0 Default: 3
IpTosCm2Cm
Note
The following list shows that the valid value for IpTosCm2Cm is between 0 and 7 and is represented as follows: 0 = routine 1 = priority 2 = immediate 3 = flash 4 = flashOver 5 = critical 6 = internet 7 = network
10-8
OL-1047-01
Chapter 10
ParamName IpTosCm2Dvce
Values Default: 3
Description Controls class of service of IP traffic and signals between Cisco CallManager to device. Controls class of service of IP traffic and signals between Cisco CallManager to Cisco CallManager.
Note
The following list shows the valid value for IpTosCm2Dvce is between 0 and 7 and is represented as follows: 0 = routine 1 = priority 2 = immediate 3 = flash 4 = flashOver 5 = critical 6 = internet 7 = network
L2RetriesN200
Default: 3
Designates the number of retries before declaring the datalink down. Valid value is any numeric value. Determines whether Line State Server (used by Cisco WebAttendant) can track the active/inactive states of each line/directory number. Designates whether when low-priority TCP queue gets too large, the system starts throwing away new call attempts.
LineStateUpdateEnabled
Default: T
LowPriorityQueueThrottling Flag
Default: F
10-9
ParamName LowPriorityQueueThrottling MaxCount
Values Default: 1000
Description Designates the maximum number of outstanding low-priority stimulus messages in the queue before new call attempts are discarded. Use this value to adjust call response time. Valid value is any numeric value.
MGCPConnectTime
Default: 30 Designates that all the responses sent by Media seconds Gateway are kept in memory for a certain time. Default for this duration is set to 30 seconds. You should not change this value. Default: 30 Designates that all the responses sent by Media Gateway are kept in memory for a certain time. Default for this duration is set to 30 seconds by default.
MGCPRespTimeout
Note
You should not change this value.
MGCPTimeout MatchingCgpnWithAttendant Flag
Default: 5 seconds Default: F
Designates the number of seconds to wait before Cisco CallManager retries its request. Compare whether the calling party number matches one of the associated analog access ports on an outbound analog access gateway call. If so, select that port; otherwise, make it so all ports with an attendant number assigned to them are not usable for the life of the current call. This forces selection of another analog access device if another analog access gateway was configured in RoutePoint/RouteGroup. If another analog access gateway was not configured, the user hears a fast busy signal. Specifies the maximum number of participants per port that can be added to a Unicast ad-hoc conference.
MaxAdHocConference
Default: 4 Max: 32
10-10
OL-1047-01
Chapter 10
ParamName MaxCTI Connections
Values Default: 400
Description Designates the maximum number of CTI connections. Cisco CallManager allows a maximum number of CTI connections. Typically, each CTI application (or instance of the application) has a single CTI connection to the Cisco CallManager; for example, each Softphone instance has a single CTI connection to the Cisco CallManager. This limit on the number of CTI connections is independent of the number of CTI devices that the application can control. Specifies the number of errors to report per data link establishment. Valid value is any numeric value.
MaxErrorsToReport
Default: 1
MaxMeetMeConferenceUnicast MaxNumberOfReceivedIFrames BeforeAcking
Default: 10 Specifies the maximum number of participants per port that can join a Unicast Meet-Me conference. Max: 32 Default: 0 Specifies number of receive 5 I-Frames received before responding with a receiver ready (RR) for an acknowledgement (ACK). Valid value is any numeric value.
MaxNumberOfStationsIniting
Default: 50 Designates the maximum number of stations that can try to initialize without completing all database requests. Under a heavy load, calls can overwhelm the system to the point where no calls can complete. Set these values to restore usability if the system becomes overwhelmed. Decreasing the LowPriorityQueueThrottlingMaxCount provides faster dial tone but also increases the chances for calls being rejected. Valid value is any numeric value.
10-11
ParamName MaxStationsInitPerSecond
Values
Description
Default: 10 Parameter is an integer with a value usually between 5 and 15. This parameter throttles the number of phones allowed to concurrently register with Cisco CallManager without being queued.
Note
If the performance value is set too high, then phone registrations could slow the Cisco CallManagers real time response. If set too low, the total time for a large group of phones to register will be slow.
MediaExchangeInterfaceCaps Timeout MediaExchangeTimeout MessageWaitingOffDN
Default: 8
Specifies the time for a device to send capabilities for a media connection. Valid value is any numeric value. Specifies the time for a media connection to be made. Valid value is any numeric value. Specifies the directory to which calls from a voicemail system are directed to disable or turn off the message waiting light for the specified calling party. Specifies the directory number to which calls from a voicemail system are directed to enable or turn on a message waiting light for the specified calling party.
Default: 5
MessageWaitingOnDN
10-12
OL-1047-01
Chapter 10
ParamName NumberingPlanInfo
Values Default: 1
Description Gives some control over the ISDN Numbering Plan Information field on the Called Party Number. This control that is available for H.323 calls and ISDN calls has the following characteristics:

If set to 0: disabled If set to 1: a check determines what the ISDN Type of Number on the called party information element is. If the Type of Number is set to UNKNOWN, the Numbering Plan Information is also set to UNKNOWN. If set to 2: The Numbering Plan Information is set to a PRIVATE PLAN, and the Type of Number is set to UNKNOWN.
OutOfBandwidthText
Designates the text to be displayed when the call Default: cannot be placed because not enough bandwidth Not exists. Enough Bandwidth Default: 7 Specifies the maximum number of outstanding I-Frames that are not acknowledged. Valid value is any numeric value. Cisco strongly recommends using the default setting for this parameter.
OutStandingIFramesK
OverlapReceivingForPriFlag PreferredG711Millisecond PacketSize PreferredG723Millisecond PacketSize PreferredG729Millisecond PacketSize
Default: F
Default: 20 Specifies the preferred time set for delivering packets. To avoid adding latency, never set value for this parameter below 20. Default: 30 Specifies the preferred time set for delivering packets. To avoid adding latency, never set this parameter below 20. Default: 20 Specifies the preferred time set for delivering packets. To avoid adding latency, never set this parameter below 20.
10-13
ParamName RASMulticastFlag
Values Default: F
Description Allows multicast registration of RAS. Caution: Do not set this parameter unless you want all RAS devices to register to Cisco CallManager. Applies to the SETUP message only on all protocols for the digital access gateway. When the flag is set to True, the SETUP message includes RedirectingNumberIE to indicate the first redirecting number and the redirecting reason of the call when Call Forward happens. Specifies when set to true that devices that have the same selection order in a route group, and are associated with a route list, are re-ordered when a call is placed using the associated route list. You should not change this value. Specifies the maximum number of Cisco CallManager exceptions before Cisco CallManager stops running.
RedirectingNumIEDeliveryFlag
Default: F
ReorderRouteList
Default: F
SdlListeningPort SdlMaxUnHandledExceptions
Default: 8002 Default: 5
SdlTraceDataFlags
Default: Provides a bit mask used for enabling tracing of 0x0000011 SDL non-application-specific components or for modifying the behavior of SDL tracing. 0 Default: 100 Used in the SDL layer. Parameter tells SDL trace processing how many bytes of raw data to dump from each signal that it traces.
SdlTraceDataSize
SdlTraceFilePath
Specifies the absolute path where SDL trace files Default: c:\Program are located. File\Cisco\ Trace\SDL \ Default: T Indicates whether SDL traces should be turned on or off. It is set to true by default, so that SDL traces are collected by default.
SdlTraceFlag
10-14
OL-1047-01
Chapter 10
ParamName SdlTraceMaxLines
Values Default: 10000 Default: 100 Default: 0x00004B 05 Default: T Default: T Default: F
Description Specifies the maximum number of lines in each file before starting the next file. Valid value is any numeric value. Specifies the maximum number of files before restarting file count and overwriting old files. Provides an application-specified bit mask used for the application tracing and signal tracing. Determines whether silence suppression is disabled for all devices on a system-wide basis. Determines whether silence suppression is disabled for all devices on gateways. Used for certification testing. Cisco recommends you do not change the default value.
SdlTraceTotalNumFiles SdlTraceTypeFlags
SilenceSuppressionSystemWide SilenceSuppressionWith Gateways StableIn4Flag Station2ndKeepaliveInterval StationKeepaliveInterval
Default: 60 Designates the Keepalive Interval for backup server. Default: 30 Designates the number of seconds between keepalive messages sent to Cisco IP Phones (stations). Use any numeric value starting at 30. Cisco recommends you do not use the 0 value. Default: T Determines whether system statistics are generated. Valid values are F = not generated T = generated
StatisticsEnabled
StatusEnqPollFlag
Default: F
Sends status enquiries to H.323 devices to check for out-of-range status. If the device is determined to be out of range, the call terminates. If the device is within range, sending these status enquiries does not disrupt call connection. Enables the stripping of # sign digits from the called party IE, of the inbound and outbound Q.931 and H.225 SETUP message.
StripPoundCalledPartyFlag
Default: T
10-15
ParamName StopRoutingOnOutOfBandwidthFla g
Values Default: F
Description Specifies when set to true, that if a call being routed through a route list detects the associated cause during the release of the call, no re-routing to the next device in the route list is attempted and the call is released with the associated cause. Specifies when set to true, that if a call being routed through a route list detects the associated cause during the release of the call, no re-routing to the next device in the route list is attempted and the call is released with the associated cause. Specifies when set to true, that if a call being routed through a route list detects the associated cause during the release of the call, no re-routing to the next device in the route list is attempted and the call is released with the associated cause. Used for debugging purposes only. Cisco strongly recommends that you do not change the default value. Determines whether out of channels responses will be sent to event processing. Sometimes the other end does not get back fast enough with the Alert, Progress, or Connect while in Call_initiated state. Valid value is any numeric value in 1/8 second ticks. Designates Layer 2 Retransmission time. This is the only timer value that is in 1/40-second ticks; all other values are in 1/8 second ticks. Valid value is any numeric value in 1/40-second ticks. Designates Layer 2 Keepalive interval. Valid value is any numeric value in 1/8 second ticks.
StopRoutingOnUnallocatedNumber Flag
Default: F
StopRoutingOnUserBusyFlag
Default: F
SuppressOutOfChansEvents
Default: T
TimerSendProgress_msec
Default: 3000 Default: 2000 Default: 1000
TimerT1Frame_msec TimerT200_msec
TimerT203_msec
Default: 10000
10-16
OL-1047-01
Chapter 10
ParamName TimerT301_msec
Description Specifies User-(Call Delivered) ALERTING Received, Network-(Call Received) ALERTING Received. Valid value is any numeric value in 1/8-second ticks. Specifies interdigit timeout for User-(Overlap Receiving) SETUP ACK sent, Network-(Overlap Sending) SETUP ACK sent. Valid value is any numeric value in 1/8-second ticks. Specifies User-(Call Initiated) SETUP sent, Network-(Call Present) SETUP sent. Valid value is any numeric value in 1/8-second ticks. Specifies User-(Overlap Sending) SETUP ACK received, Network-(Overlap Receiving) SETUP ACK received. Valid value is any numeric value in 1/8-second ticks. Specifies User-(Disconnect Request) DISCONNECT sent, Network-(Disconnect Indication) DISCONNECT without progress ind sent. Valid value is any numeric value in 1/8-second ticks. Specifies Network-(Disconnect Indication) DISCONNECT with progress ind sent. Valid value is any numeric value in 1/8-second ticks. Specifies Network-(Null) SUSPEND ACK sent. Valid value is any numeric value in 1/8-second ticks. Specifies User-(Release Request) RELEASE sent, Network-(Release Request) RELEASE sent. Valid value is any numeric value in 1/8-second ticks. Specifies User/Network-(Any stable State) Datalink lost. Valid value is any numeric value in 1/8-second ticks.
TimerT302_msec
Default: 10000
TimerT303_msec
TimerT304_msec
TimerT305_msec
Default: 30000
TimerT306_msec
Default: 30000 Default: 180000 Default: 4000 Default: 90000
TimerT307_msec
TimerT308_msec
TimerT309_msec
10-17
ParamName TimerT310_msec
Description Specifies User-(Outgoing Call Proceed) CALL PROCEED received, Network-(Incoming Call Proceed) CALL PROCEED received. Valid value is any numeric value in 1/8-second ticks. Specifies User-(Connect Request) CONNECT sent. Valid value is any numeric value in 1/8-second ticks. Specifies (Restart Request) RESTART sent. Valid value is any numeric value in 1/8-second ticks. Valid value is any numeric value in 1/8 second ticks. Specifies (Any state) D-Channel failure. Valid value is any numeric value in 1/8-second ticks. Specifies (Any state) STATUS ENQUIRY sent. Valid value is any numeric value in 1/8-second ticks. Specifies (Any state) Timer initially used to send a StatusEnq to check whether Symbol H.323 phone is still attached. Valid value is any numeric value in 1/8-second ticks. Specifies the time to wait to send a receiver ready (RR) acknowledgement on a given non poll I-Frame. Valid value is any numeric value in 25-millisecond ticks. 0 = send immediately. Designates flag to set tone on call forward on or off.
TimerT313_msec
Default: 4000 Default: 120000 Default: 300000 Default: 30000 Default: 4000 Default: 10000
TimerT316_msec TimerT317_msec TimerT321_msec TimerT322_msec
TimerTStatusEnqPoll_msec
TimeToDelayBeforeSendingAn Ack_msec
Default: 0
ToneOnCallForward ToneOnHoldTime
Default: T
Default: 10 Specifies the number of seconds to play some type of tone when a call is on hold (minimum of 5 Min: 5 seconds). Max: 99999
10-18
OL-1047-01
Chapter 10
ParamName TosBitPosition
Values Default: 3
Description Allows setting a bit between bit 0 and bit 4 along with IPTOS settings to make it compatible with Cisco DIFF-SERV (Differentiated Service). Specifies whether Cisco CallManager sends H225 user information message. When ToSendH225UserInfoMsg = false Cisco CallManager does not send out the H225UserInformation message. When ToSendH225UserInfoMsg = true Cisco CallManager sends out the H225UserInformation message.
ToSendH225UserInfoMsg
Default: F
TypeOfCalledNumberForH225Devic Default: 0 es
Denotes the type of number (TON) for H225 devices. The default value is 0, which denotes the value sent by call control. A value of 1 indicates an unknown number. A value of 2 denotes a national number, and 3, an international number.
Refer to the Configuring Trace section on page 36-1 for descriptive and configuration information on all trace parameters. UnknownCallerId Designates the directory number to be displayed. Valid value is any numeric value representing a general number for your system (if you wish to provide caller ID functionality to called parties). Valid value is any valid telephone number. Default: T Relates to the Unknown CallerId field. Cisco strongly recommends using the default setting because this flag can now be configured using Cisco CallManager Administration. Specifies the text to be displayed to called parties who have caller ID capability. The first line is 20 characters, and the second line is 14 characters. Use a character setup that can be broken into two lines, each of which has the specified number of characters per line.
UnknownCallerIdFlag
UnknownCallerIdText
Default: Unknown
10-19
ParamName UserUserIEStatus
Values Default: F
Description Designates whether the user-to-user information element (UUIE) is passed in the system. Enabling UUIE status allows ISDN PRI messages to include them on outbound PRI calls. Specifies the number that is dialed when the message button on the phone is pressed.
VoiceMail VoiceMailMaximumHopCount
Default: F
Default: 12 Used together with AdvancedCallForwardHopFlag, allows the Cisco CallManager to select the next available voicemail port by skipping the busy or unregistered voicemail ports.
Note
Set VoiceMailMaximumHopCo unt to the number of voicemail ports in the system.
Related Topics
Configuring Service Parameters, page 35-1
10-20
OL-1047-01
Chapter 10
Understanding Service Parameters Cisco TFTP Service Parameters
Cisco TFTP Service Parameters

Caution
Never add or delete service parameters unless directed to do so by the Cisco Technical Assistance Center (TAC). Some changes to service parameters may cause system failure.
Note
If you must modify trace parameters, Cisco strongly recommends doing so from the Trace Configuration page. Refer to the Configuring Trace section on page 36-1 for more information. Table 10-2 provides service parameters configured for Cisco TFTP.
Table 10-2 Cisco TFTP Service Parameters
ParamName AnalogTcpPort CallManagerIp CallManagerIpTrack ChangeUDPPort DigitalTcpPort FileDelete
Values Default: 2002 Default: 127.0.0.1 Default: T Default: 3000 Default: 2001 Default: T
Description Not used under normal circumstances. Not used under normal circumstances. Not used under normal circumstances. Do not change this parameter. Not used under normal circumstances. Flag that enables configuration file deletion to ensure deleted devices do not still get configuration files.
FileLocation
String that represents the primary path for building Default: c:\Program Fil and serving files. es\Cisco\TFTP path Default: 2000 Default: T Not used under normal circumstances. When set to True, Cisco CallManager uses default local IP address. Do not change this parameter.
PhoneTcpPort ServerIpTrack
10-21
Chapter 10 Cisco Messaging Interface Service Parameters
Table 10-2 Cisco TFTP Service Parameters (continued)
ParamName TFTPIp
Values Default: 127.0.0.1
Description String that represents the IP address of the TFTP server if ServerIpTrack is false.
Refer to the Configuring Trace section on page 36-1 for descriptive and configuration information on all trace parameters. UseDb Default: T
Related Topics

Do not change this parameter.
Configuring Service Parameters, page 35-1 Configuring Cisco TFTP, page 31-1 Configuring Trace, page 36-1 Understanding Trace Configuration, page 36-2 Table 36-4 provides the trace parameters for Event Type, User Mask, and Date and Time, page 36-9
Cisco Messaging Interface Service Parameters

Caution
Do not add or delete service parameters unless directed to do so by the Cisco Technical Assistance Center (TAC). Some changes to service parameters may cause system failure.
Note
If you must modify trace parameters, Ciscostrongly recommends doing so from the Trace Configuration page. Refer to the Configuring Trace section on page 36-1 for more information. Table 10-3 provides service parameters configured for Cisco Messaging Interface (CMI).
10-22
OL-1047-01
Chapter 10
Understanding Service Parameters Cisco Messaging Interface Service Parameters
Table 10-3 Cisco Messaging Interface (CMI) Service Parameters
ParamName BackupCallManagerName
Values
Description This parameter defines the names of the Cisco CallManagers that are going to be used for the CMI backup. You can use either the name of a Cisco CallManager or its IP address.
BaudRate
Recommended default: 9600
This parameter defines the EIA/TIA-232 connection that Cisco CallManager uses to connect to the voicemail system.
Note
Many voicemail systems can be configured to use different baud rates, but the one shown here will frequently be correct.
CallManagerName
If the default is left blank, CMI will choose the Cisco CallMan ager, if existing on a local machine. Default: 7
This parameter defines the names of the Cisco CallManagers that are going to be used for the primary CMI. You can use either the name of a Cisco CallManager or its IP address.
DataBits
This parameter defines the EIA/TIA-232 connection that Cisco CallManager uses to connect to the voicemail system..
10-23
Table 10-3 Cisco Messaging Interface (CMI) Service Parameters (continued)
ParamName DialingPlan
Values
Description CMI requires this parameter as one of four to register an intercept for the voicemail system with which CMI is going to work.
Note
Small systems without a complex dialing plan usually only need the VoiceMailDn parameter. The remaining parameters, DialingPlan, RouteFilter, and VoiceMailPartition, will default to empty strings.
InputDnSignificantDigits
Default: 10
This parameter accommodates the differences between voicemailbox numbers and directory numbers (DNs). If a legacy voicemail system has mailbox numbers that are no longer than the DNs on the system, use this parameter to strip the most-significant digits. The numeric value of this parameter indicates how many digits should be used. For this string parameter for most voicemail systems, a value of F is acceptable. However, some Octel systems periodically send an invalid DN specifically for the purpose of verifying that the attached Cisco CallManager is functioning properly. In this case, you can turn off ValidateDns if you know the DN that the Octel system will use as a keepalive one. By programming that DN into the KeepAliveDn parameter, you will ensure that the invalid DN message is returned to the voicemail system when needed.
KeepAliveDn
None
10-24
OL-1047-01
Chapter 10
ParamName MwiSearchSpace
Values
Description This parameter designates the search space to use when determining the device to be affected by the MWI lamp.
OutputDnFormat
Default: %010s Because this parameter is used to format the DNs sent to the voicemail system, most numbers passed to the voicemail system are formatted using this parameter. Default: %010s Because this parameter is also used to format the DNs sent to the voicemail system, most numbers passed to the voicemail system are formatted using this parameter. Default: Even This parameter defines the EIA/TIA-232 connection that CMI uses to connect to the voicemail system.
OutputExternalFormat
Parity
Note
Possible parity settings include None, Even, Odd, Mark, or Space. Settings are usually Even and None, Mark and Space rarely get used. Using just the first character of the parity name also works.
10-25
ParamName RouteFilter
Values
Description CMI requires this parameter as one of four to register an intercept for the voicemail system with which CMI is going to work.
Note
Small systems without a complex dialing plan usually only need the VoiceMailDn parameter. The remaining parameters, DialingPlan, RouteFilter, and VoiceMailPartition, will default to empty strings.
SerialPort
Default: COM1 This parameter defines the EIA/TIA-232 connection that CMI uses to connect to the voicemail system.
Note
Use the SerialPort name that is the same name that you see in Device Manager under NT.
10-26
OL-1047-01
Chapter 10
ParamName SsapiKeepAliveInterval
Values Default: 30
Description This numeric parameter specifies keepalive message interval. During normal operations when CMI is attached to a Cisco CallManager, CMI sends a keepalive message to the Cisco CallManager at the rate (in seconds) this parameter specifies.
Note
Do not change his parameter from the default value unless directed to do so by the Cisco Technical Assistance Center (TAC).
StopBits
Default: 1
This parameter defines the EIA/TIA-232 connection that CMI uses to connect to the voicemail system. When CMI receives incoming lamp commands from the voicemail system, it normally validates the associated DN against the NumPlan table in an attempt to verify that the DN matches an existing DN known to Cisco CallManager. If the DN is not found in NumPlan, CMI sends an invalid DN message is sent to the voicemailbox.
ValidateDns
Default: T
Note
On a system with a lot of traffic to and from the voicemail system, you may choose to skip this validation process by setting the ValidateDns parameter default to F.
10-27
Chapter 10 Cisco IP Voice Media Streaming Service Parameters
ParamName
Values
Description
Refer to the Configuring Trace section on page 36-1 for descriptive and configuration information on all trace parameters. VoiceMailDn VoiceMailPartition This parameter represents the voicemail access number. CMI requires this parameter as one of four to register an intercept for the voicemail system with which CMI is going to work. The voicemail DN resides in this partition.
Related Topics

Configuring Service Parameters, page 35-1 Cisco Messaging Interface, page 30-1 Most Commonly Changed CMI Service Parameters, page 30-2 Configuring Trace, page 36-1 Understanding Trace Configuration, page 36-2 Table 36-4 provides the trace parameters for Event Type, User Mask, and Date and Time, page 36-9
Cisco IP Voice Media Streaming Service Parameters

Caution
Do not add or delete service parameters unless directed to do so by the Cisco Technical Assistance Center (TAC). Some changes to service parameters may cause system failure. Table 10-4 provides service parameters configured for Cisco IP Voice Media Streaming.
10-28
OL-1047-01
Chapter 10
Understanding Service Parameters Cisco Database Layer Service Parameters
Table 10-4 Cisco IP Voice Media Streaming Service Parameters
ParamName CFB:OrphanStreamTimeout
Values Default: 300
Description Specifies time (number of seconds) for orphaned CFB calls to stay up when a Cisco CallManager goes down. Do not change this parameter. Specifies time (number of seconds) for orphaned calls or conferences to stay up when a Cisco CallManager goes down. This flag (when set) enables MTP.
ChangeUDPPort MTP:OrphanStreamTimeout
MTP:RunFlag
Default: F
Refer to the Configuring Trace section on page 36-1 for descriptive and configuration information on all trace parameters.
Related Topics

Configuring Service Parameters, page 35-1 Configuring Media Termination Point, page 34-1 Planning Your MTP Configuration, page 34-3 Avoiding Call Failure/User Alert, page 34-4 Configuring Trace, page 36-1
Cisco Database Layer Service Parameters

Caution
Do not add or delete service parameters unless directed to do so by the Cisco Technical Assistance Center (TAC). Some changes to service parameters may cause system failure. Table 10-5 provides service parameter configured for the Database Layer.
10-29
Chapter 10 Cisco Telephony Call Dispatcher Service Parameters
Table 10-5 Cisco Database Layer Service Parameter
ParamName MaxCdrRecords
Values
Description Specifies the maximum number of CDR records to keep. If the CDR tables get too full (the number of records reaches this maximum number), the oldest records are deleted and a message is sent to the Event log. This check occurs once a day.
Related Topics

Configuring Service Parameters, page 35-1 Most Commonly Changed CMI Service Parameters, page 30-2 Configuring Trace, page 36-1 Configuring Cisco CallManager, page 12-1 Configuring Cisco CallManager Groups, page 13-1
Cisco Telephony Call Dispatcher Service Parameters

Caution
Do not add or delete service parameters unless directed to do so by the Cisco Technical Assistance Center (TAC). Some changes to service parameters may cause system failure. Table 10-6 provides service parameters configured for Cisco Telephony Call Dispatcher.
10-30
OL-1047-01
Chapter 10
Understanding Service Parameters Cisco Telephony Call Dispatcher Service Parameters
Table 10-6 Cisco Telephony Call Dispatcher Parameters
ParamName CCN Line State Port
Description Designates the port number of the TCP/IP port in Cisco CallManager that is used by the line state server to register and receive line and device information.
LSS Access Password LSS Listen Port
Default: private Designates the default password used at registration to authenticate line state server. Default: 3221 Designates the TCP port where WA clients register with TcdSrv for Line and Device state information. Designates the TCP port where WA clients register with TcdSrv for Call Control.
TCDServ Listen Port
Default: 4321
Related Topics

Configuring Service Parameters, page 35-1 Configuring Cisco CallManager, page 12-1
10-31
Chapter 10 Cisco Telephony Call Dispatcher Service Parameters
10-32
OL-1047-01
A R T
System Configuration
The following chapters explain how to configure the system parameters used by Cisco CallManager: Chapter 11, Server Chapter 12, Configuring Cisco CallManager Chapter 13, Configuring Cisco CallManager Groups Chapter 14, Configuring Date/Time Groups Chapter 15, Setting Device Defaults Chapter 16, Configuring Regions Chapter 17, Configuring Device Pools Chapter 18, Understanding Enterprise Parameters Chapter 19, Configuring Locations Chapter 20, Starting and Stopping Cisco CallManager
C H A P T E R
11
Server
Use server configuration to specify the address of the server where Cisco CallManager is installed. If your network uses Domain Name System (DNS) services, you can specify the DNS name of the server. If your network does not use DNS services, you must specify the Internet Protocol (IP) address of the server.
Note
You must update the DNS server with the appropriate Cisco CallManager name and address information before using that information to configure the Cisco CallManager server. Use the following procedures to add, update, or delete a server address in the Cisco CallManager database:

Adding a Server, page 11-2 Updating a Server, page 11-3 Deleting a Server, page 11-4
11-1
Chapter 11 Adding a Server
Server
Adding a Server
This section describes how to add a server address to the Cisco CallManager database.
Note
Server information is configured automatically in the database when you install the Cisco CallManager software.
Procedure
Open Cisco CallManager Administration. Select System > Server. If your network uses DNS services, you can enter the DNS name of the Cisco CallManager server. Otherwise, you must enter the full IP address of the server.
Note
You must update the DNS server with the appropriate Cisco CallManager name and address information before using that information here.
Step 4
Optionally you can enter the Media Access Control (MAC) address of the Network Interface Card (NIC) in the Cisco CallManager server. The MAC address is the permanent hardware address of the NIC. If you plan to move the server periodically to different locations on the network, Cisco recommends that you enter the MAC address so that other devices on the network can always identify the server. If you do not plan to relocate the server, you can omit the MAC address. Click Insert to save the server information in the database. After adding a server, you can configure other properties of the Cisco CallManager installed on that server. Changes to the server configuration do not take effect until you restart Cisco CallManager.
Step 5
11-2
OL-1047-01
Chapter 11
Server Updating a Server
Related Topics

Adding a Cisco CallManager, page 12-1 Starting and Stopping Cisco CallManager, page 20-1
Updating a Server
This section describes how to update server information in the Cisco CallManager database.
Procedure
Open Cisco CallManager Administration. Select System > Server. From the server list, select the server you want to update. Make the desired changes in the fields you want to update. Before saving the changes, you can click Cancel to reset all fields to their original value. Click Update to save the changes in the database. Changes to the server configuration do not take effect until you restart Cisco CallManager.
Related Topics
Starting and Stopping Cisco CallManager, page 20-1
11-3
Chapter 11 Deleting a Server
Server
Deleting a Server
This section describes how to delete a server from the Cisco CallManager database.
Before You Begin
You cannot delete a server that has a specific Cisco CallManager running on it. If you try to delete a server that is in use, Cisco CallManager displays an error message. Before deleting a server that is currently in use, you must perform either or both of the following tasks:

Update the Cisco CallManager in question and assign it to a different server. See the Updating a Cisco CallManager section on page 12-5. Delete the Cisco CallManager assigned to the server you want to delete. See the Deleting a Cisco CallManager section on page 12-6.
Procedure
Open Cisco CallManager Administration. Select System > Region. In the server list, select the server you want to delete. Click Delete. If the server is not in use, it is deleted. If it is in use, an error message is displayed. Changes to the server configuration do not take effect until you restart Cisco CallManager.
Related Topics
Starting and Stopping Cisco CallManager, page 20-1
11-4
OL-1047-01
C H A P T E R
12
Configuring Cisco CallManager

Use Cisco CallManager configuration to specify the ports and other properties for each Cisco CallManager installed in the same cluster. A cluster is a set of Cisco CallManagers that share the same database. Use the following procedures to add, update, or delete a Cisco CallManager configuration:

Adding a Cisco CallManager, page 12-1 Updating a Cisco CallManager, page 12-5 Deleting a Cisco CallManager, page 12-6
Adding a Cisco CallManager

This section describes how to add a new Cisco CallManager to the database.
Note
Information about Cisco CallManager is configured automatically in the database when you install the Cisco CallManager software. After installing the software, you normally do not have to add a new Cisco CallManager configuration to the database, but you might want to update the configuration information for an existing Cisco CallManager. See the Updating a Cisco CallManager section on page 12-5.
12-1
Chapter 12 Adding a Cisco CallManager
Before You Begin
Before adding a new Cisco CallManager to the database, perform the following tasks:

Configure the address of the server where this Cisco CallManager is installed. See the Adding a Server section on page 11-2. If you want to specify a partition for directory numbers used in auto-registration with this Cisco CallManager, configure that partition. See Adding a Partition.
Procedure
Open Cisco CallManager Administration. Select System > Cisco CallManager. There are two ways to add a Cisco CallManager:
If there is an existing Cisco CallManager with settings that are similar to the one you want to add, select the existing Cisco CallManager to display its settings, click Copy, then continue with the Step 4 and modify the settings as needed. To add a Cisco CallManager without copying an existing one, continue with Step 4.
Step 4
From the Cisco CallManager Server drop-down list box, select the IP address or DNS name of the server where this Cisco CallManager is installed.
Note
Each Cisco CallManager server address can be assigned only once (that is, there can be only one Cisco CallManager per server). After you assign a server address to a particular Cisco CallManager, that address disappears from the list.
Step 5 Step 6
In the Cisco CallManager Name field, enter the name you want to assign to this Cisco CallManager. In the Description field, enter a brief text description for this Cisco CallManager.
12-2
OL-1047-01
Chapter 12
Configuring Cisco CallManager Adding a Cisco CallManager
Step 7
Enter the following auto-registration information. Refer to the Understanding Auto-Registration section on page 4-1 for more information. Field Name Starting Directory Number Ending Directory Number Description Enter the first directory number to use for auto-registration of devices. Enter the last directory number to use for auto-registration of devices. If you specify a valid range of directory numbers in the Starting Directory Number and Ending Directory Number fields, auto-registration is automatically enabled. If you set the starting and ending directory numbers to the same value, auto-registration is disabled. Partition Select the partition to which auto-registered directory numbers belong. If you are not using partitions, select None. You must select a range for auto-registration before you can select a partition and external phone number mask. External Phone Number Mask Specify the mask used to format caller ID information for external (outbound) calls made from the auto-registered devices. The mask can contain up to 50 characters. Enter the literal digits that you want to appear in the caller ID information, and use Xs to represent the directory number of the auto-registered device. For example, if you specify a mask of 972813XXXX, an external call from extension 1234 displays a caller ID number of 9728131234 if the Use External Phone Number Mask option is checked on the route pattern used to make the external call. If you specify a mask of all literal digits, such as 9728135000 to represent a main attendant number, then that literal number (9728135000) is the caller ID displayed for an external call from any auto-registered device.
12-3
Chapter 12 Adding a Cisco CallManager
Field Name Auto-registration Disabled on this Cisco CallManager
Description Auto-registration is disabled by default to prevent unauthorized connections to the network.

Uncheck the Auto-registration Disabled option to enable auto-registration for this Cisco CallManager. Check the Auto-registration Disabled option to disable auto-registration for this Cisco CallManager.
When auto-registration is disabled, you must configure the directory numbers manually whenever you add new devices to your network. Setting the Starting Directory Number and Ending Directory Number to the same value also disables auto-registration. If starting and ending directory numbers are currently specified when you disable auto-registration by checking this option, Cisco CallManager sets the starting and ending directory numbers to the same value. The partition and external phone mask information fields are reset when Auto-registration is disabled.
Step 8
Enter the following port numbers. Field Name Ethernet Phone Port Description Cisco CallManager uses this TCP port to communicate with the Cisco IP Phones on the network. Accept the default port of 2000 unless this port is already in use on your system. All port entries must be unique. The range of valid port numbers is 1024 to 49151. Cisco CallManager uses this TCP port to communicate with Cisco Access Digital Gateways (such as the DT-24+ or DE-30+) on the network. Accept the default port of 2001 unless this port is already in use on your system. All port entries must be unique. The range of valid port numbers is 1024 to 49151.
Digital Port
12-4
OL-1047-01
Chapter 12
Configuring Cisco CallManager Updating a Cisco CallManager
Field Name Analog Port
Description Cisco CallManager uses this TCP port to communicate with Cisco Access Analog Gateways (such as the WS-6624 FXS) on the network. Accept the default port of 2002 unless this port is already in use on your system. All port entries must be unique. The range of valid port numbers is 1024 to 49151. Cisco CallManager uses this TCP port to listen for messages from its associated MGCP gateway. Accept the default port of 2427 unless this port is already in use on your system. All port entries must be unique. The range of valid port numbers is 1024 to 49151. Cisco CallManager uses this TCP port to exchange keep-alive messages with its associated MGCP gateway. Accept the default port of 2428 unless this port is already in use on your system. All port entries must be unique. The range of valid port numbers is 1024 to 49151.
MGCP Listen Port
MGCP Keep-alive Port
Step 9
Click Insert to save the Cisco CallManager configuration in the database.
Related Topics

Understanding Auto-Registration, page 4-1 Adding a Cisco CallManager Group, page 13-2
Updating a Cisco CallManager

This section describes how to update a Cisco CallManager configuration.
Procedure
Step 1 Step 2
Open Cisco CallManager Administration. Select System > Cisco CallManager.
12-5
Chapter 12 Deleting a Cisco CallManager
Step 3 Step 4
From the Cisco CallManager list, select the Cisco CallManager you want to update. Make the desired changes in the fields you want to update. Refer to the Adding a Cisco CallManager section on page 12-1 for information about configuration settings. Before saving the changes, you can click Cancel to reset all fields to their original value.
Step 5
Click Update to save the changes in the database. Changes to the settings for auto-registration partition, external phone number mask, and TCP ports do not take effect until you restart Cisco CallManager. See the Starting and Stopping Cisco CallManager section on page 20-1.
Caution
The Reset button resets Cisco CallManager and can temporarily interrupt call processing. For other methods of resetting Cisco CallManager, see the Starting and Stopping Cisco CallManager section on page 20-1.
Related Topics

Adding a Cisco CallManager, page 12-1 Deleting a Cisco CallManager, page 12-6
Deleting a Cisco CallManager

This section describes how to delete a Cisco CallManager configuration from the database.
Before You Begin
You cannot delete a Cisco CallManager from the database if it is running. If you try to delete a Cisco CallManager that is in use, an error message displays. Before deleting a Cisco CallManager that is currently in use, you must perform either or both of the following tasks:
12-6
OL-1047-01
Chapter 12
Configuring Cisco CallManager Deleting a Cisco CallManager
Update the Cisco CallManager group so that it no longer contains the Cisco CallManager you want to delete. See the Updating a Cisco CallManager Group section on page 13-4. Delete the Cisco CallManager group that contains the Cisco CallManager you want to delete. See the Deleting a Cisco CallManager section on page 12-6.
Procedure
Open Cisco CallManager Administration. Select System > Cisco CallManager. From the Cisco CallManager list, select the Cisco CallManager you want to delete. Click Delete. When asked to confirm the delete operation, click either OK to delete or Cancel to cancel the delete operation.
Related Topics
Adding a Cisco CallManager, page 12-1
12-7
Chapter 12 Deleting a Cisco CallManager
12-8
OL-1047-01
C H A P T E R
13
Configuring Cisco CallManager Groups

A Cisco CallManager group is a prioritized list of up to three Cisco CallManagers. The first Cisco CallManager in the list is the primary Cisco CallManager for that group, and the other members of the group are used as secondary (backup) Cisco CallManagers. One Cisco CallManager group is assigned to each device pool. When a device registers, it attempts to connect to the primary (first) Cisco CallManager in the group assigned to its device pool. If the primary Cisco CallManager is not available, the device tries to connect to the next Cisco CallManager listed in the group, and so on. Cisco CallManager groups provide two important features for your system:
RedundancyThis feature enables you to designate a primary and backup Cisco CallManagers for each group. Refer to the Understanding Redundancy section on page 3-1. Call processing load balancingThis feature enables you to distribute the control of devices across multiple Cisco CallManagers. Refer to the Understanding Distributed Call Processing section on page 2-1.
For most systems you will want to assign a single Cisco CallManager to multiple groups to achieve better load distribution and redundancy.
13-1
Chapter 13 Adding a Cisco CallManager Group
Use the following procedures to add, update, or delete a Cisco CallManager group:

Adding a Cisco CallManager Group, page 13-2 Updating a Cisco CallManager Group, page 13-4 Copying a Cisco CallManager Group, page 13-5 Deleting a Cisco CallManager Group, page 13-6
Adding a Cisco CallManager Group

This section describes how to configure a new Cisco CallManager group. You can also create a new Cisco CallManager group by copying an existing one. Refer to Copying a Cisco CallManager Group section on page 13-5 for more information.
Before You Begin
Before configuring a Cisco CallManager group, you must configure the Cisco CallManagers that you want to assign as members of that group. Refer to the Adding a Cisco CallManager section on page 12-1 for more information.
Procedure
Open Cisco CallManager Administration. Select System > Cisco CallManager Group. Enter the name of the new group in the Cisco CallManager Group field. Click the Auto-registration Cisco CallManager Group check box if you want this Cisco CallManager group to be the default Cisco CallManager group when auto-registration is enabled. Leave this box unchecked if you do not want devices to auto-register with this Cisco CallManager group.
13-2
OL-1047-01
Chapter 13
Configuring Cisco CallManager Groups Adding a Cisco CallManager Group
Note
There can be one default auto-registration group per cluster. When you select a different Cisco CallManager group as the default group for auto-registration and apply the change, the previously selected default auto-registration group for the cluster is automatically deselected.
Step 5
In the Cisco CallManager selection area, select the Cisco CallManager names and use the arrows to arrange the lists the way you want them.
Use the left and right arrows to move Cisco CallManager groups from the Available list to the Selected list. Cisco CallManagers in the Selected list become members of the group when you click Insert, and Cisco CallManagers in the Available list are left out of the group. The Selected list can contain up to three Cisco CallManagers.
Use the up and down arrows to arrange the groups in the Selected list in the order that you want. The order of the Cisco CallManagers in the Selected list determines their priority. The first entry in the list is the primary Cisco CallManager for the group, and the other entries are successive backups. See the Understanding Redundancy section on page 3-1.
Step 6
Click Insert to save the Cisco CallManager group in the database.
Related Topics

Understanding Distributed Call Processing, page 2-1 Understanding Redundancy, page 3-1 Adding a Device Pool, page 17-1
13-3
Chapter 13 Updating a Cisco CallManager Group
Updating a Cisco CallManager Group

This section describes how to update an existing Cisco CallManager group.
Procedure
Open Cisco CallManager Administration. Select System > Cisco CallManager Group. From the Cisco CallManager group list, select the group you want to update. Make the desired changes in the fields you want to update. Before saving the changes, you can click Cancel to reset all fields to their original value. Refer to the Adding a Cisco CallManager Group section on page 13-2 for information about configuration settings.
Note
To make a group the default Auto-registration Cisco CallManager group, check in the Auto-registration Cisco CallManager check box. If the currently selected group is the default group for auto-registration, you can not deselect it by un-checking the Auto-registration Cisco CallManager check box. You must first select a different default auto-registration group. When you do so, the currently selected default auto-registration group will be automatically deselected.
Step 5
Click Update to save the changes in the database. You must restart the devices that use the updated Cisco CallManager group to apply the changes. To restart all the devices that use this Cisco CallManager group, click Restart Devices.
Tips
The Restart Devices button restarts all devices in the device pool that uses this Cisco CallManager group. This button is for your convenience in restarting devices.
13-4
OL-1047-01
Chapter 13
Configuring Cisco CallManager Groups Copying a Cisco CallManager Group
Caution
Restarting devices can cause them to drop calls.
Related Topics

Adding a Cisco CallManager Group, page 13-2 Deleting a Cisco CallManager Group, page 13-6
Copying a Cisco CallManager Group

Use the following procedure to add a new Cisco CallManager group by copying settings from an existing group.
Procedure
Step 1 Step 2 Step 3 Step 4 Step 5 Step 6 Step 7
Open Cisco CallManager Administration. Select System > Cisco CallManager Group. Select the name of the group you want to copy from the list on the left side of the page. Click Copy. Enter the name of the new group in the Cisco CallManager Group field. You must change the name of the group. Make the desired changes. Refer to the Adding a Cisco CallManager Group section on page 13-2 for information about configuration settings. Click Insert to apply the changes and add the new Cisco CallManager group to the database.
13-5
Chapter 13 Deleting a Cisco CallManager Group
Related Topics

Adding a Cisco CallManager Group, page 13-2 Updating a Cisco CallManager Group, page 13-4 Deleting a Cisco CallManager Group, page 13-6
Deleting a Cisco CallManager Group

This section describes how to delete a Cisco CallManager group from the database.
Before You Begin
You cannot delete a Cisco CallManager group if it is assigned to any device pools or if it is the current Auto-registration CallManager Group for the cluster. If you try to delete a Cisco CallManager group that is in use, an error message displays. Before deleting a Cisco CallManager group that is currently in use, you must perform some or all of the following tasks:
Assign a different Cisco CallManager group to the device pools that are currently using this Cisco CallManager group. See the Updating a Device Pool section on page 17-3. Create or select a different Cisco CallManager group to be the Auto-registration CallManager group.
Procedure
Open Cisco CallManager Administration. Select System > Cisco CallManager Group. From the Cisco CallManager group list, select the group you want to delete. Click Delete. When asked to confirm the delete operation, click either OK to delete or Cancel to cancel the delete operation.
13-6
OL-1047-01
Chapter 13
Configuring Cisco CallManager Groups Deleting a Cisco CallManager Group
Related Topics

Adding a Cisco CallManager Group, page 13-2 Updating a Cisco CallManager Group, page 13-4
13-7
Chapter 13 Deleting a Cisco CallManager Group
13-8
OL-1047-01
C H A P T E R
14
Configuring Date/Time Groups

Use Date/Time Groups to define time zones for the various devices connected to Cisco CallManager. Each device is a member of only one device pool, and each device pool is assigned only one Date/Time Group. A default Date/Time Group called CMLocal is configured automatically when you install Cisco CallManager. CMLocal is synchronized to the active date and time of the operating system on the server where Cisco CallManager is installed. After installing Cisco CallManager, you can change the settings for CMLocal as desired. Normally, server date/time should be adjusted to the local time zone date and time.
Note
CMLocal resets to the operating system date and time whenever you restart Cisco CallManager or upgrade the Cisco CallManager software to a new release. Do not change the name of CMLocal.
Tips
For a worldwide distribution of Cisco IP Phones, create one named Date/Time Group for each of the 24 time zones. Use the following procedures to add, update, or delete Date/Time Groups:

Adding a Date/Time Group, page 14-2 Updating a Date/Time Group, page 14-3 Deleting a Date/Time Group, page 14-4
14-1
Chapter 14 Adding a Date/Time Group
Adding a Date/Time Group

This section describes how to add a new Date/Time Group to the Cisco CallManager database.
Procedure
Open Cisco CallManager Administration. Select System > Date/Time Group. There are two ways to add a new Date/Time group:
If there is an existing Date/Time Group with settings that are similar to the new group you want to create, select the existing group to display its settings, click Copy, then continue with the Step 4 and modify the settings as needed. To create a new Date/Time Group without copying an existing one, continue with Step 4.
Step 4 Step 5
In the Date/Time Group Name field, enter the name you want to assign to the new Date/Time Group. From the Time Zone drop-down list box, select the time zone for the group you are adding. The option local time zone of CallManager copies the time zone information from the operating system of the server where Cisco CallManager is installed. Select the separator character to use between the date fields from the drop-down list box. From the Date Format drop-down list box, select the date format. This selection sets the format for the date displayed on the Cisco IP Phones. From the Time Format drop-down list box, select 12-hour or 24-hour time. Click Insert to save the new Date/Time Group in the database.
Related Topics
After adding a new Date/Time Group to the database, you can assign it to a device pool to configure the date and time information for that device pool. For more information, see:
Adding a Device Pool, page 17-1
14-2
OL-1047-01
Chapter 14
Configuring Date/Time Groups Updating a Date/Time Group
Updating a Date/Time Group

This section describes how to update a Date/Time Group.
Procedure
Open Cisco CallManager Administration. Select System > Date/Time Group. From the Date/Time Group list, select the Date/Time Group you want to update. Make the desired changes in the fields you want to update. Refer to the Adding a Date/Time Group section on page 14-2 for more information about configuration settings. Before saving the changes, you can click Cancel to reset all fields to their original value. Click Update to save the changes in the database.
Step 5
Tips
The Restart Devices button restarts all devices in the selected Date/Time Group. This button is only for your convenience in restarting devices. You do not have to use it when making changes to a Date/Time Group.
Caution
Related Topics

Adding a Date/Time Group, page 14-2 Deleting a Date/Time Group, page 14-4
14-3
Chapter 14 Deleting a Date/Time Group
Deleting a Date/Time Group

This section describes how to delete a Date/Time Group from the Cisco CallManager database.
Before You Begin
You cannot delete a Date/Time Group that is used by any device pool. If you try to delete a Date/Time Group that is in use, Cisco CallManager displays an error message. Before deleting a Date/Time Group that is currently in use, you must perform either or both of the following tasks:
Assign a different Date/Time Group to any device pools that are using the Date/Time Group you want to delete. See the Updating a Device Pool section on page 17-3. Delete the device pools that are using the Date/Time Group you want to delete. See the Deleting a Device Pool section on page 17-4.
Procedure
Open Cisco CallManager Administration. Select System > Date/Time Group. From the Date/Time Group list, select the Date/Time Group you want to delete. Click Delete. When asked to confirm the delete operation, click either OK to delete or Cancel to cancel the delete operation.
Related Topics

Adding a Date/Time Group, page 14-2 Updating a Date/Time Group, page 14-3
14-4
OL-1047-01
C H A P T E R
15
Setting Device Defaults

Use device defaults to set the system-wide default characteristics of each type of device that registers with a Cisco CallManager. The system-wide device defaults for a device type apply to all devices of that type within a Cisco CallManager cluster. Default settings for devices include:

Device loads Device pools Phone button templates
When a device registers with a Cisco CallManager, it acquires the system-wide device default settings for its device type. After a device registers, you can update its configuration individually to change the device settings. Device defaults are set automatically when you install Cisco CallManager. You cannot create new device defaults or delete existing ones, but you can change the default settings by using the following procedure:
Updating Device Defaults, page 15-2
15-1
Chapter 15 Updating Device Defaults
Updating Device Defaults

This section describes how to modify the device defaults in the Cisco CallManager configuration database.
Before You Begin
Before updating the device defaults, perform any of the following tasks that apply to your system:
Add new firmware files for the devices to the TFTP server. For each available firmware load, there is a .bin file in the \Program Files\Cisco\TFTPPath\ folder on the Cisco CallManager server. For example, for the firmware load P002A030, there is a file named P002A030.bin in the Program Files\Cisco\TFTPPath\folder.
Configure new device pools. See the Adding a Device Pool section on page 17-1. If the device is a phone, configure new phone templates. See the Adding Phone Button Templates section on page 47-5.
Procedure
Open Cisco CallManager Administration. Select System > Device Defaults. From the Cisco CallManager list, select the type of device whose device defaults you want to update. Make the desired changes in the fields you want to update. Before saving the changes, you can click Cancel to reset all fields to their original value.
15-2
OL-1047-01
Chapter 15
Setting Device Defaults Updating Device Defaults
The fields you can update are listed in the following table. Field Name Load Information Description This field specifies the ID number of the firmware load used with a particular type of hardware device. If you install an upgrade or patch load, you must update the load information for each type of device that uses the new load. This field specifies the device pool associated with each type of device. The device pool defines common characteristics for all devices in the pool. This field specifies the phone button template used by each type of Cisco IP Phone. The template defines which keys on the phone perform which functions.
Device Pool
Phone Template
Step 5 Step 6
Click Update to save the changes in the Cisco CallManager configuration database. Click the Reset icon to the left of the device name to reset all the devices of that type and load the new defaults on all Cisco CallManagers in the cluster. If you choose not to reset all devices of that type, only new devices added after you change the device defaults will receive the latest defaults.
Related Topics

Understanding Device Support, page 7-1 Understanding Device Loads, page 7-6
15-3
Chapter 15 Updating Device Defaults
15-4
OL-1047-01
C H A P T E R
16
Configuring Regions
Use regions to specify the type of compression and amount of bandwidth used per call. You can select the compression and bandwidth used for calls within a region and between two regions. Use the following procedures to add, update, or delete regions:

Adding a Region, page 16-3 Updating a Region, page 16-4 Deleting a Region, page 16-5
Understanding Regions
The compression types available in Cisco CallManager are G.711, G.723, and G.729. The default compression type for all calls through Cisco CallManager is G.711. To specify a different compression type, you must use regions. The bandwidth used per call depends on the compression type as well as factors such as data packet size and overhead (packet header size), as indicated in Table 16-1.
16-1
Chapter 16 Understanding Regions
Configuring Regions
Table 16-1 Bandwidth Used Per Call by Each Type of Compression
Type of Compression G.711 G.723 G.729
Bandwidth Used for Data Packets Only (Fixed Regardless of Packet Size) 64 kbps 6 kbps 8 kbps
Bandwidth Used Per Call (Including IP Headers) with 30 ms Data Packets 80 kbps 22 kbps 24 kbps
Bandwidth Used Per Call (Including IP Headers) with 20 ms Data Packets 88 kbps Not applicable 32 kbps
Figure 16-1 illustrates the use of regions to specify compression type and bandwidth.
Figure 16-1 Example of Regions
Internal: G.711 Each call uses about 80 kbps
G.723 Compression Each call uses about 22 kbps
Region A
on si es pr es om l us ps C l b ca 2 k 23 .7 ch t 2 G Ea bou a G .7 11 Ea Co m ab ch pr ou c es t 8 all si o 0 us kb es n ps
Region B
Region C

34036
16-2
OL-1047-01
Chapter 16
Configuring Regions Adding a Region
The following matrix shows the compression type that will be used for calls within and between Regions A, B, and C for the example configuration shown in Figure 16-1. Region A Region A Region B Region C G.711 G.723 G.723 Region B G.723 G.723 G.711 Region C G.723 G.711 G.723
Adding a Region
This section describes how to add a new region to the Cisco CallManager database.
Procedure
Open Cisco CallManager Administration. Select System > Region. In the Region Name box, enter the name you want to assign to the new region and click Insert. Using the drop-down list boxes, select the type of compression to use for calls within the new region and between the new region and existing regions. By selecting the compression type, you are also specifying the amount of bandwidth used per call. See Table 16-1 for details. Before saving the changes, you can click Cancel to reset all fields to their original value.
Step 5
Click Update to save the new region in the database. After adding a new region to the database, you can use it to configure device pools.
16-3
Chapter 16 Updating a Region
Configuring Regions
Related Topics

Adding a Device Pool, page 17-1 Understanding Regions, page 16-1
Updating a Region
This section describes how to update the configuration for a region.
Procedure
Open Cisco CallManager Administration. Select System > Region. From the region list, select the region you want to update. Make the desired changes in the fields you want to update. Before saving the changes, you can click Cancel to reset all fields to their original value. Click Update to save the changes in the database.
Related Topics

Understanding Regions, page 16-1 Adding a Region, page 16-3 Deleting a Region, page 16-5
16-4
OL-1047-01
Chapter 16
Configuring Regions Deleting a Region
Deleting a Region
This section describes how to delete a region from the Cisco CallManager database.
Before You Begin
You cannot delete a region that is being used by any device pools. If you try to delete a region that is in use, Cisco CallManager displays an error message. Before deleting a region that is currently in use, you must perform either or both of the following tasks:

Update the device pools to use a different region. See the Updating a Device Pool section on page 17-3. Delete the device pools that are using the region you want to delete. See the Deleting a Device Pool section on page 17-4.
Procedure
Open Cisco CallManager Administration. Select System > Region. From the region list, select the region you want to delete. Click Delete.
Related Topics

Understanding Regions, page 16-1 Adding a Region, page 16-3 Updating a Region, page 16-4
16-5
Chapter 16 Deleting a Region
Configuring Regions
16-6
OL-1047-01
C H A P T E R
17
Configuring Device Pools

Use device pools to define sets of common characteristics for devices. The device characteristics you can specify for a device pool are:

Region Date/time group Cisco CallManager group Calling search space for auto-registration
Use the following procedures to add, update, or delete a device pool:

Adding a Device Pool, page 17-1 Updating a Device Pool, page 17-3 Deleting a Device Pool, page 17-4
Adding a Device Pool

This section describes how to add a new device pool to the Cisco CallManager database.
17-1
Chapter 17 Adding a Device Pool
Before You Begin
Before configuring a device pool, you must configure the following items if you want to select them for the device pool:

Region (required). See the Adding a Region section on page 16-3. Date/time group (required). See the Adding a Date/Time Group section on page 14-2. Cisco CallManager group (required). See the Adding a Cisco CallManager Group section on page 13-2. Calling search space for auto-registration (optional). See the Adding a Calling Search Space section on page 22-1.
Procedure
Open Cisco CallManager Administration. Select System > Device Pool. There are two ways to add a new device pool:
If there is an existing device pool with settings that are similar to the new device pool you want to configure, select the existing device pool to display its settings, click Copy, then continue with Step 4 to modify settings as needed. To create a device pool without copying an existing one, continue with Step 4.
In the Device Pool Name field, enter the name of the new device pool you are creating. In the Region drop-down list box, select the region to assign to devices in this device pool. Regions specify the type of compression used. In the Date/Time Group drop-down list box, select the date/time group to assign to devices in this device pool. The date/time group specifies the time zone and the display formats for date and time. In the Cisco CallManager Group drop-down list box, select the Cisco CallManager group to assign to devices in this device pool. The Cisco CallManager group specifies the primary and backup Cisco CallManagers for the group.
Step 7
17-2
OL-1047-01
Chapter 17
Configuring Device Pools Updating a Device Pool
Step 8
In the drop-down list box for Calling Search Space for Auto-Registration, select the calling search space to assign to devices in this device pool that auto-register with Cisco CallManager. The calling search space specifies which partitions devices can search when attempting to complete a call. Click Insert to save the device pool information in the database.
Step 9
After adding a new device pool to the database, you can use it to configure devices such as Cisco IP Phones, gateways, conference bridges, transcoders, media termination points, Cisco uOne ports, CTI route points, and so on.
Related Topics
Setting Device Defaults, page 15-1
Updating a Device Pool

This section describes how to modify the configuration of an existing device pool.
Procedure
Open Cisco CallManager Administration. Select System > Device Pool. In the device pool list, click the device pool you want to update. Make the desired changes in the fields you want to update. Refer to the Adding a Device Pool section on page 17-1 for information about configuration settings Before saving the changes, you can click Cancel to reset all fields to their original value. Click Update to save the changes in the database. You must restart the devices to apply the changes. To restart all the devices in the selected device pool, click Restart Devices.
Step 5 Step 6
Tips
The Restart Devices button restarts all devices in the selected device pool. This button is for your convenience in restarting devices.
17-3
Chapter 17 Deleting a Device Pool
Caution
Deleting a Device Pool

This section describes how to delete a device pool from the Cisco CallManager database.
Before You Begin
You cannot delete a device pool that has been assigned to any devices or one that is used for Device Defaults configuration. If you try to delete a device pool that is in use, an error message is displayed. Before deleting a device pool that is currently in use, you must perform either or both of the following tasks:

Update the devices to assign them to a different device pool. See the Updating a Phone section on page 46-13. Delete the devices assigned to the device pool you want to delete. See the Deleting a Phone section on page 46-11.
Procedure
Open Cisco CallManager Administration. Select System > Device Pool. In the device pool list, click the device pool you want to delete. Click Delete. When asked to confirm the delete operation, click either OK to delete or Cancel to cancel the delete operation.
17-4
OL-1047-01
C H A P T E R
18
Understanding Enterprise Parameters

Enterprise parameters provide default settings that apply to all devices and services in the same cluster. (A cluster is a set of Cisco CallManagers that share the same database.) When you install a new Cisco CallManager, it uses the enterprise parameters to set the initial values of its device defaults. For more information on device defaults, see the Setting Device Defaults section on page 15-1. Enterprise parameters include the following default settings:

Firmware loads for devices such as phones, gateways, and Media Termination Points Lightweight Directory Access Protocol (LDAP) parameters URLs for web-based applications such as directory services for the Cisco IP Phone 7960 System Version MessageDirectoryNumber
You cannot add or delete enterprise parameters, but you can use the following procedure to update existing enterprise parameters:
Updating Enterprise Parameters, page 18-4
18-1
Chapter 18
Table 18-1 describes the enterprise parameters and lists allowed values for each.
Table 18-1 Enterprise Parameters
Enterprise Parameter FirmwareLoad
Description The firmware loads used as Device Defaults when a new Cisco CallManager is added to a cluster. A mapping of attribute names used in the enterprise directory.
Allowed Values Do not change the firmware load settings unless instructed to do so by Cisco Technical Assistance Center (TAC). Do not change this parameter setting unless instructed to do so by Cisco TAC.
LDAP: Attribute Mappings LDAP: Cisco Base LDAP: Device Base LDAP: Directory RN Attribute LDAP: User ID
The location of Cisco information in Do not change this parameter the LDAP directory. setting unless instructed to do so by Cisco TAC. The location of devices in the LDAP Do not change this parameter directory tree. setting unless instructed to do so by Cisco TAC. The RN attribute used to create new Do not change this parameter setting unless instructed to do so entries in the user portion of the LDAP directory. by Cisco TAC. The LDAP attribute used to authenticate users who log into their user speed dial and call forwarding pages. The type of the LDAP directory. DC Directory or Netscape
LDAP: Directory Type LDAP: Extension Base LDAP: Manager DN LDAP: Manager Password
The location of the list of extensions Do not change this parameter in the LDAP directory tree. setting unless instructed to do so by Cisco TAC. The directory number of the directory manager. The password of the directory manager. Any valid directory number that is not assigned to another use.
18-2
OL-1047-01
Chapter 18
Table 18-1 Enterprise Parameters (continued)
Enterprise Parameter LDAP: Profile Base LDAP: URL
Description
Allowed Values
The location of the profile subtree in Do not change this parameter the LDAP directory tree. setting unless instructed to do so by Cisco TAC. The URL of the LDAP directory. A URL in standard format (for example, LDAP://DAL-CCM1:8404). Note that the port number will always be 8404 for DC Directory installations. Do not change this setting unless you moved the enterprise directory to a new location or changed ports. If the installation is to an enterprise directory, this subtree can be anywhere.
LDAP: User Base LDAP: User Object Class LDAP: User Object Class Hierarchy MessageDirectoryNumber
The location of the user subtree in the LDAP directory tree.
The name of the object class used to Do not change this parameter setting unless instructed to do so create new users in the LDAP by Cisco TAC. directory. The object class hierarchy of the User Object Class. Default voice messaging directory number used by the Cisco Messaging Interface (CMI). The Cisco CallManager system version. This parameter is the same as the installation version number. The URL used for the directories key on the Cisco IP Phone 7960. The URL used for the information (i) button on the Cisco IP Phone 7960. Do not change this parameter setting unless instructed to do so by Cisco TAC. Any valid directory number that is not assigned to another use. This parameter should never be changed. Do not change this parameter setting unless instructed to do so by Cisco TAC. Do not change this parameter setting unless instructed to do so by Cisco TAC
System Version
URL Directories
URL Information
18-3
Chapter 18 Updating Enterprise Parameters
Table 18-1 Enterprise Parameters (continued)
Enterprise Parameter URL Messages
Description
Allowed Values
The URL used for the messages key Do not change this parameter on the Cisco IP Phone 7960. setting unless instructed to do so by Cisco TAC The URL used for the services key on the Cisco IP Phone 7960. Do not change this parameter setting unless instructed to do so by Cisco TAC
URL Services
Related Topics
Clusters, page 2-1
Updating Enterprise Parameters

This section describes how to update or modify the enterprise parameters.
Procedure
Open Cisco CallManager Administration. Select System > Enterprise Parameters. From the Parameters list, select the enterprise parameter you want to update. Enter the new value for the selected parameter. If you make an error, retype the entry before saving the changes. See Table 18-1 for allowed values. When you are done making changes to the enterprise parameters, click Update to save the changes in the database.
18-4
OL-1047-01
C H A P T E R
19
Configuring Locations
Use locations to implement call admission control in a centralized call processing system. Call admission control enables you to regulate voice quality by limiting the amount of bandwidth available for calls over links between the locations. For more information, see the Understanding Call Admission Control section on page 5-1.
Note
If you do not use call admission control to limit the voice bandwidth on an IP WAN link, an unlimited number of calls can be active on that link at the same time. This can cause the voice quality of each call to degrade as the link becomes oversubscribed. Cisco CallManager requires that you arrange the locations in a hub-and-spoke topology (also know as a star topology). The hub is the location of the primary Cisco CallManager that controls call processing on the network. The spokes are remote locations that contain other devices (such as phones and gateways) on the same network. Figure 19-1 illustrates the hub-and-spoke topology and its use with Cisco CallManager admission control.
19-1
Chapter 19 Understanding Locations
Figure 19-1 Example of Hub-and-Spoke Topology for Locations
Central site IP IP WAN
IP
Branch 1
IP
Branch 2
V
IP
V V
IP
Branch 3
IP
Branch n
The following sections explain locations in more detail:

Understanding Locations, page 19-2 Adding a Location, page 19-5 Updating a Location, page 19-7 Deleting a Location, page 19-7
Understanding Locations
For calls between devices on the same LAN, the available bandwidth is considered to be unlimited, and call admission control does not apply. However, calls between locations travel over a WAN link that has limited available bandwidth. As more active calls are placed over the WAN link, the audio quality of each call can begin to degrade. To avoid this audio quality degradation, you can use the locations feature to decrease the amount of available bandwidth and thereby decrease the number of active calls on the link. Cisco CallManager uses a hub-and-spoke topology for locations. The main location, or hub, is the location of the primary Cisco CallManager controlling the network. Using Cisco CallManager Administration, you can define the spoke locations and assign devices to those locations. You can also specify how much bandwidth to allocate for calls between each spoke location and the hub.
19-2
OL-1047-01
47072
Chapter 19
Configuring Locations Understanding Locations
For example, assume that the locations in Figure 19-1 are configured as follows: Location Hub Austin Dallas Bandwidth to Hub (kbps) Unlimited 100 200
For calculation purposes, assume that calls using G.711 compression consume 80 kbps of bandwidth and calls using G.723 or G.729 compression consume 24 kbps. Cisco CallManager continues to admit new calls to a link until the available bandwidth for that link drops to zero. Thus, the link to the Austin location could support one G.711 calls at 80 kbps each, four G.723 or G.729 calls at 24 kbps each, or one G.711 call and one G.723 (or G.729) call. Any additional calls that try to exceed the bandwidth limit are rejected, the calling party receives a reorder tone and a text message on the phones display.
Locations and Regions

Locations work in conjunction with regions to define the characteristics of a network link. Regions define the type of compression (G.711, G.723, or G.729) used on the link, and locations define the amount of available bandwidth for the link. You must assign each device on the network to both a region (by means of a device pool) and a location. As illustrated in Figure 19-2, the regions and locations can overlap and intersect in various ways, depending on how you define them. For more information, see the Configuring Regions section on page 16-1.
19-3
Chapter 19 Understanding Locations
Figure 19-2 Interaction Between Locations and Regions
San Francisco (Hub location) PSTN
H.323 Gateway
Cisco Voicemail
Region A
Region B Cisco CallManager (Primary) San Francisco (Hub location)
Cisco CallManager (Backup)
Cisco CallManager (Backup)
Region C Austin (Spoke location) Dallas (Spoke location) H.323 Gateway
PSTN
34030
Bandwidth Calculations
In performing bandwidth calculations for purposes of admission control, Cisco CallManager assumes that all calls are full-duplex connections. Cisco CallManager also assumes that calls using G.723 or G.729 protocol consume 24 kbps of bandwidth and calls using G.711 protocol consume 80 kbps.
Note
Actual bandwidth consumption per call will vary, depending on factors such as data packet size. Cisco CallManager uses the values of 24 kbps and 80 kbps to simplify the bandwidth calculations for purposes of call admission control only.
19-4
OL-1047-01
Chapter 19
Configuring Locations Adding a Location
Cisco CallManager allows calls to complete over a link until the available bandwidth for that link drops to zero. At that point, any additional calls fail and the calling party receives reorder tone. The following situations are exceptions to the bandwidth rules outlined in the preceding paragraph. In these cases, additional calls can complete even though the available bandwidth has dropped to zero:

Calls made through a Media Termination Point (MTP) can complete even if they exceed the available bandwidth limit. If a feature temporarily stops call streaming, the bandwidth from that call is temporarily available for use on another call. For example, when a user places a call on hold, the bandwidth from that call becomes available again. If new calls consume all the available bandwidth while the original call is on hold, the user can still retrieve the held call even though it exceeds the available bandwidth limit. Calls placed simultaneously on the same link can exceed the available bandwidth limit because their bandwidth is not subtracted from the available limit until the calls complete.
Caution
In the United States and Canada, an emergency 911 call can be blocked if you route it to a link that has no more available bandwidth. For each location on your network, always route 911 calls to the local Public Switched Telephone Network (PSTN) through a local VoIP gateway.
Adding a Location
This section describes how to add a new location to the Cisco CallManager database.
Before You Begin
Before configuring a location, you must configure the primary Cisco CallManager that controls the location. For details, see
Adding a Cisco CallManager, page 12-1
19-5
Chapter 19 Adding a Location
Procedure
Open Cisco CallManager Administration. Select System > Location. If there is an existing location with settings that are similar to the new location you want to configure, select the existing location to display its settings. If you want to use a copy of the existing location to configure the new one, click Copy. In the Location Name field, enter the name of the new location you are creating. In the bandwidth field, enter the maximum amount of voice bandwidth (in kbps) available for all calls on the link between this location and the hub. The hub is the location of the primary Cisco CallManager that controls call processing for your network. For purposes of these bandwidth calculations only, assume that each G.711 call uses 80 kbps of bandwidth and each G.723 or G.729 call uses 24 kbps.
Step 4 Step 5
Note
To improve voice quality, lower the bandwidth setting so that fewer active calls are allowed on the link to this location. If you enter a value of zero, this allocates infinite bandwidth and allows an unlimited number of calls on the link.
Step 6
Click Insert to save the location information in the database.
Related Topics

Understanding Call Admission Control, page 5-1 Configuring Regions, page 16-1
After adding a new location to the database, you can use it to configure a Cisco IP Phone, an H.323 gateway, or other devices:

Configuring Gateways, page 45-1 Configuring Cisco IP Phones in Cisco CallManager, page 46-1
19-6
OL-1047-01
Chapter 19
Configuring Locations Updating a Location
Updating a Location
This section describes how to modify the configuration of a location.
Procedure
Open Cisco CallManager Administration. Select System > Location. From the location list, select the location you want to update. Make the desired changes in the fields you want to update. Before saving the changes, you can click Cancel to reset all fields to their original value. Click Update to save the changes in the database.
Deleting a Location
This section describes how to delete a location from the Cisco CallManager database.
Before You Begin
You cannot delete a location that has any devices assigned to it. If you try to delete a location that is in use, Cisco CallManager displays an error message. Before deleting a location that is currently in use, you must perform either or both of the following tasks:

Update the devices to assign them to a different location. Delete the devices assigned to the location you want to delete.
Note
Deleting a location is equivalent to setting the bandwidth to zero for the links connected to that location. This allows an unlimited number of calls on those links, and it can cause the voice quality to degrade.
19-7
Chapter 19 Deleting a Location
Procedure
Open Cisco CallManager Administration. Select System > Location. From the location list, select the location you want to delete. Click Delete. When asked to confirm the delete operation, click either OK to delete or Cancel to cancel the delete operation.
19-8
OL-1047-01
C H A P T E R
20
Starting and Stopping Cisco CallManager

This chapter describes how to start and stop the Cisco CallManager server. For information about starting and stopping other Cisco CallManager services, refer to the Starting and Stopping Services Using the Control Center section on page 38-1. There are three methods for starting and stopping a Cisco CallManager server:

Using the Control Center in Cisco CallManager Administration. See the Using the Control Center section on page 20-2. Using the Windows Control Panel for Services. See the Using Windows Services section on page 20-3. Using the Reset button in Cisco CallManager Administration. See the Using the Cisco CallManager Reset Button section on page 20-4.
Caution
Stopping Cisco CallManager also stops call processing for all devices controlled by that Cisco CallManager. When a Cisco CallManager is stopped, calls from an IP phone to another IP phone will stay up; calls in progress from an IP phone to an MGCP gateway will also stay up; and any other type of calls will be dropped. See the Understanding Redundancy section on page 3-1. Table 20-1 lists the system parameters that require you to restart Cisco CallManager after changing their settings.
20-1
Chapter 20 Using the Control Center
Table 20-1 Parameter Settings that Require Restarting Cisco CallManager
System Parameter IP address of the Cisco CallManager server Partition for auto-registration External phone number mask for auto-registration TCP port settings for the Cisco CallManager server
Path to this Parameter in Cisco CallManager Administration System > Server System > Cisco CallManager System > Cisco CallManager System > Cisco CallManager
Tips
In general, it is better to make as many configuration changes as possible at one time, and restart Cisco CallManager only once after completing the changes.
Using the Control Center

This section describes how to use the Control Center in Cisco CallManager Administration to start or stop Cisco CallManager.
Procedure
Open Cisco CallManager Administration. Select Service > Control Center. From the server list, select the Cisco CallManager server you want to stop or start. Click Start or Stop for the Cisco CallManager service you want to start or stop. In the Service Status field, a square symbol indicates that the service is stopped and a triangle indicates that the service is running.
20-2
OL-1047-01
Chapter 20
Starting and Stopping Cisco CallManager Using Windows Services
Using Windows Services

This section describes how to use the Windows Control Panel to start or stop Cisco CallManager.
Procedure
Step 1
On the server that contains the Cisco CallManager you want to start or stop, open the Windows Control Panel for Services.
Caution
Make sure you are accessing the correct Cisco CallManager server before attempting to start or stop Cisco CallManager. Select the Cisco CallManager service you want to start or stop. Click Start or Stop, depending on the action you want to perform.
Step 2 Step 3
20-3
Chapter 20 Using the Cisco CallManager Reset Button
Using the Cisco CallManager Reset Button

This section describes how to use the Reset button to stop and start Cisco CallManager.
Procedure
Open Cisco CallManager Administration. Select System > Cisco CallManager. From the list of Cisco CallManagers, select on the one you want to reset. After selecting the appropriate Cisco CallManager, click Reset.
Note
Clicking the Reset button stops Cisco CallManager momentarily and then starts it again. Click the button only once to perform a complete reset, and give Cisco CallManager sufficient time to restart.
20-4
OL-1047-01
A R T
Route Configuration
The following chapters include information about configuring route plans in Cisco CallManager: Chapter 21, Configuring Partitions Chapter 22, Configuring Calling Search Spaces Chapter 23, Configuring Route Filters Chapter 24, Configuring Route Groups Chapter 25, Configuring Route Lists Chapter 26, Configuring Route Patterns Chapter 27, Configuring Translation Patterns Chapter 28, Using the External Route Plan Wizard Chapter 29, Using Route Plan Report
C H A P T E R
21
Configuring Partitions
A partition is a list of route patterns. Partitions facilitate call routing by dividing the route plan into logical subsets based on organization, location, and call type. Use the following procedures to add or delete route partitions:

Adding a Partition, page 21-1 Deleting a Partition, page 21-2
Adding a Partition
The following procedure describes how to add a partition.
Procedure
Open Cisco CallManager Administration. Select Route Plan > Partition in the menu bar. Enter a name in the Partition Name field. The name can consist of up to 50 alphanumeric characters, and can contain any combination of spaces, periods (.), hyphens (-), and underscore characters (_). Each partition name must be unique to the route plan.
21-1
Chapter 21 Deleting a Partition
Timesaver
Use concise and descriptive names for your partitions. The CompanynameLocationCalltype format usually provides a sufficient level of detail and is short enough to enable you to quickly and easily identify a partition. For example, CiscoDallasMetroPT identifies a partition for toll free inter-LATA (Local Access and Transport Area) calls from the Cisco office in Dallas. Enter a description in the Description field. The description can consist of up to 50 alphanumeric characters, and can contain any combination of spaces, periods (.), hyphens (-), and underscore characters (_). If you do not enter a description, the partition name is automatically entered in this field. Click Insert to add the new partition. The new partition name is added to the partition list on the left side of the page, and the message Status: Insert completed is displayed. To add more partitions, click New and repeat Steps 3 through 5.
Step 4
Step 5
Step 6
Related Topics
Deleting a Partition, page 21-2
Deleting a Partition
The following procedure describes how to delete a partition.
Procedure
Open Cisco CallManager Administration. Select Route Plan > Partition in the menu bar. Select a name in the partition list on the left side of the page. Click Delete to remove the partition.
21-2
OL-1047-01
Chapter 21
Configuring Partitions Deleting a Partition
Caution
Check carefully to ensure that you are deleting the correct partition before initiating this action. Deleted partitions cannot be recovered. If a partition is accidentally deleted, it must be rebuilt. A dialog box appears warning you that deleting this partition cannot be undone. Click OK to delete the partition, or click Cancel to cancel the action. If you click OK, the partition is deleted and the message Status: Ready is displayed. Repeat Steps 3 through 7 to delete other partitions.
Related Topics
Adding a Partition, page 21-1
21-3
Chapter 21 Deleting a Partition
21-4
OL-1047-01
C H A P T E R
22
Configuring Calling Search Spaces

A calling search space is an ordered list of route partitions. Calling search spaces determine which partitions calling devices search when attempting to complete a call. Use the following procedures to add, update, copy, or delete a calling search space:

Adding a Calling Search Space, page 22-1 Updating a Calling Search Space, page 22-3 Copying a Calling Search Space, page 22-3 Deleting a Calling Search Space, page 22-4
Adding a Calling Search Space

The following procedure describes how to add a calling search space.
Procedure
Open Cisco CallManager Administration. Select Route Plan > Calling Search Space in the menu bar. Enter a name in the Calling Search Space Name field. The name can consist of up to 50 alphanumeric characters, and can contain any combination of spaces, periods (.), hyphens (-), and underscore characters (_). Each calling search space name must be unique to the route plan.
22-1
Chapter 22 Adding a Calling Search Space
Timesaver
Use concise and descriptive names for your calling search spaces. The CompanynameLocationCalltype format usually provides a sufficient level of detail and is short enough to enable you to quickly and easily identify a calling search space. For example, CiscoDallasMetroCS identifies a calling search space for toll free inter-LATA (Local Access and Transport Area) calls from the Cisco office in Dallas. Enter a description in the Description field. The description can consist of up to 50 alphanumeric characters, and can contain any combination of spaces, periods (.), hyphens (-), and underscore characters (_). If you do not enter a description, the calling search space name is automatically entered in this field. Select partitions in the Available Partitions list box and add them to the Selected Partitions list box by clicking the arrow buttons between the two list boxes. To move a partition, select a partition name in the Selected Partitions list box. Move the partition up or down in the list by clicking the arrows on the right side of the list box. Click Insert to add the new calling search space. The new calling search space name is added to the calling search space list on the left side of the page, and the message Status: Insert completed is displayed. To add more calling search spaces, click New and repeat Steps 3 through 7.
Step 4
Step 5 Step 6
Step 7
Step 8
Related Topics

Updating a Calling Search Space, page 22-3 Copying a Calling Search Space, page 22-3 Deleting a Calling Search Space, page 22-4
22-2
OL-1047-01
Chapter 22
Configuring Calling Search Spaces Updating a Calling Search Space
Updating a Calling Search Space

The following procedure describes how to update a calling search space.
Procedure
Open Cisco CallManager Administration. Select Route Plan > Calling Search Space in the menu bar. Select a name in the calling search space list on the left side of the page. Add, remove, or reorder partitions in the Partitions list boxes by using the appropriate arrow buttons. Click Update. Repeat Steps 3 through 5 to update other calling search spaces.
Related Topics

Adding a Calling Search Space, page 22-1 Copying a Calling Search Space, page 22-3 Deleting a Calling Search Space, page 22-4
Copying a Calling Search Space

The following procedure describes how to copy a calling search space.
Procedure
Open Cisco CallManager Administration. Select Route Plan > Calling Search Space in the menu bar. Select a name in the calling search space list on the left side of the page. Click Copy.
22-3
Chapter 22 Deleting a Calling Search Space
Step 5
Modify the name in the Calling Search Space Name field. The name can consist of up to 50 alphanumeric characters, and can contain any combination of spaces, periods (.), hyphens (-), and underscore characters (_). Each calling search space name must be unique to the route plan. Modify the description in the Description field. The description can consist of up to 50 alphanumeric characters, and can contain any combination of spaces, periods (.), hyphens (-), and underscore characters (_). Add, remove, or reorder partitions in the Partitions list boxes by using the appropriate arrow buttons. Click Insert to add the calling search space. The new calling search space name is added to the calling search space list on the left side of the page, and the message Status: Insert completed is displayed. To copy another calling search space, repeat Steps 3 through 8.
Step 6
Step 7 Step 8
Step 9
Related Topics

Adding a Calling Search Space, page 22-1 Updating a Calling Search Space, page 22-3 Deleting a Calling Search Space, page 22-4
Deleting a Calling Search Space

The following procedure describes how to delete a calling search space.
Note
You cannot delete calling search spaces that are being used by devices or translation patterns.
Procedure
Open Cisco CallManager Administration. Select Route Plan > Calling Search Space in the menu bar. Select a name in the calling search space list on the left side of the page.
22-4
OL-1047-01
Chapter 22
Configuring Calling Search Spaces Deleting a Calling Search Space
Step 4
Click Delete to remove the calling search space. The calling search space is deleted and the message Status: Delete completed is displayed.
Caution
Check carefully to ensure that you are deleting the correct calling search space before initiating this action. Deleted calling search spaces cannot be recovered. If a calling search space is accidentally deleted, it must be rebuilt. Repeat Steps 3 and 4 to delete other calling search spaces.
Step 5
Related Topics

Adding a Calling Search Space, page 22-1 Updating a Calling Search Space, page 22-3 Copying a Calling Search Space, page 22-3
22-5
Chapter 22 Deleting a Calling Search Space
22-6
OL-1047-01
C H A P T E R
23
Configuring Route Filters

Route filters, along with route patterns, use dialed-digit strings to determine how a call is handled. Route filters can only be used with North American Numbering Plan (NANP) route patterns; that is, route patterns that use an at symbol (@) wildcard. Route filters allow you to determine which route patterns your users can dial, for example, whether your users can manually select a long distance carrier (by dialing 101 plus a carrier access code).
Tips
Always add and define the route filter first, and then add the route filter to the route pattern. Use the following procedures to add, update, copy, or delete a route filter:

Adding a Route Filter, page 23-5 Updating a Route Filter, page 23-7 Copying a Route Filter, page 23-7 Adding Route Filter Clauses, page 23-9 Removing Route Filter Clauses, page 23-10 Deleting a Route Filter, page 23-11
23-1
Chapter 23 Understanding Route Filter Tags
Understanding Route Filter Tags

The tag is the core component of a route filter. A tag applies a name to a subset of the dialed-digit string. For example, the NANP number 972-555-1234 comprises LOCAL-AREA-CODE (972), OFFICE-CODE (555), and SUBSCRIBER (1234) route filter tags. Route filter tags require operators, and can require additional values to decide which calls are filtered. The values for route filter tag fields can contain the wildcard characters X, *, #, [, ], -, ^, and the numbers 0 through 9. The descriptions in Table 23-1 use the notations [2-9] and XXXX to represent actual digits. In this notation, [2-9] represents any single digit in the range 2 through 9, and X represents any single digit in the range 0 through 9. Therefore, the description The three-digit area code in the form [2-9]XX means you can enter the actual digits 200 through 999, or all wildcards, or any mixture of actual digits and wildcards that results in a pattern with that range.
Table 23-1 Route Filter Tags
Tag AREA-CODE
Description The three-digit area code in the form [2-9]XX. This entry identifies the area code for long distance calls. The one-, two-, or three-digit code used to specify the destination country for international calls. A single character used to identify the end of the dialed-digit string. The # character is used as the end-of-dialing signal for international numbers dialed within the NANP. The two-digit access code used for international dialing. This code is 01 for calls originating in the U.S.
COUNTRY CODE
END-OF-DIALING
INTERNATIONAL-ACCESS
23-2
OL-1047-01
Chapter 23
Configuring Route Filters Understanding Route Filter Tags
Table 23-1 Route Filter Tags (continued)
Tag INTERNATIONAL-DIRECT-DIAL
Description The one-digit code identifying a direct dialed international call. This code is 1 for calls originating in the U.S. The one-digit code identifying an operator-assisted international call. This code is 0 for calls originating in the U.S. The three-digit local area code in the form [2-9]XX. This entry identifies the local area code for 10-digit local calls. The one-digit code identifying a direct dialed local call. This code is 1 for NANP calls. The one-digit code identifying an operator-assisted local call. This code is 0 for NANP calls. The one-digit code identifying a direct dialed long distance call. This code is 1 for NANP calls. The one- or two-digit code identifying an operator-assisted long distance call within the NANP. This code is 0 for operator-assisted calls, or 00 for direct operator access. The nation-specific part of the digit string for an international call. The first three digits of a seven-digit directory number in the form [2-9]XX. The one-digit code that provides access to satellite connections for international calls. A three-digit code such as 911 for emergency, 611 for repair service, and 411 for information.
INTERNATIONAL-OPERATOR
LOCAL-AREA-CODE
LOCAL-DIRECT-DIAL
LOCAL-OPERATOR
LONG-DISTANCE-DIRECT-DIAL
LONG-DISTANCE-OPERATOR
NATIONAL-NUMBER OFFICE-CODE SATELLITE-SERVICE
SERVICE
23-3
Chapter 23 Understanding Route Filter Tags
Table 23-1 Route Filter Tags (continued)
Tag SUBSCRIBER TRANSIT-NETWORK
Description The last four digits of a seven-digit directory number in the form XXXX. The four-digit value that identifies a long distance carrier. Do not include the leading 101 carrier access code prefix in the TRANSIT-NETWORK value. Refer to TRANSIT-NETWORK-ESCAPE for more information.
TRANSIT-NETWORK-ESCAPE
The three-digit value that precedes the long distance carrier identifier. The value for this field is 101. Do not include the four-digit carrier identification code in the TRANSIT-NETWORK-ESCAPE value. Refer to TRANSIT-NETWORK for more information.
Route filter tag operators determine if a call is filtered based on the existence, and sometimes the contents, of the dialed-digit string associated with that tag. The operators EXISTS and DOES-NOT-EXIST simply check for the existence of that part of the dialed-digit string. The operator == matches the actual dialed-digits with the specified value or pattern. Table 23-2 describes the operators that can be used with route filter tags.
Table 23-2 Route Filter Operators
Operator NOT-SELECTED EXISTS
Description Do not filter calls based on the dialed-digit string associated with this tag. Filter calls when the dialed-digit string associated with this tag is found.
23-4
OL-1047-01
Chapter 23
Configuring Route Filters Adding a Route Filter
Table 23-2 Route Filter Operators (continued)
Operator DOES-NOT-EXIST ==
Description Filter calls when the dialed-digit string associated with this tag is not found. Filter calls when the dialed-digit string associated with this tag matches the specified value.
Caution
Do not enter route filter tag values for tags using the operators EXISTS, DOES-NOT-EXIST, or NOT-SELECTED.
Examples
Example 1: A route filter that uses AREA-CODE and the operator DOES-NOT-EXIST, selects all dialed-digit strings that do not include an area code. Example 2: A route filter that uses AREA-CODE, the operator ==, and the entry 515, selects all dialed-digit strings that include the 515 area code. Example 3: A route filter that uses AREA-CODE, the operator ==, and the entry 5[2-9]X, selects all dialed-digit strings that include area codes in the range of 520 through 599. Example 4: A route filter that uses TRANSIT-NETWORK, the operator ==, and the entry 0288, along with TRANSIT-NETWORK-ESCAPE, the operator ==, and the entry 101, selects all dialed-digit strings with the carrier access code 1010288.
Adding a Route Filter

The following procedure describes how to add a route filter.
Procedure
Open Cisco CallManager Administration. Select Route Plan > Route Filter in the menu bar. Select North American Numbering Plan in the Dial Plan drop-down list box.
OL-1047-01
23-5
Chapter 23 Adding a Route Filter
Step 4
Enter a name in the Route Filter Name field. The name can consist of up to 50 alphanumeric characters, and can contain any combination of spaces, periods (.), hyphens (-), and underscore characters (_). Each route filter name must be unique to the route plan.
Timesaver
Use concise and descriptive names for your route filters. The CompanynameLocationCalltype format usually provides a sufficient level of detail and is short enough to enable you to quickly and easily identify a route filter. For example, CiscoDallasMetro identifies a route filter for toll free inter-LATA (Local Access and Transport Area) calls from the Cisco office in Dallas. Click Continue. Select the route filter tags and operators and enter data, where appropriate, to create a clause for this route filter.
Step 5 Step 6
Note
For help with entering data for route filter tags and operators, refer to the Understanding Route Filter Tags section on page 23-2.
Step 7
Click Insert to add the filter. The new route filter name is added to the route filter list on the left side of the page and the message Status: Insert completed is displayed. To add more route filters, click New and repeat Steps 3 through 7.
Step 8
Related Topics

Understanding Route Filter Tags, page 23-2 Route Plan Overview, page 6-1 Understanding Route Pattern Wildcards and Special Characters, page 6-7 Updating a Route Filter, page 23-7
23-6
OL-1047-01
Chapter 23
Configuring Route Filters Updating a Route Filter
Updating a Route Filter

The following procedure describes how to update a route filter.
Procedure
Open Cisco CallManager Administration. Select Route Plan > Route Filter in the menu bar. Select North American Numbering Plan in the Dial Plan drop-down list box. Select a name from the route filter list on the left side of the page. When the Route Filter Configuration page displays the tags for the route filter, update the appropriate operators and values and click Update. Repeat Step 5 to update other route filter tags. Repeat Steps 4 and 5 to update other route filters.
Related Topics

Understanding Route Filter Tags, page 23-2 Route Plan Overview, page 6-1 Understanding Route Pattern Wildcards and Special Characters, page 6-7 Adding a Route Filter, page 23-5 Copying a Route Filter, page 23-7
Copying a Route Filter

The following procedure describes how to copy a route filter.
Procedure
Step 1 Step 2
Open Cisco CallManager Administration. Select Route Plan > Route Filter in the menu bar.
23-7
Chapter 23 Copying a Route Filter
Select North American Numbering Plan in the Dial Plan drop-down list box. Select a name from the route filter list on the left side of the page. Click Copy. The Route Filter Configuration page displays the new route filter with a Copy Of... name in the Route Filter Name field. Enter the name for this route filter in the Route Filter Name field. Modify operators, add or change values, and add or remove clauses as appropriate to customize the new route filter. Click Insert to add the filter. The new route filter name is added to the route filter list on the left side of the page and the message Status: Insert completed is displayed. To build another route filter that is similar to the current route filter, click Copy, enter a new route filter name, and repeat Steps 7 and 8.
Step 9
Related Topics

Understanding Route Filter Tags, page 23-2 Route Plan Overview, page 6-1 Understanding Route Pattern Wildcards and Special Characters, page 6-7 Adding Route Filter Clauses, page 23-9 Removing Route Filter Clauses, page 23-10
23-8
OL-1047-01
Chapter 23
Configuring Route Filters Adding Route Filter Clauses
Adding Route Filter Clauses

Adding route filter clauses allows you to expand upon an existing route filter by incorporating additional operators and entries for existing tags using a logical OR. You can add route filter clauses either when initially adding a new route filter or when updating an existing route filter. This procedure describes adding a route filter clause to an existing route filter.
Procedure
Open Cisco CallManager Administration. Select Route Plan > Route Filter in the menu bar. Select North American Numbering Plan in the Dial Plan drop-down list box. Select a name from the route filter list on the left side of the page. Click Add Clause to display a new route filter clause data entry page. All the operator fields for this new clause are set to NOT-SELECTED. Select the route filter tags and operators and enter data, where appropriate, to create an additional clause for this route filter.
Note
For help with entering data for route filter tags and operators, refer to the Understanding Route Filter Tags section on page 23-2.
Step 7
Click Insert to add the clause. The new clause is added to the route filter and the message Status: Insert completed is displayed.
Note
The new clause is displayed below the existing clauses on the page. (You might need to scroll down to view the new information.)
Step 8
To add more clauses to the same filter, click Add Clause and repeat Steps 6 and 7. To add clauses to another route filter, repeat Steps 4 through 7.
23-9
Chapter 23 Removing Route Filter Clauses
Related Topics

Understanding Route Filter Tags, page 23-2 Route Plan Overview, page 6-1 Understanding Route Pattern Wildcards and Special Characters, page 6-7 Removing Route Filter Clauses, page 23-10
Removing Route Filter Clauses

You can remove route filter clauses either when setting up a new route filter or when updating an existing route filter. This procedure describes removing a route filter clause from an existing route filter.
Procedure
Open Cisco CallManager Administration. Select Route Plan > Route Filter in the menu bar. Select North American Numbering Plan in the Dial Plan drop-down list box. Select a name from the route filter list on the left side of the page. Scroll down to the top of the clause you want to remove and click Remove Clause. A dialog box appears warning you that removing this route filter clause cannot be undone.
Caution
Each Remove Clause button is linked to the clause immediately below the button. Check carefully to ensure that you are removing the correct clause before initiating this action. If a clause is accidentally removed it cannot be recovered, and must be rebuilt. Click OK to remove the clause, or click Cancel to cancel the action. If you click OK, the clause is removed from the route filter and the message Status: Ready is displayed.
Step 6
23-10
OL-1047-01
Chapter 23
Configuring Route Filters Deleting a Route Filter
Step 7
To remove more clauses from the same filter, scroll to the appropriate clause, click Remove Clause for that clause and repeat Step 6. To remove clauses from another route filter, repeat Steps 4 through 6.
Related Topics

Understanding Route Filter Tags, page 23-2 Route Plan Overview, page 6-1 Understanding Route Pattern Wildcards and Special Characters, page 6-7 Deleting a Route Filter, page 23-11
Deleting a Route Filter

The following procedure describes how to delete a route filter.
Note
You cannot delete route filters that are being used in route patterns or translation patterns.
Procedure
Open Cisco CallManager Administration. Select Route Plan > Route Filter in the menu bar. Select North American Numbering Plan in the Dial Plan drop-down list box. Select a name from the route filter list on the left side of the page. Click Delete. A dialog box appears warning you that deleting this route filter cannot be undone.
Caution
Check carefully to ensure that you are deleting the correct route filter before initiating this action. Deleted route filters cannot be recovered. If a route filter is accidentally deleted, it must be rebuilt.
23-11
Chapter 23 Deleting a Route Filter
Step 6 Step 7
Click OK to delete the route filter, or click Cancel to cancel the action. If you click OK, the route filter is deleted and the message Status: Ready is displayed. Repeat Steps 4 through 6 to delete other route filters.
Related Topics

Understanding Route Filter Tags, page 23-2 Route Plan Overview, page 6-1 Understanding Route Pattern Wildcards and Special Characters, page 6-7 Adding Route Filter Clauses, page 23-9 Removing Route Filter Clauses, page 23-10
23-12
OL-1047-01
C H A P T E R
24
Configuring Route Groups

A route group allows you to designate the order in which gateways are selected. It allows you to prioritize a list of gateways and ports for outgoing trunk selection. For example, if you use two long distance carriers, you could add a route group so that long distance calls to the less expensive carrier are given priority. Calls only route to the more expensive carrier if the first trunk is unavailable. Refer to the Route Plan Overview section on page 6-1, and Understanding Route Groups section on page 24-2 for more detailed route group information. Use the following procedures to add or delete a route group or to add devices to or remove devices from a route group:

Adding a Route Group, page 24-2 Adding Devices to a Route Group, page 24-3 Removing Devices from a Route Group, page 24-5 Updating a Route Group, page 24-6 Deleting a Route Group, page 24-7
24-1
Chapter 24 Understanding Route Groups
Understanding Route Groups

Each gateway, or all ports or selected ports combination, can only belong to one route group and can only be listed once within that route group. Route groups are optional. If a proposed route group only contains one gateway or one gateway-and-port combination and that route group is not to be included in a route list, the route group is not needed. If a gateway is assigned to a route pattern (all ports used), then the gateway will not be listed as gateways to be included in route groups. The gateway-and- port combination can only be included in one route group. For example, if device X with ports 4, 5 are selected in route group 1, then the same device and ports cannot be selected in any other route group. Other unused ports, however, can be used in other route groups.
Adding a Route Group

The following procedure describes how to add a route group.
Procedure
Open Cisco CallManager Administration. Select Route Plan > Route Group in the menu bar. Enter a name in the Route Group Name field. The name can consist of up to 50 alphanumeric characters, and can contain any combination of spaces, periods (.), hyphens (-), and underscore characters (_). Each route group name must be unique to the route plan.
Timesaver
Use concise and descriptive names for your route groups. The CompanynameLocationGroup format usually provides a sufficient level of detail and is short enough to enable you to quickly and easily identify a route group. For example, CiscoDallasAA1 identifies a Cisco Access Analog route group for the Cisco office in Dallas. Click Continue.
Step 4
24-2
OL-1047-01
Chapter 24
Configuring Route Groups Adding Devices to a Route Group
Step 5 Step 6
Select the device you want to add to the group from the Device Name drop-down list box. If this device supports individually configurable ports, select the port in the Port drop-down list box. (Cisco Access Analog and Cisco MGCP Analog gateways allow you to select individual ports.) Otherwise, select All (default value). Select the order in which you want to access this port or device in the Order drop-down list box. Click Insert to add this route group with one device. Click Add Device and repeat Steps 4 through 8 to add more devices to this route group. Click New and repeat Steps 3 through 8 to add more route groups.
Related Topics

Route Plan Overview, page 6-1 Understanding Route Groups, page 24-2 Adding Devices to a Route Group, page 24-3 Removing Devices from a Route Group, page 24-5 Deleting a Route Group, page 24-7 Adding a Route List, page 25-6 Adding Route Groups to a Route List, page 25-8
Adding Devices to a Route Group

You can add devices to a new route group or to an existing route group. The following procedure describes adding a device to an existing route group.
Before You Begin
You must define one or more gateway devices before performing this procedure.
Procedure
Step 1
Open Cisco CallManager Administration.
24-3
Chapter 24 Adding Devices to a Route Group
Select Route Plan > Route Group in the menu bar. Select a name from the route group list on the left side of the page. Click Add Device. Select the device you want to add to the group from the Device Name drop-down list box. If this device supports individually configurable ports, select the port in the Port drop-down list box. (Cisco Access Analog and Cisco MGCP Analog gateways allow you to select individual ports.) Otherwise, select All (default value). Select the order in the Order drop-down list box. Click Insert to add this gateway and selected ports to the route group. Click Update to update the device order for this route group. Select the order in which the new device is to be accessed in this route group in the Order drop-down list box. Click Add Device and repeat Steps 5 through 9 to add more devices to this route group.
Related Topics

Route Plan Overview, page 6-1 Understanding Route Groups, page 24-2 Adding a Route Group, page 24-2 Removing Devices from a Route Group, page 24-5 Updating a Route Group, page 24-6 Deleting a Route Group, page 24-7 Adding a Route List, page 25-6
24-4
OL-1047-01
Chapter 24
Configuring Route Groups Removing Devices from a Route Group
Removing Devices from a Route Group

You can remove devices from a new route group or from an existing route group. The following procedure describes removing a device from an existing route group.
Procedure
Open Cisco CallManager Administration. Select Route Plan > Route Group in the menu bar. Select a name from the route group list on the left side of the page. Under the Route Group Members subheading, select the check box or boxes to the left of the devices to be deleted. Click Remove Device. A dialog box appears warning you that removing devices from a route group cannot be undone. Click OK to remove the devices, or click Cancel to cancel the action. If you click OK, the devices are removed from the route group. Select a name in the route group list on the left side of the page and repeat Steps 4 through 6 to remove devices from another route group.
Related Topics

Route Plan Overview, page 6-1 Understanding Route Groups, page 24-2 Adding a Route Group, page 24-2 Adding Devices to a Route Group, page 24-3 Updating a Route Group, page 24-6 Deleting a Route Group, page 24-7 Adding a Route List, page 25-6
24-5
Chapter 24 Updating a Route Group
Updating a Route Group

The following procedure describes how to update a route group.
Before You Begin
The route group to be updated must already be configured before performing this procedure.
Procedure
Open Cisco CallManager Administration. Select Route Plan > Route Group in the menu bar. Select the route group you want to update from the list on the left side of the page. Make the desired changes to the route group and click Update. Your changes should appear and the Status field should say Update completed.
Related Topics

Route Plan Overview, page 6-1 Understanding Route Groups, page 24-2 Adding a Route Group, page 24-2 Adding Devices to a Route Group, page 24-3 Deleting a Route Group, page 24-7 Adding a Route List, page 25-6
24-6
OL-1047-01
Chapter 24
Configuring Route Groups Deleting a Route Group
Deleting a Route Group

The following procedure describes how to delete a route group.
Note
You cannot delete a route group that is referenced by one or more route lists. You must remove the route group from all route lists to which it belongs before deleting the route group.
Procedure
Open Cisco CallManager Administration. Select Route Plan > Route Group in the menu bar. Select a name from the route group list on the left side of the page. Click Delete. A dialog box appears warning you that deleting route groups cannot be undone. Click OK to delete the group, or click Cancel to cancel the action. If you click OK, the route group is removed from the route group list. The gateways that belonged to the deleted route group can now be selected by other route groups or route patterns, provided that all ports were available with the gateways. Select a name in the route group list on the left side of the page and repeat Steps 4 and 5 to remove another route group.
Step 6
Related Topics

Route Plan Overview, page 6-1 Understanding Route Groups, page 24-2 Adding a Route Group, page 24-2 Adding Devices to a Route Group, page 24-3 Updating a Route Group, page 24-6 Adding a Route List, page 25-6
24-7
Chapter 24 Deleting a Route Group
24-8
OL-1047-01
C H A P T E R
25
Configuring Route Lists

Route lists are made up of route groups which consist of a list of resources (gateways). A route list associates a set of route groups with a route pattern and determines the order in which those route groups are accessed. The order controls the progress of the search for available trunk devices for outgoing calls. A route list is a collection of resources (gateways, route groups) that route calls that match the defined route pattern. Once a call is determined by the Cisco CallManager to be routed througha defined route list, the Cisco CallManager finds the first available device based on the order of the route group(s) defined in a route list. There should be at least one route group in each route list. Within each route group, there should be at least one device, such as a gateway, available. Some, or all, ports can be selected as resources in each route group based on device type. Some devices, such as digital access, only allow you to select all ports. Each route list can contain the same route groups that have already been selected by other route lists. Use the following procedures to add or remove route lists or to add, remove or change the order of route groups in a route list:

Adding a Route List, page 25-6 Adding Route Groups to a Route List, page 25-8 Removing Route Groups from a Route List, page 25-10 Changing the Order of Route Groups in a Route List, page 25-11 Deleting a Route List, page 25-12
25-1
Chapter 25 Understanding Calling Party Transform Settings
Understanding Calling Party Transform Settings

Calling party transform settings allow you to manipulate the appearance of the calling partys number for outgoing calls. The calling partys number is used for Calling Line Identification (CLID). During an outgoing call, the CLID is passed to each private branch exchange (PBX), central office (CO), and inter-exchange carrier (IXC) as the call progresses. The CLID is also delivered to the calling party when the call completes. The calling party transform settings used in route lists are assigned to the individual route groups comprising the list, rather than the route list as a whole. The calling party transformsettings assigned to the route groups in a route list override any calling party transform settings assigned to a route pattern associated with that route list. Table 25-1 describes the fields, options, and values used to specify calling party transform for a route group.
25-2
OL-1047-01
Chapter 25
Configuring Route Lists Understanding Calling Party Transform Settings
Table 25-1 Calling Party Transform Settings
Field Name Use Calling Partys External Phone Number Mask
Description This field determines whether or not the full, external phone number is used for CLID on outgoing calls. The options for this field are Default, Off, and On.
Default: This setting indicates that the calling party external phone number and calling party transform masks are not governed by the route group. If a calling party external phone number mask or transform mask is selected for the route pattern, calls that are routed through this route group will use those masks. Off: This setting indicates that the calling partys external phone number is not used for CLID. If no transform mask is entered for this route group, calls that are routed through this group are not associated with a CLID. On: This setting indicates that the calling partys full, external number is used for CLID.
Calling Party Transform Mask
This field specifies the calling party transform mask for all calls routed through this route group. Valid values for this field are the numbers 0 through 9, and the wildcard character X. This field can also be left blank. If it is blank and the preceding field is set to Off, no calling party number is available for CLID. The calling party transform mask can contain up to 50 digits.
Related Topics

Route Plan Overview, page 6-1 Understanding Route Pattern Wildcards and Special Characters, page 6-7
25-3
Chapter 25 Understanding Called Party Transform Settings
Understanding Called Party Transform Settings

Called party transform settings allow you to manipulate the dialed digits, or called partys number, for outgoing calls. Examples of manipulating called numbers include appending or removing prefix digits (outgoing calls), appending area codes to calls dialed as seven-digit numbers, appending area codes and office codes to interoffice calls dialed as four- or five-digit extensions, and suppressing carrier access codes for equal access calls. The called party transform settings used in route lists are assigned to the individual route groups comprising the list, rather than the route list as a whole. The called party transform settings assigned to the route groups in a route list override any called party transform settings assigned to a route pattern associated with that route list. Table 25-2 describes the fields, options, and values used to specify called party transform for a route group.
25-4
OL-1047-01
Chapter 25
Configuring Route Lists Understanding Called Party Transform Settings
Table 25-2 Called Party Transform Settings
Field Name Dial Plan
Description This field determines which dialing plan is used. If it is not already selected, change this field to North American Numbering Plan.
Note
The Dial Plan field only appears when inserting a route group in a route list. Once the route group is inserted, this field cannot be modified.
Discard Digits
This field contains a list of discard patterns that control the discard digit instructions. For example, in a system where users must dial 9 to make a call to the Public Switched Telephone Network (PSTN), the PreDot discard pattern causes the 9 to be stripped from the dialed digit string. Refer to the Understanding Discard Digits Instructions section on page 6-12 for more information.
25-5
Chapter 25 Adding a Route List
Table 25-2 Called Party Transform Settings (continued)
Field Name Called Party Transform Mask
Description This field specifies the called party transform mask for all calls routed through this route group. Valid values for this field are the numbers 0 through 9, and the wildcard character X. This field can also be left blank. If this field is blank, no transformation takes placethe dialed digits are sent exactly as dialed. The calling party transform mask can contain up to 50 digits.
Prefix Digits (Outgoing Calls)
This field contains a prefix digit or a set of Prefix Digits (Outgoing Calls) that are appended to the called party number on all calls routed through this route group. Valid values for this field are the numbers 0 through 9 and blank. Prefix Digits (Outgoing Calls) can contain up to 50 digits.
Related Topics

Route Plan Overview, page 6-1 Understanding Route Pattern Wildcards and Special Characters, page 6-7 Understanding Discard Digits Instructions, page 6-12
Adding a Route List

The following procedure describes how to add a route list.
Procedure
Step 1 Step 2
Open Cisco CallManager Administration. Select Route Plan > Route List in the menu bar.
25-6
OL-1047-01
Chapter 25
Configuring Route Lists Adding a Route List
Step 3
Enter a name in the Route List Name field. The name can consist of up to 50 alphanumeric characters, and can contain any combination of spaces, periods (.), hyphens (-), and underscore characters (_). Each route list name must be unique to the route plan.
Timesaver
Use concise and descriptive names for your route lists. The CompanynameLocationCalltype format usually provides a sufficient level of detail and is short enough to enable you to quickly and easily identify a route list. For example, CiscoDallasMetro identifies a route list for toll free inter-LATA (Local Access and Transport Area) calls from the Cisco office in Dallas. Click Insert to add this route list. Type a description for the route list in the Description field and click Update. Click New and repeat Steps 3 through 5 to add another route list. Click Add Route Group and perform Steps 5 through 9 of the Adding Route Groups to a Route List section on page 25-8 to add a route group to this list.
Related Topics

Route Plan Overview, page 6-1 Understanding Route Groups, page 24-2 Adding Route Groups to a Route List, page 25-8 Changing the Order of Route Groups in a Route List, page 25-11 Removing Route Groups from a Route List, page 25-10 Deleting a Route List, page 25-12
25-7
Chapter 25 Adding Route Groups to a Route List
Adding Route Groups to a Route List

You can add route groups to a new route list or an existing route list. The following procedure describes adding a route group to an existing route list.
Before You Begin
You must build one or more route groups and add a route list before performing this procedure.
Procedure
Open Cisco CallManager Administration. Select Route Plan > Route List in the menu bar. Select a name from the route lists on the left side of the page. Click Add Route Group. Select a route group to add to the list from the Select Route Group drop-down list box. Click Add. If you need to manipulate the calling partys number on calls routed through this route group, set up the calling party transform in the appropriate fields.
Note
For more information on calling party transform, see Understanding Calling Party Transform Settings, page 25-2.
Step 8
If you need to manipulate the dialed digits on calls routed through this route group, set up the called party transform in the appropriate fields.
Note
For more information on called party transform, see Understanding Called Party Transform Settings, page 25-4.
Step 9
Click Insert to add the route group. The new route group name is added to the route list on the left side of the page and the message Status: Insert completed is displayed.
25-8
OL-1047-01
Chapter 25
Configuring Route Lists Adding Route Groups to a Route List
Step 10
Click Add Route Group to the current Route List and repeat Steps 5 through 9 to add more route groups to this list. Click Add new Route List and perform Steps 3 through 5 of the Adding a Route List section on page 25-6 to add another route list.
Related Topics

Route Plan Overview, page 6-1 Understanding Calling Party Transform Settings, page 25-2 Understanding Called Party Transform Settings, page 25-4 Adding a Route List, page 25-6 Changing the Order of Route Groups in a Route List, page 25-11 Removing Route Groups from a Route List, page 25-10 Deleting a Route List, page 25-12
25-9
Chapter 25 Removing Route Groups from a Route List
Removing Route Groups from a Route List

You can remove route groups from a new route list or from an existing route list. The following procedure describes removing a route group from an existing route list.
Procedure
Open Cisco CallManager Administration. Select Route Plan > Route List in the menu bar. Select a name from the route lists on the left side of the page. Select one or more route group names from the Selected Route Groups list.
Note
To select multiple route groups from the list, press the Shift key and click on Multiple Route Groups.
Click Remove Route Group. A dialog box appears warning you that removing route groups from a route list cannot be undone. Click OK to remove the route group, or click Cancel to cancel the action. If you click OK, when the page refreshes, the route group is removed from the route list and the message Status: Ready is displayed. Select a route group name from the Selected Route Groups list and repeat Steps 5 through 7 to remove another route group from this route list.
Step 8
Related Topics

Route Plan Overview, page 6-1 Adding a Route List, page 25-6 Adding Route Groups to a Route List, page 25-8 Changing the Order of Route Groups in a Route List, page 25-11 Deleting a Route List, page 25-12
25-10
OL-1047-01
Chapter 25
Configuring Route Lists Changing the Order of Route Groups in a Route List
Changing the Order of Route Groups in a Route List

Route groups are accessed in the order in which they appear in the route list. The following procedure allows you to change the access order of route groups.
Procedure
Open Cisco CallManager Administration. Select Route Plan > Route List in the menu bar. Select a name from the route lists on the left side of the page. Select a route group name from the Selected Route Groups list. Click the up or down arrows on the right side of the list box to move the route group up or down in the list. Select a route group name from the Selected Route Groups list and repeat Steps 4 and 5 to move another route group in the route list.
Related Topics

Route Plan Overview, page 6-1 Adding a Route List, page 25-6 Adding Route Groups to a Route List, page 25-8 Removing Route Groups from a Route List, page 25-10 Deleting a Route List, page 25-12
25-11
Chapter 25 Deleting a Route List
Deleting a Route List

Route lists are associated with both route groups and route patterns, however neither route groups nor route patterns are deleted when the route list is deleted. The following procedure describes how to delete a route list.
Procedure
Open Cisco CallManager Administration. Select Route Plan > Route List in the menu bar. Select a name from the route lists on the left side of the page. Click Delete. A dialog box appears warning you that removing a route list cannot be undone. Click OK to remove the route list, or click Cancel to cancel the action. If you click OK, when the page refreshes, the route list is removed and the message Status: Ready is displayed. Repeat Steps 3 through 6 to remove another route list.
Step 7
Warning
If you delete a route list that is associated with a route pattern in the Route Pattern Configuration page, the route pattern will not have a route list associated with it. This means that any calls that match the route patterns will not be routed until you select another route list/gateway to be associated with that route pattern.
Related Topics

Route Plan Overview, page 6-1 Adding a Route List, page 25-6 Adding Route Groups to a Route List, page 25-8 Changing the Order of Route Groups in a Route List, page 25-11 Removing Route Groups from a Route List, page 25-10
25-12
OL-1047-01
C H A P T E R
26
Configuring Route Patterns

A route pattern is a string of digits (an address) and a set of associated digit manipulations that can be assigned to a route list or a gateway. Route patterns provide flexibility in network design. They work in conjunction with route filters and route lists to direct calls to specific devices and to include, exclude, or modify specific digit patterns. Refer to the Understanding Route Patterns section on page 6-24 for more detailed route pattern information. Use the following procedures to add, update, copy, or delete a route pattern:

Adding a Route Pattern, page 26-1 Updating a Route Pattern, page 26-4 Copying a Route Pattern, page 26-5 Deleting a Route Pattern, page 26-6
Adding a Route Pattern

This section describes how to add a route pattern.
Before You Begin
The following Cisco CallManager applications must be configured first in order to select them:

Gateway Route List

OL-1047-01
26-1
Chapter 26 Adding a Route Pattern
Partition Route Filter
Procedure
Open Cisco CallManager Administration. Select Route Plan > Route Pattern. Enter the route pattern, including numbers and wildcards (do not use spaces) in the Route Pattern field, for example, 9.@ for typical local access, or 8XXX for a typical private network numbering plan.
Timesaver
Assigning 8XXX to a gateway routes all directory numbers 8000 to 8999 out the gateway. Similarly, 82XX routes directory numbers 8200 to 8299. Refer to the Understanding Route Pattern Wildcards and Special Characters section on page 6-7 for more information about wildcards.
Note
The directory route pattern, using the selected partition, route filter, and numbering plan combination, must be unique. Check the route pattern, translation pattern, directory number, call park number, call pickup number, or Meet Me number if you receive an error indicating duplicate entries.
Step 4
Select a partition from the Partition drop-down list box, or None if you dont want to assign a partition. Refer to the Configuring Partitions section on page 21-1 for more information on how to use partitions. Select a numbering plan from the Numbering Plan drop-down list box. If your route pattern includes the @ wildcard, select a route filter from the Route Filter drop-down list box. Selecting a route filter restricts certain number patterns. Route filters are optional. Select the gateway or route list for which you are adding a route pattern from the Gateway/Route List drop-down list box.
Step 5 Step 6
Step 7
26-2
OL-1047-01
Chapter 26
Configuring Route Patterns Adding a Route Pattern
Note
If there is at least one port of the defined gateway included in a route group, or that has an assigned DN, that gateway will not be included in this drop-down list box. No ports can be used in order to include the gateway. When a gateway is selected in the drop-down list box, all the ports are being used to route/block this route pattern.
Step 8
The Route Option designation indicates whether you want this route pattern used for routing calls (such as 9.@ or 8[2-9]XX) or for blocking calls. Select Route this pattern or Block this pattern in the Route Option fields. Check the boxes for Provide Outside Dial Tone and Urgent Priority accordingly. Check the box for Use Calling Partys External Phone Number Mask if you want the full, external phone number used for CLID on outgoing calls. You must also configure an External Mask on all phone devices. Enter a transformation mask value in the Calling Party Transform Mask field. Valid entries include the digits 0 through 9, the wildcard character X, and blank. If this field is blank and the preceding field is not checked, no calling party transformation takes place. Refer to the Understanding Calling Party Transform Settings section on page 25-2 for more information.
Step 9 Step 10
Step 11
Note
The calling party transformation settings assigned to the route groups in a route list override any calling party transformation settings assigned to a route pattern associated with that route list.
Step 12
Select the discard digits instructions you want associated with this route pattern from the Discard Digits drop-down list box. Refer to the Understanding Discard Digits Instructions section on page 6-12 for more information. Enter a transformation mask value in the Called Party Transform Mask field. Valid entries include the digits 0 through 9, the wildcard character X, and blank. If the field is blank, no transformation takes place. The dialed digits are sent exactly as dialed. Refer to the Understanding Called Party Transform Settings section on page 25-4 for more information. Enter prefix digits in the Prefix Digits (Outgoing Calls) field. Valid entries include the digits 0 through 9, #, *, and blank.
Step 13
Step 14
26-3
Chapter 26 Updating a Route Pattern
Note
The appended prefix digit does not affect which directory numbers route to the assigned device.
Step 15
Click Insert. The route pattern appears in the list on the left side of the page.
Note
Once you click Insert and the page refreshes, an (Edit) link appears on the page next to the Gateway/Route List field. This link takes you to the MGCP Member Configuration page for reference so you can see the route group(s) included in that route list.
Step 16
Click New and repeat Steps 1 through 15 to add more route patterns.
Related Topics

Route Plan Overview, page 6-1 Understanding Route Pattern Wildcards and Special Characters, page 6-7 Understanding Closest-Match Routing, page 6-11 Adding a Route Filter, page 23-5 Updating a Route Pattern, page 26-4 Copying a Route Pattern, page 26-5 Deleting a Route Pattern, page 26-6
Updating a Route Pattern

This section describes how to update a route pattern.
Procedure
Step 1 Step 2
Open Cisco CallManager Administration. Click Route Plan > Route Pattern.
26-4
OL-1047-01
Chapter 26
Configuring Route Patterns Copying a Route Pattern
Step 3
Select the route pattern you want to update from the Route Pattern list on the left side of the page.
Note
Step 4 Step 5
Make the desired changes to the route pattern and click Update. The page displays the updated route pattern. Repeat Steps 3 and 4 to update more route patterns.
Related Topics

Route Plan Overview, page 6-1 Understanding Route Pattern Wildcards and Special Characters, page 6-7 Understanding Closest-Match Routing, page 6-11 Adding a Route Filter, page 23-5 Adding a Route Pattern, page 26-1 Copying a Route Pattern, page 26-5 Deleting a Route Pattern, page 26-6
Copying a Route Pattern

This section describes how to copy a route pattern.
Procedure
Step 1 Step 2
Open Cisco CallManager Administration. Click Route Plan > Route Pattern.
26-5
Chapter 26 Deleting a Route Pattern
Select the route pattern you want to copy from the Route Pattern list on the left side of the page. Click Copy. The page displays the route pattern with a Copy of... name in the Route Pattern field. Replace the name for this route pattern in the Route Pattern field. Make appropriate changes to customize the new route pattern and click Insert. The new route pattern appears in the route pattern list on the left side of the page. To build another route pattern that is similar to the current route pattern, click Copy, enter a new route pattern name, and repeat Steps 3 through 6.
Related Topics

Route Plan Overview, page 6-1 Understanding Route Pattern Wildcards and Special Characters, page 6-7 Understanding Closest-Match Routing, page 6-11 Adding a Route Filter, page 23-5 Adding a Route Pattern, page 26-1 Updating a Route Pattern, page 26-4 Deleting a Route Pattern, page 26-6
Deleting a Route Pattern

This section describes how to delete a route pattern.
Procedure
Open Cisco CallManager Administration. Click Route Plan > Route Pattern. Select the route pattern you want to delete from the Route Pattern list on the left side of the page. Click Delete. A message displays stating that you are about to delete the selected route pattern and that this action cannot be undone.
26-6
OL-1047-01
Chapter 26
Configuring Route Patterns Deleting a Route Pattern
Step 5 Step 6
Click OK to continue, or Cancel to cancel the deletion. Repeat Steps 3 through 5 to delete more route patterns.
Related Topics

Route Plan Overview, page 6-1 Understanding Route Pattern Wildcards and Special Characters, page 6-7 Understanding Closest-Match Routing, page 6-11 Adding a Route Filter, page 23-5 Adding a Route Pattern, page 26-1 Updating a Route Pattern, page 26-4 Copying a Route Pattern, page 26-5
26-7
Chapter 26 Deleting a Route Pattern
26-8
OL-1047-01
C H A P T E R
27
Configuring Translation Patterns

The Cisco CallManager uses translation patterns to manipulate dialed digits before routing a call. In some cases, the dialed number is not the number that is used by the system. In other cases, the dialed number is not a number that is recognized by the Public Switched Telephone Network (PSTN). Refer to the Understanding Translation Patterns section on page 27-1 for more detailed translation pattern information. Use the following procedures to add, update, copy, or delete a translation pattern:

Adding a Translation Pattern, page 27-2 Updating a Translation Pattern, page 27-4 Copying a Translation Pattern, page 27-5 Deleting a Translation Pattern, page 27-6
Understanding Translation Patterns

Digit manipulation and translation patterns are used frequently in cross-geographical distributed systems where, for instance, the office codes are not the same at all locations. In these situations, a uniform dialing plan can be created, and translation patterns can be applied to accommodate the unique office codes at each location.
27-1
Chapter 27 Adding a Translation Pattern
Note
Translation patterns provide a level of routing indirection for other applications also. The previous explanation is just the most common application
Related Topics

Route Plan Overview, page 6-1 Understanding Route Pattern Wildcards and Special Characters, page 6-7 Understanding Closest-Match Routing, page 6-11 Understanding Discard Digits Instructions, page 6-12
Adding a Translation Pattern

This section describes how to add a translation pattern.
Before You Begin
Configure the following Cisco CallManager applications before adding a translation pattern:

Partition Route Filter Calling Search Space
Procedure
Open Cisco CallManager Administration. Select Route Plan > Translation Pattern. Enter the translation pattern, including numbers and wildcards (do not use spaces) in the Translation Pattern field. For example, 9.@ for typical local access, or 8XXX for a typical private network numbering plan.
27-2
OL-1047-01
Chapter 27
Configuring Translation Patterns Adding a Translation Pattern
Note
Select a partition from the Partition drop-down list box. Select None if you dont want to assign a partition. Select a numbering plan from the Numbering Plan drop-down list box. If your translation pattern includes the @ wildcard, select a route filter from the Route Filter drop-down list box. Selecting a route filter restricts certain number patterns. Route filters are optional. Refer to the Understanding Route Pattern Wildcards and Special Characters section on page 6-7, and the Configuring Route Filters section on page 23-1 for more information. Select the calling search space for which you are adding a translation pattern from the Calling Search Space drop-down list box. This is an optional selection. The Route Option designation indicates whether you want this translation pattern used for routing calls (such as 9.@ or 8[2-9}XX) or for blocking calls. Select Route this pattern or Block this pattern in the Route Option fields. Check the boxes for Provide Outside Dial Tone. Urgent Priority is selected by default.
Step 7 Step 8
Step 9
Note
All translation patterns are set with urgent priority and cannot be changed.
Step 10 Step 11
Check the box for Use Calling Partys External Phone Number Mask if you want the full, external phone number used for calling line ID (CLID) on outgoing calls. Enter a transformation mask value in the Calling Party Transform Mask field. Valid entries include the digits 0 through 9, the wildcard character X, and blank. If this field is blank and the preceding field is not checked, no calling party transformation takes place. See the Understanding Calling Party Transform Settings section on page 25-2 for more detailed information. Select the discard digits instructions you want associated with this translation pattern from the Discard Digits drop-down list box.
Step 12
OL-1047-01
27-3
Chapter 27 Updating a Translation Pattern
Step 13
Enter a transformation mask value in the Called Party Transform Mask field. Valid entries include the digits 0 through 9, the wildcard character X, and blank. If the field is blank, no transformation takes place. The dialed digits are sent exactly as dialed. Refer to the Understanding Called Party Transform Settings section on page 25-4 for more detailed information. Enter prefix digits in the Prefix Digits (Outgoing Calls) field. Valid entries include the digits 0 through 9, #, *, and blank.
Step 14
Note
The appended prefix digit does not affect which directory numbers route to the assigned device.
Step 15 Step 16
Click Insert. The translation pattern appears in the list on the left side of the page. Click New and repeat Steps 1 through 15 to add more translation patterns.
Related Topics

Updating a Translation Pattern, page 27-4 Copying a Translation Pattern, page 27-5 Deleting a Translation Pattern, page 27-6
Updating a Translation Pattern

This section describes how to update a translation pattern.
Procedure
Open Cisco CallManager Administration. Click Route Plan > Translation Pattern. Select the translation pattern you want to update from the Translation Pattern list on the left side of the page. Make the desired changes to the translation pattern and click Update. The page displays the updated translation pattern.
27-4
OL-1047-01
Chapter 27
Configuring Translation Patterns Copying a Translation Pattern
Note
Step 5
Repeat Steps 3 and 4 to update more translation patterns.
Related Topics

Adding a Translation Pattern, page 27-2 Copying a Translation Pattern, page 27-5 Deleting a Translation Pattern, page 27-6
Copying a Translation Pattern

This section describes how to copy a translation pattern.
Procedure
Open Cisco CallManager Administration. Click Route Plan > Translation Pattern. Select the translation pattern you want to copy from the Translation Pattern list on the left side of the page. Click Copy. The page displays the translation pattern with a Copy of... name in the Translation Pattern field. Replace the name for this translation pattern in the Translation Pattern field. Make appropriate changes to customize the new translation pattern and click Insert. The new translation pattern appears in the translation pattern list on the left side of the page.
27-5
Chapter 27 Deleting a Translation Pattern
Step 7
To build another translation pattern that is similar to the current translation pattern, click Copy, enter a new translation pattern name, and repeat Steps 3 through 6.
Related Topics

Route Plan Overview, page 6-1 Understanding Translation Patterns, page 27-1 Adding a Translation Pattern, page 27-2 Updating a Translation Pattern, page 27-4 Deleting a Translation Pattern, page 27-6
Deleting a Translation Pattern

This section describes how to delete a translation pattern.
Procedure
Open Cisco CallManager Administration. Click Route Plan > Translation Pattern. Select the translation pattern you want to delete from the Translation Pattern list on the left side of the page. Click Delete. A message displays stating that you are about to delete the selected translation pattern and that this action cannot be undone. Click OK to continue, or Cancel to cancel the deletion. Repeat Steps 3 through 5 to delete more translation patterns.
27-6
OL-1047-01
Chapter 27
Configuring Translation Patterns Deleting a Translation Pattern
Related Topics

Adding a Translation Pattern, page 27-2 Updating a Translation Pattern, page 27-4 Copying a Translation Pattern, page 27-5
27-7
Chapter 27 Deleting a Translation Pattern
27-8
OL-1047-01
C H A P T E R
28
Using the External Route Plan Wizard

The external route plan wizard is a tool that allows Cisco CallManager administrators to quickly configure external routing to the Public Switched Telephone Network (PSTN), to Private Branch Exchanges (PBXs), or to other Cisco CallManager systems. Refer to the Understanding the External Route Plan Wizard section on page 6-25 for more detailed information about how the wizard generates the external route plan. Use the following procedures to set up a route plan with the external route plan wizard:

Creating an External Route Plan, page 28-2 Setting the Routing Options, page 28-2 Providing Tenant Information, page 28-4 Entering Location Information, page 28-5 Selecting Gateways, page 28-6 Providing Gateway Information, page 28-8 Generating the External Route Plan, page 28-9 Confirming the External Route Plan, page 28-10 Finishing the External Route Plan, page 28-11 Deleting an External Route Plan, page 28-11
28-1
Chapter 28 Creating an External Route Plan
Creating an External Route Plan

The following procedure describes how to begin to create an external route plan.
Before You Begin
All gateways must be defined before using the external route plan wizard. Select Device > Gateway or Device > MGCP in the menu bar to set up new gateways.
Procedure
Open Cisco CallManager Administration. Select Route Plan > External Route Plan Wizard in the menu bar. Click Next on the External Route Plan Wizard introduction page to create an external route plan.
Related Topics

Setting the Routing Options, page 28-2 Providing Tenant Information, page 28-4 Entering Location Information, page 28-5 Selecting Gateways, page 28-6 Providing Gateway Information, page 28-8 Generating the External Route Plan, page 28-9 Confirming the External Route Plan, page 28-10 Finishing the External Route Plan, page 28-11 Deleting an External Route Plan, page 28-11
Setting the Routing Options

The following procedure describes how to set routing options for the external route plan.
28-2
OL-1047-01
Chapter 28
Using the External Route Plan Wizard Setting the Routing Options
Procedure
Step 1
Check the boxes for Local call fallback, Toll bypass fallback, Long distance fallback, International call fallback, and Equal access suppression as appropriate.
Note
If you choose local call fallback, toll bypass fallback, long distance fallback, or international call fallback, the external route plan wizard includes route groups with remote gateways in the associated route lists.
Step 2
Enter the access code for calls that are routed to remote or local gateways in the Access code for toll bypass and fallback calls field. Use only numeric values. (Many systems use 9 for external calls.)
Note
The access code entered in this field applies to the entire dial plan. Only one access code is allowed per dial plan.
Step 3
Enter the access code for callas between the Cisco CallManager and the adjacent PBX Access code for extensions served by a connected PBX field. (Many systems use 8 for calls to adjacent PBX systems.) Click Next.
Step 4
Related Topics

Creating an External Route Plan, page 28-2 Providing Tenant Information, page 28-4 Entering Location Information, page 28-5 Selecting Gateways, page 28-6 Providing Gateway Information, page 28-8 Generating the External Route Plan, page 28-9 Confirming the External Route Plan, page 28-10 Finishing the External Route Plan, page 28-11 Deleting an External Route Plan, page 28-11
OL-1047-01
28-3
Chapter 28 Providing Tenant Information
Providing Tenant Information

The following procedure describes how to add tenant information for the external route plan.
Procedure
Step 1
Enter the tenant name in the Tenant Name field. (This is generally the name of the organization for which the route plan is being built.)
Note
We recommend that you use a short tenant name because it is incorporated in the calling search space and partition names.
Step 2
Enter the number of geographical locations associated with the organization in the Number of physical locations in the entire system field. This field should reflect the all Cisco CallManagers in the system that use unique area codes. The default number of locations is two. Click Next.
Step 3
Related Topics

Creating an External Route Plan, page 28-2 Setting the Routing Options, page 28-2 Entering Location Information, page 28-5 Selecting Gateways, page 28-6 Providing Gateway Information, page 28-8 Generating the External Route Plan, page 28-9 Confirming the External Route Plan, page 28-10 Finishing the External Route Plan, page 28-11 Deleting an External Route Plan, page 28-11
28-4
OL-1047-01
Chapter 28
Using the External Route Plan Wizard Entering Location Information
Entering Location Information

The Location Entry page provides information for the number of locations specified on the Tenant Information page. The following procedure describes how to add location information for the external route plan.
Procedure
Step 1
Enter the name of the location in the Location Name field if it is different from the one shown. Each location name must be unique for the tenant to which it applies. Enter the local area codes available at this location in the Local Area Code(s) field. (Local area codes are all area codes in the calling area that are not considered to be long distance calls.) If your area includes more than one local (toll free) area code, use commas to separate the area codes in the list. Place the primary local area code first, followed by the secondary, and tertiary local area codes.
Step 2
Note
The primary local area code is used to set prefix digits on local route patterns. If the primary area code is not listed in the correct order, it adversely affects route filter generation.
Step 3 Step 4
Enter the 7- or 10-digit number that is the main number for the organization at this location. Specify the number of digits required for local calls at this location. The route plan wizard uses this information to determine how many route lists to create for this location. If you select 10-digit or 7-digit dialing, the wizard creates one route list for this location. If you select Metro dialing, the wizard creates two route lists for the location.
Step 5
Repeat Steps 1 through 4 to add location information for other locations.
Related Topics

Creating an External Route Plan, page 28-2 Setting the Routing Options, page 28-2
OL-1047-01
28-5
Chapter 28 Selecting Gateways
Providing Tenant Information, page 28-4 Selecting Gateways, page 28-6 Providing Gateway Information, page 28-8 Generating the External Route Plan, page 28-9 Confirming the External Route Plan, page 28-10 Finishing the External Route Plan, page 28-11 Deleting an External Route Plan, page 28-11
Selecting Gateways
The following procedure describes how to select gateways for the external route plan.
Caution
Do not select gateways that are used by existing route groups or route patterns. The wizard uses all ports on the selected gateway. If you select a gateway that is used by existing route groups or route patterns, the external route plan wizard will overwrite the previously configured ports.
Procedure
Check the boxes for all the gateways associated with this route plan in all locations. Click Select All if you want to include all the gateways defined in the system. Click Select None if you have selected several gateways and want to deselect all of your selections.
Note
You must select at least one gateway before continuing with this procedure.
28-6
OL-1047-01
Chapter 28
Using the External Route Plan Wizard Selecting Gateways
Step 4
Click Next.
Related Topics

Creating an External Route Plan, page 28-2 Setting the Routing Options, page 28-2 Providing Tenant Information, page 28-4 Entering Location Information, page 28-5 Providing Gateway Information, page 28-8 Generating the External Route Plan, page 28-9 Finishing the External Route Plan, page 28-11 Deleting an External Route Plan, page 28-11
28-7
Chapter 28 Providing Gateway Information
Providing Gateway Information

The following procedure describes how to add gateway information for the gateways in the external route plan.
Procedure
Select the gateway location in the Location of the gateway drop-down list box. Select the type of connection for this gateway in the Type of carrier to which the gateway is connected drop-down list box. Specify the calling number that will be sent to the adjacent switch when a call is routed through this gateway. Check the Discard dialed access code... check box if this gateway is connected to a PBX that does not require the Cisco CallManager access code. Enter the range of directory numbers or extension numbers associated with the adjacent PBX. Use commas to separate multiple entries. Use X wildcard characters to specify ranges of digits. For example, if the PBX serves extensions numbered 8000 through 8999 and 9000 through 9999, enter 8XXX,9XXX to create route patterns for the identified directory number ranges.
Note
If you provide directory number ranges, the wizard generates one route list for each unique range (route pattern) you enter. If you provide an access code for the directory number ranges and do not check the Discard dialed access code... check box, the wizard generates one route list for each unique range (route pattern) you enter, and precedes each route list with the access code and a dot (.).
Step 6 Step 7
Click Next. Repeat Steps 1 through 6 to add gateway information for the additional gateways.
Related Topics

Creating an External Route Plan, page 28-2 Setting the Routing Options, page 28-2
28-8
OL-1047-01
Chapter 28
Using the External Route Plan Wizard Generating the External Route Plan
Providing Tenant Information, page 28-4 Entering Location Information, page 28-5 Selecting Gateways, page 28-6 Generating the External Route Plan, page 28-9 Confirming the External Route Plan, page 28-10 Finishing the External Route Plan, page 28-11 Deleting an External Route Plan, page 28-11
Generating the External Route Plan

Click Next to generate the external route plan.
Note
The wizard can take several minutes to generate the external route plan, depending on the complexity of the route plan and the system load. Please do not start additional processes that would further load the system during this time. Click Cancel to prevent the external route plan wizard from generating this route plan.
Note
If you click Cancel, all data associated with the current route plan is discarded. This action cannot be undone. The information must be re-entered.
Related Topics

Creating an External Route Plan, page 28-2 Setting the Routing Options, page 28-2 Providing Tenant Information, page 28-4 Entering Location Information, page 28-5 Selecting Gateways, page 28-6 Providing Gateway Information, page 28-8
28-9
Chapter 28 Confirming the External Route Plan
Confirming the External Route Plan, page 28-10 Finishing the External Route Plan, page 28-11 Deleting an External Route Plan, page 28-11
Confirming the External Route Plan

The following procedure describes how to confirm an external route plan.
Procedure
Step 1 Step 2
Check the external route plan wizard status report to ensure that the route plan contains the proper elements. Click Next to complete the external route plan.
Note
We strongly recommend that you print the status report for future reference.
If you determine that the external route plan is incorrect based on the information shown in the status report, proceed to the final page of the external route plan wizard. The final page allows you to delete the entire route plan, if needed.
Related Topics

Creating an External Route Plan, page 28-2 Setting the Routing Options, page 28-2 Providing Tenant Information, page 28-4 Entering Location Information, page 28-5 Selecting Gateways, page 28-6 Providing Gateway Information, page 28-8 Finishing the External Route Plan, page 28-11 Deleting an External Route Plan, page 28-11
28-10
OL-1047-01
Chapter 28
Using the External Route Plan Wizard Finishing the External Route Plan
Finishing the External Route Plan

Click Finish to complete the external route plan if the information shown on the external route plan wizard status report is correct. Click Delete External Route Plan to remove all data generated by the external route plan wizard if the information shown on the status report is incorrect.
Warning
Clicking Delete External Route Plan deletes all data that has been generated by the external route plan wizard. This action cannot be undone. All external route plan information must be re-entered. Related Topics

Creating an External Route Plan, page 28-2 Setting the Routing Options, page 28-2 Providing Tenant Information, page 28-4 Entering Location Information, page 28-5 Selecting Gateways, page 28-6 Providing Gateway Information, page 28-8 Confirming the External Route Plan, page 28-10 Deleting an External Route Plan, page 28-11
Deleting an External Route Plan

The following procedure describes how to delete an external route plan. If any element generated by the external route plan wizard is being used in the system (for example, if Cisco IP Phones belong to a generated partition), the delete function will fail. If generated elements are used, the system components that are using those elements must be moved to non-generated elements before using the delete function.
28-11
Chapter 28 Deleting an External Route Plan
Warning
This procedure deletes all data that has been generated by the external route plan wizard. This action cannot be undone. All external route plan information must be re-entered. Procedure
Open Cisco CallManager Administration. Select Route Plan > External Route Plan Wizard in the menu bar. Click Delete External Route Plan to remove all data generated by the external route plan wizard.
Related Topics

Creating an External Route Plan, page 28-2 Setting the Routing Options, page 28-2 Providing Tenant Information, page 28-4 Entering Location Information, page 28-5 Selecting Gateways, page 28-6 Providing Gateway Information, page 28-8 Generating the External Route Plan, page 28-9 Confirming the External Route Plan, page 28-10 Finishing the External Route Plan, page 28-11
28-12
OL-1047-01
C H A P T E R
29
Using Route Plan Report

The route plan report is a listing of all call park numbers, call pickup numbers, conference numbers, route patterns and translation patterns in the system. The route plan report allows you to view either a partial or full list, and to go directly to the associated configuration pages, by selecting a route pattern, partition, route group, route list, call park number, call pickup number, conference number, or gateway. In addition, the route plan report allows you to save report data into a .csv file that you can import into other applications. The .csv file contains more detailed information than the web pages, including directory numbers (DN) for phones, route patterns, and translation patterns. The Cisco CallManager uses the route plan to route both internal calls and external (Public Switched Telephone Network [PSTN]) calls. For more detailed information on the route plan, see the Understanding Route Plans section on page 6-1. Use the following procedures to view all route plan records:

Viewing All Route Plan Records, page 29-2 Viewing Route Plan Reports in a File, page 29-3
29-1
Chapter 29 Viewing All Route Plan Records
Viewing All Route Plan Records

This section describes how to view all Route Plan Records.
Procedure
Step 1 Step 2
Open Cisco CallManager Administration. Select Route Plan > Route Plan Report. If there are more than 50 items, the Route Plan Report screen shows the first 50.
Step 3
Click All to view the entire report (viewing this option can take a long time to load on large systems), or click Next 50 or Previous 50 to navigate through the report 50 items at a time.
Note
The route plan report shows the Pattern/Directory, the corresponding call type, and partition. The Route Detail column shows a route list (with route group and associated gateway, and ports used information), or gateway information.
Related Topics

Understanding Route Plans, page 6-1 Using Route Plan Report, page 29-1 Viewing Route Plan Reports in a File, page 29-3
29-2
OL-1047-01
Chapter 29
Using Route Plan Report Viewing Route Plan Reports in a File
Viewing Route Plan Reports in a File

This section contains information on how to view route plan reports in a .csv file.
Procedure
Step 1 Step 2
Open Cisco CallManager Administration. Select Route Plan > Route Plan Report. If there are more than 50 items, the Route Plan Report screen shows the first 50.
Step 3
Click View In File. A dialog box appears. From this dialog box, you can either save the file, or import it into another application.
Step 4
Click Save File in the dialog box. Another window appears allowing you to save this file to a location of your choice.
Note
You may also save the file as a different file name, but the extension the file name must have a .csv extension.
Step 5 Step 6
Select the location in which to save the file and click Save. The file should now be saved to the location you designated. Locate the .csv file you just saved and double-click on its icon to view it.
Related Topics

Understanding Route Plans, page 6-1 Using Route Plan Report, page 29-1 Viewing All Route Plan Records, page 29-2
29-3
Chapter 29 Viewing Route Plan Reports in a File
29-4
OL-1047-01
A R T
Service Configuration
The following chapters include information on configuring services used in conjunction with Cisco CallManager: Chapter 30, Cisco Messaging Interface Chapter 31, Configuring Cisco TFTP Chapter 32, Configuring Cisco WebAttendants Chapter 33, Configuring Conference Bridges Chapter 34, Configuring Media Termination Point Chapter 35, Configuring Service Parameters Chapter 36, Configuring Trace Chapter 37, Configuring Transcoder Chapter 38, Starting and Stopping Services Using the Control Center
C H A P T E R
30
Cisco Messaging Interface

The Cisco Messaging Interface allows you to use an external voice mail system with the Cisco CallManager 3.0. The voice mail system must meet the following requirements:

The voice mail system must have a simplified message desk interface (SMDI) accessible with a null-modem RS-232 cable (and an available serial port). The voice mail system must use analog ports for connecting voice lines. The Cisco CallManager server must have an available serial port for the SMDI connection. A Cisco Analog Access Station Gateway or Cisco VG200 Gateway must be installed and configured. Gateways are configured in a route pattern. See the Configuring Route Patterns section on page 26-1 for more information.
The SMDI-compliant voice mail system is connected to Cisco CallManager in two ways:

Using a standard serial connection to the Cisco CallManager Using POTS line connections to a Cisco Analog Station gateway
Note
CMI should only reside on a single Cisco CallManager within a cluster. You cannot have two CMI applications connected to the same voice mail system running at the same time.
30-1
Chapter 30 Most Commonly Changed CMI Service Parameters
Related Topics

Most Commonly Changed CMI Service Parameters, page 30-2 Adding Cisco Messaging Interface Service on the Cisco CallManager, page 30-5 Deleting Cisco Messaging Interface Service From a Server, page 30-6 Configuring Cisco Messaging Interface Service Parameters, page 30-8 Configuring Cisco Messaging Interface Trace Parameters, page 30-10
Most Commonly Changed CMI Service Parameters

Table 30-1 lists and describes CMI service parameter fields that are most commonly changed.
Caution
Do not add or delete service parameters unless directed by the Cisco Technical Assistance Center (TAC).
Table 30-1 Most Commonly Changed Service Parameter Fields
Parameter Fields BaudRate
Value/Description CMI connects to the voice mail system via an RS-232 connection. This parameter defines that connection. Default value: 9600
Note
Many voice mail systems can be configured to use different baud rates, but the one shown here will frequently be correct.
CallManagerName
This parameter specifies the name of the Cisco CallManager server that will be used for the CMI primary. You can use either the name of a Cisco CallManager or its IP address. You can also leave this field blank. If this field is not specified, the local machine is assumed to be the Cisco CallManager.
30-2
OL-1047-01
Chapter 30
Cisco Messaging Interface Most Commonly Changed CMI Service Parameters
Table 30-1 Most Commonly Changed Service Parameter Fields (continued)
Parameter Fields BackUpCallManager
Value/Description This parameter specifies the name of the Cisco CallManager that will be used for the CMI backup. You can use either the name of a Cisco CallManager or its IP address. CMI connects to the voice mail system via an RS-232 connection. This parameter defines one of the values used to configure that connection. Recommended default value: 7
DataBits
InputDNSignificantDigits This parameter is designed to accommodate the differences between voice mail mailbox numbers and directory numbers (DNs). If a legacy voice mail system has mailbox numbers that are longer than the DNs on the system, this parameter can be used to strip the most significant digits. The numeric value of this parameter indicates how many digits should be used.
Note
There is no provision for stripping digits other than leading ones.
Recommended default value: 10 Parity CMI connects to the voice mail system via an RS-232 connection. This parameter defines one of the values used to configure that connection. Default value: Even
Note
The parity settings can be None, Even, Odd, Mark, or Space. Settings are usually Even or None, with Mark and Space rarely being used. Just using the first character of the parity name also works. This field is case insensitive.
30-3
Chapter 30 Most Commonly Changed CMI Service Parameters
Table 30-1 Most Commonly Changed Service Parameter Fields (continued)
Parameter Fields SerialPort
Value/Description CMI connects to the voice mail system via an RS-232 connection. This parameter defines one of the values used to configure that connection. Default value: COM1
Note
The SerialPort name should be the same name that you see in Device Manager under NT.
MwiSearchSpace
The search space to use when determining the device to be affected by the MWI lamp. Type a colon-separated list of partition names for the value of this parameter. For example: dallas01:dallas02, where dallas01 and dallas02 are partition names.
StopBits
CMI connects to the voice mail system via an RS-232 connection. This parameter defines one of the values used to configure that connection. Recommended default value: 1 The voice mail access number, as defined in a route pattern. The partition in which the voice mail directory number resides
Related Topics

VoiceMailDN VoiceMailPartition
Configuring Service Parameters, page 35-1 Cisco Messaging Interface Service Parameters, page 10-22 Configuring Cisco Messaging Interface Service Parameters, page 30-8 Configuring Cisco Messaging Interface Trace Parameters, page 30-10
30-4
OL-1047-01
Chapter 30
Cisco Messaging Interface Adding Cisco Messaging Interface Service on the Cisco CallManager
Adding Cisco Messaging Interface Service on the Cisco CallManager

This section describes how to add Cisco Messaging Interface service on the Cisco CallManager.
Before You Begin
Be sure that the following requirements are met before proceeding with the any series of steps. Refer to the Server section on page 11-1 for more information.

Servers must be configured The Cisco CallManager must have Cisco Messaging Interface loaded whenever the Cisco CallManager is installed or upgraded.
Note
To configure the Cisco CallManager, you must know the voice mail access number and partition, and what the extension and mailbox length are on the voice mail. To enable the MWI button on your phone for it to access the voice mailbox, go to Service > Service Parameters and select the appropriate server. Next, click Cisco CallManager in the Configured Services list, and select VoiceMail. The Value field should be the voice mail access number. The Cisco CallManager service parameters MessageWaitingOffDN and MessageWaitingOnDN parameters do not apply to configuring Cisco Messaging Interface.
Procedure
Open Cisco CallManager Administration. Click Service > Cisco Messaging Interface. Select the new server on which you want to add the Cisco Messaging Interface from the drop-down list box. The page refreshes, displaying the server you selected.
30-5
Chapter 30 Deleting Cisco Messaging Interface Service From a Server
Note
The servers listed on the left side of the page are already configured with Cisco Messaging Interface service.
Step 4
Click Insert. The page refreshes again, and the server is now configured with Cisco Messaging Interface service.
Related Topics

Deleting Cisco Messaging Interface Service From a Server, page 30-6 Configuring Cisco Messaging Interface Service Parameters, page 30-8 Configuring Cisco Messaging Interface Trace Parameters, page 30-10
Deleting Cisco Messaging Interface Service From a Server

This section describes how to delete Cisco Messaging Interface service from a server.
Before You Begin
Be sure that the following requirements are met before proceeding with the any series of steps. Refer to the Server section on page 11-1for more information.

Servers must be configured. The Cisco CallManager must have Cisco Messaging Interface loaded whenever the Cisco CallManager is installed or upgraded.
Procedure
Step 1 Step 2
Open Cisco CallManager Administration. Click Service > Cisco Messaging Interface.
30-6
OL-1047-01
Chapter 30
Cisco Messaging Interface Deleting Cisco Messaging Interface Service From a Server
Step 3
Select the server from which you want to delete the Cisco Messaging Interface service from the list on the left side of the page. The page refreshes displaying the server you selected.
Note
Step 4 Step 5
Click Delete Service. A message displays stating that you are about to permanently delete service from this server. Click OK to continue, or Cancel to cancel the deletion. If you chose Delete Service, the server should no longer appear in the list on the left side of the page.
Related Topics

Adding Cisco Messaging Interface Service on the Cisco CallManager, page 30-5 Configuring Cisco Messaging Interface Service Parameters, page 30-8 Most Commonly Changed CMI Service Parameters, page 30-2 Configuring Cisco Messaging Interface Trace Parameters, page 30-10
30-7
Chapter 30 Configuring Cisco Messaging Interface Service Parameters
Configuring Cisco Messaging Interface Service Parameters

This section describes how to configure Cisco Messaging Interface service parameters.
Caution
Do not add or delete service parameters unless directed by the Cisco Technical Assistance Center (TAC).
Before You Begin
Be sure that the following requirements are met before proceeding with any series of steps. Refer to the Server section on page 11-1.

Servers must be configured. The Cisco CallManager must have Cisco Messaging Interface loaded whenever the Cisco CallManager is installed or upgraded. Read the Understanding Service Parameters section on page 10-1 for more information on service parameters.
Caution
Cisco Messaging Interface can take up to five minutes to detect and load new parameters. Use the operating system service manager or task manager to restart Cisco Messaging Interface if you need an instant update.
Procedure
Open Cisco CallManager Administration. Click Service > Cisco Messaging Interface. Select the server on which you want to configure Cisco Messaging Interface service parameters from the list of servers on the left side of the page. The page refreshes, displaying the server you selected.
30-8
OL-1047-01
Chapter 30
Cisco Messaging Interface Configuring Cisco Messaging Interface Service Parameters
Note
Step 4
Click Command Line Parameters if it is not already selected.
Caution
Some changes to service parameters may cause system failure. We recommend you do not make any changes to service parameters unless you fully understand the feature that you are changing, or unless the changes are specified by the Cisco Technical Assistance Center (TAC). Refer to the Understanding Service Parameters section on page 10-1 for more information. Do not add or delete services parameters unless directed by the Cisco TAC.
Step 5
To make changes to an existing service parameter, highlight the parameter in the Configured Service Parameters list, make changes using the Type and Value fields, then click Update. Repeat Steps 2 through 5 for each service parameter you want to configure.
Step 6
Note
To restore Cisco CallManager default service parameter settings, click Default. A message displays stating that you are about to permanently delete any previous settings and replace them with the default settings. Click OK to continue, or Cancel to keep the current settings.
Related Topics

Most Commonly Changed CMI Service Parameters, page 30-2 Configuring Service Parameters, page 35-1 Cisco Messaging Interface Service Parameters, page 10-22 Configuring Cisco Messaging Interface Trace Parameters, page 30-10
30-9
Chapter 30 Configuring Cisco Messaging Interface Trace Parameters
Configuring Cisco Messaging Interface Trace Parameters

This section describes how to configure Cisco Messaging Interface trace parameters.
Caution
Do not add or delete trace parameters unless directed by the Cisco Technical Assistance Center (TAC).
Before You Begin
The following prerequisites must be met before proceeding with the steps. Refer to the Server section on page 11-1.

Servers must be configured The Cisco CallManager must have Cisco Messaging Interface loaded whenever the Cisco CallManager is installed or upgraded. Refer to the Configuring Trace section on page 36-1 to configure trace parameters for this service. This section provides detailed descriptions of trace levels and settings.
Note
If Trace is enabled, the Cisco Messaging Interface creates a trace file and logs its actions. This trace file can be helpful when debugging Cisco Messaging Interface operations, and it should be enabled whenever Cisco Messaging Interface operations are in question.
Procedure
Step 1 Step 2
Open Cisco CallManager Administration. Click Service > Cisco Messaging Interface.
30-10
OL-1047-01
Chapter 30
Cisco Messaging Interface Configuring Cisco Messaging Interface Trace Parameters
Step 3
Select the server on which you want to configure trace parameters, from the list of servers on the left side of the page. The page refreshes.
Note
Click Trace. Click Trace On to enable trace. If Trace On is not selected, it is disabled and you will not be able to modify any trace properties. For CMI, leave all User Mask boxes enabled. The user mask automatically appears in the Mask field. Click Show Time if you want a time associated with the mask. Select the level of trace you want from the Level drop-down menu. Click Show Date if you want a date associated with the trace level. Select the type of trace event alarms you want from the Event drop-down menu.
Step 7 Step 8
Note
The level of trace event you want is determined by what you select from the drop-down menu. For Cisco Messaging Interface, set the trace level to either ERROR or DETAILED.
Step 9 Step 10
Check the box for each trace component you want enabled. When you have completed your trace parameter selections, click Update.
Note
If youd rather use the Cisco CallManager default settings, click SetDefault.
Related Topics
Configuring Trace, page 36-1
30-11
Chapter 30 Configuring Cisco Messaging Interface Trace Parameters
30-12
OL-1047-01
C H A P T E R
31
Configuring Cisco TFTP

Cisco Trivial File Transfer Protocol (TFTP) is a Windows NT service that builds and serves files consistent with the TFTP protocol. TFTP is a simplified version of the FTP protocol. Cisco TFTP serves embedded component executable, runner files, and configuration (.cnf) files. A configuration file is a list of Cisco CallManagers to which devices (telephones and gateways) make connections. When a device boots, the component queries a Dynamic Host Configuration Protocol (DHCP) server for its network configuration information. The DHCP server responds with an IP address for the device, a subnet mask, a default gateway, a Domain Name System (DNS) server address, and a TFTP server name or address. The device requests a .cnf file from the TFTP server. The .cnf file contains a list of Cisco CallManagers and the TCP port through which the device connects to those Cisco CallManagers. If the Cisco CallManagers name is received, the device resolves the name using DNS and a Cisco CallManager connection is opened. If neither an IP address or name is received, the default server name is used. For more detailed TFTP information, refer to the following sections:

Understanding DHCP and TFTP, page 7-2 Understanding How Devices Identify the TFTP Server, page 7-4
31-1
Chapter 31 Inserting Cisco TFTP Service on a Server
Use the following procedures to insert and delete TFTP service from a server, configure and delete Command Line Parameters, and to configure and delete TFTP Trace Parameters:

Inserting Cisco TFTP Service on a Server, page 31-2 Deleting Cisco TFTP Service From a Server, page 31-4 Configuring Cisco TFTP Command Line Parameters, page 31-5 Deleting Cisco TFTP Command Line Parameters, page 31-7 Configuring Cisco TFTP Trace Parameters, page 31-9
Note
Under normal circumstances, default values are preferable.
Inserting Cisco TFTP Service on a Server

This section describes how to insert Cisco TFTP service on a server.
Note
Service(s) are automatically inserted during the installation process.
Before You Begin
The following prerequisite must be met before proceeding with the steps. See the Server section on page 11-1.
Servers must be configured
Procedure
Open Cisco CallManager Administration. Click Service > Cisco TFTP. Select a server on which to insert Cisco TFTP service from the drop-down list box and click Insert. (Servers listed on the left side of the page have already been configured with TFTP service.) The page refreshes, showing the server you selected.
31-2
OL-1047-01
Chapter 31
Configuring Cisco TFTP Inserting Cisco TFTP Service on a Server
Step 4
Select either Command Line Parameters or Trace, then click Insert. You are now ready to configure either Command Line Parameters or Trace.
Tips
Click New if you want to insert Cisco TFTP on another server. This takes you back to the first Cisco TFTP Configuration page.
Note
You only need to configure Cisco TFTP service on one server in a network, unless you want to share TFTP load.
Related Topics

Configuring Cisco TFTP, page 31-1 Understanding DHCP and TFTP, page 7-2 Understanding How Devices Identify the TFTP Server, page 7-4 Configuring Cisco CallManager Groups, page 13-1 Deleting Cisco TFTP Service From a Server, page 31-4 Configuring Cisco TFTP Command Line Parameters, page 31-5 Deleting Cisco TFTP Command Line Parameters, page 31-7 Configuring Cisco TFTP Trace Parameters, page 31-9 Adding a Cisco CallManager Group, page 13-2
31-3
Chapter 31 Deleting Cisco TFTP Service From a Server
Deleting Cisco TFTP Service From a Server

This section describes how to delete Cisco TFTP service from a server.
Before You Begin

Servers must be configured Cisco TFTP service must be configured
Procedure
Open Cisco CallManager Administration. Click Service > Cisco TFTP. Select the server from which you want to delete Cisco TFTP service from the list of servers on the left side of the page. (Servers listed on the left side of the page have already been configured with Cisco TFTP service.) The page refreshes showing the information for the server you selected. Click Delete Service. A message displays stating that you are about to permanently delete this service, and that the action can not be undone. If you wish to continue this deletion, Click OK, otherwise click Cancel.
Step 4 Step 5
Related Topics

Configuring Cisco TFTP, page 31-1 Understanding DHCP and TFTP, page 7-2 Understanding How Devices Identify the TFTP Server, page 7-4 Configuring Cisco CallManager Groups, page 13-1 Inserting Cisco TFTP Service on a Server, page 31-2 Configuring Cisco TFTP Command Line Parameters, page 31-5 Deleting Cisco TFTP Command Line Parameters, page 31-7
31-4
OL-1047-01
Chapter 31
Configuring Cisco TFTP Configuring Cisco TFTP Command Line Parameters
Configuring Cisco TFTP Trace Parameters, page 31-9 Adding a Cisco CallManager Group, page 13-2
Configuring Cisco TFTP Command Line Parameters

This section describes how to configure Cisco TFTP command line parameters.
Before You Begin

Servers must be configured Cisco TFTP service must be configured Before configuring any Cisco TFTP service parameters, read the Understanding Service Parameters section on page 10-1. Refer to the Cisco TFTP Service Parameters section on page 10-20 for service parameters specific to Cisco TFTP.
Procedure
Open Cisco CallManager Administration. Click Service > Cisco TFTP. Select the server on which you want to configure command line parameters from either the drop-down list box, or the list of servers on the left side of the page.
Note
The list of servers on the left side of the page are already configured with TFTP service. If you choose a server from the drop-down list box, you must first add Cisco TFTP service to the server before configuring any command line parameters.
The page refreshes.

Step 4
Click Command Line Parameters if it is not already selected.
31-5
Chapter 31 Configuring Cisco TFTP Command Line Parameters
Caution
Some changes to service parameters may cause system failure. We recommend you do not make any changes to service parameters unless you fully understand the feature that you are changing, or unless the changes are specified by the Cisco Technical Assistance Center (TAC). Refer to the Understanding Service Parameters section on page 10-1 for more information. You will probably never need to add parameters unless directed by the Cisco TAC. Enter the name of the parameter you want to configure on this server in the Param field. Enter the type of the parameter in the Type field, or choose a type from the drop-down list box.
Step 5 Step 6
Note
The drop-down list box contains parameter types that have already been configured.
Enter a value for the parameter in the Value field. Click Update. The page refreshes and your new service parameter appears in the Configured Service Parameters list at the bottom of the page. Repeat Steps 1 through 8 to add additional service parameters.
Note
If you would rather use the Cisco CallManager default service parameters, click Default. A message displays stating that you are about to permanently delete any previous settings and replace them with the default settings. Click OK if you wish to continue, or Cancel to keep the current settings.
Related Topics

Configuring Cisco TFTP, page 31-1 Understanding DHCP and TFTP, page 7-2 Understanding How Devices Identify the TFTP Server, page 7-4
31-6
OL-1047-01
Chapter 31
Configuring Cisco TFTP Deleting Cisco TFTP Command Line Parameters
Configuring Cisco CallManager Groups, page 13-1 Inserting Cisco TFTP Service on a Server, page 31-2 Deleting Cisco TFTP Service From a Server, page 31-4 Deleting Cisco TFTP Command Line Parameters, page 31-7 Configuring Cisco TFTP Trace Parameters, page 31-9 Adding a Cisco CallManager Group, page 13-2
Deleting Cisco TFTP Command Line Parameters

This section describes how to delete Cisco TFTP command line parameters.
Before You Begin

Servers must be configured Cisco TFTP service must be configured Command line parameters must be configured Before deleting any Cisco TFTP service parameters, read the Understanding Service Parameters section on page 10-1. Refer to the Cisco TFTP Service Parameters section on page 10-20 for service parameters specific to Cisco TFTP.
Caution
You will never need to delete parameters unless directed by the Cisco Technical Assistance Center (TAC).
Procedure
Open Cisco CallManager Administration. Click Service > Cisco TFTP. Select the server from which you want to delete command line parameters from the list of servers on the left side of the page.
31-7
Chapter 31 Deleting Cisco TFTP Command Line Parameters
Click Insert. The page refreshes. Click Command Line Parameters if it is not already selected. Highlight the service parameter you want to delete from the list of configured service parameters at the bottom of the page. Click Delete. A message displays stating that you are about to permanently delete this parameter, and that this action cannot be undone. Click OK if you wish to delete the parameter, or Cancel to cancel the deletion. The parameter you deleted should no longer appear in the list of configured service parameters.
Related Topics

Configuring Cisco TFTP, page 31-1 Understanding DHCP and TFTP, page 7-2 Understanding How Devices Identify the TFTP Server, page 7-4 Inserting Cisco TFTP Service on a Server, page 31-2 Deleting Cisco TFTP Service From a Server, page 31-4 Configuring Cisco TFTP Command Line Parameters, page 31-5 Configuring Cisco TFTP Trace Parameters, page 31-9 Adding a Cisco CallManager Group, page 13-2
31-8
OL-1047-01
Chapter 31
Configuring Cisco TFTP Configuring Cisco TFTP Trace Parameters
Configuring Cisco TFTP Trace Parameters

This section describes how to configure Cisco TFTP trace parameters. For more detailed trace information refer to the Configuring Trace section on page 36-1.
Before You Begin

Servers must be configured Cisco TFTP service must be configured Read the Configuring Trace section on page 36-1 before configuring trace parameters. This section provides detailed descriptions of trace levels and settings.
Caution
We recommend that you configure all trace parameters from the Trace configuration pages. You can access Trace via the Service menu in the Cisco CallManager Administration application. If you want to delete the trace, you can either click the Delete button, or deselect Trace On. However, Cisco does not recommend deleting any parameters without the assistance of the Cisco Technical Assistance Center (TAC).
Procedure
Open Cisco CallManager Administration. Click Service > Cisco TFTP. Select the server on which you want to configure trace parameters from either the drop-down list box, or the list of servers on the left side of the page. The page refreshes. Click Trace. Select Trace On to enable trace. If Trace On is not selected, it is disabled and you will not be able to modify any trace properties.
Step 4 Step 5
31-9
Chapter 31 Configuring Cisco TFTP Trace Parameters
Step 6
Check each User Mask check box you want enabled. The user mask automatically appears in the Mask field. Click the Show Time check box if you want a time associated with the trace. Select the level of trace you want from the Level drop-down list box. Click the Show Date check box if you want a date associated with the trace level. Select the type of trace event alarms you want from the Event drop-down list box.
Step 7 Step 8
Note
The level of trace event you want is determined by what you select from the drop-down list box. For instance, DEBUG is used for lab purposes and traces every event on the system, while CRITICAL only traces critical alarms.
Step 9 Step 10
Check the box of each trace component you want enabled. When you have completed your trace parameter selections, click Update.
Note
If youd rather use the default settings, click SetDefault.
Related Topics

Configuring Cisco TFTP, page 31-1 Understanding DHCP and TFTP, page 7-2 Understanding How Devices Identify the TFTP Server, page 7-4 Inserting Cisco TFTP Service on a Server, page 31-2 Deleting Cisco TFTP Service From a Server, page 31-4 Configuring Cisco TFTP Command Line Parameters, page 31-5 Deleting Cisco TFTP Command Line Parameters, page 31-7 Adding a Cisco CallManager Group, page 13-2
31-10
OL-1047-01
C H A P T E R
32
Configuring Cisco WebAttendants

Cisco WebAttendant, a client-server application, enables you to set up Cisco IP Phones as attendant consoles. The Cisco WebAttendant client provides a graphical user interface for controlling a Cisco IP Phone for use as an attendant console and includes speed dial buttons and quick directory access for looking up phone numbers, monitoring phone status, and directing calls. A receptionist or administrative assistant can use the Cisco WebAttendant client to handle calls, or an individual can use it with a Cisco IP Phone. This section describes the following configuration procedures for Cisco WebAttendants:

Configuring Pilot Points, page 32-2 Configuring Hunt Groups, page 32-5 Installing the Cisco WebAttendant Client, page 32-13 Configuring Cisco WebAttendant Client Settings, page 32-14 Setting Up the wauser Shared Directory for Cisco WebAttendant, page 32-19 Starting the Telephony Call Dispatcher, page 32-20
Related Topics
Understanding Cisco WebAttendant, page 8-1
32-1
Chapter 32 Configuring Pilot Points
Configuring Pilot Points

Ensure pilot points and hunt groups are configured before the Cisco Telephony Call Dispatcher can route calls to Cisco WebAttendant A Cisco WebAttendant pilot point serves as a virtual directory number that receives and redirects calls to the members of its associated hunt group. The order in which the members of the hunt group are listed determines the call redirection order. The first available (not busy) member in a hunt group receives the call.
Related Topics

Adding a Pilot Point, page 32-2 Viewing, Updating, or Deleting a Pilot Point, page 32-4 Configuring Cisco WebAttendants, page 32-1 Understanding Pilot Points and Hunt Groups, page 8-6
Adding a Pilot Point

Procedure
Perform the following steps to add a new pilot point.

Open Cisco CallManager Administration. Choose Service > Cisco WebAttendant. Enter the appropriate settings as described in Table 32-1. Click Insert. Now that the pilot point is created, the Pilot Point Configuration page refreshes to display the name of the new pilot point in the list on the left. The new pilot point and its settings display. Once the pilot point is created, you must configure a hunt group to specify how the calls that come in to the pilot point are redirected.
32-2
OL-1047-01
Chapter 32
Configuring Cisco WebAttendants Configuring Pilot Points
Table 32-1 Pilot Point Configuration Settings
Field
Device Information
Description
Usage Notes
Pilot Name Primary Cisco CallManager
Specifies descriptive name for the Enter up to 50 characters. pilot point. Specifies name or IP address of the Cisco CallManager whose Telephony Call Dispatcher (TCD) service will be used to service this pilot point. Take call processing and device load balancing into account when selecting the Primary Cisco CallManager.
Partition Calling Search Space
Choose None from the drop-down Cisco WebAttendant pilot points list box. do not use partitions. The calling search space determines which partitions the pilot point searches when attempting to route a call. Choose a calling search space from the drop-down list. Ensure directory-based hunt group members associated with a Cisco WebAttendant pilot point are in a partition that is visible to the calling search space for the pilot point number. Ensure this number is unique throughout the system (that is, it cannot be a shared line appearance).
Pilot Number (DirN)
Designates directory number for this pilot point.
Related Topics

Viewing, Updating, or Deleting a Pilot Point, page 32-4 Configuring Hunt Groups, page 32-5 Understanding Pilot Points and Hunt Groups, page 8-6
32-3
Chapter 32 Configuring Pilot Points
Viewing, Updating, or Deleting a Pilot Point

Perform the following steps to view, update, or delete pilot points.
Note
You do not have to restart TCD or Cisco CallManager after deleting a pilot point for the deletion to take effect.
Procedure
Step 1 Step 2
Open Cisco CallManager Administration. Choose Service > Cisco WebAttendant. The Pilot Point Configuration page displays, and the list on the left side of the page shows all currently configured pilot points.
Click the name of the pilot point you wish to modify or delete. The page refreshes to display information for the selected pilot point. Make the desired changes. Refer to Table 32-1 for a description of pilot point configuration settings. Click Update to modify the pilot point or click Delete to remove the pilot point. After you delete a pilot point, TCD will stop directing calls to any hunt group members associated with that pilot point within approximately 10 minutes.
Related Topics

Adding a Pilot Point, page 32-2 Configuring Hunt Groups, page 32-5 Understanding Pilot Points and Hunt Groups, page 8-6
32-4
OL-1047-01
Chapter 32
Configuring Cisco WebAttendants Configuring Hunt Groups
Configuring Hunt Groups

Once you have created a pilot point, you must configure a hunt group to specify how the calls that come in to the pilot point number are redirected. A hunt group provides a list of destinations (either directory numbers or Cisco WebAttendant user /line number references) that are used to determine the call redirection order for calls received by the pilot point. The first available (not busy) member of the hunt group receives the call. This section covers the following procedures:

Adding Hunt Group Members, page 32-5 Viewing, Updating, or Deleting Hunt Group Members, page 32-9 Understanding Pilot Points and Hunt Groups, page 8-6
Adding Hunt Group Members

Procedure
Perform the following steps to add a list of hunt group members to a new pilot point:
Open Cisco CallManager Administration. Choose Service > Cisco WebAttendant. The Pilot Point Configuration page displays. Choose the pilot point for which you want to add hunt group members. A list of available pilot points appears on the left side of the Pilot Point Configuration page. Click the link to Hunt Group Configuration in the upper right corner of the Pilot Point Configuration page to add hunt group members to this pilot point. Click New. The Pilot Hunt Group Members list initially displays the text <<not configured>>.
Step 4 Step 5
32-5
Chapter 32 Configuring Hunt Groups
Step 6
Decide whether the hunt group member you want to add will be a directory number (device member) or a user and line number (user member).

If you specify a directory number, TCD always attempts to route the call to that number. If you specify a Cisco WebAttendant user and line number, TCD first checks whether the Cisco WebAttendant user is logged in to a Cisco WebAttendant client and online before attempting to route the call. The advantage to specifying a user and line number is that the user can be logged in to any Cisco IP Phone controlled by Cisco WebAttendant software in the cluster and still receive calls.
Step 7
Enter the appropriate configuration settings for the new hunt group member as described in Table 32-2.
If the hunt group member is a directory number, fill in only the Partition and Directory Number fields in the Device Member Information section. You cannot specify a user name or a line number if the hunt group member is a directory number. The optional Always Route Member check box also applies only to directory numbers. If the hunt group member is a user and line number, fill in only the Cisco WebAttendant User Name and Line Number fields in the User Member Information section. You cannot specify a partition or a directory number if the hunt group member is a Cisco WebAttendant user.
Note
The User Name you specify is a Cisco WebAttendant User ID. Refer to Adding a Cisco WebAttendant User section on page 32-10 for more information. It is not the same as a User ID that is added through the Cisco CallManager User area of Cisco CallManager Administration.
As you make selections, the Hunt Group Member list box reflects the information you choose. The Hunt Group Member list displays either the device directory number or the Cisco WebAttendant user name and line number; for example: #1 Call directory number 35201 (directory number example) #2 Direct Call to Mary Brown, Line 1 (user and line number example)
32-6
OL-1047-01
Chapter 32
Table 32-2 Hunt Group Configuration Settings
Field Partition
Description Designates route partition to which this directory number belongs.
Usage Notes You can only choose a partition for a directory-number-based hunt group member. You cannot choose a partition for a user and line number-based hunt group member.
Device Member Information (These fields only apply to directory number-based hunt group members)
If the directory number for this hunt group member is in a partition, you must choose a partition.
If the directory number is not in a Note partition, choose None.
Ensure directory number-based hunt group members are in a partition that can be seen from the calling search space of the associated pilot point.
Directory Number
Designates directory number of the hunt group member device.
If a partition is specified, and the directory number is not in that partition, an error dialog box displays. You cannot enter a user name or line number if a directory number is specified in this field.
Always Route Member
If this box is checked (enabled), Telephony Call Dispatcher (TCD) always routes the call to this hunt group member, whether it is busy or not. The TCD does not check whether the line is available before routing the call.
You can enable this option for devices that can handle multiple, simultaneous calls, such as voicemail devices. Specify Always Route Member only for directory-number-based hunt group members.
32-7
Chapter 32 Configuring Hunt Groups
Table 32-2 Hunt Group Configuration Settings (continued)
Field User Name
Description
Usage Notes
User Member Information (these fields apply only to user and line number hunt group members)
Designates name of the Choose a user name from the Cisco WebAttendant user to choose as drop-down list. Only user names that a hunt group member. were added using Cisco WebAttendant User Configuration appear in this list. Provides drop-down list of line numbers to choose. When you define a user and line number pair as a hunt group member, the Telephony Call Dispatcher first checks whether that user is logged in to Cisco WebAttendant and online. If the user is not online, TCD automatically goes to the next member of the hunt group.
Line Number
Step 8
Repeat Steps 6 through 8 to add more hunt group members to this pilot point. You can change the order of the members in the hunt group by selecting the member you want to reorder from the list and using the up and down arrows to move that member to a new position in the list.
Note
Be sure to consider overflow conditions when assigning hunt group members. For example, you can handle overflow conditions by having one or more hunt groups that route calls to multiple Cisco WebAttendants with the final directory number being voicemail. If TCD can see the line state of a voicemail number, enable the Always Route Calls option for that number. Otherwise, the voicemail number will not receive more than one call at a time.
32-8
OL-1047-01
Chapter 32
Step 9
Click Update to save the hunt group member information. The hunt group members are added to the pilot point.
Related Topics

Viewing, Updating, or Deleting Hunt Group Members, page 32-9 Understanding Pilot Points and Hunt Groups, page 8-6
Viewing, Updating, or Deleting Hunt Group Members

Perform the following procedure to view, update, or delete members of a hunt group.
Procedure
Step 1 Step 2
Open Cisco CallManager Administration. Choose Service > Cisco WebAttendant. The Pilot Point Configuration page displays.
Step 3
Click the Hunt Group Configuration link at the top of the page. The Hunt Group Configuration group page displays, and the list on the left side of the page displays all currently configured pilot points.
Step 4
Click the name of the pilot point associated with the hunt group for which you want to view, modify, or delete members. The Hunt Group Configuration page updates to display information for the chosen pilot point.
Step 5
Make any desired changes. Refer to Table 32-2 for a description of hunt group configuration settings.

To update settings for a hunt group member, select that members name in the list; modify the settings as needed; then, click Update to save the changes. To change the order of the hunt group members, select the name of the member you wish to move and use the arrow buttons to move it to a new position in the list.
32-9
Chapter 32 Configuring Cisco WebAttendant Users
Step 6
To delete a hunt group member, highlight that members name in the list and click Delete. You can press Cancel at any time to restore any settings you changed before clicking Update.
Click Update to save the changes before leaving the Hunt Group Member Configuration screen.
Related Topics

Adding Hunt Group Members, page 32-5 Understanding Pilot Points and Hunt Groups, page 8-6
Configuring Cisco WebAttendant Users

This section covers the following procedures:

Adding a Cisco WebAttendant User, page 32-10 Viewing, Updating, and Deleting Cisco WebAttendant Users, page 32-11
Adding a Cisco WebAttendant User

Users cannot log in to a Cisco WebAttendant client before they are added in Cisco WebAttendant User Configuration.
Note
Cisco WebAttendant user IDs and passwords are not the same as Directory users and passwords entered in the User area of Cisco CallManager. The Cisco WebAttendant user and password database is completely separate from the Cisco CallManager Directory user database.
32-10
OL-1047-01
Chapter 32
Configuring Cisco WebAttendants Configuring Cisco WebAttendant Users
Procedure
Perform the following procedure to add a Cisco WebAttendant user.

Open Cisco CallManager Administration. Choose Service > Cisco WebAttendant. Click the Cisco WebAttendant User Configuration link in the upper right corner of the page. Enter the appropriate configuration settings as described in Table 32-3.
Table 32-3 Cisco WebAttendant User Configuration Settings
Field User ID Password Confirm Station Type
Action/Description Enter the login name for the new Cisco WebAttendant user. Enter up to 50 alphanumeric characters. Enter a password of up to 50 alphanumeric characters. Re-enter the same password. Not used. If specified, Cisco WebAttendant ignores this setting.
Step 5 Step 6
Click Insert to add the new user. The Cisco WebAttendant User Configuration page refreshes, and the new User ID displays in the list on the left side of the page. Repeat Steps 4 and 5 to add additional users.
Related Topics

Viewing, Updating, and Deleting Cisco WebAttendant Users, page 32-11 Understanding Cisco WebAttendant, page 8-1
32-11
Chapter 32 Configuring Cisco WebAttendant Users
Viewing, Updating, and Deleting Cisco WebAttendant Users

Perform the following procedure to view, update, or delete Cisco WebAttendant users.
Procedure
Open Cisco CallManager Administration. Choose Service > Cisco WebAttendant. Click the Cisco WebAttendant User Configuration link in the upper, right corner of the page. The Cisco WebAttendant User Configuration page displays with a list of current users on the left side of the page.
Click the name of the user you wish to modify or delete. Make the desired changes. Refer to Table 32-3 for a description of Cisco WebAttendant user configuration settings. Click Update to save the changes, click Delete to remove the user, or click Cancel to exit the screen without making any changes.
Related Topics

Adding a Cisco WebAttendant User, page 32-10 Understanding Cisco WebAttendant, page 8-1
32-12
OL-1047-01
Chapter 32
Configuring Cisco WebAttendants Installing the Cisco WebAttendant Client
Installing the Cisco WebAttendant Client

Perform the following steps to install the Cisco WebAttendant Client on a users PC.
Procedure
Step 1
Ensure you have added the Cisco WebAttendant user and the phone you wish to associate with Cisco WebAttendant to the Cisco CallManager database (refer to the Adding a Cisco WebAttendant User section on page 32-10). Write down the MAC address of the phone that is to be associated with the Cisco WebAttendant client you are installing. The MAC address comprises a 12-character, hexadecimal number located on a label on the underside of the Cisco IP Phone. Log in to the PC on which you want to install the Cisco WebAttendant client. Open Internet Explorer (version 4.0 or greater), browse to Cisco CallManager Administration, and log in to Cisco CallManager Administration. Choose Application > Install Plugins. Click the icon for the Cisco WebAttendant client. The Cisco WebAttendant installation wizard runs.
Step 2
Click Next at the initial screen; then, click Yes to accept the License Agreement. Click Next to install the Cisco WebAttendant client to the default location or use the Browse button to specify a new location and then click Next. Choose a Program Folder and click Next. Enter the following information on the Customer Information screen:

Login ID Enter the Cisco WebAttendant user ID for the attendant. Password Enter the Cisco WebAttendant password for user ID just specified.
Step 11
Click Next.
32-13
Chapter 32 Configuring Cisco WebAttendant Client Settings
Step 12
Enter the following information:
IP Address Enter IP address or host name of the primary Cisco CallManager for TCD (usually the Cisco CallManager with which the Cisco WebAttendant phone is registered). MAC ID Enter MAC address of the Cisco IP Phone that will be used with Cisco WebAttendant (see Step 2 for a description of the MAC address). You must use uppercase letters when entering the MAC address.
Click Next. After the installation program finishes installing files, choose whether you want to restart the computer now or later; then, click Finish. Restart the computer. Once the application is installed, you can configure or update any client settings that you did not configure during the installation process. Refer to Configuring Cisco WebAttendant Client Settings section on page 32-14 for more information.
Related Topics

Configuring Cisco WebAttendant Client Settings, page 32-14 Adding a Cisco WebAttendant User, page 32-10 Understanding Cisco WebAttendant, page 8-1
Configuring Cisco WebAttendant Client Settings

After the Cisco WebAttendant client is installed, you must configure it before a user can log into Cisco WebAttendant. Use the procedure in this section to configure settings that were not specified during installation, to view current settings, or to update the client configuration. Once it is configured, the Cisco WebAttendant client operates with the specified settings until they are changed.
32-14
OL-1047-01
Chapter 32
Configuring Cisco WebAttendants Configuring Cisco WebAttendant Client Settings
Procedure
Step 1
On the PC where the Cisco WebAttendant is installed, choose Start > Programs > Cisco CallManager > Cisco WebAttendant; then, click Yes to allow the ActiveX controls to launch Cisco WebAttendant. Click Settings. Enter the appropriate configuration settings, as described in Table 32-4. Click OK. The settings for Cisco WebAttendant client have been configured and can now be used for call distribution activities.
Note
If the Cisco WebAttendant client does not display directory information, check whether the wauser shared directory is configured correctly and that the Cisco WebAttendant user and client PC have read/write access to the wauser shared directory. See the Setting Up the wauser Shared Directory for Cisco WebAttendant section on page 32-19 for instructions.
Related Topics

Installing the Cisco WebAttendant Client, page 32-13 Understanding Cisco WebAttendant, page 8-1 Setting Up the wauser Shared Directory for Cisco WebAttendant, page 32-19
32-15
Table 32-4 Cisco WebAttendant User Configuration Settings
Field MAC Address
Action Enter SEP plus the media access control (MAC) address for the Cisco IP Phone you want to use in conjunction with Cisco WebAttendant. The MAC address comprises a 12-character number on a label on the underside of the Cisco IP Phone. You must enter SEP, then the MAC address, eliminating any dashes. You must use uppercase letters; for example, SEP0010EB001234.
Cisco TCD Database Leave this setting blank if you want to use the default Path database from the TCD associated with this Cisco IP Phone. This is the recommended default setting. Refer to the Setting Up the wauser Shared Directory for Cisco WebAttendant section on page 32-19 for additional steps required to ensure that this setting works correctly. As an alternative to using the default setting (leaving the field blank), copy the file on the Cisco CallManager server named C:\Program Files\Cisco\Users\UsersDB1.mdb or C:\Program Files\Cisco\UsersDB2.mdb to a different location (such as a file in a different shared directory on the network or a file on the Cisco WebAttendant users PC) and enter the path to the file in this field. If you choose to do this, any database changes made through Cisco CallManager are not automatically made available to the Cisco WebAttendant client. You must manually copy a new version of the database file to the new location when you need to update Cisco WebAttendant clients with database changes. Also, if you manually specify a TCD Database Path in the Settings dialog for the client, the client uses that path until you change it. If you change the TCD Database Path setting for a Cisco WebAttendant client, you must restart the client for the change to take effect.
32-16
OL-1047-01
Chapter 32
Configuring Cisco WebAttendants Configuring Cisco WebAttendant Client Settings
Table 32-4 Cisco WebAttendant User Configuration Settings (continued)
Field IP Address or Host Name
Action Enter the IP address or host name of the TCD server. This entry designates the Cisco CallManager to which the Cisco IP Phone specified by MAC address field is normally registered. The default value is 4321. Do not modify this value. Designates User ID for this Cisco WebAttendant user as specified in the Cisco WebAttendant User Configuration page Cisco CallManager Administration. Refer to the Adding a Cisco WebAttendant User section on page 32-10 for more information.
Cisco Telephony Call Dispatcher (TCD) Settings
IP Port WebAttendant User ID
Note
The Cisco WebAttendant User ID is not the same as a Cisco CallManager User ID entered in the User area of Cisco CallManager Administration.
WebAttendant Password
Specifies password for this Cisco WebAttendant user as specified in the Cisco WebAttendant User Configuration page in Cisco CallManager Administration. Refer to the Adding a Cisco WebAttendant User section on page 32-10 for more information.
Note
The Cisco WebAttendant password is not the same as a Cisco CallManager password entered in the User area of Cisco CallManager Administration.
32-17
Table 32-4 Cisco WebAttendant User Configuration Settings (continued)
Field Connected To
Action Designates view-only field that displays the IP address of the Cisco CallManager to which this Cisco WebAttendant client is currently connected.
Line State Server Settings IP Address or Host Name Enter the IP address or host name of the line state server. This entry usually designates the same as the Cisco CallManager to which the Cisco IP Phone specified by the MAC address field is registered. Designates line state server IP port number. The default value is 3224. Do not change this setting unless advised to do so by the Cisco Technical Assistance Center. Connected To Designates view-only field that displays the IP address of the Line State Server to which this Cisco WebAttendant client is currently connected.
IP Port
Related Topics

Installing the Cisco WebAttendant Client, page 32-13 Setting Up the wauser Shared Directory for Cisco WebAttendant, page 32-19 Understanding Cisco WebAttendant, page 8-1
32-18
OL-1047-01
Chapter 32
Configuring Cisco WebAttendants Cisco WebAttendant Server Configuration
Cisco WebAttendant Server Configuration

The Cisco WebAttendant Server Configuration page lists service parameters and enables you to configure trace parameters for the Telephony Call Dispatcher (TCD). The following service parameters are specific to TCD:
Caution
Do not change any of the listed service parameters without permission of a Cisco Technical Assistance Center engineer. Doing so may cause system failure.
CCN Line State PortThis designates the TCP/IP port number in Cisco Call Manager that is used by the line state server to register and receive line and device information. The default value is 3223. LSS Access PasswordThis default password used at registration authenticates the line state server. LSS Listen PortThis TCP port designates where Cisco WebAttendant clients register with TCD for line and device state information. The default value is 3221. TCDServ Listen PortThis TCP port designates where Cisco WebAttendant clients register with TCD for call control. The default value is 4321.
Related Topics

Understanding Service Parameters, page 10-1 Understanding Trace Configuration, page 36-2 Understanding Cisco WebAttendant, page 8-1
32-19
Chapter 32 Setting Up the wauser Shared Directory for Cisco WebAttendant
Setting Up the wauser Shared Directory for Cisco WebAttendant

You must perform the following procedure to ensure that the Cisco WebAttendant client can display the directory information from the Cisco CallManager directory database.
Note
If you are running Cisco CallManager in a cluster environment, perform this procedure on every Cisco CallManager in the cluster.
Step 1 Step 2
Log in to the Cisco CallManager server. Use Windows Explorer to browse to the following folder: C:\Program Files\Cisco\Users The Cisco WebAttendant client must have read/write access to the following two files in this directory to build its user directory information: UsersDB1.mdb and UsersDB2.mdb.
Right-click on the Users folder and choose Properties. Click the Sharing tab. Click Shared As. Change the default share name from Users to wausers. The share name is not case-sensitive. The share name must be wausers for this to work properly. Ensure security and share permissions are set so that all Cisco WebAttendant client users have read and write access for this folder on the Cisco CallManager server.
Step 7 Step 8
Click OK to apply the changes and close the Properties dialog. Perform this procedure on every Cisco CallManager in the cluster.
32-20
OL-1047-01
Chapter 32
Configuring Cisco WebAttendants Starting the Telephony Call Dispatcher
Note
To ensure that the changes made to the Shared As properties are visible to Cisco WebAttendant clients, have the Cisco WebAttendant users exit the client and log out of Windows and then log back in.
Cisco CallManager automatically makes directory database information available to Cisco WebAttendant clients and updates the information every 24 hours with the latest changes.
Related Topics

Sharing Default Directory Database Information, page 8-11 Understanding Cisco WebAttendant, page 8-1
Starting the Telephony Call Dispatcher

The Telephony Call Dispatcher (TCD) service starts up automatically when Cisco CallManager is started. The following procedure describes how to verify that the TCD service is running and how to start TCD if it is stopped.
Note
If you add new Cisco WebAttendant users or modify the user information or password for an existing user, you must wait approximately 6 minutes for the changes to take effect.
Procedure
Step 1 Step 2
Choose Service > Control Center. Coose a Cisco CallManager server from the server list on the left side of the page. The page refreshes. The Service Name column lists all services that are configured on this server.
32-21
Chapter 32 Starting the Telephony Call Dispatcher
Step 3
Look at the Service Status column for the Cisco Telephony Call Dispatcher.

If an arrow icon displays, the TCD service is running If a square icon displays, the TCD service is stopped.
Step 4
If the TCD service is not running, click the Start button in the Service Control column.
Related Topics

Understanding Pilot Points and Hunt Groups, page 8-6 Understanding Cisco WebAttendant, page 8-1
32-22
OL-1047-01
C H A P T E R
33
Configuring Conference Bridges

Conference Bridge for Cisco CallManager (release 3.0 and later) is an application designed to allow both Ad-Hoc and Meet-Me voice conferencing. Each conference bridge is capable of hosting several simultaneous, multi-party conferences.
Note
The hardware model type for Conference Bridge contains a specific Media Access Control (MAC) address and device pool information.
Related Topics

Understanding Conference Devices, page 33-2 Two Types of Conferences: Meet-Me and Ad-Hoc, page 33-3 Using an Ad-Hoc Conference Bridge, page 33-4 Using a Meet-Me Conference Bridge, page 33-5 Adding a Software Conference Device, page 33-6 Adding a Hardware Conference Device, page 33-8 Updating a Conference Device, page 33-10 Deleting a Conference Device, page 33-11 Updating Conference Bridge Parameters, page 33-12 Adding a Meet-Me Number Pattern, page 33-14 Updating a Meet-Me Number Pattern, page 33-15 Deleting a Meet-Me Number Pattern, page 33-17
33-1
Chapter 33 Understanding Conference Devices
Understanding Conference Devices

For conferencing, you must determine the total number of concurrent users (or audio streams) required at any given time. Then you create and configure a device to support the calculated number of streams. These audio streams can be used for one large conference, or several small conferences. For example, a conference device that was created with 20 streams would provide for one conference of 20 participants, or five conferences with four participants each (or any other combination that adds up to 20 total participants). The total number of conferences supported by each conference device is calculated by taking the total number of streams (for example, 20) and dividing by three. Therefore, in the example, you can have twenty divided by three (20/3) or six conferences supported by the conference device.
Caution
Although conference devices can be installed on the same PC as the Cisco CallManager, we strongly recommend against this. If conference devices are installed on the same PC as the Cisco CallManager, it can adversely affect the performance on the Cisco CallManager.
Note
Conference devices configured only for software support G.711 codecs, however, configuring for hardware provides transcoding for G.711, G.729 and G.723 codecs.
Related Topics

Two Types of Conferences: Meet-Me and Ad-Hoc, page 33-3 Using an Ad-Hoc Conference Bridge, page 33-4 Using a Meet-Me Conference Bridge, page 33-5 Adding a Software Conference Device, page 33-6 Adding a Hardware Conference Device, page 33-8 Updating a Conference Device, page 33-10 Deleting a Conference Device, page 33-11 Updating Conference Bridge Parameters, page 33-12
33-2
OL-1047-01
Chapter 33
Configuring Conference Bridges Two Types of Conferences: Meet-Me and Ad-Hoc
Adding a Meet-Me Number Pattern, page 33-14 Updating a Meet-Me Number Pattern, page 33-15 Deleting a Meet-Me Number Pattern, page 33-17
Two Types of Conferences: Meet-Me and Ad-Hoc

Cisco CallManager supports both Meet-Me conferences and Ad-Hoc conferences. Meet-Me conferences allow users to dial into a conference. Ad-Hoc conferences allow the conference controller to let only certain participants into the conference. Meet-Me conferences require that a range of directory numbers be allocated for their exclusive use. When a Meet-Me conference is set up, the conference controller selects a directory number and advertises it to members of the group. The users call the directory number to join the conference. Anyone who calls the directory number while the conference is active, joins the conference. (This is true provided that the maximum number of participants specified for that conference type has not been exceeded, and sufficient streams are available on the conference device.) Ad-Hoc conferences are controlled by the conference controller. The conference controller individually calls and adds each participant to the conference. Any number of parties can be added to the conference up to the maximum number of participants specified for Ad-Hoc conferences, and provided that sufficient streams are available on the conference device.
Related Topics

Understanding Conference Devices, page 33-2 Using an Ad-Hoc Conference Bridge, page 33-4 Using a Meet-Me Conference Bridge, page 33-5 Adding a Software Conference Device, page 33-6 Adding a Hardware Conference Device, page 33-8 Updating a Conference Device, page 33-10 Deleting a Conference Device, page 33-11 Updating Conference Bridge Parameters, page 33-12
33-3
Chapter 33 Two Types of Conferences: Meet-Me and Ad-Hoc
Adding a Meet-Me Number Pattern, page 33-14 Updating a Meet-Me Number Pattern, page 33-15 Deleting a Meet-Me Number Pattern, page 33-17
Using an Ad-Hoc Conference Bridge

When you initiate an Ad-Hoc conference, you are considered the conference controller. In an Ad-Hoc conference, only a conference controller can add participants to a conference. If other participants attempt to conference, the Cisco CallManager ignores the signals. When the conference controller initiates a conference call, the Cisco CallManager places the current call on hold, flashes the conference lamp, and provides dial tone to the user. At the dial tone, the conference controller dials the next conference participant and when the user answers, presses Conference again to complete the conference. The Cisco CallManager then connects the conference controller, the first participant, and the new conference participant to a conference bridge. Each participants Cisco IP Phone display reflects the connection to the conference. Participants can leave a conference by simply hanging up and terminating the conference call. A conference continues even if the conference controller hangs up, although the remaining conference participants cannot add new participants to the conference.
Related Topics

Understanding Conference Devices, page 33-2 Two Types of Conferences: Meet-Me and Ad-Hoc, page 33-3 Using a Meet-Me Conference Bridge, page 33-5 Adding a Software Conference Device, page 33-6 Adding a Hardware Conference Device, page 33-8 Updating a Conference Device, page 33-10 Deleting a Conference Device, page 33-11 Updating Conference Bridge Parameters, page 33-12 Adding a Meet-Me Number Pattern, page 33-14
33-4
OL-1047-01
Chapter 33
Configuring Conference Bridges Two Types of Conferences: Meet-Me and Ad-Hoc
Updating a Meet-Me Number Pattern, page 33-15 Deleting a Meet-Me Number Pattern, page 33-17
Using a Meet-Me Conference Bridge

When you initiate a Meet-Me conference by pressing Meet-Me on the phone, you are considered the conference controller. The conference controller provides the directory number for the conference to all attendees, who can then dial that directory number to join the conference. If other participants in a Meet-Me conference press Meet-Me, the Cisco CallManager ignores the signals. The conference controller selects a directory number from the range specified for the conference device. The Cisco CallManager Administrator should provide the conference directory number range to users so they can access the feature. When you, the conference controller, initiate a conference call by pressing Meet-Me, the Cisco CallManager provides dial tone to you. At the dial tone, you can dial the conference directory number to create the conference. The Cisco CallManager then connects you to the conference. Participants can join the conference by dialing the specified directory number. You hear a tone each time a participant joins the conference. Participants can leave a conference by hanging up the conference call. A conference continues even if you, the conference controller, hangs up.
Related Topics

Understanding Conference Devices, page 33-2 Two Types of Conferences: Meet-Me and Ad-Hoc, page 33-3 Using an Ad-Hoc Conference Bridge, page 33-4 Adding a Software Conference Device, page 33-6 Adding a Hardware Conference Device, page 33-8 Updating a Conference Device, page 33-10 Deleting a Conference Device, page 33-11 Updating Conference Bridge Parameters, page 33-12 Adding a Meet-Me Number Pattern, page 33-14
33-5
Chapter 33 Adding a Software Conference Device
Updating a Meet-Me Number Pattern, page 33-15 Deleting a Meet-Me Number Pattern, page 33-17
Adding a Software Conference Device

This section describes how to add a software conference device. For Conference Bridge hardware configuration see the Adding a Hardware Conference Device section on page 33-8.
Note
The service must be installed in order to perform this procedure.
Before You Begin
The following prerequisites must be met before proceeding with the steps:

Servers must be configure. See the Server section on page 11-1. Device pools must be configured. See the Configuring Device Pools section on page 17-1.
Procedure
Open Cisco CallManager Administration. Click Service > Conference Bridge. Select Software in the Model Type field. Enter a name for the conference device, up to 15 alphanumeric characters, in the Device Name field.
Note
If the specified device name is longer than 15 characters, the device will not be able to successfully register with the Cisco CallManager.
Step 5
Enter any description for the conference device in the Device Description field.
33-6
OL-1047-01
Chapter 33
Configuring Conference Bridges Adding a Software Conference Device
Step 6
Select a device pool from the drop-down list box in the Device Pool field, to which you want this conference device assigned. You can choose one of the available device pools, or you can select the default device pool. Select a server from the drop-down list box in the Server Name field. Enter the maximum number of streams you want to allow on this device, or keep the default number, in the Full Duplex Streaming Endpoint Count field. Enter the maximum number of seconds you want to allow calls or conferences to stay connected in the event of a Cisco CallManager failure, or keep the default number, in the Orphan Stream Time Out field.
Note
When a Cisco CallManager goes down, the calls to the conferences that were on that Cisco CallManager are called orphans. The orphaned calls or conferences will stay up for the length of time you have allocated for Orphan Stream Time Out.
Step 10
Select True or False in the Run Flag field. True determines when you want a run flag.
Note
The Run Flag provides a way to disable functionality without removing devices.
Step 11
Click Insert. The page refreshes and a message displays stating that the Conference Bridge device must be reset in order for the changes to take effect. Click OK. The page refreshes again, showing information, including the status, for the device you just added. Each device is listed on the left side of the page.
Step 12
Click Reset Device and follow the instructions in the Reset Device dialog box.
Related Topics

Understanding Conference Devices, page 33-2 Two Types of Conferences: Meet-Me and Ad-Hoc, page 33-3 Using an Ad-Hoc Conference Bridge, page 33-4
33-7
Chapter 33 Adding a Hardware Conference Device
Using a Meet-Me Conference Bridge, page 33-5 Adding a Hardware Conference Device, page 33-8 Updating a Conference Device, page 33-10 Deleting a Conference Device, page 33-11 Updating Conference Bridge Parameters, page 33-12 Adding a Meet-Me Number Pattern, page 33-14 Updating a Meet-Me Number Pattern, page 33-15 Deleting a Meet-Me Number Pattern, page 33-17
Adding a Hardware Conference Device

This section describes how to add a hardware conference device. For Conference Bridge software configuration, see the Adding a Software Conference Device section on page 33-6.
Note
Before You Begin

Servers must be configured. See the Server section on page 11-1. Device pools must be configured. See the Configuring Device Pools section on page 17-1.
Procedure
Open Cisco CallManager Administration. Click Service > Conference Bridge. Select Hardware in the Model Type field. Enter the device MAC address (must be at least 12 characters) in the MAC address field.
33-8
OL-1047-01
Chapter 33
Configuring Conference Bridges Adding a Hardware Conference Device
The Device Description field is automatically generated from the MAC address you provide.
Enter any special load information into the Special Load Information field, or leave blank to use default. Select a device pool from the drop-down list box or choose Default, in the Device Pool field. Click Insert. A message displays stating that the Conference Bridge device must be reset in order for the changes to take effect. Click OK. The page refreshes and displays the conference device you just added. The device should appear in the list on the left side of the page. Click Reset Device and follow the instructions in the Reset Device dialog box.
Related Topics

Understanding Conference Devices, page 33-2 Two Types of Conferences: Meet-Me and Ad-Hoc, page 33-3 Using an Ad-Hoc Conference Bridge, page 33-4 Using a Meet-Me Conference Bridge, page 33-5 Adding a Software Conference Device, page 33-6 Updating a Conference Device, page 33-10 Deleting a Conference Device, page 33-11 Updating Conference Bridge Parameters, page 33-12 Adding a Meet-Me Number Pattern, page 33-14 Updating a Meet-Me Number Pattern, page 33-15 Deleting a Meet-Me Number Pattern, page 33-17
33-9
Chapter 33 Updating a Conference Device
Updating a Conference Device

This section describes how to update a Conference Device.
Note
Before You Begin

Servers must be configured. See the Server section on page 11-1. Device pools must be configured. See the Configuring Device Pools section on page 17-1. Conference device must be configured. See the Understanding Conference Devices section on page 33-2.
Procedure
Open Cisco CallManager Administration. Click Service > Conference Bridge. Select the Conference Bridge device you want to update from the list on the left side of the page. The page refreshes showing the device you want to update. Make the desired changes to the device. When you have completed your changes, click Update. A message displays stating that the Conference Bridge device must be reset in order for the changes to take effect. Click OK. The page refreshes showing the updated device information. Click Reset Device and follow the instructions in the Reset Device dialog box. Repeat steps 1 through 6 to update other conference devices.
Related Topics

Understanding Conference Devices, page 33-2 Two Types of Conferences: Meet-Me and Ad-Hoc, page 33-3
33-10
OL-1047-01
Chapter 33
Configuring Conference Bridges Deleting a Conference Device
Using an Ad-Hoc Conference Bridge, page 33-4 Using a Meet-Me Conference Bridge, page 33-5 Adding a Software Conference Device, page 33-6 Adding a Hardware Conference Device, page 33-8 Deleting a Conference Device, page 33-11 Updating Conference Bridge Parameters, page 33-12 Adding a Meet-Me Number Pattern, page 33-14 Updating a Meet-Me Number Pattern, page 33-15 Deleting a Meet-Me Number Pattern, page 33-17
Deleting a Conference Device

This section describes how to delete a Conference Device.
Note
Before You Begin

Servers must be configured. See the Server section on page 11-1. Device pools must be configured. See the Configuring Device Pools section on page 17-1. Conference device must be configured. See the Configuring Conference Bridges section on page 33-1.
Procedure
Open Cisco CallManager Administration. Click Service > Conference Bridge. Select the device you want to delete from the list on the left side of the page. The page refreshes, showing the device you selected.
33-11
Chapter 33 Updating Conference Bridge Parameters
Step 4 Step 5
Click Delete. A message displays stating that you are about to permanently delete the device, and that this action cannot be undone. If you wish to continue with the deletion, click OK, otherwise click Cancel. The page refreshes again, and the conference device you deleted is removed from the list of devices, and all active calls are terminated.
Related Topics

Understanding Conference Devices, page 33-2 Two Types of Conferences: Meet-Me and Ad-Hoc, page 33-3 Using an Ad-Hoc Conference Bridge, page 33-4 Using a Meet-Me Conference Bridge, page 33-5 Adding a Software Conference Device, page 33-6 Adding a Hardware Conference Device, page 33-8 Updating a Conference Device, page 33-10 Updating Conference Bridge Parameters, page 33-12 Adding a Meet-Me Number Pattern, page 33-14 Updating a Meet-Me Number Pattern, page 33-15 Deleting a Meet-Me Number Pattern, page 33-17
Updating Conference Bridge Parameters

This section describes how to update Conference Bridge Parameters.
Before You Begin

Servers must be configured. See the Server section on page 11-1. Device pools must be configured. See the Configuring Device Pools section on page 17-1. Cisco CallManager must be configured. See the Configuring Cisco CallManager section on page 12-1.
33-12
OL-1047-01
Chapter 33
Configuring Conference Bridges Updating Conference Bridge Parameters
Procedure
Open Cisco CallManager Administration. Click Service > Conference Bridge. Click Conference Bridge Parameters from either the top right-hand corner or the bottom right-hand corner of the page. The page refreshes and the Conference Bridge Parameters page appears.
Step 4 Step 5
Select a device pool from the drop-down list box or choose Default. The Cisco CallManagers in this device pool appear in the box to the left of the page. Highlight the Cisco CallManager on which you want to update the conference parameters. The maximum number of users configured for both an Ad-Hoc conference and a Meet-Me conference using Unicast appear in the fields to the right of the page. Change the maximum number of users accordingly and click Update.
Step 6
Note
You must reset each Conference Bridge device after making updates for the changes to take effect. To do this, click Conference Bridge Configuration and select the Conference Bridge device you want to reset. Next, click Reset Device and follow the instructions in the Reset Device dialog box. Changes will only take place when there are no active calls. When you click Restart, the changes are made immediately, and active calls are terminated.
Related Topics

Understanding Conference Devices, page 33-2 Two Types of Conferences: Meet-Me and Ad-Hoc, page 33-3 Using an Ad-Hoc Conference Bridge, page 33-4 Using a Meet-Me Conference Bridge, page 33-5 Adding a Software Conference Device, page 33-6 Adding a Hardware Conference Device, page 33-8
33-13
Chapter 33 Adding a Meet-Me Number Pattern
Updating a Conference Device, page 33-10 Deleting a Conference Device, page 33-11 Adding a Meet-Me Number Pattern, page 33-14 Updating a Meet-Me Number Pattern, page 33-15 Deleting a Meet-Me Number Pattern, page 33-17
Adding a Meet-Me Number Pattern

This section describes how to add a Meet-Me Number Pattern.
Before You Begin

Servers must be configured. See the Server section on page 11-1. Device pools must be configured. See the Configuring Device Pools section on page 17-1.
Procedure
Open Cisco CallManager Administration. Click Service > Conference Bridge. Click Meet-Me Number/Pattern Configuration, from either the top right-hand corner or the bottom right-hand corner of the page. The page refreshes and the Meet-Me Number/Pattern Configuration page appears.
Enter a Meet-Me Numbers/pattern in the Pattern field. Select a partition from the scroll menu in the Route Partition field. See the Configuring Partitions section on page 21-1 for more information. Click Insert. The page refreshes and the new Meet-Me Numbers pattern appears in the list on the left side of the page.
33-14
OL-1047-01
Chapter 33
Configuring Conference Bridges Updating a Meet-Me Number Pattern
Related Topics

Understanding Conference Devices, page 33-2 Two Types of Conferences: Meet-Me and Ad-Hoc, page 33-3 Using an Ad-Hoc Conference Bridge, page 33-4 Using a Meet-Me Conference Bridge, page 33-5 Adding a Software Conference Device, page 33-6 Adding a Hardware Conference Device, page 33-8 Updating a Conference Device, page 33-10 Deleting a Conference Device, page 33-11 Updating Conference Bridge Parameters, page 33-12 Updating a Meet-Me Number Pattern, page 33-15 Deleting a Meet-Me Number Pattern, page 33-17 Configuring Partitions, page 21-1
Updating a Meet-Me Number Pattern

This section describes how to update a Meet-Me Number Pattern.
Before You Begin

Servers must be configured. See the Server section on page 11-1. Device pools must be configured. See the Configuring Device Pools section on page 17-1. Meet-Me Number/Pattern must be configured. See the Adding a Meet-Me Number Pattern section on page 33-14.
Procedure
Step 1 Step 2
Open Cisco CallManager Administration. Click Service > Conference Bridge.
33-15
Chapter 33 Updating a Meet-Me Number Pattern
Step 3
Click Meet-Me Number/Pattern Configuration, from either the top right-hand corner or the bottom right-hand corner of the page. The page refreshes and the Meet-Me Number/Pattern Configuration page appears.
Step 4
Highlight the Meet-Me Numbers pattern you want to update from the list on the left side of the page. The page refreshes again and the pattern you chose appears in the pattern field.
Note
You can change the number or pattern as needed (example, changing 5000 to 500X).
Step 5
Select a new route partition from the scroll list and click Update. The page refreshes and the pattern is updated with the new route partition information.
Related Topics

Understanding Conference Devices, page 33-2 Two Types of Conferences: Meet-Me and Ad-Hoc, page 33-3 Using an Ad-Hoc Conference Bridge, page 33-4 Using a Meet-Me Conference Bridge, page 33-5 Adding a Software Conference Device, page 33-6 Adding a Hardware Conference Device, page 33-8 Updating a Conference Device, page 33-10 Deleting a Conference Device, page 33-11 Updating Conference Bridge Parameters, page 33-12 Adding a Meet-Me Number Pattern, page 33-14 Deleting a Meet-Me Number Pattern, page 33-17 Configuring Partitions, page 21-1
33-16
OL-1047-01
Chapter 33
Configuring Conference Bridges Deleting a Meet-Me Number Pattern
Deleting a Meet-Me Number Pattern

This section describes how to delete a Meet-Me Number Pattern.
Before You Begin

Servers must be configured Device pools must be configured Meet-Me Number/Pattern must be configured
Procedure
Open Cisco CallManager Administration. Click Service > Conference Bridge. Click Meet-Me Number/Pattern Configuration, from either the top right-hand corner or the bottom right-hand corner of the page. The page refreshes and the Meet-Me Number/Pattern Configuration page appears.
Highlight the Meet-Me Number/Pattern you want to delete from the list on the left side of the page. The page refreshes again. Click Delete. A message displays stating that you are about to permanently delete this pattern and that this action cannot be undone. Click OK to continue, or Cancel to cancel the deletion.
Related Topics

Understanding Conference Devices, page 33-2 Two Types of Conferences: Meet-Me and Ad-Hoc, page 33-3 Using an Ad-Hoc Conference Bridge, page 33-4 Using a Meet-Me Conference Bridge, page 33-5 Adding a Software Conference Device, page 33-6 Adding a Hardware Conference Device, page 33-8 Updating a Conference Device, page 33-10
OL-1047-01
33-17
Chapter 33 Deleting a Meet-Me Number Pattern
Deleting a Conference Device, page 33-11 Updating Conference Bridge Parameters, page 33-12 Adding a Meet-Me Number Pattern, page 33-14 Updating a Meet-Me Number Pattern, page 33-15
33-18
OL-1047-01
C H A P T E R
34
Configuring Media Termination Point

A Media Termination Point (MTP) is invoked on behalf of H.323 endpoints involved in a call in order to enable supplementary call services. In some cases, H.323 gateways may require that calls use an MTP in order to enable supplementary call services, but normally, Cisco gateways do not. MTP is a Cisco software application that installs on a server during the software installation process. During installation, the component is called the IpVoiceMediaStreamer and is common to both the MTP and Conference Bridge applications. Under Windows2000, the application runs as a service and is called Cisco Ip Voice Media Streaming App. The MTP registers with its specified primary Cisco CallManager, and informs the Cisco CallManager about how many MTP resources it supports.
Note
Transcoders also provide the capabilities of an MTP in addition to their transcoding functions. You cannot have both Transcoders and MTPs registered with the same Cisco CallManager, at the same time. See the Configuring Transcoder section on page 37-1 for more information. Each MTP is given a list of Cisco CallManagers, in priority order, to which it should attempt to register. This list is called a Device Pool. The first Cisco CallManager in the list is its primary Cisco CallManager. If the primary Cisco CallManager fails, the MTP attempts to register with the next available Cisco CallManager in the list. Each MTP can register with only one Cisco CallManager at a time. An MTP always registers with its primary (or publisher) Cisco CallManager if that Cisco CallManager is available, and
34-1
Chapter 34
re-registers with the primary Cisco CallManager as soon as it becomes available after a failure, and is currently not in use. The system may have multiple MTPs, each of which may be registered to one Cisco CallManager, depending on how you have your system configured. The Cisco CallManager controls MTP resources. Multiple MTPs may be registered with the same Cisco CallManager. When more than one MTP is registered with a given Cisco CallManager, that Cisco CallManager controls the set of resources for each of the MTPs. The MTPs may also be distributed across a networked system as desired. For example, MTP application server 1 is configured for 48 MTP resources. The MTP application server 2 is configured for 24 resources. If both MTPs register with the same Cisco CallManager, that Cisco CallManager maintains both sets of resources for a total of 72 registered MTP resources. When the Cisco CallManager determines that a call endpoint requires an MTP, it allocates an MTP resource from the MTP that has the most resources available. That MTP resource is inserted into the call on behalf of the endpoint. MTP resource use is invisible to both the users of the system, and the endpoint on whose behalf it was inserted. If an MTP resource is not available when it is needed, the call is connected without using an MTP resource, and supplementary services are not available on that call.
Note
Supplementary services are features, such as call hold, call transfer, call park, and conferencing, that are otherwise not available when a call is routed to an H.323 endpoint.
Related Topics:

Planning Your MTP Configuration, page 34-3 Avoiding Call Failure/User Alert, page 34-4 Configuring Transcoder, page 37-1 Adding a Media Termination Point, page 34-5 Updating a Media Termination Point, page 34-7 Deleting a Media Termination Point, page 34-8
34-2
OL-1047-01
Chapter 34
Configuring Media Termination Point Planning Your MTP Configuration
Planning Your MTP Configuration

Consider the following information when planning your MTP configuration:
Only one MTP application can be installed per server; however, to provide more MTP resources, you can install additional MTP applications on networked Windows NT servers. A single MTP provides a default of 48 MTP (user configurable) resources, depending on the speed of the network and the network interface card (NIC) card. For example, a 100 MB Network/NIC card can support 48 MTP resources, while a 10 MB NIC card cannot. For a 10 MB Network/NIC card, approximately 24 MTP resources can be provided, however, the exact number of MTP resources available depends on the amount of resources being consumed by other applications on that PC, the speed of the processor, network loading, and various other factors. Consider the following formula to determine the approximate number of MTP applications needed for your system, assuming that your server can handle 48 MTP resources (you can substitute 48 for the correct number of MTP resources supported by your system): A plus B divided by 48 = number of MTP applications needed (A + B / 48 = # of MTP apps) where: A represents the maximum number of simultaneous calls to H.323 endpoints that require an MTP B represents the maximum number of simultaneous calls between Cisco CallManager clusters If a remainder exists, add another MTP application.
If one H.323 endpoint requires an MTP, it consumes one MTP resource, thus depending on the originating and terminating device type, more than one MTP resource might be consumed by a given call. The MTP resources assigned to the call are released when the call is terminated.
34-3
Chapter 34 Avoiding Call Failure/User Alert
Use Performance Monitor to monitor the usage of MTP resources. The Performance Monitor counter, Media TermPoints Out of Resources, increments for each H.323 call that has been connected without an MTP resource when one was required. This number can assist you in determining how many MTP resources are required for your callers, and whether you have adequate coverage. Refer to the MTP system requirements are the same as Cisco CallManager system requirements.
Related Topics:

Configuring Media Termination Point, page 34-1 Avoiding Call Failure/User Alert, page 34-4 Configuring Transcoder, page 37-1 Adding a Media Termination Point, page 34-5 Updating a Media Termination Point, page 34-7 Deleting a Media Termination Point, page 34-8
Avoiding Call Failure/User Alert

Avoid the following conditions to prevent call failure or user alert:
Although the MTP application can be installed on the same PC as the Cisco CallManager, we strongly recommend against this. If the MTP application is installed on the same PC as the Cisco CallManager, it can adversely affect the performance of the Cisco CallManager. When you configure the MTP, you are prompted to reset MTP before any changes can take effect. This does not result in disconnection of any calls connected to MTP resources. If you choose Reset, as soon as the MTP has no active calls, the changes take effect.
Note
When you make updates to the MTP and you choose Restart, all calls connected to the MTP go down at that time.
34-4
OL-1047-01
Chapter 34
Configuring Media Termination Point Adding a Media Termination Point
Related Topics:

Configuring Media Termination Point, page 34-1 Planning Your MTP Configuration, page 34-3 Configuring Transcoder, page 37-1 Adding a Media Termination Point, page 34-5 Updating a Media Termination Point, page 34-7 Deleting a Media Termination Point, page 34-8
Adding a Media Termination Point

This section describes how to add a Media Termination Point (MTP).
Note
Before You Begin

Servers must be configured. See the Server section on page 11-1. Device pools must be configured. See the Server section on page 11-1.
Note
Add only one Media Termination Point (MTP) device for each MTP application.
Procedure
Open Cisco CallManager Administration. Click Service> Media Termination Point. Enter a name for the MTP, up to 15 alphanumeric characters, in the Device Name field. Enter any description for the MTP in the Device Description field.
34-5
Chapter 34 Adding a Media Termination Point
Select a device pool from the drop-down menu in the Device Pool field. The device pool specifies the list of Cisco CallManagers for this MTP. Select the server on which the MTP will run in the Server Name field, from the drop-down list box. Enter an endpoint count or keep the default number in the Full Duplex Streaming Endpoint Count field. Enter the maximum number of seconds you want to allow conference calls to stay connected in the Orphan Stream Time Out field, or keep the default number.
Note
When a Cisco CallManager goes down, the calls to conferences that were on that Cisco CallManager are called orphans. The orphaned calls or conferences will stay up as long as the length of time you allocated for Orphan Stream Time Out.
Select True or False in the Run Flag field. (The Run Flag provides a way to disable functionality without removing devices.) Click Insert. A message displays stating that the MTP device must be reset before the changes take effect. Click OK. The page refreshes showing the specific information for the device you just created. The device should now appear in the list on the left side of the page. Click Reset Device and follow the instructions in the Reset Device dialog box.
Related Topics

Configuring Media Termination Point, page 34-1 Planning Your MTP Configuration, page 34-3 Avoiding Call Failure/User Alert, page 34-4 Configuring Transcoder, page 37-1 Updating a Media Termination Point, page 34-7 Deleting a Media Termination Point, page 34-8 Configuring a Transcoder, page 37-3
34-6
OL-1047-01
Chapter 34
Configuring Media Termination Point Updating a Media Termination Point
Updating a Media Termination Point

This section describes how to update a Media Termination Point (MTP).
Note
Before You Begin

Servers must be configured Device pools must be configured Media Termination Points must be configured
Procedure
Open Cisco CallManager Administration. Click Service> Media Termination Point. Select the MTP you want to update from the device list on the left side of the page. The page refreshes, showing the device you selected. Make the desired changes to the MTP and click Update. A message displays stating that the MTP device must be reset before the changes will take effect. Click OK. The page refreshes, showing the updated MTP. Click Reset Device and follow the instructions in the Reset Device dialog box.
Note
When you make updates to the MTP and you choose Restart, all calls connected to the MTP go down at that time. Reset will wait until all calls are completed.
Step 7
Repeat Steps 1-6 to update other MTPs.
34-7
Chapter 34 Deleting a Media Termination Point
Related Topics

Configuring Media Termination Point, page 34-1 Planning Your MTP Configuration, page 34-3 Avoiding Call Failure/User Alert, page 34-4 Configuring Transcoder, page 37-1 Adding a Media Termination Point, page 34-5 Deleting a Media Termination Point, page 34-8
Deleting a Media Termination Point

This section describes how to delete a Media Termination Point (MTP).
Note
Before You Begin

Servers must be configured Device pools must be configured Media Termination Points must be configured
Procedure
Open Cisco CallManager Administration Click Service> Media Termination Point. Select the MTP you want to delete from the device list on the left side of the page. The page refreshes, showing the device you selected. Click Delete. A message displays verifying your delete request. There is no undo for this action. Click OK to continue, or Cancel to cancel the deletion.
34-8
OL-1047-01
Chapter 34
Configuring Media Termination Point Deleting a Media Termination Point
The page refreshes again and the MTP you deleted should no longer appear in the device list. All active calls/streams are terminated.
Step 6
Repeat Steps 1-5 to delete another MTP.
Related Topics

Configuring Media Termination Point, page 34-1 Planning Your MTP Configuration, page 34-3 Avoiding Call Failure/User Alert, page 34-4 Configuring Transcoder, page 37-1 Adding a Media Termination Point, page 34-5 Updating a Media Termination Point, page 34-7
34-9
Chapter 34 Deleting a Media Termination Point
34-10
OL-1047-01
C H A P T E R
35
Configuring Service Parameters

Service Parameters for Cisco CallManager (release 3.0 and later) allows you to configure different services on selected servers. You can insert and delete services on a selected server, as well as insert, modify, and delete the service parameters for those services. Refer to the Service Parameter Restart Conditions section on page 35-2 for information on when a restart of Cisco CallManager is required for certain parameters.
Note
The previous statements only apply to the Cisco CallManager database. Services must be installed in the database for them to work. For example, if you add a conference bridge to the database, it may not physically exist. It will only be installed if you chose Media Streaming Off during installation. The Service Parameters application also provides the following lists:

Configured servers in the system All configured services on a selected server
Caution
Some changes to service parameters may cause system failure. Cisco recommends that you do not make any changes to service parameters unless you fully understand the feature that you are changing, or unless the Cisco Technical Assistance Center (TAC) specifies the changes. Read the Understanding Service Parameters section on page 10-1 for more detailed service parameter information.
35-1
Chapter 35 Service Parameter Restart Conditions
Related Topics

Understanding Service Parameters, page 10-1 Service Parameter Restart Conditions, page 35-2 Adding a New Service on a Server, page 35-3 Deleting a Service From a Server, page 35-4 Adding a New Service Parameter, page 35-5 Updating a Service Parameter, page 35-7 Deleting a Service Parameter, page 35-9
Service Parameter Restart Conditions

If you modify any of the following service parameters, you must restart the Cisco CallManager before the modifications take effect:

Digital Port Ethernet Phone Port Analog Port MGCP Listen Port MGCP Keep-alive Port MessageWaitingOffDN MessageWaitingOnDN StatisticsEnabled MaxDaResponseTimeoutErrorCount MaxTotalNumberOfRegisteredCallingEntities
Note
These restart conditions apply starting with release 3.0(7) of the Cisco CallManager.
35-2
OL-1047-01
Chapter 35
Configuring Service Parameters Adding a New Service on a Server
Related Topics

Configuring Service Parameters, page 35-1 Understanding Service Parameters, page 10-1 Adding a New Service on a Server, page 35-3 Deleting a Service From a Server, page 35-4 Adding a New Service Parameter, page 35-5 Updating a Service Parameter, page 35-7 Deleting a Service Parameter, page 35-9
Adding a New Service on a Server

This section describes how to add a new service on a server.
Before You Begin
Ensure the following prerequisite is met before proceeding with the steps:
Servers must be configured.
Procedure
Open Cisco CallManager Administration. Choose Service > Service Parameters. Choose a configured server from the list of configured servers on the left side of the page. The page refreshes to the server you selected, showing the services already configured on that server. Click New. The page refreshes again. From the Service Type drop-down menu, choose a service type to configure on this server. The page refreshes. Click Insert to configure the service type. A status message prompts you to wait. The system loads the service type you selected after the service type is inserted.
35-3
Chapter 35 Deleting a Service From a Server
Related Topics

Configuring Service Parameters, page 35-1 Understanding Service Parameters, page 10-1 Service Parameter Restart Conditions, page 35-2 Deleting a Service From a Server, page 35-4 Adding a New Service Parameter, page 35-5 Updating a Service Parameter, page 35-7 Deleting a Service Parameter, page 35-9
Deleting a Service From a Server

This section describes how to delete service from a server.
Before You Begin
Ensure the following prerequisites are met before proceeding with the steps. See the Server section on page 11-1.

Servers must be configured. Service must be present.
Procedure
Open Cisco CallManager Administration. Choose Service > Service Parameters. From the list of configured servers on the left side of the page, choose the configured server from which you want to delete a service. The page refreshes to the server you selected, showing the services already configured on that server. The drop-down list box under Configured Services lists the configured services. Choose the configured service you want to delete. The page refreshes again.
Step 4
35-4
OL-1047-01
Chapter 35
Configuring Service Parameters Adding a New Service Parameter
Step 5 Step 6
Click Delete Service. A message displays stating that you are about to permanently delete this service and that the action cannot be undone. Click OK to continue or Cancel to cancel the deletion. The service type no longer appears in the drop-down list.
Related Topics

Configuring Service Parameters, page 35-1 Understanding Service Parameters, page 10-1 Service Parameter Restart Conditions, page 35-2 Adding a New Service on a Server, page 35-3 Adding a New Service Parameter, page 35-5 Updating a Service Parameter, page 35-7 Deleting a Service Parameter, page 35-9
Adding a New Service Parameter

This section describes how to add a new service parameter.
Before You Begin
Ensure the following prerequisites are met before proceeding with the steps. See the Server section on page 11-1.

Servers must be configured. Service must be configured.
Caution
Some changes to service parameters may cause system failure. Cisco recommends that you do not make any changes to service parameters unless you fully understand the feature that you are changing or unless the Cisco Technical Assistance Center (TAC) specifies the changes. Refer to the Understanding Service Parameters section on page 10-1 for more information about service parameters.
35-5
Chapter 35 Adding a New Service Parameter
Procedure
Step 1 Step 2 Step 3 Step 4 Step 5 Step 6 Step 7 Step 8
Open Cisco CallManager Administration. Choose Service > Service Parameters. Choose a configured server from the list of configured servers on the left side of the page. The page refreshes to the list of configured services. Choose the service to which you want to add a new parameter. The page refreshes again. Enter the service parameter name you want to add in the Param field. Enter the parameter type in the Type field. Enter a value in the Value field. Click Update. A status message prompts you to wait. The page refreshes, and the status message displays results. The service parameter you added appears in the list of configured service parameters.
Note
If you want to use default settings, click Default. A message displays stating that you are about to permanently delete all the previous settings and replace them with the default settings. Click OK if you wish to use the default settings or Cancel to cancel the operation.
Related Topics

Configuring Service Parameters, page 35-1 Understanding Service Parameters, page 10-1 Service Parameter Restart Conditions, page 35-2 Adding a New Service on a Server, page 35-3 Deleting a Service From a Server, page 35-4 Updating a Service Parameter, page 35-7 Deleting a Service Parameter, page 35-9
35-6
OL-1047-01
Chapter 35
Configuring Service Parameters Updating a Service Parameter
Updating a Service Parameter

This section describes how to update a service parameter.
Before You Begin
Ensure the following prerequisites are met before proceeding with the steps. See the Server section on page 11-1 for more information.

Caution
Some changes to service parameters may cause system failure. Cisco recommends that you do not make any changes to service parameters unless you fully understand the feature that you are changing, or unless the Cisco Technical Assistance Center (TAC) specifies the changes. Refer to the Understanding Service Parameters section on page 10-1 for more information about service parameters.
Procedure
Open Cisco CallManager Administration. Choose Service > Service Parameters. Choose a configured server from the list of configured servers on the left side of the page. The page refreshes to the list of configured services. Choose the service to which you want to update a parameter. The page refreshes again. Choose the parameter you want to update from the list of configured service parameters.
Note
Refer to the Understanding Service Parameters section on page 10-1 for more information before updating service parameters.
Step 6
Using the Param, Type, and Value fields, make the desired changes to the parameter.
OL-1047-01
35-7
Chapter 35 Updating a Service Parameter
Note
You can change a service parameter type only if it is added. You cannot change default value types.
Step 7
Click Update. A status message prompts you to wait. The page refreshes, and the status message displays results. The Cisco CallManager updates the service parameter with your changes.
Note
If you want to use default settings, click Default. A message displays stating that you are about to permanently delete all the previous settings and replace them with the default settings. Click OK if you want to use the default settings or Cancel to cancel the operation.
Related Topics

Configuring Service Parameters, page 35-1 Understanding Service Parameters, page 10-1 Service Parameter Restart Conditions, page 35-2 Adding a New Service on a Server, page 35-3 Deleting a Service From a Server, page 35-4 Adding a New Service Parameter, page 35-5 Deleting a Service Parameter, page 35-9
35-8
OL-1047-01
Chapter 35
Configuring Service Parameters Deleting a Service Parameter
Deleting a Service Parameter

This section describes how to delete a service parameter.
Before You Begin
Ensure the following prerequisites are met before proceeding with the steps. See the Server section on page 11-1 and the Understanding Service Parameters section on page 10-1 for more information.

Caution
Some changes to service parameters may cause system failure. Cisco recommends that you do not make any changes to service parameters unless you fully understand the feature that you are changing or unless the Cisco Technical Assistance Center (TAC) specifies the changes. Refer to the Understanding Service Parameters section on page 10-1 for more information about service parameters.
Procedure
Open Cisco CallManager Administration. Choose Service > Service Parameters. Choose a configured server from the list of configured servers on the left side of the page. The page refreshes to the list of configured services. From the Configured Services list, choose the service type from which you want to delete a service parameter. The page refreshes again. Choose the service parameter you want to delete. Click Delete. A message displays stating that you are about to permanently delete this parameter and that this action cannot be undone. Click OK to continue or Cancel to cancel the deletion. A status message prompts you to wait. The page refreshes, and the status message displays results. The deleted service parameter no longer appears in the list of configured service parameters.
35-9
Chapter 35 Deleting a Service Parameter
Note
If you want to use default settings, click Default. A message displays stating that you are about to permanently delete all the previous settings and replace them with the default settings. Click OK if you want to use the default settings or Cancel to cancel the operation.
Related Topics

Configuring Service Parameters, page 35-1 Understanding Service Parameters, page 10-1 Adding a New Service on a Server, page 35-3 Deleting a Service From a Server, page 35-4 Adding a New Service Parameter, page 35-5 Updating a Service Parameter, page 35-7
35-10
OL-1047-01
C H A P T E R
36
Configuring Trace
Use trace configuration to specify the type and level of trace information reported by Cisco CallManager and its associated services. You can configure trace options for each of the following system services:

Cisco CallManager Cisco Database Layer Monitor Cisco IP Voice Media Streaming Application Cisco Messaging Interface (CMI) Cisco Telephony Call Dispatcher (TCD) Cisco Trivial File Transfer Protocol (TFTP)
The following sections provide details about configuring trace settings:

Understanding Trace Configuration, page 36-2 Table 36-4 provides the trace parameters for Event Type, User Mask, and Date and Time, page 36-9 Adding a New Service and Trace Configuration, page 36-11 Updating a Trace Configuration, page 36-13 Deleting a Trace Configuration, page 36-14 Deleting a Service, page 36-15
36-1
Chapter 36 Understanding Trace Configuration
Configuring Trace
Understanding Trace Configuration

Traces provide information that can be used for system performance monitoring, troubleshooting, and debugging. Selecting the proper level and amount of trace information for your needs is important. Too little trace information will prevent you from debugging the system, but too much trace information can overload the system and degrade performance. You can set the following parameters in Cisco CallManager Administration to control the type and amount of trace information generated:

Trace Levels, page 36-2 Time, page 36-3 User Mask, page 36-3 Event Level, page 36-6 Components, page 36-7
The hexadecimal number in the Trace Mask field changes as you change the settings of trace level, date, time, and user mask.
Trace Levels
Table 36-1 lists the available trace levels used by the Cisco CallManager service. The Error level provides the least amount of trace information, and the Detailed level provides the most. Because the levels are cumulative, a more detailed level includes all the same information as the lower level plus some additional information.
Table 36-1 Trace Levels
Level Error Special State Transition Significant
Description Traces alarm conditions and events. Traces all Error conditions plus process and device initialization messages. Traces all Special conditions plus subsystem state transitions that occur during normal operation. Traces all State Transition conditions plus media events that occur during normal operation.
36-2
OL-1047-01
Chapter 36
Configuring Trace Understanding Trace Configuration
Table 36-1 Trace Levels (continued)
Level Entry/Exit Arbitrary
Description Traces all Significant conditions plus entry and exit points of routines. Not all services use this trace level. Traces all Entry/Exit conditions plus low-level debugging information.
Note
Do not use this trace level with the Cisco CallManager service or the Cisco IP Voice Media Streaming Application service during normal operation.
Detailed
Traces all Arbitrary conditions plus detailed debugging information.
Note
Do not use this trace level with the Cisco CallManager service or the Cisco IP Voice Media Streaming Application service during normal operation.
Time
You can enable the Show Time option to record the time of each trace event. Cisco recommends that you enable the Show Time option for all traces.
User Mask
The user mask, a series of flags or bits, enables and disables specific types of trace information. As you click on the bits to turn them on and off, the hexadecimal value in the Mask field changes. The function of each mask bit depends on the service you are tracing, as indicated in Table 36-2.
36-3
Configuring Trace
Table 36-2 User Mask Bits
Service Cisco CallManager
Mask Bits 0 1 2 3 4 5 6 7 8 9 10
Type of Trace Enabled by This Bit Protocol Layer 1 information. Protocol Layer 2 information. Digital gateway information. Analog gateway information. Primary Rate Interface (PRI) information. Skinny Station protocol information. Message translation information for ISDN messages. Media Termination Point (MTP) information. H.225 and gatekeeper information. Gateway traces (used in conjunction with bits 2, 3, and 4) Detailed debugging information.
Note
Do not set this flag during normal system operation.
11 12 13 14-15
Subsystem information not covered by one of the other user mask bits. Conference bridge information. MGCP gateway information. Not used.
36-4
OL-1047-01
Chapter 36
Table 36-2 User Mask Bits (continued)
Service Cisco Database Layer Monitor
Mask Bits 0 1 2
Type of Trace Enabled by This Bit Detailed database information such as SQL statements. Detailed information about the business rules. Information about DBLX.dll relating to the web administration pages and Visual Basic applications. Tracing this information from web administration requires that you enable the debug settings on IISAdmin service and the web service from the IIS Management console. After enabling this bit, you must stop and restart all applications that use this DLL before tracing will begin. Information about database change notification messages. Not used. Information about DBL.dll relating to any application programs that access the database. After enabling this bit, you must stop and restart all applications that use this DLL before tracing will begin. Information about all code in the database. Not used. Application initialization information. Service and database manager information. Media Termination Point (MTP) device information. Conference bridge device information. MTP and conference bridge device recovery information. Device driver information. Message information from Skinny Station protocol. High-level WinSock information. Not used. Low-level WinSock information. Not used. Not used.
3 4-7 8
9 10-15 Cisco IP Voice Media Streaming Application 0 1 2 3 4 5 6 7 8 9 10-15 Cisco Messaging Interface (CMI) 0-15
36-5
Configuring Trace
Table 36-2 User Mask Bits (continued)
Service Cisco Trivial File Transfer Protocol (TFTP)
Mask Bits 0
Type of Trace Enabled by This Bit All TFTP event information. 0 = System 1 = Build files 2 = Server files
1-15
Not used.
Event Level
The Event level applies only to Error traces, and it specifies what types of Error events are traced. The following list gives available event levels:

Debug Information Notice Warning Error Critical Alert Emergency
The Emergency event level traces only the most severe Error events, and it provides the least amount of trace information. The Debug event level provides trace information on all types of events, including events that occur during normal system operation. The event levels between Emergency and Debug provide increasingly greater amounts of trace information. For traces during normal system use, choose an event level between Error (minimum) and Debug (maximum).
36-6
OL-1047-01
Chapter 36
Components
The trace log components let you specify where the trace information is collected or stored.
Caution
Creating a large number of trace files, or letting a single trace file grow too large, can severely degrade the performance of your system.
Warning
Do not modify the trace parameters in any way unless directed to do so by Cisco Technical Assistance Center (TAC).
Table 36-3 describes the trace log components.

Table 36-3 Trace Log Components
Component EventLog
Parameter TraceEvent
Default Value T
Description Enable this option to send trace information to the Windows 2000 EventLog. This option is for Cisco Development use only.
Output Debug String
TraceOutputDebugStri T ng
Note
Do not enable this option unless instructed to do so by Cisco Technical Assistance Center (TAC).
File
Enable this option to store trace information in a file. You can also set the following file parameters:
36-7
Configuring Trace
Table 36-3 Trace Log Components (continued)
Component
Parameter TraceFile
Default Value
Description
c:\Program Each service requires a unique trace file Files\Cisco\Trace\ name, as the fully qualified path name CCM\ccm.txt of the trace file.
Note
Cisco recommends that you leave the file names set to their default values.
TraceNumFiles
250
This parameter specifies the total number of trace files for a given service. A sequence number automatically appended to the file name indicates which file it is. When the last file in the sequence is full, the trace data begins writing over the first file again. This parameter specifies the maximum number of lines of data stored in each trace file. This parameter specifies the maximum number of minutes of data stored in each trace file.
TraceFileNumLines
10000
TraceFileNumMinutes
1440
Note
When the trace data exceeds either the maximum number of lines or the maximum number of minutes for one file, Cisco CallManager closes that file, and the remaining trace data is written to the next file in the sequence. For example, you can set up trace files to store a full week of data, with one day of data in each file. To do this, you can set the number of files to 7, the number of minutes to 1440 (one day), and number of lines to a large value such as 10000.
36-8
OL-1047-01
Chapter 36
Table 36-3 Trace Log Components (continued)
Component System Log
Parameter TraceSyslog
Default Value T
Description Enable this option to send trace information to the Cisco Syslog Collector. Debug Enabling causes all trace data to be sent to the Cisco Syslog Collector. If you do not enable this option, only alarm (Error) traces are sent to the Cisco Syslog Collector. System Server designates the name of the Cisco Syslog Collector.
TraceSyslogDebug
TraceSyslogServer
Note
Do not change this field unless instructed to do so by Cisco Technical Assistance Center (TAC).
Table 36-4 provides the trace parameters for Event Type, User Mask, and Date and Time
36-9
Chapter 36 Recommended Trace Settings
Configuring Trace
Warning
Do not modify any trace parameters unless directed to do so by Cisco Technical Assistance Center (TAC).
Table 36-4 Trace Parameters for Event Type, User Mask, and Date and Time
Parameter TraceEventLevel
Default Value 469762048
Description The event type applies only to traces at the Error level and specifies what types of the following error events are traced: Debug, Information, and Notice. The user mask, a series of flags or bits, enables and disables specific types of trace information. The Show Date option records the date of each trace event.
TraceMask
4144124
TraceShowTime
The Show Time option records the time of each trace event.
Note
The TraceOn parameter determines whether trace is enabled. The default value is T.
Recommended Trace Settings

In general, start with a small amount of tracing, so that system resources are not overloaded by the trace data. If the initial traces are not sufficient for your purposes, you can gradually increase the level of tracing until you get the desired data. If system performance begins to degrade during tracing, decrease the trace level until the performance returns to normal. During normal system operation, trace alarm conditions and respond to them as quickly as possible. Alarm tracing is the minimum level of tracing for a fully operational system. To configure this minimum level of alarm tracing, set the trace parameters as follows for each service on each Cisco CallManager in the cluster:
36-10
OL-1047-01
Chapter 36
Configuring Trace Adding a New Service and Trace Configuration
Enable the Trace On check box. Set the level type to Error. Enable the Show Time check box. Enable the appropriate user mask bits for each service, as described in Table 36-2. Set the event level to Error. Enable the EventLog check box.
Adding a New Service and Trace Configuration

Warning
Cisco recommends that you do not use this procedure unless specifically directed to do so by the Cisco Technical Assistance Center (TAC).
This section describes how to add a new service and trace configuration to the Cisco CallManager database. Normally, you do not have to use this procedure because each service receives a default trace configuration when you install the Cisco CallManager software. You can then modify this default trace configuration by following the procedure described in the Updating a Trace Configuration section on page 36-13. You can also add a new service and trace configuration before installing an additional (subscriber) Cisco CallManager in a cluster. If you then install a Cisco CallManager with the same name specified in the new trace configuration, that trace configuration becomes the default for the specified service on the specified Cisco CallManager.
36-11
Chapter 36 Adding a New Service and Trace Configuration
Configuring Trace
Procedure
Open Cisco CallManager Administration. Choose Service > Trace. From the list of IP addresses or DNS names at the left of the screen, choose the server whose trace parameters you want to configure.
Note
The Configured Services list contains all the services that are configured for this server.
Step 4 Step 5
Click New to create a trace configuration for a new service. From the Service Type drop-down list box, choose the service for which you want to add a trace configuration; then, click Insert.
Note
You can only add services that are not already configured for this Cisco CallManager server.
Click Trace On to enable trace. Choose the desired trace level. For details, see the Trace Levels section on page 36-2. If desired, enable the Show Time and Show Date options to record the time and date of each event. Cisco recommends that you enable the Show Time option. Set the appropriate user mask bits for the service, For details, see the User Mask section on page 36-3. Choose the desired event level. For details, see the Event Level section on page 36-6. Set the desired trace log components. For details, see the Components section on page 36-7.
36-12
OL-1047-01
Chapter 36
Configuring Trace Updating a Trace Configuration
Step 12
If you want to reset all trace parameters to their previous values, click Cancel. If you want to reset all trace parameters to their initial default values, click SetDefault. When you are finished setting the trace parameters, click Update to save the changes in the database.
Step 13
Updating a Trace Configuration

This section describes how to update an existing trace configuration for a service.
Procedure
Open Cisco CallManager Administration. Choose Service > Trace. From the list of IP addresses or DNS names at the left of the screen, choose the server whose trace configuration you want to update. From the list of Configured Services, choose the service whose trace configuration you want to update. Make the desired changes in the fields you want to update. Before saving the changes, you can click Cancel to reset all fields to their previous value or click SetDefault to reset all fields to their default value. Click Update to save the changes in the database.
Step 6
36-13
Chapter 36 Deleting a Trace Configuration
Configuring Trace
Deleting a Trace Configuration

Warning
This section describes how to delete a trace configuration.

Procedure
Open Cisco CallManager Administration. Choose Service > Trace. From the list of IP addresses at the left of the screen, choose the IP address of the Cisco CallManager server whose trace configuration you want to delete. From the list of Configured Services, choose the service whose trace configuration you want to delete. Click Delete to delete the trace configuration for this service. If you want to delete all trace services for the chosen Cisco CallManager, click Delete Service.
Caution
Turning off all trace services also disables Simple Network Management Protocol (SNMP). When asked to confirm the delete operation, click either OK to delete or Cancel to cancel the delete operation.
Step 6
36-14
OL-1047-01
Chapter 36
Configuring Trace Deleting a Service
Deleting a Service
Warning
This section describes how to delete a service from the Cisco CallManager database.
Procedure
Open Cisco CallManager Administration. Choose Service > Trace. From the list of IP addresses at the left of the screen, choose the IP address of the Cisco CallManager server from which you want to delete a service. Choose the service you wish to delete from the Configured Services list. Click Delete Service. A message displays stating that you are about to permanently delete this service and that the action cannot be undone. Click OK if you want to continue the deletion or Cancel to cancel the operation.
36-15
Chapter 36 Deleting a Service
Configuring Trace
36-16
OL-1047-01
C H A P T E R
37
A transcoder is a device that takes the output stream of one codec and transcodes (converts) it from one compression type to another compression type. For example, it could take an output stream from a G.711 codec and transcode (convert) it in real time to a G.729 input stream accepted by a G.729 codec. Transcoders for this Cisco CallManager release transcode between G.711, G.723, and G.729 codecs. In addition, a transcoder provides MTP capabilities, and may be used to enable supplementary services for H.323 endpoints when required. The Cisco CallManager invokes a transcoder on behalf of endpoint devices when the two devices are using different codecs, and would normally not be able to communicate. When inserted into a call, the transcoder converts the data streams between the two disparate codecs in order to enable communications between them. A transcoder requires specific hardware in order to run. The same hardware can support Conference Bridges, transcoders, or PRI interfaces. When configured as a transcoder, this hardware provides a designated number of streaming mechanisms, each of which is capable of transcoding data streams between disparate codecs, and enabling supplementary services, if required, for calls to H.323 endpoints. The transcoder registers with its specified primary Cisco CallManager, and informs that Cisco CallManager how many transcoder resources are supported.
Note
MTPs are capable of enabling supplementary services for H.323 endpoints, but they cannot transcode data streams. You cannot have both transcoders and MTPs registered with the same Cisco CallManager at the same time.
37-1
Chapter 37
Each transcoder attempts to register with a given a list of Cisco CallManagers that are arranged in priority order. The first Cisco CallManager in the list is the primary (or publisher) Cisco CallManager. If the primary Cisco CallManager fails, it attempts to register with the next available Cisco CallManager in the list. Each transcoder can register with only one Cisco CallManager at a time. The transcoder always registers with its primary Cisco CallManager and, after a failure, it re-registers with the primary Cisco CallManager. The system may have multiple transcoders, each of which is registered to the same Cisco CallManager, or each of them may be registered to a different Cisco CallManager as desired, depending on how your system is configured. Multiple transcoders may be registered with the same Cisco CallManager; however, when more than one transcoder is registered with a given Cisco CallManager, that Cisco CallManager controls the set of resources for each of the transcoders. The transcoders may be distributed across a networked system as desired. For example, transcoder 1 is configured for 16 transcoder resources. Transcoder 2 is also configured for 16 transcoder resources. If both transcoders register with the same Cisco CallManager, that Cisco CallManager maintains both sets of resources for a total of 32 registered transcoder resources. When the Cisco CallManager determines that the two endpoints of a call are using disparate codecs and cannot communicate directly, it inserts a transcoder into the call to transcode the datastreams between them. The transcoder is not visible to either the user or the endpoints involved in a call. Transcoder resources are always allocated from the registered transcoder that has the most available resources. The Cisco CallManager also uses transcoder resources as MTPs to enable supplementary services for H.323 endpoints when required. In this capacity, when the Cisco CallManager determines that an endpoint in a call requires an MTP, it allocates a transcoder resource, and inserts it into the call, where it acts like a normal MTP. The transcoder is invisible to both the users of the system, and the endpoint on whose behalf it was inserted. If a transcoder resource is not available when it is needed, the call is connected without using a transcoder resource, and supplementary services are not available on that call.
37-2
OL-1047-01
Chapter 37
Configuring Transcoder Configuring a Transcoder
Related Topics

Configuring Media Termination Point, page 34-1 Configuring Conference Bridges, page 33-1 Configuring a Transcoder, page 37-3 Updating a Transcoder, page 37-4 Copying a Transcoder, page 37-5 Deleting a Transcoder, page 37-6
Configuring a Transcoder
This section describes how to configure a Transcoder.
Procedure
Open Cisco CallManager Administration. Click Service > Transcoder. Enter a MAC address (must be at least 12 characters) in the MAC Address field. The Description field is automatically generated from the MAC address you provide.
Select a device pool from the drop-down list box or choose Default in the Device Pool field. Enter any special load information into the Special Load Information field, or leave blank to use default. Once youve chosen the device pool, click View Details for more detailed information on the selected device pool. Click Insert. The page refreshes showing specific information, including the status, for the transcoder you just configured. The transcoder should now appear in the list on the left side of the page.
37-3
Chapter 37 Updating a Transcoder
Related Topics

Configuring Transcoder, page 37-1 Configuring Media Termination Point, page 34-1 Configuring Conference Bridges, page 33-1 Updating a Transcoder, page 37-4 Copying a Transcoder, page 37-5 Deleting a Transcoder, page 37-6
Updating a Transcoder
This section describes how to update a transcoder.
Procedure
Open Cisco CallManager Administration. Click Service > Transcoder. Select the transcoder you want to update from the list on the left side of the page. The page refreshes displaying the transcoder you selected. Make the desired changes to the transcoder and click Update. A message displays stating that the transcoder must be reset before the changes will take effect. Click OK. The page refreshes again, showing the updated transcoder.
Step 6
Click Reset and follow the instructions in the Reset Device dialog box.
Related Topics

Configuring Transcoder, page 37-1 Configuring Media Termination Point, page 34-1 Configuring Conference Bridges, page 33-1 Configuring a Transcoder, page 37-3
37-4
OL-1047-01
Chapter 37
Configuring Transcoder Copying a Transcoder
Copying a Transcoder, page 37-5 Deleting a Transcoder, page 37-6
Copying a Transcoder
This section describes how to copy a transcoder.
Procedure
Open Cisco CallManager Administration. Click Service > Transcoder. Select the transcoder you want to copy from the list on the left side of the page. The page refreshes displaying the transcoder you selected. Click Copy. The page refreshes again and displays the transcoder with a Copy of... name in the Current Transcoder field. Make appropriate changes to customize the new transcoder and click Insert. The screen refreshes and the new transcoder appears in the transcoder list on the left side of the page.
Step 6
To build another transcoder that is similar to the current transcoder, click Copy, and repeat steps 1 through 5.
Related Topics

Configuring Transcoder, page 37-1 Configuring Media Termination Point, page 34-1 Configuring Conference Bridges, page 33-1 Configuring a Transcoder, page 37-3 Updating a Transcoder, page 37-4 Deleting a Transcoder, page 37-6
37-5
Chapter 37 Deleting a Transcoder
Deleting a Transcoder
This section describes how to delete a transcoder.
Procedure
Open Cisco CallManager Administration. Click Service > Transcoder. Select the transcoder you want to delete from the list on the left side of the page. The page refreshes, displaying the transcoder you selected. Click Delete. A message displays stating that you are about to permanently delete this transcoder and that this action cannot be undone. Click OK if you want to continue or Cancel to cancel the deletion. When the page is refreshed, the transcoder you deleted should no longer appear in the transcoder list.
Related Topics

Configuring Transcoder, page 37-1 Configuring Media Termination Point, page 34-1 Configuring Conference Bridges, page 33-1 Configuring a Transcoder, page 37-3 Updating a Transcoder, page 37-4 Copying a Transcoder, page 37-5
37-6
OL-1047-01
C H A P T E R
38
Starting and Stopping Services Using the Control Center

Control Center for the Cisco CallManager (release 3.0 and later) is the web page used for viewing status and starting and stopping the Cisco CallManager and other services. You can view service status or start and stop any of the configured services for a particular Cisco CallManager server. An All Servers option is provided so that you can view service status or start and stop selected services for all Cisco CallManagers in a cluster. Starting and stopping a Cisco CallManager causes all Cisco IP Phones and gateways currently registered to that Cisco CallManager to fail over to their secondary Cisco CallManager. Devices and phones will only need to restart if they can not register with another Cisco CallManager. Starting and stopping Cisco CallManager also causes all other installed applications that are homed to that Cisco CallManager, such as Conference Bridge and Cisco Messaging Interface, to start or stop as well.
Note
Stopping Cisco CallManager also stops call processing for all devices controlled by that Cisco CallManager. When a Cisco CallManager is stopped, calls from an IP phone to another IP phone will stay up; calls in progress from an IP phone to an MGCP gateway will also stay up; and any other type of calls will be dropped.
38-1
Chapter 38 Starting and Stopping Services on a Single Server
Related Topics

Starting and Stopping Services on a Single Server, page 38-2 Selecting Services to Start and Stop for All Servers, page 38-3
Starting and Stopping Services on a Single Server

Use the following procedure to view service status or start and stop services on a particular Cisco CallManager server.
Procedure
Note
In order for this procedure to work on all servers in a network, you must be logged in with Administration privileges. The User ID and password you use to log in must be identical on all servers, and the User ID must also have Administration privileges on all servers.
Open Cisco CallManager Administration. Click Service > Control Center. Select a server from the server list on the left side of the page. The page updates to display Service Status and Service Control buttons for all services that are configured on the selected server. The Service Status icons have the following meaning:

SquareStopped. ArrowRunning. Question markUnknown status.
Step 4 Step 5
In the Service Control column, click the Start or Stop button next to the service you want to start or stop. Repeat Steps 1 through 4 to start or stop services on other servers.
38-2
OL-1047-01
Chapter 38
Starting and Stopping Services Using the Control Center Selecting Services to Start and Stop for All Servers
Related Topics

Selecting Services to Start and Stop for All Servers, page 38-3 Starting and Stopping Services Using the Control Center, page 38-1
Selecting Services to Start and Stop for All Servers

Use the following procedure to select services you want to start or stop from a list of all Cisco CallManagers in a cluster.
Procedure
Note
In order for this procedure to work on all servers in a network, you must be logged in with Administration privileges. The User ID and password you use to log in must be identical on all servers, and the User ID must also have Administration privileges on all servers.
Open Cisco CallManager Administration. Click Service > Control Center. Select All Servers from the server list on the left side of the page (it is the first item in the list). The page refreshes and displays a list of all Cisco CallManagers in the cluster.
Step 4
Select the services for which you want to start, stop, or view status:

To select all services, click Select All and Refresh the List. To select a particular services or group of services, check only the services you want to display, then click Refresh the List.
The page updates to display Service Status and Service Control buttons for the selected services for each Cisco CallManager in the list. The Service Status icons have the following meaning:

SquareStopped. ArrowRunning. Question markUnknown status.
38-3
Chapter 38 Selecting Services to Start and Stop for All Servers
Step 5
Click the Start or Stop button next to the services you wish to start or stop for each server in the list.
Related Topics

Starting and Stopping Services on a Single Server, page 38-2 Starting and Stopping Services Using the Control Center, page 38-1
38-4
OL-1047-01
A R T
Feature Configuration
The following chapters include information on configuring user features: Chapter 39, Configuring Call Park Chapter 40, Configuring Call Pickup Chapter 41, Configuring Cisco IP Phone Services
C H A P T E R
39

Call park allows you to place a call on hold so that it can be retrieved from another phone in the system. For example, if you are on an active call at your phone, you can park the call to a call park extension such as 1234. Someone on another phone in your system can then dial 1234 to retrieve the call. You can define either a single directory number or a range of directory numbers for use as call park extension numbers. You can park only one call at each call park extension number. Use the following procedures to add, update, or delete a call park extension:

Adding a Call Park Number, page 39-2 Updating a Call Park Number, page 39-3 Deleting a Call Park Number, page 39-4
39-1
Chapter 39 Adding a Call Park Number
Adding a Call Park Number

This section describes how to add a single call park extension number or range of extension numbers.
Procedure
Open Cisco CallManager Administration. Select Feature > Call Park. Enter the call park extension number. You can enter literal digits or the wildcard character X. For example, enter 5555 to define a single call park extension number of 5555, or enter 55XX to define a range of call park extension numbers from 5500 to 5599.
Note
You can create a maximum of 100 call park numbers with one call park range definition.
Step 4
If you want to use a route partition to restrict access to the call park numbers, select the desired route partition from the drop-down list box. If you do not want to restrict access to the call park numbers, select None for the route partition.
Note
The combination of call park extension number and route partition must be unique within the Cisco CallManager cluster.
Step 5
Using the drop-down list box, select the Cisco CallManager to which these call park numbers apply.
Note
Each Cisco CallManager in a cluster requires its own unique call park numbers.
39-2
OL-1047-01
Chapter 39
Configuring Call Park Updating a Call Park Number
Step 6
Click Insert to save the new call park numbers in the database. The call park number you added should appear in the list on the left side of the page.
Related Topics

Clusters, page 2-1 Configuring Call Park, page 39-1 Adding a Cisco CallManager, page 12-1 Updating a Call Park Number, page 39-3 Deleting a Call Park Number, page 39-4
Updating a Call Park Number

This section describes how to update a call park extension number or range of numbers.
Procedure
Open Cisco CallManager Administration. Select Feature > Call Park. Select the call park number or range of numbers you want to update from the call park list. Make the desired changes in the fields you want to update.
Note
Before saving the changes, you can click Cancel to reset all fields to their original values.
Step 5
Click Update to save the changes in the database.
39-3
Chapter 39 Deleting a Call Park Number
Related Topics

Configuring Call Park, page 39-1 Adding a Call Park Number, page 39-2 Deleting a Call Park Number, page 39-4
Deleting a Call Park Number

This section describes how to delete call park numbers from the Cisco CallManager database.
Procedure
Open Cisco CallManager Administration. Select Feature > Call Park. Select the call park number or range of numbers you want to delete from the call park list. Click Delete.
Related Topics

Configuring Call Park, page 39-1 Adding a Call Park Number, page 39-2 Updating a Call Park Number, page 39-3
39-4
OL-1047-01
C H A P T E R
40

Call pickup allows you to answer a call that comes in on a directory number other than your own. When you hear an incoming call ringing on another phone, you can redirect the call to your phone by using the call pickup feature. There are two types of call pickup available on Cisco IP Phones:
Call Pickup allows users to pick up incoming calls within their own group. The appropriate call pickup group number is dialed automatically when a user activates this feature. Group Call Pickup allows users to pick up incoming calls within their own group or in other groups. Users must dial the appropriate call pickup group number when using this feature.
The procedures are the same for configuring both of these features, and they are described in:
Configuring Call Pickup, page 40-2
40-1
Chapter 40 Configuring Call Pickup

This section describes the general steps for configuring the call pickup feature. Subsequent sections of this chapter describe the steps in more detail.
Procedure
Step 1 Step 2
Create a call pickup group number. For details, see the Adding a Call Pickup Group Number section on page 40-2. Assign the desired directory numbers to a call pickup group by using the call pickup group number you created in Step 1. For details, see the Assigning Directory Numbers to a Call Pickup Group section on page 40-5. Add a Call Pickup or Group Call Pickup button to the phone templates where needed. For details, see the Modifying Phone Button Templates, page 47-9.
Step 3
Related Topics

Configuring Call Pickup, page 40-1 Adding a Call Pickup Group Number, page 40-2 Updating a Call Pickup Group Number, page 40-3 Deleting a Call Pickup Group Number, page 40-4 Assigning Directory Numbers to a Call Pickup Group, page 40-5
Adding a Call Pickup Group Number

This section describes how to add a call pickup group number to the Cisco CallManager database.
Procedure
Open Cisco CallManager Administration. Select Feature > Call Pickup. Enter the directory number for the call pickup group you want to add.
40-2
OL-1047-01
Chapter 40
Configuring Call Pickup Configuring Call Pickup
Step 4
If you want to use a route partition to restrict access to the call pickup group, select the desired route partition from the drop-down list box. If you do not want to restrict access to the call pickup group, select None for the route partition.
Note
The combination of call pickup group number and route partition must be unique within the Cisco CallManager cluster.
Step 5
Click Insert to save the new call pickup group number in the database.
Related Topics

Clusters, page 2-1 Configuring Call Pickup, page 40-1 Updating a Call Pickup Group Number, page 40-3 Deleting a Call Pickup Group Number, page 40-4 Assigning Directory Numbers to a Call Pickup Group, page 40-5
Updating a Call Pickup Group Number

This section describes how to update a call pickup group number.
Procedure
Open Cisco CallManager Administration. Select Feature > Call Pickup. Select the call pickup group number you want to update. Make the desired changes in the fields you want to update. Before saving the changes, you can click Cancel to reset all fields to their original value. Click Update to save the changes in the database.
40-3
When you update a call pickup group number, it is automatically updated for all directory numbers assigned to that call pickup group.
Related Topics

Configuring Call Pickup, page 40-1 Adding a Call Pickup Group Number, page 40-2 Deleting a Call Pickup Group Number, page 40-4 Assigning Directory Numbers to a Call Pickup Group, page 40-5
Deleting a Call Pickup Group Number

This section describes how to delete a call pickup group number from the Cisco CallManager database.
Caution
When you delete a call pickup group number, you disable the Call Pickup feature for all directory numbers assigned to that group. To enable Call Pickup again for those directory numbers, you must reassign each of them to a new call pickup group. For details, see the Assigning Directory Numbers to a Call Pickup Group section on page 40-5.
Procedure
Open Cisco CallManager Administration. Select Feature > Call Pickup. Select the call pickup group number you want to delete. Click Delete. The call pickup group is now removed from the list on the left side of the page.
Related Topics

Configuring Call Pickup, page 40-1 Adding a Call Pickup Group Number, page 40-2
40-4
OL-1047-01
Chapter 40
Configuring Call Pickup Configuring Call Pickup
Updating a Call Pickup Group Number, page 40-3 Assigning Directory Numbers to a Call Pickup Group, page 40-5
Assigning Directory Numbers to a Call Pickup Group

This section describes how to assign directory numbers to a call pickup group. Only directory numbers assigned to a call pickup group can use the Call Pickup feature.
Before You Begin
Before you can assign a directory number to a call pickup group, you must create a number for that group as described in:
Adding a Call Pickup Group Number, page 40-2
Procedure
Open Cisco CallManager Administration. Select Device > Phone. Use the search capability to find a directory number that you want to assign to a call pickup group. Select the desired directory number to display the configuration information for the phone where that number appears. Select the line where the desired directory number appears. Select the desired call pickup group number from the Call Pickup Group drop-down list box. Repeat Step 2 through Step 6 for each directory number you want to assign to the call pickup group.
Related Topics

Configuring Call Pickup, page 40-1 Adding a Call Pickup Group Number, page 40-2
40-5
Updating a Call Pickup Group Number, page 40-3 Deleting a Call Pickup Group Number, page 40-4
40-6
OL-1047-01
C H A P T E R
41
Configuring Cisco IP Phone Services

The Cisco IP Phone Services Configuration area of Cisco CallManager Administration is where system administrators define and maintain the list of Cisco IP Phone Services to which users can subscribe at their site. Cisco IP Phone services are XML applications that enable interactive content with text and graphics to be displayed on Cisco IP Phones.
Note
Currently, only Cisco IP Phone 7960 and 7940 model phones support Cisco IP Phone services. Once the list of services is configured, users can log on to the Cisco CallManager user preferences pages and subscribe to these services for their Cisco IP Phones. Cisco CallManager (Release 3.0(5) or later) provides sample Cisco IP Phone services applications. You can also create customized Cisco IP Phone applications for your site. This section covers the following topics:

Understanding Cisco IP Phone Services, page 41-2 Adding a Cisco IP Phone Service, page 41-3 Adding a Cisco IP Phone Service Parameter, page 41-5 Updating a Cisco IP Phone Service, page 41-6 Deleting a Cisco IP Phone Service, page 41-7
41-1
Chapter 41 Understanding Cisco IP Phone Services
Updating a Cisco IP Phone Service Parameter, page 41-8 Deleting a Cisco IP Phone Service Parameter, page 41-9
Understanding Cisco IP Phone Services

Cisco IP Phone Services are XML applications that enable interactive content with text and graphics to be displayed on Cisco IP Phones. The Cisco IP Phone model 7960 and 7940 telephones have a button labeled services. When the user presses this button, the phone uses its HTTP client to load a specific URL that contains a menu of services to which the user has subscribed for their phone. The user then selects a service from the listing. When a service is selected from the menu, the URL is requested via HTTP, and a server provides the content, which then updates the phone's display. Typical services that might be supplied to a phone include weather information, stock quotes, and news quotes. Cisco IP Phone Services are deployed using the HTTP protocol from standard web servers, such as Microsoft's Internet Information Service (IIS). Only services configured through Cisco CallManager Administration are available for user subscription. The following information is configured for each service:

URL of the server that provides the content Service name and description, which help end users browsing the system A list of parameters that are appended to the URL when it is sent to the server These are used to personalize a service for an individual user. Examples of parameters include stock ticker symbols, city names, zip codes, or user IDs.
After the system administrator configures the services, users can log on to the Cisco CallManager user preferences pages and subscribe to services. From the user preferences pages, users can

Customize the name of the service as it is displayed on their services list Enter any service parameters available for the selected phone service Review the description of each phone service parameter Subscribe to that service on their phone (Subscriptions are made on a per-device basis.)
41-2
OL-1047-01
Chapter 41
Configuring Cisco IP Phone Services Adding a Cisco IP Phone Service
When the user clicks the Subscribe button, a custom URL is built and stored in the database for this subscription. The service then appears on the devices services list.
Adding a Cisco IP Phone Service

Perform the following steps to add a Cisco IP Phone Service.
Caution
Do not put Cisco IP Phone services on any Cisco CallManager server at your site or any server associated with Cisco CallManager, such as the TFTP server or directory database publisher server. This precaution eliminates the possibility of errors in a Cisco IP Phone Service application having an impact on Cisco CallManager performance or interrupting call processing services.
Procedure
Open Cisco CallManager Administration. Select Features > Cisco IP Phone Services. Click New. Enter configuration settings for the new service, as described in Table 41-1.
Table 41-1 Cisco IP Phone Service Configuration Settings
Field Service Name Service Description
Description Name of the service as it will display on the menu of available services on the user preferences pages. Description of the content provided by the service.
41-3
Chapter 41 Adding a Cisco IP Phone Service
Table 41-1 Cisco IP Phone Service Configuration Settings (continued)
Field Service URL
Description URL to the server where the Cisco IP Phone Services application is located. This server must be independent of the servers in your Cisco CallManager cluster. Do not specify a Cisco CallManager server or any server associated with Cisco CallManager (such as a TFTP server or directory database publisher server). For the services to be available, the phones in the Cisco CallManager cluster must have network connectivity to the server. For example:
http://<Server>/ccmuser/sample/sample.asp
Where <Server> is a fully qualified domain name or an IP address.

Step 5
Click Update to add the service. Once the service is added to the list, you can add and configure parameters for the service. Refer to the Adding a Cisco IP Phone Service Parameter section on page 41-5.
Related Topics

Deleting a Cisco IP Phone Service, page 41-7 Updating a Cisco IP Phone Service, page 41-6 Adding a Cisco IP Phone Service Parameter, page 41-5
41-4
OL-1047-01
Chapter 41
Configuring Cisco IP Phone Services Adding a Cisco IP Phone Service Parameter
Adding a Cisco IP Phone Service Parameter

Use the following procedure to add and configure Cisco IP Phone service parameters. Before you can configure parameters, the phone service must already have been added. Parameter definitions are optional. Refer to the documentation for the individual Cisco IP Phone service for specific information about whether the service uses parameters and how those parameters should be configured.
Procedure
Log in to Cisco CallManager Administration. Select Features > Cisco IP Phone Services. Select the service to which you wish to add parameters from the list of Cisco IP Phone services on the left side of the page. Click the New button to the right of the Service Parameter Information list box to open the Cisco IP Phone Service Parameter Configuration dialog. Configure the phone service parameter settings as described in Table 41-2.
Table 41-2 Cisco IP Phone Service Parameter Configuration Settings
Field Parameter Name Parameter Display Name Default Value
Description The exact query string parameter to use when building the subscription URL. Descriptive parameter name to display to the user on the user preferences page. Default value for the parameter. This value will display to the user when a service is being subscribed to for the first time. Check the Parameter is Required box if the user must enter data for this parameter before the subscription can be saved. The text entered here will be available to the user while they are subscribing to the service. The parameter description should provide information or examples to help users input the correct value for the parameter.
Parameter is Required Parameter Description
41-5
Chapter 41 Updating a Cisco IP Phone Service
Click Insert to add the new parameter. Repeat Steps 4 through 6 to add additional parameters, if needed. Click Insert and Close to add the last parameter.
Updating a Cisco IP Phone Service

Perform the following steps to update a Cisco IP Phone service (for example, to change the service URL or other information).
Note
If you change the service URL, remove a Cisco IP Phone service parameter, or change the Parameter Name of a phone service parameter for a phone service to which users are already subscribed, be sure to click Update Subscriptions to update all currently subscribed users with the changes. If you do not do so, users must re-subscribe to the service to rebuild the URL correctly.
Procedure
Open Cisco CallManager Administration. Click Features > IP Phone Services. Select the Cisco IP Phone Service you wish to update from the list of Cisco IP Phone services on the left side of the page. Make the desired changes to the configuration settings. Refer to Table 41-1 for information about configuration settings. Add, update, or delete parameters as needed. Refer to the Adding a Cisco IP Phone Service section on page 41-3, Updating a Cisco IP Phone Service Parameter section on page 41-8, and Deleting a Cisco IP Phone Service Parameter section on page 41-9 for more information.
41-6
OL-1047-01
Chapter 41
Configuring Cisco IP Phone Services Deleting a Cisco IP Phone Service
Step 6
Update the Cisco IP Phone Services Configuration pages to apply the changes:
Click Update Subscriptions to rebuild all user subscriptions if the service was modified after subscriptions existed. You must update subscriptions if you have changed the service URL, removed a phone service parameter, or changed the Parameter Name for a phone service parameter. Click Update if the service is new and you do not need to rebuild user subscriptions.
Related Topics

Adding a Cisco IP Phone Service, page 41-3 Deleting a Cisco IP Phone Service, page 41-7
Deleting a Cisco IP Phone Service

Perform the following steps to update a Cisco IP Phone service.
Note
When you delete a Cisco IP Phone subscription, all service information, user subscriptions, and user subscription data are removed from the database.
Procedure
Log in to Cisco CallManager Administration. Select Features > Cisco IP Phone Services. Select the name of the Cisco IP Phone service you wish to delete from the list of Cisco IP Phone services on the left side of the page. Click Delete.
41-7
Chapter 41 Updating a Cisco IP Phone Service Parameter
Related Topics

Updating a Cisco IP Phone Service, page 41-6 Adding a Cisco IP Phone Service, page 41-3
Updating a Cisco IP Phone Service Parameter

Perform the following steps to update a service parameter for a specific Cisco IP Phone service.
Note
If you remove a Cisco IP Phone service parameter or change the Parameter Name of a phone service parameter for a phone service to which users are already subscribed, be sure to click Update Subscriptions to update all currently subscribed users with the changes. If you do not do so, users must re-subscribe to the service to rebuild the URL correctly.
Procedure
Log in to Cisco CallManager Administration. Select Features > Cisco IP Phone Services. Select the phone service you wish to update from the list of Cisco IP Phone services on the left side of the page. Click on the name of the parameter you wish to update in the Parameters list box under Service Parameter Information. Click Edit. Make the desired changes to the parameter settings. Refer to Table 41-2 for information about service parameter configuration settings. Click Update to apply the changes, or click Update and Close to apply the changes and close the dialog.
41-8
OL-1047-01
Chapter 41
Configuring Cisco IP Phone Services Deleting a Cisco IP Phone Service Parameter
Step 8
Update the Cisco IP Phone Services Configuration page to apply the changes:
Click Update Subscriptions to rebuild all user subscriptions if the service was modified after subscriptions existed. You must update subscriptions if you changed the service URL, removed a phone service parameter, or changed the Parameter Name for a phone service parameter. Click Update if the service is new and you do not need to rebuild user subscriptions.
Related Topics

Updating a Cisco IP Phone Service, page 41-6 Deleting a Cisco IP Phone Service Parameter, page 41-9
Deleting a Cisco IP Phone Service Parameter

Perform the following steps to delete a Cisco IP Phone service.
Note
If you remove a phone service parameter or modify the Parameter Name of a phone service parameter for a phone service to which users are already subscribed, you must click Update Subscriptions to update all currently subscribed users with the changes. If you do not do so, users must re-subscribe to the service to rebuild the URL correctly.
Procedure
Open Cisco CallManager Administration. Click Features > Cisco IP Phone Services. Select the phone service whose parameters you wish to delete from the list of Cisco IP Phone services on the left side of the page. Click on the name of the parameter you wish to delete in the Parameters list box under Service Parameter Information. Click Delete.
OL-1047-01
41-9
Chapter 41 Deleting a Cisco IP Phone Service Parameter
Step 6 Step 7
Click OK to confirm the deletion. Update the Cisco IP Phone Services Configuration page to apply the changes:
Click Update Subscriptions to rebuild all user subscriptions if the service was modified after subscriptions existed. You must update subscriptions if you changed the service URL, removed a phone service parameter, or changed the Parameter Name for a phone service parameter. Click Update if the service is new and you do not need to rebuild user subscriptions.
Related Topics

Updating a Cisco IP Phone Service Parameter, page 41-8 Adding a Cisco IP Phone Service Parameter, page 41-5
41-10
OL-1047-01
A R T
Configuring Devices in Cisco CallManager
The following chapters include information on configuring devices in Cisco CallManager: Chapter 42, Configuring CTI Route Points Chapter 43, Configuring Cisco uOne Voice Messaging Chapter 44, Configuring a Gatekeeper Chapter 45, Configuring Gateways Chapter 46, Configuring Cisco IP Phones in Cisco CallManager Chapter 47, Configuring Phone Button Templates
C H A P T E R
42
Configuring CTI Route Points

A Cisco Telephony Integration (CTI) route point is a virtual device that can receive multiple simultaneous calls for application-controlled redirection. For first-party call control, you must add a CTI port for each active voice line. Applications that use CTI route points and CTI ports include Cisco SoftPhone, Cisco IP Auto Attendant, and Cisco IP Interactive Voice Response System. For detailed instructions on how to configure CTI route points and CTI ports associated with these applications, refer to the documentation and online help included with these applications. This section describes the following basic procedures:

Adding a CTI Route Point, page 42-2 Modifying a CTI Route Point, page 42-3 Deleting a CTI Route Point, page 42-4 Finding and Listing CTI Route Points, page 42-5 Resetting a CTI Route Point, page 42-6
42-1
Chapter 42 Adding a CTI Route Point
Adding a CTI Route Point

Perform the following procedure to add a CTI route point.
Procedure
Open Cisco CallManager Administration. Select Device > CTI Route Point. Click the Add a New CTI Route Point link. Enter the appropriate settings, as defined in Table 42-1.
Table 42-1 CTI Route Point Configuration Settings
Field Device Name
Description Unique identifier for this device.
Usage Notes

This field is required. Enter from 1 to 15 characters, including alphanumeric, dot, dash, or underscores.
Description Device Pool
Descriptive name for the CTI route point. Specifies the collection of properties for this device including CallManager Group, Date/Time Group, Region, and Calling Search Space for auto-registration. Select the name of a Device Pool from the drop-down list box.
Location
Specifies the remote location Select the name of a location from accessed using restricted bandwidth the drop-down list box. connections. Specifies the collection of route partitions searched to determine how a collected (originating) number should be routed. Select a calling search space from the drop-down list box.
Calling Search Space
42-2
OL-1047-01
Chapter 42
Configuring CTI Route Points Modifying a CTI Route Point
Step 5
Click Insert to add the new CTI route point. The page refreshes to display the information entered for the new CTI route point, and the list on the left side of the page displays an icon that you can click to begin adding lines to the route point. For instructions on how to add and configure lines (directory numbers), refer to the Adding a Directory Number section on page 46-19
Related Topics

Modifying a CTI Route Point, page 42-3 Deleting a CTI Route Point, page 42-4 Finding and Listing CTI Route Points, page 42-5 Resetting a CTI Route Point, page 42-6
Modifying a CTI Route Point

Perform the following steps to modify a CTI route point:
Procedure
Open Cisco CallManager Administration. Select Device > CTI Route Point. The Find/List CTI Route Points page displays. Specify the search criteria needed to locate the CTI route point you want to delete. Click Find. The page updates to display a list of CTI route points that match the specified search criteria. Click on the name of the CTI route point whose settings you want to modify. The page refreshes to show the current settings for the selected CTI route point.
Step 6
Make the desired changes to the configuration settings. Refer to Table 42-1 on page 42-2 for detailed descriptions of CTI route point configuration settings.
42-3
Chapter 42 Deleting a CTI Route Point
Step 7
Click Update to apply the changes. The page refreshes to display the new settings.
Related Topics

Adding a CTI Route Point, page 42-2 Deleting a CTI Route Point, page 42-4 Finding and Listing CTI Route Points, page 42-5 Resetting a CTI Route Point, page 42-6
Deleting a CTI Route Point

Perform the following procedure to delete a CTI route point:
Procedure
Open Cisco CallManager Administration. Select Device > CTI Route Point. The Find/List CTI Route Points page displays. Specify the search criteria needed to locate the CTI route point you want to delete. Click Find. The page refreshes to display a list of the CTI route points that match the specified search criteria. Click the Delete icon for the CTI route point in the list that you want to delete. You can also click on the name of the CTI route point you want to delete from the list to display its current settings and then click Delete. A confirmation dialog displays.
Step 6
Click OK to permanently delete the CTI route point.
Related Topics

Adding a CTI Route Point, page 42-2 Modifying a CTI Route Point, page 42-3
42-4
OL-1047-01
Chapter 42
Configuring CTI Route Points Finding and Listing CTI Route Points
Finding and Listing CTI Route Points, page 42-5 Resetting a CTI Route Point, page 42-6
Finding and Listing CTI Route Points

Perform the following procedure to find and list CTI route points.
Procedure
Step 1 Step 2
Open Cisco CallManager. Select Device > CTI Route Point. The Find and List Route Points page displays.
Step 3 Step 4
Select the search criteria to use. To list all items, click Find without entering any search text, or use "Device Name is not empty" as the search criteria. Click Find. The first 20 CTI route points that match the search criteria are listed. The total number of CTI route points and pages are also listed on this page.
Step 5
To view the next set of CTI route points, click Next.
Related Topics

Adding a CTI Route Point, page 42-2 Modifying a CTI Route Point, page 42-3 Deleting a CTI Route Point, page 42-4 Resetting a CTI Route Point, page 42-6 Configuring CTI Route Points, page 42-1
42-5
Chapter 42 Resetting a CTI Route Point
Resetting a CTI Route Point

Perform the following procedure to reset a CTI route point:
Procedure
Step 1 Step 2
Open Cisco CallManager. Select Device > CTI Route Point. The Find and List CTI Route Points page displays.
Step 3 Step 4
Select the search criteria to use. Click Find. The CTI route points that match the search criteria are listed.
Step 5
Click the Reset icon for the CTI route point you want to reset. The Reset Device dialog is displayed.
Step 6
Click one of the following:

Restart DeviceRestarts a device without shutting it down. Reset DeviceShuts down a device and brings it back up. CloseCloses the Reset Device dialog without performing any action.
Related Topics

Adding a CTI Route Point, page 42-2 Modifying a CTI Route Point, page 42-3 Deleting a CTI Route Point, page 42-4 Finding and Listing CTI Route Points, page 42-5
42-6
OL-1047-01
C H A P T E R
43
Configuring Cisco uOne Voice Messaging

The optional Cisco Unified Open Network Exchange (uOne) software, available as part of Cisco IP Telephony Solutions, provides voice messaging capability for users when they are unavailable to answer calls. This section describes the procedures required for adding and configuring Cisco uOne ports in Cisco CallManager. To connect Cisco uOne to Cisco CallManager, you need to:
Add Cisco uOne ports to Cisco CallManager. All users and their directory numbers must be entered in Cisco CallManager Administration to retrieve messages from a Cisco uOne voice mail device. Configure a message waiting indicator (MWI) device. Configure values for Cisco CallManager service parameters associated with Cisco uOne. Set Forward Busy and Forward No Answer for Cisco IP Phones that will be accessing voice mail.
43-1
Chapter 43
The following table provides an overview of the steps required to configure Cisco CallManager with Cisco uOne voice messaging: Procedure
Step 1 Step 2
Reference Cisco uOne Port Wizard section on page 43-3.
Add a Cisco uOne server and ports to the Cisco CallManager database.
Configure CallManager service parameter Configuring Cisco CallManager values. Service Parameters for Cisco uOne section on page 43-8 Installation and configuration documentation supplied with Cisco uOne.
Step 3
Configure the MWI device.
Setting up the MWI Device section on page 43-11 Installation and configuration documentation supplied with Cisco uOne.
Step 4
Set up Call Forward No Answer and Call Forward Busy on all Cisco IP Phones that will be used with Cisco uOne.
Configuring Call Forward section on page 46-17 Installation and configuration documentation supplied with Cisco uOne.
For more information about configuring Cisco CallManager with Cisco uOne, refer to the installation and configuration documentation that shipped with the software.
Related Topics

Cisco uOne Port Wizard, page 43-3 Adding Cisco uOne Ports, page 43-12 Deleting a Cisco uOne Port, page 43-16 Resetting a Cisco uOne Port, page 43-17 Updating a Cisco uOne Port, page 43-18 Copying an Existing Cisco uOne Port, page 43-19
43-2
OL-1047-01
Chapter 43
Configuring Cisco uOne Voice Messaging Cisco uOne Port Wizard
Cisco uOne Port Wizard

The Cisco uOne Port wizard is a tool that allows Cisco CallManager administrators to quickly add and delete ports associated with a Cisco uOne server to the Cisco CallManager database. The following procedures are described in this section:

Adding a New Cisco uOne Server and Ports, page 43-3 Adding Ports to an Existing Cisco uOne Server, page 43-6 Deleting Ports from an Existing Cisco uOne Server, page 43-7
Adding a New Cisco uOne Server and Ports

Perform the following steps to use the Cisco uOne Port wizard to add a new Cisco uOne server and ports to the Cisco CallManager database.
Before You Begin
The uOne wizard requires a range of consecutive directory numbers for the uOne ports. Make sure the voice mail pilot number and subsequent numbers are available.
Procedure
Open Cisco CallManager Administration. Select Device > Cisco uOne Port. Click on the Use the Cisco uOne Wizard link in upper right corner of the page. If there are no existing Cisco uOne ports, the uOne wizard prompts you enter the name of the Cisco uOne Server to add (see Step 6). Otherwise, the Cisco uOne Server page displays. Select Create a new Cisco uOne server and add ports to it. Click Next. The Cisco uOne Server page displays. Enter the name of the Cisco uOne device. This name must match the CMDeviceName value in the SS.ini uOne configuration file (the default is CiscoUM).
43-3
Chapter 43 Cisco uOne Port Wizard
You do not need to add the "-VI<port_number>" suffix, because the wizard automatically appends this when adding the ports.
Click Next. The Cisco uOne Ports page is displayed. Select the number of ports to add from the list. Click Next. The Cisco uOne Device Information page is displayed. Enter the appropriate configuration settings, as described in Table 43-1. The wizard will apply these configuration settings to all of the new ports.
Table 43-1 uOne Port Wizard Device Information Settings
Field
Device Information
Description Clarifies the purpose of device. Select the default value of Default Pool. Collection of partitions that are searched for numbers called from this directory number. Select the default value of None.
Usage Notes
Description Device Pool Calling Search Space
Location
Remote location accessed using restricted bandwidth connections.
Step 11 Step 12
Click Next. The Cisco uOne Pilot Number page displays. Enter the pilot number configuration settings as described in Table 43-2.
43-4
OL-1047-01
Chapter 43
Table 43-2 uOne Port Wizard Pilot Number Configuration Settings
Field Pilot Number
Description The number people call to access the Cisco uOne server.
Usage Notes A pilot number is required. This number must be the same as the Cisco Voice Mail pilot directory number configured in the Cisco uOne DialMap.ini file. Each new port receives the next available directory number.
Route Partition
Route partition to which this set of directory numbers belong.
Select a partition from the drop-down list. Select None if partitions are not used. If a Route Partition is selected, you must select a Calling Search Space that includes the selected Route Partition.
Collection of partitions that are searched for numbers called from this directory number.
If a Route Partition is selected, you must select a Calling Search Space that includes the selected Route Partition.
Step 13 Step 14
Click Next. The Cisco uOne Operator Number page is displayed. Enter an operator number (optional). The operator number is the number to which the last port is forwarded. A caller is directed to this number if all ports on the Cisco uOne Server are busy. Supplying an attendant's number here gives the caller another chance to reach the party they were calling, instead of getting a busy signal if all ports are in use.
Step 15
Click Next. A summary screen that lists the settings you configured in the previous screens displays. The Cisco uOne wizard automatically assigns the correct values for the Forward Busy and Forward No Answer fields for each port.
43-5
Chapter 43 Cisco uOne Port Wizard
Step 16
If this information is correct, click Finish to add the new ports. If the information shown is not correct, click the Back button to edit the information, or Cancel to quit without adding any ports.
Related Topics

Adding Ports to an Existing Cisco uOne Server, page 43-6 Deleting Ports from an Existing Cisco uOne Server, page 43-7
Adding Ports to an Existing Cisco uOne Server

Perform the following steps to use the Cisco uOne Port wizard to add ports to an existing Cisco uOne server.
Before You Begin
The uOne wizard requires a range of consecutive directory numbers for the uOne ports. Make sure the voice mail pilot number and subsequent numbers are available. The voice mail pilot number is the number people call to access the Cisco uOne server. This number is the Cisco Voice mail pilot directory number configured in the Cisco uOne DialMap.ini file. Refer to the Cisco uOne documentation for information about the Cisco uOne .ini files.
Procedure
Open Cisco CallManager Administration. Select Device > Cisco uOne Port. Click on the Use the Cisco uOne Wizard link in the upper right corner of the page. The Cisco uOne Server page displays. Select Add Ports to an Existing Cisco uOne Server. Click Next. The Cisco uOne Server page displays. Select the name of an existing Cisco uOne server (pilot number) from the list and click Next. The Cisco uOne Ports page is displayed, which lists the number of ports that are currently configured.
43-6
OL-1047-01
Chapter 43
Step 7
Select the number of ports to add from the list and click Next. A summary page is displayed that shows the configuration information for the Cisco uOne server to which you added the ports. The Cisco uOne wizard automatically assigns consecutive directory numbers following the last port, and uses the same Route Partition and Calling Search Space settings as the Cisco uOne voice mail pilot directory number.
Step 8 Step 9
Click Next. If needed, add, change, or remove the Operator Number for this Cisco uOne server and ports, then click Next. The Ready to Add Ports summary screen displays the new settings. If this information is correct, click Finish to add the new ports. If the information shown is not correct, click the Back button to edit the information or click Cancel to quit without adding any ports.
Step 10
Related Topics

Adding a New Cisco uOne Server and Ports, page 43-3 Deleting Ports from an Existing Cisco uOne Server, page 43-7
Deleting Ports from an Existing Cisco uOne Server

Perform the following steps to use the Cisco uOne Port wizard to delete ports from an existing Cisco uOne server.
Procedure
Open Cisco CallManager Administration. Select Device > uOne Port. Select the Use the Cisco uOne Wizard link in the upper right corner of the page. The Cisco uOne Server page displays. Select Delete ports from an existing Cisco uOne server and click Next. The Cisco uOne Server page displays.
43-7
Chapter 43 Configuring Cisco CallManager Service Parameters for Cisco uOne
Step 5
Select the name of an existing Cisco uOne server (pilot number) from the list and click Next. The Cisco uOne Ports page is displayed, which lists the number of ports that are currently configured.
Step 6
Select the number of ports to delete from the list and click Next. A summary page is displayed that shows the updated settings for the Cisco uOne server from which you deleted the ports. The Cisco uOne wizard automatically updates the port numbers, directory numbers, Forward Busy, and Forward No Answer numbers so that they are consecutive.
Step 7
If this information is correct, click Finish to delete the selected ports. If the information shown is not correct, click the Back button to edit the information, or Cancel to quit without deleting any ports.
Related Topics

Adding a New Cisco uOne Server and Ports, page 43-3 Adding Ports to an Existing Cisco uOne Server, page 43-6
Configuring Cisco CallManager Service Parameters for Cisco uOne

The following Cisco CallManager service parameters must be set up when configuring Cisco CallManager to work with Cisco uOne:
MessageWaitingOnDN and MessageWaitingOffDNCisco uOne uses the MWI On and MWI Off directory numbers specified by these two service parameters to turn the Message Waiting Indicator (MWI) on a user's phone on or off.
Note
For Cisco IP Phone 12 SP+ and 30 VIP models, the phone button template for the users phone must have a button configured for Message Waiting for this feature to be available.
43-8
OL-1047-01
Chapter 43
Configuring Cisco uOne Voice Messaging Configuring Cisco CallManager Service Parameters for Cisco uOne
VoiceMailVoice mail pilot number (the number users dial to call in to the voice mail system). Setting this parameter enables you to configure a single button on users phones for automatically dialing the voice mail pilot number. ForwardNoAnswerTimeoutSpecifies the number of seconds to wait before forwarding on a No Answer condition. ForwardMaximumHopCountSpecifies the maximum number of attempts to extend a forwarded call.
Use the following procedure to configure the MWI On/Off directory numbers.
Before You Begin
Before changing the values of the MWI On/Off service parameters, you must first stop the Cisco uLite process in Cisco uOne. Refer to the installation and configuration documentation shipped with Cisco uOne for more information.
Note
You must set the MWI On/Off service parameters for each Cisco CallManager in the cluster.
Procedure
Open Cisco CallManager Administration. Select Service > Service Parameters. Select the appropriate IP address or name of the Cisco CallManager server from the list on the left side of the page. Select Cisco CallManager from the Configured Services list. Select MessageWaitingOffDN from the Configured Service Parameters list. In the Value field, enter the device number from the CMMWIOffNumber value as shown in the Cisco uOne SSMWI.ini file. This value is the number to be dialed to turn off the message waiting indicator as configured in Cisco CallManager.
Note
For more information about Cisco uOne .ini files, refer to the installation and configuration documentation supplied with Cisco uOne.
Step 7
Click Update.
OL-1047-01
43-9
Chapter 43 Configuring Cisco CallManager Service Parameters for Cisco uOne
Step 8 Step 9
Select MessageWaitingOnDN from the Configured Service Parameters list. In the Value field, enter the device number from the CMMWIOnNumber value as shown in the Cisco uOne SSMWI.ini file. This value is the number to be dialed to turn on the message waiting indicator device as configured in Cisco CallManager. Click Update. Select VoiceMail from the Configured Service Parameters list. In the Value field, enter the Cisco uOne Voice Mail pilot number. This is the directory number that users call to access voice mail. This number must be the same as the Cisco uOne voice mail pilot directory number configured in the Cisco uOne DialMap.ini file. Setting this parameter enables you to configure a single button (for example, the messages button on a Cisco IP Phone 79xx) on users phones for automatically dialing the voice mail pilot number.
Step 10 Step 11
Step 12 Step 13
Click Update. Select ForwardMaximumHopCount from the Configured Service Parameters list. The ForwardMaximumHopCount parameter specifies the number of attempts to extended a forwarded call. Enter a numeric value. The recommended value is 15. Click Update. Select ForwardNoAnswerTimeout from the Configured Service Parameters list box. The ForwardNoAnswerTimeout parameter specifies the number of seconds to wait before forwarding on a No Answer condition. Enter a numeric value in the Value field. The recommended value is 24. Click Update. Repeat this procedure for each Cisco CallManager server in the cluster.
Related Topics:
Setting up the MWI Device, page 43-11
43-10
OL-1047-01
Chapter 43
Configuring Cisco uOne Voice Messaging Setting up the MWI Device
Setting up the MWI Device

Use the following procedure to create and configure the MWI device for use with Cisco uOne.
Procedure
Open Cisco CallManager Administration. Select Device > Cisco uOne Port. In the Cisco uOne Port Name field, enter the name of the Cisco MWI uOne port device. This name must match the CMDeviceName value in the SSMWI.ini file (for example, CiscoMWI-VI1).
Note
For more information about Cisco uOne .ini files, refer to the Installation and Configuration documentation supplied with Cisco uOne.
Step 4
Enter the device configuration settings as follows: Field Name Description Device Pool Location Partition Calling Search Space Value Optional descriptive text about the device. Select the default value of Default Pool. Select the default value of None. If partitions are being used, they must be defined here also. If partitions and calling search spaces are used, the calling search space specified here must include the partitions of the DNs on all phones whose lamps you wish to light (the partition defined for a phone's DN must be in a calling search space that the MWI device uses).
43-11
Chapter 43 Adding Cisco uOne Ports
Field Name Directory Number
Value Enter the Cisco MWI device directory number. This should be a number that is not used within the Cisco uOne messaging system or within the Cisco CallManager auto-registration range. Leave blank. Leave blank. Leave blank.
Forward All Forward Busy Forward No Answer
Note
The directory number for the MWI device is used for turning on the message indicator only. Since it is not used by the uOne Messaging System or Cisco CallManager for receiving calls, the Forward Busy and Forward No Answer fields are not used.
Step 5
Click Insert to add this device to the system.
Related Topics:
Configuring Cisco CallManager Service Parameters for Cisco uOne, page 43-8
Adding Cisco uOne Ports

To connect Cisco uOne to Cisco CallManager, you must add Cisco uOne ports to Cisco CallManager. All users and their directory numbers must be entered in Cisco CallManager Administration to retrieve messages from a Cisco uOne voice mail device.
43-12
OL-1047-01
Chapter 43
Configuring Cisco uOne Voice Messaging Adding Cisco uOne Ports
Tips
You can also use the Cisco uOne wizard to add a new Cisco uOne server and ports or to add multiple ports to an existing server rather than the procedure described here. Refer to the Cisco uOne Port Wizard section on page 43-3 for more information. Follow these instructions to add individual Cisco uOne ports to the Cisco CallManager database.
Note
If you are adding multiple ports, use the Cisco uOne wizard. Use this procedure add individual Cisco uOne ports (for example, to update the Operator Number). The naming convention for the ports should be CiscoUM-VI<consecutive number for each port>. An Operator Number can be specified for the Forward Busy and Forward No Answer values for the last uOne port.
Procedure
Step 1 Step 2
Open Cisco CallManager Administration. Select Device > Cisco uOne Port. The Cisco uOne Port Configuration page displays.
Step 3
Enter the appropriate settings as described in Table 43-3.
Table 43-3 uOne Configuration Settings
Field
Device Information
Description Identifies the Cisco uOne port.
Usage Notes
Cisco uOne Port Name
Must match the information in the uOne .ini files, such as CiscoUM-VI1 or CiscoUM-VI2. Must add a device for each port on Cisco uOne. If there are 24 ports, you must define 24 devices.
43-13
Chapter 43 Adding Cisco uOne Ports
Table 43-3 uOne Configuration Settings (continued)
Field Description Device Pool Calling Search Space
Description Clarifies the purpose of the device. Select the default value of Default Pool from the list. Collection of partitions that are searched for numbers called from this device. Select the default value of None from the list. Indicates a phone number that can be dialed.
Usage Notes
Location
Directory Number Information
Directory Number
Indicates the number associated with this uOne port Values can include a maximum of 50 numeric characters Unique in combination with the Partition field.
Partition
Indicates the route partition to which the directory number belongs.
Select a partition from the drop-down list. Select None if partitions are not used. If a Route Partition is selected, you must select a Calling Search Space that includes the selected Route Partition.
Collection of partitions that are searched for numbers called from this directory number.
If a Route Partition is selected, you must select a Calling Search Space that includes the selected Route Partition.
Call Forwarding Information
Forward All
This field should be left blank.
43-14
OL-1047-01
Chapter 43
Configuring Cisco uOne Voice Messaging Adding Cisco uOne Ports
Table 43-3 uOne Configuration Settings (continued)
Field Forward Busy
Description
Usage Notes
Voice mail directory number where This should be the next sequential Cisco uOne port or, if it is the last calls are forwarded if this port is port, an operator number. busy (for example, the next sequential uOne port number). The Forward Busy and Forward No Answer fields should have the same value.
Forward No Answer
Voice mail directory number where This should be the next sequential calls are forwarded if this port does Cisco uOne port or, if it is the last not answer the call (for example, the port, an operator number. next sequential port). The Forward Busy and Forward No Answer fields should have the same value.
Step 4
Click Insert to add the new Cisco uOne port device.
Related Topics

Cisco uOne Port Wizard, page 43-3 Deleting a Cisco uOne Port, page 43-16 Resetting a Cisco uOne Port, page 43-17 Updating a Cisco uOne Port, page 43-18 Copying an Existing Cisco uOne Port, page 43-19
43-15
Chapter 43 Deleting a Cisco uOne Port
Deleting a Cisco uOne Port

Follow these procedures to delete a single Cisco uOne port from Cisco CallManager.
Tips
You can also use the Cisco uOne wizard to delete ports from an existing server instead of using the procedure described here. Refer to the Cisco uOne Port Wizard section on page 43-3 for more information.
Procedure
Step 1 Step 2
Open Cisco CallManager Administration. Select Devices > Cisco uOne Port. The Cisco uOne port configuration page displays with a list of the defined Cisco uOne ports.
Step 3
Select the Cisco uOne port you want to delete.
Note
When you delete a uOne port (and its associated directory number), you must make sure that no Cisco uOne ports refer to the deleted directory number in their Forward Busy and Forward No Answer fields.
Step 4
Click Delete. The Cisco uOne port is deleted, and the Cisco uOne Ports page updates to display the changes.
Related Topics

Cisco uOne Port Wizard, page 43-3 Adding Cisco uOne Ports, page 43-12 Resetting a Cisco uOne Port, page 43-17 Updating a Cisco uOne Port, page 43-18 Copying an Existing Cisco uOne Port, page 43-19
43-16
OL-1047-01
Chapter 43
Configuring Cisco uOne Voice Messaging Resetting a Cisco uOne Port
Resetting a Cisco uOne Port

Follow these procedures to reset a Cisco uOne port from Cisco CallManager.
Procedure
Step 1 Step 2
Select the Cisco uOne port you want to reset. Click Reset. Click OK. The Reset Device dialog box displays.
Step 6
Select one of the following:

Restart DeviceRestart a device without shutting it down Reset DeviceShut down a device and bring it back up. CloseClose the Reset Device dialog without making any changes.
Related Topics

Cisco uOne Port Wizard, page 43-3 Adding Cisco uOne Ports, page 43-12 Deleting a Cisco uOne Port, page 43-16 Updating a Cisco uOne Port, page 43-18 Copying an Existing Cisco uOne Port, page 43-19
43-17
Chapter 43 Updating a Cisco uOne Port
Updating a Cisco uOne Port

Follow these procedures to update a Cisco uOne port (for example, to make minor changes such as updating the Operator Number).
Procedure
Step 1 Step 2
Select the Cisco uOne port you want to update. Enter the desired changes. Refer to Table 43-3 on page 43-13 for a detailed description of the configuration settings for Cisco uOne ports. Click Update.
Related Topics

Cisco uOne Port Wizard, page 43-3 Adding Cisco uOne Ports, page 43-12 Deleting a Cisco uOne Port, page 43-16 Copying an Existing Cisco uOne Port, page 43-19
43-18
OL-1047-01
Chapter 43
Configuring Cisco uOne Voice Messaging Copying an Existing Cisco uOne Port
Copying an Existing Cisco uOne Port

If you want to add several similar Cisco uOne ports to the Cisco CallManager database, you can add one and then copy its basic settings to apply to another Cisco uOne port.
Tips
It is much easier to use the Cisco uOne wizard to add a new Cisco uOne server and ports or to add multiple ports to an existing server instead of the procedure described here. Refer to the Cisco uOne Port Wizard section on page 43-3 for more information. Follow these steps to copy a Cisco uOne ports settings.
Procedure
Step 1 Step 2
Select the Cisco uOne port you want to copy. Click Copy. Make the required changes. You must change the Cisco uOne Port Name and Directory Number fields. You should also update the Forward Busy and Forward No Answer fields. Refer to Table 43-3 on page 43-13 for a detailed description of the configuration settings for Cisco uOne ports.
Step 6
Click Insert.
Related Topics

Cisco uOne Port Wizard, page 43-3 Adding Cisco uOne Ports, page 43-12 Deleting a Cisco uOne Port, page 43-16
43-19
Chapter 43 Copying an Existing Cisco uOne Port
Resetting a Cisco uOne Port, page 43-17 Updating a Cisco uOne Port, page 43-18
43-20
OL-1047-01
C H A P T E R
44
Configuring a Gatekeeper
A gatekeeper (also known as a Cisco Multimedia Conference Manager, or MCM) is a device that supports the H.225 RAS message set used for call admission control, bandwidth allocation, and dial pattern resolution. Only one gatekeeper device can be configured per Cisco CallManager cluster.
Related Topics
The following topics contain additional information related to gatekeepers:

Understanding Call Admission Control, page 5-1 Gatekeepers, page 5-3 Adding a Gatekeeper, page 44-1 Deleting the Gatekeeper, page 44-6 Resetting or Restarting the Gatekeeper, page 44-6 Modifying the Gatekeeper, page 44-7
Adding a Gatekeeper
Perform the following procedure to add a gatekeeper device.
Procedure
Step 1 Step 2
Open Cisco CallManager Administration. Select Device > Gatekeeper.

OL-1047-01
44-1
Chapter 44 Adding a Gatekeeper
Step 3
Enter the appropriate settings, as defined in Table 44-1.
Table 44-1 Gatekeeper Configuration Settings
Field Gatekeeper Name
Description
Usage Notes
The IP address or DNS name of the Only one gatekeeper can be gatekeeper. registered per Cisco CallManager cluster. Descriptive name for the gatekeeper. The amount of time that the gatekeeper will consider a registration request (RRQ) valid. A keepalive RRQ must be sent to the gatekeeper before the RRQ Time to Live expires. An RRQ is a request sent by a Cisco CallManager to the gatekeeper to register and then subsequently to maintain a connection with the gatekeeper. The request may be confirmed (RCF) or denied (RRJ). Enter a time in seconds. The default value is 60 seconds. Do not change this value unless instructed to by a Cisco TAC engineer.
Description Registration Request Time to Live
Registration Retry Timer
The amount of time Cisco CallManager waits before retrying gatekeeper registration after a failed registration attempt.
Enter a time in seconds. The default value is 300 seconds. Do not change this value unless instructed to by a Cisco TAC engineer.
44-2
OL-1047-01
Chapter 44
Configuring a Gatekeeper Adding a Gatekeeper
Table 44-1 Gatekeeper Configuration Settings (continued)
Field Terminal Type
Description Determines the type for all of the devices controlled by this gatekeeper.
Usage Notes All gatekeeper-controlled devices must be of the same type. Select either Terminal or Gateway from the drop-down list box. This field is normally set to Gateway for normal gatekeeper call admission control.
Select Gateway if all gatekeeper-controlled devices are gateways (including intercluster trunks). Select Terminal if all gatekeeper-controlled devices are H.323 clients (for example, Microsoft NetMeeting devices).
Device Pool
Specifies the collection of properties for this device including CallManager Group, Date/Time Group, Region, and Calling Search Space. This setting enables or disables the ability to send and receive intercluster calls to and from devices that are not explicitly configured in the database for each remote Cisco CallManager controlled by this gatekeeper. This eliminates the need for a Cisco CallManager to have an H.225 device (intercluster trunk) explicitly configured for every remote CallManager that may be called over the IP WAN.
Select the name of a Device Pool from the drop-down list box.
Allow Anonymous Calls
By default, Allow Anonymous Calls is disabled. When you enable Allow Anonymous Calls and fill in the remainder of the fields below, you are essentially creating a device (similar to an intercluster trunk) that can send and receive calls to or from any remote Cisco CallManager controlled by this gatekeeper. This only applies to intercluster calls.
This device has all the characteristics of a normal device such as region, calling search space, When you enable Allow Anonymous Calls, you must also fill location, and so on. in the configuration settings below.
44-3
Chapter 44 Adding a Gatekeeper
Field Calling Search Space
Description Specifies the collection of Route Partitions searched to determine how a collected (originating) number should be routed. Specifies the remote location accessed using restricted bandwidth connections. The pattern you want to use for Caller ID, from 0 to 24 digits.
Usage Notes
Allow Anonymous Calls Device
Location
Caller ID DN
For example, in North America:
555XXXX = variable Caller ID, where X is equal to an extension number. The Central Office (CO) appends the number with the area code if you do not specify it. 5555000 = Fixed Caller ID. Use when you want the Corporate number to be sent instead of the exact extension from which the call is placed. The CO appends the number with the area code if you do not specify it.
Calling Party Selection
Any outbound call on a gateway can The following options specify send directory number information. which directory number is sent: This field determines which Originatorsend the directory directory number is sent. number of the calling device.
First Redirect Numbersend the directory number of the redirecting device. Last Redirect Numbersend the directory number of the last device to redirect the call.
44-4
OL-1047-01
Chapter 44
Configuring a Gatekeeper Adding a Gatekeeper
Field Presentation Bit
Description Determines whether the CO transmits or blocks caller ID.
Usage Notes Select Allowed if you want the CO to send caller ID. Select Restricted if you do not want the CO to send caller ID.
Media Termination Point Required
Determines whether or not a Media Termination Point (MTP) is used to implement features that H.323 does not support (such as hold and transfer). An MTP is also required if you need a transcoder. Specifies the number of significant digits to collect, from 0 to 32. Significant digits are counted from the right (last digit) of the number called.
Used for H.323 clients only and those H.323 devices that do not support the H.245 empty capabilities set.
Num Digits
This field is used if you enable Sig Digits. It is used for the processing of incoming calls and indicates the number of digits starting from the last digit of the called number used to route calls coming into the H.323 device. See Prefix DN and Sig Digits. Enable or disable this box depending on whether you want to collect significant digits. If disabled, the Cisco CallManager does not truncate the inbound number. If enabled, you also need to choose the number of significant digits to collect (see Num Digits).
Sig Digits
Represents the number of final digits retained on inbound calls. A trunk with significant digits enabled truncates all but the final few digits of the address provided an inbound call.
Prefix DN
Specifies the prefix digits that are The Cisco CallManager adds prefix appended to the called party number digits after first truncating the on incoming calls. number in accordance with the Num Digits setting.
44-5
Chapter 44 Deleting the Gatekeeper
Step 4
Click Insert to add the new gatekeeper. The page is updated and the name of the new gatekeeper is displayed in the list on the left.
Related Topics
Gatekeepers section on page 5-3
Deleting the Gatekeeper

Perform the following steps to delete the gatekeeper.
Procedure
Open Cisco CallManager Administration. Select Device > Gatekeeper. Click on the name of the gatekeeper from the list on the left side of the screen. The page refreshes to show the configuration information for the gatekeeper.
Step 4 Step 5
Click the Delete button. A confirmation dialog box displays. Click OK to permanently delete the gatekeeper.
Related Topics
Resetting or Restarting the Gatekeeper

Perform the following procedure to reset or restart the gatekeeper.
Procedure
Step 1
Open Cisco CallManager Administration.
44-6
OL-1047-01
Chapter 44
Configuring a Gatekeeper Modifying the Gatekeeper
Step 2 Step 3
Select Device > Gatekeeper. Click on the name of the gatekeeper in the list on the left side of the screen. The page refreshes to show the configuration information for the gatekeeper.
Step 4 Step 5
Click Reset Gatekeeper. The Reset Device dialog displays. Click one of the following:
Restart or Reset Shut down, then reset the internal gatekeeper device. The Cisco CallManager cluster will unregister (URQ) and then re-register (RRQ) with the gatekeeper. CloseClose the Reset Device dialog without performing any action.
Related Topics
Modifying the Gatekeeper

Perform the following steps to modify gatekeeper settings:
Procedure
Open Cisco CallManager Administration. Select Device > Gatekeeper. Click on the name of the gatekeeper from the list on the left side of the screen. The page refreshes to show the configuration settings for the gatekeeper.
Step 4 Step 5
Make the desired changes to the configuration settings. Click Update to apply the changes. The page refreshes to display the new settings.
Related Topics
44-7
Chapter 44 Modifying the Gatekeeper
44-8
OL-1047-01
C H A P T E R
45
Configuring Gateways
Cisco IP telephony gateways enable Cisco CallManager to communicate with non-IP telecommunications devices. Cisco CallManager supports several types of gateways as described in Table 45-1.
Table 45-1 Gateway Model Overview
Gateway Model Cisco Access Analog Station Gateway (AS-2, AS-4, AS-8)
Communication Protocol Skinny Gateway Protocol
Device Protocol Analog
Port Types Foreign Exchange Station (FXS) (loop start) Foreign Exchange Office (FXO) (loop start) PRI E1 PRI T1 Foreign Exchange Station (FXS)
Cisco Access Analog Trunk Gateway (AT-2, AT-4, AT-8)
Skinny Gateway Protocol
Analog
Cisco Access Digital Trunk Gateway DE-30+ Cisco Access Digital Trunk Gateway DT-24+
Skinny Gateway Protocol Skinny Gateway Protocol
Digital PRI E1 Digital PRI T1 Analog
Cisco Catalyst 6000 24 Port FXS Skinny Gateway Protocol Analog Interface Module Cisco Catalyst 6000 8 Port E1/T1 and Services Module Skinny Gateway Protocol
Digital E1/T1 PRI PRI E1/T1
45-1
Chapter 45 Understanding Supported Gateways
Table 45-1 Gateway Model Overview (continued)
Gateway Model Cisco Voice Gateway 200 (VG200)
Communication Protocol
Device Protocol
Port Types Foreign Exchange Office (FXO) Foreign Exchange Station (FXS) Depends on model
Analog Media Gateway Control Protocol (MGCP); works as an H.323 gateway with T1-CAS ports
All H.323 Gateways, including Cisco VG200 and Cisco IOS-based gateways
H.323
H.225, Inter-cluster Trunk
These sections provide information about working with and configuring Cisco gateways with Cisco CallManager

Understanding Supported Gateways, page 45-2 Adding Gateways to Cisco CallManager, page 45-7 Configuring Gateway Ports in Cisco CallManager, page 45-27 Modifying Gateways, page 45-41 Finding Specific Gateways, page 45-44
Understanding Supported Gateways

Cisco CallManager supports several types of Cisco and third-party IP telephony gateways. These sections provide an overview of these supported gateways:

Understanding Cisco Access Gateways, page 45-3 Understanding Catalyst 6000 Gateways, page 45-4 Cisco VG200 Gateway, page 45-6 Understanding Other H.323 Devices, page 45-6
45-2
OL-1047-01
Chapter 45
Configuring Gateways Understanding Supported Gateways
Understanding Cisco Access Gateways

Cisco Access gateways make it possible for the Cisco CallManager to communicate with non-IP telecommunications devices. The following Cisco Access gateways are available:

Cisco Access Analog GatewaysTrunk and station analog gateways Cisco Access Digital Trunk GatewaysDigital trunk gateways
Cisco Access Analog Gateways

There are two categories of Cisco Access Analog gateways: trunk gateways and station gateways.
Cisco Access Analog Station Gateways
Station gateways let you connect the Cisco CallManager to Plain Old Telephone Service (POTS) analog telephones, interactive voice response (IVR) systems, fax machines, and voice mail systems. Station gateways provide Foreign Exchange Station (FXS) ports. The AS-2, AS-4, and AS-8 models accommodate two, four, and eight Voice over IP (VoIP) gateway channels, respectively.
Access Analog Trunk Gateways
Analog trunk gateways let you connect the Cisco CallManager to standard public switched telephone network (PSTN) central office (CO) or PBX trunks. Trunk gateways provide Foreign Exchange Office (FXO) ports. The AT-2, AT-4, and AT-8 models accommodate two, four, and eight VoIP gateway channels. The signalling type is loop start.
Related Topics

Adding an Analog Gateway, page 45-7 Configuring Ports on Analog Gateways, page 45-27 Modifying Gateways, page 45-41 Finding Specific Gateways, page 45-44 Understanding Device Loads, page 7-6
45-3
Cisco Access Digital Trunk Gateways

A Cisco Access Digital Trunk Gateway allows you to connect a Cisco CallManager system to the PSTN or to a PBX. These models of Cisco Access Digital Trunk gateways are available: Cisco Access Digital Trunk DT-24+ Gateway and Cisco Access Digital Trunk DE-30+ (E1) Gateway.
Access Digital Trunk DT-24+ T1 Gateway
The DT-24+ gateway connects VoIP networks to a PBX or the PSTN. The DT-24+ supports ISDN PRI at a T1 rate.
Access Digital Trunk DE-30+ E1 Gateway
The DE-30+ (E1) gateway connects VoIP networks to a PBX or the PSTN. The DE-30+ supports ISDN PRI at an E1 rate.
Related Topics

Adding Digital Gateways, page 45-9 Modifying Gateways, page 45-41 Finding Specific Gateways, page 45-44 Understanding Device Loads, page 7-6
Understanding Catalyst 6000 Gateways

Several telephony modules are available for the Cisco Catalyst 6000 Family. These modules act as telephony gateways enabling you to implement IP telephony in your network using existing Cisco Catalyst 6000 Family devices. The Catalyst 6000 gateways are line cards you can install in any Catalyst 6000 or 6500 series switch.
Catalyst 6000 Family Analog Line Card

The Catalyst 6000 Family Analog Line Cards include the following:
Cisco Catalyst 6000 24 Port FXS Analog Interface Module
45-4
OL-1047-01
Chapter 45
Configuring Gateways Understanding Supported Gateways
Related Topics

Catalyst 6000 Family T1/E1 Line Cards

The Cisco Catalyst 6000 Family T1 Line Card provides eight ports allowing T1 PRI ISDN ports on connections to the PSTN or a PBX. The Cisco Catalyst 6000 Family E1 Line Card provides eight ports allowing E1 PRI ISDN ports on connections to the PSTN or a PBX.
Related Topics

Catalyst 6000 Family DSP Services Card

The Catalyst 6000 Family DSP Services Card is the same hardware as the Catalyst 6000 Family T1/E1 Line Cards. However, the DSP Services Card is configured with a different firmware load. This special configuration enables the card to function as a conference bridge or transcoder. When used in these configurations, this card does not act as a gateway and is not described in detail in this chapter.
Related Topics
Understanding Device Loads, page 7-6
45-5
Cisco VG200 Gateway

The Cisco VG200 gateway allows you to connect standard POTS devices to the Cisco IP Telephony Solution. The Cisco VG200 gateway provides a 10/100BaseT Ethernet port for connection to the data network. The following telephony connections are available:

1 to 4 Foreign Exchange Office (FXO) ports for connecting to a central office or PBX 1 to 4 Foreign Exchange Station (FXS) ports for connecting to POTS telephony devices 1 to 2 T1 digital ports for connecting to the PSTN
The Cisco VG200 gateway supports MGCP on FXO and FXS analog ports, and it supports H.323 on digital (T1) ports.
Related Topics

Adding an MGCP Gateway, page 45-21 Configuring Ports on a Cisco MGCP Gateway, page 45-35 Modifying Gateways, page 45-41 Finding Specific Gateways, page 45-44
Understanding Other H.323 Devices

H.323 devices comply with the H.323 communications standards and enable video conferencing over LANs and other packet-switched networks. You can add third-party H.323 devices or other Cisco devices that support H.323 (such as the Cisco 2600 series, 3600 series, or 5300 series gateways). H.323 gateways used to interlink Cisco CallManagers in different clusters are configured as inter-cluster trunks.
Related Topics

Adding an H.323 Gateway, page 45-23 Finding Specific Gateways, page 45-44 Configuring a Gatekeeper section on page 44-1
45-6
OL-1047-01
Chapter 45
Configuring Gateways Adding Gateways to Cisco CallManager
Adding Gateways to Cisco CallManager

To enable Cisco CallManager to manage IP telephony gateways in your network, you must first add each gateway to the Cisco CallManager system. Refer to these sections for detailed procedures:

Adding an Analog Gateway, page 45-7 Adding Digital Gateways, page 45-9 Adding an MGCP Gateway, page 45-21 Adding an H.323 Gateway, page 45-23
Adding an Analog Gateway

Use the following procedure to add these Cisco analog gateways to Cisco CallManager:

Cisco AS-2, AS-4, and AS-8 Gateways Cisco AT-2, AT-4, and AT-8 Gateways Cisco Catalyst 6000 24 Port FXS Gateway
Procedure
Step 1 Step 2
Open Cisco CallManager Administration. Select Device > Add a New Device. The Add a New Device screen appears.
Step 3
Select Gateway from the Device type drop-down list box. The Add a New Gateway screen appears.
Step 4
Select an analog gateway from the Gateway type drop-down list box. Supported analog gateways include the following:

45-7
Chapter 45 Adding Gateways to Cisco CallManager
When you select a Gateway type, the appropriate Device Protocol for the selected gateway (in this case, Analog Access) is automatically selected.
Step 5
Click Next. The Gateway Configuration screen appears.
Step 6 Step 7
Enter the appropriate settings, as described in Table 45-2. Click Insert.
Table 45-2 Access Analog Gateway Configuration Settings
Field MAC Address Description Device Pool
Description Identifies hardware-based devices. Clarifies the purpose of the device. Specifies the collection of properties for this device including CallManager Group, Date/Time Group, Region, and Calling Search Space for auto-registration of devices. Specifies the custom software for gateway.
Usage Notes Value must be 12 hexadecimal characters.
Load Information Country Code
Values entered here override the default values for this gateway.
The country in which the gateway is Select the country in which the located. gateway is located from the drop-down list box. Specifies the remote location accessed using restricted bandwidth connections. Specifies the collection of Route Partitions searched to determine how a collected (originating) number should be routed.
Location
45-8
OL-1047-01
Chapter 45
Table 45-2 Access Analog Gateway Configuration Settings (continued)
Field Port Selection Order
Description Specifies the order in which ports are selected.
Usage Notes
Valid entries are TOP_DOWN or BOTTOM_UP. If you're not sure which port order to use, choose TOP_DOWN selects ports in descending order, from port 1 to TOP_DOWN. port 8.
BOTTOM_UP selects ports in ascending order, from port 8 to port 1.
Related Topics

Cisco Access Analog Gateways, page 45-3 Catalyst 6000 Family Analog Line Card, page 45-4 Configuring Ports on Analog Gateways, page 45-27 Updating Device Loads, page 7-7
Adding Digital Gateways

You can add a Cisco digital gateway to Cisco CallManager. Follow these steps to add a digital PRI gateway.
Procedure
Step 1 Step 2
Open Cisco CallManager Administration. Select Device > Add a New Device. The Add a New Device screen appears.
Step 3 Step 4
Select Gateway from the Device type drop-down list box. Select a digital gateway from the Gateway Type drop-down list box.
45-9
Digital Access PRI gateways include:

Cisco DT-24+ Gateway Cisco DE-30+ Gateway Cisco Catalyst 6000 E1 VoIP Gateway Cisco Catalyst 6000 T1 VoIP Gateway
When you select a Gateway type, the appropriate Device Protocol for the selected Gateway type (in this case, Digital Access PRI) is automatically selected.
Step 5
Click Next. The Gateway Configuration screen appears.
Step 6 Step 7
Enter the appropriate settings as described in Table 45-3. Click Insert.
Table 45-3 Access Digital PRI Gateway Configuration Settings
Field MAC Address Description Device Pool
Description Identifies hardware-based telephones and device name. Clarifies the purpose of the device. Specifies the collection of properties for this device including CallManager Group, Date/Time Group, Region, and Calling Search Space for auto registration of devices. Specifies the collection of Route Partitions searched to determine how a collected (originating) number should be routed. Remote location accessed using restricted bandwidth connections. Specifies the custom software for gateway.
Usage Notes Value must be 12 hexadecimal characters.
Location Load Information
Values entered here override the default values for this gateway.
45-10
OL-1047-01
Chapter 45
Table 45-3 Access Digital PRI Gateway Configuration Settings (continued)
Field TX-Level CSU
Description
Usage Notes
Specifies the transmit level based on Select one of the alternative settings to attenuate the line. the distance between the gateway and the nearest repeater. The default -7.5dB is full power (0dB). -15dB
-22.5dB
Channel Selection Order
Specifies the order in which ports are enabled from first (lowest number port) to last (highest number port), or from last to first. Specifies the digital encoding format.
Valid entries are TOP_DOWN (last to first) or BOTTOM_UP (first to last). If you're not sure which port order to use, choose TOP_DOWN. Choose from the following:

PCM Type
A-law: Use for Europe and the rest of the world -law: Use for North America and Japan InternalWhen clocking is derived from the card and is then distributed at the span NetworkWhen the Cisco Access Digital Trunk Gateway receives its clocking from the network Span 1 to Span 8When the Cisco Access Digital Trunk Gateway receives clocking from another port on the same Cisco Catalyst 6000 blade.
Clock Reference
Specifies from where the master clock is derived. Cisco Catalyst 6000 blades have eight ports on the same hardware card, each of which can be used as a clock reference by other ports on the same blade.
Select Internal or Network.
45-11
Field Protocol Side
Description Setting used for Cisco Access Digital gateways depending on whether gateway is connected to a Central Office/Network device or to a User device. The two ends of the PRI connection should use opposite settings. For example, if you are connected to a PBX and the PBX uses User as its protocol side, Network should be chosen for this device. Typically, this option is User for Central Office connections.
Usage Notes
Caller ID DN
The pattern you want to use for Caller ID, from 0 to 24 digits.
555XXXX = variable Caller ID, where X is equal to an extension number. The CO appends the number with the area code if you do not specify it. 5555000 = Fixed Caller ID. Use when you want the Corporate number to be sent instead of the exact extension from which the call is placed. The CO appends the number with the area code if you do not specify it.
45-12
OL-1047-01
Chapter 45
Field Calling Party Selection
Description
Usage Notes
Determines which directory number The following options specify which directory number is sent: is sent. Any outbound call on a gateway can send directory number OriginatorSend the directory information. number of the calling device.
First Redirect NumberSend the directory number of the redirecting device. Last Redirect NumberSend the directory number of the last device to redirect the call.
Channel IE Type
Indicates whether channel selection Select one of the following from the is presented as a channel map or a drop-down list box: slot map. NumberB-channel usage is always a channel map format.

SlotmapB-channel usage is always a slotmap format Use Number When 1BChannel usage is a channel map for one B-channel but is a slotmap if more than one B-channel
Interface Identifier Present
The purpose of this parameter is to interoperate with a Nortel PBX when the PBX is configured to use the DMS100 protocol.
The default for this setting is disabled.
This setting only applies to the DMS100 protocol for digital access gateways in the Channel Identification information element (IE) of the SETUP, CALL PROCEEDING, When this box is checked, it indicates that an Interface Identifier ALERTING, and CONNECT messages. is present. This value should be obtained from Applies to DMS100 protocol only. Valid the PBX provider. values range from 0 to 255.
Interface Identifier Value
45-13
Field
Description
Usage Notes
Display IE Delivery When this box is checked, it enables By default, Display IE Delivery is disabled. delivery of the display information element (IE) in SETUP and CONNECT messages for the calling and called party name delivery service. Redirecting Number IE Delivery When this box is checked (enabled), the Redirecting Number IE is included in the SETUP message to indicate the first redirecting number and the redirecting reason of the call when Call Forward happens. Controls the rate at which the spans are brought in service when Inhibit Restarts at PRI Initialization is disabled. By default, this setting is disabled. This setting applies to the SETUP message only on all protocols for digital access gateways.
Delay for first restart (1/8 sec ticks)
Use this option when many PRI spans are enabled on a system and Inhibit Restarts at PRI Initialization is disabled. For example, set the first five cards to 0, and set the next five cards to 16. (Wait two seconds before bringing them in service.)
Delay between restarts (1/8 sec ticks) Num Digits
Determines the length of time between restarts if Inhibit Restarts is disabled, when a PRI RESTART is sent. Specifies the number of significant digits to collect, from 0 to 32. Significant digits are counted from the right (last digit) of the number called. This field is used if you enable Sig Digits. It is used for the processing of incoming calls and indicates the number of digits starting from the last digit of the called number used to route calls coming into the PRI span. See Prefix DN and Sig Digits.
45-14
OL-1047-01
Chapter 45
Field Sig Digits
Description Represents the number of final digits a PRI span should retain on inbound calls. A trunk with significant digits enabled truncates all but the final few digits of the address provided an inbound call.
Usage Notes Enable or disable this box depending on whether you want to collect significant digits. If disabled, the Cisco CallManager does not truncate the inbound number. If enabled, you also need to choose the number of significant digits to collect.
Prefix DN
Specifies the prefix digits that are appended to the digits this trunk receives on incoming calls.
The Cisco CallManager adds prefix digits after first truncating the number in accordance with the Num Digits setting.
Presentation Bit
Determines whether the central Select Allowed if you want the Central office transmits or blocks caller ID. Office to send caller ID. Select Restricted if you do not want the Central Office to send caller ID.
Called party IE number type unknown
The format for the type of number in Use the following definition for each of the variables: called party directory numbers. Cisco CallManager sets the called CallManagerThe directory number (DN) type. We Cisco CallManager sets the directory recommend that you do not change number type. the default value unless you have InternationalUse when you are advanced experience with dialing dialing outside the dialing plan for plans, such as NANP or the your country. European dialing plan. You may need to change the default in Europe NationalUse when you are dialing because Cisco CallManager does within the dialing plan for your not recognize European national country. dialing patterns. You can also change this setting when connecting UnknownThe dialing plan is unknown. to PBXs using routing as a non-national type number.
45-15
Field Calling party IE number type unknown
Description
Usage Notes
The format for the type of number in Use the following definition for each of the variables: calling party directory numbers. Cisco CallManager sets the calling directory number (DN) type. We recommend you do not change the default value unless you have advanced experience with dialing plans, such as NANP or the European dialing plan. You may need to change the default in Europe because Cisco CallManager does not recognize European national dialing patterns. You can also change this setting when connecting to PBXs using routing as a non-national type number. The format for the numbering plan in called party directory numbers. Cisco CallManager sets the called DN numbering plan. We recommend that you do not change the default value unless you have advanced experience with dialing plans, such as NANP or the European dialing plan. You may need to change the default in Europe because Cisco CallManager does not recognize European national dialing patterns. You can also change this setting when connecting to PBXs using routing as a non-national type number.
CallManagerThe Cisco CallManager sets the directory number type. InternationalUse when you are dialing outside the dialing plan for your country. NationalUse when you are dialing within the dialing plan for your country. UnknownThe dialing plan is unknown.
Called Numbering Plan
Use the following definition for each of the variables: CallManagerThe Cisco CallManager sets the Numbering Plan in the directory number. ISDNUse when you are dialing outside the dialing plan for your country. National StandardUse when you are dialing within the dialing plan for your country. PrivateUse when you are dialing within a 'private' network. UnknownThe dialing plan is unknown.
45-16
OL-1047-01
Chapter 45
Field
Description
Usage Notes Use the following definition for each of the variables: CallManagerThe Cisco CallManager sets the Numbering Plan in the directory number. ISDNUse when you are dialing outside the dialing plan for your country. National StandardUse when you are dialing within the dialing plan for your country. PrivateUse when you are dialing within a 'private' network. UnknownThe dialing plan is unknown. Determine the switch to which you are connecting and the preferred protocol, as follows:

Calling Numbering The format for the numbering plan Plan in calling party directory numbers. Cisco CallManager sets the calling DN numbering plan. We recommend that you do not change the default value unless you have advanced experience with dialing plans, such as NANP or the European dialing plan. You may need to change the default in Europe because Cisco CallManager does not recognize European national dialing patterns. You can also change this setting when connecting to PBXs using routing as a non-national type number. PRI Protocol Type The communications protocol for the span:

4E AT&T InterExchange carrier 5E8 CustomCisco IP Phone 5E9 and NI2AT&T family local exchange switch or carrier Australian European ISDN DMSMCI family local exchange switch or carrier ETSI SCEuropean local exchange carrier on T1; also Japanese local exchange. EuroEuropean ISDN
Nortel Meridian5E8 Custom Lucent Definity4ESS or 5E8 Madge (Teleos) box5E8 Teleos Intecom PBX5E8 Intecom
Alternatively, select the protocol based on the carrier:

MCIDMS-250 SprintDMS-250 or DMS-100 AT&T4ESS
45-17
Field Inhibit restarts at PRI initialization
Description A RESTART is a message that confirms the status of the ports on a PRI span. If RESTARTs are not sent, they are assumed to be in service. Enable to view the B-channel status in the debug window.
Usage Notes Enable or disable. When the D-Channel successfully connects with another PRI's D-Channel it sends restarts when this option is disabled.
Enable status poll
Number of digits to The number of digits to strip on strip outbound calls, from 0 to 32.
For example, 8889725551234 is dialed, and the number of digits to strip is 3. In this example, 888 is stripped from the outbound number.
Zero Suppression
Determines how the T1 or E1 span For a T1, this could be AMI (Alternate electrically codes binary 1's and 0's Mark Inversion) or B8ZS (Bipolar 8-Zeros on the wire (line coding selection). Substitution). For an E1, this could be AMI or HDB3 Determines the multiframe format of the span. The choices are (for T1)

Framing
SFsuperframe consisting of 12 frames ESFextended superframe consisting of 24 frames. E1 is always ESF (Extended Superframe, consisting of 16 frames)
FDL Channel
Only relevant on T1 spans. Choices are: Determines what kind, if any, facility data link is supported by the ANSI T.401 span. The FDL is a maintenance AT&T PUB 54016 channel that allows remote troubleshooting of link-layer none problems, and remote monitoring of performance statistics of the link.
45-18
OL-1047-01
Chapter 45
Field Yellow Alarm
Description Determines how a remote alarm indication is coded on a T1 span. A yellow alarm indicates that the other end of the link has lost frame synchronization on the signal being transmitted by this end. Adjusts the gain of audio entering or leaving the span.
Usage Notes Choices include F-bit (out of band signaling; allows 64kbps clear channel bearer capability per B-channel), or bit-2 (in band signaling; robs bit 2 of every channel).
Trunk Level Audio Signal Adjustment into IP Network
Specifies the gain or loss applied to Select the gain or loss you want applied to the received audio signal relative to the received audio signal relative to the the port application type. following port application types: AnalogCOTrunkMinus3db DigitalToAnalogCONoDbPadding AnalogTieTrunkNoDbPadding DigitalToDigitalCONoDbPadding ISDNStationNoDbPadding ISDN_DigitalTieTrunkNoDbPadding ISDNTrunkNoDbPadding OnPremisePOTSLinePlus3db OffPremisePOTSLineNoDbPadding SatelliteAnalogTieTrunkNoDbPadding SatelliteDigitalTieTrunkNoDbPadding AnalogTollTrunkPlus3db
45-19
Field
Description
Usage Notes
Audio Signal Specifies the gain or loss applied to Select the gain or loss you want applied to Adjustment from IP the transmitted audio signal relative the transmitted audio signal relative to the Network to the port application type. following port application types:

AnalogCOTrunkMinus6db DigitalToAnalogCOMinus3db AnalogTieTrunkNoDbPadding DigitalToDigitalCONoDbPadding ISDNStationNoDbPadding ISDN_DigitalTieTrunkNoDbPadding ISDNTrunkNoDbPadding OnPremisePOTSLinePlus3db OffPremisePOTSLineMinus3db SatelliteAnalogTieTrunkMinus3db SatelliteDigitalTieTrunkMinus3db AnalogTollTrunkNoDbPadding
Card Location
Select the slot position from the drop-down list box. A slot position refers to the peripheral component interconnect (PCI) card slot into which the digital signal processor (DSP) card is plugged.
Only appears on a DT-24 Gateway. When adding a new card to the digital access, always add cards from right to left when viewing the gateway from the back. The first (oldest) card should be in the right-most slot, and each subsequent card should be installed in the next available slot position, moving from right to left. If you have existing cards that were not installed in the right-most positions, move the original cards to the right-most slots before adding the new card.
45-20
OL-1047-01
Chapter 45
Related Topics

Cisco Access Digital Trunk Gateways, page 45-4 Catalyst 6000 Family T1/E1 Line Cards, page 45-5 Updating Device Loads, page 7-7
Adding an MGCP Gateway

To use an MGCP gateway, you must use the FXO or FXS analog ports.
Before You Begin
Before using adding an MGCP gateway to Cisco CallManager, you must configure the gateway using the Cisco IOS command line interface (CLI). For procedures and commands required to perform this configuration, refer to the configuration documentation supplied with the gateway.
Procedure
Step 1 Step 2
Open Cisco CallManager Administration. Select Device > Add a New Device. The Add Device screen appears.
Step 3
Step 4
Select an MGCP gateway, such as the Cisco VG200, from the Gateway Type drop-down list box. When you select a Gateway type, the appropriate Device Protocol for the selected Gateway type. In this case, Not Required for MGCP is selected.
Step 5 Step 6
Click Next. Enter the appropriate settings, as described in Table 45-4. Slot 0 is not used on the Cisco VG200 gateway.
45-21
Table 45-4 MGCP Configuration Settings
Field MGCP Domain Name
Description Uniquely identifies the Cisco MGCP gateway.
Usage Notes
For example, if the hostname is configured on the gateway to resolve to vg200-1 (the IP domain Use the Domain Name Service name is not configured) you would (DNS) host name if it is configured only need to enter the hostname in to resolve correctly. Otherwise use this field (in this case, vg200-1). the host name as defined on the If the hostname is configured on the Cisco MGCP gateway. gateway as vg200-1 and the IP You must use the same value here domain name is configured on the that is used to configure the gateway as cisco.com, you would Cisco MGCP gateway at the IOS enter vg200-1.cisco.com in this command line. field. Clarifies the purpose of the device.
Description Module in Slot 0 Module in Slot 1 Module in Slot 2 Module in Slot 3 . . . (and so on)
Installed Voice Interface Cards For each available slot on the selected MGCP gateway, select the type of network module installed:
The correct number of slots are displayed for each model of MGCP gateway.
NM-1V Has one Voice Interface Card (VIC) in SubUnit 0. NM-2V Can have two VICs, one in SubUnit 0 and one in SubUnit 1. None No network modules installed.
Step 7
Click Insert. The screen automatically updates to add options for configuring the type of installed Voice Interface Cards (VIC) in Sub-Unit, which can be VIC-2FXO (two FXO ports), VIC-2FXS (two FXS ports), or None.
Step 8
Click Update.
45-22
OL-1047-01
Chapter 45
The screen automatically updates to add options for configuring endpoint information for the type of VICs configured in the previous screen.
Step 9
To configure ports on an MGCP gateway, see the Configuring Ports on a Cisco MGCP Gateway section on page 45-35.
Related Topics

Cisco VG200 Gateway, page 45-6 Configuring Ports on a Cisco MGCP Gateway, page 45-35
Adding an H.323 Gateway

Follow these instructions to add an H.323 gateway to Cisco CallManager.
Procedure
Step 1 Step 2
Open Cisco CallManager Administration. Select Device > Add a New Device. The Add Device screen appears.
Step 3
Step 4 Step 5
Select H.323 Gateway from the Gateway Type drop-down list box. Select a device protocol from the Device Protocol drop-down list box. Two device protocols are available:

H.225 (default) Inter-cluster Trunk An inter-cluster trunk is a virtual H.323 gateway that is used to interlink Cisco CallManagers in different clusters.
Click Next. Enter the appropriate settings as described in Table 45-5. Click Insert.
45-23
Table 45-5 H.323 Gateway Configuration Settings
Field Device Name
Description Specifies unique name used by Cisco CallManager to identify the device. Clarifies the purpose of the device. Specifies the collection of properties for this device including CallManager Group, Date/Time Group, Region, and Calling Search Space for auto-registration of devices. Specifies the collection of Route Partitions searched to determine how a collected (originating) number should be routed. Specifies the remote location accessed using restricted bandwidth connections. The pattern you want to use for Caller ID, from 0 to 24 digits.
Usage Notes
Location
Caller ID DN
555XXXX = variable Caller ID, where X is equal to an extension number. The CO appends the number with the area code if you do not specify it. 5555000 = Fixed Caller ID. Use when you want the Corporate number to be sent instead of the exact extension from which the call is placed. The CO appends the number with the area code if you do not specify it.
45-24
OL-1047-01
Chapter 45
Table 45-5 H.323 Gateway Configuration Settings (continued)
Description
Usage Notes
Any outbound call on a gateway can The following options specify send directory number information. which directory number is sent: This field determines which Originatorsend the directory directory number is sent. number of the calling device.
First Redirect Numbersend the directory number of the redirecting device. Last Redirect Numbersend the directory number of the last device to redirect the call.
Presentation Bit
Determines whether the central Select Allowed if you want the office transmits or blocks caller ID. Central Office to send caller ID. Select Restricted if you do not want the Central Office to send caller ID.
Display IE Delivery
When this box is checked, it enables By default, Display IE Delivery is delivery of the display IE in SETUP disabled. and CONNECT messages for the calling and called party name delivery service. The Domain Name Service (DNS) name or IP address of the H.323 gatekeeper. A gatekeeper is an H.323 entity on the LAN that supports the H.225 RAS message set used for admission control, bandwidth allocation, and dial pattern resolution. It controls access to the LAN for connections between H.323-compliant devices such as terminals and gateways. Use only for H.323-compliant gateways. All other devices do not use this box.

Gatekeeper Name
If your device is not gatekeeper controlled, select None. If the H.225 device will be controlled by a remote Gatekeeper, select the name of the Gatekeeper from the drop-down list.
45-25
Table 45-5 H.323 Gateway Configuration Settings (continued)
Field Media Termination Point Required
Description Determines whether or not a Media Termination Point is used to implement features that H.323 does not support (such as hold and transfer). Specifies the number of significant digits to collect, from 0 to 32. Significant digits are counted from the right (last digit) of the number called.
Usage Notes Used for H.323 clients only and those H.323 devices that do not support the H.245 Empty Capabilities Set message. This field is used if you enable Sig Digits. It is used for the processing of incoming calls and indicates the number of digits starting from the last digit of the called number used to route calls coming into the H.323 device. See Prefix DN and Sig Digits. Enable or disable this box depending on whether you want to collect significant digits. If disabled, the Cisco CallManager does not truncate the inbound number. If enabled, you also need to choose the number of significant digits to collect (see Num Digits).
Num Digits
Sig Digits
Represents the number of final digits retained on inbound calls. A trunk with significant digits enabled truncates all but the final few digits of the address provided an inbound call.
Prefix DN
Specifies the prefix digits that are The Cisco CallManager adds prefix appended to the called party number digits after first truncating the on incoming calls. number in accordance with the Num Digits setting.
Related Topics
Understanding Other H.323 Devices, page 45-6
45-26
OL-1047-01
Chapter 45
Configuring Gateways Configuring Gateway Ports in Cisco CallManager
Configuring Gateway Ports in Cisco CallManager

After adding gateways to Cisco CallManager refer to these sections to configure the ports on the analog gateways in your network:

Configuring Ports on Analog Gateways, page 45-27 Configuring Ports on a Cisco MGCP Gateway, page 45-35
Configuring Ports on Analog Gateways

You can configure ports on the analog devices added to Cisco CallManager. Follow these procedures to configure ports on these analog gateways:

Configuring POTS Ports

Use this procedure to configure POTS ports on these devices:

Cisco Access Analog AS-2, AS-4, and AS-8 Gateways Cisco Catalyst 6000 24 Port FXS Gateway
Before You Begin
You must add a Cisco analog gateway before configuring ports. See Adding an Analog Gateway section on page 45-7 for instructions.
Procedure
Step 1 Step 2
Open Cisco CallManager Administration. Select Device > Gateway. The Find and List Gateways screen appears.
Step 3
Enter the appropriate search criteria to locate the analog gateway to which you want to add ports and click Find.
45-27
Chapter 45 Configuring Gateway Ports in Cisco CallManager
Step 4
Select the name of the analog access gateway from the list of gateways that matched the search criteria. The screen updates to display the Gateway Configuration screen with information for the selected analog access gateway.
Step 5 Step 6
Click Add a New Port at the top of the list of ports on the left side of the page to display a dialog for adding ports. Select POTS as the port type. The screen updates to add configuration options for Port Number and End Port Number.
Step 7
Select whether you want to add and configure all available ports, a single port, or a range of ports by setting values for the Port Number and End Port Number fields.

To create a single port, specify the same number in the Port Number and End Port Number fields. To add all available ports, you must select All Ports for both the Port Number and End Port number fields.
To modify additional settings, click Advanced. Enter the appropriate settings, as described in Table 45-6. Click Insert and Close to apply the changes and close the window. Once you have inserted and configured the POTS ports, the screen refreshes and displays the POTS ports in the list on the left-hand side of the screen. To the right of each new port is link (Add DN) to the Configure a Directory Number page in Cisco CallManager Administration.
Step 11
Add directory numbers to the new ports. For each new POTS port, click the Add DN link to open the Configure a Directory Number page. Refer to the section Adding a Directory Number section on page 46-19 and Table 46-2 on page 46-20 for information about directory number configuration settings.
45-28
OL-1047-01
Chapter 45
Table 45-6 POTS Port Configuration Settings
Field Port Direction
Description The direction of calls passing through this port:

Usage Notes
InboundUse for incoming calls only OutboundUse for outgoing calls BothwaysInbound and outbound calls (default)
Port Level Audio Signal Adjustment into IP Network
Adjusts the gain of audio entering or leaving the span. Specifies the gain or loss applied Select the gain or loss you want applied to the received audio signal relative to the following to the received audio signal port application types: relative to the port application type. AnalogCOTrunkMinus3db DigitalToAnalogCONoDbPadding AnalogTieTrunkNoDbPadding DigitalToDigitalCONoDbPadding ISDNStationNoDbPadding ISDN_DigitalTieTrunkNoDbPadding ISDNTrunkNoDbPadding OnPremisePOTSLinePlus3db OffPremisePOTSLineNoDbPadding SatelliteAnalogTieTrunkNoDbPadding SatelliteDigitalTieTrunkNoDbPadding AnalogTollTrunkPlus3db
45-29
Table 45-6 POTS Port Configuration Settings (continued)
Field
Description
Usage Notes
Audio Signal Specifies the gain or loss applied Select the gain or loss you want applied to the transmitted audio signal relative to the Adjustment from IP to the transmitted audio signal following port application types: Network relative to the port application type. AnalogCOTrunkMinus6db

DigitalToAnalogCOMinus3db AnalogTieTrunkNoDbPadding DigitalToDigitalCONoDbPadding ISDNStationNoDbPadding ISDN_DigitalTieTrunkNoDbPadding ISDNTrunkNoDbPadding OnPremisePOTSLinePlus3db OffPremisePOTSLineMinus3db SatelliteAnalogTieTrunkMinus3db SatelliteDigitalTieTrunkMinus3db AnalogTollTrunkNoDbPadding
Prefix DN
Specifies the prefix digits that The Cisco CallManager adds prefix digits are appended to the digits this after truncating the number in accordance trunk receives on incoming calls. with the Num Digits setting. This field is used for the processing of Specifies the number of significant digits to collect, from incoming calls and indicates the number of digits starting from the last digit of the called 0 to 32. number used to route calls coming into the Significant digits are counted from the right (last digit) of the PRI span. See Prefix DN. number called. Number of digits expected on the Leave zero as the default value if you are inbound side of the trunk. unsure. This field is rarely used. The default is 1500 ms. We recommend always using default values for this timer.
Num Digits
Expected Digits
Call Restart Timer (1000-5000 ms)
45-30
OL-1047-01
Chapter 45
Table 45-6 POTS Port Configuration Settings (continued)
Field
Description
Usage Notes We recommend always using default values for this timer. We recommend always using default values for this timer. We recommend always using default values for this timer.
Offhook Validation The default is 100 ms. Timer (100 -1000 ms) Onhook Validation Timer (100 -1000 ms) Hookflash Timer (100 - 1500 ms) The default is 250 ms.
The default is 1000 ms.
Related Topics

Cisco Access Analog Gateways, page 45-3 Catalyst 6000 Family Analog Line Card, page 45-4 Adding an Analog Gateway, page 45-7 Adding a Directory Number, page 46-19
Configuring Loop Start Ports

Use this procedure to configure loop start ports on these devices:
Cisco AT-2, AT-4, and AT-8 Gateways
Before You Begin
You must add a Cisco analog gateway before configuring ports. See Adding an Analog Gateway section on page 45-7 for instructions.
Procedure
Step 1 Step 2
45-31
Step 3 Step 4
Enter the appropriate search criteria to locate the analog gateway to which you want to add loop start ports and click Find. Select the name of the analog access gateway from the list of gateways that matched the search criteria. The screen updates to display the Gateway Configuration screen with information for the selected analog access gateway.
Step 5 Step 6
Click Add a New Port at the top of the list on the left side of the page to display a dialog for adding ports. Select Loop Start as the port type. The screen updates to add Port Number and End Port Number configuration options
Step 7
Select whether you want to add and configure all available ports, a single port, or a range of ports by setting values for the Port Number and End Port Number fields.

To create a single port, specify the same number in the Port Number and End Port Number fields. To add all available ports, you must select All Ports for both the Port Number and End Port number fields.
To modify additional settings, click Advanced. Enter the appropriate settings as described in Table 45-7. Click Insert and Close to add the ports and close the window.
Table 45-7 Access Analog Loop Start Port Configuration Settings
Field Port Direction

Usage Notes
Inbound. Use for incoming calls only Outbound. Use for outgoing calls Both Ways. Inbound and outbound calls
45-32
OL-1047-01
Chapter 45
Table 45-7 Access Analog Loop Start Port Configuration Settings (continued)
Field Trunk Level Audio Signal Adjustment into IP Network
Description Adjusts the gain of audio entering or leaving the span. Specifies the gain or loss applied to the received audio signal relative to the port application type.
Usage Notes
Select the gain or loss you want applied to the received audio signal relative to the following port application types:

AnalogCOTrunkMinus3db DigitalToAnalogCONoDbPadding AnalogTieTrunkNoDbPadding DigitalToDigitalCONoDbPadding ISDNStationNoDbPadding ISDN_DigitalTieTrunkNoDbPadding ISDNTrunkNoDbPadding OnPremisePOTSLinePlus3db OffPremisePOTSLineNoDbPadding SatelliteAnalogTieTrunkNoDbPadding SatelliteDigitalTieTrunkNoDbPadding AnalogTollTrunkPlus3db
45-33
Field
Description
Usage Notes
Select the gain or loss you want applied to the Audio Signal Specifies the gain or loss Adjustment from IP applied to the transmitted audio transmitted audio signal relative to the following port application types: Network signal relative to the port application type. AnalogCOTrunkMinus6db

DigitalToAnalogCOMinus3db AnalogTieTrunkNoDbPadding DigitalToDigitalCONoDbPadding ISDNStationNoDbPadding ISDN_DigitalTieTrunkNoDbPadding ISDNTrunkNoDbPadding OnPremisePOTSLinePlus3db OffPremisePOTSLineMinus3db SatelliteAnalogTieTrunkMinus3db SatelliteDigitalTieTrunkMinus3db AnalogTollTrunkNoDbPadding Allowed Select if you want the Central Office to send caller ID Restricted Select if you do not want the Central Office to send caller ID
Caller ID Enable
Determines whether the Central Office transmits or blocks caller ID.
Attendant DN
For Loop_Start port type only. Type the number to which you want incoming The directory number to which calls routed. For example, zero or a directory you want incoming calls routed. number for an attendant. The default is 500 ms. We recommend always using default values for this timer. We recommend always using default values for this timer.
Delay Before Dialing Timer (100-5000 ms) Release Guard Timer (100-5000 ms)
The default is 2000 ms.
45-34
OL-1047-01
Chapter 45
Field
Description
Usage Notes We recommend always using default values for this timer. We recommend always using default values for this timer.
Incoming Ring Halt The default is 4500 ms. Timer (1000-8000 ms) Incoming Ring Validation Timer (100-2000 ms) The default is 400 ms.
Related Topics

Cisco Access Analog Gateways, page 45-3 Catalyst 6000 Family Analog Line Card, page 45-4 Adding an Analog Gateway, page 45-7
Configuring Ports on a Cisco MGCP Gateway

Refer to these sections to configure ports on the VG200 FXS or FXO:

Configuring FXS Ports on a Cisco MGCP Gateway, page 45-35 Configuring FXO Ports on Cisco MGCP Gateways, page 45-38
Configuring FXS Ports on a Cisco MGCP Gateway

Foreign Exchange Station (FXS) ports can be used to connect to any POTS device. Use this procedure to configure FXS ports on the Cisco VG200 gateway.
Before You Begin
You must add a Cisco VG200 gateway before configuring ports. See the Adding an MGCP Gateway section on page 45-21 for instructions.
45-35
Procedure
From the MGCP Configuration screen, click the endpoint identifiers of the FXS port you want to configure. Select Port Type > POTS. Enter the appropriate settings as described in Table 45-8. Click Insert. Once you have inserted a POTS port, the screen refreshes and displays the POTS port in the list on the left-hand side of the screen. To the right of the new port is an Add DN link.
Step 5
Click the Add DN link for the port to add a directory numbers to the new POTS port. Refer to the section Adding a Directory Number section on page 46-19 and Table 46-2 on page 46-20 for information about directory number configuration settings.
Table 45-8 POTS on MGCP Gateway Configuration Settings
Field
MGCP Member Information
Description Describes the purpose of the device. Identifies the Region selection for this device.
Usage Notes
This field is only used for Region selection. The list of Cisco CallManagers this port connects to is configured through IOS commands on the gateway.
Identifies the collection of route partitions searched to determine how a dialed number is routed.
45-36
OL-1047-01
Chapter 45
Table 45-8 POTS on MGCP Gateway Configuration Settings (continued)
Field
Port Information
Description Specifies the prefix digits that are appended to the digits received on incoming calls. Specifies the number of significant digits to collect, from 0 to 32. Significant digits are counted from the right (last digit) of the number called.
Usage Notes The Cisco CallManager adds prefix digits after first truncating the number in accordance with the Num Digits setting. This field is used for the processing of incoming calls and indicates the number of digits starting from the last digit of the called number used to route calls coming into the PRI span. See Prefix DN.
Prefix DN
Num Digits
Expected Digits
Number of digits expected on the inbound side of the trunk. Leave zero as the default value if you are unsure. This field is rarely used.
Related Topics

Cisco VG200 Gateway, page 45-6 Adding an MGCP Gateway, page 45-21 Adding a Directory Number section on page 46-19
45-37
Configuring FXO Ports on Cisco MGCP Gateways

Foreign Exchange Office (FXO) ports can be used for connecting to a central office or PBX. The following two subsections describe how to configure FXO ports for ground start and loop start:

Configuring Ground Start on an MGCP Gateway, page 45-38 Configuring Loop Start on MGCP Gateways, page 45-40
Cisco CallManager assumes all loop start trunks lack positive disconnect supervision. Configure trunks with positive disconnect supervision as ground start so that active calls can be maintained during a Cisco CallManager server fail-over.
Note
The physical characteristics of a Cisco VG200 gateway port are configured under Cisco VG200 configuration.
Configuring Ground Start on an MGCP Gateway

Use this procedure to configure FXO ports for ground start on an MGCP gateway.
Before You Begin
You must add an MGCP gateway before configuring ports. See the section Adding an MGCP Gateway section on page 45-21 for instructions.
Procedure
From the MGCP Configuration screen, click the endpoint identifiers of the FXO port you want to configure. Select Ground Start as the Port Type on the MGCP Member Configuration screen. Enter the appropriate settings as described in Table 45-9.
45-38
OL-1047-01
Chapter 45
Table 45-9 Ground Start on MGCP Gateway Configuration Settings
Field
Description Clarifies the purpose of device. Identifies the Region selection for this device.
Usage Notes
This field is only used for Region selection. The list of Cisco CallManagers this device connects to is configured through IOS commands on the gateway.
Specifies the collection of route partitions searched to determine how a dialed number should be routed. Specifies the remote location accessed using restricted bandwidth connections. The direction of calls passing through this port:

Location
Port Information
Port Direction
Inbound. Use for incoming calls only Outbound. Use for outgoing calls Both Ways. Inbound and outbound calls
Attendant DN
The directory number to which you Type the number to which you want want incoming calls routed. incoming calls routed. For example, zero or a directory number for an attendant.
45-39
Related Topics

Cisco VG200 Gateway, page 45-6 Adding an MGCP Gateway, page 45-21
Configuring Loop Start on MGCP Gateways

Use this procedure to configure FXO ports for loop start on MGCP gateways.
Before You Begin
You must add an MGCP gateway before configuring ports. See the section Adding an MGCP Gateway section on page 45-21 for instructions.
Procedure
From the MGCP Configuration screen, click the endpoint identifiers of the FXO port you want to configure. Select Loop Start as the Port Type on the MGCP Member Configuration screen. Enter the appropriate settings as described in Table 45-10.
Table 45-10 Loop Start on MGCP Gateway Configuration Settings
Field
Description Clarifies the purpose of the device. Identifies the Region selection for this device.
Usage Notes
This field is only used for Region selection. The list of Cisco CallManagers this gateway connects to is configured through IOS commands on the gateway.
Specifies the collection of route partitions searched to determine how a number should be routed.
45-40
OL-1047-01
Chapter 45
Configuring Gateways Modifying Gateways
Table 45-10 Loop Start on MGCP Gateway Configuration Settings (continued)
Field
Port Information

Usage Notes
Port Direction
Inbound. Use for incoming calls only. Outbound. Use for outgoing calls. Both Ways. Inbound and outbound calls.
Attendant DN
The directory number to which you For example, zero or a directory want incoming calls routed. number for an attendant.
Related Topics

Cisco VG200 Gateway, page 45-6 Adding an MGCP Gateway, page 45-21
Modifying Gateways
Using Cisco CallManager, you perform several tasks identically regardless of the gateway type, including:

Deleting Gateways, page 45-42 Resetting Gateways, page 45-42 Updating Gateways, page 45-43
45-41
Chapter 45 Modifying Gateways
Deleting Gateways
Complete the following steps to delete a gateway from Cisco CallManager.
Procedure
Step 1 Step 2
Open Cisco CallManager Administration. Select Devices > Gateway. The Find and List Gateways screen appears.
Step 3
Enter search criteria to locate a specific gateway. A list of discovered devices appears.
Step 4
Click the Delete icon next to the gateway you want to delete. A message appears verifying that you want to delete the gateway.
Step 5
Click OK.
Related Topics

Adding Gateways to Cisco CallManager, page 45-7 Finding Specific Gateways, page 45-44
Resetting Gateways
Complete the following steps to reset a gateway using Cisco CallManager.
Procedure
Step 1 Step 2
Open Cisco CallManager Administration. Select Device > Gateway. The Find and List Gateway screen appears.
Step 3
Enter search criteria to locate a specific gateway. A list of discovered devices appears.
45-42
OL-1047-01
Chapter 45
Configuring Gateways Modifying Gateways
Step 4
Click the Reset button next to the gateway you want to reset. The Reset Device window appears.
Step 5

Restart DeviceRestart a device without shutting it down. Reset DeviceShuts down a device and bring it back up.
Related Topics
Finding Specific Gateways, page 45-44
Updating Gateways
Complete the following steps to update a gateway from Cisco CallManager.
Procedure
Step 1 Step 2
Open Cisco CallManager Select Device > Gateway. The Find and List Gateways screen appears.
Step 3
Enter search criteria to locate a specific gateway. A list of discovered device appears.
Step 4
Select Device Name. The Gateway Configuration window appears.
Enter desired changes. Click Update. Reset the gateway to put the changes into effect.
Related Topics

Adding Gateways to Cisco CallManager, page 45-7 Finding Specific Gateways, page 45-44
OL-1047-01
45-43
Chapter 45 Finding Specific Gateways
Finding Specific Gateways

Because you might have hundreds of gateways in your network, Cisco CallManager enables you to locate specific gateways based on specific criteria. Use these sections to

Searching by Device Name, page 45-44 Searching by Description, page 45-45 Searching by Directory Number, page 45-46
Searching by Device Name

Use this option if you know the device name of a specific gateway or if you want to get a listing of all gateways registered with Cisco CallManager.
Procedure
Step 1 Step 2
Step 3
Select Device Name from the drop-down list box, then chose one of the following:

begins with contains ends with is exactly is not empty is empty
Step 4
Specify the appropriate search text, if applicable.
45-44
OL-1047-01
Chapter 45
Configuring Gateways Finding Specific Gateways
Step 5
Click Find. A list of discovered devices appears displaying:

Device icon Device name Description Device pool Delete Reset
Related Topics

Searching by Description, page 45-45 Searching by Directory Number, page 45-46
Searching by Description
Use this option if you know any of the key words used in the Description field of a specific gateway registered with Cisco CallManager.
Procedure
Step 1 Step 2
Step 3
Select Description from the drop-down list box, then chose one of the following:

begins with contains ends with is exactly
45-45
Step 4 Step 5
is not empty is empty
Specify the appropriate search text, if applicable. Click Find. A list of discovered devices appears displaying:

Device icon Device name Description Device pool Delete Reset
Related Topics

Searching by Device Name, page 45-44 Searching by Directory Number, page 45-46
Searching by Directory Number

Use this option to locate gateways assigned to a specific extension or range of extensions and registered with Cisco CallManager.
Procedure
Step 1 Step 2
Step 3
Select Directory Number from the drop-down list box, then chose one of the following:

begins with contains
45-46
OL-1047-01
Chapter 45
Configuring Gateways Finding Specific Gateways
Step 4 Step 5
ends with is exactly is not empty is empty
Specify the appropriate search text, if applicable. Click Find. A list of discovered devices appears displaying:

Device icon Device name Description Delete Reset
Related Topics

Searching by Device Name, page 45-44 Searching by Description, page 45-45
45-47
45-48
OL-1047-01
C H A P T E R
46
Configuring Cisco IP Phones in Cisco CallManager

Cisco IP Phones are full-featured telephones that can be plugged directly into your IP network. Cisco CallManager supports the following Cisco IP Phones:

Cisco IP Phone 7900 Family Cisco IP Phone 30 VIP Cisco IP Phone 12 SP+
The following devices are also configured through the Cisco CallManager Administration phone configuration pages:

H.323 Clients CTI Ports
Note
Devices such as analog phones or fax machines must be connected to a gateway (for example, a Cisco VG200 gateway). If you are administering a large number of phones at your site, you can use the Bulk Administration Tool (BAT) to perform batch add, modify, and delete operations for Cisco IP Phones instead of manually adding and configuring each phone using Cisco CallManager Administration. BAT is a plug-in application for Cisco CallManager. If BAT is already installed on your Cisco CallManager system, it can be accessed by opening Cisco CallManager administration and selecting Application > BAT.
46-1
Chapter 46 Understanding Cisco IP Phones
Refer to the Bulk Administration Tool Guide for Cisco CallManager for detailed instructions on configuring BAT to perform batch operations on Cisco IP phones.
Related Topics
The following topics provide information about working with and configuring Cisco IP phones in Cisco CallManager:

Understanding Cisco IP Phones, page 46-2 Configuring Cisco IP Phones, page 46-5 Finding a Phone, page 46-15 Configuring Phone Features, page 46-16 Configuring Directory Numbers, page 46-18 Configuring Phone Button Templates, page 47-1 Shared Line Appearances, page 46-25
Understanding Cisco IP Phones

The following topics describe the types of phones and other devices that can be configured through the Device > Phone area of Cisco CallManager Administration:

Cisco IP Phone 7900 Family Cisco IP Phone 30 VIP Cisco IP Phone 12 SP+ CTI Ports H.323 Clients
Cisco IP Phone 7900 Family

Cisco CallManager supports the Cisco IP Phone 7900 family of phones, which include the following models:

Cisco IP Phone 7960 Cisco IP Phone 7940
46-2
OL-1047-01
Chapter 46
Configuring Cisco IP Phones in Cisco CallManager Understanding Cisco IP Phones
Cisco IP Phone 7910
Cisco CallManager does not directly control all features on these phones through phone button templates. Refer to the Cisco IP Phone 7900 Family Administration Guide and the Getting Started publications for individual Cisco IP Phone 7900 Family models for detailed information.
Cisco IP Phone 7960

The Cisco IP Phone model 7960 is a full-featured, six-line business set that supports the following features:

An information (i) button Six programmable line or speed dial buttons Four fixed buttons for accessing voice mail messages and adjusting phone settings, services, and directories Four soft keys for displaying additional call detail and functionality A large LCD display that shows call detail and soft key functions An internal two-way speakerphone and microphone mute
Cisco IP Phone 7940

The Cisco IP Phone model 7940 is a two-line business set with features similar to the Cisco IP Phone model 7960. These include:

An information (i) button Two programmable buttons (these can be configured as two lines or one line and one speed dial) Four on-screen mode buttons for accessing voice mail messages and adjusting phone settings, services, and directories Four soft keys for displaying additional call detail and functionality A large LCD display that shows call detail and soft key functions An internal two-way speakerphone and microphone mute
46-3
Chapter 46 Understanding Cisco IP Phones
Cisco IP Phone 7910

The Cisco IP Phone 7910 is a single-line, basic feature phone designed primarily for common-use areas with medium telephone traffic such as lobbies or break rooms. It includes the following features:

Four dedicated feature buttons for Line, Hold, Transfer, and Settings Six programmable feature buttons that can be configured through phone button templates in Cisco CallManager Available features include Call Park, Redial, Speed Dial, Call Pickup, Conference, Forward All, Group Call Pickup, Message Waiting, and Meet-Me Conference.
A two-line LCD display (24 characters per line) that indicates the directory number, call status, date and time An internal two-way speakerphone and microphone mute
Cisco IP Phone 12 SP+

The Cisco IP Phone model 12 SP+ offers many of the same features as PBX or plain old telephone service (POTS) telephones. This IP phone includes the following features:

12 programmable line and feature buttons An LED associated with each of the 12 feature and line buttons to indicate feature and line status A two-line LCD display (20 characters per line) for call status and identification An internal two-way speakerphone and microphone mute
Cisco IP Phone 30 VIP

The Cisco IP Phone 30 VIP offers many of the same features as PBX or plain old telephone service (POTS) telephones. This IP phone includes the following features:
26 programmable line and feature buttons
46-4
OL-1047-01
Chapter 46
Configuring Cisco IP Phones in Cisco CallManager Configuring Cisco IP Phones
An LED associated with each of the 26 feature and line buttons to indicate feature and line status A two-line LCD for displaying date and time, calling party name, calling party number, and digits dialed An internal two-way speakerphone with microphone mute A transfer feature button
CTI Ports
CTI ports are virtual devices that are used by software-based Cisco CallManager applications such as Cisco SoftPhone, Cisco AutoAttendant, and Cisco IP Interactive Voice Response (IVR). CTI ports are configured through the same Cisco CallManager Administration area as phones, but require fewer configuration settings.

For general instructions on how to configure settings for CTI ports, refer to the Configuring Cisco IP Phones section on page 46-5. For information on how to configure CTI ports for use with a specific application, such as Cisco SoftPhone, refer to the documentation and online help provided with that application.
H.323 Clients
H.323 clients include Microsoft NetMeeting devices and NetVision Symbol phones. They are configured through the same Cisco CallManager Administration pages as phones, but require fewer configuration settings. For instructions on how to configure H.323 clients, refer to the Configuring Cisco IP Phones section on page 46-5.
Configuring Cisco IP Phones

When connecting a Cisco IP Phone to your IP telephony network, you can choose to allow the phone to auto-register itself with the Cisco CallManager database. By enabling auto-registration, you can automatically add phones to the database.
46-5
Chapter 46 Configuring Cisco IP Phones
However, in many cases, you might not want to use auto-registration. For example, auto-registration does not allow you to assign specific directory numbers to a phone. Instead, numbers are assigned sequentially based on the next available number designated in Cisco CallManager. If you do not use auto-registration, you must manually add phones to the Cisco CallManager database or use the Bulk Administration Tool (BAT). BAT is a plug-in application that enables system administrators to perform batch add, modify, and delete operations on large numbers of Cisco IP Phones. Refer to the Bulk Administration Tool Guide for Cisco CallManager for detailed instructions on using BAT. You can also delete, reset, update, and copy phones from Cisco CallManager. H.323 clients and CTI ports are also configured in this area of Cisco CallManager Administration, and are covered in the procedures in this section.
Related Topics

Displaying the MAC Address of a Phone, page 46-6 Adding a Phone, page 46-7 Deleting a Phone, page 46-11 Resetting a Phone, page 46-12 Updating a Phone, page 46-13 Copying an Existing Phone, page 46-14
Displaying the MAC Address of a Phone

The Media Access Control (MAC) address is a unique 12-character hexadecimal number that identifies a Cisco IP Phone or other hardware device. It is located on a label on the bottom of the phone (for example, 000B6A409C405 for Cisco IP Phone 7900 Family models or SS-00-0B-64-09-C4-05 for Cisco IP Phone SP 12+ and 30 VIP models). The MAC address is a required field for Cisco IP Phone device configuration. When entering the MAC address in Cisco CallManager fields, do not use spaces or dashes and do not include the "SS" that may precede the MAC address on the label.
46-6
OL-1047-01
Chapter 46
To display the MAC address when the phone is powered on:
Cisco IP Phone 7960 and 7940 models press Settings, use the arrow buttons to highlight the Network Configuration menu option, and press the Select softkey. Cisco IP Phone 7910 Press Settings, use the arrow buttons to locate Network Config options, press 6 on the phone keypad to begin displaying the Network Config options, then use the arrow keys to scroll the Network Config option display to the MAC address. Cisco IP Phone 12 SP+ and 30VIP models press ** to display the MAC address on the second line of the LCD display.
For more information about displaying additional configuration settings on Cisco IP Phones, refer to the Cisco IP Phone 7900 Family Administration Guide and the individual Getting Started publications provided with Cisco IP Phones.
Adding a Phone
Before a Cisco IP Phone can be used, you must add the phone to Cisco CallManager.
Procedure
Step 1 Step 2
Open Cisco CallManager Administration. Select Device > Add a Device. The Add a New Device page displays.
Step 3
Select Phone from the Device Type drop-down list box and click Next. The Add a New Phone page displays.
Step 4
Select the appropriate phone type (Cisco IP Phone model, H.323 client, or CTI port) from the phone type drop-down list and click Next. The Phone Configuration page displays.

Once you select a phone type, you cannot modify it. CTI ports are virtual devices used by Cisco CallManager applications such as Cisco SoftPhone and Cisco AutoAttendant
46-7
Step 5
H.323 clients can be Symbol NetVision phones or Microsoft NetMeeting clients.
Enter the appropriate settings as described in Table 46-1. These settings are not available for all phone types. Only the settings appropriate to the selected phone type will appear on your screen.
Table 46-1 IP Phone Configuration Settings
Field Device Information MAC Address
Description Media Access Control (MAC) address that identifies Cisco IP Phones (hardware phones only) Refer to the Displaying the MAC Address of a Phone section on page 46-6.
Usage Notes

Value must be 12 hexadecimal characters. This field is only displayed for hardware Cisco IP Phones
Device Name
Identifies software-based telephones.
Value can include 1 to 15 characters, including alphanumeric, dot, dash, or underscores. Only available for H.323 clients and CTI ports
Description Load Information
Clarifies the purpose of the device. Specifies custom software for a Cisco IP Phone. The value entered here overrides the default values for this type of device. Refer to the Setting Device Defaults section on page 15-1. The value entered here overrides the default value for this type of device. Refer to the Setting Device Defaults section on page 15-1.
Device Pool
Defines sets of common characteristics for devices, such as region, date/time group, Cisco CallManager group, and calling search space for auto-registration
46-8
OL-1047-01
Chapter 46
Table 46-1 IP Phone Configuration Settings (continued)
Field Location
Description Specifies the remote location accessed using restricted bandwidth connections.
Usage Notes
Calling Search Space Specifies the collection of Route Partitions searched to determine how a dialed number should be routed. Button Template Determines the configuration of buttons on a phone and identifies which feature (line, speed dial, and so on) is used for each button. The value entered here overrides the default value for this type of device. Refer to the Setting Device Defaults section on page 15-1. Not available for H.323 clients or CTI ports. For example, in North America:
H.323 Client-Specific Device Information Outgoing Caller ID Pattern Specifies the number to send as Caller ID for outgoing calls. NNNXXXX = variable Caller ID, where XXXX is equal to an extension number or directory number (X is a number from 0 to 9) and NNN is the office code. The Central Office (CO) prepends the number with the area code if you do not specify it. 5555000 = Fixed Caller ID. Use when you want the Corporate number to be sent instead of the exact extension from which the call is placed. The CO appends the number with the area code if you do not specify it.
46-9
Description Determines what to display if a call to this device is forwarded or transferred.
Usage Notes

Originatorsend the directory number of the calling device. First Redirect Numbersend the directory number of the redirecting device. Last Redirect Numbersend the directory number of the last device to redirect the call.
Caller ID Presentation
Determines whether the central office transmits or blocks caller ID. When this box is checked, it enables delivery of the display IE (incoming exclusion) in SETUP and CONNECT messages for the calling and called party name delivery service.
Select Allowed if you want the Central Office to send caller ID. Select Restricted if you do not want the Central Office to send caller ID. By default, Display IE Delivery is disabled.
Display IE Delivery
Media Termination Point Required
Used for H.323 devices that do not support Determines whether or not a Media Termination Point is used the H.245 Empty Capabilities Set message. to implement features that H.323 does not support (such as hold and transfer). Specifies the primary and secondary servers from which the phone obtains directory information. Only used for Cisco IP Phone 7960 and 7940 models.
Cisco IP Phone - External Data Locations (leave blank to use the default) Directory
Information
Specifies the location (UL) of Only used for Cisco IP Phone 7960 and the help text for the information 7940 models. (i) button.
46-10
OL-1047-01
Chapter 46
Field Services Messages
Description
Usage Notes
Specifies the location (URL) for Only used for Cisco IP Phone 7960 and Cisco IP Phone Services. 7940 models. Specifies the voice mail pilot Only used for Cisco IP Phone 7960 and directory number for messaging. 7940 models.
Click Insert. Add a directory number to this phone. Refer to the Adding a Directory Number section on page 46-19. You must reset the phone after making changes to apply the new settings. Refer to the Resetting a Phone section on page 46-12.
Related Topics

Resetting a Phone, page 46-12 Adding a Directory Number, page 46-19 Deleting a Phone, page 46-11 Updating a Phone, page 46-13
Deleting a Phone
Perform the following procedure to delete a Cisco IP Phone from Cisco CallManager.
Procedure
Step 1 Step 2
Open Cisco CallManager Administration. Select Device > Phone. The Find and List Phones page displays.
Step 3
Enter search criteria to locate a specific phone and click Find.
46-11
A list of phones that match the search criteria appears.

Step 4
Click the Delete icon next to the phone you want to delete. A message appears verifying that you want to delete the phone.
Step 5
Click OK.
Related Topics

Finding a Phone, page 46-15 Adding a Phone, page 46-7
Resetting a Phone
Perform the following procedure to reset a Cisco IP Phone using Cisco CallManager.
Before You Begin
If a call is in progress, the phone does not reset until the call is finished.
Procedure
Step 1 Step 2
Step 3
Enter search criteria to locate a specific phone and click Find. A list of phones that match the search criteria appears.
Step 4
Click the Reset button next to the phone you want to reset. The Reset Device page displays.
Step 5
Restart DeviceRestarts a device without shutting it down (re-registers the phone with Cisco CallManager).
46-12
OL-1047-01
Chapter 46
Reset DeviceShuts down a device and bring it back up (performs a complete shut-down and re-initialization of the phone).
Related Topics

Updating a Phone
Perform the following procedure to update a Cisco IP Phone from Cisco CallManager.
Procedure
Step 1 Step 2
Step 3
Step 4
Select the name of the phone you want to update from the list. The Phone Configuration page displays.
Enter desired changes. Click Update. Click Reset to reset the phone and apply the new settings.
Related Topics

46-13
Copying an Existing Phone

If you want to manually add several similar phones to the Cisco CallManager database, you can add one and then copy its basic settings to apply to another phone. You must change at least the Media Access Control (MAC) address before inserting the new phone into the database. Perform the following procedure to copy a phones settings.
Procedure
Step 1 Step 2
Step 3
Step 4
Click on the Copy icon for the phone whose settings you want to copy. The Phone Configuration page displays.
Enter the MAC address of the new phone. Enter additional desired changes. Click Insert. Once it is added, you can add and configure lines for the new phone.
Related Topics

Adding a Directory Number, page 46-19 Finding a Phone, page 46-15 Adding a Phone, page 46-7
46-14
OL-1047-01
Chapter 46
Configuring Cisco IP Phones in Cisco CallManager Finding a Phone
Finding a Phone
Because you might have thousands of Cisco IP Phones in your network, Cisco CallManager enables you to search for phones based on specified criteria. Follow these steps to search for a specific Cisco IP Phone in the Cisco CallManager database.
Procedure
Step 1 Step 2
Step 3
Select one of the following options from list of fields:

Device Name Description Directory Number Calling Search Space Device Pool
Step 4
Select one of the following options from the list of patterns:

begins with contains ends with is exactly exists is empty
Step 5 Step 6
Enter the item to search for in the Find field. Click Find. A list of the first 20 discovered devices appears. The devices in the list are sorted by the field you selected in Step 3. The total number of devices and pages are also listed on this page.
46-15
Chapter 46 Configuring Phone Features
Step 7
To view the next set of discovered devices, click Next.
Related Topics

Tips for Finding a Phone, page 46-16 Configuring Cisco IP Phones, page 46-5
Tips for Finding a Phone

Searching by Calling Search Space or Device Pool
If you select calling search space or device pool, the options available in the database display. You can select one of these options from the drop-down list box below the Find button.
Finding All Phones in the Database
To find all phones registered in the database, select Device Name from the list of fields, select is not empty from the list of patterns, then click Find.
Note
Analog phones and fax machines connected to gateways (such as a Cisco VG200) are not included in this list. Only phones configured in Cisco CallManager Administration are listed here.
Related Topics
Finding a Phone, page 46-15
Configuring Phone Features

Cisco CallManager enables you to configure these phone features on Cisco IP Phones: call waiting, call forward, call park, and call pickup.
Related Topics

Configuring Call Waiting, page 46-17 Configuring Call Forward, page 46-17
46-16
OL-1047-01
Chapter 46
Configuring Cisco IP Phones in Cisco CallManager Configuring Phone Features
Configuring Call Park, page 46-17 Configuring Call Pickup, page 46-18
Configuring Call Waiting

Call waiting lets users receive a second incoming call on the same line without disconnecting the first call. When the second call arrives, the user hears a brief call waiting indicator tone. Call waiting is configured on the Configure a Directory Number web page in Cisco CallManager Administration.
Related Topics
Adding a Directory Number, page 46-19
Configuring Call Forward

Call forward is a phone feature that allows a user to configure a Cisco IP Phone so that all calls destined for it ring another phone. There are three types of call forward:

Call forward allForwards all calls. Call forward busyForwards calls only when the line is in use. Call forward no answerForwards calls when the phone is not answered after four rings.
Call waiting is configured on the Configure a Directory Number web page in Cisco CallManager Administration.
Related Topics
Adding a Directory Number, page 46-19

Call park allows a user to place a call on hold so that anyone connected to the Cisco CallManager system can retrieve it.
46-17
Chapter 46 Configuring Directory Numbers
For example, if a user is on an active call at extension 1000, they can park the call to a call park extension such as 1234. Anyone connected to the system can then dial 1234 to retrieve the call. To use call park, the call park extension (in this case, 1234) must be added in Cisco CallManager Administration. The call park extension is added when configuring phone features in Cisco CallManager Administration.
Related Topics
Configuring Call Park, page 39-1

Call pickup allows you to use your phone to answer another ringing phone in your designated call pickup group. You configure call pickup when configuring phone features in Cisco CallManager. Refer to the Configuring Call Pickup section on page 40-1 for details. However, when adding a directory line, you can indicate the call pickup group. The call pick up group indicates a number that can be dialed to answer calls to this directory number (in the specified partition). See the Adding a Directory Number section on page 46-19 for details.
Related Topics

Adding a Directory Number, page 46-19 Configuring Call Pickup, page 40-1
Configuring Directory Numbers

Using Cisco CallManager, you can configure and modify directory lines assigned to specific phones. These sections provide instructions for working with directory lines. This area of Cisco CallManager Administration is where you perform tasks such as adding or removing directory lines, configuring call forward, call pickup, and call waiting, setting the display text that appears on the called partys phone when a call is placed from a line, and disabling ring on a line.
46-18
OL-1047-01
Chapter 46
Configuring Cisco IP Phones in Cisco CallManager Configuring Directory Numbers
Related Topics

Adding a Directory Number, page 46-19 Deleting a Directory Number, page 46-23 Updating a Directory Number, page 46-24 Shared Line Appearances, page 46-25
Adding a Directory Number

Follow these instructions to add a directory line to a specific phone.
Before You Begin
You must add a Cisco IP Phone to Cisco CallManager before adding a directory line. See the Adding a Phone section on page 46-7 for details.
Procedure
Step 1 Step 2
Step 3
Enter search criteria to locate a specific phone. A list of discovered devices appears.
Step 4
Select Device Name. The Phone Configuration page displays, with the lines listed on the left side.
Step 5
Select an unassigned line (Line 1, Line 2, and so on). The Configure a Directory Number page displays in a separate window.
Step 6
Enter the appropriate settings as described in Table 46-2.
46-19
Table 46-2 Directory Line Configuration Settings
Field
Directory Number
Description Indicates a dialable phone number. If the words Shared Line appear in red next to the directory number, the directory number appears on more than one device in the same partition. Refer to the Shared Line Appearances section on page 46-25 for more information.
Usage Notes
Directory Number
Values can include a maximum of 50 numeric characters except for (.) and (@). Can appear in more than one partition. Unique in combination with partition. Unique in combination with the Directory Number.
Partition
Indicates the route partition to which the directory number belongs. Collection of partitions that are searched for numbers called from this directory number.
Directory Number Settings
Changes cause update of the numbers listed in the Call Pickup Group field. Applies to all devices using this directory number.
Call Waiting
Specifies whether this directory number uses call waiting when a line is busy (On), responds with a busy signal (Off), or uses the system-wide default setting (Default). Indicates a number that can be dialed to answer calls to this directory number (in the specified partition).
Applies to all devices using this directory number.
Call Forward and Pickup Settings
Call Pickup Group
46-20
OL-1047-01
Chapter 46
Table 46-2 Directory Line Configuration Settings (continued)
Field Forward All
Description Indicates the directory number to which all calls are forwarded.
Usage Notes
Any dialable phone number, including an outside destination. Applies to all devices using this directory number. Any dialable phone number, including an outside destination. Applies to all devices using this directory number. Any dialable phone number, including an outside destination. Applies to all devices using this directory number. Applies to all devices using this directory number.
Forward Busy
Indicates the directory number that a call is forwarded to when the line is in use.
Forward No Answer
Indicates the directory number that a call is forwarded to when no one answers after four rings.
Indicates the Calling Search Space to use when forwarding to the specified destination. Calling Search Space can be configured for Forward All, Forward Busy, and Forward No Answer directory numbers.
Line Settings for this Phone
Display
Indicates text that appears on the called partys phone when a call is placed from this line.
Leave this field blank to have the system display the extension. Maximum of 30 alphanumeric characters. Typically use the users name or the directory number. Applies only to the current device.
46-21
Table 46-2 Directory Line Configuration Settings (continued)
Field Label
Description
Usage Notes
Indicates the text for the line button Applies only to the current device. on this phone.

Cisco IP Phone 7960The text is displayed on the LCD. Other Cisco IP PhonesThe text is not displayed but could be used when printing button templates. Applies only to the current device. Maximum of 30 number and X characters. The X characters must appear at the end of the pattern.
Disable ring on this line External Phone Number Mask
Stops the phone from ringing to indicate incoming calls. Indicates phone number (or mask) used to send Caller ID information when placing a call from this line.
Step 7 Step 8
Click Update. Click Reset Devices.
Related Topics

Finding a Phone, page 46-15 Adding a Phone, page 46-7 Deleting a Directory Number, page 46-23 Updating a Directory Number, page 46-24
46-22
OL-1047-01
Chapter 46
Deleting a Directory Number

Perform the following procedure to delete a directory number from a specific phone.
Procedure
Step 1 Step 2
Step 3
Enter the search criteria to locate a specific phone and click Find. A list of discovered devices appears.
Step 4
Select a Device Name. The Phone Configuration page displays, with the lines listed on the left side.
Step 5
Select the line you want to delete. The Directory Number configuration page displays.
Step 6
Click Delete. A message appears verifying that you want to delete the line.
Step 7
Click OK. The Phone Configuration page displays with the line deleted.
Step 8
Click Reset.
Related Topics

Finding a Phone, page 46-15 Adding a Directory Number, page 46-19 Updating a Directory Number, page 46-24
46-23
Updating a Directory Number

Follow these instructions to update a directory number assigned to a specific phone.
Procedure
Step 1 Step 2
Step 3
Enter search criteria to locate a specific phone. A list of phones that match the search criteria appears.
Step 4
Select the name of the phone to update. The Phone Configuration page displays, with the lines listed on the left side.
Step 5
Select the line you want to update. The Directory Number Configuration page displays.
Enter the desired changes. Click Update. Click Reset Devices.
Related Topics

Finding a Phone, page 46-15 Adding a Phone, page 46-7 Adding a Directory Number, page 46-19 Deleting a Directory Number, page 46-23
46-24
OL-1047-01
Chapter 46
Configuring Cisco IP Phones in Cisco CallManager Shared Line Appearances
Shared Line Appearances

In a Cisco CallManager system, a directory number (line) is considered to be a shared line if it appears on more than one device in the same partition. This is referred to as a shared line appearance. For example, a shared line can be set up so that a directory number appears on line 1 of a managers phone and also on line 2 of their assistants phone. Another example of a shared line would be a single incoming 800 number that is set up to appear as line 2 on every sales representatives phone in an office. The following notes and tips apply to using shared line appearances with Cisco CallManager:

You create a shared line appearance by assigning the same directory number and partition to different lines on different devices. If a line will be shared with other devices, the words Shared Line are displayed in red next to the directory number in the Configure a Line Number page in Cisco CallManager Administration. If you change the Calling Search Space, Call Waiting, or Call Forward and Pickup settings on any device that uses the shared line, the changes are applied to all devices that use that shared line. To stop sharing a line appearance on a device:
If the shared line is not line 1, change the directory number or partition
number for the line and update the device.

If the shared line is line 1, you must first delete the line from the device,
and then re-add the line with a new directory number or partition.

In the case of a shared line appearance, Delete will remove the directory number only on the current device. Other devices are not affected. Do not use shared line appearances on any phone that will be used with Cisco WebAttendant.
Related Topics

Adding a Directory Number, page 46-19 Deleting a Directory Number, page 46-23 Updating a Directory Number, page 46-24
46-25
Chapter 46 Shared Line Appearances
46-26
OL-1047-01
C H A P T E R
47
Configuring Phone Button Templates

Cisco CallManager includes several default phone button templates. When adding phones, you can assign one of these templates to the phones, or create a new template. Creating and using templates is a fast way to assign a common button configuration to a large number of phones. For example, if users in your company do not use the conference feature, you can create a template that reassigns this button to a different feature, such as speed dial. All phones must have at least one line assigned. Normally this is button 1 (with a feature index of 1). Phones can have additional lines assigned, depending on the Cisco IP Phone model. Phones also generally have several features, such as speed dial and call forward, assigned to the remaining buttons. The following sections provide details about using and working with the phone button templates:

Understanding Default Phone Button Templates, page 47-1 Adding Phone Button Templates, page 47-5 Modifying Phone Button Templates, page 47-9
Understanding Default Phone Button Templates

Although all Cisco IP Phones support similar features, these features are implemented differently on various models. For example, some models configure features such as Hold or Transfer using phone button templates; other models have fixed buttons or on-screen program keys for these features that are not
47-1
Chapter 47 Understanding Default Phone Button Templates
configurable. Also, the maximum number of lines or speed dials supported is different for some phone models. These differences require different phone button templates for specific models. A default phone button template is provided for each Cisco IP Phone model. The default templates can be used as is to quickly configure phones. They can also be copied and modified to create custom templates. Custom templates enable you to make features available on some or all phones, restrict the use of certain features to certain phones, configure a different number of lines or speed dials for some or all phones, and so on, depending on how the phone will be used. For example, you may want to create a custom template that can be applied to phones that will be used in conference rooms. Refer to the Adding Phone Button Templates section on page 47-5 and the Guidelines for Creating Custom Templates section on page 47-7 for more information.
Related Topics

Default Cisco IP Phone 7960 Template, page 47-2 Default Cisco IP Phone 7940 Templates, page 47-3 Default Cisco IP Phone 7910 Templates, page 47-3 Default Cisco IP Phone 30 SP+ Template, page 47-3 Default Cisco IP Phone 30 VIP Template, page 47-4 Default Cisco IP Phone 12-Series Template, page 47-4
Default Cisco IP Phone 7960 Template

The default Cisco IP Phone 7960 template uses buttons 1 and 2 for lines, and assigns buttons 3 through 6 as speed dial. Other phone features, such as call park, call forward, redial, hold, resume, voice mail, conferencing, and so on are accessed using soft keys on the Cisco IP Phone 7960.
Related Topics

Adding Phone Button Templates, page 47-5 Modifying Phone Button Templates, page 47-9
47-2
OL-1047-01
Chapter 47
Configuring Phone Button Templates Understanding Default Phone Button Templates
Default Cisco IP Phone 7940 Templates

Two preconfigured phone button templates are provided for the Cisco IP Phone 7940:

7940 (2-Line)Uses button 1 and 2 for lines. 7940 (1-Line)Uses button 1 for line 1 and button 2 for speed dial.
All Cisco IP Phone 7940 phones use one or the other of these templates. Phone features, such as call park, call forward, redial, hold, resume, voice mail, conferencing, and so on are accessed using soft keys on the Cisco IP Phone 7940.
Related Topics

Default Cisco IP Phone 7910 Templates

The default phone button template for the Cisco IP Phone 7910 (named Default 7910), uses button 1 for message waiting, button 2 for conference, button 3 for forwarding, buttons 4 and 5 for speed dial, and button 6 for redial. The Cisco IP Phone 7910 has fixed buttons for Line, Hold, Transfer, and Settings.
Related Topics

Default Cisco IP Phone 30 SP+ Template

The default Cisco IP Phone 30 SP+ template uses buttons 1 through 4 for lines, button 5 for call park, button 6 for redial, buttons 8 through 13 and 22 through 25 for speed dial, button 14 for message waiting indicator, button 15 for forward, and button 16 for conference.
47-3
Chapter 47 Understanding Default Phone Button Templates
Note
For the Cisco IP Phone 30 SP+ only, button 26 must be assigned Automatic Echo Cancellation (AEC).
Related Topics

Default Cisco IP Phone 30 VIP Template

The default Cisco IP Phone 30 VIP template uses buttons 1 through 4 for lines, button 5 for call park, button 6 for redial, buttons 8 through 13 and 22 through 25 for speed dial, button 14 for message waiting indicator, button 15 for call forward, and button 16 for conference.
Related Topics

Default Cisco IP Phone 12-Series Template

All Cisco IP Phone 12 Series phones (12 S, 12 SP, 12 SP+) use the default Cisco IP Phone 12 SP+ template. The default Cisco IP Phone 12 SP+ template uses buttons 1 and 2 for lines, button 3 for redial, buttons 4 through 6 for speed dial, button 7 for hold, button 8 for transfer, button 9 for forwarding, button 10 for call park, button 11 for message waiting, and button 12 for conference.
Related Topics

47-4
OL-1047-01
Chapter 47
Configuring Phone Button Templates Adding Phone Button Templates
Adding Phone Button Templates

Creating and using templates is a fast way to assign a common button configuration to a large number of phones. For example, if users in your company do not use the conference feature, you can create a template that reassigns this button to a different feature, such as speed dial. Default templates for each Cisco IP phone model are included with the Cisco CallManager. When adding phones, you can assign one of these templates to the phone, or create one of your own.
Before You Begin
If you are creating a custom phone button template, refer to the to the guidelines for creating new phone button templates. See the Guidelines for Creating Custom Templates section on page 47-7.
Procedure
Step 1 Step 2
Open Cisco CallManager Administration. Select Device > Phone Button Template. Decide which method to use to create this template:
Based on existing templatethe new template exactly duplicates the existing template. You must update this new template if you want it to be different from the original. New design for a specific phoneYou must set up each button individually.
Step 3
Choose a method to create this template:
Select a template and click Copy to create a new template. The new template exactly duplicates the existing template and automatically assigns it a new name. You must update this new template if you want it to be different than the original.
Select a phone and click Continue to create a new template and assign each button individually. The new template is preset with only the required settings for that specific phone type.
Step 4
Make desired changes to the fields described in Table 47-1.
47-5
Chapter 47 Adding Phone Button Templates
Table 47-1 Phone Button Configuration Settings
Field Template Name
Description Unique name used by Cisco CallManager to identify the template. Specifies the function of the phone button when the template is used. Specifies the instance of a feature so that templates can have multiple line and speed-dial buttons.
Usage Notes

Use any 1-50 characters. Each template must have a unique name.
Feature Index
Label
Text that appears when the template Cisco IP Phone 79xx model phones ignore this setting. is displayed in the Administration interface or printed on some Cisco IP Phones.
Step 5 Step 6
Click Insert to add the new template. Click View Button Layout to verify the button layout.
Related Topics

Guidelines for Creating Custom Templates, page 47-7 Understanding Default Phone Button Templates, page 47-1 Modifying Phone Button Templates, page 47-9
47-6
OL-1047-01
Chapter 47
Configuring Phone Button Templates Adding Phone Button Templates
Guidelines for Creating Custom Templates

Use the following guidelines when creating custom phone button templates:
Be sure that phone users receive a quick reference card or getting started guide that describes the most basic features of the custom template. If you create a custom template to be used by employees in your company, ensure that it includes the following features and that you describe them on the quick reference card you create for your users:
Cisco IP Phone 7960, 7940 Line (one or more). Cisco IP Phone 7910Forward all. Cisco IP Phone 12 SP+Line (one or more), hold, call park, and
forward all.
Cisco IP Phone 30 VIPLine (one or more), call park, and forward all.
Consider the nature of each feature in order to determine how to configure your phone button template. You might want multiple buttons assigned to Speed Dial and Line. However, you will usually require only one of the other features described in Table 47-2. For each feature you select, you must also select the number of times you would like this feature to appear on the phone button template (the Feature Index). Most features appear only once. The feature index tells the user which line or speed dial corresponds to that button (for example, Line 1, Speed Dial 2, and so on).
Table 47-2 Phone Feature Description
Feature AEC
Description If you are configuring a template for the Cisco IP Phone 30VIP, you must include one occurrence of this feature and assign it to button 26. Provides Auto Echo Cancellation (AEC) to reduce the amount of feedback the called party hears when the calling party is using a speakerphone. Users should press the AEC button on a Cisco IP Phone 30SP+ when using speakerphone. This button does not need to be pressed when speakerphone is not in use. No configuration is necessary for this feature to work. Used in conjunction with a headset apparatus so the user can press a button on the headset apparatus to answer and release (disconnect) calls.
Answer/release
OL-1047-01
47-7
Chapter 47 Adding Phone Button Templates
Table 47-2 Phone Feature Description (continued)
Feature Auto answer Call park
Description If this feature is programmed on the template, activating this button causes the speakerphone to go off-hook automatically when an incoming call is received. Used in conjunction with a call park number or range so that when the user presses this button, the call is parked at a directory number for later retrieval. You must have a call park number or range configured in the system for this button to work, and you should provide that number or range to your users so they can dial into the number(s) to retrieve calls. Call Pickup allows users to pick up incoming calls within their own group. The appropriate call pickup group number is dialed automatically when a user activates this feature. When users press this button, they are initiating an Ad-Hoc conference and will be conferencing other participants in one at a time. Only the person initiating an Ad-Hoc conference needs a Conference button. An Ad-Hoc conference device must be configured in Cisco CallManager Administration for this button to work. Users press this button to forward all calls to the designated directory number. Users can designate the forward all in the User Web pages, or you can designate a forward all number for each user in Cisco CallManager Administration. Group Call Pickup allows users to pick up incoming calls within their own group or in other groups. Users must dial the appropriate call pickup group number when using this feature Users press this button to place an active call on hold. To retrieve a call on hold, users press the flashing line button or lift the handset and press the flashing line button for the call on hold. The caller on hold hears a tone every 10 seconds to indicate the hold status. No configuration is necessary for this feature to work. Users press this button to dial a number or to answer an incoming call. You must have added line numbers on the user phone for this button to work. When users press this button, they are initiating a Meet-Me conference and they expect other invited users to dial into the conference. Only the person initiating a Meet-Me conference needs a Meet-Me button. You must have configured a Meet-Me conference device in Cisco CallManager Administration for this button to work.
Call pickup
Conference
Forward all
Group call pickup
Hold
Line Meet-Me conference
47-8
OL-1047-01
Chapter 47
Configuring Phone Button Templates Modifying Phone Button Templates
Table 47-2 Phone Feature Description (continued)
Feature Message waiting None Redial Speed-dial Transfer
Description Users press this button to connect to the voice messaging system. Use None to leave a button unassigned. Users press this button to redial the last number dialed on the Cisco IP Phone. No configuration is necessary for this feature to work. Users press this button to speed dial a specified number. Users can designate speed-dial numbers in the User Web pages. Users press this button to transfer an active call to another directory number. No configuration is necessary for this feature to work.
Related Topics

Understanding Default Phone Button Templates, page 47-1 Adding Phone Button Templates, page 47-5 Modifying Phone Button Templates, page 47-9
Modifying Phone Button Templates

You can make changes to the default templates included with Cisco CallManager or to custom templates you created. You can rename existing templates and modify them to create new ones, update custom templates to add or remove features, lines, or speed dials, and delete templates that are no longer being used.
Related Topics

Renaming a Phone Button Template, page 47-10 Deleting a Phone Button Template, page 47-11 Updating a Phone Button Template, page 47-12
47-9
Chapter 47 Modifying Phone Button Templates
Renaming a Phone Button Template

Renaming a template does not affect the phones that use that template. All Cisco IP Phones that use this template continue to use this template once it is renamed. You can use this feature to create a copy of an existing template that you can modify.
Procedure
Follow these steps to rename a phone button template:

Step 1 Step 2
Open Cisco CallManager Administration. Select Device > Phone Button Template. A listing of current phone button templates appears on the left side of the screen.
Step 3
Click the phone button template you want to rename. The phone button template configuration page displays.
Step 4 Step 5
Enter the new name in the Template Name field. Click Update. The template re-displays with the new name.
Related Topics

Adding Phone Button Templates, page 47-5 Deleting a Phone Button Template, page 47-11 Updating a Phone Button Template, page 47-12
47-10
OL-1047-01
Chapter 47
Configuring Phone Button Templates Modifying Phone Button Templates
Deleting a Phone Button Template

You can delete old or out-of-date phone templates that are not currently assigned to any of the phones in your system. You cannot delete a template that is assigned to one or more devices. All Cisco IP Phones using the template you want to delete must be reassigned to a different phone button template before you can delete the template.
Procedure
Step 1 Step 2
Step 3
Click the phone button template you want to delete. The phone button template configuration page displays.
Step 4
Click Delete. A message displays verifying that you want to delete the template.
Step 5
Click OK to delete the template. A message appears verifying that the template was deleted.
Step 6
Click OK to continue.
Related Topics

Adding Phone Button Templates, page 47-5 Updating a Phone Button Template, page 47-12 Renaming a Phone Button Template, page 47-10
47-11
Chapter 47 Modifying Phone Button Templates
Updating a Phone Button Template

You can update a phone button template to add or remove features, add or remove lines and speed dials, or assign features, lines, and speed dials to different buttons on the phone. If you update a phone template, be sure to inform affected users of the changes. Follow these instructions to update a phone button template.
Before You Begin
When you update a template, the change affects all phones that use the template.
Procedure
Follow these steps to update an existing phone button template:

Step 1 Step 2
Step 3
Click the phone button template you want to update. The phone button template configuration page displays.
Step 4 Step 5
Enter the desired changes. Click Update. The template reappears with the changes assigned to it. You must restart devices using the template after updating it.
Step 6
Click Restart Devices to apply the updated phone button template.
Related Topics

Adding Phone Button Templates, page 47-5 Deleting a Phone Button Template, page 47-11 Renaming a Phone Button Template, page 47-10
47-12
OL-1047-01
A R T
User Configuration
The following chapters explain how to configure user and directory information: Chapter 48, Adding a New User Chapter 49, Searching the Global Directory
C H A P T E R
48
Adding a New User

The User area in Cisco CallManager Administration allows the administrator to display and maintain information about Cisco CallManager users. Generally, completing user information is optional; the devices function whether or not you complete this information. However, information that you enter here is also accessed by Directory Services, Cisco WebAttendant, and the User Web pages. If you want to provide these features to your users, you must complete the information in the User area for all users and their directory numbers, and also for resources such as conference rooms or other areas with phones (this is useful for Cisco WebAttendant). For users to have Web access so they can change their speed dial and forward numbers on the Web, they must be associated with a device, and the name and directory number of that device must be specified in the user area. Refer to the Searching the Global Directory section on page 49-1 for details on updating information on existing users. This chapter includes the following topics:

Adding a User, page 48-2 Assigning Devices to a User, page 48-3
48-1
Chapter 48 How Cisco JTAPI uses the Directory
Adding a New User
How Cisco JTAPI uses the Directory

After you install Cisco JTAPI, you have access to the Cisco CallManager directory. The directory stores user profiles, application logic, and network-specific configuration information, such as the location of network resources and system administrator authentication. Cisco JTAPI uses the directory to determine which devices it has the privilege to control. This section summarizes what you need to know about using the directory.

Installing the Cisco CallManager also installs an embedded directory on the Cisco CallManager machine. This directory also provides the MetaLink utility, which migrates the configuration information for Cisco CallManager from the relational database system where it has been stored to the embedded directory where it becomes available for use with Cisco JTAPI.
Adding a User
The following procedure provides instructions on adding a user.
Procedure
Open Cisco CallManager Administration. Click User > Add a New User. Complete all the user fields in the User Information window. An asterisk (*) designates required fields.
48-2
OL-1047-01
Chapter 48
Adding a New User Assigning Devices to a User
Note
Cisco CallManager automatically generates the Auto Attendant Name Dialing field once all the other fields are completed. The manager name entered in the optional Manager field must already exist in the directory as a user. Cisco CallManager does not permit modifying the user ID once it is created.
Step 4
When you have completed the user information, you can either Save your changes and add the user by clicking Insert. Or, if you want to associate devices to this user, continue with the Assigning Devices to a User procedure.
Related Topics
The following list contains additional information and procedures related to this section:

How Cisco JTAPI uses the Directory, page 48-2 Assigning Devices to a User, page 48-3 Using Basic User Search, page 49-1 Using Advanced User Search, page 49-3
Assigning Devices to a User

Once you have added a user, you can assign devices over which they will have control. Some devices, such as phones, can be controlled by users. Other devices, such as CTI ports, can be controlled by applications that are identified as users. When users have control of a phone, they have the ability to control certain settings for that phone, such as speed dial and call forwarding. The User Device Assignment window consists of a device filter area and a list of available devices. These areas are described in the this section.
48-3
Chapter 48 Assigning Devices to a User
Adding a New User
Available Device List Filters
The device filter allows you to limit your list of devices by entering search criteria based on all or part of the device name, description, or directory number. To limit the list of available devices to a specific selection, enter the criteria by which you wish to search using the following methods:
select the device name, description, or directory number. select the comparison operator. enter a text or number entry.
For example, to list all extensions that begin with 5, you would select Directory Number begins with and then enter 5 in the text box.
Available Devices
Once you have specified the search criteria to display devices, all available devices that match your criteria appear in the Available Devices list. The list displays in groups of twenty devices and can be navigated using the buttons at the bottom of the window. You can page through the device list by clicking First, Previous, Next, and Last, or you can jump to a specific page by entering the page number in the page entry box and then clicking Page. If you are modifying the device assignment for an existing user, the devices previously assigned to that user appear in a group at the beginning of the device list. You can associate one or more devices to the user by selecting the checkbox next to that device. If a device has multiple extensions associated with it, each line extension appears in the list. You need to select only one line extension to select all the lines associated with that device. To assign devices to a user, you must access the User Information window for that user. Refer to the Using Basic User Search section on page 49-1 for information on accessing information on existing users.
48-4
OL-1047-01
Chapter 48
Adding a New User Assigning Devices to a User
Once the users User Information window displays, perform the following steps to assign devices:
Step 1 Step 2
Click Associate Devices. If you wish, limit the list of available devices by enter the search criteria in the device filter area. You should specify

the device name, description, or directory number the comparison operator a text or number entry
Then, click Select Devices.

Step 3
Select the check box of one or more devices you want to associate with the user. You can assign one primary extension from the devices to which the user is assigned by clicking the radio button in the right column for that device. Once you have completed the assignment, click Insert if you are assigning devices to a new user or Update if you are assigning devices to an existing user. Or, you can click Personal Information to return to the User Information window.
Step 4
Related Topics

How Cisco JTAPI uses the Directory, page 48-2 Adding a User, page 48-2 Using Basic User Search, page 49-1 Using Advanced User Search, page 49-3
48-5
Chapter 48 Assigning Devices to a User
Adding a New User
48-6
OL-1047-01
C H A P T E R
49
Searching the Global Directory

The Global Directory for Cisco CallManager (release 3.0 and later) contains every user within a Cisco CallManager directory. Cisco CallManager uses Lightweight Directory Access Protocol (LDAP) to interface with a directory that contains user information. This is an embedded directory supplied with Cisco CallManager. Its primary purpose is to maintain the associations of devices with users. You can access the Global Directory by using either a basic or an advanced user search. Refer the Adding a New User section on page 48-1 for details on adding and configuring a new user. This chapter includes the following topics:

Using Basic User Search, page 49-1 Using Advanced User Search, page 49-3
Using Basic User Search

The Basic User search utility searches the first name, last name, and user ID fields for matches of any substring that you enter as search criteria. For example, if you enter 'li in the search field, the search results would include users whose first name, last name or user ID match that substring, as indicated in the following list:
49-1
Chapter 49 Using Basic User Search
Last name Johnson Ni Collins Lin Ivey
First Name Charlie Liang Manny Mike Gabriel
User ID cjohnson lni mcollins michaell Gabrieli
If you enter two or more substrings separated by spaces, the search will look for matches of any of the substrings in any of the three search fields. The following procedure contains information about how to use the Global Directory Basic User Search engine.
Procedure
Open Cisco CallManager Administration. Click User > Global Directory. The page refreshes to the User Search page. Enter the first name, last name, user ID, or substring of the user for whom you are searching in the User Search field. From the resulting list of matching names, click on the desired name to get specific information on that user. On the User Information window, you can view or modify this users information. To save changed information, click Update. If you want to view or modify this users device assignment, refer to the Assigning Devices to a User section on page 48-3 for more information.
Related Topics

How Cisco JTAPI uses the Directory, page 48-2 Adding a User, page 48-2
49-2
OL-1047-01
Chapter 49
Searching the Global Directory Using Advanced User Search
Assigning Devices to a User, page 48-3 Using Advanced User Search, page 49-3
Using Advanced User Search

With the Advanced User Search utility, you can enter search criteria using three search fields and built-in Boolean logic to perform more complex searches. If you enter two or more names or substrings separated by spaces in any one field, the search will interpret the request with the OR relationship operator, and will look for matches where any of your specified criteria is true. For example, if you enter john jerry, the search will return all users whose first names are John or Jerry. If you enter a substring in two or more search fields, the search will interpret the request with the AND relationship operator and look for matches where both criteria are true. For example, if you enter Ling for first name and Chu for last name, the search will return the user named Ling Chu.
Tips
Use ORs with multiple entries in a single field, and ANDs across fields. For example, if you enter: First Name: john jane Last Name: jones smith UserID: jjones jsmith the search will be for (firstname='john OR 'jane) AND lastname='jones OR 'smith) AND (userid='jjones OR 'jsmith). The following procedure contains information about how to use the Global Directory Advanced User Search engine.
Procedure
Open Cisco CallManager Administration. Click User > Global Directory. Click Advanced Search. The page refreshes to the Advanced User Search page.
OL-1047-01
49-3
Chapter 49 Using Advanced User Search
Step 4 Step 5
Enter the first name, last name, and user ID search criteria of the user for whom you are searching in the appropriate fields. Click Search.
Note
Click Refine Search if you want to further limit your search. When refining a search, you can enter new search criteria and then click Search, or click Reset to populate the fields with the last search criteria. Click Clear to delete all entries from the fields.
Once the desired user appears is the search list, click on the user ID or name to display the Update User Information window. On the User Information window, you can view or modify this users information. To save changed information, click Update. If you want to view or modify this users device assignment, refer to the Assigning Devices to a User section on page 48-3 for more information.
Related Topics

How Cisco JTAPI uses the Directory, page 48-2 Adding a User, page 48-2 Assigning Devices to a User, page 48-3 Using Basic User Search, page 49-1
49-4
OL-1047-01
A R T
Appendices
The following appendices contain additional information related to Cisco CallManager and IP telephony: Appendix A, Cisco TAPI Service Provider Installation and Configuration Appendix B, Cisco JTAPI Installation and Configuration Appendix C, Creating Custom Cisco IP Phone Rings
C H A P T E R
Cisco TAPI Service Provider Installation and Configuration

The following sections outline the installation of the Cisco TAPI Service Provider (TSP) and describe some of the issues you need to be aware of after installation. The topics include:

Installing the Cisco TAPI Service Provider, page A-1 Activating the Cisco TAPI Service Provider, page A-3 Configuring the Cisco TAPI Service Provider, page A-4 Uninstalling the Cisco TAPI Service Provider, page A-9 Installing the Wave Driver, page A-10 Verifying the Cisco TAPI Service Provider Installation, page A-14 Setting up Client-Server Configuration, page A-16
Installing the Cisco TAPI Service Provider

The Cisco TAPI Service Provider software is installed either directly from the Cisco CallManager CD-ROM, or by browsing to the Cisco CallManager server and installing the Cisco TSP from the Applications > Install Plugins menu. To install the Cisco TSP from the Cisco CallManager CD-ROM, perform the following steps:
-1
Chapter Installing the Cisco TAPI Service Provider
Procedure
Insert the Cisco CallManager CD-ROM. Double-click on My Computer Double-click on the CD-ROM drive. Double-click on the Installs folder. Double-click Cisco TSP.exe. Follow the online instructions.
To install the Cisco TSP from the Cisco CallManager, perform the following steps:
Procedure
Step 1
Open a Web browser and enter the URL for Cisco CallManager Administration in the URL address text box (for example, http://callmanager/main.asp). Press Enter. Click Application > Install Plugins. Click Cisco Telephony Service Provider. On the Cisco TSP-Welcome window, click Continue. Follow the online instructions.
Note
Once the installation is complete, you must install the Cisco Wave drivers and then restart the computer. Refer to Installing the Wave Driver section on page A-10 for more information.
-2
OL-1047-01
Chapter
Cisco TAPI Service Provider Installation and Configuration Activating the Cisco TAPI Service Provider
Activating the Cisco TAPI Service Provider

When the Cisco TSP is installed, it is added to the set of active TAPI service providers. The Cisco TSP will be loaded by TAPI as required. If it has been removed or if some problem has occurred, it can be manually added to this set. To manually add the Cisco TSP to the list of telephony drivers, perform the following steps:
Procedure for Windows 2000
Open the Control Panel. Double-click Phone and Modem Options. On the Phone and Modem Options dialog box, click the Advanced tab.
Note
If the Cisco TSP is either not there or you removed it previously and want to add it now, you can do so from this window.
Click Add. On the Add Provider dialog box, select Cisco IP-PBX Service Provider. Click Add. The Cisco IP PBX Service Provider is now included in the provider list on the Phone and Modem Options window.
Step 7
At this point, you can either configure the Cisco TSP or click Close to complete the setup.
Procedure for Windows NT, Windows 98, and Windows 95

Open the Control Panel. Double-click Telephony. Click the Telephony Drivers tab.
-3
Chapter Configuring the Cisco TAPI Service Provider
Note
If the Cisco TSP is either not there or you removed it previously and want to add it now, you can do so from this window. Click Add. On the Add Driver dialog box, select Cisco IP-PBX Service Provider. Click Add. The provider list on the Phone and Modem Options window now includes the Cisco IP PBX Service Provider.
Step 7
At this point, you can either configure the Cisco TSP or click Close to complete the setup.
Configuring the Cisco TAPI Service Provider

You configure the Cisco TSP by setting parameters on the Cisco IP-PBS Service Provider configuration window, as illustrated in Figure 0-1.
-4
OL-1047-01
Chapter
Cisco TAPI Service Provider Installation and Configuration Configuring the Cisco TAPI Service Provider
Figure 0-1
Cisco IP-PBX Service Provider Configuration
-5
Table 0-1 contains a list of the fields that must be set and their descriptions:
Table 0-1 Cisco IP-PBX Service Provider Configuration Fields
Field group Automated Voice Calls
Description The number of Cisco wave devices you are using determines the number of possible automated voice lines (the default is five). You need to create the same number of CTI port devices in the Cisco CallManager. For example, if you enter 5 here, you need to create five CTI port devices in Cisco CallManager. We recommend that you use one line per device. If you change this number, you also need to remove and then reinstall any Cisco wave devices that you installed. This number is the maximum number of lines that can be simultaneously opened using both LINEMEDIAMODE_AUTOMATEDVOICE and LINEMEDIAMODE_INTERACTIVEVOICE. If you are not developing a third-party call control application, check the option to Enumerate only lines that support automated voice so that the Cisco TSP sees only lines associated with a CTI port device.
Silence Detection
If you use silence detection, this checkbox informs the wave driver which method to use to detect silence on lines that support automated voice calls using the Cisco Wave Driver. If the checkbox is checked (default), the wave driver looks for the absence of audio stream RTP packets. Because all devices on the network suppress silence and stop sending packets, this provides a very efficient method for the wave driver to detect silence. However, if some phones or gateways do not perform silence suppression, the wave driver must analyze the content of the media stream and at some threshold, declare that silence is in effect. This method is CPU-intensive but handles media streams from any type of device. If some phones or gateways on your network do not perform silence suppression, you must specify the energy level at which the wave driver declares that silence is in effect. This value of the 16-bit linear PCM energy level has a range of zero to 32767, and the default is 200. If all phones and gateways perform silence suppression, the system ignores this value.
-6
OL-1047-01
Chapter
Cisco TAPI Service Provider Installation and Configuration Configuring the Cisco TAPI Service Provider
Table 0-1
Cisco IP-PBX Service Provider Configuration Fields (continued)
Field group Security
Description Users need to enter their user name and password in the Cisco IP PBX Service Provider configuration dialog box to access devices. The Cisco CallManager creates each users user name and password in the administration pages, encrypts them, and stores them in the registry. Devices and lines are assigned to that user. The Cisco TSP returns these lines to the application when the Cisco TSP issues lineInitializeEx. When the Cisco TSP initializes, it reads the user name and password and sends them in the ProviderOpen request to the Cisco CallManager. Only one user name and password can be active at a time. The list of devices that the Cisco TSP receives from the Cisco CallManager is the entire list of devices the user is allowed to access regardless of whether the device is registered. If the application attempts to open an unregistered device, the Cisco TSP responds to the lineOpen request with the error LINEERR_RESOURCEUNAVAIL. The application is responsible for retrying the lineOpen until it succeeds.
CallManager Location
If the TSP is on the same machine as the CallManager, click the Local CallManager radio button. If the CallManager is on a different machine, click the CallManager IP Address radio button and enter the IP address or click the CallManager Name radio button and enter the host name. The Synchronous Message Timeout designates the time the TSP should wait to receive a response to a synchronous message. The value displays in milliseconds, and the default is 15000 ms. The TSP uses the CallManager directory to retrieve devices for a user. If a device is added to a user's control list from the CallManager user administration pages, no notification goes to the TSP about the new device. If dynamic device updates are required, the TSP polls the directory for new devices if this feature is enabled. To enable dynamic device updates, select the Poll for New Devices checkbox at the bottom of the configuration dialog box.
Message Timeout
New Device Detection
-7
Perform the following steps to configure Cisco TSP:

Open the Control Panel. Double-click Phone and Modem Options. Select Cisco IP-PBX Service Provider. Click Configure. The system displays the Cisco IP PBX Service Provider dialog box.
Step 5 Step 6
Enter values for the fields on this dialog box. Refer to Table 0-1 for field information: Click OK to save changes.
Note
After the TSP is configured, you must restart the telephony service before an application can run and connect with its devices.

Open the Control Panel. Double-click Telephony. Select Cisco IP-PBX Service Provider. Click Configure. The system displays the Cisco IP PBX Service Provider dialog box.
Step 5 Step 6
Enter values for the fields on this dialog box. Refer to Table 0-1 for field information: Click OK to save changes.
-8
OL-1047-01
Chapter
Cisco TAPI Service Provider Installation and Configuration Uninstalling the Cisco TAPI Service Provider
Note
After configuring the TSP, the telephony service must be restarted before an application can run and connect with its devices.
Uninstalling the Cisco TAPI Service Provider

This process uninstalls Cisco TAPI Service Provider and removes it from the provider list. To make these changes, perform the following steps:
Open the Control Panel. Double-click the Phone and Modem icon. Click the Advanced tab. Highlight the Cisco IP-PBX Service provider. Click Remove to delete the Cisco TSP from the list.

Open the Control Panel. Double-click the Telephony icon. Click the Advanced tab. Highlight the Cisco IP-PBX Service provider. Click Remove to delete the Cisco TSP from the list.
-9
Chapter Installing the Wave Driver
Installing the Wave Driver

Cisco wave driver is available for Windows 2000 and Windows NT only. Windows 98 and Windows 95 do not support it. You should install Cisco wave driver if you plan to use first-party call control. (Do this even if you are performing your own media termination.)
Caution
Due to a restriction in Windows NT, the software may overwrite or remove existing wave drivers from the system when you install or remove the Cisco wave driver on a Windows NT system. The procedures in this section for installing and uninstalling the Cisco wave driver on Windows NT include instructions on how to prevent existing wave drivers from being overwritten or removed. To install the Cisco wave driver, perform the following steps.
Step 1 Step 2 Step 3 Step 4 Step 5 Step 6 Step 7 Step 8 Step 9 Step 10 Step 11 Step 12 Step 13
Open the Control Panel. Double-click Add/Remove Hardware. Click Next. Click Add/Troubleshoot a Device and click Next. Click Add a New Device and click Next. Click No, I want to select the hardware from a list. Select Sound, video and game controllers and click Next. Click Have Disk. Click Browse and change to the Wave Drivers folder in the folder where the Cisco TSP is installed. Select OEMSETUP.INF and click Open. Click OK in the Install From Disk window. The Cisco TAPI Wave Driver displays on the screen. Click Next. Click Next.
-10
OL-1047-01
Chapter
Cisco TAPI Service Provider Installation and Configuration Installing the Wave Driver
Click Yes. Click Finish. Click Yes to restart.
Procedure for Windows NT

Step 1
Before you add the Cisco wave driver, you must save the wave driver information from the registry in a separate file. To do this, perform the following steps:
a. b. c. d.
Click Start > Run. Enter regedit in the text box. Click OK. Select the Drivers32 key located in the following path:
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\ CurrentVersion

e. f. Step 2 Step 3 Step 4 Step 5 Step 6 Step 7 Step 8 Step 9 Step 10
Select Registry > Export Registry File. Enter a filename and select the location to save. Click Save. The file is given a .reg extension.
After the registry information is saved, open the Control Panel. Double-click Multimedia. Click Next. Click Add. Click Unlisted or Updated Driver. Click OK. Click Browse and change to the Wave Drivers folder in the folder where the Cisco TSP is installed. Click OK. Follow the on-screen instruction, but do not restart the system when prompted. Examine the contents of the registry to verify the new driver was installed and the old drivers still exist. To do this, perform the following steps.
a.
Click Start > Run.
-11
Chapter Uninstalling the Wave Driver
b. c. d. a. b. c.
Enter regedit in the text box. Click OK. Select the Drivers32 key located in the following path: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\ CurrentVersion Make sure the driver avaudio32.dll displays in the data column. This is the Cisco wave driver. Verify that the previously existing wave values appear in the data column for wave1, wave2, wave3, and so on. You can compare this registry list to the contents of the .reg file you saved in Step 1 by opening the .reg file in a text editor and viewing it and the registry window side-by-side. If necessary, add the appropriate waveX string values for any missing wave values that should be installed on the system. For each missing wave value, select Edit > New > String Value and enter a value name. Then, select Edit > Modify, enter the value data, and click OK. Close the registry by selecting Registry > Exit.
d.
e. Step 11
Restart the computer.
Uninstalling the Wave Driver

To remove the Cisco wave driver, perform the following steps:
Open the Control Panel. Double-click Add/Remove Hardware. Click Next. Select Uninstall/Unplug a device and click Next. Select Uninstall a device and click Next. Select Cisco TAPI Wave Driver and click Next.
-12
OL-1047-01
Chapter
Cisco TAPI Service Provider Installation and Configuration Uninstalling the Wave Driver
Step 7 Step 8
Select Yes, I want to uninstall this device and click Next. Click Finish.
Procedure for Windows NT

Step 1
Before you add the Cisco wave driver, you must save the wave driver information from the registry in a separate file. To do this, perform the following steps:
a. b. c. d.
Click Start > Run. Enter regedit in the text box. Click OK. In the left window, select the Drivers32 key located in the following path:
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\ CurrentVersion

e. f. Step 2 Step 3 Step 4 Step 5 Step 6 Step 7 Step 8 Step 9
Select Registry > Export Registry File. Enter a filename and select the location to save. Click Save. The file is given a .reg extension.
After the registry information is saved, open the Control Panel. Double-click Multimedia. Click the Devices tab. Click the + symbol next to Audio Devices to view all the audio devices. Click Audio for Cisco Sound System. Click Remove. Click Finish. Do not restart the system. Examine the contents of the registry to verify the Cisco wave driver was removed and the old drivers still exist. To do this, perform the following steps.
a. b. c.
Click Start > Run. Enter regedit in the text box. Click OK.
-13
Chapter Verifying the Cisco TAPI Service Provider Installation
d. a. b. c.
In the left window, select the Drivers32 key located in the following path: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\ CurrentVersion Make sure the Cisco wave driver avaudio32.dll does not appear in the data column. Verify that the previously existing wave values appear in the data column for wave1, wave2, wave3, and so on. You can compare this registry list to the contents of the .reg file you saved in Step 1 by opening the .reg file in a text editor and viewing it and the registry window side-by-side. If necessary, add the appropriate waveX string values for any missing wave values that should be installed on the system. For each missing wave value, select Edit > New > String Value and enter a value name. Then select Edit > Modify, enter the value data, and click OK. Close the registry by selecting Registry > Exit.
d.
e. Step 10
Restart the computer.
Verifying the Cisco TAPI Service Provider Installation

You can use the Microsoft Windows Phone Dialer Application to verify that the Cisco TSP is operational. For Windows NT and Windows 2000, the dialer application is located in C:\Program Files\Windows NT\dialer.exe For windows 95 and Windows 98, the dialer application is located in C:\Windows\dialer.exe
Procedure For Windows 2000
Step 1 Step 2
Open the Dialer application by locating it in Windows Explorer and double-clicking it. Click Edit > Options.
-14
OL-1047-01
Chapter
Cisco TAPI Service Provider Installation and Configuration Verifying the Cisco TAPI Service Provider Installation
Select Phone as the Preferred Line for Calling. In the Line Used For area, select one of the Cisco Lines in the Phone Calls drop down menu. Click OK. Click Dial. Enter a number to dial, select Phone Call in the Dial as box, and then click Place Call.

Step 1
Open the Dialer application by locating it in Windows Explorer and double-clicking it: A dialog box appears requesting the line and address that you want to use. If there are no lines in the Line drop-down list box, then there might be a problem between the Cisco TSP and the Cisco CallManager.
Select one of the lines from the Line drop down menu. Make sure Address is set to Address 0. Click OK. Enter a number to dial.
If the call was successful, you have verified that the Cisco TSP is operational on the machine where the Cisco TSP is installed. If you encounter problems during this procedure, or if no lines appear in the line drop-down list on the dialer application, check the following items:

Make sure the Cisco TSP was configured properly. Test the network link between the Cisco TSP and the Cisco CallManager by using the ping command to check connectivity. Make sure the Cisco CallManager server is functioning.
-15
Chapter Setting up Client-Server Configuration
Setting up Client-Server Configuration

For information on setting up a client-server configuration in Windows 2000, refer to the Microsoft Windows Help feature. For information on client-server configuration in Windows NT, refer to Microsofts White Papers.
-16
OL-1047-01
C H A P T E R
Cisco JTAPI Installation and Configuration

Cisco Java Telephony API (JTAPI) implementation consists of Java classes that reside on all client machines running Cisco JTAPI applications. Installation of the Cisco JTAPI implementation is necessary before Cisco JTAPI applications will function correctly. The Cisco JTAPI classes are installed wherever JTAPI applications will run, whether on Cisco CallManager, on a separate machine, or on both. Installation requires 5 MB of local disk space. This section discusses the software installation and configuration required to ready the Cisco JTAPI environment for programming and running applications.

Installing the Cisco JTAPI Software, page B-2 Verifying the Installation, page B-4 Configuring Cisco JTAPI Tracing, page B-4 Administering User Information for JTAPI and TAPI Applications, page B-14
-1
Chapter Installing the Cisco JTAPI Software
Installing the Cisco JTAPI Software

Perform the steps below to install the CiscoJTAPI software:
Procedure
Log in to the computer where you want to install the Cisco JTAPI client software. Close all Windows programs. Open a web browser. Go to the Cisco CallManager administration pages: http://Name/CCMAdmin/main.asp where: Name is the name or IP address of the Cisco CallManager Click Application > Install Plugins. Click the Cisco JTAPI link. Save the file on your desktop or run it from the download site. Follow the instructions in the pop-up windows.
Note
Install Cisco JTAPI software on the default drive as directed by the installation software. The default directory, for example, is C:\WINNT\Java\lib, when Windows NT is installed in C:\WINNT.
Installed files
The cisco JTAPI installation utility installs the following items on the local disk drive:

JTAPI java classes in %SystemRoot%\java\lib JTAPI Preferences (jtprefs.exe) in Program Files\JTAPITools JTAPI sample applications(makecall, muzak, jtrace) in Program Files\JTAPITools JTAPI documentation in Program Files\JTAPITools
-2
OL-1047-01
Chapter Installing the Cisco JTAPI Software
Note
To run many JTAPI applications, all you need is a Java 1.1-compatible environment such as the Sun JDK 1.1.x or Microsoft Virtual Machine (bundled with Internet Explorer 4.0 and higher). Cisco JTAPI will also run on Sun JDK1.2. To use JTPREFS (application to set Cisco JTAPI tracing parameters) and the sample applications bundled with Cisco JTAPI, however, Microsoft Java Virtual Machine 5.00.3190 or later is required. If you are installing Cisco JTAPI on a Windows 2000 Workstation or Server, you already have a compatible version of the Microsoft Virtual Machine. On all other Microsoft platforms such as Windows 95, Windows 98, and Windows NT, verify the current version of the Microsoft Virtual Machine by running the command "jview /?" and noting the version printed at the top of the console. You can download the latest version of the Microsoft Java Virtual Machine from http://www.microsoft.com/java.
-3
Chapter Verifying the Installation
Verifying the Installation

When you perform the procedure in this section, a call is placed in order to test the Cisco TJAPI installation and configuration. Perform the following steps:
Procedure
Step 1
From the Windows NT command line, navigate to the directory where you installed Cisco JTAPI Tools. By default, this directory is Program Files\JTAPITools. Execute the following command: Jview makecall <server name> <login> <password> 1000 <phone1> <phone2> where server name is the hostname or IP address of the Cisco CallManager (for example, CTISERVER). phone1 and phone2 are directory numbers of IP phones or virtual phones that are controlled by the user according to the user configuration. Refer to the Adding a New User section for details. login and password are the user ID and password that you configured in the Cisco CallManager User Configuration page.
Step 2
Configuring Cisco JTAPI Tracing

You use the Cisco JTAPI tracing preferences application (JTPREFS.EXE) to configure trace levels, trace destinations, and CallManager names. The Cisco JTAPI Preferences utility is installed by default in the directory Program Files\JTAPITools. To open Cisco JTAPI preferences, select Start > Programs > Cisco JTAPI.
-4
OL-1047-01
Chapter Trace Levels
Trace Levels
This section describes how to use the Cisco JTAPI preferences application. The following topics are discussed:

Debug Levels, page B-7 Log Destination, page B-8 Cisco CallManager, page B-11 Other JTAPI Preferences Settings, page B-12 JTAPI Preferences on non-Microsoft environments, page B-13
Figure 0-1 illustrates the trace level window of the Cisco JTAPI preferences application. The JTAPI version number is shown in the window title.
-5
Figure 0-1
Cisco JTAPI Trace Levels
The Trace Level tab allows you to enable or disable the following JTAPI trace levels:

WARNING - low level warning events INFORMATIONAL - status events DEBUG - highest level debugging events
-6
OL-1047-01
Debug Levels
Figure 0-2 illustrates the debug level window.
Figure 0-2 Cisco JTAPI Debug Levels
When the DEBUG trace level is enabled, you may enable or disable additional debugging levels in the Debug Levels tab, as described below:
-7
JTAPI_DEBUGGING - to trace JTAPI methods and events JTAPI_IMPLDEBUGGING - internal JTAPI implementation trace CTI_DEBUGGING - to trace Cisco CallManager events that are sent to the JTAPI implementation CTIIMPL_DEBUGGING - internal CTICLIENT implementation trace PROTOCOL_DEBUGGING - full CTI protocol decoding MISC_DEBUGGING - miscellaneous low-level debug trace
Log Destination
Figure 0-3 illustrates the log destination window.
-8
OL-1047-01
Figure 0-3
Cisco JTAPI Log Destination
The Log Destination tab allows you to configure how JTAPI will create traces and how they will be stored. Log destination fields are described as follows:
Use Java Console
When this option is enabled, tracing is sent to the standard output or console (command) window.
-9
Use Syslog
When this option is enabled, traces are sent to a UDP port as specified in the Syslog Collector and Port number fields. Syslog collector is the service by which traces are collected and directed to the CiscoWorks2000 server.
Use Rotating Log Files
This option allows you to direct the traces to a specific path and folder in the system. There can be no fewer than two log files and no more than ninety-nine. Cisco JTAPI rotates through the log files in numerical order, returning to the first log file after filling the last. Log files are sized in increments of one megabyte.
Use the Same Directory
This option allows you to specify if the same folder name should be used for each instance of an application. When enabled, JTAPI will trace the log files to the same directory. In this case, successive instances of a JTAPI application will restart the log files starting at index 01. When disabled, each application instance, whether successive or simultaneous, will cause the trace files to be placed in a new folder sequential to the last folder written. Cisco JTAPI detects the last folder present in the trace path and automatically increments the numeric index.
Path
Allows you to specify the path name where the trace files will be written to. When the path is not specified, the default is the application's path.
Directory Name Base
Allows you to specify a folder name where the trace files will be contained.
File Name Base and File Name Extension
These values are used to make up the trace file names with a numerical index appended to the file base name to indicate the order in which the files are created. For example, as shown in the figure the trace files would rotate between jtapiTrace01.log, jtapiTrace02.log and jtapiTrace10.log. If the 'File Name Base' and 'File Name Extension' were left blank Cisco JTAPI will pick the trace files names as CiscoJtapi01.log, CiscoJtapi02.log and so on.
-10
OL-1047-01
Cisco CallManager
Figure 0-4 illustrates the Cisco CallManager window
Figure 0-4 Cisco JTAPI CallManager
This tab allows you to define a list of Cisco CallManagers that a JTAPI application can present the user for optional Cisco CallManager connectivity.
-11
Other JTAPI Preferences Settings

There are a number of parameters that are not configurable through the JTAPI Preferences application. These parameters are low-level and may be needed only for troubleshooting and debugging purposes. Typically, you would not need to modify these unless instructed by support personnel. These parameters and their values must be edited manually in the jtapi.ini file located by default in %Sysroot%\java\lib. When editing parameters in the jtapi.ini file, use the format below:
<Parameter>=<value>
For example:
RouteSelectTimeout=5000
The following table lists the additional parameters, their functions, and default values.
Parameter RouteSelectTimeout
Function Specifies the amount in milliseconds for JTAPI to wait for a response to a Route event Instructs the implementation to do periodic measurements of its internal queues
Default 5000
PeriodicWakeupEnabled
PeriodicWakeupInterval QueueStatsEnabled
Specifies the frequency in milliseconds to 50 do periodic measurements Instructs the implementation to trace queue statistics 0 1
DeviceListUpdateEnabled Instructs the implementation to update the list of provider controlled devices periodically DeviceListUpdateInterval
Specifies the frequency in milliseconds to 30 do device list updates
-12
OL-1047-01
Parameter AlwaysQueryCallInfo
Function Instructs the implementation to always query the call information for tracing purposes
Default 1
CtiRequestTimeout
Specifies the time in milliseconds that 30 JTAPI will wait for a response from a CTI request
JTAPI Preferences on non-Microsoft environments

For non-Microsoft environments, a jtapi.ini file must be created manually and placed in the CLASSPATH. The following are the parameter names with sample values:
Traces=WARNING;INFORMATIONAL;DEBUG WARNING=0 INFORMATIONAL=0 DEBUG=1 Debugging=JTAPI_DEBUGGING;JTAPIIMPL_DEBUGGING;CTI_DEBUGGING; CTIIMPL_DEBUGGING;PROTOCOL_DEBUGGING;MISC_DEBUGGING JTAPI_DEBUGGING=1 JTAPIIMPL_DEBUGGING=1 CTI_DEBUGGING=1 CTIIMPL_DEBUGGING=1 PROTOCOL_DEBUGGING=0 MISC_DEBUGGING=0 UseSystemDotOut=0 UseSyslog=0 SyslogCollector= SyslogCollectorUDPPort= UseTraceFile=1 TraceFileSize=1048576 NumTraceFiles=10 UseSameDirectory=1 Directory= TracePath=d:/public/traces FileNameBase=jtapiTrace FileNameExtension=log CallManagers=ctiserver; ctiserver2
-13
Chapter Administering User Information for JTAPI and TAPI Applications
Administering User Information for JTAPI and TAPI Applications

JTAPI and TAPI applications require that users be administered in the directory and be given privilege to control one or more devices. Follow the procedures for adding a user and assigning devices to a user in the Adding a New User section before using a JTAPI or TAPI application. The list of devices assigned to the user represent the phones that the user needs to control from the application (e.g. make calls, answer calls).
-14
OL-1047-01
C H A P T E R
Creating Custom Cisco IP Phone Rings

Cisco IP Phones ship with two default ring types that are implemented in hardware: Chirp1 and Chirp2. Cisco CallManager also provides a default set of additional phone ring sounds that are implemented in software as pulse code modulation (PCM) files. The PCM files, along with an XML file (named RingList.xml) that describes the ring list options available at your site are installed in the TFTP directory on each Cisco CallManager server. This appendix describes how you can customize the phone ring types available at your site by creating your own PCM files and editing the RingList.xml file. The following topics are covered:

Creating a Custom Phone Ring, page C-2 RingList.xml File Format, page C-2 PCM File Requirements for Custom Ring Types, page C-3
Note
The procedure described here only applies to creating custom phone rings for the Cisco IP Phone 7940 and 7960 models.
-1
Chapter Creating a Custom Phone Ring
Creating a Custom Phone Ring

Use the following procedure to create a custom phone ring.
Procedure
Step 1
Create a PCM file for each custom ring (one ring per file). The PCM files must comply with the format guidelines listed in the PCM File Requirements for Custom Ring Types section on page C-3. Use an ASCII editor to edit the RingList.xml file. Refer to the RingList.xml File Format section on page C-2 for information about how to format this file, along with a sample RingList.xml file. Save your modifications and close the RingList.xml file. Place the new PCM files you created in the C:\ Program Files\Cisco\TFTPPath directory on the Cisco TFTP server for each Cisco CallManager in your cluster.
Step 2
Step 3 Step 4
RingList.xml File Format

The RingList.xml file defines an XML object that contains a list of phone ring types. Each ring type contains a pointer to the PCM file used for that ring type and the text that will be displayed on the Ring Type menu on a Cisco IP Phone for that ring. This file is located in the C:\ Program Files\Cisco\TFTPPath directory of the Cisco TFTP server for each Cisco CallManager. The CiscoIPPhoneRingList XML object uses the following simple tag set to describe the information:
<CiscoIPPhoneRingList> <Ring> <DisplayName/> <FileName/> </Ring> </CiscoIPPhoneRingList>
-2
OL-1047-01
Chapter PCM File Requirements for Custom Ring Types
In the above definition:

Ring contains two fields, DisplayName and FileName, that are required for each phone ring type. Up to 50 rings can be listed. DisplayName defines the name of the custom ring for the associated PCM file that will be displayed on the Ring Type menu of the Cisco IP Phone. FileName
specifies the name of the PCM file for the custom ring to associate with DisplayName.
The DisplayName and FileName fields must not exceed 25 characters.
A sample RingList.xml file that defines two phone ring types is shown below:
<CiscoIPPhoneRingList> <Ring> <DisplayName>Analog Synth 1</DisplayName> <FileName>Analog1.raw</FileName> </Ring> <Ring> <DisplayName>Analog Synth 2</DisplayName> <FileName>Analog2.raw</FileName> </Ring> </CiscoIPPhoneRingList>
PCM File Requirements for Custom Ring Types

The PCM files for the rings must meet the following requirements for proper playback on Cisco IP Phones:

Raw PCM (no header) 8000 samples per second 8 bits per sample uLaw compression Maximum ring size 16080 samples Minimum ring size 240 samples Number of samples in the ring must be evenly divisible by 240 Ring should start and end at the zero crossing
You can use any standard audio editing packages that supports these file format requirements to create PCM files for custom phone rings.
-3
Chapter PCM File Requirements for Custom Ring Types
-4
OL-1047-01
N D E X
A
admission control 5-1, 19-1 analog gateways 45-3 attendant console 8-1 administration 8-3 Cisco WebAttendant 8-1 hunt groups and pilot points 8-6 audio quality 5-1 auto-registration 4-1 disabling 4-6 enabling 4-2 reusing auto-registration numbers 4-7
C
call admission control 5-1 calling search spaces 22-1 adding 22-1 copying 22-3 deleting 22-4 updating 22-3 call processing, distributed 2-1 Cisco Access gateways 45-3 analog 45-3 digital 45-4 Cisco CallManager 11-1 adding 12-1 configuring 12-1 deleting 12-6 groups, configuring 13-1 server configuration 11-1 starting and stopping 20-1 updating 12-5 Cisco CallManager Group 3-2 Cisco Catalyst 6000 gateways 45-4 DSP services card 45-5 E1/T1 line card 45-5 Cisco IP Phones 46-1
B
bandwidth 5-1, 16-1 allocation of 5-1 calculations for admission control 19-4 usage per call 16-1 batch phone operations 46-1 Bulk Administration Tool (BAT) 46-1
Index
12 SP+, description 46-4 30 VIP, description 46-4 7910, description 46-4 7940, description 46-3 7960, description 46-3 adding 46-7 auto-registration 4-1 batch operations 46-1 configuring 46-5 configuring phone features 46-16 deleting 46-11 device loads for 7-6 directory numbers 46-18 finding and listing 46-15 MAC address, displaying 46-6 resetting 46-12 templates, phone button 47-1 understanding 46-2 updating 46-13 Cisco IP Phone Services 41-1 Cisco Messaging Interface 30-1 adding service 30-5 commonly changed service parameter fields 30-2 configuring trace parameters 30-10 deleting service 30-6 Cisco TAPI Service Provider A-1 activating A-3 configuring A-4 installation and configuration A-1
installing A-1 installing the wave driver A-10, A-12 setting up the client-server configuration A-16 uninstalling A-9 verifying the installation A-14 Cisco Telephony Interface (CTI) CTI ports 46-5 Cisco Telephony Interface (CTI) route point 42-1 Cisco uOne 43-1 adding ports 43-12 configuring CallManager for uOne 43-1 copying ports 43-19 deleting ports 43-16 MWI device, configuring 43-11 MWI On/Off numbers, setting 43-8 port wizard 43-3 resetting ports 43-17 understanding 43-1 updating ports 43-18 Cisco uOne Port wizard 43-3 adding a new uOne server and ports 43-3 adding ports 43-6 deleting ports 43-7 Cisco VG200 gateway 45-6 configuring FXO ports 45-38 configuring FXS ports 45-35 closest-match routing 6-11 clusters 2-1
OL-1047-01
Index
compared to groups 3-1 described 2-1 CMI (Cisco Messaging Interface) 30-1 CMLocal Date/Time Group 14-1 communication protocols, gateway 45-1 compression of data 16-1 configuring call park 39-1 adding a number 39-2 assigning directory numbers to a group 40-5 configuring 40-2 configuring call park number 40-2 deleting a group number 40-4 deleting a number 39-4 updating a group number 40-3 updating a number 39-3 configuring call pickup described 40-1 configuring Cisco TFTP 31-1 configuring command line parameters 31-5 configuring trace parameters 31-9 deleting command line parameters 31-7 deleting service 31-4 inserting service 31-2 configuring conference bridges 33-1 adding a hardware device 33-8 adding a Meet-Me number pattern 33-14 adding a software device 33-6 Ad-Hoc 33-4 deleting a conference device 33-11
deleting a Meet-Me number pattern 33-17 Meet-Me 33-5 two types of conferences 33-3 understanding conference devices 33-2 updating a conference device 33-10 updating a Meet-Me number pattern 33-15 updating conference bridge parameters 33-12 configuring gateways 45-1 configuring media termination point 34-1 adding 34-5 avoiding call failure/user alert 34-4 call hold 34-2 call park 34-2 call transfer 34-2 CiscoIpVoiceMediaStreamingApp 34-1 conferencing 34-2 deleting 34-8 IpVoiceMediaStreamer 34-1 planning MTP configuration 34-3 transcoders 34-1 updating 34-7 configuring route filters 23-1 adding 23-5 adding clauses 23-9 copying 23-7 deleting 23-11 removing clauses 23-10 updating 23-7 configuring route groups 24-1
Index
adding 24-2 adding devices 24-3 deleting 24-7 removing devices 24-5 understanding 24-2 updating 24-6 configuring route lists 25-1 adding 25-6 adding route groups 25-8 changing the order of route groups 25-11 deleting 25-12 removing route groups 25-10 understanding called party transformation settings 25-4 understanding calling party transformation settings 25-2 configuring service parameters 35-1 adding 35-5 adding new service 35-3 deleting 35-9 deleting a service 35-4 updating 35-7 configuring trace 36-1 adding a configuration 36-10 alarm conditions 36-2 components 36-7 deleting a configuration 36-13 deleting a service 36-14 error messages 36-2 event level 36-6
event log 36-7 levels 36-2 options 36-2 output debug string 36-7 recommended settings 36-9 services 36-3 system log 36-7 time 36-3 updating a configuration 36-12 user mask 36-3 configuring transcoder 37-1 configuring 37-3 copying 37-5 deleting 37-6 MTPs 37-1 updating 37-4 Control Center 38-1 starting and stopping services 38-2 using 20-2 CTI ports 46-5 CTI route point 42-1 adding 42-2 deleting 42-4 finding and listing 42-5 modifying 42-3 resetting 42-6 custom phone button templates adding 47-5 guidelines for creating 47-7
OL-1047-01
Index
D
data compression 16-1 Date/Time Group 14-1 default settings for devices 15-1 device defaults 15-1 updating 15-2 device loads 7-6 understanding 7-6 updating 7-7 verifying 7-9 device pool 17-1 adding 17-1 deleting 17-4 updating 17-3 devices 15-1 Cisco uOne ports 43-1 defining common characteristics 17-1 device defaults 15-1 device loads 7-6 gatekeeper 44-1 gateways 45-1 phones 46-1 understanding device support 7-1 DHCP 7-2 understanding 7-2 digital gateways 45-4 directory numbers 46-18
adding 46-19 auto-registration 4-1 configuring 46-18 deleting 46-23 searching 45-46 updating 46-24 discard digits Instructions 6-12 distributed system, configuring 2-3 Domain Name System (DNS) 11-1
E
E1 gateways 45-4 enterprise parameters 18-1 external phone number mask 4-4 external route plan wizard 28-1 confirming the external route plan 28-10 creating an external route plan 28-2 deleting an external route plan 28-11 entering location information 28-5 finishing the external route plan 28-11 generating the external route plan 28-9 providing gateway information 28-8 providing tenant information 28-4 selecting gateways 28-6 setting the routing options 28-2 understanding 6-25
Index
F
FXO 45-38 configuring ports on the Cisco VG200 45-38 Foreign Exchange Office 45-2 FXS 45-35 configuring ports on the Cisco VG200 45-35 Foreign Exchange Station 45-2
configuring 45-35 Cisco VG200 ports 45-35 loop start ports 45-31 ports 45-27 deleting 45-42 digital 45-4 E1 45-4 finding and listing 45-44 H.323 45-6 ISDN 45-10 MGCP 45-21 modifying 45-41 PRI 45-10 resetting 45-42 searching 45-45 station 45-3 T1 45-4 trunk 45-3 updating 45-43 Global Directory Advanced User Search 49-3 Basic User Search 49-1 Global Directory 49-1 Lightweight Directory Access Protocol (LDAP) 49-1 ground start, configuring ports on MGCP gateway 45-38 group call pickup adding a group number 40-2 assigning directory numbers to a group 40-5
G
G.711 16-1 G.723 16-1 G.729 16-1 gatekeeper 44-1 adding 44-1 configuring 44-1 deleting 44-6 modifying 44-7 restarting or resetting 44-6 gateways 45-1 adding 45-7 analog ports 45-27 digital 45-9 H.323 45-23 analog 45-3 Cisco Catalyst 6000 45-4 Cisco VG200 45-6 communication protocols 45-1
10
OL-1047-01
Index
deleting a group number 40-4 updating a group number 40-3 groups, CallManager adding 13-2 compared to clusters 3-1 components of 3-2 configuring 13-1 deleting 13-6 updating 13-4 groups, Date/Time 14-1
I
introduction 1-1 IP address 11-1 ISDN, gateway configuration 45-10
K
keypad templates 47-1
L H
H.225 45-2 H.323 45-2 adding gateways 45-23 gateway 45-6 H.323 clients 46-5 hub-and-spoke topology 5-1 hunt groups 8-6, 32-5 adding members 32-5 configuring 32-5 deleting members 32-9 described 8-6 updating 32-9 viewing 32-9 LDAP directory 9-1 Cisco CallManager directory 9-1 using the embedded directory 9-2 LDAP parameters 18-1 Lightweight Directory Access Protocol (LDAP) 9-1 locations 19-1 adding 19-5 defined 19-1 deleting 19-7 interaction with regions 19-3 updating 19-7 used in admission control 5-1 loop start configuring gateway ports 45-31 configuring on MGCP gateway 45-40
11
Index
M
MAC address 46-6 phone 46-6 server 11-2 Media Access Control (MAC) address 11-2 phone 46-6 server 11-2 messaging Cisco Messaging Interface (CMI) 30-1 Cisco uOne 43-1 MGCP 45-21 adding gateways 45-21 configuring ground start ports 45-38 configuring loop start ports 45-40 Media Gateway Control Protocol 45-2 MWI (message waiting indicator) 43-8 MWI device for uOne 43-11 MWI On/Off numbers 43-8
P
parameters enterprise 18-1 LDAP 18-1 partitions 21-1 adding 21-1 deleting 21-2 phone button templates 47-1 12-Series, default template 47-4 30 SP+, default template 47-3 30 VIP, default template 47-4 7910, default templates 47-3 7940, default templates 47-3 7960, default template 47-2 adding 47-5 deleting 47-11 guidelines for creating 47-7 renaming 47-10 understanding 47-1 updating 47-12 phone features 46-16 call forward 46-17 call park 46-17 call pickup 46-18 call waiting 46-17 configuring 46-16 phones 46-1 adding 46-7
N
Network Interface Card (NIC) 11-2
O
overview 1-1
12
OL-1047-01
Index
auto-registration 4-1 batch operations 46-1 Cisco IP Phone 12 SP+ 46-4 Cisco IP Phone 30 VIP 46-4 Cisco IP Phone 7900 Family 46-2 Cisco IP Phone 7910 46-4 Cisco IP Phone 7940 46-3 Cisco IP Phone 7960 46-3 Cisco IP Phone Services 41-1 configuring 46-5 deleting 46-11 device loads for 7-6 directory numbers 46-18 directory numbers, configuring 46-18 features, configuring 46-16 finding and listing 46-15 MAC address, displaying 46-6 phone button templates 47-1 resetting 46-12 understanding Cisco IP Phones 46-2 updating 46-13 pilot points 8-6, 32-2 adding 32-2 configuring 32-2 deleting 32-4 described 8-6 updating 32-4 viewing 32-4 plug-ins 8-10
Cisco WebAttendant client 8-10 PRI, gateway configuration 45-10
Q
quality of sound 5-1
R
redundancy 3-1 configuring 3-5 types of 3-1 with distributed call processing 3-3 regions 16-1 configuring 16-1 interaction with locations 19-3 used with admission control 19-3 resetting Cisco CallManager 20-1 restarting Cisco CallManager 20-1 route filters understanding tags 23-2 Route Pattern considerations for using 6-24 understanding 6-24 route patterns 26-1 adding 26-1 copying 26-5 deleting 26-6 updating 26-4
13
Index
route pattern wildcards and special characters 6-7
copying 27-5 deleting 27-6 understanding 27-1 updating 27-4 trunk gateways 45-3
S
server configuration 11-1 services 38-2 Control Center 20-2, 38-2 Telephony Call Dispatcher (TCD) 8-9 shared line appearances 46-25 Skinny Gateway Protocol 45-1 sound quality 5-1 starting and stopping 38-2 station gateways 45-3
U
understanding distributed call processing 2-1 understanding route plans route plan overview 6-1 understanding 6-1 Understanding Service Parameters
10-1
Cisco CallManager service parameters 10-2
T
T1 gateways 45-4 TCD (Telephony Call Dispatcher) 8-9 service parameters 32-18 starting 32-20 TFTP understanding 7-2 TFTP server 7-3 accessing 7-3 identifying 7-4 time zones 14-1 translation patterns 27-1 adding 27-2
Cisco database layer service parameters 10-29 Cisco IP voice media streaming service parameters 10-28 Cisco messaging interface service parameters 10-22 Cisco telephony call dispatcher service parameters 10-30 Cisco TFTP service parameters 10-20 uOne, Cisco 43-1 port wizard 43-3 user information adding a user 48-2, 48-3 associate devices 48-2, 48-3 user information 48-1
14
OL-1047-01
Index
using route plan report 29-1 viewing all records 29-2 viewing in a file 29-3
Telephony Call Dispatcher (TCD) 8-9 tips and troubleshooting 8-14, 8-16 users, adding 32-10 wausers 8-11 wizards 43-3 Cisco uOne Port wizard 43-3
V
voice gateways 45-1 voice mail 43-1 Cisco uOne 43-1 voice quality 5-1
W
WebAttendant, Cisco 8-1, 32-1 administration 8-3 client, configuring 32-14 client, installing 32-13 client installation 8-10 client requirements 8-10 configuring CallManager for 8-3 described 8-1 directory database 8-11 hunt groups, configuring 32-5 performance monitors 8-14 phone guidelines 8-4 pilot points, configuring 32-2 pilot points and hunt groups 8-6 redundancy 8-13 TCD service parameters 32-18
15
Index
16
OL-1047-01

Configuring Cisco Call Manager

Uploaded by

Document Information

Original Description:

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Configuring Cisco Call Manager

Uploaded by

Copyright:

Available Formats

Cisco CallManager Administration Guide

Introduction 1-1 Understanding Distributed Call Processing 2-1 Clusters 2-1

Cisco CallManager Administration Guide OL-1047-01

Configuring a Distributed System 2-3

Understanding Call Admission Control 5-1 Locations 5-2 Gatekeepers 5-3

Cisco CallManager Administration Guide

Generated Route Patterns 6-29

Cisco CallManager Administration Guide OL-1047-01

Adding a Server 11-2 Updating a Server 11-3 Deleting a Server 11-4

Cisco CallManager Administration Guide

Setting Device Defaults 15-1 Updating Device Defaults 15-2

Configuring Device Pools 17-1 Adding a Device Pool 17-1

Cisco CallManager Administration Guide OL-1047-01

Updating a Device Pool 17-3 Deleting a Device Pool 17-4

Understanding Enterprise Parameters 18-1 Updating Enterprise Parameters 18-4

Configuring Partitions 21-1 Adding a Partition 21-1 Deleting a Partition 21-2

Cisco CallManager Administration Guide

Cisco CallManager Administration Guide OL-1047-01

Deleting a Route List 25-12

Cisco CallManager Administration Guide

Cisco CallManager Administration Guide OL-1047-01

Cisco CallManager Administration Guide

Configuring a Transcoder 37-3 Updating a Transcoder 37-4

Cisco CallManager Administration Guide OL-1047-01

Copying a Transcoder 37-5 Deleting a Transcoder 37-6

Configuring Call Park

Configuring Call Pickup

Cisco CallManager Administration Guide

Deleting a Cisco IP Phone Service Parameter 41-9

Configuring Devices in Cisco CallManager

Cisco CallManager Administration Guide OL-1047-01

Resetting or Restarting the Gatekeeper 44-6 Modifying the Gatekeeper 44-7

Configuring Ground Start on an MGCP Gateway 45-38

Cisco CallManager Administration Guide

Configuring Loop Start on MGCP Gateways 45-40

Cisco CallManager Administration Guide OL-1047-01

Cisco CallManager Administration Guide

Cisco CallManager Administration Guide OL-1047-01

Cisco CallManager Administration Guide

Cisco CallManager Administration Guide OL-1047-01

Cisco CallManager Administration Guide

Cisco CallManager Administration Guide OL-1047-01

Cisco CallManager Administration Guide

Preface Related Documentation

Cisco CallManager Administration Guide OL-1047-01

Notes use the following conventions:

Cisco CallManager Administration Guide

Preface Obtaining Documentation

Timesavers use the following conventions:

Cisco CallManager Administration Guide OL-1047-01

Preface Obtaining Documentation

World Wide Web

http://www.cisco.com http://www-china.cisco.com http://www-europe.cisco.com

Cisco CallManager Administration Guide

Preface Obtaining Technical Assistance

Obtaining Technical Assistance

Preface Obtaining Technical Assistance

Technical Assistance Center

Contacting TAC by Using the Cisco TAC Website

Cisco CallManager Administration Guide

Preface Obtaining Technical Assistance

Contacting TAC by Telephone

Cisco CallManager Administration Guide OL-1047-01