Cisco Unified IP Phone 7931G Administration Guide for Cisco Unified Communications Manager 9.0 (SCCP and SIP)
Cisco Unified IP Phone Customization
Downloads: This chapterpdf (PDF - 1.27MB) The complete bookPDF (PDF - 5.23MB) | The complete bookePub (ePub - 715.0KB) | Feedback

Cisco Unified IP Phone Customization

Cisco Unified IP Phone Customization

Phone Customization Overview

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

Configuration File Customization and Modification

You can modify configuration files and add customized files to the TFTP directory. You can modify files or add customized files to the TFTP directory in Cisco Unified Communications Operating System Administration, from the TFTP Server File Upload window. For information about how to upload files to the TFTP folder on a Cisco Unified Communications Manager server, see the Cisco Unified Communications Manager System Guide.

You can obtain a copy of the Ringlist.xml or Ringlist-wb.xml files and the List.xml file from the system using the following admin command-line interface (CLI) "file" commands:

  • admin:file
    • file list
    • file view
    • file search
    • file get
    • file dump
    • file tail
    • file delete

For more information, see the Cisco Intercompany Media Engine Command Line Interface Reference Guide.

Custom Phone Ring Creation

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 server on each Cisco Unified Communications Manager server.

For more information, see the "Custom Phone Rings" chapter in the Cisco Unified Communications Manager Features and Services Guide and the "Software Upgrades" chapter in the 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

The Ringlist.xml file defines an XML object that contains a list of phone ring types. This file includes 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 specifies 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 in length.


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
  • 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.
    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 a text editor to edit the Ringlist.xml file. See Ringlist.xml File Format Requirements 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 reenable the "Enable Caching of Constant and Bin Files at Startup" TFTP service parameter (that is found in the Advanced Service Parameters area.)

    Wideband Codec Setup

    By default, the G.722 codec is enabled for the Cisco Unified IP Phone 7931G. If Cisco Unified Communications Manager has been configured to use G.722 and if the far endpoint supports G.722, the call can connect using the G.722 codec in place of G.711. In this case, 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, some users may prefer the additional sensitivity of G.722. Other users may be distracted by the additional sensitivity of G.722. The Cisco Unified IP Phone 7931G does not support a wideband handset.

    The following parameters in Cisco Unified Communications Manager Administration affect whether wideband is supported for this Cisco Unified Communications Manager server and 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 Phones that are registered to this Cisco Unified Communications Manager advertise G.722 to Cisco Unified Communications Manager. For more information, see the Cisco Unified Communications Manager System Guide, "Cisco Unified IP Phones" chapter.
    • Advertise G.722 Codec: From Cisco Unified Communications Manager Administration, choose Device > Phone. The default value for this product-specific parameter is the value that is 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.

    Idle Display Setup

    You can specify an idle display that appears on the phone screen. The idle display is an XML service that the phone invokes when the phone 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. Format an image for display on the phone.
    2. Configure Cisco Unified Communications Manager to display the image on the phone.

    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 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 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 page, 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 page, 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, if the phone is registered with Cisco Unified Communications Manager, press the Application Menu button, then choose Settings > User Preferences > Audio Preferences and scroll to the Idle URL and the Idle URL Time parameters. By default, the Application Menu button is line button 24 (the top left line button).]

    Cisco Unified IP Phone Backlight

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

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

    You can take any of these actions to turn on the backlight any time it is off:

    • Press any button on the phone. The phone will take the action designated by that button and turn on the backlight.
    • Lift the handset.

    When you turn the backlight 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 backlight turns on and off. You configure these fields in Cisco Unified Communications Manager Administration in the Product Specific Configuration page. You access this page by choosing Device > Phone from Cisco Unified Communications Manager Administration.

    You can view the backlight settings for a phone from the Power Save Configuration menu on the phone. For more information, see Power Save Configuration Menu.

    Table 1 Backlight On and Off Configuration Fields

    Field

    Description

    Days Backlight Not Active

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

    Backlight On Time

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

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

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

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

    Backlight On Duration

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

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

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

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

    Note   

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

    Backlight Idle Timeout

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

    The default value is 0:30.