XML Considerations | Cisco Systems OL-20949-01 specs

Chapter 3 CiscoIPPhone XML Objects

XML Considerations

Note The <URLDown> tag can only contain Internal URIs—it cannot contain an HTTP URL. The “URL” in the name “URLDown” does not signify that an HTTP URL can be used.

Definition

<SoftKeyItem>

<Name>Displayed sofkey label</Name>

<URL>URL or URI action for softkey RELEASE event</URL> <URLDown>URL or URI action for softkey PRESS event</URLDown> <Position>position of softkey</Position>

</SoftKeyItem>

Example

In this example, a CiscoIPPhoneText object has a single custom softkey defined:

<CiscoIPPhoneText>

<Text>This object has one softkey named "Custom"</Text>

<SoftKeyItem>

<Name>Custom</Name>

<URL>http://someserver/somepage</URL>

<Position>4</Position>

</SoftKeyItem>

</CiscoIPPhoneText>

If any custom softkeys are defined in the XML object, then all default softkeys are removed from that object. To retain default softkey behavior, then you must explicitly define it in the XML object using a <SoftKeyItem> tag. The internal Softkey URIs can be used in the <URL> tag of <SoftKeyItem> to invoke default softkey actions from custom softkeys. See Chapter 5, “Internal URI Features” for more information on invoking internal softkey features.

Note If there are no custom softkeys and there is no default softkey placed in position 1, either a Next or Update softkey is assigned automatically. If the URL is a Refresh URL, the softkey will be “Next.” If not, the Update softkey is assigned.

Example

The following softkey definitions would provide the custom softkey, without losing the default “Select” behavior:

<SoftKeyItem>

<Name>Select</Name>

<URL>SoftKey:Select</URL>

<Position>1</Position>

</SoftKeyItem>

<SoftKeyItem>

<Name>Custom</Name>

<URL>http://someserver/somepage</URL>

<Position>4</Position>

</SoftKeyItem>

XML Considerations

The XML parser in Cisco Unified IP Phones does not function as a fully capable XML parser. Do not include any tags other than those defined in your XML display definitions.

	Cisco Unified IP Phone Services Application Development Notes
3-20	OL-20949-01

Image 38

Cisco Systems OL-20949-01 manual XML Considerations, SoftKeyItem NameDisplayed sofkey label/Name

Contents

Americas Headquarters Text Part Number OL-20949-01 Copyright 2004-2009 Cisco Systems, Inc. All rights reserved N T E N T S Iii Display Init Benefits Revision History PrefaceOverview Audience Viii OrganizationChapter Description Cisco Unified IP Phone 7900 Series Cisco Unified Communications Manager AdministrationRelated Documentation Cisco Unified Communications Manager Business Edition Convention Indication Cisco Product Security OverviewDocument Conventions Page Xii Overview 1shows a sample text menu Graphic Menu on a Cisco Unified IP Phone Sample Page OL-20949-01 New and Changed Information New Information for Cisco Unified Communications Manager OL-20949-01 CiscoIPPhone XML Objects Understanding Object Behavior 1shows the supported XML objects for this release XML Object Definitions CiscoIPPhoneMenu CiscoIPPhoneText Definition CiscoIPPhoneInput Sample User Input Display CiscoIPPhoneDirectory InputFlag Description CiscoIPPhoneImage Custom Directories Packed Pixel Translation Example Example Resolution1CiscoIPPhoneImageFile Model Monochrome Cisco Unified IP Phone 7970G Image File Display CiscoIPPhoneGraphicMenu CiscoIPPhoneGraphicFileMenu CiscoIPPhoneIconMenu 5shows the display of the CiscoIPPhoneGraphicFileMenu 6shows an IconMenu on a Cisco Unified IP Phone CiscoIPPhoneIconFileMenu CiscoIPPhoneStatus Dynamic Sizing of the Application Status Window CiscoIPPhoneStatus Phone Models Area Width Area Height 7940G, 7960G 7962G, 7965G 7970G/7971G-GE, 7975G, IP Communicator Text Area Size Phone Models WxH No Timer WxH 7940G, 7960GCiscoIPPhoneStatusFile 7962G, 7965G CiscoIPPhoneExecute Behavior Description CiscoIPPhoneResponse CiscoIPPhoneErrorCustom Softkeys XML Considerations SoftKeyItem NameDisplayed sofkey label/Name Character Name Escape Sequence Mandatory Escape SequencesXML Encoding Attributes Application Event HandlersSupported Unsupported Attribute Description Event Handler Schema RTP Streaming API Component APIsApplication Management API RTP Streaming Schema Interaction Rules with Legacy RTP URI Streams XscomplexType Xsall Error Schema Start Media Errors and ResponsesExamples Stop Media Applicable Condition Methods Http Result Code Type Data 7942G, 7962G 7906G 7945G, 7965G 7970G 6921 Internal URI FeaturesSupported URIs by Phone Model 7905G 7911G 7921G 7940G 7971G-GE 6941 URI Format Device Control URIsKey KeyDirectories Phone Unsupported Models Description and Alternatives Display URI XML Displayable Object URIs SoftKey Select Exit Update Submit Search Cancel Next Dial QueryStringParam Internal URI Features XML Displayable Object URIs Interaction with Call Streaming Multimedia URIsRTP Streaming RTPRx URI Formats RTPTx Interaction with Incoming Calls PlayVibrate Telephony URIs Dial EditDial SendDigits Error and Response Condition Status Data Notify Application Management URIsInit Called from SoftKey, with credentials, with data Application Called from SoftKey, no credentials, no data AppactionpriorityidleTimerapplicationId Error and Response Http Server Requests Http Post Http Requests and Header SettingsHttp Client Requests Http GET Http Header Settings See the Http Refresh Setting section on page 6-3section Http Refresh Setting Refresh Display Sample Content Expiration Header Setting Mime Type and Other Http Headers Set-Cookie Header Setting Http Encoding Header Setting Accept-Language CiscoIPPhoneDisplay Identifying the Capabilities of IP Phone ClientsCiscoIPPhoneModelName Accept Header CiscoIPPhoneSDKVersion Accessing IP Phone Information Html URL XML URL OL-20949-01 XML Parsing Errors Troubleshooting Cisco Unified IP Phone Service ApplicationsTroubleshooting Tips Error Messages Cisco IP Phone Services Software Development Kit SDK SDK Components OL-20949-01 Sample Services Requirements \CiscoIpServices\Tools OL-20949-01 IP Phone Service Administration Subscription Accessing Phone Service Administration Adding a Phone Service Field Description Defining IP Phone Service Parameters Field Description Service Parameter Information User Service Subscription DeviceListX Report 10-1 Integration Considerations and Interoperability BenefitsRestrictions Performance and Scalability Supported Platforms Related Features and TechnologiesSecurity Prerequisites Field Name Description Troubleshooting DeviceListX ReportsError Codes 10-4 10-5 Determining Problems With the InterfaceProcedure 10-6 CiscoIPPhone XML Object Quick Reference Object Definition Appendix a CiscoIPPhone XML Object Quick Reference IndexA unique index from 0 to 9/Index OL-20949-01 Cisco Unified IP Phone Services XML Schema File Updated XML Parser and Schema Enforcement CiscoIPPhone.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 Numerics IN-1 Html URL IN-2 IN-3 XML URL IN-4