Cisco Systems OL-12041-01 User Manual

Size:
380.99 Kb
Download

C H A P T E R 6

IP Phone Service Administration and

Subscription

Cisco Unified Communications Manager administrators maintain the list of services to which users can subscribe. These sections provide details about administering Cisco Unified IP Phone Services using

Cisco Unified Communications Manager Administration.

Overview

Adding a Phone Service

Defining IP Phone Service Parameters in Cisco Unified Communications Manager Administration

User Service Subscription

Overview

Administrators must use Cisco Unified Communications Manager Administration to add and administer Cisco Unified IP Phone services. To access phone service administration, open Cisco Unified Communications Manager Administration and choose Feature >Cisco Unified 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, using their User Options web pages.

 

 

Cisco Unified IP Phone Services Application Development Notes

 

 

 

 

 

 

OL-12041-01

 

 

6-1

 

 

 

Chapter 6 IP Phone Service Administration and Subscription

Adding a Phone Service

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 Unified Communications Manager 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

 

To access phone service administration, open Cisco Unified Communications

 

Manager Administration and choose Feature >Cisco Unified IP Phone

 

Services:

 

The Cisco Unified Services Configuration page in

 

Cisco Unified Communications Manager Administration contains the following

 

fields:

Table 6-1

Adding a Cisco Unified IP Phone Service

 

 

 

Field

 

Description

 

 

 

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 Description

Enter a description of the content that the service provides.

 

 

 

 

Cisco Unified IP Phone Services Application Development Notes

6-2

OL-12041-01

Chapter 6 IP Phone Service Administration and Subscription

 

 

 

 

Adding a Phone Service

 

Table 6-1

Adding a Cisco Unified IP Phone Service (continued)

 

 

 

 

 

Field

 

 

 

Description

 

 

 

 

 

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 Communications Manager cluster. Do not specify

 

 

 

 

a Cisco Unified Communications Manager server or any server that is

 

 

 

 

associated with Cisco Unified Communications Manager (such as a TFTP

 

 

 

 

server or directory database publisher server).

 

 

 

 

For the services to be available, the phones in the

 

 

 

 

Cisco Unified Communications Manager cluster must have network

 

 

 

 

connectivity to the server.

 

 

 

 

When defining the service URL, you can embed a special #DEVICENAME#

 

 

 

 

substitution tag within the URL. This tag provides a convenient method for IP

 

 

 

 

phones to pass their device name to a web application server. For example, if a

 

 

 

 

service URL was defined in Cisco Unified Communications Manager Admin

 

 

 

 

as: http://myserver/myscript?name=#DEVICENAME#, when a phone actually

 

 

 

 

makes the HTTP request for the service, the requested URL will appear as:

 

 

 

 

http://myserver/myscript?name=SEP000123456789

 

 

 

 

 

Character Set

 

 

 

If you are using a language other than English for Service Name and

 

 

 

 

Description, choose the character set for that language. Text that is input by the

 

 

 

 

user displays incorrectly if the wrong character set is chosen.

 

 

 

 

 

 

 

 

 

 

 

 

Tip

 

 

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 Unified IP Phone subscription,

Cisco Unified Communications Manager removes all service information, user subscriptions, and user subscription data from the database.

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

 

 

Cisco Unified IP Phone Services Application Development Notes

 

 

 

 

 

 

OL-12041-01

 

 

6-3

 

 

 

Chapter 6 IP Phone Service Administration and Subscription

Defining IP Phone Service Parameters in Cisco Unified Communications Manager Administration

Defining IP Phone Service Parameters in

Cisco Unified Communications Manager

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 Unified IP Phone Service Parameter Configuration page in

 

 

Cisco Unified Communications Manager Administration contains the following

 

 

fields:

Table 6-2

Defining Cisco Unified IP Phone Service Parameters

 

 

 

 

Field

 

 

Description

 

 

 

 

Parameter Name

 

 

Enter the exact query string parameter to use when you build the subscription

 

 

 

URL; for example, symbol.

 

 

 

Parameter Display

 

Enter a descriptive parameter name to display to the user in the

Name

 

 

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

 

 

Enter a description of the parameter. The user can access the text that is entered

Description

 

 

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

 

 

If the user must enter data for this parameter before the subscription can be

Required

 

 

saved, check the Parameter is Required check box.

 

 

 

 

Parameter is a

 

 

You can mask entries in the Cisco Unified IP Phone User Options application,

Password (mask

 

 

so asterisks display rather than the actual user entry. You may want to do this

contents)

 

 

for parameters such as passwords that you do not want others to be able to view.

 

 

 

To mask a 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 Communications Manager Administration.

 

 

 

 

 

Cisco Unified IP Phone Services Application Development Notes

6-4

OL-12041-01

Chapter 6 IP Phone Service Administration and Subscription

User Service Subscription

Tip If you change the service URL, remove a Cisco Unified 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 clickUpdate 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.

User Service Subscription

End users can configure service subscriptions using the Unified CMUser web site. After users log in and choose a device, a list of services that are assigned to the phone displays. The user can then configure these services, adding additional ones or removing un-usedservices. Thesepassword-protectedwindows are authenticated via the LDAP directory.

Users can personalize their services using the User Options pages to:

Customize the name of the service.

Enter any available service parameters.

Review the description of each parameter.

After all the required fields are set, the user clicks Subscribe to add the services. A custom URL gets built and stored in the database for this subscription. The service then appears on the device services list.

 

 

Cisco Unified IP Phone Services Application Development Notes

 

 

 

 

 

 

OL-12041-01

 

 

6-5

 

 

 

Chapter 6 IP Phone Service Administration and Subscription

User Service Subscription

 

Cisco Unified IP Phone Services Application Development Notes

6-6

OL-12041-01