Polycom VVX Expansion Module Administrator’s Guide Addendum ADMINISTRATOR’S GUIDE UC Software 4.1.6 Software 4.1.6 | March 2014 | 3725-46307-001 Rev B Polycom® VVX® Expansion Module Addendum to the Polycom UC Software 4.1.0 Administrator’s Guide Polycom, Inc.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Copyright ©2014, Polycom, Inc. All rights reserved. No part of this document may be reproduced, translated into another language or format, or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of Polycom, Inc.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Contents About This Guide ....................................................................................... 5 Conventions Used in this Guide .............................................................................. 5 Information Elements ........................................................................................................ 5 Typographic Conventions ....................................................
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 ........................................................................................................................... 49 ................................................................................................................................ 52 Get Help .................................................................................................... 60 Polycom and Partner Resources ..............
About This Guide This Administrator’s Guide Addendum uses a number of conventions that help you to understand information and perform tasks. Conventions Used in this Guide This guide contains terms, graphical elements, and a few typographic conventions. Familiarizing yourself with these terms, elements, and conventions will help you successfully perform tasks. Information Elements This guide may include any of the following icons to alert you to important information.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Typographic Conventions A few typographic conventions, listed next, are used in this guide to distinguish types of in-text information. Typographic Conventions Convention Description Bold Highlights interface items such as menus, soft keys, file names, and directories. Also used to represent menu selections and text entry to the phone.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Power the VVX Expansion Module This section provides information on the power process and values for Polycom VVX business media phones and expansion modules. Configure VVX Expansion Module Features available on for the VVX Expansion Module. Configuration Parameters In this section, you’ll learn how to configure features This section provides a list of parameters with descriptions.
Get Started The Polycom VVX Expansion Module (EM) extends the functionality of Polycom VVX business media phones and provides multifunctional line keys that you can configure as line registrations, Presence, Favorites, or Busy Lamp Field features. Polycom offers the expansion module with a paper display and a color LCD display. The expansion module with a paper display has 40 line keys; the Color expansion module has 28 line keys with three pages, for a total of 84 line keys.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 ● Display background images for VVX phones and expansion modules** ● Status information for connected modules ● Line key PDF for expansion module with paper display **These features are only available on the VVX Color Expansion Module. Get Help and Support Resources This guide includes a Get Help section where you can find links to Polycom product and support sites and partner sites.
Power the VVX Expansion Module The Polycom VVX Expansion Modules are powered and signaled by VVX business media phones and require minimal setup. The expansion modules are powered by VVX phones using an auxiliary cable that connects the modules and phone. After you connect the module to a phone, the module is automatically configured to work with the phone. Note that you cannot connect paper display and color display expansion modules together on the same phone.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Phone Power Values Model Power Usage (Watts) Power Value Sent in LLDP-MED Extended Power Via MDI TLV VVX 300 5.0 5000mW VVX 310 5.0 5000mW VVX 400 5.0 5000mW VVX 410 5.0 5000mW VVX 500 8.0 8000mW VVX 600 8.0 8000mW Web Info: Power Consumption on Polycom Phones For more detailed information about power consumption on Polycom phones, see Engineering Advisory 48152: Power Consumption on Polycom Phones.
Configure VVX Expansion Module Features You can configure features for the VVX expansion module using the phone’s interface, the Web Configuration Utility, or XML configuration files. Using the Web Configuration Utility, you can configure features and settings for your phone and expansion modules remotely on a per-phone basis. You can also assign lines to contacts, configure line functions, upload background images, and add or update contacts’ profile pictures.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Polycom UC Software 4.1.0 Administrator’s Guide), a background image displays on the entire screen, and the time, date, and line and soft key labels display over the backgrounds. Web Info: Adding a Graphic Display Background For detailed instructions on adding a display background to a VVX phone, see Technical Bulletin 62470: Customizing the Display Background on Your Polycom VVX Business Media Phone.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Example Graphic Display Background Configuration This example configuration shows a background image applied to a VVX phone and expansion module. The default background in the features.cfg template file, specified in the bg.color.selection parameter, is set to 2,1, where 2 enables background images and 1 selects the image. For example, 1= bg.color.bm.1.em.name and bg.color.bm.1.name.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Assign Flexible Line Key Functions You can customize the function of a line key anywhere on the phone’s screen and expansion modules. By default, functions are assigned to line keys in chronological order. This feature enables you to change that ordering and assign a line key function to any line key in any order anywhere on the phone’s screen or expansion module.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 and Presence to a line key, you need to assign a corresponding registration line. You can configure multiple line keys per registration if each line key has a corresponding reg.x.lineKeys parameter. To enable flexible line key assignment, In the features.cfg template, set the lineKey.reassignment.enabled parameter to 1. Then assign each line key a category and an index.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Enable Multiple Line Registrations Polycom phones can have multiple registrations; each registration requires an address or phone number. All VVX phones support up to 48 registration line keys and up to 34 line registrations when connected to three expansion modules. You can assign each registration to one or more line keys. Note that you can use a line key for only one registration.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Example Multiple Registration Configuration The following figure shows an example configuration in the reg-basic.cfg template. Multiple line registrations and a label for each registration have been enabled for lines 1, 2, and 3. Polycom, Inc.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 In the reg-advanced.cfg template shown next, when you make a call using line 1, the name you enter in reg.1.displayname displays as your caller ID, in this case Lisa. The parameter reg.x.type is set to the default private, which indicates that the registration uses standard call signaling. This configuration results in the following registrations on a VVX 600 phone.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 On some call servers, enabling Presence for an active Favorites contact displays that contact’s status on the favorite’s line key label. For information on how to enable Lync Presence for contacts, see Configure Lync Presence. Configuring the Favorites Feature Central Provisioning Server .....................................................................................................................
Polycom VVX Expansion Module Administrator’s Guide Addendum Element Definition Permitted Values lb Label UTF-8 encoded string of up to 40 bytes1 UC Software 4.1.6 The label for the contact. Note: The label of a contact directory item is by default the label attribute of the item. If the label attribute does not exist or is Null, then the first and last names form the label. A space is added between first and last names.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 For more information on how to use the template directory file 000000000000-directory~.xml, see Using the Local Contact Directory in Polycom UC Software 4.1.0 Administrator’s Guide. After you have renamed the directory file as a per-phone directory, enter a number in the Favorites field to display a contact directory entry as a favorite on the phone.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 This configuration results in the following favorites keys on the phone and module. Use Busy Lamp Field Feature Use the Busy Lamp Field (BLF) feature to monitor the status of lines on remote phones, display remote party information, and answer incoming calls to remote phones on your VVX phone and expansion modules. The BLF feature must be supported by a call server, and the specific functions vary with the call server you use.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Asterisk® v1.6 or later BroadSoft® BroadWorks ● Proxy architecture Avaya® SipX Enterprise Communications Server (ECS) eZuce openUC™ These proxy architectures may support the full range of statically configured BLF features. However, they do not provide configuration control through their web management console.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Web Info: Managing Monitored Lines For information on how to manage calls to monitored phones, see the section Handling Remote Calls on Attendant Phones in Technical Bulletin 62475: Using Statically Configured Busy Lamp Field with Polycom® SoundPoint IP Phones. Configuring the Busy Lamp Field Feature Central Provisioning Server ................................................................................................
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 To specify BLF resources in the configuration file, open the features.cfg template file and enter the address (phone number) of the BLF resource you want to monitor, the label to display beside the line key on the phone, and the type of resource you are monitoring. Your call server must support static BLF in order to configure BLF using the static method.
Polycom VVX Expansion Module Administrator’s Guide Addendum States UC Software 4.1.6 Line Icons Monitored line is busy Monitored line is ringing Configure Lync Presence The Lync presence feature enables you to monitor the status of other remote users and phones. By adding remote users to your Buddy List, you can monitor changes in the status of remote users in real time or you can monitor remote users as Favorites on the VVX phone and expansion module.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Example Presence Configuration In the following illustration, the presence feature is enabled in feature.presence.enabled. The MyStatus and Buddies soft keys both display on the phone’s home screen when you enable the pres.idleSoftkeys parameter. The pres.reg parameter uses the address of phone line 1 for the presence feature.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 The following figure shows Lync Presence contacts on the Color expansion module. The following table shows the Lync presence icons that display on the VVX phone and expansion module. Lync Presence Icons Icons Description Available Busy, In a Call Away, Be Right Back, Inactive Do Not Disturb Offline Unknown Polycom, Inc.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Customize Enhanced Feature Keys The Enhanced Feature Keys (EFK) feature enables you to customize the functions of any line keys, soft keys, and hard keys on VVX phones and expansion modules. You can use EFK to assign frequently used functions to line keys, soft keys, and hard keys or to create menu shortcuts to frequently used phone settings on VVX 300, 310, 400, 410, 500, and 600 phones running UC software 4.1.6 or later.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 ● Activation of EFK functions requires valid macro construction. ● All failures are logged at level 4 (minor). ● If two macros have the same name, the first one is used and the subsequent ones are ignored. ● A sequence of characters prefixed with an exclamation point (!) are parsed as a macro name. The exception is the favorites reference, which starts with ! and contains digits only.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Enable enhanced feature keys in the features.cfg template file, as shown next. In the following illustration, the EFK parameters are located in the features.cfg template file. In the efk.efklist.x.* parameters, line key 1 has been assigned a Call Park address (1955) and line key 2 a Call Retrieve function. The parameter action.string shows you the macro definition for these two functions.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 In the efk.prompt.* parameters, status has been enabled. The label on the user prompt is defined as Enter Number: and this prompt displays on the phone screen. The type parameter is set to numeric to allow only numbers, and because userfeedback is specified as visible, you are able to see the numbers you enter into the prompt.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 2 Log in as an Admin, enter the default password, and select Submit, as shown next. 3 Select Utilities > EM Directory. 4 Select the expansion module you want to generate a PDF for. For example, EM1 is chosen in the following figure. 5 In the confirmation dialog, select Yes to download the PDF for the configured lines for your expansion module. 6 Select Save > Open.
Configuration Parameters This reference section shows the UC software configuration parameters used to configure the features and functions for VVX phones and expansion modules running UC software 4.1.6 or later. The following information is helpful if you need a detailed description of a particular configuration parameter or want to see the default or permitted values for that parameter. See the Polycom UC Software 4.1.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Parameter Permitted Values Default attendant.behaviors.display.remoteCallerID.normal1 Normal attendant.behaviors.display.remoteCallerID.automata1 Automatic 0 or 1 1 If 1, normal and automatic remote party caller ID information is presented to the attendant. If 0, the string unknown will be substituted for both name and number information. attendant.resourceList.x.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 bg/> This section defines the backgrounds you can display on the VVX phones and expansion modules. Background Parameters Parameter Permitted Values Default bg.color.selection w,x 1,1 Set the background. Specify which type of background (w) and index (x) for that type is selected on reboot. The default selection is 2,1 the first solid background. Use w=1 and x=1 (1,1) to select the built-in image.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Parameter Permitted Values Default lineKey.reassignment.enabled 0, 1 0 Enables the line key reassignment feature—Flexible Line Key. lineKey.x.index 0, 1, 2 0 Specifies which index is used to pick up the line key x, within the specified category, and assigned to the line key. Depends on the lineKey.x.category parameter. Use the following three tables to configure the enhanced feature key feature on your phone.
Polycom VVX Expansion Module Administrator’s Guide Addendum Parameter Name UC Software 4.1.6 Permitted Values efk.efklist.x.type Default invite The SIP method to be performed. If set to invite, the action required is performed using the SIP INVITE method. Note: This parameter is included for backward compatibility. Do not use if possible. If efk.x.action.string contains types, this parameter is ignored. If Null, the default of INVITE is used.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Parameter Permitted Values Default feature.presence.enabled1 0 or 1 0 If 0, the presence feature—including buddy managements and user status—is disabled. If 1, the presence feature is enabled with the buddy and status options. 1 Change causes phone to restart or reboot. The parameter pres.reg is the line number used to send SUBSCRIBE.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Registration Parameters Parameter Permitted Values Default reg.x.acd-login-logout reg.x.acd-agent-available 0 or 1 0 or 1 0 0 If both ACD login/logout and agent available are set to 1 for registration x, the ACD feature will be enabled for that registration. reg.x.address string address Null The user part (for example, 1002) or the user and the host part (for example, 1002@polycom.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Parameter Permitted Values Default reg.x.dialPlanName String Null If reg.x.server.y.specialInterop is set to lync2010, the dial plan name from the Microsoft Lync Server is stored here. Each registration has its own name for this dial plan. Note: Do not change this parameter if set by Microsoft Lync. reg.x.displayName UTF-8 encoded string Null The display name used in SIP signaling and/or the H.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Parameter Permitted Values Default reg.x.lisdisclaimer string, 0 to 256 characters Null Sets the value of the location policy disclaimer. For example, the disclaimer may be “Warning: If you do not provide a location, emergency services may be delayed in reaching your location should you need to call for help.” This parameter is set by in-band provisioning when the phone is registered to Microsoft Lync Server 2010. reg.x.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Parameter Permitted Values Default reg.x.outboundProxy.failOver.reRegisterOn 0 or 1 0 This parameters overrides reg.x.server.y.failOver.failBack.RegisterOn. When set to 1, the phone will attempt to register with (or via, for the outbound proxy scenario) the secondary server. If the registration succeeds (a 200 OK response with valid expires), signaling will proceed with the secondary server.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Parameter Permitted Values Default reg.x.serverFeatureControl.localProcessing.cf 0 or 1 1 If 0 and reg.x.serverFeatureControl.cf is set to 1, the phone will not perform local call-forward behavior. If set to 1, the phone will perform local call-forward behavior on all calls received. This parameter overrides voIpProt.SIP.serverFeatureControl.localProcessing.cf. reg.x.serverFeatureControl.localProcessing.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Parameter Permitted Values Default reg.x.thirdPartyName string address Null This field must match the reg.x.address value of the registration that makes up the part of a bridged line appearance (BLA). It must be Null in all other cases. reg.x.type private or shared private If set to private, use standard call signaling.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Parameter Permitted Values Default reg.x.server.y.expires.lineSeize 0 to 65535 30 5 to 65535 60 Requested line-seize subscription period. reg.x.server.y.expires.overlap The number of seconds before the expiration time returned by server x at which the phone should try to reregister.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Parameter Permitted Values Default reg.x.server.y.useOutboundProxy 0 or 1 1 Specify whether or not to use the outbound proxy specified in reg.x.outboundProxy.address for server x. This parameter overrides voIpProt.server.x.useOutboundProxy for registration x. reg.x.server.y.port 0, 1 to 65535 Null The port of the SIP server that specifies registrations. If 0, the port used depends on reg.x.server.y.transport. reg.x.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 ● ● This configuration parameter is defined as follows. VoIP Server Parameters Parameter Permitted Values Default voIpProt.server.dhcp.available1 0 or 1 0 If 0, do not check with the DHCP server for the SIP server IP address. If 1, check with the server for the IP address. voIpProt.server.dhcp.option1 128 to 254 128 The option to request from the DHCP server if voIpProt.server.dhcp.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Parameter Permitted Values Default voIpProt.server.x.transport DNSnaptr, TCPpreferred, UDPOnly, TLS, TCPOnly DNSnaptr The transport method the phone uses to communicate with the SIP server. - Null or DNSnaptr If voIpProt.server.x.address is a hostname and voIpProt.server.x.port is 0 or Null, do NAPTR then SRV lookups to try to discover the transport, ports, and servers, as per RFC 3263. If voIpProt.server.x.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Parameter Permitted Values Default voIpProt.server.x.failOver.failRegistrationOn 0 or 1 0 When set to 1, and the reRegisterOn parameter is enabled, the phone will silently invalidate an existing registration (if it exists), at the point of failing over. When set to 0, and the reRegisterOn parameter is enabled, existing registrations will remain active.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Parameter Permitted Values Default voIpProt.server.H323.x.port 0 to 65535 1719 Port to be used for H.323 signaling. Note: The H.323 gatekeeper RAS signaling uses UDP, while the H.225/245 signaling uses TCP. voIpProt.server.H323.x.expires positive integer 3600 Desired registration period. 1 Change causes phone to restart or reboot.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Parameter Permitted Values Default voIpProt.SIP.CID.sourcePreference ASCII string up to 120characters long Null The priority order for the sources of caller ID information. The headers can be in any order. If Null, caller ID information comes from P-Asserted-Identity, Remote-Party-ID, and From in that order. The values From,P-Asserted-Identity, Remote-Party-ID, and P-Asserted-Identity,From, Remote-Party-ID are also valid.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Parameter Permitted Values Default voIpProt.SIP.dtmfViaSignaling.rfc29761 0 or 1 0 If set to 1, DTMF digit information is sent in RFC2976 SIP INFO packets during a call. If set to 0, no DTMF digit information is sent. voIpProt.SIP.enable1 0 or 1 1 A flag to determine whether the SIP protocol is used for call routing, dial plan, DTMF, and URL dialing. If set to 1, the SIP protocol is used. voIpProt.SIP.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Parameter Permitted Values Default voIpProt.SIP.ms-forking 0 or 1 0 If set to 0, support for MS-forking is disabled. If set to 1, support for MS-forking is enabled and the phone rejects all Instant Message INVITEs. This parameter applies when installing Microsoft Live Communications Server.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Parameter Permitted Values Default voIpProt.SIP.outboundProxy.failOver.onlySignalWithRegistered 0 or 1 1 When set to 1, and the reRegisterOn and failRegistrationOn parameters are enabled, no signaling is accepted from or sent to a server that has failed until failback is attempted or failover occurs.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Parameter Permitted Values Default voIpProt.SIP.requestValidation.x.method1 Null, source, digest, both, all Null If Null, no validation is made. Otherwise this sets the type of validation performed for the request: - source Ensure request is received from an IP address of a server belonging to the set of target registration servers.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Parameter Permitted Values Default voIpProt.SIP.serverFeatureControl.localProcessing.dnd 0 or 1 1 If set to 0 and voIpProt.SIP.serverFeatureControl.dnd is set to 1, the phone will not perform local DND call behavior. If set to 1, the phone performs local DND call behavior on all calls received. voIpProt.SIP.specialEvent.checkSync.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 Parameter Permitted Values Default voipPort.SIP.useCompleteUriForRetrieve 0 or 1 1 If set to 1, the target URI in BLF signaling uses the complete address as provided in the XML dialog document. If set to 0, only the user portion of the XML dialog document is used and the current registrar's domain is appended to create the full target URI. voipPort.SIP.
Get Help This section provides a list of Polycom documents referred to in this guide as well as partner resources you can use. For more information on using and configuring Polycom phones, view the following resources on Polycom Voice Support. ● To update Polycom phones with the latest UC software, see the Latest Polycom® UC Software Release page on the Polycom Voice Support Web site. ● For details on how to provision your Polycom phones with the latest UC software, see the Polycom UC Software 4.1.
Polycom VVX Expansion Module Administrator’s Guide Addendum UC Software 4.1.6 The Polycom Community The Polycom Community gives you access to the latest developer and support information. Participate in discussion forums to share ideas and solve problems with your colleagues. To register with the Polycom Community, simply create a Polycom online account.
Troubleshoot This section shows you some tools and techniques for identifying issues and troubleshooting Polycom phones and expansion modules running Polycom UC software. Use the following list as a guide to testing hardware and resolving issues, problems, or common difficulties you may encounter while deploying this solution.
