Outbound (PBX -> Telco) - NBE listens on port 5066 for a sip invite from the PBX, once this invite is received NBE places the call out to the telco

Inbound (Telco -> PBX) - NBE sends a sip invite to port 5060 which is the port the PBX listens on, once the pbx receives this the call gets setup with the PBX.

Now below is a diagram showing how this all works. Also the ports and IP addresses can be changed using the "Quick Setup" in the NBE manager.

How to Restart NBE Gateway

Using NBE Gateway Manager:

Open your favourite web browser on the system running NBE Gateway
Go to "http://localhost:7783/"
Click on the "Stop Gateway" button...wait for NBE Gateway to stop
Clcik on the "Start Gateway" button....wait for the NBE Gateway to start successfully

Manually Restarting the NBE Gateway Service

Click on "Start -> Control Panel -> Administrative Tools -> Services"
Scroll through the list of sevices and look for the one named "Netborder Express Gateway"
Right click this server and select "restart" or "start" from the pop-up menu.

Server With Multiple IP Addresses Will Not Start

Edit your "\Program Files\Netborder\Express\Gateway\config\gw.properties" and place the following line in there

"netborder.net.primaryIPAddress=X",

X being the ip address that you want NBE to listen on. After this is done start NBE again and it will start up.

For more information on IP Addresses Configuration see How IP address configuration works

After install/re-install there are no Sangoma cards available

After performing a new install or a re-install of NBE you find that there are no Sangoma ports active, Windows says it found new hardware, and/or after configuring the cards in NBE the gateway fails to start.

The problem is that the Sangoma drivers did not install correctly and need to be re-installed. You can confirm this by looking at the "Device Manager". The Sangoma card(s) will show up as "Network Controller"

To solve the problem, uninstall the drivers, reboot and install the drivers again.

Go to the Windows "Device Manager" and uninstall the "Network Controller" by right-clicking and selecting "Uninstall".
Go to the Windows "Add or Remove Programs" and remove all "Windows Driver Package - Sangoma Technologies...", if there are any there
Reboot the computer
After reboot Windows will report that new hardware has been found and will try to install the drivers, click "cancel" to this window. You will see a window for each Sangoma card you have.
Click on "Start -> All Programs -> Netborder Express Gateway -> Install Device Drivers". A Command Prompt window will open up and the drivers will be installed. If any "New Hardware Found" windows pop-up, click the "cancel" button.
Once the drivers are installed check in the device manager that the cards are detected properly. In the example the system has an A200 and an A104 card installed.
If you continue to have problems please contact Sangoma support at "techdesk@sangoma.com"

General Configuration

How to Enable Development Mode

Click on "Start -> All Programs -> Netborder Express Gateway -> Configuration -> Edit Global Configuraiton File"
In the file that is opened search (ctrl+f) for "netborder.run.mode"...you should be sent to the end of the file
Remove the "#" from "#netborder.run.mode=development"
Add a "#" to "netborder.run.mode=production"
Save the file
Restart the NBE Gateway...see "How to restart NBE Gateway"

How to assign particular channels to particular group

One "Channel Group" (PSTN Config of GUI) per campaign, assign channels in groups, then specify a channel group to use in routing rules based on the
campaign to use (phone number prefix?)

Add BChannel2.png

How to dynamically disable/enable channels on the Gateway

It is possible to put specific channels in maintenance mode while the gateway is in operation with the use of the command-line executable named "netborder-oam-cmd.exe" found in the /bin directory of the installation directory.

The following command disables one or many channels.

netborder-oam-cmd.exe localhost:18086 pstn-channel-op oos REGEX

where "REGEX" is a regular expression matching the name of the channel(s) you want to put out-of-service (oos).

When you are ready to put the channels back in service, just re-issue the same command, this time replacing oos by is (in-service)

You can find information about regular expressions here.

There are two types of channel name formats: One for digital interfaces (A101,102,104 and 108) and one for analog interfaces (A200):

Digital channel name format

b1(B1 - A102_digital)di2(B1I2)-c0

The REGEX to match the channel(s) will have the following fo rmat: "bX.*diY.*-cZ"
X is the board number
Y is the digital interface number
Z is the channel number

To take all channels on board 1 down and back up
netborder-oam-cmd localhost:18086 pstn-channel-op oos "b1"
netborder-oam-cmd localhost:18086 pstn-channel-op is "b1"

To take digital interface 1 on board 1 down and back up
netborder-oam-cmd localhost:18086 pstn-channel-op oos "b1.*di1"
netborder-oam-cmd localhost:18086 pstn-channel-op is "b1.*di1"

To take multiple digital interfaces on board 1 down and back up (interface 1 to 4)
netborder-oam-cmd localhost:18086 pstn-channel-op oos "b1.*di[1-4]"
netborder-oam-cmd localhost:18086 pstn-channel-op is "b1.*di[1-4]"

To take a digital channel 1 on board 1 interface 1 down and back up
netborder-oam-cmd localhost:18086 pstn-channel-op oos "b1.*di1.*c1$"
netborder-oam-cmd localhost:18086 pstn-channel-op is "b1.*di1.*c1$"

To take multiple digital channels on board 1 interface 1 down and back up (1 to 9)
netborder-oam-cmd localhost:18086 pstn-channel-op oos "b1.*di1.*c[1-9]$"
netborder-oam-cmd localhost:18086 pstn-channel-op is "b1.*di1.*c[1-9]$"

Analog channel name format

b1(B1 - A200_analog)ai1(B1I1)-c1
b1(B1 - A200_analog)ai2(B1I1)-c1

The REGEX to match the channel(s) will have the following format: bX.*aiY
X is the board number
Y is the analog interface number or channel.

To take board 1 down and back up
netborder-oam-cmd localhost:18086 pstn-channel-op oos "b1"
netborder-oam-cmd localhost:18086 pstn-channel-op is "b1"

To take analog interface/channel 1 down and back up
netborder-oam-cmd localhost:18086 pstn-channel-op oos "b1.*ai1$"
netborder-oam-cmd localhost:18086 pstn-channel-op is "b1.*ai1$"

To take a group analog interfaces/channels down and back up [1-3]
netborder-oam-cmd localhost:18086 pstn-channel-op oos "b1.*ai[1-3]$"
netborder-oam-cmd localhost:18086 pstn-channel-op is "b1.*ai[1-3]$"

How to Enable Call Recording

This feature can come in handy when you want to record a few calls for troubleshooting purposes. However, it is very CPU intensive and should not be used as a permanent solution for call recording.

Click on "Start -> All Programs -> Netborder Express Gateway -> Configuration -> Edit Global Configuraiton File"
In the file that is opened search (ctrl+f) for "netborder.gw.recordCalls.enabled=false"...
Set the value to true and save the file
The location of the recordings is defined by the "netborder.gw.recordCalls.directory" property. The default value is logs/recording/
Restart the NBE Gateway...see "How to restart NBE Gateway"

How to dynamically activate/deactivate call recording on the Gateway (version 2.1+)

It is possible to activate/deactivate the call recording feature while the gateway is in operation with the use of the command-line executable named "netborder-oam-cmd.exe" found in the /bin directory of the installation directory.

To turn on recording:

netborder-oam-cmd localhost:18086 set-config-param netborder.gw.recordCalls.enabled true

To turn off recording:

netborder-oam-cmd localhost:18086 set-config-param netborder.gw.recordCalls.enabled false

How IP address configuration works

There are 3 parameters that control the IP Addresses assignement of the gateway.

These parameters are located in the gw.properties file in the config folder of the installation directory.

netborder.net.primaryIPAddress

Used to set the SIP Contact we use in our SIP messages.

netborder.sip.userAgent.IPAddress

A comma separated list of addresses, ports & transport on which the SIP stack listens for incoming SIP messages

netborder.media.rtp.IPAddress

The ip address used to send & receive RTP packets, if this value is not set in the properties file, the value from primaryIPAddress is used.

The gateway can only send and receive RTP traffic on one IP address

There are 3 parameters (located in the gw.properties file in the config folder of the installation directory) that control the IP Addresses assignment of the gateway:

netborder.net.primaryIPAddress: Used to set the SIP Contact used in the SIP messages

netborder.sip.userAgent.IPAddress: A comma separated list of addresses, ports & transport on which the SIP stack listens for incoming SIP messages

netborder.media.rtp.IPAddress: The ip address used to send & receive RTP packets, if this value is not set in the properties file, the value from primaryIPAddress is used.

The gateway can only send and receive RTP traffic on one IP address. However, SIP signaling can use multiple IP addresses and ports.

PSTN Configuration: Analog

Why Am I Seeing "B-Channel[0] failed to setup callerID detector" In My Application Log?

If you are seeing this error in your Application log then your ToneDecoder.dll file has not been registered correctly. To fix this go to "\Program Files\Netborder\Express\Gateway\drivers\sangoma\hw_abstraction_driver\" from the command prompt and run the command "regsvr32 ToneDecoder.dll". Once this is done then try to start NBE again to be sure the issue is corrected.

NBE 2.0 can't open Analog B-channel

Symptom:

NBE starts but on the "System Status" page of the Gateway Manager you see the following error message:

B-Channel[X] Can't open Analog B-channel wanpipe! This error could occur if: - WANPIPE is not a valid wanpipe ID. Edit the pstn-config.xml to specify a valid wanpipe for sangoma interface ID=<NBE ID value for A200>

Solution:

You can get this error message if you do not have your FXO modules plugged in the correct socket on the A200. The modules have to go sequentially into the sockets, starting at the lowest numbered socket, and without any gaps.
The lowest numbered socket is the socket furthest away from the metal bracket on the lowest numbered card.
The lowest numbered card (when using an A200 with atleast 1 Remora card connected via a Backplane) is the left-most card in the bundle when looking from the metal bracket to the backplane.

a200-remora-anotated -v2.jpg

International deployments with analog boards

For deployments with analog boards outside of North America, there are important aspects of the gateway configuration to consider:

1. Analog line variant

Analog line physical characteristics (ex. electrical impedance) are different from a country to another. This is set in the Physical Configurations->Analog Configuration->Analog Variant value of the Gateway Manager PSTN Config. About 110 countries are supported. If your country isn't in the list, try neighboring countries or countries you know have a similar phone system.

2. Tone detection set

In-band tones used to report progress of a call are different from country to country. The tone definition set used for detection by the gateway are selected via Physical Configurations->Audio Configuration->Tone Set Attributes value of the Gateway Manager PSTN Config. Tone sets are available for all the countries for which the line variant is supported.

If your country isn't in the list, an existing tone detection set (.xml file) will need to be modified to match tone definition of your country, following the instructions found in the Tone Configuration Guide located in the "doc" subdirectory of your NBE installation. You would not be able to rename the .xml file to the name of your country, so you'll need to refer to the tone set using the original country name (ex GERMANY if you modified the file called germany.xml to match your country tones.)

3. Tone generation set

The gateway must generate in-band tones in some conditions (ex. ringback played back on inbound calls). Currently, audio files must be provided by the gateway installer if deployed outside North America. See the Tone Configuration Guide located in the "doc" subdirectory of your NBE installation for details.

4. Caller ID detection

The delivery mode of Caller ID changes from country to country. The NBE Release Notes provides the list of countries for which Caller ID is supported.

PSTN Configuration: Digital

Caller name is not showing up.

The caller name arrives in a FACILITY message and the gateway is configured to get the caller name from a DISPLAY IE in the SETUP message. To get the caller name right, you will need to change the path configuration of the gateway as follows:

In the Pstn config tab of the Gateway Manager, choose "Call Control" and then "ISDN Configurations" in the panel on the left.
Double-click on the Call control config name in the ISDN Configuration Grid (usually FAS1-T1)
A Fas Configuration display menu will then appear, in the "Caller Name Location Method" scrolling menu, choose "IN-FACILITY-MSG"
In the "Wair Facility Delay (ms)" menu enter 100
Save the new configuration by clicking on the Save button.
If you've got more than one Call Control Configuration, you will need to perform operations 3 to 5 for all your Call Control configurstions.
Restart the gateway

Why Is There No Ringing When I Call Into The PRI?

This is because NBE is configured for the switch to provide the ringing, so if it is not then you will not hear any ringing. To fix this issue simply tell NBE to provide the ring back tone.To do this follow the steps below.

1) First go into the "Gateway Manager" web interface and then click on "Configuration -> PSTN Config".

2) Next go to "Call Control -> ISDN configurations" and then select your T1 configuration.

3) Next in the configuration change the "Inband Progress Tones Generation:" as shown below to "ALWAYS".

4) Stop and start the gateway to apply the changes.

NBE 1.6

To do this please edit your routing rules which should be located at "\Program Files\Netborder\Express\Gateway\config\pstn-config.xml". Once in there simply find the lines as shown below in gray and then add the new lines below in orange.

How To Change the PRI Numbering Plan.

On some rare switches they will require the numbering plan to be set. Below shows you how to set this for the calling and called number and then the possible values for both fields. Now it would be best to get the telco to tell you exactly how to configure this but if not then you can just simply try all combinations. Now all of this will be done in the \Program Files\Netborder\Express\Gateway\config\routing-rules.xml file in the default_pstn_out rule. Each time this is set you need to restart NBE gateway.

There is two parameters below to set the number plan type for the "called" number which are below.

pstn.out.phoneNumber.type
pstn.out.phoneNumber.numberingPlan

Now for the "calling" number there is two other parameters as shown below.

pstn.out.ani.type
pstn.out.ani.numberingPlan

The "type" field can be set to one of the following numbers shown in the list below.

Value    Description
0    Unknown
1    International number
2    National number
3    Network specific number
4    Subscriber number
5    Abbreviated number
7    Reserved for extension

The "numberingPlan" field can be set to one of the following numbers shown in the list below.

0    Unknown
1    ISDN/telephony numbering plan (Recommendation E.164 [19])
3    Data numbering plan (Recommendation X.121 [21])
4    Telex numbering plan (Recommendation F.69 [22])
8    National standard numbering plan
9    Private numbering plan
15    Reserved for extension

Below is a sample of how the rule may look once modified. Note the changes from the default are in orange.

Setting Up NBE To Be The Network Side (telco side).

#1 - Clocking - You can change the clocking in NBE as shown in the picture below.

#2 - Signaling - You will need to change to network mode termination as shown in the picture below.

#3 - Cabling - You will need a cross over cable if you are connecting back to back with NBE or another pbx. For pinouts go tohttp://wiki.sangoma.com/Pinouts#A101/2/4%20Cross. Now note this is different pinouts then a ethernet cross over cable.

Routing Rules

Configuring NBE to work with DID's (DDI)

To pass the DID from the telco to the SIP pbx simply just modify your "default_sip_out" rule as shown below, this is found in your "\Program Files\Netborder\Express\Gateway\config\routing-rules.xml" configuration file. This will save the pstn.in.dnis into the %1 variable since the pstn.in.ani has the %0 variable because it was declared before the dnis. Now the (.*) is what saves it into the next available variable.

3CX Is Sending CID In Quotes

If 3CX is sending CID in quotes then you can simply remove this by editing your routing-rules.xml which can be found in the file browser of the management interface. Once in there locate the rule "default_pstn_out_with_caller_name" as shown below.

Then change the sip.in.from.displayName line so it looks like the rule below. Once this is done then stop and start the gateway and the issue will be resolved.

Sometimes 3CX is not responding to NBE SIP INVITES

If the CID has other characters other then letters and numbers then 3CX has been known not to respond. So to fix this you can modify the default routing rule and add a second routing rule to send CID with a comma in it.

1) Take your normal routing rule and change "(.*)" to "([0-9a-zA-Z]+)" as shown below.

2) Then add a second routing rule which will get any calls with a comma in it, eg. "Doe, John". This new rule will have 2 variables as shown below and there will be a space between them instead of a comma, you can see this below where is says "%2 %3". So insure the space is kept and other then that just copy and paste this rule below the first rule. All required changes from the default rule above have been high lighted.

3) Then simply restart the gateway and test to insure the issue has been resolved.

Caller ID on SIP REFER transfers is incorrect/incomplete

By default, the routing rule handling the SIP REFER requests will copy the From: header to the resulting INVITE message, so that the Caller Number presented to the transfer target is the one of the transferring SIP endpoint (IVR or person triggering the transfer).

Default Rule:

To present the Caller Number corresponding to the PSTN number associated to the call instead, the contents of the To: header must be used instead

Alternate rule:

Also, the default rule only copy over the Caller Number, and not the Caller Name if available. The following rule shows how to extract the Caller Number and Caller Name from the PSTN side of the call and package it in the resulting INVITE message.

PSTN Caller Number and Name rule:

Debugging

How to record RTP traffic using Wireshark when NBE and PBXnSIP are on the same system

On Linux based systems this is not a problem, simply set Wireshark to listen on the "lo" interface.

On Windows based systems this is a little tricky as Wireshark cannot listen to the 127.0.0.1. Use the following instructions to "bounce the traffic to your default gateway and back so that Wireshark can record the traffic.

NOTE: THIS IS ONLY FOR DEBUGGING DO NOT RUN THIS IN A PRODUCTION ENVIRONMENT

Setup NBE to send all traffic to your LAN IP address
1. Open the NBE Gateway Manager, go to the "Routing Rules" tab under the "Configuration" Tab.
2. Find the default routing rules block, this block will contain the following line:
  <param name="sip.out.requestUri" expr="sip:%0@127.0.0.1:5060"/>
3. Change the line so that the traffic is sent to the LAN IP address (in my case it was 192.168.1.90):
  <param name="sip.out.requestUri" expr="sip:%0@192.168.1.91:5060"/>
4. Click the "submit changes" button to update the routing rules.
5. Next open the "gw.properites" configuration file under the "config" folder on the "File Browser" tab of the NBE Gateway Manager
6. In this file we need to tell NBE to send all RTP traffic to the LAN IP address. Search the file for "netborder.media.rtp.IPAddress"
7. Uncomment this option and it to your LAN IP adress.
  netborder.media.rtp.IPAddress=192.168.1.91
8. Restart NBE to apply all the changes
  -
Setup PBXnSIP to send traffic to the LAN IP address rather then 127.0.0.1
1. The only part of PBXnSIP that needs to be changed is the "Outbound Proxy" field of the the trunk configuration
2. Login into the PBXnSIP Domain, go to the "Trunks" tab, and then click on the "edit" icon of your NBE trunk.
3. Change the "Outbound Proxy" field to your LAN IP address...leave the port the same
4. Restart PBXnSIP to apply the change
  -
Setup the Windows Routing table to forward all messages destined for your LAN address to the default gateway
1. Start the Windows command prompt by clicking "Start", "Run" and running "cmd"
2. Now we need to tell the Windows Routing table that all packets destined for your LAN IP address is sent to their destination by way of the default gateway. Run the command:
  route add 192.168.1.91 mask 255.255.255.255 192.168.1.1 metric 1
3. Run "exit" to get out of the command prompt
  -
Setup Wireshark to limit the capture to only the traffic between NBE and PBXnSIP
1. Start a new capture in Wireshark with the following capture rule
  src 192.168.1.91 && dst 192.168.1.91
2. Reproduce the "failure"
3. Save the capture as a .pcap file so that it can be opened by other applications (tcpdump, ethereal, etc)

NBE - PRI Span Debugging

1) The first step is to check the physical layer connection between NBE and the telco.To do this we will need to open wanpipemon following the steps below.

a) Right click on the port you want and click properties.

b) Click on the "T1/E1 Groups of channels" tab and then select a channel group. Once selected right click and pick "Start WANPIPE Monitor".

c) In wanpipemon click on "T1/E1 Tools" and then click "Alarms" to view the alarm status page.

d) As you can see you have all the different T1/E1 alarms here plus some error counters.

OOF means the line framing is out of frame so we are receiving bad data. Also on E1 you can toggle the framing and this may correct the issue.
AIS means one of the repeaters down stream are in alarm so speak with the telco about this.
YEL means the telco is in alarm so call them and find out what alarm they are in
LOS means loss of signal so the line is probably not connected. If the line looks good try a cross over cable. Note this is not the same as a ethernet cross over; pinouts are available at http://wiki.sangoma.com/Pinouts#A101/2/4%20Cross

2) Once you have a physical layer connection then you just simply need to insure the D channel is up. To do this simply open your NBE gateway manager (http://localhost:7783/) and click on "Status and Controls" and then select "Channel Status" in there. Then insure the status looks as shown below, also note below is only a single T1 so E1 and multiple links will show more channels.

3) Now if you have a different status other then "Idle" then refer to the legend below. If you can not resolve the issue please send everything at http://wiki.sangoma.com/SangomaTechSupport#nbe totechdesk@sangoma.com

4) Now if the D channel is up but calls do not work then place NBE into development mode by following the steps at http://wiki.sangoma.com/NBE-debugging#enable_devel_mode. Once in development mode there will be a new log for each time in "\Program Files\Netborder\Express\Gateway\logs\call-logs\<<Number of Year>>\<<Number of Month>><<Name of Month>>\<<Number of Day>>\<<Hour>>" eg. \Program Files\Netborder\Express\Gateway\logs\call-logs\2009\11November\27\11\. Now before you continue to debug the calls first go to http://wiki.sangoma.com/nbe-faq#basic to get an understanding of how this all works.

5) Now to start tracing the calls simply start with an inbound call first if inbound is not working. Now below is a trace of a working inbound call and one where the PBX does not respond to NBE's SIP messages.

Inbound Call Where PBX Does Not Respond --> Coming Soon!

Inbound Call That Works --> Coming Soon!

6) Now below is a trace of a outbound call that the pstn side rejects the call and the other call is a working outbound call. Also note if you call out and the log file is not being made you ether do not have development mode enabled (step 4), or your pbx is not sending the SIP message to IP and port you setup in the quick setup.

Outbound Call That Is Rejected From The Telco --> http://wiki.sangoma.com/NBE-pri-span-debugging-outbound-rejected

Outbound Call That Works --> http://wiki.sangoma.com/NBE-pri-span-debugging-outbound-working

7) If you can not sort out the issue please go to http://wiki.sangoma.com/SangomaTechSupport#nbe and send everything into techdesk@sangoma.com.

Wiki :: Sangoma Technologies

Because it must work!

NetBorder Express Gateway FAQ