Guest

Cisco Unified Communications Manager (CallManager)

Unified Communications Manager 6.x: Create a Customized Background Image for Cisco IP Phone

Cisco - Unified Communications Manager 6.x: Create a Customized Background Image for IP Phone

Document ID: 112041

Updated: Apr 08, 2011

   Print

Introduction

This document describes the procedure to create a customized background image for a Cisco IP phone in the Cisco Unified Communications Manager environment.

Note: You can find the video for changing the background image for an IP phone at Video: IP Phone Background Image Change leavingcisco.com.

Prerequisites

Requirements

Cisco recommends that you have knowledge of Cisco Unified Communications Manager 6.x and later.

Components Used

The information in this document is based on the Cisco Unified Communications Manager 6.x and later.

The information in this document was created from the devices in a specific lab environment. All of the devices used in this document started with a cleared (default) configuration. If your network is live, make sure that you understand the potential impact of any command.

Conventions

Refer to Cisco Technical Tips Conventions for more information on document conventions.

Configure

Complete these steps in order to set the customized background image for a Cisco IP phone through Cisco Unified Communications Manager.

  1. Create the Image Files

  2. Edit the List.xml File

  3. Upload the Image Files

  4. Restart Cisco Unified Communications Manager TFTP service

Note: Complete all these steps if your cluster has more than one Cisco Unified Communications Manager.

Create the Image Files

Create two .PNG files for each image, a full size version and a thumbnail version.

Refer to this table to set the size and directory location based on Cisco IP phone models.

Phone Model Pixel range for full size image Pixel range for thumbnail size image Directory location
7906 / 7911 95x34 23x8 /Desktops/95x34x1
7941 / 7961 320x196 80x49 /Desktops/320x196x4
7942 / 7962 320x196 80x49 /Desktops/320x196x4
7945 / 7965 320x212 80x53 /Desktops/320x212x16
7970 / 7971 320x212 80x53 /Desktops/320x212x12
7975 320x216 80x53 /Desktops/320x216x16

Edit the List.xml File

Use a text editor to edit the existing List.xml file from the respective subdirectory location based on the IP phone model, or you can create a new List.xml file in the subdirectory location based on the IP phone model. Refer to Customizing and Modifying Configuration Files for more information.

Refer to the table for the correct file save location.

Complete these steps:

  1. You can create the List.xml file with this sample script:

    <CiscoIPPhoneImageList>
    		  <ImageItem Image="TFTP:Desktops/320x212x12/TN-Fountain.png"
    		  URL="TFTP:Desktops/320x212x12/Fountain.png"/>
        </CiscoIPPhoneImageList>

    Note: Make sure that the file name is entered correctly here. If it is not correct, you will receive the File not found error when you select the customized background in phone user preferences.

  2. In this script, you need to change the file name to the name of the background images. The first one is the thumbnail image, and the second one is the full size image.

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

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

  3. Save this file as List.xml.

Upload the Image File

You need to upload all the three files, two image files and the List.xml file, to the TFTP subdirectory location. Complete these steps:

  1. Open the Cisco Unified OS Administration page.

  2. Choose Software Upgrades > TFTP file Management > Upload File.

  3. Click Browse, and then select your background image PNG files and List.xml file.

    background-01.gif

  4. Specify the Directory path based on your Cisco IP phone model defined in the table in the Create the Image Files section.

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

Restart Cisco Unified Communications Manager TFTP Service

Complete these steps:

  1. Open the Cisco Unified Serviceability page.

  2. Choose Tools > Control Center – Feature Services.

  3. Scroll down to the CM services, select the Cisco Tftp option, then scroll down and click the Restart button.

Creating Custom 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.

These 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

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

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.

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

This next 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.

<CiscoIPPhoneImageList>

<ImageItem Image="TFTP:Desktops/320x212x16/TN-Fountain.png" 
URL="TFTP:Desktops/320x212x16/Fountain.png"/> 

<ImageItem Image="TFTP:Desktops/320x212x16/TN-FullMoon.png" 
URL="TFTP:Desktops/320x212x16/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 phone.

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

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

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

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

Configuring a Custom Background Image

Complete these steps in order to create custom background images for the Cisco Unified IP Phone:

  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.

  2. In order to upload the files, login to the Cisco Unified Communications Operating System Administration web page.

    background-02.gif

  3. Choose Software Upgrades > TFTP File Management.

    background-03.gif

  4. Click Upload file. A window, as shown below, pops up. You need to click Browse, then select your background image from the PNG files (for thumbnail and full size image) and List.xml file one by one.

    background-04.gif

  5. Upload the new PNG files that you created and the List.xml to this subdirectory in the TFTP server for the Cisco Unified Communications Manager: /Desktops/320x212x16

  6. In order to cache the new List.xml file, stop and start the TFTP service by using Cisco Unified Communications Manager Serviceability. From the Cisco Unified Serviceability page, navigate to Tools > Control Center - Feature Services.

    background-05.gif

  7. Stop and start the TFTP service.

    background-06.gif

Note: Now you can an select the uploaded background image and change it by choosing Settings > User Preferences > Background Images on the IP phone.

Related Information

Updated: Apr 08, 2011
Document ID: 112041