Cisco Systems OL-20949-01 manual Defining IP Phone Service Parameters

Page 87

Chapter 9 IP Phone Service Administration and Subscription

Defining IP Phone Service Parameters

Table 9-1

IP Phone Service Configuration Settings (continued)

 

 

 

Field

 

Description

 

 

 

Enable

 

Select this check box to enable the service, or clear the check box to

 

 

disable the service without deleting it.

 

 

Note You cannot delete default services. Use this field if a default

 

 

service exists, but you do not want to make it available for

 

 

subscription.

 

 

Enterprise Subscriptions

Select this check box to automatically provision the new service to all

 

 

devices in the enterprise without requiring individual subscription. If

 

 

this option is selected, the service automatically gets provisioned and

 

 

does not get presented for user subscription.

 

 

Note Be aware that this check box is available for selection only

 

 

when the service is created. You cannot modify it.

 

 

 

Defining IP Phone Service Parameters

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 fields as described in Table 9-2.

Table 9-2

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 Cisco Unified

 

 

CM User Options; 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

You can mask entries in Cisco Unified CM User Options, so asterisks

 

(mask contents)

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, select the Parameter is a Password (mask

 

 

contents) check box in the Configure IP phone service Parameter window

 

 

in Cisco Unified Communications Manager Administration.

 

 

 

 

 

 

 

 

Cisco Unified IP Phone Services Application Development Notes

 

 

 

 

 

 

OL-20949-01

 

 

 

9-3

 

 

 

 

 

 

Page 86 Page 88
Image 87
Page 86 Page 88
Contents Text Part Number OL-20949-01 Americas HeadquartersCopyright 2004-2009 Cisco Systems, Inc. All rights reserved Iii N T E N T SDisplay Init Benefits Audience PrefaceOverview Revision HistoryOrganization Chapter DescriptionViii Cisco Unified Communications Manager Business Edition Cisco Unified Communications Manager AdministrationRelated Documentation Cisco Unified IP Phone 7900 SeriesCisco Product Security Overview Document ConventionsConvention Indication Page Xii 1shows a sample text menu OverviewGraphic Menu on a Cisco Unified IP Phone Sample Page OL-20949-01 New Information for Cisco Unified Communications Manager New and Changed InformationOL-20949-01 Understanding Object Behavior CiscoIPPhone XML Objects1shows the supported XML objects for this release CiscoIPPhoneMenu XML Object DefinitionsDefinition CiscoIPPhoneTextSample User Input Display CiscoIPPhoneInputInputFlag Description CiscoIPPhoneDirectoryCustom Directories CiscoIPPhoneImagePacked Pixel Translation Example Model Resolution1CiscoIPPhoneImageFile ExampleCisco Unified IP Phone 7970G Image File Display MonochromeCiscoIPPhoneGraphicFileMenu CiscoIPPhoneGraphicMenu5shows the display of the CiscoIPPhoneGraphicFileMenu CiscoIPPhoneIconMenu6shows an IconMenu on a Cisco Unified IP Phone CiscoIPPhoneStatus CiscoIPPhoneIconFileMenuCiscoIPPhoneStatus Dynamic Sizing of the Application Status Window7962G, 7965G 7970G/7971G-GE, 7975G, IP Communicator Phone Models Area Width Area Height 7940G, 7960G7962G, 7965G Phone Models WxH No Timer WxH 7940G, 7960GCiscoIPPhoneStatusFile Text Area SizeBehavior Description CiscoIPPhoneExecuteCiscoIPPhoneError Custom SoftkeysCiscoIPPhoneResponse SoftKeyItem NameDisplayed sofkey label/Name XML ConsiderationsMandatory Escape Sequences XML EncodingCharacter Name Escape Sequence Application Event Handlers Supported UnsupportedAttributes Attribute Description Event Handler Schema Component APIs Application Management APIRTP Streaming API Interaction Rules with Legacy RTP URI Streams RTP Streaming SchemaXscomplexType Xsall Error Schema Stop Media Errors and ResponsesExamples Start MediaApplicable Condition Methods Http Result Code Type Data 7905G 7911G 7921G 7940G 7971G-GE 6941 Internal URI FeaturesSupported URIs by Phone Model 7942G, 7962G 7906G 7945G, 7965G 7970G 6921Device Control URIs KeyURI Format KeyDirectories Description and Alternatives Phone Unsupported ModelsURI DisplaySoftKey XML Displayable Object URIsQueryStringParam Select Exit Update Submit Search Cancel Next DialInternal URI Features XML Displayable Object URIs Multimedia URIs RTP StreamingInteraction with Call Streaming URI Formats RTPRxRTPTx Play VibrateInteraction with Incoming Calls Dial Telephony URIsSendDigits EditDialCondition Status Data Error and ResponseApplication Management URIs InitNotify Called from SoftKey, with credentials, with data Called from SoftKey, no credentials, no data ApplicationAppactionpriorityidleTimerapplicationId Error and Response Http Requests and Header Settings Http Client Requests Http GETHttp Server Requests Http Post See the Http Refresh Setting section on page 6-3section Http Header SettingsRefresh Display Sample Http Refresh SettingMime Type and Other Http Headers Content Expiration Header SettingSet-Cookie Header Setting Accept-Language Http Encoding Header SettingIdentifying the Capabilities of IP Phone Clients CiscoIPPhoneModelNameCiscoIPPhoneDisplay CiscoIPPhoneSDKVersion Accept HeaderHtml URL XML URL Accessing IP Phone InformationOL-20949-01 Troubleshooting Cisco Unified IP Phone Service Applications Troubleshooting TipsXML Parsing Errors Error Messages SDK Components Cisco IP Phone Services Software Development Kit SDKOL-20949-01 \CiscoIpServices\Tools Sample Services Requirements OL-20949-01 Accessing Phone Service Administration IP Phone Service Administration SubscriptionField Description Adding a Phone ServiceField Description Service Parameter Information Defining IP Phone Service ParametersUser Service Subscription 10-1 DeviceListX ReportPerformance and Scalability BenefitsRestrictions Integration Considerations and InteroperabilityPrerequisites Related Features and TechnologiesSecurity Supported Platforms10-4 Troubleshooting DeviceListX ReportsError Codes Field Name DescriptionDetermining Problems With the Interface Procedure10-5 10-6 Object Definition CiscoIPPhone XML Object Quick ReferenceAppendix a CiscoIPPhone XML Object Quick Reference IndexA unique index from 0 to 9/Index OL-20949-01 Updated XML Parser and Schema Enforcement Cisco Unified IP Phone Services XML Schema FileCiscoIPPhone.xsd Xsdelement name=Name minOccurs=0 xsdsimpleType Xsdrestriction XsdsimpleType XsdsimpleType xsdrestriction base=xsdstring XsdcomplexType name=CiscoIPPhoneSoftKeyType xsdsequence Xsdelement name=Title minOccurs=0 xsdsimpleType Xsdrestriction XsdsimpleType Xsdattribute XsdcomplexType Xsdelement name=CiscoIPPhoneDirectory xsdcomplexType Xsdelement name=CiscoIPPhoneImageFile xsdcomplexType Xsdelement name=CiscoIPPhoneIconMenu xsdcomplexType Xsdelement name=CiscoIPPhoneGraphicFileMenu xsdcomplexType Xsdsequence Xsdelement name=Text minOccurs=0 xsdsimpleType Xsdsequence XsdcomplexType Xsdelement IN-1 NumericsIN-2 Html URLIN-3 IN-4 XML URL
Top Page Image Contents