BroadSoft Partner Configuration Guide Grandstream GXV31xx IP Multimedia Phone GXP21xx/GXP14xx Enterprise IP Phone March 2011 Document Version 1.4 1297 Beacon Street, 2nd Floor Brookline, MA 02446 USA Voice: (617) 566-9300 Fax: (617) 249-1987 WWW.GRANDSTREAM.
BroadWorks® Guide Copyright Notice Copyright© 2011 Grandstream Networks, Inc. All rights reserved. Any technical documentation that is made available by Grandstream Networks, Inc. is proprietary and confidential and is considered the copyrighted work of Grandstream Networks, Inc. Trademarks BroadWorks® and BroadWorks Assistant–Enterprise™, BroadWorks Call Center™, BroadWorks Communicator™, BroadWorks Receptionist™, and BroadWorks Deployment Studio™ are trademarks of BroadSoft, Inc.
Document Revision History Version Reason for Change 1.1 Introduced document for Grandstream GXP21xx/GXP14xx/GXV31xx in validation with BroadWorks Release 17.0. 1.2 Edited and published document. 1.3 Added Device Management configuration instructions. 1.4 Edited and published document.
Table of Contents 1 Overview.......................................................................................................................................... 6 2 Interoperability Status ................................................................................................................... 7 2.1 2.2 2.3 3 BroadWorks Configuration.........................................................................................................12 3.1 3.
Table of Figures Figure 1 Shared Call Appearance Configuration .................................................................................... 18 Figure 2 System Default Tag Settings..................................................................................................... 23 Figure 3 Configuration Method 1: Import................................................................................................ 25 Figure 4 Auto Configuration Options Settings.....................................
1 Overview This document describes the configuration procedures required for the Grandstream GXP21xx/GXP14xx/GXV31xx phones to be interoperable with BroadWorks. This includes the following Grandstream phone models: GXP2100 GXP2110 GXP2120 GXP1450 GXV3140 GXV3175 The GXP21xx/GXP14xx/GXV31xx phones use the Session Initiation Protocol (SIP) to communicate with BroadWorks for call control. This guide describes the specific configuration items that are important for use of BroadWorks.
2 Interoperability Status This section provides the known interoperability status of the Grandstream GXP21xx/GXV3140/GXV3175 with BroadWorks. This includes the version(s) tested, capabilities supported and known issues. Interoperability testing validates that the device interfaces properly with BroadWorks via the SIP interface.
BroadWorks with the intent to ensure interoperability sufficient to support the BroadWorks feature set. The Supported column in the following table identifies the Grandstream GXP21xx/GXV3140/GXV3175’s support for each of the items covered in the test plan packages, with the following designations: Yes Test item is supported. No Test item is not supported. NA Test item is not applicable to the device type. NT Test item was not tested.
BroadWorks SIP Access Device Interoperability Test Plan Support Table Test Plan Package Test Plan Package Items Comments Diversion Header Yes History-Info Header No Advice of Charge Yes Meet-Me Conferencing NT Call Waiting Yes Call Hold Yes Call Transfer Yes No for attended transfer before answering Three-Way Call Yes No for attended transfer before answering Network-Based Conference No Register Authentication Yes Maximum Registration Yes Minimum Registration Yes Invite Authenti
BroadWorks SIP Access Device Interoperability Test Plan Support Table Test Plan Package Test Plan Package Items Supported Comments Call Forward Always Ring Splash No Call Forward Always Diversion Inhibitor No Call Center Agent Logon/Logoff No Call Center Agent Unavailable Code No Advanced Phone Services – Missed Calls Display Synchronization Missed Calls Display Sync Yes Advanced Phone Services – Shared Call Appearance using Call Info Line-Seize Yes Except GXP3140/GXV3175 Call-Info/Lamp M
BroadWorks SIP Access Device Interoperability Test Plan Support Table Test Plan Package Test Plan Package Items Video – Basic Video Calls Video – BroadWorks Video Services TCP 2.
3 BroadWorks Configuration This section identifies the required BroadWorks device profile for the Grandstream GXP21xx/GXV3140/GXV3175 as well as any other unique BroadWorks configuration required for interoperability with the Grandstream models listed previously. 3.1 BroadWorks Device Profile Configuration This section identifies the device profile to use when deploying the Grandstream GXP21xx/GXV3140/GXV3175 with BroadWorks.
Auto Configuration Soft Client Requires BroadWorks Call Waiting Tone Advice of Charge Capable X Forwarding Override Conference Device Music On Hold Device Requires BroadWorks Digit Collection Requires MWI Subscription Support Call Center MIME Type Reset Event checkSync Trunk Mode User Auto Configuration Options Web Based Configuration URL Extension Auto Configuration Type 2 Config File Enable Monitoring 3.2 CPE System File Name cfg%BWMACADDRESS%.
4 GXP21xx/GXP14xx/GXV31xx Configuration Grandstream GXP21xx/GXP14xx/GXV31xx can be configured via web GUI as well as via the Configuration File through TFTP or HTTP/HTTPS. The GXP21xx/GXP14xx/GXV31xx accepts configuration files in XML format in addition to the legacy proprietary binary format. When Grandstream device boots up or reboots, it issues a request for a configuration file named “cfgMAC.xml”, where “MAC” is the MAC address of the device, for example “cfg000b820102ab.xml”.
4.1 System Level Configuration This section describes system-wide configuration items that are generally required for each GXP21xx/GXP14xx/GXV31xx to work with BroadWorks. Subscriber-specific settings are described in the next section. Step Command Purpose System Configuration Items Step 1 Set SIP Proxy/Domain. SIP Server = as.broadworks.net Set the GXP21xx/GXP14xx/GXV31xx SIP server to the Fully Qualified Domain Name (FQDN) for the BroadWorks Application Server cluster.
4.2 Subscriber Level Configuration Parameters This section identifies the device-specific parameters, including registration and authentication. These settings must be unique across devices to be matched with the settings for a BroadWorks subscriber. Provisioning a subscriber to register with BroadWorks allows calls to terminate to the subscriber’s line.
Subscriber BLF Configuration Items (GXP21xx only) Step 2 Configure Multipurpose Key in Basic Settings page. Configure a Multipurpose Key for “eventlist BLF” under Basic Settings page. Example: The user ID is the monitored account SIP user ID.
4.3 Shared Call Appearance Configuration The Shared Call Appearance (SCA) feature allows the administrator to add multiple locations to a given line. Any of the locations can be used to originate or receive calls. When a call comes in to an idle line, all the provisioned locations for that line are alerted. The first location to answer the call is connected to the originator. If the line is already active in a call, only the active location is alerted.
4.3.1 Bob’s Phone Configuration The following steps are used to configure line 1 for Bob’s phone. This line rings when Bob is called, so it has Bob’s authentication information. Step Command Purpose Step 1 Configure Line Key 1 in Basic Settings page as Shared. Configure the line as “shared” (as opposed to “private”). Line Key 1 Key Mode = "Shared Line”; Step 2 Set Register User ID for Account1. Example: SIP User_ID = Step 3 "2405551111_1" ; Enable SIP Authentication for Account1.
4.3.2 Joe’s Phone Configuration The following steps are used to configure line 1 for Joe’s phone. This line rings when Joe is called, so it has Joe’s authentication information. Step Command Purpose Step 1 Configure Line Key 1 in Basic Settings page as Shared. Configure the line as “shared” (as opposed to “private”). Line Key 1 Key Mode = "Shared Line”; Step 2 Set Register User ID for Account1. Example: SIP User ID Step 3 = "2405552222_1" ; Enable SIP Authentication for Account1.
5 Device Management The BroadWorks Device Management feature provides the capability to automate generation of device configuration files. This section identifies the device management capabilities supported by the Grandstream GXP21xx/GXP14xx/GXV31xx and the configuration steps required. For Device Management configuration details not covered here, refer to the BroadWorks Device Management Configuration Guide [2]. 5.
BroadWorks Device Management Interoperability Test Plan Support Table Test Plan Package Test Plan Package Items Supported File Inspection Inspect System Config File NA Inspect Device-Specific Config File NA Inspect Other Config Files NA Inspect Static Files NA Inspect SIP Settings Yes Inspect Line Settings Yes Inspect Service Settings Yes HTTP Upload Using XSP IP Address No HTTP Upload Using XSP FQDN No HTTP Upload Using XSP Cluster FQDN No Register with Authentication Yes Call Ori
5.2.1.1 Create System Default Tags Browse to System Æ Resources Æ Device Management Tag Sets and select the System Default tag set. Add the system default tags in the following table if they do not already exist.
5.2.1.2 Create Device Type Specific Tags Browse to System Æ Resources Æ Device Management Tag Sets and select Add to add a new tag set. Configure the tag set name using the device name Grandstream GXP GXV Tags. Add the device type specific tags in the following table to the device tag set. Note that the Grandstream GXP21xx/GXP14xx/GXV31xx does not currently require device type specific tags, but it is important to create the tag set as a placeholder to enable use of tags in the future. 5.2.
Example: Figure 3 Configuration Method 1: Import Firmware files must be obtained from Grandstream. The firmware files are defined for the device profile type but the binaries are not included in the import. Complete the steps in section 5.2.2.2.2.2 Static Files to upload the firmware. 5.2.2.2 Configuration Method 2: Manual This section identifies the manual steps necessary to configure BroadWorks to add the Grandstream GXP21xx/GXP14xx/GXV31xx models as Device Management-enabled device types.
The Standard Options and Advanced Options should already be configured as specified in section 3.1. This section identifies the required settings for Auto Configuration Options and Device Management. 5.2.2.2.1.1 Configure Auto Configuration Options Modify the device profile type Auto Configuration Options as directed in the following table. Note that these are common settings that apply to all devices enabled for Device Management.
Example Auto Configuration Options settings: Figure 4 Auto Configuration Options Settings 5.2.2.2.1.2 Configure Device Management Options Modify the device profile type Device Management Options as directed in the table below. Note that these are common settings that apply to all devices enabled for Device Management. Parameters not identified in the following table can normally be left as defaults.
Example Device Management Options settings: Figure 5 Device Management Options Settings 5.2.2.2.2 Define Device Profile Type Files This section describes the BroadWorks Device Management configuration necessary to identify the config files and other files that the Grandstream GXP21xx/GXP14xx/GXV31xx downloads. In order to define the files, configuration templates, firmware and other files the Grandstream phones use must be uploaded to BroadWorks.
Parameters not identified in the following table can normally be left as defaults. Parameter Value Description/Notes Device Access File Format cfg%BWMACADDRESS%.xml This is the filename format the phone uses to request the file. Repository File Format cfg%BWDEVICEID%.xml This is the filename format as stored on the Device Management repository. File Category Dynamic Per-Type Only one system file is generated for the profile type.
Example Device-Specific File settings: Figure 6 Device-Specific File Settings 5.2.2.2.2.2 Static Files Static files are files such as firmware and media files that are not configurable and/or do not make use of the dynamic BroadWorks Device Management tags. The Grandstream GXP21xx/GXP14xx/GXV31xx requires the following static files: Grandstream GXP1450 gxp1450base.bin gxp1450boot.bin gxp1450core.bin gxp1450prog.bin Grandstream GXP2100 gxp2100aux.bin gxp2100base.bin gxp2100boot.
gxp2100core.bin gxp2100prog.bin Grandstream GXP2110 gxp2110aux.bin gxp2110base.bin gxp2110boot.bin gxp2110core.bin gxp2110prog.bin Grandstream GXP2120 gxp2120aux.bin gxp2120base.bin gxp2120boot.bin gxp2120core.bin gxp2120prog.bin Grandstream GXV3140 gxv3140base.bin gxv3140boot.bin gxv3140core.bin gxv3140prog.bin gxv3140guia.bin gxv3140guib.bin gxv3140rcvr.bin Grandstream GXV3175 gxv3170base.bin gxv3170boot.bin gxv3170core.bin gxv3170prog.bin gxv3170guia.bin gxv3170guib.bin gxv3170rcvr.bin gxv3170supp.
Parameters not identified in the following table can normally be left as defaults. Parameter Value Description/Notes Device Access File Format Examples: This is the filename the phone uses to request the file. gxv3170base.bin gxv3170boot.bin Repository File Format Examples: gxv3170base.bin This is the filename as stored on the Device Management repository. Use the same name as the actual file name. gxv3170boot.bin File Category Static This is a static file.
Example Static File settings: Figure 7 Static File Settings 5.2.3 Create Device Profile Instance This section describes how to create a BroadWorks device profile instance for an individual Grandstream phone. Device profile instances are normally created at the BroadWorks Group level and assigned to users. Browse to the BroadWorks Æ Resources Æ Identity/Device Profiles and select Add to add a new Grandstream device profile. Select the specific Grandstream model to be used.
Parameter Value Description/Notes Identity/Device Profile Type Select from the dropdown one of the Grandstream device profile types created in the previous sections. Authentication Use Custom Credentials Use unique login and password for each phone. Device Access User Name The phone login user naming convention must be determined by the service provider.
that when a unit is powered up, it automatically contacts the Grandstream provisioning server. The Grandstream provisioning server then redirects the unit to the appropriate BroadWorks XSP server. The unit reboots and sends further HTTP/S provisioning requests to the BroadWorks XSP server. The phone can also be manually configured with the BroadWorks XSP address if the Grandstream redirection service is not being used. This is described in the following sections. 5.2.4.
HTTP/HTTPS Password: BroadWorks Device Access Password Example: 123456 Upgrade Via: HTTP (or HTTPS) Firmware Server Path: Device Management server (XSP) device address URL Example: xsp1.broadworks.net:80/dms/Grandstream_GXV3175/ Config Server Path: Device Management server (XSP) device address URL Example: xsp1.broadworks.net:80/dms/Grandstream_GXV3175/ Click on “Save”, then “Reboot”.
Appendix A: Sample GXP21xx/GXP14xx/GXV31xx Configuration Files NOTE: The following samples are examples and should be used as a reference only. DO NOT CUT AND PASTE THESE EXAMPLES TO GENERATE YOUR CONFIGURATION FILES. Use the configuration files obtained from Grandstream with the specific release to generate your configuration files. GXV21xx/GXP14xx Phone-Specific File: cfg%BWMACADDRESS%.xml NOTE: This is an example file and should be used for reference only.
%BWBLF-USER-1% 102 1 %SBC_ADDRESS% 1 1 60 0 1 0 { x+ | *x+ | *xx*x+ } %BWBLF-USER-4% 102 1 %SBC_ADDRESS% 1 1 60 1 1 A %BWDN-2% %BWLINEPORT-2% %BWAUTHUSER-2% %BWAUTHPASSWORD-2% %BWCLID-2% %BWHOST-2% %SBC_ADDRESS% %BWAUTHUSER-3% %BWAUTHPASSWORD-3% %BWCLID-3% %BWHOST-3% %SBC_ADDRESS% 1 1
