proprietary and confidential and is considered the copyri ghted work of Grandstream
Networks, Inc.
Trademarks
BroadWorks® and BroadWorks Assistant–Enterp rise™, Broad Works Call Center™,
BroadWorks Communicator™, BroadWorks Receptionist™, and BroadWorks
Deployment Studio™ are trademarks of BroadSoft, Inc.
Microsoft, MSN, Windows, and the Windows logo are registered trademarks of Microsoft
Corporation. Other product names mentioned in thi s document may be trademarks or
registered trademarks of their respective co mpanies and are hereby acknowle dged.
This document is printed in the United States of America.
GRANDSTREAM GXP21XX/GXV3140/GXV3175 SERIES PHONES 20-BD5320-00
This document describes the configuration procedures re quired for the Gran dstream
GXP21xx/GXP14xx/GXV31xx phones to be interoperab le with BroadWorks. This
includes the following Grandstream phone models:
The GXP21xx/GXP14xx/GXV31xx phones use the Session Initiation Protocol (SIP) to
communicate with BroadWorks for call control.
This guide describes the specific configu ration items that are important for use of
BroadWorks. It does not describe the purpose and use of all configuration item s on the
GXP21xx/GXP14xx/GXV31xx. For those details, see the GXP21xx/GXP14xx/GXV31xx
User Manual supplied by Grandstream[1].
GRANDSTREAM GXP21XX/GXV3140/GXV3175 SERIES PHONES 20-BD5320-00
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. Qualitative aspects of the device or device capabilities not affecting the
SIP interface such as display features, performance, and audio qualities are not covered
by interoperability testing. Requests for information and/or issues regarding these aspect s
should be directed to Grandstream.
2.1 Verified Versions
The following table identifies the verified Gr andstream G XP21xx/GXV3140/GXV317 5 and
BroadWorks versions and the month/year the testi ng occurred. If the device ha s
undergone more than one test cycle, version s for each test cy cle are listed, wit h the most
recent listed first.
Compatible Versions in the following table identifies specific G randstrea m versions which
the partner has identified as compatible and should interface properly with BroadWorks.
Generally, maintenance releases of the validated versio n are considere d compatible and
may not be specifically listed here. Contact Grandstream for any questions concerning
maintenance and compatible releases.
NOTE: Interoperability testing is normally performed with the latest generally available (GA)
device firmware/software and the latest GA BroadWorks release and service pack at the time the
testing occurs. If there is a need to use a non-verified mix of BroadWorks and device software
versions, customers can mitigate their risk by self-testing the combination using the BroadWorks
The Grandstream GXP21xx/GXV3140/GXV3175 has completed interoperability testing
with BroadWorks using the BroadWorks SIP Access Device Interoperability Test Plan [5].
results are summarized in the followin g table.
The
The BroadWorks test plan is composed of packages, eac h covering distin ct
interoperability areas, such as “Basic” call scenarios and “Redundancy” scenarios. Each
package is composed of one or more test item s which in turn are composed of on e or
more test cases. The test plan exercises the SIP interface between the device and
Grandstream Compatible
Versions
Any maintenance release of the
verified versions.
GRANDSTREAM GXP21XX/GXV3140/GXV3175 SERIES PHONES 20-BD5320-00
BroadWorks with the intent to ensure interoperability sufficient to supp ort the BroadWorks
feature set.
The Supported column in the following table identifies the Grandstream
GXP21xx/GXV3140/GXV3175’s support for ea ch of the items cove red in the test pla n
packages, with the following designations:
Yes Test item is supported.
No Test item i s not support ed.
NA Test item is not applicable to the device type.
NT Test item was not tested.
Caveats or clarifications are identified in the Comments column.
Note that DUT in the following table refers to the Device Under Te st which in this case is
the Grandstream phone.
BroadWorks SIP Access Device Interoperability Test Plan Support Table
Test Plan Package Test Plan Package Items Supported Comments
Basic Call Origination Yes
Call Termination Yes
Session Audit Yes
Session Timer Yes
Ringback Yes
Forked Dialog Yes
Early UPDATE No
Early-Session No
181 Call Being Forwarded Yes
Dial Plan Yes
DTMF - Inband Yes
DTMF – RFC 2833 Yes
DTMF – DTMF Relay Yes
Codec Negotiation Yes
Codec Renegotiation Yes
BroadWorks Services Third-Party Call Control – Basic NA
Third-Party Call Control – Advanced Yes
Voice Message Deposit/Retrieval Yes
Message Waiting Indicator Yes
Voice Portal Outcall Yes
Advanced Alerting Yes
Calling Line ID Yes
Connected Line ID Yes
GRANDSTREAM GXP21XX/GXV3140/GXV3175 SERIES PHONES 20-BD5320-00
Advanced Phone
Services – Shared
Call Appearance
using Call Info
Advanced Phone
Services – Shared
Call Appearance
using Dialog Event
Call Forward Always Diversion
No
Inhibitor
Call Center Agent Logon/Logoff No
Call Center Agent Unavailable Code No
Missed Calls Display Sync Yes
Line-Seize Yes Except GXP3140/GXV3175
Call-Info/Lamp Management Yes Except GXP3140/GXV3175
Public Hold Yes Except GXP3140/GXV3175
Private Hold Yes Except GXP3140/GXV3175
Multiple Call Arrangement Yes Except GXP3140/GXV3175
Bridging Yes Except GXP3140/GXV3175
Call Park Notification NT
Dialog Event No
Hold/Retrieve No
Multiple Call Arrangement No
Bridging No
Call Park Notification No
Advanced Phone
Hold Reminder No
Services – Call Center
Call Information No
Hoteling Event No
Status Event No
Disposition Code No
Emergency Escalation No
Customer Originated Trace No
Advanced Phone
Call Park Notification NT
Services – Call Park
Notification
Redundancy DNS SRV Lookup Yes
Register Failover/Failback Yes
Invite Failover/Failback Yes No for INVITE Failback
Bye Failover Yes
SBC/ALG Register Yes
Outgoing Invite Yes
GRANDSTREAM GXP21XX/GXV3140/GXV3175 SERIES PHONES 20-BD5320-00
BroadWorks SIP Access Device Interoperability Test Plan Support Table
Test Plan Package Test Plan Package Items Supported Comments
Incoming Invite Yes
Video – Basic Video
Calls
Video – BroadWorks
Video Services
TCP Register Yes
Call Origination NA
Call Termination NA
Call Hold NA
Call Waiting NA
Call Transfer NA
Auto Attendant NA
Auto Attendant - HD NA
Voice Messaging NA
Voice Messaging - HD NA
Custom Ringback NA
Outgoing Invite Yes
Incoming Invite Yes
2.3 Known Issues
This section lists the known interoperability issues between BroadWorks and specific
partner release(s). Issues identified during interoperability testing and known issues
identified in the field are listed.
The following table provides a description of each issu e and, where possi ble, identifies a
workaround. The verified partner d evice versions are li sted with an “X” indicati ng that the
issue occurs in the specific release. The issu es identified are devic e deficienci es or bugs,
so typically not BroadWorks release dependent.
The Issue Number is a BroadSoft ExtraView pa rtner issue number if the te sting was
performed by BroadSoft. If the testing was performed by the partner or a third party, the
partner may or may not supply a tracking number.
For more information on any issues related to the particul ar partner devi ce release, see
the partner release notes.
Issue Number Issue Description Partner Version
GXP2120
No issues identified.
1.0.1.39
GRANDSTREAM GXP21XX/GXV3140/GXV3175 SERIES PHONES 20-BD5320-00
This section identifies the require d BroadWorks d evice profile for the Grandstream
GXP21xx/GXV3140/GXV3175 as well as any other u nique BroadWor ks configuration
required for interoperability with the Grandstream models listed previously.
3.1 BroadWorks Device Profile Configuration
This section identifies the device profil e to use when d eploying the Gra ndstream
GXP21xx/GXV3140/GXV3175 with BroadWorks.
The following table identifies the required B roadWorks de vice identity/profile setti ngs for
interoperability between the GXP21xx/GXV3140/GXV3175 and BroadWorks. For an
explanation of the profile parameters, refer to the BroadWorks Device Management
Configuration Guide [2].
r most of the following parameters, an “X” indicates th e parameter functio n is supported
Fo
and/or required. If the item is blank, it is not supported. For items wh ere text is supplied,
the text content maps directly to the web page for ad ding or modifying a device profile.
Grandstream Identity/Device Profile
Signaling Address Type Intelligent Proxy Addressing
Ringback Tone/Early Media Support Local Ringback – No Early Media
Authentication Enabled
Registration Capable X
Static Registration Capable
E.164 Capable
Trusted
Authenticate REFER X
RFC 3264 Hold X
Video Capable X
Use History-Info Header X
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
CPE System File Name
Device File Format not_used
cfg%BWMACADDRESS%.xml
3.2 BroadWorks Configuration Steps
No special BroadWorks configuration is required.
GRANDSTREAM GXP21XX/GXV3140/GXV3175 SERIES PHONES 20-BD5320-00
Grandstream GXP21xx/GXP14xx/GXV31xx can be configu red via web GUI as well as via
the Configuration File through TFTP or HTTP/HT TPS.
The GXP21xx/GXP14xx/GXV31xx accepts configuration files i n XML format in additi on to
the legacy proprietary binary format.
When Grandstream device boots up or reboots, it issues a re quest for a configuration file
named “cfgMAC.xml”, where “MAC” is the MAC address of the d evice, for exam ple
“cfg000b820102ab.xml”. The configuration file name shoul d be in lower case.
The following examples describe how to set the pa rameters usi ng a configuration file. The
GXP21xx/GXP14xx/GXV31xx should be configured to load the configuration file each time
it resets or re-synchronizes. For detailed i nformation on auto mated prov isioning, se e the
GXP21xx/GXP14xx/GXV31xx User Manual [1] and th
Guide [6].
capabilities of the GXP21xx/GXP14xx/GXV31xx have been verifie d for use with
The
BroadWorks based on the settings described in the follo wing table. For mo re information
on the meaning, purpose, and applicability of the indivi dual configuratio n items see the
GXP21xx/GXP14xx/GXV31xx Configuration Tool and Template [7].
This section describes system-wide configuratio n 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
Step 2
Step 3
Set SIP Proxy/Domain.
SIP Server = as.broadworks.net
Set Outbound Proxy.
Outbound Proxy = sbc.broadworks.net
Enable DNS SRV lookup.
DNS Mode = “SRV”
Set the
GXP21xx/GXP14xx/GXV31xx
SIP server to the Fully Qualified
Domain Name (FQDN) for the
BroadWorks Application Server
cluster.
The domain must match the
domain configured for the
BroadWorks subscriber’s line/port
domain.
Set the Outbound Proxy to the
Session Border Controller (SBC)
if one is deployed between the
GXP21xx/GXP14xx/GXV31xx
and BroadWorks.
If there are redundant SBCs, set
it to the FQDN for the SBC
cluster.
This section identifies the device-spe cific parameters, i ncluding regi stration and
authentication. These settings must be unique across devices to be matched with the
settings for a BroadWorks subscriber.
Provisioning a subscriber to registe r with BroadWorks all ows calls to te rminate to the
subscriber’s line. Registration requi res that a unique address of record (A oR) is
provisioned on BroadWorks and the phone; provisioning an Ao R on BroadWorks con sists
of setting the line/port parameter to a unique value withi n the Applicatio n Server cluster.
Grandstream GXP21xx/GXP14xx/GXV31xx each supports different numbers of SIP
accounts. The following example shows how to config ure subscri ber eleme nts for an
account.
The Shared Call Appearance (SCA) feature allo ws the admini strator to add multi ple
locations to a given line. Any of the locations can be use d to originate or re ceive calls.
When a call comes in to an idle line, all the provisione d locations fo r that line are al erted.
The first location to answer the call is connect ed to the origin ator. If the line is already
active in a call, only the active location is alert ed.
A subscriber can originate calls from any of the configure d locations. All othe r locations
are unable to originate calls until all calls are released.
It is recommended that the phone number plus an index (<phoneNum ber>_<index>) is
used when provisioning the unique address of record (A oR) for each shared line. Fo r
example: 2405551111_2. If a phone number does not ex ist, the MAC addre ss plus an
index could be used (<macAddress>_<index>).
Line/Port:/Ao R 2405552222_1
Auth UserID: joebrown
Auth Password: joeb
Shared Call Appearance
Configuration
Bob's 2nd Line
Line/Port:/AoR 2405551111_2
Joe's Line
Figure 1 Shared Call Appearance Configuration shows that Bob and Joe each have two
lines and that Bob shares a line with Joe and Joe shares a line with Bob. The figure also
shows the applicable Subscriber Profile and Shared Call Appearance Configuration data
for subscribers Bob and Joe.
When Bob (2405551111) is calle d, Bob’s first line an d Joe’s se cond line wi ll ring. When
Joe (2405552222) is called, Joe’s first line and Bob’s second line will ring.
The following steps show how to configure both phones for this S hared Call Appe arance
configuration.
GRANDSTREAM GXP21XX/GXV3140/GXV3175 SERIES PHONES 20-BD5320-00
The BroadWorks Device Management feature provides the capability t o automate
generation of device configuration files. This se ction iden tifies the devi ce manageme nt
capabilities supported by the Grandstream GXP21xx/GXP14xx/GXV31 xx and the
configuration steps required. For Device Management co nfiguration details n ot covered
here, refer to the BroadWorks Device Management Configuration Guide[2].
5.1 Device Management Capabilities Supported
The Grandstream GXP21xx/GXP14xx/GXV31xx has completed Device Management
interoperability testing with BroadWorks using the BroadWorks Device Management
Interoperability Test Plan [3]. The re
The BroadWorks test plan is composed of packages, eac h covering distin ct
interoperability areas. Each package is composed of one or more test items which in turn
are composed of one or more test cases. The test plan exe rcises the Device
Management interface between the device and Broa dWorks with the i ntent to ensure
interoperability.
The Supported column in the following table identifies the Grandstream
GXP21xx/GXP14xx/GXV31xx’s support for each of the items covered in the test plan
packages, with the following designations:
sults are summarized in the following table.
Yes Test item is supported.
No Test item is not supported.
NA Test item is not applicable.
NT Test item was not tested.
Caveats or clarifications are identified in the Comments column.
Note that DUT in the following table refers to the Device Under Te st, which in this case is
the Grandstream GXP21xx/GXP14xx/GXV31xx.
BroadWorks Device Management Interoperability Test Plan Support Table
Test Plan Package Test Plan Package Items Supported Comments
HTTP File
Download
HTTPS File
Download
HTTP Download Using
XSP IP Address
HTTP Download Using
XSP FQDN
HTTP Download Using
XSP Cluster FQDN
HTTP Download With
Double Slash
HTTPS Download Using
XSP IP Address
HTTPS Download Using
XSP FQDN
Yes
Yes
Yes
Yes
Yes
Yes
HTTPS Download Using
XSP Cluster FQDN
GRANDSTREAM GXP21XX/GXV3140/GXV3175 SERIES PHONES 20-BD5320-00
BroadWorks Device Management Interoperability Test Plan Support Table
Test Plan Package Test Plan Package Items Supported Comments
File Inspection Inspect System Config File NA Config files cannot be
Inspect Device-Specific
Config File
Inspect Other Config Files NA
Inspect Static Files NA
Device Inspection Inspect SIP Settings Yes
Inspect Line Settings Yes
Inspect Service Settings Yes
Shared Line Origination Yes GXP Models only
Shared Line Termination Yes GXP Models only
Shared Line Status Yes GXP Models only
Busy Lamp Field Yes GXP Models only
5.2 Device Management Configuration
This section identifies the steps requ ired to enable the Grandstream
GXP21xx/GXP14xx/GXV31xx for device management. For Device Management
configuration details not covered here, refer to the BroadWorks Device Management
Configuration Guide [2].
5.2.1 Configure BroadWorks Tags
Grandstream GXP21xx/GXP14xx/GXV31xx makes use of dynami c tags which may
The
be configured by a BroadWorks administrator as either system def ault or device type
specific tags. This section identifies the required ta gs.
GRANDSTREAM GXP21XX/GXV3140/GXV3175 SERIES PHONES 20-BD5320-00
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 th e device name Grandst ream GXP GXV Tags. Add the device type specific tags in the following table t o 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.2 Configure BroadWorks Device Profile
re are two BroadWorks device profile configuration metho ds described: import a nd
The
manual. It is necessary to perform only one of the BroadWorks confi guration methods.
The import method is quick and easy. The manua l method walks the administrator
through each step.
5.2.2.1 Configuration Method 1: Import
This section identifies the steps necessary to ma ke use of the Device Man agement import
feature to configure BroadWorks to add the Grandstream GXP21xx/GXP14xx/GXV3 1xx
models as Device Management-enabled device type s.
The import method is available in BroadWo rks Release 17.0 a nd later. For previ ous
releases, use the manual configuration method described in the next secti on.
Download the Grandstream GXP21xx-GXP14xx-GXV31xx CPE kit from BroadSoft
Xchange at xchange.broadsoft.com
. Extract the DTAF files from the CPE kit. These are
the import files. Repeat the following steps for e ach model you wish to import.
Log in to BroadWorks as an administrator. Browse to System
Æ
Resources Æ
Identity/Device Profile Types and sele ct Import. Select Browse to find the extracted DTAF
file for the model and select OK to start the import.
After the import finishes, the following post-import configuration steps must be completed.
Browse to System
Æ
Resources Æ Identity/Device Profile Types and perform a search to
find the imported Grandstream device p rofile type, (for ex ample, Grandstream GXV 3175).
Browse to the Profile page and change the Devi ce Management Device Access FQDN to
your XSP or XSP cluster address.
GRANDSTREAM GXP21XX/GXV3140/GXV3175 SERIES PHONES 20-BD5320-00