Cisco IP Phone 7961G/7961G-GE and 7941G/7941G-GE Administration Guide for Cisco CallManager 4.1(3) - Customizing the Cisco IP Phone [Cisco Unified IP Phones 7900 Series]

Table Of Contents

Customizing the Cisco IP Phone

Creating Custom Phone Rings

RingList.xml File Format Requirements

PCM File Requirements for Custom Ring Types

Configuring a Custom Phone Ring

Creating Background Images

List.xml File Format Requirements

PNG File Requirements for Custom Background Images

Configuring a Background Image

Customizing the Cisco IP Phone

This chapter explains how you customize phone ring sounds and background images at your site. Ring sounds play when the phone receives a call. Background images appear on the phone's LCD screen.

This chapter includes these topics:

•Creating Custom Phone Rings

•Creating Background Images

Creating Custom Phone Rings

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

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 will appear on the Ring Type menu on a Cisco IP Phone for that ring. The C:\ Program Files\Cisco\TFTPPath directory of the Cisco TFTP server for each Cisco CallManager 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 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 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 IP Phone 7961G/7961G-GE and 7941G/7941G-GE, 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 Place the new PCM files that you created in the C:\Program Files\Cisco\ TFTPPath directory on the Cisco TFTP server for each Cisco CallManager in your cluster.

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 CallManager 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 Background Images

You can provide users with a choice of background images for the LCD screen on their phones. Users can select a background image by choosing Settings > User Preferences > Background Images 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 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 folder on the TFTP server:

C:\Program Files\Cisco\TFTPPath\Desktops\320x196x4

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.

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 will appear 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/320x196x4/TN-Fountain.png" 
URL="TFTP:Desktops/320x196x4/Fountain.png"/> 
<ImageItem Image="TFTP:Desktops/320x196x4/TN-FullMoon.png" 
URL="TFTP:Desktops/320x196x4/FullMoon.png"/> 
</CiscoIPPhoneImageList>
The Cisco 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 appears 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 will resize 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 using a different name.

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

•Full size image—320 pixels (width) X 196 pixels (height).

•Thumbnail image—80 pixels (width) X 49 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 will posterize to 16 shades of grayscale.

Configuring a Background Image

To create custom background images for the Cisco 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 Place the new PNG files that you created in the following folder on the TFTP server for each Cisco CallManager in the cluster:

C:\Program Files\Cisco\TFTPPath\Desktops\320x196x4

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 CallManager.

Step 3 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 4 Save your modifications and close the List.xml file.

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

	Cisco IP Phone 7961G/7961G-GE and 7941G/7941G-GE Administration Guide for Cisco CallManager 4.1(3)
	Customizing the Cisco IP Phone
Cisco IP Phone 7961G/7961G-GE and 7941G/7941G-GE Administration Guide for Cisco CallManager 4.1(3) Cisco IP Phone Administration Guide for Cisco CallManager, Models 7961G, 7961G-GE, 7941G, 7941G-GE Preface An Overview of the Cisco IP Phone Preparing to Install the Cisco IP Phone on Your Network Setting Up the Cisco IP Phone Configuring Settings on the Cisco IP Phone Configuring Features, Templates, Services, and Users Customizing the Cisco IP Phone Viewing Security Information, Model Information, Status, and Statistics on the Cisco IP Phone Monitoring the Cisco IP Phone Remotely Troubleshooting and Maintenance Providing Information to Users Via a Website Supporting International Users Technical Specifications	Download this chapter Customizing the Cisco IP Phone Table Of Contents Customizing the Cisco IP Phone Creating Custom Phone Rings RingList.xml File Format Requirements PCM File Requirements for Custom Ring Types Configuring a Custom Phone Ring Creating Background Images List.xml File Format Requirements PNG File Requirements for Custom Background Images Configuring a Background Image Customizing the Cisco IP Phone This chapter explains how you customize phone ring sounds and background images at your site. Ring sounds play when the phone receives a call. Background images appear on the phone's LCD screen. This chapter includes these topics: •Creating Custom Phone Rings •Creating Background Images Creating Custom Phone Rings The Cisco IP Phone ships with two default ring types that are implemented in hardware: Chirp1 and Chirp2. Cisco CallManager also provides a default set of additional phone ring sounds that are implemented in software as pulse code modulation (PCM) files. The PCM files, along with an XML file (named RingList.xml) that describes the ring list options that are available at your site, exist in the TFTP directory on each Cisco CallManager server. 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 will appear on the Ring Type menu on a Cisco IP Phone for that ring. The C:\ Program Files\Cisco\TFTPPath directory of the Cisco TFTP server for each Cisco CallManager 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 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 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 IP Phone 7961G/7961G-GE and 7941G/7941G-GE, 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 Place the new PCM files that you created in the C:\Program Files\Cisco\ TFTPPath directory on the Cisco TFTP server for each Cisco CallManager in your cluster. 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 CallManager 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 Background Images You can provide users with a choice of background images for the LCD screen on their phones. Users can select a background image by choosing Settings > User Preferences > Background Images 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 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 folder on the TFTP server: C:\Program Files\Cisco\TFTPPath\Desktops\320x196x4 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. 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 will appear 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/320x196x4/TN-Fountain.png" URL="TFTP:Desktops/320x196x4/Fountain.png"/> <ImageItem Image="TFTP:Desktops/320x196x4/TN-FullMoon.png" URL="TFTP:Desktops/320x196x4/FullMoon.png"/> </CiscoIPPhoneImageList> The Cisco 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 appears 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 will resize 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 using a different name. The PNG files for background images must meet the following requirements for proper display on the Cisco IP Phone: •Full size image—320 pixels (width) X 196 pixels (height). •Thumbnail image—80 pixels (width) X 49 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 will posterize to 16 shades of grayscale. Configuring a Background Image To create custom background images for the Cisco 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 Place the new PNG files that you created in the following folder on the TFTP server for each Cisco CallManager in the cluster: C:\Program Files\Cisco\TFTPPath\Desktops\320x196x4 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 CallManager. Step 3 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 4 Save your modifications and close the List.xml file. Note When you upgrade Cisco CallManager, a default List.xml file will replace your customized List.xml file. After your customize the List.xml file, make a copy of the file and store it in another location. After upgrading Cisco CallManager, replace the default List.xml file with your stored copy.
	© 1992-2008 Cisco Systems, Inc. All rights reserved. Terms & Conditions \| Privacy Statement \| Cookie Policy \| Trademarks of Cisco Systems, Inc.