proprietary and confidential and is considered the copyrighted work of Grandstream
Networks, Inc.
Trademarks
BroadWorks® and BroadWorks Assistant™ are trademarks of BroadSoft, Inc.
Microsoft, MSN, Windows, and the Windows logo are registered trademarks of Microsoft
Corporation. Other product names mentioned in this manual may be trademarks or
registered trademarks of their respective companies and are hereby acknowledged.
This document is printed in the United States of America.
2007 GRANDSTREAM. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 4 OF 25
1 Overview
This document describes the configuration procedures required for a Grandstream GXW4004 / GXW-4008 / HT-502 to make full use of the capabilities of B roadWorks.
The GXW-4004 / GXW-4008 / HT-502 are a few of the many access devices that
interoperate with BroadWorks.
The GXW-4004 / GXW-4008 / HT-502 uses the Session Initiation Protocol (SIP) to
communicate with BroadWorks for call control. It also translates voice to audio packets for
transmission across a packet network.
This guide describes the specific configuration items that are important for use with
BroadWorks. It does not describe the purpose and use of all configuration items on the
GXW-4004 / GXW-4008 / HT-502. For those details, see the GXW-4004 / GXW-4008 / HT-502 User Manual supplied by Grandstream 1.a)i.[1]
2007 GRANDSTREAM. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 5 OF 25
2 BroadWorks Validation Package Support Level
Devices are validated according to BroadWorks Validation Packages. Each package
validates a subset of features or items. This section describes the device’s support level
for a BroadWorks Validation Package as well as the features or items in the package that
are not supported. For specific issues, see section3.2Interoperab ility Issues. For a
complete list of items validated per package, see Appendix B: BroadWorks Validation
Package Test Items.
BroadWorks Package Support Level Items Not Supported
Basic Call Full
BroadWorks Enhanced Services Partial Ring Splash
DUT Services – Call Control Partial Network Conference 3-Way
DUT Services – Registration and
Authentication
DUT Services – FAX Full
DUT Services – Busy Lamp Field None
Redundancy Full
SBC/ALG Full
Shared Call Appearance None
Video None
TCP Full
2007 GRANDSTREAM. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 6 OF 25
3 Device Capabilities and Known Interoperability Issues
This section describes the features supported by the GXW-4004 / GXW-4008 / HT-502,
as well as BroadWorks interoperability issues and impact. The following table describes
capabilities.
Verified Revisions shows the results of partner (vendor) testing of a specific BroadWorks
version with a specific partner’s device under test (DUT) version.
Compatible Revisions indicates the maintenance versions that should interface properly
with BroadWorks.
3.1 Capabilities
Device Type
Lines and Appearances
Speaker/Power/Bridge
Verified Revisions
Compatible Revisions
SIP Proxy FQDN DNS Lookup
(A, SRV, NAP T R)
Outbound Proxy Configurable
Outbound Proxy FQDN DNS Lookup
(A, SRV, NAP T R)
BroadWorks Redundancy Enabled
BroadWorks Shared Call Appearance
BroadWorks Enhanced IP Phone
Configuration
Device Services
Device Call Control
(Device-Controlled or Flash INFO-
based)
Codecs
RFC 2833 DTMF
T.38 Fax
Generic SIP Smart (Proxy Addr)
GXW-4004: 4 lines 1 appearances per line
GXW-4008: 8 lines 1 appearances per line
HT-502: 2 lines 1 appearances per line
2007 GRANDSTREAM. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 8 OF 25
3.2 Interoperability Issues
This section lists the known interoperability issues between BroadWorks and partner
release(s). For more information on issues related to the particular software release, see
the partner release not es (generally, this should only be for GA partner releases).
Issue Tracking
Number
BroadWorks Release 14
1025 - 61
1025 -119 DUT to BroadWorks via Primary Application Server, DUT
Issue Title and Description Partner Releases
Broadworks to DUT, Do Not Disturb (DND) ring splash
DUT does not play a ring splash. DUT driver does not support ring
splash.
Currently Served by Secondary Application Server
DUT does not always contact the primary server first for INVITE. It
relies on the OPTIONS message from BroadWorks to failback.
When DUT is registered on secondary server and the primary
server becomes available and sends an OPTIONS request, DUT
will send INVITE to the primary server.
2007 GRANDSTREAM. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 9 OF 25
4 BroadWorks Device Identity/Profile
BroadWorks configurable device identify/profile is introduced in BroadWorks Release 14.0.
This section applies only to BroadWorks Release 14.0 and later.
The following table identifies the required BroadWorks device identity/profile settings for
interoperability between the GXW-4004/GXW-4008/HT-502 and BroadWorks. For an
explanation of the prof ile pa rameters , refer t o the BroadWorks Device Inventory Guide
1.a)i.[4].
For most of the parameters below, an “X” indicates the parameter function is supported
and/or required. If the item is blank, it is n ot supporte d.
Registration Capable
Static Registration Capable
E.164 Capable
Trusted
Authentication Override
Video Capable
RFC 3264 Hold
Route Advance
Wireless Integration
PBX Integration
Use Business Trunking Contact
Forwarding Override
Conference Device
Music On Hold Device
Web Based Configuration URL
Auto Configuration Type
Reset Event
Enable Monitoring
CPE System File Name
Device File Format
The above device types require BroadWorks Release 14 MP<TBD>. If the BroadWorks
system is currently at a lower patch level, either apply the necessary patch or use the
following generic device type until the system can be patched accordingly.
2007 GRANDSTREAM. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 11 OF 25
6 Configuration
Grandstream GXW- 4004 / GX W-40 08 / HT-5 02 can be confi gured v ia Web GUI Interf ace
as well as via Configuration File through TFTP or HTTP.
The GXW-4004 / GXW-4008 / HT-502 accepts configuration files in a proprietary binary
format which is produced by the Grandstream configuration tool. The configuration tool
creates a device configuration file based on a configuration template and the device’s
MAC address. All Grandstream products’ sample configuration templates are available on
Grandstream’s w eb s ite. A config uration t emplate file c ontains all confi guration
parameters available f or a p roduct , with comments d escribin g allow ed valu es of the
parameters. For a detailed parameter list, please refer to the corresponding firmware
release configuratio n template 1.a)i.[2].
When Grandstream device boots up or reboots, it will issue request for a binary
configuration file named “cfgxxxxxxxxxxxx”, where “xxxxxxxxxxxx” is the LAN MAC
address of the device, i.e., “cfg000b820102ab”. The configuration file name should be in
lower cases.
Grandstream offers f ree Config uration Fil e genera tor softw are in bot h Linux /Unix an d
Windows platform. Both Configuration File Generators can be downloaded from
Grandstream official w eb site at http://www .grandstream .com/configurationtool.html
1.a)i.[2].
The following examples describe how to set the parameters using a configuration file.
The GXW-4004 / GXW-4008 / HT-502 should be configured to load the configuration file
each time it resets or re-synchronizes. For detai led info rmation o n automat ed p rovisioni ng,
please check the GXW-4004 / GXW-4008 / HT-502 User Manual 1.a)i.[1] and the
Grandstream configurat ion tool user guide 1. a)i.[2].
The capabilities of the GXW-4004 / GXW-4008 / HT-502 have been verified for use w ith
BroadWorks based on the settings described in the fo llowing table. For more info rmation
on the meaning, purpose, and applicability of the individual configuration items, see the
2007 GRANDSTREAM. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 13 OF 25
6.1 System Level Configuration
This section describes system-wide configuration items that are generally required for
each GXW-4004 / GXW-4008 / HT-502 to work with BroadWorks. Subscriber-specific
settings are described in the next section.
Step Command Purpose
System Configuration File <system-wide configuration file na me>
Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
Step 7
Step 8
Set SIP Proxy/Domain.
SIP Server = as.broadworks.net
Set Outbound Proxy.
OutBound Proxy =
sbc.broadworks.net
Enable DNS SRV lookup.
Use DNS SRV = “Yes”
Set register mode.
SIP Registration = “Yes”
Set SIP Timers.
Register Expiration = 60
Enable negotiated DTMF type.
Send DTMF = “via RTP (RFC2833)”
Configure dialplan.
Example:
Dial Plan = “{ x+ }”
Disable local feature code
services.
Enable Call Features = “No”
Set the GXW-4004 / GXW-4008
/ HT-502 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
GXW-4004 / GXW-4008 / HT502 and BroadWorks.
If there are redundant SBCs, set
it to the FQDN for the SBC
cluster.
Enable DNS SRV lookups.
Enable SIP register.
The default registration period is
60 minutes.
Set the GXW-4004 / GXW-4008
/ HT-502 to enable inband or
RFC 2833 negotiated DTMF.
Configure the GXW-4004 /
GXW-4008 / HT-502 dial plan
according to the locale.
The dial plan shown is the
device default dial plan – any
number is allowed.
Disable feature access codes
controlled by the device.
2007 GRANDSTREAM. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 14 OF 25
6.2 Subscribe r Level Configuration Parameters
This section identifies the device-specific parameters, including registration and
authentication. These settings must be unique across devices in order 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. Registra tion re quires th at a uniq ue addre ss of reco rd (AoR) is
provisioned on Br oadWo rks and t he pho ne; prov isioni ng an AoR on Bro adWork s cons ists
of setting the line/port parameter to a unique value within the Application Server cluster.
Grandstream GXW-40 04 / GXW-4008 / HT-502 suppo rts four SIP acc ounts (lines), eig ht
SIP accounts, and two SIP accounts respectively. The follow example shows how to
configure subscriber elements for an account.
2007 GRANDSTREAM. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 15 OF 25
7 Enhanced IP Phone Configuration
Enhanced IP Phone Configuration is a BroadWorks feature that enables automatic
generation of device confi guration fil es, giv en adminis trator-su pplied te mplates.
For more information on t he Enha nced IP Phone Co nfigurat ion feat ure, se e the Enh anced
IP Phone Configuration Guide 1.a)i.[3].
NOTE: BroadSoft does not manage or distribute template files for use with the Enhanced IP
Phone Configuration feature. Obtain template files from Grandstream or use the configuration
files obtained from Grandstream for the specific GXW-4004 / GXW-4008 / HT-502 firmware
release to create template files appropriate for your installation.
Since the GXW-4004 / GXW-4008 / HT-502 SIP phones require the configuration files be
converted into a binary format, an extra step must be performed when using this feature. After
the configuration files have been sent to the TFTP server and before the phone is reset, the
configuration files must be converted to binary format using Grandstream’s configuration tool. .
For detailed information on automated provisioning, please check the Grandstream configuration
tool user guide 1.a)i.[2].
The GXW-4004 / GXW-4008 / HT-502 use only a phone-specific file to configure the
device. However, the Enhanced IP Phone Configuration feature requires a system and a
phone-specific file for each device. To satisfy the system file requirement, an empty file
(gxwDefault.txt, htDesfult.txt) will need to be uploaded to BroadWorks as the system file.
This file will be sent to the FTP server but will not actually be used for the configurati on file
generation. The group template file is used to build the c onfiguratio n files for the devi ces
of this device type assigned to the group. For a sample GXW-4004 / GXW-4008 / HT-502
group template file, see Appendix A.
NOTE: The following samples are examples and should be used as a reference only. DO NOT CUT
AND PASTE THESE EXAMPLES TO GENERATE YOUR CONFIG URATION FILES. Use the
configuration files obtained from Grandstream with the specific release to generate your configuration
files.
System Default Param eter s
NOTE: This is an example file and should be used for reference only.
# FXS Port 1
# SIP USER ID, Authent icate ID , Pas sword, Display Name, Profile ID (0 Profile 1, 1 - Profile 2)
P4060 =
P4090 =
P4120 =
P4180 =
P4150 =
# FXS Port 2
# SIP USER ID, Authent icate ID , Pas sword, Display Name, Profile ID (0 Profile 1, 1 - Profile 2)
P4061 =
P4091 =
P4121 =
P4181 =
P4151 =
# FXS Port 3
# SIP USER ID, Authent icate ID , Pas sword, Display Name, Profile ID (0 Profile 1, 1 - Profile 2)
P4062 =
P4092 =
P4122 =
P4182 =
P4152 =
# FXS Port 4
# SIP USER ID, Authent icate ID , Pas sword, Display Name, Profile ID (0 Profile 1, 1 - Profile 2)
P4063 =
P4093 =
P4123 =
P4183 =
P4153 =
###################### ######## ##### ###### ######## ####
# The following 4 port s belong to G XW-400 8 only #
###################### ######## ##### ###### ######## ####
# FXS Port 5
# SIP USER ID, Authent icate ID , Pas sword, Display Name, Profile ID (0 Profile 1, 1 - Profile 2)
P4064 =
P4094 =
P4124 =
P4184 =
P4154 =
# FXS Port 6
# SIP USER ID, Authent icate ID , Pas sword, Display Name, Profile ID (0 -
# FXS Port 1
# SIP USER ID, Authent icate ID , Pas sword, Display Name, Profile ID (0 Profile 1, 1 - Profile 2)
P4060 =
P4090 =
P4120 =
P4180 =
P4150 =
# FXS Port 2
# SIP USER ID, Authent icate ID , Pas sword, Display Name, Profile ID (0 Profile 1, 1 - Profile 2)
P4061 =
P4091 =
P4121 =
P4181 =
P4151 =
# FXS Port 3
# SIP USER ID, Authent icate ID , Pas sword, Display Name, Profile ID (0 Profile 1, 1 - Profile 2)
P4062 =
P4092 =
P4122 =
P4182 =
P4152 =
# FXS Port 4
# SIP USER ID, Authent icate ID , Pas sword, Display Name, Profile ID (0 Profile 1, 1 - Profile 2)
P4063 =
P4093 =
P4123 =
P4183 =
P4153 =
###################### ######## ##### ###### ######## ####
# The following 4 port s belong to G XW-400 8 only #
###################### ######## ##### ###### ######## ####
# FXS Port 5
# SIP USER ID, Authent icate ID , Pas sword, Display Name, Profile ID (0 Profile 1, 1 - Profile 2)