Cucm Trace Documentation

Cisco Unified CallManager Serviceability Administration Guide
Release 4.2(3)
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
Text Part Number: OL-10643-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. CCSP, CCVP, the Cisco Square Bridge logo, Follow Me Browsing, and StackWise are trademarks of Cisco Systems, Inc.; Changing the Way We Work, Live, Play, and Learn, and iQuick Study are service marks of Cisco Systems, Inc.; and Access Registrar, Aironet, BPX, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, Cisco, the Cisco Certified Internetwork Expert logo, Cisco IOS, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity, Enterprise/Solver, EtherChannel, EtherFast, EtherSwitch, Fast Step, FormShare, GigaDrive, GigaStack, HomeLink, Internet Quotient, IOS, IP/TV, iQ Expertise, the iQ logo, iQ Net Readiness Scorecard, LightStream, Linksys, MeetingPlace, MGX, the Networkers logo, Networking Academy, Network Registrar, Packet, PIX, Post-Routing, Pre-Routing, ProConnect, RateMUX, ScriptShare, SlideCast, SMARTnet, The Fastest Way to Increase Your Internet Quotient, and TransPath are registered trademarks of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. All other trademarks mentioned in this document or Website 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. (0601R) Cisco Unified CallManager Serviceability Administration Guide Copyright 2006 Cisco Systems, Inc. All rights reserved.
C O N T E N T S
Preface xix Purpose xix Audience xx Organization xx Related Documentation xxiii Conventions xxiv Obtaining Documentation xxv Cisco.com xxvi Product Documentation DVD xxvi Ordering Documentation xxvi Documentation Feedback xxvii Cisco Product Security Overview xxvii Reporting Security Problems in Cisco Products xxviii Obtaining Technical Assistance xxix Cisco Technical Support & Documentation Website xxix Submitting a Service Request xxx Definitions of Service Request Severity xxxi Obtaining Additional Publications and Information xxxi
1
PART
Cisco CallManager Serviceability

1
CHAPTER
Introduction 1-1 Cisco Unified CallManager Serviceability 1-1 Remote Serviceability 1-2
Cisco Unified CallManager Serviceability Administration Guide OL-10643-01
iii
Contents
Cisco Unified CallManager CDR Analysis and Reporting 1-3 Using Hypertext Transfer Protocol over Secure Sockets Layer (HTTPS) 1-4 HTTPS Overview 1-5 Saving the Certificate to the Trusted Folder 1-6 Where to Find More Information 1-7
2
PART
Alarms Configuration and View Definitions

2
CHAPTER
Alarm Configuration 2-1 Configuring or Updating an Alarm for a Service 2-2 Applying an Alarm Configuration to All Nodes in a Cluster 2-4 Alarm Destination Settings 2-6 Alarm Event Level Settings 2-7
CHAPTER
Alarm Definitions 3-1 Searching for and Viewing an Alarm Definition 3-2 Creating User-Defined Description in the Alarm Definition 3-3 Alarm Definition Catalog Descriptions 3-4
CHAPTER
Alarm Information 4-1 Viewing Alarm Information in Text Format 4-2 Viewing Alarm Information in XML Format 4-2
PART
Trace Tools
5
CHAPTER
Trace Configuration 5-1 Configuring Cisco CallManager Trace Parameters 5-3 Configuring Cisco CDR Insert Trace Parameters 5-8
iv
OL-10643-01
Contents
Configuring Cisco Certificate Authority Proxy Function Parameters 5-10 Configuring Cisco CTIManager Trace Parameters 5-12 Configuring Cisco CTL Provider Trace Parameters 5-15 Configuring Cisco Database Layer Monitor Trace Parameters 5-17 Configuring Cisco Extended Functions Trace Parameters 5-20 Configuring Cisco Extension Mobility Trace Parameters 5-23 Configuring Cisco IP Manager Assistant Trace Parameters 5-25 Configuring Cisco IP Voice Media Streaming Application Trace Parameters 5-28 Configuring Cisco Messaging Interface Trace Parameters 5-31 Configuring Cisco MOH Audio Translator Trace Parameters 5-33 Configuring Cisco RIS Data Collector Trace Parameters 5-35 Configuring Cisco Telephony Call Dispatcher Trace Parameters 5-39 Configuring Cisco TFTP Trace Parameters 5-41 Configuring Cisco WebDialer Trace Parameters 5-44 Debug Trace Level Settings 5-46 Configuring Device Name Based Trace Monitoring Trace Parameters 5-47 Configuring SDL Trace Parameters 5-50 Viewing Trace Log Files 5-54 Trace Log File Descriptions and Defaults 5-56 Trace Filter Settings 5-57 Trace Output Settings 5-58 Configuring Servers with Four Disk Drives to Collect Trace Files 5-59
6
CHAPTER
Trace Collection Configuration 6-1 Loading the Trace Collection Tool 6-2 Collecting Traces by Using Trace Collection Tool 6-5 Viewing the Certificate 6-9
Contents
CHAPTER
Trace Analysis Configuration 7-1 Specifying Criteria for an SDI Trace Analysis 7-2 Search Criteria 7-2 Display Fields 7-3 Specifying Criteria for an SDL Trace Analysis 7-5 Search Criteria 7-5 Display Fields 7-5
CHAPTER
Q.931 Translator 8-1 Using the Message Translator 8-1
CHAPTER
Troubleshooting Trace Setting Configuration 9-1 Setting Troubleshooting Trace 9-1 Resetting Troubleshooting Trace 9-2
PART
Monitoring Tools Configuration

10
CHAPTER
Service Activation 10-1 Activating Cisco Unified CallManager Services 10-2 Deactivating Cisco Unified CallManager Services 10-4 Service Considerations 10-5 Deleting Services 10-10
CHAPTER
11
Control Center 11-1 Viewing Status of Services 11-3 Stopping a Service 11-4 Starting a Service 11-5
vi
OL-10643-01
Contents
CHAPTER
12
Real-Time Monitoring Configuration 12-1 Loading Real-Time Monitoring 12-2 RTMT Default Configuration 12-4 Creating Configuration Profiles 12-5 RTMT Window Components 12-6 Viewing the Summary Category in the View Tab 12-7 Viewing the Server Category in the View Tab 12-9 Monitoring Server CPU and Memory Information 12-9 Monitoring Server Disk Usage 12-10 Monitoring Server Critical Services 12-11 Viewing the CallProcess Category in the View Tab 12-12 Monitoring Call Activity 12-12 Monitoring Gateway Activity 12-13 Monitoring Trunk Activity 12-14 Monitoring SDL Queue 12-15 Viewing the Service Category in the View Tab 12-16 Monitoring Cisco TFTP 12-16 Monitoring Directory Server Information 12-17 Monitoring Heartbeat 12-19 Viewing the Device Category in the View Tab 12-20 Monitoring Device Summary Information 12-20 Monitoring Devices by Using Device Search 12-21 Viewing Phone Information 12-25 Viewing Device Properties 12-27 Viewing Application Information 12-27 Viewing the CTI Category in the View Tab 12-28 Monitoring CTI Manager Information 12-29 Using CTI Search 12-30 Monitoring CTI Applications by Using CTI Search 12-30
OL-10643-01
vii
Contents
Monitoring CTI Devices by Using CTI Search 12-32 Monitoring CTI Lines by Using the CTI Search 12-34 Understanding Performance Monitoring 12-36 Adding a Counter to Monitor by Using the Perfmon Category 12-36 Configuring Performance Counters in Table View/Chart View 12-38 Configuring Alert Notification for a Counter 12-39 Zooming a Counter 12-43 Understanding Counter Properties 12-43 Displaying a Property Description 12-44 Configuring a Data Sample 12-45 Viewing Counter Data 12-46 Removing a Counter from Monitor 12-47 Understanding Alert Central in the Alert Tab 12-48 Viewing and Sorting Alerts in Alert Central 12-49 Setting Alert Properties 12-51 Removing an Alert 12-54 Enabling an Alert 12-56 Disabling an Alert 12-57 Suspending Alerts on Cisco Unified CallManager Nodes or the Cluster 12-58 Clearing Alerts 12-60 Viewing Alert Events Details 12-61 Configuring E-mails for Alert Notification 12-62 Configuring Alert Actions 12-63 Counter Alert Configuration Settings 12-64
13
CHAPTER
QRT Viewer 13-1 Listing IP Phone Problem Reports 13-2
viii
OL-10643-01
Contents
CHAPTER
14
Serviceability Reports Archive Configuration 14-1 Reporting Tools Configuration
PART
CHAPTER
15
CDR Analysis and Reporting 15-1 Installing the CAR Plug-in 15-2 Uninstalling the CAR Plug-in 15-3 Configuring CDR Service Parameters 15-4 Accessing the Initial User ID and Password 15-5 Loading CAR 15-5 Administrator Procedure 15-6 Administrator and User Procedure 15-7 Logging On to CAR 15-7 Logging Out of CAR 15-8 Viewing About CAR 15-8
CHAPTER
16
CAR System Configuration 16-1 System Parameters Configuration 16-1 Granting Administrator Rights 16-2 Revoking Administrator Rights 16-3 Configuring Mail Server Parameters 16-4 Configuring the Dial Plan 16-5 Restoring the Default Values for the CAR Dial Plan 16-6 Gateway Configuration 16-8 Configuring System Preferences 16-10 System Scheduler Configuration 16-11 Configuring the CDR Load Schedule 16-12 Restoring the Default CDR Load Schedule 16-15
ix
Contents
Disabling the Loading of CDR Data 16-15 Enabling the Loading of CDR Data 16-16 Scheduling Daily Reports 16-17 Scheduling Weekly Reports 16-18 Scheduling Monthly Reports 16-20 Restoring Default Report Schedules 16-21 Disabling Reports 16-23 Starting or Stopping the CAR Scheduler 16-24 System Database Configuration 16-25 Configuring CAR Database Alerts 16-25 Configuring CDR Database Alerts 16-27 Configuring Automatic Database Purge 16-29 Disabling Automatic Database Purge 16-30 Using Manual Database Purge 16-31 Restoring Database Purge Defaults 16-32 System Log Screens 16-33 Generating the Event Log 16-33 Generating the Error Log 16-34 Understanding Log Reports 16-35 Understanding the Event Log Output 16-36 Understanding the Error Log Output 16-36 Understanding the Error Log Details 16-37
17
CHAPTER
CAR Report Configuration 17-1 Configuring the Rating Engine 17-2 Setting the Base Rate and Duration 17-2 Factoring Time of Day into Call Cost 17-4 Factoring Voice Quality into Call Cost 17-5 Restoring Default Values for Call Cost 17-7
OL-10643-01
Contents
Restoring Default Values for Duration 17-7 Restoring Default Values for Time of Day 17-8 Restoring Default Values for Voice Quality 17-8 Defining the Quality of Service (QoS) Values 17-9 Restoring Default QoS Values 17-10 Configuring Automatic Report Generation/Alert 17-12 Enabling or Customizing Reports for Automatic Generation 17-13 Enabling or Disabling Alerts by Mail 17-14 Configuring Notification Limits 17-15
18
CHAPTER
CAR User Reports Configuration 18-1 Understanding Bills 18-2 Configuring Individual Bills 18-2 Configuring Department Bills 18-3 Understanding Top N 18-5 Configuring Top N by Charge 18-6 Configuring Top N by Duration 18-8 Configuring Top N by Number of Calls 18-11 Understanding Cisco Unified CallManager Assistant 18-14 Configuring Manager Call Usage for Cisco Unified CallManager Assistant 18-15 Configuring Assistant Call Usage for Cisco Unified CallManager Assistant 18-16 Configuring CTI Application User Reports 18-18 Configuring Reports for Cisco Unified IP Phone Services 18-19 Mailing a Report 18-20 Searching for Users 18-22
xi
Contents
CHAPTER
19
CAR System Reports Configuration 19-1 Configuring QoS Reports 19-2 QoS Detail Report Configuration 19-2 QoS Summary Report Configuration 19-5 Configuring QoS Parameters 19-8 QoS by Gateway Configuration 19-8 QoS by Call Types Configuration 19-11 Configuring Traffic Reports 19-15 Configuring Traffic Summary 19-15 Configuring Traffic Summary by Extensions 19-19 Configuring Malicious Call Details Reports 19-23 Configuring Precedence Call Summary 19-24 Configuring Client Matter Code Reports 19-25 Configuring Authorization Code Name Reports 19-27 Configuring Authorization Level Reports 19-28 Configuring System Overview 19-30 Configuring CDR Error 19-31 QoS Parameter Operators 19-32
CHAPTER
20
CAR Device Reports Configuration 20-1 Configuring Gateway Reports 20-1 Gateway Detail Report Configuration 20-2 Gateway Summary Report Configuration 20-5 Gateway Utilization Reports Configuration 20-8 Configuring Route Plan Reports 20-10 Route and Line Group Utilization Reports Configuration 20-11 Route/Hunt List Utilization Report Configuration 20-13 Route Pattern/Hunt Pilot Utilization Report Configuration 20-16
xii
OL-10643-01
Contents
Configuring Conference Call Details 20-18 Configuring Conference Bridge Utilization Reports 20-20 Configuring Voice-Messaging Utilization Reports 20-22
21
CHAPTER
CDR Search Configuration 21-1 Configuring CDR Search by User Extension 21-2 Configuring CDR Search by Gateway 21-3 Configuring CDR Search by Cause for Call Termination 21-5 Viewing Call Termination Details 21-7 Configuring CDR Search By Call Precedence Levels 21-8 Configuring CDR Search for Malicious Calls 21-10
CHAPTER
22
Export CDR/CMR Records Configuration 22-1 Viewing Export CDR/CMR Records Results 22-2
PART
Other Monitoring Tools

23
CHAPTER
Microsoft Performance 23-1 Starting the Microsoft Performance Program 23-1 Viewing Performance Statistics 23-2 Extending Your Data Display 23-3
CHAPTER
24
Bulk Trace Analysis 24-1 Downloading Bulk Trace Analysis 24-1 Installing the Bulk Trace Analysis Program 24-2 Using Bulk Trace Analysis 24-3 Starting and Exiting the Program 24-4 Creating a Report 24-6
OL-10643-01
xiii
Contents
Opening a Report 24-8 Printing a Report 24-9 Saving the Master Report 24-10 Searching for Data in a Report 24-11 Creating a Report with Multiple Views 24-12 Displaying View Information 24-15 Customizing the Report Table Headings 24-16
7
PART
CiscoWorks2000 Interfaces
25
CHAPTER
Overview of CiscoWorks2000 25-1 CiscoWorks2000 25-2 Remote Network Management Features 25-2 IP Path Analysis Interface 25-2 System Log Management 25-2 Simple Network Management Protocol Support 25-3 Cisco Discovery Protocol 25-3
CHAPTER
26
Path Analysis Configuration 26-1 Understanding Path Analysis 26-1 Setting Up Call Detail Records Logging 26-2
CHAPTER
27
System Log Management Configuration 27-1 Understanding System Log Management 27-1 Directing Syslog Messages 27-2 Directing Messages to Local Syslog Analyzer Collector 27-3 Directing Messages to CiscoWorks2000 Server 27-4 Enabling the SNMP Agent 27-5
xiv
OL-10643-01
Contents
CHAPTER
28
Cisco Discovery Protocol Support Configuration 28-1 Using CDP Advertisement Support 28-1 Using the CDP Driver 28-2 Accessing CDP Driver Control 28-2 Installing the CDP Protocol Driver 28-3 Starting the CDP Protocol Driver 28-3 Enabling the CDP Protocol Driver 28-4 Showing CDP Protocol Driver Property 28-5 Updating an IP Address for CDP Protocol Driver 28-5 Locating Updated CDP Driver and Interface Files 28-6 Default CDP Setting 28-7
PART
Remote Serviceability Tools

29
CHAPTER
Cisco Secure Telnet Configuration 29-1 Cisco Secure Telnet Components 29-1 The Relay Server 29-2 Telnet Client 29-2 Telnet Server 29-2 Cisco Secure Telnet Applications 29-3 Cisco Secure Telnet Executables 29-3 Telnet Proxy 29-4 Command Line Syntax for tndconnect 29-4 Display All Options 29-5 Telnet Connector Program Structure 29-5 Terminate a Cisco Secure Telnet Session 29-6 Connect with the Telnet Daemon 29-6 Plan for a Windows NT Telnet Daemon 29-7 Cisco Secure Telnet Usage Scenario 29-7
OL-10643-01
xv
Contents
CHAPTER
30
Show Command Line Interface 30-1 Show Command Syntax 30-1 Show Command Options 30-2
CHAPTER
31
Simple Network Management Protocol Configuration 31-1 Configuring SNMP Security 31-2 Setting the SNMP Trap Receiver 31-3 Starting the Cisco Unified CallManager SNMP Extension Agent 31-4 Configuring the Cisco Unified CallManager Traps 31-5 Stopping the Cisco Unified CallManager SNMP Extension Agent 31-8 Understanding Cisco Real-Time Information Server Data Collector 31-9 Starting the Cisco RIS Data Collector 31-9 Stopping Cisco RIS Data Collector 31-10 Updating the CISCO-CCM-MIB Information 31-11
PART
Appendix
A
APPENDIX
Understanding CAR Reports A-1 Bill Summary Report Results A-2 Bill Detail Report Results A-4 Top N By Charge or Duration Report Results A-6 Top N By Number of Calls Report Results A-8 Call Usage for AssistantDetail A-9 Call Usage for AssistantSummary A-10 Call Usage for ManagerDetail A-11 Call Usage for ManagerSummary A-12 CTI Application User Report Results A-13
xvi
OL-10643-01
Contents
Cisco Unified IP Phone Services Report Results A-14 QoS Detail Report Results A-14 QoS Summary Report Results A-16 QoS by Gateways Report Results A-17 QoS by Call Types Report Results A-18 Traffic Summary Report Results A-20 Authorization Code Name Call Details A-21 Authorization Level Call Details A-22 Client Matter Code Details A-23 Malicious Call Details Report Results A-23 Precedence Call Summary Report Results A-24 System Overview Report Results A-25 CDR Error Report Results A-27 Gateway Detail Report Results A-28 Gateway Summary Report Results A-30 Gateway and Route Utilization Report Results A-31 Conference Call Detail Report Results A-32 Conference Bridge Utilization Report Results A-33 Voice Messaging Utilization Report Results A-34 Understanding the CDR Search Results A-35 Understanding the Results for CDR Search A-35 Media Information A-37 CDR and CMR Dump Tables A-38
INDEX
xvii
Contents
xviii
OL-10643-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 xix Audience, page xx Organization, page xx Related Documentation, page xxiii Conventions, page xxiv Obtaining Documentation, page xxv Documentation Feedback, page xxvii Cisco Product Security Overview, page xxvii Obtaining Technical Assistance, page xxix Obtaining Additional Publications and Information, page xxxi
Purpose
The Cisco CallManager Serviceability Administration Guide provides information about Cisco Unified CallManager Serviceability, remote serviceability tools, and the Cisco Unified CallManager CDR Analysis and Reporting tool.
xix
Preface Audience
Use this book with the Cisco CallManager System Guide, the Cisco Unified CallManager Administration Guide, and the Cisco Unified CallManager Serviceability System Guide. All documents provide instructions for administering the Cisco Unified CallManager program and include descriptions of procedural tasks that you complete using Cisco Unified CallManager Administration.
Audience
The Cisco CallManager Serviceability Administration Guide provides information for network administrators responsible for managing and supporting the Cisco Unified CallManager system. Network engineers, system administrators, or telecom engineers use this guide to learn about, and administer, remote serviceability features. This guide requires knowledge of telephony and IP networking technology.
Organization
The following table shows how this guide is organized: Chapter Chapter 1, Introduction Chapter 2, Alarm Configuration Chapter 3, Alarm Definitions Chapter 4, Alarm Information Chapter 5, Trace Configuration Description Provides an overview of Cisco Unified CallManager Serviceability, remote serviceability programs, and reporting tools. Provides procedures for configuring the Cisco Unified CallManager alarm tool. Provides procedures for searching and editing the Cisco Unified CallManager alarm definitions tool. Provides procedures for viewing the Cisco Unified CallManager alarms in text and XML format. Provides procedures for configuring the Cisco Unified CallManager trace tool.
xx
OL-10643-01
Preface Organization
Chapter Chapter 6, Trace Collection Configuration Chapter 7, Trace Analysis Configuration Chapter 8, Q.931 Translator Chapter 9, Troubleshooting Trace Setting Configuration
Description Provides procedures for configuring the Cisco Unified CallManager trace collection tool. Provides procedures for configuring the Cisco Unified CallManager trace analysis tool. Provides procedures for using the Q.931 translation tool. Provides procedures for configuring the Troubleshooting Trace Setting tool.
Chapter 10, Provides procedures for using the serviceability service Service Activation activation tool to activate and deactivate Cisco CallManager services. Chapter 11, Control Center Chapter 12, Real-Time Monitoring Configuration Chapter 13, QRT Viewer Chapter 14, Serviceability Reports Archive Configuration Chapter 15, CDR Analysis and Reporting Chapter 16, CAR System Configuration Provides procedures for using the serviceability control center tool to start and stop Cisco Unified CallManager services. Provides procedures for using the Real-Time Monitoring Tool.
Provides procedures for using the IP Phone Problem Reports viewer. Provides procedures for using the Serviceability Reports Archives.
Provides the procedures for configuring the Cisco Unified CallManager CDR Analysis and Reporting (CAR) CDR service parameters and logging in and out of CAR. Provides procedures for configuring the CAR system parameters, system scheduler, and system database.
xxi
Preface Organization
Chapter Chapter 17, CAR Report Configuration Chapter 18, CAR User Reports Configuration Chapter 19, CAR System Reports Configuration Chapter 20, CAR Device Reports Configuration Chapter 21, CDR Search Configuration
Description Provides procedures for configuring the rating engine, quality of service, and automatic generation for CAR reports. Provides procedures for configuring individual and department bills, CTI ports, and Cisco IP phone services for use with CAR user reports. Provides procedures for configuring quality of service reports and parameters, traffic summary, system overview, and CDR errors for use with CAR system reports. Provides procedures for configuring CAR device reports for gateways, conference bridges, and voice-mail utilization. Provides procedures for configuring CAR CDR Search for user extension and gateway.
Chapter 22, Export Provides procedures for configuring Export CDR/CMR CDR/CMR Records records. Configuration Chapter 23, Microsoft Performance Chapter 24, Bulk Trace Analysis Chapter 25, Overview of CiscoWorks2000 Chapter 26, Path Analysis Configuration Provides procedures for using the Microsoft Performance program to monitor the performance of the Cisco Unified CallManager system. Provides procedures for using Bulk Trace Analysis to analyze large trace log files. Provides information on how to remotely monitor the Cisco Unified CallManager system using CiscoWorks2000. Provides information on setting up path analysis and call detail records logging.
Chapter 27, System Provides information for setting up the Syslog file for use Log Management with CiscoWorks2000. Configuration
xxii
OL-10643-01
Preface Related Documentation
Chapter Chapter 28, Cisco Discovery Protocol Support Configuration Chapter 29, Cisco Secure Telnet Configuration Chapter 30, Show Command Line Interface Chapter 31, Simple Network Management Protocol Configuration Appendix A, Understanding CAR Reports
Description Provides general and procedural information for Cisco Discovery Protocol (CDP).
Provides general and procedural information for using Cisco Secure Telnet with the Cisco Unified CallManager system. Provides an overview of the Cisco Show command.
Provides procedures for setting the SNMP agent, setting the SNMP trap receiver, starting the SNMP agent, and updating the management information base (MIB) information. Provides information describing the results of all CAR reports.
Related Documentation
Refer to the following documents for further information about related Cisco IP telephony applications and products:

Installing Cisco Unified CallManager Release 4.2 Release Notes for Cisco Unified CallManager Release 4.2 Cisco Unified CallManager Administration Guide Cisco Unified CallManager System Guide Cisco Unified CallManager Serviceability System Guide Cisco Unified IP Phone 7900 Family Administration Guide Troubleshooting Guide for Cisco Unified CallManager
xxiii
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.
< >
xxiv
OL-10643-01
Preface Obtaining Documentation
Notes use the following conventions:
Note
Means reader take note. Notes contain helpful suggestions or references to material not covered in the publication. 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:
Tip
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
Cisco documentation and additional literature are available on Cisco.com. Cisco also provides several ways to obtain technical assistance and other technical resources. These sections explain how to obtain technical information from Cisco Systems.
xxv
Preface Obtaining Documentation
Cisco.com
You can access the most current Cisco documentation at this URL: http://www.cisco.com/techsupport You can access the Cisco website at this URL: http://www.cisco.com You can access international Cisco websites at this URL: http://www.cisco.com/public/countries_languages.shtml
Product Documentation DVD

Cisco documentation and additional literature are available in the Product Documentation DVD package, which may have shipped with your product. The Product Documentation DVD is updated regularly and may be more current than printed documentation. The Product Documentation DVD is a comprehensive library of technical product documentation on portable media. The DVD enables you to access multiple versions of hardware and software installation, configuration, and command guides for Cisco products and to view technical documentation in HTML. With the DVD, you have access to the same documentation that is found on the Cisco website without being connected to the Internet. Certain products also have .pdf versions of the documentation available. The Product Documentation DVD is available as a single unit or as a subscription. Registered Cisco.com users (Cisco direct customers) can order a Product Documentation DVD (product number DOC-DOCDVD=) from Cisco Marketplace at this URL: http://www.cisco.com/go/marketplace/
Ordering Documentation
Beginning June 30, 2005, registered Cisco.com users may order Cisco documentation at the Product Documentation Store in the Cisco Marketplace at this URL: http://www.cisco.com/go/marketplace/
xxvi
OL-10643-01
Preface Documentation Feedback
Nonregistered Cisco.com users can order technical documentation from 8:00 a.m. to 5:00 p.m. (0800 to 1700) PDT by calling 1 866 463-3487 in the United States and Canada, or elsewhere by calling 011 408 519-5055. You can also order documentation by e-mail at tech-doc-store-mkpl@external.cisco.com or by fax at 1 408 519-5001 in the United States and Canada, or elsewhere at 011 408 519-5001.
Documentation Feedback
You can rate and provide feedback about Cisco technical documents by completing the online feedback form that appears with the technical documents on Cisco.com. You can send comments about Cisco documentation to bug-doc@cisco.com. You can submit comments by using the response card (if present) behind the front cover of your document or by writing to the following address: Cisco Systems, Inc. Attn: Customer Document Ordering 170 West Tasman Drive San Jose, CA 95134-9883 We appreciate your comments.
Cisco Product Security Overview

This product contains cryptographic features and is subject to United States and local country laws governing import, export, transfer and use. Delivery of Cisco cryptographic products does not imply third-party authority to import, export, distribute or use encryption. Importers, exporters, distributors and users are responsible for compliance with U.S. and local country laws. By using this product you agree to comply with applicable laws and regulations. If you are unable to comply with U.S. and local laws, return this product immediately. A summary of U.S. laws governing Cisco cryptographic products may be found at: http://www.cisco.com/wwl/export/crypto/tool/stqrg.html. If you require further assistance please contact us by sending email to export@cisco.com.
xxvii
Preface Cisco Product Security Overview
Cisco provides a free online Security Vulnerability Policy portal at this URL: http://www.cisco.com/en/US/products/products_security_vulnerability_policy.ht ml From this site, you can perform these tasks:

Report security vulnerabilities in Cisco products. Obtain assistance with security incidents that involve Cisco products. Register to receive security information from Cisco.
A current list of security advisories and notices for Cisco products is available at this URL: http://www.cisco.com/go/psirt If you prefer to see advisories and notices as they are updated in real time, you can access a Product Security Incident Response Team Really Simple Syndication (PSIRT RSS) feed from this URL: http://www.cisco.com/en/US/products/products_psirt_rss_feed.html
Reporting Security Problems in Cisco Products

Cisco is committed to delivering secure products. We test our products internally before we release them, and we strive to correct all vulnerabilities quickly. If you think that you might have identified a vulnerability in a Cisco product, contact PSIRT:
Emergencies security-alert@cisco.com An emergency is either a condition in which a system is under active attack or a condition for which a severe and urgent security vulnerability should be reported. All other conditions are considered nonemergencies.
Nonemergencies psirt@cisco.com 1 877 228-7302 1 408 525-6532
In an emergency, you can also reach PSIRT by telephone:

xxviii
OL-10643-01
Preface Obtaining Technical Assistance
Tip
We encourage you to use Pretty Good Privacy (PGP) or a compatible product to encrypt any sensitive information that you send to Cisco. PSIRT can work from encrypted information that is compatible with PGP versions 2.x through 8.x. Never use a revoked or an expired encryption key. The correct public key to use in your correspondence with PSIRT is the one linked in the Contact Summary section of the Security Vulnerability Policy page at this URL: http://www.cisco.com/en/US/products/products_security_vulnerability_policy.ht ml The link on this page has the current PGP key ID in use.
Obtaining Technical Assistance

Cisco Technical Support provides 24-hour-a-day award-winning technical assistance. The Cisco Technical Support & Documentation website on Cisco.com features extensive online support resources. In addition, if you have a valid Cisco service contract, Cisco Technical Assistance Center (TAC) engineers provide telephone support. If you do not have a valid Cisco service contract, contact your reseller.
Cisco Technical Support & Documentation Website

The Cisco Technical Support & Documentation website provides online documents and tools for troubleshooting and resolving technical issues with Cisco products and technologies. The website is available 24 hours a day, at this URL: http://www.cisco.com/techsupport Access to all tools on the Cisco Technical Support & Documentation website requires a Cisco.com user ID and password. If you have a valid service contract but do not have a user ID or password, you can register at this URL: http://tools.cisco.com/RPF/register/register.do
xxix
Preface Obtaining Technical Assistance
Note
Use the Cisco Product Identification (CPI) tool to locate your product serial number before submitting a web or phone request for service. You can access the CPI tool from the Cisco Technical Support & Documentation website by clicking the Tools & Resources link under Documentation & Tools. Choose Cisco Product Identification Tool from the Alphabetical Index drop-down list, or click the Cisco Product Identification Tool link under Alerts & RMAs. The CPI tool offers three search options: by product ID or model name; by tree view; or for certain products, by copying and pasting show command output. Search results show an illustration of your product with the serial number label location highlighted. Locate the serial number label on your product and record the information before placing a service call.
Submitting a Service Request

Using the online TAC Service Request Tool is the fastest way to open S3 and S4 service requests. (S3 and S4 service requests are those in which your network is minimally impaired or for which you require product information.) After you describe your situation, the TAC Service Request Tool provides recommended solutions. If your issue is not resolved using the recommended resources, your service request is assigned to a Cisco engineer. The TAC Service Request Tool is located at this URL: http://www.cisco.com/techsupport/servicerequest For S1 or S2 service requests or if you do not have Internet access, contact the Cisco TAC by telephone. (S1 or S2 service requests are those in which your production network is down or severely degraded.) Cisco engineers are assigned immediately to S1 and S2 service requests to help keep your business operations running smoothly. To open a service request by telephone, use one of the following numbers: Asia-Pacific: +61 2 8446 7411 (Australia: 1 800 805 227) EMEA: +32 2 704 55 55 USA: 1 800 553-2447 For a complete list of Cisco TAC contacts, go to this URL: http://www.cisco.com/techsupport/contacts
xxx
OL-10643-01
Preface Obtaining Additional Publications and Information
Definitions of Service Request Severity

To ensure that all service requests are reported in a standard format, Cisco has established severity definitions. Severity 1 (S1)Your network is down, or there is a critical impact to your business operations. You and Cisco will commit all necessary resources around the clock to resolve the situation. Severity 2 (S2)Operation of an existing network is severely degraded, or significant aspects of your business operation are negatively affected by inadequate performance of Cisco products. You and Cisco will commit full-time resources during normal business hours to resolve the situation. Severity 3 (S3)Operational performance of your network is impaired, but most business operations remain functional. You and Cisco will commit resources during normal business hours to restore service to satisfactory levels. Severity 4 (S4)You require information or assistance with Cisco product capabilities, installation, or configuration. There is little or no effect on your business operations.
Obtaining Additional Publications and Information

Information about Cisco products, technologies, and network solutions is available from various online and printed sources.
Cisco Marketplace provides a variety of Cisco books, reference guides, documentation, and logo merchandise. Visit Cisco Marketplace, the company store, at this URL: http://www.cisco.com/go/marketplace/
Cisco Press publishes a wide range of general networking, training and certification titles. Both new and experienced users will benefit from these publications. For current Cisco Press titles and other information, go to Cisco Press at this URL: http://www.ciscopress.com Packet magazine is the Cisco Systems technical user magazine for maximizing Internet and networking investments. Each quarter, Packet delivers coverage of the latest industry trends, technology breakthroughs, and
xxxi
Preface Obtaining Additional Publications and Information
Cisco products and solutions, as well as network deployment and troubleshooting tips, configuration examples, customer case studies, certification and training information, and links to scores of in-depth online resources. You can access Packet magazine at this URL: http://www.cisco.com/packet
iQ Magazine is the quarterly publication from Cisco Systems designed to help growing companies learn how they can use technology to increase revenue, streamline their business, and expand services. The publication identifies the challenges facing these companies and the technologies to help solve them, using real-world case studies and business strategies to help readers make sound technology investment decisions. You can access iQ Magazine at this URL: http://www.cisco.com/go/iqmagazine or view the digital edition at this URL: http://ciscoiq.texterity.com/ciscoiq/sample/
Internet Protocol Journal is a quarterly journal published by Cisco Systems for engineering professionals involved in designing, developing, and operating public and private internets and intranets. You can access the Internet Protocol Journal at this URL: http://www.cisco.com/ipj Networking products offered by Cisco Systems, as well as customer support services, can be obtained at this URL: http://www.cisco.com/en/US/products/index.html Networking Professionals Connection is an interactive website for networking professionals to share questions, suggestions, and information about networking products and technologies with Cisco experts and other networking professionals. Join a discussion at this URL: http://www.cisco.com/discuss/networking
World-class networking training is available from Cisco. You can view current offerings at this URL: http://www.cisco.com/en/US/learning/index.html
xxxii
OL-10643-01
A R T
Cisco CallManager Serviceability
C H A P T E R
Introduction
This chapter provides an overview of Cisco Unified CallManager Serviceability, remote serviceability, and Cisco Unified CallManager CDR Analysis and Reporting. Administrators can use the Cisco Unified CallManager Administration service tools to troubleshoot system problems. These tools include Serviceability, remote serviceability, and Cisco Unified CallManager CDR Analysis and Reporting. This chapter comprises the following topics:

Cisco Unified CallManager Serviceability, page 1-1 Remote Serviceability, page 1-2 Cisco Unified CallManager CDR Analysis and Reporting, page 1-3 Using Hypertext Transfer Protocol over Secure Sockets Layer (HTTPS), page 1-4 Where to Find More Information, page 1-7
Cisco Unified CallManager Serviceability

This web-based tool, Serviceability, provides the following services:

AlarmsSaves Cisco Unified CallManager services alarms and events for troubleshooting and provides alarm message definitions. TraceSaves Cisco Unified CallManager services trace information to various log files for troubleshooting. Administrators can configure, collect, and analyze trace information.
1-1
Chapter 1 Cisco Unified CallManager Serviceability
Introduction
Real-Time MonitoringMonitors real-time behavior of the components in a Cisco Unified CallManager cluster. Service ActivationViews activation status of Cisco Unified CallManager services. Administrators use Service Activation to activate and deactivate services. Control CenterViews status of Cisco Unified CallManager services. Administrators use Control Center to start and stop services. IP Phone Problem Reports ViewerViews IP phone problem reports that are generated by the Quality Report Tool (QRT).
Access Serviceability from the Cisco Unified CallManager Administration window by choosing Applications from the menu bar. Installing the Cisco Unified CallManager software automatically installs Serviceability and makes it available for use.
Remote Serviceability
Cisco Service Engineers (CSE) use the remote serviceability tools to supplement the management and administration of your Cisco Unified CallManager system. Using these tools, CSEs gather system and debug information when remote troubleshooting or diagnostic help is needed. With customer permission, technical support engineers log on to a Cisco Unified CallManager server and get a desktop or shell that allows them to perform any function that could be done from a local logon session. Remote serviceability supports numerous applications in the multihost and multiplatform Cisco Unified Communications Solutions environment. The tools can process and report on a vast collection of local or remote Cisco Unified CallManager configuration data and system information. Cisco Unified CallManager supports the following capabilities for remote serviceability:

Cisco Secure TelnetAllows CSEs to log on to customer remote site to troubleshoot Cisco Unified CallManager system. Show Command Line InterfaceAllows CSEs to display Cisco Unified CallManager system statistics on customer network.
1-2
OL-10643-01
Chapter 1
Introduction Cisco Unified CallManager Serviceability
Microsoft Windows 2000 Performance MonitoringAllows administrators to monitor performance of Cisco Unified CallManager on local or remote installations. Message Translator for ISDN TraceAllows CSEs to use Q931 Message Translator to debug ISDN Layer 3 protocol messages. CiscoWorks2000 Network Management SystemProvides remote network management for a Cisco Unified CallManager cluster. Path Analysis InterfaceTraces connectivity between two specified points on a network and analyzes both physical and logical paths (Layer 2 and Layer 3) taken by packets flowing between those points. System Log ManagementProvides a centralized system logging service for Cisco Unified Communications Solutions. SNMP InstrumentationEnables administrators to remotely manage network performance, find and solve network problems, and plan for network growth. Cisco Discovery Protocol SupportEnables discovery of Cisco Unified CallManager servers and management of those servers by CiscoWorks2000.
Related Topics

Cisco Unified CallManager CDR Analysis and Reporting, page 1-3 Where to Find More Information, page 1-7
Cisco Unified CallManager CDR Analysis and Reporting

The Cisco Unified CallManager Serviceability reporting tool, Cisco Unified CallManager CDR Analysis and Reporting (CAR), provides the following functions:
Multiple levels of usersAdministrators who can generate system reports, and configure system parameters; managers who can generate reports for users an departments; users who can generate individual billing reports. Generate user reportsUser reports include individual bills, department bills, top N by charge, top N by duration, top N by number of calls, CTI port enabled, and Cisco IP phone services.
1-3
Chapter 1 Using Hypertext Transfer Protocol over Secure Sockets Layer (HTTPS)
Introduction
Generate system reportsSystem reports include QoS detail, QoS summary, QoS by gateway, QoS by call types, traffic summary, traffic summary with extensions, system overview, and CDR error. Generate device reportsDevice reports include gateway detail, gateway summary, gateway utilization, route group utilization, route list utilization, route pattern utilization, conference bridge utilization, and voice mail utilization. CDR searchSearches the CDR database to verify the details of a call helping to track the progress and quality of leg of a call. System configurationAdministrators configure system parameters, report scheduler, database options, and error and event logs. Report configurationAdministrators configure base rate and duration for calls, factoring options, QoS values, and automatic report generation/alert.
Related Topics

Cisco Unified CallManager Serviceability, page 1-1 Where to Find More Information, page 1-7
Using Hypertext Transfer Protocol over Secure Sockets Layer (HTTPS)

This section contains information on the following topics:

HTTPS Overview, page 1-5 Saving the Certificate to the Trusted Folder, page 1-6
Note
For additional information about HTTPS, refer to Cisco Unified CallManager Security Guide.
1-4
OL-10643-01
Chapter 1
Introduction Using Hypertext Transfer Protocol over Secure Sockets Layer (HTTPS)
HTTPS Overview
Hypertext Transfer Protocol over Secure Sockets Layer (SSL), which secures communication between the browser client and the IIS server, uses a certificate and a public key to encrypt the data that is transferred over the internet. HTTPS, which ensures the identity of the server, supports applications, such Cisco Unified CallManager Serviceability. HTTPS also ensures that the user login password transports securely via the web. The first time that you (or a user) accesses Cisco Unified CallManager Administration or other Cisco Unified CallManager SSL-enabled virtual directories after the Cisco Unified CallManager installation/upgrade, a Security Alert dialog box asks if you trust the server. When the dialog box displays, you must perform one of the following tasks:
By clicking Yes, you choose to trust the certificate for the current web session only. If you trust the certificate for the current session only, the Security Alert dialog box displays each time that you access the application, that is, until you install the certificate in the trusted folder. By clicking View Certificate > Install Certificate, you intend to perform certificate installation tasks, so you always trust the certificate. If you install the certificate in the trusted folder, the Security Alert dialog box does not display each time that you access the web application. By clicking No, you cancel the action. No authentication occurs, and you cannot access the web application. To access the web application, you must click Yes or install the certificate via the View Certificate > Install Certificate options.
Note
If you access the web application by using the hostname and install the certificate in the trusted folder and then try to access the application by using the localhost or IP address, the Security Alert dialog box displays to indicate that the name of the security certificate does not match the name of the site. If you use the localhost, the IP address, or the hostname in the URL to access the application, you must save the certificate in the trusted folder for each type (localhost, IP address, and so on).
1-5
Chapter 1 Using Hypertext Transfer Protocol over Secure Sockets Layer (HTTPS)
Introduction
Note
Https does not work for https-enabled applications when you browse into the application by using Netscape 4.79 and a hostname that contains an underscore (_). If the error message, The computer name <xxxx> contains one or more non-standard characters. Standard characters include letters (A-Z), digits (0-9), and hyphens (-). Using a nonstandard name will prevent others from finding the computer on the network, unless your network is using the Microsoft DNS Server. Do you want to use this nonstandard name? displays, click No. This error occurs because the certificate that enables the https service uses the hostname as the subject name of the certificate; Netscape 4.79 considers the underscore in the subject name to be an invalid character, so https will not work. For https support, use Internet Explorer. To use Netscape 4.79 and the hostname to access the application, disable https, as described in Cisco Unified CallManager Security Guide.
Related Topics

Using Hypertext Transfer Protocol over Secure Sockets Layer (HTTPS), page 1-4 Saving the Certificate to the Trusted Folder, page 1-6
Saving the Certificate to the Trusted Folder

To save the CA Root certificate in the trusted folder so the Security Alert dialog box does not display each time that you access the web application, perform the following procedure:
Procedure
Step 1 Step 2 Step 3 Step 4 Step 5 Step 6
Browse to the application on the IIS server. When the Security Alert dialog box displays, click View Certificate. In the Certificate pane, click Install Certificate. Click Next. Click the Place all certificates in the following store radio button; click Browse. Browse to Trusted Root Certification Authorities.
1-6
OL-10643-01
Chapter 1
Introduction Where to Find More Information
Step 7 Step 8 Step 9
Click Next. Click Finish. To install the certificate, click Yes. A message states that the import was successful.Click OK. In the lower, right corner of the dialog box, click OK. To trust the certificate so you do not receive the dialog box again, click Yes.
Step 10 Step 11
Note
If you use the localhost, the IP address, or the hostname in the URL to access Cisco Unified CallManager Administration, you must save the certificate in the trusted folder for each of type (local host, IP address, and so on); otherwise, the Security Alert dialog box displays for each type.
Related Topics

Using Hypertext Transfer Protocol over Secure Sockets Layer (HTTPS), page 1-4 HTTPS Overview, page 1-5
Where to Find More Information

Cisco Unified CallManager Administration Guide Cisco Unified CallManager System Guide Cisco Unified CallManager Serviceability System Guide Cisco Unified CallManager Security Guide CiscoWorks2000 user documentation: http://www.cisco.com/univercd/cc/td/doc/product/rtrmgmt/cw2000/index.htm
1-7
Chapter 1 Where to Find More Information
Introduction
1-8
OL-10643-01
A R T
Alarms Configuration and View Definitions
C H A P T E R
Alarm Configuration
This chapter provides procedural information to configure Serviceability Alarms and contains the following topics:

Configuring or Updating an Alarm for a Service, page 2-2 Applying an Alarm Configuration to All Nodes in a Cluster, page 2-4 Alarm Destination Settings, page 2-6 Alarm Event Level Settings, page 2-7
Cisco Unified CallManager Serviceability Alarms provides a web-based interface that has two main functions: configure alarms and events and provide alarm message definitions. Both functions assist the system administrator and support personnel in troubleshooting Cisco Unified CallManager problems.You can configure alarms for Cisco Unified CallManager servers that are in a cluster and services for each server, such as Cisco CallManager, Cisco TFTP, and Cisco CTIManager (see the Configuring or Updating an Alarm for a Service section on page 2-2). You use Alarms to provide runtime status and state of the system and to take corrective action for problem resolution; for example, to determine whether phones are registered and working. Alarms contain information such as explanation and recommended action. Alarm information includes application name, machine name, and cluster name to help you perform troubleshooting for problems that are not on your local Cisco Unified CallManager. You configure the Alarm interface to send alarm information to multiple destinations, and each destination can have its own alarm event level (from debug to emergency).
2-1
Chapter 2 Configuring or Updating an Alarm for a Service
Alarm Configuration
You can forward alarms to a Serviceability Trace file. An administrator configures Alarms and Trace parameters and provides the information to a Cisco TAC engineer. You can direct Alarms to the Win2000 Event Log, Syslog, an SDI trace log file, an SDL trace log file (for Cisco Unified CallManager and Cisco CTIManager only), or to all destinations. Use Trace to collect and analyze the alarms. When a service issues an alarm, the alarm interface sends the alarm to the chosen monitors (for example, SDI trace, Cisco RIS Data Collector). The monitor forwards the alarm or writes it to its final destination (such as a log file).
Note
To log alarms in the SDI trace log file, check two check boxes in Trace configuration and one check box in Alarm configuration: the Trace on check box in Trace configuration, the Enable trace file log check box in Trace configuration, and the SDI alarm destination check box in Alarm configuration.
Configuring or Updating an Alarm for a Service

This section describes how to configure an alarm for any service that you activate in Cisco Unified CallManager Serviceability.
Note
Java-based applications cannot be configured using the alarm configuration web pages. Use the standard registry editor provided with your operating system to view the alarm configuration and to change registry entries. You can access the registry by running RegEdt32.exe or RegEdit.exe registry editors. Registry entries are described in the following examples: Go to HKEY_LOCAL_MACHINE\SOFTWARE\Cisco Systems, Inc.\Cisco Java Applications\Monitors\Event Log. Set the Enabled key to a value of 0 to turn off Event Log, or 1 to turn it on. Go to HKEY_LOCAL_MACHINE\SOFTWARE\Cisco Systems, Inc.\Cisco Java Applications\Monitors\Event Log. Set the Enabled the Severity key to a value between 0 and 7 to set the Alarm Event Level. See the Alarm Event Level Settings section on page 2-7 for event level settings.
2-2
OL-10643-01
Chapter 2
Alarm Configuration Configuring or Updating an Alarm for a Service
If you change the registry entries, then JavaApplications must be restarted in order for the configuration changes to take effect.
Note
Cisco recommends that you do not change SNMP Trap and Catalog configurations. Refer to your online OS documentation for more information on how to use your standard registry editor.
Procedure
Step 1
From the Cisco Unified CallManager Administration window, choose Application > Cisco Unified CallManager Serviceability. The Cisco Unified CallManager Serviceability window displays. Choose Alarm > Configuration. From the Servers column, choose the server. The server you chose displays, and a box with available services for alarms displays.
Step 2 Step 3
Step 4
From the Available Services for Alarm list, choose the service for which you want to configure the alarm. The service that you chose displays after the Current Service title, along with the current server that you chose. A list of alarm monitors with the event levels displays in the Alarm Configuration window.
Note
Only the Cisco CallManager and CTIManager services have the check box for Enable Alarm for SDL Trace available.
Step 5 Step 6
Check the check box or boxes for the desired alarm destination as described in Table 2-1. In the Alarm Event Level selection box, click the Down arrow. A list with event levels displays. Click the desired alarm event level as described in Table 2-2.
Step 7
2-3
Chapter 2 Applying an Alarm Configuration to All Nodes in a Cluster
Alarm Configuration
Step 8
To save your configuration, click the Update button.
Note
To set the default, click the SetDefault button; then, click Update. To apply the current settings for selected services to all nodes in a cluster, check the Apply to all Nodes check box.
Related Topics

Applying an Alarm Configuration to All Nodes in a Cluster, page 2-4 Alarm Destination Settings, page 2-6 Alarm Event Level Settings, page 2-7 Alarms, Cisco CallManager System Guide
Applying an Alarm Configuration to All Nodes in a Cluster

This section describes how to apply an alarm configuration for all nodes in a Cisco Unified CallManager cluster.
Procedure
Step 1
From the Cisco Unified CallManager Administration window, choose Application > Cisco Unified CallManager Serviceability. The Cisco Unified CallManager Serviceability window displays. Choose Alarm > Configuration. From the Servers column, choose the server. The server that you chose displays, and a box with available services for alarms displays.
Step 2 Step 3
Step 4
From the Available Services for Alarm list, choose the service for which you want to update the alarm configuration.
2-4
OL-10643-01
Chapter 2
Alarm Configuration Applying an Alarm Configuration to All Nodes in a Cluster
The service that you chose displays after the Current Service title, along with the current server that you chose. A list of alarm monitors with the event levels displays in the Alarm Configuration window.
Note
Only the Cisco CallManager and CTIManager services have the check box for Enable Alarm for Trace (SDL) available.
Step 5 Step 6
Check the check box or boxes for the desired alarm destination as described in Table 2-1. In the Alarm Event Level selection box, click the Down arrow. A list with eight event levels displays.
Click the desired alarm event level as described in Table 2-2. Check the Apply to all Nodes check box. To save your configuration, click the Update button.
Note
To set the default, click the SetDefault button.
Related Topics

Configuring or Updating an Alarm for a Service, page 2-2 Alarm Destination Settings, page 2-6 Alarm Event Level Settings, page 2-7
2-5
Chapter 2 Alarm Destination Settings
Alarm Configuration
Alarm Destination Settings

Table 2-1 describes the alarm destination settings.
Table 2-1 Alarm Destinations
Name Enable Alarm for Event Viewer
Destination description Windows 2000 Event Viewer program. The program logs Cisco Unified CallManager errors in the Application Logs within Event Viewer and provides a description of the alarm and a recommended action. The SDI trace library. Ensure this alarm destination is configured in Trace configuration of Cisco Unified CallManager Serviceability.
Enable Alarm for SDI Trace
Enable Alarm for Syslog The Syslog file. Check this check box to enable the Syslog messages and configure the Syslog server name. If this destination is enabled and no server name is specified, Cisco Unified CallManager sends Syslog messages to the local host. This box remains unchecked by default. Enable Alarm for SDL Trace The SDL trace library. This destination applies only to Cisco CallManager and CTIManager services. Configure this alarm destination using Trace SDL configuration. See the Trace Analysis Configuration section on page 7-1 for more information.
Related Topics

Configuring or Updating an Alarm for a Service, page 2-2 Applying an Alarm Configuration to All Nodes in a Cluster, page 2-4 Alarm Event Level Settings, page 2-7
2-6
OL-10643-01
Chapter 2
Alarm Configuration Alarm Event Level Settings
Alarm Event Level Settings

Table 2-2 describes the alarm event level settings.
Table 2-2 Alarm Event Levels
Name Emergency Alert Critical Error Warning Notice Informational Debug
Description This level designates system as unusable. This level indicates that immediate action is needed. Cisco Unified CallManager detects a critical condition. This level signifies an error condition exists. This level indicates that a warning condition is detected. This level designates normal but significant condition. This level designates information messages only. This level designates detailed event information used for debugging by Cisco TAC engineers.
Related Topics

Configuring or Updating an Alarm for a Service, page 2-2 Applying an Alarm Configuration to All Nodes in a Cluster, page 2-4 Alarm Destination Settings, page 2-6
2-7
Chapter 2 Alarm Event Level Settings
Alarm Configuration
2-8
OL-10643-01
C H A P T E R
Alarm Definitions
This chapter provides procedural information to search, view, and create user information for the Serviceability Alarm Definitions. This chapter contains the following topics:

Searching for and Viewing an Alarm Definition, page 3-2 Creating User-Defined Description in the Alarm Definition, page 3-3 Alarm Definition Catalog Descriptions, page 3-4
Alarm definitions describe alarm messages: what they mean and how to recover from them. You search the Alarm definitions database for alarm information. When you click on any service-specific alarm, a description of the alarm information and a recommended action display. Cisco Unified CallManager stores alarm definitions and recommended actions in a standard query language (SQL) server database. The system administrator can search the database for definitions of all the alarms. The definitions include the alarm name, description, explanation, recommended action, severity, parameters, and monitors. This information aids the administrator in process of troubleshooting problems that Cisco Unified CallManager encounters.
3-1
Chapter 3 Searching for and Viewing an Alarm Definition
Alarm Definitions
Searching for and Viewing an Alarm Definition

This section describes how to search for and view an alarm definition.
Procedure
Step 1
From Cisco Unified CallManager Administration, choose Application > Cisco Unified CallManager Serviceability. The Cisco Unified CallManager Serviceability window displays.
Choose Alarm > Definitions. From the Equals field, choose a catalog of alarm definitions or enter the alarm name in the Enter Alarm Name field. See Table 3-1. Click the Find button. The definitions list displays for the alarm catalog that you chose.
Note
Multiple pages of alarm definitions may exist. To choose another page, click the Next or Last button at the bottom of the Alarm Message Definitions window.
Step 5
In the list, click the hyperlink alarm definition for which you want alarm details. The Alarm Details window displays. To add text to the alarm definition User Defined Text box, see the Creating User-Defined Description in the Alarm Definition section on page 3-3. To return to the Alarm Message Definitions window, click Back to Find/List Alarms.
Step 6 Step 7
Related Topics

Creating User-Defined Description in the Alarm Definition, page 3-3 Alarm Definition Catalog Descriptions, page 3-4
3-2
OL-10643-01
Chapter 3
Alarm Definitions Creating User-Defined Description in the Alarm Definition
Creating User-Defined Description in the Alarm Definition

This section describes how to create user information for Cisco Unified CallManager alarms. The information that you create provides an addition to the definition that Cisco Unified CallManager provides.
Procedure
Step 1
Choose Alarm > Definitions. From the Equals field, choose a catalog of alarm definitions or enter the alarm name in the Enter Alarm Name field. See Table 3-1. Click the Find button. The definitions list displays for the alarm catalog that you chose.
Note
Multiple pages of alarm definitions may exist. To choose another page, click the Next or Last button at the bottom of the Alarm Message Definitions window.
Step 5
In the list, click the hyperlink alarm definition for which you want alarm details. The Alarm Details window displays.
In the User Defined Text box, use freestyle mode to enter the text for the definition. To save your changes, click the Update button. To return to the Alarm Message Definitions window, click Back to Find/List Alarms.
3-3
Chapter 3 Alarm Definition Catalog Descriptions
Alarm Definitions
Related Topics

Searching for and Viewing an Alarm Definition, page 3-2 Alarm Definition Catalog Descriptions, page 3-4
Alarm Definition Catalog Descriptions

Table 3-1 contains the alarm definition catalog descriptions.
Table 3-1 Alarm Definition Catalogs
Name CallManager CEFAlarmCatalog CMIAlarmCatalog CtiManagerAlarmCatalog DBAlarmCatalog GenericAlarmCatalog IpVmsAlarmCatalog JavaApplications
Description All Cisco Unified CallManager alarm definitions All Cisco Extended Functions alarm definitions All Cisco messaging interface alarm definitions All Cisco computer telephony integration (CTI) manager alarm definitions All Cisco database (Aupair) alarm definitions All generic alarm definitions that all applications share All IP voice media streaming applications alarm definitions All Cisco Unified CallManager Java Applications alarm definitions
Note
You cannot configure JavaApplications alarms by using the alarm configuration web pages. You generally configure these alarms to go to the Event Logs and to generate SNMP traps to integrate with CiscoWorks2000. Use the registry editor that is provided with your operating system to view or change alarm definitions and parameters.
3-4
OL-10643-01
Chapter 3
Alarm Definitions Alarm Definition Catalog Descriptions
Table 3-1
Alarm Definition Catalogs (continued)
Name MLAAlarmCatalog
Description MLA alarm definitions

Note
You cannot configure MLA alarms by using the alarm configuration web pages. By default, MLA alarms route to the Sys Log, Event Log, and Data Collector. Use the registry editor that is provided with your operating system to view or change alarm definitions and parameters.
TCDSRVAlarm Catalog TFTPAlarmCatalog

Related Topics

All Cisco telephony call dispatcher service alarm definitions All Cisco TFTP alarm definitions
Searching for and Viewing an Alarm Definition, page 3-2 Creating User-Defined Description in the Alarm Definition, page 3-3
3-5
Chapter 3 Alarm Definition Catalog Descriptions
Alarm Definitions
3-6
OL-10643-01
C H A P T E R
Alarm Information
This chapter provides information on viewing Serviceability Alarms and contains the following topics:

Viewing Alarm Information in Text Format, page 4-2 Viewing Alarm Information in XML Format, page 4-2
You view alarm information to determine whether Cisco Unified CallManager problems exist. Use the Event Viewer program to view alarm information that is sent to the Event Log. You can view alarm information sent to the SDI or SDL trace log file in text or XML format. Use Trace to view the SDI or SDL log files in XML format or use a text editor to view the SDI or SDL log files in text format. (Trace supports text format as well.) Use CiscoWorks2000 report viewer to view Syslog messages. Microsoft Windows 2000 documentation provides detailed information about Event Viewer and Microsoft text editors.
4-1
Chapter 4 Viewing Alarm Information in Text Format
Alarm Information
Viewing Alarm Information in Text Format

This section describes the procedure to view alarm information sent to the Microsoft Windows 2000 Event Log.
Procedure
Step 1
From the Microsoft Windows menu, choose Start > Programs > Administrative Tools > Event Viewer. The Event Viewer window displays.
Step 2
Choose Application Log. The application log containing Cisco Unified CallManager alarms displays.
Step 3
Double-click the alarm that you want to view. The Event Properties window displays. For more information about the alarm, use Alarm Definitions.
Step 4
Related Topics

Viewing Alarm Information in XML Format, page 4-2 Alarm Configuration, page 2-1 Alarm Definitions, page 3-1
Viewing Alarm Information in XML Format

This section describes the procedure to view alarm information in XML format.
Procedure
Step 1
From the Cisco Unified CallManager Administration window, choose Application > Cisco Unified CallManager Serviceability. The Cisco Unified CallManager Serviceability window displays.
Step 2
Choose Trace > Collect.
4-2
OL-10643-01
Chapter 4
Alarm Information Viewing Alarm Information in XML Format
Step 3
For more information about viewing alarm information in XML format, see the Trace Collection Configuration section on page 6-1
Related Topics

Viewing Alarm Information in Text Format, page 4-2 Alarm Configuration, page 2-1 Alarm Definitions, page 3-1 Trace Collection Configuration, page 6-1
4-3
Chapter 4 Viewing Alarm Information in XML Format
Alarm Information
4-4
OL-10643-01
A R T
Trace Tools
C H A P T E R
Trace Configuration
This chapter provides procedural information on using the Trace Configuration tool to configure trace parameters for Cisco Unified CallManager services. This chapter contains the following topics:

Configuring Cisco CallManager Trace Parameters, page 5-3 Configuring Cisco CDR Insert Trace Parameters, page 5-8 Configuring Cisco Certificate Authority Proxy Function Parameters, page 5-10 Configuring Cisco CTIManager Trace Parameters, page 5-12 Configuring Cisco CTL Provider Trace Parameters, page 5-15 Configuring Cisco Database Layer Monitor Trace Parameters, page 5-17 Configuring Cisco Extended Functions Trace Parameters, page 5-20 Configuring Cisco Extension Mobility Trace Parameters, page 5-23 Configuring Cisco IP Manager Assistant Trace Parameters, page 5-25 Configuring Cisco IP Voice Media Streaming Application Trace Parameters, page 5-28 Configuring Cisco Messaging Interface Trace Parameters, page 5-31 Configuring Cisco MOH Audio Translator Trace Parameters, page 5-33 Configuring Cisco RIS Data Collector Trace Parameters, page 5-35 Configuring Cisco Telephony Call Dispatcher Trace Parameters, page 5-39 Configuring Cisco TFTP Trace Parameters, page 5-41
5-1
Chapter 5
Trace Configuration
Configuring Cisco WebDialer Trace Parameters, page 5-44 Debug Trace Level Settings, page 5-46 Configuring Device Name Based Trace Monitoring Trace Parameters, page 5-47 Configuring SDL Trace Parameters, page 5-50 Viewing Trace Log Files, page 5-54 Trace Log File Descriptions and Defaults, page 5-56 Trace Filter Settings, page 5-57 Trace Output Settings, page 5-58 Configuring Servers with Four Disk Drives to Collect Trace Files, page 5-59
Cisco Unified CallManager Serviceability provides a web-based trace tool to assist the system administrator and support personnel in troubleshooting Cisco Unified CallManager problems. Trace provides three main functions:

Configure trace parameters Collect trace files Analyze trace data for troubleshooting problems
The Trace and Alarm tools work together. You configure trace and alarm settings for Cisco Unified CallManager services. A Cisco TAC engineer receives the results. You can direct alarms to the Win2000 Event Viewer, CiscoWorks2000 Syslog, system diagnostic interface (SDI) or signal distribution layer (SDL) trace log files, or to all destinations. You can base traces for services on debug levels, specific trace fields, and Cisco Unified CallManager devices such as phones or gateways. You can perform a trace on the alarms that are sent to the SDI or SDL trace log files. Use the Trace Configuration tool to specify the parameters that you want to trace for troubleshooting Cisco Unified CallManager problems. The Trace Configuration window provides two types of settings: trace filter and trace output. Specify the following trace parameters:

Cisco Unified CallManager server (within the cluster) Service on the server Debug level
5-2
OL-10643-01
Chapter 5
Trace Configuration Configuring Cisco CallManager Trace Parameters
Specific trace fields Output settings
If the service is a call-processing application such as Cisco CallManager or Cisco CTIManager, you can configure a trace on devices such as phones and gateways; for example, you can narrow the trace to all enabled phones with a directory number beginning with 555.
Note
To log alarms in the SDI trace log file, check two check boxes in Trace configuration and one check box in Alarm configuration: the Trace on check box in Trace configuration, the Enable trace file log check box in Trace configuration, and the SDI alarm destination check box in Alarm configuration.
Note
Enabling Trace decreases system performance; therefore, enable Trace only for troubleshooting purposes. For assistance in using Trace, contact Cisco TAC.
Configuring Cisco CallManager Trace Parameters

This section describes how to configure trace parameters for the Cisco CallManager service.
Procedure
Step 1
Step 2 Step 3
Choose Trace > Configuration. From the Servers column, choose the server. The server that you chose displays next to the Current Server title, and a box with configured services displays.
Step 4
From the Configured Services box, choose the Cisco CallManager service.
5-3
Chapter 5 Configuring Cisco CallManager Trace Parameters
Trace Configuration
The service that you chose displays next to the Current Service title, along with the current server that you chose. The trace parameters display for the service that you chose.
Note
Only the trace parameters for the service that you chose display. The display shows all other parameters grayed out.
Check the Trace On check box. If you want trace to apply to all Cisco Unified CallManager servers in the cluster, check the Apply to All Nodes check box. In the Debug Trace Level selection box, click the Down arrow. A list with six debug trace levels displays.
Step 8 Step 9
Click the desired debug trace level as described in Table 5-11. Check the Cisco CallManager Trace Fields check box. Table 5-1 describes the options from which to choose.
Table 5-1 Cisco CallManager Trace Fields
Field Name Enable H245 Message Trace Enable DT-24+/DE-30+ Trace Enable PRI Trace Enable ISDN Translation Trace Enable H225 & Gatekeeper Trace Enable Miscellaneous Trace
Description Activates trace of H245 messages. Activates the logging of ISDN type of DT-24+/DE-30+ device traces. Activates trace of primary rate interface (PRI) devices. Activates ISDN message traces. Used for normal debugging. Activates trace of H.225 devices. Used for normal debugging. Activates trace of miscellaneous devices.
Note
Do not check this check box during normal system operation.
5-4
OL-10643-01
Chapter 5
Table 5-1
Cisco CallManager Trace Fields (continued)
Field Name Enable Conference Bridge Trace Enable Music on Hold Trace
Description Activates trace of conference bridges. Used for normal debugging. Activates trace of music on hold (MOH) devices. Used to trace MOH device status such as registered with Cisco Unified CallManager, unregistered with Cisco Unified CallManager, and resource allocation processed successfully or failed. Activates Cisco Unified CallManager real-time information traces that the real-time information server uses. Activates trace of SIP Stack. Activates trace for the Annunciator, a SCCP device that uses the Cisco IP Voice Media Streaming Application service to enable Cisco Unified CallManager to play pre-recorded announcements (.wav files) and tones to Cisco Unified IP Phones, gateways, and other configurable devices. Activates traces for CDR. Activates trace of all analog trunk (AT) gateways. Activates trace of phone devices. Trace information includes SoftPhone devices. Used for normal debugging. Activates trace of media termination point (MTP) devices. Used for normal debugging. Activates trace of all analog and digital gateways.
Enable CM Real-Time Information Server Trace Enable SIP Stack Trace Enable Annunciator Trace
Enable CDR Trace Enable Analog Trunk Trace Enable All Phone Device Trace
Enable MTP Trace
Enable All Gateway Trace
5-5
Chapter 5 Configuring Cisco CallManager Trace Parameters
Trace Configuration
Table 5-1
Cisco CallManager Trace Fields (continued)
Field Name Enable Forward and Miscellaneous Trace
Description Activates trace for call forwarding and all subsystems that another check box does not cover. Used for normal debugging. Activates trace for media gateway control protocol (MGCP) devices. Used for normal debugging. Activates trace for media resource manager (MRM) activities. Activates trace for SIP call processing. Activates trace for keep alive messages. Used for normal debugging.
Enable MGCP Trace
Enable Media Resource Manager Trace Enable SIP Call Processing Trace Enable Keep Alive Trace
Step 10
If you want trace information for specific Cisco Unified CallManager devices, check the Device Name Based Trace Monitoring check box. See the Configuring Device Name Based Trace Monitoring Trace Parameters section on page 5-47. If you want trace to apply to non-devices in addition to devices, check the Include Non-device Traces check box. If check box is checked, set the appropriate debug trace level as described in Table 5-11.
Step 11
Check the Enable File Trace Log check box to enable the log file to receive trace information. The default log file name and the default parameters display in the fields. If you want to send the trace information to another file, specify the filename and pathname by clicking the File Name field. Change the default parameters by clicking the appropriate field and entering the information.
Note
Trace validates the filename and ensures that the filename has a .txt extension. Do not use a filename that exists on another computer. Use a filename that exists on the computer that is running the trace.
The following default Trace log file name applies for the Cisco Unified CallManager: C:\Program Files\Cisco\Trace\CCM\ccm.txt. See Table 5-16 for the Trace log file default parameters.
5-6
OL-10643-01
Chapter 5
Step 12
If you want the trace information to be available for Trace Analysis, check the Enable XML Formatted Output check box. If this check box is not checked, the log file compiles in text format, and it will not be available for Trace Analysis. If you are a Cisco engineer debugging the system, check the Enable Debug Output String check box; otherwise, continue with the following steps. To save your trace parameters configuration, click the Update button. The changes to trace configuration take effect immediately for Cisco Unified CallManager.
Step 13 Step 14
Note
To set the default, click the SetDefault button. To apply the current settings for chosen services to all nodes in a cluster, check the Apply to all Nodes check box.
Related Topics

Debug Trace Level Settings, page 5-46 Trace Analysis Configuration, page 7-1 Viewing Trace Log Files, page 5-54 Configuring Device Name Based Trace Monitoring Trace Parameters, page 5-47 Trace Log File Descriptions and Defaults, page 5-56 Trace Filter Settings, page 5-57 Trace Output Settings, page 5-58 Alarm Configuration, page 2-1 Trace Collection Configuration, page 6-1 Trace Analysis Configuration, page 7-1 Bulk Trace Analysis, page 24-1
5-7
Chapter 5 Configuring Cisco CDR Insert Trace Parameters
Trace Configuration
Configuring Cisco CDR Insert Trace Parameters

This section describes how to configure trace parameters for the Cisco CDR Insert service.
Procedure
Step 1
Step 2 Step 3
Step 4
From the Configured Services box, choose the Cisco CDR Insert service. The service that you chose displays next to the Current Service title, along with the current server that you chose. The trace parameters display for the service that you chose.
Note
Check the Trace On check box. If you want trace to apply to all Cisco Unified CallManager servers in the cluster, check the Apply to All Nodes check box. In the Debug Trace Level selection box, click the Down arrow. A list with seven debug trace levels displays. Choose the desired debug trace level as described in Table 5-11. Check the Cisco CDR Insert Trace Fields check box. Check Enable CDR Insert Trace check box.
5-8
OL-10643-01
Chapter 5
Trace Configuration Configuring Cisco CDR Insert Trace Parameters
Step 11
To enable the log file to receive trace information, check the Enable File Trace Log check box. The default log file name and the default parameters display in the fields. If you want to send the trace information to another file, specify the filename and pathname by clicking the File Name field. Change the default parameters by clicking the appropriate field and entering the information.
Note
The following default Trace log file name applies for the Cisco Messaging Interface: C:\Program Files\Cisco\Trace\DBL\InsertCDR.txt. See Table 5-16 for the Trace log file default parameters.
Step 12 Step 13
If you are a Cisco engineer who is debugging the system, check the Enable Debug Output String check box; otherwise, continue with the following steps. To save your trace parameters configuration, click the Update button.
Note
Related Topics

Debug Trace Level Settings, page 5-46 Viewing Trace Log Files, page 5-54 Trace Log File Descriptions and Defaults, page 5-56 Trace Filter Settings, page 5-57 Trace Output Settings, page 5-58
5-9
Chapter 5 Configuring Cisco Certificate Authority Proxy Function Parameters
Trace Configuration
Configuring Cisco Certificate Authority Proxy Function Parameters

This section describes how to configure trace parameters for the Cisco Certificate Authority Proxy Function service.
Procedure
Step 1
Step 2 Step 3
Step 4
From the Configured Services box, choose the Cisco Certificate Authority Proxy Function service. The service that you chose displays next to the Current Service title, along with the current server that you chose. The trace parameters display for the service that you chose.
Note
Check the Trace On check box. If you want trace to apply to all Cisco Unified CallManager servers in the cluster, check the Apply to All Nodes check box. In the Debug Trace Level selection box, click the Down arrow. A list with seven debug trace levels displays.
Step 8 Step 9
Click the desired debug trace level as described in Table 5-11. Check the Cisco Certificate Authority Proxy Function Trace Fields check box.
5-10
OL-10643-01
Chapter 5
Trace Configuration Configuring Cisco Certificate Authority Proxy Function Parameters
Step 10
Note
The following default Trace log file name applies for the Cisco Certificate Authority Proxy Function: C:\Program Files\Cisco\Trace\CAPF\CAPF.txt. See Table 5-16 for the Trace log file default parameters.
Step 11 Step 12
If you are a Cisco engineer who is debugging the system, check the Enable Debug Output String check box; otherwise, continue with the following steps. To save your trace parameters configuration, click the Update button. Cisco Cisco Certificate Authority Proxy Function detects changes to trace settings immediately.
Note
Related Topics

Debug Trace Level Settings, page 5-46 Configuring Device Name Based Trace Monitoring Trace Parameters, page 5-47 Trace Analysis Configuration, page 7-1 Viewing Trace Log Files, page 5-54 Trace Log File Descriptions and Defaults, page 5-56 Trace Filter Settings, page 5-57
OL-10643-01
5-11
Chapter 5 Configuring Cisco CTIManager Trace Parameters
Trace Configuration
Trace Output Settings, page 5-58 Alarm Configuration, page 2-1 Trace Collection Configuration, page 6-1 Trace Analysis Configuration, page 7-1 Bulk Trace Analysis, page 24-1
Configuring Cisco CTIManager Trace Parameters

This section describes how to configure trace parameters for the Cisco CTIManager service.
Procedure
Step 1
Step 2 Step 3
Step 4
From the Configured Services box, choose the Cisco CTIManager service. The service that you chose displays next to the Current Service title, along with the current server that you chose. The trace parameters display for the service that you chose.
Note
Step 5 Step 6
Check the Trace On check box. If you want trace to apply to all Cisco Unified CallManager servers in the cluster, check the Apply to All Nodes check box.
5-12
OL-10643-01
Chapter 5
Trace Configuration Configuring Cisco CTIManager Trace Parameters
Step 7
In the Debug Trace Level selection box, click the Down arrow. A list with seven debug trace levels displays.
Step 8 Step 9 Step 10 Step 11
Click the desired debug trace level as described in Table 5-11. Check the Cisco CTIManager Trace Fields check box. If you want all Cisco CTIManager trace parameters, check the Enable All Trace check box. If you want trace information for specific Cisco CTIManager devices, check the Device Name Based Trace Monitoring check box. Refer to the Configuring Device Name Based Trace Monitoring Trace Parameters section on page 5-47. If you want trace to apply to non-devices in addition to devices, check the Include Non-device Traces check box. If check box is checked, set the appropriate debug trace level as described in Table 5-11.
Step 12
Note
The following default Trace log file name applies for the Cisco CTIManager: C:\Program Files\Cisco\Trace\CTI\cti.txt. See Table 5-16 for the Trace log file default parameters.
Step 13
If you want the trace information to be available for Trace Analysis, check the Enable XML Formatted Output check box. If this check box is not checked, the log file compiles in text format, and it will not be available for Trace Analysis. If you are a Cisco engineer who is debugging the system, check the Enable Debug Output String check box; otherwise, continue with the following steps.
Step 14
5-13
Chapter 5 Configuring Cisco CTIManager Trace Parameters
Trace Configuration
Step 15
To save your trace parameters configuration, click the Update button. Cisco CTIManager detects changes to trace settings immediately.
Note
Related Topics

Debug Trace Level Settings, page 5-46 Configuring Device Name Based Trace Monitoring Trace Parameters, page 5-47 Trace Analysis Configuration, page 7-1 Viewing Trace Log Files, page 5-54 Trace Log File Descriptions and Defaults, page 5-56 Trace Filter Settings, page 5-57 Trace Output Settings, page 5-58 Alarm Configuration, page 2-1 Trace Collection Configuration, page 6-1 Trace Analysis Configuration, page 7-1 Bulk Trace Analysis, page 24-1
5-14
OL-10643-01
Chapter 5
Trace Configuration Configuring Cisco CTL Provider Trace Parameters
Configuring Cisco CTL Provider Trace Parameters

This section describes how to configure trace parameters for the Cisco CTL Provider service.
Procedure
Step 1
Step 2 Step 3
Step 4
From the Configured Services box, choose the Cisco CTL Provider service. The service that you chose displays next to the Current Service title, along with the current server that you chose. The trace parameters display for the service that you chose.
Note
Step 5 Step 6
Check the Trace On check box. In the Debug Trace Level selection box, click the Down arrow. A list with seven debug trace levels displays. Click the desired debug trace level as described in Table 5-11. Check the Cisco CTL Provider Trace Fields check box. Check the Enable CTL Provider Service Trace check box.
5-15
Chapter 5 Configuring Cisco CTL Provider Trace Parameters
Trace Configuration
Step 10
Note
The following default Trace log file name applies for the Cisco Database Layer Monitor: C:\Program Files\Cisco\Trace\CTLProvider\CTLProvider.txt. See Table 5-16 for the Trace log file default parameters.
Step 11 Step 12
If you are a Cisco engineer who is debugging the system, check the Enable Debug Output String check box; otherwise, continue with the following steps. To save your trace parameters configuration, click the Update button. The changes to trace configuration take effect immediately for Cisco CTL Provider.
Note
Related Topics

Debug Trace Level Settings, page 5-46 Viewing Trace Log Files, page 5-54 Trace Log File Descriptions and Defaults, page 5-56 Trace Filter Settings, page 5-57 Trace Output Settings, page 5-58 Alarm Configuration, page 2-1
5-16
OL-10643-01
Chapter 5
Trace Configuration Configuring Cisco Database Layer Monitor Trace Parameters
Configuring Cisco Database Layer Monitor Trace Parameters

This section describes how to configure trace parameters for the Cisco Database Layer Monitor service.
Procedure
Step 1
Step 2 Step 3
Step 4
From the Configured Services box, choose the Cisco Database Layer Monitor service. The service that you chose displays next to the Current Service title, along with the current server that you chose. The trace parameters display for the service that you chose.
Note
Check the Trace On check box. If you want trace to apply to all Cisco Unified CallManager servers in the cluster, check the Apply to All Nodes check box. In the Debug Trace Level selection box, click the Down arrow. A list of debug trace levels displays.
Note
The default debug trace level for Cisco Database Layer Monitor specifies Detailed.
5-17
Chapter 5 Configuring Cisco Database Layer Monitor Trace Parameters
Trace Configuration
Step 8 Step 9
Click the desired debug trace level as described in Table 5-11. Check the Cisco Database Layer Monitor Trace Fields check box. Table 5-2 describes the options from which to choose.
Table 5-2 Database Layer Monitor Trace Fields
Field Name Enable Detailed DB Trace Enable DBLX Trace
Description Activates traces for lowest level of layer (SQL statements). Activates trace for ActiveX interface to database layer. Traces go to DBLX.txt file. Activates trace for lightweight directory access protocol (LDAP) interface to database layer. Do not check this check box. Cisco engineering uses it for debugging purposes. Activates trace to monitor communication between Cisco Unified CallManager and database layer. Activates traces for business rules and transactions. Traces go to DBLR.txt and DBLRt.txt files.
Enable LDAP Trace
Enable Unit Test Trace
Enable CCM Change Notification Trace Enable Business Rules Trace
Enable DB Change Notification Trace Activates the database change notification traces. Enable All DB Trace Activates traces for all application programs that use the database. You must restart all applications that use this database before the tracing begins. Traces go to DBL.txt file. Activates trace to monitor communication between all services, except Cisco CallManager, and database layer.
Enable Change Notification Service Trace
5-18
OL-10643-01
Chapter 5
Trace Configuration Configuring Cisco Database Layer Monitor Trace Parameters
Step 10
Note
The following default Trace log file name applies for the Cisco Database Layer Monitor: C:\Program Files\Cisco\Trace\DBL\Aupair.txt. See Table 5-16 for the Trace log file default parameters.
Step 11 Step 12
If you are a Cisco engineer who is debugging the system, check the Enable Debug Output String check box; otherwise, continue with the following steps. To save your trace parameters configuration, click the Update button. The changes to trace configuration take effect immediately for Cisco Database Layer Monitor.
Note
Related Topics

5-19
Chapter 5 Configuring Cisco Extended Functions Trace Parameters
Trace Configuration
Configuring Cisco Extended Functions Trace Parameters

This section describes how to configure trace parameters for the Cisco Extended Functions service.
Procedure
Step 1
Step 2 Step 3
Step 4
From the Configured Services box, choose the Cisco Extended Functions service. The service that you chose displays next to the Current Service title, along with the current server that you chose. The trace parameters display for the service that you chose.
Note
Step 8
Click the desired debug trace level as described in Table 5-11.
Note
The default debug trace level specifies Error.
5-20
OL-10643-01
Chapter 5
Trace Configuration Configuring Cisco Extended Functions Trace Parameters
Step 9
Check the Cisco Extended Functions Trace Fields check box. Table 5-3 describes the options from which to choose.
Table 5-3 Cisco Extended Functions Trace Fields
Field Name Enable QBE Helper TSP Trace Enable QBE Helper TSPI Trace Enable QRT Dictionary Trace Enable Template Map Traces Enable QBE Helper CTI Trace Enable QRT Event Handler Trace Enable QRT Report Handler Trace Enable QRT Service Trace Enable QRT DB Traces Enable DOM Helper Traces Enable Redundancy and Change Notification Trace
Description Activates Telephony service provider trace. Activates QBE Helper TSP Interface trace. Activates Quality Report Tool Service Dictionary trace. Activates Standard template map and multimap trace. Activates QBE Helper CTI interface trace. Activates Quality Report Tool Event Handler trace. Activates Quality Report Tool Report Handler trace. Activates Quality Report Tool Report related trace. Activates DB access trace. Activates DOM Helper trace. Activates Database Change Notification trace.
5-21
Chapter 5 Configuring Cisco Extended Functions Trace Parameters
Trace Configuration
Step 10
Check the Enable File Trace Log check box to enable the log file to receive trace information. The default log file name and the default parameters display in the fields. If you want to send the trace information to another file, specify the filename and pathname by clicking the File Name field. Change the default parameters by clicking the appropriate field and entering the information.
Note
The following default Trace log file name applies for Cisco Extended Functions: C:\Program Files\Cisco\Trace\CEF\cef.txt. See Table 5-16 for the Trace log file default parameters.
Step 11
If you want the trace information to be available for Trace Analysis, check the Enable XML Formatted Output check box. If this check box is not checked, the log file compiles in text format, and it will not be available for Trace Analysis. If you are a Cisco engineer who is debugging the system, check the Enable Debug Output String check box. To save your trace parameters configuration, click the Update button. The changes to trace configuration take effect immediately for Cisco Extended Functions.
Step 12 Step 13
Note
Related Topics

Debug Trace Level Settings, page 5-46 Viewing Trace Log Files, page 5-54 Configuring Device Name Based Trace Monitoring Trace Parameters, page 5-47
5-22
OL-10643-01
Chapter 5
Trace Configuration Configuring Cisco Extension Mobility Trace Parameters
Trace Log File Descriptions and Defaults, page 5-56 Trace Filter Settings, page 5-57 Trace Output Settings, page 5-58 Alarm Configuration, page 2-1
Configuring Cisco Extension Mobility Trace Parameters

This section describes how to configure trace parameters for the Cisco Extension Mobility service.
Procedure
Step 1
Step 2 Step 3
Step 4
From the Configured Services box, choose the Cisco Extension Mobility service. The service that you chose displays next to the Current Service title, along with the current server that you chose. The trace parameters display for the service that you chose.
Note
Step 5 Step 6
5-23
Chapter 5 Configuring Cisco Extension Mobility Trace Parameters
Trace Configuration
Step 7
In the Debug Trace Level selection box, click the Down arrow. A list of debug trace levels displays.
Step 8 Step 9
Click the desired debug trace level as described in Table 5-11. Check the Cisco Extension Mobility Trace Fields check box. Table 5-4 describes the options from which to choose.
Table 5-4 Cisco Extension Mobility Trace Fields
Field Name Enable EM Service Trace Enable EM Application Trace
Description Activates trace for the Extension Mobility service. Activates application trace for the Extension Mobility service.
Step 10
Note
The following default Trace log file name applies for the Cisco Database Layer Monitor: C:\Program Files\Cisco\Trace\EM\EMSvc.txt. See Table 5-16 for the Trace log file default parameters.
Step 11
If you are a Cisco engineer who is debugging the system, check the Enable Debug Output String check box; otherwise, continue with the following steps.
5-24
OL-10643-01
Chapter 5
Trace Configuration Configuring Cisco IP Manager Assistant Trace Parameters
Step 12
To save your trace parameters configuration, click the Update button. The changes to trace configuration take effect immediately for Cisco Extension Mobility.
Note
Related Topics

Configuring Cisco IP Manager Assistant Trace Parameters

This section describes how to configure trace parameters for the Cisco IP Manager Assistant service, which supports Cisco Unified CallManager Assistant.
Procedure
Step 1
Step 2 Step 3
Choose Trace > Configuration. From the Servers column, choose the server.
5-25
Chapter 5 Configuring Cisco IP Manager Assistant Trace Parameters
Trace Configuration
The server that you chose displays next to the Current Server title, and a box with configured services displays.
Step 4
From the Configured Services box, choose the Cisco IP Manager Assistant service. The service that you chose displays next to the Current Service title, along with the current server that you chose. The trace parameters display for the service that you chose.
Note
Check the Trace On check box. If you want trace to apply to all Cisco Unified CallManager servers in the cluster, check the Apply to All Nodes check box. In the Debug Trace Level selection box, click the Down arrow. A list of debug trace levels displays. Click the desired debug trace level as described in Table 5-11. Check the Cisco IP Manager Assistant Trace Fields check box. Table 5-5 describes the options from which to choose.
Table 5-5 Cisco Unified CallManager Assistant Trace Fields
Step 8 Step 9
Field Name Enable IPMA Service Trace Enable IPMA Manager Configuration Change Log Enable IPMA CTI Trace
Description Activates trace for the Cisco IP Manager Assistant service. Activates configuration change logs for Cisco IP Manager Assistant service. Activates CTI trace for Cisco Unified CallManager Assistant.
5-26
OL-10643-01
Chapter 5
Trace Configuration Configuring Cisco IP Manager Assistant Trace Parameters
Step 10
Note
The following default Trace log file name applies for the Cisco Database Layer Monitor: C:\Program Files\Cisco\Trace\IPMA\IPMA.txt. See Table 5-16 for the Trace log file default parameters.
Step 11 Step 12
If you are a Cisco engineer who is debugging the system, check the Enable Debug Output String check box; otherwise, continue with the following steps. To save your trace parameters configuration, click the Update button. The changes to trace configuration take effect immediately for Cisco Unified CallManager Assistant.
Note
Related Topics

5-27
Chapter 5 Configuring Cisco IP Voice Media Streaming Application Trace Parameters
Trace Configuration
Configuring Cisco IP Voice Media Streaming Application Trace Parameters

This section describes how to configure trace parameters for the Cisco IP Voice Media Streaming Application service.
Procedure
Step 1
Step 2 Step 3
Choose Trace > Configuration. From the Servers column, choose the server. The server that you chose displays next to the Current Servers title, and a box with configured services displays.
Step 4
From the Configured Services box, choose the Cisco IP Voice Media Streaming App service. The service that you chose displays next to the Current Service title, along with the current server that you chose. The trace parameters display for the service that you chose.
Note
Step 8
Click the desired debug trace level as described in Table 5-11.
5-28
OL-10643-01
Chapter 5
Trace Configuration Configuring Cisco IP Voice Media Streaming Application Trace Parameters
Step 9
Check the Cisco IP Voice Media Streaming App Trace Fields check box. Table 5-6 describes the options from which to choose.
Table 5-6 IP Voice Media Streaming Application Trace Fields
Field Name Enable Service Initialization Trace Enable MTP Device Trace
Description Activates trace for initialization information. Activates traces to monitor the processed messages for media termination point (MTP). Activates traces for device-recovery-related information for MTP, conference bridge, and MOH.
Enable Device Recovery Trace
Enable Skinny Station Messages Trace Activates traces for skinny station protocol. Enable WinSock Level 2 Trace Activates trace for high-level, detailed WinSock-related information.
Enable Music On Hold Manager Trace Activates trace to monitor MOH audio source manager. Enable DB Setup Manager Trace Activates trace to monitor database setup and changes for MTP, conference bridge, and MOH. Activates traces to monitor the processed messages for conference bridge. Activates device driver traces. Activates trace for low-level, general, WinSock-related information. Activates traces to monitor the processed messages for MOH. Activates trace to monitor the download of MOH audio source files. Activates trace to monitor annunciator.
Enable Conference Bridge Device Trace Enable Device Driver Trace Enable WinSock Level 1 Trace Enable Music on Hold Device Trace Enable TFTP Downloads Trace Enable Annunciator Trace
5-29
Chapter 5 Configuring Cisco IP Voice Media Streaming Application Trace Parameters
Trace Configuration
Step 10
Note
The following default Trace log file name applies for the Cisco IP Voice Media Streaming Application: C:\Program Files\Cisco\Trace\CMS\cms.txt. See Table 5-16 for the Trace log file default parameters.
Step 11 Step 12
If you are a Cisco engineer who is debugging the system, check the Enable Debug Output String check box; otherwise, continue with the following steps. To save your trace parameters configuration, click the Update button. The changes to trace configuration take effect immediately for Cisco IP Voice Media Streaming Application.
Note
Related Topics

5-30
OL-10643-01
Chapter 5
Trace Configuration Configuring Cisco Messaging Interface Trace Parameters
Configuring Cisco Messaging Interface Trace Parameters

This section describes how to configure trace parameters for the Cisco Messaging Interface service.
Procedure
Step 1
Step 2 Step 3
Step 4
From the Configured Services box, choose the Cisco Messaging Interface service. The service that you chose displays next to the Current Service title, along with the current server that you chose. The trace parameters display for the service that you chose.
Note
Note
The default debug trace level for Cisco Messaging Interface specifies Error.
5-31
Chapter 5 Configuring Cisco Messaging Interface Trace Parameters
Trace Configuration
Choose the desired debug trace level as described in Table 5-11. Check the Cisco Messaging Interface check box. Check Enable All Trace check box. To enable the log file to receive trace information, check the Enable File Trace Log check box. The default log file name and the default parameters display in the fields. If you want to send the trace information to another file, specify the filename and pathname by clicking the File Name field. Change the default parameters by clicking the appropriate field and entering the information.
Note
The following default Trace log file name applies for the Cisco Messaging Interface: C:\Program Files\Cisco\Trace\CMI\csumi.txt. See Table 5-16 for the Trace log file default parameters.
Step 12 Step 13
If you are a Cisco engineer who is debugging the system, check the Enable Debug Output String check box; otherwise, continue with the following steps. To save your trace parameters configuration, click the Update button. The changes to trace configuration take effect in 3 to 5 minutes for Cisco Messaging Interface.
Note
Related Topics

Debug Trace Level Settings, page 5-46 Viewing Trace Log Files, page 5-54 Trace Log File Descriptions and Defaults, page 5-56
5-32
OL-10643-01
Chapter 5
Trace Configuration Configuring Cisco MOH Audio Translator Trace Parameters
Trace Filter Settings, page 5-57 Trace Output Settings, page 5-58 Alarm Configuration, page 2-1
Configuring Cisco MOH Audio Translator Trace Parameters

This section describes how to configure trace parameters for the Cisco MOH Audio Translator service.
Procedure
Step 1
Step 2 Step 3
Choose Trace > Configuration. From the Servers column, choose the server. The server that you chose displays next to Current Server title, and a box with configured services displays.
Step 4
From the Configured Services box, choose the Cisco MOH Audio Translator service. The service that you chose displays next to the Current Service title, along with the current server that you chose. The trace parameters display for the service that you chose.
Note
Step 5 Step 6
5-33
Chapter 5 Configuring Cisco MOH Audio Translator Trace Parameters
Trace Configuration
Step 7
In the Debug Trace Level selection box, click the Down arrow. A list of debug trace levels displays.
Note
The default debug trace level for Cisco MOH Audio Translator specifies Error.
Click the desired debug trace level as described in Table 5-11. Check the Cisco MOH Audio Translator Trace Fields check box. If you want all MOH Audio Translator trace parameters, check the Enable All Trace check box. To enable the log file to receive trace information, check the Enable File Trace Log check box. The default log file name and the default parameters display in the fields. If you want to send the trace information to another file, specify the filename and pathname by clicking the File Name field. Change the default parameters by clicking the appropriate field and entering the information.
Note
The following default Trace log file name applies for the Cisco MOH Audio Translator: C:\Program Files\Cisco\Trace\CMS\at.txt. See Table 5-16 for the Trace log file default parameters.
Step 12
5-34
OL-10643-01
Chapter 5
Trace Configuration Configuring Cisco RIS Data Collector Trace Parameters
Step 13
To save your trace parameters configuration, click the Update button. The changes to trace configuration take effect within 1 minute for Cisco MOH Audio Translator.
Note
Related Topics

Configuring Cisco RIS Data Collector Trace Parameters

This section describes how to configure trace parameters for the Cisco RIS Data Collector service.
Procedure
Step 1
Step 2
Choose Trace > Configuration.
5-35
Chapter 5 Configuring Cisco RIS Data Collector Trace Parameters
Trace Configuration
Step 3
From the Servers column, choose the server. The server that you chose displays next to the Current Server title, and a box with configured services displays.
Step 4
From the Configured Services box, choose the Cisco RIS Data Collector service. The service that you chose displays next to the Current Service title, along with the current server that you chose. The trace parameters display for the service that you chose.
Note
Step 8 Step 9
Click the desired debug trace level as described in Table 5-11. Check the Cisco RIS Data Collector Trace Fields check box. Table 5-7 describes the options from which to choose.
Table 5-7 RIS Data Collector Trace Fields
Field Name Enable RISDC Trace
Description Activates trace for the RISDC thread of the real-time information server (RIS) data collector. Activates trace for the Link Services library in both the RIS data collector and its RISX client. Activates trace for the RISDB library in the RIS data collector. Activates trace for the SNMPDC thread of the RIS data collector.
Enable Link Services Trace
Enable RISDB Trace Enable SNMPDC Trace
5-36
OL-10643-01
Chapter 5
Trace Configuration Configuring Cisco RIS Data Collector Trace Parameters
Table 5-7
RIS Data Collector Trace Fields (continued)
Field Name Enable RISX Trace Enable RISDC Access Trace Enable Real-Time Monitoring Tool Trace Enable CCM SNMP Agent Trace
Description Activates trace for the RISX client to the RIS data collector. Activates trace for the RISDC access library in the RIS data collector. Activates trace for the Real-Time Monitoring Tool ISAPI client to the RIS data collector. Activates trace for the CCM SNMP agent.
Enable AXL-Serviceability API Trace Activates SOAP trace for AXL-Serviceability API in the RISDC service.
Step 10
Note
The following default Trace log file name applies for the Cisco RIS Data Collector: C:\Program Files\Cisco\Trace\RIS\ris.txt. See Table 5-16 for the Trace log file default parameters.
Step 11
5-37
Chapter 5 Configuring Cisco RIS Data Collector Trace Parameters
Trace Configuration
Step 12
To save your trace parameters configuration, click the Update button. The changes that were made to trace configuration take effect immediately; however, trace configuration changes affect two Cisco RIS Data Collector dynamic link libraries (DLL) (RISX.dll and ASTIsapi.dll). These DLLs belong to the Internet Information Services (IIS) processes, which means that trace configuration changes require a restart of the IIS process. Refer to Microsoft Windows documentation for IIS starting and stopping procedures.
Note
Restarting the IIS process stops and restarts all Internet services, including the web server that Cisco Unified CallManager Administration uses, and the Real-Time Monitoring Tool. These programs will be unavailable while IIS is being restarted. You must close and reopen any existing AST browser windows after IIS restarts.
Note
Related Topics

5-38
OL-10643-01
Chapter 5
Trace Configuration Configuring Cisco Telephony Call Dispatcher Trace Parameters
Configuring Cisco Telephony Call Dispatcher Trace Parameters

This section describes how to configure trace parameters for the Cisco Telephony Call Dispatcher service.
Procedure
Step 1
Step 2 Step 3
Step 4
From the Configured Services box, choose the Cisco Telephony Call Dispatcher service. The service that you chose displays next to the Current Service title, along with the current server that you chose. The trace parameters display for the service that you chose.
Note
Check the Trace On check box. If you want trace to apply to all Cisco Unified CallManager servers in the cluster, check the Apply to All Nodes check box. In the Debug Trace Level selection box, click the Down arrow. A list with debug trace levels displays.
Step 8 Step 9
Click the desired debug trace level settings as described in Table 5-11. Check the Cisco Telephony Call Dispatcher Trace Fields check box.
5-39
Chapter 5 Configuring Cisco Telephony Call Dispatcher Trace Parameters
Trace Configuration
Step 10
Check the Enable low level trace check box or the Enable high level trace check box, or both. Table 5-8 describes the options from which to choose.
Table 5-8 Telephony Call Dispatcher Trace Fields
Field Name Enable low level trace Enable high level trace
Step 11
Description Activates low-level trace. Activates high-level trace.
Note
The following default Trace log file name applies for the Cisco Telephony Call Dispatcher: C:\Program Files\Cisco\Trace\TCD\tcdsrv.txt. See Table 5-16 for the Trace log file default parameters.
Step 12 Step 13
If you are a Cisco engineer who is debugging the system, check the Enable Debug Output String check box; otherwise, continue with the following steps. To save your trace parameters configuration, click the Update button.
Note
5-40
OL-10643-01
Chapter 5
Trace Configuration Configuring Cisco TFTP Trace Parameters
Related Topics

Configuring Cisco TFTP Trace Parameters

This section describes how to configure trace parameters for the Cisco TFTP service.
Procedure
Step 1
Step 2 Step 3
Step 4
From the Configured Services box, choose the Cisco TFTP service. The service that you chose displays next to the Current Service title, along with the current server that you chose. The trace parameters display for the service that you chose.
Note
Step 5
Check the Trace On check box.
5-41
Chapter 5 Configuring Cisco TFTP Trace Parameters
Trace Configuration
Step 6 Step 7
If you want trace to apply to all Cisco Unified CallManager servers in the cluster, check the Apply to All Nodes check box. In the Debug Trace Level selection box, click the Down arrow. A list of debug trace levels displays. Click the desired debug trace level as described in Table 5-11. Check the Cisco tftp Trace Fields check box. Table 5-9 describes the three options from which to choose.
Table 5-9 TFTP Trace Fields
Step 8 Step 9
Field Name Enable Service System Trace Enable Build File Trace Enable Serve File Trace
Step 10
Description Activates trace for service system. Activates trace for build files. Activates trace for serve files.
Note
The following default Trace log file name applies for the Cisco TFTP: C:\Program Files\Cisco\Trace\TFTP\ctftp.txt. See Table 5-16 for the Trace log file default parameters.
Step 11
If you want the trace information to be available for Trace Analysis, check the Enable XML Formatted Output check box. If this check box is not checked, the log file compiles in text format, and it will not be available for Trace Analysis. If you are a Cisco engineer who is debugging the system, check the Enable Debug Output String check box; otherwise, continue with the following steps.
Step 12
5-42
OL-10643-01
Chapter 5
Trace Configuration Configuring Cisco TFTP Trace Parameters
Step 13
To save your trace parameters configuration, click the Update button. The changes to trace configuration take effect immediately for Cisco TFTP.
Note
Related Topics

Debug Trace Level Settings, page 5-46 Viewing Trace Log Files, page 5-54 Trace Log File Descriptions and Defaults, page 5-56 Trace Filter Settings, page 5-57 Trace Output Settings, page 5-58 Alarm Configuration, page 2-1 Trace Collection Configuration, page 6-1 Trace Analysis Configuration, page 7-1 Bulk Trace Analysis, page 24-1
5-43
Chapter 5 Configuring Cisco WebDialer Trace Parameters
Trace Configuration
Configuring Cisco WebDialer Trace Parameters

This section describes how to configure trace parameters for the Cisco WebDialer service.
Procedure
Step 1
Step 2 Step 3
Step 4
From the Configured Services box, choose the Cisco WebDialer service. The service that you chose displays next to the Current Service title, along with the current server that you chose. The trace parameters display for the service that you chose.
Note
Step 5 Step 6
Check the Trace On check box. In the Debug Trace Level selection box, click the Down arrow. A list of debug trace levels displays. Click the desired debug trace level as described in Table 5-11. Check the Cisco WebDialer Trace Fields check box. Table 5-10 describes the options from which to choose.
Step 7 Step 8
5-44
OL-10643-01
Chapter 5
Trace Configuration Configuring Cisco WebDialer Trace Parameters
Table 5-10 Cisco WebDialer Trace Fields
Field Name Enable WebDialer Servlet Trace Enable Redirector Servlet Trace
Description Activates trace for Cisco WebDialer servlet. Activates trace for the Redirector servlet.
Step 9
Note
The following default Trace log file name applies for the Cisco WebDialer: C:\Program Files\Cisco\Trace\Webdialer\webdialer.txt. See Table 5-16 for the Trace log file default parameters.
Step 10 Step 11
If you are a Cisco engineer debugging the system, check the Enable Debug Output String check box; otherwise, continue with the following steps. To save your trace parameters configuration, click the Update button. The changes to trace configuration take effect immediately for Cisco WebDialer.
Note
5-45
Chapter 5 Debug Trace Level Settings
Trace Configuration
Related Topics

Debug Trace Level Settings, page 5-46 Viewing Trace Log Files, page 5-54 Trace Log File Descriptions and Defaults, page 5-56 Trace Filter Settings, page 5-57 Trace Output Settings, page 5-58 Alarm Configuration, page 2-1 Trace Collection Configuration, page 6-1 Trace Analysis Configuration, page 7-1 Bulk Trace Analysis, page 24-1
Debug Trace Level Settings

Table 5-11 describes the debug trace level settings.
Table 5-11 Debug Trace Levels
Level Error
Description Traces alarm conditions and events. Used for all traces that are generated in abnormal path. Uses minimum amount of CPU cycles. Traces all Error conditions plus process and device initialization messages. Traces all Special conditions plus subsystem state transitions that occur during normal operation. Traces callprocessing events. Traces all State Transition conditions plus media layer events that occur during normal operation.
Special State Transition
Significant
5-46
OL-10643-01
Chapter 5
Trace Configuration Configuring Device Name Based Trace Monitoring Trace Parameters
Table 5-11 Debug Trace Levels (continued)
Level Entry/Exit
Description Traces all Significant conditions plus entry and exit points of routines. Not all services use this trace level (for example, Cisco CallManager does not). Traces all Entry/Exit conditions plus low-level debugging information.
Note
Arbitrary
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.
Configuring Device Name Based Trace Monitoring Trace Parameters

Use this Trace Configuration option to narrow the number of trace logs that are generated and reduce the impact on call processing. This option traces only the selected devices. This section describes how to configure device-name-based trace monitoring parameters for the Cisco CallManager and Cisco CTIManager services.
5-47
Chapter 5 Configuring Device Name Based Trace Monitoring Trace Parameters
Trace Configuration
Procedure
Step 1
Step 2 Step 3
Step 4
From the Configured Services box, choose the Cisco CallManager or the Cisco CTIManager service. The service that you chose displays next to the Current Service title, along with the current server that you chose. The trace parameters display for the service that you chose.
Step 5 Step 6
Check the Trace On check box. In the Debug Trace Level selection box, click the Down arrow. A list of debug trace levels displays. Click the desired debug trace level as described in Table 5-11. If you are configuring devices for Cisco Unified CallManager, check the Cisco CallManager Trace Fields check box. If you are configuring devices for Cisco CTIManager, check the Cisco CTIManager Trace Fields check box. See Table 5-1 for Cisco CallManager trace fields information. Check the Device Name Based Trace Monitoring check box. Click the Select Devices button. The Device Selection for Tracing window displays.
Step 7 Step 8
Step 9 Step 10
Tip
Under Cisco Unified CallManager Administration System > Enterprise Parameters, configure the maximum number of devices that are available for tracing. Enter a value in the Max Number of Device Level Trace field. The default specifies 12.
Step 11
Click the Down arrow of the Find box.
5-48
OL-10643-01
Chapter 5
Trace Configuration Configuring Device Name Based Trace Monitoring Trace Parameters
Step 12 Step 13 Step 14 Step 15 Step 16 Step 17 Step 18 Step 19 Step 20
From the following list, choose the device for which you want a trace. Click the Down arrow of the where box. From the following list, choose the type of device information for which you want a trace. Click the Down arrow of the second box. From the following list, choose the search criteria of the device information for which you want a trace. Enter the text search criteria string that corresponds with your choice in the previous step; for example, begins with ABC or ends with 123. Click the Down arrow of the Trace box. From the following list, choose the device Trace status for which you want a trace. Click the Find button. The window with the search results displays. If more pages of search results to view exist, click the First, Previous, Next, or Last button.
Step 21 Step 22 Step 23 Step 24 Step 25
Click the Trace check box for the device or devices for which you want device-name-based trace monitoring. Click the Update button. When the update finishes, click the Close button to close the Device Selection for Tracing window and return to the Trace Configuration window. To update the Trace Configuration parameters for the service that you chose, click the Update button. Continue with the rest of your trace configuration parameter settings as described in the Configuring Cisco CallManager Trace Parameters section on page 5-3, and the Configuring Cisco CTIManager Trace Parameters section on page 5-12.
Related Topics

Configuring Cisco CallManager Trace Parameters, page 5-3 Configuring Cisco CTIManager Trace Parameters, page 5-12 Trace Collection Configuration, page 6-1 Trace Analysis Configuration, page 7-1
OL-10643-01
5-49
Chapter 5 Configuring SDL Trace Parameters
Trace Configuration
Configuring SDL Trace Parameters

This section describes how to configure the SDL trace parameters for the Cisco CallManager and Cisco CTIManager services.
Procedure
Step 1
From the Cisco Unified CallManager or Cisco CTIManager trace configuration window, click the SDL Configuration link. The SDL Trace Configuration window displays. Check the Trace On check box. If you are configuring SDL parameters for the Cisco CallManager service, check the Trace Filter Settings check boxes that you want to apply to this trace as described in Table 5-12. If you are configuring the SDL parameters for the Cisco CTIManager service, check the Trace Filter Settings check boxes that you want to apply to this trace as described in Table 5-13.
Step 2 Step 3
Note
Cisco recommends that you use the defaults unless a Cisco engineer instructs you to do otherwise.
Table 5-12 Cisco Unified CallManager SDL Filter Settings
Setting Name Enable all Layer 1 traces. Enable detailed Layer 1 traces. Enable all Layer 2 traces. Enable Layer 2 interface trace. Enable Layer 2 TCP trace. Enable detailed dump Layer 2 trace. Enable all Layer 3 traces. Enable all call control traces.
Description Activates traces for Layer 1. Activates detailed Layer 1 traces. Activates traces for Layer 2. Activates Layer 2 interface traces. Activates Layer 2 Transmission Control Program (TCP) traces. Activates detailed traces for dump Layer 2. Activates traces for Layer 3. Activates traces for call control.
5-50
OL-10643-01
Chapter 5
Trace Configuration Configuring SDL Trace Parameters
Table 5-12 Cisco Unified CallManager SDL Filter Settings (continued)
Setting Name Enable miscellaneous polls trace. Enable miscellaneous trace (database signals). Enable message translation signals trace. Enable UUIE output trace. Enable gateway signals trace. Enable CTI trace. Enable CDR trace.
Description Activates traces for miscellaneous polls. Activates miscellaneous traces such as database signals. Activates traces for message translation signals. Activates traces for user-to-user informational element (UUIE) output. Activates traces for gateway signals. Activates CTI trace. Activates CDR trace.
Table 5-13 Cisco CTIManager Trace SDL Configuration Filter Settings
Setting Name Enable miscellaneous polls trace. Enable miscellaneous trace (database signals). Enable CTI trace.
Step 4
Description Activates traces for miscellaneous polls. Activates miscellaneous traces such as database signals. Activates CTI trace.
If you are configuring SDL parameters for the Cisco CallManager service, check the Trace Characteristics check boxes that you want to apply to this trace as described in Table 5-14. If you are configuring the SDL parameters for the Cisco CTIManager service, check the Trace Characteristics check boxes that you want to apply to this trace as described in Table 5-15.
5-51
Chapter 5 Configuring SDL Trace Parameters
Trace Configuration
Table 5-14 Cisco CallManager SDL Configuration Characteristics
Characteristics Enable SDL link states trace.
Description Activates trace for intracluster communication protocol (ICCP) link state. Activates trace for low-level SDL. Activates trace for ICCP link poll. Activates trace for ICCP raw messages. Activates traces for signal data dump. Activates traces for correlation tag mapping. Activates traces for SDL process states. Disables trace for pretty print of SDL. Pretty print adds tabs and spaces in a trace file without performing post processing.
Enable low-level SDL trace. Enable SDL link poll trace. Enable SDL link messages trace. Enable signal data dump trace. Enable correlation tag mapping trace. Enable SDL process states trace. Disable pretty print of SDL trace.
Table 5-15 Cisco CTIManager SDL Configuration Characteristics
Characteristics Enable SDL link states trace. Enable low-level SDL trace. Enable SDL link poll trace. Enable SDL link messages trace. Enable signal data dump trace. Enable correlation tag mapping trace.
Description Activates trace for ICCP link state. Activates trace for low-level SDL. Activates trace for ICCP link poll. Activates trace for ICCP raw messages. Activates traces for signal data dump. Activates traces for correlation tag mapping.
5-52
OL-10643-01
Chapter 5
Trace Configuration Configuring SDL Trace Parameters
Table 5-15 Cisco CTIManager SDL Configuration Characteristics (continued)
Characteristics Enable SDL process states trace. Disable pretty print of SDL trace.
Description Activates traces for SDL process states. Disables trace for pretty print of SDL. Pretty print adds tabs and spaces in a trace file without performing post processing.
Step 5
If you want the trace information to be available for Trace Analysis, check the Enable XML Formatted Output check box. If this check box is not checked, the log file compiles in text format, and it will not be available for Trace Analysis. The default trace directory path and the default parameters display in the fields. If you want to send the trace information to another file, enter the filename and pathname in the Trace Directory Path field. Change the default parameters by clicking the appropriate field and entering the information. The following default Trace log file name applies for SDL Trace Configuration: C:\Program Files\Cisco\Trace\SDL. See Table 5-16 for the Trace log file default parameters.
Step 6
To save your SDL trace parameters configuration, click the Update button. The changes to trace configuration take effect immediately for SDL Trace Configuration.
Note
Step 7 Step 8
To continue with SDL Trace Configuration for another service, choose the service from the Configured Services box; otherwise continue with Step 8. To return to the Cisco Unified CallManager or Cisco CTIManager SDI Trace Configuration window, click the SDI Configuration link.
5-53
Chapter 5 Viewing Trace Log Files
Trace Configuration
Related Topics

Trace Log File Descriptions and Defaults, page 5-56 Trace Filter Settings, page 5-57 Trace Output Settings, page 5-58 Trace Collection Configuration, page 6-1 Trace Analysis Configuration, page 7-1
Viewing Trace Log Files

You can view the contents of the SDI or SDL trace log file in text or XML format. Use Trace Analysis to view the log files in XML format (see the Trace Analysis Configuration section on page 7-1) or use a text editor to view the log files in text format. Microsoft Windows 2000 documentation provides detailed information about Microsoft text editors. This section describes how to view the contents of a trace log file in text format.
Procedure
Step 1
From the Microsoft Windows menu, choose Start > Run. The Run window displays.
Step 2 Step 3
In the Open: field text box, enter the log file path name; for example, c:\Program Files\Cisco\Trace. Click the OK button. The Trace folder window displays. The trace directory includes folders for CCM, CMI, CMS, CTI, DBL, RIS, TCD, and TFTP. The trace log files for the services exist in these folders.
Step 4
Double-click the folder that contains the trace log file that you want to view; for example, to view CTIManager log files, double-click the CTI folder.
5-54
OL-10643-01
Chapter 5
Trace Configuration Viewing Trace Log Files
A window with all the trace log files that are contained within the folder displays; for example, cti001.txt, cti002.txt, cti003.txt.
Tip
Hundreds of log files may exist in the folder. To find the most recent log file, sort by date (most recent first).
Step 5
To open the log file and view the contents, use a text editor.
Related Topics

Trace Log File Descriptions and Defaults, page 5-56 Trace Filter Settings, page 5-57 Trace Output Settings, page 5-58 Trace Collection Configuration, page 6-1 Trace Analysis Configuration, page 7-1
5-55
Chapter 5 Trace Log File Descriptions and Defaults
Trace Configuration
Trace Log File Descriptions and Defaults

Table 5-16 contains the trace log file descriptions and defaults.
Table 5-16 Trace Log File Description
Field Maximum number of files
Description This field specifies the total number of trace files for a given service. Cisco Unified CallManager automatically appends a sequence number to the file name to indicate which file it is; for example, ccm299.txt. When the last file in the sequence is full, the trace data begins writing over the first file. The default specifies 250 files. This field specifies the maximum number of lines of data that are stored in each trace file. The default specifies 10000 lines for text files and 2000 for XML files. This field specifies the maximum minutes of data that are stored in each trace file. The default specifies 1440 minutes.
Maximum number of lines
Maximum number of minutes
When the trace data exceeds either the maximum number of lines or the maximum minutes for one file, Cisco Unified CallManager closes that file and writes the remaining trace data 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, set the number of files to 7, the minutes to 1440 (one day), and the number of lines to a large value such as 10000 (or larger for a busy system).
5-56
OL-10643-01
Chapter 5
Trace Configuration Trace Filter Settings
Trace Filter Settings

Use the trace filter settings to set the type of trace that you want (Table 5-17). To access the trace filter settings, click the Trace On check box.
Table 5-17 Trace Configuration Filter Settings
Filter Setting Debug trace level
Description Setting specifies the level of information that you want traced (see Table 5-11). Levels range from error to detailed. Each service provides specific trace fields. The configuration procedure for each service describes the trace fields.
Trace fields
Device Name Based Trace Monitoring Setting applies to Cisco CallManager and Cisco CTIManager services only. This filter setting configures trace for devices such as phones and gateways. See the Configuring Device Name Based Trace Monitoring Trace Parameters section on page 5-47.
5-57
Chapter 5 Trace Output Settings
Trace Configuration
Trace Output Settings

Use the trace output settings to specify the output log file and its format (Table 5-18).
Note
Trace Configuration automatically provides the time and date of the trace.
Table 5-18 Trace Configuration Output Settings
Filter Setting Enable file trace log
Description This setting enables sending the output of the trace to a log file (either the default log file or one that you choose). Each service includes a default log file. This setting formats the output of the trace in XML format. Trace Analysis requires XML format. Cisco CallManager, CTIManager, and Cisco TFTP services support this setting. Cisco engineers use this setting.
Enable XML formatted output
Enable debug output string
5-58
OL-10643-01
Chapter 5
Trace Configuration Configuring Servers with Four Disk Drives to Collect Trace Files
Configuring Servers with Four Disk Drives to Collect Trace Files

To increase system performance, you can configure service parameters and trace output settings, so trace files write to the drive that is labeled Trace instead of to the default C: drive. Using the trace drive allows you to capture more trace files because this drive is set up specifically for trace file collection. Perform the following procedure for all servers in the cluster with four disk drives:
Procedure
Step 1 Step 2
Determine which drive is labeled Trace by double-clicking My Computer. From Cisco Unified CallManager Administration, choose Application > Cisco Unified CallManager Serviceability. The Cisco Unified CallManager Serviceability window displays.
Choose Trace > Configuration. From the Server pane on the left side of the Trace Configuration window, click the server name or IP address of the four-disk drive server. From the Configured Services drop-down list box, click either the Cisco CallManager or CTIManager service.
Note
Depending on which service you chose, repeat this entire procedure for the service you did not choose in Step 5.
The Trace Configuration window for the service and server displays.
Step 6
In the upper, right corner of the window, click the SDL Configuration link. The SDL Configuration window displays. In the Trace Directory Path field under Trace Output Settings, change the default from the C: drive to the drive letter of the trace drive.
Step 7
5-59
Chapter 5 Configuring Servers with Four Disk Drives to Collect Trace Files
Trace Configuration
Step 8 Step 9
Click Update. Repeat this procedure on all four-disk drive servers in the cluster, for both Cisco CallManager and CTIManager services.
5-60
OL-10643-01
C H A P T E R
Trace Collection Configuration

This chapter provides the following procedural information on using the Serviceability Trace Collection Tool:

Loading the Trace Collection Tool, page 6-2 Collecting Traces by Using Trace Collection Tool, page 6-5

The Trace and Alarm tools work together. You configure trace and alarm settings for Cisco Unified CallManager services. A Cisco TAC engineer receives the results. You can direct alarms to the Microsoft Windows 2000 Event Viewer, CiscoWorks2000 Syslog, system diagnostic interface (SDI) or signal distribution layer (SDL) trace log files, or to all destinations. You can base traces for Cisco Unified CallManager services on debug levels, specific trace fields, and Cisco Unified CallManager devices such as phones or gateways. You can perform a trace on the alarms that are sent to the SDI or SDL trace log files. Use the Trace Collection tool to collect trace information for any Cisco Unified CallManager service and the time and date of the trace for that service. Trace Collection collects and zips the chosen files.
6-1
Chapter 6 Loading the Trace Collection Tool
Note
Enabling Trace decreases system performance; therefore, enable Trace only for troubleshooting purposes. For assistance using Trace, contact Cisco TAC. After configuring trace parameters and running the trace, you can choose trace information to collect for analysis. You can base the collection of information on type of Cisco Unified CallManager service and time and date of trace. Trace Collection focuses on traces for a specific period. See the Loading the Trace Collection Tool section on page 6-2 for information about loading and launching the Trace Collection Tool. See the Collecting Traces by Using Trace Collection Tool section on page 6-5 for information about how to collect traces by using the Cisco Trace Collection Tool.
Loading the Trace Collection Tool

The following procedure describes how to load the Trace Collection Tool.
Note
Run the Trace Collection Tool only on Windows XP/98/2000-based machines that have Visual Basic 6.0 Runtime Libraries/DLLs installed. To avoid any CPU spiking on the server while the tool collects and zips files, do not install it on the server. You do not need to apply troubleshooting traces to collect the traces by using this tool. See the Troubleshooting Trace Setting Configuration section on page 9-1 and refer to the Trace section in the Cisco Unified CallManager Serviceability System Guide for more information.
Procedure
Step 1
From Cisco Unified CallManager Administration or Cisco Unified CallManager Serviceability, choose Application > Install Plugins. The Install Plugins window displays. Click the Cisco Unified CallManager Trace Collection Tool icon. The InstallShield Wizard window displays. Follow all the installation prompts and click Finish.
Step 2
Step 3
6-2
OL-10643-01
Chapter 6
Trace Collection Configuration Loading the Trace Collection Tool
Step 4
When the installation is complete, go to the Start menu and choose Start > Programs > Cisco Unified CallManager Serviceability > Trace Collection Tool.
Note
You can also launch the Trace Collection Tool by clicking the Trace Collection Tool icon that is created on your desktop during installation.
The Cisco Unified CallManager Trace Collection Tool authentication window displays.
Step 5
In the Server/Name IP Address field, enter the server name or IP address of the Cisco Unified CallManager server in the cluster on which you want to collect traces. In the User Name field, enter the user name of the Cisco Unified CallManager server. In the Password field, enter the NT Administrator password of the Cisco Unified CallManager server.
Step 6 Step 7
Note
The usename and password that you enter should be the same as ones that you used when you installed the Cisco Unified CallManager server.
Step 8
In the To Collect Traces box, choose one of the following radio buttons:

Use IP Address (Convert DNS Names of CallManager Servers to IP Addresses) Use DNS Names (Convert IP Addresses of CallManager Servers to DNS Names)
Note
The option to use IP address acts as the default selection as long as no Network Address Translation (NAT) is used between the machine where Trace Collection Tool is running, and the Cisco Unified CallManager servers, regardless of whether they are running on the same subnet.
Step 9 Step 10
To connect to the server that has HTTPS enabled, check the Secure Connection check box. Click Next.
6-3
Chapter 6 Loading the Trace Collection Tool
Note
If you did not check the Secure Connection check box and the server to which you are connecting is HTTPS enabled, the following error message displays: Error: Cannot connect to server without secure channel. Please check the Secure Connection check box and proceed. If you checked the Secure Connection check box and the server to which you are connecting is not HTTPS enabled, the following error message displays: Unable to connect to <ipaddress> (Unable to establish security context for this session).
Step 11
If you are connecting with a HTTPS connection, a dialog displays that indicates that the certificate for the server may not be secure. To continue, click Yes.
Note
When you access online help from the Trace Collection Tool, the Security Alert dialog box displays. This dialog box displays each time that you access online help until you install the certificate on your computer. To continue without installing the security certificate, click Yes. To install the security certificate, see the Using Hypertext Transfer Protocol over Secure Sockets Layer (HTTPS) section on page 1-4.
Note
HTTPS does not work for HTTPS-enabled applications when you browse into the application by using Netscape 4.79 and a hostname that contains an underscore (_). Under these circumstances, the following message may display: The security library has encountered an improperly formatted DER-encoded message. When the message displays, click OK. This error occurs because the certificate that enables the HTTPS service uses the hostname as the subject name of the certificate; Netscape 4.79 considers the underscore in the subject name to be an invalid character, so HTTPS will not work.
6-4
OL-10643-01
Chapter 6
Trace Collection Configuration Collecting Traces by Using Trace Collection Tool
For HTTPS support, use Internet Explorer. To use Netscape 4.79 and the hostname to access the application, disable HTTPS, as described in the Cisco Unified CallManager Security Guide.
Related Topic

Collecting Traces by Using Trace Collection Tool, page 6-5 Trace Configuration, page 5-1 Bulk Trace Analysis, page 24-1 Using Hypertext Transfer Protocol over Secure Sockets Layer (HTTPS), page 1-4 Trace, Cisco Unified CallManager Serviceability System Guide.
Collecting Traces by Using Trace Collection Tool

The following procedure describes how to collect traces by using the Trace Collection Tool. The Trace Collection Tool comprises the following tabs:

Select CallManager Services Select CallManager Applications Select System Traces
The Select CallManager Services tab provides a grid of services for the Cisco Unified CallManager nodes in the cluster. You can choose all or some of the services for which traces must be collected by checking the appropriate check boxes.
Note
The services that you have not activated also display, so you can collect traces for those services. The nodes that cannot be reached get listed at the bottom of the window.
6-5
Chapter 6 Collecting Traces by Using Trace Collection Tool
The Select CallManager Applications tab provides the list of Cisco Unified CallManager applications that you can collect. You can choose all or some of the applications in this tab. The Cisco Unified CallManager nodes that are unavailable display at the bottom of the window.
Note
If you want to check all the applications on all Cisco Unified CallManager servers, check the Select all Applications on all Servers check box. You can install some of the listed applications only on the Cisco Unified CallManager publisher; therefore, you can obtain traces for such applications only from the publisher. The Select System Traces tab provides the list of system logs that you can collect. You can choose some or all of the logs. The Cisco Unified CallManager nodes that are not available display at the bottom of the window.
Procedure
Step 1
From the Cisco Unified CallManager Trace Collection Tool main window, choose the Select CallManager Services, Select CallManager Applications, or Select System Traces tab and choose the services, applications, and/or system traces on which you want traces collected and zipped and click Next.
Note
You can click the <Back button to go back to the previous window to connect to a different server, or Exit to exit the application.
The Trace Collection Tool displays.

Step 2
If you want to collect all available traces, choose Collect All Available Traces.
6-6
OL-10643-01
Chapter 6
Trace Collection Configuration Collecting Traces by Using Trace Collection Tool
Step 3
If you want to collect traces within a given date range, choose Date Range, choose a time zone from the Select Time Zone drop-down list box, and enter a date and time in the From Time and To Time fields.
Note
The time zone of the client machine provides the default setting. All the standard time zones, along with a separate set of entries for all time zones that have Daylight Savings settings, display in the Select Time Zone drop-down list box.
Step 4
To see the time zone details of the Cisco Unified CallManager servers, click Show Server Time Zones. A popup window displays the details like server name, time zone of each of the servers, and whether Daylight Saving is applicable.
Note
The trace files that get modified in the date range (between the From date and the to date, get collected if the chosen time zone matches the time zone settings of the server (for example Server 1). If there is another server in the same Cisco Unified CallManager cluster (Server 2), that is in a different time zone, then the trace files that get modified in the corresponding date range in Server 2 will get collected from Server 2.
Step 5
From the Zip File Location field, click the Browse button and enter the path name on the client machine where you want to store the zip file.
Note
The default path is C:\ and the default file name is CiscoCallManagerTraceCollection.zip. If the file already exists, then you get prompted to either replace the file, or enter a different path name.
You can collect the output zip file as a single zip file, or you can opt for the files to be split into multiple files.
Step 6
To split the output zip file into multiple files, choose the Create MultiVolume Zip File when zipping the files option and enter a value for MultiVolume File size, which would indicate the size of each file that gets split.
Note
The minimum value for the size of each zip file specifies 100KB.
6-7
Chapter 6 Collecting Traces by Using Trace Collection Tool
Step 7
From the Compression Factor pull-down list, choose the compression factor value of the zip file.
Note
The Trace Collection Tool only allows you to enter values 0 through 9 because any higher values would only be useful if the files to be zipped are of binary type.
Step 8
Click Collect Traces. A message displays and states that you are about to collect and zip files of a particular size. If you think that the file size is too large, you can cancel the operation.
Note
At any time, only a single user can collect traces from the cluster. If more than a single user tries to collect traces, a message displays that states that another user is already collecting traces. This check can only occur when the Cisco Unified CallManager publisher database server is active in the network; otherwise, a warning displays, and you must cancel the trace collection. You must cancel because multiple users who are collecting traces from the same cluster at the same time exist and high disk I/O operations in the servers may occur.
Step 9
Click Yes to continue. A window displays that shows the progress of the zipping process. When the zipping process completes, a window displays that provides the zipping details. The list of files not found includes the files that are not found in the given path and/or files that exist on a machine that is not present in the network.
Note
If a machine goes out of network during the zipping process, those files do not get zipped and they display as files not found. The list of Registry Entries that were not found means that if any Registry Entries were missing, the file(s) that correspond to the Application/Log do not get zipped.
6-8
OL-10643-01
Chapter 6
Trace Collection Configuration Viewing the Certificate
Related Topics

Loading the Trace Collection Tool, page 6-2 Trace Configuration, page 5-1 Bulk Trace Analysis, page 24-1 Trace, Cisco Unified CallManager Serviceability System Guide
Viewing the Certificate

From the Trace Collection Tool, you can view the server authentication certificate that the certificate authority provides. You cannot change any data that displays on the certificate. To view the certificate, perform the following procedure.
Procedure
Step 1
From the Trace Collection Tool, click View > Certificate. The Certificate dialog box displays information about the certificate, such as whether the certificate has been issued by a trusted authority, who issued the certificate, to whom the certificate was issued, and the dates that the certificate is valid.
Step 2
To close the Certificate dialog box, click OK.
6-9
Chapter 6 Viewing the Certificate
6-10
OL-10643-01
C H A P T E R
Trace Analysis Configuration

This chapter provides procedural information on the Cisco Unified CallManager Serviceability Trace Analysis tool. This chapter contains the following topics:

Specifying Criteria for an SDI Trace Analysis, page 7-2 Specifying Criteria for an SDL Trace Analysis, page 7-5

The Trace and Alarm tools work together. You configure trace and alarm settings for Cisco Unified CallManager services. A Cisco TAC engineer receives the results. You can direct alarms to the Microsoft Windows 2000 Event Viewer, CiscoWorks2000 Syslog, system diagnostic interface (SDI) or signal distribution layer (SDL) trace log files, or to all destinations. You can base traces for Cisco Unified CallManager services on debug levels, specific trace fields, and Cisco Unified CallManager devices such as phones or gateways. You can perform a trace on the alarms that are sent to the SDI or SDL trace log files. The Trace Analysis tool, a post-processing tool that displays XML files, provides greater trace detail to help narrow system problems. Using the Trace Analysis tool, you can specify an SDI or SDL trace, a device name, or an IP address for a Cisco Unified CallManager service.
7-1
Chapter 7 Specifying Criteria for an SDI Trace Analysis
Note
Enabling Trace decreases system performance; therefore, enable Trace only for troubleshooting purposes. For assistance using Trace, contact Cisco TAC. Cisco Unified CallManager system administrators and Cisco engineers use Trace Analysis to debug system problems. After the trace is configured and collected, you request a list of SDI or SDL log files. From the list, you can choose a specific log file and request information from that log file such as host address, IP address, trace type, and device name. An SDL Trace log file contains call-processing information from services such as Cisco CallManager, Cisco CTIManager, and Cisco TFTP. The system traces the signal distribution layer of the call and logs state transitions into a log file. An SDI Trace log file contains information for all Cisco Unified CallManager services. The system traces system diagnostic interface information from the services and logs run-time events and traces to a log file. The easy-to-read SDI and SDL log files display in XML format. The format for contents of log files looks like a table with headings, rows, and columns of information.
Specifying Criteria for an SDI Trace Analysis

An SDI trace analysis provides you with specific trace information from an SDI log file. After you choose the SDI log file from which you would like detailed information, you choose the search criteria and the fields that you want displayed. Narrow the SDI Trace Analysis by choosing the search criteria and the display fields.
Search Criteria
The following list provides search criteria:

CallManager HostChoose ALL or a specific host name. Device NameChoose ALL or the name of the device (use Cisco Unified CallManager Administration to name devices).
7-2
OL-10643-01
Chapter 7
Trace Analysis Configuration Specifying Criteria for an SDI Trace Analysis
IP AddressChoose ALL or the source IP address. Trace TypeChoose ALL, Alarm, or Trace.
Display Fields
You can choose the following fields to display:

ClusterDisplays the cluster name. Date and TimeDisplays the date and time. CallManager NodeDisplays the IP address of the node. Trace TypeDisplays the type of trace such as Alarm or Trace. IP AddressDisplays the source IP address. Correlation TagDisplays the number that correlates traces with each other. Application NameDisplays DNs and other service-specific information. InformationProvides description of what the trace found. Device NameDisplays the device name.
This section describes how to obtain the trace results from an SDI Trace file.
Procedure
Caution
The Trace Analysis tool affects the performance of the Cisco Unified CallManager server that runs the tool. If possible, run Trace Analysis during off-peak business hours or use the Bulk Trace Analysis tool. From the Cisco Unified CallManager Administration window, choose Application > Cisco Unified CallManager Serviceability. The Cisco Unified CallManager Serviceability window displays.
Step 1
Choose Trace > Analysis. From the Available Cisco Servers selection box, click the Down arrow. Choose the server for which you want the trace information. From the Available Services selection box, click the Down arrow.
7-3
Chapter 7 Specifying Criteria for an SDI Trace Analysis
Choose the service for which you want the trace information. Click the SDI Trace radio button. Click the List Files button. A window displays with a list of all files for the server and services that you chose. The filename, size, and last modified date of each file displays.
Note
To see the entire list of trace files, click the First, Previous, Next, or Last button.
Step 9
Double-click the filename to open the file. The SDI Trace Analysis window displays. Use this window to choose specific trace information to view and analyze.
Note
If you want to use the system trace analysis defaults, click the Select Defaults button; otherwise, continue with the following steps.
Step 10 Step 11 Step 12 Step 13 Step 14 Step 15 Step 16 Step 17 Step 18 Step 19
In the CallManager Host box, click the down arrow. Choose the host for which you want trace analysis. In the Device Name box, click the down arrow. Choose the device name for which you want trace analysis. In the IP Address box, click the down arrow. Choose the IP address for which you want trace analysis. In the Trace Type box, click the down arrow. Choose the trace type for which you want trace analysis. In the Fields to Display window area, check the appropriate check boxes. Click the Display Records button. The trace analysis search results display.
7-4
OL-10643-01
Chapter 7
Trace Analysis Configuration Specifying Criteria for an SDL Trace Analysis
Related Topics

Trace Configuration, page 5-1 Trace Collection Configuration, page 6-1 Bulk Trace Analysis, page 24-1
Specifying Criteria for an SDL Trace Analysis

An SDL trace analysis provides you with specific trace information from an SDL log file. After you choose the SDL log file from which you would like detailed information, you choose the search criteria and the fields that you want displayed. Narrow the SDL Trace Analysis by choosing the search criteria and the display fields.
Search Criteria
The following list provides the search criteria:

CallManager HostChoose ALL or a specific host name. Device NameChoose ALL or the name of the device (use Cisco Unified CallManager Administration to name devices). IP AddressChoose ALL or the source IP address. Trace TypeChoose ALL, Created, ErrorSdl, SdlSig, SdlSg-S, SdlSig-Q, and Stopping.
Display Fields
You can choose the following fields to display:

Line NumberDisplays the line number within the trace file. Date and TimeDisplays the date and time. CallManager NodeDisplays the IP address of the node. Trace TypeDisplays the type of trace. SignalDisplays the signal name responsible for the state transition.
OL-10643-01
7-5
Chapter 7 Specifying Criteria for an SDL Trace Analysis
Receiving ProcessDisplays the process name that received the signal. Sending ProcessDisplays the process name that originated the signal. Receiving Process StateDisplays the state of the receiving process when it received the signal. Correlation TagDisplays the number that correlates traces with each other. Application NameDisplays DNs and other service-specific information. InformationProvides description of what the trace found. Device NameDisplays the device name. IP AddressDisplays the source IP address responsible for the trace.
This section describes how to obtain the trace results from an SDL Trace file.
Procedure
Caution
The Trace Analysis tool affects the performance of the Cisco Unified CallManager server that runs the tool. If possible, run Trace Analysis during off-peak business hours or use the Bulk Trace Analysis tool. From Cisco Unified CallManager Administration, choose Application > Cisco Unified CallManager Serviceability. The Cisco Unified CallManager Serviceability window appears.
Step 1
Step 2 Step 3 Step 4 Step 5 Step 6 Step 7 Step 8
Choose Trace > Analysis. From the Available Cisco Servers selection box, click the Down arrow. Choose the server for which you want the trace information. From the Available Services selection box, click the Down arrow. Choose the service for which you want trace information. Click the SDL Trace radio button. Click the List Files button. A window displays with a list of all files for the server and services that you chose. The filename, size, and last modified date of each file displays.
7-6
OL-10643-01
Chapter 7
Trace Analysis Configuration Specifying Criteria for an SDL Trace Analysis
Note
To see the entire list of trace files, click the First, Previous, Next, or Last button.
Step 9
Double-click the filename to open the file. The SDL Trace Analysis window displays. Use this window to choose specific trace information to view and analyze.
Note
If you want to use the system trace analysis defaults, click the Select Defaults button; otherwise, continue with the following steps.
Step 10 Step 11 Step 12 Step 13 Step 14 Step 15 Step 16 Step 17 Step 18 Step 19 Step 20 Step 21
In the CallManager Host box, click the down arrow. Choose the host for which you want trace analysis. In the Device Name box, click the down arrow. Choose the device name for which you want trace analysis. In the IP Address box, click the down arrow. Choose the IP address for which you want trace analysis. In the Trace Type box, click the down arrow. Choose the trace type for which you want trace analysis. In the Signal Name box, click the down arrow. Choose the signal for which you want trace analysis. In the Fields to Display window area, check the appropriate check boxes. Click the Display Records button. The trace analysis search results display.
Related Topics

Trace Configuration, page 5-1 Trace Collection Configuration, page 6-1 Bulk Trace Analysis, page 24-1
7-7
Chapter 7 Specifying Criteria for an SDL Trace Analysis
7-8
OL-10643-01
C H A P T E R
Q.931 Translator
This chapter describes how to use the message translator. Cisco Unified CallManager generates ISDN trace files, that can be used to diagnose and troubleshoot connectivity problems in Cisco Unified CallManager installations. The log files contain Q.931 type messages (ISDN Layer 3 protocol). Using the message translator tool, Cisco Support Engineers translate your incoming debugging information into familiar Cisco IOS-equivalent messages. The message translator works by filtering incoming data from Cisco Unified CallManager system diagnostic interface (SDI) log files, then parsing and translating them into Cisco IOS-equivalent messages. Message translator supports XML and text files.
Related Topics

Using the Message Translator, page 8-1 Alarm Configuration, page 2-1 Trace Configuration, page 5-1
Using the Message Translator

This section describes how to use the message translator to locate the SDI log file and save it as an IOS format file.
8-1
Chapter 8 Using the Message Translator
Q.931 Translator
Procedure
Step 1
Step 2
Choose Trace > Q931 Translator. The Q931 Translator window displays. Choose the Cisco Unified CallManager server for which you want to translate Q.931 messages. To choose an XML trace file format, click the XML bullet. To choose a Text trace file format, click the Text bullet. If you want to search for a particular trace file, enter the file name in the Search For field. To begin the search, click List Files. The trace files with the selected criteria display. The window displays a list of all files for the server and the format you chose. The filename, size, and last modified date of each file displays.
Step 3 Step 4
Step 5 Step 6
Step 7
Double-click the filename for which you want the Q931 message translation. The Q931 Translation window displays. If the trace file that you chose does not have any ISDN messages in it, the error message, No ISDN Messages in the File, displays. If the trace file that you chose does have ISDN messages in it, the Q931 translation page contains the following fields: ISDN Message Text and IOS Translation. ISDN Message Text displays all the ISDN messages in the trace file. IOS Translation displays the translated message of the selected ISDN message from the ISDN Message Text list box.
Step 8
Choose the ISDN message to be translated. The IOS translation text changes based on the chosen ISDN message.
8-2
OL-10643-01
Chapter 8
Q.931 Translator Using the Message Translator
To save the IOS translated messages for the ISDN messages, click the IOS Format link. A file save dialog window displays. Save the file. To return to the Q931 file search window, click the Back to List Trace Files link.
Related Topics

Q.931 Translator, page 8-1 Alarm Configuration, page 2-1 Trace Configuration, page 5-1
8-3
Chapter 8 Using the Message Translator
Q.931 Translator
8-4
OL-10643-01
C H A P T E R
Troubleshooting Trace Setting Configuration

This chapter provides a description of how to use the Troubleshooting Trace Setting web pages in Cisco Unified CallManager Serviceability. The Troubleshooting Trace Setting web pages that are available on all the Cisco Unified CallManager nodes, get installed when you install the Cisco Unified CallManager. You can access the Troubleshooting Trace Setting pages by going to Trace > Troubleshooting Trace Setting. The following topics cover the Troubleshooting Trace Setting configuration information:

Setting Troubleshooting Trace, page 9-1 Resetting Troubleshooting Trace, page 9-2
Setting Troubleshooting Trace

The following procedure describes how to set Troubleshooting Trace settings.
Procedure
Step 1
9-1
Chapter 9 Resetting Troubleshooting Trace
Choose Trace > Troubleshooting Trace Settings. Check the check box of each Cisco Unified CallManager node on which you want to set troubleshooting trace. From the Services list, check the check box of the service(s) on which you want to set troubleshooting trace.
Note
If you want to check all services on a particular node, check the Check all Services for a Node check box under the node.
Step 5
After you finish choosing all the services on which you want to set troubleshooting trace, click Apply Troubleshooting Traces.
Note
Having Troubleshooting trace enabled for a longer period of time will increase the size of the trace files and may impact the performance of the services.
The page refreshes.
Related Topics

Resetting Troubleshooting Trace, page 9-2 Trace Configuration, page 5-1 Trace, Cisco Unified CallManager Serviceability System Guide
Resetting Troubleshooting Trace

The following procedure describes how to reset troubleshooting trace.
Before You Begin
You must set troubleshooting trace before performing the following procedure. See the Setting Troubleshooting Trace section on page 9-1.
9-2
OL-10643-01
Chapter 9
Troubleshooting Trace Setting Configuration Resetting Troubleshooting Trace
Procedure
Step 1
Step 2 Step 3
Choose Trace > Troubleshooting Trace Settings. Click Reset Troubleshooting Traces. The page refreshes, and the original trace settings for services get restored.
Related Topics

Setting Troubleshooting Trace, page 9-1 Trace Configuration, page 5-1 Trace, Cisco Unified CallManager Serviceability System Guide
9-3
Chapter 9 Resetting Troubleshooting Trace
9-4
OL-10643-01
A R T
Monitoring Tools Configuration
C H A P T E R
10
Service Activation
This chapter provides information on the Serviceability Service Activation tool and contains the following topics:

Activating Cisco Unified CallManager Services, page 10-2 Deactivating Cisco Unified CallManager Services, page 10-4 Service Considerations, page 10-5 Deleting Services, page 10-10
Cisco Unified CallManager Serviceability provides a web-based Service Activation tool that is used to activate and deactivate Cisco Unified CallManager services for servers.
Note
If you deactivate the Cisco CallManager and CTIManager services in Service Activation, the Cisco Unified CallManager where you deactivated the service no longer exists in the database. This means that you cannot choose the Cisco Unified CallManager for configuration operations in Cisco Unified CallManager Administration because it will not display in the graphical user interface (GUI). If you then reactivate the services on the same Cisco Unified CallManager, the database creates the Cisco Unified CallManager again and adds a CM_ prefix to the server name or IP address; for example, if you reactivate the Cisco CallManager or CTIManager service on a server with an IP address of 172.19.140.180, then CM_172.19.140.180 displays in Cisco Unified CallManager Administration. You can now choose the Cisco Unified CallManager, with the new CM_ prefix, in Cisco Unified CallManager Administration.
10-1
Chapter 10 Activating Cisco Unified CallManager Services
Service Activation
Note
You can access the Service Activation web pages from the Start Menu on the Cisco Unified CallManager server. Choose Start > Cisco Unified CallManager X.X > Cisco Service Configuration.
Activating Cisco Unified CallManager Services

Use the Service Activation tool to activate Cisco Unified CallManager services for a particular server.
Caution
Activate/deactivate services only from the Service Activation windows. If you activate/deactivate services from the Windows Service Control Manager instead of from Service Activation, entries do not get added to/removed from the database table; therefore, services do not get properly configured or started and may be out of sync with the Cisco Unified CallManager database.
Note
The Cisco Unified CallManager services do not start until you activate them by using Service Activation.
Procedure
Step 1
Step 2
Choose Tools > Service Activation. The Service Activation window displays the list of servers. From the Servers pane, choose the server. The window displays the service names for the server that you chose, the activation status of the services, and the Tomcat Web Service information.
Step 3
10-2
OL-10643-01
Chapter 10
Service Activation Activating Cisco Unified CallManager Services
Note
Cisco Tomcat designates an NT service that is started at Cisco Unified CallManager installation. Cisco Tomcat loads the Cisco IP Manager Assistant service when the first occurrence of the desktop or IP phone interface tries to connect to it to get service.
Step 4 Step 5
Check the check boxes next to the services that you want to activate. After you choose all services that you want to activate, click Update. The window displays the services that you chose with an activation status of Activated.
Tip
You can choose all the services that are required to run Cisco Unified CallManager by clicking the Set Default button. This action not only chooses all required services, but also checks for service dependencies. The SetDefault button chooses default services that are to be activated based on single-server configuration. For multiserver cluster configuration, see Table 10-1 for service considerations.
Note
You can start or stop activated services from the Control Center. To access the Control Center web pages, click the Control Center link. Refer to Service Activation, page 10-1, for more information about Control Center.
Related Topics

Deactivating Cisco Unified CallManager Services, page 10-4 Service Considerations, page 10-5 Deleting Services, page 10-10 Service Activation, page 10-1 Service Activation, page 10-1, Cisco Unified CallManager Serviceability System Guide
10-3
Chapter 10 Deactivating Cisco Unified CallManager Services
Service Activation
Service Activation, page 10-1, Cisco Unified CallManager Serviceability System Guide
Deactivating Cisco Unified CallManager Services

Use the Service Activation tool to deactivate Cisco Unified CallManager services for a particular server.
Caution
Activate/deactivate services only from the Service Activation windows. If you activate/deactivate services from the Windows Service Control Manager instead of from Service Activation, entries do not get added to/removed from the database table; therefore, services do not get properly configured and may be out of sync with the Cisco Unified CallManager database.
Procedure
Step 1
Step 2
Choose Tools > Service Activation. The Service Activation window displays the list of servers. From the Servers pane, choose the server. The window displays the service names for the server that you chose, the activation status of the services, and the Tomcat Web Service information.
Step 3
Note
Cisco Tomcat designates an NT service that is started at Cisco Unified CallManager installation. Cisco Tomcat loads the Cisco IP Manager Assistant service when the first occurrence of the desktop or IP phone interfaces tries to connect to it to get service. Refer to the Understanding Cisco Unified CallManager Assistant section on page 18-14 for more information about the Cisco IP Manager Assistant service.
Step 4
Uncheck the check boxes next to the services that you want to deactivate.
10-4
OL-10643-01
Chapter 10
Service Activation Service Considerations
Step 5
When you have chosen each service that you want to deactivate, click Update. An activation status of Deactivated displays for the services that you chose.
Tip
You can activate all the services that are required to run Cisco Unified CallManager by clicking the Set Default button. This action not only activates all required services but also checks for service dependencies.
Note
You can now start or stop activated services from the Control Center. To access the Control Center web pages, click the Control Center link. Refer to Service Activation, page 10-1, for more information about Control Center.
Related Topics

Activating Cisco Unified CallManager Services, page 10-2 Service Considerations, page 10-5 Deleting Services, page 10-10 Service Activation, page 10-1 Service Activation, page 10-1, Cisco Unified CallManager Serviceability System Guide Service Activation, page 10-1, Cisco Unified CallManager Serviceability System Guide
Service Considerations
Table 10-1 shows all Cisco Unified CallManager services and considerations for configuring services. When you activate a service in Service Activation, all dependent services that are required on the node for that service also activate. For more information on services, refer to the Cisco Unified CallManager System Guide.
10-5
Chapter 10 Service Considerations
Service Activation
Table 10-1 Service Considerations
Service
Description
Server Concerns Activate the Cisco Database Layer Monitor and the Cisco RIS Data Collector services on servers that run the Cisco CallManager service.
Considerations Several services rely on the Cisco CallManager service. Before you activate any services, review Table 10-1.
Cisco CallManager Allows call processing
Cisco TFTP
Builds and serves files for devices
Activate on one server Configure Option 150 if you activate this service on more in the cluster that is dedicated specifically to than one server in the cluster. the Cisco TFTP service. Activate on one server in the cluster. Do not activate this service if you plan to use Cisco Unity system. Do not activate this service on the publisher database server or any servers that are running the Cisco CallManager service. This service requires that you activate Cisco TFTP on one server in the cluster.
Cisco Messaging Interface
Used for voice-messaging systems that use the SMDI interface Allows conferences, Music On Hold, and Media Termination Point (MTP)
Cisco IP Voice Media Streaming App
Activate on one or two servers per cluster. You may activate on a server that is dedicated specifically for Music On Hold.
Cisco Telephony Call Dispatcher (TCD)
Used for hunt groups and the Cisco Unified CallManager Attendant Console
Activate on every server See the Server Concerns in the cluster that runs cell. the Cisco CallManager service.
10-6
OL-10643-01
Chapter 10
Table 10-1 Service Considerations (continued)
Service Cisco Database Layer Monitor
Description Manages failover, fallback for the database; removes CDRs; provides change notification; and logs out phones by using Cisco Extension Mobility Used for hunt groups and the Cisco Unified CallManager Attendant Console
Server Concerns Activate on all servers in the cluster.
Considerations All services rely on the Cisco Database Layer Monitor service.
Cisco CTIManager
Activate the Cisco RIS Data Collector and Cisco CallManager services on the server where you activate the Cisco CTIManager service. Activate on all servers where the Cisco Unified CallManager and Cisco TFTP services run.
See the Server Concerns cell.
Cisco CTL Provider
Works with the Cisco CTL Client to change the clusterwide security mode from nonsecure to secure
After you activate the service, the Cisco CTL Provider service reverts to the default CTL port, which is 2444. If you want to change the port, refer to the Cisco Unified CallManager security documentation for more information. You must install and configure the Cisco CTL Client and activate this service for the clusterwide security mode to change from nonsecure to secure.
10-7
Chapter 10 Service Considerations
Service Activation
Service Cisco MOH Audio Translator
Description Converts wave files or other audio source files for Music On Hold; for example, if you want to use personalized messages with Music On Hold
Server Concerns To minimize security issues, activate on the server that runs the Cisco TFTP service.
Considerations If you activate this service on a server that does not run the Cisco TFTP service, you must manually configure write privileges. This service requires that you activate Cisco TFTP on one server in the cluster. To minimize CPU usage, do not activate this service on the publisher database server or any servers that are running the Cisco CallManager service.
Cisco RIS Data Collector
Activate on all servers Collects and distributes real-time in the cluster. information, such as the IP addresses of the phones Allows you to define login settings such as duration limits on phone configuration for the Cisco Unified CallManager Extension Mobility feature Reads transferred files, places contents into CDR database, removes old files
See the Server Concerns cell.
Cisco Extension Mobility
Activate on each server See the Server Concerns cell. that the Cisco Unified CallManager Extension Mobility application accesses.
Cisco CDR Insert
Activate on the server that contains the CDR database.
Cisco recommends that you place the CDR database on the publisher database server.
10-8
OL-10643-01
Chapter 10
Service Cisco IP Manager Assistant
Description Supporting Cisco Unified CallManager Assistant, enables managers and their assistants to work together more effectively Provides support for Cisco Unified CallManager features, such as Quality Report Tool (QRT)
Server Concerns Refer to the Cisco Unified CallManager Features and Services Guide for recommendations.
Considerations Refer to the Cisco Unified CallManager Features and Services Guide for recommendations.
Cisco Extended Functions
Activate on one or more Make sure that you activate the Cisco CTIManager service on servers that run the a server in the cluster. Cisco RIS Data Collector.
Cisco Serviceability Reporter
Activate on the Cisco Generates reports once a day based on Unified CallManager publisher node. logged information. Each summary report comprises different charts that display the statistics for that particular report. Allows Cisco Unified You should typically activate on one server IP Phone users to make calls from web per cluster. and desktop-based applications Issues locally significant certificates to supported Cisco Unified IP Phones Activate on the publisher database server.
To reduce any impact to call processing, run non-real-time reports during non-production hours.
Cisco WebDialer
Ensure that Cisco CTI Manager service is running on a server (not necessarily the same as Cisco WebDialer) in the cluster.
Cisco Certificate Authority Proxy Function (CAPF)
You can deactivate the CAPF service after the certificates are issued, but you must activate it again if you need to Be aware that the Database Layer Monitor use CAPF for any reason (for service is also required example, deleting certificates, on the publisher node. troubleshooting, and so on).
10-9
Chapter 10 Deleting Services
Service Activation
Related Topics

Activating Cisco Unified CallManager Services, page 10-2 Deactivating Cisco Unified CallManager Services, page 10-4 Deleting Services, page 10-10 Service Activation, page 10-1 Service Activation, page 10-1, Cisco Unified CallManager Serviceability System Guide Service Activation, page 10-1, Cisco Unified CallManager Serviceability System Guide
Deleting Services
When you activate services for a server, database entries get made for each activated service. When a server gets permanently removed from a Cisco Unified CallManager cluster, the database entries for the services that are already activated in that particular server still exist and continue to show up in the list of servers in the Cisco Unified CallManager Serviceability and administration windows. You must use the Delete Services utility to permanently remove the database entries. The following procedure describes how to delete services from a removed server.
Procedure
Step 1
In Cisco Unified CallManager Administration, choose Application > Cisco Unified CallManager Serviceability. The Cisco Unified CallManager Serviceability window displays.
Step 2
Choose Tools > Service Activation. The Service Activation window displays the list of servers. From the Servers pane, choose the server that has been permanently removed from the Cisco Unified CallManager cluster. The following message displays: Status: Connection to the server could not be established. Note: If this server has been permanently removed from the network, use Delete Services utility to remove the database entries.
Step 3
10-10
OL-10643-01
Chapter 10
Service Activation Deleting Services
Note
Use the Delete Services utility only when the server has been permanently removed from the network and to clean up the database entries.
Step 4
Click the Delete Services link. The Delete Services window displays the services that contain remaining database entries.
Step 5 Step 6
Check the check box beside each service that you want to delete. Click Delete.
Note
You can delete all services at once by clicking Delete All.
The following warning message displays: Deleting services from this page will remove the database entries for the services. Use this option only if the server has already been permanently removed from the network. Click OK to remove the database entries for these service(s) -or- Cancel to keep the database entries.
Note
You cannot use the Delete Services windows to delete the Cisco CallManager service. You must use the Cisco Unified CallManager windows to delete this service.
Step 7
Click OK to delete the services or Cancel to cancel the operation.
Related Topics

Activating Cisco Unified CallManager Services, page 10-2 Deactivating Cisco Unified CallManager Services, page 10-4 Service Considerations, page 10-5 Service Activation, page 10-1, Cisco Unified CallManager Serviceability System Guide
10-11
Chapter 10 Deleting Services
Service Activation
10-12
OL-10643-01
C H A P T E R
11
Control Center
This chapter provides information on the Serviceability Control Center tool and contains the following topics:

Viewing Status of Services, page 11-3 Stopping a Service, page 11-4 Starting a Service, page 11-5
Cisco Unified CallManager Serviceability provides a web-based Control Center tool that is used to view status and to start and stop Cisco Unified CallManager services for a particular server in a cluster. Starting and stopping a Cisco Unified CallManager service causes all Cisco Unified IP Phones and gateways that are currently registered to that Cisco Unified CallManager service to fail over to their secondary Cisco Unified CallManager service. Devices and phones need to restart only if they cannot register with another Cisco Unified CallManager service. Starting and stopping a Cisco Unified CallManager service causes other installed applications (such as Conference Bridge or Cisco Messaging Interface) that are homed to that Cisco Unified CallManager to start and stop as well.
Note
If you are upgrading Cisco Unified CallManager, those services that were already started on your system will start after the upgrade.
11-1
Chapter 11
Control Center
Caution
Stopping a Cisco Unified CallManager service also stops call processing for all devices that are controlled by that service. When a Cisco Unified CallManager service is stopped, calls from an IP phone to another IP phone stay up; calls in progress from an IP phone to a Media Gateway Control Protocol (MGCP) gateway also stay up, but other types of calls get dropped.
Note
You can activate or deactivate services from the Service Activation web pages. To access Service Activation, click the link from the Control Center web page. Refer to Chapter 10, Service Activation for more information about Service Activation. Table 11-1 provides a description of the service status icons.
Table 11-1 Service Status Icons
Icon Symbol Square Arrow Question Mark
Description Service is stopped. Service is running. Service is in an unknown status.
11-2
OL-10643-01
Chapter 11
Control Center Viewing Status of Services
Viewing Status of Services

Use the Control Center tool to view the status of Cisco Unified CallManager services for a particular server in a cluster. This section describes how to view the status of services on a particular server.
Procedure
Step 1
Step 2
Choose Tools > Control Center. The Control Center window displays the list of servers in the Cisco Unified CallManager cluster.
Step 3
From the Servers column, choose the server. The window displays the service names for the server that you chose, the activation status of the services, and a service control panel to stop or start a service.
Step 4 Step 5
To start a service, see the Starting a Service section on page 11-5. To stop a service, see the Stopping a Service section on page 11-4.
Related Topics

Stopping a Service, page 11-4 Starting a Service, page 11-5
11-3
Chapter 11 Stopping a Service
Control Center
Stopping a Service
Use the Control Center tool to stop a service for a particular server in a cluster. This section describes how to stop a service on a particular server.
Procedure
Step 1
Step 2
Step 3
From the Servers column, choose the server. The window displays the services for the server that you chose, the status of the services, and a service control panel to stop or start a service.
Step 4
Click the radio button next to the service that you want to stop.
Note
You can only start/stop services that are listed under NT Services. For Cisco Tomcat services, the services do not get started/stopped, and the start/stop/restart buttons are disabled for the Cisco Tomcat web service.
Step 5
Click the Stop button. The Service Status symbol changes from an arrow to a square.
Related Topics

Viewing Status of Services, page 11-3 Starting a Service, page 11-5
11-4
OL-10643-01
Chapter 11
Control Center Starting a Service
Starting a Service
Use the Control Center tool to start a service for a particular server in a cluster. This section describes how to start a service on a particular server.
Procedure
Step 1
Step 2
Step 3
From the Servers column, choose the server. The window displays the services for the server that you chose, the status of the services, and a service control panel to stop or start a service.
Step 4
Click the radio button next to the service that you want to start.
Note
You can only start/stop services that are listed under NT Services. For Cisco Tomcat services, the services do not get started/stopped and the start/stop/restart buttons are disabled for the Cisco Tomcat web service.
Step 5
Click the Start button. The Service Status symbol changes from a square to an arrow.
Related Topics

Viewing Status of Services, page 11-3 Stopping a Service, page 11-4
11-5
Chapter 11 Starting a Service
Control Center
11-6
OL-10643-01
C H A P T E R
12
Real-Time Monitoring Configuration

This chapter provides procedural information to configure the Real-Time Monitoring Tool (RTMT). The following topics cover the Real-Time Monitoring Tool performance monitoring configuration information:

Loading Real-Time Monitoring, page 12-2 RTMT Default Configuration, page 12-4 Creating Configuration Profiles, page 12-5 RTMT Window Components, page 12-6 Viewing the Summary Category in the View Tab, page 12-7 Viewing the Server Category in the View Tab, page 12-9 Viewing the CallProcess Category in the View Tab, page 12-12 Viewing the Service Category in the View Tab, page 12-16 Viewing the Device Category in the View Tab, page 12-20 Viewing the CTI Category in the View Tab, page 12-28 Using CTI Search, page 12-30 Understanding Performance Monitoring, page 12-36 Understanding Counter Properties, page 12-43 Understanding Alert Central in the Alert Tab, page 12-48 Counter Alert Configuration Settings, page 12-64
12-1
Chapter 12 Loading Real-Time Monitoring
Loading Real-Time Monitoring

This section describes how to load the Real-Time Monitoring Tool (RTMT). You can install RTMT from Install Plugins, under the Application menu in either Cisco Unified CallManager Administration or Cisco Unified CallManager Serviceability, and then launch from the Windows RTMT desktop shortcut. Refer to the Cisco Unified CallManager Administration Guide for information on plugin configuration.
Note
The Cisco Unified CallManager Serviceability program also lists RTMT under the Tools menu; however, if you choose RTMT from this location, you get directed to the Install Plugins menu.
Procedure
Step 1
From your Windows desktop, double-click the Real-Time Monitoring Tool icon. The Real-Time Monitoring Tool launch window displays. In the Host IP Address field, enter either the digital IP address or host name. In the User Name field, enter a user name. In the Password field, enter a password.
Note
Ensure that the authentication user name and password for RTMT is the same as the one that you used for installing Cisco Unified CallManager. If the authentication fails or if the server is unreachable, you will be prompted to reenter the server and authentication details, or you can click the Cancel button to exit the application. If the authentication succeeds, RTMT launches the monitoring module either from local cache or from a remote node, when the local cache does not contain a monitoring module that matches the backend Cisco Unified CallManager version.
Step 5 Step 6
In the Port field, enter a port number. To connect to the server that has HTTPS enabled, check the Secure connection check box.
12-2
OL-10643-01
Chapter 12
Real-Time Monitoring Configuration Loading Real-Time Monitoring
Note
If the server in the Cisco Unified CallManager cluster to which you are trying to connect is HTTPS-enabled, you must check the Secure connection check box to access the tool.
Note
HTTPS does not work for HTTPS-enabled applications when you browse into the application by using Netscape 4.79 and a hostname that contains an underscore (_). Under these circumstances, the following message may display: The security library has encountered an improperly formatted DER-encoded message. When the message displays, click OK. This error occurs because the certificate that enables the HTTPS service uses the hostname as the subject name of the certificate; Netscape 4.79 considers the underscore in the subject name to be an invalid character, so HTTPS will not work. For HTTPS support, use Internet Explorer. To use Netscape 4.79 and the hostname to access the application, disable HTTPS, as described in the Cisco Unified CallManager Security Guide.
Step 7 Step 8
Click OK. If you are connecting, for the first time, to a server in the Cisco Unified CallManager cluster that is HTTPS enabled, a dialog box displays that indicates that the certificate for the server may not be secure. When you access RTMT online help, the Security Alert dialog box displays. This dialog box displays each time that you access online help until you install the certificate on your computer. To continue without installing the security certificate, click Yes. To install the security certificate, refer to the Using Hypertext Transfer Protocol over Secure Sockets Layer (HTTPS) section on page 1-4. If you trust the server certificate, click Yes in the dialog box.
Step 9
If you do not trust the certificate, click No. Upon successful authentication, the RTMT window opens and displays with the default configuration. See the Creating Configuration Profiles section on page 12-5 for more information.
12-3
Chapter 12 RTMT Default Configuration
Step 10
Click OK.
Note
If you do not want a configuration that displays in the Select Configuration window, click the Cancel button. To create configuration profiles, see the Creating Configuration Profiles section on page 12-5.
The configuration that you chose displays.
Related Topics

RTMT Default Configuration, page 12-4 Creating Configuration Profiles, page 12-5 RTMT Window Components, page 12-6
RTMT Default Configuration

When you initially load RTMT, the system includes a default configuration called CM-Default. Dynamically created, CM-Default monitors all registered phones in all the Cisco Unified CallManager nodes. If your cluster includes five Cisco Unified CallManager-configured nodes, CM-Default displays all registered phones for each node in a Cisco Unified CallManager cluster, as well as calls in progress and active gateway ports and channels. See the Creating Configuration Profiles section on page 12-5 for information on how to create your own configuration profile.
Related Topics

Loading Real-Time Monitoring, page 12-2 Creating Configuration Profiles, page 12-5 RTMT Window Components, page 12-6
12-4
OL-10643-01
Chapter 12
Real-Time Monitoring Configuration Creating Configuration Profiles
Creating Configuration Profiles

You can create your own configuration profiles in RTMT after you open and view several different precanned (preconfigured) windows, such as CPU & Memory and SDL Queue. The following procedure describes how to create a profile.
Procedure
Step 1 Step 2
Open the monitoring windows that you want to be a part of your configuration profile. Choose System > Profile. The Preferences popup dialog box displays. Click Save. The Save Current Configuration popup dialog box displays. In the Configuration name field, enter a name for this particular configuration profile. In the Configuration description field, enter a description of this particular configuration profile.
Step 3
Step 4 Step 5
Note
You can use whatever you want for the configuration profile name and description.
The system creates the new configuration profile.

Close RTMT and relaunch it. Choose System > Profile again. In the popup dialog box, click Restore. Your profile displays in the Configuration List.
Step 9
Click the profile that you want to open. The precanned windows open automatically.
12-5
Chapter 12 RTMT Window Components
See the RTMT Default Configuration section on page 12-4 for information on RTMT CM-Default.
RTMT Window Components

The RTMT window comprises two main components: the Menu Bar and Monitor Window. You can access several different monitoring functions by using both or either of these components. The RTMT menu bar, located at the top of the RTMT window, comprises the following drop-down menu items that provide specific monitoring functions:

System menu Monitor menu Search menu Edit menu Device menu Perfmon menu Alert menu Window menu Application menu Help menu
Note
You can use the RTMT Menu bar or the Monitor window in the left controlling center pane of the RTMT window to monitor many of the same monitoring objects in RTMT. For more detailed information about the RTMT menu bar items, refer to Chapter 9, Real-Time Monitoring Tool, in the Cisco Unified CallManager Serviceability System Guide. The RTMT main user interface, or monitor window, comprises two parts: a left controlling center pane and right content viewing pane.
12-6
OL-10643-01
Chapter 12
Real-Time Monitoring Configuration Viewing the Summary Category in the View Tab
The controlling center pane comprises the View tab and the Alert tab. The View tab comprises several different monitoring categories, and the Alert tab comprises only the Alert category. See the following sections for procedures for the View tab monitoring categories:

Viewing the Summary Category in the View Tab, page 12-7 Viewing the Server Category in the View Tab, page 12-9 Viewing the CallProcess Category in the View Tab, page 12-12 Viewing the Service Category in the View Tab, page 12-16 Viewing the Device Category in the View Tab, page 12-20 Viewing the CTI Category in the View Tab, page 12-28 Using CTI Search, page 12-30 Understanding Performance Monitoring, page 12-36 Understanding Counter Properties, page 12-43
See the following sections for procedures for the Alert tab monitoring category:

Understanding Alert Central in the Alert Tab, page 12-48 Counter Alert Configuration Settings, page 12-64
Related Topics

Loading Real-Time Monitoring, page 12-2 Creating Configuration Profiles, page 12-5 Chapter 9, Real-Time Monitoring Tool, Cisco Unified CallManager Serviceability System Guide
Viewing the Summary Category in the View Tab

The following procedure describes how to view summary information by using the Summary category in the View tab.
12-7
Chapter 12 Viewing the Summary Category in the View Tab
Note
You can also view a summary of the Cisco Unified CallManager cluster by using the menu bar at the top of the RTMT pane by choosing Monitor > Cluster Summary. For more information the RTMT Menu Bar, refer to Chapter 9, Real-Time Monitoring Tool, in the Cisco Unified CallManager Serviceability System Guide.
Procedure
Step 1 Step 2
In the left controlling center pane, click the View tab. Click Summary. The Summary window displays and shows the activities of several precanned monitoring objects in the Cisco Unified CallManager cluster such as memory and CPU usage, registered phones, calls in progress, and active gateway ports and channels.
Note
Memory Usage % = (Committed Memory/Total Physical Memory) * 100% CPU Usage % = the percentage of time that the processor executes in a non-Idle thread.
Related Topics

RTMT Window Components, page 12-6 Chapter 9, Real-Time Monitoring Tool, Cisco Unified CallManager Serviceability System Guide
12-8
OL-10643-01
Chapter 12
Real-Time Monitoring Configuration Viewing the Server Category in the View Tab
Viewing the Server Category in the View Tab

See the following procedures for information on how to view server information by using the Server category in the View tab.

Monitoring Server CPU and Memory Information, page 12-9 Monitoring Server Disk Usage, page 12-10 Monitoring Server Critical Services, page 12-11
Monitoring Server CPU and Memory Information

The following procedure describes how to monitor CPU and memory information in the Server category.
Note
You can also monitor CPU and memory information by using the menu bar at the top of the RTMT pane by choosing Monitor > Server, and then choosing CPU and Memory from the drop-down menu. For more information on the RTMT Menu Bar, refer to Chapter 9, Real-Time Monitoring Tool, in the Cisco Unified CallManager Serviceability System Guide.
Procedure
In the left controlling center pane, click the View tab. Click Server. In the left controlling center pane under Server, click the CPU & Memory icon. The CPU & Memory window displays and shows the server memory and CPU usage.
Note
Memory Usage % = (Committed Memory/Total Physical Memory) * 100% CPU Usage % = the percentage of time that the processor executes in a non-Idle thread.
12-9
Chapter 12 Viewing the Server Category in the View Tab
Step 4
To monitor CPU and memory usage on another server, click the Process at Host down arrow and, from the drop-down list, choose the server that you want to monitor. The CPU and memory usage monitoring information for the server that you chose displays.
Related Topics

Monitoring Server Disk Usage

The following procedure describes how to monitor disk usage in the Server category.
Note
You can also monitor disk usage information by using the menu bar at the top of the RTMT pane by choosing Monitor > Server and then choosing DISK usage from the drop-down menu. For more information on the RTMT Menu Bar, refer to Chapter 9, Real-Time Monitoring Tool, in the Cisco Unified CallManager Serviceability System Guide.
Procedure
In the left controlling center pane, click the View tab. Click Server. In the left controlling center pane under Server, click the Disk Usage icon. The Disk Usage monitoring window displays and shows the percentage of disk usage per the largest partition in each host.
12-10
OL-10643-01
Chapter 12
Real-Time Monitoring Configuration Viewing the Server Category in the View Tab
Step 4
To monitor disk usage on another server, click the Disk Usage at Host down arrow and, from the drop-down list, choose the server that you want to monitor. The disk usage monitoring information for the server that you chose displays.
Related Topics

Monitoring Server Critical Services

The following procedure describes how to monitor critical services in the Server category.
Note
You can also monitor critical services by using the menu bar at the top of the RTMT pane by choosing Monitor > Server and then choosing Critical Services from the drop-down menu. For more information on the RTMT Menu Bar, refer to Chapter 9, Real-Time Monitoring Tool, in the Cisco Unified CallManager Serviceability System Guide.
Procedure
In the left controlling center pane, click the View tab. Click Server. In the left controlling center pane under Server, click the Critical Services icon. The Critical Services monitoring window displays and shows the services on this particular server.
Step 4
To monitor critical services on another server, click the Critical Services at Host down arrow, from the drop-down list, choose the server that you want to monitor.
12-11
Chapter 12 Viewing the CallProcess Category in the View Tab
The critical services monitoring information for the server that you chose displays. From this window, you can monitor each service on the Cisco Unified CallManager node and determine whether the service is up, down, or activated and determine how long the service has been in the current status.
Related Topics

Viewing the CallProcess Category in the View Tab

See the following procedures for information on how to view call-processing information by using the CallProcess category in the View tab.

Monitoring Call Activity, page 12-12 Monitoring Gateway Activity, page 12-13 Monitoring Trunk Activity, page 12-14 Monitoring SDL Queue, page 12-15
Monitoring Call Activity

The following procedure describes how to monitor call activity in the CallProcess category.
Note
You can also monitor call activity information by using the menu bar at the top of the RTMT pane by choosing Monitor > Call Process and then choosing Call Activity from the drop-down menu. For more information on the RTMT Menu Bar, refer to Chapter 9, Real-Time Monitoring Tool, in the Cisco Unified CallManager Serviceability System Guide.
12-12
OL-10643-01
Chapter 12
Real-Time Monitoring Configuration Viewing the CallProcess Category in the View Tab
Procedure
In the left controlling center pane, click the View tab. Click CallProcess. In the left controlling center pane under CallProcess, click the Call Activity icon. The Call Activity monitoring window displays and shows the call activity for each Cisco Unified CallManager node in the cluster.
Related Topics

Monitoring Gateway Activity

The following procedure describes how to monitor gateway activity in the CallProcess category.
Note
You can also monitor gateway activity by using the menu bar at the top of the RTMT pane by choosing Monitor > Call Process and then choosing Gateway Activity from the drop-down menu. For more information on the RTMT Menu Bar, refer to Chapter 9, Real-Time Monitoring Tool, in the Cisco Unified CallManager Serviceability System Guide.
Procedure
In the left controlling center pane, click the View tab. Click CallProcess. In the left controlling center pane under CallProcess, click the Gateway Activity icon. The Gateway Activity monitoring window displays and shows gateway activity for the Cisco Unified CallManager cluster.
OL-10643-01
12-13
Chapter 12 Viewing the CallProcess Category in the View Tab
The gateway activity in the cluster displays according to gateway type.

Step 4
To view the gateway activity for another gateway type, click the Gateway Type down arrow and, from the drop-down list, choose the gateway type that you want to monitor. The window displays the gateway activity of the gateway type that you chose.
Related Topics

Monitoring Trunk Activity

The following procedure describes how to monitor trunk activity in the CallProcess category.
Note
You can also monitor trunk activity by using the menu bar at the top of the RTMT pane by choosing Monitor > Call Process, and then choosing Trunk Activity from the drop-down menu. For more information on the RTMT Menu Bar, refer to Chapter 9, Real-Time Monitoring Tool, in the Cisco Unified CallManager Serviceability System Guide.
Procedure
In the left controlling center pane, click the View tab. Click CallProcess. In the left controlling center pane under CallProcess, click the Trunk Activity icon. The Trunk Activity monitoring window displays and shows the trunk activity for the Cisco Unified CallManager cluster. The trunk activity in the cluster displays according to trunk type.
12-14
OL-10643-01
Chapter 12
Real-Time Monitoring Configuration Viewing the CallProcess Category in the View Tab
Step 4
To view the trunk activity for another trunk type, click the Trunk Type down arrow and, from the drop-down list, choose the trunk type that you want to monitor. The window displays the trunk activity of the trunk type that you chose.
Related Topics

Monitoring SDL Queue

The following procedure describes how to monitor the SDL Queue in the CallProcess category.
Note
You can also monitor the SDL Queues by using the menu bar at the top of the RTMT pane by choosing Monitor > Call Process and then choosing SDL Queues from the drop-down menu. For more information on the RTMT Menu Bar, refer to Chapter 9, Real-Time Monitoring Tool, in the Cisco Unified CallManager Serviceability System Guide.
Procedure
In the left controlling center pane, click the View tab. Click CallProcess. In the left controlling center pane under CallProcess, click the SDL Queue icon. The SDL Queue monitoring window displays and shows the SDL queue information. The SDL Queue information in the cluster displays according to SDL Queue type. To view the SDL queue information for another SDL Queue type, click the SDL Queue Type down arrow and, from the drop-down list, choose the trunk type that you want to monitor.
Step 4
12-15
Chapter 12 Viewing the Service Category in the View Tab
The window displays the SDL queue information of the SDL Queue type that you chose.
Related Topics

Viewing the Service Category in the View Tab

See the following procedures for information on how to view service monitoring information by using the Service category in the View tab.

Monitoring Cisco TFTP, page 12-16 Monitoring Directory Server Information, page 12-17 Monitoring Heartbeat, page 12-19
Monitoring Cisco TFTP

The following procedure describes how to monitor the Cisco TFTP in the Service category.
Note
You can also monitor Cisco TFTP by using the menu bar at the top of the RTMT pane by choosing Monitor > Service and then choosing Cisco TFTP from the drop-down menu. For more information on the RTMT Menu Bar, refer to Chapter 9, Real-Time Monitoring Tool, in the Cisco Unified CallManager Serviceability System Guide.
Procedure
Step 1 Step 2
In the left controlling center pane, click the View tab. Click Service.
12-16
OL-10643-01
Chapter 12
Real-Time Monitoring Configuration Viewing the Service Category in the View Tab
Step 3
In the left controlling center pane under Service, click the Cisco TFTP icon. The Cisco TFTP monitoring window displays and shows the Cisco TFTP status for each Cisco Unified CallManager node.
Related Topics

Monitoring Directory Server Information

The following procedure describes how to monitor directory server information in the Service category.
Note
You can also monitor directory server information by using the menu bar at the top of the RTMT pane by choosing Monitor > Service and then choosing Directory Server from the drop-down menu. For more information the RTMT Menu Bar, refer to Chapter 9, Real-Time Monitoring Tool, in the Cisco Unified CallManager Serviceability System Guide.
Procedure
In the left controlling center pane, click the View tab. Click Service. In the left controlling center pane under Service, click the DirectoryServer icon. The DirectoryServer monitoring window displays and shows directory server information for the Cisco Unified CallManager cluster. The Directory Servers pane displays. See Table 12-1 for a description of the directory servers information.
12-17
Chapter 12 Viewing the Service Category in the View Tab
Table 12-1 Directory Servers Information
Information CallManager Node
Description The name of the Cisco Unified CallManager node (IP address or host name) as configured in the database The IP address or host name and the port number of the Cisco Unified CallManager server on which the directory resides Embedded, Netscape, or Active Directory Operational or Not Connected. If a Not Connected connection status exists, an error message displays that describes the error return code that the Directory API returns. Operational or Not Operational. If the directory type is Embedded and a subscriber node, a status displays. If the directory type is Embedded and a publisher/subscriber node, it is also a directory publisher node. If the replication status is Not Operational, an error message displays that describes the error return code that the Directory API returns.
Directory Server
Directory Type Connection Status (Reason)
Replication Status (Reason)
Note
You can expand and contract the columns of the Directory Services window. Move the cursor to the column edge. When the double arrow displays, click the mouse and move left and right to expand and contract.
12-18
OL-10643-01
Chapter 12
Real-Time Monitoring Configuration Viewing the Service Category in the View Tab
Related Topics

Monitoring Heartbeat
The following procedure describes how to monitor the Cisco Unified CallManager heartbeat in the Service category. For more information on the Cisco Unified CallManager heartbeat, refer to Chapter 9, Real-Time Monitoring Tool, in the Cisco Unified CallManager Serviceability System Guide.
Note
You can also monitor heartbeat information by using the menu bar at the top of the RTMT pane by choosing Monitor > Service and then choosing Heartbeat from the drop-down menu. For more information the RTMT Menu Bar, refer to Chapter 9, Real-Time Monitoring Tool, in the Cisco Unified CallManager Serviceability System Guide.
Procedure
In the left controlling center pane, click the View tab. Click Service. In the left controlling center pane under Service, click the Heartbeat icon. The Heartbeat monitoring window displays and shows the heartbeat information for the Cisco CallManager, Cisco TFTP service, and the Cisco Telephony Call Dispatcher (TCD) service. The Heartbeat monitoring window shows the heartbeat information for each Cisco Unified CallManager node, Cisco TFTP node, and Cisco TCD node in the cluster.
12-19
Chapter 12 Viewing the Device Category in the View Tab
Related Topics

Viewing the Device Category in the View Tab

See the following procedures for information on how to view device monitoring information by using the Device category in the View tab:

Monitoring Device Summary Information, page 12-20 Monitoring Devices by Using Device Search, page 12-21
Monitoring Device Summary Information

The following procedure describes how to monitor all the devices in the Cisco Unified CallManager cluster in the Device category.
Note
You can also monitor device information by using the menu bar at the top of the RTMT pane by choosing Monitor > Device and then choosing Device Summary from the drop-down menu. For more information on the RTMT Menu Bar, refer to Chapter 9, Real-Time Monitoring Tool, in the Cisco Unified CallManager Serviceability System Guide.
Procedure
In the left controlling center pane, click the View tab. Click Device. In the left controlling center pane under Device, click the Device Summary icon. The Device Summary monitoring window displays and shows phone, gateway, and media resources activities in the Cisco Unified CallManager cluster.
12-20
OL-10643-01
Chapter 12
Real-Time Monitoring Configuration Viewing the Device Category in the View Tab
Related Topics

Monitoring Devices by Using Device Search

The following procedure describes how to search for Cisco Unified CallManager devices to monitor by using Device Search in the Device category.
Note
You can also search for Cisco Unified CallManager devices by using the menu bar at the top of the RTMT pane by choosing Search > Device and then choosing the particular device for which you want to search from the drop-down menu. For more information on the RTMT Menu Bar, refer to Chapter 9, Real-Time Monitoring Tool, in the Cisco Unified CallManager Serviceability System Guide.
Procedure
In the left controlling center pane, click the View tab. Click Device. In the left controlling center pane under Device, click the Device Search icon. The Device Search window displays and shows the cluster and a tree hierarchy that lists all the devices within the cluster. You can use the right-click button on your mouse to find devices within the cluster, go to Cisco Unified CallManager Administration, or view cluster information for each Cisco Unified CallManager node in the cluster.
Step 4 Step 5
To find devices within the cluster, click the cluster name at the top of the tree hierarchy and right-click. Click Monitor. The Find devices in StandAloneCluster dialog box displays.
12-21
Step 6
In the Select device with status dialog box, choose one of the following radio buttons:

Registered Unregistered Rejected Any Status Device only configured in database.
The drop-down box that displays to the right of the radio button highlights.
Step 7
In the drop-down box, click the down arrow. The nodes in the Cisco Unified CallManager cluster display in the drop-down list.
Step 8
Choose the Cisco Unified CallManager node or any Cisco Unified CallManager for which you want the device information to display.
Note
In the remaining steps, you can choose the < Back, Next >, Finish, or Cancel buttons. The procedure uses the button that completes the procedure.
Step 9
Click the Next > button. The Search by device model dialog box displays. Click one of the following radio buttons:

Step 10
Any Model Device Model
Step 11 Step 12
If you chose Device Model, choose the device for which you want the device information to display. Click Next. The Search with name dialog box displays. Choose one of the following radio buttons and enter the appropriate information in the corresponding fields, if applicable:

Step 13
Any name/address Directory Number (for example, 200*) Device Name (for example, SEP123*)
12-22
OL-10643-01
Chapter 12
Device Description (for example, Auto*) IP Address (for example, 172.20.12.*) IP Subnet
Click Next. The Monitor following attributes dialog box displays.

Step 14
Check one or all of the following search attributes:

Name Node IPAddress Model StatusReason Status DirNumber Type LoginUserId TimeStamp
Step 15
Click Finish. Based on your search criteria, a window displays the results of your search.
Step 16 Step 17
To view Cisco Unified CallManager cluster information, click the cluster name at the top of the tree hierarchy and right-click. Click Properties. The CallManager Cluster Info window displays and shows cluster information for each Cisco Unified CallManager node in the cluster.
Step 18 Step 19
Click the tab with the name of the Cisco Unified CallManager node for which you want to view cluster information. To update cluster information, click Update. You can use the right-click button on your mouse to monitor devices within the cluster or go to Cisco Unified CallManager Administration for each Cisco Unified CallManager node in the cluster.
12-23
Step 20
To monitor devices within the cluster, right-click the device name from the tree hierarchy. Click Monitor. A dialog box for the device that you chose displays.
Step 21
Step 22
In the Select device with status dialog box, choose one of the following radio buttons:

Registered Unregistered Rejected Any Status Device only configured in database.
The drop-down box that displays to the right of the radio button highlights, if applicable.
Step 23 Step 24
Choose the Cisco Unified CallManager node on which you want to monitor the device or choose Any CallManager. Click Next. The Search by device model dialog box displays.
Step 25
Choose one of the following radio buttons:

Any Model Device Model
Step 26 Step 27
If you chose Device Model, choose the device for which you want the device information to display. Click Next. The Search with name dialog box displays.
Step 28
Choose one of the following radio buttons and enter the appropriate information in the corresponding fields, if applicable:

Any name/address Directory Number (for example, 200*) Device Name (for example, SEP123*) Device Description (for example, Auto*)
12-24
OL-10643-01
Chapter 12
IP Address (for example, 172.20.12.*) IP Subnet
Click Next. The Monitor following attributes dialog box displays.

Step 29
Choose one or all of the following search attributes:

Name Node Model Time Stamp Status IpAddress StatusReason
Step 30
Click Finish. Based on your search criteria, a window displays the results of your search. Repeat Step 20 through Step 30 for each device that you want to monitor.
Step 31
Related Topics

Viewing Phone Information

You can view information about phones that display in the RTMT device monitoring pane. This section describes how to view phone information.
Procedure
Step 1
To display the phone in the RTMT device monitoring pane, see the Monitoring Devices by Using Device Search section on page 12-21.
12-25
Step 2 Step 3
Choose the phone for which you want information. Right-click the mouse button. A popup menu displays. Choose Open. The Device Information window displays. See Figure 12-1. For more information on the device, choose any field that is displayed in the left pane of the window.
Step 4
Figure 12-1 Device Information Window
Related Topics

12-26
OL-10643-01
Chapter 12
Viewing Device Properties

You can view the properties of devices that display in the RTMT device monitoring pane. This section describes how to view device properties.
Procedure
Perform the procedure to display the device in the RTMT device monitoring pane. See the Monitoring Devices by Using Device Search section on page 12-21. Choose the device for which you want property information. Right-click the mouse button. A popup menu displays. Choose Properties. The Device Property window displays. To display the device description information, click the Description tab. To display other device information, click the Other Info tab. The window displays product ID, HTTP support, platform type, and registration attempts.
Step 4
Step 5 Step 6
Related Topics

Viewing Application Information

You can view the application information for selected devices such as the Cisco Unified IP Phone, CTI port, and CTI route point. This section describes how to view application information.
12-27
Chapter 12 Viewing the CTI Category in the View Tab
Procedure
Step 1 Step 2
Choose the device for which you want application information; for example, CTI. Right-click the mouse button. A popup menu displays. Choose App Info. The Application Information window displays the CTI manager node name, application ID, user ID, application IP address, application status, app time stamp, device time stamp, device name, and CTI device open status.
Step 3
Step 4
To view updated information, click the Refresh button or to close the window, click the OK button.
Related Topics

Viewing the CTI Category in the View Tab

See the following procedures for information on how to view CTI Manager monitoring information by using the CTI category in the View tab.

Monitoring CTI Manager Information, page 12-29 Using CTI Search, page 12-30 Monitoring CTI Applications by Using CTI Search, page 12-30 Monitoring CTI Devices by Using CTI Search, page 12-32
12-28
OL-10643-01
Chapter 12
Real-Time Monitoring Configuration Viewing the CTI Category in the View Tab
Monitoring CTI Manager Information

The following procedure describes how to monitor CTI Managers in the Cisco Unified CallManager cluster in the CTI category.
Note
You can also monitor CTI Manager information by using the menu bar at the top of the RTMT pane by choosing Monitor > CTI Manager. For more information the RTMT Menu Bar, refer to Chapter 9, Real-Time Monitoring Tool, in the Cisco Unified CallManager Serviceability System Guide.
Procedure
In the left controlling center pane, click the View tab. Click CTI. In the left controlling center pane, click the Cti Manager icon. The CtiManager monitoring window displays and shows the number of open devices, lines, and CTI connections for each Cisco Unified CallManager in the cluster.
Related Topics

12-29
Chapter 12 Using CTI Search
Using CTI Search

With CTI Search, you can search for all CTI applications, devices, and lines in the Cisco Unified CallManager cluster. See the following procedures for information on how to search for CTI information:

Monitoring CTI Applications by Using CTI Search, page 12-30 Monitoring CTI Devices by Using CTI Search, page 12-32 Monitoring CTI Lines by Using the CTI Search, page 12-34
Monitoring CTI Applications by Using CTI Search

The following procedure describes how to search for Cisco Unified CallManager CTI applications to monitor by using CTI Search in the CTI category.
Note
You can also search for Cisco Unified CallManager CTI applications by using the menu bar at the top of the RTMT pane by choosing Search > CTI and then choosing the CTI application, device, or line for which you want to search from the drop-down menu. For more information on the RTMT Menu Bar, refer to Chapter 9, Real-Time Monitoring Tool, in the Cisco Unified CallManager Serviceability System Guide.
Tip
To choose a CTI application, double-click the name or right-click Applications. A double-click opens the Select Applications to Monitor window. A right-click displays the Monitor option, which must be chosen to display the Select Applications to Monitor window. In the following procedure, use either method to choose applications.
12-30
OL-10643-01
Chapter 12
Real-Time Monitoring Configuration Using CTI Search
Procedure
In the left controlling center pane, click the View tab. Click CTI. In the left controlling center pane, click the CTI Search icon. The CTI Search window displays and shows the cluster and a tree hierarchy that lists all the CTI applications, devices, and lines within the cluster.
Step 4
In the tree hierarchy list, choose Applications. The Select Applications to monitor window displays. In the CTI Manager field, from the drop-down list box, choose the CTI manager that you want to monitor. In the Applications Status field, choose the application status. Click Next. A window with search criteria displays. Click one of the following radio buttons:

Step 8
Any name/address App Id IP Address IP Subnet UserId
Step 9
Enter the information in the field for the radio button that you chose; for example, if you chose the IP Subnet radio button, enter the IP address and the subnet mask in the field. Click Next. A window with the monitoring attributes fields displays. Check the check box for the attributes of the applications that you want to monitor. Click Finish. The applications monitoring pane displays the information that you chose.
Step 10
Step 11 Step 12
12-31
Related Topics

Monitoring CTI Devices by Using CTI Search

The following procedure describes how to search for Cisco Unified CallManager CTI devices to monitor by using CTI Search in the CTI category.
Note
You can also search for Cisco Unified CallManager CTI devices by using the menu bar at the top of the RTMT pane by choosing Search > CTI and then choosing the CTI application, device, or line for which you want to search from the drop-down menu. For more information on the RTMT Menu Bar, refer to Chapter 9, Real-Time Monitoring Tool, in the Cisco Unified CallManager Serviceability System Guide.
Tip
To choose a CTI device, double-click the name or right-click Devices. A double-click opens the Select Devices to Monitor window. A right-click displays the Monitor option, which must be chosen to display the Select Devices to Monitor window. In the following procedure, use either method to choose devices.
Procedure
Step 4
In the tree hierarchy list, choose Devices. The Select Devices to monitor window displays.
12-32
OL-10643-01
Chapter 12
In the CTI Manager field, choose the CTI manager that you want to monitor in the drop-down list box. In the Devices Status field, choose the device status. In the Devices box, click one of the following radio buttons:

Any name/address Device Name (for example, SEP123*)
Note
If you chose the Device Name radio button, enter the device name in the field.
Step 8 Step 9
Click Next. In the Application Pattern box, choose one of the following radio buttons:

Any name/address App Id IP Address IP Subnet UserId (for example, jsmith*)
Step 10 Step 11
Enter the information in the field for the radio button that you chose; for example, if you chose IP Subnet, enter the IP address and subnet mask in the field. Click Next. A window with the monitoring attributes fields displays. Check the check box for the attributes of the devices that you want to monitor. Click Finish. The devices monitoring pane displays the information that you chose.
Step 12 Step 13
Related Topics

12-33
Monitoring CTI Lines by Using the CTI Search

The following procedure describes how to search for Cisco Unified CallManager CTI lines to monitor by using CTI Search in the CTI category.
Note
You can also search for Cisco Unified CallManager CTI lines by using the menu bar at the top of the RTMT pane by choosing Search > CTI and then choosing the CTI application, device, or line for which you want to search from the drop-down menu. For more information on the RTMT Menu Bar, refer to Chapter 9, Real-Time Monitoring Tool, in the Cisco Unified CallManager Serviceability System Guide.
Tip
To choose CTI lines, double-click the name or right-click Lines. A double-click opens the Select Lines to Monitor window. A right-click displays the Monitor option, which must be chosen to display the Select Lines to Monitor window. In the following procedure, use either method to choose lines.
Procedure
Step 4
In the tree hierarchy list, choose Lines. The Select Lines to monitor window displays.
In the CTI Manager & Status field, choose the CTI manager that you want to monitor in the drop-down list box. In the Lines Status field, choose the status. In the Devices box, choose one of the following radio buttons:

Any name/address Device Name (for example, SEP123*)
12-34
OL-10643-01
Chapter 12
Note
If you chose the Device Name radio button, enter the device name in the field.
Step 8
In the Lines box, choose one of the following radio buttons:

Any name/address Directory Number (for example, 200*)
Note
If you chose the Directory Number radio button, enter the directory number in the field.
Step 9 Step 10
Click Next. In the Application Pattern box, choose one of the following radio buttons:

Any name/address App Id (for example, TSP*) IP Address (for example, 172.20.12*) IP Subnet UserId (for example, jsmith*)
Step 11 Step 12
Enter the information in the field for the radio button that you chose; for example, if you chose IP Subnet, enter the IP address and subnet mask in the field. Click Next. A window with the monitoring attributes fields displays.
Step 13 Step 14
Check the check box for the attributes of the lines that you want to monitor. Click Finish. The lines monitoring pane displays the information that you chose.
Related Topics

12-35
Chapter 12 Understanding Performance Monitoring
Understanding Performance Monitoring

You can monitor the performance of Cisco Unified CallManager by choosing the counters for any object. The counters for each object display when the folder is expanded. See the following sections for perfmon monitoring procedures:

Adding a Counter to Monitor by Using the Perfmon Category, page 12-36 Configuring Alert Notification for a Counter, page 12-39 Zooming a Counter, page 12-43 Displaying a Property Description, page 12-44 Configuring a Data Sample, page 12-45 Viewing Counter Data, page 12-46 Removing a Counter from Monitor, page 12-47
Related Topics

Microsoft Performance, page 23-1 Chapter 2, Performance Objects and Counters, Cisco Unified CallManager Serviceability System Guide Appendix A, Cisco Unified CallManager Performance Counters, RTMT, and CISCO-CCM-MIB, Cisco Unified CallManager Serviceability System Guide
Adding a Counter to Monitor by Using the Perfmon Category

To troubleshoot system performance problems, you can add the counter that is associated with the perfmon object to the RTMT Perfmon Monitoring pane, which displays a chart for the counter. Category tabs contain up to six performance counter charts.
Before You Begin
Perform the steps in the Loading Real-Time Monitoring section on page 12-2 before beginning the following procedure. This section describes how to add a counter to the RTMT Perfmon Monitoring pane.
12-36
OL-10643-01
Chapter 12
Real-Time Monitoring Configuration Understanding Performance Monitoring
Note
To choose a counter, double-click the name, right-click the name, or drag the counter and drop it in the Perfmon Monitoring pane. A double-click displays the counter information in chart format in the RTMT Perfmon Monitoring pane. A right-click opens a menu and displays the Add option; choose Add to display the counter information in the RTMT Perfmon Monitoring pane. In the following procedure, use any method to choose a device.
Note
You can display up to three counters in one chart in the RTMT Perfmon Monitoring pane. To add three counters in one chart, click the counter and drag it to the RTMT Perfmon Monitoring pane. Repeat for each counter.
Procedure
In the left controlling center pane, click the View tab. Click Perfmon. In the left controlling center pane under Perfmon, click the Perfmon Monitoring icon. The Perfmon Monitoring window displays and shows a tree hierarchy with the Cisco Unified CallManager cluster name at the top.
Step 4
Click the name of the node on which you want to add a counter to monitor. The tree hierarchy expands and displays all the perfmon objects that the node comprises.
Step 5
Click the file icon next to the object name that lists the counters that you want to monitor. The object icon opens, and a list of counters displays. Choose the counter that you want to monitor. Right-click the counter name. Click Counter Monitoring. The counter chart displays in the RTMT Perfmon Monitoring pane.
12-37
To monitor the counter in table format, see the Removing a Counter from Monitor section on page 12-47.
Related Topics

Configuring Performance Counters in Table View/Chart View

The Real-Time Monitoring Tool displays perfmon counters in chart or table format. Chart format looks like a miniature screen of information. Up to six charts display in the RTMT Perfmon Monitoring pane for each category tab that you create. Because chart view is the default, you configure the perfmon counters to display in table format when you create a category. This section describes how to configure table format for the Perfmon Monitoring pane.
Procedure
In the left controlling center pane, click the View tab. Click Perfmon. In the left controlling center pane under Perfmon, click the Perfmon Monitoring icon. In the RTMT menu bar, choose Edit > New Tab. In the Enter tab name field, enter a name for the tab. To display the perfmon counters in table format, check the Present Data in Table View check box; otherwise, leave box unchecked for chart view. Click the OK button. A new tab with the name that you chose displays at the bottom of the RTMT pane.
12-38
OL-10643-01
Chapter 12
Step 8
Choose the object and perfmon object that you want to monitor. See Adding a Counter to Monitor by Using the Perfmon Category, page 12-36.
Related Topics

Configuring Alert Notification for a Counter

The following procedure describes how to configure alert notification for a counter.
Before You Begin
Before beginning the following procedure, perform the steps in the Adding a Counter to Monitor by Using the Perfmon Category section on page 12-36.
Procedure
Step 1 Step 2
From the counter chart or table, right-click the counter for which you want to configure the alert notification. Choose Alert/Threshold. The Alert Properties dialog box displays. Check the Enable Alert check box. In the Severity drop-down list, choose the severity level at which you want to be notified. In the Description box, enter a description of the alert. Click Next. The Alert Properties: Threshold & Duration dialog box displays.
Step 7
If you want the alert threshold to be over a certain value, check the Over check box.
12-39
Step 8
In the Over value field, enter a value. For example, enter a value that is the number of calls in progress.
Note
Use the Over check box in conjunction with the Frequency and Schedule configuration parameters.
Step 9 Step 10
If you want the alert threshold to be under a certain value, check the Under check box. In the Under value field, enter a value. For example, enter a value that is the number of calls in progress.
Note
Use the Under check box in conjunction with the Frequency and Schedule configuration parameters.
In the Value Calculated As information box, choose one of the following radio buttons:

Absolute Delta (curr - prev) Delta Percentage ((curr - prev)/prev)
See Table 12-2.

Step 11
If you want the alert notification only when the value is constantly below or over threshold for a desired number of seconds, choose the first radio button in the Duration information box and enter seconds after which you want the alert to be sent. If you want the alert notification to be sent immediately, choose the Trigger alert immediately radio button. Click Next. The Alert Properties: Frequency & Schedule dialog box displays. If you want the alert notification to be activated on every poll when the threshold is met, click the trigger alert on every poll radio button.
Step 12 Step 13
Step 14
12-40
OL-10643-01
Chapter 12
If the calls in progress continue to go over or under the threshold, the system does not send another alert notification. When the threshold is normal (between 50 and 100 calls in progress), the system deactivates the alert notification. However, if the threshold should go over or under the threshold value again, the system reactivates alert notification.
Step 15
If you want the alert notification to be activated at certain intervals, choose the second radio button and enter the number of alerts that you want sent and the number of minutes within which you want them sent. If you want the alert to be triggered 24 hours a day, choose the 24-hours daily radio button. If you want the alert notification activated within a specific time frame, choose the second radio button and enter a start time and a stop time. Click Next. The Alert Properties: Email Notification dialog box displays.
Step 19 Step 20
If you want an e-mail message to be sent for the alert, check the Enable Email check box. If you want to trigger an alert action that is already configured, choose the alert action that you want from the drop-down list in the Trigger Alert Action information box. If you want to configure a new alert action for the alert, click Configure.
Step 21
Note
Whenever the specified alert is triggered, the system sends the alert action.
The Alert Action dialog box displays.

Step 22
To add a new alert action, click Add. The Action Configuration dialog box displays. In the Name field, enter a name for the alert action. In the Description field, enter a description for the alert action. To add a new e-mail recipient for the alert action, click Add. The Input dialog box displays. Enter either the e-mail or e-page address of the recipient that you want to receive the alert action notification.
Step 26
OL-10643-01
12-41
Step 27
Click OK. The recipient address displays in the Recipient list. The Enable check box gets checked.
Step 28
To disable the recipient address, uncheck the Enable check box.
Note
To delete a recipient address from the Recipient list, highlight the address and click Delete. This removes the recipient address.
Step 29 Step 30
Click OK. The alert action that you added displays in Action List.
Note
To delete an alert action from the action list, highlight the alert action and click Delete. You can also edit an existing alert action by clicking Edit.
Click Close.
Step 31 Step 32
In the User-defined email text box, enter the text that you want to appear in the e-mail message. Click Activate.
Note
If you want to change any alert configuration information, click the < Back button or the Cancel button.
Table 12-3 provides a description of the counter alert configuration parameters.
Related Topics

12-42
OL-10643-01
Chapter 12
Real-Time Monitoring Configuration Understanding Counter Properties
Zooming a Counter
To get a closer look at perfmon counters, zoom the perfmon monitor counter in the RTMT Perfmon Monitoring pane.
Before You Begin
Before beginning the following procedure, perform the steps in the Adding a Counter to Monitor by Using the Perfmon Category section on page 12-36. This section describes how to zoom the monitoring information for a counter.
Procedure
Step 1 Step 2
In the RTMT performance monitoring pane, right-click the counter for which you want to zoom. Choose Zoom. The Zoom window displays. The minimum, maximum, average, and last fields show the values for the counter since the monitoring began for the counter. To close the window, click the OK button.
Step 3 Step 4
Related Topics

Understanding Counter Properties

Counter properties provides two capabilities: display a description of the counter and configure data sampling parameters. See the following procedures to display counter descriptions, to configure data samples, and to view counter data:
Displaying a Property Description, page 12-44

OL-10643-01
12-43
Chapter 12 Understanding Counter Properties
Configuring a Data Sample, page 12-45 Viewing Counter Data, page 12-46
Displaying a Property Description

Use one of two ways to obtain a description of the counter:

In the Perfmon Monitoring pane, right-click the counter to display only the description of the counter. In the RTMT Perfmon Monitoring pane, right-click the counter chart to display the description and to configure the data-sampling parameters.
Before You Begin
Before beginning the following procedure, perform the steps in the Adding a Counter to Monitor by Using the Perfmon Category section on page 12-36. The following procedure describes how to display the counter property description.
Procedure
Step 1 Step 2
In the RTMT Perfmon Monitoring pane, right-click the counter for which you want property information. Choose Counter Description. The Counter Property window displays the description of the counter. The description includes the host address, the object to which the counter belongs, the counter name, and a brief overview of what the counter does.
Step 3
To close the Counter Property window, click the OK button.
Related Topics

12-44
OL-10643-01
Chapter 12
Configuring a Data Sample

The Counter Property window contains the option to configure data samples for a counter. The perfmon counters that display in the RTMT Perfmon Monitoring pane contain green dots that represent samples of data over time. You can configure the number of data samples to collect and the number of data points to show in the chart. After the data sample is configured, view the information by using the View All Data/View Current Data menu selection. See the Viewing Counter Data section on page 12-46.
Before You Begin
Before beginning the following procedure, perform the steps in the Adding a Counter to Monitor by Using the Perfmon Category section on page 12-36. This section describes how to configure the number of data samples to collect for a counter.
Procedure
Step 1 Step 2
In the RTMT Perfmon Monitoring pane, right-click the counter chart for the counter for which you want data sample information. Choose Monitoring Properties. The Counter Property window displays the description of the counter, as well as the tab for configuring data samples. The description includes the host address, the object to which the counter belongs, the counter name, and a brief overview of what the counter does.
Note
You can also display the Counter Property window by right-clicking the counter chart and clicking Perfmon > Monitoring Properties in the RTMT menu bar.
To configure the number of data samples for the counter, click the Data Sample tab. Click the down arrow on the No. of data samples drop-down menu. Choose the number of samples (between 100 and 1000). The default specifies 100. Click the down arrow on the No. of data points shown on chart drop-down menu.
12-45
Chapter 12 Understanding Counter Properties
Step 7 Step 8
Choose the number of data points to show on the chart (between 10 and 50). The default specifies 20. Click one parameter as described in Table 12-2.
Table 12-2 Data Sample Parameters
Parameter Absolute
Description Because some counter values are accumulative (for example, CallsAttempted or CallsCompleted), choose Absolute to display the data at its current status. Choose Delta to display the difference between the current counter value and the previous counter value. Choose % Delta to display the counter performance changes in percentage.
Delta % Delta
Step 9
To close the Counter Property window and return to the RTMT Perfmon Monitoring pane, click the OK button.
Related Topics

Viewing Counter Data

Use this view data for a monitor option to view the data that is collected for a performance counter. See the Understanding Counter Properties section on page 12-43 for a description of data sample configuration.
Before You Begin
Before beginning the following procedure, perform the steps in the Adding a Counter to Monitor by Using the Perfmon Category section on page 12-36. This section describes how to view all and current data for a performance counter.
12-46
OL-10643-01
Chapter 12
Procedure
Step 1 Step 2
In the RTMT Perfmon Monitoring pane, right-click the counter chart for the counter for which you want to view data samples. Choose View All Data. The counter chart displays all data that has been sampled. The green dots appear very close together, almost forming a solid line.
Step 3 Step 4
Right-click the counter that is currently displayed. Choose View Current. The counter chart displays the last configured data samples that were collected. See the Configuring a Data Sample section on page 12-45 procedure for configuring data samples.
Related Topics

Removing a Counter from Monitor

You can remove counters from the RTMT Perfmon Monitoring pane when they are no longer needed. This section describes how to remove a counter from the window.
Procedure
Step 1 Step 2
In the RTMT Perfmon Monitoring pane, right-click the counter that you want to remove. Choose Remove. The counter no longer displays in the window.
12-47
Chapter 12 Understanding Alert Central in the Alert Tab
Related Topics

Understanding Alert Central in the Alert Tab

RTMT comprises two kinds of alerts: preconfigured and user defined. You can configure both kinds of alerts, but you cannot delete preconfigured alerts, whereas you can add and delete user-defined alerts. You can also disable both preconfigured and user-defined alerts in RTMT. For a complete list of preconfigured alerts, alert customization, and alert action fields in which you can configure alerts, refer to Chapter 9, Real-Time Monitoring Tool, in the Cisco Unified CallManager Serviceability System Guide. When an activated service goes from up to down, RTMT generates an alert. You can use Alert Central, in the Alert tab, to view the status and history of the alerts that RTMT generates. You can use the Alert menu (or context menu), in the RTMT menu bar at the top of the RTMT window, in conjunction with Alert Central, to perform the following tasks:
Access Alert CentralUsing this menu item, you can open the Alert Central monitoring window to view the status and history of RTMT alerts, as well as sort the alerts. See the Viewing and Sorting Alerts in Alert Central section on page 12-49. Set alert propertiesThis menu item allows you to set alert properties for alerts. See the Setting Alert Properties section on page 12-51. Remove an alertYou can remove user-defined alerts by using this menu item. See the Removing an Alert section on page 12-54. Enable an alertThis menu item allows you to enable an alert for a Cisco Unified CallManager node or for the entire cluster. See the Enabling an Alert section on page 12-56. Disable an alertThis menu item allows you to disable an alert for a Cisco Unified CallManager node or for the entire cluster. See the Disabling an Alert section on page 12-57.
12-48
OL-10643-01
Chapter 12
Real-Time Monitoring Configuration Understanding Alert Central in the Alert Tab
Suspend alertsUsing this menu item, you can temporarily suspend alerts on a Cisco Unified CallManager node or for the entire cluster. See the Suspending Alerts on Cisco Unified CallManager Nodes or the Cluster section on page 12-58. Clear an alertYou can use this menu item to clear (reset) an alert that has been resolved. See the Clearing Alerts section on page 12-60. Clear all alertsThis menu allows you to clear all alerts that have been resolved. See the Clearing Alerts section on page 12-60. View alert event detailsThis menu item allows you to view the details of an alert event. See the Viewing Alert Events Details section on page 12-61. Configure e-mails for alertsYou can use this menu item to configure e-mails for recipients that you want to receive notification about an alert. See the Configuring E-mails for Alert Notification section on page 12-62. Configure alert actionsWith this menu item, you can configure specific alert actions to be sent to e-mail recipients. See the Configuring Alert Actions section on page 12-63.
Viewing and Sorting Alerts in Alert Central

Using the Alert tab in RTMT, you can view the status of every alert that RTMT generates in the Cisco Unified CallManager cluster. The following procedure describes how to view alert status.
Before You Begin
Before beginning the following procedure, follow the steps in the Loading Real-Time Monitoring section on page 12-2.
Procedure
Step 1 Step 2
In the left controlling center pane, click the Alert tab. Click Alert Central. The Alert Central monitoring window displays and shows the alert status and alert history of the alerts that RTMT has generated in the Cisco Unified CallManager cluster. You can sort alert status in the Alert Status window.
OL-10643-01
12-49
To sort alert names alphabetically from A to Z in the Alert Status window, click the up/down arrow in the Alert Name column. To sort alert names from Z to A in the Alert Status window, click the up/down arrow in the Alert Name column. To sort according to enabled/disabled status in the Alert Status window, click the up/down arrow in the Enabled column. To sort by whether the alert is in safe range in the Alert Status window, click the up/down arrow in the InSafeRange column. To sort by whether alert action is default or user defined in the Alert Status window, click the up/down arrow in the AlertAction column. To sort by time of alert occurrence in the Alert Status window, click the up/down arrow in the Last Alert Raised column. You can also sort alert history in the Alert History window. To sort by time stamp of an alert in the Alert History window, click the up/down arrow in the Time Stamp column. To sort by node name in the Alert History window, click the up/down arrow in the Node column. To sort alert names from A to Z in the Alert History window, click the up/down arrow in the AlertName column. To sort by alert severity in the Alert History window, click the up/down arrow in the Severity column. To sort by e-mail recipient in the Alert History window, click the up/down arrow in the SentTo column. To sort by alert description in the Alert History window, click the up/down arrow in the Description column.
Note
To see alert history that is out of view in the window, you can use the scroll bar on the right side of the Alert History window.
Related Topics
Understanding Alert Central in the Alert Tab, page 12-48
12-50
OL-10643-01
Chapter 12
Setting Alert Properties, page 12-51 Counter Alert Configuration Settings, page 12-64 Chapter 9, Real-Time Monitoring Tool, Cisco Unified CallManager Serviceability System Guide
Setting Alert Properties

The following procedure describes how to set alert properties.
Procedure
Step 1 Step 2
In the left controlling center pane, Click the Alert tab. Click Alert Central. The Alert Central monitoring window displays and shows the alert status and alert history of the alerts that RTMT has generated in the Cisco Unified CallManager cluster.
Step 3 Step 4
From the Alert Status window, highlight the alert for which you want to set alert properties. Right-click the alert name and choose Set Alert/Properties.
Note
You can also open the Set Alert/Properties window by highlighting the alert and choosing Alert > Set Alert/Properties in the RTMT menu bar at the top of the RTMT window.
The Alert Properties window displays.
Note
For Cisco Unified CallManager clusterwide alerts, the Enable/Disable this alert on following server(s): box does not show up in the alert properties window. The following list names clusterwide alerts: number of registered phones, gateways, media devices, route list exhausted, media list exhausted, MGCP D-channel out of service, malicious call trace, and excessive quality reports.
12-51
To enable the alert, check the Enable Alert check box. From the Severity drop-down list, choose the severity of the alert. From the Enable/Disable this alert on following server(s) box, check the Enable check box of the servers on which you want this alert to be enabled. If this is a preconfigured alert, the Description information box displays a description of the alert.
Step 8
Click Next. The Alert Properties: Threshold & Duration window displays.
Step 9 Step 10
In the Threshold information box, enter the conditions in which the alert will be triggered. In the Duration information box, if you want the alert to be triggered only when the value is constantly below or over the threshold for a specific number of seconds, choose the first radio button and enter the seconds. If you want the alert to be triggered immediately, choose the second radio button. Click Next. In the Frequency information box, if you want the alert to be triggered on every poll, choose the first radio button. If you want a specific number of alerts to be triggered within a specific number of minutes, choose the second radio button and enter the information. In the Schedule information box, if you want the alert to be triggered 24 hours a day, choose the first radio button. If you want the alert to be triggered within a specific start and stop time, choose the second radio button and enter the start and stop times. Click Next. The Alert Properties: Email Notification window displays.
If you want to enable e-mail for this alert, check the Enable Email check box. To trigger an alert action with this alert, from the drop-down list, choose the alert action that you want to send. If you want to configure a new alert action, or edit an existing one, click Configure. The Alert Action window displays.
12-52
OL-10643-01
Chapter 12
Step 21
To add a new alert action, click Add. The Action Configuration window displays.
In the Name field, enter a name for the alert action. In the Description field, enter a description of the alert action. To add an e-mail recipient, click Add. The Input window displays. In the Enter email/epage address field, enter an e-mail or e-page address of the recipient that you want to receive the alert action.
Step 25
Click OK. The Action Configuration window displays again and shows the recipient(s) that you added, and the Enable check box is checked. The recipient that you chose disappears from the recipient list.
Step 26
When you finish adding all the recipients, click OK. The new action displays in the Action List. The Action Configuration window of the alert action that you chose displays. Make the desired changes and click OK. When you finish making all the desired changes, click Close. The Alert Properties: Email Notification window displays again. Click Activate.
Step 27 Step 28
Step 29
Note
To delete an alert action, highlight the action, click Delete, and click Close.
12-53
Related Topics

Understanding Alert Central in the Alert Tab, page 12-48 Viewing and Sorting Alerts in Alert Central, page 12-49 Removing an Alert, page 12-54 Enabling an Alert, page 12-56 Disabling an Alert, page 12-57 Suspending Alerts on Cisco Unified CallManager Nodes or the Cluster, page 12-58 Clearing Alerts, page 12-60 Viewing Alert Events Details, page 12-61 Configuring E-mails for Alert Notification, page 12-62 Configuring Alert Actions, page 12-63 Counter Alert Configuration Settings, page 12-64 Chapter 9, Real-Time Monitoring Tool, Cisco Unified CallManager Serviceability System Guide
Removing an Alert
The following procedure describes how to remove an alert from the Alert Central pane.
Note
You can only remove user-defined alerts from Alert Central.

Procedure
Step 1 Step 2
In the left controlling center pane, click the Alert tab. Click Alert Central. The Alert Central monitoring window displays and shows the alert status and alert history of the alerts that RTMT generated in the Cisco Unified CallManager cluster.
Step 3
From the Alert Status window, highlight the alert that you want to remove.
12-54
OL-10643-01
Chapter 12
Step 4
Right-click the alert name and choose Remove Alert.
Note
You can also remove an alert by highlighting the alert and choosing Alert > Remove Alert in the RTMT menu bar at the top of the RTMT window.
The alert that you chose disappears from Alert Status in the Alert Central pane.
Related Topics

Understanding Alert Central in the Alert Tab, page 12-48 Viewing and Sorting Alerts in Alert Central, page 12-49 Setting Alert Properties, page 12-51 Enabling an Alert, page 12-56 Disabling an Alert, page 12-57 Suspending Alerts on Cisco Unified CallManager Nodes or the Cluster, page 12-58 Clearing Alerts, page 12-60 Viewing Alert Events Details, page 12-61 Configuring E-mails for Alert Notification, page 12-62 Configuring Alert Actions, page 12-63 Counter Alert Configuration Settings, page 12-64 Chapter 9, Real-Time Monitoring Tool, Cisco Unified CallManager Serviceability System Guide
12-55
Enabling an Alert
The following procedure describes how to enable an alert in Alert Central.
Procedure
Step 1 Step 2
Step 3 Step 4
From the Alert Status window, highlight the alert that you want to enable. Right-click the alert name and choose Enable Alert.
Note
You can also remove an alert by highlighting the alert and choosing Alert > Enable Alert in the RTMT menu bar at the top of the RTMT window.
The alert that you chose shows Enabled in the Enabled column in the Alert Status window.
Related Topics

Understanding Alert Central in the Alert Tab, page 12-48 Viewing and Sorting Alerts in Alert Central, page 12-49 Setting Alert Properties, page 12-51 Removing an Alert, page 12-54 Disabling an Alert, page 12-57 Suspending Alerts on Cisco Unified CallManager Nodes or the Cluster, page 12-58 Clearing Alerts, page 12-60 Viewing Alert Events Details, page 12-61
12-56
OL-10643-01
Chapter 12
Configuring E-mails for Alert Notification, page 12-62 Configuring Alert Actions, page 12-63 Counter Alert Configuration Settings, page 12-64 Chapter 9, Real-Time Monitoring Tool, Cisco Unified CallManager Serviceability System Guide
Disabling an Alert
The following procedure describes how to disable an alert in Alert Central.
Procedure
Step 1 Step 2
Step 3 Step 4
From the Alert Status window, highlight the alert that you want to disable. Right-click the alert name and choose Disable Alert.
Note
You can also remove an alert by highlighting the alert and choosing Alert > Disable Alert in the RTMT menu bar at the top of the RTMT window.
The alert that you chose shows Disabled in the Disabled column in the Alert Status window.
Related Topics

Understanding Alert Central in the Alert Tab, page 12-48 Viewing and Sorting Alerts in Alert Central, page 12-49 Setting Alert Properties, page 12-51
12-57
Removing an Alert, page 12-54 Enabling an Alert, page 12-56 Suspending Alerts on Cisco Unified CallManager Nodes or the Cluster, page 12-58 Clearing Alerts, page 12-60 Viewing Alert Events Details, page 12-61 Configuring E-mails for Alert Notification, page 12-62 Configuring Alert Actions, page 12-63 Counter Alert Configuration Settings, page 12-64 Chapter 9, Real-Time Monitoring Tool, Cisco Unified CallManager Serviceability System Guide
Suspending Alerts on Cisco Unified CallManager Nodes or the Cluster

You may want to temporarily suspend some or all alerts, either on a particular Cisco Unified CallManager node or the entire cluster. For example, if you are upgrading the Cisco Unified CallManager to a newer release, you would probably want to suspend all alerts until the upgrade completes, so you do not receive e-mails and/or e-pages during the upgrade. The following procedure describes how to suspend alerts in Alert Central.
Procedure
Step 1 Step 2
Step 3
From the RTMT menu bar at the top of the window, choose Alert > Suspend cluster/node Alerts. The Suspend/Resume Alert window displays.
12-58
OL-10643-01
Chapter 12
Note
Per server suspend states do not apply to Cisco Unified CallManager clusterwide alerts.
To suspend all alerts in the cluster, choose the Cluster Wide radio button and check the suspend all alerts check box. To suspend alerts per server, choose the Per Server radio button and check the Suspend check box of each server on which you want alerts suspended. Click OK.
Note
To resume alerts, choose Alert > Suspend cluster/node Alerts again and uncheck the suspend check boxes.
Related Topics

Understanding Alert Central in the Alert Tab, page 12-48 Viewing and Sorting Alerts in Alert Central, page 12-49 Setting Alert Properties, page 12-51 Removing an Alert, page 12-54 Disabling an Alert, page 12-57 Clearing Alerts, page 12-60 Viewing Alert Events Details, page 12-61 Configuring E-mails for Alert Notification, page 12-62 Configuring Alert Actions, page 12-63 Counter Alert Configuration Settings, page 12-64 Chapter 9, Real-Time Monitoring Tool, Cisco Unified CallManager Serviceability System Guide
12-59
Clearing Alerts
The following procedure describes how to clear both individual and collective alerts after they get resolved.
Procedure
Step 1 Step 2
Step 3 Step 4
To clear (reset) an individual alert after the alert has been resolved, from the Alert Status window, highlight the alert that you want to clear. From the Alert drop-down menu, choose Clear Alert. The alert changes from red to black. To clear (reset) all alerts, from the Alert drop-down menu, choose Clear All Alerts. All alerts change from red to black.
Step 5
Related Topics

Understanding Alert Central in the Alert Tab, page 12-48 Viewing and Sorting Alerts in Alert Central, page 12-49 Setting Alert Properties, page 12-51 Removing an Alert, page 12-54 Enabling an Alert, page 12-56 Disabling an Alert, page 12-57 Suspending Alerts on Cisco Unified CallManager Nodes or the Cluster, page 12-58 Viewing Alert Events Details, page 12-61 Configuring E-mails for Alert Notification, page 12-62
12-60
OL-10643-01
Chapter 12
Configuring Alert Actions, page 12-63
Viewing Alert Events Details

The following procedure describes how to view alert events details.
Procedure
Step 1 Step 2
In the left controlling center pane, Click the Alert tab. Click Alert Central. The Alert Central monitoring window displays and shows the alert status and alert history of the alerts that RTMT generated in the Cisco Unified CallManager cluster.
Step 3 Step 4
From the Alert Status window, highlight the alert for which you want alert details. Right-click the alert name and choose Alert Detail.
Note
You can also remove an alert by highlighting the alert and choosing Alert > Alert Events Detail in the RTMT menu bar at the top of the RTMT window.
The Alert Detail window displays.

Step 5
When you finish viewing the alert details, click OK.
Related Topics

Understanding Alert Central in the Alert Tab, page 12-48 Viewing and Sorting Alerts in Alert Central, page 12-49 Setting Alert Properties, page 12-51 Removing an Alert, page 12-54 Enabling an Alert, page 12-56 Disabling an Alert, page 12-57
12-61
Suspending Alerts on Cisco Unified CallManager Nodes or the Cluster, page 12-58 Clearing Alerts, page 12-60 Configuring E-mails for Alert Notification, page 12-62 Counter Alert Configuration Settings, page 12-64 Chapter 9, Real-Time Monitoring Tool, Cisco Unified CallManager Serviceability System Guide
Configuring E-mails for Alert Notification

The following procedure describes how to configure e-mails for alert notification.
Procedure
Step 1 Step 2
Step 3
From the RTMT menu bar at the top of the pane, choose Alert > Config Email Server. The Mail Server Configuration window displays.
In the Mail Server field, enter the e-mail recipient information. In the Port field, enter the port number of the recipient. Click OK.
Related Topics

Understanding Alert Central in the Alert Tab, page 12-48 Viewing and Sorting Alerts in Alert Central, page 12-49 Setting Alert Properties, page 12-51 Removing an Alert, page 12-54
12-62
OL-10643-01
Chapter 12
Enabling an Alert, page 12-56 Disabling an Alert, page 12-57 Suspending Alerts on Cisco Unified CallManager Nodes or the Cluster, page 12-58 Clearing Alerts, page 12-60 Viewing Alert Events Details, page 12-61 Configuring E-mails for Alert Notification, page 12-62 Counter Alert Configuration Settings, page 12-64 Chapter 9, Real-Time Monitoring Tool, Cisco Unified CallManager Serviceability System Guide
Configuring Alert Actions

The following procedure describes how to configure new alert actions.
Procedure
Step 1 Step 2
Step 3
From the RTMT menu bar at the top of the pane, choose Alert > Config Alert Action. The Alert Action window displays.
Step 4
Follow the procedure in Step 21 through Step 29 in the Setting Alert Properties section on page 12-51 to add, edit, or delete alert actions.
Related Topics

Understanding Alert Central in the Alert Tab, page 12-48 Viewing and Sorting Alerts in Alert Central, page 12-49
OL-10643-01
12-63
Chapter 12 Counter Alert Configuration Settings
Setting Alert Properties, page 12-51 Removing an Alert, page 12-54 Enabling an Alert, page 12-56 Disabling an Alert, page 12-57 Suspending Alerts on Cisco Unified CallManager Nodes or the Cluster, page 12-58 Clearing Alerts, page 12-60 Viewing Alert Events Details, page 12-61 Configuring E-mails for Alert Notification, page 12-62 Counter Alert Configuration Settings, page 12-64 Chapter 9, Real-Time Monitoring Tool, Cisco Unified CallManager Serviceability System Guide
Counter Alert Configuration Settings

Table 12-3 describes the counter alert configuration parameters.
Table 12-3 Counter Alert Configuration Parameters
Parameter Over
Description Check this check box to configure a maximum threshold that must be met before an alert notification is activated. The value that is entered in this check box field associates with the counter type (for example, Calls in progress). Check this check box to configure a minimum threshold that must be met before an alert notification is activated. The value that is entered in this check box field associates with the counter type (for example, Calls in progress).
Under
12-64
OL-10643-01
Chapter 12
Real-Time Monitoring Configuration Counter Alert Configuration Settings
Table 12-3 Counter Alert Configuration Parameters (continued)
Parameter Frequency
Description Choosing the Once option configures the alert notification to activate once when either the under or over counter threshold is exceeded. Choosing the Every option configures the system to check the value of the counter threshold at specific intervals and to determine whether an alert notification should activate. The Every option values range from 1 to 99 seconds, minutes, or hours.
Daily Task
Check the Daily Task check box if the system is to check the value of the counter threshold every day. If the check box is checked, enter the start and stop times of the daily task. For example, you can configure the counter to be checked every day from 9:00 am to 5:00 pm or from 5:00 pm to 9:00 am. Click the At radio button in the start time to configure a time for the system to start checking the counter threshold. If the Daily Task check box is not checked, enter a date in the date field. Choose the At radio button in the stop time to configure a time for the system to stop checking the counter threshold. If the Daily Task check box is not checked, enter a date in the date field.
Start time
Stop time
12-65
Chapter 12 Counter Alert Configuration Settings
12-66
OL-10643-01
C H A P T E R
13
QRT Viewer
This chapter describes how to use the QRT Viewer that is part of the Tools menu. See Listing IP Phone Problem Reports for instructions on how to generate a list of IP phone problem reports. You can view the IP phone problem reports, that are generated by the Quality Report Tool (QRT), by using the QRT Viewer. QRT serves as a voice-quality and general problem-reporting tool for Cisco Unified IP Phones. The Cisco Extended Functions service supports the QRT feature. For additional information about the Quality Report Tool, refer to the Quality Report Tool section on page 10-1 in the Cisco Unified CallManager Serviceability System Guide. For detailed information about how to configure and use QRT, refer to the Cisco Unified CallManager Features and Services Guide. See the Cisco Unified CallManager Services section on page 3-1 for more information about the Cisco Extended Functions service. The QRT Viewer allows you to filter, format, and view phone problem reports that are generated. QRT uses the Cisco Extended Functions NT service, so it shares the same architecture as Cisco Call Back. It also shares the same system requirements, redundancy, dependencies, restrictions, installation, and activation as Cisco Call Back.
13-1
Chapter 13 Listing IP Phone Problem Reports
QRT Viewer
Listing IP Phone Problem Reports

This section describes how to list and view Cisco Unified IP Phone problem reports by using the QRT Viewer.
Note
Quality Report Tool (QRT) collects streaming data only once per call. Therefore, if A calls B and both submit multiple reports for that same call, only the first report includes streaming data.
Procedure
Step 1
Step 2
Choose Tools > QRT Viewer. The IP Phone Problem Reporting window displays.
Step 3
Choose the available Cisco Unified CallManager server for which you want to view a problem report.
Note
Because CEF service activation is configurable, the user may have changed the server.
Enter the From: date in the Date: box; for example, 2/2/2002. Enter the To: date in the Date: box; for example 2/3/2002. In the From Time: selection box, click the down arrow for the beginning hour, minute, and second of the problem reporting information that you want to collect; for example, 3 hour, 45 minute, 0 second. In the To Time: selection box, click the down arrow for the ending hour, minute, and second of the problem reporting information that you want to collect; for example, 23 hour, 59 minute, 59 second. Click Get Logs.
Step 7
Step 8
13-2
OL-10643-01
Chapter 13
QRT Viewer Listing IP Phone Problem Reports
The system collects all the phone problem reports that are available within the chosen time frame on the chosen server. The IP Phone Problem Reporting format window displays.
From the Extension Number drop-down menu, choose the extension number(s) that you want included in the report. From the Device drop-down menu, choose the device(s) that you want included in the report. From the Category drop-down menu, choose the problem category that you want included in the report. From the List of Fields box, choose the fields that you want included in the report and click the down arrow to place them in the Selected Fields box.
Note
The order in which you choose the fields determines the order in which they appear in the report.
Step 13
Click Display Records to view the report in your browser.
Note
You can save the report in CSV format or view it by using Excel or a similar application by either clicking View CSV, or Right Click here to Save in CSV.
13-3
Chapter 13 Listing IP Phone Problem Reports
QRT Viewer
Related Topics

Quality Report Tool, page 10-1, Cisco Unified CallManager Serviceability System Guide Cisco Unified CallManager Services, page 3-1, Cisco Unified CallManager Serviceability System Guide Cisco Unified CallManager Features and Services Guide
13-4
OL-10643-01
C H A P T E R
14
Serviceability Reports Archive Configuration

This chapter describes how to use the Serviceability Reports Archive option under the Tools menu.
Procedure
Step 1
Step 2
Choose Tools > Serviceability Reports Archive. The Serviceability Reports Archive window displays. From the RTMT Reports pane, choose the month for which you want to display reports. The month and year that you chose displays. To view reports, click the link that corresponds to the day for which RTMT generated reports. The report files for the day that you chose display.
Step 3
Step 4
Step 5
To view a particular PDF report, click the link of the report that you want to view. A window opens and displays the PDF file of the report that you chose.
14-1
Chapter 14
Serviceability Reports Archive Configuration
Related Topics

Real-Time Monitoring Configuration, page 12-1 Chapter 9, Real-Time Monitoring Tool, Cisco Unified CallManager Serviceability System Guide Chapter 11, Serviceability Reports Archive, Cisco Unified CallManager Serviceability System Guide
14-2
OL-10643-01
A R T
Reporting Tools Configuration
C H A P T E R
15
CDR Analysis and Reporting

The Cisco Unified CallManager CDR Analysis and Reporting (CAR) tool generates reports of information for quality of service, traffic, user call volume, billing, and gateways.
Note
CAR does not handle iDivert calls (feature to divert calls to voicemessaging system) and treats them as normal calls. The part of the call after iDivert feature gets activated may not get charged to the correct party.
This chapter contains the following topics:

Installing the CAR Plug-in, page 15-2 Uninstalling the CAR Plug-in, page 15-3 Configuring CDR Service Parameters, page 15-4 Accessing the Initial User ID and Password, page 15-5 Loading CAR, page 15-5 Logging On to CAR, page 15-7 Logging Out of CAR, page 15-8 Viewing About CAR, page 15-8
Note
You can view CAR reports in either PDF or CSV format. PDF format limits the number of records in the CAR reports to 5000, and CSV format limits the records to 20,000. If the number of records exceeds these limits, a message displays to
OL-10643-01
15-1
Chapter 15 Installing the CAR Plug-in
inform you that the results are truncated. To avoid this, you can reduce the date range and generate the reports, or, if you are using PDF format, you can use CSV format instead.
Installing the CAR Plug-in

This section describes how to install the Cisco Unified CallManager CDR Analysis and Reporting (CAR) plug-in with Cisco CallManager Release 3.2 and above. For more information about upgrading Cisco Unified CallManager, refer to the latest version of the Upgrading Cisco Unified CallManager document.
Note
If you have Cisco Unified CallManager CDR Analysis and Reporting (CAR), formerly known as Administrative Reporting Tool (ART), running on your system before upgrading to a new version of Cisco Unified CallManager, the upgrade process automatically upgrades CAR. If you are installing Cisco Unified CallManager for the first time or if you are upgrading and do not already have CAR running in the system, you must install CAR from the Install Plugins window. During the CAR installation, the following message may display:
Password phrase is not correct. Click OK to re-enter the Private Password phrase. Click Cancel to go ahead with install, but CAR Scheduler service will not start.
If this message displays, run the Admin Utility to reset the Private Password phrase. To obtain the Admin Utility, navigate to C:\Program Files\Cisco\Bin on the publisher database server. Before you use the utility, review the readme documentation that is available in the same directory as the utility.
Procedure
Step 1
Open Cisco Unified CallManager Administration by choosing Start > Programs > Cisco Unified CallManager > CallManager Administration and log in with administrative privileges. Choose Applications > Cisco Unified CallManager Serviceability.
Step 2
15-2
OL-10643-01
Chapter 15
CDR Analysis and Reporting Uninstalling the CAR Plug-in
In Cisco Unified CallManager Serviceability, choose Applications > Install Plugins. Click the icon next to the Cisco Unified CallManager CDR Analysis and Reporting (CAR) plug-in. Choose whether you want to run the program from its current location or to save the program to disk.
Note Step 6
Install CAR only on the publisher database server.
Click OK.
Tip
CAR uses the Cisco Tomcat service that is installed by Cisco Unified CallManager, so ensure that the Cisco Tomcat service is running. While installing/uninstalling CAR, you cannot access other applications that use the Cisco Tomcat service because the CAR installation/uninstallation temporarily stops this service.
Related Topic
Uninstalling the CAR Plug-in, page 15-3
Uninstalling the CAR Plug-in

You can uninstall CAR from the Add/Remove programs application in your Control Panel. This section describes how to uninstall CAR.
Procedure
Step 1
From the Start menu, choose Settings > Control Panel. The Control Panel window displays.
Step 2
Double-click the Add/Remove Programs icon. The Add/Remove Programs window displays.
15-3
Chapter 15 Configuring CDR Service Parameters
Step 3
Scroll down until you locate the CDR Analysis and Reporting tool and click Change/Remove.
Related Topics

Installing the CAR Plug-in, page 15-2 Chapter 10, Quality Report Tool, Cisco CallManager System Guide
Configuring CDR Service Parameters

CAR requires that CDR records be available in the CDR database of the primary CDR server. To ensure that CAR functions properly, change the default values for CDR service parameters.
Note
Because the default values for the service parameters CDREnabled and CallDiagnosticsEnabled are disabled, you must enable these service parameters to make CDR records available to CAR. To write the CDR records to a CDR database, configure the service parameters as described in Table 15-1.
Table 15-1 CDR Service Parameters
Parameter Name LocalCDRPath Primary CDRUNCPath CDRFormat PrimaryCDRDSN CDREnabled CallDiagnosticsEnabled
Parameter Value Include a valid pathname. Include a valid pathname. Enter the value Database. Specifies a directory service number that points to the primary CDR server. Enable this service. Enable this service.
15-4
OL-10643-01
Chapter 15
CDR Analysis and Reporting Accessing the Initial User ID and Password
Accessing the Initial User ID and Password

Only CAR administrators have administrative privileges on CAR. Individual users can log on to CAR by using the user ID and password that they use to access Cisco Unified CallManager Administration; however, only a CAR administrator can grant administrative privileges. The initial logon to CAR requires the use of a specific user ID and password.
Note
To grant administrative privileges to users, you must first log on to CAR by using admin as the initial user name and password. Log on to CAR by using this user name and password to grant CAR administrator rights to user(s) for the first time. This user ID and password will only work when no CAR administrators are configured in the system. After one or more users is granted administrator rights, this initial logon (admin, admin) is disabled. At this point, only CAR administrators (users who have been granted administrator rights initially by using admin, admin,) can grant CAR administrator rights to other users. See the Granting Administrator Rights section on page 16-2, for information on how to grant users administrative privileges.
Loading CAR
Administrators access CAR from the Tools menu in Cisco Unified CallManager Serviceability. When the CAR main menu displays, you must log in to CAR. The user profile in Cisco Unified CallManager Administration determines the user ID and password for CAR. See the Accessing the Initial User ID and Password section on page 15-5. CAR supports three types of users: system administrators, individuals, and managers. Permission levels provide the basis for access to CAR reports:

Individual users can view or generate bills pertaining to their own phone calls. Managers can view reports and bills pertaining to all users within their group. CAR system administrators can use all the features.
15-5
Chapter 15 Loading CAR
Administrator Procedure
This section describes how administrators load CAR. Cisco Unified CallManager Serviceability lists CAR under the Tools menu item.
Procedure
Step 1
Step 2
Choose Tools > CDR Analysis and Reporting. The tool displays.
Note
You must provide managers and individual users with a web address that they can use to browse into CAR.
Step 3
Log on to CAR. See the Logging On to CAR section on page 15-7.
Related Topics

Accessing the Initial User ID and Password, page 15-5 Administrator and User Procedure, page 15-7 Logging On to CAR, page 15-7 Logging Out of CAR, page 15-8
15-6
OL-10643-01
Chapter 15
CDR Analysis and Reporting Logging On to CAR
Administrator and User Procedure

This section describes how administrators and users load CAR. Administrators can also load CAR from the Serviceability main window. See the Administrator Procedure section on page 15-6.
Procedure
Step 1 Step 2
From the web browser, enter https://<Server-ip/name>/art/Logon.jsp. Log on to CAR. See the Logging On to CAR section on page 15-7.
Related Topics

Accessing the Initial User ID and Password, page 15-5 Administrator Procedure, page 15-6 Logging On to CAR, page 15-7 Logging Out of CAR, page 15-8
Logging On to CAR
This section describes how to log on to CAR.
Procedure
Step 1 Step 2
In the CAR logon window, enter your user ID in the User Name field. In the Password field, enter your password. If the user ID or password are invalid, CAR displays the message, Invalid Logon. Either the User Name or Password entered is invalid. Click here to try again. Enter another user ID or password and click OK. The CAR window displays.
15-7
Chapter 15 Logging Out of CAR
Related Topics

Accessing the Initial User ID and Password, page 15-5 Loading CAR, page 15-5 Logging Out of CAR, page 15-8
Logging Out of CAR

This section describes how to log out of CAR.
Procedure
Step 1 Step 2
In the CAR window, choose Logout. You are prompted with the message For security reasons, it is advisable to close the browser window on Logout. Do you want to close the browser window? Choose whether you want to close the browser window. If you click OK, the CAR window (browser) closes; otherwise, the CAR Logon window displays.
Related Topics

Accessing the Initial User ID and Password, page 15-5 Loading CAR, page 15-5 Logging On to CAR, page 15-7
Viewing About CAR

This section describes how to view the About CAR information.
Procedure
Step 1 Step 2
From the CAR window, choose Help > About CAR. Click the Details button. The About window displays the following information:
15-8
OL-10643-01
Chapter 15
CDR Analysis and Reporting Viewing About CAR
Note
When reporting or troubleshooting a problem, give the following information to Technical Assistance. CDR Analysis and Reporting version: X.X (where Xs equal version numbers) Database Information
Driver:sun.jdbc.odbc.JdbcOdbcDriver Server:<server name> Name:art Version:X.X(X) (where Xs equal version numbers)
Third party software

Tomcat: X.X.X Apache (where Xs equal version numbers) JRE: X.X.X_XX Sun Microsystems (where Xs equal version numbers) StyleReport: X.X InetSoft Corp. (where Xs equal version numbers)
Step 3
To close the window, click the OK button.
15-9
Chapter 15 Viewing About CAR
15-10
OL-10643-01
C H A P T E R
16
CAR System Configuration

Before you start generating reports with CAR, configure the system. In most cases, CAR provides default values. However, review the topics provided in this chapter to learn more about customizing CAR. This chapter contains the following topics:

System Parameters Configuration, page 16-1 System Scheduler Configuration, page 16-11 Starting or Stopping the CAR Scheduler, page 16-24 System Database Configuration, page 16-25 System Log Screens, page 16-33 Understanding Log Reports, page 16-35
System Parameters Configuration

Unless you want to use the default values, you should customize a number of system parameters before you generate any reports. This section describes the system parameters. Because default values are provided for all system parameters, Cisco recommends customizing but does not require it.
16-1
Chapter 16 System Parameters Configuration
Any user can be a CAR administrator; however, you must specify each user designated as a CAR administrator in the Grant/Revoke CAR Admin Rights window. Users who have been identified as CAR administrators have full control over the CAR system. The administrator can modify all the parameters related to the system and the reports. CAR requires a minimum of one administrator.
Related Topics

Granting Administrator Rights, page 16-2 Revoking Administrator Rights, page 16-3
Granting Administrator Rights

This section describes how to grant CAR administrator rights to one or more users.
Note
To grant administrative privileges to users, you must first log onto CAR using admin as the initial user name and password. Log onto CAR using this user name and password to grant CAR administrator rights to user(s) for the first time. This user ID and password will only work when there are no CAR administrators configured in the system. Once one or more users have been granted administrator rights, this initial logon (admin, admin) will be disabled. At this point, only CAR administrators (users who have been granted administrator rights initially using admin, admin, can grant CAR administrator rights to other users.
Procedure
Step 1
In the CAR window, choose System > System Parameters > Admin Rights. The Grant/Revoke CAR Admin Rights window displays.
Step 2
In the User ID field, enter the user ID for the individual that you want to add as a CAR administrator. If you do not know the valid user ID, click the Search User(s) link. See Searching for Users, page 18-22, for instructions on searching for a user.
Step 3
Click the Add button.
16-2
OL-10643-01
Chapter 16
CAR System Configuration System Parameters Configuration
Cisco Unified CallManager copies the user specified in the User ID field to the list of CAR administrators.
Step 4
To designate the listed users as CAR administrators, click the Update button. Changes take effect immediately.
Related Topic
Revoking Administrator Rights, page 16-3
Revoking Administrator Rights

This section describes how to revoke CAR administrator rights for one or more users.
Procedure
Step 1
Choose System > System Parameters > Admin Rights. The Grant/Revoke CAR Admin Rights window displays.
Step 2 Step 3
In the CAR Administrators list box, choose the user ID for the individual that you want to remove as a CAR administrator. To remove the selected user(s), click the Remove button, or to remove all users specified in the CAR Administrators list box, click the Remove All button. Only those user(s) still listed in the CAR Administrators list box will continue to have CAR administrator rights.
Step 4
To remove the users, click the Update button. The CAR Administrators that you removed no longer have administrator access. Changes take effect immediately.
Related Topic
Granting Administrator Rights, page 16-2
16-3
Configuring Mail Server Parameters

To send e-mail alerts and reports by e-mail, you must specify the mail server configuration information. CAR uses the configuration information to successfully connect to the e-mail server. This section describes how to specify e-mail server information.
Procedure
Step 1
Choose System > System Parameters > Mail Parameters. The Mail Parameters window displays. In the Mail ID field, enter the e-mail identifier that will be used in the From field when e-mails are sent. In the Password field, enter the password used to access the server running the e-mail system.
Step 2 Step 3
Note
CAR does not authenticate the user ID and password. You must disable authentication on the mail server or enter a valid user ID and password.
In the Confirm Password field, enter the same password from Step 3 to confirm. In the Mail Domain field, enter the domain name for the server running the e-mail system. In the Main Server Name field, enter the name or IP address of the server running the e-mail system. To make the changes, click the Update button.
Related Topics

Configuring CAR Database Alerts, page 16-25 Configuring CDR Database Alerts, page 16-27 Configuring Automatic Report Generation/Alert, page 17-12
16-4
OL-10643-01
Chapter 16
Configuring the Dial Plan

The default dial plan in CAR specifies the North American numbering plan (NANP). Make sure that the dial plan is properly configured, so call classifications are correct in the reports.
Note
If you have modified the default NANP provided in Cisco Unified CallManager Administration, or if you are outside the NANP, be sure to configure the dial plan according to your Cisco Unified CallManager dial plan. At least one condition has to be there to configure the Dial Plan. Refer to the Cisco Unified CallManager Administration Guide and the Cisco Unified CallManager System Guide for dial plan information. To configure the dial plan, define the parameters for the outgoing call classifications. Call classifications include international, local, long distance, on net, and others. For example, if local calls in your area are 6 digits in length, you would specify a row in the dial plan as follows: Condition = No of Digits 6 Pattern ! Call Type Local
This section describes how to update the CAR dial plan configuration.
Procedure
Step 1
Choose System > System Parameters > Dial Plan Configuration. The Dial Plan Configuration window displays.
Step 2 Step 3
In the Toll Free Numbers field, enter the numbers in your dial plan that can be placed without a charge. Update the values in the table using the following fields:
ConditionSelect the condition of the rule where > represents greater than; < represents less than, and = represents a value that is equal to the specified value in the No of Digits field.
16-5
No Of DigitsChoose the number of digits in the directory number to which this rule should be applied. If the number of digits does not impact the rule, specify NA. PatternEnter the pattern used for the call classification, where
GThe call is classified as specified in the rule (i.e. G is a wildcard for
the gateway area codes specified in the Gateway Configuration section on page 16-8.
TRetrieves the toll-free numbers configured in CAR. !Signifies multiple digits (any number that is more than 1 digit in
length, such as 1234 or 5551234).

XSignifies a single-digit number (such as 0, 1, or 9). Step 4
Call TypeChoose the call type if the condition is satisfied.
To add more rows, check the check box in the row below where you want to add rows and click the Add Rows link. The system adds a row above the row you chose. To delete a row, check the check box by the row that you want to delete and click the Delete Rows link.
Note
CAR classifies calls based on the dialed number as stored in the CDRs. If the dialed digits are different from the digits that are written in CDRs (due to number transformations), then the Dial Plan in CAR should be configured based on how the digits show up in CDRs.
Step 5
To make the changes, click the Update button.
Related Topic
Restoring the Default Values for the CAR Dial Plan, page 16-6
Restoring the Default Values for the CAR Dial Plan

If you have modified the default dial plan in CAR, you can restore the default values that are based on the North American numbering plan (NANP). Table 16-1 provides the default NANP values.
16-6
OL-10643-01
Chapter 16
Table 16-1 Default Values for CAR Dial Plan
Condition = = = = = = = = >
No of Digits 5 7 10 10 10 11 11 11 3
Pattern ! ! T! G! ! T! XG! ! 011!
Call Type OnNet Local Others Local Long Distance Others Local Long Distance International
The following information explains the default table values (see Table 16-1): Row 1If the number of digits dialed is equal to 5 and the pattern is ! (more than one digit, in this case, 5 digits), the call gets classified as on net. Row 2If the number of digits dialed is equal to 7 and the pattern is ! (more than one digit, in this case, 7 digits), the call gets classified as Local. Row 3If the number of digits dialed is equal to 10 and the pattern is T! (more than one digit, in this case a 10-digit number that starts with a Toll Free number code), the call gets classified as Others. Row 4If the number of digits dialed is equal to 10 and the pattern is G! (more than one digit, in this case a 10-digit number that starts with a gateway code), the call gets classified as Local. Row 5If the number of digits dialed is equal to 10 and the pattern is ! (more than one digit, in this case an 10-digit number), the call gets classified as Long Distance. Row 6If the number of digits dialed is equal to 11 and the pattern is T! (more than one digit, in this case an 11-digit number that starts with a toll-free number code), the call gets classified as Others. Row 7If the number of digits dialed is equal to 11 and the pattern is XG! (more than one digit, in this case an 11-digit number that starts with any single digit followed by a gateway code), the call gets classified as Local.
16-7
Row 8If the number of digits dialed is equal to 11 and the pattern is ! (more than one digit, in this case an 11-digit number), the call gets classified as Long Distance. Row 9If the number of digits dialed is greater than 3 and that starts with 011, the call gets classified as International. If none of the conditions gets satisfied, the call is classified as Others. This section describes how to restore the NANP dial plan values in CAR.
Procedure
Step 1
Choose System > System Parameters > Dial Plan Configuration. The Dial Plan Configuration window displays. Click the Restore Defaults button. The restoration takes effect at midnight. To make changes take effect immediately, restart the Cisco CAR Scheduler service.
Step 2
Related Topics

Configuring the Dial Plan, page 16-5 Starting or Stopping the CAR Scheduler, page 16-24
Gateway Configuration
Configure the gateways in CAR before using the CAR gateway reports.
Tip
Configure the gateways in CAR for existing Cisco Unified CallManager system gateways. Also, when you add gateways to Cisco Unified CallManager Administration, configure the new gateways in CAR. When gateways are deleted from the Cisco Unified CallManager system, these gateways are automatically removed (and any configuration settings you may have specified) from CAR.
16-8
OL-10643-01
Chapter 16
CAR uses the area code information to determine whether calls are local or long distance. You must provide the Number of Ports information for each gateway to enable CAR to generate the Utilization reports.
Note
G is a wildcard for the gateway area codes used in Dial Plan configuration. This section describes how to configure gateways in CAR.
Procedure
Step 1
Choose System > System Parameters > Gateway Configuration. The Gateway Configuration window displays.
Note
If you have not configured gateways in Cisco Unified CallManager Administration, a message displays that indicates that you have not configured gateways for the system.
In the area code field, enter the area code for each gateway that you want to configure. To update the area code for all gateways, enter the area code in the Area Code field and click the Set Area Code button. In the Max No. of Ports field, enter the number of ports for each gateway that you want to configure. The Max No of Ports range goes from 1 to 1000.
Note
CAR uses the values provided for the gateway when it was added in Cisco Unified CallManager Administration. Therefore, some gateways will already have an area code setting or have a zero for maximum number of ports, depending on the details specified when the gateway was added in Cisco Unified CallManager Administration. CAR does not accept 0 as a value for the maximum number of ports; you may be prompted to change the maximum number of ports for all gateways with a value of zero.
16-9
Step 5
To make the changes, click the Update button. You can run reports in CAR on any or all of the configured gateways.
Related Topics

QoS by Gateway Configuration, page 19-8 Gateway Detail Report Configuration, page 20-2 Gateway Summary Report Configuration, page 20-5 Gateway Utilization Reports Configuration, page 20-8
Configuring System Preferences

CAR provides default system preferences; however, you may customize the system by specifying values for the system parameters. You can also modify multiple system parameters at the same time. This section describes how to specify values for system parameters.
Procedure
Step 1
Choose System > System Parameters > System Preferences. The System Preferences window displays. The list of available system parameters appears in the Parameter Name list.
Step 2
In the Parameter Value field, enter the desired values for the parameters as described in Table 16-2.
16-10
OL-10643-01
Chapter 16
CAR System Configuration System Scheduler Configuration
Table 16-2 System Preferences Parameters
Parameter ERRORLOGFILESIZE
Description Enter the maximum size of the error log file in KB, with a range from 1 to 9999. The default is 100 KB. If the file exceeds the specified size limit, an e-mail alert gets sent to the administrator(s). The file will continue to grow in size if error logging continues, and the administrator(s) will receive an alert by e-mail each day that the file exceeds the specified size. Enter the time, in seconds, that must pass without any activity before a user is logged out of CAR, with a range from 60 to 86400 (1 minute to 24 hours). The default is 1800 (30 minutes). Enter the company name used as header information in reports.
SESSIONTIMEOUT
COMPANY_NAME
Step 3
Click the Update button.
System Scheduler Configuration

The CAR System Scheduler provides the following functions:

Loads the daily CDR schedule Disables the daily CDR schedule Schedules the daily report Schedules the weekly report Schedules the monthly report
16-11
Chapter 16 System Scheduler Configuration
Note
Loading CDR data can cause performance degradation on the Cisco Unified CallManager server. Cisco recommends that you use the default loading time or schedule the loading to occur at a time when Cisco Unified CallManager performance will be least affected.
Configuring the CDR Load Schedule

By default, CDR data loads every day from midnight to 5 a.m. This section describes how to customize the loading schedule, how to restore the default loading schedule if it was customized, and how to disable CDR loading. Disable CDR loading when you are installing or upgrading the system in the same off-hours that CDR loading normally occurs. Because loading CDRs causes a resource drain on Cisco Unified CallManager resources, you can suspend CDR loads until other operations complete. Of course, the CDR data does not get updated when CDR loading is disabled. Be sure to enable CDR loading again as soon as possible. The CAR tool does not affect the CDR generation in Cisco Unified CallManager.
Procedure
Step 1
Choose System > Scheduler > CDR Load. The CDR Load window displays. In the Load CDR & CMR area, complete the fields as described in Table 16-3.
Step 2
16-12
OL-10643-01
Chapter 16
Table 16-3 Load CDR & CMR Values
Field Time
Value Choose the hour and minute that you want CAR to begin loading CDR data from the Cisco Unified CallManager CDR database. Choose the interval at which you want records loaded. The interval can range from every 15 minutes to every 24 hours. Enter the number of minutes that you want to allow CDR data to load. Depending on the size of the CDR database, CAR performance may degrade when CDRs load. You can limit the time allowed for loading, but in doing so, it is possible that only a portion of the CDR data will be loaded in the time that you set. Be sure to reconcile the duration limit you place with the interval. For example, if you load CDR data every 15 minutes, the duration of loading cannot exceed 15 minutes.
Loading Interval
Duration
Step 3
In the Uninhibited Loading of CDR area, complete the fields as described in Table 16-4.
16-13
Table 16-4 Uninhibited Loading of CDR Values
Field From
Value Choose the hour and minute that you want continuous loading of CDR data to begin. Choose the hour and minute that you want continuous loading of CDR data to end.
To
Uninhibited loading allows you to set a time during which CDR data will load continuously. It will not load CDR data automatically in the duration specified, it will load CDR data uninhibited in the specified duration only if loading starts at that duration as per settings done in load CDR and CMR area. So, if loading starts at uninhibited loading interval, it will continue to the end of uninhibited loading interval, plus the duration field set in the load CDR and CMR area. Uninhibited loading take precedence over any values set for scheduled loading. If you do not want uninhibited loading of CDR data, set the From and To values at 00:00.
Step 4
Click the Update button. CAR will load CDR data based on the time, interval, and duration that you have specified. Changes take effect at midnight. You can force the change to take effect immediately by stopping and restarting the CAR Scheduler service.
Related Topics

Starting or Stopping the CAR Scheduler, page 16-24 Disabling the Loading of CDR Data, page 16-15 Enabling the Loading of CDR Data, page 16-16 Restoring the Default CDR Load Schedule, page 16-15
16-14
OL-10643-01
Chapter 16
Restoring the Default CDR Load Schedule

By default, CDR data loads every day from midnight to 5 a.m. This section describes how to restore the default loading schedule if it was customized.
Procedure
Step 1
Choose System > Scheduler > CDR Load. The Daily CDR Load window displays.
Step 2
Click the Restore Defaults button. CDR data will load every day from midnight to 5 a.m. Changes take effect at midnight. You can force the change to take effect immediately by stopping and restarting the CAR Scheduler service.
Related Topics

Configuring the CDR Load Schedule, page 16-12 Starting or Stopping the CAR Scheduler, page 16-24
Disabling the Loading of CDR Data

By default, CDR data loads at midnight on a daily basis; however, you can disable the CDR loading.
Tip
Disable CDR loading when you are installing or upgrading the system in the same off-hours that CDR loading normally occurs. Because loading CDRs causes a resource drain on Cisco Unified CallManager resources, you can suspend CDR loads until other operations complete. Of course, the CDR data does not get updated when CDR loading is disabled. Be sure to enable CDR loading again as soon as possible. The CAR tool does not affect the CDR generation in Cisco Unified CallManager. This section describes how to disable the loading of CDR data.
16-15
Procedure
Step 1
Click System > Scheduler > CDR Load. The Daily CDR Load window displays.
Step 2 Step 3
Check the Disable Loader check box. Click the Update button. CDR data will not load into CAR until you enable CDR loading. Changes take effect at midnight. You can force the change to take effect immediately by stopping and restarting the CAR Scheduler service.
Related Topics

Configuring the CDR Load Schedule, page 16-12 Restoring the Default CDR Load Schedule, page 16-15 Enabling the Loading of CDR Data, page 16-16 Starting or Stopping the CAR Scheduler, page 16-24
Enabling the Loading of CDR Data

When CDR is enabled, CDR data loads at midnight on a daily basis (by default). This section describes how to enable the loading of CDR data if it was previously disabled.
Procedure
Step 1
Choose System > Scheduler > CDR Load. The Daily CDR Load window displays. Uncheck the Disable Loader check box.
Step 2
16-16
OL-10643-01
Chapter 16
Step 3
Click the Update button. Changes take effect at midnight. You can force the change to take effect immediately by stopping and restarting the CAR Scheduler service.
Related Topics

Configuring the CDR Load Schedule, page 16-12 Restoring the Default CDR Load Schedule, page 16-15 Disabling the Loading of CDR Data, page 16-15 Starting or Stopping the CAR Scheduler, page 16-24
Scheduling Daily Reports

The Daily Report Scheduler schedules the time and duration of CAR daily reports.
Note
Report generation can degrade Cisco Unified CallManager performance; schedule reports when performance will be least affected.
Before You Begin
Specify the reports to be generated using the Automatic Generation/Alert Option. See Configuring Automatic Report Generation/Alert, page 17-12, for more information. This section describes how to schedule the time and duration of the automatic daily reports.
Procedure
Step 1
Choose System > Scheduler > Daily. The Daily Scheduler window displays.
16-17
Step 2
In the Time field, choose the hour and minute that you want daily reports generated. A 24-hour clock represents time, where 0 equals midnight, and 1 through 11 represent a.m. hours, and 12 through 23 represent the p.m. hours of 1 p.m. through 11 p.m., respectively. In the Life field, choose the duration of the report from the range of 0 to 12 days. If you set the life of the report to 00, the report does not generate. Click the Update button. Reports with report generation interval as Daily in Automatic Generation/Alert Option, and enabled, automatically generate every day at the time you specified and get deleted after the number of days that you specified. Changes take effect at midnight. You can force the change to take effect immediately by stopping and restarting the CAR Scheduler service.
Step 3 Step 4
Related Topics

Scheduling Weekly Reports, page 16-18 Scheduling Monthly Reports, page 16-20 Configuring Automatic Report Generation/Alert, page 17-12 Disabling Reports, page 16-23 Restoring Default Report Schedules, page 16-21 Starting or Stopping the CAR Scheduler, page 16-24
Scheduling Weekly Reports

The Weekly Report Scheduler schedules the time and duration of CAR weekly reports.
Note
16-18
OL-10643-01
Chapter 16
Before You Begin
Use the Automatic Generation/Alert Option to specify the reports to be generated. See Configuring Automatic Report Generation/Alert, page 17-12, for more information. This section describes how to schedule the day, time, and duration of the automatic weekly reports.
Procedure
Step 1
Choose System > Scheduler > Weekly. The Weekly Scheduler window displays.
Step 2 Step 3
In the Day of Week field, choose the day that you want reports generated. In the Time field, choose the hour and minute that you want reports generated. A 24-hour clock represents time, where 0 equals midnight, and 1 through 11 represent a.m. hours, and 12 through 23 represent the p.m. hours of 1 p.m. through 11 p.m., respectively. In the Life field, choose the duration of the report from the range of 00 to 12 weeks. If you choose 00, the report does not generate. Click the Update button. Reports with report generation interval as Weekly in Automatic Generation/Alert Option, and enabled, automatically generate every week at the time you specified and get deleted after the number of weeks that you specified. Changes take effect at midnight. You can force the change to take effect immediately by stopping and restarting the CAR Scheduler service.
Step 4 Step 5
Related Topics

Scheduling Daily Reports, page 16-17 Scheduling Monthly Reports, page 16-20 Disabling Reports, page 16-23 Configuring Automatic Report Generation/Alert, page 17-12 Starting or Stopping the CAR Scheduler, page 16-24
16-19
Scheduling Monthly Reports

The Monthly Report Scheduler schedules the time and duration of CAR monthly reports.
Note
Before You Begin
Use the Automatic Generation/Alert Option to specify the reports to be generated. See Configuring Automatic Report Generation/Alert, page 17-12, for more information. This section describes how to schedule the day, time, and duration of the automatic monthly reports.
Procedure
Step 1
Choose System > Scheduler > Monthly. The Monthly Scheduler window displays.
Step 2
In the Monthly Bill Generation area, Day of Month field, choose the day of the month that you want the report generated. If this value is set to a day that does not occur in a given month (such as 29, 30, or 31), the report generates on the last day of that month. In the Monthly Bill Generation area, Time field, choose the hour and minute that you want the report generated. A 24-hour clock represents time, where 0 equals midnight, and 1 through 11 represent a.m. hours, and 12 through 23 represent the p.m. hours of 1 p.m. through 11 p.m., respectively. In the Monthly Bill Generation area, Life field, choose the duration of the report from the range of 00 to 12 months. If you choose 00, the reports do not generate. In the Other Monthly Reports area, Day of Month field, choose the day of the month that you want the reports generated. If this value is set to a day that does not occur in a given month (such as 29, 30, or 31), the report generates on the last day of that month.
Step 3
Step 4 Step 5
16-20
OL-10643-01
Chapter 16
Step 6
In the Other Monthly Reports area, Time field, choose the hour and minute that you want reports generated. A 24-hour clock represents time, where 0 equals midnight, and 1 through 11 represent a.m. hours, and 12 through 23 represent the p.m. hours of 1 p.m. through 11 p.m., respectively. In the Other Monthly Reports area, Life field, choose the life of the report from the range of 00 to 12 months. If you choose 00, the reports do not generate. Click the Update button. Reports with report generation interval as Monthly in Automatic Generation/Alert Option, and enabled, automatically generate every month at the time you specified and get deleted after the number of months that you specified. Changes take effect at midnight. You can force the change to take effect immediately by stopping and restarting the CAR Scheduler service.
Step 7 Step 8
Related Topics

Scheduling Daily Reports, page 16-17 Scheduling Weekly Reports, page 16-18 Disabling Reports, page 16-23 Configuring Automatic Report Generation/Alert, page 17-12 Starting or Stopping the CAR Scheduler, page 16-24
Restoring Default Report Schedules

This section describes how to restore the default schedule for automatic generation of daily, weekly, and monthly reports.
Before You Begin
Use the Automatic Report Generation/Alert Option to specify the reports that you want generated. See Configuring Automatic Report Generation/Alert, page 17-12, for more information.
16-21
Procedure
Step 1
To restore the default schedule for daily reports, choose System > Scheduler > Daily. The Daily Scheduler window displays. The default daily reports run at 1 a.m. and get purged after two days. page 32 default scheduled job times are: Click the Restore Defaults button. To restore the default schedule for weekly reports, choose System > Scheduler > Weekly. The Weekly Scheduler window displays. The default weekly reports run at 4 a.m. every Sunday and get purged after four weeks.
Step 2 Step 3
Step 4 Step 5
Click the Restore Defaults button. To restore the default schedule for monthly reports, choose System > Scheduler > Monthly. The Monthly Scheduler window displays. The default monthly bill reports run at 3 a.m. on the first day of every month and get purged after two months. The default other monthly reports run at 2 a.m. on the first day of every month and get purged after two months.
Step 6
Click the Restore Defaults button. Changes take effect at midnight. You can force the change to take effect immediately by stopping and restarting the CAR Scheduler service.
Related Topics

Scheduling Daily Reports, page 16-17 Scheduling Weekly Reports, page 16-18 Scheduling Monthly Reports, page 16-20 Disabling Reports, page 16-23 Configuring Automatic Report Generation/Alert, page 17-12 Starting or Stopping the CAR Scheduler, page 16-24
16-22
OL-10643-01
Chapter 16
Disabling Reports
This section describes how to disable the automatic generation of daily, weekly, and monthly reports.
Procedure
Step 1
To disable the generation of daily reports, choose System > Scheduler > Daily. The Daily Scheduler window displays.
In Life field, choose 00 for days. Click the Update button. To disable the generation of weekly reports, choose System > Scheduler > Weekly. The Weekly Scheduler window displays.
In Life field, choose 00 for weeks. Click the Update button. To disable the generation of monthly reports, choose System > Scheduler > Monthly. The Monthly Scheduler window displays.
Step 8 Step 9
In Life field, choose 00 for months. Click the Update button. If reports are selected for automatic generation using the Automatic Generation/Alert Option, none get generated. Changes take effect at midnight. You can force the change to take effect immediately by stopping and restarting the CAR Scheduler service.
Related Topics

Scheduling Daily Reports, page 16-17 Scheduling Weekly Reports, page 16-18 Scheduling Monthly Reports, page 16-20 Restoring Default Report Schedules, page 16-21
OL-10643-01
16-23
Chapter 16 Starting or Stopping the CAR Scheduler
Configuring Automatic Report Generation/Alert, page 17-12 Starting or Stopping the CAR Scheduler, page 16-24
Starting or Stopping the CAR Scheduler

Use Control Center to start or stop the CAR Scheduler. The CAR Scheduler forces the changes that you made to take effect immediately by stopping and then restarting the scheduler service. This section describes how to start or stop the CAR Scheduler.
Procedure
Step 1
Choose System > Control Center. The Control Center window displays indicating the server name or IP address, the service name, and the status of the service.
Step 2
Click the Start or Stop Service Control button. If you stop a service, any jobs currently scheduled (such as automatic generation of reports, database purge, loading CDRs, or alert notifications) also terminate.
Note
By hovering your mouse over the graphic under Service Status, you can tell whether the service is running. A right-facing arrowhead displays when a service is running; a square box displays when a service is stopped.
Step 3
To exit the Control Center and return to the CAR main window, click the Close button.
Related Topic
System Scheduler Configuration, page 16-11
16-24
OL-10643-01
Chapter 16
CAR System Configuration System Database Configuration
System Database Configuration

You can configure CAR to notify you when the CAR database size or CDR database size exceeds a percentage of the maximum number of records. You can set the message and the maximum number of records and specify the alert percentage. You cannot edit the maximum number of records for the CDR database from CAR. See the following sections to configure system database information:

Configuring CAR Database Alerts, page 16-25 Configuring CDR Database Alerts, page 16-27 Configuring Automatic Database Purge, page 16-29 Disabling Automatic Database Purge, page 16-30 Using Manual Database Purge, page 16-31 Restoring Database Purge Defaults, page 16-32
Configuring CAR Database Alerts

This section describes how to set an alert for CAR database size.
Before You Begin
If you have not already done so, see Configuring Automatic Report Generation/Alert, page 17-12, for instructions. Alerts by mail are enabled by default.
Procedure
Step 1
Choose System > Database > CAR Database Alert. The CAR Database Alert window displays. Enter a value for the Max number of rows in Billing Table. The records in excess of this value will be deleted by CAR. In the Notify Users when number of rows reaches field, enter the percentage of rows that can be filled with data before you are notified. The default is 80%.
Step 2 Step 3
16-25
Chapter 16 System Database Configuration
Step 4
To have an e-mail alert sent to all users designated as CAR Administrators, check the Mail to Administrator check box. When the percentage of rows that can be filled with data has been met, CAR sends an e-mail to the users specified in the To field.
Step 5
If you want the e-mail alert sent to users who are not administrators, perform Step 6 through Step 11. The To field contains the default: CAR Administrator. When CAR is set to the default, an e-mail alert goes to all the users who are designated as CAR Administrators.
Step 6
To send e-mail to users other than CAR administrators, enter the e-mail ID of those users in the To field, or search for users by clicking the To button. When you click the To button, the User Search window displays.
Step 7 Step 8
In the First Name and Last Name boxes, enter characters of the first or last name of the user to whom you want an e-mail alert sent. Click the Search button. User Search Results displays in the same page, listing all users who matched the search criteria that you entered.
Step 9
In the row for the user to whom you want an e-mail alert sent, click the Select button. The user you chose gets added to the field. Use the same search results window to search for more users and add to the list of people to be alerted by an e-mail. When you have added all users, click the Close button in the User Search window. The users listed in the Search Users window get copied to the To field. To copy users on the e-mail alert, enter the e-mail ID of those users in the CC field, or search for users by clicking the CC button. Repeat Step 7 through Step 11 to add users to the CC field. In the Mail Subject field, accept the default, Alert for CAR Database, or enter your own subject message. In the Mail Message field, accept the default text or enter your own message. The default specifies the following message: Number of rows in Billing table in the CAR database has crossed the threshold limit.
Step 10 Step 11
16-26
OL-10643-01
Chapter 16
Step 16
Click the Update button. When the database reaches the designated size, an e-mail alert using the subject message and text provided in the Mail fields, gets sent to the users listed in the To and Cc fields.
Related Topics

Configuring Notification Limits, page 17-15 Configuring Mail Server Parameters, page 16-4 Configuring CDR Database Alerts, page 16-27 Configuring Automatic Report Generation/Alert, page 17-12
Configuring CDR Database Alerts

This section describes how to set an alert for CDR database size.
Before You Begin
If you have not already done so, see Configuring Automatic Report Generation/Alert, page 17-12, for instructions. Alerts by mail are enabled by default.
Procedure
Step 1
Choose System > Database > CDR Database Alert. The CDR Database Alert window displays. The Max number of rows in CDR Table field is automatically populated from the Cisco Unified CallManager database.
Step 2 Step 3
In the Notify users when number of rows reaches field, enter the percentage of rows that can be filled with data before you are notified. The default is 80 percent. To have an e-mail alert sent to all users designated as CAR Administrators, check the Mail to Administrator check box. When the percentage of rows that can be filled with data has been met, an e-mail goes to the users specified in the To field.
16-27
Step 4
If you want the e-mail alert sent to users who are not administrators, perform Step 6 through Step 10. The To field contains the default: CAR Administrator. When CAR is set to the default, an e-mail alert gets sent to all the users who are designated as CAR Administrators.
Step 5
To send e-mail to users other than CAR administrators, enter the e-mail ID of those users in the To field, or search for users by clicking the To button. When you click the To button, the User Search window displays. In the First Name and Last Name boxes, enter characters of the first or last name of users to whom you want an e-mail alert sent. Click the Search button. User Search Results displays in the same page, listing all users who matched the search criteria that you entered.
Step 6 Step 7
Step 8
In the row for the user to whom you want an e-mail alert sent, click the Select button. The user you selected gets added to the field.
Step 9 Step 10
Use the same search results window to search for more users and add to the list of people to be alerted by an e-mail. When you have added all users, click the Close button in the User Search window. The users listed in the Search Users window get copied to the To field.
To copy users on the e-mail alert, enter the e-mail ID of those users in the CC field or search for users by clicking the CC button. Repeat Step 7 through Step 10 to add users to the CC field. In the Mail Subject field, accept the default, Alert for CDR Database, or enter your own subject message. In the Mail Message field, accept the default text or enter your own message. The default specifies the following message: Number of rows in CallDetailRecord table in the CDR database has crossed the threshold limit. Click the Update button.
Step 15
16-28
OL-10643-01
Chapter 16
When the database reaches the designated size, an e-mail alert using the subject message and text provided in the Mail fields, gets sent to the users listed in the To and Cc fields.
Related Topics

Configuring Mail Server Parameters, page 16-4 Configuring CAR Database Alerts, page 16-25 Configuring Automatic Report Generation/Alert, page 17-12 Configuring Notification Limits, page 17-15
Configuring Automatic Database Purge

This section describes how to schedule automatic purging of the CDR and CAR databases. By default, automatic database purge is disabled.
Procedure
Step 1
Choose System > Database > Configure Automatic Purge. The Configure Automatic Database Purge window displays. In the Delete CDR Records older than field of the Automatic Database Purge area, enter the age, in days, of the CDR records that you want to purge from the database. CAR deletes only records older than the specified number of days. In the Delete CAR Records older than field of the Automatic Database Purge area, enter the age, in days, of the CAR records that you want to purge from the database. CAR deletes only records older than the specified number of days. Click the Update button. The restoration takes effect at midnight. To make changes take effect immediately, restart the Cisco CAR Scheduler service.
Step 2
Step 3
Step 4
16-29
The values specified are saved. The CAR Scheduler checks the age of the records as set here daily and deletes the records that exceed this age. The deletion is done at the same time that the Daily report generation is set, as in the Scheduling Daily Reports section on page 16-17.
Related Topics

Using Manual Database Purge, page 16-31 Disabling Automatic Database Purge, page 16-30 Restoring Database Purge Defaults, page 16-32 Starting or Stopping the CAR Scheduler, page 16-24
Disabling Automatic Database Purge

This section describes how to disable automatic purging of the CAR and CDR databases.
Procedure
Step 1
Choose System > Database > Configure Automatic Purge. The Configure Automatic Database Purge window displays. To disable automatic CDR database purge, check the Disable CDR Purge check box. To disable automatic CAR database purge, check the Disable CAR Purge check box. Click the Update button. The disabling takes effect at midnight. To make changes take effect immediately, restart the Cisco CAR Scheduler service.
Related Topics

Configuring Automatic Database Purge, page 16-29 Using Manual Database Purge, page 16-31
16-30
OL-10643-01
Chapter 16
Restoring Database Purge Defaults, page 16-32 Starting or Stopping the CAR Scheduler, page 16-24
Using Manual Database Purge

This section describes how to manually purge the CAR or CDR database.
Procedure
Step 1
Choose System > Database > Manual Purge. The Manual Database Purge window displays.
In the Select Database field, choose the CAR or CDR database to manually purge. In the Select Table field, choose the table in the database that you want purged. Click the Table Information button. The Table Information window displays. The window displays the tables for which manual purge is permitted, the total number of records in the table, and the latest record and oldest record in the table.
Step 5 Step 6
To return to the Manual Database Purge window, click the Close button. In the Delete records field, choose a date that will determine which records will be purged by clicking one of the following radio buttons:

Older than Between
Step 7
Click the Purge button to delete all records older than or between the dates that you specified. A prompt advises you that you are about to permanently delete the specified records.
Step 8
Click the OK button to purge the records or click the Cancel button to abort the purge operation.
16-31
If you click OK, the records get purged from the selected table. After successful deletion of records, the status message shows the number of records deleted from the table.
Related Topics

Configuring Automatic Database Purge, page 16-29 Disabling Automatic Database Purge, page 16-30 Restoring Database Purge Defaults, page 16-32
Restoring Database Purge Defaults

This section describes how to restore the default values for automatic database purging. Disabled is the default value for automatic database purge.
Procedure
Step 1
Choose System > Database > Configure Automatic Purge. The Configure Automatic Database Purge window displays.
Step 2
Click the Restore Defaults button. The restoration takes effect at midnight. To make changes take effect immediately, restart the Cisco CAR Scheduler service.
Related Topics

Configuring Automatic Database Purge, page 16-29 Disabling Automatic Database Purge, page 16-30 Using Manual Database Purge, page 16-31 Starting or Stopping the CAR Scheduler, page 16-24
16-32
OL-10643-01
Chapter 16
CAR System Configuration System Log Screens
System Log Screens

CAR provides logs that can be used to track the status of the various activities. The event log tracks events triggered by the CAR Scheduler, such as automatically generated reports, loading of CDRs, database alerts notifications, report deletions, and database purging. The error log tracks errors that CAR encountered while performing various tasks. It also tracks errors that CAR encountered while loading CDR data. The error log assists with debugging and diagnosing problems in CAR functionality.
Related Topics

Generating the Event Log, page 16-33 Generating the Error Log, page 16-34
Generating the Event Log

The event log provides a report on the status of the activities controlled by the CAR scheduler. The event log report shows whether the tasks have started, completed successfully, or are in progress. This section describes how to generate the event log report.
Procedure
Step 1
Choose System > Log Screens > Event Log. The Event Log window displays. Click on the Daily radio button to choose daily jobs; the Weekly radio button to choose weekly jobs; and the Monthly radio button to choose monthly jobs. In the List of Jobs area, choose the tasks for which you want information. To add the chosen task to the Selected Jobs area, click the right arrow icon. To remove tasks from the Selected Jobs area, choose the task that you want removed and click the left arrow icon. To add tasks with a different frequency, repeat Step 2 through Step 4. For example, you can have daily reports and reports that include monthly or weekly tasks.
16-33
Chapter 16 System Log Screens
Step 7
Choose the status to include in the report. You must choose at least one of the statuses as described in Table 16-5.
Note
All the jobs are selected by default.
Table 16-5 Event Log Report Status
Status Completed
Description If this check box is checked, the event log report includes tasks that have completed. If this check box is checked, the event log report includes tasks that are currently in progress. If this check box is checked, the event log report includes tasks that have failed.
In Progress
Unsuccessful
Step 8 Step 9
Choose a date range by choosing From and To values. Click the OK button to generate the event log report. The event log displays information about the chosen tasks. Print the log by right-clicking on the screen and choosing Print.
Related Topic
Generating the Error Log, page 16-34
Generating the Error Log

The error log provides a report on the errors that CAR encountered while performing various tasks. You can use this information to assist with troubleshooting the system when problems occur. This section describes how to generate the error log report.
16-34
OL-10643-01
Chapter 16
CAR System Configuration Understanding Log Reports
Procedure
Step 1
Choose System > Log Screens > Error Log. The Error Log window displays.
Step 2 Step 3 Step 4 Step 5 Step 6 Step 7 Step 8 Step 9
In the List of Modules area, choose the modules for which you want information. To add the chosen module to the Selected Modules area, click the right arrow icon. To remove tasks from the Selected Modules area, choose the module that you want removed and click the left arrow icon. In the List of Users area, choose the users for which you want information. To add the chosen user to the Selected Users area, click the right arrow icon. To remove users from the Selected Users area, choose the user that you want removed and click the left arrow icon. Choose a date range by selecting From and To values. Click the OK button to generate the error log report. The error log displays information about the chosen modules and users. Print the log by right-clicking on the screen and choosing Print.
Related Topics

Understanding the Error Log Output, page 16-36 Understanding the Error Log Details, page 16-37 Generating the Event Log, page 16-33
Understanding Log Reports

This section provides information about the event and error log reports. See the following sections:

Understanding the Event Log Output, page 16-36 Understanding the Error Log Output, page 16-36 Understanding the Error Log Details, page 16-37
16-35
Chapter 16 Understanding Log Reports
Understanding the Event Log Output

Table 16-6 describes the event log report output.
Table 16-6 Event Log Report Output
Status Sl No Jobs Start Time End Time Status Date
Description Serial number. Name of the task. Time the task started. Time the task ended. Unsuccessful, in progress, completed Date the task was scheduled.
Understanding the Error Log Output

Table 16-7 describes the error log report output.
Table 16-7 Error Log Report Output
Status Sl No Module Name Message Details
Description Serial number. The name of the module that generated the error. The description of the error and a recommended resolution. A link to the error log details that displays the serial number, error code, and other error details. See Understanding the Error Log Details, page 16-37, for more information.
16-36
OL-10643-01
Chapter 16
CAR System Configuration Understanding Log Reports
Understanding the Error Log Details

Table 16-8 describes the error log report details.
Table 16-8 Error Log Report Details
Status Sl No Error Code User Message Program Name User Time
Description Serial number. The code assigned to the error message. Brief message to the user, explaining the error. The program that generated the error. The user name who was logged on when this error occurred. The precise date and time that the error was generated.
16-37
Chapter 16 Understanding Log Reports
16-38
OL-10643-01
C H A P T E R
17
CAR Report Configuration

Use report configuration to define the following parameters:
Rating parameters for callsduration, time of day, voice quality
Note
Rating parameters for calls occurs during CAR loading. If want old CDR records in the CAR database to use new values for these parameters, you must reload all the CDRs in the CAR database. Quality of service Automatic generation of reports with alerts Notification limits

Configuring the Rating Engine, page 17-2 Defining the Quality of Service (QoS) Values, page 17-9 Configuring Automatic Report Generation/Alert, page 17-12 Configuring Notification Limits, page 17-15
Before You Begin
Before you start generating reports with CAR, configure the system. See Chapter 16, CAR System Configuration.
17-1
Chapter 17 Configuring the Rating Engine
Configuring the Rating Engine

You can use CAR to set a base monetary rate for the cost of calls based on a time increment. You can further qualify the cost by applying the time of day and voice quality factors. Service providers who must account for service to subscribers commonly use this feature. Some organizations also use this information to establish billing costs for users and departments in the organization for accounting or budgeting purposes. Reports that use these rating parameters include individual bill, department bill, Top N by charge, Top N by number of calls, and Top N by duration.
Note
If you do not change the default value for charge base/block, the cost will always be zero because the default base charge per block is zero. The charge of any call is the multiplication of the basic charge of the call, multiplication factor for time of day, and multiplication factor for voice quality. You can set the basic charge for a call through the Report Config > Rating Engine > Duration web page. Refer to the following list:

Basic charge = cost, or number of units, applied to the duration block specified in the Number of Blocks section Number of blocks = total duration of call, in seconds, for which you want the base charge to be applied
You can set the multiplication factor for time of day through the Report Config > Rating Engine > Time of Day web page. The settings are based on the connect time of the call. You can set the multiplication factor for voice quality through the Report Config > Rating Engine > Voice Quality web page.
Setting the Base Rate and Duration

To establish a cost basis for calls, you must specify a base rate for all calls. For example, if your service provider charges you 6 cents for each minute, billed in 10-second increments, you can set the base rate at which all calls are charged at 1 cent for each 10-second increment. This section describes how to establish the base charge and duration values.
17-2
OL-10643-01
Chapter 17
CAR Report Configuration Configuring the Rating Engine
Note
If you use the default base charge value, reports do not provide any costs. Default values are provided, but if left to the defaults, the Rating Engine stays disabled and does not provide costs.
Procedure
Step 1
Choose Report Config > Rating Engine > Duration. The Call Duration window displays. In the To (seconds) field, enter the seconds for which you want the base charge to be applied. For example, if you are billed in 6-second increments, enter 6 in this field. If you are billed a flat rate for each minute regardless of call duration, enter 60 in this field, so the charge is based on whole minutes. In the Base Charge/Block field, enter the cost basis for the seconds shown in the To (seconds) field. For example, if you are billed 6 cents for each minute in 6-second increments, enter 0.006 in this field. If you are billed 7 cents for each minute in whole minutes (no incremental billing), enter 0.07 in this field. In the preceding examples, if you are billed in 6-second increments and the cost is 0.006 for each 6-second increment, a call that lasted 7 seconds would cost 0.012. Rationale: Each 6-second increment costs 0.006, and there were two blocks from 0 to 6 seconds. Likewise, if you are billed in whole minutes and the cost is 7 cents for each minute, a call that lasted 3 minutes would cost 21 cents. Rationale: Each 60-second increment costs 7 cents, and there were 3 blocks of 1 minute.
Step 2
Step 3
Step 4
Click the Update button.
Related Topics

Factoring Time of Day into Call Cost, page 17-4 Factoring Voice Quality into Call Cost, page 17-5 Restoring Default Values for Call Cost, page 17-7 Starting or Stopping the CAR Scheduler, page 16-24
17-3
Factoring Time of Day into Call Cost

To further define the cost of calls, you can specify a multiplication factor for certain times of day. For example, if you want to charge subscribers a premium for daytime calls, you can apply a multiplication factor to the base charge/block that you specified in the Call Duration window. This section describes how to establish certain times of day when calls cost more.
Note
If you do not want to increase call cost by time of day, you can use the default values. The default multiplication factor is 1, so no increase in call cost for time of day occurs.
Procedure
Step 1
Choose Report Config > Rating Engine > Time of Day. The Time of Day window displays. To add rows, click the Add Rows link. The system adds a row between 00:00:00 and 23:59:59.
Step 2
Step 3
To add additional rows, check the check box for the row above which you want to add a new row, and click the Add Rows link.
Note
To delete rows, check the check box for the row that you want to delete and click the Delete Rows link.
Step 4
Enter the From and To time ranges in 24-hour, minute, and second format. A 24-hour period, from 00:00:00 to 23:59:59, represents the default time range. If you want to set one time-of-day range from 8 am to 5 pm, you will need to establish three time-of-day ranges: the first from 00:00:00 to 07:59:59; the second from 08:00:00 to 16:59:59; and the third from 17:00:00.
Note
You must use military time, rather than a 12-hour clock when factoring Time of Day into Call Cost.
17-4
OL-10643-01
Chapter 17
Step 5
Enter the Multiplication Factor that designates a number by which you want the base charge/block to be multiplied when a call occurs in the specified time range. For example, if you charge a premium of double the price for calls that are placed between 8 a.m. and 5 p.m., the multiplication factor would be 2.00. A multiplication factor of 1.00 does not affect the cost of the call. To add the time-of-day and multiplication factors, click the Update button.
Step 6
Tip
To restore the default setting, click the Restore Defaults button.
Related Topics

Setting the Base Rate and Duration, page 17-2 Factoring Voice Quality into Call Cost, page 17-5 Restoring Default Values for Call Cost, page 17-7 Starting or Stopping the CAR Scheduler, page 16-24
Factoring Voice Quality into Call Cost

To further define the cost of calls, you can specify a multiplication factor for the voice quality of a call. For example, if subscribers are paying a premium price to ensure the highest voice quality on calls, you can apply various multiplication factors to the base charge/block that you specified in the Call Duration window depending on the voice quality. Using a multiplication factor other than 1.00 helps differentiate between the various voice quality calls as well. This section describes how to establish call cost when calls that have a certain voice quality cost more.
Note
If you do not want to increase call cost by voice quality, you can use the default values. The default multiplication factor is 1.00, so there is no increase in call cost for voice quality.
17-5
Procedure
Step 1
Choose Report Config > Rating Engine > Voice Quality. The Voice Quality window displays.
Step 2
In the Multiplication Factor field, enter the number by which you want the base charge/block to be multiplied when a call occurs in the specified voice-quality category. Defining the Quality of Service (QoS) Values, page 17-9, defines the voice quality categories, Good, Acceptable, Fair, and Poor.
Example
Voice Quality Good; Factor 1.2 Voice Quality Acceptable; Factor 1.0 Voice Quality Fair; Factor 1.0 Voice Quality Poor; Factor 0.8 A good call will be charged 1.2 times that of an acceptable and fair call. A poor call would be charged 0.8 times that of an acceptable and fair call.
Note
Multiplication factor for a good call >= the multiplication factor for acceptable >= multiplication factor for fair >= multiplication factor for poor.
Step 3
To set the voice quality multiplication factors, click the Update button.
Related Topics

Setting the Base Rate and Duration, page 17-2 Factoring Time of Day into Call Cost, page 17-4 Restoring Default Values for Call Cost, page 17-7 Restoring Default QoS Values, page 17-10 Starting or Stopping the CAR Scheduler, page 16-24
17-6
OL-10643-01
Chapter 17
Restoring Default Values for Call Cost

You can restore the default values that CAR uses to determine call cost. By restoring the default value of 0.00 for the call charge/block, you effectively disable the other factors used in determining call cost.
Restoring Default Values for Duration

This section describes how to restore defaults for duration.
Procedure
Step 1
Choose Report Config > Rating Engine > Duration. The Call Duration window displays. Click the Restore Defaults button.
Step 2
Related Topics

Configuring the Rating Engine, page 17-2 Setting the Base Rate and Duration, page 17-2 Factoring Voice Quality into Call Cost, page 17-5 Starting or Stopping the CAR Scheduler, page 16-24
17-7
Restoring Default Values for Time of Day

This section describes how to restore defaults for time of day.
Procedure
Step 1
Choose Report Config > Rating Engine > Time of Day. The Time of Day window displays. Click the Restore Defaults button.
Step 2
Related Topics

Restoring Default Values for Voice Quality

This section describes how to restore defaults for voice quality.
Procedure
Step 1
Choose Report Config > Rating Engine > Voice Quality. The Voice Quality window displays.
Step 2
Click the Restore Defaults button.
17-8
OL-10643-01
Chapter 17
CAR Report Configuration Defining the Quality of Service (QoS) Values
Related Topics

Defining the Quality of Service (QoS) Values

CAR generates Quality of Service reports. To qualify the data presented in those reports, CAR uses predefined values that are set about voice quality. Specify the value ranges that are good, acceptable, fair, and poor for jitter, latency, and lost packets. If a call does not satisfy any of the criteria set for any of the three voice-quality categories, it receives a classification of NA (not applicable). Enter NA to ignore the values of a parameter. For example, a QoS parameter such as jitter, has NA, and the QoS is defined as good. This means that the QoS depends only on the values of latency and lost packets. All three parameters cannot have NA as values. Infinity designates the maximum value that is available for any parameter. If you specify a rule where a jitter value from 500 to Infinity is considered poor, a call with jitter greater than 500 receives a classification of poor.
Note
The classifications of NA and Infinity are case-sensitive. This section describes how to define the quality-of-service values.
Procedure
Step 1
Choose Report Config > Define QoS. The Define Quality of Service window displays.
Step 2
To add rows, check the check box for the row above which you want to add a new row and click the Add Rows link. The new row gets added above the row that you checked and the check box is cleared.
17-9
Chapter 17 Defining the Quality of Service (QoS) Values
The rows represent the values that CAR uses to quantify the conditions good, acceptable, fair, and poor in the QoS reports. For each value set, enter the upper and lower limits in the From and To columns.
Note
To delete rows, check the check box for the row that you want to delete, and click the Delete Rows link.
Step 3 Step 4
For each value that you have set, choose the Quality of Service. Click the Update button.
Related Topics

Configuring the Rating Engine, page 17-2 Setting the Base Rate and Duration, page 17-2 Factoring Time of Day into Call Cost, page 17-4 Factoring Voice Quality into Call Cost, page 17-5 Restoring Default QoS Values, page 17-10 Starting or Stopping the CAR Scheduler, page 16-24
Restoring Default QoS Values

This section describes how to restore the default QoS values.
Procedure
Step 1
Choose Report Config > Define QOS. The Define Quality of Service window displays. Table 17-1 describes the QoS default values.
17-10
OL-10643-01
Chapter 17
CAR Report Configuration Defining the Quality of Service (QoS) Values
Table 17-1 QoS Default Values
QoS Parameter Lost Packets
Default Good0.00 to 15.00 Acceptable15.01 to 30.00 Fair30.01 to 45.00 Poor45.01 to infinity Good0 to 20 Acceptable21 to 100 Fair101 to 150 Poor151 to infinity Latency has no default values.
Jitter
Latency
Step 2
Click the Restore Defaults button.
Related Topics

Configuring the Rating Engine, page 17-2 Setting the Base Rate and Duration, page 17-2 Factoring Time of Day into Call Cost, page 17-4 Factoring Voice Quality into Call Cost, page 17-5 Restoring Default QoS Values, page 17-10 Starting or Stopping the CAR Scheduler, page 16-24
17-11
Chapter 17 Configuring Automatic Report Generation/Alert
Configuring Automatic Report Generation/Alert

CAR automatically generates reports based on a schedule. Report generation can include a daily, weekly, or monthly summary report, QoS reports, traffic reports, Device/Route Plan utilization reports, etc., that you may want to view on a regular basis.
Note
In large setups, with a large number of gateways, route groups, route lists, and route patterns, enabling all the Utilization reports (Gateway Utilization, Route Group Utilization, Route List Utilization, and Route Pattern Utilization) increases the CPU usage of the system, therefore increasing the time in which reports are generated. This also affects system performance. Cisco recommends that you enable only Gateway Utilization reports for automatic generation, due to the number of gateways typically found in a large system. All Utilization reports can be generated on demand by selecting 15 or less gateways, route groups, route lists, or route groups.
Before You Begin
Automatically generating reports involves a two-step process:

First, enable the reports that you want generated unless they are enabled by default. See Chapter 16, CAR System Configuration. Second, schedule the reports for the day and time that you want them to generate. (CAR provides a default schedule. If the default schedule is acceptable, only enable the reports that you want automatically generated.)
CAR provides e-mail alerts for various events. Enabling the system for e-mail alerts involves a two-step process:

First, enable the e-mail alerts. Default enables some, but not all, reports. Second, configure the e-mail that is sent when the alert criteria is met.
Refer to the Cisco Unified CallManager Serviceability System Guide for more information about scheduling report generation and e-mail alerts.
Related Topics

Enabling or Customizing Reports for Automatic Generation, page 17-13 Enabling or Disabling Alerts by Mail, page 17-14
17-12
OL-10643-01
Chapter 17
CAR Report Configuration Configuring Automatic Report Generation/Alert
Enabling or Customizing Reports for Automatic Generation

This section describes how to enable or disable one or all reports for automatic generation. You can also customize the report parameters and enable a mailing option, so reports get e-mailed when they are created. The Cisco Unified CallManager Serviceability System Guide describes reports that are enabled by default.
Procedure
Step 1
Choose Report Config > Automatic Generation/Alert. The Automatic Report Generation/Alert Option window displays. In the Reports [Report Generation Interval] box, choose the report that you want to automatically generate based on the schedule that you defined in the System Scheduler. See System Scheduler Configuration, page 16-11. In the Status field, choose Enabled or Disabled. To customize the report or have the report e-mailed when it is generated, click the Customize Parameters button. The Customize Parameters window displays.
Step 2
Step 3 Step 4
Note
Each report provides different customization options, depending on the type of report. Refer to the Cisco Unified CallManager Serviceability System Guide for more information.
Choose the CSV or PDF radio button, depending on the type of report you want the system to mail. Check the Mailing Option check box to have the report mailed to an individual user, manager, or administrator, depending on the type of report. Click the Update button to save the values that you specified. The Customize Parameters window closes. Repeat Step 4 through Step 7 to enable or customize other reports. Click the Update button.
Step 8 Step 9
17-13
Chapter 17 Configuring Automatic Report Generation/Alert
Changes take effect at midnight. You can force the change to take effect immediately by stopping and restarting the CAR Scheduler service.
Related Topics

Enabling or Disabling Alerts by Mail, page 17-14 Configuring Mail Server Parameters, page 16-4 System Scheduler Configuration, page 16-11 Starting or Stopping the CAR Scheduler, page 16-24
Enabling or Disabling Alerts by Mail

This section describes how to enable alerts to be mailed to users.
Note
For database alerts, see System Database Configuration section on page 16-25, and for the QoS and Charge Limit Notifications, see the Configuring Notification Limits section on page 17-15.
Procedure
Step 1
Choose Report Config > Automatic Generation/Alert. The Automatic Report Generation/Alert window displays. In the Alerts by Mail box, choose the alert that you want to enable or disable. In the Status field, choose Enabled or Disabled. Click the Update button. Repeat Step 2 and Step 4 to enable or disable alerts by mail. Changes take effect at midnight. You can force the change to take effect immediately by stopping and restarting the CAR Scheduler service.
17-14
OL-10643-01
Chapter 17
CAR Report Configuration Configuring Notification Limits
Related Topics

Enabling or Customizing Reports for Automatic Generation, page 17-13 Starting or Stopping the CAR Scheduler, page 16-24 System Parameters Configuration, page 16-1 Configuring Mail Server Parameters, page 16-4
Configuring Notification Limits

You can specify limits for QoS and daily charges, so the administrator gets alerted by e-mail when these limits are exceeded. The alerts go to all administrators that are identified in the administration rights window. See System Parameters Configuration section on page 16-1, and Configuring Mail Server Parameters section on page 16-4. This section describes how to specify the notification limits for QoS and daily charges.
Procedure
Step 1
Choose Report Config > Notification Limits. The Set Limits for Notification window displays. In the Daily QoS Parameters area, enter a threshold for good and poor calls. The threshold applies in the form of a percentage of all calls that must be exceeded to trigger an e-mail alert to the administrator. The default for good calls specifies less than 20 percent, meaning that when good calls represent less than 20 percent of all calls per day, an alert gets sent. The default for poor calls specifies greater than 30 percent, meaning that when poor calls represent more than 30 percent of all calls per day, an alert gets sent.
Step 2
Step 3
In the Daily Charge Limit area, enter the number of monetary units (such as dollars, francs, or pounds) that, when exceeded by any user in the system, will trigger sending of an e-mail alert to the administrator. Click the Update button.
Step 4
17-15
Chapter 17 Configuring Notification Limits
Changes take effect immediately. The new values will be used whenever the next alert is sent.
Related Topics

System Parameters Configuration, page 16-1 Starting or Stopping the CAR Scheduler, page 16-24
17-16
OL-10643-01
C H A P T E R
18
CAR User Reports Configuration

CAR provides reporting capabilities for three levels of users:

AdministratorsGenerate system reports to help with load balancing, system performance, and troubleshooting. ManagersGenerate reports for users, departments, and QoS to help with call monitoring for budgeting or security purposes and for determining the voice quality of the calls. Individual usersGenerate a billing report for their calls. Understanding Bills, page 18-2 Understanding Top N, page 18-5 Understanding Cisco Unified CallManager Assistant, page 18-14 Configuring CTI Application User Reports, page 18-18 Configuring Reports for Cisco Unified IP Phone Services, page 18-19 Mailing a Report, page 18-20 Searching for Users, page 18-22

Note
Depending on your job function, you may not have access to every report that is described in this chapter.
18-1
Chapter 18 Understanding Bills
Understanding Bills
Individual bills provide call information for the date range that you specify. You can either view reports that the system automatically generates or generate new reports. Only CAR administrators can schedule reports for automatic generation. If you are an administrator, see System Scheduler Configuration, page 16-11, for more information. Department bills provide call information and quality-of-service (QoS) ratings. If you are a manager, you can generate a summary or detailed report of the calls that all users who report to you made, or only those users that you choose. If you are a CAR administrator, you can generate a summary or detailed report of the calls that some or all users in the system made. This report helps you keep track of all calls on a user-level basis for the entire system.
Configuring Individual Bills

This section describes how to view, or mail, summary or detail information about users, managers, and administrators.
Procedure
Step 1
Perform one of the following tasks:

If you are a user or manager, choose Bills > Individual. If you are a CAR administrator, choose User Reports > Bills > Individual.
The Individual Bill window displays.

Step 2
In the Report Type field, choose Summary or Detail. Summary reports provide a summary of all calls for a chosen period (the total number of calls that were made and the charges that were incurred). Detailed reports provide the call types (Internal, Local, Long Distance, International, or On Net) for all calls over a chosen period.
Step 3
In the Available Reports field, choose an automatically generated report (if available) and go to Step 6, or use the default setting, Generate New Report, and go to Step 4. Choose the date range for the period for which you want to see call information.
Step 4
18-2
OL-10643-01
Chapter 18
CAR User Reports Configuration Understanding Bills
Step 5 Step 6
If you want the report in CSV format, click CSV (comma separated value). If you want the report in PDF format, click PDF (portable document format). Click View Report. The report displays. If you want to mail the report, click Send Report. To send the report, follow the procedure that is described in Mailing a Report section on page 18-20.
Step 7
Related Topics

Bill Summary Report Results, page A-2 Bill Detail Report Results, page A-4 Configuring Department Bills, page 18-3
Configuring Department Bills

Caution
Use CAR only during off-peak hours. Otherwise, data collection and report generation could cause performance degradation on the Cisco Unified CallManager system. This section describes how to generate, view, or mail summary or detail information about departmental bills.
18-3
Chapter 18 Understanding Bills
Procedure
Step 1

If you are a manager, choose Bills > Department. If you are a CAR administrator, choose User Reports > Bills > Department.
The Department Bill window displays.

Step 2
In the Report Type field, choose Summary or Detail. Summary reports provide a summary of all calls for a chosen period (the total number of calls that were made and the charges that were incurred). Detailed reports provide the call types (Internal, Local, Long Distance, International, or On Net) for all calls over a chosen period.
Step 3
In the Available Reports field, choose an automatically generated report (if available) and go to Step 14 or use the default setting, Generate New Report, and go to Step 4. Choose the date range for the period for which you want to see call information. If you are a manager, continue with Step 6; otherwise, if you are a CAR administrator, continue with Step 10. To choose all of your direct reports, check the Select All Reportees check box. The List of Reportees shows your direct reports.
Step 7 Step 8
To choose individual reportees, choose the reports that are shown in the List of Reportees. Click Add. The department bill includes only users who are listed in the Selected Reportees box.
Step 9
To see the reportees under a particular user, choose the user and click the Down button. All reportees to the chosen user display. If you are a CAR administrator, check the Select All Users check box to include all users. If you are a manager, proceed to Step 13. To specify individual users, enter the user ID of the individual that you want to include in the report in the User ID field.
Step 10 Step 11
18-4
OL-10643-01
Chapter 18
CAR User Reports Configuration Understanding Top N
Step 12
Click Add. You can also use a provided search function. See Searching for Users, page 18-22, for instructions on using the search feature.
Step 13 Step 14
If you want the report in CSV format, click CSV (comma separated value). If you want the report in PDF format, click PDF (portable document format). Click View Report. The report displays. If you want to mail the report, click Send Report. To send the report, follow the procedure that is described in Mailing a Report section on page 18-20.
Step 15
Related Topics

Bill Summary Report Results, page A-2 Bill Detail Report Results, page A-4 Configuring Individual Bills, page 18-2
Understanding Top N
Top N by Charge reports the users who made the maximum charge for the specified date range. If you are a manager, the report includes the top charges for all calls that users who report to you made during the specified period. If you are a CAR administrator, the report includes the top charges for all calls that all users on the system made for the specified period. You can generate each Top N report with two to three options to show the Top N Users, Destinations, Calls, or Extensions. Top N by Duration reports the top number of users that incurred a maximum time on calls during a period that you specify. If you are a manager, the report lists the top number of users who report to you that incurred a maximum time for calls that were made during the chosen date range, starting with the longest. If you are a CAR administrator, the report lists the top number of users that incurred a maximum time for calls that were made during the chosen date range, starting with the longest.
18-5
Chapter 18 Understanding Top N
Top N by Number of Calls reports the top number of calls that were made and received by users during a period that you specify. If you are a manager, the report lists the top number of calls by users among the users who report to you for the chosen date range. If you are a CAR administrator, the report lists the top number of calls for each user in the system.
Configuring Top N by Charge

This section describes how to generate, view, or mail reports about the top calls when classified by cost.
Caution
Use CAR only during off-peak hours. Otherwise, data collection and report generation could cause performance degradation on the Cisco Unified CallManager system.
Procedure
Step 1

If you are a user or manager, choose Top N > By Charge. If you are a CAR administrator, choose User Reports > Top N > By Charge.
The Top N by Charge window displays.

Step 2
In the Select Call Types area, check the check boxes for the types of calls that you want included in the report. These boxes display only when you have chosen Generate New Report in Step 4. Table 18-1 describes the call types.
Table 18-1 Top N by Charge Call Types
Call Type On Net
Description Outgoing, intercluster calls that originate on one Cisco Unified CallManager cluster and terminate on a different cluster. Intracluster calls that originate in the Cisco Unified CallManager network and ended in the same Cisco Unified CallManager network (no gateways are used).
Internal
18-6
OL-10643-01
Chapter 18
Table 18-1
Top N by Charge Call Types (continued)
Call Type Local
Description Local calls that are routed through the public switched telephone network (PSTN) to numbers without an area code or that include one of the local area codes. Long-distance calls that originate in the Cisco Unified CallManager network going out through the PSTN. International calls that originate in the Cisco Unified CallManager network going out through the PSTN. Inbound calls that originate outside the Cisco Unified CallManager network and enter the Cisco Unified CallManager network through a gateway. Inbound calls that originate outside the Cisco Unified CallManager network, enter the Cisco Unified CallManager network through a gateway, and transfer outbound from the Cisco Unified CallManager network through a gateway. All other outgoing calls, such as toll-free numbers or emergency calls such as 911.
Long Distance
International
Incoming
Tandem
Others
Step 3
In the Report Type field, choose a report type as described in Table 18-2.
Table 18-2 Top N by Charge Report Types
Report Type By Individual Users By Destinations By All Calls
Description This report lists the users who incurred the maximum charges. This report lists the destinations that incurred the maximum charges. This default report lists the calls that incurred the maximum charges.
18-7
Note
Top N Destination by Charge reports display the Top destinations based on the charge incurred. If the same destination number comprises different call classifications (for example, some are Internal and some are Incoming), they get treated and listed separately in these reports.
In the Available Reports field, choose an automatically generated report (if available) or use the default Generate New Report. If you chose Generate New Report in Step 4, enter the number (n) of records that display in the report in the No of Records field. The default designates five. If you chose Generate New Report in Step 4, choose the date range for the period for which you want to generate the report. If you want the report in CSV format, click CSV (comma separated value). If you want the report in PDF format, click PDF (portable document format). Click View Report. The report displays. If you want to mail the report, click Send Report. To send the report, follow the procedure that is described in Mailing a Report section on page 18-20.
Step 9
Related Topics

Top N By Charge or Duration Report Results, page A-6 Configuring Top N by Duration, page 18-8 Configuring Top N by Number of Calls, page 18-11
Configuring Top N by Duration

This section describes how to generate, view, or mail reports about the top calls when they are classified by duration.
Caution
18-8
OL-10643-01
Chapter 18
Procedure
Step 1

If you are a manager, choose Top N > By Duration. If you are a CAR administrator, choose User Reports > Top N > By Duration.
The Top N by Duration window displays.

Step 2
In the Select Call Types area, check the check boxes for the types of calls that you want included in the report. These boxes display only when you choose Generate New Report from the Available Reports drop-down list box, as described in Step 4. Table 18-3 describes the call types.
Table 18-3 Top N by Duration Call Types
Call Type Internal
Description Intracluster calls that originated in the Cisco Unified CallManager network and ended in the same Cisco Unified CallManager network (no gateways are used). Local calls that are routed through the public switched telephone network (PSTN) to numbers without an area code or that include one of the local area codes. Long-distance calls that originate in the Cisco Unified CallManager network going out through the PSTN. International calls that originate in the Cisco Unified CallManager network going out through the PSTN. Outgoing, intercluster calls that originate on one Cisco Unified CallManager cluster and terminate on a different cluster.
Local
Long Distance
International
On Net
18-9
Table 18-3 Top N by Duration Call Types (continued)
Call Type Incoming
Description Inbound calls that originated outside the Cisco Unified CallManager network, entered through a gateway, and go into the Cisco Unified CallManager network. Inbound calls that originated outside the Cisco Unified CallManager network, entered the Cisco Unified CallManager network through a gateway, and then were transferred outbound from the Cisco Unified CallManager network through a gateway. All other outgoing calls, such as toll-free numbers or emergency calls such as 911.
Tandem
Others
Step 3
Table 18-4 Top N by Duration Report Types
Report Type By Individual Users By Destinations By All Calls
Description This report lists the users who incurred the maximum duration. This report lists the destinations that incurred the maximum duration. This report lists the calls that incurred the maximum duration.
18-10
OL-10643-01
Chapter 18
Note
Top N Destinations by Duration reports display the Top destinations based on the duration of the calls. If the same destination number comprises different call classifications (for example, some are Internal and some are Incoming), they get treated and listed separately in these reports.
In the Available Reports field, choose an automatically generated report (if available) or use the default Generate New Report. If you chose Generate New Report in Step 4, enter the number (n) of records that display in the report in the No of Records field. The default designates five. If you chose Generate New Report in Step 4, choose the date range for the period for which you want to generate the report. If you want the report in CSV format, click CSV (comma separated value). If you want the report in PDF format, click PDF (portable document format). Click View Report. The report displays. If you want to mail the report, click Send Report. To send the report, follow the procedure that is described in Mailing a Report section on page 18-20.
Step 9
Related Topics

Top N By Charge or Duration Report Results, page A-6 Configuring Top N by Charge, page 18-6 Configuring Top N by Number of Calls, page 18-11
Configuring Top N by Number of Calls

This section describes how to generate, view, or mail reports about the top calls when classified by volume.
18-11
Caution
Procedure
Step 1

If you are a manager, choose Top N > By Number of Calls. If you are a CAR administrator, choose User Reports > Top N > By Number of Calls.
The Top N by Number of Calls window displays.

Step 2
In the Select Call Types area, check the check boxes for the types of calls that you want included in the report. Table 18-5 describes the call types.
Table 18-5 Top N by Number of Calls Call Types
Call Type Internal
Description Intracluster calls that originated in the Cisco Unified CallManager network and ended in the same Cisco Unified CallManager network (no gateways are used). Local calls that are routed through the public switched telephone network (PSTN) to numbers without an area code or that include one of the local area codes. Long-distance calls that originate in the Cisco Unified CallManager network going out through the PSTN. International calls that originate in the Cisco Unified CallManager network going out through the PSTN.
Local
Long Distance
International
18-12
OL-10643-01
Chapter 18
Table 18-5 Top N by Number of Calls Call Types (continued)
Call Type On Net
Description Outgoing, intercluster calls that originate on one Cisco Unified CallManager cluster and terminate on a different cluster. Inbound calls that originated outside the Cisco Unified CallManager network, entered through a gateway, and go into the Cisco Unified CallManager network. Inbound calls that originated outside the Cisco Unified CallManager network, entered the Cisco Unified CallManager network through a gateway, and then were transferred outbound from the Cisco Unified CallManager network through a gateway. All other outgoing calls, such as toll-free numbers or emergency calls such as 911.
Incoming
Tandem
Others
Step 3
Table 18-6 Top N by Number of Calls Report Types
Report Type By Individual Users By Extensions
Description This report lists the users who incurred the maximum number of calls. This report lists the extensions that have placed or received the greatest number of calls in your group (managers) or the system (CAR administrators).
18-13
Chapter 18 Understanding Cisco Unified CallManager Assistant
In the Available Reports field, choose an automatically generated report (if available) or use the default Generate New Report. If you chose Generate New Report in Step 4, enter the number (n) of records that display in the report in the No of Records field. The default designates five. If you chose Generate New Report in Step 4, choose the date range for the period for which you want to generate the report. If you chose Generate New Report in Step 4, choose CSV (comma separated value) in the Report Format area. If you want the report in PDF format, choose PDF (portable document format) in the Report Format area. Click View Report. The report displays.
Step 8
Step 9
If you want to mail the report, click Send Report. To send the report, follow the procedure that is described in Mailing a Report, page 18-20.
Related Topics

Top N By Number of Calls Report Results, page A-8 Configuring Top N by Charge, page 18-6 Configuring Top N by Duration, page 18-8
Understanding Cisco Unified CallManager Assistant

CAR provides call completion usage reports for the following Cisco Unified CallManager Assistant users: manager(s) and the configured/assigned assistant(s) that manage the calls of the manager(s). In CAR, you can choose all or a subset of managers or assistants by using simple search functionality that is based on partial or complete first or last name. You can generate these reports on demand in either PDF or CSV format and e-mail them. In addition, you can choose the time range and generate either detailed or summary level reports. The manager reports can include calls that only managers handle for themselves, calls that only assistants handle for managers, and calls that qualify in either case. The summary report for a manager shows the number of calls of each type and total, apart from duration for each assistant (and/or manager). The detail report
18-14
OL-10643-01
Chapter 18
CAR User Reports Configuration Understanding Cisco Unified CallManager Assistant
for a manager shows the date, origination time, origination number, destination number, call classification, and duration for each call for all the assistants (and/or manager), and last total duration for the manager. The assistant reports can include calls that only assistants handle for themselves, or calls that only assistants handle for managers, and calls that qualify in either case. The summary report for an assistant shows the number of calls of each type and total of them apart from duration for each manager (and/or assistant). The detail assistant report shows the date, origination time, origination number, destination number, call classification, and duration for each call for all the managers (and/or assistant) and last total duration for the assistant.
Related Topics

Configuring Manager Call Usage for Cisco Unified CallManager Assistant, page 18-15 Configuring Assistant Call Usage for Cisco Unified CallManager Assistant, page 18-16
Configuring Manager Call Usage for Cisco Unified CallManager Assistant

This section describes how to generate a manager call usage report for Cisco Unified CallManager Assistant.
Caution
Procedure
Step 1
Choose User Reports > Cisco Unified CallManager Assistant > Manager Call Usage. The Call Usage for Manager window displays.
Step 2
From the Report Type drop-down list box, choose either Summary or Detail.
18-15
Chapter 18 Understanding Cisco Unified CallManager Assistant
From the Calls handled by drop-down list box, choose either Manager, Assistant for Manager, or Manager & Assistant for Manager. Choose the date range for the period for which you want to see call information. In the Select Manager(s) box, either check the Select All Manager(s) check box and enter a manager ID or click the Select Manager(s) link to search for a manager ID and enter the ID(s) in the Manager Id field. Click Add. The ID that you chose displays in the Selected Manager(s) pane. If you want the report in CSV format, click CSV (comma separated value). If you want the report in PDF format, click PDF (portable document format). Click View Report. The report displays. If you want to mail the report, click Send Report. To send the report, follow the procedure that is described in Mailing a Report section on page 18-20.
Step 6
Step 7 Step 8
Step 9
Note
To remove a manager from the Selected Manager(s) list, highlight the ID and click Remove. To remove all managers from the list, click Remove All.
Related Topics

Understanding Cisco Unified CallManager Assistant, page 18-14 Configuring Assistant Call Usage for Cisco Unified CallManager Assistant, page 18-16
Configuring Assistant Call Usage for Cisco Unified CallManager Assistant

This section describes how to generate an assistant call usage report for Cisco Unified CallManager Assistant.
18-16
OL-10643-01
Chapter 18
CAR User Reports Configuration Understanding Cisco Unified CallManager Assistant
Caution
Procedure
Step 1
Choose User Reports > Cisco Unified CallManager Assistant > Assistant Call Usage. The Call Usage for Assistant window displays.
From the Report Type drop-down list box, choose either Summary or Detail. From the Calls handled by drop-down list box, choose either Assistant, Assistant for Manager, or Assistant & Assistant for Manager. Choose the date range for the period for which you want to see call information. In the Select Assistant(s) box, either check the Select All Assistant(s) check box and enter an assistant ID or click the Select Assistant(s) link to search for an assistant ID and enter the ID(s) in the Assistant Id field. Click Add. The ID that you chose displays in the Selected Assistant(s) pane. If you want the report in CSV format, click CSV (comma separated value). If you want the report in PDF format, click PDF (portable document format). Click View Report. The report displays. If you want to mail the report, click Send Report. To send the report, follow the procedure that is described in Mailing a Report section on page 18-20.
Step 6
Step 7 Step 8
Step 9
Note
To remove a manager from the Selected Assistant(s) list, highlight the ID and click Remove. To remove all assistants from the list, click Remove All.
18-17
Chapter 18 Configuring CTI Application User Reports
Related Topics

Understanding Cisco Unified CallManager Assistant, page 18-14 Configuring Manager Call Usage for Cisco Unified CallManager Assistant, page 18-15
Configuring CTI Application User Reports

Only CAR administrators can generate the CTI-enabled report. You can generate a list of users who have been configured for using CTI applications. The list does not show the users who currently are using CTI application user.
Tip
CTI calls consume considerable call-processing resources. Use this report to ensure that only those users who truly need a CTI application have been allocated one. You can also use this report for capacity planning to ensure that your Cisco Unified CallManager network is not overloaded because of the call processing demands of the CTI applications. This section describes how to generate a list of users who are configured for using CTI applications.
Caution
Procedure
Step 1
Choose User Reports > CTI Application User. The Users Configured to use CTI applications window displays. For the Report Format, click either the CSV or PDF radio button. To generate the report, click View Report. The Users Configured to use CTI Applications report displays in the format that you chose. The report shows the following information:
Step 2 Step 3
18-18
OL-10643-01
Chapter 18
CAR User Reports Configuration Configuring Reports for Cisco Unified IP Phone Services
Step 4 Step 5
Sl NoSerial number NameThe name of the user User IDThe user ID for the user
To mail the report to someone in an e-mail, click Send Report and perform the procedure that is described in the Mailing a Report section on page 18-20. After you view the list, click Close.
Configuring Reports for Cisco Unified IP Phone Services

Only CAR administrators can generate the Cisco Unified IP Phone services report. You can generate a report that shows chosen Cisco Unified IP Phone services, the number of users who are subscribed to each of the chosen services, and the utilization percentage for each of the chosen services. Use the following instructions to generate a report that shows the usage of specific Cisco Unified IP Phone services.
Caution
Procedure
Step 1
Choose User Reports > Cisco Unified IP Phone Services. The Cisco Unified IP Phone Services window displays a list of all Cisco Unified IP Phone services that are configured in the system.
Step 2 Step 3
In the List of Cisco Unified IP Phone Services area, choose the services that you want to include in the report. To add the chosen service to the Selected Cisco Unified IP Phone Services box, click Add.
18-19
Chapter 18 Mailing a Report
The report will include all services that are listed in this box when you generate it.
Step 4 Step 5
If you want the report in CSV format, click CSV (comma separated value). If you want the report in PDF format, click PDF (portable document format). Click View Report. The report displays. If you want to mail the report, click Send Report. To send the report, perform the procedure that is described in Mailing a Report section on page 18-20.
Step 6
Related Topic
Cisco Unified IP Phone Services Report Results, page A-14
Mailing a Report
You can e-mail all reports in CAR. You can send a report by mail from any report window in CAR. You can also view the report first and then send it.
Before You Begin
To e-mail reports, first configure valid Mail Parameters. The Mail Parameters allow CAR to send e-mail by using the e-mail server in your system. See Configuring Mail Server Parameters, page 16-4, for more information. Also, set up the details of the report that you want generated. See the following sections:

Understanding Bills, page 18-2 Understanding Top N, page 18-5 Configuring Reports for Cisco Unified IP Phone Services, page 18-19 Understanding Cisco Unified CallManager Assistant, page 18-14 Chapter 19, CAR System Reports Configuration Chapter 20, CAR Device Reports Configuration Chapter 21, CDR Search Configuration
This section describes how to mail a CAR report.
18-20
OL-10643-01
Chapter 18
CAR User Reports Configuration Mailing a Report
Procedure
Step 1
In any CAR Reports window or after you review the report, click Send Report. The Mail To window displays.
Step 2 Step 3
Enter the e-mail ID for the user to whom you want to send the report. To search for a user, click To. A User Search window displays.
Step 4
In the First Name and Last Name fields, enter characters of the first or last name of the user and click Search. A User Search Results window displays and lists all users who matched the search criteria that you entered.
Step 5
In the row for the user to whom you want to send the report, click the Select link. The user that you chose gets added to the To field of the Mail To window. Repeat this step to add more users to the list of people who will be e-mailed a copy of this report.
Step 6
When you have added all users, click Close in the User Search window. The users get copied to the To field of the Mail To window.
To add a user to the Cc field, click Cc and follow the same instructions as described in Step 4 through Step 6. In the Subject field, enter a subject message (optional). In the Message area, enter a message (optional). To send the report, click Send.
Related Topics

CAR User Reports Configuration, page 18-1 CAR System Reports Configuration, page 19-1 CAR Device Reports Configuration, page 20-1 CDR Search Configuration, page 21-1
18-21
Chapter 18 Searching for Users
Searching for Users

Many of the reports in CAR provide a search function, so you can look for users. The following CAR reports support search:
User ReportsDepartment and individual bills, Top N by charge, duration and number of calls, Cisco Unified CallManager Assistant, CTI Application User, and Cisco Unified IP Phone Services System ReportsQoS details, Traffic Summary (Extn) SystemAdmin rights All reports that can be viewed and sent
Before You Begin
You must be using one of the windows that are listed in Searching for Users, page 18-22. This section describes how to search for a user.
Procedure
Step 1
Click the Search Users link. A User Search window displays. In the First Name and Last Name fields, enter characters of the first or last name of the user and click Search. A User Search Results window displays in the same window and lists all users who matched the search criteria that you entered.
Step 2
Step 3
In the row for the user that you want, click the Select link. The user that you chose gets added to the List of Users in the User Search window. Repeat this step to add more users.
Step 4
When you have added all users, click Close in the User Search window.
Related Topics

CAR User Reports Configuration, page 18-1 CAR System Reports Configuration, page 19-1
18-22
OL-10643-01
Chapter 18
CAR User Reports Configuration Searching for Users
Chapter 16, CAR System Configuration
18-23
Chapter 18 Searching for Users
18-24
OL-10643-01
C H A P T E R
19
CAR System Reports Configuration

CAR provides reporting capabilities for three levels of users:

AdministratorsGenerate system reports to help with load balancing, system performance, and troubleshooting. ManagersGenerate reports for users, departments, and QoS to help with call monitoring for budgeting or security purposes and for determining the voice quality of the calls. Individual usersGenerate a billing report for each users calls. Configuring QoS Reports, page 19-2 Configuring QoS Parameters, page 19-8 Configuring Traffic Reports, page 19-15 Configuring Malicious Call Details Reports, page 19-23 Configuring Precedence Call Summary, page 19-24 Configuring Client Matter Code Reports, page 19-25 Configuring Authorization Code Name Reports, page 19-27 Configuring Authorization Level Reports, page 19-28 Configuring System Overview, page 19-30 Configuring CDR Error, page 19-31 QoS Parameter Operators, page 19-32

19-1
Chapter 19 Configuring QoS Reports
Note
Depending on your job function, you may not have access to every report that is described in this chapter.
Configuring QoS Reports

Only CAR administrators generate the QoS detail report. The report details the QoS ratings that are attributed to inbound and outbound calls on the Cisco Unified CallManager network for the period specified. Managers or CAR administrators generate the QoS summary report. The report provides a three-dimensional pie chart that shows the distribution of QoS grades that are achieved for the specified call classifications and period. The report also provides a table that summarizes the calls for each QoS. The call details in CDRs and CMRs and the QoS parameters that are provided in the Defining the Quality of Service (QoS) Values, page 17-9, provide basis for assigning a call a particular voice-quality category. You can either view reports that the system automatically generates or generate new reports. Only CAR administrators can schedule reports for automatic generation. See System Scheduler Configuration, page 16-11, for more information. The following sections describe how to configure QoS detail and summary reports:

QoS Detail Report Configuration, page 19-2 QoS Summary Report Configuration, page 19-5
QoS Detail Report Configuration

Caution
Use CAR only during off-peak hours. Otherwise, data collection and report generation could cause performance degradation on the Cisco Unified CallManager system. This section describes how to generate, view, or mail detailed information about the system QoS.
19-2
OL-10643-01
Chapter 19
CAR System Reports Configuration Configuring QoS Reports
Procedure
Step 1
Choose System Reports > QoS > Detail. The QoS Detail window displays.
Step 2
In the Select Call Types area, check the check boxes for the types of calls that you want the report to include. Table 19-1 describes the call types.
Table 19-1 QoS Detail Report Call Types
Call Type Internal
Description Intracluster calls that originated in the Cisco Unified CallManager network and ended in the same Cisco Unified CallManager network (no gateways are used). Local calls that are routed through the public switched telephone network (PSTN) to numbers without an area code or that include one of the local area codes. Long-distance calls that originate in the Cisco Unified CallManager network going out through the PSTN. International calls that originate in the Cisco Unified CallManager network going out through the PSTN. Outgoing, intercluster calls that originate on one Cisco Unified CallManager cluster and terminate on a different cluster. Inbound calls that originated outside the Cisco Unified CallManager network, entered through a gateway, and went into the Cisco Unified CallManager network.
Local
Long Distance
International
On Net
Incoming
19-3
Table 19-1 QoS Detail Report Call Types (continued)
Call Type Tandem
Description Inbound calls that originated outside the Cisco Unified CallManager network, entered the Cisco Unified CallManager network through a gateway, and were transferred outbound from the Cisco Unified CallManager network through a gateway. All other outgoing calls, such as toll-free numbers or emergency calls such as 911.
Others
Step 3
In the Select QoS area, check the check boxes for the voice-quality categories that you want included in the report. The parameters set in the Defining the Quality of Service (QoS) Values, page 17-9, provide basis for all voice-quality categories.
Table 19-2 QoS Detail Report Voice Quality
Voice Quality Good Acceptable
Description QoS for these calls represents the highest possible quality. QoS for these calls, although slightly degraded, still falls within an acceptable range. QoS for these calls is degraded but still within a usable range. QoS for these calls designates unsatisfactory quality. These calls did not match any criteria for the established QoS categories.
Fair Poor NA
Step 4
Choose the date range for the period for which you want to see QoS information.
19-4
OL-10643-01
Chapter 19
Step 5
In the Select Users field, you can either choose all users or search for particular users. To choose all users, check the Select All Users check box. To choose individual users, enter the user ID of the individual in the User ID field and click the Add button.
Note
You can also use a provided search function. See Searching for Users section on page 18-22.
Step 6
If you want the report in CSV format, choose CSV (comma separated value) in the Report Format area. If you want the report in PDF format, choose PDF (portable document format) in the Report Format area. Click the View Report button. The report displays. If you want to mail the report, click the Send Report button. To send the report, follow the procedure that is described in Mailing a Report, page 18-20.
Step 7
Step 8
Related Topics

QoS Detail Report Results, page A-14 Defining the Quality of Service (QoS) Values, page 17-9 QoS Summary Report Configuration, page 19-5
QoS Summary Report Configuration

Caution
Use CAR only during off-peak hours. Otherwise, data collection and report generation could cause performance degradation on the Cisco Unified CallManager system. This section describes how to generate, view, or mail summary information about the system QoS.
19-5
Procedure
Step 1
Perform one of the following steps:

If you are a manager, choose QoS > Summary If you are a CAR administrator, choose System Reports > QoS > Summary.
The QoS Summary window displays.

Step 2
In the Available Reports field, choose an automatically generated report (if available) and go to Step 6, or use the default Generate New Report and go to Step 3. In the Select Call Types area, check the check boxes for the types of calls that you want the report to include. Table 19-3 describes the call types.
Table 19-3 QoS Summary Report Call Types
Step 3
Call Type Internal
Description Intracluster calls that originated in the Cisco Unified CallManager network and ended in the same Cisco Unified CallManager network (no gateways are used). Local calls that are routed through the public switched telephone network (PSTN) to numbers without an area code or that include one of the local area codes. Long-distance calls that originate in the Cisco Unified CallManager network going out through the PSTN. International calls that originate in the Cisco Unified CallManager network going out through the PSTN. Outgoing, intercluster calls that originate on one Cisco Unified CallManager cluster and terminate on a different cluster.
Local
Long Distance
International
On Net
19-6
OL-10643-01
Chapter 19
Table 19-3 QoS Summary Report Call Types (continued)
Call Type Incoming
Description Inbound calls that originated outside the Cisco Unified CallManager network, entered through a gateway, and went into the Cisco Unified CallManager network. Inbound calls that originated outside the Cisco Unified CallManager network, entered the Cisco Unified CallManager network through a gateway, and were transferred outbound from the Cisco Unified CallManager network through a gateway. All other outgoing calls, such as toll-free numbers or emergency calls such as 911.
Tandem
Others
Step 4 Step 5
If you chose Generate New Report in Step 2, choose the date range for the period for which you want to generate the report. If you want the report in CSV format, choose CSV (comma separated value) in the Report Format area. If you want the report in PDF format, choose PDF (portable document format) in the Report Format area. Click the View Report button. The report displays.
Step 6
Step 7
If you want to mail the report, click the Send Report button. To send the report, follow the procedure that is described in Mailing a Report, page 18-20.
Related Topics

QoS Detail Report Configuration, page 19-2 QoS Summary Report Results, page A-16 Defining the Quality of Service (QoS) Values, page 17-9
19-7
Chapter 19 Configuring QoS Parameters
Configuring QoS Parameters

Only CAR administrators generate the QoS by gateway report. The report provides the percentage of calls that satisfy the selected QoS criteria for a period that is specified for the selected gateways. Only CAR administrators generate the QoS by call types report. The report provides jitter, latency, and lost packet information for a period that is specified for all calls of a chosen type. The following sections describe how to configure QoS parameters by gateway and by call type:

QoS by Gateway Configuration, page 19-8 QoS by Call Types Configuration, page 19-11
QoS by Gateway Configuration

Caution
Use CAR only during off-peak hours. Otherwise, data collection and report generation could cause performance degradation on the Cisco Unified CallManager system. This section describes how to generate, view, or mail QoS information about all chosen gateways.
Before You Begin
Configure the gateway by using the procedures in Gateway Configuration, page 16-8.
Procedure
Step 1
Choose System Reports > QoS > By Gateways. The QoS based on Gateways window displays. In the Generate Reports field, choose a time as described in Table 19-4.
Step 2
19-8
OL-10643-01
Chapter 19
CAR System Reports Configuration Configuring QoS Parameters
Table 19-4 Generate Report Fields
Parameter Hour of Day
Description Displays the percentage of the calls, for each selected gateway, that satisfies the QoS criteria for the period that you specify in Step 6. The percentage results show for hour of day. Displays the percentage of the calls, for each selected gateway, that satisfies the QoS criteria for the period that you specify in Step 6. The percentage results show for day of week. Displays the percentage of the calls, for each selected gateway, that satisfies the QoS criteria for the period that you specify in Step 6. The percentage results show for day of month.
Day of Week
Day of Month
Step 3 Step 4
In the Jitter field, choose the operator that you want to use and enter the value for jitter. See QoS Parameter Operators, page 19-32, for descriptions of operators. In the Latency field, choose the operator that you want to use and enter the value for latency. See QoS Parameter Operators, page 19-32, for descriptions of operators. In the Lost Packets field, choose the operator that you want to use and enter the value for number of lost packets. See QoS Parameter Operators, page 19-32, for descriptions of operators. Choose the date range of the period for which you want to see call information. To choose the type of gateway that you want included in the report, click Gateway Types in the column on the left side of the window. The tree structure expands and displays the type of gateway that you chose. To choose a gateway that uses a particular route pattern/hunt pilot, rather than a gateway type, click Route Patterns/Hunt Pilots in the column on the left side of the window. The tree structure expands and displays the route pattern that you chose.
Step 5
Step 6 Step 7
19-9
Note
You can also search for specific route patterns/hunt pilots by entering part of the name of the route pattern(s)/hunt pilot(s) in the Route Patterns/Hunt Pilots box in the column on the left side of the window. CAR searches for the route pattern(s)/hunt pilot(s) that matches the search string.
Step 8
From the list, choose a gateway type. The gateway name displays in the List of Gateways box.
Note
The List of Gateways box will display up to 200 gateways that are configured for the chosen gateway type.
Step 9
In the List of Gateways box, choose the gateways that you want to include in the report.
Note Step 10
You can generate a report for up to 15 gateways at a time.
Click the down arrow icon to move the chosen gateway to the list of Selected Gateways box. The gateway that you chose displays in the Selected Gateways box.
Step 11
If you want the report in CSV format, choose CSV (comma separated value) in the Report Format area. If you want the report in PDF format, choose PDF (portable document format) in the Report Format area. You can view CSV files in CAR or save them to disk and view them by using a spreadsheet application such as Microsoft Excel; you can view PDF files in CAR by using Adobe Acrobat Reader.
Step 12
Click the View Report button. If you chose PDF, the report generates, and you are prompted to view the file or to save it to disk. If you chose CSV, the report displays.
Step 13
19-10
OL-10643-01
Chapter 19
Related Topics

QoS by Gateways Report Results, page A-17 QoS Parameter Operators, page 19-32 QoS by Call Types Configuration, page 19-11
QoS by Call Types Configuration

This section describes how to generate, view, or mail QoS information about all calls of a certain type.
Caution
Procedure
Step 1
Choose System Reports > QoS > By Call Types. The QoS based on Call Types window displays. In the Generate Report field, choose a time as described in Table 19-5.
Step 2
Description Displays the percentage of the calls, for each call type, that satisfy the QoS criteria for the period that you specify in Step 7. The percentage results show for hour of day.
19-11
Table 19-5 Generate Report Fields (continued)
Parameter Day of Week
Description Displays the percentage of the calls, for each call type, that satisfy the QoS criteria for the period that you specify in Step 7. The percentage results show for day of week. Displays the percentage of the calls, for each call type, that satisfy the QoS criteria for the period that you specify in Step 7. The percentage results show for day of month.
Day of Month
Step 3 Step 4
In the Jitter field, choose the operator that you want to use and enter the value for jitter. See QoS Parameter Operators, page 19-32, for descriptions of operators. In the Latency field, choose the operator that you want to use and enter the value for latency. See QoS Parameter Operators, page 19-32, for descriptions of operators. In the Lost Packets field, choose the operator that you want to use and enter the value for number of lost packets. See QoS Parameter Operators, page 19-32, for descriptions of operators. In the Select Call Types area, check the check boxes for the types of calls that you want the report to include. Table 19-6 describes the call types.
Step 5
Step 6
19-12
OL-10643-01
Chapter 19
Table 19-6 QoS Parameters by Call Types
Call Type Internal
Description Intracluster calls that originated in the Cisco Unified CallManager network and ended in the same Cisco Unified CallManager network (no gateways are used). Local calls that are routed through the public switched telephone network (PSTN) to numbers without an area code or that include one of the local area codes. Long-distance calls that originate in the Cisco Unified CallManager network going out through the PSTN. International calls that originate in the Cisco Unified CallManager network going out through the PSTN. Outgoing, intercluster calls that originate on one Cisco Unified CallManager cluster and terminate on a different cluster. Inbound calls that originated outside the Cisco Unified CallManager network, entered through a gateway, and went into the Cisco Unified CallManager network.
Local
Long Distance
International
On Net
Incoming
19-13
Table 19-6 QoS Parameters by Call Types (continued)
Call Type Tandem
Description Inbound calls that originated outside the Cisco Unified CallManager network, entered the Cisco Unified CallManager network through a gateway, and were transferred outbound from the Cisco Unified CallManager network through a gateway. All other outgoing calls, such as toll-free numbers or emergency calls such as 911.
Others
Step 7 Step 8
Choose the date range for the period for which you want to see call information. If you want the report in CSV format, choose CSV (comma separated value) in the Report Format area. If you want the report in PDF format, choose PDF (portable document format) in the Report Format area. Click the View Report button. The report displays. If you want to mail the report, click the Send Report button. To send the report, follow the procedure that is described in Mailing a Report, page 18-20.
Step 9
Step 10
Related Topics

QoS by Call Types Report Results, page A-18 QoS Parameter Operators, page 19-32 QoS by Gateway Configuration, page 19-8
19-14
OL-10643-01
Chapter 19
CAR System Reports Configuration Configuring Traffic Reports
Configuring Traffic Reports

Only CAR administrators can generate the traffic summary report. The report provides information about the call volume for a period that you specify. Include only those call types and QoS voice-quality categories that you chose.
Tip
Use this report to determine the number of calls that are being made on an hourly or daily basis. This report helps you identify high- and low-traffic patterns for capacity planning. Only CAR administrators can generate the traffic summary by extensions report. The report provides information about the call volume for a period and set of extensions that you specify. Include only those call types and extensions that you chose.
Tip
You can use this report to track call usage by a specified group of users, by a department, or by another criteria, such as lobby phones or conference room phones. You can set up this report to generate on a weekly basis. This report helps you determine high-usage users or groups by aggregating the usage level across the users that you specify. The following sections describe how to configure traffic summary and traffic summary by extensions reports:

Configuring Traffic Summary, page 19-15 Configuring Traffic Summary by Extensions, page 19-19
Configuring Traffic Summary

Only CAR administrators generate the traffic summary report. The report provides information about the call volume for a period that you specify. You can either view reports that the system automatically generates or generate new reports. See System Scheduler Configuration, page 16-11, for more information.
19-15
Chapter 19 Configuring Traffic Reports
Caution
Use CAR only during off-peak hours. Otherwise, data collection and report generation could cause performance degradation on the Cisco Unified CallManager system. This section describes how to generate, view, or mail summary information about system traffic.
Procedure
Step 1
Choose System Reports > Traffic> Summary. The Traffic Summary window displays.
Step 2
In the Generate Report field, choose a time as described in Table 19-7.

Description Displays the average number of calls in the system for the period that you specify in Step 4, the call types you specify in Step 5, and the Qos values you specify in Step 6 for hour of day. Displays the average number of calls in the system for the period that you specify in Step 4, the call types you specify in Step 5, and the Qos values you specify in Step 6 for day of the week. Displays the average number of calls in the system for the period that you specify in Step 4, the call types you specify in Step 5, and the Qos values you specify in Step 6 for day of month.
Day of Week
Day of Month
Step 3
In the Available Reports field, choose an automatically generated report (if available) and go to Step 8 or use the default Generate New Report and go to Step 4.
19-16
OL-10643-01
Chapter 19
Step 4 Step 5
Choose the date range for the period for which you want to generate the report. In the Select Call Types area, check the check boxes for the types of calls that you want to include in the report. Table 19-8 describes the call types.
Table 19-8 Traffic Summary by Call Types
Call Type Internal
Description Intracluster calls that originated in the Cisco Unified CallManager network and ended in the same Cisco Unified CallManager network (no gateways are used). Local calls that are routed through the public switched telephone network (PSTN) to numbers without an area code or that include one of the local area codes. Long-distance calls that originate in the Cisco Unified CallManager network going out through the PSTN. International calls that originate in the Cisco Unified CallManager network going out through the PSTN. Outgoing, intercluster calls that originate on one Cisco Unified CallManager cluster and terminate on a different cluster. Inbound calls that originated outside the Cisco Unified CallManager network, entered through a gateway, and went into the Cisco Unified CallManager network. All other outgoing calls, such as toll-free numbers or emergency calls such as 911.
Local
Long Distance
International
On Net
Incoming
Others
19-17
Note
The calls that are shown in the chart/table comprise an average number of calls per day. If the data that is generated is less and you have chosen a large date range, the report shows negligible values, that are treated as 0, and the graph does not display. For example, if a Day of Week report gets generated for eight days that comprise two Mondays, the data shown for Monday represents the average number of calls for both of the Mondays (the sum of all the calls in each Monday divided by 3). Similarly, in an Hour of Day report, the data that is displayed against 05-06 will be the average number of calls per day between the time 05 and 06 of the date range that was chosen for the report.
Step 6
In the Select QoS area, check the check boxes for the voice-quality categories that you want to include in the report. The parameters set in the Defining the Quality of Service (QoS) Values, page 17-9 provide basis for all voice-quality categories.
Table 19-9 QoS Detail Report Voice Quality
Description QoS for these calls represents the highest possible quality. QoS for these calls, although slightly degraded, still falls within an acceptable range. QoS for these calls, although degraded, still remains within a usable range. Poor voice quality indicates that QoS for these calls is unsatisfactory. These calls did not match any criteria for the established QoS categories.
Fair Poor NA
Step 7
If you want the report in CSV format, choose CSV (comma separated value) in the Report Format area. If you want the report in PDF format, choose PDF (portable document format) in the Report Format area. Click the View Report button. The report displays.
Step 8
19-18
OL-10643-01
Chapter 19
Step 9
If you want to mail the report, click the Send Report button. To send the report, follow the procedure described in Mailing a Report, page 18-20.
Related Topics

Traffic Summary Report Results, page A-20 Configuring Traffic Summary by Extensions, page 19-19
Configuring Traffic Summary by Extensions

Only CAR administrators generate the traffic summary by extensions report. The report provides information about the call volume for a period and set of extensions that you specify. This section describes how to generate, view, or mail a traffic summary report based on user extensions.
Caution
Procedure
Step 1
Choose System Reports > Traffic > Summary By Extension. The Traffic Summary based on Extension(s) window displays. In the Generate Report field, choose a time as described in Table 19-10.
Step 2
19-19
Description Displays the average number of calls in the system for the chosen extension numbers for the date range that was chosen for hour of day.
Note
Ensure that the date and time range does not exceed one month.
Day of Week
Displays the average calls in the system for the selected extension numbers for the date range that was selected for day of week.
Note
Day of Month
Displays the average calls in the system for the selected extension numbers for the date range that was selected for day of month.
Note
Step 3
In the Select Call Types area, check the check boxes for the types of calls that you want to include in the report. Table 19-11 describes the call types.
19-20
OL-10643-01
Chapter 19
Table 19-11 Traffic Summary (Extn) by Call Types
Call Type Internal
Description Intracluster calls that originated in the Cisco Unified CallManager network and ended in the same Cisco Unified CallManager network (no gateways are used). Local calls that are routed through the public switched telephone network (PSTN) to numbers without an area code or that include one of the local area codes. Long-distance calls that originate in the Cisco Unified CallManager network going out through the PSTN. International calls that originate in the Cisco Unified CallManager network going out through the PSTN. Outgoing, intercluster calls that originate on one Cisco Unified CallManager cluster and terminate on a different cluster. Inbound calls that originated outside the Cisco Unified CallManager network, entered through a gateway, and went into the Cisco Unified CallManager network. All other outgoing calls, such as toll-free numbers or emergency calls such as 911.
Local
Long Distance
International
On Net
Incoming
Others
19-21
Note
The calls that are shown in the chart/table comprise an average number of calls per day. If the data generated is less and you have chosen a large date range, the report shows negligible values, that are treated as 0, and the graph does not display. For example, if a Day of Week report gets generated for eight days that comprise two Mondays, the data shown for Monday represents the average number of calls for both of the Mondays (the sum of all the calls in each Monday divided by 3). Similarly, in an Hour of Day report, the data that is displayed against 05-06 will be the average number of calls per day between the time 05 and 06 of the date range that was chosen for the report.
Step 4
In the Select Extensions field, you can either choose all extensions or search for extensions based on users.
Note
You can enter a wildcard pattern like ! or X to search on extensions. The ! represents any n digit that has 0-9 as each of its digits, and the X represents a single digit in the range 0-9.
To choose all extensions, check the Select All Extensions check box. To choose extensions based on users, enter the extension number of the individual in the Extension field and click the Add Extension button. You can also use a provided search function, as described in Searching for Users section on page 18-22.
Step 5
Step 6
Step 7
Related Topics

Traffic Summary Report Results, page A-20 Configuring Traffic Summary, page 19-15
19-22
OL-10643-01
Chapter 19
CAR System Reports Configuration Configuring Malicious Call Details Reports
Configuring Malicious Call Details Reports

Only CAR administrators generate the Malicious Call Details report. The report displays the details of malicious calls. This section describes how to generate, view, or mail a malicious call detail report.
Caution
Procedure
Step 1
Choose System Reports > Malicious Call Details. The Malicious Call Details window displays. In the From Date drop-down list boxes, choose the month, day, and year from which you want malicious call details. In the To Date drop-down list boxes, choose the month, day, and year to which you want malicious call details. In Report Format, choose either the CSV or PDF radio button. To view the report, click View Report. The Malicious Call Details report for the given date range displays in the chosen format.
Note
From this report, you can go back to the previous window, mail the report, access online help, or close the window by clicking either Back, Send Report, Help, or Close. If you want to mail the report, proceed to Step 8.
Step 6
To mail the report to an e-mail recipient, see Mailing a Report section on page 18-20.
19-23
Chapter 19 Configuring Precedence Call Summary
Related Topics

Malicious Call Details Report Results, page A-23 Chapter 14, System Reports, Cisco Unified CallManager Serviceability System Guide
Additional Documentation
Cisco Unified CallManager Features and Services Guide
Configuring Precedence Call Summary

Only CAR administrators generate the Precedence Call Summary report. The report displays the Call Summary for the precedence values that you choose. This section describes how to generate, view, or mail a Precedence Call Summary report.
Caution
Procedure
Step 1
Choose System Reports > Precedence Call Summary. The Call Summary by Precedence window displays. In the Generate Reports field, choose a time as described in Table 19-10. In the Select Precedence Levels field, check the precedence levels that you want in the report or click Select All to check all precedence levels.
Step 2 Step 3
Note Step 4 Step 5
Click Clear All to uncheck the precedence level check boxes.
In the From Date drop-down list boxes, choose the month, day, and year from which you want precedence summary information. In the To Date drop-down list boxes, choose the month, day, and year to which you want precedence summary information.
19-24
OL-10643-01
Chapter 19
CAR System Reports Configuration Configuring Client Matter Code Reports
Step 6 Step 7
In Report Format, choose either the CSV or PDF radio button. To view the report, click View Report. The Call Summary by Precedence report for the given date range displays in the chosen format.
Note
From this report, you can go back to the previous window, mail the report, access online help, or close the window by clicking either Back, Send Report, Help, or Close. If you want to mail the report, proceed to Step 8.
Step 8
To mail the report to an e-mail recipient, see Mailing a Report section on page 18-20.
Related Topics

Precedence Call Summary Report Results, page A-24 Chapter 14, System Reports, Cisco Unified CallManager Serviceability System Guide
Additional Documentation
Cisco Unified CallManager Features and Services Guide
Configuring Client Matter Code Reports

Only CAR administrators can generate the Client Matter Code report. You can generate a report that shows the originating and destination numbers, the date and time that the call originated, the call duration in seconds, and the call classification for calls that relate to each chosen client matter code. The following procedure describes how to generate a report that shows the usage of specific client matter codes.
Caution
Use CAR only during off-peak hours; otherwise, data collection and report generation could cause performance degradation on the Cisco Unified CallManager system.
19-25
Chapter 19 Configuring Client Matter Code Reports
Procedure
Step 1
Choose System Reports > FAC CMC > Client Matter Code. The Call Details for Client Matter Code window displays a list of all client matter codes that are configured in the system.
Step 2
In the List of Client Matter Codes box, choose the codes that you want included in the report.
Note Step 3
You can choose up to 100 client matter codes.
Click the down button to add the chosen code(s) to the Selected Client Matter Codes box. The report will include all codes, for which data is available, that are listed in this box.
Step 4 Step 5
In the From Date and To Date pull-down list boxes, enter the date range of the period for which you want to see client matter code information. In Report Format, choose the CSV radio button if you want the report to generate in CSV (comma separated value) format or the PDF radio button if you want the report to generate in PDF (portable document format). Click View Report. The report displays. If you want to mail the report, click the Send Report button. To send the report, follow the procedure that is described in Mailing a Report section on page 18-20.
Step 6
Step 7
Related Topics

Configuring Authorization Code Name Reports, page 19-27 Configuring Authorization Level Reports, page 19-28 CDR Analysis and Reporting, Cisco Unified CallManager Serviceability System Guide
19-26
OL-10643-01
Chapter 19
CAR System Reports Configuration Configuring Authorization Code Name Reports
Configuring Authorization Code Name Reports

Only CAR administrators can generate the Authorization Code Name report. You can generate a report that shows the originating and destination numbers, the date and time that the call originated, the call duration in seconds, the call classification, and the authorization level for calls that relate to each chosen authorization code name.
Note
For security purposes, the authorization code does not display; instead, the authorization code name (description) displays. The following procedure describes how to generate a report that shows the usage of specific authorization code names.
Caution
Procedure
Step 1
Choose System Reports > FAC CMC > Authorization Code Name. The Call Details for Authorization Code Name window displays a list of all authorization code names that are configured in the system.
Step 2
In the List of Authorization Code Names box, choose the code names that you want included in the report.
Note Step 3
You can choose up to 30 code names.
Click the down button to add the chosen code name(s) to the Selected Authorization Code Names box. The report will include all code names, for which data is available, that are listed in this box.
Step 4
In the From Date and To Date pull-down list boxes, enter the date range of the period for which you want to see authorization code name information.
19-27
Chapter 19 Configuring Authorization Level Reports
Step 5
In Report Format, choose the CSV radio button if you want the report to generate in CSV (comma separated value) format, or the PDF radio button if you want the report to generate in PDF (portable document format). Click View Report. The report displays.
Step 6
Step 7
If you want to mail the report, click the Send Report button. To send the report, follow the procedure that is described in Mailing a Report section on page 18-20.
Related Topics

Configuring Client Matter Code Reports, page 19-25 Configuring Authorization Level Reports, page 19-28 CDR Analysis and Reporting, Cisco Unified CallManager Serviceability System Guide
Configuring Authorization Level Reports

Only CAR administrators can generate the Authorization Level report. You can generate a report that shows the originating and destination numbers, the date and time that the call originated, the call duration in seconds, and the call classification for calls that relate to each chosen authorization level. The following procedure describes how to generate a report that shows the usage of specific authorization levels.
Caution
Procedure
Step 1
Choose System Reports > FAC CMC > Authorization Level.
19-28
OL-10643-01
Chapter 19
CAR System Reports Configuration Configuring Authorization Level Reports
The Call Details by Authorization Level window displays a list of all authorization levels that are configured in the system.
Step 2 Step 3
In the List of Authorization Levels box, choose the levels that you want included in the report. Click the down button to add the chosen level(s) to the Selected Authorization Levels box. The report will include all levels, for which data is available, that are listed in this box.
Note
Only FAC authorization levels reports associated with Route Patterns will be generated.
Step 4 Step 5
In the From Date and To Date pull-down list boxes, enter the date range of the period for which you want to see authorization level information. In Report Format, choose the CSV radio button if you want the report to generate in CSV (comma separated value) format or the PDF radio button if you want the report to generate in PDF (portable document format). Click View Report. The report displays.
Step 6
Step 7
Related Topics

Configuring Client Matter Code Reports, page 19-25 Configuring Authorization Code Name Reports, page 19-27 CDR Analysis and Reporting, Cisco Unified CallManager Serviceability System Guide
19-29
Chapter 19 Configuring System Overview
Configuring System Overview

Only CAR administrators generate the system overview report that provides the entire set of system reports in one report. You can either view reports that the system automatically generates or generate new reports. Only CAR administrators can schedule reports for automatic generation. See System Scheduler Configuration, page 16-11, for more information.
Caution
Use CAR only during off-peak hours. Otherwise, data collection and report generation could cause performance degradation on the Cisco Unified CallManager system. This section describes how to generate, view, or mail summary information about the Cisco Unified CallManager system.
Procedure
Step 1
Choose System Reports > System Overview. The System Overview window displays. In the Available Reports field, choose an automatically generated report (if available) and go to Step 6, or use the default Generate New Report and go to Step 3. Choose the date range for the period for which you want to generate the report. From the List of Reports, choose the reports that you want generated by highlighting the report and clicking the right arrow icon. The reports that you chose appear in the Selected Reports list box.
Step 2
Step 3 Step 4
Tip
You can highlight more than one report at a time by holding down the Ctrl key on your keyboard while clicking the reports.
Step 5
If you want the report in CSV format, choose CSV (comma separated value) in the Report Format area. If you want the report in PDF format, choose PDF (portable document format) in the Report Format area.
19-30
OL-10643-01
Chapter 19
CAR System Reports Configuration Configuring CDR Error
Step 6
Click the View Report button. The report displays.
Step 7
Related Topic

System Overview Report Results, page A-25 Enabling or Customizing Reports for Automatic Generation, page 17-13
Configuring CDR Error

Only CAR administrators generate the CDR error report. The report provides statistics for the number of error records in the CAR Billing_Error table and the reason for the errors. This section describes how to generate, view, or mail information about CDR errors.
Caution
Procedure
Step 1
Choose System Reports > CDR Error. The CDR Error window displays. Choose the date range of the period for which you want to generate the report. If you want the report in CSV format, choose CSV (comma separated value) in the Report Format area. If you want the report in PDF format, choose PDF (portable document format) in the Report Format area. Click the View Report button.
Step 2 Step 3
Step 4
19-31
Chapter 19 QoS Parameter Operators
The report displays.

Step 5
Related Topic
CDR Error Report Results, page A-27
QoS Parameter Operators

Table 19-12 describes the QoS parameter operators.
Table 19-12 QoS Parameter Operators
Operator >=
Description Choose this operator to generate jitter, latency, or lost packet data that is greater than or equal to the specified value. Choose this operator to generate jitter, latency, or lost packet data that is equal to the specified value. Choose this operator to generate jitter, latency, or lost packet data that is less than or equal to the specified value. Choose this operator to preclude jitter, latency, or lost packet data. Choose this operator to generate jitter, latency, or lost packet data that occurs between one value and another value. When you choose this operator, a second field displays, so you can set the start and end values.
<=
N.A. Between
19-32
OL-10643-01
C H A P T E R
20
CAR Device Reports Configuration

CAR provides reporting capabilities for three levels of users: Administrators, managers, and individual users. Only administrators generate device reports. Device reports track the load and performance of Cisco Unified CallManager-related devices, such as conference bridges, voice-mail server, and gateways. This chapter contains the following topics:

Configuring Gateway Reports, page 20-1 Configuring Route Plan Reports, page 20-10 Configuring Conference Call Details, page 20-18 Configuring Conference Bridge Utilization Reports, page 20-20 Configuring Voice-Messaging Utilization Reports, page 20-22
Configuring Gateway Reports

Configure the following device reports for gateways:

Gateway Detail Gateway Summary Gateway Utilization
20-1
Chapter 20 Configuring Gateway Reports
Gateway Detail Report Configuration

Only CAR administrators generate the gateway detail report. Use the gateway detail report to track issues with specific gateways. This section describes how to generate, view, or mail detailed information about selected gateways.
Caution
Procedure
Step 1
Choose Device Reports > Gateway > Detail. The Gateway Detail window displays. To display the list of gateways in the List of Gateways box that you can include in the report, perform one of the following tasks:

Step 2
To display all gateways in the List of Gateways box, click Gateway Types in the column on the left side of the window. To display gateways for a particular gateway type in the List of Gateways box, click the icon next to Gateway Types in the column on the left side of the window. The tree structure expands, and a list of gateway types displays. Choose a gateway type from the list, and the gateway name displays in the List of Gateways box.
Note
The List of Gateways box will list up to 200 gateways that are configured for the chosen gateway type. To specify gateways that use any route pattern, rather than a gateway type, click Route/Patterns/Hunt Pilots in the column on the left side of the window.
20-2
OL-10643-01
Chapter 20
CAR Device Reports Configuration Configuring Gateway Reports
To specify only those gateways that use a particular route pattern, rather than a gateway type, click the icon next to Route Patterns/Hunt Pilots in the column on the left side of the window. The tree structure expands and displays a list of route patterns/hunt lists. Choose a gateway from the list, and the gateway name displays in the List of Gateways box.
Note
You can also search for specific route patterns/hunt lists by entering part of the name of the route pattern(s)/hunt list(s) in the Route Patterns/Hunt Pilots box in the column on the left side of the window. CAR searches for the route pattern(s)/hunt list(s) that matches the search string.
Step 3
Note Step 4
You can generate up to 15 gateways at a time.
Click the down arrow icon to move the chosen gateway to the list of Selected Gateways box. The gateway(s) that you chose displays in the Selected Gateways box.
Step 5
In the Select Call Types area, check the check boxes for the types of calls that you want to include in the report. Table 20-1 describes the call types.
Table 20-1 Gateway Details by Call Types
Call Type Local
Description Local calls that are routed through the public switched telephone network (PSTN) to numbers without an area code or that include one of the local area codes. Long-distance calls that originate in the Cisco Unified CallManager network going out through the PSTN. International calls that originate in the Cisco Unified CallManager network going out through the PSTN.
Long Distance
International
20-3
Table 20-1 Gateway Details by Call Types (continued)
Call Type On Net
Description Outgoing, intercluster calls that originate on one Cisco Unified CallManager cluster and terminate on a different cluster. Inbound calls that originated outside the Cisco Unified CallManager network, entered through a gateway, and went into the Cisco Unified CallManager network. Inbound calls that originated outside the Cisco Unified CallManager network, entered the Cisco Unified CallManager network through a gateway, and were transferred outbound from the Cisco Unified CallManager network through a gateway. All other outgoing calls, such as toll-free numbers or emergency calls such as 911.
Incoming
Tandem
Others
Step 6
In the Select QoS area, check the check boxes for the voice-quality categories that you want to include in the report. The parameters that are set in Defining the Quality of Service (QoS) Values, page 17-9, provide basis for all voice-quality categories.
Table 20-2 Gateway Detail Voice Quality
Description QoS for these calls represents the highest possible quality. QoS for these calls, although slightly degraded, still falls within an acceptable range.
20-4
OL-10643-01
Chapter 20
Table 20-2 Gateway Detail Voice Quality (continued)
Voice Quality Fair Poor NA
Description QoS for these calls represents degraded quality but still within a usable range. QoS for these calls represents unsatisfactory quality. These calls did not match any criteria for the established QoS categories.
Step 7
Choose the date range for the period for which you want to see call information.
Note Step 8
Ensure the date and time range does not exceed one month.
Step 9
Step 10
Related Topic
Gateway Detail Report Results, page A-28
Gateway Summary Report Configuration

Only CAR administrators generate the gateway summary report. This report provides a summary of all the calls that went through the gateways. You can use this information for monitoring the traffic and QoS for calls through the gateways. You can either view reports that the system automatically generates or generate new reports. Only CAR administrators can schedule reports for automatic generation. See CAR System Configuration, page 16-1, for more information.
20-5
Caution
Use CAR only during off-peak hours. Otherwise, data collection and report generation could cause performance degradation on the Cisco Unified CallManager system. This section describes how to generate, view, or mail summary information about gateways.
Procedure
Step 1
Choose Device Reports > Gateway > Summary. The Gateway Summary window displays.
Step 2
In the Available Reports field, choose an automatically generated report (if available) and go to Step 6 or use the default setting, Generate New Report, and go to Step 3. In the Select Call Types area, check the check boxes for the types of calls that you want to include in the report. Table 20-3 describes the call types.
Table 20-3 Gateway Summary Call Types
Step 3
Call Type On Net
Description Outgoing, intercluster calls that originate on one Cisco Unified CallManager cluster and terminate on a different cluster. Intracluster calls that originate in the Cisco Unified CallManager network and end in the same Cisco Unified CallManager network (no gateways are used). Local calls that are routed through the public switched telephone network (PSTN) to numbers without an area code or that include one of the local area codes. Long-distance calls that originate in the Cisco Unified CallManager network going out through the PSTN.
Internal
Local
Long Distance
20-6
OL-10643-01
Chapter 20
Table 20-3 Gateway Summary Call Types (continued)
Call Type International
Description International calls that originate in the Cisco Unified CallManager network going out through the PSTN. Inbound calls that originated outside the Cisco Unified CallManager network, entered through a gateway, and went into the Cisco Unified CallManager network. Inbound calls that originated outside the Cisco Unified CallManager network, entered the Cisco Unified CallManager network through a gateway, and were transferred outbound from the Cisco Unified CallManager network through a gateway. All other outgoing calls, such as toll-free numbers or emergency calls such as 911.
Incoming
Tandem
Others
Step 4 Step 5
If you chose Generate New Report, choose the date range of the period for which you want to generate the report. If you want the report in CSV format, choose CSV (comma separated value) in the Report Format area. If you want the report in PDF format, choose PDF (portable document format) in the Report Format area. Click the View Report button. The report displays. If you want to mail the report, click the Send Report button. To send the report, follow the procedure that is described in Mailing a Report, page 18-20.
Step 6
Step 7
Related Topic
Gateway Summary Report Results, page A-30
20-7
Gateway Utilization Reports Configuration

Only CAR administrators generate the gateway utilization report. The report provides an estimate of the utilization percentage of the gateway for the period and not the exact utilization. For example, the system calculates the utilization of a gateway between 11hrs-12hrs, as (number of calls in the 5-minute interval that used the gateway *100) / (maximum number of calls that could possibly use the gateway at any time). Maximum number of calls that are possible by using the gateway at any time = maximum number of ports for the gateway as configured in the CAR Gateway Configuration window. After calculating the utilization for each 5-minute sample for the whole 1-hour duration, the maximum utilization value found for that 1 hour displays in the report as the utilization for the time between 11hrs and 12hrs. Similarly, to get a utilization for the whole day, the whole day gets divided into samples of 5 minutes each, and maximum utilization is calculated. You can examine the usage based on each hour of a day or on a specified number of days for each week or month. Reports generate for each gateway that is chosen. You can either view reports that the system automatically generates or generate new reports. Only CAR administrators can schedule reports for automatic generation. See CAR System Configuration, page 16-1, for more information.
Caution
Use CAR only during off-peak hours. Otherwise, data collection and report generation could cause performance degradation on the Cisco Unified CallManager system. This section describes how to generate, view, or mail gateway utilization reports.
Procedure
Step 1
Choose Device Reports > Gateway > Utilization. The Gateway Utilization window displays.
Step 2
In the Generate Reports field, choose a time as described in Table 20-4.
20-8
OL-10643-01
Chapter 20
Description Displays the cumulative results for each hour in a 24-hour period for the period that you specify in Step 8. Displays the days of the week that occur within the period that you specify in Step 8. Displays the days of the month that occur within the period that you specify in Step 8.
Day of Week
Day of Month
Step 3
In the Available Reports field, choose an automatically generated report (if available) and go to Step 10, or use the default Generate New Report and go to Step 4. To choose the type of gateway that you want to include in the report, click Gateway Types in the column on the left side of the window. The tree structure expands, and a list of gateway types displays. A list of gateway types displays. To specify only those gateways that use a particular route pattern, rather than a gateway type, click Route Patterns/Hunt Pilots in the column on the left side of the window. The tree structure expands and displays a list of route patterns/hunt lists.
Step 4
Note
You can also search for specific route patterns/hunt lists by entering part of the name of the route pattern(s) or hunt list(s) in the Route Patterns/Hunt Pilots box in the column on the left side of the window. CAR searches for the route pattern(s)/hunt list(s) that matches the search string.
Step 5
Choose a gateway type from the list. The gateway name displays in the List of Gateways box.
20-9
Chapter 20 Configuring Route Plan Reports
Note
Step 6
Note Step 7
Click the down arrow icon to move the chosen gateway to the list of Selected Gateways box. The gateway(s) that you chose displays in the Selected Gateways box.
Step 8
If you chose Generate New Report, enter the date range of the period for which you want to see call information.
Note Step 9
Step 10
Step 11
Related Topic
Gateway and Route Utilization Report Results, page A-31
Configuring Route Plan Reports

Configure the following device reports for route plans:
20-10
OL-10643-01
Chapter 20
CAR Device Reports Configuration Configuring Route Plan Reports
Route and Line Group Utilization Route/Hunt List Utilization Route Pattern/Hunt Pilot Utilization
Route and Line Group Utilization Reports Configuration

Only CAR administrators generate the route and line group utilization report. This report provides an estimate of the maximum utilization percentage of the route and line group (cumulative utilization of all the gateways under the route and line group) for the period and not the exact utilization. The system calculates the utilization in the same way as it is done for Gateway Utilization, but this calculation gives cumulative utilization of all the gateways under the route and line group. You can examine the usage based on each hour of a day or on a specified number of days for each week or month. Reports generate for each of the selected route and line groups. You can either view reports that the system automatically generates or generate new reports. Only CAR administrators can schedule reports for automatic generation. See CAR System Configuration, page 16-1, for more information.
Caution
Use CAR only during off-peak hours. Otherwise, data collection and report generation could cause performance degradation on the Cisco Unified CallManager system. This section describes how to generate, view, or mail route and line group utilization reports.
Procedure
Step 1
Choose Device Reports > Route Plan > Route and Line Group Utilization. The Route and Line Group Utilization window displays. In the Generate Reports field, choose a time as described in Table 20-5.
Step 2
20-11
Day of Week
Day of Month
Step 3
In the Available Reports field, choose an automatically generated report (if available) and go to Step 10, or use the default Generate New Report and go to Step 4. To choose only those route and line groups that use a particular route pattern, click Route Patterns/Hunt Pilots in the column on the left side of the window. The tree structure expands and displays the route patterns/hunt lists that you chose.
Step 4
Note
You can also search for specific route patterns/hunt lists by entering part of the name of the route pattern(s)/hunt list(s) in the Route Patterns/Hunt Pilots box in the column on the left side of the window. CAR searches for the route pattern(s)/hunt list(s) that matches the search string.
Step 5
Choose a route pattern/hunt list from the list. The route and line groups for this route pattern/hunt list display in the List of Route/Line Groups box.
Note Step 6
The List of Route/Line Groups box will display up to 200 route groups.
In the List of Route/Line Groups box, choose the route/line groups that you want to include in the report.
20-12
OL-10643-01
Chapter 20
Note Step 7
You can generate a report for up to 15 route/line groups at a time.
Click the down arrow icon to move the chosen gateway to the list of Selected Route/Line Groups box. The route/line groups that you chose display in the Selected Route Groups box. If you chose Generate New Report, enter the date range of the period for which you want to see call information.
Step 8
Note Step 9
Step 10
Step 11
Related Topic
Route/Hunt List Utilization Report Configuration

Only CAR administrators generate the route/hunt list utilization report. The route/hunt list utilization report provides an estimate of the maximum utilization percentage of the route/hunt list (cumulative utilization of all the gateways under the route/hunt list) for the period and not the exact utilization. The system calculates the utilization in the same way as it is done for Gateway Utilization, but this gives cumulative utilization of all the gateways under the route/hunt list. You can examine the usage based on each hour of a day or on a specified number of days for each week or month. Reports generate for each of the selected route/hunt lists.
20-13
You can either view reports that the system automatically generates or generate new reports. Only CAR administrators can schedule reports for automatic generation. See System Scheduler Configuration, page 16-11, for more information.
Caution
Use CAR only during off-peak hours. Otherwise, data collection and report generation could cause performance degradation on the Cisco Unified CallManager system. This section describes how to generate, view, or mail route/hunt list utilization reports.
Procedure
Step 1
Choose Device Reports > Route Plan > Route/Hunt List Utilization. The Route/Hunt List Utilization window displays. In the Generate Report field, choose a time as described in Table 20-6.
Step 2
Day of Week
Day of Month
Step 3
In the Available Reports field, choose an automatically generated report (if available) and go to Step 10, or use the default Generate New Report and go to Step 4. To choose the route/hunt lists that you want to include in the report, click Route Patterns/Hunt Pilots in the column on the left side of the window.
Step 4
20-14
OL-10643-01
Chapter 20
The tree structure expands and displays the route patterns/hunt pilots that you chose.
Note
You can also search for specific route patterns/hunt lists by entering part of the name of the route pattern(s)/hunt lists in the Route Patterns/Hunt Pilots box in the column on the left side of the window. CAR searches for the route pattern(s)/hunt list(s) that matches the search string.
Step 5
Choose a route/hunt list from the list. The route/hunt list name displays in the List of Route/Hunt Lists box.
Note Step 6
The List of Route/Hunt Lists box will display up to 200 route/hunt lists.
In the List of Route/Hunt Lists box, choose the route/hunt lists that you want to include in the report.
Note Step 7
You can generate a report for up to 15 route/hunt lists at a time.
Click the down arrow icon to move the chosen route/hunt lists to the list of Selected Route/Hunt Lists box. The route/hunt lists that you chose display in the Selected Route/Hunt Lists box.
Step 8
Note Step 9
Step 10
20-15
Step 11
Related Topic
Route Pattern/Hunt Pilot Utilization Report Configuration

Only CAR administrators generate the route pattern/hunt pilot utilization report. The report provides an estimate of the maximum utilization percentage of the route pattern/hunt pilot (cumulative utilization of all the gateways under the route pattern/hunt pilot) for the period and not the exact utilization. The system calculates the utilization in the same way as it is done for Gateway Utilization, but this gives cumulative utilization of all the gateways under the route pattern/hunt pilot. You can examine the usage based on each hour of a day or on a specified number of days for each week or month. Reports generate for each of the selected route patterns/hunt pilots. You can either view reports that the system automatically generates or generate new reports. Only CAR administrators can schedule reports for automatic generation. See System Scheduler Configuration, page 16-11, for more information.
Caution
Use CAR only during off-peak hours. Otherwise, data collection and report generation could cause performance degradation on the Cisco Unified CallManager system. This section describes how to generate, view, or mail route pattern/hunt pilot utilization reports.
Procedure
Step 1
Choose Device Reports > Route Plan > Route Pattern/Hunt Pilot Utilization. The Route Pattern/Hunt Pilot Utilization window displays. In the Generate Report field, choose a time as described in Table 20-7.
Step 2
20-16
OL-10643-01
Chapter 20
Day of Week
Day of Month
Step 3
In the Available Reports field, choose an automatically generated report (if available) and go to Step 10, or use the default Generate New Report and go to Step 4. To choose the route pattern(s)/hunt list(s) that you want to include in the report, click Route Patterns/Hunt Pilots in the column on the left side of the window. The tree structure expands and displays the route pattern(s)/hunt list(s) that you chose.
Step 4
Note
You can also search for specific route patterns/hunt lists by entering part of the name of the route pattern(s)/hunt list(s) in the Route Patterns box in the column on the left side of the window. CAR searches for the route pattern(s)/hunt list(s) that matches the search string.
Step 5
Choose a route pattern/hunt list from the list. The route pattern/hunt list name displays in the List of Route Patterns/Hunt Pilots box.
Note
The List of Route Patterns/Hunt Pilots box will display up to 200 route patterns/hunt lists.
20-17
Chapter 20 Configuring Conference Call Details
Step 6
In the List of Route Patterns/Hunt Pilots box, choose the route patterns/hunt lists that you want to include in the report.
Note Step 7
You can generate a report for up to 15 route patterns/hunt pilots at a time.
Click the down arrow icon to move the chosen route pattern/hunt list to the list of Selected Route Patterns/Hunt Pilots box. The route pattern/hunt list that you chose displays in the Selected Route Patterns/Hunt Pilots box.
Step 8
Note Step 9
Ensure the date and time range do not exceed one month.
Step 10
Step 11
Related Topic
Configuring Conference Call Details

Only CAR administrators generate the Conference Call Details report. The Conference Call Details reports allows you to generate and view details about conference calls.
20-18
OL-10643-01
Chapter 20
CAR Device Reports Configuration Configuring Conference Call Details
Caution
Use CAR only during off-peak hours. Otherwise, data collection and report generation could cause performance degradation on the Cisco Unified CallManager system. This section describes how to generate, view, or mail a Conference Call Details report.
Procedure
Step 1
Choose Device Reports > Conference Bridge > Call Details. The Conference Call Details window displays.
Step 2 Step 3
In the Report Type pull-down menu, choose either Summary or Detail. In the Available Reports field, choose an automatically generated report (if available) and go to Step 7, or use the default Generate New Report and go to Step 4. In Select Conference Types, check the check box of the conference type that you want to include in the report. If you chose Generate New Report, enter the date range of the period for which you want to see conference call details.
Step 4 Step 5
Note Step 6
Step 7
Step 8
Related Topic
Conference Call Detail Report Results, page A-32

OL-10643-01
20-19
Chapter 20 Configuring Conference Bridge Utilization Reports
Configuring Conference Bridge Utilization Reports

Only CAR administrators generate the conference bridge utilization report. The report provides an estimate of the maximum utilization percentage of the Conference Bridges (cumulative utilization of all the Conference Bridges in the system) for the period and not the exact utilization. For example, the system calculates the utilization of a Conference Bridge between 11hrs and 12hrs by sampling the 1-hour duration in 5-minute equal samples. The utilization for each 5 minutes gets calculated as (number of calls in the 5-minute interval that used the conference bridge *100) / (maximum number of calls that the conference bridge can handle at any time). After calculating the utilization for each 5-minute sample for the whole one-hour duration, the maximum utilization value found for that one hour displays in the report as the utilization for the time between 11hrs and 12hrs. You can examine the usage based on each hour of a day or on a specified number of days for each week or month. Reports generate for each conference bridge. You can either view reports that the system automatically generates or generate new reports. Only CAR administrators can schedule reports for automatic generation. See System Scheduler Configuration, page 16-11, for more information.
Caution
Use CAR only during off-peak hours. Otherwise, data collection and report generation could cause performance degradation on the Cisco Unified CallManager system. This section describes how to generate, view, or mail conference bridge utilization reports for each conference bridge type.
Procedure
Step 1
Choose Device Reports > Conference Bridge > Utilization. The Conference Bridge Utilization window displays. In the Generate Report field, choose a time as described in Table 20-8.
Step 2
20-20
OL-10643-01
Chapter 20
CAR Device Reports Configuration Configuring Conference Bridge Utilization Reports
Day of Week
Day of Month
Step 3
In the Available Reports field, choose an automatically generated report (if available) and go to Step 8, or use the default Generate New Report and go to Step 4. From the Conference Bridge Types column in the left side panel, choose the conference bridge type(s) that you want to include in the utilization report. The conference bridges of the particular conference bridge type that you chose display in the List of Devices box.
Step 4
Step 5
When you have chosen all the conference bridges that you want to include in the report, click the down arrow to add them to the Selected Devices box. If you chose Generate New Report, enter the date range of the period for which you want to see call information.
Step 6
Note Step 7
Step 8
20-21
Chapter 20 Configuring Voice-Messaging Utilization Reports
Step 9
Related Topic
Conference Bridge Utilization Report Results, page A-33
Configuring Voice-Messaging Utilization Reports

Only CAR administrators generate the voice-messaging utilization report. The report provides an estimate of the maximum utilization percentage of the voice messaging devices for the period and not the exact utilization. For example, the system calculates the utilization of a voice-messaging device between 11hrs and 12hrs by sampling the 1-hour duration in 5-minute samples. The system calculates utilization for each 5 minutes as (number of calls in the 5-minute interval that used the voice-messaging devices *100) / (maximum number of calls that the voicemessaging devices can handle at any time). After calculating the utilization for each 5-minute sample for the entire one-hour duration, the maximum utilization value that is found for that one hour displays in the report as the utilization for the time between 11hrs and 12hrs. Similarly, to get a utilization for the whole day, the whole day comprises samples of 5 minutes each, and maximum utilization gets calculated. You can examine the usage based on each hour of a day or on a specified number of days for each week or month. Reports generate for each voice- messaging server. You can either view reports that the system automatically generates or generate new reports. Only CAR administrators can schedule reports for automatic generation. See System Scheduler Configuration, page 16-11, for more information.
Note
The CAR voice-messaging utilization report only supports Cisco uOne, Unity, and Octel Voicemail gateway.
20-22
OL-10643-01
Chapter 20
CAR Device Reports Configuration Configuring Voice-Messaging Utilization Reports
Caution
Use CAR only during off-peak hours. Otherwise, data collection and report generation could cause performance degradation on the Cisco Unified CallManager system. This section describes how to generate, mail, or view voice-messaging utilization reports.
Procedure
Step 1
Choose Device Reports > Voice Messaging > Utilization. The Voice Messaging Utilization window displays.
Step 2
In the Generate Report field, choose a time as described in Table 20-9.

Day of Week
Day of Month
Step 3
In the Available Reports field, choose an automatically generated report (if available) and go to Step 14, or use the default Generate New Report and go to Step 4. To choose a voice-messaging DN, click Voice Messaging DNs in the left side panel. A list of configured voice-messaging DNs displays. From the list of DNs, choose a voice messaging DN. The DN that you chose displays in the List of DNs/Ports list box.
Step 4
Step 5
OL-10643-01
20-23
Chapter 20 Configuring Voice-Messaging Utilization Reports
Step 6
In Select Voice Messaging DNs/Ports, click the down arrow icon. The DN that you chose displays in the Selected DNs/Ports list box.
Step 7 Step 8
Repeat Step 5 and Step 6 until you have chosen all DNs that you want to include in the report. To choose a voice-messaging port, click Voice Messaging Ports in the left side panel. A list of configured voice-messaging ports displays. From the list of ports, choose a voice-messaging port. The port that you chose displays in the List of DNs/Ports list box. In Select Voice Messaging DNs/Ports, click the down arrow icon. The port that you chose displays in the Selected DNs/Ports list box.
Step 9
Step 10
Step 11 Step 12
Repeat Step 9 and Step 10 until you have chosen all the ports that you want to include in the report. If you chose Generate New Report, enter the date range of the period for which you want to see call information.
Note Step 13
Step 14
Step 15
Related Topic
Voice Messaging Utilization Report Results, page A-34
20-24
OL-10643-01
C H A P T E R
21
CDR Search Configuration

CAR provides reporting capabilities for three levels of users: Administrators, managers, and individual users. Only CAR administrators can use CDR Search. This chapter contains the following topics:

Configuring CDR Search by User Extension, page 21-2 Configuring CDR Search by Gateway, page 21-3 Configuring CDR Search by Cause for Call Termination, page 21-5 Viewing Call Termination Details, page 21-7 Configuring CDR Search By Call Precedence Levels, page 21-8 Configuring CDR Search for Malicious Calls, page 21-10
Before You Begin
Make sure that you set the Cisco Unified CallManager service parameters CDR Enabled Flag and Call Diagnostics Enabled to true (enabled), so that the system can generate CDR/CMR data. By default, the system disables these service parameters. For more information about these service parameters, refer to the Cisco Unified CallManager Administration Guide. All CAR reports use CDR data. Be sure to have the most current CDR data from which your reports are built. By default, CDR data loads daily from midnight to 5 a.m. However, you can set the loading time, interval, and duration as needed. See System Scheduler Configuration, page 16-11, for more information.
21-1
Chapter 21 Configuring CDR Search by User Extension
Configuring CDR Search by User Extension

Only CAR administrators use the CDR search by user extension feature. This section describes how to show the details of CDR data based on a user or extension.
Caution
Procedure
Step 1
Choose CDR > Search > By User/Extension. The CDR Search by User Extension window displays.
Note
You can enter a wildcard pattern like ! or X to search on extensions. The ! represents any n digit having 0-9 as each of its digits, and the X represents a single digit in the range 0-9.
Step 2

To search CDRs based on extensions, enter the extension number in the Extension field and click the Add Extension button. To search CDRs based on user, click the Search Extension(s) based on User(s) link, enter the first few letters of the first and/or last name in the First Name and/or Last Name fields, and click the Search button. When the results display, click the Select link next to the result that you want to include. Click the Close button.
The extension displays in the Selected Extension(s) box.
Note
To delete an item from the Report Criteria box, click the Remove Extension(s) button. You can delete all items from the Report Criteria box by clicking the Remove All Extensions button.
21-2
OL-10643-01
Chapter 21
CDR Search Configuration Configuring CDR Search by Gateway
Step 3 Step 4
Choose the date range of the period for which you want to see CDR data for the specified user or extension. Click the OK button. The CDR-CMR Results window displays. If the search returns more than 100 records, a message indicates that the result will be truncated.
Step 5 Step 6
To view the CMR data, click the Others button; to view both the CDR and CMR data fields, click the View button. To mail the report to e-mail recipient(s), follow the steps in Mailing a Report section on page 18-20.
Related Topics

Understanding the Results for CDR Search, page A-35 Media Information, page A-37 CDR and CMR Dump Tables, page A-38 Configuring CDR Search by Gateway, page 21-3 Configuring CDR Search by Cause for Call Termination, page 21-5 Viewing Call Termination Details, page 21-7 Configuring CDR Search By Call Precedence Levels, page 21-8 Configuring CDR Search for Malicious Calls, page 21-10
Configuring CDR Search by Gateway

Only CAR administrators use the CDR search by gateway feature. This section describes how to search CDR data based on a specific gateway type or on those gateways that use a chosen route pattern.
Caution
21-3
Chapter 21 Configuring CDR Search by Gateway
Procedure
Step 1
Choose CDR > Search > By Gateway. The CDR Search by Gateway window displays.
Step 2
To choose the type of gateway that you want to include in the report, click Gateway Types in the column on the left side of the window. The tree structure expands, and a list of gateway types displays.
To specify only those gateways that use a particular route pattern/hunt list, rather than a gateway type, click Route Patterns/Hunt Pilots in the column on the left side of the window. The tree structure expands, and a list of route patterns/hunt pilots displays.
Note
You can also search for specific route patterns/hunt lists by entering part of the name of the route pattern(s)/hunt pilot(s) in the Route Patterns/Hunt Pilots box in the column on the left side of the window. CAR searches for the route pattern(s)/hunt list(s) that matches the search string.
Step 3
Choose a gateway type from the list. The gateway name displays in the List of Gateways box.
Note
Step 4
Note Step 5
Click the down arrow icon to move the chosen gateway to the list of Selected Gateways box. The gateway that you chose displays in the Selected Gateways box.
21-4
OL-10643-01
Chapter 21
CDR Search Configuration Configuring CDR Search by Cause for Call Termination
Step 6 Step 7
Choose the date and time range of the period when you want to search CDR data. Click the OK button. The CDR-CMR Results window displays. If the search returns more than 100 records, a message indicates that the result will be truncated.
Step 8 Step 9
Related Topics

Understanding the Results for CDR Search, page A-35 Media Information, page A-37 CDR and CMR Dump Tables, page A-38 Configuring CDR Search by User Extension, page 21-2 Configuring CDR Search by Cause for Call Termination, page 21-5 Viewing Call Termination Details, page 21-7 Configuring CDR Search By Call Precedence Levels, page 21-8 Configuring CDR Search for Malicious Calls, page 21-10
Configuring CDR Search by Cause for Call Termination

Only CAR administrators use the CDR Search by Cause for Call Termination feature. This section describes how to search for information about the cause for termination of a call.
21-5
Chapter 21 Configuring CDR Search by Cause for Call Termination
Procedure
Step 1
Choose CDR > Search > By Cause for Call Termination. The Cause for Call Termination window displays.
Step 2
To search for the cause(s) of the termination of a call, highlight the cause(s) in the list of call termination causes.
Tip
You can select more than one cause by clicking the causes that you want while holding down the Ctrl key on your keyboard. You can also select all causes in the list by holding down the Shift key while clicking all causes.
Step 3
With the desired cause(s) highlighted, click the down arrow icon above the Selected Call Termination Causes box. The cause(s) that you chose displays in the Selected Call Termination Causes list box.
Step 4
Choose the date and time range of the period when you want to search CDR data. The current time in Greenwich Mean Time and Local Time displays. Click OK. The Call Termination Details window displays the report criteria for which the report has been generated, along with the total number of calls that have been placed during the given time range as well as how many call legs and the percentage of call legs for each cause code selected.
Step 5
Step 6
To view CDRs, see the Viewing Call Termination Details section on page 21-7.
Related Topics

Understanding the Results for CDR Search, page A-35 Media Information, page A-37 CDR and CMR Dump Tables, page A-38 Configuring CDR Search by User Extension, page 21-2 Configuring CDR Search by Gateway, page 21-3 Mailing a Report, page 18-20
21-6
OL-10643-01
Chapter 21
CDR Search Configuration Viewing Call Termination Details
Viewing Call Termination Details, page 21-7 Configuring CDR Search By Call Precedence Levels, page 21-8 Configuring CDR Search for Malicious Calls, page 21-10
Viewing Call Termination Details

This section describes how to view the call termination details.
Before You Begin
Follow the steps in the Configuring CDR Search by Cause for Call Termination section on page 21-5. This brings you to the Call Termination Details window, that lists the report criteria for which the report has been generated, along with the total number of calls that were placed during the given time range.
Procedure
Step 1
In the Select CDRs field, check the check box beside the individual CDRs that you want to view, or, if you want to view all CDRs in the list, check the Select CDRs check box. After you have chosen the CDRs that you want to view, click View CDRs. The CDR-CMR Search Results window displays. From this window, you can view the media information and the CDR-CMR dump records by clicking the Others and View links. Refer to the Understanding the CDR Search Results section on page A-35 for information on how to read CDR search results reports.
Step 2
Step 3
To mail the report in an e-mail, click Send Report and follow the procedure described in the Mailing a Report section on page 18-20.
Related Topics

Media Information, page A-37 CDR and CMR Dump Tables, page A-38 Configuring CDR Search by User Extension, page 21-2
21-7
Chapter 21 Configuring CDR Search By Call Precedence Levels
Configuring CDR Search by Gateway, page 21-3 Mailing a Report, page 18-20 Configuring CDR Search by Cause for Call Termination, page 21-5 Configuring CDR Search By Call Precedence Levels, page 21-8 Configuring CDR Search for Malicious Calls, page 21-10
Configuring CDR Search By Call Precedence Levels

Only CAR administrators use the CDR Search by Call Precedence Levels feature. This section describes how to search for calls according to call precedence.
Procedure
Step 1
Choose CDR > Search > By Call Precedence Level. The CDR Search by Precedence Levels window displays. In Select Precedence Levels, check the check box(es) for the call precedence level(s) for which you want to search, as described in Table 21-1.
Table 21-1 Call Precedence Levels
Step 2
Voice Quality Flash Override Flash Immediate Priority Routine
Description Highest precedence setting for MLPP calls. Second highest precedence setting for MLPP calls. Third highest precedence setting for MLPP calls. Forth highest precedence setting for MLPP calls. Lowest precedence setting for MLPP calls.
Note
To check the check boxes of every precedence level, click Select All. To clear the check boxes, click Clear All.
21-8
OL-10643-01
Chapter 21
CDR Search Configuration Configuring CDR Search By Call Precedence Levels
In the From Date field, choose the date and time from which you want CDRs searched. In the To Date field, choose the date and time to which you want CDRs searched. Click OK. The Call Precedence Details window displays and shows the call precedence levels and values, number of call legs, and percentage of call legs.
Step 6 Step 7
In the Select CDRs column, check the check box(es) of the CDR(s) at which you want to look. Click the View CDRs button. If the search returns more than 100 records, a message indicates that the result will be truncated.
Step 8
To view the CMR data, click the Others button; to view both the CDR and CMR data fields, click the View button. To mail the report to e-mail recipient(s), click Send Report and follow the steps in Mailing a Report section on page 18-20.
Step 9
Related Topics

Understanding the Results for CDR Search, page A-35 Media Information, page A-37 CDR and CMR Dump Tables, page A-38 Mailing a Report, page 18-20 Configuring CDR Search by User Extension, page 21-2 Configuring CDR Search by Gateway, page 21-3 Configuring CDR Search by Cause for Call Termination, page 21-5 Viewing Call Termination Details, page 21-7 Configuring CDR Search for Malicious Calls, page 21-10
21-9
Chapter 21 Configuring CDR Search for Malicious Calls
Configuring CDR Search for Malicious Calls

Only CAR administrators use the CDR Search for Malicious Calls feature. This section describes how to search for malicious calls.
Procedure
Step 1
Choose CDR > Search > For Malicious Calls. The CDR Search for Malicious calls window displays. Perform one of the following tasks:
Step 2
In the Select Extension(s) box, enter an extension in the Extension field and click Add Extension. The users extension displays in the Selected Extension(s) box. To search for a user extension, click the Search Extension(s) based on User(s) link, enter the first few letters of the first and/or last name in the First Name and/or Last Name fields, and click the Search button. When the results display, click the Select link next to the result that you want to include. The extension number associated with the user to appears in the Selected Extension(s) box. Click the Close button.
Note
To remove an extension, highlight the extension(s) that you want removed and click Remove Extension(s). To remove all extensions, click Remove All Extensions.
Step 3 Step 4
Choose the date and time range of the period when you want to search CDR data. Click OK. The CDR-CMR Results window displays. If the search returns more than 100 records, a message indicates that the result will be truncated.
Step 5 Step 6
21-10
OL-10643-01
Chapter 21
CDR Search Configuration Configuring CDR Search for Malicious Calls
Related Topics

Understanding the Results for CDR Search, page A-35 Media Information, page A-37 CDR and CMR Dump Tables, page A-38 Mailing a Report, page 18-20 Configuring CDR Search by User Extension, page 21-2 Configuring CDR Search by Gateway, page 21-3 Configuring CDR Search by Cause for Call Termination, page 21-5 Viewing Call Termination Details, page 21-7 Configuring CDR Search By Call Precedence Levels, page 21-8
21-11
Chapter 21 Configuring CDR Search for Malicious Calls
21-12
OL-10643-01
C H A P T E R
22
Export CDR/CMR Records Configuration

This chapter describes how to export CDR/CMR records. Using Export CDR/CMR in the CDR menu in Cisco Unified CallManager CDR Analysis and Reporting, you can export CDR/CMR dump information to the location of your choice on your computer. The CDR/CMR dump exists in the CSV format. The following procedure describes how to export CDR/CMR dumps to a file.
Procedure
Step 1
From CDR Analysis and Reporting, choose CDR > Export CDR/CMR. The Export CDR/CMR records window displays. In the From Date and To Date pull-down menus, choose a date range for the CDR/CMR dump. In Select records, check the CDR and/or CMR check box. Click Export to File.
Note
If you do not check the Delete File check box(es) (for example, if the CDR or CMR dump files get left undeleted), the background process deletes the files on a daily basis. Because the CDR and CMR dump files a large size, Cisco recommends that you download the file to a local disk and delete them from the server to avoid disk usage in the server side.
22-1
Chapter 22 Viewing Export CDR/CMR Records Results
The Export CDR/CMR records Result window displays. See Viewing Export CDR/CMR Records Results, page 22-2.
Related Topics

Viewing Export CDR/CMR Records Results, page 22-2 CDR Search Configuration, page 21-1 Chapter 14, CDR Analysis and Reporting, Cisco Unified CallManager Serviceability System Guide
Viewing Export CDR/CMR Records Results

The following procedure describes how to view Export CDR/CMR record results.
Before You Begin
Before you begin the following procedure, perform all the steps in the Export CDR/CMR Records Configuration section on page 22-1.
Procedure
Step 1
From the Export CDR/CMR record Results window, right click either the CDR Dump or CMR Dump link. A pop-up window that comprises the following option displays:

OpenThis option allows you to open the web page that contains the CDR/CMR dump in the same window. Open in a New WindowThis option allows you to open the web page that contains the CDR/CMR dump in a new window. Save Target As...This option allows you to save the CDR/CMR dump to a location on your computer. Print TargetThis option allows you to print out the CDR/CMR dump. Copy ShortcutThis option allows you to copy the web page shortcut to paste in another file.
22-2
OL-10643-01
Chapter 22
Export CDR/CMR Records Configuration Viewing Export CDR/CMR Records Results
Step 2 Step 3
Add to FavoritesThis option allows you to add the CDR/CMR dump to your Favorites folder. PropertiesThis option provides the properties of the CDR/CMR dump file.
Choose one of the options from the pop-up window. If you chose to save the CDR/CMR dump to your computer, choose a location in which to save the dump and click Save. After the download is complete, you can locate the file wherever you downloaded it to open it. To delete the CDR and/or CMR dump, check the Delete File check box and click either Back or Close. The files get deleted.
Step 4
Related Topics

Export CDR/CMR Records Configuration, page 22-1 CDR Search Configuration, page 21-1 Chapter 14, CDR Analysis and Reporting, Cisco Unified CallManager Serviceability System Guide
22-3
Chapter 22 Viewing Export CDR/CMR Records Results
22-4
OL-10643-01
A R T
Other Monitoring Tools
C H A P T E R
23
Microsoft Performance
This chapter provides procedural information for using the Microsoft Performance application with Cisco Unified CallManager. This chapter contains the following topics:

Starting the Microsoft Performance Program, page 23-1 Viewing Performance Statistics, page 23-2 Extending Your Data Display, page 23-3
Starting the Microsoft Performance Program

You can use the Microsoft Performance application to monitor various conditions on a Cisco Unified CallManager system. For example, you can find the number of calls in progress on a particular Cisco Unified CallManager node at any time or the number of calls attempted on a Cisco Unified CallManager system. Setting up Performance can yield statistics that are customized to reflect your Cisco Unified CallManager system. For example, you may use the information that Performance returns to manage traffic on the system by monitoring the number of calls in progress at any particular time.
23-1
Chapter 23 Viewing Performance Statistics
This section describes how to start the Performance tool and add Cisco Unified CallManager object counters for monitoring.
Procedure
Step 1
Choose Start > Programs > Administrative Tools > Performance. The Performance window displays. Choose the Cisco Unified CallManager server that you will be monitoring. Local computer name is shown by default. To monitor a remote machine, you can overwrite the local computer name with the remote computer name. Use the Explain button to get a description of each available counter. Choose a Cisco Unified CallManager Performance object. Choose the counter or counters that describe the statistics that you want to monitor. Click the Add button to start gathering data for the counters that you specified.
Step 2
Related Topics

Viewing Performance Statistics, page 23-2 Extending Your Data Display, page 23-3
Viewing Performance Statistics

The statistical data that is retrieved through Performance provides the information that you need for analysis and interpretation of any local or remote Cisco Unified CallManager system. You may choose specific counters to return data describing changing activity levels in your system, or you may choose to react as events occur. Performance visually formats the statistical data to facilitate your quick comprehension of the state of the system. Using the visual formats provided, you can display Cisco Unified CallManager data in graphical, histogram, or report form.
23-2
OL-10643-01
Chapter 23
Microsoft Performance Extending Your Data Display
This section describes how to report Cisco Unified CallManager performance statistics.
Procedure
Step 1
Choose Start > Programs > Administrative Tools > Performance. The Performance graphical interface displays. Choose the Cisco Unified CallManager system that you will be monitoring. If the system is local, Cisco Unified CallManager detects the name automatically. Click the View Graph, View Histogram, or View Report icon located at the top of the Performance window to graphically display your statistics.
Step 2 Step 3
Related Topics

Starting the Microsoft Performance Program, page 23-1 Extending Your Data Display, page 23-3
Extending Your Data Display

Each report form offers a different visual rendition of the statistical data. You can repeat the process to choose the most effective display. You can add counters from other objects to see how dynamic data affects your Cisco Unified CallManager data. For purposes of illustration, Figure 23-1 shows active operating system conditions with inactive Cisco Unified CallManager data. When your Cisco Unified CallManager data is added, you can interpret that information in the context of any number of system counters.
23-3
Chapter 23 Extending Your Data Display
By combining standard counters with the Cisco Unified CallManager criteria, you better understand your systems, so you can manage them more efficiently.
Figure 23-1 Line Graph of Static Call Data
23-4
34448
OL-10643-01
C H A P T E R
24
Bulk Trace Analysis

The Cisco Bulk Trace Analysis tool, a plug-in software application provided in Serviceability, takes the input from one or multiple large (over 2MB) XML trace files and creates a report that you can use to analyze trace data. This chapter contains the following topics:

Downloading Bulk Trace Analysis, page 24-1 Installing the Bulk Trace Analysis Program, page 24-2 Using Bulk Trace Analysis, page 24-3
Before You Begin
Bulk Trace Analysis uses an XML trace file as the input file. Use the Trace tools to generate the XML trace file. For information on XML trace files, see the following chapters:

Trace Configuration, page 5-1 Trace Collection Configuration, page 6-1 Trace Analysis Configuration, page 7-1
Downloading Bulk Trace Analysis

You download the Bulk Trace Analysis tool from Serviceability and install it on a client PC. This section describes how to download the Bulk Trace Analysis tool.
24-1
Chapter 24 Installing the Bulk Trace Analysis Program
Bulk Trace Analysis
Procedure
Step 1
From the Serviceability window, choose Application > Install Plugins. The Serviceability Install Plugins window displays.
Click the Bulk Trace Analysis icon. In the window, choose Save the program to disk. Enter the filename and location where you want the Bulk Trace Analysis program saved. Click the OK button.
Related Topics

Installing the Bulk Trace Analysis Program, page 24-2 Using Bulk Trace Analysis, page 24-3
Installing the Bulk Trace Analysis Program

Install the Bulk Trace Analysis program on a PC after the plugin has been downloaded from the Serviceability program. This section describes how to install the Bulk Trace Analysis program on a client PC.
Procedure
Step 1
From the PC, double-click the Bulk Trace Analysis icon or the TraceAnalysis_installation.exe filename. The installation wizard window displays. Click the Next > buttons in the windows as they display. Click the Finish button. The now installed program is ready to be used.
Step 2 Step 3
24-2
OL-10643-01
Chapter 24
Bulk Trace Analysis Using Bulk Trace Analysis
Related Topics

Downloading Bulk Trace Analysis, page 24-1 Using Bulk Trace Analysis, page 24-3
Using Bulk Trace Analysis

Bulk Trace Analysis takes one or multiple SDI or SDL XML trace files and creates reports that you can use to analyze the trace data. Bulk Trace Analysis supports the following report functionality:

Starting and Exiting the Program Creating a Report Opening a Report Printing a Report Saving the Master Report Searching for Data in a Report Creating a Report with Multiple Views Displaying View Information Customizing the Report Table Headings
Before You Begin
You must install the Bulk Trace Analysis program on a PC other than the Cisco Unified CallManager publisher or subscriber system. See Downloading Bulk Trace Analysis, page 24-1 and Installing the Bulk Trace Analysis Program, page 24-2. Make sure the program is started and running on the PC. See Starting and Exiting the Program, page 24-4.
24-3
Chapter 24 Using Bulk Trace Analysis
Bulk Trace Analysis
Starting and Exiting the Program

This section describes how to start and exit the Bulk Trace Analysis program.
Procedure
Step 1
Choose Start > Programs > Cisco Bulk Trace Analysis Tool. The Bulk Trace Analysis Tool window displays. See Figure 24-1.
Step 2 Step 3
Use the procedures described in this section to create a report, open a report, and print a report. To end the program, choose File > Exit.
24-4
OL-10643-01
Chapter 24
Figure 24-1 Bulk Trace Analysis Window
1 2 3
Workplace Report Table Task Control and Status

Related Topics

Creating a Report, page 24-6 Opening a Report, page 24-8 Printing a Report, page 24-9 Saving the Master Report, page 24-10 Searching for Data in a Report, page 24-11 Creating a Report with Multiple Views, page 24-12
OL-10643-01
24-5
Bulk Trace Analysis
Displaying View Information, page 24-15 Customizing the Report Table Headings, page 24-16
Creating a Report
Bulk Trace Analysis creates reports using SDI or SDL XML trace files. You create a report using the following input trace files:

Select multiple XML files in the Bulk Trace Analysis program File Open dialog window using the Control key while selecting filenames. Select a file from a remote Cisco Unified CallManager node by entering the IP address of the node in the Bulk Trace Analysis program File Open dialog window. You must use a user ID and password. From Cisco Unified CallManager Serviceability, choose a zip file that was collected using the Trace Collection tool.
Caution
The Bulk Trace Analysis program only accepts original XML trace files or trace files that the Trace Collection tool zipped. Using a trace file zipped by any other application (such as WinZip) could cause the Cisco Unified CallManager system to stop working.
Procedure
This section describes how to create a report from a trace file.

Step 1
From the Bulk Trace Analysis window, choose File > New Report. The New File dialog window displays.
Step 2 Step 3
To choose an SDI trace file, click the SDI button; to choose an SDL trace file, click the SDL button. To choose the trace source file, click the Browse button. The Open window displays.
Step 4 Step 5
Choose the source trace file from the list of files. Click the Open button.
24-6
OL-10643-01
Chapter 24
The New File dialog window displays, and the file that you chose is entered in the Source File field. To choose multiple files, press the Control key while clicking on the file name.
Step 6
To save the report using the default file name displayed in the Save Report As field, click the OK button. Continue with Step 10; otherwise, continue with Step 7. To save the report using another file name, click the Browse button. In the Save As window, enter a file name in the file name field or use the default. Click the Save button. The New File dialog window displays, and the file name that you chose is entered in the Save Report As field.
Step 10
Click the OK button. The data from the source file displays in the Report Table pane, the report name appears in the Workplace Views pane, and the status of the report displays in the Task Control and Status pane. See Figure 24-1.
Step 11 Step 12
To save the report, choose File > Save. Click the Save button.
Related Topics

Downloading Bulk Trace Analysis, page 24-1 Installing the Bulk Trace Analysis Program, page 24-2 Using Bulk Trace Analysis, page 24-3 Starting and Exiting the Program, page 24-4 Opening a Report, page 24-8 Printing a Report, page 24-9 Saving the Master Report, page 24-10 Searching for Data in a Report, page 24-11 Creating a Report with Multiple Views, page 24-12 Displaying View Information, page 24-15 Customizing the Report Table Headings, page 24-16
24-7
Bulk Trace Analysis
Opening a Report
This section describes how to open a report that is already created. See Creating a Report, page 24-6.
Procedure
Step 1
From the Bulk Trace Analysis window, choose File > Open Report. The Open dialog window displays.
Step 2 Step 3
Choose the report file from the list of files. Click the Open button. The data from the source file displays in the Report Table pane, the report name appears in the Workplace Views pane, and the status of the report displays in the Task Control and Status pane.
Related Topics

Downloading Bulk Trace Analysis, page 24-1 Installing the Bulk Trace Analysis Program, page 24-2 Using Bulk Trace Analysis, page 24-3 Starting and Exiting the Program, page 24-4 Creating a Report, page 24-6 Printing a Report, page 24-9 Saving the Master Report, page 24-10 Searching for Data in a Report, page 24-11 Creating a Report with Multiple Views, page 24-12 Displaying View Information, page 24-15 Customizing the Report Table Headings, page 24-16
24-8
OL-10643-01
Chapter 24
Printing a Report
This section describes how to print a report.
Procedure
Step 1
If you have more than one report open, choose the report that you want to print.
Tip Step 2
Before printing a report, choose File > Print Preview.
From the Bulk Trace Analysis window, choose File > Print. The Print dialog window displays.
Tip Step 3
Choose Landscape as the paper layout.
Click the OK button.
Related Topics

Downloading Bulk Trace Analysis, page 24-1 Installing the Bulk Trace Analysis Program, page 24-2 Using Bulk Trace Analysis, page 24-3 Starting and Exiting the Program, page 24-4 Creating a Report, page 24-6 Opening a Report, page 24-8 Saving the Master Report, page 24-10 Searching for Data in a Report, page 24-11 Creating a Report with Multiple Views, page 24-12 Displaying View Information, page 24-15 Customizing the Report Table Headings, page 24-16
24-9
Bulk Trace Analysis
Saving the Master Report

This section describes how to save the master report. The master report designates the report without any filtering criteria.
Procedure
Step 1 Step 2
In the Workplace Views pane, choose the report that you want to save. Choose File > Save.
Related Topics

Downloading Bulk Trace Analysis, page 24-1 Installing the Bulk Trace Analysis Program, page 24-2 Using Bulk Trace Analysis, page 24-3 Starting and Exiting the Program, page 24-4 Creating a Report, page 24-6 Opening a Report, page 24-8 Printing a Report, page 24-9 Searching for Data in a Report, page 24-11 Creating a Report with Multiple Views, page 24-12 Displaying View Information, page 24-15 Customizing the Report Table Headings, page 24-16
24-10
OL-10643-01
Chapter 24
Searching for Data in a Report

This section describes how to search for data (information) in a report.
Procedure
Step 1 Step 2
In the Workplace Views pane, choose the report that you want to search. Choose Edit > Find or click the binoculars icon. The Find window displays. Enter the search criteria; for example, Alarm. Choose additional search options as described in Table 24-1.
Table 24-1 Search Options
Step 3 Step 4
Option Match case
Description Searches the file for the search criteria matching the case (upper and lower) exactly. Searches the file for the search criteria beginning at the current cursor position and searching upwards. Searches the file for the search criteria beginning at the current cursor position and searching downwards.
Up Direction
Down Direction
Step 5
Click the Find Next button. The highlighted match displays.
Step 6 Step 7
To search again, click the Find Next button. Click the Cancel button when you finish searching.
24-11
Bulk Trace Analysis
Related Topics

Downloading Bulk Trace Analysis, page 24-1 Installing the Bulk Trace Analysis Program, page 24-2 Using Bulk Trace Analysis, page 24-3 Starting and Exiting the Program, page 24-4 Creating a Report, page 24-6 Opening a Report, page 24-8 Printing a Report, page 24-9 Saving the Master Report, page 24-10 Creating a Report with Multiple Views, page 24-12 Displaying View Information, page 24-15 Customizing the Report Table Headings, page 24-16
Creating a Report with Multiple Views

A view designates a report that contains specific information used for troubleshooting. A report can contain multiple views that allow you to examine the trace information from different perspectives. Configuration of Bulk Trace Analysis filtering criteria is similar to configuration of filtering criteria in the Trace Analysis tool (see the Trace Analysis Configuration section on page 7-1). You can choose the type of information (such as host name, IP address, or correlation tag) to include in a trace analysis. The results you receive from choosing correlation tag filtering provides more information than when you do not choose correlation tag filtering. Correlation tag filtering shows the relation between one trace to another trace. See the following examples.
Example Using Correlation Tag
In a trace file, a user checks the Use Correlation Tag check box and chooses a filter of IP Address=172.21.10.555 and Trace type=Alarm. Bulk Trace Analysis looks for all trace records with this IP address and trace type and collects all trace
24-12
OL-10643-01
Chapter 24
records that have a correlation tag associated with the trace records. The correlation tag gets applied to all the trace records found and gets filtered again. The trace filter finds the following records:

Record 1: IP Address=172.21.10.555, Trace type=Alarm, Ctag=3,65,100,1.1 Record 2: IP Address=172.21.10.555, Trace type=Error, Ctag=3,65,100,1.1 Record 3: IP Address=172.21.10.556, Trace type=Alarm, Ctag=3,65,100,1.1 Record 4: IP Address=172.21.10.557, Trace type=Trace, Ctag=3,65,100,1.3
Because Use Correlation Tag is checked the view displays record 1, record 2, and record 3.
Example Without Correlation Tag
In a trace file, a user does not check the Use Correlation Tag check box. The user chooses a filter of IP Address=172.21.10.555 and Trace type=Alarm. Bulk Trace Analysis looks for all trace records with this IP address and trace type and collects all trace records that have a correlation tag associated with the trace records. The correlation tag gets applied to all the trace records found and gets filtered again. The trace filter finds the following records:

Record 1: IP Address=172.21.10.555, Trace type=Alarm, Ctag=3,65,100,1.1 Record 2: IP Address=172.21.10.555, Trace type=Error, Ctag=3,65,100,1.1 Record 3: IP Address=172.21.10.556, Trace type=Alarm, Ctag=3,65,100,1.1 Record 4: IP Address=172.21.10.557, Trace type=Trace, Ctag=3,65,100,1.3
Because Use Correlation Tag is not checked the view only displays record 1. This section describes how to make the report contain specific information by choosing filtering criteria and saving it as another view.
Procedure
Step 1 Step 2
In the Workplace Views pane, choose the report for which you want to create another view. Choose View > New View, right-click the report name or click the new view icon. The Filter window displays. Check the Use Correlation Tag check box if you want to use the CTag field of the trace record. See Example Using Correlation Tag, page 24-12.
Step 3
24-13
Bulk Trace Analysis
Step 4
In the Selection Criteria area, choose the information that you want included in the new view. See Table 24-2.
Table 24-2 Selection Criteria
Option Use Correlation Tag
Description Check this check box if you want the view to contain all trace records associated with the selection criteria you chose. Choose a specific host from which the trace originated or choose all hosts. Choose a specific device from which a trace was created or choose all devices. Choose a specific IP address for a device from which a trace was created or choose all IP addresses. Choose trace types such as alarms or errors, only alarms, or only traces from which the trace originated.
CallManager Host (CCM) Source Device (SrcDev) Source IP Address (SrcIP)
Trace Type
Step 5 Step 6
In the Time area, choose a specific time and date range. Click the OK button. The view with the specified criteria displays in the Report Table pane with a new view name (for example, View 2) displayed under the Task name in the Workspace Views pane.
Tip
If you do not want the view in the report, close the view using the Windows close box.
Related Topics

Downloading Bulk Trace Analysis, page 24-1 Installing the Bulk Trace Analysis Program, page 24-2
24-14
OL-10643-01
Chapter 24
Using Bulk Trace Analysis, page 24-3 Starting and Exiting the Program, page 24-4 Creating a Report, page 24-6 Opening a Report, page 24-8 Printing a Report, page 24-9 Saving the Master Report, page 24-10 Searching for Data in a Report, page 24-11 Displaying View Information, page 24-15 Customizing the Report Table Headings, page 24-16
Displaying View Information

If you need to find out the filter information for a particular view, you can display the information. This section describes how to display the filter information for a view.
Procedure
Step 1
In the Workplace Views pane, choose the view for which you want filter information displayed. The filter information window displays. Right-click the view name. Choose View Information from the pop up menu. Click the OK button to close.
Related Topics

Downloading Bulk Trace Analysis, page 24-1 Installing the Bulk Trace Analysis Program, page 24-2 Using Bulk Trace Analysis, page 24-3 Starting and Exiting the Program, page 24-4
24-15
Bulk Trace Analysis
Creating a Report, page 24-6 Opening a Report, page 24-8 Printing a Report, page 24-9 Searching for Data in a Report, page 24-11 Creating a Report with Multiple Views, page 24-12 Customizing the Report Table Headings, page 24-16
Customizing the Report Table Headings

To view specific columns of information in the report, you can remove the columns of information that you do not want to see. This section describes how to customize the Report Table headings.
Procedure
Step 1 Step 2
In the Workplace Views pane, choose the report or view for which you want to customize the Report Table headings. Choose Edit > Customize Header or click the Customize header icon. The Customize columns window displays.
To remove columns, choose a column from the Columns to be shown and order area. Click the <- Remove button. To rearrange the order of the columns, choose the column from the Columns to be shown and order area. Click the Move Up or Move Down button. To add columns, choose a column from the Columns not shown area. Click the Add -> button. Click the OK button. The report with the new heading arrangement displays in the Report Table pane.
24-16
OL-10643-01
Chapter 24
Related Topics

Downloading Bulk Trace Analysis, page 24-1 Installing the Bulk Trace Analysis Program, page 24-2 Using Bulk Trace Analysis, page 24-3 Starting and Exiting the Program, page 24-4 Creating a Report, page 24-6 Opening a Report, page 24-8 Printing a Report, page 24-9 Saving the Master Report, page 24-10 Searching for Data in a Report, page 24-11 Creating a Report with Multiple Views, page 24-12 Displaying View Information, page 24-15
24-17
Bulk Trace Analysis
24-18
OL-10643-01
A R T
CiscoWorks2000 Interfaces
C H A P T E R
25
Overview of CiscoWorks2000
This chapter, which provides an overview of CiscoWorks2000 that is used with Cisco Unified CallManager, contains the following topics:

CiscoWorks2000, page 25-2 Remote Network Management Features, page 25-2
CiscoWorks2000 serves as the network management system (NMS) of choice for all Cisco devices as well as the Cisco Unified CallManager system. Because it is not bundled with Cisco Unified CallManager, you must purchase it separately. Use the following tools with CiscoWorks2000 for remote serviceability:

System Log (see Chapter 27, System Log Management Configuration) Path Analysis (see Chapter 26, Path Analysis Configuration) Cisco Discovery Protocol (see Chapter 28, Cisco Discovery Protocol Support Configuration) Simple Network Management Protocol (see Chapter 31, Simple Network Management Protocol Configuration)
The CiscoWorks2000 family of web-based products supports maintenance of Cisco Enterprise networks and devices. The products include Resource Management Essentials and Campus Manager, which provide Syslog Analysis, Topology Services, Path Analysis, User Tracking, and other network management services.
25-1
Chapter 25 CiscoWorks2000
CiscoWorks2000
After you purchase and install the software, access CiscoWorks2000 from any web browser. The browser must have Java and JavaScript enabled and be configured to accept cookies. Network administrators and Cisco Service Engineers (CSE) use CiscoWorks2000. It manages diagnostic and troubleshooting information collected from your Cisco IP telephony installation.
Remote Network Management Features

The network management features offered with remote serviceability support the fundamental elements and operations of the Cisco Unified CallManager process.
IP Path Analysis Interface

PathTool designates one of a suite of tools included in Campus Manager 3.0, which is offered with CiscoWorks2000. This tool defines your Cisco Unified CallManager system paths in the form of maps, trace logs, or discovery tables. The PathTool application traces connectivity between two specified points on your network. It analyzes both physical and logical paths (Layers 2 and 3) taken by packets flowing between those points. This tool makes it possible to trace activity between all entities of your Cisco Unified Communications Solutions for the Enterprise architecture.
System Log Management

The Syslog Analysis tools comprise Cisco Syslog Collector and Cisco Syslog Analyzer. Alternatively, CiscoWorks2000 offers these tools as part of the Resource Management Essentials package. You can adapt Syslog output from Cisco Unified CallManager for use with other network management systems.
25-2
OL-10643-01
Chapter 25
Overview of CiscoWorks2000 Remote Network Management Features
The Cisco Syslog Collector keeps common system logs that record messages reported to the Cisco CallManager system. The Cisco Syslog Analyzer controls and displays all events efficiently, so they can easily be read, interpreted, and used for system maintenance and problem solving. Using the reporting and managing capabilities of these tools, you can monitor and manage a wide range of events and error messages concurrently on each Cisco Unified CallManager server and other Cisco devices on your site.
Simple Network Management Protocol Support

Simple Network Management Protocol (SNMP) Management Information Base (MIB) tables organize and distribute the information gathered from your company site. Cisco technical support engineers, who remotely monitor the status of your Cisco Unified CallManager system, can also access the information in these tables. However, as an on-site administrator, you can stop and start services, as well as gain access to and control some diagnostic information. You can use SNMP instrumentation with a CiscoWorks2000 interface, and you can also adapt it for use with other network management systems.
Cisco Discovery Protocol

Cisco Discovery Protocol (CDP) enables Cisco Unified CallManager to advertise itself to other Cisco devices on the network, allowing detection of all the installations on your site. Using information provided through CDP, CiscoWorks2000 builds topology maps that show network administrators the Cisco Unified CallManager systems existing on your network.
25-3
Chapter 25 Remote Network Management Features
25-4
OL-10643-01
C H A P T E R
26
Path Analysis Configuration

This chapter, which provides an overview of Path Analysis, contains the following topics:

Understanding Path Analysis, page 26-1 Setting Up Call Detail Records Logging, page 26-2
Using Path Analysis with Cisco Unified CallManager requires the installation of the Common Management Foundation 1.1.1 Voice Manager patch on the CiscoWorks2000 server.
Understanding Path Analysis

Path Analysis, a diagnostic application, traces connectivity between two specified points on a network. It analyzes both physical and logical paths (Layer 2 and Layer 3) taken by packets flowing between those points. After a call completes, PathTool traces the route of audio packets by specifying the directory number of the calling and called parties. This applies to calls among any of the following endpoints: Cisco Unified IP Phones, analog devices connected to a station gateway, or trunk gateways (analog or digital). For more information, consult CiscoWorks2000 online help. The following information assists you in setting up Cisco Unified CallManager. You can display the paths that are traced in the form of maps, trace logs, or tables in CiscoWorks2000 Campus Manager.
26-1
Chapter 26 Setting Up Call Detail Records Logging
Path Analysis Configuration
Related Topic
To learn more about CiscoWorks2000, access the following URL: http://www.cisco.com/univercd/cc/td/doc/product/rtrmgmt/cw2000/index.htm
Setting Up Call Detail Records Logging

You can activate Voice over IP (VoIP) traces only when Cisco Unified CallManager is installed with call detail record (CDR) logging enabled. The default status specifies disabled. From the Cisco Unified CallManager Administration window, perform the following procedure to enable CDR logging.
Procedure
Choose Service > Service Parameters. Choose the IP address of your Cisco Unified CallManager server. Click Next. Choose the Cisco CallManager service. In the Parameter Value field, choose True for the Cdr Enabled Flag service parameter. Click Update. Call detail records start logging immediately.
Caution
Tracing voice connectivity requires that CDR logging be enabled on every Cisco Unified CallManager server in a cluster.
26-2
OL-10643-01
C H A P T E R
27
System Log Management Configuration

This chapter, which provides an overview of system log, contains the following topics:

Understanding System Log Management, page 27-1 Directing Syslog Messages, page 27-2 Enabling the SNMP Agent, page 27-5
In an open distributed system, multiple applications generally run on several machines of different types. Cisco Syslog Analysis streamlines the management of such systems by providing a common administrative interface for all log messages that are received from the applications. The result provides an orderly presentation of information that assists in the diagnosis and troubleshooting of system problems.
Understanding System Log Management

Although it can be adapted to other network management systems, Cisco Syslog Analysis, which is packaged with CiscoWorks2000 Resource Manager Essentials, provides the best method to manage Syslog messages from Cisco devices. Cisco Syslog Analyzer serves as the component of Cisco Syslog Analysis that provides a common storage and analysis of the system log for multiple applications. The other major component, Syslog Analyzer Collector, gathers log messages from Cisco Unified CallManager servers.
27-1
Chapter 27 Directing Syslog Messages
These two Cisco applications work together to provide a centralized system logging service for Cisco Unified Communications Solutions. A diagram of the system (Figure 27-1) shows how the Syslog Analyzer and Syslog Collector function within the syslog analysis process.
Figure 27-1 Functional Components of the System Logging Service
CiscoWorks2000 RME Server
or
Database Remote Syslog Analyzer Collector
Voice Gateways
Cisco Unified CallManager Remote Syslog Analyzer Collector Applications Applications
or
Applications
141750
Directing Syslog Messages

You can configure Cisco Unified CallManager applications to send Syslog messages directly to the CiscoWorks2000 server or to a local host on which the Remote Syslog Analyzer Collector (RSAC) software is installed.
27-2
OL-10643-01
Chapter 27
System Log Management Configuration Directing Syslog Messages
Refer to the CiscoWorks2000 installation procedures for the Resource Manager Essentials at the following Internet address: http://www.cisco.com/univercd/cc/td/doc/product/rtrmgmt/cw2000/index.htm Refer to the CiscoWorks2000 online documentation for information about the Remote Syslog Analyzer Collector. Cisco Unified CallManager Serviceability directs the syslog output and initiates the logging activity. See Chapter 2, Alarm Configuration, for information.
Directing Messages to Local Syslog Analyzer Collector

Perform the following procedures to direct Syslog messages to a local host.
Procedure
Step 1
Step 2 Step 3
Choose Alarm > Configuration. From the Servers column, choose the server. The server that you chose appears after the Current Server title, and a box with configurable services displays.
Step 4
From the Configured Services list, choose the service for which you want to configure the alarm. The service that you chose displays after the Current Service title, along with the current server that you chose. A list of alarm monitors with the event levels displays in the Alarm Configuration window.
Step 5 Step 6
Check the Enable Alarm for Syslog check box. In the Alarm Event Level selection box, click the Down arrow. A list with eight event levels displays.
Step 7 Step 8
Click the desired alarm event level. Leave the Server Name box blank to send Syslog messages to a local host.
27-3
Chapter 27 Directing Syslog Messages
Step 9
To save your configuration, click Update.
Directing Messages to CiscoWorks2000 Server

Perform the following procedures to send Syslog messages directly to the CiscoWorks2000 server.
Procedure
Step 1
Step 2 Step 3
Choose Alarm > Configuration. From the Servers column, choose the server. The server that you chose appears after the Current Server title, and a box with configurable services displays.
Step 4
From the Configured Services list, choose the service for which you want to configure the alarm. The service that you chose displays after the Current Service title, along with the current server that you chose. A list of alarm monitors with the event levels displays in the Alarm Configuration window.
Step 5 Step 6
Check the Enable Alarm for Syslog check box. In the Alarm Event Level selection box, click the Down arrow. A list with eight event levels displays. Click the desired alarm event level. In the Server Name box, enter the CiscoWorks2000 server name. To save your configuration, click Update.
27-4
OL-10643-01
Chapter 27
System Log Management Configuration Enabling the SNMP Agent
Enabling the SNMP Agent

Because CiscoWorks2000 sends SNMP requests to query for device information, you must enable the Microsoft Windows 2000 SNMP service at the time that Cisco Unified CallManager is installed. Adding a system adds device databases to the CiscoWorks device list, and SNMP requests are used to retrieve that information. See Chapter 31, Simple Network Management Protocol Configuration, for more information.
27-5
Chapter 27 Enabling the SNMP Agent
27-6
OL-10643-01
C H A P T E R
28
Cisco Discovery Protocol Support Configuration

This chapter provides general and procedural information for Cisco Discovery Protocol (CDP). This chapter contains the following topics:

Using CDP Advertisement Support, page 28-1 Using the CDP Driver, page 28-2 Accessing CDP Driver Control, page 28-2 Default CDP Setting, page 28-7
Cisco Discovery Protocol discovers Cisco devices on a network. CDP enables discovery of Cisco Unified CallManager servers and management of those servers by CiscoWorks2000.
Using CDP Advertisement Support

With CDP Advertisement Support, Cisco Unified CallManager periodically sends out CDP messages on the active interface to a designated multicast address. These messages contain information such as device identification, interface name, system capabilities, and time to live. Any Cisco device with CDP support can locate a Cisco Unified CallManager by using these periodic messages. For example, a device can locate Cisco Unified CallManager agent IP addresses by using the CDP cache from the direct neighboring devices.
28-1
Chapter 28 Using the CDP Driver
Before You Begin
CDP designates a Windows 2000 Protocol Driver that is designed to run with Cisco Unified CallManager on a Cisco Media Convergence Server with a 10/100BaseT Ethernet network interface card. It does not support other media, such as Token Ring, ATM, or Windows NT platforms (including Windows 98 or Windows NT 4.0).
Using the CDP Driver

Starting Cisco Unified CallManager enables the CDP driver. You can use CDP to allow CiscoWorks2000 to discover and manage your Cisco Unified CallManager systems. After you have used the CDP cache MIB of the direct neighboring device to discover the Cisco Unified CallManager, you can use CiscoWorks2000 to query other Cisco Unified CallManager-supported MIBs for provisions or statistics information about topology services, user tracking, path analysis, and other network management services.
Tip
You can use the show CDP neigh (neighbor) command from the direct neighboring device of Cisco Unified CallManager to check CDP information that Cisco Unified CallManager advertises.
Accessing CDP Driver Control

You can control the CDP driver by using the CISCO-CDP-MIB. When you are using CiscoWorks2000, you must keep the CDP driver enabled at all times to discover Cisco Unified CallManager.
Caution
You should alter the CDP setting only in special cases. For example, you might restart the CDP driver from the control panel at run time to pick up the latest IP configuration changes without resetting the system.
28-2
OL-10643-01
Chapter 28
Cisco Discovery Protocol Support Configuration Accessing CDP Driver Control
Installing the CDP Protocol Driver

The Cisco Unified CallManager installation process installs the CDP driver. After you successfully Cisco Unified CallManager installation, the CDP protocol driver resides in the list of device drivers under the Windows 2000 control panel.
Starting the CDP Protocol Driver

This section describes how to start the CDP protocol driver.
Procedure
Choose Start > Settings > Control Panel. Double-click System. Click the Hardware tab. Click the Device Manager button. The Device Manager window displays.
Choose View > Devices by connection. Choose View > Show hidden devices. Double-click CDP Protocol Driver. Click the Driver tab. To enable the driver (Default = Start), click the Start button. Click the OK button. Start the Cisco RIS data collector service (see Starting the Cisco RIS Data Collector section on page 31-9, for more details).
Note
Choosing Startup Type=Demand keeps Start setting after a restart.
Related Topics
Installing the CDP Protocol Driver, page 28-3

OL-10643-01
28-3
Chapter 28 Accessing CDP Driver Control
Enabling the CDP Protocol Driver, page 28-4 Showing CDP Protocol Driver Property, page 28-5 Updating an IP Address for CDP Protocol Driver, page 28-5 Locating Updated CDP Driver and Interface Files, page 28-6
Enabling the CDP Protocol Driver

This section describes how to enable the CDP protocol driver.
Procedure
Choose Start > Settings > Control Panel. Double-click System. Click the Hardware tab. Click the Device Manager button. The Device Manager window displays. Choose View > Devices by connection. Choose View > Show hidden devices. Double-click CDP Protocol Driver. Click the Driver tab. Choose Enable Device. Choose Next; then, choose Finish to enable device. Choose Close and restart the system. After the system is up, start the Cisco RIS data collector service.
Related Topics

Installing the CDP Protocol Driver, page 28-3 Starting the CDP Protocol Driver, page 28-3 Showing CDP Protocol Driver Property, page 28-5
28-4
OL-10643-01
Chapter 28
Cisco Discovery Protocol Support Configuration Accessing CDP Driver Control
Updating an IP Address for CDP Protocol Driver, page 28-5 Locating Updated CDP Driver and Interface Files, page 28-6
Showing CDP Protocol Driver Property

This section describes how to show CDP protocol driver property.
Procedure
Choose Start > Run. Enter \WINNT\System32\drivers in the Run field. Click the OK button. Right-click cdp.sys. To show CDP driver properties, such as driver version and date, choose Properties. Click the OK button.
Related Topics

Installing the CDP Protocol Driver, page 28-3 Starting the CDP Protocol Driver, page 28-3 Enabling the CDP Protocol Driver, page 28-4 Updating an IP Address for CDP Protocol Driver, page 28-5 Locating Updated CDP Driver and Interface Files, page 28-6
Updating an IP Address for CDP Protocol Driver

The CDP protocol driver runs on top of the existing Ethernet network interface card. You can restart CDP when a new IP address is configured at run time.
28-5
Chapter 28 Accessing CDP Driver Control
This section describes how to update the CDP protocol driver.

Procedure
Step 1 Step 2
Restart CDP by using the Device Manager to update the CDP driver with the new IP address information. You do not have to reset the system after updating.
Related Topics

Installing the CDP Protocol Driver, page 28-3 Starting the CDP Protocol Driver, page 28-3 Enabling the CDP Protocol Driver, page 28-4 Showing CDP Protocol Driver Property, page 28-5 Locating Updated CDP Driver and Interface Files, page 28-6
Locating Updated CDP Driver and Interface Files

Installing Cisco Unified CallManager updates these components:

The CDP driver (cdp.sys) updates to the Windows 2000 driver directory (WINNT\System32\Drivers\cdp.sys). The CDP Interface Library (cdpintf.dll) updates to the Windows 2000 System32 directory (\WINNT\System32\cdpintf.dll). A Backup Regedit export file for reinstalling CDP registries updates to the bin directory (\Program Files\Cisco\Bin\cdp2k101.reg). Use this file to restore the CDP registry in case it becomes corrupted. After running the cdp2k101.reg file, you must perform a system reset to restore the CDP registries.
28-6
OL-10643-01
Chapter 28
Cisco Discovery Protocol Support Configuration Default CDP Setting
Default CDP Setting

Table 28-1 provides the default CDP settings.
Table 28-1 Default CDP Settings
Description Default Transmit Frequency Default Time to Live Default State
Default Value 60 seconds 180 seconds CDP advertisement enabled
28-7
Chapter 28 Default CDP Setting
28-8
OL-10643-01
A R T
Remote Serviceability Tools
C H A P T E R
29
Cisco Secure Telnet Configuration

This chapter provides a description and overview of Cisco Secure Telnet and contains the following topics:

Cisco Secure Telnet Components, page 29-1 Cisco Secure Telnet Applications, page 29-3 Cisco Secure Telnet Usage Scenario, page 29-7
Cisco Secure Telnet offers Cisco Service Engineers (CSE) transparent firewall access to Cisco Unified CallManager servers on your site. Cisco Secure Telnet works by enabling a Telnet client inside the Cisco Systems firewall to connect to a Telnet daemon behind your firewall. This secure connection allows remote monitoring and maintenance of your Cisco Unified CallManager servers without requiring firewall modifications.
Note
Cisco accesses your network only with your permission. You must provide a network administrator at your site to help initiate the process.
Cisco Secure Telnet Components

The following sections describe the Cisco Secure Telnet components:

The Relay Server, page 29-2 Telnet Client, page 29-2 Telnet Server, page 29-2
OL-10643-01
29-1
Chapter 29 Cisco Secure Telnet Components
The Relay Server

The Cisco relay server runs on the Windows NT platform. Because it is a node on the public Internet that is configured as a multiuser system, any Cisco customer using the Cisco Secure Telnet service can access it freely. You can make the relay server a dedicated device, or during a pilot period, you may attach it on an as-needed basis. The relay server resides outside the Cisco Systems firewall, but it comprises a secure and controlled system that Cisco Systems owns, manages, and operates.
Note
If easy access to the Internet is not available to access the relay server, use a dial-in connection to an ISP that allows direct Internet access to its devices.
Telnet Client
The Telnet client runs at the Cisco site on a UNIX host or Windows NT system. It provides terminal emulation over TCP/IP, providing a remote shell allowing entry into the server at your site. The Telnet client provides command line access to the Cisco Unified CallManager host through the Cisco relay server.
Telnet Server
The Telnet server resides on your network and runs on the Cisco Unified CallManager server. The Windows 2000 operating system runs on the Cisco Unified CallManager server and supports execution of the text-based commands used on the local system. The Telnet proxy, tndconnect, runs on the Cisco Unified CallManager server and links your Telnet server to the Cisco relay server.
29-2
OL-10643-01
Chapter 29
Cisco Secure Telnet Configuration Cisco Secure Telnet Applications
Note
The tndconnect window running on the Windows 2000 system displays the commands and responses being issued between Cisco TAC and your Cisco Unified CallManager system. However, depending on its terminal type support, the Windows 2000 Telnet daemon may eliminate spaces between the elements.
Cisco Secure Telnet Applications

The Cisco Secure Telnet system comprises four software components.
1. 2. 3. 4.
The Telnet Daemon Connect (tndconnect) program runs on a Cisco Unified CallManager server at your site. The relay application (relayapp) program runs on the Cisco relay or connect server. The Windows 2000 Telnet Daemon comprises Microsoft software that runs on the Cisco Unified CallManager server at your site. The standard Telnet client runs behind the firewall at the Cisco TAC.
Cisco Secure Telnet Executables

Invoke the tndconnect program command-line executable from a Windows 2000 command prompt window. Remote serviceability users invoke the tndconnect program from a command window on the Cisco Unified CallManager server. This program contacts the relayapp application on the relay server, which resides on the Internet. After you invoke tndconnect at your site, the CSE uses Telnet to reach relayapp to gain access to your system. Logging in to that system maps the Telnet sessions together, allowing technical support access to your site. Each executable includes command line parameters, such as passwords and TCP ports, that control the operating characteristics of each program.
29-3
Chapter 29 Cisco Secure Telnet Applications
Telnet Proxy
The tndconnect program acts as a proxy that provides the connection from your site to an external application residing on the relay server. If you use this connector program, you must specify certain command line parameters; some of these parameters are optional.
Command Line Syntax for tndconnect

The tndconnect program resides on your Cisco Unified CallManager server at C:\Program Files\Cisco\Bin. Invoke it on a command line; for example: tndconnect -host relayservername -password cisco -file connect.log -port 80 -verbose -noecho
Note
You can terminate tndconnect by entering Control-C in the window. The following list defines each of these parameters:
-host
<relay hostname> You must use the host argument because it defines the Domain Name System (DNS) name of target relay server. The CSE supplies you with that host name during the initial call.
-password
<any 4+ character string> You must use the password argument because it allows access to the relay server. CSE gives the password during the initial call. <logfile name> All Telnet exchanges generate logs, allowing for later review. The -file parameter provides an opportunity to name the log files that provide an audit trail of startup and console activity. The system logs all activity to the command window. If the -file argument is not used, the filename defaults to tndconnect.log. <optional port number> The port argument allows selection of a port on the relay server other than Telnet port 23, which is the default. You need this option in case the firewall at your site has blocked the Telnet port. For example, some servers might allow only HTTP transmissions through the firewall, in which case -port 80 could be used.
-file
-port
29-4
OL-10643-01
Chapter 29
Cisco Secure Telnet Configuration Cisco Secure Telnet Applications
-verbose
Use the verbose option if connectivity problems are anticipated. This parameter logs debug messages and program trace details to the log file as well as to the console window.
-target
<optional host name of Cisco Unified CallManager system> Use this parameter only if tndconnect resides on a system other than the Cisco Unified CallManager server; for example, a Telnet server at your site. In this case, you would have to specify the host name of the Cisco Unified CallManager system. If you do not use this argument, its value defaults to localhost.
-noecho
Disable the echo of the relayed data to the console.
Display All Options

Invoke the tndconnect program with the /? argument on a command line to give information on the entire system: tndconnect /? This command returns information on all the command line options.
Telnet Connector Program Structure

The tndconnect program performs the tasks that provide the CSE with the ability to log in to your Cisco Unified CallManager system.
Note
If the Telnet daemon is not running when the program executes, tndconnect prints an error message on your console, and the command terminates. When the tndconnect program starts, the command parser sets the values specified in the command line. If no specific parameters are set in the command line, the program uses default values, except for the -host and -password parameters. You must enter those values each time that you start tndconnect. When the CSE connects to the relay application, a signal instructs the tndconnect program to create TCP/IP structures and to connect to the local Telnet daemon.
29-5
Chapter 29 Cisco Secure Telnet Applications
If the -target option is not used, tndconnect defaults to your local Telnet server.
Note
You may have to add the name of the Cisco relay application server to the hosts file of the local system if DNS cannot locate it. If so, add a line with IP address and hostname to the file C:\WINNT\system32\drivers\etc\hosts to provide that hostname. The tndconnect program sends the information to the Cisco relay server, where the CSE logs in. The CSE then provides the IP address and password of the Cisco Unified CallManager and enters a return, which prompts the appearance of a login screen. The CSE then logs in to the Cisco Unified CallManager system using the password provided by the customer.
Terminate a Cisco Secure Telnet Session

Once a connection is established, a timer starts and eventually terminates the connection if no traffic is observed. The tunnel to your site established by tndconnect automatically terminates after 30 minutes of inactivity. If you deliberately disconnect, you must manually restart the Telnet Connector program each time that you use it. Any socket failure can also terminate the session as does closing the connection from either Cisco or the customer site. A close can occur when the CSE disconnects, the relay program ends, or if the Telnet daemon terminates. Termination may also occur if TCP detects connection failure, if either of the Telnet sessions closes, or if you terminate the tndconnect program by pressing Control-C. When the connection terminates, the program terminates, and the program takes down the tunnel constructed between the Cisco Unified CallManager Telnet server and the relay server.
Connect with the Telnet Daemon

Under the Cisco Secure Telnet system, the Telnet client and daemon comprise standard, unmodified components and exchange data just as they would if they connected directly.
29-6
OL-10643-01
Chapter 29
Cisco Secure Telnet Configuration Cisco Secure Telnet Usage Scenario
Any system running Cisco Unified CallManager must run the standard Windows 2000 Telnet daemon service. Because this program expects clients to connect into it, you need an additional software component, tndconnect, to both connect to the Telnet daemon and to establish a connection out of the corporate network and into the Telnet relay program. The Telnet daemon and tndconnect work together to provide an end-to-end connection through which Telnet session traffic may flow. The Telnet server component can run as a service in the background on the Cisco Unified CallManager Windows 2000 system. Responding to a connection request provides the primary function of the daemon. Once a Telnet session is established, you can execute command line programs. All these considerations affect the choice of Telnet daemon software.
Plan for a Windows NT Telnet Daemon

Because both Telnet daemon and File Transfer Protocol (FTP) servers make up part of Windows 2000 standard features, you can logically use these connectivity methods for remote serviceability.
Cisco Secure Telnet Usage Scenario

You may want to activate Cisco Secure Telnet to call in problems that require diagnosis of a remote Cisco Unified CallManager server by a CSE. The following sequence of events represents a common scenario.
Procedure
Step 1
Configure the Windows 2000 Telnet daemon to allow Telnet access from UNIX hosts. You may use the Windows 2000 command tndadmn to set the operating characteristics of the Telnet daemon.
Note
Make sure that the local Telnet session works and that a suitable userid and password are chosen for the Cisco TAC to log in.
Step 2
The CSE gives you a one-time password and the DNS name of the Cisco relay server to use to open communications.
OL-10643-01
29-7
Chapter 29 Cisco Secure Telnet Usage Scenario
Step 3 Step 4
If the Telnet daemon is not already running, you should start it by using the Windows 2000 System Control Panel, Services option. You run tndconnect to initiate a tunnel session between the Telnet Daemon and the Cisco relay server. The command-line syntax allows transmission of a one-time password, which acts as a correlator to the one supplied by the CSE upon connection to the relay server.
Note
Tunnels allow secure transmission of data streams between networks, making the routing appear transparent. Create them by using software that communicates through the firewall protecting the destination network.
Step 5
After bit manipulation encrypts the one-time password for transmission, tndconnect transmits it to relayapp for identification. When transmission is complete, your system is set up for Cisco TAC diagnostics. (You may observe the support engineer commands and responses in the tndconnect window.) After the Cisco TAC engineer disconnects, the tndconnect program terminates.
29-8
OL-10643-01
C H A P T E R
30
Show Command Line Interface

This chapter provides an overview of the Cisco Show command and contains the following topics:

Show Command Syntax, page 30-1 Show Command Options, page 30-2
A command line tool, show, displays the contents of the Cisco Unified CallManager configuration database, configuration file, memory statistics, and/or the Windows diagnostic information.
Show Command Syntax

You must install Cisco Unified CallManager to use the show tool. You run the show command from a DOS shell. You can display the output data on the console or save it into a text file.
Note
Because the show command uses a temporary file in the \Temp directory for the output, check to see that you have enough disk space available to receive it. The amount that you will need varies depending on a number of factors; for example, the number of users and devices being used and the size of the database being used by the system. Alternatively, you can run show.exe from a Telnet session if Telnet server software is enabled. The Program Files\Cisco\Bin directory contains the file show.exe.
OL-10643-01
30-1
Chapter 30 Show Command Options
The following syntax applies for the show command: show [-f <filename>] [-c <column width>] [-w <console width>] [-v] [command]
Show Command Options

Table 30-1 lists options that the show command supports.
Table 30-1 Show Command Options
Command -f <filename> -c <col width> -w <con width> -v
Description Name of file to print the report Width of each column in the database report (default 15) Width of the database report area (default 80) Verbose mode
Table 30-2 provides the Command parameter descriptions:

Table 30-2 Show Command Parameters
Command ? db db tables db t <tablename> inst [apps | elem | all] isdn [cluster | local | specific] ps
Description Show help message. Show configuration database. Show database table names. Show content of database table. Show information about installed applications and elements. Show D channel status on gateway. Show all processes running on the local system.
30-2
OL-10643-01
Chapter 30
Show Command Line Interface Show Command Options
Table 30-2 Show Command Parameters (continued)
Command win
Description Report windows diagnostics. The win command includes, but is not limited to, information such as system statistics, storage information, software environment, and summary statistics.
Note
Show win consumes a significant part of CPU resources to get the windows system information and takes a long time to display. Execute it only when Cisco Unified CallManager is not busy. Show tech reports the same multireport output as show command without a parameter.
tech | (none)
Report database and Windows system information.

Note
Example: show -f output.txt -v -w480 db show tech show db t ProcessNode
30-3
Chapter 30 Show Command Options
30-4
OL-10643-01
C H A P T E R
31
Simple Network Management Protocol Configuration

This chapter briefly describes Cisco Unified CallManager that is using the Simple Network Management Protocol (SNMP) interface. This chapter contains the following topics:

Configuring SNMP Security, page 31-2 Setting the SNMP Trap Receiver, page 31-3 Starting the Cisco Unified CallManager SNMP Extension Agent, page 31-4 Configuring the Cisco Unified CallManager Traps, page 31-5 Stopping the Cisco Unified CallManager SNMP Extension Agent, page 31-8 Understanding Cisco Real-Time Information Server Data Collector, page 31-9 Updating the CISCO-CCM-MIB Information, page 31-11
Related Topics

Chapter 12, Real-Time Monitoring Configuration Chapter 23, Microsoft Performance
31-1
Chapter 31 Configuring SNMP Security
Configuring SNMP Security

This section describes how to set the SNMP agent community name.
Caution
The Windows 2000 SNMP agent provides security through the use of community names and authentication traps. You must configure the community name to access any management information base (MIB) in a Cisco Unified CallManager system. Change the community name to limit access to the Cisco Unified CallManager system.
Note
Refer to the Microsoft Windows 2000 online help for SNMP configuration details.
Procedure
Choose Start > Settings > Control Panel. Double-click Administrative Tools. Double-click Services. Right-click SNMP Service. Choose Properties. Click the Security tab. In Accepted community names field, click the Add button. In the Community name field, enter the name, and in the community rights field, choose either READ-ONLY or READ-WRITE.
Note
To change the Cisco Unified CallManager trap configuration parameters, you need to use a community with READ-WRITE privileges.
Step 9 Step 10
Click the Add button. Choose the Accept SNMP packets from these hosts option to allow only specific network management system (NMS) hosts to query the SNMP extension agent.
31-2
OL-10643-01
Chapter 31
Simple Network Management Protocol Configuration Setting the SNMP Trap Receiver
Click the Add button. Enter the IP address for the hosts that are allowed to query the SNMP extension agent. Click the Add button. If you want to receive SNMP authentication failure traps, check the Send Authentication Trap check box.
Related Topics

Setting the SNMP Trap Receiver, page 31-3 Starting the Cisco Unified CallManager SNMP Extension Agent, page 31-4 Stopping the Cisco Unified CallManager SNMP Extension Agent, page 31-8
Setting the SNMP Trap Receiver

This section describes how to set the SNMP trap receiver.
Note
Refer to the Microsoft Windows 2000 online help for SNMP configuration details.
Procedure
Choose Start > Settings > Control Panel. Double-click Administrative Tools. Double-click Services. Right-click SNMP Service. Choose Properties. Click the Traps tab. In the Community name field, enter the community name to be used in the trap messages that are generated from this host. Click Add to list.
OL-10643-01
31-3
Chapter 31 Starting the Cisco Unified CallManager SNMP Extension Agent
In the Trap destinations field, click Add. In the Trap destinations field, enter the IP address or hostname of the trap destination. Click Add. Repeat Steps 9 through 11 for each trap destination that is required. Click OK.
Step 12
Related Topics

Configuring SNMP Security, page 31-2 Starting the Cisco Unified CallManager SNMP Extension Agent, page 31-4 Stopping the Cisco Unified CallManager SNMP Extension Agent, page 31-8
Starting the Cisco Unified CallManager SNMP Extension Agent

This section describes how to start the Cisco Unified CallManager SNMP extension agent.
Note
The SNMP service start s automatically when the system boots. Start the SNMP service only if it does not start automatically.
Procedure
Choose Start > Settings > Control Panel. Double-click Administrative Tools. Double-click Services. Right-click SNMP Service. From the toolbar, choose Start Service.
31-4
OL-10643-01
Chapter 31
Simple Network Management Protocol Configuration Configuring the Cisco Unified CallManager Traps
Note
You must activate the Cisco RIS Data Collector for the Cisco Unified CallManager SNMP Extension Agent to get loaded successfully.
Note
The dynamic tables such as phoneTable, gatewayTable, and so on, get populated only if the local Cisco CallManager service is up and running. The static tables such as region, time zone, device pool, and so on, in the Cisco Unified CallManager MIB, get populated only if the local Real-Time Information Server (RIS) data collector is up and running.
Related Topics

Configuring SNMP Security, page 31-2 Setting the SNMP Trap Receiver, page 31-3 Stopping the Cisco Unified CallManager SNMP Extension Agent, page 31-8
Configuring the Cisco Unified CallManager Traps

This section describes how to configure Cisco Unified CallManager SNMP traps.
Note
Make sure to start the SNMP service before you configure traps. Refer to the Starting the Cisco Unified CallManager SNMP Extension Agent section on page 31-4 to start SNMP. Also, make sure that you have configured the SNMP READ-WRITE community name correctly. Refer to the Configuring SNMP Security section on page 31-2. The CISCO-CCM-MIB supports the following traps:

ccmCallManagerFailed ccmPhoneFailed ccmPhoneStatusUpdate ccmGatewayFailed

OL-10643-01
31-5
Chapter 31 Configuring the Cisco Unified CallManager Traps
ccmMaliciousCall ccmMediaResourceListExhausted ccmQualityReportRequest ccmRouteListExhausted ccmGatewayLayer2Change
The ccmAlarmConfigInfo and ccmQualityReportAlarmConfigInfo groups in the CISCO-CCM-MIB define the configuration parameters that relate to these traps. Refer to the CISCO-CCM-MIB document for more details about these configuration parameters. Access the CISCO-CCM-MIB at the following link: ftp://ftp.cisco.com/pub/mibs/supportlists1/callmanager/callmanager-supportlist. html Table 31-1 comprises information about how to configure Cisco Unified CallManager trap parameters.
Note
Some changes in the default values for some parameters in the ccmAlarmConfigInfo group in the CCM MIB occurred since the earlier releases of Cisco Unified CallManager. Refer to the CISCO-CCM-MIB for more details.
31-6
OL-10643-01
Chapter 31
Simple Network Management Protocol Configuration Configuring the Cisco Unified CallManager Traps
Table 31-1 Cisco Unified CallManager Trap Configuration Parameters
Configuration Parameter Name ccmCallManagerAlarmEnable
Default Value True
Related Traps ccmCallManagerFailed
Configuration Steps
None, the default specifies these traps ccmMediaResourceListExh as enabled. austed ccmRouteListExhausted ccmGatewayFailed None, the default specifies these traps ccmGatewayLayer2Change as enabled. Note Although you can configure a Cisco ATA 186 device as a phone in Cisco Unified CallManager Administration, when Cisco Unified CallManager sends SNMP traps for the Cisco ATA device, it sends a gateway type trap; for example, ccmGatewayFailed. ccmPhoneStatusUpdate Set the ccmPhoneStatusUpda teAlarmInterval to a value between 30 and 3600. Set the ccmPhoneFailedAlar mInterval to a value between 30 and 3600.
ccmGatewayAlarmEnable
True
ccmPhoneStatusUpdateStorePeriod ccmPhoneStatusUpdateAlarmInterval
1800 0
ccmPhoneFailedStorePeriod ccmPhoneFailedAlarmInterval
1800 0
ccmPhoneFailed
31-7
Chapter 31 Stopping the Cisco Unified CallManager SNMP Extension Agent
Table 31-1 Cisco Unified CallManager Trap Configuration Parameters (continued)
Configuration Parameter Name ccmMaliciousCallAlarmEnable
Default Value true
Related Traps ccmMaliciousCall
Configuration Steps None. The default specifies this trap is enabled. None. The default specifies this trap is enabled.
ccmQualityReportAlarmEnable
true
ccmQualityReport
Note
This trap gets generated only if the Cisco Extended Functions service is activated and running on the local Cisco Unified CallManager node.
Related Topics

Setting the SNMP Trap Receiver, page 31-3 Starting the Cisco Unified CallManager SNMP Extension Agent, page 31-4 Updating the CISCO-CCM-MIB Information, page 31-11
Stopping the Cisco Unified CallManager SNMP Extension Agent

This section describes how to stop the Cisco Unified CallManager SNMP extension agent.
Caution
Stopping the SNMP service results in loss of data; the network management system no longer monitors the Cisco Unified CallManager network. Do not stop the service except in an emergency.
31-8
OL-10643-01
Chapter 31
Simple Network Management Protocol Configuration Understanding Cisco Real-Time Information Server Data Collector
Procedure
Choose Start > Settings > Control Panel. Double-click Administrative Tools. Double-click Services. Right-click SNMP Service. From the toolbar, choose Stop Service. The SNMP Service stops, and the Cisco Unified CallManager SNMP extension agent no longer functions.
Related Topics

Configuring SNMP Security, page 31-2 Setting the SNMP Trap Receiver, page 31-3 Starting the Cisco Unified CallManager SNMP Extension Agent, page 31-4
Understanding Cisco Real-Time Information Server Data Collector

The Cisco Real-Time Information Server (RIS) data collector service has responsibility for sending the configured information from the Cisco Unified CallManager database into the RIS database. Cisco Unified CallManager sends all the dynamic information to the RIS database through the alarm interface.
Starting the Cisco RIS Data Collector

This section describes how to start the Cisco RIS data collector.
Note
The Cisco RIS data collector service should start automatically when the system boots. Start the Cisco RIS data collector service only if it does not start automatically.
31-9
Chapter 31 Understanding Cisco Real-Time Information Server Data Collector
Procedure
Choose Start > Settings > Control Panel. Double-click Administrative Tools. Double-click Services. Choose Cisco RIS DC Service. From the toolbar, choose Start Service. The Cisco RIS data collector service starts, and all the static tables in the CISCO-CCM-MIB get populated with configuration data from the Cisco Unified CallManager database.
Note
The dynamic tables such as phoneTable, gatewayTable, and so on, get populated only if the local Cisco CallManager service is up and running.
Related Topics

Understanding Cisco Real-Time Information Server Data Collector, page 31-9 Stopping Cisco RIS Data Collector, page 31-10
Stopping Cisco RIS Data Collector

This section describes how to stop the Cisco RIS data collector.
Caution
Stopping the Cisco RIS data collector service results in loss of static information in the CISCO-CCM-MIB. Do not stop the service except in an emergency.
Procedure
Step 1 Step 2
Choose Start > Settings > Control Panel. Double-click Administrative Tools.
31-10
OL-10643-01
Chapter 31
Simple Network Management Protocol Configuration Updating the CISCO-CCM-MIB Information
Double-click Services. Choose Cisco RIS DC Service. From the toolbar, choose Stop Service. The Cisco RIS data collector service stops, and the Cisco Unified CallManager SNMP extension agent loses the static information in the CCM MIB; the dynamic tables will still contain valid data as long as the local Cisco CallManager service is running.
Related Topics

Understanding Cisco Real-Time Information Server Data Collector, page 31-9 Stopping Cisco RIS Data Collector, page 31-10
Updating the CISCO-CCM-MIB Information

The CISCO-CCM-MIB contains both dynamic and configured (static) information that relate to a Cisco Unified CallManager system. At startup, the Cisco RIS data collector service updates the RIS database with all the configured information from the Cisco Unified CallManager database. It also updates the RIS static data when configuration data changes occur in the Cisco Unified CallManager database. When the status of a device changes, Cisco Unified CallManager sends all the dynamic information to the RIS database through the alarm interface.
31-11
Chapter 31 Updating the CISCO-CCM-MIB Information
31-12
OL-10643-01
A R T
Appendix
A P P E N D I X
Understanding CAR Reports

This chapter describes report output information for each of the CAR report types:

Bill Summary Report Results, page A-2 Bill Detail Report Results, page A-4 Top N By Charge or Duration Report Results, page A-6 Top N By Number of Calls Report Results, page A-8 Call Usage for AssistantDetail, page A-9 Call Usage for AssistantSummary, page A-10 Call Usage for ManagerDetail, page A-11 Call Usage for ManagerSummary, page A-12 CTI Application User Report Results, page A-13 Cisco Unified IP Phone Services Report Results, page A-14 QoS Detail Report Results, page A-14 QoS Summary Report Results, page A-16 QoS by Gateways Report Results, page A-17 QoS by Call Types Report Results, page A-18 Traffic Summary Report Results, page A-20 Authorization Code Name Call Details, page A-21 Authorization Level Call Details, page A-22 Client Matter Code Details, page A-23
A-1
Appendix A Bill Summary Report Results
Malicious Call Details Report Results, page A-23 Precedence Call Summary Report Results, page A-24 System Overview Report Results, page A-25 CDR Error Report Results, page A-27 Gateway Detail Report Results, page A-28 Gateway Summary Report Results, page A-30 Gateway and Route Utilization Report Results, page A-31 Conference Call Detail Report Results, page A-32 Conference Bridge Utilization Report Results, page A-33 Voice Messaging Utilization Report Results, page A-34 Understanding the CDR Search Results, page A-35 Media Information, page A-37 CDR and CMR Dump Tables, page A-38
Bill Summary Report Results

The report groups information by the user name in ascending order. The summary report includes the following fields (see Table A-1).
Table A-1 Summary Report Fields
Field Internal
Description Intracluster calls that originated in the Cisco Unified CallManager network and ended in the same Cisco Unified CallManager network (no gateways are used).
Call ClassificationCall categories specify classes.
A-2
OL-10643-01
Appendix A
Understanding CAR Reports Bill Summary Report Results
Table A-1
Summary Report Fields (continued)
Field Local
Description Local calls that are routed through the public switched telephone network (PSTN) to numbers without an area code or which include one of the local area codes. Long-distance calls originating in the Cisco Unified CallManager network going out through the PSTN. International calls originating in the Cisco Unified CallManager network going out through the PSTN. Outgoing, intercluster calls that originate on one Cisco Unified CallManager cluster and terminate on a different cluster. All other outgoing calls, such as toll-free numbers or emergency calls such as 911.
Long Distance
International
On Net
Others
QOSThe number of calls for each Quality of Service category. Parameters set by the CAR administrator provided basis for QoS categories; see Defining the Quality of Service (QoS) Values, page 17-9, and Configuring QoS Parameters, page 19-8. Good Acceptable QoS for these calls designates the highest possible quality. QoS for these calls shows them slightly degraded but still falls within an acceptable range. QoS for these calls, although degraded, still fall within a usable range. QoS for these calls was unsatisfactory. These calls did not match any of the criteria for the established QoS categories.
Fair Poor NA
A-3
Appendix A Bill Detail Report Results
Table A-1
Summary Report Fields (continued)
Field
Description
CallsIndicates the number of calls for each call classification. The total number of calls and total charges by reportee and per-call classification by manager ChargeIndicates the charge associated with each call. Call charge information provided by the CAR administrator for the CAR rating engine provides basis for charges. See Configuring the Rating Engine, page 17-2.
Bill Detail Report Results

The report groups information by the user name in ascending order. The detail report includes the following fields (see Table A-2).
Table A-2 Detail Report Fields
Field Date and Orig. Time Orig. Dest.
Description The date and time the that call originated. The originating number from which the call was placed. The destination number to which the call was directed. Intracluster calls that originated in the Cisco Unified CallManager network and ended in the same Cisco Unified CallManager network (no gateways are used). Local calls that are routed through the public switched telephone network (PSTN) to numbers without an area code or which include one of the local area codes.
Call ClassificationCall categories specify classes. Internal
Local
A-4
OL-10643-01
Appendix A
Understanding CAR Reports Bill Detail Report Results
Table A-2
Detail Report Fields (continued)
Field Long Distance
Description Long-distance calls originating in the Cisco Unified CallManager network going out through the PSTN. International calls originating in the Cisco Unified CallManager network going out through the PSTN. Outgoing, intercluster calls that originate on one Cisco Unified CallManager cluster and terminate on a different cluster. All other outgoing calls, such as toll-free numbers or emergency calls such as 911.
International
On Net
Others
QOSThe number of calls for each Quality of Service category. Parameters set by the CAR administrator provided basis for QoS categories; see Defining the Quality of Service (QoS) Values, page 17-9, and Configuring QoS Parameters, page 19-8. Good Acceptable QoS for these calls designates the highest possible quality. QoS for these calls shows them slightly degraded but still falls within an acceptable range. QoS for these calls, although degraded, still falls within a usable range. QoS for these calls was unsatisfactory. These calls did not match any of the criteria for the established QoS categories.
Fair Poor NA
A-5
Appendix A Top N By Charge or Duration Report Results
Table A-2
Field Duration(s) Charge
Description The time, in seconds, that the call was connected. Indicates the charge associated with each call. Call charge information provided by the CAR administrator for the CAR rating engine provides basis for charges. See Configuring the Rating Engine, page 17-2.
Top N By Charge or Duration Report Results

The fields for the Top N by Charge and the Top N by Duration vary depending on the report type. The reports show only outgoing calls. See Table A-3.
Table A-3 Top N by Charge and by Duration Report Fields
Field By Individual Users Users Calls Duration(s) Charge
Description User names. Total number of calls. The time, in seconds, that the call was connected. Indicates the charge associated with each call. Call charge information provided by the CAR administrator for the CAR rating engine provides basis for charges. See Configuring the Rating Engine, page 17-2. The destination of the calls. The total number of calls for each call classification.
By Destinations Dest Call Classification
A-6
OL-10643-01
Appendix A
Understanding CAR Reports Top N By Charge or Duration Report Results
Table A-3
Top N by Charge and by Duration Report Fields (continued)
Field Calls Duration Charge
Description Total number of calls. The time, in seconds, that the call was connected. Indicates the charge associated with each call. Call charge information provided by the CAR administrator for the CAR rating engine provides basis for charges. See Configuring the Rating Engine, page 17-2. User names. Date that the call occurred. Time that the calls originated. Destination of the calls. The total number of calls for each call classification. The time, in seconds, that the call was connected. Indicates the charge associated with each call. Call charge information provided by the CAR administrator for the CAR rating engine provides basis for charges. See Configuring the Rating Engine, page 17-2.
By Number of Calls User Date Orig Time Orig Dest Call Classification Duration Charge
A-7
Appendix A Top N By Number of Calls Report Results
Top N By Number of Calls Report Results

The fields for the Top N by Number of Calls report vary depending on the report type. The report shows both incoming and outgoing calls. See Table A-4.
Table A-4 Top N by Number of Calls Report Fields
Field By Individual Users Users Calls Duration(s) Charge
Description User names. Total number of calls. The time, in seconds, that the call was connected. The total amount of billing charges for all calls to that user. Call charge information provided by the CAR administrator for the CAR rating engine provides basis for charges. See Configuring the Rating Engine, page 17-2. The total number of calls placed by the user. The total number of calls received by the user. The total number of incoming and outgoing calls. The extension call originator. The total amount of billing charges for all calls to that user. Call charge information provided by the CAR administrator for the CAR rating engine provides basis for charges. See Configuring the Rating Engine, page 17-2.
Calls Made Calls Received Total Calls By Extensions Extension Number Charge
A-8
OL-10643-01
Appendix A
Understanding CAR Reports Call Usage for AssistantDetail
Table A-4
Top N by Number of Calls Report Fields (continued)
Field Duration Calls Made Calls Received Total Calls
Description The time, in seconds, that the call was connected. The total number of calls placed by the user. The total number of calls received by the user. The total number of incoming and outgoing calls.
Call Usage for AssistantDetail

This report, which supports Cisco Unified CallManager Assistant, shows the number of calls handled by the assistants for themselves, by the assistant for each manager, and the total number of calls handled by the assistant. The report groups information about calls handled by the assistant and calls handled by the assistant for the manager. The detail report includes the following fields (see Table A-5).
Field Date Orig. Time Orig. Dest. Call Classification Duration (sec)
Description The date that the call originated. The time the that call originated. The originating number from which the call was placed. The destination number to which the call was directed. The total number of calls for each call type (internal, incoming, etc.) The time, in seconds, that the call was connected.
A-9
Appendix A Call Usage for AssistantSummary
Call Usage for AssistantSummary

This report, which supports Cisco Unified CallManager Assistant, shows information about calls handled by the assistant for themselves and the assistant for the manager. The reports groups call information by attendant name. The summary report includes the following fields (see Table A-6).
Field Assistant-Extn/Manager
Description Shows the assistant name and directory number. If the assistant handles a call for a manager, the manager name displays. Intracluster calls that originated in the Cisco Unified CallManager network and ended in the same Cisco Unified CallManager network (no gateways are used). Local calls that are routed through the public switched telephone network (PSTN) to numbers without an area code or which include one of the local area codes. Long-distance calls originating in the Cisco Unified CallManager network going out through the PSTN. International calls originating in the Cisco Unified CallManager network going out through the PSTN. Outgoing, intercluster calls that originate on one Cisco Unified CallManager cluster and terminate on a different cluster.
Local
Long Distance
International
On Net
A-10
OL-10643-01
Appendix A
Understanding CAR Reports Call Usage for ManagerDetail
Table A-6
Field Others
Description All other outgoing calls, such as toll-free numbers or emergency calls such as 911. Shows the number of calls handled by the assistant or the assistant for the manager. Shows the total number of duration for all the calls for the particular call classification.
Calls
Duration (sec)
Call Usage for ManagerDetail

The report, which support Cisco Unified CallManager Assistant, provides information about calls handled by managers for themselves and assistants for managers. The report groups information by the assistant name and shows the total number of calls handled by the manager and by the assistant for the manager. The detail report includes the following fields (see Table A-7).
Field Date Orig. Time Orig. Dest. Call Classification Duration (sec)
Description The date that the call originated. The time the that call originated. The originating number from which the call was placed. The destination number to which the call was directed. The total number of calls for each call type (internal, incoming, etc.) The time, in seconds, that the call was connected.
A-11
Appendix A Call Usage for ManagerSummary
Call Usage for ManagerSummary

This report, which supports the Cisco Unified CallManager Assistant, shows information about calls that are handled by the managers for themselves and the assistants for the managers. The report groups information by the manager name and shows the total number of calls handled for each manager. The report includes the following fields (see Table A-6).
Field Manager-Extn/Assistant
Description Shows the manager name and directory number. If the assistant handles a call for a manager, the assistant name displays. Intracluster calls that originated in the Cisco Unified CallManager network and ended in the same Cisco Unified CallManager network (no gateways are used). Local calls that are routed through the public switched telephone network (PSTN) to numbers without an area code or which include one of the local area codes. Long-distance calls originating in the Cisco Unified CallManager network going out through the PSTN. International calls originating in the Cisco Unified CallManager network going out through the PSTN. Outgoing, intercluster calls that originate on one Cisco Unified CallManager cluster and terminate on a different cluster.
Local
Long Distance
International
On Net
A-12
OL-10643-01
Appendix A
Understanding CAR Reports CTI Application User Report Results
Table A-8
Field Others
Description All other outgoing calls, such as toll-free numbers or emergency calls such as 911. Shows the number of calls handled by the assistant or the manager. Shows the total number of duration for all the calls for the particular call classification.
Calls Duration
CTI Application User Report Results

The report for CTI Application User report includes the following fields. See Table A-9.
Table A-9 CTI Application User Report Fields
Field Sl No. User Name User ID
Description The serial or record number. The user name of the CTI application user. The user identification number of the CTI application user.
A-13
Appendix A Cisco Unified IP Phone Services Report Results
Cisco Unified IP Phone Services Report Results

The Cisco Unified IP Phone Services report includes the following fields. See Table A-10.
Table A-10 Cisco Unified IP Phone Services Report Fields
Field Cisco Unified IP Phone Services Number of Subscribers % Subscription
Description The name of the selected service. The total number of subscribers for a given service. The percentage of users who have subscribed to a given service, out of the total number of subscriptions for all services.
QoS Detail Report Results

The QoS detail report includes the following fields. See Table A-11.
Table A-11 QoS Detail Report Fields
Field Orig. Time Term. Time Duration(s) Orig. Dest.
Description The time the call was placed, in 24-hour, minute, and second format. The time the call disconnected, in 24-hour, minute, and second format. The amount of time, in seconds, that the call was connected. The originating number from which the call was placed. The destination number to which the call was directed.
A-14
OL-10643-01
Appendix A
Understanding CAR Reports QoS Detail Report Results
Table A-11 QoS Detail Report Fields (continued)
Field Internal
Description Intracluster calls that originated in the Cisco Unified CallManager network and ended in the same Cisco Unified CallManager network (no gateways are used). Local calls that are routed through the public switched telephone network (PSTN) to numbers without an area code or which include one of the local area codes. Long-distance calls originating in the Cisco Unified CallManager network going out through the PSTN. International calls originating in the Cisco Unified CallManager network going out through the PSTN. Outgoing, intercluster calls that originate on one Cisco Unified CallManager cluster and terminate on a different cluster. Inbound calls that originated outside the Cisco Unified CallManager network, entered through a gateway, and went into the Cisco Unified CallManager network. Inbound calls that originated outside the Cisco Unified CallManager network, entered the Cisco Unified CallManager network through a gateway, and were transferred outbound from the Cisco Unified CallManager network through a gateway.
Call ClassificationCall categories specify classes.
Local
Long Distance
International
On Net
Incoming
Tandem
A-15
Appendix A QoS Summary Report Results
Table A-11 QoS Detail Report Fields (continued)
Field Others
Description All other outgoing calls, such as toll-free numbers or emergency calls such as 911. The codec used by the originating device. The codec used by the destination device. The name of the device that placed the call. The name of the device that received the call. The voice quality experienced by the device that placed the call. The voice quality experienced by the device that received the call.
Orig. Codec Dest. Codec Orig. Device Dest. Device Orig. QoS Dest. QoS
QoS Summary Report Results

The QoS summary report includes the following fields. See Table A-12.
Table A-12 QoS Summary Report Fields
Field Quality of Service Call Legs
Description The quality of service of the calls. Number of call legs with the quality of service specified in the Quality of Service field.
A-16
OL-10643-01
Appendix A
Understanding CAR Reports QoS by Gateways Report Results
QoS by Gateways Report Results

The QoS by gateways report provides the following information. See Table A-13.
Table A-13 QoS Gateway Report Fields
Field Time
Description Indicates the cumulative hours of the day(s), the days of the week, or the days of the month for the selected date range. Displays the percentage of calls for each gateway for the hours of the day, the days of the week, or the days of the month for the selected date range.
% of Calls
A-17
Appendix A QoS by Call Types Report Results
QoS by Call Types Report Results

The QoS by call types report provides the following information. See Table A-14.
Table A-14 QoS Call Type Report Fields
Field Time
Description Indicates the cumulative hours of the day(s), the days of the week, or the days of the month for the selected date range. Displays the percentage of calls for each gateway for the hours of the day, the days of the week, or the days of the month for the selected date range. Intracluster calls that originated in the Cisco Unified CallManager network and ended in the same Cisco Unified CallManager network (no gateways are used). Local calls that are routed through the public switched telephone network (PSTN) to numbers without an area code or which include one of the local area codes. Long-distance calls originating in the Cisco Unified CallManager network going out through the PSTN. International calls originating in the Cisco Unified CallManager network going out through the PSTN. Outgoing, intercluster calls that originate on one Cisco Unified CallManager cluster and terminate on a different cluster.
% of Calls
Internal
Local
Long Distance
International
On Net
A-18
OL-10643-01
Appendix A
Understanding CAR Reports QoS by Call Types Report Results
Table A-14 QoS Call Type Report Fields (continued)
Field Incoming
Description Inbound calls that originated outside the Cisco Unified CallManager network, entered through a gateway, and went into the Cisco Unified CallManager network. Inbound calls that originated outside the Cisco Unified CallManager network, entered the Cisco Unified CallManager network through a gateway, and were transferred outbound from the Cisco Unified CallManager network through a gateway. All other outgoing calls, such as toll-free numbers or emergency calls such as 911. The total number of calls for each hour or day.
Tandem
Others
Total
A-19
Appendix A Traffic Summary Report Results
Traffic Summary Report Results

The traffic summary and traffic summary by extension reports contain the same information and include some or all of the following fields. See Table A-15.
Table A-15 Traffic Summary Report Fields
Field Time
Description Indicates the cumulative hours of the day(s), the days of the week, or the days of the month for the selected date range. Displays the percentage of calls for each gateway for the hours of the day, the days of the week, or the days of the month for the selected date range. Intracluster calls that originated in the Cisco Unified CallManager network and ended in the same Cisco Unified CallManager network (no gateways are used). Local calls that are routed through the public switched telephone network (PSTN) to numbers without an area code or which include one of the local area codes. Long-distance calls originating in the Cisco Unified CallManager network going out through the PSTN. International calls originating in the Cisco Unified CallManager network going out through the PSTN. Outgoing, intercluster calls that originate on one Cisco Unified CallManager cluster and terminate on a different cluster.
No of Calls
Internal
Local
Long Distance
International
On Net
A-20
OL-10643-01
Appendix A
Understanding CAR Reports Authorization Code Name Call Details
Table A-15 Traffic Summary Report Fields (continued)
Field Incoming
Description Inbound calls that originated outside the Cisco Unified CallManager network, entered through a gateway, and went into the Cisco Unified CallManager network. Inbound calls that originated outside the Cisco Unified CallManager network, entered the Cisco Unified CallManager network through a gateway, and were transferred outbound from the Cisco Unified CallManager network through a gateway. All other outgoing calls, such as toll-free numbers or emergency calls such as 911. The total number of calls for each hour or day.
Tandem
Others
Total
Authorization Code Name Call Details

This report shows the usage of specific authorization code names. For security purposes, the authorization code authorization code name (description) displays and not the authorization code. The detail report includes the following fields (see Table A-2).
Field Orig. Dest.
Description The originating number from which the call was placed. The destination number to which the call was directed.
A-21
Appendix A Authorization Level Call Details
Table A-16 Detail Report Fields (continued)
Field Date and Orig. Time Duration (sec) Call Classification Authorization Level
Description The date and time the that call originated. The time, in seconds, that the call was connected. The total number of calls for each call type (internal, incoming, etc.) The authorization level for calls for each chosen authorization code name.
Authorization Level Call Details

This report shows the usage of specific authorization levels. The detail report includes the following fields (see Table A-17).
Field Orig. Dest. Date and Orig. Time Duration (sec) Call Classification Authorization Code Name
Description The originating number from which the call was placed. The destination number to which the call was directed. The date and time the that call originated. The time, in seconds, that the call was connected. The total number of calls for each call type (internal, incoming, etc.) The authorization code name for each authorization level you chose.
A-22
OL-10643-01
Appendix A
Understanding CAR Reports Client Matter Code Details
Client Matter Code Details

The report shows the usage of specific client matter codes. The detail report includes the following fields (see Table A-18).
Field Orig. Dest. Orig. Date and Time Duration (sec) Call Classification
Description The originating number from which the call was placed. The destination number to which the call was directed. The date and time the that call originated. The time, in seconds, that the call was connected. The total number of calls for each call type (internal, incoming, etc.)
Malicious Call Details Report Results

The Malicious Call Details report provides information about malicious calls. The report provides the following fields. See Table A-19.
Table A-19 Malicious Call Details Report Fields
Field Orig. Time Term. Time Duration Orig. Dest. Orig. Device
Description Time at which the malicious call originated. Time at which the malicious call terminated. Total time of malicious call. Originating DN. Destination DN. Name of the originating device.
A-23
Appendix A Precedence Call Summary Report Results
Table A-19 Malicious Call Details Report Fields (continued)
Field Dest. Device Call Classification
Description Name of the destination device. Classification of the malicious call.
Precedence Call Summary Report Results

The Precedence Call Summary report provides information about calls based on precedence levels. The report displays the call summary for the precedence values in the form of a stacked bar on an Hour of Day, Day of Week, or Day of Month basis for each of the precedence levels you choose. Two tables, one reflecting the stacked bar chart, and the other listing the Number of Calls and Percentage for each of the precedence levels chosen displays in the report. See.
Table A-20 Precedence Call Summary Report Fields
Field Time Precedence Level No. of Call Legs Percentage
Description Time at which the call took place. Precedence level value of the call. Number of call legs per each precedence level. Percentage of calls per each precedence level.
A-24
OL-10643-01
Appendix A
Understanding CAR Reports System Overview Report Results
System Overview Report Results

The system overview provides information about all parts of the Cisco Unified CallManager network. The report provides the following sections. See Table A-21.
Table A-21 System Overview Report
Field Top 5 Users based on Charge
Description Details the 5 users who have incurred the highest charges for calls that occurred during the specified date range. See Top N By Charge or Duration Report Results, page A-6, for details about this section of the system overview report. Details the 5 called numbers that have incurred the highest charges for calls during the specified date range. See Top N By Charge or Duration Report Results, page A-6, for details about this section of the system overview report. Details the 5 calls that have incurred the highest charges for calls during the specified date range. See Top N By Charge or Duration Report Results, page A-6, for details about this section of the system overview report. Details the 5 users who have spent the most time on calls during the specified date range. See Top N By Charge or Duration Report Results, page A-6, for details about this section of the system overview report.
Top 5 Destinations based on Charge
Top 5 Calls based on Charge
Top 5 Users based on Duration
A-25
Appendix A System Overview Report Results
Table A-21 System Overview Report (continued)
Field Top 5 Destinations based on Duration
Description Details the 5 called numbers that have been engaged in calls for the longest time during the specified date range. See Top N By Charge or Duration Report Results, page A-6, for details about this section of the system overview report. Details the 5 longest calls for the date range specified. See Top N By Charge or Duration Report Results, page A-6, for details about this section of the system overview report.
Top 5 Calls based on Duration
Traffic Summary Report - Hour of Day Shows the volume of calls during the specified date range based on each hour of the day. See Traffic Summary Report Results, page A-20, for details about this section of the system overview report. Traffic Summary Report - Day of Week Shows the volume of calls during the specified date range based on each day of the week. See Traffic Summary Report Results, page A-20, for details about this section of the system overview report. Traffic Summary Report - Day of Month Shows the volume of calls during the specified date range based on each day of the month. See Traffic Summary Report Results, page A-20, for details about this section of the system overview report.
A-26
OL-10643-01
Appendix A
Understanding CAR Reports CDR Error Report Results
Table A-21 System Overview Report (continued)
Field Quality of Service Report - Summary
Description Shows the number of calls that fell within each voice-quality category during the specified date range. See QoS Summary Report Results, page A-16, for details about this section of the system overview report. Shows the summary of the call classification for each gateway along with the QoS, the number of calls, and the duration for each classification for the gateway during the specified date range. See QoS by Gateways Report Results, page A-17, for details about this section of the system overview report.
Gateway Summary Report
CDR Error Report Results

The CDR error report provides the following information. See Table A-22.
Table A-22 CDR Error Report Fields
Field Time No of Error CDRs
Description The hour for the specified day that the error occurred. The total number of CDR data records that were not processed during loading into CAR due to an error. The total number of CDR data records that were successfully loaded to CAR. The percentage of failed CDR data records out of all the CDR data records to be loaded.
No of Valid CDRs % of Error CDRs
A-27
Appendix A Gateway Detail Report Results
Table A-22 CDR Error Report Fields (continued)
Field Error Description % of Error CDRs
Description An error that occurred when trying to load the CDR data records. The percentage of CDR data records that failed due to the corresponding error description.
Gateway Detail Report Results

The gateway detail report includes the following fields. See Table A-23.
Table A-23 Gateway Detail Report Fields
Field Date Orig. Time Term. Time Duration(s)
Description The date when the call went through the gateway. The time when the call went through the gateway. The time that the call terminated. The duration, in seconds, that the call was connected. The duration specifies the difference between the Dest Connect and the Dest Disconnect times. The directory number from which the call was placed.
Orig
A-28
OL-10643-01
Appendix A
Understanding CAR Reports Gateway Detail Report Results
Table A-23 Gateway Detail Report Fields (continued)
Field Dest
Description The directory number to which the call was originally placed. If the call was not forwarded, this directory number should match the Final Destination number. If the call was forwarded, this field contains the original destination number of the call before it was forwarded. The codec type (compression or payload type) that the call originator used on its sending side during this call. This type may differ from the codec type used on its receiving side. The codec type (compression or payload type) that the destination used on its sending side during this call. This type may differ from the codec type used on its receiving side. The device name of the device that placed the call. For incoming and tandem calls, this field specifies the device name of the gateway. The device name of the device that received the call. For outgoing and tandem calls, this field specifies the device name of a gateway. For conference calls, this field specifies the device name of the conference bridge. Quality of service shows the voice-quality grade achieved for the calls. The QOS category experienced by the receiver of the call.
Orig. Codec
Dest. Codec
Orig. Device
Dest Device
Orig QoS
Dest QoS
A-29
Appendix A Gateway Summary Report Results
Gateway Summary Report Results

The gateway summary report includes the following fields. See Table A-24.
Note
The gateway summary report segregates calls for each call classification selected by the user, and divides the calls on QoS type.
Table A-24 Gateway Summary Report Fields
Field Call Classification Quality of Service
Description Shows the total number of calls for each call classification. Shows a summary of the performance of the various gateways with the total number of calls for each voice-quality category. The parameters set in the Defining the Quality of Service (QoS) Values, page 17-9, provide the basis for all voice-quality categories.
GoodQoS for these calls specifies the highest possible quality. AcceptableQoS for these calls, although slightly degraded, still falls within an acceptable range. FairQoS for these calls, although degraded, still falls within a usable range. PoorQoS for these calls was unsatisfactory. NAThese calls did not match any criteria for the established QoS categories.
A-30
OL-10643-01
Appendix A
Understanding CAR Reports Gateway and Route Utilization Report Results
Table A-24 Gateway Summary Report Fields (continued)
Field Calls Duration(s)
Description Shows the total number of calls for the particular call classification. Shows the total number of duration for all the calls for the particular call classification.
Gateway and Route Utilization Report Results

The gateway, route group, route list, and route pattern utilization reports provide similar output. If you generate these reports in CSV format, the report displays in a table. If you chose PDF, the report shows the utilization as a bar chart. A graph displays for each selected gateway or route group. See Table A-25.
Table A-25 Gateway and Route Utilization Report Fields
Field Time
Description Time in one-hour blocks if you chose Hourly or one-day blocks if you chose weekly or monthly. The results show the utilization for each hour or day for the entire period shown in the from and to dates. Gateway, route group, route list, or route pattern utilization percentage. This field gives the cumulative utilization percentage of the gateways or route groups or route lists or route patterns to the total number of calls that all the gateways put together can support at any one time.
Percentage
A-31
Appendix A Conference Call Detail Report Results
Conference Call Detail Report Results

You can choose to generate a Conference Call information either in a summary or a detailed report. The reports display the call details in a table whether you chose to generate the report in the CSV or PDF format. The following tables show the fields in the Conference Call Detail and Summary reports.
Note
The report criteria includes the type of conference (Ad-Hoc, Meet-Me, and/or Application Controlled), and the From and To date range.
Table A-26 Conference Call Detail Summary Report Fields
Field Orig. Time Term. Time No. of Participants Duration App Conf Id
Description Time that the first participant enters the conference. Time that the last participant leaves the conference. Number of participants in the conference. Sum of the duration of individual participants in the conference.
Note
This field generates only for Application Controlled conferences.
Device Name
Names of the conference devices used.
Table A-27 Conference Call Detail Report Fields
Field Conference Start Time Conference End Time
Description Time at which conference started. Time at which conference ended.
A-32
OL-10643-01
Appendix A
Understanding CAR Reports Conference Bridge Utilization Report Results
Table A-27 Conference Call Detail Report Fields (continued)
Field Application Conference Id
Description
Note
This field generates only for Application Controlled conferences.
Connect Time Disconnect Time Duration Directory Number Call Classification Device Name QoS
Time at which conference participants connected to conference. Time at which conference participants disconnected from conference. Total time of conference. Directory number of participants. Call types of conference (internal, incoming, etc.) Names of the conference devices used. Quality of service.
Conference Bridge Utilization Report Results

The report provides the following fields. If you chose CSV output, the report displays the utilization in a table. If you chose PDF, the report shows the utilization as a bar chart. See Table A-28.
Table A-28 Conference Bridge Utilization Report Fields
Field Time
Description Time in one-hour blocks if you chose Hourly or one-day blocks if you chose day of week or daily. Conference bridge utilization percentage. The conference bridge device that is used to hold conference calls.
Percentage Conf. Bridge
A-33
Appendix A Voice Messaging Utilization Report Results
Table A-28 Conference Bridge Utilization Report Fields (continued)
Field Type of Conference Bridge Max Streams
Description Either hardware of software conference bridge. The number of conferences that can be held at a time along with the number of people per conference.
Voice Messaging Utilization Report Results

The report provides the following fields. If you chose CSV output, the report displays the utilization in a table. If you chose PDF, the report shows the utilization as a bar chart. See Table A-29.
Table A-29 Voice Messaging Utilization Report Fields
Field Percentage Time
Description Voice-messaging utilization percentage. Time in one-hour blocks if you chose Hourly or one-day blocks if you chose day of week or daily. Time in one-hour blocks if you chose Hourly or one-day blocks if you chose day of week or daily. The sum of the maximum number of ports for all the gateways under the route patterns configured for Octel voice mail and the entries in the Device table of Cisco Unified CallManager that have type Class as 8.
Time
Voice Mail Ports
A-34
OL-10643-01
Appendix A
Understanding CAR Reports Understanding the CDR Search Results
Table A-29 Voice Messaging Utilization Report Fields (continued)
Field Voice Messaging Gateways
Description The originating or destination device name as the gateways under the route patterns configured for Octel system. The number of ports supported by the voice-messaging gateway.
Number of Ports
Understanding the CDR Search Results

The following sections describe CDR search results: Understanding the Results for CDR Search, page A-35, Media Information, page A-37, and CDR and CMR Dump Tables, page A-38.
Understanding the Results for CDR Search

The CDR search provides following information. See Table A-30.
Table A-30 CDR Search Results
Field Sl No Call Type GCID_CMId GCID_CallId Orig Node Id Dest Node Id
Description The serial or record number. The type of call: simple, transfer, forward, pickup, or conference. The call identifiers associated with all the records for the entire call. The node within the Cisco Unified CallManager cluster where the call originator/destination was registered at the time of the call. The unique identifiers (within a cluster) to the originating/destination leg of a call.
Orig Leg Id Dest Leg Id
A-35
Appendix A Understanding the CDR Search Results
Table A-30 CDR Search Results (continued)
Field Calling No Calling Partition
Description The calling number specifies the directory number where the call originated. The calling partition specifies the partition associated with the calling party. The called number specifies the directory number from which the call was initially placed and is the same as the Dest No when the call is not transferred or forwarded. The called partition specifies the partition associated with the called party. The destination number specifies the directory number where the call finally terminated and is the same as the called number when the call is not transferred or forwarded. The destination number partition specifies the partition associated with the destination number. The last redirected number specifies the directory number from which the call was finally redirected. The last redirected number partition specifies the partition associated with the last redirected number.
Called No Called Partition
Dest No Dest No Partition
Last Rd. No Last Rd. No Partition
A-36
OL-10643-01
Appendix A
Understanding CAR Reports Understanding the CDR Search Results
Table A-30 CDR Search Results (continued)
Field Media Info Orig Pkts Rcd Dest Pkts Rcd Orig Pkts Lost Dest Pkts Lost
Description The packets received or lost for the origination or destination leg of a call and a link to the media information. See CDR and CMR Dump Tables, page A-38, for information about the CDR and CMR Dump tables. A link to the CDR and CMR dump tables. These tables identify the CDR and CMR table dumps as specified in the CallDetailRecord and CallDetailRecordDiagnostic tables in the CDR database. See CDR and CMR Dump Tables, page A-38, for information about the CDR and CMR Dump tables.
CDR - CMR Dump
Media Information
The media information table provides following information. See Table A-31.
Table A-31 CDR Media Information
Field Origination Leg Destination Leg Parameter
Description A unique identifier (within a cluster) for the originating leg of a call. A unique identifier (within a cluster) for the destination leg of a call. The media parameters: MediaTransportAdd_IP, PayLoadCapability, MediaCap_g723BitRate, packets sent, octets sent, packets received, octets received, packets lost, jitter, latency, and QoS.
A-37
Appendix A Understanding the CDR Search Results
Table A-31 CDR Media Information (continued)
Field Origination
Description The value for all the preceding parameters for the origination leg of the call. The value for all the preceding parameters for the destination leg of the call.
Destination
CDR and CMR Dump Tables

The CDR and CMR dump tables provide the following information. See Table A-32.
Table A-32 CDR and CMR Dump Tables
Field CDR Origination CMR
Description The call detail record fields. There are only a single set of fields for origination and destination in the database. The origination or destination CMR can be found using the leg IDs. If the leg IDs of the CMR match the Orig/Dest leg ID of the CDR, then the following record is Orig/Dest CMR. There are only a single set of fields for origination and destination in the database. The origination or destination CMR can be found using the leg IDs. If the leg IDs of the CMR match the Orig/Dest leg ID of the CDR, then the following record is Orig/Dest CMR.
Destination CMR
A-38
OL-10643-01
I N D EX
A
administrator granting rights, CAR system 16-2 revoking rights, CAR system 16-3 alarm configuration, described 2-1 Alarm definitions catalog descriptions 3-4 creating user-defined description procedure 3-3 described 3-1 searching and viewing procedure 3-2 searching for 3-2 user-defined, creating 3-3 viewing 3-2 Alarm Information, described 4-1 Alarms definitions catalogs 3-4 directing Syslog messages to a local server 27-3 directing Syslog messages to CiscoWorks2000 server 27-4 information, described 4-1 viewing information
text format 4-2 XML format 4-2 alarms applying configuration to all nodes 2-4 configuring, procedure 2-2 destinations 2-6 destination settings 2-6 event levels 2-7 event level settings 2-7 Event Viewer 2-6 SDI trace library 2-6 SDL trace library 2-6 Syslog 2-6 updating, procedure 2-2 alert actions configuration 12-63 alert notification configuration parameters for counter 12-64 parameters for directory servers 12-18 e-mail for counter 12-39 message 12-39 schedule 12-39 thresholds 12-39 alerts
IN-1
Index
enabling or disabling, by mail 17-14 authorization code name system report 19-27 authorization code name report 19-27 authorization level system report 19-28 authorization level report 19-28 automatic report generation 17-12
printing a report 24-9 saving master report 24-10 searching for data 24-11 starting and exiting 24-4 using 24-3 window 24-5
C
call data, line graph of (figure) 23-4
B
base rate 17-2 bill department 18-3 department detail, report results A-4 department summary, report results A-2 individual 18-2 individual detail, report results A-4 individual summary, report results A-2 Bulk Trace Analysis correlation tags 24-12 creating a report 24-6 creating a report with multiple views 24-12 customizing report table headings 24-16 displaying view information 24-15 downloading 24-1 installing 24-2 opening a report 24-8
call detail conference call detail, report results A-32 Call Detail Records (CDR) 26-2 call termination CDR search by 21-5 call termination details, viewing 21-7 call types QoS by 19-11 QoS report results by call types A-18 CAR assistant call usage configuration 18-16 automatic database purge configuration 16-29 automatic report generation/alert configuration 17-12 call termination details, viewing 21-7 CDR/CMR records configuration 22-1 CDR database alerts configuration 16-27 CDR error report 19-31 CDR error report configuration 19-31
IN-2
OL-10643-01
Index
CDR search 21-1 by call precedence levels 21-8 malicious calls 21-10 CDR search by cause for call termination configuration 21-5 CDR search by gateway configuration 21-3 CDR search by user extension configuration 21-2 CDR service parameters 15-4 Cisco IP manager/assistant, described 18-14 Cisco IP Phone services report configuration 18-19 conference bridge utilization report 20-20 conference call details configuration 20-18 configuration, gateway 16-8 CTI application user configuration 18-18 department bills configuration 18-3 device report, described 20-1 dial plan default values 16-7 disabling automatic database purge 16-30 error log report output 16-36 event log report output 16-36 event log report status 16-34 export CDR/CMR records results 22-2 gateway report 20-1, 20-10 generate report fields 19-9, 19-11, 19-16, 19-20 individual bills configuration 18-2 load CDR and CMR values 16-13 loading 15-5 logging off 15-8
logging on 15-7 log reports, described 16-35 Malicious Call Identification 19-23 manager call usage configuration 18-15 manual database purge 16-31 notification limits configuration 17-15 overview 15-1 precedence call summary 19-24 QoS by call types report 19-11 QoS by gateway report 19-8 QoS default values 17-11 QoS detail report call types 19-3 voice quality 19-4, 19-18 QoS detail report configuration 19-2 QoS parameter operators 19-32 QoS parameters call types 19-13 described 19-8 QoS reports, described 19-2 QoS summary report 19-5 call types 19-6 QoS summary report configuration 19-5 QoS values, defining 17-9 rating engine configuration 17-2 report configuration, described 17-1 reports, understanding A-1 restoring database purge defaults 16-32 restoring dial plan default values 16-6
IN-3
Index
searching for users 18-22 system configuration 16-1 system log screens, described 16-33 system overview report 19-30 system overview report configuration 19-30 system preferences parameters 16-11 system reports, described 19-1 top N, described 18-5 top N by charge call types 18-6 report types 18-7 top N by charge configuration 18-6 top N by duration call types 18-9 report types 18-10 top N by duration configuration 18-8 top N by number of calls call types 18-12 report types 18-13 top N by number of calls configuration 18-11 traffic reports described 19-15 traffic summary (extn), call types 19-21 traffic summary, call types 19-17 traffic summary by extensions report configuration 19-19 traffic summary report 19-15 traffic summary report configuration 19-15 uninhibited loading of CDR values 16-14 user reports, described 18-1
voice messaging utilization report 20-22 CDP accessing CDP driver control 28-2 advertisement support 28-1 Cisco device support 28-1 default settings 28-7 driver, usage 28-2 enabling CDP protocol driver 28-4 installing CDP protocol driver 28-3 list of topics 28-1 locating updated driver 28-6 periodic messages 28-1 protocol driver enabling 28-4 installing 28-3 settings 28-7 showing CDP protocol driver property 28-5 starting CDP protocol driver 28-3 updating IP address for CDP protocol driver 28-5 CDR automatic database purge configuration 16-29 CAR plugin, installing 15-2 CAR plugin, uninstalling 15-3 database alerts, configuration 16-27 disabling automatic database purge 16-30 disabling loading 16-15 dump table A-38 enabling loading 16-16
IN-4
OL-10643-01
Index
error, report results A-27 error report 19-31 load schedule configuration 16-12 logging setting up 26-2 restoring database purge defaults 16-32 restoring the default load schedule 16-15 search 21-1 search by cause for call termination 21-5 search by gateway 21-3 search by user extension 21-2 search by user extension, report results A-35 service parameters, configuring 15-4 setting up logging 26-2 values CDR load 16-13 CDR Analysis and Reporting Tool described 15-1 loading 15-5 logging off 15-8 logging on 15-7 CDR service parameters 15-4 CDR values uninhibited loading 16-14 chart counters configuring 12-38 Cisco Bulk Trace Analysis tool, described 24-1 Cisco CallManager, service 5-3
Cisco CDR Insert service 5-8 Cisco CTIManager service 5-12 Cisco Database Layer Monitor service 5-17,
5-23, 5-25
Cisco Discovery Protocol (CDP) 25-3 Cisco Discovery Protocol (CDP), described 28-1 Cisco IP manager/assistant 18-15, 18-16 assistant call usage 18-16 manager call usage 18-15 Cisco IP Phone services, report results A-14 Cisco IP Phone services report, configuration 18-19 Cisco IP Voice Media Streaming Application service 5-28 Cisco Messaging Interface service 5-31 Cisco MOH Audio Translator service 5-33 Cisco RIS Data Collector service 5-35 Cisco Secure Telnet applications 29-3 components relay server 29-2 Telnet client 29-2 Telnet server 29-2 executables 29-3 list of topics 29-1 proxy 29-4 terminate session 29-6 usage scenario 29-7 Cisco Telephony Call Dispatcher service 5-39 Cisco TFTP service 5-41
OL-10643-01
IN-5
Index
Cisco Unified CallManager, starting performance tool 23-1 CiscoWorks2000 list of topics 25-1 messages directed to server 27-4 remote network management features 25-2 SNMP requests 27-5 Syslog messages 27-4 CiscoWorks2000, defined 25-2 clearing alerts 12-60 client matter code system report 19-25 client matter code report 19-25 CMR dump table A-38 CMR values, CDR load 16-13 collecting traces 6-2 commands show.exe 30-1 show CDP neigh 28-2 show command list of topics 30-1 options 30-2 parameters 30-2 show tech 30-2 show win 30-2 tndconnect 29-4 conference bridge utilization, report results A-33 conference call detail, report results A-32 configuration profiles
creating, Real-Time Monitoring Tool 12-5 configuring 19-23, 21-8, 21-10 automatic database purge 16-29 CAR system 16-1 CDR database alerts 16-27 CDR load schedule 16-12 Cisco Extended Functions trace parameters 5-20 dial plan 16-5 gateway reports 20-1 mail server parameters in CAR 16-4 SDL trace parameters 5-50 serviceability reports archive 14-1 system log management 27-1 system preferences, CAR 16-10 Trace SDL parameters 5-50 configuring CDR service parameters 15-4 Control Center list of topics 11-1 start a service 11-5 status icons 11-2 stop a service 11-4 view status 11-3 Control Center, described 11-1 conventions xxiv correlation tags, Bulk Trace Analysis 24-12 counter alert configuration settings 12-64 counters alert notification parameters 12-64
IN-6
OL-10643-01
Index
chart view 12-38 configuring alert notification 12-39 data sample 12-45 data sample parameters 12-46 removing from monitoring window 12-47 table view 12-38 viewing data 12-46 zooming 12-43 creating a Bulk Trace Analysis report 24-6 creating a Bulk Trace Analysis report with multiple views 24-12 CTI application user enabled 18-18 report results A-13 CTI application user, report results A-13 CTI port, configuration 18-18 customizing, reports for automatic generation 17-13 customizing report table headings for Bulk Trace Analysis 24-16
disabling automatic purge 16-30 purge, CAR 16-31 restoring purge defaults 16-32 data sample configuring parameters 12-46 data sample, Real-Time Monitoring Tool 12-45 debug trace levels Cisco CallManager fields 5-4, 5-21 Cisco IP Voice Media Streaming Application fields 5-29 Database Layer Monitor fields 5-18, 5-24, 5-26 defined 5-46 RIS Data Collector fields 5-36 Telephony Call Dispatcher fields 5-40 TFTP fields 5-42, 5-45 Trace configuration filter settings 5-57 Trace configuration output settings 5-58 department bill detail 18-3 summary 18-3
D
daily charges, notification limits configuration 17-15 daily reports restoring default schedule 16-21 scheduling CAR reports 16-17 database automatic purge configuration 16-29
department bill detail, report results A-4 department bill summary, report results A-2 detail department bill 18-3 department bill, report results A-4 gateway 20-2 gateway, report results A-28 individual bill 18-2 individual bill, report results A-4
OL-10643-01
IN-7
Index
QoS, report results A-14 QoS report 19-2 details report 19-23 device name based trace monitoring 5-47 device reports 20-1 devices information window 12-26 monitoring phones 12-25 dial plan configuration 16-5 restoring default values 16-6 directory servers alert notification parameters 12-18 disabling alerts by mail 17-14 automatic CAR and CDR database purge 16-30 automatic database purge 16-30 CDR loading 16-15 disabling alerts 12-57 displaying view information for Bulk Trace Analysis 24-15 document audience xx conventions xxiv organization xx purpose xix documentation related xxiii
downloading Bulk Trace Analysis 24-1 driver CDP driver control 28-2 locating interface files 28-6 locating updated CDP driver 28-6 using 28-2 CDP protocol enabling 28-4 installing 28-3 showing property 28-5 starting 28-3 updating IP address 28-5 dump table, CDR and CMR A-38 duration 17-2
E
e-mail configuration 12-62 enabling alerts by mail 17-14 CDR loading 16-16 reports for automatic generation 17-13 enabling alerts 12-56 error CDR report 19-31 CDR report, results A-27 error log generating 16-34
IN-8
OL-10643-01
Index
understanding the details 16-37 understanding the output 16-36 error log report, output 16-36 event levels for alarms 2-7 event log generating 16-33 understanding the output 16-36 event log report output 16-36 status 16-34 exiting Bulk Trace Analysis 24-4 extension CDR search by 21-2 CDR search by, report results A-35
gateway detail, report results A-28 gateway detail report 20-2 gateway report, configuring 20-1 gateway summary, report results A-30 gateway summary report 20-5 gateway utilization, report results A-31 gateway utilization report 20-8 generate report fields 20-9, 20-12, 20-14, 20-17,
20-21, 20-23
generating error log 16-34 event log 16-33 granting administrator rights, CAR system 16-2
I F
features, remote network management 25-2 individual bill configuration 18-2 detail 18-2 summary 18-2
G
gateway CDR search by 21-3 configuration for CAR 16-8 QoS by 19-8 QoS report results by gateway A-17 gateway detail call types 20-3 voice quality 20-4
individual bill detail, report results A-4 individual bill summary, report results A-2 initial user ID and password 15-5 installing Bulk Trace Analysis 24-2 installing the CAR plugin 15-2 introduction, serviceability 1-1 IOS messages, from ISDN trace files 8-1 IP path analysis 25-2 IP Phone Problem Reports procedure 13-2
OL-10643-01
IN-9
Index
ISDN trace files, translating to IOS format 8-1
control of CDP driver 28-2 enable device discovery 28-2 Microsoft Performance tool 23-1 monitoring performance extending data display 23-3 line graph of static call data (figure) 23-4 monthly reports restoring default schedules 16-21 scheduling CAR reports 16-20
L
line graph of static call data (figure) 23-4 load disabling CDR 16-15 enabling CDR 16-16 restoring the default CDR schedule 16-15 loading CDR Analysis and Reporting Tool 15-5 load schedule CDR schedule configuration 16-12 log files, Trace 5-54 logging off CAR 15-8 logging on to CAR 15-7
N
nodes applying an alarm configuration to all nodes 2-4 notification limits 17-15 NT Event Viewer 2-6
M
mailing a report 18-20 mail server parameters 16-4 manual database purge, configuration 16-31 media information A-37 messages CDP 28-1 directing messages to syslog 27-3 syslog 27-2 message translator, using 8-1 MIB CISCO-CCM-MIB, Updating 31-11
O
opening a Bulk Trace Analysis report 24-8 organization xx overview automatic report generation 17-12 CAR 15-1 department bill reports 18-3 device reports 20-1 individual bill reports 18-2
IN-10
OL-10643-01
Index
system report 19-30
printing a Bulk Trace Analysis report 24-9 properties, counter 12-43 purge automatic database configuration 16-29 disabling automatic database 16-30 restoring database defaults 16-32 using manual database purge, CAR 16-31 purging CAR database manually 16-31
P
parameters factoring time of day for rating 17-4 factoring voice quality for rating 17-5 mail server configuration 16-4 restoring default values for call cost 17-7 setting the base rate and duration for rating 17-2 system configuration 16-1 password, initial use 15-5 path analysis configuration 26-1 described 26-1 PathTool 25-2 performance monitoring extending data display 23-3 line graph of static call data (figure) 23-4 removing a counter 12-47 tool, starting 23-1 viewing performance statistics 23-2 phones Real-Time Monitoring Tool 12-25 viewing information 12-25 plug-in software, Bulk Trace Analysis 24-1 preferences system configuration 16-10
Q
Q931 translator list of topics 8-1 message, using 8-1 procedure 8-1 QoS default values 17-11 notification limits configuration 17-15 restoring default values 17-10 QoS by call types, report results A-18 QoS by call types report 19-11 QoS by gateway, report results A-17 QoS by gateway report 19-8 QoS detail, report results A-14 QoS detail report call types 19-3 voice quality 19-4, 19-18 QoS parameter operators 19-32 QoS parameters, call types 19-13
IN-11
Index
QoS summary, report results A-16 QoS summary report call types 19-6 QoS values, defining 17-9 QRT viewer 13-1 QRT viewer 13-1 listing IP phone problem reports 13-2
counter data sample configuration parameters 12-46 counter properties 12-43 counters alert notify 12-39 chart view 12-38 data sample 12-45 display property description 12-44 properties 12-43 removing 12-47
R
rating engine, configuration 17-2 rating parameters factoring time of day 17-4 factoring voice quality 17-5 restoring default values for call cost 17-7 setting the base rate and duration 17-2 Real-Time Information Server (RIS) data collector 31-9 Real-Time Monitoring Tool adding a counter 12-36 alert central 12-49, 12-51, 12-54, 12-56, 12-57,
12-58, 12-60, 12-61, 12-62, 12-63, 12-64
table view 12-38 viewing data 12-46 zooming 12-43 CPU and memory monitoring 12-9 data samples 12-45 default configuration 12-4 directory servers alert configuration parameters 12-18 list of topics 12-1 loading 12-2 monitoring call activity 12-12 monitoring Cisco TFTP 12-16 monitoring critical services 12-11 monitoring CTI applications using search 12-30 monitoring CTI devices using CTI search 12-32 monitoring CTI lines 12-34 monitoring CTI manager 12-29 monitoring device information 12-20 monitoring devices by device search 12-21
alert notification configuring

12-39 chart view, configuring 12-38
for a counter
configuring alert notification for counter 12-39 counter alert configuration parameters 12-64
IN-12
OL-10643-01
Index
monitoring directory server information 12-17 monitoring disk usage 12-10 monitoring gateway activity 12-13 monitoring heartbeat 12-19 monitoring SDL queue 12-15 monitoring trunk activity 12-14 removing a counter 12-47 table view, configuring 12-38 understanding alert central 12-48 understanding perfmon monitoring 12-36 using CTI search 12-30 using device search 12-21 viewing call process category 12-12 viewing CTI category 12-28 viewing data 12-46 viewing phone information 12-25 viewing server category 12-9 viewing summary 12-7 viewing the device category 12-20 viewing the service category 12-16 window components 12-6 zooming a counter 12-43 related documentation xxiii remote network management, features 25-2 removing alerts 12-54 report authorization code name 19-27 authorization level 19-28 CAR system report configuration 19-1
CDR error 19-31 CDR search 21-1 CDR search by cause for call termination 21-5 CDR search by gateway 21-3 CDR search by user extension 21-2 Cisco IP manager/assistant 18-15, 18-16 client matter code 19-25 CTI application user enabled 18-18 department bill 18-3 device 20-1 for Bulk Trace Analysis 24-3 gateway detail report 20-2 gateway summary 20-5 gateway utilization 20-8 individual bill 18-2 mailing 18-20 precedence call summary 19-24 QoS by call types report 19-11 QoS by gateway report 19-8 QoS detail 19-2 route and line group utilization 20-11 route list utilization 20-13 route pattern/hunt pilot utilization 20-16 system overview 19-30 top N by charge 18-6 top N by duration 18-8 top N by number of calls 18-11 traffic summary 19-15 traffic summary by extensions 19-19
IN-13
Index
voice-mail utilization 20-22 report configuration, CAR 17-1 report results CDR error A-27 CDR search by user extension A-35 Cisco IP Phone services A-14 conference bridge utilization A-33 conference call detail A-32 CTI application user A-13 department bill, detail A-4 department bill, summary A-2 gateway detail A-28 gateway summary A-30 gateway utilization A-31 individual bill, detail A-4 individual bill, summary A-2 QoS by gateway A-17 QoS detail A-14 QoS report by call types A-18 QoS summary A-16 route group utilization A-31 route list utilization A-31 route pattern utilization A-31 system overview A-25 top N by charge A-6 top N by duration A-6 top N by number of calls A-8 traffic summary A-20 traffic summary by extensions A-20
voice mail utilization A-34 Reports understanding CAR reports A-1 reports automatic generation configuration 17-12 automatic report generation/alert 17-12 customizing for automatic generation 17-13 enabling for automatic generation 17-13 gateway report configuration 20-1 restoring default schedules 16-21 route plan 20-10 scheduling daily, CAR 16-17 scheduling monthly, CAR 16-20 scheduling weekly, CAR 16-18 system overview results A-25 user 18-1 restoring CAR and CDR database purge defaults 16-32 default CDR load schedule 16-15 default QoS values 17-10 default schedule for daily, weekly, and monthly reports 16-21 default values for rating parameters 17-7 revoking administrator rights, CAR system 16-3 rights granting administrator, CAR system 16-2 revoking administrator, CAR system 16-3 RIS data collector 31-9 route
IN-14
OL-10643-01
Index
group utilization, report results A-31 list utilization, report results A-31 pattern utilization, report results A-31 route and line group utilization report 20-11 route list utilization report 20-13 route pattern/hunt pilot utilization report 20-16 route plan report, configuring 20-10
CDR by gateway 21-3 CDR by user extension 21-2 CDR by user extension, report results A-35 CDRs 21-1 searching for data in a Bulk Trace Analysis report 24-11 searching for users, CAR 18-22 server, mail parameters 16-4 serviceability
S
saving the Bulk Trace Analysis master report 24-10 schedule CDR load configuration 16-12 restoring the default CDR load 16-15 scheduling CAR daily reports 16-17 monthly CAR reports 16-20 weekly CAR reports 16-18 SDI log file, saving to IOS format 8-1 SDL configuration characteristics Cisco CallManager service 5-52 Cisco CTIManager service 5-52 filter settings Cisco CallManager service 5-50 Cisco CTIManager 5-51 procedure 5-50 search CDR by cause for call termination 21-5
introduction 1-1 Serviceability Reports Archive configuration 14-1 Service Activation activate services 10-2 deactivate services 10-4 delete services 10-10 list of topics 10-1 service considerations 10-5 services status icons 11-2 SESSIONTIMEOUT 16-11 setting alert properties 12-51 show CDP neigh command 28-2 show command list of topics 30-1 options 30-2 parameters 30-2 syntax 30-1 SNMP agent, enabling 27-5
IN-15
Index
Cisco Unified CallManager traps configuring 31-5 list of topics 31-1 RIS data collector 31-9 SNMP agent configuring SNMP security 31-2 setting SNMP trap receiver 31-3 SNMP extension agent starting 31-4 stopping 31-8 SNMP RIS data collector starting 31-9 stopping 31-10 support 25-3 starting Bulk Trace Analysis 24-4 summary department bill 18-3 department bill, report results A-2 gateway 20-5 gateway, report results A-30 individual bill 18-2 individual bill, report results A-2 QoS, report results A-16 traffic 19-15 traffic, report results A-20 traffic by extensions 19-19 traffic by extensions, report results A-20 suspending alerts 12-58 syntax
show command 30-1 tndconnect 29-4 Syslog analyzer 25-2 collector 25-2 syslog analysis, components (figure) 27-2 directing messages 27-2 directing messages to CiscoWorks2000 server 27-4 directing messages to local server 27-3 system logging, components (figure) 27-2 system log management configuration 27-1 described 27-1 system log screens CAR 16-33 system overview, report results A-25 system overview report 19-30 system parameters, configuration 16-1 system preferences configuration 16-10 system preferences parameters for CAR 16-11
T
table, CDR and CMR dump A-38 Telnet 29-1 connect with daemon 29-6 plan for Windows 29-7
IN-16
OL-10643-01
Index
terminate session 29-6 Telnet, Cisco Secure applications 29-3 components relay server 29-2 Telnet client 29-2 Telnet server 29-2 executables 29-3 list of topics 29-1 proxy 29-4 terminate session 29-6 usage scenario 29-7 time of day 17-4 tndconnect connect with Telnet daemon 29-6 display all options 29-5 program structure 29-5 syntax 29-4 terminate session 29-4 top N by charge 18-6 by charge, report results A-6 by duration 18-8 by duration, report results A-6 by number of calls 18-11 by number of calls, report results A-8 top N by charge 18-6 call types 18-6 report types 18-7
top N by charge, report results A-6 top N by duration 18-8 call types 18-9 configuration 18-8 report types 18-10 top N by duration, report results A-6 top N by number of calls 18-11 call types 18-12 configuration 18-11 report types 18-13 top N by number of calls, report results A-8 Trace analysis list of topics 7-1 SDI trace 7-2 SDL trace 7-5 analysis configuration, described 7-1 Cisco CallManager service configuring 5-3 SDL configuration characteristics 5-52 SDL configuration filter settings 5-50 trace fields 5-4, 5-21 Cisco CDR Insert service 5-8 Cisco Certificate Authority Proxy Function service configuring 5-10 Cisco CTIManager service configuring 5-12 SDL configuration characteristics 5-52 SDL configuration filter settings 5-51
OL-10643-01
IN-17
Index
Cisco CTL provider service configuring 5-15 Cisco Database Layer Monitor service configuring 5-17 trace fields 5-18, 5-24, 5-26 Cisco Extended Functions service configuring 5-20 Cisco Extension Mobility service configuring 5-23 Cisco IP Manager Assistant service configuring 5-25 Cisco IP Voice Media Streaming Application service configuring 5-28 trace fields 5-29 Cisco Messaging Interface service 5-31 Cisco MOH Audio Translator service 5-33 Cisco RIS Data Collector service configuring 5-35 trace fields 5-36 Cisco Telephony Call Dispatcher service configuring 5-39 trace fields 5-40 Cisco TFTP service configuring 5-41 trace fields 5-42 Cisco WebDialer service configuring 5-44 trace fields 5-45 collection
list of topics 6-1 collection configuration, described 6-1 configuration described 5-1 filter settings 5-57 list of topics 5-1 output settings 5-58 debug trace levels 5-46 device name based trace monitoring 5-47 log files field descriptions 5-56 viewing 5-54 Q931 translator 8-1 SDI trace analysis 7-2 SDL trace analysis 7-5 Trace Collection Tool collecting traces 6-5 loading 6-2 traffic summary 19-15 traffic summary (extn), call types 19-21 traffic summary, call types 19-17 traffic summary, report results A-20 traffic summary by extensions, report results A-20 traffic summary by extensions report 19-19 Troubleshooting Trace Setting configuration 9-1 resetting 9-2
IN-18
OL-10643-01
Index
setting 9-1
viewing and sorting alerts 12-49 viewing event details 12-61 voice mail utilization, report results A-34 voice-mail utilization report 20-22 voice quality 17-5
U
uninhibited loading of CDR values 16-14 uninstalling the CAR plugin 15-3 user-defined alarm descriptions 3-3 user ID, initial use 15-5 user reports, described 18-1 using Bulk Trace Analysis 24-3 utilization conference bridge, report results A-33 gateway 20-8 gateway, report results A-31 route and line group 20-11 route group, report results A-31 route list 20-13 route list, report results A-31 route pattern/hunt pilot 20-16 voice-mail 20-22 voice mail, report results A-34
W
weekly reports restoring default schedule 16-21 scheduling CAR reports 16-18
X
XML trace files, Q931 translator 8-1 using with Bulk Trace Analysis 24-1 XML format, viewing alarms 4-2
Z
zooming a counter 12-43
V
viewing export CDR/CMR record results 22-2 Viewing alarm information text format 4-2 XML format 4-2
IN-19
Index
IN-20
OL-10643-01

Cucm Trace Documentation

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

Cucm Trace Documentation

Uploaded by

Copyright:

Available Formats

Cisco Unified CallManager Serviceability Administration Guide

Cisco CallManager Serviceability

Cisco Unified CallManager Serviceability Administration Guide OL-10643-01

Alarms Configuration and View Definitions

Cisco Unified CallManager Serviceability Administration Guide OL-10643-01

Q.931 Translator 8-1 Using the Message Translator 8-1

Monitoring Tools Configuration

Cisco Unified CallManager Serviceability Administration Guide

QRT Viewer 13-1 Listing IP Phone Problem Reports 13-2

Cisco Unified CallManager Serviceability Administration Guide

Serviceability Reports Archive Configuration 14-1 Reporting Tools Configuration

Cisco Unified CallManager Serviceability Administration Guide OL-10643-01

Cisco Unified CallManager Serviceability Administration Guide

Cisco Unified CallManager Serviceability Administration Guide OL-10643-01

Cisco Unified CallManager Serviceability Administration Guide

Other Monitoring Tools

Cisco Unified CallManager Serviceability Administration Guide

Remote Serviceability Tools

Cisco Unified CallManager Serviceability Administration Guide

Cisco Unified CallManager Serviceability Administration Guide OL-10643-01

Cisco Unified CallManager Serviceability Administration Guide

Cisco Unified CallManager Serviceability Administration Guide OL-10643-01

Cisco Unified CallManager Serviceability Administration Guide

Cisco Unified CallManager Serviceability Administration Guide OL-10643-01

Cisco Unified CallManager Serviceability Administration Guide

Preface Related Documentation

Cisco Unified CallManager Serviceability Administration Guide OL-10643-01

Cisco Unified CallManager Serviceability Administration Guide

Preface Obtaining Documentation

Notes use the following conventions:

Cisco Unified CallManager Serviceability Administration Guide OL-10643-01

Preface Obtaining Documentation

Product Documentation DVD

Preface Documentation Feedback

Cisco Product Security Overview

Cisco Unified CallManager Serviceability Administration Guide OL-10643-01

Preface Cisco Product Security Overview

Reporting Security Problems in Cisco Products

Nonemergencies psirt@cisco.com 1 877 228-7302 1 408 525-6532

In an emergency, you can also reach PSIRT by telephone:

Cisco Unified CallManager Serviceability Administration Guide

Preface Obtaining Technical Assistance

Obtaining Technical Assistance

Cisco Technical Support & Documentation Website

Cisco Unified CallManager Serviceability Administration Guide OL-10643-01

Preface Obtaining Technical Assistance

Submitting a Service Request

Cisco Unified CallManager Serviceability Administration Guide

Preface Obtaining Additional Publications and Information

Definitions of Service Request Severity

Obtaining Additional Publications and Information

Cisco Unified CallManager Serviceability Administration Guide OL-10643-01

Preface Obtaining Additional Publications and Information

Cisco Unified CallManager Serviceability Administration Guide

Cisco CallManager Serviceability

Cisco Unified CallManager Serviceability

Cisco Unified CallManager Serviceability Administration Guide OL-10643-01

Chapter 1 Cisco Unified CallManager Serviceability

Cisco Unified CallManager Serviceability Administration Guide

Introduction Cisco Unified CallManager Serviceability

Cisco Unified CallManager CDR Analysis and Reporting

Cisco Unified CallManager Serviceability Administration Guide OL-10643-01

Using Hypertext Transfer Protocol over Secure Sockets Layer (HTTPS)