Administrator Guide
SoundPoint® IP SIP
Copyright © 2004 Polycom, Inc. All rights reserved.
Version 1.2.0
4 March 2004
Notices
1. Specifications subject to change without notice.
Polycom, Inc.
1565 Barber Lane, Milpitas CA 95035, USA
www.polycom.com
Part Number: 1725-11518-120 Rev A
Copyright © 2004 Polycom, Inc. All rights reserved.
Administrator Guide - SoundPoint® IP Table of Contents
Table of Contents
1 Overview ......................................................... 1
2 Installation and Operation ................................. 3
2.1 Installation Models ..................................................3
2.2 Installation Process..................................................4
2.2.1 Basic Network Setup....................................................................................................................... 4
2.2.1.1 DHCP or Manual TCP/IP Setup..............................................................................................5
2.2.1.2 Local User Interface Setup Menus ..........................................................................................6
2.2.1.3 Reset to Factory Defaults......................................................................................................9
2.2.2 Application Configuration................................................................................................................ 9
2.2.2.1 Centralized Configuration......................................................................................................10
2.2.2.2 Local Telephone Configuration...............................................................................................15
2.2.2.3 SIP Authentication Parameters...............................................................................................16
3 Features .......................................................... 17
3.1 Basic Features.........................................................17
3.1.1 Call Log ......................................................................................................................................... 17
3.1.2 Call Timer ...................................................................................................................................... 17
3.1.3 Call Waiting ................................................................................................................................... 17
3.1.4 Called Party Identification............................................................................................................... 17
3.1.5 Calling Party Identification.............................................................................................................. 18
3.1.6 Configurable Feature Keys.............................................................................................................. 18
3.1.7 Connected Party Identification ........................................................................................................ 21
3.1.8 Context Sensitive Volume Control.................................................................................................... 21
3.1.9 Customizable Audio Sound Effects................................................................................................... 21
3.1.10 Message Waiting Indication .......................................................................................................... 22
3.1.11 Distinctive Incoming Call Treatment............................................................................................... 22
3.1.12 Distinctive Ringing........................................................................................................................ 23
3.1.13 Distinctive Call Waiting ................................................................................................................. 23
3.1.14 Do-Not-Disturb............................................................................................................................. 24
3.1.15 Handset, Headset, and Speakerphone........................................................................................... 24
3.1.16 Local Contact Directory................................................................................................................. 25
3.1.16.1 Local Contact Directory File Format.......................................................................................26
3.1.17 Local Digit Map............................................................................................................................ 27
3.1.18 Microphone Mute ......................................................................................................................... 28
Copyright © 2004 Polycom, Inc. i
Administrator Guide - SoundPoint® IP Table of Contents
3.1.19 Multiple Call Appearances............................................................................................................. 28
3.1.20 Shared Call Appearances .............................................................................................................. 29
3.1.21 Customizable Fonts and Indicators................................................................................................. 30
3.1.22 Soft Key-Driven User Interface...................................................................................................... 31
3.1.23 Speed Dial ................................................................................................................................... 31
3.1.24 Time and Date Display.................................................................................................................. 32
3.2 Call Management Features........................................33
3.2.1 Automatic Off-hook Call Placement................................................................................................. 33
3.2.2 Call Hold........................................................................................................................................ 33
3.2.3 Call Transfer .................................................................................................................................. 34
3.2.4 Three-Way Conference, Local.......................................................................................................... 34
3.2.5 Call Diversion (Call Forward) .......................................................................................................... 34
3.3 Audio Processing Features ........................................35
3.3.1 Low-Delay Audio Packet Transmission............................................................................................. 35
3.3.2 Jitter Buffer and Packet Error Concealment ..................................................................................... 35
3.3.3 Local Conference Mixing................................................................................................................. 36
3.3.4 Voice Activity Detection (VAD)......................................................................................................... 36
3.3.5 DTMF Tone Generation ................................................................................................................... 37
3.3.6 DTMF Event RTP Payload ................................................................................................................ 37
3.3.7 Acoustic Echo Cancellation (AEC) ..................................................................................................... 37
3.3.8 Audio Codecs.................................................................................................................................. 38
3.3.9 Background Noise Suppression (BNS).............................................................................................. 39
3.3.10 Comfort Noise Fill......................................................................................................................... 39
3.3.11 Automatic Gain Control (AGC)....................................................................................................... 39
3.4 Presence and Instant Messaging Features ...................40
3.4.1 Presence........................................................................................................................................ 40
3.4.2 Instant Messaging .......................................................................................................................... 40
3.5 Localization Features ...............................................41
3.5.1 Multilingual User Interface ............................................................................................................. 41
3.5.2 Downloadable Fonts ....................................................................................................................... 43
3.5.3 Synthesized Call Progress Tones...................................................................................................... 43
3.6 Advanced Server Features ........................................43
3.6.1 Voicemail Integration ..................................................................................................................... 43
3.6.2 Multiple Registrations..................................................................................................................... 44
3.6.3 Server Redundancy ........................................................................................................................ 45
ii Copyright © 2004 Polycom, Inc.
Administrator Guide - SoundPoint® IP Table of Contents
3.6.3.1 DNS SIP Server Name Resolution...........................................................................................46
3.7 Accessory Internet Features.......................................46
3.7.1 Services Browser ............................................................................................................................ 46
3.8 Security Features.....................................................46
3.8.1 Local User and Administrator Privilege Levels.................................................................................. 46
3.8.2 Incoming Signaling Validation......................................................................................................... 47
4 Optimizing SoundPoint....................................... 49
4.1 Ethernet Switch .......................................................49
4.2 Application Network Setup .......................................49
4.2.1 RTP Ports....................................................................................................................................... 49
4.2.2 Working with Network Address Translation (NAT) ............................................................................50
4.3 Updating and Rebooting...........................................51
4.4 Event Logging .........................................................52
4.5 Audio Quality Issues and VLANs ................................53
4.5.1 IP TOS ........................................................................................................................................... 53
4.5.2 IEEE 802.1p/Q............................................................................................................................... 54
4.5.3 RTCP Support ................................................................................................................................. 54
4.6 Configuration Files...................................................55
4.6.1 Core Configuration - ipmid.cfg ........................................................................................................ 55
4.6.1.1 Localization <localization/> .................................................................................................55
4.6.1.2 User Preferences <user_preferences/> ..................................................................................59
4.6.1.3 Tones <tones/> .................................................................................................................60
4.6.1.4 Sampled Audio for Sound Effects <sampled_audio/> ..............................................................62
4.6.1.5 Sound Effects <sound_effects/>...........................................................................................63
4.6.1.6 Voice Settings <voice/> ......................................................................................................68
4.6.1.7 Quality of Service <QOS/> ..................................................................................................78
4.6.1.8 Basic TCP/IP <TCP_IP/>.....................................................................................................80
4.6.1.9 Web Server <HTTPD/>........................................................................................................82
4.6.1.10 Call Handling Configuration <call/>.....................................................................................83
4.6.1.11 Directory <directory/>.......................................................................................................84
4.6.1.12 Fonts <font/>..................................................................................................................85
4.6.1.13 Keys <keys/>..................................................................................................................88
4.6.1.14 Bitmaps <bitmaps/>.........................................................................................................91
4.6.1.15 Indicators <indicators/>.....................................................................................................92
4.6.1.16 Event Logging <logging/> .................................................................................................94
4.6.1.17 Security <security/> .........................................................................................................97
Copyright © 2004 Polycom, Inc. iii
Administrator Guide - SoundPoint® IP Table of Contents
4.6.1.18 Provisioning <provisioning/>..............................................................................................97
4.6.1.19 RAM Disk <RAMdisk/>......................................................................................................98
4.6.1.20 Request <request/>..........................................................................................................99
4.6.1.21 Feature <feature/>...........................................................................................................99
4.6.1.22 Resource <resource/>.......................................................................................................100
4.6.2 SIP Configuration - sip.cfg .............................................................................................................. 101
4.6.2.1 Protocol <volpProt/>...........................................................................................................101
4.6.3 Per-phone Configuration - phone1.cfg............................................................................................. 108
4.6.3.1 Registration <reg/> ............................................................................................................108
4.6.3.2 Calls <call/>......................................................................................................................110
4.6.3.3 Diversion <divert/>.............................................................................................................111
4.6.3.4 Dial Plan <dialplan/>..........................................................................................................113
4.6.3.5 Messaging <msg/> ............................................................................................................115
4.6.3.6 Network Address Translation <nat/> .....................................................................................116
4.6.3.7 User Preferences <user_preferences/> ..................................................................................117
5 Session Initiation Protocol (SIP)........................... 119
5.1 Basic Protocols ........................................................119
5.1.1 RFC and Internet Draft Support....................................................................................................... 119
5.1.2 Request Support............................................................................................................................. 119
5.1.3 Header Support.............................................................................................................................. 120
5.1.4 Response Support........................................................................................................................... 122
5.1.4.1 1xx Responses - Provisional ..................................................................................................122
5.1.4.2 2xx Responses - Success ......................................................................................................122
5.1.4.3 3xx Responses - Redirection..................................................................................................123
5.1.4.4 4xx Responses - Request Failure............................................................................................123
5.1.4.5 5xx Responses - Server Failure..............................................................................................124
5.1.4.6 6xx Responses - Global Failure ..............................................................................................124
5.1.5 Hold Implementation...................................................................................................................... 125
5.1.6 Reliability of Provisional Responses................................................................................................. 125
5.1.7 Transfer......................................................................................................................................... 125
5.1.8 Third Party Call Control................................................................................................................... 125
5.2 Protocol Extensions..................................................125
5.2.1 RFC and Internet Draft Support....................................................................................................... 126
5.2.2 Request Support............................................................................................................................. 126
5.2.3 Header Support.............................................................................................................................. 126
5.2.4 SIP for Instant Messaging and Presence Leveraging Extensions (SIMPLE).......................................... 126
5.2.5 Shared Call Appearance Signaling................................................................................................... 127
iv Copyright © 2004 Polycom, Inc.
Administrator Guide - SoundPoint® IP Overview
1 Overview
SoundPoint® IP is a feature-rich, enterprise-class voice communications terminal for
Ethernet TCPIP networks. It is designed to facilitate high-quality audio and text message communications. This telephone is an endpoint in the overall network topology
designed to interoperate with other compatible equipment including application servers, media servers, internetworking gateways, voice bridges, and other endpoints.
Remote
Boot Server
10/100
Ethernet
Switch
PC
Ethernet
Ethernet
Internet
C
789101112
123456
A
1x
C
789101112
123456
A
1x
A
A
Router /
Firewall
12x6x8x2x9x3x10x4x11x5x7x
12x6x8x2x9x3x10x4x11x5x7x
1x
B
Polycom
SoundPoint IP
500/600s
10/100
12x6x8x2x9x3x10x4x11x5x7x
12x6x8x2x9x3x10x4x11x5x7x
1x
B
Ethernet
Hub
IDC
C
789101112
Ethernet
123456
A
C
789101112
Ethernet
123456
A
Remote
Application
Server
12x6x8x2x9x3x10x4x11x5x7x
1x
1x
B
A
12x6x8x2x9x3x10x4x11x5x7x
1x
1x
B
A
PC
PSTN
PSTN
Gateway
Modem Bank
12x6x8x2x9x3x10x4x11x5x7x
Ethernet
12x6x8x2x9x3x10x4x11x5x7x
Switches
Voice Bridge
IDC
Local
Application
Server
Local
Boot Server
PC PC
SoundPoint® IP connects physically to a standard office twisted-pair (IEEE 802.3) 10/
100 megabytes per second Ethernet LAN and sends and receives all data using the
same packet-based technology. Since SoundPoint® IP is a data terminal, digitized
audio being just another type of data from the telephone’s perspective, SoundPoint® IP
is capable of vastly more than traditional business telephones. As SoundPoint® IP
runs the same protocols as your office personal computer, many innovative applica-
Copyright © 2004 Polycom, Inc. 1
Administrator Guide - SoundPoint® IP Overview
tions can be developed without resorting to specialized technology. Regardless of
SoundPoint® IP’s diverse application potential, it is fundamentally a good office tele-
phone, providing the productivity enhancing features needed today such as multiple
call appearances, full-duplex speakerphone, hold, transfer, conference, forward, voice
mail compatibility, and contact directory.
2 Copyright © 2004 Polycom, Inc.
Administrator Guide - SoundPoint® IP Installation and Operation
2 Installation and Operation
This section describes the basic steps that are needed to make your Soundpoint® IP
telephone operational.
2.1 Installation Models
SoundPoint® IP supports diverse installation models scaling from stand-alone telephones to large, centrally provisioned systems with thousands of telephones. For any
size system, SoundPoint® IP telephones can be centrally provisioned from a boot
server via a system of global and per-telephone configuration files. To augment the
®
central provisioning model, or as the sole method in smaller systems, SoundPoint
telephones may be configured using user interfaces driven from the telephones themselves: both a local setup user interface and a web server-based user interface are
available to make configuration changes.
IP
master config file
application binary
config files
dictionary files
user interface
resource files
Boot Server
0004f2002999.cfg
sip.ld
ipmid.cfg
sip.cfg
phone2999.cfg
SoundPointIP-dictionary.xml
Local User Interface
0004f2002999-phone.cfg
0004f2002999-directory.cfg
SoundPoint IP
MAC 00:04:f2:00:29:99
config overrides
directory
0004f2002999-boot.log
0004f2002999-app.log
Local
Web Server
event log files
A boot server allows global and per-phone configuration to be managed centrally via
text XML-format configuration files that are downloaded by the telephones at boot
Copyright © 2004 Polycom, Inc. 3
Administrator Guide - SoundPoint® IP Installation and Operation
time. The boot server also facilitates automated application upgrades, diagnostics, and
a measure of fault tolerance.
The configuration served by the boot server can be augmented by changes made
locally on the telephone itself or via the telephone’s built-in web server. If file uploads
are permitted, the boot server allows these local changes to be backed up automatically.
Polycom recommends the boot server central provisioning model for installations
involving more than a few telephones. The investment required is minimal in terms of
time and equipment, and the benefits are significant.
SoundPoint® IP also supports dynamic host configuration protocol (DHCP). When set
up, DHCP permits plug-and-play TCP/IP network setup.
2.2 Installation Process
Regardless of whether or not you will be installing a centrally provisioned system,
there are two steps required to get your telephones up and running.
1. Basic TCP/IP Network Setup such as IP address and subnet mask. For more information, see 2.2.1 Basic Network Setup on page 4.
2. Application Configuration such as application specific parameters. For
more information, see
2.2.2 Application Configuration on page 9.
2.2.1 Basic Network Setup
SoundPoint® IP boots up in two phases:
• Phase 1: bootROM - a generic program designed to load the application.
• Phase 2: application - the SIP telephone application.
Networking starts in Phase 1. The bootROM application uses the network to query the
boot server for upgrades or configuration changes, which is an optional process that
will happen automatically when properly deployed. The boot server can be on the
local LAN or anywhere on the Internet. The bootROM then loads the configured
application. The application will restart networking using most of the parameters
established by the bootROM (a DHCP query will be performed by the application).
Basic network settings can be changed during Phase 1 using the bootROM’s setup
menu. A similar, but more sophisticated menu system is present in the application for
changing the same network parameters. For more information, see 2.2.1.2 Local User
Interface Setup Menus on page 6.
4 Copyright © 2004 Polycom, Inc.
Administrator Guide - SoundPoint® IP Installation and Operation
2.2.1.1 DHCP or Manual TCP/IP Setup
Basic network settings can be derived from DHCP or entered manually using the telephone’s LCD-based user interface. Polycom recommends using DHCP where possible to eliminate repetitive manual data entry.
The following table shows the manually entered networking parameters that may be
overridden by parameters obtained from a DHCP server:
Parameter DHCP Option DHCP
12 3
IP address
subnet mask
IP gateway
boot server address
SNTP server address
SNTP GMT offset
DNS server IP address
alternate DNS server IP
1
1
3
See 2.2.1.2.2
DHCP Menu
on page 7
42 then 4
2
6
6
•- •
•- •
•- •
•- •
•• •
•• •
•- •
•- •
address
DNS domain
15
•- •
Configuration File
(Phase 2: application only)
priority when more than one source exists
Local
FLASH
a
CDP
VLAN ID
Copyright © 2004 Polycom, Inc. 5
b
a. CDP - Cisco Discovery Protocol
b. The VLAN ID may be overridden by a value obtained from a connected Ethernet switch if
the switch supports the Cisco Discovery Protocol (CDP).
-
-
-
-
-•
-•
Administrator Guide - SoundPoint® IP Installation and Operation
2.2.1.2 Local User Interface Setup Menus
Access to Network Configuration Menu:
Phase 1: bootROM The network configuration menu is accessible during the auto-boot
countdown of the bootROM phase of operation. Press the
key to launch the main menu.
Phase 2: application The network configuration menu is accessible from the main menu.
Navigate to Menu>Settings>Network Configuration. This menu is
locked by default. Enter the administrator password to unlock.
(Factory default password: 456)
SoundPoint® IP network configuration parameters may be edited by means of a main
menu and two sub-menus: DHCP Menu and Server Menu.
Use the soft keys, the arrow keys, the Sel/3, and the Del/X keys to make changes.
Parameters that are dimmed are read-only due to the value of other parameters. For
example, if the DHCP Client parameter is enabled, the Phone IP Addr and Subnet
Mask parameters are dimmed since these are guaranteed to be supplied by the DHCP
server (mandatory DHCP parameters) and the statically assigned IP address and subnet mask will never be used in this configuration.
Setup soft
2.2.1.2.1 Main Menu
Configuration parameters that may be edited on the main setup menu are described in
the table below:
Name Possible Values
DHCP Client Enabled, Disabled If enabled, DHCP will be used to obtain the
Phone IP Address dotted-decimal IP
Subnet Mask dotted-decimal subnet
IP Gateway dotted-decimal IP
address
mask
address
a
Description
parameters discussed in 2.2.1.1 DHCP or Manual TCP/IP Setup on page 5.
Telephone’s IP address.
Note: Disabled when DHCP client is enabled.
Telephone’s subnet mask.
Note: Disabled when DHCP client is enabled.
Telephone’s default router.
6 Copyright © 2004 Polycom, Inc.
Administrator Guide - SoundPoint® IP Installation and Operation
Name Possible Values
SNTP Address dotted-decimal IP
address
OR
domain name string
GMT Offset -12 through +13 Offset of the local time zone from Greenwich
DNS Server dotted-decimal IP
address
DNS Alternate Server dotted-decimal IP
address
DNS Domain domain name string Telephone’s DNS domain.
CDP Enabled, Disabled If enabled, the telephone will attempt to deter-
VLAN ID Null, 0 through 4094 Telephone’s 802.1Q VLAN identifier.
a. A parameter value of “???” indicates that the parameter has not yet been set and saved in the
telephone’s configuration. Any such parameter should have its value set before continuing.
a
Description
SNTP server from which the telephone will
obtain the current time.
Mean Time in half hour increments.
Primary server to which the telephone directs
Domain Name System queries.
Secondary server to which the telephone directs
Domain Name System queries.
mine its VLAN ID via the CDP.
The DHCP and Server sub-menus may be accessed from the main setup menu.
2.2.1.2.2 DHCP Menu
The DHCP menu is accessible only when the DHCP client is enabled. DHCP configuration parameters are described in the following table:
Name
Timeout 1 through 600 Number of seconds the telephone waits for secondary
Possible
Values
Description
DHCP Offer messages before selecting an offer.
Copyright © 2004 Polycom, Inc. 7
Administrator Guide - SoundPoint® IP Installation and Operation
Possible
Name
Values
Description
Boot Server Option 66
Custom
Static
Custom+Opt.66
Boot Server Option 128 through 254 When the boot server parameter is set to Custom, this
Boot Server Option
Type
IP Address,
String
Option 66: The telephone will look for option number
66 (string type) in the response received from the
DHCP server. The DHCP server must be configured to
send the boot server address in option 66.
Custom: The telephone will look for the option number specified by the “Boot Server Option” parameter
(below), and the type specified by the “Boot Server
Option Type” parameter (below) in the response
received from the DHCP server.
Static: The telephone will use the boot server configured via the Server Menu. For more information, see
2.2.1.2.3 Server Menu on page 8.
Custom+Opt.66: The telephone will first use the custom option if present or use Option 66 if the custom
option is not present.
parameter specifies the DHCP option number in which
the telephone will look for its boot server.
When the Boot Server parameter is set to Custom, this
parameter specifies the type of the DHCP option in
which the telephone will look for its boot server.
2.2.1.2.3 Server Menu
Name Possible Values Description
Server Type
Server Address dotted-decimal IP address
FTP User
b
FTP, Trivial FTP
OR
domain name string
any string When the Server Type parameter is set to FTP,
a
When set to FTP, the telephone will use the File
Transfer Protocol (FTP) to obtain configuration
and telephone application files from the boot
server.
When set to Trivial FTP, the telephone will use
the Trivial File Transfer Protocol (TFTP) to
obtain configuration and telephone application
files from the boot server.
The boot server to use if the DHCP client is disabled, or the DHCP server does not send a boot
server option, or the Boot Server parameter is set
to Static.
this is the user name used when the telephone
logs into the FTP server.
8 Copyright © 2004 Polycom, Inc.
Administrator Guide - SoundPoint® IP Installation and Operation
Name Possible Values Description
b
FTP Password
a. Using TFTP will make management of the telephone more difficult. For more information,
see 2.2.2.1.1 FTP vs. TFTP on page 10.
b. The FTP server user name and FTP password should be changed from the default values.
Note that FTP is an insecure protocol and the user chosen should have very few privileges
on the server.
any string When the Server Type parameter is set to FTP,
this is the password used when the telephone logs
in to the FTP server.
2.2.1.3 Reset to Factory Defaults
The basic network configuration referred to in the preceding sections can be reset to
factory defaults. To perform this function, simultaneously press and hold the 4, 6, 8
and * dial pad keys until the password prompt appears. Enter the administrator password to initiate the reset. This will reset the administrator password as well.
2.2.2 Application Configuration
While it is possible to make telephone calls with SoundPoint® IP using its default configuration, most installations will require some basic configuration changes to get
things running optimally. These changes can be made using the central boot server
model, if a boot server has been set up, or some, but not all changes can be made using
the telephone’s internal configuration web server.
Advantages of using a boot server:
1. The centralized repository for application images and configuration files permits
application updates and coordinated configuration parameters.
2. Some parameters can only be modified using boot server configuration
files.
3. The multilingual feature requires boot server-resident dictionary files.
4. The customized sound effect wave files require a boot server.
5. When file uploads are permitted, the boot server is the repository for:
• boot process and application event log files - very effective when diagnosing system problems
• local configuration changes via the <Ethernet address>-phone.cfg boot
server configuration overrides file - the telephone treats the boot server
copy as the original when booting
• per-telephone contact directory named <Ethernet address>-directory.cfg
6. The boot server copy of the application images and configuration files can
be used to “repair” a damaged telephone configuration in the same way that
system repair disks work for PCs.
The following sections discuss the available configuration options.
Copyright © 2004 Polycom, Inc. 9
Administrator Guide - SoundPoint® IP Installation and Operation
2.2.2.1 Centralized Configuration
The SoundPoint® IP application consists of an executable image file (sip.ld) and one
or more XML-format configuration files. In the centrally provisioned model, these
files are stored on a boot server and cached in the telephone. If the boot server is available at boot time, the telephone will automatically synchronize its configuration cache
with the boot server: bootROM image, application executable, and configuration files
are all upgraded this way. The telephone requires that a SNTP server be properly configured for this feature to work optimally.
2.2.2.1.1 FTP vs. TFTP
If using a trivial FTP (TFTP) protocol boot server, synchronization with the boot
server will be based on file names, not file timestamps, as is the case with FTP. Executable upgrades and changes made to configuration files will not be recognized by
the telephone unless their names are changed.
Example:
file.ld file01.ld (an upgrade to SIP 1.0.1))
ipmid.cfg ipmid01.cfg
The master configuration file, which references the other files and is always downloaded and parsed by the telephone, will need to change to reflect these name changes.
Polycom does not recommend TFTP boot servers for actively managed systems.
File name management is the responsibility of the System Administrator.
2.2.2.1.2 Configuration Files
SoundPoint® IP configuration files consist of master configuration files and application configuration files.
2.2.2.1.2.1 Master Configuration File
Central provisioning requires that an XML-format master configuration file be located
in the home directory on the boot server.
Per-telephone Master Configuration File
If per-telephone customization is required (for all applications that require per-telephone customization), the file should be named <Ethernet address>.cfg, where Ether-
net address is the Ethernet MAC address of the telephone in question. For A-F
hexadecimal digits, use lower case only, for example, 0004f200106c.cfg. The Ethernet address can be viewed using the About soft key during the auto-boot countdown of
10 Copyright © 2004 Polycom, Inc.
Administrator Guide - SoundPoint® IP Installation and Operation
the bootROM or via the Menu>System Status>General menu in the application. It is
also printed on a label on the back of the telephone.
Default Master Configuration File
For systems in which the configuration is identical for all telephones (no per-telephone
<Ethernet address>.cfg files), the default master configuration file may be used to set
the configuration for all telephones. The file named 000000000000.cfg (<12
zeros>.cfg) is the default master configuration file and it is recommended that one be
present on the boot server. If a telephone does not find its own <Ethernet
address>.cfg file, it will use this one, and establish a baseline configuration. This file
is part of the standard Polycom distribution of configuration files. It should be used as
the template for the <Ethernet address>.cfg files.
The default SIP master configuration file, 000000000000.cfg, is shown below:
Example:
< ?xm l version= "1 .0" stand alone ="ye s" ?>
Default Master SIP Configuration File -->
<!-<!--
Edit and rename this file to <Ethernet-address>.cfg for each
phone.
<!--
< APPLICATION APP_FILE_PATH="sip.ld"
-->
$Revision: 1.24 $ $Date: Mar 26 2003 11:59:02 $ -->
CONFIG_FILES="phone1.cfg, sip.cfg, ipmid.cfg"
MISC_FILES="" LOG_FILE_DIRECTORY= ""/>
Master configuration files contain four XML attributes:
APP_FILE_PATH The path name of the application executable. Has a maximum length
of 127 characters.
CONFIG_FILES A comma-separated list of configuration files. Has a maximum length
of 511 characters, including commas and white space.
MISC_FILES
LOG_FILE_DIRECTORY An alternative directory to use for log files if required. This is left
a. MISC_FILES is not used for the SIP application, but is used for the MGCP application.
A comma-separated list of other required files.
blank by default.
a
Note
The order of the configuration files listed in CONFIG_FILES is significant.
• The files are processed in the order listed (left to right).
• The same parameters may be included in more than one file.
• The parameter found first in the list of files will be the one that is effective.
This provides a convenient means of overriding the behavior of one or more telephones without altering the baseline configuration files for an entire system.
Copyright © 2004 Polycom, Inc. 11
Administrator Guide - SoundPoint® IP Installation and Operation
2.2.2.1.2.2 Application Configuration Files
Typically, the files are arranged in the following manner although parameters may be
moved around within the files and the file names themselves can be changed as
needed.
Per-phone settings phoneXXXX.cfg
Application settings sip.cfg
Core settings ipmid.cfg
Category Description Example
Core Contain parameters that affect the basic operation of the telephone
such as voice codecs, gains, and tones. All telephones in an installation usually share this category of files.
Applicationspecific
User Contain parameters unique to a particular telephone user. Typical
Contain parameters that dictate performance of a particular telephone application.
Typical parameters include the IP address of an application server.
All telephones in an installation usually share application-specific
files. This file would normally be modified from Polycom templates.
parameters include:
• display name
• unique addresses
Each telephone in an installation usually has its own customized
version of user files derived from Polycom templates.
ipmid.cfg
sip.cfg,
mgcp.cfg
phone1.cfg
These application configuration files dictate the behavior of the telephone once it is
running the executable specified in the master configuration file.
Important
Configuration files should only be modified by a knowledgeable System Administrator.
Applying incorrect parameters may render the telephone unusable.
12 Copyright © 2004 Polycom, Inc.
Administrator Guide - SoundPoint® IP Installation and Operation
2.2.2.1.3 Deploying a SoundPoint® IP boot server
The following table describes the steps required for successful deployment of a
SoundPoint® IP boot server. These instructions assume an FTP protocol boot server.
For more information on TFTP boot servers, see 2.2.2.1.1 FTP vs. TFTP on page 10.
Step: Instructions:
1. Set-up FTP Server:
Install FTP server application or locate suitable existing server. Use RFC-compliant FTP servers. The fol-
Note: Typically all SoundPoint
®
IP telephones are configured with the same FTP
account, but the FTP account provides a
means of conveniently partitioning the configuration. Give each account an unique
home directory on the server and change
the configuration on an account-by-
lowing FTP servers have been tested with
Soundpoint
®
IP and are known to work acceptably:
• Linux: ProFTPd 1.2.2 through 1.2.9 rc2p, ftpdbsd-0.3.3 (Linux port), we-ftpd 2.6.0
• Windows 2000 Server: IIS 5.0, WFTPD 2.03
• Create account and home directory.
a
account basis.
2. Copy all files: Copy all files from the distribution.zip file to the
SoundPoint
®
IP home directory. Maintain the same
folder hierarchy.
3. Create per-telephone configuration
b
files
:
Obtain a list of telephone Ethernet addresses (barcoded label on underside of telephone).
Create per-telephone phoneXXXX.cfg and <Ethernet
address>.cfg files by using the 00000000000.cfg and
phone1.cfg files from the distribution as templates.
Edit contents of phoneXXXX.cfg as appropriate. For
example, edit the registration parameters.
Edit the CONFIG_FILES attribute of the <Ethernet
address>.cfg files so that it references the appropriate
phoneXXXX.cfg file. (Replace the reference to
phone1.cfg with phoneXXXX.cfg.)
4. Edit <application>.cfg: See 4.6.2 SIP Configuration - sip.cfg on page 101,
particularly for SIP server address.
Copyright © 2004 Polycom, Inc. 13
Administrator Guide - SoundPoint® IP Installation and Operation
Step: Instructions:
5. Edit ipmid.cfg: See 4.6.1 Core Configuration - ipmid.cfg on page 55.
Most of the default settings are typically adequate,
however, if overriding SNTP settings are not available
via DHCP, the SNTP GMT offset and (possibly) the
SNTP server address will need to be edited for the correct local conditions. Changing the default daylight
savings parameters will likely be necessary outside of
North American locations.
(Optional) Disable the local web (HTTP) server or
alter its signalling port if local security policy dictates.
Change the default location settings:
• user interface language
• time and date format
6. Decide on FTP server security pol-
icy:
7. Reboot telephones after configuring
their boot server via DHCP or statically:
Polycom recommends allowing file uploads to the
FTP server where the security environment permits.
This allows event log files to be uploaded and changes
made by the telephone user to the configuration (via
the web server and local user interface) and changes
made to the directory to be backed up.
For organizational purposes, configuring a separate
log file directory is recommended, but not required
(see LOG_FILE_DIRECTORY in 2.2.2.1.2.1 Master
Configuration File on page 10). File permissions
should give the minimum access required, and the
account used should have no other rights on the server.
The telephone's FTP account needs to be able to add
files to which it can write in the log file directory and
the root directory. It must also be able to list files in
all directories mentioned in the [mac].cfg file. All
other files that the telephone needs to read, such as the
application executable and the standard configuration
files, should be made read-only via file server file permissions.
See 2.2.1 Basic Network Setup on page 4.
To reboot telephones manually, press and hold the following keys simultaneously until a confirmation tone
is heard or for about three seconds:
IP 400/500: Volume-, Volume+, Hold, and Messages
IP 600: Volume-, Volume +, Mute, and Messages
Monitor the boot server event log and the uploaded
event log files (if permitted):
Ensure that the configuration process completed correctly.
Start making calls!
14 Copyright © 2004 Polycom, Inc.
Administrator Guide - SoundPoint® IP Installation and Operation
a. The FTP account name and password must match those configured in the telephones them-
selves. Defaults are: name: PlcmSpIp, password: PlcmSpIp
b. This step may be omitted if per-telephone configuration is not needed.
2.2.2.2 Local Telephone Configuration
As the only method of modifying telephone configuration or as a distributed method
of augmenting a centralized provisioning model, a local telephone-based configuration
web server is available, unless disabled via ipmid.cfg. For more information, see
4.6.1.9 Web Server <HTTPD/> on page 82. The telephone’s local user interface also
permits certain application settings to be modified, such as ring type or regional settings such as time/date format and language.
Local Web Server Access Point your web browser to http://<phoneIPAddress>/.
Configuration pages are accessible from the menu along the top banner.
The web server will issue an authentication challenge to all pages
except for the home page.
Credentials are (case sensitive):
• User Name: Polycom
• Password: The administrator password is used for this.
Local Settings Menu Access Some items in the Settings menu are locked to prevent accidental
changes. To unlock these menus, enter the user or administrator
passwords.
The administrator password can be used anywhere that the user password is used.
Factory default passwords are:
• User password: 123
• Administrator password: 456
Passwords:
Network Configuration Requires administrator password.
Authentication Requires user password.
Reset User Settings Requires user password.
Changes made via the web server or local user interface are stored internally as overrides. These overrides take precedence over settings contained in the configuration
obtained from the boot server that existed previously within the telephone.
Copyright © 2004 Polycom, Inc. 15
Administrator Guide - SoundPoint® IP Installation and Operation
If the boot server permits uploads, these override setting will be saved in a file called
<Ethernet address>-phone.cfg on the boot server.
Important
Local configuration changes will continue to override the boot server-derived configuration
until deleted via the Reset User Settings menu selection.
2.2.2.3 SIP Authentication Parameters
There are several pairs of username/password fields in the Authentication menu of the
application. These correspond to the SIP digest authentication settings for each registration. Authentication parameters will be used in response to challenges unless you
include non-Null parameters in the per-telephone (phoneXXXX.cfg) configuration
files. For more information, see 4.6.3.1 Registration <reg/> on page 108. Reg User x
should contain the authentication username for the first registration (corresponds to
reg.x.auth.userId) and Reg Password x should contain the corresponding password
(corresponds to reg.x.auth.password).
16 Copyright © 2004 Polycom, Inc.
Administrator Guide - SoundPoint® IP Features
3 Features
This section describes SoundPoint® IP’s many features and corresponding administration points. References are made frequently to 4.6 Configuration Files on page 55.
3.1 Basic Features
3.1.1 Call Log
The telephone maintains a call log. The log:
• contains call information such as remote party identification, time and date, and
call duration,
• allows for convenient redialing of previous outgoing calls and for returning
incoming calls,
• saves contact information from call log entries in the contact directory.
The call log is stored in volatile memory and is maintained automatically by the telephone. The call log can be cleared manually by the user and will be erased on reboot.
3.1.2 Call Timer
A call timer is provided on the display. A separate call timer is maintained for each
distinct call in progress.
3.1.3 Call Waiting
When an incoming call arrives while the user is active on another call, the incoming
call is presented to the user visually on the LCD display. A configurable sound effect
such as the familiar call-waiting beep will be mixed with the active call audio as well.
3.1.4 Called Party Identification
SoundPoint® IP displays and logs the identity of the remote party specified for outgoing calls. This is the party that the user intends to connect with.
Copyright © 2004 Polycom, Inc. 17
Administrator Guide - SoundPoint® IP Features
3.1.5 Calling Party Identification
The telephone displays the caller identity, derived from the network signalling, when
an incoming call is presented. For calls from parties for which a directory entry exists,
the local name assigned to the directory entry may optionally be substituted.
Central
(boot
server)
Local
Configuration File:
ipmid.cfg
Configuration File:
phone1.cfg
Web Server
(if enabled)
Local Telephone
User Interface
Specify whether or not to use directory name substitution.
• For more information, see 4.6.1.2 User Preferences
<user_preferences/> on page 59.
Specify whether or not to use directory name substitution.
• For more information, see 4.6.3.7 User Preferences
<user_preferences/> on page 117.
Specify whether or not to use directory name substitution.
Navigate to: http://<phoneIPAddress>/coreConf.htm#us
Changes are saved to local flash and backed up to <Ethernet
address>-phone.cfg on the boot server. Changes will permanently override global settings unless deleted via the Reset
User Settings menu selection.
None.
3.1.6 Configurable Feature Keys
All SoundPoint® IP key functions can be changed from the factory defaults, although
this is typically not necessary. The scrolling timeout for specific keys can be configured.
Central
(boot
server)
Local
Configuration File:
ipmid.cfg
Web Server
(if enabled)
Local Telephone
User Interface
Set the key scrolling timeout, key functions, and sub-pointers for each key (usually not necessary).
• For more information, see 4.6.1.13 Keys <keys/> on
page 88.
None.
None.
The following diagrams and table show the default SIP key layouts for
SoundPoint® IP 500 and IP 600 models.
18 Copyright © 2004 Polycom, Inc.
Administrator Guide - SoundPoint® IP Features
SoundPoint IP 500 SIP Key Layout
35
40
39
38
Directo ries
Conference
Services
Call Lists
Conference
Transfer
Redial
34
33
32
31
30
29
37
36
28
13
4
19 20 21
GHI
PQRS
7
18
PQRS
15
*
ABC21DEF
2
ABC
5
54
JKL
TUV87WXYZ
8
TUV
OPER
0
0
OPER
12
2627
3
222324
DEF
MNOJKLGHI
6
6
MNO
9
9
16
17
WXYZ
#
13
14
1
1
SoundPoint IP 600 SIP Key Layout
25
Key ID
1
Sel
Sel
2
5
Del
Del
6
Menu
Messages
Do Not Di sturb
Hold
Hold
10
4
3
7
8
9
34
33
35
41
42
31
Directo ries
Services
Conference
Transfer
Redial
Hold
30
29
32
37
36
40
ABC21DEF
13
2
ABC
5
4
54
19 20 21
JKL
GHI
TUV87WXYZ
PQRS
8
7
18
17
TUV
PQRS
*
WXYZ
OPER
0
0
OPER
11
12
DEF
MNOJKLGHI
MNO
25262728
3
222324
6
6
9
9
16
#
131415
Key ID
Sel
2
Del
Menu
Messages
Do Not Di sturb
Hold
39
1
4
5
3
6
7
8
9
10
38
Copyright © 2004 Polycom, Inc. 19
Administrator Guide - SoundPoint® IP Features
Key ID IP 500 Function IP 600 Function
1 ArrowUp ArrowUp
2 ArrowLeft ArrowLeft
3 Select ArrowDown
4 ArrowRight ArrowRight
5 ArrowDown Select
6 Delete Delete
7 Menu Menu
8 Messages Messages
9 DoNotDisturb DoNotDisturb
10 Hold MicMute
11 VolUp VolUp
12 VolDown VolDown
13 DialpadPound DialpadPound
14 Dialpad0 Dialpad0
15 DialpadStar DialpadStar
16 Dialpad9 Dialpad9
17 Dialpad8 Dialpad8
18 Dialpad7 Dialpad7
19 Dialpad4 Dialpad4
20 Dialpad5 Dialpad5
21 Dialpad6 Dialpad6
22 Dialpad3 Dialpad3
23 Dialpad2 Dialpad2
24 Dialpad1 Dialpad1
25 SoftKey4 SoftKey4
26 SoftKey3 SoftKey3
27 SoftKey2 SoftKey2
28 SoftKey1 SoftKey1
29 Conference Services
30 CallHistory Directories
31 Services Line6
20 Copyright © 2004 Polycom, Inc.
Administrator Guide - SoundPoint® IP Features
Key ID IP 500 Function IP 600 Function
32 Directories Conference
33 Line3 Line2
34 Line2 Line1
35 Line1 Line3
36 Redial Redial
37 Transfer Transfer
38 Headset Headset
39 MicMute Handsfree
40 Handsfree Hold
41 n/a Line4
42 n/a Line5
3.1.7 Connected Party Identification
Where possible, SoundPoint® IP displays and logs the identity of the remote party to
which the user has connected. The connected party identity is derived from the network signaling. In some cases the remote party will be different from the called party
identity due to network call diversion.
3.1.8 Context Sensitive Volume Control
The volume of user interface sound effects, such as the ringer, and the receive volume
of call audio is adjustable. While transmit levels are fixed according to the TIA/EIA810-A standard, receive volume is adjustable. If using the default configuration
parameters, the receive handset/headset volume resets to nominal after each call to
comply with regulatory requirements. See 4.6.1.6.2 Volume Persistence <volume/> on
page 70.
3.1.9 Customizable Audio Sound Effects
SoundPoint® IP audio sound effects used for incoming call alerting and other indications are customizable. Sound effects can be composed of patterns of synthesized
tones or sample audio files. The default sample audio files may be replaced with alternates in .wav file format. Supported .wav formats include:
• mono G.711 (13-bit dynamic range, 8-khz sample rate),
Copyright © 2004 Polycom, Inc. 21
Administrator Guide - SoundPoint® IP Features
• mono L16/1600 (16-bit dynamic range, 16-kHz sample rate).
Note
The alternate sampled audio sound effect files must be present on the boot server or the Internet for
downloading at boot time.
Configuration File:
ipmid.cfg
Specify patterns used for sound effects and the individual
tones or sampled audio files used within them.
Central
(boot
server)
Web Server
(if enabled)
Local
Local Phone User
Interface
For more information, see:
• 4.6.1.1.3 Call Progress Tones <callProgTones> on
page 58
• 4.6.1.4 Sampled Audio for Sound Effects
<sampled_audio/> on page 62
• 4.6.1.5 Sound Effects <sound_effects/> on page 63
Specify sampled audio wave files to replace the built-in
defaults. Navigate to:
http://<phoneIPAddress>/coreConf.htm#sa
Changes are saved to local flash and backed up to <Ethernet
address>phone-.cfg on the boot server and will permanently
override global settings unless deleted via the Reset User Set
tings menu selection.
None.
3.1.10 Message Waiting Indication
SoundPoint® IP will flash a message-waiting indicator LED when instant messages
are waiting, and it can be configured to do so when voice messages are waiting.
-
3.1.11 Distinctive Incoming Call Treatment
SoundPoint® IP can automatically apply distinctive treatment to calls containing specific attributes. The distinctive treatment that can be applied includes customizable
alerting sound effects and automatic call diversion or rejection. Call attributes that can
trigger distinctive treatment include the calling party name or SIP contact (number or
URL format).
Administration: Distinctive Incoming Call Treatment
For more information, see 3.1.16 Local Contact Directory on page 25.
22 Copyright © 2004 Polycom, Inc.
Administrator Guide - SoundPoint® IP Features
3.1.12 Distinctive Ringing
There are three aspects to Distinctive Ringing:
1. The user can select the ring type for each line. There are many different ring patterns to choose from.
2. The ring type for specific callers can be assigned in the contact directory.
For more information, see
page 22. This feature has higher priority than Item 1.
3. The SIP Alert-Info field can be used to map calls to specific ring types.
This feature has higher priority than Items 1 and 2.
3.1.11 Distinctive Incoming Call Treatment on
Central
(boot
server)
Local
Configuration file:
sip.cfg
XML File: <Ethernet
address>-directory.xml
Web Server
(if enabled)
Local Phone User
Interface
Specify the mapping of Alert-Info strings to ring types.
• For more information, see 4.6.2.1.3.2 Alert Infor-
This file can be created manually using an XML editor.
• For more information, see 3.1.16.1 Local Contact
None.
The user can edit the ring types selected for each line
under the Settings menu. The user can also edit the
directory contents.
Changes are saved to local flash and backed up to
<Ethernet address>-phone.cfg on the boot server. These
changes will permanently override global settings unless
deleted via the Reset User Settings menu selection.
3.1.13 Distinctive Call Waiting
mation <alertInfo/> on page 104.
Directory File Format on page 26.
The SIP Alert-Info field can be used to map calls to distinct call waiting types, currently limited to two styles.
Central
(boot
server)
Local
Configuration file:
sip.cfg
Web Server
(if enabled)
Local Phone User
Interface
Copyright © 2004 Polycom, Inc. 23
Specify the mapping of Alert-Info strings to call waiting
types.
• For more information, see 4.6.2.1.3.2 Alert Information <alertInfo/> on page 104.
None.
None.
Administrator Guide - SoundPoint® IP Features
3.1.14 Do-Not-Disturb
A do-not-disturb feature is available to temporarily stop all incoming call alerting.
Calls can optionally be treated as though the telephone is busy while Do-Not-Disturb
(DND) is enabled. Incoming calls received while DND is enabled are logged as
missed.
Central
(boot
server)
Local
Configuration file:
ipmid.cfg
Configuration file:
phone1.cfg
Web Server
(if enabled)
Local Phone User
Interface
Specify whether or not DND results in incoming calls
being given busy treatment.
• For more information, see 4.6.1.10 Call Handling
Configuration <call/> on page 83.
Specify whether DND is treated as a per-registration feature or a global feature on the telephone.
• For more information, see 4.6.3.2.1 Do Not Disturb
<donotdisturb/> on page 110.
None.
User DND changes are recorded in flash memory and
backed up in the local overrides file of <Ethernet
address>-phone.cfg on the boot server if available.
3.1.15 Handset, Headset, and Speakerphone
SoundPoint® IP comes standard with a handset and a full-duplex speakerphone. A
dedicated connector is provided for a headset (not supplied). The telephone provides
dedicated keys for convenient selection of either the speakerphone or headset.
Configuration file:
ipmid.cfg
Central
(boot
server)
Local
24 Copyright © 2004 Polycom, Inc.
Configuration file:
phone1.cfg
Web Server
(if enabled)
Local Phone User
Interface
Enable or disable persistent headset mode.
• For more information, see 4.6.1.2 User Preferences
<user_preferences/> on page 59.
Enable or disable persistent headset mode.
• For more information, see 4.6.3.7 User Preferences
<user_preferences/> on page 117.
None.
Enable or disable persistent headset mode via the Settings
menu. Changes are saved to local flash and backed up to
<Ethernet address>-phone.cfg on the boot server.
Changes will permanently override global settings unless
deleted via the Reset User Settings menu.
Loading...