FXS Gateway: From GUI to BroadWorks

Provisioning, access, dialing, routing, network, media, Hotline, fax, TLS/SRTP, and ACS configuration

Version 4 | Internal Technical Guide

Purpose: A structured technician reference for FourteenIP FXS gateway deployments managed through BroadWorks, including the TLS and SRTP settings in Version 4.

Guide Map

Select a section or technician task below to jump directly to the relevant part of the guide.

Presentation rule: Values inside monospaced blocks are configuration examples. Preserve capitalization, separators, percent signs, and spacing when copying them into the applicable interface.

01 Magic Device Profile & User Creation

1.5.1 Building FourteenIP FXS Gateway Users – EV Full / EV Select

NOTE: Evolution Voice Gateway (EVG) screenshots are referenced because FourteenIP gateways follow the same BroadWorks provisioning and user-build process. All configuration steps shown apply equally to FourteenIP 24S/96S gateways.

Building Users (EV Full Version)

1. Navigate to the group where the new users are being built, open the Users tab, and select the bulk-build option.

   

2. Select the service provider/enterprise and group where the users are being built.

3. Select the number of users to build.

   

4. Enter the user ID in the normal format, select the Domain ID, and auto-generate passwords.

5. Select the required name format for the bulk build.

   

6. Select the number range to build.

7. Under User Device, select Hosted User.

8. Add a new device by selecting the + symbol, then select Evolution_Voice_Gateway from the list.

9. Open the optional tab and add the gateway MAC address. EV gateways use the MAC address for provisioning; automatic provisioning will fail if it is missing.

   

10. Name the device according to normal naming conventions, then add the line port using the normal standard.

    

11. Add feature packs as normal.

12. Add any required department, detail, contact, and address information.

13. Select Save. On the import sheet, locate allowAccessDeviceUpdate and change its value from false to true. This allows multiple users to be added to the same device profile.

14. Select Submit and wait for the users to be built.

    

Key Notes

• FourteenIP gateways use their MAC address for provisioning. It must be added to the device profile or automatic provisioning will fail.

• For a bulk upload, the update-device-profile option must be set to TRUE and the MAC address must be entered on all users; otherwise, it will be removed from the device profile.

• The default BroadWorks authentication password length is 30 characters. FourteenIP gateways support a maximum of 25 characters, so an authentication password must be run after the users are built.

There are two device-profile groups, depending on the installation type:

• EV Full or EV Select: FourteenIP-24GW, FourteenIP-50GW, or FourteenIP-96GW.

• EV Lite: FourteenIP-24Lite, FourteenIP-50Lite, or FourteenIP-96Lite.

Important Note – FourteenIP-50GW Port Mapping

IMPORTANT: The FourteenIP-50GW will typically identify itself in the gateway GUI as CX-GW96-64S. Although the interface may indicate a 64-port gateway, the FourteenIP-50GW supports only 50 active FXS users/ports.

• Ports 26-32 are non-functional and must not be used.

• Ports 58-64 are non-functional and must not be used.

• The user assigned as Port 26 appears on Port 33 within the gateway.

• User assignments continue sequentially from Port 33 onward.

• The 50th and final user is assigned to Port 57.

The provisioning templates and configuration files have already been modified to account for this port-mapping behavior, and user assignments should be generated correctly during normal provisioning.

Keep this behavior in mind when:

• Reviewing generated configurations.

• Troubleshooting registration issues.

• Verifying user-to-port assignments.

• Performing manual provisioning or configuration changes.

If port assignments skip from Port 25 to Port 33, this is expected behavior and does not indicate a provisioning issue.

1.2 Building Users (EV Lite Version)

1) Add a Device for Each EV Gateway

• Device Type: FourteenIP-50Lite, FourteenIP-96Lite, or FourteenIP-24Lite.

• Device Name: (GROUPID)_GWL_*, where * is the location letter A, B, C, and so on.

• Example: EVATEST_GWL_A (Group ID_Gateway_Lite_Location).

• Add the MAC address of each EV Gateway if known. It must be added before installation for provisioning to work.

2) Add a Trunk Group for Each Vega

3) Add a Pilot User

4) Add Bedroom Users to the Trunk Group

• User ID: standard format (GROUPID)(Extension Number)@Domain.

• Add the extension number and phone number.

• Select Trunking and assign the trunk group created for the gateway.

• Line/Port: standard format (GROUPID)(Extension Number)@Domain.

• Assign the user a Guest Lite feature pack.

Key Notes

• The First Name of the pilot user must be the Group ID.

• The line port for all users must follow the traditional format: groupId + extension @ domain.

• Use the %EXTENSION-% tags in the trunk-group gateway device profile to add the extensions.

  

02 GUI Login Parameters

Privileges of Administrator and Operator (Web GUI)

Login users are classified as Administrator or Operator. The default passwords and post-provisioning password are shown below. Lowercase letters are required where applicable.

The Administrator can browse and modify all configuration parameters and change login passwords. After login, Admin appears in the upper-left corner of the interface.

The Operator can browse only a subset of configuration parameters. Operator access cannot browse Advanced > Security, System Tools > Change Password, System Tools > Software Upgrade, System Tools > Import Data, or System Tools > Export Data.

The gateway enforces a single active management session. If another user logs in, the existing session may be terminated. Coordinate changes and select Logout when finished.

For security, change the default password at first login under Tools > Change Password according to organizational standards.

03 Routing > Digit Map (BroadWorks Controlled Settings)

Explanation

The FourteenIP gateway uses a digit-map engine to decide when a user has finished dialing and the call should be sent to BroadWorks.

• The timers determine how long the gateway waits for digits.

• The digit map defines which number patterns are valid and whether the gateway sends immediately (#) or waits for a timeout (T).

Each rule appears on its own line in the gateway GUI. In BroadWorks, the map must be provided as one string with rules separated by the pipe character |.

Digit Map Symbols

BroadWorks Tag Reference

Operational Notes

• Pressing # sends the call immediately and ignores the timers.

• Rules ending with T wait for the interdigit timer before sending.

• The digit map decides when digits are sent; BroadWorks handles the call routing after the digits are delivered.

04 Digit Manipulation Via Routing Table (FourteenIP Gateways – BroadWorks Integration)

1. What the Routing Table Is

The routing table controls how calls are processed, modified, and routed based on defined rules. Each rule evaluates the call source and number pattern, then modifies the digits or determines where the call is sent. This supports extension mapping, digit manipulation, call routing, and call blocking within the gateway.

The routing table is processed from top to bottom. The gateway checks each rule in order and applies the first matching rule. If no rule matches, the call is sent to the default SIP proxy server, so a final catch-all routing rule is important.

The routing table has two main purposes:

• Number Transformation – modifying digits before routing.

• Call Routing – determining where the call is sent.

In most deployments, both are used together so calls are normalized and then routed appropriately.

2. How Routing Rules Work and Are Written on FourteenIP

All routing rules follow a consistent format:

Source Number Action Value

Example: FXS1 5032 REPLACE 2999 means that a call from FXS port 1 to 5032 is changed to 2999 before routing.

The Source identifies where the call originates. FXS represents subscriber ports, FXO represents trunk ports, and IP represents calls from the SIP network. Rules can apply to all ports, one port, or a port range.

The Number determines which calls match. It supports exact matches, prefixes, ranges, wildcards, and calling-number matching through CPN.

The Action determines what happens to the call:

Examples:

FXS 9 REMOVE 1
FXS 00 ROUTE NONE
FXS X ROUTE IP 10.10.10.10:5060

Specific rules must appear above general rules. Otherwise, a general rule may match first and prevent later rules from being evaluated.

3. Mapping Routing Rules to BroadWorks Device Profile Tags

Each routing rule is assigned to a separate tag using the format %ROUTE_TABLE_X%. The number determines the evaluation order: %ROUTE_TABLE_1% is processed first, then %ROUTE_TABLE_2%, and so on.

ROUTE_TABLE=
%ROUTE_TABLE_1%
%ROUTE_TABLE_2%
%ROUTE_TABLE_3%
%ROUTE_TABLE_4%
%ROUTE_TABLE_5%

Each tag contains one routing rule written exactly as it appears on the gateway.

%ROUTE_TABLE_1% = FXS1 5032 REPLACE 2999
%ROUTE_TABLE_2% = FXS 9 REMOVE 1
%ROUTE_TABLE_3% = FXS 00 ROUTE NONE

In this example, 5032 is replaced with 2999; the leading 9 is removed; calls beginning with 00 are blocked; and all remaining calls are routed to the SIP server.

A multi-port example is shown below:

%ROUTE_TABLE_1% = FXS1-24 5001 REPLACE 2999
%ROUTE_TABLE_2% = FXS1-24 5003 REPLACE 3606
%ROUTE_TABLE_3% = FXS1-24 5005 REPLACE 3603
%ROUTE_TABLE_4% = FXS1-24 5006 REPLACE 3607
%ROUTE_TABLE_5% = FXS1-24 5008 REPLACE 6223

• Write each rule with exact syntax and no leading spaces.

• Order rules correctly.

• Leave unused tags blank for future expansion.

05 Network Configuration – FourteenIP Gateway

Overview

The Network page defines how the gateway connects to the local network and how optional services such as IPv6, STUN, and VPN are enabled.

IMPORTANT: Set static IP settings correctly before provisioning the gateway to avoid a gateway boot loop.

BroadWorks Network Device Tags

Use the following BroadWorks device tags to apply the gateway’s IPv4 and DNS network settings. The example values are the same defaults shown in the previous guide.

Gateway GUI Reference

Additional Parameters Controlling This Page

06 TLS & SRTP BroadWorks Tag Mapping

BroadWorks Device Tags

The following BroadWorks device tags must be used together to enable TLS signaling and mandatory SRTP on this gateway. The example uses the secure SBC address us-sbc-secure.14ip.net and the TLS SIP port 5061.

PROVISIONING BEHAVIOR: These settings are provisioned by the BroadWorks device tags. No manual gateway GUI configuration is required. The gateway screenshots in this chapter are reference views of the provisioned result.

BroadWorks TLS device-profile tag example using the United States secure SBC.

IMPORTANT: Use the secure SBC assigned to the site’s region. The complete SBC address, including :5061, must be entered in both %SBC_ADDRESS% and %TLS_SBC_ADDRESS%.

Regional Secure SBC Values

SIP Server and Port Tag Mapping

The BroadWorks tags below populate the secure SIP server and port settings shown in the reference image.

TLS, SRTP, Transport, and DNS Tag Mapping

These BroadWorks tags enable the TLS, SRTP, SIP transport, and DNS settings shown in the reference image.

SRTP Method Value Reference

Per-Line TLS and SRTP Tag Mapping

The line-level TLS and SRTP states shown in the reference image are enabled by the following BroadWorks tags.

07 DHCP Configuration – FourteenIP Gateway

Overview

This page controls whether the gateway obtains its network information through DHCP and how additional DHCP options are processed. These parameters affect IPv4 and IPv6 behavior and determine how the gateway receives provisioning information such as options 66 and 67.

GUI Reference

Parameters Controlling This Page

How These Settings Are Used

• ETH1_DHCP enables the gateway to obtain its IP address, gateway, and DNS through IPv4 DHCP.

• DHCPV6_MODE controls how IPv6 addressing and prefix information are learned.

• DHCP_OPTION defines which DHCP options the gateway reads. The default is DHCP_OPTION = 66|67.

• Option 66 provides the provisioning server URL.

• Option 67 provides the configuration file name.

Typical Configuration

ETH1_DHCP = on
DHCP_OPTION = 66|67

08 System – Codec & DTMF Configuration

Overview

This page controls media codec selection and how the gateway generates and interprets DTMF digits. The parameters below map the GUI fields to BroadWorks device-profile tags.

GUI Reference

Parameters Controlling This Page

Method Values

09 Hotline (Hotdial) – FXS Ports (FourteenIP Gateways)

Overview

The Hotline feature automatically dials a predefined number when an FXS port goes off-hook. It can be configured per port or through batch configuration. Hotline is disabled by default.

When enabled, the gateway can dial the configured number immediately or wait for a timeout, depending on the selected mode.

Configuration on the Gateway

Configure Hotline under Line > Configuration, or apply it to multiple ports under Line > Configuration > Batch Configuration.

Behavior Summary

• Disabled (0): Hotline is off and normal dialing applies.

• Immediate (1): The gateway dials the hotline number as soon as the port goes off-hook.

• Delay (2): The user hears dial tone. If no digits are entered before DHOT_TO expires, the gateway dials the hotline number.

BroadWorks Device Profile Tags

Example Configuration

Port 1 - Immediate Hotline to 2999
%%HL_MODE_1% = 1
%%HL_NUM_1%% = 2999

Port 1 - Delay Mode (5 seconds)
%HL_MODE_1% = 2
%HL_NUM_1% = 2999
DHOT_TO = 5

Disable Hotline
%HL_MODE_1% = 0

10 Fax Configuration Parameter Mapping

Transport Mode (T.38 / G.711) > T38

T38=on selects T.38 fax relay. T38=off selects G.711 fax pass-through.

• Type: BOOL (on/off)

• Default: on

Maximum Fax Rate > T38_RATE

T38_RATE sets the maximum fax speed. Use T38_RATE=14400 for the default behavior shown in the guide.

• Type: UINT

• Default: 14400

• Typical values: 9600, 14400

Port for Fax Transmission > T38_CHANGE_PORT

T38_CHANGE_PORT=no selects Use original RTP port. T38_CHANGE_PORT=yes selects Use a new port.

• Type: BOOL (yes/no)

• Default: no

Example

T38=on
T38_RATE=9600
T38_CHANGE_PORT=no

11 Country Tone and Time Zone Configuration

FourteenIP FXS gateways use the same country-tone and time-zone values as the FourteenIP T1 gateway software. Apply these settings through BroadWorks tags during provisioning or use the native parameters when importing an .ini file through the gateway GUI.

Quick Reference

Country-Tone Configuration

Add the following line to the BroadWorks configuration template:

COUNTRY = %COUNTRY%

Set %COUNTRY% to the internal value for the gateway’s location. Enter only the numeric value in the BroadWorks tag.

Example for the United States:

%COUNTRY% = 1

The gateway automatically loads the matching dial, busy, congestion, ringback, call-waiting, and confirmation tones.

Time-Zone Configuration

Add the following line to the BroadWorks configuration template:

TIMEZONE = %TIMEZONE%

Set %TIMEZONE% to the required internal value. Enter only the internal value in the BroadWorks tag and preserve its capitalization, hyphens, and underscores exactly.

Common Regional Tag-Set Values

Example BroadWorks tag set for a gateway in Florida:

%COUNTRY% = 1
%TIMEZONE% = New_York

Manual GUI Import (.ini)

When importing these settings directly through the gateway GUI, use the native parameter names without percent signs.

IMPORTANT: Save the configuration with the .ini extension. The first line inside the file must be exactly upgrade.

upgrade
COUNTRY=1
TIMEZONE=New_York

This example applies the United States tone set and the New_York time zone used for Florida.

12 Gateway Firmware Upgrade

The RGW gateway supports firmware upgrades through the web interface using either an .img file or a .tar.gz file. Obtain the latest approved firmware release file from the supplier before beginning.

For current firmware files, click the following link here and select the firmware for your specified device:https://fourteenip.sharepoint.com/:f:/s/EvolutionVoiceNinjas/IgDVxwhiERb4Sq2PPVMIQ-nZAe042EpEOKKA_sKevDVtdmI?e=giYSXi

Upgrade Procedure

CRITICAL UPGRADE SAFEGUARDS: Always select Backup when upgrading a provisioned gateway. Selecting Skip can factory-wipe the device and remove its existing configuration. During the upgrade, do not power off, disconnect, or restart the gateway; interruption may prevent it from starting.

After a successful upgrade, the gateway restarts automatically. Log in again, click Info, and verify that the displayed software version matches the intended target version.

13 Auto Provisioning Overview

RGW series voice gateways support automatic provisioning for centralized and remote management of gateway configuration and firmware upgrades. Firmware packages and configuration files are stored on an Automatic Configuration Server (ACS), which the gateway can access at startup or on a configured schedule.

Automatic provisioning supports:

• Configuration of all gateways or selective firmware upgrades for specific devices.

• Automatic update of gateway parameters.

• TFTP, FTP, HTTP, and HTTPS protocols.

• Local management through the web interface in addition to centralized provisioning.

• Automatic retrieval of the ACS address through DHCP Option 66 or manual configuration.

Benefits of Auto Provisioning

• Efficient, low-cost deployment and management of large gateway estates.

• Centralized configuration-file backup.

• Enhanced security through centralized management of account information.

Configuring Auto Provisioning on the Gateway

1. Log in to the gateway web interface.

2. Navigate to Advanced > System.

3. Under Management System Type, locate the ACS URL field.

4. Enter the appropriate provisioning credentials for EV Full or EV Lite using the tables below.

EV Full Sites

EV Lite Sites

IMPORTANT – A REBOOT IS REQUIRED: After entering the ACS URL and credentials, reboot the gateway for automatic provisioning to take effect. The device will not contact the ACS or download its configuration until it restarts.

5. Following the reboot, the gateway connects to the ACS and automatically downloads its assigned configuration and firmware.

6. If a configuration must be imported manually through the gateway GUI, save it as an .ini file and make upgrade the first line inside the file. See Section 11 for an example.

Internal Technical Guide – Version 4