14IP 2 Port GW Configuration Guide - 14IP

14IP 2 Port GW Configuration Guide

FourteenIP 2 Port GW

From Gateway GUI to BroadWorks

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

Scope

This edition is written specifically for the FourteenIP-2GW and covers both installation types: EV Full / EV Select (hosted users on the FourteenIP-2GW device profile) and EV Lite (trunk group and pilot user on the FourteenIP-2Lite device profile). It supports two active FXS ports mapped directly as ports 1 and 2.

Document

Value

Edition

Version 4 – 2 Port GW

Audience

BroadWorks, deployment, and support technicians

Device profile – EV Full / EV Select

FourteenIP-2GW

Device profile – EV Lite

FourteenIP-2Lite

Active analog ports

FXS 1-2

Tag reference

FourteenIP FXS gateway device-template tag set

Classification

Internal Technical Guide

Configuration examples are shown in monospaced blocks. Preserve capitalization, percent signs, separators, and routing-rule order when copying values.

Guide Map

Section

Technician task

Where it is set / verified

01

Build EV Full / EV Select users and the FourteenIP-2GW device profile

BroadWorks

01L

Build EV Lite device, trunk group, pilot, and Base-Lite users (FourteenIP-2Lite)

BroadWorks

02

Find the gateway and log in

Gateway GUI

03

Digit map (US and EU/APAC digit maps)

BroadWorks tags; verify in Routing > Digit map

04

Digit manipulation and routing

BroadWorks tags; verify in Routing > Routing table

05

Network addressing

BroadWorks tags; verify in Basic > Network

06

TLS and SRTP

BroadWorks tags; verify in Basic > SIP

07

DHCP behavior

BroadWorks tags; verify in Basic > VLAN

08

Codecs and DTMF

BroadWorks tags; verify in Basic > System

09

Hotline / Hotdial

BroadWorks tags; verify in Line > Configuration

10

Fax behavior

BroadWorks tags; verify in gateway fax settings

11

Country tones and time zone

BroadWorks tags

12

Upgrade firmware safely

Tools > Software upgrade

13

Configure BroadWorks auto provisioning (EV Full and EV Lite)

Advanced > System

Everything is managed by BroadWorks tags

Every gateway setting in sections 03-11 is set by BroadWorks device tags and applied when the gateway auto provisions. Technicians do not configure these settings on the gateway. The gateway screenshots show where to check the result after provisioning. To change a setting, change its tag on the device profile, rebuild the device files, and reset the gateway.

Core 2 Port rule

Port numbering is direct: BroadWorks user 1 maps to gateway FXS 1 and user 2 maps to gateway FXS 2. There are no skipped ports or remapping exceptions in this edition. The same rule applies to Base-Lite user extensions (%EXTENSION-1% and %EXTENSION-2%).

Deployment Inputs to Collect

  • Gateway MAC address.

  • Installation type: EV Full / EV Select (FourteenIP-2GW) or EV Lite (FourteenIP-2Lite).

  • BroadWorks service provider, group, domain, and two user IDs/line ports (EV Lite: also the trunk-group name and pilot user).

  • Site IP address, subnet mask, and default gateway.

  • Regional SBC selection: United States, Europe, or Asia-Pacific.

  • TLS/SRTP requirement, codec preference, DTMF method, fax mode, country tone, and time zone.

  • Approved 2 Port GW firmware package and the applicable provisioning URL (EV Full or EV Lite).

01 BroadWorks Device Profile and User Creation

FourteenIP-2GW Hardware Reference

Hardware item

FourteenIP-2GW specification

Voice interfaces

2 analog FXS ports for the FourteenIP-2GW deployment

Maximum concurrent calls

2

Dimensions

30 mm H x 150 mm W x 109 mm D

Installation

Desktop

Processor

Dual-core 880 MHz

Memory

128 MB RAM

Flash

16 MB

Power

12 VDC / 1.5 A; 6 W power consumption

Ethernet

PC and WAN 10/100/1000 Mbps RJ45 ports

Default addressing

DHCP enabled

2 Port GW connection panel: FXS 2, FXS 1, PC, WAN, and 12 VDC power.

There are two device-profile types for this gateway, depending on the installation type. Select the profile that matches the site.

BroadWorks environment

EV Full / EV Select profile

EV Lite profile

United States

FourteenIP-2GW

FourteenIP-2Lite

Europe

FourteenIP-2GW

FourteenIP-2Lite

Asia-Pacific

FourteenIP-2GW

FourteenIP-2Lite

Shared tag support

The BroadWorks network, digit-map, routing, codec, DTMF, fax, country, time-zone, TLS, and SRTP tags described in this guide follow the FourteenIP FXS gateway device-template tag set. For line-specific settings, use indexes 1 and 2.

Gateway port

BroadWorks user / line index

FXS 1

1

FXS 2

2

Building Users – EV Full / EV Select

The screenshots use the established Evolution Voice Gateway workflow. Apply the same sequence to the FourteenIP-2GW and select the 2GW device profile where the device type is chosen.

  1. Open the target BroadWorks group, select Users, and start the bulk-build workflow.

  2. Select the correct service provider / enterprise and group.

  3. Set the user count to the number of active analog ports, up to a maximum of two.

  4. Enter the user-ID format, select the domain, and generate passwords.

  5. Select the required naming convention and telephone-number range.

  6. Under User Device, select Hosted User and add the FourteenIP-2GW device profile.

  7. Enter the gateway MAC address on the optional device tab.

  8. Assign the line ports to FXS ports 1 and 2 and apply the required feature packs.

  9. Save the bulk build. In the import sheet, set allowAccessDeviceUpdate from false to true so multiple users can share the same gateway profile.

  10. Submit the job and confirm that all intended users were created and associated with the same 2GW profile.

Authentication password limit

BroadWorks normally generates a 30-character authentication password. FourteenIP gateways support a maximum of 25 characters, so update the authentication password after the users are created.

BroadWorks user list and bulk-build entry point.

Select the number of gateway users to build. For this model, do not exceed two active ports.

01 BroadWorks Device Profile and User Creation – Continued

Configure the required user naming and extension format.

Create or select the FourteenIP-2GW profile and populate the gateway MAC address.

Assign the hosted user device and line port.

Set allowAccessDeviceUpdate to true before submitting the bulk import.

01L EV Lite – Device, Trunk Group, and User Creation

Use this section when the site is an EV Lite installation. EV Lite gateways register as a trunk group with a pilot user rather than as two hosted users; each phone line is a Base-Lite user on the trunk group. The device type is FourteenIP-2Lite.

1) Add a Device for the Gateway

  • Device Type: FourteenIP-2Lite.

  • 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 gateway MAC address. It must be added before installation for provisioning to work.

2) Add a Trunk Group for the Gateway

Field

Required value

Trunk Name

(GROUPID)_GWL_*

Call Capacity

2 (one call per FXS port)

Access Device

FourteenIP-2Lite device created for the gateway

Authentication

Required

Authentication UserName

(GROUPID)_GWL_*

Authentication Password

Generate and record (25 characters maximum)

Trunk Group Identity

(GROUPID)_GWL_*@domain

Allow Unscreened Calls

Enabled

Allow Unscreened Emergency Calls

Enabled

CL Asserted ID Policy

Unscreened originating calls

3) Add a Pilot User

Field

Required value

User ID

Match the trunk group name: (GROUPID)_GWL_*@domain

First Name

GROUPID

Last Name

EV Gateway Lite * Pilot

Phone / Extension Number

N/A

Identity / Device Profile

FourteenIP-2Lite device created for the gateway

Trunk Group

Trunk group created for the gateway

Line Port

(GROUPID)_GWL_*@domain

Feature Pack

SIP-DID

Authentication Username

(GROUPID)_GWL_*

Authentication Password

Password generated for the trunk group

Assign As Pilot

Make this user the trunk-group pilot

4) Add Base-Lite 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 each Base-Lite user the Base Lite feature pack.

  • Build no more than two users per gateway – one per FXS port.

5) Map Extensions to FXS Ports

Add the %EXTENSION-x% device tags to the FourteenIP-2Lite device profile. The tag index is the gateway FXS port, so %EXTENSION-1% is FXS 1 and %EXTENSION-2% is FXS 2. Leave a tag blank for an unused port.

BroadWorks device tags used to add Base-Lite user extensions to the trunk-group gateway profile.

%EXTENSION-1% = 3607

%EXTENSION-2% = 3608

Key notes

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

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

The network, digit-map, routing, codec, DTMF, Hotline, fax, country, time-zone, TLS, and SRTP tags in sections 03-11 apply to EV Lite as well.

Use the EV Lite ACS username and FourteenIP-2Lite URL in section 13 – not the EV Full values.

02 Gateway GUI Login and Access

Finding the gateway IP address

To open the web GUI you need the gateway’s current IP address. How it gets that address depends on where it is in the deployment:

Stage

How the gateway gets its address

Out of the box

DHCP is on. When the gateway boots it requests an address from the site’s DHCP server.

After auto provisioning

The address comes from the network tags on the device profile (section 05): DHCP when %ETH1_DHCP% is on, or the static address in %ETH1_IP_ADDRESS%.

Hear the IP address from any analog phone

Plug an analog phone into any FXS port, lift the handset and dial ##. The gateway reads out its current IP address, firmware version and web port. Dial ## again after provisioning to confirm the final address.

Logging in

FourteenIP gateway web-login page.

Access item

2 Port GW value / behavior

Administrator password before provisioning

Contact support

Administrator password after auto provisioning

Auto provisioning changes the default password. Contact support for the value.

Administrator

Can view and modify all configuration parameters.

Operator

Limited view; cannot access security, password, software upgrade, import, or export pages.

Concurrent sessions

Only one active management session is supported.

  • Open the gateway IP address in a supported browser and log in as Administrator.

  • Coordinate changes with other technicians because a second login can end the first session.

  • Select Logout when finished.

  • Auto provisioning changes the default administrator password.

03 Routing > Digit Map

What the digit map is

An analog phone has no Send button, so the gateway has to work out when the caller has finished dialing. The digit map is the list of number patterns it uses to decide. As each digit is pressed, the gateway compares the digits so far against every pattern. As soon as they match a complete pattern, the gateway sends the call to BroadWorks. When a pattern ends in T, or nothing matches yet, the timers decide how long it waits.

Without a digit map every call would wait for the interdigit timer to run out before connecting. The digit map only decides when the dialed digits are sent; BroadWorks still decides where the call goes.

Gateway digit-map and timer settings.

BroadWorks tag

Generated parameter

Default

Purpose / range

%FIRST_DIGIT_TO%

FIRST_DIGIT_TO

15

Seconds the caller has to press the first digit after lifting the handset; 2-60 seconds.

%INTER_DIGIT_TO%

INTER_DIGIT_TO

5

Seconds the gateway waits between digits before sending; 2-60 seconds.

%CRITICAL_DIGIT_TO%

CRITICAL_DIGIT_TO

2

Shorter wait used once the digits already match a rule but more digits could still follow; 1-10 seconds.

%DEFAULT_DIGIT_MAP%

DEFAULT_DIGIT_MAP

See blocks below

Our dialing rules (US, or EU and APAC), on one line separated by the pipe character; up to 250 rules / 2280 bytes.

FourteenIP has two standard digit maps: one for US sites and one for EU and APAC sites. Paste the one that matches the site into %DEFAULT_DIGIT_MAP%.

US digit map

%DEFAULT_DIGIT_MAP% = *x.T|*1xx|[2-9]11|1[2-9]xxxxxxxxx|

[2-9]1[0,2-9]xxxxxxxxx|[2-9][0,2-9]xxxxxxxxx.T|

011xxx.T|9011xxx.T|xxxxxx.T|x.#|#xx|##

EU and APAC digit map

%DEFAULT_DIGIT_MAP% = *xx|#xx|##|[2-9]11|xxxx|1[2-9]xxxxxxxxx|

[2-9][0-9]xxxxxxxx|011x.|00x.|xxxxxxxxxx.T|x.#|x.T

The line breaks above are only for printing. Enter the tag value as one continuous line with no spaces.

Changing the digit map

To use the US digit map or the EU and APAC digit map, or different dialing rules for a site or country, set the %DEFAULT_DIGIT_MAP% tag on the device profile to the new rule set (one line, rules separated by |), rebuild the device files, and reset the gateway. The timers are changed the same way with %FIRST_DIGIT_TO%, %INTER_DIGIT_TO%, and %CRITICAL_DIGIT_TO%. Do not edit the digit map on the gateway; the next auto provisioning overwrites it.

What our digit maps do

US digit map – each rule, in the order it appears:

Rule

What it matches

When the call is sent

Example

*x.T

Star codes of any length (feature access codes)

When the caller stops dialing (interdigit timer)

*72, *67

*1xx

Four-character star codes that start with *1

Immediately after the fourth character

*1xx feature codes

[2-9]11

N11 service numbers, including 911 emergency

Immediately after the third digit

911, 411, 611

1[2-9]xxxxxxxxx

1 + area code + 7-digit number (11 digits, North American long distance)

Immediately after the 11th digit

1 305 555 0123

[2-9]1[0,2-9]xxxxxxxxx

12-digit numbers starting 2-9 whose second digit is 1 and third digit is not 1

Immediately after the 12th digit

–

[2-9][0,2-9]xxxxxxxxx.T

Numbers starting 2-9 whose second digit is not 1 (US local and toll-free style numbers)

When the caller stops dialing

305 555 0123

011xxx.T

International calls: 011 + country code + number

When the caller stops dialing

011 44 20 7946 0000

9011xxx.T

International calls at sites that use 9 as the outside-line access code: 9 + 011 + country code + number

When the caller stops dialing

9 011 44 20 7946 0000

xxxxxx.T

Any other number of six or more digits

When the caller stops dialing

5550123

x.#

Any number followed by #

Immediately when # is pressed; # skips the wait

3055550123#

#xx

# + two digits (feature deactivation codes)

Immediately after the second digit

#72

##

Gateway IP announcement

Immediately; the gateway reads out its IP address

##

EU and APAC digit map – each rule, in the order it appears:

Rule

What it matches

When the call is sent

Example

*xx

Star + two digits (feature activation codes)

Immediately after the second digit

*72

#xx

# + two digits (feature deactivation codes)

Immediately after the second digit

#72

##

Gateway IP announcement

Immediately; the gateway reads out its IP address

##

[2-9]11

Three-digit N11 service numbers

Immediately after the third digit

211, 911

xxxx

Four-digit extensions

Immediately after the fourth digit

3607

1[2-9]xxxxxxxxx

1 + area code + 7-digit number (11 digits, North American long distance)

Immediately after the 11th digit

1 305 555 0123

[2-9][0-9]xxxxxxxx

Ten-digit numbers starting 2-9

Immediately after the 10th digit

305 555 0123

011x.

International calls with the 011 prefix

When the caller stops dialing or presses #

011 44 20 7946 0000

00x.

International calls with the 00 prefix used in Europe and Asia-Pacific

When the caller stops dialing or presses #

00 44 20 7946 0000

xxxxxxxxxx.T

Any number of ten or more digits

When the caller stops dialing

0044 20 7946 0000

x.#

Any number followed by #

Immediately when # is pressed; # skips the wait

020 7946 0000#

x.T

Any other number (catch-all, for example 112 or national numbers of other lengths)

When the caller stops dialing

112

How the two maps differ

US digit map

EU and APAC digit map

Star codes

*x.T (any length, sent on timeout) and *1xx

*xx (star + two digits, sent immediately)

Extensions

No four-digit rule; caller presses # or waits for the interdigit timer

xxxx sends four-digit extensions immediately

International

011 or 9 + 011 (outside-line access code)

011 or 00

Everything else

xxxxxx.T (six or more digits)

x.T (any length)

Operational notes

  • Pressing # after a number sends the call immediately and ignores the timers.

  • Rules ending with T wait for the caller to stop dialing before sending.

  • Rules are checked as the caller dials, so the most specific rule that completes first sends the call.

  • At US sites that use 9 as the outside-line access code, the 9011xxx.T rule lets callers dial 9 before an international number.

Digit-map symbols

Symbol

Meaning

x

Any digit from 0 through 9.

[ ]

One digit from the listed range, for example [2-9].

.

The previous character can repeat: one or more digits.

T

Wait for the interdigit timer, then send.

#

Send immediately.

|

Separates rules in the BroadWorks tag.

04 Digit Manipulation and Routing Table

The routing table modifies called or calling digits and determines where calls are sent. Rules are evaluated from top to bottom, so specific rules must be placed above broader wildcard rules.

Rule format

Source Number Action Value

Example: FXS1 5032 REPLACE 2999 changes a call from port 1 to 5032 into 2999 before the next applicable action.

Action

Function

REPLACE

Replace a matching number with another value.

REMOVE

Remove digits from the matching number.

ADD

Add digits to the beginning or end.

KEEP

Retain only the selected part of the number.

ROUTE

Send the call to a destination.

NONE

Block the call.

BroadWorks routing tags

Each %ROUTE_TABLE_x% tag holds one routing rule, written in the rule format above (Source Number Action Value). Number the tags 1, 2, 3 and so on; the gateway applies them in that order. Leave a tag blank if it is not needed. In the example below, %ROUTE_TABLE_1% changes a call from any port to 5001 into 2999.

ROUTE_TABLE=

%ROUTE_TABLE_1%

%ROUTE_TABLE_2%

%ROUTE_TABLE_3%

…

%ROUTE_TABLE_24%

2 Port example

%ROUTE_TABLE_1% = FXS1-2 5001 REPLACE 2999

%ROUTE_TABLE_2% = FXS1-2 5003 REPLACE 3606

%ROUTE_TABLE_3% = FXS1-2 5005 REPLACE 3603

%ROUTE_TABLE_4% = FXS1-2 5006 REPLACE 3607

%ROUTE_TABLE_5% = FXS1-2 5008 REPLACE 6223

  • Use FXS1-2 when the rule must apply to every analog line on this model.

  • Use FXS1, FXS2, and so on when a rule applies to one port only.

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

  • Leave unused route tags (up to %ROUTE_TABLE_24%) blank for future expansion.

  • Do not place a catch-all rule above a specific transformation that still needs to run.

05 Network Configuration

Important – static IP sites: add the network tags before auto provisioning

DHCP is on by default (%ETH1_DHCP% = on), so DHCP sites need no network tags. For a static IP site, add the network tags – %ETH1_DHCP% = off, %ETH1_IP_ADDRESS%, %ETH1_NETMASK%, and %GATEWAY% – to the FourteenIP-2GW (or FourteenIP-2Lite) device profile before auto provisioning the gateway, so the static addressing is applied in the configuration the gateway downloads. Complete the approved gateway firmware upgrade before entering the ACS settings and rebooting the device.

Avoid a boot loop

On static IP sites, set the static IP settings correctly before provisioning the gateway. Incorrect static values can leave the gateway in a boot loop.

The gateway starts with DHCP enabled. After auto provisioning, check the final address under Basic > Network or by dialing ## from an analog phone.

BroadWorks network tags in the device profile.

Gateway network configuration page.

BroadWorks tag

Generated parameter

Example / default

Gateway setting

%ETH1_DHCP%

ETH1_DHCP

on (default); off for static

DHCP state on ETH1.

%ETH1_IP_ADDRESS%

ETH1_IP_ADDRESS

10.0.0.100

ETH1 IPv4 address.

%ETH1_NETMASK%

ETH1_NETMASK

255.255.255.0

ETH1 subnet mask.

%GATEWAY%

GATEWAY

10.0.0.1

Default gateway.

%NETWORKING_IPV6%

NETWORKING_IPV6

off

IPv6 network state.

%SUPPORT_IPV6%

SUPPORT_IPV6

0

0 disables IPv6 support.

%STUN_FLAG%

STUN_FLAG

0

0 disables STUN; 2 enables STUN.

%STUN_SERVER%

STUN_SERVER

–

STUN server IP / FQDN (only when STUN is enabled).

%OPENVPN%

OPENVPN

off

VPN state.

06 TLS and SRTP

Apply all TLS and SRTP tags together. Use the secure SBC assigned to the site’s region and include :5061 in both the registrar/proxy value and the TLS-server value.

BroadWorks device tags used to enable TLS and SRTP.

BroadWorks TLS device-profile tag values.

BroadWorks tag

Generated parameter

Required value

Result

%SBC_ADDRESS%

SIP_PROXY, SIP_REGISTRATION

Regional secure SBC:5061

Registrar and proxy server.

%TLS_SBC_ADDRESS%

SIP_TLS_PROXY

Regional secure SBC:5061

TLS server.

%SIP_PORT%

SIP_PORT

5061

TLS SIP signaling port.

%SIP_TRANSPORT%

SIP_PORT_TYPE

2

TLS transport (0 UDP, 1 TCP, 2 TLS).

%SRTP_METHOD%

SRTP_METHOD

5

Mandatory SRTP.

%ENABLE_TLS%

FT_SIP_1 – FT_SIP_2

1

Enables TLS on each mapped FXS line.

%ENABLE_SRTP%

FT_SRTP_1 – FT_SRTP_2

1

Enables SRTP on each mapped FXS line.

%DNS_SRV_NAPTR%

DNS_SRV_NAPTR

yes

Enables DNS SRV/NAPTR resolution.

SRTP method values

Value

SRTP behavior

0

RTP only; fallback to SRTP for incoming calls

1

SRTP only; fallback to RTP for incoming calls

2

Both RTP and SRTP; RTP preferred

3

Both RTP and SRTP; SRTP preferred

4

Disable SRTP

5

Mandatory SRTP – required for this TLS configuration

Regional secure SBC values

Region

Secure SBC value

United States

us-sbc-secure.14ip.net:5061

Europe

eu-sbc-secure.14ip.net:5061

Asia-Pacific

apac-sbc-secure.14ip.net:5061

06 TLS and SRTP – 2-Line Template Mapping

The 2GW template maps the shared TLS and SRTP tags to both analog lines: FT_SIP_1 and FT_SIP_2, and FT_SRTP_1 and FT_SRTP_2.

FT_SIP_1 = %ENABLE_TLS%

FT_SIP_2 = %ENABLE_TLS%

FT_SRTP_1 = %ENABLE_SRTP%

FT_SRTP_2 = %ENABLE_SRTP%

Reference result: secure registrar, proxy, TLS server, and SIP port 5061.

06 TLS and SRTP – Verification

Reference result: TLS transport, mandatory SRTP, and DNS SRV/NAPTR.

Reference result: per-line TLS and SRTP enabled.

Applied by auto provisioning

These TLS and SRTP settings come from the BroadWorks tags. The gateway applies them when it reboots after auto provisioning and then registers using TLS. The screenshots above show where to verify them.

07 DHCP Configuration

Gateway DHCP and automatic-discovery settings.

GUI field

BroadWorks tag

Generated parameter

Default / values

DHCP (IPv4)

%ETH1_DHCP%

ETH1_DHCP

on; on or off

DHCPv6 mode

%DHCPV6_MODE%

DHCPV6_MODE

Device defined

DHCP options

%DHCP_OPTION%

DHCP_OPTION

66|67

  • Option 66 provides the provisioning-server URL.

  • Option 67 provides the configuration filename.

  • For a static address, set %ETH1_DHCP% to off and fill in the network tags in section 05. Auto provisioning applies them.

%ETH1_DHCP% = on

%DHCP_OPTION% = 66|67

08 Codec and DTMF Configuration

Gateway codec and DTMF configuration page.

GUI field

BroadWorks tag

Default / values

Codec

%DEFAULT_CODEC%

PCMA/20, PCMU/20, G722/20, G723/30

DTMF method

%DTMF_METHOD%

AUDIO; INFO|2833, INFO, 2833, or AUDIO

Tone duration

%DIGIT_ON_TIME%

100 ms; 20-3000 ms

Interdigit pause

%DIGIT_OFF_TIME%

100 ms; 30-3000 ms

Minimum detection

%DTMF_ON_TIME%

48 ms; 32-96 ms

Detection increment

%DTMF_ADJUST%

16 ms

Required DTMF behavior

DTMF_METHOD value

RFC 2833 plus SIP INFO

INFO|2833

SIP INFO only

INFO

RFC 2833 only

2833

In-band audio

AUDIO

09 Hotline / Hotdial

Hotline is set per port with the BroadWorks tags below and is off by default. After provisioning, it can be checked under Line > Configuration.

BroadWorks line-level Hotline tags.

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 tag

Generated parameter

Purpose

Values

%HL_MODE_x%

FT_HOTLINE_x

Hotline mode for line x

0 disabled, 1 immediate, 2 delayed

%HL_NUM_x%

HOT_x

Hotline destination for line x

Dialable number

%DHOT_TO%

DHOT_TO

Global delayed-Hotline timer

2-20 seconds; default 5

Port 1 – Immediate Hotline to 2999

%HL_MODE_1% = 1

%HL_NUM_1% = 2999

Port 1 – Delay mode with 5-second timer

%HL_MODE_1% = 2

%HL_NUM_1% = 2999

%DHOT_TO% = 5

Disable Hotline

%HL_MODE_1% = 0

Replace the final index with 1 or 2 for the applicable gateway port.

10 Fax Configuration

Gateway fax configuration page.

BroadWorks tag

Generated parameter

Default

Behavior

%T38%

T38

on

on selects T.38 relay; off selects G.711 pass-through.

%T38_RATE%

T38_RATE

14400

Maximum fax rate; typical values are 9600 and 14400.

%T38_CHANGE_PORT%

T38_CHANGE_PORT

no

no keeps the RTP port; yes selects a new port.

%T38% = on

%T38_RATE% = 9600

%T38_CHANGE_PORT% = no

Additional T.38 tags in the template. The defaults are recommended.

BroadWorks tag

Generated parameter

Gateway default

Behavior

%T38_ECM_MODE%

T38_ECM_MODE

off (at 14400)

Fax error correction mode (ECM). Off by default when the maximum fax rate is 14400.

%T38_PTIME%

T38_PTIME

30

T.38 packet interval in milliseconds; 30 or 40.

%T38_REDUNDANCY%

T38_REDUNDANCY

4

Number of redundant signaling frames in each T.38 packet; 0-6.

%T38_DATA_RED%

T38_DATA_RED

1

Number of redundant image-data frames in each T.38 packet; 0-2.

%T38_CNG_SWITCH%

T38_CNG_SWITCH

Template value

Advanced T.38 negotiation setting. Leave at the template value unless engineering asks for a change.

%T38_REJECT%

T38_REJECT

Template value

Advanced T.38 negotiation setting. Leave at the template value unless engineering asks for a change.

%T30%

T30

Template value

Advanced fax protocol setting. Leave at the template value unless engineering asks for a change.

11 Country Tone and Time Zone

Set these values with the BroadWorks tags below. Preserve time-zone capitalization and underscores exactly.

BroadWorks tag

Generated parameter

Purpose

%COUNTRY%

COUNTRY = %COUNTRY%

Regional call-progress tone set.

%TIMEZONE%

TIMEZONE = %TIMEZONE%

Gateway clock and displayed time zone.

Country values

Value

Country / region

1

United States

7

Russia

30

Greece

33

France

34

Spain

39

Italy

44

United Kingdom

49

Germany

52

Mexico

54

Argentina

56

Chile

60

Malaysia

61

Australia

62

Indonesia

63

Philippines

65

Singapore

81

Japan

82

Korea

86

China

90

Turkey

91

India

92

Pakistan

98

Iran

213

Algeria

249

Sudan

263

Zimbabwe

327

Kazakstan

852

Hong Kong

886

Taiwan

971

United Arab Emirates

972

Israel

11 Time-Zone Values

Internal value

Gateway display

Midway

(GMT-11:00) Midway

Hawaii

(GMT-10:00) Hawaii

Alaska

(GMT-09:00) Alaska

Los_Angeles

(GMT-08:00) Los Angeles

Denver

(GMT-07:00) Denver

Phoenix

(GMT-07:00) Phoenix

Chicago

(GMT-06:00) Chicago

Regina

(GMT-06:00) Regina

Mexico_City

(GMT-06:00) Mexico City

New_York

(GMT-05:00) New York

Bogota

(GMT-05:00) Bogota

Glace_Bay

(GMT-04:00) Glace Bay

South_Georgia

(GMT-04:00) South Georgia

Newfoundland

(GMT-03:30) Newfoundland

Buenos_Aires

(GMT-03:00) Buenos Aires

Azores

(GMT-01:00) Azores Islands

Cape_Verde

(GMT-01:00) Cape Verde

GMT

(GMT) Greenwich Mean Time

London

(GMT) London

Amsterdam

(GMT+01:00) Amsterdam

Cairo

(GMT+02:00) Cairo

Tel_Aviv

(GMT+02:00) Tel Aviv

Harare

(GMT+02:00) Harare

Moscow

(GMT+03:00) Moscow

Tehran

(GMT+03:30) Tehran

Dubai

(GMT+04:00) Dubai

Muscat

(GMT+04:00) Muscat

Kabul

(GMT+04:30) Kabul

Karachi

(GMT+05:00) Karachi

Kolkata

(GMT+05:30) Kolkata

Kathmandu

(GMT+05:45) Kathmandu

Almaty

(GMT+06:00) Almaty

Bangkok

(GMT+07:00) Bangkok

Jakarta

(GMT+07:00) Jakarta

Beijing

(GMT+08:00) Beijing

Kuala_Lumpur

(GMT+08:00) Kuala Lumpur

Singapore

(GMT+08:00) Singapore

Taipei

(GMT+08:00) Taipei

Adelaide

(GMT+09:30) Adelaide

Canberra

(GMT+10:00) Canberra

Magadan

(GMT+11:00) Magadan

Auckland

(GMT+12:00) Auckland

GMT-12

(GMT+12:00) International Date Line East

Common regional values

Location

%COUNTRY%

%TIMEZONE%

Florida

1

New_York

California

1

Los_Angeles

United Kingdom

44

London

12 Firmware Upgrade

Use only the approved firmware package for the FourteenIP-2GW. The web interface accepts .img and .tar.gz packages.

Firmware download

For current firmware files, open the FourteenIP firmware library and select the 2 Port GW package: FourteenIP firmware library (SharePoint)

Tools > Software upgrade: select the approved firmware package.

  1. Log in to the gateway as Administrator.

  2. Back up the current configuration. For a .tar.gz upgrade, use Tools > Configuration maintenance > Export.

  3. Open Tools > Software upgrade, choose the approved 2GW package, and begin the upgrade.

  4. When the Backup / Skip screen appears on a provisioned gateway, select Backup.

  5. Allow the gateway to restart. Log in again, open Info, and confirm the target software version.

Always select Backup on a provisioned gateway. Never select Skip.

Critical safeguard

Selecting Skip can factory-wipe the device and remove its provisioned settings. Never power off, disconnect, or restart the gateway while the upgrade is running.

13 BroadWorks Auto Provisioning

Configure the Automatic Configuration Server under Advanced > System. Use the EV Full / EV Select values for FourteenIP-2GW sites and the EV Lite values for FourteenIP-2Lite sites, selecting the URL for the site’s region.

FourteenIP 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).

Auto provisioning supports configuration of all gateways or selective firmware upgrades, automatic update of gateway parameters, TFTP/FTP/HTTP/HTTPS, local web management alongside centralized provisioning, and retrieval of the ACS address through DHCP Option 66 or manual entry.

Prerequisite

Static IP sites only: add the site’s network tags (%ETH1_DHCP%, %ETH1_IP_ADDRESS%, %ETH1_NETMASK%, and %GATEWAY%) to the device profile before auto provisioning, and complete the approved firmware upgrade first. See section 05.

EV Full / EV Select Sites – FourteenIP-2GW

Item

2 Port GW value

Username

Contact support

Password

Contact support

United States URL

https://xsp.14ip.net:443/dms/FourteenIP-2GW/

Europe URL

https://eu-xsp.14ip.net:443/dms/FourteenIP-2GW/

Asia-Pacific URL

https://apac-xsp.14ip.net:443/dms/FourteenIP-2GW/

EV Lite Sites – FourteenIP-2Lite

Item

2 Port Lite value

Username

Contact support

Password

Contact support

United States URL

https://xsp.14ip.net:443/dms/FourteenIP-2Lite/

Europe URL

https://eu-xsp.14ip.net:443/dms/FourteenIP-2Lite/

Asia-Pacific URL

https://apac-xsp.14ip.net:443/dms/FourteenIP-2Lite/

  1. Log in to the gateway and open Advanced > System.

  2. Locate the management-system or ACS URL field.

  3. Enter the regional URL and credentials for the site type shown above (EV Full: FourteenIP-2GW; EV Lite: FourteenIP-2Lite).

  4. Save the changes and reboot the gateway.

  5. After the reboot, confirm that the gateway contacts DMS, retrieves its assigned configuration, and registers its intended lines (EV Lite: the trunk group and its Base-Lite users).

Reboot required

The gateway does not contact the ACS and download its configuration until it restarts. Once provisioned, the template keeps the ACS address in ACS_URL = %ACS_URL% and the DMS configuration path in CFG_URL.

End of FourteenIP 2 Port GW Configuration Guide