Polycom SIP 2.2.0 manual

November, 2007 Edition 1725-17693-210 Rev. A1 SIP 2.2.0 W eb 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 reproduce d or transmitted in any form or by any means, el ectronic or mechanical, for any purpose, without the express written permission of Polycom, Inc. Under the law, reprod ucing includ es translating into another language or format. As between the part[...]

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 Soun dPoint IP / SoundStation IP phones. The following relat ed documents for Soun dPoint IP / SoundStation IP family are available: • Quick Start Guides, which describe how to assemble the ph[...]

Developer’ s Guide SoundPoint IP / SoundStation IP iv[...]

v Contents About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii 1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–1 What is the Microbrowser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–1 What is XHTML . . . . . . . . . . . . . . . . . . . [...]

Developer’ s Guide SoundPoint IP / SoundStation IP vi[...]

1 - 1 1 Over view 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 Microb[...]

Developer’ s Guide SoundPoint IP / SoundStation IP 1 - 2 The XHTML pages displayed on the Micr obrowser can contain static or dynamic information. Static XHTML. These pages are created us ing XHTML editors and hoste d by the Web server. These pages are accessed from the Microbrowser (usin g HTTP protocol) by entering the URL to a ccess the page. [...]

Over view 1 - 3 Modularization is also intended to help content cr eators. As more and more devices become web-enabled, the number of platforms a content creator will be asked to support will become unreasonable. By dividi ng HTML up into different ‘building blocks’ content creators can supply a minimal version of their site for user agents tha[...]

Developer’ s Guide SoundPoint IP / SoundStation IP 1 - 4 Dependin g 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 applicati ons, you migh t want to consider the following guidelines: 1. Spend sufficient ti me designing the appl[...]

2 - 1 2 Application Development This chapter provides informati on on supported XHTML elements. It describes HTTP support and the Microbrows er user interface. It also describes the configuration parameters that can be found in sip.cfg . This chapter presents step-by-step in structions on how to develop an XHTML application that can be run on the M[...]

Developer’ s Guide SoundPoint IP / SoundStation IP 2 - 2 • Table Tags • Meta Information Tags Unsupported elements and attributes are de scribed in Unsupported XHTML Elements on page A-1 . Basic T ags The following basic tags are supported: • <!DOCTYPE> —Defines the document type • <!--...--> —Defines a comment <!DOCTYP[...]

Application Development 2 - 3 <!--...--> The comment tag is used to insert a comment in the source code. A comment will be ignored by the browser. You can use comments to explain your code , which can help you when you edit the source code at a later date. This tag does not have any attributes. Link T ags The following link tag is supported: [...]

Developer’ s Guide SoundPoint IP / SoundStation IP 2 - 4 <form> The form element creates a form for user input. A form can contain text fields, check boxes, radio buttons and more. Forms are used to pass user d ata to a specified URL. The following attributes are supported: Note The Microbrowser supports both the GET and POST methods for su[...]

Application Development 2 - 5 <input> The <input> tag defines the start of an input field where the user can enter data. In XHTML the <input> tag must be properly closed. The following attributes are supported: Attribute Va l ue / s Description checked checked Indicates that the input elem ent should be checked when it first loads[...]

Developer’ s Guide SoundPoint IP / SoundStation IP 2 - 6 Image T ags The following image t ag is supported: • <img> —Defines an image Various platforms have di ffering limits due to memory. There are also differing pixel limits for devices of di ffering pixel depth. A 1 bit per pixel image 160x80 requires only 1600 bytes. For a 24 bit p[...]

Application Development 2 - 7 Ta b l e Ta g s The following tabl e tags are supported: • <table> —Defines a table • <tr> —Defines a table row • <td> —Defines a table cell • <tbody> —Defines a table body <table> The <table> tag defines a table. Inside a <table> tag you can put table headers, [...]

Developer’ s Guide SoundPoint IP / SoundStation IP 2 - 8 <tr> This tag defines a row in a table. The following attributes are supported: <td> This tag defines a cell in a table. The following attributes are supported: Attribute Va l ue / s Description align right left center justify char Defines the text alignment in cells. Attribute [...]

Application Development 2 - 9 <tbody> This tag defines a table body. The thead, tfoot and tbody elements enable you to group rows in a tabl e. The following attributes are supported: Meta Information T ags The following meta information tags are supported: • <head> —Defines information about the document <head> The head elemen[...]

Developer’ s Guide SoundPoint IP / SoundStation IP 2 - 10 — Self-signed or custom CA certificates • There are the following exception s: — There is no sophisticated caching. The HTML cache refresh META tag is not supported. — Any images in the body of a document with the same URL are assumed to be the same image. Th e image is loaded from[...]

Application Development 2 - 11 • A n i n s t a n c e t h a t d o e s n o t s u p p o r t u s er input, but appears in a window on the idle display Launching the Microbrowser The first time the Services key is pressed, the main Microbrowser loads the home page specified in the mb.main.home configuration parameter. Subsequent presses of the Service[...]

Developer’ s Guide SoundPoint IP / SoundStation IP 2 - 12 When the user has focused on a link that they would like to follow, or a form element they would like to toggle, they press the Select key. This will either generate a request for the linke d page or toggle the selection of an element in the form. When the focus moves to fields which are e[...]

Application Development 2 - 13 3. Change mb.proxy t o t h e a d d r e s s o f t h e d e s i r e d H T T P p r o x y t o b e u s e d b y the Microbrowser. For example, mb.proxy=10.11.32.103:8080 where 10.11.32.103 is proxy server IP address and 8080 is the port number. 4. Change mb.idleDisplay.home to the URL used for Micr obrowser idle display home[...]

Developer’ s Guide SoundPoint IP / SoundStation IP 2 - 14 2. Configure the Web server to serve the above XHTML file. For example, if you are using Apache To mcat to try this example, then put this file into the webappsPLCM folder of Tomcat. 3. Configure SoundPoint IP and SoundStation IP phones to point to the XHTML file in the sip.cfg configurat[...]

Application Development 2 - 15 <?xml version="1.0" encoding ="iso-8859-1"?> <!DOCTYPE html PUBLIC "-//W3 C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1 /DTD/xhtml1-strict.dtd"> <%@page import="java.io.File,java.io .IOException,java.net.URL,java.a wt.image.B ufferedImage,javax.im[...]

Developer’ s Guide SoundPoint IP / SoundStation IP 2 - 16 5. Configure SoundPoint IP and SoundStation IP phones to point to the XHTML file in the sip.cfg configuration file. For this example, change mb.main.home to http://< WEBSERVER_ADDRESS : PORT >/PLCM/ AddStock.xhtml . 6. Reboot the phones. 7. On a SoundPoint IP phone, press the Servi c[...]

3 - 1 3 T roubleshooting This chapter presents problems, li kely causes, and corrective actions. Problems are grouped as follows: • XML Errors If you still need as sistance, c ontact your system administrator. XML Errors Symptom Problem Corrective Action Improperly formatted tables could cause the phone to stop and restart or display the error ?[...]

Developer’ s Guide SoundPoint IP / SoundStation IP 3 - 2[...]

A - 1 A Appendix This appendix provides information on unsupported XHTML elements. Unsuppor ted XHTML Elements The unsupported elements and attributes are: Ta g Ty p e T ag Description Basic T ags <html>—Defines HTML document. <body>—Defines docu ments’ body . <h1> to <h6>—Defines header 1 to header 6. <p>—De[...]

Developer’ s Guide SoundPoint IP / SoundStation IP A - 2 Output T ags <pre>—Defines preformatted text. <code>—Defines computer code text. <tt>—Defines teletype text. <kbd>—Defines keyboard text. <var>—Defin es a va ri ab l e. <dfn>—De fi ne s a de fi n i ti on te rm. <samp>—Defines sample co[...]

Appendix A - 3 Input T ags <form>—Defines a form. The following attributes ar e not supp orte d: accept, accept charset, enctype, target, class, id, style, title, dir , lang, and accesskey . <input>—Defines an input field. The following attributes are not su pported: accept, align, alt, disabled, maxlength , readonly , size, arc, ty[...]

Developer’ s Guide SoundPoint IP / SoundStation IP A - 4 Ta b l e Ta g s <table>—Defines a table. The following atrribu te s are not supported: bgcolo r , frame, rules, summary , id, cla ss, title, style, dir , lang, and xml:lang. <caption>—Defines a table caption. <col>—Defines attributes for table columns. <th>—D[...]

Appendix A - 5 Programming T ags <script>—Defines a script <noscript>—Defines a noscript section <applet>—Deprec ate d. Defines an applet <object>—Defi nes an embe dded object <param>—Defines a parameter for an object Ta g Ty p e T ag Description[...]

Developer’ s Guide SoundPoint IP / SoundStation IP A - 6[...]

Index – 1 Index A application development process 2–12 B basic tags supported 2–2 unsupported A–1 block tags unsupported A–2 C character format tags unsupported A–1 configuration parameters, changes t o 2–12 F frame tags unsupported A–2 H HTTP support 2–9 I image tags supported 2–6 unsupported A–3 input tags supported 2–3 un[...]

Developer’ s Guide SoundPoint IP / SoundStation IP Index – 2 X XHTML, definition 1–2[...]