Cisco Unified CallManager Administration Guide, Release 5.1(3)
Cisco Unified IP Phone Services Configuration
Downloads: This chapterpdf (PDF - 214.0KB) The complete bookPDF (PDF - 6.61MB) | Feedback

Cisco Unified IP Phone Services Configuration

Table Of Contents

Cisco Unified IP Phone Services Configuration

Finding a Cisco Unified IP Phone Service

Configuring a Cisco Unified IP Phone Service

Cisco Unified IP Phone Service Configuration Settings

Deleting a Cisco Unified IP Phone Service

Configuring a Cisco Unified IP Phone Service Parameter

Cisco Unified IP Phone Service Parameter Settings

Deleting a Cisco Unified IP Phone Service Parameter

Adding a Cisco Unified IP Phone Service to a Phone Button

Related Topics


Cisco Unified IP Phone Services Configuration


Using Cisco Unified CallManager Administration, you define and maintain the list of Cisco Unified IP Phone Services to which users can subscribe at their site. Cisco Unified IP Phone Services comprise XML applications that enable the display of interactive content with text and graphics on Cisco Unified IP Phones 7970, 7960, 7940, 7912, and 7905.


Note Cisco Unified IP Phones 7912 and 7905 only support text-based XML applications.


Cisco Unified CallManager provides sample Cisco Unified IP Phone Services applications. You can also create customized Cisco Unified IP Phone applications for your site.

After you configure the list of services, you can add services to the phones in the database and assign them to phone buttons. In Cisco Unified CallManager Administration, you can view and modify settings for phones and device profiles. Users can log on to the Cisco Unified IP Phone User Options application and subscribe to these services for their Cisco Unified IP Phones.

This section covers the following topics:

Finding a Cisco Unified IP Phone Service

Configuring a Cisco Unified IP Phone Service

Cisco Unified IP Phone Service Configuration Settings

Deleting a Cisco Unified IP Phone Service

Configuring a Cisco Unified IP Phone Service Parameter

Cisco Unified IP Phone Service Parameter Settings

Deleting a Cisco Unified IP Phone Service Parameter

Adding a Cisco Unified IP Phone Service to a Phone Button

Cisco Unified IP Phone Services, Cisco Unified CallManager System Guide

Finding a Cisco Unified IP Phone Service

Because you might have several Cisco Unified IP Phone Services in your network, Cisco Unified CallManager lets you locate specific Cisco Unified IP Phone Services on the basis of specific criteria. Use the following procedure to locate Cisco Unified IP Phone Services.


Note During your work in a browser session, Cisco Unified CallManager Administration retains your Cisco Unified IP Phone Service search preferences. If you navigate to other menu items and return to this menu item, Cisco Unified CallManager Administration retains your Cisco Unified IP Phone Service search preferences until you modify your search or close the browser.


Procedure


Step 1 Choose Device >Device Settings > Phone Services.

The Find and List IP Phone Services window displays. Use the two drop-down list boxes to search for a Cisco Unified IP Phone Service.

Step 2 From the first Find Service where drop-down list box, choose one of the following criteria:

IP Phone Service

Description

From the second Find Service where drop-down list box, choose one of the following criteria:

begins with

contains

is exactly

ends with

is empty

is not empty

Step 3 Specify the appropriate search text, if applicable, and click Find. You can also specify how many items per page to display.


Tip To find all Cisco Unified IP Phone Services that are registered in the database, click Find without entering any search text.


A list of discovered Cisco Unified IP Phone Services displays by

IP Phone Service name

Description


Note You can delete multiple Cisco Unified IP Phone services from the Find and List IP Phone Services window by checking the check boxes next to the appropriate Cisco Unified IP Phone Services and clicking Delete Selected. You can delete all Cisco Unified IP Phone Services in the window by clicking Select All and then clicking Delete Selected.


Step 4 From the list of records, click the Cisco Unified IP Phone Service name or description that matches your search criteria.

The window displays the Cisco Unified IP Phone Service that you choose.


Additional Information

See the "Related Topics" section.

Configuring a Cisco Unified IP Phone Service

Perform the following steps to add or update a Cisco Unified IP Phone Service.


Caution Do not put Cisco Unified IP Phone Services on any Cisco Unified CallManager server at your site or any server that is associated with Cisco Unified CallManager, such as the TFTP server or directory database publisher server. This precaution eliminates the possibility that errors in a Cisco Unified IP Phone Service application will have an impact on Cisco Unified CallManager performance or interrupt call-processing services.

Procedure


Step 1 Choose Device >Device Settings > Phone Services.

The Find and List IP Phone Services window displays.

Step 2 Perform one of the followings tasks:

To add a Cisco Unified IP Phone Service, click the Add New button. The Cisco Unified IP Phone Services Configuration window displays. Continue with Step 3.

To update an existing Cisco Unified IP Phone Service (for example, to change the service URL or other information), locate the appropriate Cisco Unified IP Phone service as described in "Finding a Cisco Unified IP Phone Service" section. Click the name of the Cisco Unified IP Phone Service that you want to update and continue with Step 3.

Step 3 Enter the appropriate settings as described in Table 79-1.

Step 4 Click Save.

You can add, update, or delete parameters as needed as described in "Configuring a Cisco Unified IP Phone Service Parameter" section and "Deleting a Cisco Unified IP Phone Service Parameter" section.

Step 5 To apply the changes, update the Cisco Unified IP Phone Services Configuration window:

If the service was modified after subscriptions existed, click Update Subscriptions to rebuild all user subscriptions. You must update subscriptions if you changed the service URL, removed a phone service parameter, or changed the Parameter Name for a phone service parameter.


Note If you change the service URL, remove a Cisco Unified IP Phone Service parameter, or change the name of a phone service parameter for a phone service to which users are subscribed, be sure to click Update Subscriptions to update all currently subscribed users with the changes. If you do not do so, users must resubscribe to the service to rebuild the URL correctly.


If the service is new and you do not need to rebuild user subscriptions, click Save.


Additional Information

See the "Related Topics" section.

Cisco Unified IP Phone Service Configuration Settings

Table 79-1 describes the Cisco Unified IP Phone Service configuration settings. See Table 79-2 for Cisco Unified IP Phone Service configuration settings. For more information about related procedures, see the "Related Topics" section.

Table 79-1 Cisco Unified IP Phone Service Configuration Settings 

Field
Description
Service Information

Service Name

Enter the name of the service as it will display on the menu of available services in the Cisco Unified IP Phone User Options application. Enter up to 32 characters for the service name.

Service Name (ASCII Format)

Enter the name of the service to display if the phone cannot display Unicode.

Service Description

Enter a description of the content that the service provides.

Service URL

Enter the URL of the server where the Cisco Unified IP Phone Services application is located. Make sure that this server remains independent of the servers in your Cisco Unified CallManager cluster. Do not specify a Cisco Unified CallManager server or any server that is associated with Cisco Unified CallManager (such as a TFTP server or directory database publisher server).

For the services to be available, the phones in the Cisco Unified CallManager cluster must have network connectivity to the server.


Deleting a Cisco Unified IP Phone Service

Perform the following steps to delete a Cisco Unified IP Phone Service.

Before You Begin

When you delete a Cisco Unified IP Phone Service, Cisco Unified CallManager removes all service information, user subscriptions, and user subscription data from the database. To find out which devices are using the Cisco Unified IP Phone Service, from the Cisco Unified IP Phone Service Configuration window, choose Dependency Records from the Related Records drop-down list box and click Go. If the dependency records are not enabled for the system, the dependency records summary window displays a message. For more information about dependency records, see the "Accessing Dependency Records" section on page A-2. If you try to delete a Cisco Unified IP Phone Service that is in use, Cisco Unified CallManager displays an error message. Before deleting a Cisco Unified IP Phone Service that is currently in use, you must perform either or both of the following tasks:

Assign a different Cisco Unified IP Phone Service to any devices that are using the Cisco Unified IP Phone Service that you want to delete. See the "Deleting a Phone" section on page 71-5.

Delete the devices that are using the Cisco Unified IP Phone Service that you want to delete. See the "Deleting a Phone" section on page 71-5.

Procedure


Step 1 Find the Cisco Unified IP Phone Service by using the procedure in the "Finding a Cisco Unified IP Phone Service" section.

Step 2 Click the name of the IP Phone Service that you want to delete.

The Cisco Unified IP Phone Services Configuration window displays.

Step 3 Click Delete.

You receive a message that asks you to confirm the deletion.

Step 4 Click OK.

The window refreshes, and the Cisco Unified IP Phone Service gets deleted from the database.


Additional Information

See the "Related Topics" section.

Configuring a Cisco Unified IP Phone Service Parameter

Use the following procedure to add and configure or update Cisco Unified IP Phone Service parameters. Add the phone service before you configure parameters. Refer to the documentation for the individual Cisco Unified IP Phone Service for specific information about whether the service uses parameters, how those parameters should be configured, and whether you should provide optional parameter definitions.

Procedure


Step 1 Find the Cisco Unified IP Phone service by using the procedure in the "Finding a Cisco Unified IP Phone Service" section.

Step 2 From the Cisco Unified IP Phone Services list, choose the service to which you want to add parameters or update existing parameters.

The Cisco Unified IP Phone Services Configuration window displays.

Step 3 Perform one of the followings tasks:

To add a new phone service parameter, click the New button to the right of the Parameters list box. The Configure Cisco Unified IP Phone Service Parameter window displays. Continue with Step 4.

To update an existing parameter, choose the name of the parameter that you want to update in the Parameters list box. Click Edit and continue with Step 4.

Step 4 Enter the appropriate settings as described in Table 79-2.

To add the new parameter, click Save. To add additional parameters, if needed, click Add New in the Configure Cisco Unified IP Phone Service Parameter window and repeat Step 3 and Step 4.To add the last parameter, click Save and Close.

To apply the changes to the updated parameters, click Save, or to apply the changes and close the window, click Save and Close.

Step 5 To apply the changes, update the Cisco Unified IP Phone Services Configuration window:

If the service was modified after subscriptions existed, click Update Subscriptions to rebuild all user subscriptions. You must update subscriptions if you changed the service URL, removed a phone service parameter, or changed the name for a phone service parameter.


Note If you remove a Cisco Unified IP Phone Service parameter or change the parameter name of a phone service for a phone service to which users are subscribed, be sure to click Update Subscriptions to update all currently subscribed users with the changes. If you do not do so, users must resubscribe to the service to rebuild the URL correctly.


If the service is new and you do not need to rebuild user subscriptions, click Save.


Additional Information

See the "Related Topics" section.

Cisco Unified IP Phone Service Parameter Settings

Table 79-2 describes the Cisco Unified IP Phone Service parameter settings. For more information about related procedures, see the "Related Topics" section.

Table 79-2 Cisco Unified IP Phone Service Parameter Settings 

Field
Description
Service Parameter Information

Parameter Name

Enter the exact query string parameter to use when you build the subscription URL; for example, symbol.

Parameter Display Name

Enter a descriptive parameter name to display to the user in the Cisco Unified IP Phone User Options application; for example, Ticker Symbol.

Default Value

Enter the default value for the parameter. This value displays to the user when a service is being subscribed to for the first time; for example, CSCO.

Parameter Description

Enter a description of the parameter. The user can access the text that is entered here while the user is subscribing to the service. The parameter description should provide information or examples to help users input the correct value for the parameter.

Parameter is Required

If the user must enter data for this parameter before the subscription can be saved, check the Parameter is Required check box.

Parameter is a Password (mask contents)

You can mask entries in the Cisco Unified IP Phone User Options application, so asterisks display rather than the actual user entry. You may want to do this for parameters such as passwords that you do not want others to be able to view. To mask parameter entry, check the Parameter is a Password (mask contents) check box in the Configure Cisco Unified IP Phone Service Parameter window in Cisco Unified CallManager Administration.


Deleting a Cisco Unified IP Phone Service Parameter

Perform the following steps to delete a Cisco Unified IP Phone Service parameter.


Note If you remove a phone service parameter or modify the Parameter Name of a phone service parameter for a phone service to which users are subscribed, you must click Update Subscriptions to update all currently subscribed users with the changes. If you do not do so, users must resubscribe to the service to rebuild the URL correctly.


Procedure


Step 1 Find the Cisco Unified IP Phone Service by using the procedure in the "Finding a Cisco Unified IP Phone Service" section.

Step 2 From the Cisco Unified IP Phone Services list, choose the phone service whose parameters you want to delete.

Step 3 In the Parameters list box, choose the name of the parameter that you want to delete.

Step 4 Click Delete.

You receive a message that asks you to confirm the deletion.

Step 5 To confirm the deletion, click OK.

Step 6 To apply the changes, update the Cisco Unified IP Phone Services Configuration window:

If the service was modified after subscriptions existed, click Update Subscriptions to rebuild all user subscriptions. You must update subscriptions if you changed the service URL, removed a phone service parameter, or changed the Parameter Name for a phone service parameter.

If the service is new and you do not need to rebuild user subscriptions, click Save.


Additional Information

See the "Related Topics" section.

Adding a Cisco Unified IP Phone Service to a Phone Button

In addition to adding a Cisco Unified IP Phone Service, so it is available to users on their phones, you can assign the service to a phone button that is configured as a service URL. This gives the user one-button access to the service without using the services button on the IP phone.

Perform the following steps to add a service to a service URL button:

Procedure


Step 1 Add the service to Cisco Unified CallManager (see Configuring a Cisco Unified IP Phone Service).

Step 2 Customize a phone button template by configuring a Service URL button (refer to the "Configuring Phone Button Templates" section).

Step 3 Add the customized phone button template to the phone (refer to the "Configuring Cisco Unified IP Phones" section on page 71-2).

Step 4 Subscribe the service to the phone (refer to the "Configuring Cisco Unified IP Phone Services" section on page 71-25).

Step 5 Add the service URL to a phone button (refer to the "Configuring Service URL Buttons" section on page 71-27).


Related Topics

Finding a Cisco Unified IP Phone Service

Configuring a Cisco Unified IP Phone Service

Cisco Unified IP Phone Service Configuration Settings

Deleting a Cisco Unified IP Phone Service

Configuring a Cisco Unified IP Phone Service Parameter

Cisco Unified IP Phone Service Parameter Settings

Deleting a Cisco Unified IP Phone Service Parameter

Adding a Cisco Unified IP Phone Service to a Phone Button

Cisco Unified IP Phone Services, Cisco Unified CallManager System Guide