Sei sulla pagina 1di 56

Avaya one-X™ Deskphone Edition

for 9600 Series SIP IP Telephones


Developer Guide

16-603173
Issue 1
September 2008
© 2008 Avaya Inc. Third-party Components
All Rights Reserved. Certain software programs or portions thereof included in the Product may
contain software distributed under third party agreements (“Third Party
Notice
Components”), which may contain terms that expand or limit rights to use
While reasonable efforts were made to ensure that the information in this certain portions of the Product (“Third Party Terms”). Information identifying
document was complete and accurate at the time of printing, Avaya Inc. can Third Party Components and the Third Party Terms that apply to them is
assume no liability for any errors. Changes and corrections to the information available on Avaya’s Web site at:
in this document may be incorporated in future releases.
http://support.avaya.com/ThirdPartyLicense/
For full legal page information, please see the complete document, Avaya
Interference
Legal Page for Hardware Documentation, Document number 03-600759.
Using a cell, mobile, or GSM telephone, or a two-way radio in close proximity to
To locate this document on our Web site, simply go to
an Avaya IP Telephone might cause interference.
http://www.avaya.com/support and search for the document number in
the search box.

Documentation disclaimer
Avaya Inc. is not responsible for any modifications, additions, or deletions to
the original published version of this documentation unless such modifications,
additions, or deletions were performed by Avaya. Customer and/or End User
agree to indemnify and hold harmless Avaya, Avaya's agents, servants and
employees against all claims, lawsuits, demands and judgments arising out of,
or in connection with, subsequent modifications, additions or deletions to this
documentation to the extent made by the Customer or End User.

Link disclaimer
Avaya Inc. is not responsible for the contents or reliability of any linked Web
sites referenced elsewhere within this documentation, and Avaya does not
necessarily endorse the products, services, or information described or offered
within them. We cannot guarantee that these links will work all of the time and
we have no control over the availability of the linked pages.
Warranty
Avaya Inc. provides a limited warranty on this product. Refer to your sales
agreement to establish the terms of the limited warranty. In addition, Avaya’s
standard warranty language, as well as information regarding support for this
product, while under warranty, is available through the following Web site:
http://www.avaya.com/support

Copyright
Except where expressly stated otherwise, the Product is protected by copyright
and other laws respecting proprietary rights. Unauthorized reproduction,
transfer, and or use can be a criminal, as well as a civil, offense under the
applicable law.

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

Software License
USE OR INSTALLATION OF THE PRODUCT INDICATES THE END USER’S
ACCEPTANCE OF THE TERMS SET FORTH HEREIN AND THE GENERAL
LICENSE TERMS AVAILABLE ON THE AVAYA WEBSITE AT
http://support.avaya.com/LicenseInfo/ (“GENERAL LICENSE TERMS”). IF
YOU DO NOT WISH TO BE BOUND BY THESE TERMS, YOU MUST
RETURN THE PRODUCT(S) TO THE POINT OF PURCHASE WITHIN TEN
(10) DAYS OF DELIVERY FOR A REFUND OR CREDIT.
Avaya grants End User a license within the scope of the license types
described below. The applicable number of licenses and units of capacity for
which the license is granted will be one (1), unless a different number of
licenses or units of capacity is specified in the Documentation or other
materials available to End User. “Designated Processor” means a single
stand-alone computing device. “Server” means a Designated Processor that
hosts a software application to be accessed by multiple users. “Software”
means the computer programs in object code, originally licensed by Avaya and
ultimately utilized by End User, whether as stand-alone Products or
pre-installed on Hardware. “Hardware” means the standard hardware
Products, originally sold by Avaya and ultimately utilized by End User.

License Type(s):
Designated System(s) License (DS). End User may install and use each copy
of the Software on only one Designated Processor, unless a different number
of Designated Processors is indicated in the Documentation or other materials
available to End User. Avaya may require the Designated Processor(s) to be
identified by type, serial number, feature key, location or other specific
designation, or to be provided by End User to Avaya through electronic means
established by Avaya specifically for this purpose.
Contents
About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
About this Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Intended Audience. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Document Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Issue Date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
How to Use This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Terms Used in This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Conventions Used in This Document . . . . . . . . . . . . . . . . . . . . . . . . 9
Symbolic Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Typographic Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Online Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
IETF Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
ITU Documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
ISO/IEC, ANSI/IEEE Documents. . . . . . . . . . . . . . . . . . . . . . . . 10
Avaya Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Other Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Chapter 1: Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Prerequisite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
New Features in Release 2.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Ways of Customizing the Avaya SIP IP Phone. . . . . . . . . . . . . . . . . . . . 14
Using the Push Feature. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Configuring XML Settings Files. . . . . . . . . . . . . . . . . . . . . . . . . . 15
Overview of Configuring the XML Files . . . . . . . . . . . . . . . . . . . . . . . 16

Chapter 2: Customizing the Content . . . . . . . . . . . . . . . . . . . . 17


Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Enable Customization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Create a Customized Content File . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Example content.xml file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
IPTML Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Basic Structure of an IPTML Document . . . . . . . . . . . . . . . . . . . . . 21
Card Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Label Elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Item Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Action Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Issue 1 September 2008 3


Contents

Disabling Functions of Hard Buttons . . . . . . . . . . . . . . . . . . . . . . . . 24


Using a Password to Hide Screens. . . . . . . . . . . . . . . . . . . . . . . . . . 25
Language Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Language Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Support Multiple Languages on the Customized Screen . . . . . . . . . . . . 27
Bind the Language Resource . . . . . . . . . . . . . . . . . . . . . . . . . 28
Utilizing the Go Command to Launch an Application . . . . . . . . . . . . . . . . 30
Navigate to a card . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Launch an Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Open a URL in the WML Browser . . . . . . . . . . . . . . . . . . . . . . . 31

Chapter 3: Customizing the Skin . . . . . . . . . . . . . . . . . . . . . . 33


Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Using a Sample Skin. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Using the 46xxSettings.txt file to Modify the Skin . . . . . . . . . . . . . . 33
Create a Skin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Image Dimensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Renaming Image File Names . . . . . . . . . . . . . . . . . . . . . . . . . 35
Positioning the Logo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Screen Size for Avaya 9600 Series IP Phones . . . . . . . . . . . . . . . . 39

Chapter 4: Validate the Content and Skin Files . . . . . . . . . . . . . . 41


Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Installing the Avaya 9600 XML Validator . . . . . . . . . . . . . . . . . . . . . . . 41
Starting the Avaya 9600 XML Validator. . . . . . . . . . . . . . . . . . . . . . . . 42
About the Avaya 9600 XML Validator . . . . . . . . . . . . . . . . . . . . . . . . . 43
Menu Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Action Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Text Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Status Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Editing XML Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Using the Log to View All Problems . . . . . . . . . . . . . . . . . . . . . . . 47

Appendix A: IPTML Reference . . . . . . . . . . . . . . . . . . . . . . . 49


Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
IPTML Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
IPTML Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

4 Avaya 9600 Series IP Telephone Developer 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.

Intended Audience
This document is intended for the application developers and System Administrators who
develop or implement:
● customized content for the Avaya 9620, 9630, and 9640 SIP IP Telephones
● a customized "look and feel" for the Avaya 9640 SIP IP Telephone.

! CAUTION:
CAUTION: Avaya does not provide product support for many of the products mentioned in
this document. Take care to ensure that there is adequate technical support
available for the servers involved, including, but not necessarily limited to, HTTP,
HTTPS, and DHCP servers. If the servers are not functioning correctly, the IP
telephones might not be able to operate correctly.

Issue 1 September 2008 5


About This Guide

Document Organization
This guide contains the following chapters:

Chapter 1: Overview Lists prerequisite hardware and software required. The


methods that can be used and an overview of steps for
customizing content and the user interface on applicable
9600 Series IP Telephones.

Chapter 2: Customizing the Describes steps needed to enable customization, then


Content details steps required to create customized content on the
9600 series SIP IP phones. Also provides an overview and
some examples of the IP Telephony Markup Language
(IPTML). A generic description is provided, followed by
further details about various IPTML elements, and how to
implement changes to an Avaya IP Telephone using
IPTML.

Chapter 3: Customizing the Describes steps needed to change and create the "look
Skin and feel" such as background image, logo, etc. of the
9640 SIP IP phone.

Chapter 4: Validate the Explains how to ensure the XML files are formed correctly
Content and Skin Files and ready to be used.

Appendix A: IPTML Reference Provides a list of IPTML elements and functions.

Issue Date
This is the first release of this document, issued in September 2008.

How to Use This Document


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


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.
Application Area The usable display area between the Prompt Line and Softkey labels.
Application Line The display area line that indicates application-specific messages.
Card An IPTML document contains zero or more IPTML Cards. Each Card consists
of Lists and Labels.
Deck A deck can be described as a stack of cards. When the browser downloads a
WML page, it really is downloading a deck of cards but only one card in the
deck is visible at a time.
DTD Document Type Definition. The DTD defines the names and contents of all
elements that permissible on a WML page, the order in which the elements
must appear, the contents of all elements, attributes and default values.
Elements Elements are the essential components that make up a single IPTML
document.
FLOW The flow type represents “card-level” information. In general, flow is used
anywhere general markup can be included.
Focus Since the phone has no mouse to navigate around the screen, the line buttons if
shown, or the OK button are used to select a particular line on the display.
Selecting a line serves to “to bring that line into focus.” Focusing on a line is
used to select a line for text entry or to select a line that contains a link to
another URL (card). Additionally, new titles can (not always) be presented to
the user as each line on the screen is individually brought “into focus” (selected
by pressing the Line or OK buttons).
H.323 A TCP/IP-based protocol for VoIP signaling.
HTML HyperText Markup Language is a text-based way of describing data for
transmission over the Internet HTML is usually used with larger, color displays.
HTTP HyperText Transfer Protocol, used to request and transmit pages on the World
Wide Web.
HTTPS HyperText Transfer Protocol Secure. A secure version of HTTP over SSL
(Secure Socket Layer). Designed to provide encrypted communications for
handling secure transactions.
1 of 3

Issue 1 September 2008 7


About This Guide

Term Description (continued)

IP Internet Protocol – a suite of information-exchanged message sets widely used


for data transmission and increasingly used for the transmission of voice.
IPTML IP Telephony Markup Language. A simple XML based language that allows
applications to exchange information with an IP endpoint.
Item The Item element is the most often used element in an IPTML document. It can
refer to an application line, a softkey, or a hard button on the IP phone.
Label The Label element is used to define text for the Top Line, Title Line and Prompt
Line.
Link The URI that is used to chain cards together.
List Used in a Card Element to identify application lines, softkeys, or hard buttons.
Prompt Line The third line in the top display area. The current application uses the Prompt
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.
Skin The "look and feel" of an Avaya IP Telephone, specifically the display area.
Title Line The second line in the top display area. Comprised of the current application
title, subtitle (if applicable), and choice or Web paging indicators as applicable.
Top Line The top area of the display is subdivided horizontally into a Top Line, a Title
Line, and a Prompt Line, each extending across the entire width of the 318 pixel
usable area for the 9600 Series IP Telephones. The Top Line contains current
status information. Examples of status information are the extension number,
time and date, and icons for phone- or call-related data. For the 9610 IP
Telephone, which has only a Top Line, messages and prompts appear there.
Type Type specifies a tag or attribute.
VDATA A DTD data type representing a string that can contain variable references. This
type is only used in attribute values.
W3C World Wide Web Consortium.
WAP Wireless Application Protocol. An open global standard for wireless solutions
that includes WML.
WML Wireless Markup Language is a subset of XML, used by the Avaya IP
Telephone Web browser to communicate with WML Servers.
2 of 3

8 Avaya 9600 Series SIP IP Telephone Developer Guide


Conventions Used in This Document

Term Description (continued)

XML 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
interpret information.

Symbolic Conventions
Note:
Note: This symbol precedes additional information about a topic.

! CAUTION:
CAUTION: This symbol is used to emphasize possible harm to software, possible loss of
data, or possible service interruptions.

Typographic Conventions
This guide uses the following typographic conventions:

Document Underlined type indicates a section or sub-section in this document


containing additional information about a topic.
“Document” Italic type enclosed in quotes indicates a reference to specific
section or chapter of an external document.
italics Italic type indicates the result of an action you take or a system
response in step by step procedures.

Issue 1 September 2008 9


About This Guide

Conference In step by step procedures, words shown in bold represent a single


telephone button that should be pressed/selected.
message Words printed in this type are messages, prompts, code excerpts,
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

IETF Documents
The following documents provide information relevant to IP telephony and are available for free
from the IETF Web site:
● IETF RFC 2616: http://www.ietf.org/rfc/rfc2616.txt?number=2616
● IETF 1945: http://www.ietf.org/rfc/rfc1945.txt?number=1945

ITU Documents
Access the ITU Web site for more information about ITU guidelines and documents, available
for a fee from the ITU Web site: http://www.itu.int.

ISO/IEC, ANSI/IEEE Documents


Access the ISO/IEC standards Web site for more information about IP Telephony standards,
guidelines, and published documents: http://www.iec.ch.

10 Avaya 9600 Series SIP IP Telephone Developer Guide


Related Documentation

Avaya Documents
● Avaya one-X™ Deskphone Edition for 9600 Series IP Telephone Administrator Guide
(Document Number 16-603158)
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)
This guide provides information on administering Avaya Communication Manager, DHCP,
HTTP/HTTPS servers for 9600 Series SIP IP Telephones, a Local Area Network (LAN), SIP
Enablement Services (SES) or a Network Time server.
● IP Telephone WML Server Setup Guide (Document Number 16-300507)
This guide provides information on setting up a Web server.

Other Documents
● Extensible Markup Language (XML) 1.0 (Second Edition), W3C Recommendation 6
October 2000.

Issue 1 September 2008 11


About This Guide

12 Avaya 9600 Series SIP IP Telephone Developer Guide


Chapter 1: Overview

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

Hardware
● Avaya 9620, 9630, or 9640 SIP IP Phone
● Desktop computer
● Web server

Software
● 96xx SIP phone with R2.2 firmware from the Avaya Support Web site: http://
www.avaya.com/support
● Microsoft Windows XP (or later) with Internet Explorer, or a web browser of your choice
● Microsoft XML Notepad, or an xml editor of your choice
● Microsoft Paint or an image editor of your choice
● Avaya 9600 XML Validator

New Features in Release 2.2


Previous versions of the 9600 Series IP Phone firmware allowed an administrator the capability
of pushing content including text, web pages and audio files to the phone.
The release of version 2.2 firmware includes the following features:
● Clear the call log
● Clear the web history

Issue 1 September 2008 13


Overview

● Change the phone language


● Change the user name
● Control the backlight
● Change the appearance of the phone by updating the skin and logo
● Change the display screen
● Update the user profile
Note:
Note: Further information about the Push feature is available in Avaya one-X™
Deskphone Edition for 9600 Series IP Telephones Application Programmer
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.

Feature Push Configuring XML Files

Interaction is... remote local

Configuration a web browser XML files native to the phone


through...

Customized screen in ’real-time’ when phone boots up


updated...

Using the Push Feature.


The Push feature provides the ability for an application to send content to the Web browser, to
the Top Line of the display, or to the audio transducers of 9600 Series IP Telephones. With the
Push interface, the application can ’push’ unsolicited information to the telephone without the
user having to click a link.

14 Avaya 9600 Series SIP IP Telephone Developer Guide


Overview of Configuring the XML Files

Some uses of the Push interface include:


● Broadcasting company news
● Sending meeting reminders with conference bridge numbers, so that users don’t have to
search for the conference number
● Streaming music, such as wake-up alarms in hotel rooms
● Streaming audio announcements
● Sending critical stock news information
● Broadcasting critical emergency notices and weather alerts
● Building intelligent databases to target information to an individual or groups of phones

Configuring XML Settings Files


By configuring XML files you can change the content and "look and feel" of your phone.
XML files can be downloaded from the Avaya Support Web Site: http://www.avaya.com/
support
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 15


Overview

● Enable Customization
● Create a Customized Content File
● Customizing the Skin
● Validate the Content and Skin Files
Note:
Note: Content on the Avaya 9620 and 9630 IP Phones can also be customized.
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.

16 Avaya 9600 Series SIP IP Telephone Developer Guide


Chapter 2: Customizing the Content

Introduction
This chapter provides the steps needed to enable customization, then details steps required to
create customized content on the 9600 series SIP IP phones.

Enable Customization
To enable customization on the 9600 series SIP IP Phone:
1. Download the 9600template.zip file from the Avaya Support Web site:
http://www.avaya.com/support.
2. Extract the zip file and copy the sample files to the root folder of your file server.
Note:
Note: The generic term "file server" refers to both "HTTP server" and "HTTPS server".
3. Configure the 46xxSettings.txt file
4. Navigate to the section SETTINGS9640, and modify the following parameters:
SET CURRENT_CONTENT "http://<webserver>/content.xml"
SET SKINS "example=http://<webserver>/skins/example/9640.xml"
SET CURRENT_SKIN "example"
In the above example, <webserver> should be replaced with HTTP server which is
deployed in your environment.

! Important:
Important: The SET SKINS value must be on one line.
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. This file is available from the Avaya Support Web site
6. Reboot the phone.

Issue 1 September 2008 17


Customizing the Content

7. The content provided in content.xml should be displayed on the screen when the phone has
started up.
The example below shows how the display can be customized using this procedure.

Create a Customized Content File


You can customize content such as menu items on the 9600 Series IP Phone.
Alternatively, refer to the samples provided in the 9600template.zip file.
See IPTML Overview for more information about the structure and elements in an IPTML
document.

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


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.
5. Enter a new display in the DisplayLabel attribute value; Press OK to dial the
Housekeeper

6. Copy the HouseKeeping item and paste it into the content.xml document to create a new
menu item.
a. Rename Housekeeping to Help Desk

Issue 1 September 2008 19


Customizing the Content

b. Change the extension number to 45150


c. Enter a new prompt message within the DisplayLabel attribute, Press OK to dial
the Help Desk.
The content.xml file should now include the following:
<Item>
<Label>Help Desk</Label>
<Actions trigger="OnActivate">
<Dial>45150</Dial>
</Actions>
<Actions trigger="OnFocus">
<DisplayLabel>Press Ok to dial the Help Desk</DisplayLabel>
</Actions>
</Item>
7. Save the content.xml file and copy to your file server.
8. Restart the IP phone.

IPTML Overview
IPTML is a simple XML based language that allows applications to exchange information with
IP endpoints.
The key aspect of IPTML is to present an interface for applications to interact with various IP
telephony events, such as attaching content to home screens and to various call handling
screens.
An IPTML document is an ordinary XML document containing the following elements:
● A number of Card elements that contain the content of the customized screens.
● A number of Label elements that contain information to display on the Title Line or Prompt
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


IPTML Overview

Basic Structure of an IPTML Document


The following page shows an example of a simple IPTML document:
Note:
Note: Throughout this document, the configuration of an external server sending IPTML
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>
<Card name="ThirdCard"> </Card>
<Card name="FourthCard"> </Card>
<Label id="promptLine">Please select an option</Label>
</IPTML>

Card Elements
An IPTML document contains zero or more IPTML Cards. Each Card consists of a set of
Actions. The Path is used to identify the IPTML with a unique address or path. The Actions are
sequences of actions that are invoked by the recipient, usually the device. The Events are a
sequence of events sent to the recipient, usually the application.
A Card element can contain a Label, List, softkeys and more. Cards can be related to each
using the <NextCardName> or <PrevCardName> element.
Syntax
Here is the syntax for a card element:
<Card name ="Menu1, root="true">
<Label id="titleLine">Hello</Label>
<List id="appLines"></List>
<List id="softkeys"></List>
<NextCardName>Menu2</NextCardName>
<PrevCardName>Menu3</PrevCardName>
</Card>

Issue 1 September 2008 21


Customizing the Content

Attributes
The attributes of a Card element are:
● name: a unique name to identify the card
● root: set to true to indicate this card is the default card for the phone to display. When the
phone loads the IPTML document, it will display the card which has a value of root="true".
The default value for root is false. If root is not present, the value is false. Only one card
can have the root attribute as true in an IPTML document.

Label Elements
A Label element can be positioned below an IPTML element, or Card element. The Label
element is used to define text for the Top Line, Title Line and Prompt Line. If the Label element
appears under an IPTML element, it provides a default Label for all the Cards in the document.
If a card does not contain a Label, it will use this default Label. If a Label element appears under
a Card element, it overrides the default Label under IPTML element.
The example below will display the Welcome message on the Title Line of the phone.
<Label id="titleline"> Welcome to Avaya </Label>

Attribute of List IDs


The attribute of List ID is:
● id: identify the list and the values it contains. The value can be either appLines, softkeys,
or hardButtons. Normally, a Card element comprises of two lists; one list defines the
application lines, and the other defines the softkeys.

Item Elements
The Item element is the most often used element in an IPTML document. It can refer to an
application line, a softkey, or a hard button on the IP phone.
In the example below, the Item is positioned below the appLines List. This will display as a line
appearance (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


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. Once the user presses the softkey button, the extension number 46052 is
dialled. Since the softkey cannot be the focal point, the actions with trigger OnActivate is
used instead of OnFocus.
<List id="softkeys">
<Item>
<Label>Help</Label>
<Actions trigger="OnActivate">
<Dial>40653</Dial>
</Actions>
</Item>
</List>

Action Elements
An IPTML Element contains a sequence of zero or more Actions. 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.

Issue 1 September 2008 23


Customizing the Content

The table below shows an example of some Actions:

Action Purpose

Dial Dial a phone number


Go Go to a specified Path. The Go element
supports:
- CardName – navigate to a card
- App – Launch an application
- URL – open a url in the wml browser

The table below shows an example of Events that can trigger the Actions described above:

Event Used when the...

OnFocus line appearance comes into focus


OnActivate line appearance is selected
OnPassword user enters a password

Disabling Functions of Hard Buttons


To disable functions of hard buttons on your IP Phone:
● Define a list and name it HardButtons
Note:
Note: The list must be positioned within an IPTML element
● Set the value of id to one of the following:
Note:
Note: The Item's id attribute identifies the hard button on the phone.
- calllog
- contacts
- amenu
- message
- forward

24 Avaya 9600 Series SIP IP Telephone Developer Guide


Using a Password to Hide Screens

Here is an example of disabling hard buttons on the phone:


<List id="HardButtons">
<Item id="calllog">
<Item id="message">
</List>

Using a Password to Hide Screens


Use this procedure to define a hidden screen which can only be accessed through a password.
The IPTML document provide the facilities to display a Card by entering a password. An Action
with a trigger set to OnPassword is required under the IPTML element for this to occur.

! Important:
Important: The password must be a four digit number.
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>
</Actions>
</IPTML>

Language Support
9600 Series IP Telephones are factory-set to display information in the English language. In
addition to English, the SIP software bundle downloads include the following language files:
● Canadian French
● Parisian French
● Latin American Spanish

Issue 1 September 2008 25


Customizing the Content

● German
● Brazilian Portuguese
● Italian
● Dutch
● Castilian Spanish
● Russian
● Simplified Chinese
● Japanese
● Korean
● Hebrew
● Arabic
Administrators can specify from one to four languages per telephone to replace English. End
users can then select which of those languages they want their telephone to display. All
downloadable language files contain all the information needed for the telephone to present the
language as part of the screen display.

Language Files
All SIP language files are suffixed with an .xml file extension, and must include the UTF-8
encoding at the top of each document.
To use the language feature with the 9600 Series IP Telephone:
1. Create an xml language file
2. Copy the file to your HTTP or HTTPS server
3. Ensure the url in the settings file links to the absolute path of the language file.
The file is then downloaded by the 9600 Series IP phone.
Note:
Note: Specifying a language other than English in the configuration file has no impact
on Avaya Communication Manager settings, values, or text strings.

26 Avaya 9600 Series SIP IP Telephone Developer Guide


Language Support

Support Multiple Languages on the Customized Screen


The Language Resource defines the language translations depending on the phone’s local
language settings. It maps a phrase into one or more languages. Any Labels within the IPTML
document referencing this phrase is mapped into its language value corresponding to the
phone’s language setting. For instance, if you change your phone's language to Chinese, you
will naturally want the customized screen to display in Chinese.
IPTML allows you to bind a Language Resource to an IPTML document. A Language Resource
is a 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>
Below is a sample Chinese Resource Document

Issue 1 September 2008 27


Customizing the Content

Bind the Language Resource


The example below shows how to bind the English and Chinese language resources to the
IPTML document.
<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


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:
Note: When the language of the phone changed, the customized display screen will
change accordingly. If it cannot find a language that the phone uses, it will use
the default language. The language name defined in

<data name="languageName"><value>English</value></data>

must match to the language name in the 46xx language file.

Issue 1 September 2008 29


Customizing the Content

Utilizing the Go Command to Launch an Application


As described in Action Elements the Go element can be used to:
● navigate to a card
● launch an application
● open a url in the WML browser

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

The following examples show different uses of the Go element.

Navigate to a card
<Item>
<Label>CardX</Label>
<Actions>
<Go>
<CardName>CardNumber1</CardName>
</Go>
</Actions>
</Item>

30 Avaya 9600 Series SIP IP Telephone Developer Guide


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 31


Customizing the Content

32 Avaya 9600 Series SIP IP Telephone Developer Guide


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. Press the A menu button on the phone (between the Contact and Log buttons)
2. Select Options & Settings > Screen & Sound Options from the menu
3. Navigate to the Skin option and select the desired screen.
4. Click Save.

Using the 46xxSettings.txt file to Modify the Skin


The following example configures the 46xxsettings.txt file so that a customized skin can be
referenced and added to the phone display.

Tip:
Tip: The 9600template.zip file contains sample skin files.
1. Download the 46xxsettings.txt and 96xxupgrade.txt from the Avaya Support Web site.
2. Use a text editor to open the 46xxsettings.txt file.
3. Find the 9640 settings section, similar to the following:
############################################################
#
# SETTINGS9640
#
############################################################

Issue 1 September 2008 33


Customizing the Skin

4. Copy the following text into the settings file and replace the IP address 135.27.66.138
with your HTTP web server IP address.
The example below shows two available skins, with company_red selected as the
preferred skin.
a. Replace company_red and company_blue with the name of your skins.
SET SKINS "company_red=http://135.27.67.138/skins/company_red/
9640.xml,company_blue=http://135.27.67.138/skins/company_blue/
9640.xml"
SET CURRENT_SKIN "company_red"
SET CURRENT_CONTENT "http://135.27.67.138/content.xml"

! Important:
Important: The SET SKINS value must be on one line.
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.
You will need to modify the 9640.xml file to customize the skin of your IP phone. This file is
available from the Avaya Support Web site:
In addition, there are five image files which are referenced by the 9640.xml file:
- appline_off.jpg
- appline_on.jpg
- background.jpg
- logo.jpg
- softkey.jpg

Image Dimensions
Use an image editor to create each image.

! Important:
Important: Each image must be saved as a JPEG file, using the extension jpg.
The size and purpose of each image is listed below:

34 Avaya 9600 Series SIP IP Telephone Developer Guide


Create a Skin

File Name Image Size Purpose


(in pixels)

background.jpg width: 320 Covers the entire background area of the


height: 240 display

appline_on.jpg width: 297 Image displays over a selected menu item


height: 20
appline_off.jpg width: 297 Image displays over menu items when they
height: 20 are not selected

softkey.jpg width: 73 Image displays over softkey menu buttons


height: 20
logo.jpg width: 180 Optional image that can be integrated into
height: 40 the display

Renaming Image File Names


If you create new images, the simplest method is to use the file names listed above since the
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)
● menu_highlight.jpg (rather than appline_on.jpg)
● menu_normal.jpg (rather than appline_off.jpg)
● softkey_highlight.jpg (rather than softkey.jpg)
● company_logo.jpg (rather than logo.jpg)

Issue 1 September 2008 35


Customizing the Skin

The 940.xml file would display as follows:


<skin>
<components>
<logo>
<img src="company_logo.jpg" />
</logo>
<background>
<img src="layer1.jpg" width="100%" height="100%"
transparent="false" />
</background>
<topLine>
<img src="layer1.jpg" width="100%" height="100%" srcx="1"
srcy="1" transparent="false" />
</topLine>
<titleLine textColor="90,77,51">
<img src="layer1.jpg" width="100%" height="100%" srcx="1"
srcy="25" transparent="false" />
</titleLine>
<promptLine textColor="90,77,51">
<img src="layer1.jpg" width="100%" height="100%" srcx="1"
srcy="47" transparent="false" />
</promptLine>
<appLine>
<img src="menu_normal.jpg" width="8" height="100%" />
<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


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" width="100%" height="100%"
transparent="false" />
</softkey>
<popup textColor="black">
<roundedrect width="100%" height="100%" ellipseSize="21"
border="1" color="white" borderColor="black" />
</popup>
<infoArea textColor="black">
<roundedrect width="100%" height="100%" ellipseSize="21"
color="white" />
</infoArea>
<scrollbar textColor="white" />
</components>
<layout />
</skin>

Issue 1 September 2008 37


Customizing the Skin

Positioning the Logo


While the use of the logo.jpg file is optional, there are some factors you need to consider to
ensure the image is positioned on the correct area of the screen. You can specify the exact
location of the image by adding a horizontal and vertical attribute value to the logo element in
the 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.

In addition to the logo image file being 180 x 40 (pixels), the value of the:
● x coordinate cannot be greater than 320.
● y coordinate cannot be greater than 240.

! Important:
Important: The logo image will not be displayed if it is not positioned within the x and y
coordinates above.
For example, the following refernce to the logo in the 9640.xml file is allowed:
<logo>
<img src="logo.jpg" x="0" y="96"/>
</logo>

Tip:
Tip: You may need to experiment with the x and y values, as the size of the width and
height of the logo file affect the exact positioning on the screen.

38 Avaya 9600 Series SIP IP Telephone Developer Guide


Create a Skin

Screen Size for Avaya 9600 Series IP Phones


The size of the 9600 Series IP Phones are listed below:
Note:
Note: The Avaya 9610 IP Phone is not listed here since it does not support the features
described in this document.

Phone Screen Size


(in pixels)

9620 IP Phone width: 320


height: 160
9630 IP Phone width: 320
height: 240
9640 IP Phone width: 320
height: 240

Tip:
Tip: Refer to the 9600 Series IP Telephones Application Programmer Interface (API)
Guide from the Avaya support Web site: http://www.avaya.com/support for more
information about editable display areas.

Issue 1 September 2008 39


Customizing the Skin

40 Avaya 9600 Series SIP IP Telephone Developer Guide


Chapter 4: 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)
● logical structure
● syntax
● nesting of elements
● contents of elements
● attributes

Installing the Avaya 9600 XML Validator


Before installing the Validator, ensure:
● Microsoft Windows XP is the operating system
● You have administrative rights on the local computer to run the executable file
● The Microsoft .NET Framework Version 2.0 is installed
To install the Validator:
1. Download the Avaya 9600 XML Validator setup file, setup.exe, from the Avaya Support
Web site: http://www.avaya.com/support
2. Extract the zip file to a temporary directory
3. Double-click setup.exe to start the installation
4. Follow the prompts.
The Avaya 9600 XML Validator application displays.

Issue 1 September 2008 41


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


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:
Note: To ensure you have the latest functionality available, the application connects to
the Avaya Support Web site each time you start a new session. Some screens or
menu items may appear slightly different from the image on this page.

Issue 1 September 2008 43


Validate the Content and Skin Files

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.
Log Menu
Use the Log menu to view or export a log file as a text file.

Action Pane
The Actions Pane allows you to load the content or skin xml file and run the validation.

Text Editor
The Text Editor area allows you to make changes to an xml file. It provides many of the features
available in common text editors. Text can be entered directly into the Text editor or it can be
copy-pasted from an XML editor of your choice.

Tip:
Tip: Further options, such as Undo, are available through the Edit menu.

Status Pane
Once an xml file has been examined by the Validator, any errors or warnings are displayed in
the Status Pane.
An Error indicates that validation has failed, and that the XML file will not be successfully
loaded onto the phone.
A Warning indicates that the XML file will be able to be loaded onto the phone, but the XML
files may not be displayed as intended.

! Important:
Important: Only one error or warning displays in the Status Pane. it is recommended you
routinely inspect the log file using the Log > View Log menu item to canvass all
identified errors and warnings.

44 Avaya 9600 Series SIP IP Telephone Developer Guide


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.

Issue 1 September 2008 45


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


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:
Tip: Alternatively, you can fix the problem displayed in the Status Pane and click
Validate. Continue to do this until the Severity column indicates a status of
Success.

Issue 1 September 2008 47


Validate the Content and Skin Files

48 Avaya 9600 Series SIP IP Telephone Developer Guide


Appendix A: IPTML Reference

Introduction
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 49


IPTML Reference

IPTML Components

Component Definition Attributes Example

Card Elements are the name - a unique <Label>Concierge</Label>


Element logical constructs of name to identify
an IPTML document. the card
It comprises of start
and end tags that
surround content, root - set to true to
other elements, or indicate this card
both. The tags of an is the default card
element are delimited for the phone to
by angle bracket. display. When the
phone loads the
A Card element can IPTML document,
contain a Label, List, it will display the
softkeys and more. card which has a
value of
Cards can be related root="true". The
to each using the default value for
<NextCardName> or root is false. If root
<PrevCardName> is not present, the
element. value is false.
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


IPTML Components

Component Definition Attributes Example

Label A Label element can topline: consists The example below will
Elements be positioned below of the actual text display the Welcome
an IPTML element, or message to message on the Title
Card element. The display on the Line of the phone
Label element is used telephone’s top
to define text for the line <Label
Top Line, Title Line id="titleline">
and Prompt Line. titleLine: the Welcome to Avaya
second line, </Label>
If the Label element specifies the
appears under an current
IPTML element, it application, and a
provides a default subtitle if one
Label for all the Cards exists. The
in the document. If a subtitle typically
card does not contain changes from
a Label, it will use the screen to screen
default Label, as within an
defined under the application to
IPTML element. reflect changes in
context caused
If a Label element either by user
appears under a Card actions or by
element, it overrides other events.
the default Label
under IPTML promptLine:
element. used by the
current
application to
provide
context-specific
prompts, hints,
explanations,
help, or similar
information.
Application
specific help
messages are
managed by each
application.
2 of 4

Issue 1 September 2008 51


IPTML Reference

Component Definition Attributes Example

Item The Item element is <List


Element the most frequently id="softkeys">
used element in an
IPTML document. It
can refer to an
application line, a
softkey, or a hard
button on the IP
phone.
List IDs Identify the list and The value can be <List
the values it contains. either appLines, id="appLines">
softkeys, or
hardButtons.
Normally, a Card
element
comprises of two
lists; one list
defines the
application lines,
and another list
defines the
softkeys.
Action An IPTML Element <Actions
Elements contains a sequence trigger="OnActivat
of zero or more e">
Actions. The Action <Dial>40687</Dial>
element defines the </Actions>
actions associated
with an Item. Each
action is triggered by <Actions
an Event and has an trigger="OnActivat
attribute specifying e">
what initiates it. An <Go>
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


IPTML Components

Component Definition Attributes Example

Events Events trigger Actions OnFocus: line <Actions


and contain an appearance trigger="OnFocus">
attribute to specify comes into focus
how those Actions are <DisplayLabel>Call a
triggered. OnActivate: line maid to clean the
appearance is room
selected </DisplayLabel>
</Actions>
OnPassword:
user enters a
password <Actions
trigger="OnActivate"
>
<Dial>70921</Dial>
</Actions>

<Actions
trigger="OnPasswor
d"
password="1234">
<Go><CardName>
SecondCard
</CardName></Go>
</Actions>

4 of 4

Issue 1 September 2008 53


IPTML Reference

IPTML Schema
The schema describes the structure, and defines the legal building blocks, of the IPTML
document.
The Avaya 9600 XML Validator allows you to view the content 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.

54 Avaya 9600 Series SIP IP Telephone Developer Guide


x

Index

Index

Numerical F
9600template.zip . . . . . . . . . . . . . . . . 18, 33 Features in SIP 2.2 . . . . . . . . . . . . . . . . . 13
9640.xml file . . . . . . . . . . . . . . . . . . . . 35

G
A Glossary . . . . . . . . . . . . . . . . . . . . . . .7
Action Elements . . . . . . . . . . . . . . . . . . 23 Go Command
Avaya 9600 Series IP Phones launch an application . . . . . . . . . . . . . . 31
languages supported . . . . . . . . . . . . . . 27 navigate to a card . . . . . . . . . . . . . . . . 30
screen sizes . . . . . . . . . . . . . . . . . . 39 open a url in the WML browser . . . . . . . . . . 31
Avaya 9600 XML Validator to launch an application . . . . . . . . . . . . . 30
action pane . . . . . . . . . . . . . . . . . . . 44
editing xml files . . . . . . . . . . . . . . . . . 45
installing . . . . . . . . . . . . . . . . . . . . 41 H
log file . . . . . . . . . . . . . . . . . . . . . 47 Hard Buttons
menu items . . . . . . . . . . . . . . . . . . . 44 remapping . . . . . . . . . . . . . . . . . . . 24
status pane . . . . . . . . . . . . . . . . . . . 44 Hardware . . . . . . . . . . . . . . . . . . . . . 13
text editor . . . . . . . . . . . . . . . . . . . 44

I
B
Images
Bind the Language Resource . . . . . . . . . . . . 28 dimensions . . . . . . . . . . . . . . . . . . . 34
renaming . . . . . . . . . . . . . . . . . . . . 35
images
C logo.jpg . . . . . . . . . . . . . . . . . . . . . 38
Card Elements . . . . . . . . . . . . . . . . . . . 21 IP Telephone Interfaces . . . . . . . . . . . . . . . 13
attributes . . . . . . . . . . . . . . . . . . . . 22 IPTML
syntax . . . . . . . . . . . . . . . . . . . . . 21 action elements . . . . . . . . . . . . . . . . . 23
Configuring XML Settings Files . . . . . . . . . . . 15 card elements . . . . . . . . . . . . . . . . . . 21
overview . . . . . . . . . . . . . . . . . . . . 16 item elements . . . . . . . . . . . . . . . . . . 22
Content label elements . . . . . . . . . . . . . . . . . 22
create customized . . . . . . . . . . . . . . . 18 overview . . . . . . . . . . . . . . . . . . . . 20
example content.xml file . . . . . . . . . . . . . 18 structure . . . . . . . . . . . . . . . . . . . . 21
Customizing ISO/IEC, ANSI/IEEE Documents . . . . . . . . . . 10
Avaya SIP IP Phone . . . . . . . . . . . . . . 14 Item Elements . . . . . . . . . . . . . . . . . . . 22
ITU Documents. . . . . . . . . . . . . . . . . . . 10

D
Disabling Functions of Hard Buttons . . . . . . . . 24 J
Documentation JPEG
Related . . . . . . . . . . . . . . . . . . . . 10 file names. . . . . . . . . . . . . . . . . . . . 34
image sizes . . . . . . . . . . . . . . . . . . . 34

E
Editing XML Files L
using Avaya 9600 XML Validator . . . . . . . . 45 Label Elements . . . . . . . . . . . . . . . . . . . 22
Enable Customization . . . . . . . . . . . . . . . 17 attribute. . . . . . . . . . . . . . . . . . . . . 22

Issue 1 September 2008 55


Index

Languages using the log . . . . . . . . . . . . . . . . . . 47


binding . . . . . . . . . . . . . . . . . . . . . 28 window . . . . . . . . . . . . . . . . . . . . . 43
files . . . . . . . . . . . . . . . . . . . . . . 26
supported . . . . . . . . . . . . . . . . . . . 27
Launch an Application . . . . . . . . . . . . . . . 31
List IDs . . . . . . . . . . . . . . . . . . . . . . 22
Logo
positioning . . . . . . . . . . . . . . . . . . . 38
x and y coordinates . . . . . . . . . . . . . . . 38

N
Navigate to a card . . . . . . . . . . . . . . . . . 30

O
Open a URL in the WML Browser . . . . . . . . . . 31

P
Prerequisites
Hardware . . . . . . . . . . . . . . . . . . . 13
Software . . . . . . . . . . . . . . . . . . . . 13
Push Feature
uses . . . . . . . . . . . . . . . . . . . . . . 15

S
Skin
images . . . . . . . . . . . . . . . . . . . . . 34
Software . . . . . . . . . . . . . . . . . . . . . 13

T
Terms Used in This Document . . . . . . . . . . . . 7
Troubleshooting the Push Interface . . . . . . . . . 33

U
Using a Password to Hide Screens . . . . . . . . . 25
Utilizing the Go Command to Launch an Application . 30

V
Validate the Content and Skin Files . . . . . . . . . 41
Validator
action pane . . . . . . . . . . . . . . . . . . . 44
editing xml files . . . . . . . . . . . . . . . . . 45
installing . . . . . . . . . . . . . . . . . . . . 41
menu items . . . . . . . . . . . . . . . . . . . 44
starting . . . . . . . . . . . . . . . . . . . . . 42
status pane . . . . . . . . . . . . . . . . . . . 44
text editor . . . . . . . . . . . . . . . . . . . 44

56 Avaya 9600 Series SIP IP Telephone Developer Guide

Potrebbero piacerti anche