Cisco Unified IP Phone 8961, 9951, and 9971 Administration Guide for Cisco Unified Communications Manager 8.6 (SIP)
Customizing the Cisco Unified IP Phone
Downloads: This chapterpdf (PDF - 247.0KB) The complete bookPDF (PDF - 15.26MB) | 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

Ringlist.xml File Format Requirements

PCM File Requirements for Custom Ring Types

Configuring a Custom Phone Ring

Creating Custom Background Images

List.xml File Format Requirements

PNG File Requirements for Custom Background Images

Configuring a Custom Background Image

Configuring Wideband Codec

Configuring the Idle Display

Automatically Disabling the Cisco Unified IP Phone Display

Enabling EnergyWise on the Cisco Unified IP Phone

Enabling and Disabling SSH


Customizing the Cisco Unified IP Phone


This chapter explains how you customize configuration files, phone ring sounds, and background images, and how to disable the phone screen to conserve power.

This chapter includes these topics:

Customizing and Modifying Configuration Files

Creating Custom Phone Rings

Creating Custom Background Images

Configuring Wideband Codec

Configuring the Idle Display

Automatically Disabling the Cisco Unified IP Phone Display

Enabling EnergyWise on the Cisco Unified IP Phone

Enabling and Disabling SSH

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. See 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 Ringlist.xml and List.xml files from the system using the following admin command-line interface (CLI) "file" commands (for exact syntax, see 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 Ringlist.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 TFTP" chapter in Cisco Unified Communications Manager System Guide and the "Software Upgrades" chapter in Cisco Unified Communications Operating System Administration Guide.

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

Ringlist.xml File Format Requirements

PCM File Requirements for Custom Ring Types

Configuring a Custom Phone Ring

Ringlist.xml File Format Requirements

The Ringlist.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 appears 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 displays 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 Ringlist.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 package that supports 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.

Step 2 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 "Software Upgrades" chapter in Cisco Unified Communications Operating System Administration Guide.

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

Step 4 Save your modifications and close the Ringlist.xml file.

Step 5 To cache the new Ringlist.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).


Creating Custom Background Images

You can provide users with a choice of background images (or wallpaper) for the LCD screen on their phones. Users can select a background image by choosing Applications  > Preferences > Wallpaper on the phone.

The image choices that users see come from PNG images and an XML file (called List.xml) that are stored on the TFTP server used by the phone. By storing your own PNG files and editing the XML file on the TFTP server, you can designate the background images from which users can choose. In this way, you can provide custom images, such as your company logo.

The following sections describe how you can customize the background images that are available at your site by creating your own PNG files and editing the List.xml file:

List.xml File Format Requirements.

PNG File Requirements for Custom Background Images.

Configuring a Custom Background Image

List.xml File Format Requirements

The List.xml file defines an XML object that contains a list of background images. The List.xml file is stored in the following subdirectory on the TFTP server:

Desktops/640x480x24


Tip If you are manually creating the directory structure and the List.xml file, you must ensure that the directories and files can be accessed by the user\CCMService, which is used by the TFTP service.


For more information, see the "Software Upgrades" chapter in Cisco Unified Communications Operating System Administration Guide.

The List.xml file can include up to 50 background images. The images are in the order that they appear in the Background Images menu on the phone. For each image, the List.xml file contains one element type, called ImageItem. The ImageItem element includes these two attributes:

Image—Uniform resource identifier (URI) that specifies where the phone obtains the thumbnail image that appears on the Background Images menu on a phone.

URL—URI that specifies where the phone obtains the full size image.

The following example shows a List.xml file that defines two images. The required Image and URL attributes must be included for each image. The TFTP URI that is shown in the example is the only supported method for linking to full size and thumbnail images. HTTP URL support is not provided.

List.xml Example

<CiscoIPPhoneImageList>
<ImageItem Image="TFTP:Desktops/640x480x24/TN-Fountain.png" 
URL="TFTP:Desktops/640x480x24/Fountain.png"/> 
<ImageItem Image="TFTP:Desktops/640x480x24/TN-FullMoon.png" 
URL="TFTP:Desktops/640x480x24/FullMoon.png"/> 
</CiscoIPPhoneImageList>
 
   

The Cisco Unified IP Phone firmware includes a default background image. This image is not defined in the List.xml file. The default image is always the first image that appears in the Background Images menu on the phone.

PNG File Requirements for Custom Background Images

Each background image requires two PNG files:

Full size image—Version that appears on the on the phone.

Thumbnail image—Version that displays on the Background Images screen from which users can select an image. Must be 25% of the size of the full size image.


Tip Many graphics programs provide a feature that resizes a graphic. An easy way to create a thumbnail image is to first create and save the full size image, then use the sizing feature in the graphics program to create a version of that image that is 25% of the original size. Save the thumbnail version by using a different name.


The PNG files for background images must meet the following requirements for proper display on the Cisco Unified IP Phone:

Full size image—640 pixels (width) X 480 pixels (height).

Thumbnail image—123 pixels (width) X 111 pixels (height).


Tip If you are using a graphics program that supports a posterize feature for grayscale, set the number of tonal levels per channel to 16, and the image posterizes to 16 shades of grayscale.


Configuring a Custom Background Image

To create custom background images for the Cisco Unified IP Phone, follow these steps:

Procedure


Step 1 Create two PNG files for each image (a full size version and a thumbnail version). Ensure the PNG files comply with the format guidelines that are listed in the "PNG File Requirements for Custom Background Images" section.

Step 2 Upload the new PNG files that you created to the following subdirectory in the TFTP server for the Cisco Unified Communications Manager:

Desktops/640x480x24


Note The file name and subdirectory parameters are case sensitive. Be sure to use the forward slash "/" when you specify the subdirectory path.


To upload the files, choose Software Upgrades > Upload TFTP Server File in Cisco Unified Communications Operating System Administration. For more information, see the "Software Upgrades" chapter in Cisco Unified Communications Operating System Administration Guide.


Note If the folder does not exist, the folder gets created and the files get uploaded to the folder.


Step 3 You must also copy the customized images and files to the other TFTP servers that the phone may contact to obtain these files.


Note Cisco recommends that you also store backup copies of custom image files in another location. You can use these backup copies if the customized files are overwritten when you upgrade Cisco Unified Communications Manager.


Step 4 Use a text editor to edit the List.xml file. See the "List.xml File Format Requirements" section for the location of this file, formatting requirements, and a sample file.

Step 5 Save your modifications and close the List.xml file.


Note When you upgrade Cisco Unified Communications Manager, a default List.xml file replaces your customized List.xml file. After you customize the List.xml file, make a copy of the file and store it in another location. After upgrading Cisco Unified Communications Manager, replace the default List.xml file with your stored copy.


Step 6 To cache the new List.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 Wideband Codec

If Cisco Unified Communications Manager is configured to use G.722 (G.722 is enabled by default for the Cisco Unified IP Phone 8961, 9951, and 9971) and if the far endpoint supports G.722, the call connects by using the G.722 codec in place of G.711. This situation occurs regardless of whether the user has enabled a wideband headset or wideband handset, but if either the headset or handset is enabled, the user may notice greater audio sensitivity during the call. Greater sensitivity means improved audio clarity but also means that more background noise can be heard by the far endpoint—noise such as rustling papers or nearby conversations. Even without a wideband headset or handset, some users may prefer the additional sensitivity of G.722. Other users may be distracted by the additional sensitivity of G.722.

Two parameters in Cisco Unified Communications Manager Administration affect whether wideband is supported for this Cisco Unified Communications Manager server or a specific phone:

Advertise G.722 Codec—From Cisco Unified Communications Manager Administration, choose System > Enterprise Parameters. The default value of this enterprise parameter is True, which means that all Cisco Unified IP Phone Models 9971 that are registered to this Cisco Unified Communications Manager advertises G.722 to Cisco Unified Communications Manager. If each endpoint in the attempted call supports G.722 in the capabilities set, Cisco Unified Communications Manager chooses that codec for the call when possible.

Advertise G.722 Codec—From Cisco Unified Communications Manager Administration, choose Device > Phone. The default value of this product-specific parameter is to use the value specified in the enterprise parameter. If you want to override this on a per-phone basis, choose Enabled or Disabled in the Advertise G.722 Codec parameter on the Product Specific Configuration area of the Phone Configuration window.

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 screen. The idle display is an XML service that the phone invokes when the phone is idle (not in use) for a designated period and no feature menu is open.

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

http://www.cisco.com/warp/public/788/AVVID/idle-url.html

In addition, you can see 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 Settings > Device Configuration and scroll to the Idle URL and the Idle URL Time parameters.

Automatically Disabling the Cisco Unified IP Phone Display

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

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

To turn on the display any time it is off, press the Select button.

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

Table 9-1 explains the Cisco Unified Communications Manager Administration fields that control when the display 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 9-1 Display On and Off Configuration Fields 

Field
Description

Days Display Not Active

Days that the display does not turn on automatically at the time specified in the Display 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.

Display On Time

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

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

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

If this field is blank, the display automatically turns on at 0:00.

The default value is 07:30.

Display On Duration

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

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

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

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

Note If Display On Time is 0:00 and the display on duration is blank (or 24:00), the display remains on continuously.

The default value is 10:30.

Display Idle Timeout

Length of time that the phone is idle before the display turns off. Applies only when the display was powered off as scheduled and was turned on by an end-user (by pressing the Select button on the phone).

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

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

The default value is 1:00.


Enabling EnergyWise on the Cisco Unified IP Phone

To reduce power consumption, you can configure the phone to sleep (power down) and wake (power up) if your system includes an EnergyWise controller.

You configure settings in Cisco Unified Communications Manager Administration to enable EnergyWise and configure sleep and wake times. These parameters are closely tied to the phone display configuration parameters.

When EnergyWise is enabled and a sleep time is set, the phone sends a request to the switch to wake it up at the configured time. The switch sends back either an acceptance or a rejection of the request. If the switch rejects the request or if the switch does not reply, the phone does not power down. If the switch accepts the request, the idle phone goes to sleep, reducing the power consumption to a predetermined level. A phone that is not idle sets an idle timer, and goes to sleep after the timer expires.

The user can wake up the phone by pressing the Select key. At the scheduled wake time, the system restores power to the phone, waking it up.

Table 9-2 explains the Cisco Unified Communications Manager Administration fields that control the EnergyWise settings. You configure these fields in Cisco Unified Communications Manager Administration in the Product Specific configuration window, by choosing Device > Phone.

Table 9-2 EnergyWise Configuration Fields 

Field
Description

Enable Power Save Plus

Selects the schedule of days for which the phone powers off. Select multiple days by pressing and holding the Control key while clicking on the days for the schedule.

By default, no days are selected.

When Enable Power Save is checked, you receive a message to warn about emergency (e911) concerns.


Caution While Power Save Plus Mode (the "Mode") is in effect, endpoints configured for the mode are disabled for emergency calling and from receiving inbound calls. By selecting this mode, you agree to the following: (i) You are taking full responsibility for providing alternate methods for emergency calling and receiving calls while the mode is in effect; (ii) Cisco has no liability in connection with your selection of the mode and all liability in connection with enabling the mode is your responsibility; and (iii) you fully inform users of the effects of the mode on calls, calling and otherwise.

Note To disable Power Save Plus, you must uncheck the Allow EnergyWise Overrides check box. Leaving the Allow EnergyWise Overrides checked with no days selected in the Enable Power Save Plus field does not disable Power Save Plus.

Phone On Time

Determines when the phone automatically turns on for the days selected in the Enable Power Save Plus field.

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

For example, to automatically power up the phone at 7:00 a.m. (0700), enter 7:00. To power up the phone at 2:00 p.m. (1400), enter 14:00.

The default value is blank, which means 00:00.

Note The Phone On Time must be at least 20 minutes later than the Phone Off Time. For example, if the Phone Off Time is 7:00, the Phone On Time must be no earlier than 7:20.

Phone Off Time

The time of day that the phone powers down for the days selected in the Enable Power Save Plus field. If the Phone On Time and the Phone Off Time fields contain the same value, the phone does not power down.

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

For example, to automatically power down the phone at 7:00 a.m. (0700), enter 7:00. To power down the phone at 2:00 p.m. (1400), enter 14:00.

The default value is blank, which means 00:00.

Note The Phone On Time must be at least 20 minutes later than the Phone Off Time. For example, if the Phone Off Time is 7:00, the Phone On Time must be no earlier than 7:20.

Phone Off Idle Timeout

The length of time that the phone must be idle before the phone powers down.

The timeout occurs under the following conditions:

When the phone was in Power Save Plus mode, as scheduled, and was taken out of Power Save Plus mode because the phone user pressed the Select key.

When the phone is repowered by the attached switch

When the Phone Off Time is reached but the phone is in use.

The range of the field is 20 to 1440 minutes.

The default value is 60 minutes.

Enable Audible Alert

When enabled, instructs the phone to play an audible alert starting at 10 minutes before to the time specified in the Phone Off Time field.

The audible alert uses the phone's ringtone, which briefly plays at specific times during the 10-minute alerting period. The alerting ringtone plays at the user's designated volume level. The audible alert schedule is:

At 10 minutes before power down, play the ringtone four times

At 7 minutes before power down, play the ringtone four times

At 4 minutes before power down, play the ringtone four times

At 30 seconds before power down, play the ringtone 15 times or until the phone powers off

This check box applies only if the Enable Power Save Plus list box has one or more days selected.

EnergyWise Domain

The EnergyWise domain that the phone is in.

The maximum length of this field is 127 characters.

EnergyWise Secret

The security secret password that is used to communicate with the endpoints in the Energywise domain.

The maximum length of this field is 127 characters.

Allow EnergyWise Overrides

This check box determines whether you allow the EnergyWise domain controller policy to send power level updates to the phones. The following conditions apply:

1. One or more days must be selected in the Enable Power Save Plus field.

2. The settings in Cisco Unified Communications Manager Administration take effect on schedule even if EnergyWise sends an override.

For example, assume the Phone Off Time is set to 22:00 (10:00 p.m.), the value in the Phone On Time field is 06:00 (6:00 a.m.), and the Enable Power Save Plus has one or more days selected.

If EnergyWise directs the phone to turn off at 20:00 (8:00 p.m.), that directive remains in effect (assuming no phone user intervention occurs) until the configured Phone On Time at 6:00 a.m.

At 6:00 a.m., the phone turns on and resumes receiving the power level changes from the settings in Unified CM Administration.

To change the power level on the phone again, EnergyWise must reissue a new power level change command.

Note To disable Power Save Plus, you must uncheck the Allow EnergyWise Overrides check box. Leaving the Allow EnergyWise Overrides checked with no days selected in the Enable Power Save Plus field does not disable Power Save Plus.


Enabling and Disabling SSH

You can enable or disable to access the SSH daemon through port 22. Leaving port 22 open leaves the phone vulnerable to Denial of Service (DoS) attacks. By default, the SSH daemon is disabled.


Note Phones that are upgraded from Firmware Release 9.2.0 or earlier to Firmware Release 9.2.1 or later have the SSH Access parameter set to Disabled by default. You must enable the SSH Access parameter before users of these phones can use SSH.


Use the following table to enable or disable SSH from the Cisco Unified Communications Manager, Device > Device Settings > Common Phone Profile or Device > Phone windows.

Table 9-3 SSH Enable Field

Field
Description

SSH Access

Select Enabled to allow access to the SSH Daemon.

Select Disabled to disallow access to the SSH Daemon.

The default is Disabled.