Avaya 9640 Series Developer's Manual
  1. Manuals
  2. Brands
  3. Avaya Manuals
  4. IP Phone
  5. 9640 Series
  6. Developer's manual
Avaya 9640 Series Developer's Manual

Avaya 9640 Series Developer's Manual

One-x deskphone edition for 9600 series sip ip telephones
Hide thumbs Also See for 9640 Series:
Table of Contents

Advertisement

Quick Links

Download this manual See also: User Manual, Installation Manual
Avaya one-X™ Deskphone Edition
for 9600 Series SIP IP Telephones
Developer Guide
16-603173
Issue 1
September 2008

Advertisement

Table of Contents
loading

Related Manuals for Avaya 9640 Series

Summary of Contents for Avaya 9640 Series

  • Page 1 Avaya one-X™ Deskphone Edition for 9600 Series SIP IP Telephones Developer Guide 16-603173 Issue 1 September 2008...
  • Page 2 Avaya support Avaya provides a telephone number for you to use to report problems or to ask questions about your product. The support telephone number is 1-800-242-2121 in the United States. For additional support telephone numbers, see the Avaya Web site: http://www.avaya.com/support...

  • Page 3: Table Of Contents

    ISO/IEC, ANSI/IEEE Documents......Avaya Documents .......
  • Page 4 Starting the Avaya 9600 XML Validator......About the Avaya 9600 XML Validator ......

  • Page 5: About This Guide

    About This Guide About this Document This document describes how to customize the contents, and "look and feel" for the 9640 SIP IP Telephone. This document applies to Release SIP 2.2 for the 9640 SIP IP Telephone and also covers, in part, the behavior of the Avaya 9620 and 9630 Series SIP IP Telephones. The performance and behavior of the application or application server(s) are not addressed.

  • Page 6: Document Organization

    This guide is organized to help you find topics in a logical manner. Read it from start to finish to get a thorough understanding of the interfaces or use the Table of Contents or Index to locate specific features. 6 Avaya 9600 Series SIP IP Telephone Developer Guide...

  • Page 7: Terms Used In This Document

    Terms Used in This Document Terms Used in This Document Term Description Action The Action element defines the actions associated with an Item. Each action is triggered by an Event and has an attribute specifying what initiates it. An Action Element can contain a sequence of individual actions.
  • Page 8 Line to provide context-specific prompts, hints, explanations, help, or similar information. Registration The registration is a scheme of allowing an Avaya IP Telephone to authenticate itself with the Avaya Communication Manager. The Avaya Media Server switch supports registering and authenticating Avaya IP Telephones using the extension and password.

  • Page 9: Conventions Used In This Document

    Conventions Used in This Document Term Description (continued) eXtensible Markup Language. W3C's standard for Internet Markup Languages. WML is one of these languages. xml:lang The xml:lang attribute specifies the natural or formal language of an element or its attributes. This is a DTD term. 3 of 3 Conventions Used in This Document This guide uses the following textual, symbolic, and typographic conventions to help you...

  • Page 10: Online Documentation

    Words printed in this type are messages, prompts, code excerpts, message code samples, and XML tags. Online Documentation The online documentation for this guide and related Avaya documentation for 9600 Series IP Telephones is located at the Avaya Support Web site: http://www.avaya.com/support Related Documentation...

  • Page 11: Avaya Documents

    This guide provides a description of administrative duties like HTTP server setup, and how to set up Push parameters in the settings file. Avaya one-X™ Deskphone Edition for 9600 Series SIP IP Telephones Installation and ● Maintenance Guide (Document Number 16-603159)
  • Page 12 About This Guide 12 Avaya 9600 Series SIP IP Telephone Developer Guide...

  • Page 13: Chapter 1: Overview

    Chapter 1: Overview Prerequisite The following hardware and software is required to customize your Avaya 9600 Series IP Phone. Note: Refer to the Pre-Installation Checklist in Avaya one-X™ Deskphone Edition for Note: 9600 Series SIP IP Telephones Installation and Maintenance Guide (Document Number 16-603159).

  • Page 14: Ways Of Customizing The Avaya Sip Ip Phone

    Interface (API) Guide (Document Number 16-600888). Ways of Customizing the Avaya SIP IP Phone There are two ways for you to customize your Avaya SIP IP phone, the Push feature and configuring XML settings files. The table below depicts the main difference between both methods.

  • Page 15: Configuring Xml Settings Files

    The image below shows which files are used during the IP phone’s boot-up sequence. Overview of Configuring the XML Files Customizing the content and design of the 9640 SIP IP Phone involves the following steps: Issue 1 September 2008...
  • Page 16 Content on the Avaya 9620 and 9630 IP Phones can also be customized. Note: However, only the Avaya 9640 IP Phone in the 9600 Series can have its "llok and feel" (skin) customized. The Avaya 9610 IP Phone is not listed here since it does not support the features described in this document.

  • Page 17: Chapter 2: Customizing The Content

    The SET SKINS value must be on one line. Important: Refer to the Avaya one-X™ Deskphone Edition for 9600 Series IP Telephone Administrator Guide (Document Number 16-603158) for more information. 5. You will also need to modify the content.xml file to customize the content that displays on your IP phone.

  • Page 18: Create A Customized Content File

    Example content.xml file The instructions and files referenced below are provided as a sample of the changes required. To customize content: 1. Start an xml editor of your choice, such as XML Notepad. 18 Avaya 9600 Series SIP IP Telephone Developer Guide...
  • Page 19 Create a Customized Content File 2. Open the content.xml file. A screen similar to the example below displays. 3. Navigate to the label Concierge and replace this with Housekeeping. 4. Enter a new extension number of 40648. Edit the Dial attribute value of 40647 that was previously used for Concierge to reflect the new Housekeeping extension.

  • Page 20: Iptml Overview

    Line on the 9600 Series IP phones. Optional elements to disable hard buttons on an IP phone. ● Optional language resource elements to provide multiple languages for the IPTML ● document. 20 Avaya 9600 Series SIP IP Telephone Developer Guide...

  • Page 21: Basic Structure Of An Iptml Document

    The following page shows an example of a simple IPTML document: Note: Throughout this document, the configuration of an external server sending IPTML Note: actions to a phone is for illustrative purpose only. <?xml version="1.0"?> <IPTML xmlns="http://xml.avaya.com/IPTML"> <Card name="FirstCard" root="true"> <List id="appLines"></List> <List id="softkeys"></List> </Card> <Card name="SecondCard"> </Card>...

  • Page 22: Label Elements

    (Concierge) on the phone display. When the user selects this line, the message Please press OK to call the Concierge displays on the Prompt Line. Once the user presses the OK button, the extension number 46052 is dialled. 22 Avaya 9600 Series SIP IP Telephone Developer Guide...

  • Page 23: Action Elements

    IPTML Overview <List id="appLines"> <Item> <Label>Concierge</Label> <Actions trigger="OnActivate"> <Dial>46052</Dial> </Actions> <Actions trigger="OnFocus"> <DisplayLabel>Please press OK to call the Concierge</ DisplayLabel> </Actions> </Item> </List> In the example below, the Item is positioned below the softkeys list. This will display as a softkey on the phone display.

  • Page 24: Disabling Functions Of Hard Buttons

    Set the value of id to one of the following: ● Note: The Item's id attribute identifies the hard button on the phone. Note: - calllog - contacts - amenu - message - forward 24 Avaya 9600 Series SIP IP Telephone Developer Guide...

  • Page 25: Using A Password To Hide Screens

    OnPassword is required under the IPTML element for this to occur. Important: The password must be a four digit number. Important: In the following example, the phone will display the SecondCard once the user presses MUTE1234#. <IPTML xmlns="http://xml.avaya.com/IPTML"> <Card name="FirstCard" root="true"></Card> <Card name="SecondCard"></Card> <Card name="ThirdCard"></Card> <Actions trigger="OnPassword" password="1234"> <Go><CardName>SecondCard</CardName></Go>...

  • Page 26: Language Files

    The file is then downloaded by the 9600 Series IP phone. Note: Specifying a language other than English in the configuration file has no impact Note: on Avaya Communication Manager settings, values, or text strings. 26 Avaya 9600 Series SIP IP Telephone Developer Guide...

  • Page 27: Support Multiple Languages On The Customized Screen

    9600 Series SIP IP Phone Language file, which defines a label and translation for that label. Below is a sample English Resource Document <?xml version="1.0"?> <root> <data name="languageName"><value>English</value></data> <data name="COMPANY_NAME"><value>Avaya</value></data> <data name="WELCOME_TEXT"><value>Welcome to Avaya</value></data> <data name="SELECT_TEXT"><value>Please Make a Selection</value></data> <data name="HELP_TEXT"><value>Help</value></data> <data name="HELP_PROMPT_TEXT"><value>Press OK to Call for Assistant</ value></data> </root>...

  • Page 28: Bind The Language Resource

    <IPTML xmlns="http://xml.avaya.com/IPTML"> <Languages> <LanguageResource>http://www.hotel.com/langs/english.xml</ LanguageResource> <LanguageResource>http://www.hotel.com/langs/chinese.xml</ LanguageResource> </Languages> </IPTML> The example on the following page shows how a placeholder ${LABEL} is used to insert the Label defined in the language resource. 28 Avaya 9600 Series SIP IP Telephone Developer Guide...
  • Page 29 Language Support <IPTML xmlns="http://xml.avaya.com/IPTML"> <Languages> <LanguageResource>http://www.hotel.com/langs/english.xml</ LanguageResource> <LanguageResource>http://www.hotel.com/langs/chinese.xml</ LanguageResource> </Languages> <Card name="FirstCard" root="true"> <List id="appLines"> <Item> <Label>${HELP_TEXT}</Label> <Actions trigger="OnActivate"> <Dial>40643</Dial> </Actions> <Actions trigger="OnFocus"> <DisplayLabel>${HELP_PROMPT_TEXT}</DisplayLabel> </Actions> </Item> </List> </Card> <Label id="topline">${HOTEL_NAME}</Label> <Label id="topline">${WELCOME_TEXT}</Label> <Label id="promptline">${SELECT_TEXT}</Label> </IPTML> Note: When the language of the phone changed, the customized display screen will Note: change accordingly.

  • Page 30: Utilizing The Go Command To Launch An Application

    The following phone applications can be launched: CONTACTS - Contacts application ● CALLLOG - Call Log application ● OPTIONS - A (Avaya) Menu (or one of the sub-menus such as Options) ● WEB - launch the web browser ● FEATURE - feature screen ●...

  • Page 31: Launch An Application

    Utilizing the Go Command to Launch an Application Launch an Application <Item> <Label>Contacts</Label> <Actions trigger="OnFocus"> <DisplayLabel id="promptLine">Contact application</DisplayLabel> </Actions> <Actions> <Go> <App>CONTACT</App> </Go> </Actions> </Item> Open a URL in the WML Browser <Item> <Label>Application Line</Label> <Actions> <Go> <URL>http://avaya.com/hospitality.wml</URL> </Go> </Actions> </Item> Issue 1 September 2008...
  • Page 32 Customizing the Content 32 Avaya 9600 Series SIP IP Telephone Developer Guide...

  • Page 33: Chapter 3: Customizing The Skin

    Introduction This chapter describes the steps needed to change and create the "look and feel" such as background image, logo, etc. of the 9640 SIP IP phone. Using a Sample Skin If you wish to change the current design to a different skin: 1.

  • Page 34: Create A Skin

    5. Save the 46xxSettings.txt file and reboot your phone. Create a Skin The "look and feel", or skin, of the 9640 SIP IP phone can be customized to suit your company branding. The skin is dependent on a number of files.

  • Page 35: Renaming Image File Names

    9640.xml file references these names. However, you can create your own file names if required. Ensure that any changes to these images file names are properly referenced in the 9640.xml file. For example, suppose the following file names are used: layer1.jpg (rather than background.jpg)
  • Page 36 <img src="menu_normal.jpg" x="8" right="3" height="100%" srcx="8" /> <img src="menu_normal.jpg" right="0" width="4" height="100%" srcx="293" /> </appLine> <appLine_selected> <img src="menu_highlight.jpg" width="8" height="100%" /> <img src="menu_highlight.jpg" x="8" right="3" height="100%" srcx="8" /> <img src="menu_highlight.jpg" right="0" width="4" height="100%" srcx="293" /> 36 Avaya 9600 Series SIP IP Telephone Developer Guide...
  • Page 37 Create a Skin </appLine_selected> <webLine textColor="black" backColor="white"> <rect x="2" width="295" height="100%" color="white" /> <line x="297" y="1" x2="297" y2="19" color="white" /> </webLine> <webLine_selected textColor="white" backColor="black"> <rect x="2" width="295" height="100%" color="black" /> <line x="297" y="1" x2="297" y2="19" color="black" /> </webLine_selected> <softkey textColor="85,114,124"> <img src="softkey_highlight.jpg"...

  • Page 38: Positioning The Logo

    9640.xml file. In addition to the 9640 SIP IP Phone, the logo can also be changed on the 9620 and 9630 SIP IP Phones.

  • Page 39: Screen Size For Avaya 9600 Series Ip Phones

    Screen Size for Avaya 9600 Series IP Phones The size of the 9600 Series IP Phones are listed below: Note: The Avaya 9610 IP Phone is not listed here since it does not support the features Note: described in this document.
  • Page 40 Customizing the Skin 40 Avaya 9600 Series SIP IP Telephone Developer Guide...

  • Page 41: Chapter 4: Validate The Content And Skin Files

    Validate the Content and Skin Files Introduction The Avaya 9600 XML Validator checks the xml files against the XML 1.0 standards, as published by the Worldwide Web Consortium (W3C). The Validator checks the validity of the content.xml and 9640.xml files, including: conformance to the XML Schema Definition (XSD) ●...

  • Page 42: Starting The Avaya 9600 Xml Validator

    Validate the Content and Skin Files Starting the Avaya 9600 XML Validator If the program is not open, from the Windows Start button, click All Programs > Avaya > Avaya 9600 XML Validator 42 Avaya 9600 Series SIP IP Telephone Developer Guide...

  • Page 43: About The Avaya 9600 Xml Validator

    About the Avaya 9600 XML Validator About the Avaya 9600 XML Validator The image below shows there are four main parts of the Avaya 9600 XML Validator window. Note: To ensure you have the latest functionality available, the application connects to Note: the Avaya Support Web site each time you start a new session.

  • Page 44: Menu Items

    Menu Items The menu bar options are similar to those in other Windows applications, however some options on each menu are specific to Avaya 9600 XML Validator. Schema Menu The schema for the content and skin xml files can be viewed by using the Schema menu option.

  • Page 45: Editing Xml Files

    Editing XML Files Editing XML Files Editing content and skin files is similar. The example below shows how to use the Validator to fix an error and a warning in a sample content file. Using the Text Editor to Fix a Problem Here is a warning that displays when running the Validator: On further inspection the xml file contains an incorrect List id, highlighted below.
  • Page 46 Validate the Content and Skin Files After correcting the List id from apLines to appLines in the Text Editor pane, the status bar displays: 46 Avaya 9600 Series SIP IP Telephone Developer Guide...

  • Page 47: Using The Log To View All Problems

    Editing XML Files Using the Log to View All Problems The Log file provides a complete status report about the loaded xml file. As the image below shows, the Validator’s main window only displays one error or warning in the Status Pane: Viewing the Log file allows you to identify further problems with the xml file, as highlighted below: Tip:...
  • Page 48 Validate the Content and Skin Files 48 Avaya 9600 Series SIP IP Telephone Developer Guide...

  • Page 49: Appendix A: Iptml Reference

    IPTML is a simple XML based language that allows applications to exchange information with IP endpoints. This appendix lists IPTML components and their functions. Only those elements implemented for the Avaya 9600 Series SIP IP Phone are listed. Issue 1 September 2008...

  • Page 50: Iptml Components

    If root <NextCardName> or is not present, the <PrevCardName> value is false. element. Only one card can have the root attribute as true in a IPTML document. 1 of 4 50 Avaya 9600 Series SIP IP Telephone Developer Guide...
  • Page 51 Label element is used telephone’s top to define text for the line <Label Top Line, Title Line id="titleline"> and Prompt Line. Welcome to Avaya titleLine: the </Label> second line, If the Label element specifies the appears under an current IPTML element, it...
  • Page 52 Event and has an e"> attribute specifying <Go> what initiates it. An Action Element can <CardName>Housekee contain a sequence of pCard</CardName> individual actions. </Go> </Actions> 3 of 4 52 Avaya 9600 Series SIP IP Telephone Developer Guide...
  • Page 53 IPTML Components Component Definition Attributes Example Events trigger Actions OnFocus: line Events <Actions and contain an appearance trigger="OnFocus"> attribute to specify comes into focus <DisplayLabel>Call a how those Actions are triggered. maid to clean the OnActivate: line appearance is room selected </DisplayLabel>...

  • Page 54: Iptml Schema

    Select Schema > View Content Schema from the menu. ● Here is a sample of the content schema: The Avaya 9600 XML Validator also allows you to view the skin schema. Select Schema > View 9640 Skin Schema from the menu. ●...

  • Page 55: Index

    Action Elements Go Command ....Avaya 9600 Series IP Phones launch an application ....
  • Page 56 ....status pane ....text editor 56 Avaya 9600 Series SIP IP Telephone Developer Guide...

Table of Contents