Cisco Unified IP Phone 8941 and 8945 Administration Guide for Cisco Unified Communications Manager 9.0 (SCCP and SIP)
Cisco Unified IP Phone Customization
Downloads: This chapterpdf (PDF - 1.18MB) The complete bookPDF (PDF - 4.42MB) | The complete bookePub (ePub - 731.0KB) | Feedback

Cisco Unified IP Phone Customization

Cisco Unified IP Phone Customization

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:

Customization and Modification of Configuration Files

You can modify configuration files (for example, edit the xml files) and add customized files (for example, custom ring tones and, 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. For information on how to upload files to the TFTP folder on a Cisco Unified Communications Manager server, see Cisco Unified Communications Operating System Administration Guide.

You can obtain a copy of the Ringlist.xml and List.xml files from the system by using the following administration command line interface (CLI) file commands. For exact syntax, see 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

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" chapter, and the Cisco Unified Communications Operating System Administration Guide, "Software Upgrades" chapter.

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

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>
<Ring>
<DisplayName>Are You There 1</DisplayName>
<FileName>AreYouThere.raw</FileName>
</Ring>
<Ring>
<DisplayName>Are You There 2</DisplayName>
<FileName>AreYouThereF.raw</FileName>
</Ring>
<Ring>
<DisplayName>Bass</DisplayName>
<FileName>Bass.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
  • Mu-law compression
  • Maximum ring size = 16080 samples
  • Minimum ring size = 240 samples
  • Number of samples in the ring = multiple of 240.
  • Ring start and end at zero crossing.

To create PCM files for custom phone rings, use any standard audio editing package that supports these file format requirements.

Set up custom phone ring

To create custom phone rings for the Cisco Unified IP Phone, perform 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 PCM File Requirements for Custom Ring Types.

    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" chapter.

    Step 2   Use a text editor to edit the DistinctiveRinglist.xml file. See the DistinctiveRingList File Format Requirements 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 reenable the "Enable Caching of Constant and Bin Files at Startup" TFTP service parameter (located in the Advanced Service Parameters).

    Idle Display Setup

    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/​en/​US/​products/​sw/​voicesw/​ps556/​products_​tech_​note09186a00801c0764.shtml

    In addition, see the Cisco Unified Communications Manager Administration Guide or the 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 in the Phone Configuration window in Cisco Unified Communications Manager Administration.
      • For multiple phones simultaneously: URL Idle field in the 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 in the Phone configuration window in Cisco Unified Communications Manager Administration.
      • For multiple phones simultaneously: URL Idle Time field in the 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.

    Cisco Unified IP Phone Display Automatic Disable

    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.

    You can take any of these actions to turn on the display 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 display.
    • Lift the handset.

    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.

    The following table 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 1 Backlight 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 will automatically turn on at 0:00.

    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 will turn 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 will remain on continuously.

    Display Idle Timeout

    Length of time that the phone is idle before the display turns off. Applies only when the display was off as scheduled and was turned on by a 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 display off when the phone is idle for 1 hour and 30 minutes after a user turns the display on, enter 1:30.

    The default value is 0:30.

    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 or JPG images and an XML file (called List.xml) that are stored on the TFTP server used by the phone. By storing your own image 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.

    To allow user access to the background image setting, you must enable the access using Cisco Unified CM Administration. If you disable user access, the wallpaper menu is not available to the user. In this case, you can specify a wallpaper for the phone in either the common phone profile or phone configuration settings.

    The following sections describe how you can customize the background images that are available at your site by creating your own image 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 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. The List.xml file does not define this image. The default image is always the first image that appears in the Background Images menu on the phone.

    File Requirements for Custom Background Images

    Each background image requires two files:

    Full-size image

    Version that appears on the on the phone.

    Thumbnail image

    Version that is displayed on the Background Images screen from which users can select an image. Must be 25% of the size of the full-size image.


    Note


    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, and 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 background image files 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)


    Note


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


    Set Up Custom Background Image

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

    Procedure
      Step 1   Create two files for each image (a full-size version and a thumbnail version).

      Ensure the image files comply with the format guidelines that are listed in the File Requirements for Custom Background Images.

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

      Desktops/640x480x24

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

      Step 3   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.

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

      Step 4   Copy the customized images and files to the other TFTP servers that the phone may contact to obtain these files

      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 5   Use a text editor to edit the List.xml file.

      See List.xml File Format Requirements for the location of this file, formatting requirements, and a sample file.

      Step 6   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 7   To cache the new List.xml file, stop and start the TFTP service by using Cisco Unified Serviceability or disable and reenable the Enable Caching of Constant and Bin Files at Startup TFTP service parameter (located in the Advanced Service Parameters).