Administrator Guide SoundPoint®/SoundStation® IP SIP Version 1.6.x 18 July 2005 Copyright © 2005 Polycom, Inc. All rights reserved. Notices 1. Specifications subject to change without notice. Polycom, Inc. 1565 Barber Lane, Milpitas CA 95035, USA www.polycom.com Part Number: 1725-11530-160 Rev A Copyright © 2005 Polycom, Inc. All rights reserved. Administrator Guide - SoundPoint® IP / SoundStation® 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 Provisioning File Transfer ......................................................................................................5 2.2.1.3 Local User Interface Setup Menus ..........................................................................................7 2.2.1.4 Reset to Factory Defaults......................................................................................................11 2.2.2 Application Configuration................................................................................................................ 11 2.2.2.1 Centralized Configuration......................................................................................................11 2.2.2.2 Local Phone Configuration.....................................................................................................17 3 Features .......................................................... 19 3.1 Basic Features .........................................................19 3.1.1 Call Log ......................................................................................................................................... 19 3.1.2 Call Timer ...................................................................................................................................... 19 3.1.3 Call Waiting ................................................................................................................................... 20 3.1.4 Called Party Identification............................................................................................................... 20 3.1.5 Calling Party Identification.............................................................................................................. 20 3.1.6 Missed Call Notification................................................................................................................... 20 3.1.7 Configurable Feature Keys.............................................................................................................. 21 3.1.8 Connected Party Identification ........................................................................................................ 25 3.1.9 Context Sensitive Volume Control.................................................................................................... 25 3.1.10 Customizable Audio Sound Effects ................................................................................................. 25 3.1.11 Message Waiting Indication .......................................................................................................... 26 3.1.12 Distinctive Incoming Call Treatment............................................................................................... 26 3.1.13 Distinctive Ringing........................................................................................................................ 27 3.1.14 Distinctive Call Waiting ................................................................................................................. 27 3.1.15 Do-Not-Disturb............................................................................................................................. 28 3.1.16 Handset, Headset, and Speakerphone ........................................................................................... 28 3.1.17 Local Contact Directory ................................................................................................................. 29 3.1.17.1 Local Contact Directory File Format.......................................................................................31 3.1.18 Local Digit Map ............................................................................................................................ 32 Copyright © 2005 Polycom, Inc. i Administrator Guide - SoundPoint® IP / SoundStation® IP Table of Contents 3.1.19 Microphone Mute ......................................................................................................................... 33 3.1.20 Multiple Line Keys per Registration ............................................................................................... 33 3.1.21 Multiple Call Appearances............................................................................................................. 34 3.1.22 Shared Call Appearances .............................................................................................................. 35 3.1.23 Bridged Line Appearances............................................................................................................. 37 3.1.24 Customizable Fonts and Indicators................................................................................................. 38 3.1.25 Soft Key-Driven User Interface...................................................................................................... 39 3.1.26 Speed Dial ................................................................................................................................... 39 3.1.27 Time and Date Display.................................................................................................................. 40 3.1.28 Idle Display Animation ................................................................................................................. 41 3.2 Call Management Features........................................42 3.2.1 Automatic Off-hook Call Placement ................................................................................................. 42 3.2.2 Call Hold........................................................................................................................................ 43 3.2.3 Call Transfer .................................................................................................................................. 43 3.2.4 Three-Way Conference, Local or Centralized .................................................................................... 44 3.2.5 Call Diversion (Call Forward) .......................................................................................................... 44 3.2.6 Directed Call Pick-up ...................................................................................................................... 45 3.2.7 Group Call Pick-up.......................................................................................................................... 46 3.2.8 Call Park / Retrieve ....................................................................................................................... 46 3.2.9 Last Call Return.............................................................................................................................. 47 3.3 Audio Processing Features ........................................47 3.3.1 Low-Delay Audio Packet Transmission ............................................................................................. 47 3.3.2 Jitter Buffer and Packet Error Concealment ..................................................................................... 47 3.3.3 Local Conference Mixing................................................................................................................. 48 3.3.4 Voice Activity Detection (VAD)......................................................................................................... 48 3.3.5 DTMF Tone Generation ................................................................................................................... 49 3.3.6 DTMF Event RTP Payload ................................................................................................................ 49 3.3.7 Acoustic Echo Cancellation (AEC) ..................................................................................................... 50 3.3.8 Audio Codecs.................................................................................................................................. 50 3.3.9 Background Noise Suppression (BNS).............................................................................................. 51 3.3.10 Comfort Noise Fill......................................................................................................................... 51 3.3.11 Automatic Gain Control (AGC)....................................................................................................... 51 3.4 Presence and Instant Messaging Features ...................51 3.4.1 Presence ........................................................................................................................................ 51 3.4.2 Instant Messaging .......................................................................................................................... 52 3.5 Localization Features ...............................................52 ii Copyright © 2005 Polycom, Inc. Administrator Guide - SoundPoint® IP / SoundStation® IP Table of Contents 3.5.1 Multilingual User Interface ............................................................................................................. 52 3.5.2 Downloadable Fonts ....................................................................................................................... 54 3.5.3 Synthesized Call Progress Tones...................................................................................................... 54 3.6 Advanced Server Features ........................................55 3.6.1 Voicemail Integration ..................................................................................................................... 55 3.6.2 Multiple Registrations..................................................................................................................... 56 3.6.3 ACD login / logout ......................................................................................................................... 59 3.6.4 ACD agent available / unavailable.................................................................................................. 59 3.6.5 Server Redundancy ........................................................................................................................ 59 3.6.5.1 DNS SIP Server Name Resolution...........................................................................................60 3.7 Accessory Internet Features.......................................60 3.7.1 MicroBrowser ................................................................................................................................. 60 3.8 Security Features .....................................................61 3.8.1 Local User and Administrator Privilege Levels.................................................................................. 61 3.8.2 Custom Certificates......................................................................................................................... 61 3.8.3 Incoming Signaling Validation......................................................................................................... 62 4 Optimization .................................................... 63 4.1 Ethernet Switch .......................................................63 4.2 Application Network Setup .......................................63 4.2.1 RTP Ports ....................................................................................................................................... 63 4.2.2 Working with Network Address Translation (NAT) ............................................................................ 64 4.3 Updating and Rebooting...........................................65 4.4 Event Logging .........................................................66 4.5 Audio Quality Issues and VLANs ................................67 4.5.1 IP TOS ........................................................................................................................................... 67 4.5.2 IEEE 802.1p/Q............................................................................................................................... 68 4.5.3 RTCP Support ................................................................................................................................. 69 4.6 Configuration Files...................................................70 4.6.1 SIP Configuration - sip.cfg .............................................................................................................. 70 4.6.1.1 Protocol ...........................................................................................................71 4.6.1.2 Dial Plan ..........................................................................................................77 4.6.1.3 Localization .................................................................................................78 4.6.1.4 User Preferences ..................................................................................82 Copyright © 2005 Polycom, Inc. iii Administrator Guide - SoundPoint® IP / SoundStation® IP Table of Contents 4.6.1.5 Tones .................................................................................................................83 4.6.1.6 Sampled Audio for Sound Effects ..............................................................85 4.6.1.7 Sound Effects ...........................................................................................87 4.6.1.8 Voice Settings ......................................................................................................92 4.6.1.9 Quality of Service ..................................................................................................102 4.6.1.10 Basic TCP/IP ...................................................................................................104 4.6.1.11 Web Server ......................................................................................................107 4.6.1.12 Call Handling Configuration .....................................................................................108 4.6.1.13 Directory .......................................................................................................110 4.6.1.14 Fonts ..................................................................................................................111 4.6.1.15 Keys ..................................................................................................................113 4.6.1.16 Bitmaps .........................................................................................................115 4.6.1.17 Indicators ...................................................................................................116 4.6.1.18 Event Logging .................................................................................................119 4.6.1.19 Security .........................................................................................................122 4.6.1.20 Provisioning ..............................................................................................123 4.6.1.21 RAM Disk ......................................................................................................123 4.6.1.22 Request ..........................................................................................................124 4.6.1.23 Feature ...........................................................................................................125 4.6.1.24 Resource .......................................................................................................126 4.6.1.25 MicroBrowser ..........................................................................................127 4.6.2 Per-phone Configuration - phone1.cfg............................................................................................. 128 4.6.2.1 Registration ............................................................................................................128 4.6.2.2 Calls ......................................................................................................................131 4.6.2.3 Diversion .............................................................................................................133 4.6.2.4 Dial Plan ..........................................................................................................135 4.6.2.5 Messaging ............................................................................................................137 4.6.2.6 Network Address Translation .....................................................................................138 5 Session Initiation Protocol (SIP)........................... 141 5.1 Basic Protocols ........................................................141 5.1.1 RFC and Internet Draft Support....................................................................................................... 141 5.1.2 Request Support............................................................................................................................. 141 5.1.3 Header Support.............................................................................................................................. 142 5.1.4 Response Support........................................................................................................................... 144 5.1.4.1 1xx Responses - Provisional ..................................................................................................144 5.1.4.2 2xx Responses - Success ......................................................................................................144 5.1.4.3 3xx Responses - Redirection..................................................................................................145 5.1.4.4 4xx Responses - Request Failure............................................................................................145 5.1.4.5 5xx Responses - Server Failure ..............................................................................................146 5.1.4.6 6xx Responses - Global Failure ..............................................................................................146 5.1.5 Hold Implementation...................................................................................................................... 147 5.1.6 Reliability of Provisional Responses................................................................................................. 147 iv Copyright © 2005 Polycom, Inc. Administrator Guide - SoundPoint® IP / SoundStation® IP Table of Contents 5.1.7 Transfer......................................................................................................................................... 147 5.1.8 Third Party Call Control................................................................................................................... 147 5.2 Protocol Extensions..................................................148 5.2.1 RFC and Internet Draft Support....................................................................................................... 148 5.2.2 Request Support............................................................................................................................. 148 5.2.3 SIP for Instant Messaging and Presence Leveraging Extensions (SIMPLE).......................................... 149 5.2.4 Shared Call Appearance Signaling ................................................................................................... 149 5.2.5 Bridged Line Appearance Signaling ................................................................................................. 149 6 Appendix 1 ...................................................... 151 6.1 Trusted Certificate Authority List ................................151 7 Appendix 2 ...................................................... 155 7.1 Third Party Software Attribution ................................155 Copyright © 2005 Polycom, Inc. v Administrator Guide - SoundPoint® IP / SoundStation® IP Table of Contents vi Copyright © 2005 Polycom, Inc. Administrator Guide - SoundPoint® IP / SoundStation® IP Overview 1 Overview This Administrator Guide is for the SIP 1.6.0 software release, and the bootROM 3.1.0 release. Unless specifically described separately, the behavior and configuration of the SoundPoint® IP 301 is the same as the 300, the behavior and configuration of the SoundPoint® IP 501 is the same as the 500, the behavior and configuration of the SoundPoint® IP 601 is the same as the 600. SoundPoint® IP and SoundStation® IP are feature-rich, enterprise-class voice communications terminals for Ethernet TCP/IP networks. They are designed to facilitate high-quality audio and text message communications. These phones are endpoints in the overall network topology designed to interoperate with other compatible equipment including application servers, media servers, internetworking gateways, voice bridges, and other endpoints. Copyright © 2005 Polycom, Inc. 1 Administrator Guide - SoundPoint® IP / SoundStation® IP Overview The phones connect physically to a standard office twisted-pair (IEEE 802.3) 10/100 megabytes per second Ethernet LAN and send and receive all data using the same packet-based technology. Since the phone is a data terminal, digitized audio being just another type of data from its perspective, the phone is capable of vastly more than traditional business phones. As SoundPoint® IP and SoundStation® IP run the same protocols as your office personal computer, many innovative applications can be developed without resorting to specialized technology. Regardless of the diverse application potential, it is fundamentally a good office 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 © 2005 Polycom, Inc. Administrator Guide - SoundPoint® IP / SoundStation® IP Installation and Operation 2 Installation and Operation This section describes the basic steps that are needed to make your phone operational. 2.1 Installation Models There are diverse installation models scaling from stand-alone phones to large, centrally provisioned systems with thousands of phones. For any size system, the phones can be centrally provisioned from a boot server via a system of global and per-phone configuration files. To augment the central provisioning model, or as the sole method in smaller systems, configuration can be done using user interfaces driven from the phones themselves: both a local setup user interface and a web server-based user interface are available to make configuration changes. A boot server allows global and per-phone configuration to be managed centrally via text XML-format configuration files that are downloaded by the phones at boot time. The boot server also facilitates automated application upgrades, diagnostics, and a measure of fault tolerance. Copyright © 2005 Polycom, Inc. 3 Administrator Guide - SoundPoint® IP / SoundStation® IP Installation and Operation The configuration served by the boot server can be augmented by changes made locally on the phone itself or via the phone'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 phones. The investment required is minimal in terms of time and equipment, and the benefits are significant. The phones also support 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 phones 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 11. 2.2.1 Basic Network Setup The phones boot up in two phases: · Phase 1: bootROM - a generic program designed to load the application. · Phase 2: application - the SIP phone 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.3 Local User Interface Setup Menus on page 7. 4 Copyright © 2005 Polycom, Inc. Administrator Guide - SoundPoint® IP / SoundStation® 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 phone'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: Configuration File (Phase 2: application only) priority when more than one source exists Parameter DHCP Option DHCP Local FLASH 1 2 3 IP address subnet mask IP gateway boot server address 1 1 3 See 2.2.1.3.2 DHCP Menu on page 8 42 then 4 2 6 6 15 See 2.2.1.3.2 DHCP Menu on page 8 · · · · - · · · · SNTP server address SNTP GMT offset DNS server IP address alternate DNS server IP address DNS domain VLAN ID · · · · · · · - · · · · · Special Case: Cisco Discovery Protocol (CDP)a overrides Local FLASH which overrides DHCP VLAN Discovery. a. Can be obtained from a connected Ethernet switch if the switch supports CDP. 2.2.1.2 Provisioning File Transfer The bootROM on the phone performs the provisioning functions of downloading the bootROM, the .cfg file, and the SIP application and uploading log files. The SIP application performs the provisioning functions of downloading all other configuration files, uploading and downloading the configuration override file and user directory, downloading the dictionary and uploading log files. Copyright © 2005 Polycom, Inc. 5 Administrator Guide - SoundPoint® IP / SoundStation® IP Installation and Operation The protocol which will be used to transfer files from the boot server depends on several factors including the phone model and whether the bootROM or SIP application stage of provisioning is in progress. TFTP and FTP are supported by all SoundPoint® and SoundStation® phones. The SoundPoint® IP 301, 501, 600 and 601 and SoundStation® IP 4000 bootROM also supports HTTP while the SIP application supports HTTP1 and HTTPS. If an unsupported protocol is specified, this may result in unexpected behavior, see the table for details of which protocol the phone will use. The "Specified Protocol" listed in the table can be selected in the Server Type field or the Server Address can include a transfer protocol, for example http://usr:pwd@server (see 2.2.1.3.3 Server Menu on page 10). The boot server address can also be obtained via DHCP. Configuration file names in the .cfg file can include a transfer protocol, for example https://usr:pwd@server/dir/file.cfg. If a user name and password are specified as part of the server address or file name, they will be used only if the server supports them. URL Notes: A URL should contain forward slashes instead of back slashes and should not contain spaces. Escape characters are not supported. If a user name and password are not specified, the Server User and Server Password will be used (see 2.2.1.3.3 Server Menu on page 10). Protocol used by bootROM 300, 500 FTP TFTP FTP FTP Specified Protocol FTP TFTP HTTP HTTPS Protocol used by SIP Application 300, 500 FTP TFTP HTTP Not supported. Transfers will fail. 301, 501, 600, 601, 4000 FTP TFTP HTTP HTTP 301, 501, 600, 601, 4000 FTP TFTP HTTP HTTPS For downloading the bootROM and application images to the phone, the secure HTTPS protocol is not available. To guarantee software integrity, the bootROM will only download signed bootROM or application images. For HTTPS, widely recognized certificate authorities are trusted by the phone and custom certificates can be added. See 6.1 Trusted Certificate Authority List on page 151. Using HTTPS requires that SNTP be functional. Provisioning of configuration files is done by the application instead of the bootROM and this transfer can use a secure protocol. 1. HTTP is supported on all phones to download ringer wave files. 6 Copyright © 2005 Polycom, Inc. Administrator Guide - SoundPoint® IP / SoundStation® IP Installation and Operation 2.2.1.3 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 SETUP soft key to launch the main menu. The network configuration menu is accessible from the main menu. Navigate to Menu>Settings>Advanced>Admin Settings>Network Configuration. Advanced Settings locked by default. Enter the administrator password to unlock. (Factory default password: 456) Phase 2: application Phone 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/ , and the Del/X keys to make changes. Parameters that cannot be changed 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 or not visible 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. 2.2.1.3.1 Main Menu Configuration parameters that may be edited on the main setup menu are described in the table below: Name DHCP Client Possible Valuesa Enabled, Disabled Description If enabled, DHCP will be used to obtain the parameters discussed in 2.2.1.1 DHCP or Manual TCP/IP Setup on page 5. See 2.2.1.3.2 DHCP Menu on page 8. Note: Disabled when DHCP client is disabled. DHCP Menu Phone IP Address dotted-decimal IP address dotted-decimal subnet mask dotted-decimal IP address Phone's IP address. Note: Disabled when DHCP client is enabled. Phone's subnet mask. Note: Disabled when DHCP client is enabled. Phone's default router. See 2.2.1.3.3 Server Menu on page 10. Subnet Mask IP Gateway Server Menu Copyright © 2005 Polycom, Inc. 7 Administrator Guide - SoundPoint® IP / SoundStation® IP Installation and Operation Name SNTP Address Possible Valuesa dotted-decimal IP address OR domain name string Description SNTP server from which the phone will obtain the current time. GMT Offset DNS Server DNS Alternate Server DNS Domain CDP VLAN ID -12 through +13 dotted-decimal IP address dotted-decimal IP address domain name string Enabled, Disabled Null, 0 through 4095 Offset of the local time zone from Greenwich Mean Time in half hour increments. Primary server to which the phone directs Domain Name System queries. Secondary server to which the phone directs Domain Name System queries. Phone's DNS domain. If enabled, the phone will attempt to determine its VLAN ID via the CDP. Phone's 802.1Q VLAN identifier. Note: 4095 = no VLAN tagging a. A parameter value of "???" indicates that the parameter has not yet been set and saved in the phone's configuration. Any such parameter should have its value set before continuing. The DHCP and Server sub-menus may be accessed from the main setup menu. 2.2.1.3.2 DHCP Menu The DHCP menu is accessible only when the DHCP client is enabled. DHCP configuration parameters are described in the following table: Possible Values 1 through 600 Name Timeout Description Number of seconds the phone waits for secondary DHCP Offer messages before selecting an offer. 8 Copyright © 2005 Polycom, Inc. Administrator Guide - SoundPoint® IP / SoundStation® IP Installation and Operation Name Boot Server Possible Values Option 66 Description Option 66: The phone will look for option number 66 (string type) in the response received from the DHCP server. The DHCP server should send address information in option 66 which matches one of the formats described for Server Address in 2.2.1.3.3 Server Menu on page 10. If the DHCP server sends nothing then the boot server address from flash will be used. Custom: The phone 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 phone will use the boot server configured via the Server Menu. For more information, see 2.2.1.3.3 Server Menu on page 10. Custom+Opt.66: The phone will first use the custom option if present or use Option 66 if the custom option is not present. When the boot server parameter is set to Custom, this parameter specifies the DHCP option number in which the phone 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 phone will look for its boot server. The IP Address must specify the boot server. The String must match one of the formats described for Server Address in 2.2.1.3.3 Server Menu on page 10 No VLAN discovery via DHCP. Use predefined DHCP private option values of 128, 144, 157 and 191. If this is used, the VLAN ID Option field will be ignored. Use the number specified in the VLAN ID Option field as the DHCP private option value. The DHCP private option value (when VLAN Discovery is set to Custom). Default is 129. Custom Static Custom+Opt.66 Boot Server Option 128 through 254 (Cannot be the same as VLAN ID Option) IP Address Boot Server Option Type String VLAN Discovery Disabled Fixed Custom VLAN ID Option 128 through 254 (Cannot be the same as Boot Server Option) Copyright © 2005 Polycom, Inc. 9 Administrator Guide - SoundPoint® IP / SoundStation® IP Installation and Operation 2.2.1.3.3 Server Menu Name Server Type Possible Values FTP or Trivial FTP or HTTP or HTTPS Description The protocol which the phone will use to obtain configuration and phone application files from the boot server. See 2.2.1.2 Provisioning File Transfer on page 5. FTP = File Transfer Protocol Trivial FTP = Trivial File Transfer Protocol HTTP = Hypertext Transfer Protocol HTTPS = Hypertext Transfer Protocol, Secure Server Address dotted-decimal IP address OR domain name string OR URL. All addresses can be followed by an optional directory and optional file name. 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. If a URL is chosen it can include a user name and password. See 2.2.1.2 Provisioning File Transfer on page 5. All options can specify a directory and the master configuration file. See 2.2.2.1.1.1 Master Configuration Files on page 12. Note: ":", "@", or "/" cannot be used in the user name or password. The user name used when the phone logs into the server if required for the selected Server Type. Note: If the Server Address is a URL with a user name, this will be ignored. Server User any string Server Passworda any string The password used when the phone logs in to the server if required for the selected Server Type. Note: If the Server Address is a URL with user name and password, this will be ignored. Provisioning Methodb Provisioning String Default or SAS-VP v2 any string If SAS-VP v2 is selected, provisioning is done using XML post/response transactions. The string used in XML post/response transactions. Note: Disabled when Provisioning Method is Default. a. The server user name and password should be changed from the default values. Note that for insecure protocols the user chosen should have very few privileges on the server. b. Not available on SoundPoint® IP 300 and SoundPoint® IP 500 phones. 10 Copyright © 2005 Polycom, Inc. Administrator Guide - SoundPoint® IP / SoundStation® IP Installation and Operation 2.2.1.4 Reset to Factory Defaults The basic network configuration referred to in the preceding sections can be reset to factory defaults. To perform this function on all phones except the IP® 4000, simultaneously press and hold the 4, 6, 8 and * dial pad keys until the password prompt appears. To perform this function on the IP® 4000, simultaneously press and hold the 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 calls with the phone 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 phone's internal configuration web server or the phone's SIP Configuration menu. 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 -phone.cfg boot server configuration overrides file - the phone treats the boot server copy as the original when booting, · per-phone contact directory named -directory.cfg. 6. The boot server copy of the application images and configuration files can be used to "repair" a damaged phone configuration in the same way that system repair disks work for PCs. The following sections discuss the available configuration options. 2.2.2.1 Centralized Configuration The phone 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 phone. If the boot server is available at boot time, the phone will automatically synchronize its configuration cache with the boot Copyright © 2005 Polycom, Inc. 11 Administrator Guide - SoundPoint® IP / SoundStation® IP Installation and Operation server: bootROM image, application executable, and configuration files are all upgraded this way. 2.2.2.1.1 Configuration Files The phone configuration files consist of master configuration files and application configuration files. 2.2.2.1.1.1 Master Configuration Files Central provisioning requires that an XML-format master configuration file be located on the boot server. Either a URL-specified master configuration file or one whose name is associated with the particular phone can be used. Refer to the following sections. Specified Master Configuration File The master configuration file can be explicitly specified in the boot server address, for example, http://usr:pwd@server/dir/example1.cfg. The file name must end with ".cfg" and be at least five characters long. If this file cannot be downloaded, the phone will search for the per-phone master configuration file described below. Per-phone Master Configuration File If per-phone customization is required (for all applications that require per-phone customization), the file should be named .cfg, where Ethernet address is the Ethernet MAC address of the phone 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 the bootROM or via the Menu>Status>Platform>Phone menu in the application. It is also printed on a label on the back of the phone. If this file cannot be downloaded, the phone will search for the default master configuration file described below. Default Master Configuration File For systems in which the configuration is identical for all phones (no per-phone .cfg files), the default master configuration file may be used to set the configuration for all phones. 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 phone does not find its own .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 .cfg files. 12 Copyright © 2005 Polycom, Inc. Administrator Guide - SoundPoint® IP / SoundStation® IP Installation and Operation The default master configuration file, 000000000000.cfg, is shown below: Example: < ? x m l v e r s io n = " 1 .0 " s t a n d a lo n e = " y e s " ? > < ! - - D e fa u lt M a s te r S IP C o n fig u ra tio n F ile - - > < ! - - E d it a n d re n a m e th is file to < E th e rn e t-a d d re s s > .c fg fo r e a c h p h o n e .- - > < ! - - $ R e v is io n : 1 .1 3 $ $ D a te : 2 0 0 4 /1 1 /2 6 2 3 :3 0 :4 4 $ - - > < A P P L IC A T IO N A P P _ F I L E _ P A T H = " s ip .ld " C O N F I G _ F IL E S = " p h o n e 1 .c f g , s ip .c f g " M IS C _ F I L E S = " " L O G _ F IL E _ D IR E C T O R Y = " " / > Master configuration files contain four XML attributes: APP_FILE_PATH The path name of the application executable. Has a maximum length of 255 characters. This can be a URL with its own protocol, user name and password, for example http://usr:pwd@server/dir/sip.ld. A comma-separated list of configuration files. Each file name has a maximum length of 255 characters and the list of file names has a maximum length of 2047 characters, including commas and white space. Each configuration file can be specified as a URL with its own protocol, user name and password, for example ftp://usr:pwd@server/ dir/phone2034.cfg. A comma-separated list of other required files.a An alternative directory to use for log files if required. This is left blank by default. CONFIG_FILES MISC_FILES LOG_FILE_DIRECTORY a. MISC_FILES is not normally used. 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 phones without altering the baseline configuration files for an entire system. 2.2.2.1.1.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 Application settings phoneXXXX.cfg sip.cfg Copyright © 2005 Polycom, Inc. 13 Administrator Guide - SoundPoint® IP / SoundStation® IP Installation and Operation Category Application Description Contains parameters that affect the basic operation of the phone such as voice codecs, gains, and tones and the IP address of an application server. All phones in an installation usually share this category of files. This file would normally be modified from Polycom templates. Contains parameters unique to a particular phone user. Typical parameters include: · · display name unique addresses Example sip.cfg User / perphone phone1.cfg Each phone in an installation usually has its own customized version of user files derived from Polycom templates. These application configuration files dictate the behavior of the phone 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 phone unusable. 14 Copyright © 2005 Polycom, Inc. Administrator Guide - SoundPoint® IP / SoundStation® IP Installation and Operation 2.2.2.1.2 Deploying a Boot Server for the Phones The following table describes the steps required for successful deployment of a boot server for SoundPoint® IP and SoundStation® IP phones. Step: 1. Set up boot server: Instructions: Install boot server application or locate suitable existing server. Use RFC-compliant servers. Create account and home directory.a Note that each phone may open multiple connections to the server. The phone will attempt to upload log files, a configuration override file, and a directory file to the server. This requires that the phone's account has delete, write, and read permissions. The phone will still function without these permissions but will not be able to upload files. The files downloaded from the server by the phone should be made read-only. Note: Typically all phones are configured with the same server account, but the server 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-account basis. 2. Copy all files: Copy all files from the distribution zip file to the phone home directory. Maintain the same folder hierarchy. Obtain a list of phone Ethernet addresses (barcoded label on underside of phone). Create per-phone phoneXXXX.cfg and .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 .cfg files so that it references the appropriate phoneXXXX.cfg file. (Replace the reference to phone1.cfg with phoneXXXX.cfg.) 3. Create per-phone configuration filesb: Copyright © 2005 Polycom, Inc. 15 Administrator Guide - SoundPoint® IP / SoundStation® IP Installation and Operation Step: 4. Edit sip.cfg: Instructions: See 4.6 Configuration Files on page 70, particularly for SIP server address. 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 5. Decide on boot server security policy: Polycom recommends allowing file uploads to the boot server where the security environment permits. This allows event log files to be uploaded and changes made by the phone 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.1.1 Master Configuration Files on page 12). File permissions should give the minimum access required, and the account used should have no other rights on the server. The phone's server 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 phone needs to read, such as the application executable and the standard configuration files, should be made read-only via file server file permissions. 16 Copyright © 2005 Polycom, Inc. Administrator Guide - SoundPoint® IP / SoundStation® IP Installation and Operation Step: 6. Reboot phones after configuring their boot server via DHCP or statically: Instructions: See 2.2.1 Basic Network Setup on page 4. To reboot phones, a menu option can be selected or a key combination can be held down. The menu option is called Restart Phone and it is in the Settings menu. For the key combination, press and hold the following keys simultaneously until a confirmation tone is heard or for about three seconds: IP 300 & IP 301: Volume-, Volume+, Hold and Do Not Disturb IP 500 & IP 501: Volume-, Volume+, Hold, and Messages IP 600 & IP 601: Volume-, Volume+, Mute, and Messages IP 4000: *, #, Volume+, and Select Monitor the boot server event log and the uploaded event log files (if permitted): Ensure that the configuration process completed correctly. Start making calls! a. If the provisioning protocol requires an account name and password, the server account name and password must match those configured in the phones. Defaults are: provisioning protocol: FTP, name: PlcmSpIp, password: PlcmSpIp b. This step may be omitted if per-phone configuration is not needed. 2.2.2.2 Local Phone Configuration As the only method of modifying phone configuration or as a distributed method of augmenting a centralized provisioning model, a local phone-based configuration web server is available, unless disabled via sip.cfg. For more information, see 4.6.1.11 Web Server on page 107. The phone's local user interface also permits Copyright © 2005 Polycom, Inc. 17 Administrator Guide - SoundPoint® IP / SoundStation® IP Installation and Operation many application settings to be modified, such as SIP server address or ring type or regional settings such as time/date format and language. Local Web Server Access Point your web browser to http:///. 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): · · Local Settings Menu Access User Name: Polycom Password: The administrator password is used for this. 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: Administrator password required. Network Configuration SIP Configuration SSL Security settings Reset to Default - local configuration, device settings, and file system format Restart Phone User password required. 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 phone. If the boot server permits uploads, these override setting will be saved in a file called -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. 18 Copyright © 2005 Polycom, Inc. Administrator Guide - SoundPoint® IP / SoundStation® IP Features 3 Features This section describes the many features and corresponding administration points of SoundPoint® IP and SoundStation® IP. References are made frequently to 4.6 Configuration Files on page 71. 3.1 Basic Features 3.1.1 Call Log The phone 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, · can be used to save contact information from call log entries to the contact directory. The call log is stored in volatile memory and is maintained automatically by the phone in three separate lists: Missed Calls, Received Calls and Placed Calls. The call lists can be cleared manually by the user and will be erased on reboot. Central (boot server) Configuration File: sip.cfg Enable or disable all call lists or individual call lists. · For more information, see 4.6.1.23 Feature on page 125. Local Web Server (if enabled) Local Telephone User Interface None. None. 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. Copyright © 2005 Polycom, Inc. 19 Administrator Guide - SoundPoint® IP / SoundStation® IP Features 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 The phone displays and logs the identity of the remote party specified for outgoing calls. This is the party that the user intends to connect with. 3.1.5 Calling Party Identification The phone 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) Configuration File: sip.cfg Specify whether or not to use directory name substitution. · For more information, see 4.6.1.4 User Preferences on page 82. Web Server (if enabled) Specify whether or not to use directory name substitution. Navigate to: http:///coreConf.htm#us Changes are saved to local flash and backed up to -phone.cfg on the boot server. Changes will permanently override global settings unless deleted via the Reset User Settings menu selection. Local Local Telephone User Interface None. 3.1.6 Missed Call Notification The phone can display the number of calls missed since the user last looked at the Missed Calls list. The types of calls which are counted as "missed" can be configured per registration. Remote missed-call notification can be used to notify the phone when a call originally destined for it is diverted by another entity such as a SIP server. 20 Copyright © 2005 Polycom, Inc. Administrator Guide - SoundPoint® IP / SoundStation® IP Features Configuration file: sip.cfg Central (boot server) Turn this feature on or off. · For more information, see 4.6.1.23 Feature on page 125. Configuration file: phone1.cfg Specify per-registration whether all missed-call events or only remote/server-generated missed-call events will be displayed. · For more information, see 4.6.2.2.3 Missed Call Configuration on page 132. Local Web Server (if enabled) Local Phone User Interface None. None. 3.1.7 Configurable Feature Keys All key functions can be changed from the factory defaults, although this is typically not necessary. The scrolling timeout for specific keys can be configured. Configuration File: sip.cfg Set the key scrolling timeout, key functions, and sub-pointers for each key (usually not necessary). · Web Server (if enabled) Local Telephone User Interface For more information, see 4.6.1.15 Keys on page 113. Central (boot server) None. None. Local The following diagrams and table show the default SIP key layouts for SoundPoint® IP 300, IP 301, IP 500, IP 501, IP 600, IP 601 and SoundStation® IP 4000 models. Copyright © 2005 Polycom, Inc. 21 Administrator Guide - SoundPoint® IP / SoundStation® IP Features SoundPoint IP 300 and IP 301 SIP Key Layout 2 Sel 1 28 27 25 Del 35 26 31 29 1 21 2 20 3 19 ABC DEF Menu Do Not Disturb Redial 32 23 7 ABC JKL DEF MNO GHI 4 16 5 17 6 18 GHI JKL TUV MNO WXYZ PQRS PQRS 7 7 15 8 14 9 13 8 9 TUV OPER WXYZ Hold Hold * 10 OPER 0 11 # 12 8 5 9 Key ID SoundPoint IP 500 and IP 501 SIP Key Layout 35 40 39 38 Conference Directories Services Call Lists Conference Transfer Redial 1 2 Sel 34 3 5 4 33 Del 32 6 28 31 27 ABC 26 DEF 25 Menu Messages 7 8 9 30 29 1 2 3 24 23 22 ABC DEF MNO 37 GHI 19 PQRS 4 GHI JKL 20 TUV 5 JKL MNO21 WXYZ 6 Do Not Disturb