Polycom SIP 2.2.0 Developer's Manual

Sip 2.2.0 web application
Hide thumbs Also See for SIP 2.2.0:

Advertisement

Web Application Developer's Guide
®
for the SoundPoint
®
IP/SoundStation
IP Family
SIP 2.2.0
August, 2007 Edition
1725-17693-210 Rev. A
SIP 2.2.0

Advertisement

Table of Contents
loading

Summary of Contents for Polycom SIP 2.2.0

  • Page 1 Web Application Developer’s Guide ® for the SoundPoint ® IP/SoundStation IP Family SIP 2.2.0 August, 2007 Edition 1725-17693-210 Rev. A SIP 2.2.0...
  • Page 2 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.
  • Page 3: About This Guide

    ® 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: ________________________________________________...
  • Page 4 Developer’s Guide SoundPoint IP / SoundStation IP...
  • Page 5: Table Of Contents

    Contents About This Guide ....... . . iii 1 Overview ........1–1 What is the Microbrowser .
  • Page 6 Developer’s Guide SoundPoint IP / SoundStation IP...
  • Page 7: Overview

    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.
  • Page 8: What Is Xhtml

    Developer’s Guide SoundPoint IP / SoundStation IP 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.
  • Page 9: How To Create Applications

    Overview 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...
  • Page 10 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. Polycom is not responsible for troubleshooting any programming that you create for Note the Microbrowser. 1 - 4...
  • Page 11: Application Development

    Developing an XHTML Application To troubleshoot any problems with your applications, refer to Troubleshooting on page 3-1. Polycom is not responsible for troubleshooting any programming that you create for Note the Microbrowser. Supported XHTML Elements The Microbrowser supports a subset of XHTML elements. Most are derived from HTML 4.01.
  • Page 12: Basic Tags

    Developer’s Guide SoundPoint IP / SoundStation IP • Table Tags • Meta Information Tags Unsupported elements and attributes are described in Unsupported XHTML Elements on page A-1. Basic Tags The following basic tags are supported: • <!DOCTYPE>—Defines the document type •...
  • Page 13: Link Tags

    The following attributes are supported: Attribute Value/s Description href URL (Ex:” www.polycom.com”) The target URL of the link name section_name Names an anchor. Use this attribute to create a bookmark in a document.
  • Page 14 Developer’s Guide SoundPoint IP / SoundStation IP Note The Microbrowser supports both the GET and POST methods for submitting forms. Nesting forms within tables is supported. However, nesting of one form tag within another is not supported and may lead to unexpected results. <form>...
  • Page 15 Application Development <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 Value/s Description checked checked Indicates that the input element should be checked when it first loads.
  • Page 16: Image Tags

    Developer’s Guide SoundPoint IP / SoundStation IP Image Tags The following image tag is supported: • <img>—Defines an image Note The Microbrowser supports images stored in uncompressed .bmp format. While all BMP bit depths will be displayed to the best of the phone’s ability, it is recommended that the image format most suitable for the target platform be chosen.
  • Page 17: Table Tags

    Application Development Table Tags The following table tags are supported: • <table>—Defines a table • <tr>—Defines a table row • <td>—Defines a table cell • <tbody>—Defines a table body XHTML tables must be properly formatted (should include <tbody> and </tbody> Note tags).
  • Page 18 Developer’s Guide SoundPoint IP / SoundStation IP <tr> This tag defines a row in a table. The following attributes are supported: Attribute Value/s Description align right Defines the text alignment in cells. left center justify char <td> This tag defines a cell in a table. The following attributes are supported: Attribute Value/s...
  • Page 19: Meta Information Tags

    Application Development <tbody> This tag defines a table body. The thead, tfoot and tbody elements enable you to group rows in a table. The following attributes are supported: Attribute Value/s Description align right Defines the text alignment in cells. left center Meta Information Tags The following meta information tags are supported:...
  • Page 20: Microbrowser User Interface

    Developer’s Guide SoundPoint IP / SoundStation IP — Self-signed or custom CA certificates • There are the following exceptions: — 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.
  • Page 21: Launching The Microbrowser

    Application Development • An instance that does not support user input, but appears in a window on the idle display SoundPoint IP 430 SoundPoint IP 650 SoundPoint IP 501 SoundStation IP 4000 Launching the Microbrowser The first time the Services key is pressed, the main Microbrowser loads the homepage specified in the mb.main.home configuration parameter.
  • Page 22: Idle Display Microbrowser

    Developer’s Guide SoundPoint IP / SoundStation IP 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 linked page or toggle the selection of an element in the form.
  • Page 23: Sample Application

    Application Development 3. Change mb.proxy to the address of the desired HTTP proxy to be used by 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 Microbrowser idle display home page.
  • Page 24 Developer’s Guide SoundPoint IP / SoundStation IP 2. Configure the Web server to serve the above XHTML file. For example, if you are using Apache Tomcat to try this example, then put this file into the webapps\PLCM folder of Tomcat. 3.
  • Page 25 Application Development <?xml version="1.0" encoding="iso-8859-1"?> <!DOCTYPE html PUBLIC "-//W3C//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.awt.image.B ufferedImage,javax.imageio.ImageIO"%> <html> <head> <title>Stock Quote</title> </head> <body> <% // GETTING THE PATH WHERE BMP FILE HAS TO BE SAVED String bmpFilePath = application.getRealPath(File.separator) + "quote.bmp"; // DEFINE URL FROM WHERE CONTENT TO BE RETRIEVED String stockUrl = "http://ichart.yahoo.com/t?s=";...
  • Page 26 Developer’s Guide SoundPoint IP / SoundStation IP 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 Services (or Applications) key. The AddStock.xhtml appears on the graphic display.
  • Page 27: Troubleshooting

    Troubleshooting This chapter presents problems, likely causes, and corrective actions. Problems are grouped as follows: • XML Errors If you still need assistance, contact your system administrator. XML Errors Symptom Problem Corrective Action Improperly formatted tables A table tag was improperly Correct the improperly formatted table.
  • Page 28 Developer’s Guide SoundPoint IP / SoundStation IP 3 - 2...
  • Page 29: A Appendix

    Appendix This appendix provides information on unsupported XHTML elements. Unsupported XHTML Elements The unsupported elements and attributes are: Tag Type Tag Description Basic Tags <html>—Defines HTML document. <body>—Defines documents’ body. <h1> to <h6>—Defines header 1 to header 6. <p>—Defines a paragraph. <br>—Inserts a single line break.
  • Page 30 Developer’s Guide SoundPoint IP / SoundStation IP Tag Type Tag Description Output Tags <pre>—Defines preformatted text. <code>—Defines computer code text. <tt>—Defines teletype text. <kbd>—Defines keyboard text. <var>—Defines a variable. <dfn>—Defines a definition term. <samp>—Defines sample computer code. <xmp>—Deprecated. Defines preformatted text. Block Tags <acronym>—Defines an acronym.
  • Page 31 Appendix Tag Type Tag Description Input Tags <form>—Defines a form. The following attributes are not supported: accept, accept charset, enctype, target, class, id, style, title, dir, lang, and accesskey. <input>—Defines an input field. The following attributes are not supported: accept, align, alt, disabled, maxlength, readonly, size, arc, type:button, type:file, type:image, class, is, style, title, dir, lang, accesskey.
  • Page 32 Developer’s Guide SoundPoint IP / SoundStation IP Tag Type Tag Description Table Tags <table>—Defines a table. The following atrributes are not supported: bgcolor, frame, rules, summary, id, class, title, style, dir, lang, and xml:lang. <caption>—Defines a table caption. <col>—Defines attributes for table columns. <th>—Defines a table header.
  • Page 33 Appendix Tag Type Tag Description Programming Tags <script>—Defines a script <noscript>—Defines a noscript section <applet>—Deprecated. Defines an applet <object>—Defines an embedded object <param>—Defines a parameter for an object A - 5...
  • Page 34 Developer’s Guide SoundPoint IP / SoundStation IP A - 6...
  • Page 35: Index

    Index application development process 2–12 meta information tags supported 2–9 unsupported A–4 Microbrowser basic tags definition 1–1 supported 2–2 idle display 2–12 unsupported A–1 launching 2–11 block tags overview 1–1 unsupported A–2 Microbrowser <mb> 2–12 character format tags navigation and form editing 2–11 unsupported A–1 configuration parameters, changes to 2–12 output tags...
  • Page 36 Developer’s Guide SoundPoint IP / SoundStation IP unsupported attributes A–1 unsupported elements A–1 XHTML, definition 1–2 Index – 2...

Table of Contents