Cisco Unified IP Phone 6921, 6941, 6945, and 6961 Administration Guide for Cisco Unified Communications Manager 10.0 (SCCP and SIP)
Cisco Unified IP Phone Customization
Downloads: This chapterpdf (PDF - 1.27MB) The complete bookPDF (PDF - 5.67MB) | The complete bookePub (ePub - 1.44MB) | Feedback

Cisco Unified IP Phone Customization

Cisco Unified IP Phone Customization

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

Attention:

All file names are case sensitive. If you use ringlist.xml for the file name, the phone will not apply your changes.

For more information, see the "Cisco TFTP" chapter in Cisco Unified Communications Manager System Guide and the "Software Upgrades" chapter in Cisco Unified Communications Operating System Administration Guide.

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

    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 23:59), 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.

    EnergyWise on the Cisco Unified IP Phone Setup

    To reduce power consumption, configure the phone to sleep (power down) and wake (power up) if your system includes an EnergyWise controller.

    You configure settings in Cisco Unified Communications Manager Administration to enable EnergyWise and configure sleep and wake times. These parameters are closely tied to the phone display configuration parameters.

    When EnergyWise is enabled and a sleep time is set, the phone sends a request to the switch to wake it up at the configured time. The switch returns either an acceptance or a rejection of the request. If the switch rejects the request or if the switch does not reply, the phone does not power down. If the switch accepts the request, the idle phone goes to sleep, thus reducing the power consumption to a predetermined level. A phone that is not idle sets an idle timer and goes to sleep after the timer expires.

    To wake up the phone press Select. At the scheduled wake time, the system restores power to the phone, waking it up.

    The following table explains the Cisco Unified Communications Manager Administration fields that control the EnergyWise settings. You configure these fields in Cisco Unified Communications Manager Administration in the Product Specific Configuration area of the Phone Configuration window Device > Phone.

    Table 2 EnergyWise Configuration Fields

    Field

    Description

    Enable Power Save Plus

    Selects the schedule of days for which the phone powers off. Select multiple days by pressing and holding the Control key while clicking on the days for the schedule.

    By default, no days are selected.

    When Enable Power Save Plus is checked, you receive a message that warns about emergency (e911) concerns.

    Caution   

    While Power Save Plus Mode (the "Mode") is in effect, endpoints that are configured for the mode are disabled for emergency calling and from receiving inbound calls. By selecting this mode, you agree to the following: (i) You take full responsibility for providing alternate methods for emergency calling and receiving calls while the mode is in effect; (ii) Cisco has no liability in connection with your selection of the mode and all liability in connection with enabling the mode is your responsibility; and (iii) You fully inform users of the effects of the mode on calls, calling and otherwise.

    Note   

    To disable Power Save Plus, you must uncheck the Allow EnergyWise Overrides check box. Leaving the Allow EnergyWise Overrides checked with no days selected in the Enable Power Save Plus field does not disable Power Save Plus.

    Phone On Time

    Determines when the phone automatically turns on for the days that are in the Enable Power Save Plus field.

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

    For example, to automatically power up the phone at 7:00 a.m. (0700), enter 7:00. To power up the phone at 2:00 p.m. (1400), enter 14:00.

    The default value is blank, which means 00:00.

    Note   

    The Phone On Time must be at least 20 minutes later than the Phone Off Time. For example, if the Phone Off Time is 7:00, the Phone On Time must be no earlier than 7:20.

    Phone Off Time

    The time of day that the phone powers down for the days that are selected in the Enable Power Save Plus field. If the Phone On Time and the Phone Off Time fields contain the same value, the phone does not power down.

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

    For example, to automatically power down the phone at 7:00 a.m. (0700), enter 7:00. To power down the phone at 2:00 p.m. (1400), enter 14:00.

    The default value is blank, which means 00:00.

    Note   

    The Phone On Time must be at least 20 minutes later than the Phone Off Time. For example, if the Phone Off Time is 7:00, the Phone On Time must be no earlier than 7:20.

    Phone Off Idle Timeout

    The length of time that the phone must be idle before the phone powers down.

    The timeout occurs under the following conditions:

    • When the phone was in Power Save Plus mode, as scheduled, and was taken out of Power Save Plus mode because the phone user pressed the Select key.
    • When the phone is repowered by the attached switch.
    • When the Phone Off Time is reached but the phone is in use.

    The range of the field is 20 to 1440 minutes.

    The default value is 60 minutes.

    Enable Audible Alert

    When enabled, instructs the phone to play an audible alert starting 10 minutes before the time that the Phone Off Time field specifies.

    The audible alert uses the phone ringtone, which briefly plays at specific times during the 10-minute alerting period. The alerting ringtone plays at the user-designated volume level. The audible alert schedule is:

    • At 10 minutes before power down, play the ringtone four times.
    • At 7 minutes before power down, play the ringtone four times.
    • At 4 minutes before power down, play the ringtone four times.
    • At 30 seconds before power down, play the ringtone 15 times or until the phone powers off.

    This check box applies only if the Enable Power Save Plus list box has one or more days selected.

    EnergyWise Domain

    The EnergyWise domain that the phone is in.

    The maximum length of this field is 127 characters.

    EnergyWise Secret

    The security secret password that is used to communicate with the endpoints in the EnergyWise domain.

    The maximum length of this field is 127 characters.

    Allow EnergyWise Overrides

    This check box determines whether you allow the EnergyWise domain controller policy to send power level updates to the phones. The following conditions apply:

    1. One or more days must be selected in the Enable Power Save Plus field.
    2. The settings in Cisco Unified Communications Manager Administration take effect on schedule even if EnergyWise sends an override.

    For example, assuming the Phone Off Time is set to 22:00 (10:00 p.m.), the value in the Phone On Time field is 06:00 (6:00 a.m.), and the Enable Power Save Plus has one or more days selected.

    • If EnergyWise directs the phone to turn off at 20:00 (8:00 p.m.), that directive remains in effect (assuming no phone user intervention occurs) until the configured Phone On Time at 6:00 a.m.
    • At 6:00 a.m., the phone turns on and resumes receiving the power level changes from the settings in Unified Communications Manager Administration.
    • To change the power level on the phone again, EnergyWise must reissue a new power level change command.
    Note   

    To disable Power Save Plus, you must uncheck the Allow EnergyWise Overrides check box checked. Leaving the Allow EnergyWise Overrides checked with no days selected in the Enable Power Save Plus field does not disable Power Save Plus.