Polycom SIP 2.2.0 Instruction Manual

August, 2007 Edition

1725-17693-210 Rev. A

SIP 2.2.0

Web Application Developer’s Guide

for the SoundPoint®

IP/SoundStation®IP Family

SIP 2.2.0

Polycom Inc.

4750 Willow Road

Pleasanton, CA 94588-2708

USA

No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for

any purpose, without the express written permission of Polycom, Inc. Under the law, reproducing includes translating

into another language or format.

As between the parties, Polycom, Inc. retains title to, and ownership of, all proprietary rights with respect to the software

contained within its products. The software is protected by United States copyright laws and international treaty

provision. Therefore, you must treat the software like any other copyrighted material (e.g. a book or sound recording).

Every effort has been made to ensure that the information in this manual is accurate. Polycom, Inc. is not responsible

for printing or clerical errors. Information in this document is subject to change without notice.

Trademark Information

Polycom®, the Polycom logo design, SoundPoint® IP, SoundStation®, SoundStation VTX 1000®, ViaVideo®,

ViewStation®, and Vortex® are registered trademarks of Polycom, Inc. Conference Composer™, Global Management

System™, ImageShare™, Instructor RP™, iPower™, MGC™, PathNavigator™, People+Content™, PowerCam™,

Pro-Motion™,QSX™,ReadiManager™,Siren™,StereoSurround™,V2IU™, VisualConcert™,VS4000™,VSX™,and

the industrial design of SoundStation are trademarks of Polycom, Inc. in the United States and various other countries.

All other trademarks are the property of their respective owners.

Patent Information

The accompanying product is protected by one or more U.S. and foreign patents and/or pending patent applications

held by Polycom, Inc.

iii

About This Guide

The Developer’s Guide for the SoundPoint IP / SoundStation IP family is for

developers of applications which use the Microbrowser on SoundPoint IP /

SoundStation IP phones.

The following related documents for SoundPoint IP / SoundStation IP family

are available:

•Quick Start Guides, which describe how to assemble the phones

•Quick User Guides, which describe the most basic features available on

the phones

•User Guides, which describe the basic and advanced features available on

the phones

•Administrator’s Guide, which describes how to configure, customize,

manage, and troubleshoot SoundPoint IP / SoundStation IP phone

systems

•Technical Bulletins, which describe workarounds to existing issues

•Release Notes, which describe the new and changed features and fixed

problems in the latest version of the software

For support or service, please contact your Polycom®reseller or go to Polycom

Technical Support at http://www.polycom.com/support/voip/.

Polycom recommends that you record the phone model numbers, software

(both the bootROM and SIP), and partner platform for future reference.

SoundPoint IP / SoundStation IP models: ___________________________

BootROM version: ________________________________________________

SIP Application version: ___________________________________________

Partner Platform: _________________________________________________

Developer’s Guide SoundPoint IP / SoundStation IP

Contents

About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii

1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–1

What is the Microbrowser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–1

What is XHTML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–2

How to Create Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–3

2 Application Development . . . . . . . . . . . . . . . . . . . . . . . . . . 2–1

Supported XHTML Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–1

Basic Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–2

Link Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–3

Input Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–3

Image Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–6

Table Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–7

Meta Information Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–9

HTTP Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–9

Microbrowser User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–10

Launching the Microbrowser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–11

Navigation and Form Editing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–11

Idle Display Microbrowser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–12

Developing an XHTML Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–12

Changing Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . 2–12

Sample Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–13

3 Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–1

XML Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–1

A Appendix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A–1

Unsupported XHTML Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A–1

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Index–1

Developer’s Guide SoundPoint IP / SoundStation IP

1 - 1

Overview

This chapter provides an overview of the Microbrowser available on

SoundPoint IP 330/320, 430, 501, 550, 600, 601, and 650 desktop phones and

SoundStation IP 4000 conference phone.

It also provides an introduction to XHTML and guidelines for the application

development.

This chapter contains information on:

•What is the Microbrowser

•What is XHTML

•How to Create Applications

To develop an application that can run on the Microbrowser, refer to

Application Development on page 2-1. To troubleshoot any problems with

your applications, refer to Troubleshooting on page 3-1.

What is the Microbrowser

The Microbrowser is like any Web browser—Microsoft Internet Explorer and

Firefox, for example—but supports only a subset of XHTML features. It can

connect to Web servers hosted in the Internet or intranet and download

XHTML pages. The Microbrowser supports a limited number of XHTML 1.0

features—it does not have full Web browser functionality.

The Microbrowser downloads XHTML content from a Web server into the

phone’s memory, then parses the content to identify XHTML tags and renders

these tags onto the phone's graphic display. The appearance of the rendered

page depends on the graphical capabilities and display size of the device on

which the browser is running. Complicated pages should be avoided on

devices with very small displays.

The Microbrowser does not support scripting (such as JavaScript). All actions

on data entered into forms is processed by the server using POST or GET

methods.

Developer’s Guide SoundPoint IP / SoundStation IP

1 - 2

The XHTML pages displayed on the Microbrowser can contain static or

dynamic information.

Static XHTML. These pages are created using XHTML editors and hosted by

the Web server. These pages are accessed from the Microbrowser (using HTTP

protocol) by entering the URL to access the page. These XHTML pages are

called static, because the information that is displayed is already coded into

the XHTML pages. These pages do not include information that keep changing

or contact other services for update.

Dynamic XHTML. These pages involves dynamic information updates of

XHTML pages by an application hosted on the Web server. The application

residing on the Web server will get information from an intranet or through

the Internet—data service providers like Yahoo, Exchange Server, Call Control

Servers and other enterprise servers.

Users can launch the Microbrowser on a SoundPoint IP or SoundStation IP

phone by pressing the Services key, or if there isn’t one on the phone, it can be

accessed through the Menu key by selecting Features, and then Applications.

The Microbrowser is supported on:

•SoundPoint IP 330/320 - screen resolution - 102*22 pixels (3” by 1”)

•SoundPoint IP 430 – screen resolution – 132*46 pixels (3.5”*1.5”)

•SoundPoint IP 501 – screen resolution – 160*80 pixels (4” by 2”)

•SoundPoint IP601/650 – screen resolution – 320*160 pixels (4” by 2”)

•SoundPoint IP 4000 – screen resolution – 240*68 pixels (2.4”*0.8”)

What is XHTML

XHTML is the abbreviation of eXtensible HyperText Markup Language.

XHTML 1.0 is a transformation of HTML 4.01 into valid XML. The use of the

stricter XML syntax makes parsing of XHTML much easier for small clients,

but XHTML 1.0 was also the first step towards making HTML easily

extensible. Moving to XML allowed the methods used to create XML

extensions to apply to HTML as well. Step two occurred with XHTML 1.1,

where XHTML was divided up into ‘modules’, where any features above and

beyond a skeleton set were grouped into individual modules. User agent (UA)

developers could then decide which extensions to support. A simple user

agent can be considered a fully compliant user agent by supporting only the

Basic module, whereas a more powerful browser can support all the official

modules, as well as those developed by third parties.

Note As of SIP 2.2, the Services key and menu entry were renamed Applications,

however the functionality remains the same.

Overview

1 - 3

Modularization is also intended to help content creators. As more and more

devices become web-enabled, the number of platforms a content creator will

be asked to support will become unreasonable. By dividing HTML up into

different ‘building blocks’ content creators can supply a minimal version of

their site for user agents that only support the Basic module, a moderate

version of their site for user agents who support the additional modules, and

a full version of their site for user agents that support the full range of the

XHTML specification.

Finally the X in XHTML was intended to help people who wish to extend

HTML. The use of XML brought a standard grammar with which they could

define their extension, and the modularization meant that their extension

would be just another module that a user agent developer or content creator

could choose to support. Additionally, since XHTML pages should state what

modules are required to accurately render them, the user agent software could

dynamically load a ‘plug-in’ that it could use to render a module that was

defined after the user agent had been originally released.

For more information, go to:

•HTML 4.0—http://www.w3.org/TR/1999/REC-html401-19991224

•XHTML™ 1.0—http://www.w3.org/TR/2002/REC-xhtml1-20020801

•XHTML™

Basic—http://www.w3.org/TR/2000/REC-xhtml-basic-20001219/

•XHTML™ 1.1—http://www.w3.org/TR/2001/REC-xhtml11-20010531/

•XHTML Tables Module -

XHTML™2.0—http://www.w3.org/TR/2004/WD-xhtml2-20040722/m

od-tables.html

For the purposes of this guide, it is assumed that you have experience in

HTML and XHTML programming or access to someone who has such

experience.

How to Create Applications

You can design the following types of applications:

•Web browser

•Company directory

•Stock ticker

Developer’s Guide SoundPoint IP / SoundStation IP

1 - 4

Depending on the type and complexity of the application, you might use one

of the following tools for creation:

•Text editor

•XML editor

•Microsoft Word

When designing applications, you might want to consider the following

guidelines:

1. Spend sufficient time designing the application by:

—Developing a conceptual design

—Describe all user-application interactions

—Plan for all user types

2. Create standardized applications to assist in:

—Lowering design time

—Speed up debugging

—Increasing usability

3. Promote consistent output and predictable user input.

4. Create a prototype application to test on sample users.

5. Thoroughly test your application before releasing to:

—Identify all user interface issues

—Verify that all error conditions are caught cleanly

For step-by-step instructions on how to develop an XHTML application that

can be run on the Microbrowser of all SoundPoint IP and SoundStation IP

phones, refer to Application Development on page 2-1.

Note These guidelines are for your information only. You are solely responsible for

determining the suitability and applicability of this information to your needs.

Note Polycom is not responsible for troubleshooting any programming that you create for

the Microbrowser.

Other manuals for SIP 2.2.0

This manual suits for next models

Table of contents

Other Polycom Conference System manuals

Polycom

Polycom V500 User manual

Polycom

Polycom SoundStation 2W Service manual

Polycom

Polycom RPX HD 400 Series How to use

Polycom

Polycom ViewStation SP User manual

Polycom

Polycom SpectraLink 6000 System User manual

Polycom

Polycom RMX 1000 User manual

Polycom

Polycom RealPresence EduCart 500 Manual

Polycom

Polycom CX5500 Service manual

Polycom

Polycom SoundStructure C8 Installation and operating instructions

Polycom

Polycom V2IU 5300-E User manual

Polycom

Polycom SpectraLink 6000 System User manual

Polycom

Polycom HDX 4500 User manual

Polycom

Polycom iPower 900 Series Instruction Manual

Polycom

Polycom 1725-22886-001/A User manual

Polycom

Polycom RMX 1500 Datasheet

Polycom

Polycom G7500 How to use

Polycom

Polycom VSX 7000 Service manual

Polycom

Polycom realpresence trio 8800 User manual

Polycom

Polycom CX8000 Assembly instructions

Polycom

Polycom VIEWSTATION EX User manual

Polycom

Polycom VSX 3000 User manual

Polycom

Polycom VSX 5000 User manual

Polycom

Polycom CX7000 series User manual

Polycom

Polycom VIEWSTATION Setup guide

Popular Conference System manuals by other brands

Kramer

Kramer VIA GO quick start guide

AVT

AVT MAGIC AC1 Go Configuration guide

ProSoft Technology

ProSoft Technology AN-X4-AB-DHRIO user manual

Sony

Sony PCS-I150 Operation guide

Middle Atlantic Products

Middle Atlantic Products VTC Series instruction sheet

Prentke Romich Company

Prentke Romich Company Vanguard Plus Setting up and using

Speakerbus

Speakerbus iD 712 user guide

Trelleborg

Trelleborg SafePilot CAT PRO user guide

Sennheiser

Sennheiser ADN instruction manual

ADTRAN

ADTRAN NetVanta 7100 Configuration guide

AINA

AINA PTT Voice Responder quick guide

Yamaha

Yamaha ProjectPhone PJP-100H owner's manual

vissonic

vissonic VLI Series user manual

Panasonic

Panasonic KX-VC500 user manual

Poly

Poly Trio 8300 user guide

Crestron

Crestron Mercury CCS-UCA-SMK Do guide

Inmarsat

Inmarsat mini M manual

Tenveo

Tenveo ALL-IN-ONE manual