Cisco Unified IP Phone 6921, 6941, 6945, and 6961 Administration Guide for Cisco Unified CM 8.6 (SCCP and SIP)
Customizing the Cisco Unified IP Phone
Downloads: This chapterpdf (PDF - 174.0KB) The complete bookPDF (PDF - 7.0MB) | Feedback

Customizing the Cisco Unified IP Phone

Table Of Contents

Customizing the Cisco Unified IP Phone

Customizing and Modifying Configuration Files

Creating Custom Phone Rings

DistinctiveRingList File Format Requirements

PCM File Requirements for Custom Ring Types

Configuring a Custom Phone Ring

Configuring the Idle Display

Automatically Disabling the Cisco Unified IP Phone Backlight


Customizing the Cisco Unified IP Phone


This chapter explains how you customize configuration files and phone ring sounds, and how to disable the phone screen to conserve power. Ring sounds play when the phone receives a call.

This chapter includes these topics:

Customizing and Modifying Configuration Files

Creating Custom Phone Rings

Configuring the Idle Display

Automatically Disabling the Cisco Unified IP Phone Backlight

Customizing and Modifying Configuration Files

You can modify configuration files (for example, edit the xml files) and add customized files (for example, custom ring tones, call back tones) to the TFTP directory. You can modify files and add customized files to the TFTP directory in Cisco Unified Communications Operating System Administration, from the TFTP Server File Upload window. Refer to Cisco Unified Communications Operating System Administration Guide for information about how to upload files to the TFTP folder on a Cisco Unified Communications Manager server.

You can obtain a copy of the DistinctiveRinglist.xml and List.xml files from the system using the following admin command-line interface (CLI) "file" commands (for exact syntax, refer to the Command Line Interface Reference Guide for Cisco Unified Communications Solutions):

admin:file

file list

file view

file search

file get

file dump

file tail

file delete

Creating Custom Phone Rings

The Cisco Unified IP Phone ships with two default ring types that are implemented in hardware: Chirp1 and Chirp2. Cisco Unified Communications Manager also provides a default set of additional phone ring sounds that are implemented in software as pulse code modulation (PCM) files. The PCM files, along with an XML file (named DistinctiveRinglist.xml) that describes the ring list options that are available at your site, exist in the TFTP directory on each Cisco Unified Communications Manager server.

For more information, see the Cisco Unified Communications Manager System Guide, Cisco TFTP, and the Cisco Unified Communications Operating System Administration Guide, Software Upgrades.

The following sections describe how you can customize the phone rings that are available at your site by creating PCM files and editing the DistinctiveRinglist.xml file:

DistinctiveRingList File Format Requirements

PCM File Requirements for Custom Ring Types

Configuring a Custom Phone Ring

DistinctiveRingList File Format Requirements

The DistinctiveRingList.xml file defines an XML object that contains a list of phone ring types. This file can include up to 50 ring types. Each ring type contains a pointer to the PCM file that is used for that ring type and the text that will appear on the Ring Type menu on a Cisco Unified IP Phone for that ring. The Cisco TFTP server for each Cisco Unified Communications Manager contains this file.

The CiscoIPPhoneRinglist XML object uses the following simple tag set to describe the information:

<CiscoIPPhoneRingList>
   <Ring>
      <DisplayName/>
      <FileName/>
   </Ring>
</CiscoIPPhoneRingList>
 
   

The following characteristics apply to the definition names. You must include the required DisplayName and FileName for each phone ring type.

DisplayName defines the name of the custom ring for the associated PCM file that will display on the Ring Type menu of the Cisco Unified IP Phone.

FileName specifies the name of the PCM file for the custom ring to associate with DisplayName.


Note The DisplayName and FileName fields must not exceed 25 characters.


This example shows a DistinctiveRinglist.xml file that defines two phone ring types:

<CiscoIPPhoneRingList>
   <Ring>
      <DisplayName>Analog Synth 1</DisplayName>
      <FileName>Analog1.raw</FileName>
   </Ring>
   <Ring>
      <DisplayName>Analog Synth 2</DisplayName>
      <FileName>Analog2.raw</FileName>
   </Ring>
</CiscoIPPhoneRingList>

PCM File Requirements for Custom Ring Types

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

Raw PCM (no header)

8000 samples per second

8 bits per sample

uLaw compression

Maximum ring size—16080 samples

Minimum ring size—240 samples

Number of samples in the ring is evenly divisible by 240.

Ring starts and ends at the zero crossing.

To create PCM files for custom phone rings, you can use any standard audio editing packages that support these file format requirements.

Configuring a Custom Phone Ring

To create custom phone rings for the Cisco Unified IP Phone, follow these steps:

Procedure


Step 1 Create a PCM file for each custom ring (one ring per file). Ensure the PCM files comply with the format guidelines that are listed in the "PCM File Requirements for Custom Ring Types" section.

Upload the new PCM files that you created to the Cisco TFTP server for each Cisco Unified Communications Manager in your cluster. For more information, see the Cisco Unified Communications Operating System Administration Guide, Software Upgrades.

Step 2 Use an text editor to edit the DistinctiveRinglist.xml file. See the "DistinctiveRingList File Format Requirements" section for information about how to format this file and for a sample DistinctiveRinglist.xml file.

Step 3 Save your modifications and close the DistinctiveRinglist.xml file.

Step 4 To cache the new DistinctiveRinglist.xml file, stop and start the TFTP service by using Cisco Unified Serviceability or disable and re-enable the "Enable Caching of Constant and Bin Files at Startup" TFTP service parameter (located in the Advanced Service Parameters).


Configuring the Idle Display

You can specify an idle display (text only; text-file size should not exceed 1M bytes) that appears on the phone LCD screen. The idle display is an XML service that the phone invokes when the phone has been idle (not in use) for a designated period and no feature menu is open.

For detailed instructions about creating and displaying the idle display, refer to Creating Idle URL Graphics on Cisco Unified IP Phone at this URL:

http://www.cisco.com/en/US/products/sw/voicesw/ps556/products_tech_note09186a00801c0764.shtml

In addition, you can refer to Cisco Unified Communications Manager Administration Guide or to Cisco Unified Communications Manager Bulk Administration Guide for the following information:

Specifying the URL of the idle display XML service:

For a single phone—Idle field on the Cisco Unified Communications Manager Phone Configuration window

For multiple phones simultaneously—URL Idle field on the Cisco Unified Communications Manager Enterprise Parameters configuration window, or the Idle field in the Bulk Administration Tool (BAT)

Specifying the length of time that the phone is not used before the idle display XML service is invoked:

For a single phone—Idle Timer field on the Cisco Unified Communications Manager Phone Configuration window

For multiple phones simultaneously—URL Idle Time field on the Cisco Unified Communications Manager Enterprise Parameters configuration window, or the Idle Timer field in the Bulk Administration Tool (BAT)

From a phone, you can see settings for the idle display XML service URL and the length of time that the phone is not used before this service is invoked. To see these settings, choose Administrator Settings > Device Configuration and scroll to the Idle URL and the Idle URL Time parameters.

Automatically Disabling the Cisco Unified IP Phone Backlight

To conserve power and ensure the longevity of the phone screen backlight, you can set the backlight to turn off when it is not needed.

You can configure settings in Cisco Unified Communications Manager Administration to turn off the backlight at a designated time on some days and all day on other days. For example, you may choose to turn off the backlight after business hours on weekdays and all day on Saturdays and Sundays.

You can take any of these actions to turn on the backlight any time it is off:

Press any button on the phone.

The phone takes the action designated by that button in addition to turning on the backlight.

Lift the handset.

When you turn the backlight on, it remains on until the phone has remained idle for a designated length of time, then it turns off automatically.

Table 6-1 explains the Cisco Unified Communications Manager Administration fields that control when the backlight turns on and off. You configure these fields in Cisco Unified Communications Manager Administration in the Product Specific configuration window. (You access this window by choosing Device > Phone from Cisco Unified Communications Manager Administration.)

Table 6-1 Backlight On and Off Configuration Fields 

Field
Description

Days Backlight Not Active

Days that the backlight does not turn on automatically at the time specified in the Backlight On Time field.

Choose the day or days from the drop-down list. To choose more than one day, Ctrl-click each day that you want.

Backlight On Time

Time each day that the backlight turns on automatically (except on the days specified in the Days Backlight Not Active field).

Enter the time in this field in 24 hour format, where 0:00 is midnight.

For example, to automatically turn the backlight on at 7:00 a.m., (0700), enter 7:00. To turn the backlight on at 2:00 p.m. (1400), enter 14:00.

If this field is blank, the backlight will automatically turn on at 0:00.

Backlight On Duration

Length of time that the backlight remains on after turning on at the time specified in the backlight On Time field.

Enter the value in this field in the format hours:minutes.

For example, to keep the backlight on for 4 hours and 30 minutes after it turns on automatically, enter 4:30.

If this field is blank, the phone will turn off at the end of the day (0:00).

Note If Backlight On Time is 0:00 and the backlight on duration is blank (or 24:00), the backlight will remain on continuously.

Backlight Idle Timeout

Length of time that the phone is idle before the backlight turns off. Applies only when the backlight was off as scheduled and was turned on by an end-user (by pressing a button on the phone or lifting the handset).

Enter the value in this field in the format hours:minutes.

For example, to turn the backlight off when the phone is idle for 1 hour and 30 minutes after an end-user turns the backlight on, enter 1:30.

The default value is 0:30.