Cisco IP Phone Services Application Development Notes for Release 3.3(4)
IP Phone Service Administration and Subscription
Downloads: This chapterpdf (PDF - 234.0KB) The complete bookPDF (PDF - 1.41MB) | Feedback

IP Phone Service Administration and Subscription

Table Of Contents

IP Phone Service Administration and Subscription

Adding a Phone Service

Defining IP Phone Service Parameters in Cisco CallManager Administration

User Service Subscription


IP Phone Service Administration and Subscription


Cisco CallManager administrators maintain the list of services to which users can subscribe. Add and administer Cisco IP Phone services through Cisco CallManager Administration:

To access phone service administration, open Cisco CallManager Administration and choose Feature > Cisco IP Phone Services.

Phone services can have any number of parameters associated with them.

You can specify phone service parameters as optional or required, depending on how the phone service application defines them.

Users can subscribe to any service configured in their cluster.

Service subscriptions currently occur on a device basis.

A URL constitutes the core of each service. When a service is chosen from the menu, the URL gets requested via HTTP, and a server somewhere provides the content. The Service URL field shows this URL entry. For the services to be available, the phones in the Cisco CallManager cluster must have network connectivity to the server.

Example

http://<servername>/ccmuser/sample/sample.asp

Where

<servername> designates a fully qualified domain name or an IP address.

Adding a Phone Service

Figure 1 shows the pane that the administrator uses to add new services to the system:

To access this pane in Cisco CallManager Administration, choose Feature > Cisco IP Phone Services.

You can insert, update, or delete a service definition.

After a service is inserted, you can insert, update, or delete service parameter definitions.

When you delete a Cisco IP Phone subscription, Cisco CallManager removes all service information, user subscriptions, and user subscription data from the database.

The Update Subscriptions button rebuilds all user subscriptions if the service has been modified after subscriptions exist.


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

Figure 1 Adding a New Service in Cisco CallManager Administration

Defining IP Phone Service Parameters in Cisco CallManager Administration

Each service can have a list of parameters. You can use these parameters, which are appended to the URL when they are sent to the server, to personalize a service for an individual user. Examples of parameters include stock ticker symbols, city names, or user IDs. The service provider defines the semantics of a parameter.

The Cisco IP Phone Service Parameter Configuration pane in Cisco CallManager Administration contains the following fields:

Field
Description

Parameter Name

This field provides the exact query string parameter to use when the subscription URL is built.

Parameter Display Name

This field designates the descriptive parameter name to display to the user on the user preferences window.

Default Value

This field designates the default value for the parameter. This value displays to the user when user is being subscribed to a service for the first time.

Parameter is Required

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

Parameter is a Password (mask contents)

Check this check box if the parameter is a password. The system will mask the contents.

Parameter Description

While subscribing to the service, the user can click on a link to view the text that is entered here. The parameter description should provide information or examples to help users input the correct value for the parameter.



Tip If you change the service URL, remove a Cisco IP Phone service parameter, or change the Parameter Name of a phone service parameter for a phone service to which users are already 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.


Figure 2 displays an example Cisco IP Phone Service Parameter Configuration pane in Cisco CallManager Administration.

Figure 2 Defining Service Parameters in Cisco CallManager Administration

User Service Subscription

User service subscriptions get configured with the CCMUser web site after the user has logged in and chosen a device.

The end user has a single list of services that are attached to an individual phone. The user configures this list of services via the user windows, which are also used to set speed-dial numbers and call-forwarding options. These password-protected windows get authenticated via the LDAP directory.

Figures 6-3, 6-4, and 6-5 show user subscription panes for administering personal services. Users can insert or remove services.

Users use these user configuration panes to assign values to the service parameters, allowing for personalization:

The user can customize the name of the service when it displays on the services list.

The user can enter any service parameters that are available for the chosen service.

The user can review the description of each parameter.

After all the required fields are set, the user can click Subscribe.

A custom URL gets built and stored in the database for this subscription.

The service then appears on the device services list.

Figure 6-3 Cisco CallManager User Subscription Pane

Figure 6-4 Personalizing a User Subscription

Figure 6-5 Personalizing a User Subscription Completed