-
Web Application Developer’s Guide for the SoundPoint® IP/SoundStation® IP Family SIP 3.0.2 April, 2008 Edition 1725-17693-300 Rev. A SIP 3.0.
-
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™, Visual Concert™, VS4000™, VSX™, and the industrial design of SoundStation are trademarks of Polycom, Inc.
-
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.
-
Developer’s Guide SoundPoint IP / SoundStation IP iv
-
Contents About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii 1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–1 What is the Microbrowser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–1 What is XHTML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–2 How to Create Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
-
Developer’s Guide SoundPoint IP / SoundStation IP vi
-
1 Overview This chapter provides an overview of the Microbrowser available on SoundPoint IP 330/320, 430, 501, 550, 560, 600, 601, 650, and 670 desktop phones and SoundStation IP 4000, 6000, and 7000 conference phones. It also provides an introduction to XHTML and guidelines for the application development.
-
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. These XHTML pages are called static, because the information that is displayed is already coded into the XHTML pages.
-
Overview 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. Modularization is also intended to help content creators.
-
Developer’s Guide SoundPoint IP / SoundStation IP • Company directory • Stock ticker 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: Note These guidelines are for your information only. You are solely responsible for determining the suitability and applicability of this information to your needs. 1.
-
2 Application Development This chapter provides information on supported XHTML elements. It describes HTTP support and the Microbrowser user interface. It also describes the configuration parameters that can be found in sip.cfg . This chapter presents step-by-step instructions on how to develop an XHTML application that can be run on the Microbrowser of certain SoundPoint IP and SoundStation IP phones.
-
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: • —Defines the document type • —Defines a comment The declaration is the very first thing in your document, before the tag. This tag tells the browser which XHTML specification the document uses. XHTML 1.
-
Application Development 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 Tags The following link tag is supported: • Note —Defines an anchor The Microbrowser supports both http:// and tel:// URL schemes.
-
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.
-
Application Development The tag defines the start of an input field where the user can enter data. In XHTML the 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. Note: Used with type="checkbox" and type="radio" name field_name Defines a unique name for the input element.
-
Developer’s Guide SoundPoint IP / SoundStation IP Image Tags The following image tag is supported: • ![]()
—Defines an image 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. For example: • The SoundPoint IP 601 LCD supports four levels of grey, so a 16-color BMP format would be most appropriate.
-
Application Development Table Tags The following table tags are supported: Note •
—Defines a table • —Defines a table row • | —Defines a table cell • |
—Defines a table body XHTML tables must be properly formatted (should include and tags). The tag defines a table. Inside a tag you can put table headers, table rows, table cells, and other tables.
-
Developer’s Guide SoundPoint IP / SoundStation IP
This tag defines a row in a table. The following attributes are supported: Attribute Value/s Description align right left center justify char Defines the text alignment in cells. This tag defines a cell in a table.
-
Application Development 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 left center Defines the text alignment in cells.
-
Developer’s Guide SoundPoint IP / SoundStation IP — HTTP over SSL/TLS — 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. The image is loaded from the Microbrowser’s memory instead of making another request to the server.
-
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 Applications key is pressed, the main Microbrowser loads the home page specified in the mb.main.home configuration parameter. Subsequent presses of the Applications key simply toggle between the Microbrowser and SIP telephony applications.
-
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. When the focus moves to fields which are editable, the user may simply enter text at will, then move the focus to the next selectable item when complete using the up and down arrow keys.
-
Application Development To allow an application to be run from the Microbrowser: 1. Open a new configuration file in an XML editor. 2. Add the Microbrowser parameter. 3. Set 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. Set mb.idleDisplay.home to the URL used for Microbrowser idle display home page. For example, mb.idleDisplay.home=http://10.11.32.
-
Developer’s Guide SoundPoint IP / SoundStation IP To develop a static XHTML application: 1. Create a Sample.xhtml page with static information to be displayed. In this case, the static information will be "Hello World!". Sample Application HelloWorld! 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.
-
Application Development 2. Configure the Web server to serve the above XHTML file. For example, if you are using Apache Tomcat to try this example, put this file into the webapps\PLCM folder of Tomcat. 3. Write an application that is going to retrieve the stock information from a data service provider. For this example, this application will be retrieving stock information from Yahoo and will send it to the Microbrowser.
-
Developer’s Guide SoundPoint IP / SoundStation IP  |
