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™,
2
Pro-Motion™, QSX™, ReadiManager™, Siren™, StereoSurround™, V
IU™, Visual Concert™, 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.
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.
About This Guide
The Developer’s Guide for the SoundPoint IP / SoundStation IP family is for
developers of applications which use the Web Server and 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 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: ___________________________
This chapter provides an overview of the Web Server and 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.
This chapter contains information on:
•What is the Microbrowser
•What is XHTML
•How to Create Applications
•New Features in SIP 3.1
To develop an application that can run on the Web Server and 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.
1 - 1
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. 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 Applications key, or if there isn’t one on the phone, it
can be accessed through the Menu key by selecting Applications.
Note
What is XHTML
As of SIP 2.2, the Services key and menu entry were renamed Applications,
however the functionality remains the same.
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 IP 550/560/601/650 — screen resolution – 320*160 pixels (4”
by 2”)
•SoundPoint IP 670 — screen resolution – 320*160 pixels (4” by 2”)
•SoundStation IP 4000/6000 — screen resolution – 240*68 pixels (2.4” by
0.8”)
•SoundStation IP 7000 — screen resolution – 255*128 pixels (3” by 1.5”)
XHTML is the abbreviation of eXtensible HyperText Markup Language.
1 - 2
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
Overview
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. 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 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 examples of applications:
•Web browser
1 - 3
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. 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.
1 - 4
Note
Polycom is not responsible for troubleshooting any programming that you create for
the Microbrowser.
New Features in SIP 3.1
The following new features were introduced in SIP 3.1:
•SoundPoint IP/SoundStation IP XML API Application
Interface—Expanded support in the Microbrowser for applications on the
SoundPoint IP 320/330, 430, 501, 550, 560, 650, and 670 desktop phones,
and SoundStation IP 4000, 6000, and 7000 conference phones. The
SoundPoint IP/SoundStation IP XML API is intended to provide
developers with flexibility in developing applications on SoundPoint IP
and SoundStation IP phones, while tightly integrating into the phone’s
telephony capabilities and functions.
Overview
1 - 5
Developer’s Guide SoundPoint IP / SoundStation IP
1 - 6
Application Development
This chapter presents step-by-step instructions on how to develop an XHTML
application that can be run on the Web Server and Microbrowser of certain
SoundPoint IP and SoundStation IP phones. It also describes the configuration
parameters that can be found in the sip.cfg configuration file.
This chapter contains information on:
•Supported XHTML Elements
•SoundPoint IP/SoundStation IP XML API Application Interface
•HTTP Support
•Microbrowser User Interface
2
•Developing an XHTML Application
To troubleshoot any problems with your applications, refer to
Troubleshooting on page 3-1.
Note
Polycom is not responsible for troubleshooting any programming that you create for
the Microbrowser.
Supported XHTML Elements
The Microbrowser supports a subset of XHTML elements. Most are derived
from HTML 4.01.
The supported elements and attributes are:
•Basic Tags
•Link Tags
•Input Tags
•Image Tags
•Table Tags
2 - 1
Developer’s Guide SoundPoint IP / SoundStation IP
•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
•<!--...-->—Defines a comment
<!DOCTYPE>
The <!DOCTYPE> declaration is the very first thing in your document, before
the <html> tag. This tag tells the browser which XHTML specification the
document uses. XHTML 1.0 specifies three XML document types: Strict,
Transitional, and Frameset.
•XHTML Strict
— Use this DTD when you want clean markup, free of presentational
clutter.
For example,
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
•XHTML Transitional
— Use this DTD when you need to use XHTML's presentational features.
For example,
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0
Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
•XHTML Frameset
— Use this DTD when you want to use frames.
For example,
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0
Frameset//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
XHTML 1.1 specifies one XML document type: Strict. For example,
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2 - 2
This tag does not have any attributes.
Link Tags
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.
The following link tag is supported:
•<a>—Defines an anchor
Note
The Microbrowser supports both
internal URIs. When a tel:// URL is selected, the phone switches to the telephony
application and dials the number specified in the URL. Currently the number is
dialed as-is, however, full support for tel:// URL parsing as specified in RFC 2806
will be available in a future release.
sip://
URLs are not supported at this time.
http://
and
tel://
URL schemes as well as
<a>
The <a> tag defines an anchor. An anchor can be used to create a link to
another document by using the
href
attribute.
The following attributes are supported:
AttributeValue/sDescription
hrefURL (Ex:” www.polycom.com”)The target URL of the link
namesection_nameNames an anchor. Use this
attribute to create a bookmark in a
document.
In future versions of XHTML the
name attribute will be replaced by
the id attribute.
Note: This attribute is parsed, but
not used.
Input Tags
The following input tags are supported:
•<form>—Defines a form
•<input>—Defines an input field
2 - 3
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>
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 data to a
specified URL.
The following attributes are supported:
AttributeValue/sDescription
actionURL
Ex: http://www.google.com
methodget
post
A URL that defines where to send
the data when the subm it butt on is
pushed
The HTTP method for sending
data to the action URL. Default is
get.
method="get": This method
sends the form contents in the
URL:
URL?name=value&name=value.
Note: If the form values contains
non-ASCII characters or exceeds
100 characters you MUST use
method="post".
method="post": This method
sends the form contents in the
body of the request.
2 - 4
nameform_nameDefines a unique name for the
form
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:
AttributeValue/sDescription
checkedcheckedIndicates that the input element
should be checked when it first
loads.
Note: Used with type="checkbox"
and type="radio"
namefield_nameDefines a unique name for the
input element.
Note: This attribute is required
with type="button",
type="checkbox", type="file",
type="hidden", type="image",
type="password", type="text", and
type="radio"
typecheckbox
hidden
password
radio
reset
submit
text
valuevalueFor buttons, reset buttons and
Indicates the type of the input
element. The default value is
"text".
submit buttons: Defines the text on
the button.
For image buttons: Defines the
symbolic result of the field passed
to a script.
For checkboxes and radio buttons:
Defines the result of the input
element when clicked. The result
is sent to the form's action URL.
For hidden, password, and text
fields: Defines the default valu e of
the element.
Note: Cannot be used with
type="file"
Note: This attribute is required
with type="checkbox" and
type="radio"
2 - 5
Developer’s Guide SoundPoint IP / SoundStation IP
Image Tags
The following image tag is supported:
•<img>—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.
•The SoundPoint IP 670 LCD supports 12-bit color.
Images can be scrolled up and down, however images that are too wide will
be truncated.
Various platforms have differing limits due to memory. There are also
differing pixel limits for devices of differing pixel depth. A 1 bit per pixel
image 160x80 requires only 1600 bytes. For a 24 bit picture, the memory
requirement is 38400 bytes.
There are several limits depending on the source data (this involves the cache
limits in configuration) and the display converted data, which is dependant on
available RAM (and is limited in the code depending on platform).
Note
<img>
The img element defines an image.
The "align", "border", "hspace", and "vspace" attributes of the image element are
not supported in XHTML 1.0 Strict DTD.
Specifies the height of the image
in pixel or percent.
Specifies the width of the image in
pixel or percent.
2 - 6
Tab le Tags
Application Development
The following table tags are supported:
•<table>—Defines a table
•<caption>—Defines a table caption
•<th>—Defines a table header
•<tr>—Defines a table row
•<td>—Defines a table cell
•<thead>—Defines a table header
•<tbody>—Defines a table body
•<tfoot>—Defines a table footer
Note
XHTML tables must be properly formatted (should include <tbody> and </tbody>
tags).
<table>
The <table> tag defines a table. Inside a <table> tag you can put table headers,
table rows, table cells, and other tables.
The following attributes are supported:
AttributeValue/sDescription
align Left
center
right
border Pixels (number, EX: “30” )Specifies the border width.
cellpaddingPixels (number, EX: “30” )
%
cellspacing Pixels (number, EX: “30” )
%
Aligns the table. Deprecated. Use
styles instead.
Tip: Set border="0" to display
tables with no borders!
Specifies the space between the
cell walls and contents
Specifies the space between cells.
width %
Specifies the width of the table
Pixels (number, EX: “30” )
2 - 7
Developer’s Guide SoundPoint IP / SoundStation IP
<caption>
This element defines a table caption. The <caption> tag must be inserted
immediately after the <table> tag. You can specify only one caption per table.
Usually the caption will be centered above the table. The “align” attribute of
the caption element is not supported in XHTML 1.0 Strict DTD.
The following attributes are supported:
AttributeValue/sDescriptionMB Support
align Left
right
top
bottom
idunique_nameDefines a unique name for the map
classclass_rule
style_rule
titletooltip_textA text to display in a tool tipNeed to verify
stylestyle_definitionAn inline style definitionNeed to verify
dirltr (left to right)
rtl (left to right)
langlanguage_code (Ex: EN,
deu/ger, hin)
xml:langlanguage_code (Ex: EN,
deu/ger, hin)
How to align the caption.
Deprecated. Use styles instead.
tag.
The class of the elementNeed to verify
Sets the text directionNeed to verify
Sets the language codeNeed to verify
Sets the language codeNeed to verify
Need to verify
Need to verify
<th>
This tag defines a table header cell in a table. The text within the th element
usually renders in bold. The “bgcolor”, “height”, “width”, and “nowrap”
attributes of the th element are not supported in XHTML 1.0 Strict DTD.
2 - 8
The following attributes are supported:
AttributeValue/sDescription
abbr abbr_textSpecifies an abbreviated version
of the content in a cell
align left
right
center
justify
char
axis category_namesDefines a name for a cell
Specifies the horizontal alignment
of cell content
AttributeValue/sDescription
Application Development
bgcolor rgb(x,x,x)
#xxxxxx
colorname
Specifies the background color of
the table cell. Deprecated. Use
styles instead.
char characterSpecifies which character to align
text on.
Note: Only used if align="char"!
charoff Pixels (number, EX: “30” )
%
Specifies the alignment offset to
the first character to align on.
Note: Only used if align="char"!
colspan numberIndicates the number of columns
this cell should span.
headers header_cells'_idA space-separated list of cell IDs
that supply header information for
the cell. This attribute allows
text-only browsers to render the
header information for a given cell.
height Pixels (number, EX: “30” )Specifies the height of the table
cell. Deprecated. Use styles
instead.
nowrap nowrapWhether to disable or enable
automatic text wrapping in this
cell. Deprecated. Use styles
instead.
rowspan numberIndicates the number of rows this
cell should span.
scope col
colgroup
row
rowgroup
Specifies if this cell provides
header information for the rest of
the row that contains it (row), or for
the rest of the column (col), or for
the rest of the row group that
contains it (rowgroup), or for the
rest of the column group that
contains it
valign top
middle
Specifies the vertical alignment of
cell content
bottom
baseline
width Pixels (number, EX: “30” )
%
Specifies the width of the table
cell. Deprecated. Use styles
instead.
idunique_nameDefines a unique name for the
map tag.
2 - 9
Developer’s Guide SoundPoint IP / SoundStation IP
AttributeValue/sDescription
classclass_rule
style_rule
titletooltip_textA text to display in a tool tip
stylestyle_definitionAn inline style definition
dirltr (left to right)
rtl (left to right)
langlanguage_code (Ex: EN, deu/ger,
hin)
xml:langlanguage_code (Ex: EN, deu/ger,
hin)
The class of the element
Sets the text direction
Sets the language code
Sets the language code
<tr>
This tag defines a row in a table.
The following attributes are supported:
AttributeValue/sDescription
align right
left
center
justify
char
Defines the text alignment in cells.
2 - 10
<td>
This tag defines a cell in a table.
The following attributes are supported:
AttributeValue/sDescription
align left
right
center
justify
char
colspan numberIndicates the number of columns
rowspan numberIndicates the number of rows this
Specifies the horizontal alignment
of cell content
this cell should span.
cell should span.
Loading...
+ 49 hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.