Cisco IP Communicator Administration Guide (1.1)
Customizing Cisco IP Communicator
Downloads: This chapterpdf (PDF - 212.0KB) The complete bookPDF (PDF - 2.44MB) | Feedback

Customizing Cisco IP Communicator

Table Of Contents

Customizing Cisco IP Communicator

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 Background Image

Configuring the Idle Display


Customizing Cisco IP Communicator


This chapter explains how to customize phone ring sounds, background images, and the idle display at your site. Ring sounds play when Cisco IP Communicator receives a call. Background images appear on the phone screen. The idle display appears on the phone screen when the Cisco IP Communicator has not been used for a designated period.

This chapter includes these topics:

Creating Custom Phone Rings

Creating Custom Background Images

Configuring the Idle Display

Creating Custom Phone Rings

Cisco IP Communicator software provides two default ring types: 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 ring types that are available at your site by creating your own 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. Each ring type contains a pointer to the PCM file that is used for that ring type and the text that will appear in the Ring Type menu of Cisco IP Communicator 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 in the Ring Type menu of Cisco IP Communicator.

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.


The following 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>

Related Topics

PCM File Requirements for Custom Ring Types

Configuring a Custom Phone Ring

PCM File Requirements for Custom Ring Types

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

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.

Related Topics

RingList.xml File Format Requirements

Configuring a Custom Phone Ring

Configuring a Custom Phone Ring

To create custom phone rings, 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).


Related Topics

RingList.xml File Format Requirements

PCM File Requirements for Custom Ring Types

Creating Custom Background Images

You can provided users with a choice of background images for their Cisco IP Communicator phone screens. Users can select the background image that appears on the phone screen by choosing Settings > User Preferences > Background Images.

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. This file is stored in the following folder on the TFTP server:

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


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


The List.xml file can include up to 50 background images. The images are presented in the order that they appear in the Background Images menu on the phone.

For each background 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 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/320x212x12/TN-Fountain.png" 
URL="TFTP:Desktops/320x212x12/Fountain.png"/>
<ImageItem Image="TFTP:Desktops/320x212x12/TN-FullMoon.png" 
URL="TFTP:Desktops/320x212x12/FullMoon.png"/>
</CiscoIPPhoneImageList>

Cisco IP Communicator software includes a default background image. This image is not defined in the List.xml file. Cisco IP Communicator displays the default image if you do not create custom images or if there is an error retrieving a custom image. The default image is always the first image that appears in the Background Images menu.

Related Topics.

PNG File Requirements for Custom Background Images.

Configuring a Background Image

PNG File Requirements for Custom Background Images

Each background image requires two PNG files:

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

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 Cisco IP Communicator:

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

Thumbnail image—80 pixels (width) X 53 pixels (height).

Color palette—Includes up to 12-bit color (4096 colors). You can use more than 12-bit color, but Cisco IP Communicator will reduce the color palette to12-bit before displaying the image. For best results, reduce the color palette of an image to 12-bit when you create a PNG file.


Tip If you are using a graphics program that supports a posterize feature for specifying the number of tonal levels per color channel, set the number of tonal levels per channel to 16 (16 red X 16 green X 16 blue = 4096 colors).


Related Topics.

List.xml File Format Requirements.

Configuring a Background Image

Configuring a Background Image

To create custom background images, 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\320x212x12


Tip Cisco recommends that you also store backup copies of custom image files in another location. You can use these backup copies if the files in 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 the custom List.xml file that you customized. After you 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.



Related Topics.

List.xml File Format Requirements.

PNG File Requirements for Custom Background Images

Configuring the Idle Display

You can specify an idle display that appears on the phone screen. The idle display is an XML service that Cisco IP Communicator invokes when it has been idle (not in use) for a designated period and no feature menu is open.

XML services that can be used as idle displays include company logos, product pictures, and stock quotes.

Configuring the idle display consists of these general steps.

1. Formatting an image.

2. Configuring Cisco CallManager to display the image.

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

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

In addition, you can refer to Cisco CallManager Administration Guide or to Bulk Administration Tool User Guide for Cisco CallManager for the following information:

Specifying the URL of the idle display XML service:

For a single phone device—Idle field on the Cisco CallManager Phone Configuration page

For multiple devices simultaneously—URL Idle field on the Cisco CallManager Enterprise Parameters Configuration page, or the Idle field in the Bulk Administration Tool (BAT)

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

For a single device—Idle Timer field on the Cisco CallManager Phone Configuration page

For multiple devices simultaneously—URL Idle Time field on the Cisco CallManager Enterprise Parameters Configuration page, or the Idle Timer field in the Bulk Administration Tool (BAT)

From the Cisco IP Communicator interface, you can see settings for the idle display XML service URL and the length of time Cisco IP Communicator must be inactive 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.

Related Topics.

Creating Custom Phone Rings.

Creating Custom Background Images