Document Revision History
|
Version |
Changes Made |
Release Date |
|---|---|---|
|
1.0 |
Created Document |
25 April 2023 |
|
1.1 |
Additional Information added for creation and deployment of the EVG within Broadworks |
15 May 2023 |
|
1.2 |
Change to Provisioning details for all EVG Models |
11 Aug. 23 |
|
1.3 |
Added information for EVG 4s and 8s |
25 Sep. 25 |
Overview
The Evolution Voice Gateway is a multi-functional analog gateway offering seamless connectivity between IP-based telephony networks and legacy telephones (POTS) and fax machines. It comes in 2 build types. The EVG-24/48/96 S-A which provides 24, 48 or 96 FXS ports via RJ21 interfaces and the EVG-128S-B which provides up to 128 FXS ports via modularized boards with RJ45 interfaces. Each board has 2 RJ45 ports each carrying 4 FXS port for a total of 8 per board.
The Evolution Voice Gateway supports the standard SIP protocol and is compatible with leading IMS/NGN platforms and SIP-based IP telephony systems.
Installation Recommendations
There are Requirement for the Installations of the Evolution Voice Gateway to ensure proper performance and life span of the Device. If these requirements are not met, it could lead to intermittent issues or full device failure.
-
To reduce the interference with telephone calls, it’s highly recommended that telephone lines connected to the gateway should be routed away from power cables.
-
The gateway accepts AC input voltage of 100-240V. Please ensure safe and stable power supply.
-
Ensure there is enough bandwidth to guarantee the network stability of the gateway.
-
To avoid overheating, please do not pile up the gateway with other devices and make sure the gateway has good ventilation around.
-
To avoid any accident that might cause malfunction, it is advised to install the gateway in an equipment room where temperature and humidity are appropriate.
-
It is highly advised to place the gateway horizontally on a flat surface or mount it securely in a network cabinet to avoid damage.
Broadworks requirements
Auto Provisioning Through DMS
All Evolution Voice Gateways are setup to auto provision using Broadworks DMS. This will enable us to manage configurations and handle mass deployment. As of right not there is no redirect server, the Auto provisioning parameters will need to be manually added to each gateway.
Building EV Gateway User – EV Full/ EV Select.
Building users
Navigate to the group where the new users are being built, go to the users tab and select the bulk build option.
Select the service provider/ enterprise and group where the users are being built.
Select the number of users to build:
Select the user ID in the normal format and set the Domain ID.
Auto Generate passwords.
Select the name format to bulk build:
Select the number range to build.
Under user device select “Hosted User”.
Add and new device, click the + symbol and select the appropriate device type from the list.
Go to the optional tab, EV Gateways use their MAC address for provisioning. This must be added to the device profile otherwise auto provisioning will fail.
Device Name should follow normal naming conventions.
Add line port, following the normal standard.
Add feature packs as normal.
Add any Department, details, contacts, and address needed.
Click save and you will be directed to the import sheet, from here go to row allowAccessDeviceUpdate and change the value from false to true. This will allow multiple users to be added to the same device profile.
Press submit and wait for the users to be built.
Key notes
There are a few key notes to keep in mind when building a new device profile or adding extensions to an existing device profile.
-
EV Gateways use their MAC address for provisioning, this must be added to the device profile otherwise auto provisioning will fail.
-
If completing a Bulk upload, the update device profile option must be set to TRUE and the MAC must be entered on all users, otherwise it will be removed from the device profile.
-
The default Auth Password length in BroadWorks is 30 characters. EV Gateway only supports 25 Characters. An Auth password will need to be run once users are built.
There are 2 different device profile types for each EVG model, depending on the type of install being completed.
If the Gateway is being used on an EV Full or EV select site, use the EVG-__S device profile type ( where __ is the number of ports)
If the Gateway is being used on an EV Lite site, use the EVG-__S-Lite device profile type ( where __ is the number of ports)
EV Lite Setup
EV Lite is supported on the Evolution Voice Gateway, but there are a few requirements to how the trunk group/ users are built in order for calls to route properly.
EV Lite groups must be added to an enterprise.
Building Users
-
We need to add capacity to the enterprise trunking call capacity.
-
For each Gateway we add to an enterprise, 10 channels should be added to the enterprise level capacity. (Note 50 channels should be added for Gateways 1 to 5 into the enterprise and 10 channels for every Vega after that.)
-
Vega 1 = 50, Vega 2 = 50, Vega 3 = 50, Vega 4 = 50, Vega 5 = 50, Vega 6 = 60, Vega 7 = 70
-
1 Guest Lite Vega = 10 Business Trunking License Units added at enterprise level.
-
-
We now need to add Group level capacity, for each EV Guest Vega we add to a group, 10 channels should be added to the group level capacity. (Note 50 channels should be added for Vega 1 to 5 into the group and 10 channels for every Vega after that.)
-
Vega 1 = 50, Vega 2 = 50, Vega 3 = 50, Vega 4 = 50, Vega 5 = 50, Vega 6 = 60, Vega 7 = 70
-
1 Guest Lite Vega = 10 Business Trunking License Units added at Group level.
-
-
Add a device for each EV Gateway:
-
The Device Type should be EVG-__S-Lite ( where __ is the number of ports on the device)
-
Device Name should be – (GROUPID)_GWL_*(* is the location letter A,B,C etc)
-
An example name would be EVATEST_GWL_A (Group ID_Gateway_Lite_ Location)
-
Add the MAC of each EV Gateway, if known at the time. (Will need to be added before installation for provisioning to work)
-
-
Add a trunk group for each Vega.
-
Trunk Name = (GROUPID)_GWL_*(* is the location letter A,B,C etc).
-
Call Capacity for each Vega = 50
-
Access Device = Device created in step 2 = (GROUPID)_GWL_*(* is the location letter A,B,C etc)
-
Authentication is required.
-
Authentication UserName = (GROUPID)_GWL_*
-
Authentication Password = Should be generated and recorded.
-
Trunk Group Identity = (GROUPID)_GWL_*(* is the location letter A,B,C etc)@domian
-
Allow Unscreened Calls = Enabled
-
Allow Unscreened Emergency Calls =Enabled
-
Cl Asserted ID Policy = Unscreened originating Calls
-
-
Add a pilot user.
-
User ID should match the Trunk group name=
-
(GROUPID)_GWL_*(* is the location letter A,B,C etc)@domain
-
First Name must be the GROUPID.
-
Last Name EV Gateway Lite * Pilot (* = Vega location letter)
-
Phone Number/ Extension Number = N/A
-
Identity/Device Profile = The device profile created in step 3
-
Trunk Group = the trunk group created in step 4
-
Line Port = (GROUPID)_GWL_*(* is the location letter A,B,C etc)@domian
-
Feature Pack for this Pilot user should be SIP-DID
-
Authentication UserName = (GROUPID)_GWL_*(* is the location letter A,B,C etc)
-
Authentication password = Authentication Password generated in step 3
-
Assign As Pilot = make this user the pilot user of the trunk group
-
-
Add bedroom users to trunk group
-
User ID = standard user format (GROUPID)(Extension Number)@Domain
-
Add extension number and phone number
-
Select Trunking
-
Trunk Group = the trunk created in step 3
-
Line/Port = standard user format (GROUPID)(Extension Number)@Domain
-
Feature Pack- assign the user with a Guest Light Feature, see table in doc for more details.
-
-
Assign extensions to ports on the device
-
EV Lite extensions will not auto populate to the ports, this must be done manually by custom tags. (Bulk upload on Magic can be used)
-
The tag is %EXTENSION-x% where x is the port number (EVG ports start at 0)
-
Key notes
-
The First Name of the pilot user must be the group ID.
-
The Lineport for all users must be follow the traditional format of
{{ groupId }}{{ extension }}@{{ domain }} -
The extensions have to be manually assigned to the ports on the device using custom tags.
-
EV Gateway’s Port count starts at 0 not 1
–
Hardware
Wiring Guide
EVG-48/96 S-A
-
Evolution SIP Gateway – 48 x FXS, T38 FAX, G711, G723, G729. SNMP, IPv6 & Evolution SIP Gateway – 96 x FXS, T38 FAX, G711, G723, G729. SNMP, IPv6
-
The EVG-48S-A has 2 LAN ports and 2 RJ21 connectors, the EVG-96S-A has 2 Lan Ports and 4 RJ21 connectors.
Connection Diagram
-
Network Connection (Use LAN0):
-
Analog Phone Connection:
-
Power Connection & Grounding:
RJ21 Wire Sequence
The EVG-48/92 S-A both have RJ21 interface as FXS port.
One RJ21 cable has 25 pairs of wires, with the 25th pair of wires vacant. This means each RJ21 interface supports 24 FXS ports.
EVG-128S-B
The EVG-128S-B supports up to 128 ports using 8 port FXS boards, it always requires the house & MCU boards allowing for a maximum of 16 FXS boards.
-
It has 2 LAN ports and 32 RJ45 connectors (when outfitted with 16 FXS boards).
-
The EVG-128S has a max BTU of 358.05 when it is fully active.
Connection Diagram
-
Network Connection (Use LAN0):
-
Analog Phone Connection:
-
Power Connection & Grounding:
RJ45 Wire Sequence
-
The EVG-128S-B is equipped with RJ45 interface as FXS port. One RJ45 cable supports four FXS ports.
-
The internal wire sequence of RJ45 cable is shown as follows:
EVG-24S-A
The EVG-24S-A VoIP gateway provides voice services based on IP network. It’s a cost-effective and flexible solution for SOHO, remote office, medium-sized enterprise, and enterprise with multiple branches.
The gateway connects to analog telephone, fax and traditional analog PBX with standard voice interfaces and provides high quality voice service.
-
The EVG-24S-A has 4 LAN ports and 2 RJ21 connectors, in addition to 21 RJ 11 ports.
Connection Diagram
-
Network Connection (Use LAN0):
-
Analog Phone Connection:
-
Power Connection & Grounding:
RJ21 Wire Sequence
The EVG-24S has both a RJ21 interface and RJ11 Interfaces for FXS ports.
One RJ21 cable has 25 pairs of wires, with the 25th pair of wires vacant. This means each RJ21 interface supports 24 FXS ports.
Physical Indicators
Power Utilization
|
Part Number |
No Load |
20% Load |
100% Load |
|---|---|---|---|
|
EVG-24S-A |
25 W |
30 W |
40 W |
|
EVG-128S-B-HOUS |
0 W |
0 W |
0 W |
|
EVG-128S-B-MCU |
51 W |
51 W |
51 W |
|
EVG-128S-B-8FXS |
2 W |
2.375 W |
3.375 W |
Initial Setup
Network Configuration
By Default, all EV Gateways come configured with a static IP address of 192.168.11.1. We can access the Web Management System by browsing to this address from a device on the same subnet, or by using a feature code to enable DHCP. (Feature codes are removed during provisioning)
Static IP
To connect to the configured static IP address, it requires a computer to be connected to the eth0 interface on the gateway.
It is recommended to modify the IP address of the local computer to ensure that it is in the same network subnet with the device. Take windows 7 as an example, change the IP address of the local computer to 192.168.11.10:
Now we need to check the connectivity between the PC and the device. Click Start→Run and enter cmd to open a command prompt. Execute the command “ping 192.168.11.1” to verify there is communication between the PC and the device.
DHCP
To enable DHCP we must enter a feature code into an analog handset connected to one of the FXS ports on the gateway.
Once connected, dial *150*2 to enable DHCP. A voice prompt indicating successful configuration will be played.
Once complete restart the device to force a DHCP request to the DHCP server.
Use an IP scanner/ DHCP server to find the IP address of the device, or dial *158# into the analog phone to query the IP address of the device.
Web Interface login
Open a web browser and enter the IP address of the LAN port. You will be greeted with a login screen.
Enter the default username and password: (contact support)/(contact support), then click Log in to enter the Web interface.
Provisioning
To enable provisioning, we must navigate to the provisioning section of the Web Interface. It is in the Navigation tree to the left under Management -> Provisioning. Insert the provisioning details for the device profile type used from the below.
|
Name |
Value |
|---|---|
|
US URL |
|
|
EU URL |
|
|
Account |
(contact support) |
|
Password |
(contact support) |
|
Name |
Value |
|---|---|
|
US URL |
https://xsp.14ip.net:443/dms/ EVG-__S-Lite |
|
EU URL |
|
|
Account |
(contact support) |
|
Password |
(contact support) |
After inserting the provisioning details and clicking save, the EV Gateway will immediately reach out to Broadworks to requests its Configuration. If successful, the Gateway will reboot and apply the new parameters.
After Provisioning the Username/ Password changes to (contact support)/(contact support)
Broadworks Configuration
All configuration changes should be made on Broadworks through Custom Tags. Once provisioned, the Evolution Voice Gateway is setup to perform a checksync every 24 hours and during its reboot cycle to ensure its config is up to date. If at least 1 extension is registered on the gateway a reset can be initiated on the BroadWorks device profile to force a checksync and reboot the device.
Network
To set the network parameters on the Evolution Voice Gateway, it supports both DHCP and Static addressing. By default, it is set to use DHCP, so the device does not drop off the network once it provisions. Change the below Tags where required.
|
Tag Name |
Default Value |
Available Values |
|---|---|---|
|
|
2 |
1- Static Address, 2- DHCP |
|
|
10.0.0.100 |
Valid IP |
|
|
255.255.255.0 |
Valid Subnet |
|
|
10.0.0.1 |
Valid IP |
|
|
disable |
disable- Use static DNS servers, enable- Use DNS servers from DHCP |
|
|
8.8.8.8 |
Valid DNS Server |
|
|
8.8.4.4 |
Valid DNS Server |
Hotlines
The Evolution Voice Gateway supports Hotlines using its auto dialling feature. The below tags need to be set for each port that an auto dial is required, where x is the port number.
|
Tag Value |
Description |
|---|---|
|
|
Number to be dialled |
|
|
How long, in seconds, the port is off hook before it Auto dials |
Digit Manipulation
Each Evolution Voice Gateway is set up for 12 entries to modify the outgoing called number. These Manipulations are set up to be used for Analog phones with speed dials that ring * codes which cannot be used on Broadworks.
Below are the Tags to set each manipulation where “x” is the manipulation number (1-12). Note a description is required for the Manipulation to work.
In Addition, there is automatically a manipulation set up for House Keeping codes. “#5” is set to be modified to the number is designated by the %HSK_CODE_EXTENSION% tag.
|
Tag Name |
Default Value |
Available Values |
|---|---|---|
|
|
6963 |
Maid Status code extension |
|
|
Description (Required) |
|
|
|
Digits Dialled |
|
|
|
Number of digits to strip from the left |
|
|
|
Number of digits to strip from the right |
|
|
|
Prefix to add to number |
|
|
|
Suffix to add to number |
The easiest way to set the manipulations is to strip out all digits dialled, then insert the digits to send to Broadworks. For Example,
%SD_MANIPULATION_INPUT_1% = *25501 %SD_MANIPULATION_LSTRIP_1% = 6 %SD_MANIPULATION_OUTPUT_PREFIX_1% = 5001
Country Tones
Every Country has its own Unique call processing tones which will need to be set based off the location of the site. By default, the US property is set for USA and the EU platform is set for UK.
For the Tag %CALL_PROCESS_TONE%, Use the below values to specify which country the EV Gateway is being installed.
|
Country Name |
Country Value |
|---|---|
|
AUSTRALIA |
13 |
|
AUSTRIA |
1 |
|
BELGIUM |
2 |
|
BOSNIA |
22 |
|
CHINA |
14 |
|
DENMARK |
16 |
|
DPRK |
23 |
|
DUTCH |
21 |
|
FINLAND |
3 |
|
FRANCE |
4 |
|
GERMANY |
5 |
|
GREECE |
6 |
|
HONG KONG |
15 |
|
ITALY |
7 |
|
JAPAN |
8 |
|
NORWAY |
9 |
|
POLAND |
18 |
|
PORTUGAL |
19 |
|
RUSSIA |
17 |
|
SPAIN |
10 |
|
SWEDEN |
11 |
|
TURKEY |
20 |
|
UK |
12 |
|
USA |
0 |
|
USER DEFINED |
255 |
If using “User Defined”, use the below Tags to specify the ring patterns.
|
Tag Name |
Tag Value Example |
|---|---|
|
|
440,180,480,180,800,4000,0,0 |
|
|
480,180,620,180,500,500,0,0 |
|
|
350,180,440,180,0,0,0,0 |
EV Port Migration
In some situations, it is necessary to move an extension to another port on either the same device or a different device. With BroadWorks auto provisioning, there is no way to specify/ skip a port. Once the user is removed it will shift all the other users up a port on the config. This will cause problems as the frame will then be incorrect.
To get around this, we have developed a solution to use blank users to fill in the gaps. These Blank Users will have their own UserID format and Feature packs. This will allow for better management and make it easier to locate spare/ bad ports on the EV Gateway.
If the Required Feature Pack is not available allow on the group, a case must be raised with Platform support for it to be added.
Spare Ports
For a Spare port, the existing user needs to be removed from the Device before we build a dummy user. The dummy user will need to be built using the following format:
-
UserID: EVGSPx@domain (where x is the next available user number)
-
Example :
-
-
First Name: EVG Spare
-
Last Name: Port x (where x is the same number in the UserID)
-
Line Port: Should be Identical as UserID
-
Extension: No Extension should be assigned to this user
-
Identity Device Profile: The Device Profile for the Gateway you are moving the user from
-
Feature Pack: EVG-SP
-
On Magic: The Authentication password will need to be regenerated.
Once the user is created and added to the device, it needs to be moved to the correct port on the Gateway. To do this we need to navigate to the device profile of the Gateway -> Users -> and press Search.
Above the users there is an option to “Reorder Line/Ports on this Identity/Device Profile”.
From here the User will be at the bottom of the list. Highlight it and use the Move Up and Move Down buttons to place it where it needs to be.
Highlight the user and use the Move Up and Move Down buttons to place it where it needs to be. Once it is in the correct location, press OK.
While still in the device profile, Navigate to Files and complete a rebuild and a reset to reprovision the EV Gateway with the new user.
Bad Port
For a Bad port, the existing user needs to be removed from the Device before we build a dummy user. The dummy user will need to be built using the following format:
-
UserID: EVGBPx@domain (where x is the next available user number)
-
Example :
-
-
First Name: EVG Bad
-
Last Name: Port x (where x is the same number in the UserID)
-
Line Port: Should be Identical as UserID
-
Extension: No Extension should be assigned to this user
-
Identity Device Profile: The Device Profile for the Gateway you are moving the user from
-
Feature Pack: EVG-BP
-
On Magic: The Authentication password will need to be regenerated.
Once the user is created and added to the device, it needs to be moved to the correct port on the Gateway. To do this we need to navigate to the device profile of the Gateway -> Users -> and press Search.
Above the users there is an option to “Reorder Line/Ports on this Identity/Device Profile”.
From here the User will be at the bottom of the list. Highlight it and use the Move Up and Move Down buttons to place it where it needs to be.
Highlight the user and use the Move Up and Move Down buttons to place it where it needs to be. Once it is in the correct location, press OK.
While still in the device profile, Navigate to Files and complete a rebuild and a reset to reprovision the EV Gateway with the new user.
Diagnostics
Status & Statistics
System Information
In the Web interface, click Status & Statistics → System Information, and the following page will be displayed. Here you can view the Device Information and a visual status of each port (the EVG-128S-B is shown below)
Port Status
The following figure shows the registration information and status of each port and port group.
The description of ports and port groups is as follows:
Port: An FXS port
Port group: A group of ports that share the same SIP registration. (Used for EV Lite)
Current Calls
Current Call statistics for each port of the device, including port number, port type, source, destination, connection time, and duration.
RTP Session
On the Status & Statistics → RTP Session page, you can view the real-time RTP session information, including port, payload type, packet period, local port, peer IP, peer port, sent packets, received packets, lost packets, jitter, and duration.
CDRs
On the Status & Statistic→CDR page, you can enable the CDR function and view the details of all calls through the FXS ports. You can also export, filter, or clear the CDRs. Maximum of 5000 entries can be saved at one time.
Record Statistics
On the Status & Statistic****→Record Statistics page, record statistics including server status, count of current records, count of no response, count of server return errors, count of record starts, count of record startAck, count of record stops and count of stopAck are displayed.
Debug Logging
For troubleshooting, it may be required to gather a Debug log from the CLI. This log shows everything happening to the gateway. From SIP traffic to provisioning, it will be displayed to the CLI. The easiest way to capture is to set up the telnet client to copy all terminal outputs to a file. This log is required for Platform support and/or the manufacturer to investigate any faults.
To do this we must enable allow Telnet connections (disable by default), Enable logging to an external file for capture, Telnet to the Gateway, enable the debugging settings, reproduce the fault.
Enable Telnet
To re enable telnet, we must disable the telnet ACL in the Web interface for the gateway. Navigate to Security****→Telnet ACL and untick the box that says enable. This will allow you to telnet to the device.
Telnet client
To Telnet to the Gateway a telnet client is needed. Putty is used in this example.
Before establishing a connection, we can enable logging by going to Session→Logging, selecting all session output to be logged, then choosing the filename and location to be saved.
Once Logging is enabled, establish a telnet connection to the gateway. The telnet username and password by default is (contact support)/ (contact support).
ROS>en ROS#^config ROS(config)#deb port all ROS(config) #sip config sipdebug 9 ROS(config )#debug sip stack all on ROS(config )#debug sip info all ROS#^ada ROS(ada)#[079-19:27:46:370]ADA CONNECTED ...,WELCOME! ROS(ada)#turnon “ada number” (See CLI Guide for available options. Once these are enabled, you will start seeing the logging outputs in the CLI window. Reproduce the issue, then terminate the telnet session.