Manual KMG One - EN v2
Manual KMG One - EN v2
2. Front view 11
2. Rear view 11
2. Front view 12
2. Rear view 12
2. Safety features 13
2. Optional features 13
3. Technical specifications 15
3. Media gateway 15
3. Telephony interfaces 16
4. Installing KMG 17
4. Network connection 17
4. Centronics connector 20
Table of Contents
4. RJ45 connector 21
6. KMG operation 23
7. Configuration 23
7. Network 23
7. System 29
7. VoIP Settings 31
7. Configuring Services 32
7. Telephony 34
7. Signaling 34
7. Dial Plan 37
7. SS7/SIGTRAN 37
7. SS7/SIGTRAN settings 38
7. MTP2/M2PA 38
7. Point Codes 38
7. MTP3 38
7. ISUP 39
7. Features 39
7. Integrations 39
7. Insight! 39
7. Device Management 39
7. TR-069 39
7. Other systems 40
7. Survivability 40
7. Configuration 41
7. Network 41
7. Servers 42
7. Register Authorization 43
7. Network settings 43
7. General options 44
7. Advanced options 44
7. Routing 49
7. NAP 50
7. Options 53
7. Registering extensions 54
7. Proxy list 55
7. Extensions 55
7. Ring pattern 56
7. Cadences 56
7. Routes 58
7. Regular expressions 60
7. Retry 60
7. Configuration steps 64
7. Configuring portability 74
7. Importing data 75
Table of Contents
7. Scripts 76
7. Adding a script 77
7. High Availability - HA 80
8. Monitoring 81
8. NAP 82
8. SIM cards 82
8. Devices 83
8. Status 85
8. Links 85
8. Restarting 87
8. Blocking 87
8. Channels 87
8. Device statistics 88
8. Links 88
9. Diagnostics 89
9. Downloading logs 89
9. Diagnostics mode 89
9. Advanced options 90
9. Logs 90
9. Config 90
9. Licenses 90
9. OLD 90
9. CDR 90
9. Packet capture 91
9. Audit 91
10. Management 92
10. Licenses 95
10. Provisioning 95
10. Requirements 95
10. Procedure 96
10. Update 96
10. Troubleshooting 96
1. About this manual
This manual is directed at professionals responsible for managing media gateways of the KMG line.
This document contains the necessary information for installation, configuration and management, as well as
technical specifications of the media gateways.
At the beginning of each configuration section, the route for accessing the configuration interface is
described. Depending on the version of your KMG, the access route may be different. To check which version of
KMG you are using, please refer to the "Check KMG version" section, in this manual.
Some features are only available in certain models, and this will be informed at the beginning of the
section describing the feature. This also applies to features that are made available through acquisition of additional
licenses.
Modularity because you can have all of your telephony interfaces together in a single media gateway.
This makes it possible for you to have digital E1/T1 telephony interfaces, analog FXS and FXO interfaces and
mobile 2G and 3G GSM interfaces in one media gateway.
All models in the line include the security features provided by SBC - Khomp’s Session Border Controller.
This way, you will have the features you need to increase the security of your telephony network.
In addition to the features mentioned, the media gateways of the KMG line will enable you to decrease
your costs with telephony call charges. With the creation of lower cost routes, you will be able to direct each call to
the carrier that offers the lowest call charges. In addition to lower cost routes, it is possible to create fallback routes,
balancing and routes that operate in accordance with programmed hours.
All configuration and management tasks are performed through a Web interface that can be accessed
from any browser.
2. General overview of models
In the following you will find a general overview of the various models of the KMG line.
2. Front view
Caption:
1 Power button
2 Power LED
2. Rear view
Caption:
1 E1/T1 Link #1
2 E1/T1 Link #2
5 VGA port
2. KMG 3200 One
The KMG 3200 is a high-density media gateway that can have up to 64 E1/T1 links or 2000
simultaneous calls for E1, GSM, FXS, FXO or VoIP SBC technologies. All with the possibility of up to 1000 calls with
transcoding (G.729/G.722 ↔ G.711). See the section "Capacity for simultaneous calls" in this manual for more
information about the capacity of the KMG 3200.
The telephony interfaces are made available solely through external telephony modules - the KMG Module (see the
section "Telephony interfaces" in this manual for more information).
2. Front view
Caption:
1 Power button 4 Disk activity status
2. Rear view
Caption:
Caption:
2 VGA port
2. Safety features
● Network topology hiding
● Detection of malicious RTP packets
● Access Control List - ACL
● Protection against malformed packets
● Call blocking by destination and source
● Protection against DoS/DDoS attacks
● SIP TLS and SRTP protocols (SDES and DTLS)
2. Optional features
The following features are available through acquisition of additional licenses (not included in the standard KMG)
● Survivability - SAS
● High Availability - HA¹
● Analytics - Call Classification Feature
● Register Authorization
● ISUP (SS7), SIGTRAN Support
¹Resource available in all models, however there is no HA support for the internal model of the equipment, if one is present
2. Telephony interfaces - KMG module
Telephony interfaces can be made available through the KMG Module - an external telephony module or
one that is integrated in the media gateway (KMG 200 and KMG 400 ).
There are different models of KMG Modules that offer E1/T1, FXS, FXO and GSM interfaces, providing a
scalable media gateway with optimized capability for expansion.
The modules are connected to the KMG server through an Ethernet interface. They were designed to be
installed in a rack, with each module occupying 1U and a half 19-inch rack.
The KMG module is a commercial variation of the EBS module. It is exactly the same
Note hardware, differing only in the way features are licensed.
2. Physical connection of KMG modules
The modules must be connected to the interfaces that will be used. Additional information can be found
in the section "7.1.1 - Network configurations". A physical connection may be made as shown in the image below:
The KMG module is connected to the configured network interface, and if the number of external
modules is greater than the number of ports available in the server, the module’s second network interface can be
connected to the first network interface of the second module, making it possible to use the maximum capacity of
the equipment with a chain connection of up to one level.
If an HA solution is being used, the second telephony module can be connected to the spare KMG
server, establishing a complete high availability connection in the system, involving all of the external telephony
modules.
3. Technical specifications
The following lists the technical specifications for the media gateway and the telephony modules.
3. Media gateway
Here are the technical specifications for the media gateway.
Item KMG E1 Module KMG GSM KMG FXO KMG FXS Modular KMG
Module Module Module Module
Dimensions (W x H x L)
8,68" x 1.75" x 11.02" (220.5 mm x 44.5 mm x 280 mm)
5,73 lb to 4.4 lb to
5,73 lb to 6,17 lb
Approximate weight (without 8,81 lb 4.85 lb (2 5.9 lb (2.7
(2.6 Kg to 2.8 Kg) 5.7 lb (2.6 Kg)
packaging) (2.6 Kg to Kg to 2.2 Kg)
4 Kg) Kg
3. Telephony interfaces
E1/T1
Item Description
GSM
Item Description
Item Description
FXS
Item Description
Loop current 20 mA
4. Installing KMG
KMG was designed to be installed in 19-inch racks. The media gateway (server), occupies 1U. The
external telephony modules - KMG Module, occupy an additional 1U and a half rack. If you acquire only one KMG
Module, a tab is included for installation in a rack.
Installation, both of the media gateway and the KMG Module, should be done in environments with a
temperature of between 0 to 50º Celsius and humidity between 0 to 90% without condensation.
4. Network connection
The media gateways have a switch with a dedicated network controller. The number of external network
ports of this switch varies depending on the model. The following table lists the description of the gateways and
their number of network ports.
The network interfaces of the gateways that have 5 network ports are called eth0, eth1, eth2, eth3, and
eth4. These five interfaces have the same MAC address, as they are connected to the same port on the network
controller. Therefore, it is necessary to connect each KMG port to a physically separate network. For each virtual
network interface, a VLAN can be configured to allow propagation to the local network.
Connect the KMG ports to different physical networks, since the MAC address is shared between the
network ports, as shown in the figure below.
The KMG 1600, despite having 8 external network ports, has the same specifications and connections
as the KMG 400.
The network interfaces of the KMG with13 ports are arranged in the following manner: The eth0, eth1,
eth2, eth3 and eth4 ports can be used exclusively for the network and have the same MAC address, because they
are connected to the same port as the network controller. Therefore, ports eth0 to eth4 must be connected to
physically separate networks.
The last 8 network ports, from P0 through P7, are specified for connection to external telephony
modules - KMG Module, but they may also be used for connection to other VoIP networks, provided that they are all
different. These interfaces have their own distinct MAC address different than that of ports eth0 through eth4.
In the image below, the 13-port KMG is connected to 2 physically separate networks.
1 Not connected
2 Not connected
3 Ring
4 Type
5 Not connected
6 Not connected
4. Centronics connector
With this connection, the exchanges are connected through a 50-pin Centronics connector. The
connector must be assembled according to the following specifications in order for the module to operate correctly:
Pin Signal Pin Signal Chan Pin Signal Pin Signal Chan Pin Signal Pin Signal Chan
nel nel nel
3. Enter your user name and password. If this is your first access, use the user name and password
described as follows.
User Password
admin khomp
During the first access, we recommend you change the admin user password as a security
Note measure.
● Configuration: Contains the options for network configuration, creation of SIP trunks, E1 trunks,
configuration of analog interfaces, GSM, codecs and other gateway configurations.
● Monitoring: Provides options for monitoring telephony interfaces and VoIP channels.
● Diagnostics: Features options to display KMG main operational messages, and enables users to
download and view Logs.
● Management: Features options to manage the gateway, such as updating the equipment version,
changing the Web interface access password, and provisioning.
Some features and options may only be available in certain versions of the equipment. This manual lists
the versions where different features are available.
The Web interface offers help for almost all fields indicated by a "?" symbol, which can help with device
configuration.
To configure routing in the gateway, you need to know the concepts of "NAP", "Routes" and how they
relate.
"NAP" (Network Access Point) is an entry and/or exit point for calls. It represents one or more E1/T1,
GSM, FXS, and FXO channels, a SIP host/user, or a SIP Trunk, thus defining groups of channels that may be used by
one or more routes as a source (incoming calls) or a destination (outgoing calls).
"Routes" are associations between source and destination NAPs. i.e., to create a route, the user needs to
select the source NAP, which is the entry point for calls in the Gateway, and the destination NAP, which are the
outgoing calls.
Routing can be based on the source number, destination number and the result of the portability query.
You can also restrict routes by schedules, set up alternative routes that will be used as "fallback" and "retry", as well
as create advanced call routing scripts using the LUA language.
When there is an incoming call, all routes that have the NAP in which the call was received as the
Source NAP will be evaluated in the priority order set in the configuration. The first route that satisfies all filters will
be used to allocate the outgoing call using the configured Destination NAP.
The outgoing call progress is monitored and may result in the "retry" behavior if it disconnects
prematurely (before the call is answered), or in the "time-out" behavior if completion occurs and the cause for
disconnecting is mapped to the incoming call profile as "retry". Fallback is a "retry"-like feature, available only for SIP
destination NAPs with multiple configured proxy servers. This feature allows KMG to change the "proxy" of the
outgoing call, if it does not respond in a timely manner, without triggering the "retry" feature.
If a "retry" occurs, route evaluations will be resumed from the next priority set for the valid Source NAP
routes.
In order to make product configuration and management easier, the Web interface was developed,
gathering all settings and features, which were distributed into 4 major categories: "Configuration", "Monitoring",
"Diagnosis", and "Administration".
● Step 1: Create a NAP that will act as the Source NAP and another that will act as the Destination NAP at:
Details of the KMG operation and a description of the fields in each menu are provided throughout this
manual.
7 Configuration
7. Network
The menu Network contains all of the configurations pertaining to the network configurations of the
equipment. Interfaces, Firewall and TLS certificates. It is not necessary to reboot the equipment to apply these
configurations.
7. Configuring the network
The menu Network contains all of the configurations pertaining to the network configurations of the
equipment. Interfaces, Firewall and TLS certificates. It is not necessary to reboot the equipment to apply these
configurations.
This menu displays options for configuring the KMG network interfaces. In this Web page you can
configure the network interfaces for connection of the KMG to a VoIP network, define the network interface to be
used with an external telephony module - KMG Module, as well as perform configuration of DNS and static routes.
The "Network" panel displays a table for configuration of each network interface. The following table
describes how to use each option.
The network interface options will be displayed according to the defined operation mode. Other options will be
displayed only if the settings mode is "Static".
With the edit button you can perform configurations related to the particular network interface. With the
add button you can add a VLAN interface.
Field Description
Network
Field Description
Type IPv4 or IPv6 protocol that will be used in this network interface.
Field Description
Configure DNS
Configure the search domain and the addresses of the primary, secondary, and tertiary DNS servers that
will be used, according to the provided order of preference, for network name resolution.
To enter another route, click on Add route, just below the table of static routes.
The KMG access control settings and the network services that will be able to communicate with the
gateway are defined.
The following protocols will be available, regardless of the configurations applied in KMG firewall:
Access through SSH and FTP protocols has active protection against brute force attacks. Both accept a
maximum of 3 consecutive unsuccessful connection attempts before entering into a holding mode for 120
seconds. It is necessary to wait for 120 seconds before new access attempts may be accepted, and this time
interval begins to recount any time a new attempt is made before the 120-second wait time is completed.
Configuration of the firewall is performed in the following order:
1. Define a list of Authorized Addresses. When an IP address gets authorized, the other settings do not get
applied, even if they have been configured.
2. Block the addresses that are not on the list of Authorized Addresses.
If the "Authorized Address" field is set to "ANY", the options mentioned earlier will not be effective even if
they have been configured.
Allowed addresses
IP addresses that are allowed access to the KMG are specified. If no value is entered, it is assumed that
any IP address can access the KMG. However, access is restricted to the Web interface and SIP registration only.
This setting is used in conjunction with the Blocked Addresses setting. Click on the "Add" button and apply one of
the following options:
● ANY: Makes it explicit that any IP address can access KMG. Whether it is through the Web interface,
FTP, SSH and SNMP.
● IP address: Only the specified IP addresses can access KMG. For example: 192.168.0.5.
● Network prefix: Only IP addresses belonging to the specified range can access KMG. For example:
192.168.109.0/24.
We recommend that you only allow the IP addresses that will have access to KMG. To do this,
Note be sure to check the "Block all addresses that are not in the Authorized Addresses list" option.
Blocked addresses
When enabled, this option blocks all IP addresses that are not in the "Authorized Addresses" list.
When this option is enabled, make sure you have at least one IP address authorized to
Attention access KMG
2. Then, simply enable the type of detection desired. There are four types of detection:
● SSH access by brute force: Blocking due to an excess of attempts with SSH access failure.
● WEB Interface access by brute force: Blocking due to an excess of attempts with failure in accessing
the Web interface.
● SIP registration by brute force: Blocking due to an excess of attempts with registration failure. Available
only with an active license for Register Authorization.
● SIP flood: Protection against SIP flood. Available only with an active license for Register Authorization.
3. When you enable a type of detection, the following fields are displayed. Configure them in accordance
with your security policies:
● Maximum number of attempts: The maximum number of times that a device can attempt to access
KMG. If this limit is reached, the device IP address will be blocked for the amount of time set in the
"Blocking Time" field.
● Time interval: The interval of time, in seconds, that a device can attempt to access KMG. For example: If
there are 3 unsuccessful access attempts in 60 seconds, the IP address will be blocked.
● Block time: Time, in seconds, during which a device that exceeds the previous limits will not have
access to KMG. At the end of the blocking period, the device may try to access the KMG again.
4. Click on the "Save" button. Finally, click on the Apply button for the changes to take effect.
7. Managing TLS certificates
"Configuration" → "Network" → "TLS Certificates"
You can register private key, certificate, and trust store sets to be used by the device's VoIP interfaces. A
private key can be generated automatically by the device along with a self-signed certificate using the "Create
self-signed certificate" button, or existing files can be sent to a new configuration using the "Add existing certificate"
button and then using the edit button of the setting you wish to change.
Only Survivability and Register Authorization modules allow configuration by interface; the
Note routing module uses the first configuration available on all interfaces.
Size of the private key (in bits) that will be generated using random values.
Size (bits) The larger the key, the safer it is, however, it will require more processing in
order to be used
Enables encryption of the private key with the desired algorithm; requires
Encryption algorithm
"Encryption Password"
The password that will be used for encrypting and decrypting the private
Encryption password key must be provided only if an "Encryption algorithm" has been selected
Organization or company Name of the organization or company informed in field O of the certificate
(O)
Organizational unit or The name of the organizational unit or department to be informed in the
department (OU) field OU of the certificate
E-Mail Address E-mail address of the contact person or the person responsible for the
(emailAddress) device informed in the field emailAddress of the certificate
When configured, it is the password used to decrypt the private key and
will display a link to change the password. If it is not already configured, it
will display the field to add a new password.
Encryption password
ATTENTION: The private key is never changed using this field. If
you wish to decrypt and re-encrypt the key with a new password, you need
to download the key, make the changes, and upload the new key with the
new password.
If enabled, the default system trust store must be loaded and used in
conjunction with the "trust store" provided by this configuration. The
Enable Default Trust
default trust store contains the widely public certificates of certifying
Store
authorities and is provided as part of the KMG update file. It cannot be
changed.
This option depends on whether the Trust Store and/or the Default Trust 4.0.2
Store are enabled and will require verification that the certificate provided
Enable Certificate by the remote site during the TLS handshake was issued by any of the
Verification known certifying authorities. If a Trust Store is not configured and the
Default Trust Store is disabled, this setting is ignored and any certificate
offered by the remote site will be accepted.
When there is no associated private key, this field will give the option of
sending a private key. When there is a private key, it will show the condition
Private key
of use of the key and its size (if the condition is OK) and buttons to
download or remove it.
When there is no associated certificate, this field will give the option of
Certificate sending a certificate. When there is a certificate, it will show the conditions
of use of the certificate and buttons to download or remove it.
When there is no associated trust store, this field will give the option of
Trust Store sending a trust store. When there is a trust store, it will show the
conditions of use of the trust store and buttons to download or remove it.
7. System
This menu groups all of the system configurations that require rebooting of the equipment for validation.
7. Configuring the operation mode
The mode of operation defines the operating mode and consequently the set of codecs supported by
the KMG. Configuration of the mode of operation will depend on the licenses applied in the KMG, the maximum
number of simultaneous calls supported by the KMG, and the codecs used by the trunks connected to the gateway.
3. It is possible to select the number of TDM channels to be used in the panel "Between TDM and VoIP", or
select the option for exclusive use in SBC mode, as explained below:
● SBC ONLY: The KMG does not accept calls between TDM and VoIP; only SBC mode is enabled.
● E1-G711: The KMG accepts calls between TDM and VoIP. There are different E1 levels registered for
each type of equipment.
4. The panel "Between VoIP and VoIP" displays the number of calls remaining according to the options that
were previously selected giving the maximum number of VoIP calls available and in accordance with the
support provided for the codecs configured.
5. Click on the "Save" button.
6. Restart the gateway for those settings to take effect. A message will be displayed with a button to
restart the gateway, or you can restart it later (see the section "Turn off and restart the KMG").
The fields "Maximum number of TDM channels" and "Maximum number of SBC calls" display
Note the capacity for simultaneous calls supported by the KMG according to the mode of operation
defined.
7. VoIP Settings
The mode of operation defines the operating mode and consequently the set of codecs supported by
the KMG. Configuration of the mode of operation will depend on the licenses applied in the KMG, the maximum
number of simultaneous calls supported by the KMG, and the codecs used by the trunks connected to the gateway.
In this tab you can change the VoIP settings for the KMG. The configurations applied here are global,
applicable in all sections and SIP trunks.
The following table shows the description of KMG VoIP configuration fields:
Maximum value of the RTP port that should be used to transmit the audio
Highest RTP port
of the SIP connections to each network interface.
-
Minimum value of the RTP port that should be used to transmit the audio
Lowest RTP port
of the SIP connections to each network interface.
SIP Port used for the UDP protocol. Any server that needs to connect to
UDP Port
KMG should use this port for SIP protocol traffic to each network interface.
SIP Port used for the TCP protocol. Any server that needs to connect to
TCP Port 4.1.1
KMG should use this port for SIP protocol traffic to each network interface.
SIP Port used for the TLS protocol. Any server that needs to connect to
TLS port
KMG should use this port for SIP protocol traffic to each network interface.
Audio packet size Determines the size of the audio packet used in milliseconds.
-
ToS for SIP packets
Signaling packet marking for ToS.
(DSCP)
TLS Encryption Selects the TLS certificate option to be used by the system.
In the "Timers" section, you will find the specific SIP timing settings.
Field Description
Whenever there are changes to the VoIP configuration, the KMG must be restarted after
Note clicking on the "Apply" button.
7. Configuring Services
The services available on the KMG are configured. Currently it is possible to configure the HTTP port
and enable HTTPS service defining the port and certificate to be used.
The date and time in KMG can be configured manually or retrieved by an SNTP/NTP server.
We strongly recommend that the date and time of the KMG be correctly set, as the logs, the
Attention call records on CDR files, and the time-restricted routes are affected by this setting.
7. Manually changing the date and time
To configure the date and time manually through the Web interface of the KMG:
1. In the "Date" and "Time" fields, enter the date and time according to the location where KMG is installed
(e.g.: 01/05/2018).
1. In the "Time zone" field, select the time zone according to the location where KMG is installed.
2. Click on the Save button. If no other configuration is performed, click on the Apply button.
3. Restart the gateway for those settings to take effect. A message will be displayed with a button to
restart the gateway, or you can restart it later (see the section Turn off and restart the KMG).
To configure the date and time manually through the Web interface of the KMG:
This menu contains the entire history of changes to configurations of the equipment. It makes it
possible to see the user and access IP, and the time of the change. It also allows for verification of what changes
were made and for undoing the changes, if necessary.
When restoring the configuration to a determined point, all of the configurations will be
returned to their prior state at the point selected. All changes made after that point will be
Attention undone.
7. Telephony
This menu displays all of the configurations related to telephony.
The E1/T1 interface must be connected to the KMG for this menu to be displayed.
Note
7. Signaling
"Configuration" → "Telephony" → "Signalization"
It is possible to change the signaling profile of the equipment that is applied to the E1/T1 links and GSM,
FXO and FXS telephony channels. All of the default configurations refer to the standard protocols. You can edit or
copy a profile to change its properties accordingly.
The profiles are applied in all telephony links or channels of the telephony module - KMG Module. It is
not possible to apply a signaling profile in only some of the channels in the same module.
Change these configurations only when necessary and if you are knowledgeable about each
Attention type of signalization.
1. In the profile that is to be changed, click on the icon
2. Change the necessary properties.
3. Click on the "Save" button. If no other configuration is made, click on the "Apply" button for the changes
to take effect.
1. In the profile that will have its properties copied, click on the icon
2. In the field "Name" define a different description from that of the original profile. Change the necessary
properties.
3. Click on the "Save" button.
4. Consult the section "Applying a signaling profile to the telephony module" and then apply the profile
created in a telephony module.
3. In the column "Profile", select the profile that you created. Only profiles compatible with the technology
of the telephony interface will be displayed. For example: If the interface is an E1/T1, only signaling
profiles that are compatible with this interface will be displayed, such as R2 and ISDN, among others.
4. Click on the "Save" button. If no other configuration is made, click on the "Apply" button for the changes
to take effect.
7. Setting the properties of the E1/T1 Links
"Configuration" → "Telephony" → "E1/T1 Links"
It is possible to change the signaling profile of the equipment that is applied to the E1/T1 links and GSM,
FXO and FXS telephony channels. All of the default configurations refer to the standard protocols. You can edit or
copy a profile to change its properties accordingly.
The profiles are applied in all telephony links or channels of the telephony module - KMG Module. It is
not possible to apply a signaling profile in only some of the channels in the same module.
The following table contains the description of the fields available in this Interface:
Field Description
Description of the module to aid in identification. For example: The name of the telephony
Name carrier that the link is connected to. This name is displayed during the creation of the E1
trunk (menu Configuration → Routing → NAPs).
Determine whether the telephony interface should receive or generate the reference clock
in the link. There are two options:
Synchronism (clock) ● Receive: Used when the KMG is connected to a fixed telephone carrier
(PSTN).
● Generate: Used when the KMG is connected to a digital PBX.
Minimum number of digits for the destination number to be requested from the remote
Incoming digits
exchange.
If enabled, KMG will use the CRC resource. The device connected to KMG must also have
CRC
CRC support.
The configurations in the table seen previously are the only definitions that are usually changed.
Because they depend on the type of connection, PBX digital or PSTN.
For more link configurations, click on the Advanced Configurations button. More columns in the table
will be displayed. These configurations should be changed only if there is a need or if requested by your fixed
telephony operator.
Field Description
The Dial Plan determines an expected sequence of dialed digits. If the gateway gets an expected
sequence, the number will be accepted and sent for routing. Otherwise, the call will be refused. It is possible to
register plans counting on the dialing rules of your scenario and subsequently associate this plan to an E1 Link or
NAP FXS.
In order to validate the digits dialed, rules should be added to the dial plan settings. Each rule
determines the required prefix to validate the sequence.
Rules are determined using a sequence of values according to the syntax in the table below:
Digits 0123456789ABCD*#
Wild card X
"X" can assume any numerical digit. I.e.; the rule "0XX4837222900" should match the sequence
"0214837222900" and fail with "0##4837222900".
Numerical digits inside "[]" mean a list of options and/or a numeric interval. I.e.; the rule "2[38][6-9]X"
should match the sequence "2370" and fail with "2470" or "2350". The wild card "X" corresponds to the "[0-9]"
interval.
Option and interval can be used in the same "[]" structure. I.e.; the rule "2[37-9][2-46]X" should match the
sequences "2360", "2830" and "2720". The same rule should fail with "2450", "2100" and "2070".
A sequence that partially matches a rule may be accepted in the dial plan. I.e.; the rule "XXXX"
Note accepts the sequence "123" or "456" after the signaling determines there are no more numbers
to be sent.
The sequence is validated per prefix. I.e.; the received sequence "12345" matches the "XXXX"
Note rule.
In the dial plan, rules are determined in a given order. The first rule has priority over the second, the
second rule has priority over the third, and so on. When a rule fails, it is removed from the checklist. When the
sequence matches, the highest priority rule in the checklist is applied. When the dialed digits match at least one rule,
the received sequence is accepted. When all rules fail, the call is refused.
7. SS7/SIGTRAN
"Configuration" → "Telephony" → "SS7/SIGTRAN"
The KMG has support for SS7 and SIGTRAN signaling in its E1 modules. These signals are used for
inter-carrier trunking, and for interconnection with the core devices of their networks.
Khomp supports the MTP2, MTP3 M2PA and ISUP protocols. For more information on these protocols,
please refer to the ITU recommendations.
Special licenses are required to use SS7 or SIGTRAN signaling with the KMG. These licenses can be
obtained from Khomp's sales department. The licenses will be linked to the device's serial number.
7. SS7/SIGTRAN settings
Initially, you must configure all the links that are going to be used with ISUP signaling. Either the links
that will be used for signaling (MTP2 / M2PA) or the links that will be used for voice (Circuit Groups) or both.
Following that, go to the SS7/SIGTRAN menu on the KMG Web interface. To make configuration easier, have the
Interconnection Technical Project (PTI) at hand.
7. MTP2/M2PA
You must configure which of the links will be used as signaling links for the MTP2 and M2PA protocols.
There must be at least one link with signaling.
MTP2: Add the link defining its name, device, and mode of operation. Additionally, you can change the default
timers of the MTP2 protocol.
M2PA: Add the client or server M2PA link and define a name. Client: Enter the address and local port of the KMG, as
well as the address and remote port of the server. Server: Enter the remote client's address and port.
M2PA - Local port configuration: Local port used to receive the connection information, in case a server M2PA Link
is configured on this device.
7. Point Codes
Settings related to "Point Codes". There must be at least two configured Point Codes, local and remote.
When you fill in the decimal format, the 3-8-3 format field will be updated.
7. MTP3
Settings related to the MTP3 protocol. You must configure Linksets and Routes.
Linksets
Linkset settings for association with configured links. To add a Linkset, you must perform the following
procedures:
1. Select the Source (Source Point Code), which will be the point code used by this Signaling Point.
2. Select the Adjacent (Adjacent Point Code), which is the point code of the Signaling Point immediately
connected to this Linkset.
3. Select the Network Indicator.
4. Select which link will be used by this Linkset, defining the SLC (Signaling Link Code) value to be used by
this link (this value must be equal to the value at the adjacent signaling point).
Routines
Route configuration for MTP3.
To create a route, select the destination PointCode and associate the Linkset that can be used to reach
this point code.
If it is possible to reach this point code using more than one Linkset, click on "Add Linkset to Route" and
go back to step 3 as many times as necessary. Note that the order of inclusion will be the Linkset's priority order to
reach the configured point code.
7. ISUP
ISUP circuit groups settings:
Circuit Groups
Circuit Groups settings and definition of timeslots to be used.
To add a Circuit Group:
1. Select the Source (Source Point Code), which will be the point code used as source of the calls.
2. Select Destination (Destination Point Code), which will be the point code used as destination of the
calls.
3. Select the link that will be used for voice traffic.
4. Define the initial Circuit Identification Code (CIC) value of this Circuit Group. This should be exactly the
same as the one configured at the other end of the link.
If there is any limitation regarding the link timeslots that may be used, check or uncheck the boxes
referring to the timeslots that should be used by this Circuit Group.
KMG does not allow the use of timeslot 0 and 16 as a circuit to be used in Circuit Groups
Attention configuration.
Timers
Definition of ISUP signaling timers.
7. Features
This menu presents all of the general resources for the equipment that may be acquired separately
depending upon the particular needs of each scenario.
7. Integrations
This menu presents all of the general resources for the equipment that may be acquired separately
depending upon the particular needs of each scenario.
7. Insight!
"Configuration" → "Resources" → "Integrations" → "Insight!"
Configurations to permit access through Insight! the Web interface of the KMG. To allow this, the VPN
configuration supplied by Insight must be loaded and the WEB portal configured for HTTPS.
7. Device Management
"Configuration" → "Resources" → "Integrations" → "Device Management"
Configurations for integration with the Broadsoft Device Management system that uses HTTP/HTTPS
requisitions to allow for the updating of the configuration and version of the KMG from a remote, centralized
location through the Broadsoft platform.
7. TR-069
"Configuration" → "Resources" → "Integrations" → "TR-069"
Configurations related to support for the TR-069 protocol allowing for updating of the configuration or
version of the KMG from a remote centralized location through an ACS server.
7. Other systems
"Configuration" → "Resources" → "Integrations" → "Other systems"
Used for integration with the KSMS System which is Khomp’s platform designed to send SMS
messages, making it possible to reach clients through the use of SMS campaigns.
You will find more information about this platform at Khomp website. To use this feature, the KMG must
be connected to the Internet.
7. Survivability
"Configuration" → "Resources" → "Survivability"
This option will only be displayed when the KMG has a valid "Survivability" license.
Note
Survivability allows the KMG to be able to maintain the basic functionalities of a PBX in the event of
unavailability. The PBX is monitored and if a failure is detected the KMG can assume the role of the PBX and provide
resources in a limited manner, including the maintaining of registers and incoming and outgoing calls, using the
known registers and the routing table for the equipment for forwarding of calls.
The Survivability module is configured on the users side as a proxy for the PBX, so the entire call flow
goes through the KMG's Survivability module first, before it reaches the PBX. The Survivability module checks the
availability of the PBX at a configurable frequency (in seconds) via SIP OPTIONS. When there is no response to the
SIP OPTIONS command within the defined time frame, the KMG replaces it. At this point its operation mode
changes from proxy to Survivability mode.
● Registration management.
● Local calls between extensions.
● Incoming calls (via E1/T1, GSM, or FXO KMG links)
● Outgoing calls (via E1/T1, GSM, or FXO KMG links)
● Call transfer (direct and assisted), both local and external
New extensions can register during Survivability mode, but need to register again once the PBX
becomes available.
All gateways of the KMG line support the Survivability module. Licenses must be purchased
Note separately.
Key
S = Survivability module
GW = Gateway
7. Configuration
On the SIP NAP that will communicate with the desired PBX, configure the "Survivability" option in the
proxy list to enable this feature.
7. Network
"Configuration" → "Resources" → "Survivability" → "Network"
All KMG network interfaces will be available for configuration; select the desired protocol (UDP, TCP,
TLS), as well as the port through which the Survivability module should receive the packets.
The network interface address and the port configured for Survivability should be used as a
Note proxy setting for the PBX on the IP phone or softphone.
Interface Identifies the network interface of the KMG's general network settings
TLS
NOTE: Enabling TLS requires loading the keys into the KMG global TLS
settings.
7. Servers
"Configuration" → "Resources" → "Survivability" → "Servers"
In this area you can configure the SIP server (PBX) that the Survivability module will monitor and take over in case of
failure.
When you click on "Add", a form will be displayed for registration of the server, containing the following
fields:
Domain Identification of the domain that will be used for the user register
4.1.42.0
Address This is a list of addresses to be used for forwarding registers and calls.
SIP Port Network port used for communicating with the server.
Time interval (in seconds) for the Survivability module to trigger tests
Interval between tests using SIP OPTIONS to detect failure/unavailability of the monitored
server.
Maximum number of Number of failures that must occur during the tests using SIP OPTIONS
failures before going into before the Survivability module takes over the communication from the 4.0.5
Survivability mode. monitored server.
Time interval (in seconds) for the Survivability module to trigger tests
Interval between tests using SIP OPTIONS to detect failure/unavailability of the monitored
server.
Maximum number of Number of failures that must occur during the tests using SIP OPTIONS
failures before going into before the Survivability module takes over the communication from the 4.0.5
Survivability mode. monitored server.
4.0.5
Wait time (in seconds) for answering by one of the members of the
Time-out for call answering group. When this time limit is reached, the Survivability
answering module will cancel the call and make another call to the next extension
in the group.
7. Register Authorization
Configurations related to the Register Authorization module. This application allows external users to
access the PBX of the internal network using the KMG to authorize registers, providing security and topology hiding,
guaranteeing the identity and confidentiality of the users.
7. Network settings
"Configuration" → "Resources" → "Register Authorization" → "General" → "Network Configurations"
All of the network interfaces of the KMG are available for configuration. For each enabled interface,
inform whether the data transport will be UDP, TCP or TLS, and indicate the port that will be used. In the case of TLS,
choose the TLS setting in the corresponding field. To enable the TLS, access the menu "Configuration" → "System"
→ "VoIP" → "TLS Encryption".
Back-to-back: In this mode, registrations are handled independently for each configured server. To use this mode,
users must be pre-authenticated via query to an LDAP database. The LDAP database settings are as follows:
● LDAP Servers (Primary or Alternative): Configuring the LDAP database to check user registration
information.
○ Address: IP address of the server where the LDAP database is located.
○ Port: Port that will be used by the KMG to access the LDAP database. The default port for
LDAP is 389 and for LDAPS it is 636.
○ Schema: The type of database that will be used, which can be LDAP or LDAPS.
You must configure the Primary LDAP Server. Configuring the Alternative LDAP Server is optional. If configured, it
will be used if the query to the primary server fails.
● Perform BIND: If the LDAP database requests access credentials, the user and password can be
informed by selecting the Perform BIND checkbox.
● Search: Parameters for user search and evaluation in the LDAP server, through a rule that must be
entered and must be followed by users who try to register; depending on the result obtained with the
rule, an action can be taken.
○ DN Base: The verification rule that must be met for user validation, based on the ID and
values that will be extracted from the LDAP database.
○ Filter: Filter for comparison between the value extracted from the REGISTER message, and
the value extracted from the LDAP database, based on the DN Base rule. If the values are
identical, then the user will be allowed access.
○ Scope: Database level in which the value extracted for Register Authorization will be
searched in LDAP.
○ Password Attribute Name: Identifier used for the attribute used as password in the
database.
● Registration expiration: In the back-to-back mode, registration expiration times are independent for UAS
and UAC. Provide the expiration time for the UAS in the "Expiration time for UAS" field and the maximum,
minimum, and default values of the expiration time for UAC in the fields of the "Expiration Time for UAC"
section.
7. Advanced options
● Keep Encryption Key for Re-Invite: When using TLS, select this option to use the same encryption key
when a Re-Invite occurs.
● Strict address-of-record validation: It accepts subsequent messages after REGISTER (INVITES, etc.)
only if they are identified by the same address-of-record informed in REGISTER.
● Use the same UAC transport: Uses the same UAC transport for exchanging messages with UAS.
● UAC Keep Alive (OPTIONS): Sends Keep Alive, via OPTIONS packages, to UAC. For each type of
transport (UDP, TCP or TLS), select the interval in seconds to send the packages, or use the "Disabled"
option, so as not to send Keep Alive.
Click on "Save" to store the settings, then click on "Apply" to send them to KMG
Note
7. Media profiles for Register Authorization
Media profiles save the Codecs that can be used by users of the Register Authorization service when
making calls through the KMG. They can be configured at:
To add a new profile, click on the Add button. In the screen that will be displayed, name the profile, select
the allowed Codecs, and the media transports (UDP-RTP, UDP-SRTP or TCP-RTP) related to each signaling transport
(SIP UDP, SIP TCP or SIP TLS ).
Click on "Save" to store the settings, then click on "Apply" to send them to KMG
Note
To add a new server, click on the Add button and configure the following parameters:
Each server can have more than one address. To add a new address, click the Add Endpoint link.
● Operation mode:
○ BRIDGE: There is no handling of the call media by KMG, therefore, there is no transcoding.
Select a media profile for UAC and one for UAS. KMG will accept calls with any Codecs, even
if different from those configured in the media profile.
○ TRANSCODE: It allows conversion between different Codecs. Select a media profile for UAC
and one for UAS.
○ FILTERED-BRIDGE: Call forwarding ONLY when the telephone device or server supports the
same Codecs that are available for use in the KMG. In this case there is no transcoding, and
if the telephone device or the server does not display a compatible Codec, the call is
ignored. The accepted Codecs will be those configured by the chosen media profile.
Click on "Save" to store the settings, then click on "Apply" to send them to KMG
Note
Configured servers will be shown in a list. To make a server the primary one for sending messages,
press the icon indicated by the star (Set UAS as primary).
7. Policies for Register Authorization
With the Register Authorization policies, you can allow or not users to register and make calls through
the KMG. Verification is performed through the analysis of SIP protocol methods, such as REGISTER, INVITE, etc.
To configure the policies for Register Authorization, go to:
Policies can be used together, and a register will only be allowed if it meets all the rules contained
therein
● Regular Expressions for User-Agent Validation: Regular expressions that must be checked so that
actions can be taken.
● Action if evaluated positively: If the value extracted from the User-Agent header meets the established
rule, the configured action is taken.
● Action if evaluated negatively: If the value extracted from the User-Agent header does not meet the
established rule, the configured action is taken.
● LDAP Configuration - Configuration of the LDAP database to perform the verification of extracted
information in Use SIP header values:
○ Address: IP address of the server where the LDAP database is located.
○ Port: Port that will be used by the KMG to access the LDAP database. The default port for
LDAP is 389 and for LDAPS it is 636.
○ Schema: The type of database that will be used, which can be LDAP or LDAPS.
● Perform BIND - If the LDAP database requests access credentials, the user and password can be
informed by selecting the "Perform BIND" checkbox.
● Search - Parameters for user search and evaluation in the LDAP server, through a rule that must be
followed by users who try to register. Depending on the result obtained with the rule, an action can be
taken.
○ DN Base: The verification rule that must be met for user validation, based on the ID and
values that will be extracted from the LDAP database.
○ Filter: Filter for comparison between the value extracted from the REGISTER message, and
the value extracted from the LDAP database, based on the DN Base rule. If the values are
identical, then the user will be allowed access.
○ Scope: Database level in which the value extracted will be searched in LDAP database.
● Attribute Validation - Action that must be taken according to the result obtained in the evaluation of the
attempt to register.
○ Action if evaluated positively - If the value extracted from the message meets the
established rule, one of the following actions can be taken:
■ ACCEPT - Accept registration.
■ DROP - Ignore registration.
○ Action if evaluated negatively - If the value extracted from the message meets the
established rule, one of the following actions can be taken:
■ ACCEPT - Accept registration.
■ DROP - Ignore registration.
○ Action if it is not possible to evaluate - If the value extracted from the message meets the
established rule, one of the following actions can be taken:
■ ACCEPT - Accept registration.
■ DROP - Ignore registration.
v=0
o=IpPhone 2890844526 8000 IN IP4 10.100.10.246
s=IpPhone CALL
c=IN IP4 10.100.10.246
t=0 0
m=audio 10006 RTP/AVP 0 8 101
a=rtpmap:0 PCMU/8000
a=rtpmap:8 PCMA/8000
a=rtpmap:101 telephone-event/8000
a=fmtp:101 0-15
a=ptime:20
a=sendrecv
● Use SIP header values: The following SIP message fields can be used for verification:
○ AUTHORIZATION - User authentication data.
○ FROM - Message origin identification.
○ TO - Message destination identification.
● Positive if status is one of the following: The evaluation is considered positive if the register status is:
○ INVALID - The status cannot be checked.
○ REGISTERED - The user is registered.
○ EXPIRED - The registration session has expired.
Click on "Save" to store the settings, then click on "Apply" to send them to KMG
Note
7. Global settings for Analytics
"Configuration" → "Resources" → "Analytics"
This option contains the global KMG Analytics timing settings. The values provided in this menu affect
the audio frequency analysis performed by Analytics.
Those settings usually cover most scenarios in telephony. Change these properties only if
Attention you are knowledgeable or have orientation from Khomp support.
Field Description
Maximum duration to detect that a Maximum duration of the call during detection, done after Response
human answered silence duration, in order to consider that a human answered.
Maximum duration for detection of Maximum voice time post-answering, to consider that it was a short
short human answer human answer.
Minimum voice time to report Minimum voice duration before connection to report Unknown Message
Unknown Message during answering.
7. Routing
The routing menu brings together all of the configurations related to call routing, which are the most
common configurations of the equipment.
In the Routing menu, you can configure the routes and NAPS that connect calls from one point to
another. In addition, profiles, behavior of Analytics (if the license is applied), CDR, Portability, and Routing scripts are
defined, among other functionalities.
7. NAP
"Configuration" → "Routing" → "NAPs"
As mentioned previously, the KMG functions according to the concept of creating associations between
NAPs and Routes. NAP - Network Access Points are logical representations to group E1/T1 links, GSM, channels
analog FXS and FXO channels, and SIP trunks. These NAPs are used for routing calls involving points of origin,
destination, or a combination of the two. Therefore, before configuring a route, it is necessary to determine its
incoming and outgoing NAP.
When selecting the type of NAP, the fields for configuration will be displayed, some of which are
exclusive and correspond to the technology selected. More details about each type of NAP are described
throughout this section.
3. Select a telephony profile, or leave the option "Use default profile", which serves the majority of
scenarios. See the section "Configure call properties" for more information on profiles.
4. In the "Script for Routing" field, select a previously created script. Please refer to the "Scripts" section, in
this manual, for more information.
5. In the field "Channel allocation algorithm", select an algorithm to define the way in which the link’s
channels will be used. Please refer to "Channel allocation algorithm", in this manual, for more
information.
6. The panel "Devices" will display all of the modules connected to the KMG that have an E1/T1 interface,
represented by their serial numbers.
○ Unallocated: The link will not be used by this NAP.
○ The entire link: All of the channels of this link should be used by this NAP. If this option is not
being displayed, the link is being used in a fractioned manner by another NAP.
○ Fractionate Link: Only the selected channels will be used by this NAP. If a channel is
disabled, it is being used by another NAP.
○ If you are creating an E1 trunk and you see only the message "This link is already completely
allocated by another NAP", this means that all of the E1/T1 links available are being used by
another NAP.
7. Click on the "Save" button. If no other configuration is made, click on the "Apply" button for the changes to
take effect.
Devices that have E1/T1 links that are fully allocated will display a message stating this situation. During
routing, this NAP is valid as source if the channel allocated for incoming call is associated with it.
Use IP packet address as In incoming calls, use the IP packet address as the "Domain" for
source validation, rather than using the value contained in the "From" field.
Ignore source port In incoming calls, it ignores the SIP packet source port.
-
Use called number from In incoming calls, it uses the called number sent in the "RequestURI"
URI header instead of using the value in the "To" field.
The time limit in seconds for the proxy configured in this NAP to be considered as a
destination. If no answer is received within this time limit, the next proxy on the list
Proxy fallback timeout will be used. If all of the destinations are unavailable, this NAP will not be used and
a retry will be performed using a different route in accordance with the
configuration.
Field Description Release/
Version
Time interval between Enables or disables Keep Alive checking of the remote SIP server. If
Keep Alive Checkups (SIP enabled, this option will disable NAP if the Keep Alive check fails. 3.2.0
OPTION) Defined time in milliseconds.
Limit of allocated Limits the number of VoIP channels that can be used by this NAP. This
3.0.0
channels limit applies to incoming and outgoing calls.
Network
External IP address for If NAT traversal by "Fixed IP external address" is enabled, this field must
the SIP protocol be filled in with the external IP address used for the SIP protocol.
3.2.0
External IP address for |If NAT traversal by "Fixed IP external address" is enabled, this field
the RTP protocol must be filled in with the external IP address used for the SIP protocol.
Transport
Type of SIP transport Defines the type of transport used for the SIP protocol.
3.1.0
Type of audio transport Defines the type of transport used for the RTP protocol.
Proxy list
Allows you to add SIP proxy servers. To add a new server, click on "Add proxy" in the lower-right corner
of the proxy list. In the SIP Interface, SIP Transport, Audio Interface and Audio Transport options, you can use the
settings applied to SIP NAP, or specify different values.
7. Options
The field "Channel allocation algorithm" determines which algorithm should be used to allocate the
channels associated with this NAP. Please refer to "Channel Allocation Algorithm" section for more information.
The "SMS Channel Allocation Algorithm" field allows you to configure the use of SIM cards to send SMS,
in which the usage algorithm and the sorting are defined.
● Algorithm
○ First free: Allocates the first available channel.
○ Round robin: Allocates channels in a balanced way so that all of them send the same
amount of SMS
● Sorting channels:
○ Ascending: Allocates from the lowest channel to the highest channel.
○ Descending: Allocates from the highest channel to the lowest channel.
SIM cards
Provides options for using SIM cards in each GSM device modem. It is worth noting that each modem
has an active and a stand-by SIM card, and they can be switched.
● Minutes of use to change SIM card: When this option is enabled, you must specify the maximum
number of minutes, according to the agreement with the carrier. When the maximum number of
minutes is reached, KMG forwards the call to the stand-by SIM card.
● SMS messages sent to change SIM card: When this option is enabled, you need to specify the
maximum number of SMS messages that can be sent by the SIM card, according to agreement with the
carrier. When the set number of SMS messages is reached, KMG will forward messages to the stand-by
SIM card.
By clicking on the "Add manually" button, you can enter the SIM cards. To do this, the SIM card ICCID
must be filled in.
Usage control
If this option is enabled, it provides an option to control the use of SIM cards individually, regardless of
the model in which the SIM card is inserted.
● Period for renewal: Determines the period after which the SIM card can be used again, if the limit of
minutes or SMS messages has been reached. You can select the following values: Daily, Weekly or
Monthly. Depending on the selected period, you need to specify the renewal time in the following field.
For example, if the selected period is Daily, you must specify the renewal time. If you select Weekly, you
must specify the day of the week, and the day of the month for the Monthly period.
● Minutes per period: Number of minutes that a SIM card can use during the period set. When this limit is
reached, another SIM card will be used.
● SMS messages per period: Number of SMS messages that a SIM card can send during the period set.
When this limit is reached, another SIM card will be used.
● Shared limits: If this option is enabled, both the number of minutes and SMS messages will be shared
among all SIM cards available in the NAP.
● Interval for usage control: Determines the time interval for controlling usage of the SIM card plan. The
first value indicates the initial billing time, regardless of the call duration. The second value indicates the
time for charging additional minutes. So if 60/6 is set, the call will be charged for 60 minutes, even if the
call duration is less than this time. If this same call is longer than this time, the billing control will be
every 6 minutes.
● Change SIM Card: Determines the time when the SIM card should be changed.
7. Configuring FXS channels
The FXS routes are the associations between the KMG and a destination FXS NAP, which will be used to
allocate the FXS channel for sending. You can also define filters for its use, such as the destination number and a
portability query.
Create a new NAP and select the type as FXS; note that an additional menu will be displayed with the
following options:
● End-of-dial marker - A key that when dialed will mark the end of the dialing process.
● Time-out for dialing - time-out to dial the call; after the time limit expires, the call will be canceled.
Still in the additional menu, select one or more channels to compose the NAP and make the following
configurations:
7. Registering extensions
Field Description
Domain listening port, where the packets will come from and where they should
Domain Port
be sent to.
Field Description
Use IP packet address as In incoming calls, use the IP packet address as the "Domain" for validation, rather
source than using the value contained in the "From" field.
Maximum wait time for a response via a given active proxy. Upon reaching
Force incoming calls through time-out, the next active proxy will be used (fallback). When there are no active
a configured proxy proxies to perform fallback, either the call is terminated or there is a retry on the
next route.
Ignore source port In incoming calls, it ignores the SIP packet source port.
In incoming calls, it uses the called number sent in the "RequestURI" header
Use number called in the URI
instead of using the value in the "To" field.
Maximum wait time for a response via a given active proxy. Upon reaching
time-out, the next active proxy will be used (fallback). When there are no active
Fallback time-out
proxies to perform fallback, either the call is terminated or there is a retry on the
next route.
Time-out for idle SIP session Time interval to terminate an idle SIP call.
Enables or disables the use of certain Codecs according to the created CODEC
Route CODEC profile
profiles.
Network
Field Description
Transport
Field Description
Accept any type of SIP Allows for receiving calls regardless of the data transport protocol used at the
transport in incoming calls source.
Type of SIP
Selects the data transport protocol of the calls.
transport
Type of SIP
Selects the audio transport protocol of the calls.
Audio
7. Proxy list
If the IP PBX server has proxies, they must be entered and configured in the Proxy List. Indicating the
network address, and the port by which you can access the server and transport the KMG data.
7. Extensions
Table in which the extensions of the FXS devices are registered. This information must match those of
the SIP server.
In the FXS device table header, the serial number is displayed. Beside it, there is an option to fill in the
extension number and user for automatic registration. For this, you only need to register the lowest extension in the
range.
For example: When you register extension 2000 through this option, the KMG automatically registers the
other extensions (2001, 2002, etc.) for all channels of the device.
Lastly, there is a button to clear the extensions that have been registered on the device, if it is necessary
to clear them all.
● Channels: List of FXS channels that can be included in the NAP (channels with a blocked selection are
already allocated to an FXS NAP).
● Extension Number: Dialing number that identifies the channel;
● User for registration: User for extension registration;
● Password for registration: Password for extension registration.
7. Ring pattern
Defines the ring pattern for the devices defined in the NAP, in milliseconds. You must register at least a
ring duration and a silence duration.
By default, the KMG has a ring duration of 1000 milliseconds and 4 milliseconds of silence.
7. Cadences
Sets the duration of the dial tone and disconnect tone that will be transmitted to the devices registered
in the NAP. You must register at least a tone duration and a silence duration.
Field Description
List of FXO channels that can be included in the NAP (channels with a blocked
Channels
selection are already allocated to a FXO NAP).
Field Description
When this option is enabled, the gateway will disregard group members that have
exceeded their call forwarding weight (refer to "Weight"), even if there is a retry
Force proportional
going on within the group). If it is not possible to forward the call to any of the
distribution of weights
members (because the proportional value has been exceeded or because there is
no available channel), then the system should consider the next route
Selects the algorithm used to perform the load distribution between the group
Load distribution algorithm
member NAPs.
The weight assigned to each NAP will be normalized using the following formula:
100 * WEIGHT / SUM(WEIGHT), providing a number within the range [0–100],
Weight named proportional weight, which will be used for channel allocation distribution
within the group. Use the zero value for weight for the NAP to be considered for
allocation only during a retry within the group
7. Load balancing algorithms
Two algorithms are available: "Forwarded Calls" and "Active Calls".
● Forwarded calls: The number of calls that were proportionally forwarded to each group member NAP
will be considered. This algorithm aims to forward calls proportionally in relation to the assigned
weights.
● Active Calls: The number of active calls at the time of forwarding for each member NAP in relation to
the total active calls for all members will be considered. This algorithm aims to keep active calls
proportionally in relation to the assigned weights.
The NAP whose calculated index is farthest from its proportional weight will have the highest priority.
Members that have an inactive status or that have all channels occupied, will be disregarded.
In the case of "retry" within the group or "fallback", the proportionality of the weights can be ignored,
allowing calls to be forwarded to members that have a resulting index greater than the proportional weight, when
the option "Force proportional distribution of weights" is disabled.
Group members with a zero weight value will be considered only in the "retry" within the group or
"fallback" situation. They are not considered for generation of the indexes and never take precedence over the
members that have assigned weights.
When you change and reload the configuration of a group, the call forwarding
Note counters will be reset.
Retry within the Group and Fallback
If a call is forwarded to a member of the group and this member is not able to complete the call, then
there may be a retry within the group. In this situation, the next member will be used to perform a new call
forwarding. This new forwarding is considered for the use of the Forwarded Calls algorithm. The occurrence of a
retry within the group follows the same rules as of the "retry" for the system routes, so if the disconnection cause is
not enough to justify a "retry", it will not occur within the group either.
If a call is forwarded to a member of the group that supports fallback and it occurs, then the same
member of the group will be used to forward the call again in fallback mode. This new forwarding is considered for
the use of the Forwarded Calls algorithm.
In both cases, if the option Force proportional distribution of weights is enabled, it may consider using
the next gateway route instead of performing a retry within the group or fallback.
7. Sorting options
Channel sorting will sort the channels considering their index and the telephony module. They will be
sorted according to the selected option which can be "Ascending" or "Descending".
For devices with multiple telephony modules, channels with similar indexes, but located in different
modules, will be grouped and sorted using the serial number of the device as a reference.
Sorting by links will sort the channels considering their index and the telephony module. Channels will
be sorted according to the selected option, which may be "Lowest channels first" or "Highest channels first".
For example: For a Trunk-type NAP configured with two links from the same telephony module, say link
1 and link 3, opting for the Round-robin algorithm and ordering by Links configuration, using the "Lowest Channels
First", the behavior for four consecutive outgoing calls will be:
7. Routes
"Configuration" → "Routing" → "Routes"
A table is displayed showing the configured routes. To create a new route, click on the "New Route"
button. The "Options" column displays the icons for editing or deleting a route.
Field Description
Priority to check a route over the others, if the route is similar to another. This
Priority value varies between 0 and 99; 0 indicates maximum priority, while 99 indicates
minimum priority.
The called number. The call data must match those in this field for this rule to
B Number
apply. Accepts regular expressions (POSIX.1-2001).
The caller number. The call data must match those in this field for this rule to
A Number
apply. Accepts regular expressions (POSIX.1-2001).
This option is only displayed if the "Check portability" field is enabled. Selects the
Valid service providers
service providers that are valid for this route.
Change number for It is used to format the number to be checked, according to the format expected
portability query by the query service provider. Accepts regular expressions (POSIX.1-2001).
Destination NAP Select the NAP to which the call will be forwarded if all rules are met.
Changes the B number (called) of the outgoing call by using regular expressions
Change B number
(POSIX.1-2001).
Changes the A number (caller) of the outgoing call by using regular expressions
Change A Number
(POSIX.1-2001).
Selects the Profile used by the destination. Profiles are defined in the Profiles
Destination profile
menu.
Select the predefined restriction in "Time Restriction". This rule will only apply on
Time Restriction
the dates and times specified in the restriction.
This option is only displayed if the source NAP is SIP or E1, with R2 or ISDN
signaling. Filters at the source channel according to the selected option. For SIP
NAPs, it is necessary to indicate the header of the collect call in the Profile.
Collect call filter
● Accept all calls: All calls are accepted.
● Accept collect calls only: Only calls signaled as collect are accepted.
● Reject collect calls: Calls signaled as collect are not accepted
This option is only displayed if the destination NAP is VoIP or E1, with R2 or ISDN
signaling. Signal outgoing calls according to the option selected. For SIP NAPs, it
is necessary to indicate the header of the collect call in the Profile.
Collect call indicator
● Paid calls: Calls are signaled as paid.
● Collect calls: Calls are signaled as collect.
● Forward signaling: Calls are signaled according to the incoming call
7. Regular expressions
Regular expressions follow the extended POSIX standard. Its official definition is available in chapter 9,
session 4 of the POSIX specifications. For more information, use the full reference (in English).
Name LOCAL_NUMBER
PRIORITY 1
CHANGE B NUMBER /^48([0-9]{8})$/$1/ Removes the prefix and dials only the last 8 digits
7. Retry
By default, when the defined route for call forwarding defines an unavailable NAP (physical or logical
failure) as a Destination NAP, that route is ignored and the next valid route is used.
If, after the call is routed, there is a call failure, e.g., a congested network, the call can be forwarded using
the next valid route, as long as the failure cause is marked for Retry in the settings profile of the source call.
Routes whose filters accept the source call are considered a valid route. If there is no valid new route,
the call will be rejected.
Reloading the gateway settings will disable the "retry" feature for all ongoing calls.
Note
This option displays the profiles registered in the KMG for use in NAPs and routes. In the option column,
there is a button to make this profile the system default, which is represented by a star. You can also copy an
existent profile by clicking on the button represented by a double sheet.
Maximum wait
time for the
Maximum wait time before the KMG uses another valid
outgoing channel
route.
allocation to
perform "retry"
R2
Forced
Enable sending of forced disconnection in the R2
disconnection
SIP
Send Custom Option in which you can enable the use of a custom SIP
Any 2.1.0
Header header
Identification
Option that makes it possible to configure the collect call
heading for
identification heading at the origin and the value that will Source 4.1.43.0
collect call at the
be used to send or receive collect calls a in the SIP
origin
Collect call Option that makes it possible to configure the collect call
identification identification heading at the destination and the value Source
4.1.43.0
heading at the that will be used to send or receive collect calls in the
destination SIP
Forward
Enables or disables extension header forwarding for
extension headers Any -
VoIP-VoIP calls.
(X-Headers)
Forward
The gateway must forward the header or User-to-User
User-to-User Any -
information from the incoming call to the outgoing call.
information
The configuration of codecs that can be used is made available in the call profile. Select the codecs that
will be used. You can drag them to define priorities, if there is more than one codec selected.
Cause Map
Defines the translation of causes of disconnection for different signaling types. When a disconnection is
received by one end of the call, the other end's cause map is used to translate that cause according to its signaling.
When the disconnection comes from a channel associated with the destination, the cause map will also determine
if a retry should occur because of the disconnection. Thus, the retry configuration is only valid for the source.
For example: For a call between an E1/T1 source and a SIP destination, if there is a disconnection from
the destination (SIP) (say a rejection of an INVITE), the cause provided by the SIP signaling will be used to determine
whether the source (E1/T1) should do a retry and, if not, which disconnection cause should be sent to disconnect
the source (E1/T1).
Analytics is a call classification feature which, when applied in the KMG, allows for identification of
signaling during a call that is answered. It can indicate whether the call is answered by a human or not, allowing the
call center administrator to decide what can be done with this call.
Analytics performs automatic detection of voice on a network (VAD - Voice Activity Detection).
7. Configuration steps
The configuration of Analytics involves the following steps:
Disconnect behaviors define which disconnecting code should be sent to the source channel when the
action performed by the call classification feature results in a "hang up".
Field Description
Code that should be used for disconnecting when using SIP signaling. Values
SIP Code
between 300 and 699 are accepted.
Code that should be used for disconnecting when using ISDN signaling. Values in
ISDN Code
accordance with the ITU-T Q.850 standard are accepted.
3. Click on the "Save" button. If no other configuration is made, click on the "Apply" button for the changes
to take effect.
This Web interface displays the Analytics behaviors created and allows users to manage them.
Follow these steps to create a new Analytics behavior:
1. Click on the "Add" button. The Web interface will be displayed, as shown in the following image.
You can also create an Analytics behavior by copying or editing a profile. Please refer to the "Configure
call properties" section, in this manual, for more information on call profiles.
2. Register a name and select the location where KMG will operate. The following table gives more details
on these fields:
Select the country and language for signaling. The choice entered in this
field affects the set of defaults that will be displayed. For example: When
Location 3.2.0
choosing "Portuguese (Brazil)", the KMG displays the set of defaults for
this region and language
3. In the "Timeout" panel, adjust the maximum time that the Call Classification feature will have to analyze
the audio of the call after connection is made. If the Call Classification feature cannot analyze the audio
within the time allotted, then the action set in Timeout will be applied.
Adjust the time for classification analysis carefully. Raising this value too high may increase
Attention the number of calls classified, but will raise the cost of telephony charges.
4. Define the action that the call classification should take in a timeout. These actions will also be
displayed for the signaling patterns in this Web interface. The following table describes what each
action does.
The gateway will send a connection to the source and replace the
Answer
audio if it hasn't already been replaced.
The gateway will play the selected audio on the destination channel
Play audio and hang
and, when the audio finishes or the destination end disconnects, it
up
will send a disconnect to the source similar to the "Hang up" action.
If the source is a VoIP channel, the gateway will send an SIP INFO
with the information obtained from the classification.
For example: -
X-Khomp-Analytics-CC: Fax
X-Khomp-Analytics-CC-Pattern: Fax 1100 Hz
Notify ● For the "Answer" action, the extension header will be sent
when the call is accepted.
● For the "Hang up" or "Play audio and hang up" actions, it
will be sent when the call is canceled or disconnected.
● For the "Notify" action, an SIP INFO will be sent with the
information.
The gateway will attempt to perform a call retry. If the retry is not
possible, the call will be terminated and a Log will be generated
informing the reason for termination.
Perform call retry 3.4.0
ATTENTION! - You need to enable the retry option in the
configuration of the source profile and allow it in the disconnection
cause map for cause 30003: Gateway analytics retry action, because
this setting takes precedence over analytics configuration.
5. Configure the action (described in the previous table) for the audio and signaling standards that require
adjustment. The default action is that all calls are answered. Some signaling standards allow two types
of adjustments:
● Global Configuration: Analytics applies the behavior for any classified call with the default type of
signaling and its variations (if any).
● Specific Configuration: Analytics applies the behavior that is defined in each default standard variation.
If the signaling standard is disabled, the action defined in the global default standard is applied.
Field Description
Answering machine Automated answering followed by a recording and ending with a beep.
The signaling pattern indicates that the call has been intercepted by the
Interception signaling
carrier and that the service is not human.
It is reported upon answering, when there was a voice before that, but no
Unknown message
pattern was recognized.
A beep informing that both the destination and origin numbers are from the
Portability tones
same carrier.
Field Description
Used to differentiate the ringback tone (usually songs chosen by users), from
Calling tone
unknown announcements.
Answered by a person (long Business human response, for example: "Secretary of Environmental and
answer) Social Studies, Philomena, good morning".
6. Click on the "Save" button. If no other configuration is made, click on the "Apply" button for the changes
to take effect.
If you select the "Play audio and disconnect" action, the "Audio file" field will be displayed so that you can
select an audio file.
These files are sent to KMF through the FTP protocol. Please refer to the "Access KMG via FTP" section,
in this manual, for more information on how to access KMG using this protocol.
The files should be uploaded to the /audio directory.
KMG accepts WAV files with the following specifications:
● PCM, 8-bit, 8000 Hz.
● PCM, 8-bit, 11025 Hz.
● PCM, 16-bit, 8000 Hz.
● A-LAW, 8-bit, 8000 Hz (RAW).
● U-LAW, 8-bit, 8000 Hz.
● GSM, VBR, 8000 Hz.
Audio files with unrecognized formats will be considered as being in RAW format (A-LAW, 8-bit, 8-KHz).
After creating Analytics behavior, you must associate it to a call profile. You can edit an existing profile
to attribute an Analytics behavior to it, or create a new profile by copying an existing one.
1. Click on the "Add" button to create a new call profile, or on the " " icon to copy the properties of an
existing profile, or click on the " " icon to edit a profile that you have created previously.
2. Select an Analytics behavior that was created previously, as described in the "Configure Analytics
behaviors" section.
3. Click on the "Save" button. If no other configuration is made, click on the "Apply" button for the changes
to take effect.
Please refer to the "Configure call properties" section, in this manual, for more information on call
profiles.
This is the final step in the configuration of Analytics. For KMG to run the Call Classification feature you
must associate the call profile containing Analytics to the routing where the classification is needed.
3. In the field "Profile", select a call profile that contains an associated Analytics behavior.
4. Click on the "Save" button.
5. Access the menu "Configuration" → "Routing" → "Routes".
6. 6. Create or edit a route where call classification will be applied.
7. In the field "Destination Profile", select the option "Use NAP profile".
Displays the time restrictions that can be applied to routes. This feature allows you to define that a
particular route operates only during business hours, for example. Or that a route operates only on weekends. Thus,
it is possible to configure overflow to another valid route if the main route is outside the defined hours.
The KMG has some default restrictions, which can be removed or edited by clicking on the action
buttons in the "Options" column.
To create a new restriction, click on the "New Time Restriction" button. You can define a restriction by
time, day of the week, day of the month, months, or by a combination of these restrictions. It is possible, for
example, to create a restriction on which a route will operate on Mondays and Wednesdays from 8 am to 6 pm.
Finally, click on the "Save" button and then on the "Apply" button for the changes to take effect.
In order for the time constraint to work correctly, KMG must have the date and time set
Attention correctly.
7. CDR - Call Detail Record
CDR is a register that contains the details of all calls processed by KMG. The following list contains
some examples of information included in the CDR:
● The phone number of the subscriber originating the call (calling party, A-party).
● The phone number receiving the call (called party, B-party).
● Additional digits on the called number.
● The starting time of the call (date and time).
● The duration of the call.
● The identification of KMG device.
● The results of the call, indicating, for example, whether or not the call was connected.
● The type of technology used in the call (VoIP, SMS, etc.)
● Any fault condition during call.
The registers can be visualized in KMG Web interface, at the "Diagnostics" → "CDR" menu, and can be
sent to a RADIUS server or to an FTP server.
● per minute: One file will be generated per minute containing all calls finalized during this minute.
● per hour: One file will be generated per hour containing all calls finalized during this hour.
● per day: One file will be generated per day containing all calls finalized during this day.
Call records are only written to a file when the call is ended. This way, the complete call data will always
be in a single file. If CDR file generation has been defined as per minute, for example, and a connection is in
progress at the end of the CDR file generation minute, the record of this call will be written to the next file generated,
if it is finalized during the next minute.
4. In the "Recording Style" field, select the style in which the CDR file will be recorded on the server:
● One line per routing attempt: One line will be written to the file for each routing attempt, including "retry".
● One line per call: One line will be written to the file for each call made.
5. In the "Formatting" text box, customize the CDR record. You can enter any desired text; all special fields
(${field_name}) will be replaced with the logged call data. The available fields are listed to the right of the
text box and can be added by dragging them into the text box or by double-clicking on the desired field.
Before dragging the field into the text box, you must position the mouse cursor where you want to insert
the field.
It is advisable to use an operator between the fields to make the file easier to read, such as a comma (,),
semicolon (;), or whatever provides better visibility. Note that the date and time fields have several
formatting options. There are some examples available in the interface help feature, located in the lower
left corner.
The available fields have a help button, represented by a "?", which contains their description. To view it,
position the mouse cursor over the help icon.
6. Click on the "Save" button. If no other configuration is made, click on the "Apply" button for the changes
to take effect.
RADIUS servers can be configured to collect information from the calls processed by the gateway for
registration and billing analysis. This configuration Web interface allows you to send KMG CDR data to up to 3
RADIUS servers.
To activate this feature, enable the RADIUS option and add a server. You can add up to 3 RADIUS
servers.
The description of each field is verified as follows:
List of Servers
Field Description
Port RADIUS server port. To set the default port (1813), use the value 0.
Value to be shared between the server and the client (get more information
Shared secret
at RFC 2865).
Advanced options
Field Description
Maximum time the KMG should wait for a valid response from the RADIUS
Maximum Request Wait Time server. This parameter works in conjunction with the "Maximum number of
retransmissions".
Maximum number of times that the KMG should retransmit a packet to the
RADIUS server. This parameter works in conjunction with the "Maximum
Request Wait Time". If there is no response from the server after the
Maximum Number of
maximum wait Time of the last retransmission, then the next server must be
Retransmissions
used. If there are no more servers configured or all are already inactive, the
packet will be discarded. The server may be marked as inactive if the
deactivation time is configured.
Date Format Date and time format expected by the RADIUS server.
Parallel Requests Number of parallel requests that should be made to the RADIUS server.
When the submit queue is longer than the value specified in this field, new
Acct-Status-Type packets with a value of Start (1) will be discarded, to allow
Submit Queue Size for the more Acct-Status-Type packets with Stop (2) to be added to the queue, until
disposal of packets the submitting queue reaches the "Maximum Queue Size" value. The
Acct-Status-Type: Start (1) "Maximum Queue Size" setting takes precedence over this setting. Therefore,
you can either use the same value for both or a smaller value in this field, if
you want the queue to have only the maximum limit.
When the submit queue is longer than the value specified in this field, new
Maximum Queue Size
packets are discarded.
This interface presents the options that allow you to send CDR records to the FTP server of your choice.
1. Enable the "Automatically send to FTP server" option.
2. Register the information from your FTP server in the "Server Address", "Server Port", "User", "Password",
and "Destination Directory" fields.
3. Click on the Save button. KMG will test the connection with the FTP server. This operation can take a
few minutes.
4. Finally, click on the Apply button for the changes to take effect.
After you click on the "Save" button, KMG will perform a connection test with the FTP
Note server. During the test, no response is displayed on the Interface. After the test is
complete, the test result will be displayed.
By default, CDR records are stored in KMG for a period of 30 days. After this period, the older records
are removed. This configuration is not related to
In this Web interface you can change the retention period. CDR storage is also limited by the capacity of
the KMG hard drive. The KMG 200, KMG 400 and KMG 1600 offer 2.5 GB. The KMG 3200 offers 8 GB.
7. Configuring portability
The portability feature, when enabled, is used in call routing to identify the carrier of the destination
number, so as to use the lower cost route.
When you enable this option in the system, the "Check portability" option will be available in the route
configuration ("Configuration" → "Routing" → "Routes"). When you select it, two more options will become available:
"Valid service providers" and "Change number for portability query".
When the portability query is enabled, it will check each call to discover which carrier the destination
number belongs to and the result will be stored. If the carrier of the destination number is listed in the "Valid service
providers" field, this route will be used, otherwise the routing will test the next routes.
In the "Valid service providers" field, you must select which carriers can be used with this route.
The "Change number for portability query" field is used to format the number to be checked, according
to the format expected by the query service provider. For example, if the dialed number is 0994899998888 and the
provider expects the Area code + number format, you will need to use a regular replacement expression, such as:
/0..([0-9]*)$/$1/, so the first 3 digits will be removed and the query will be performed using 4899998888.
Go to the topic "Importing data" for details on how to import RN1 codes.
Field Description
URL of the portability service. Use the wild card ${number} to indicate where
URL
the number being checked should be entered.
Parameters submitted using the POST method. Use the wild card ${number}
Additional Parameters
to indicate the key that should contain the number being checked.
It determines the number of errors that the portability system should accept
Acceptable amount of errors without taking action. When the defined amount is reached, the portability
system must be disabled according to the defined Time-out in case of errors.
Defines the time (in seconds) during which the portability system will be
Time-out in case of errors temporarily disabled if the acceptable number of errors is reached. After this
time, the service is enabled again.
7. Importing data
To import the data, open the import wizard using the "Import data" button and then fill out the form. The
import form applies to both Webservice and local database portability.
The submitted file must be a text file or compressed text in "gzip" format. If the file has special
characters (accents, for example), you must use UTF-8 encoding. The file must be in the format of fields separated
by a well-defined character, with one record per line (mandatory). The CSV format is recommended for the text file
provided. Empty lines are ignored.
Field Description
Select the type of data in the file. For portability via Webservice, only the
Type of data in the file
Carrier data type is available.
Select the data type in each field according to the order in which they are
Format of the fields in the file
displayed in the file being imported.
If enabled, it deletes all records that match the "Type of data in the file"
Remove all records before
selected before initiating the import. "Caution", because dependent records
importing
will also be erased (Numbers and Prefixes are dependent on the carriers).
If enabled, it skips the first line of the file. This option exists for compatibility
Skip first line
with having columns headers in the first row.
If enabled, the "Operation" field, informed in "Format of fields in the file", will
Incremental Import
be used as a guideline to what to do with the record.
If enabled, invalid rows (which could not be imported) will be discarded and
Skip invalid rows logged. If disabled, the import will end with an error on the first invalid line
encountered.
We recommend carrying out the first import of the portability database using the following order:
1. Carriers.
2. Ported numbers (local database only).
3. Prefixes (local database only).
7. Scripts
Products in the KMG line have support for Scripts in the LUA format. Lua is a programming language
designed to extend applications. It allows procedural programming, object-oriented programming, functional
programming, data-oriented programming, and data description. More information on LUA can be found at the site
www.lua.org.
The use of a script basically allows you to make changes to the SIP header, and change the source and
destination numbers. You can manipulate the same information that is logged in the CDR file.
The script is associated with a NAP. When the route has a scripted NAP, then it executes its instructions.
The script can be run on both a source NAP and destination NAP.
7. Adding a script
1. Click on the "New Script" button.
2. Enter the script name.
3. Write the script in the displayed text area.
4. Click on the "Save" button and then on "Apply."
The text area has instructions for manipulating call data in the KMG. The script must contain the
following functions so that it runs correctly.
function prerouting()
return true
end
function postrouting()
return true
Assigning a script to a NAP
end
To associate a script with a NAP:
This Web interface displays the SIM cards inserted in the GSM interfaces along with their properties,
either through internal modules (KMG 400) or external telephony modules - KMG Module. When you insert a
properly registered new SIM card, it will be displayed on this Interface, so that it is associated with an existing GSM
NAP.
The icon " " indicates that a new SIM card was discovered.
By clicking on the icon " ", you can associate a new SIM card to a group of GSM channels that have
been previously registered and also include or edit the number of the SIM card. This number will be used as the
destination number in routing.
7. Associating a new SIM card with a group of existing
GSM channels - NAP GSM
When inserting a new SIM card, you can associate a group of previously created GSM channels. See the
section Configure GSM channels for more information on the creation of a group of GSM channels.
1. Click on the icon " " for the SIM card that will be associated with a GSM group.
2. In the column "NAP", select the group of GSM channels created (NAP GSM). Repeat this action if there
are more SIM cards that will be associated with a NAP GSM.
3. Click on the "Save" button. If no other configuration is made, click on the "Apply" button for the changes
to take effect.
You can add SIM cards before installing the SIM cards in the GSM interfaces connected to the KMG.
This way, when a SIM card is inserted, it can be associated with a NAP GSM defined automatically.
Field Description
SMS messages can be sent even if the channel is occupied with a voice call.
Name Note Name of the SMS route. The name must be unique among all routes.
The priority with which this route will be evaluated. Lower priority routes will
Priority be assessed before higher priority routes. There is no defined order for equal
priority routes.
Destination Number Filter by POSIX.1-2001 regular expression for the SMS destination number.
Check Portability If enabled, it will indicate the use of the portability query for this route.
When the option Check Portability is enabled, it selects the service providers
Valid service providers
that are valid for this route.
Change number for portability Number to be used for the portability query. Accepts regular expressions
query (POSIX.1-2001).
The NAP to be used for the allocation of the outgoing SMS channel, only
Destination NAP
GSM NAPs are displayed.
7. SMS sending test
With the KMG, it is possible to carry out SMS sending tests to ensure that the configured SMS routing is
working properly. For this, you must use the sending form, providing information on the required fields "Destination
Number" and "Text Message". You can also request the sending confirmation.
When sending, the following information is displayed: the value of the generated sms_reference code,
the ICCID of the Sim Card that was used to send the SMS, the route used, and the carrier resulting from the
portability query, if any of the evaluated routes use portability query. Confirmation of successful sending (by the
carrier), as well as of receipt, if requested, can only be done through the Logs or the notification system.
The "Notifications" option is displayed only if KMG has an SMS telephony interface.
Note
With a GSM telephony interface, the KMG can send the content of SMS messages received to HTTP
servers that are able to receive GET and POST type requisitions or even REST APIs.
This feature makes it possible to integrate the KMG with systems that process SMS messages received,
such as a system that solicits a response from a client by SMS, for example.
To use this resource, an HTTP server must be registered first. It is possible to register more than one
server to receive different types of messages separately, or send all types to the same server.
Field Description
Used to describe the server. The panel "Default transport for types of notification
Name
will display for selection
User of authentication of HTTP service, or API REST. This field is not mandatory in
User for authentication
the event that the server does not request authentication
Password for authentication of HTTP service, or API REST. This field is not
Password for authentication
mandatory in the event that the server does not request authentication
Remote path HTTP server directory where the messages will be stored
7. High Availability - HA
Resource available on all KMG models, however HA is not supported by the EBS
Note internal model, if present.
If the main hardware fails, another KMG of the same model will take on the gateway functions,
preserving network settings, including the IP addresses. The High Availability feature was designed to operate with
or without external telephony modules.
A KMG installed with High Availability offers "system security" and guarantees "uninterrupted continuity
of operation".
Khomp's external telephony modules have two network interfaces. When using this module in an HA
scenario, both the master KMG and the spare KMG must be connected to the same module and the same gateway
network interface. For example: If the master KMG is connected to an E1 telephony module via the P0 interface, the
spare KMG must also be connected to this same module via the P0 interface, as shown in the previous figure. The
same rule should apply to other network interfaces and modules, if available.
Enabling/disabling the High Availability feature is a task that must only be performed by
Attention Khomp’s support team.
With high availability licenses loaded on the equipment, the configuration options become available.
Initially it is necessary to configure the Master equipment selecting the network interface that will be used for
management, as well as its IP and network mask. The same process is repeated afterward on the Spare equipment.
At that point, both pieces of equipment will be operating in high availability.
Field Description
The IP address that will be used to access the KMG. After enabling High
Administration IP
Availability, this will be the actual IP address of the gateway.
Subnet mask that will be used to access the KMG. After enabling High Availability,
Subnet mask
this will be the actual subnet mask of the gateway.
8 Monitoring
"Monitoring"
The Monitoring interface should be used to monitor the KMG operation. In this section you can check
the created NAPs and track the status, analyze the KMG telephony devices and modules and their respective
channels.
In the "Refresh rate" field, you can define a period for the interface to update the information
automatically, according to the defined time. Or update manually.
8. NAP
"Monitoring"→ "NAP"
List of information for monitoring of one or more NAPs. The columns provide the following data.
Field Description
● Active
Status Provides the NAP status for its use.
● Inactive
8. SIM cards
"Monitoring" → "SIM Cards"
The status information of the SIM Cards configured in the system is displayed. You can also change the
minutes and SMS message control for SIM cards that have this setting enabled.
8. Devices
"Monitoring"→ "Devices"
It displays monitoring information on the physical devices - Boards and external telephony modules
(EBS) - and Logical devices (VoIP). For each device the following is displayed:
Field Description Values
8. Links
"Monitoring" → "Links"
The purpose of this section is specifically for monitoring digital links. All the links configured in the
system are listed, as well as any information about their current situation. The following information items are
available:
● Link: The links are identified in the "Link" column by a code consisting of the serial number of the device
and the link number in the device, and the assigned name (optional), separated by the character ".".
● Status: Operation situation of the links. It indicates if a link is active or not, according to the following
values:
○ Up – the link is aligned, configured, and functional.
○ Down – the link is not operational. The "Alarms" column has information about the cause.
○ N/A – Information not available. This situation occurs when it was impossible to retrieve the
information, either because one or more Services that are essential for the system operation
are not active, or because the device to which this link belongs is not connected.
● Alarms: Information about link errors. When the link is operational (Status="Up"), only the character "-" is
displayed.
The possible alarms are:
FrameSyncLost Loss of frame alignment Cable connected, but remote equipment off
● Tx circuit interrupted
Alarm was issued in remote ● CRC4 not configured
Remote alarm
equipment ● Internal failure in the remote
equipment
HighErrorRate Reserved -
● Variations: It indicates whether there are variations in the link error counters. For example, if a cable
presents a bad contact issue at a given moment but works well after that, the counters will indicate that
a problem occurred.
If there are no variations (all counters are reset), clicking on the "View" link will display a table of
variations without error increments. Otherwise, if there is a counter with a value greater than zero, the link will
appear in bold.
Additionally, there is the option to reset the counters through the "Clear" link.
The following counters are monitored:
Slip alarm Number of discarded frames Links operating with different clocks
PRBS Reserved -
Frames without
Reserved -
synchronism
● Signaling: It displays the telephony signaling protocol used on the link defined in E1/T1 Links
"configuration".
8. Restarting
It power cycles the link framer, causing a physical restart of the system. All the calls are dropped and
the link is configured again.
8. Blocking
It power cycles the link framer, causing a physical restart of the system. All the calls are dropped and
the link is configured again.
8. Channels
"Monitoring" → "Channels"
This section gathers monitoring information about the device channels. To view the channel list, select
the device and then the channel range. In devices with digital links, channels are grouped in links.
Value Meaning
● Free ● Idle
● Incoming ● Call in Progress
● Outgoing ● SMS in Progress
E1
● Fail GSM ● Modem Error
● Locked for Outgoing ● SIM Card Error
● Locked for Incoming ● Network Error
● Remote Lock ● Not Ready
Interface AddInfo
● Free
VoIP ● Outgoing Lock
● Incoming Lock
● Dialed Number: This field informs the called number in the current call.
● Duration: Duration of current call.
● Average time: This field informs the average time duration of the calls made.
● Statistics: It informs the statistics of calls computed by API K3L.
● Incoming: Total of calls received.
● Outgoing:
○ Amount: Total number of outgoing calls.
○ Failures: Unsuccessful outgoing calls.
○ Completed: Successful outgoing calls.
● SIM Card: In this field, you can select the channel index that will be used by the GSM modem, with the
option of alternating between the two existing slots, 0 and 1.
A request for changing the SIM Card has precedence over the automatic rotation by use and
can be configured in the NAP.
Attention If there is a call in progress using this SIM Card, it will be finalized.
● Carrier: It informs the carrier name, registered in the ERB cell, in which the modem is currently registered
at the Level of RX signal, as a percentage, received by GSM antenna. The signal strength can range from
-113dbm (1%) to -51dbm (100%).
8. Device statistics
Displays the device information since the last KMG boot.
● Dialing completion: Percentage of completed, unanswered and failed calls, i.e., calls that for some
reason could not be completed.
● Cause of failures: If there are failed calls in the previous chart, the percentage of these causes will be
displayed.
8. Links
If the telephony device has an E1/T1 link, you can view the dialing completion of all links available on the
device, which may help identify possible failures in these links.
9 Diagnostics
The diagnostics area allows for reading and downloading system logs, as well as changing log levels.
The most important or urgent system messages are shown on the initial Web interface (Summary). The content
shown is the same as the messages.log file.
9. Downloading logs
In addition, in this screen you can perform a download of the latest logs of the system. Downloading the
latest Logs makes it easier to provide a packet with all system logs to the technical or diagnostics team using tools
of the workstation currently being used to access the Web interface.
● The first character indicates the priority level of the message and can be (in order of higher priority to
lower priority):
○ E - Error - Error messages usually indicate inability of one of the services to properly operate.
○ W - Warning - Serious problem warning messages usually indicate a behavior that will not
disable the service operation, but could compromise the expected result.
○ I - Information - Informative messages usually indicate start and end of service execution,
as well as start and end of device operation. This level of log is displayed on the log
summary screen.
○ N - Notify - Notification messages contain relevant information, however, they are normally
not prejudicial to the operation of the system.
○ T - Trace - Debugging messages, which should always be disabled during normal operation,
provide service debugging data, normally useful when diagnosing an operation problem.
● The date and time in which the message appeared will always be between the first and the second
vertical lines "|";
● From the second vertical line "|" to the parentheses at the end of the line, the formatting varies according
to the service;
● The name of the service that issued the message will be located at the end of the line, enclosed in
parentheses.
Messages labeled as error, warning and information priorities are recorded in the service Log and in the
messages.log file.
● Identify the device by using the letter D followed by the device serial number.
● Notify the channel using letter C followed by the channel number.
● Notify the link using letter L followed by the link number.
In this area you can enable the diagnostics mode, and change the Log levels.
9. Diagnostics mode
It is not recommended that the diagnostics remains enabled during normal device
operation. Whenever debugging messages are unnecessary, this mode should be
Attention deactivated.
9. Advanced options
Allows you to enable or disable the trace (debugging) of the Logs displayed in this option. Other
information, such as information, warnings and errors, will continue to be recorded in the Logs.
The first record, "Logs", has the "FullLog" component that overlaps the trace registration in the other
logs, so it is not necessary to enable each log individually.
When you expand the log types, the "Value" is displayed in the first line. This setting affects all other
components of the Log. Therefore, when you set the K3L Log value as True, the system understands that all other
components of this Log will also be true, except if a particular Log is marked as Never. The following explains some
more details on log debugging levels.
● False: The Log (trace) debugging is not recorded in the Log. However, if the Value or FullLog fields are
set to true, this value is overridden.
● True: The Log (trace) debugging is recorded in the Log, even if the Value or FullLog fields are false, this
field remains true.
● Never: The debugging of this Log will never be recorded, even if the Value or FullLog fields are set to
true.
9. Logs
"Diagnostics" → "Logs"
It provides access to the service Log files, in which the following Logs stand out:
● messages.log - The most important and urgent Logs are also saved in this file.
● k3l_intf.log - Debugging Log of the received commands and sent events from/by the API to the other
services.
● kgateway.log - Routing service Log.
● kmp.log - VoIP service Log.
● isdn.log - ISDN debugging Log. Contains the option for analysis that displays the log in the most
user-friendly format.
● r2.log - R2 debugging Log. Contains the option for analysis that displays the log in the most
user-friendly format.
● voip_msg.log - SIP debugging Log.
● 9. Config
gsm.log - GSM debugging Logs.
This option displays the KMG configuration files with the date of the last reboot of the machine.
9. Licenses
This option displays the licenses applied to the KMG. You can also view and download the license file as a backup.
9. OLD
Old logs are automatically moved to the subdirectory /old, where they are archived with the date and
time on which they were moved, subsequently compressed and eventually removed, depending on disk usage.
The system is configured to retain up to 5GB (1 GB on the KMG 200 model) of logs, combining all active,
old and compressed logs. When this number is reached the logs are automatically removed, from the oldest to the
newest.
9. CDR
"Diagnostics" → "CDR"
The CDR file is a list of records of calls made by the KMG. For each call made, a record ticket is
generated to store the call data.
In the CDR diagnostics environment it is possible to download the CDR file or view it directly on the Web
interface.
9. Packet capture
"Diagnostics" → "Packet capture"
It allows you to enable network packet capture on the gateway. This capture file uses the pcap
compressed format, employing the gzip algorithm. We recommend using the free software Wireshark for viewing
the capture files.
The capture files are stored in the /capture directory in the FTP and are also accessible through the Web
interface, at this page.
Once the capture is started, it can be stopped by any of the following three conditions:
● It was requested that the capture be aborted, through the Web interface.
● The configured time limit was reached.
● The maximum size allowed has been reached.¹
¹The maximum size is determined by KMG model and is shown in the help section for the "Duration" field. The
following configurations are shown:
Field Description
9. Audit
"Diagnostics" → "Auditing"
Routing audit refers to audio recording during the call classification period, i.e., the period between the
beginning of the call and the result of the classification.
When the result of the classification occurs, the audio is stored in a folder accessible through the FTP
protocol with the name of the classification result, so this audio can be used to verify that the classification is
correct. To enable auditing, the destination NAP of a given route must be associated with a configured Analytics
profile.
Only the channel allocated to the destination NAP is recorded, as this is the channel
Note being evaluated by the classification feature.
To enable auditing, the destination NAP profile must have Analytics behavior selected. Routes that meet
these requirements will display a tick box to the left of the route name. Additionally, it is necessary to configure the
displayed fields:
● Duration: Configures how long, in minutes, the audit process should record calls.
● Record the entire call: When selecting this option, it will record until the call is ended, otherwise it will
record until the end of the classification.
● Routes to be audited: Defines which routes should be audited. You must enable at least one.
You can only enable auditing on routes wherein the destination NAP has Analytics
Note behavior selected in its profile.
Activation of the audit occurs when the audit options are saved; the start and end time will be displayed
on the audit interface. At any time, the audit can be ended using the same configuration interface.
The audit end time is the time limit to start recording calls, thus, when this time limit is
Note reached, no new recordings will start. Recordings in progress will continue until the
end of the classifier and can be stored after the audit end time.
To access audit audio, you must access the KMG through your "FTP" service with the same username
and password valid for Web access in the audio/audit folder. Within this folder there are other folders, representing
the possible classification results and error conditions, as follows:
Never remove or modify audit folders. Audit files are never removed by the KMG. Removing
old files is the responsibility of the system administrator. Keeping old files which take up
Attention storage drive space may result in unwanted gateway behavior.
10 Management
In this menu the options for managing the gateway are displayed. In the upper menu there are some
buttons with specific functions.
Beginning with version 4.1.42.0, the download of two files is performed: KHOMP-MIB
Note and KHOMP-KMG-MIB.
More information can be found at the "KQueryServer Manual".
The MIB developed for KHOMP products, in the SMI RFC1065 RFC-1065 format, can be downloaded in
the "Download gateway MIB" option in the Management menu of the Web interface.
A new command line interface is made available via SSH. New options can be consulted through the
terminal’s help command. To access it, click on the "Remote Terminal" button, read the instruction displayed in the
Interface and download the private key.
Notes:
● The login credentials are the same as those used to access the Web interface of the KMG.
New users with different Web interface access privileges can be configured. Privileges allow for access
to the four gateway menus: Configuration, Monitoring, Diagnosis, and Administration. For the monitoring menu, you
can specify whether the user can have full or read-only access. These users may access KMG both through the
Web interface and FTP.
10. Changing a user password
1. In the menu "Administration", click on the icon " " for the user whose password will be changed.
2. Enter the new password in the "New Password" and "Reenter password" fields.
3. Click on the "Save" button.
The new password will be requested when next accessing the KMG.
The following describes actions that can be taken and files that can be accessed through the FTP:
● CDR files: All CDR records are available for download in the /cdr directory. These files should be
removed manually to free up space.
● KMG Log Files: All of the current Log files are available in the /log directory. Older Log files are stored in
the subdirectory /log/old.
These files are managed by the KMG. Older files are removed automatically to free up space on the disc.
● Update files: KMG update files are in the firmware folder. Upload and management of theses files can be
performed both via FTP and via Web interface.
● Classification audit recordings: Recordings from the classification audit will be available in the
audio/audit directory. The files in this folder are not removed automatically and their maintenance is the
user's responsibility.
● Files for playback in the classification list: The files that you wish to play using the Play audio and hang
up feature of the call classifier must be placed in the audio directory.
● Network packet capture files: The network packet capture files will be generated in the capture directory.
10. Provisioning
Provisioning allows for saving the settings applied to the KMG on file. This way you can keep a backup
of the settings and restore when necessary. This file can also be applied to another KMG gateway.
A single packaged, compacted file will be generated and exported in the format "tar.gz". You must use
this format for restoring settings.
The file name contains the KMG serial number and the date it was created.
The settings file should not be changed. An improper change could render the file unusable.
Attention
Restore configurations
3. In the "Management" → "Provisioning" menu, click on the "Choose file" button, in the "Restore
configurations" option.
4. Click on the "Send" button. After performing this step, the KMG must be rebooted
5. Restart the gateway through the "Management" → "Restart the gateway" menu.
The IP address of KMG network interfaces is not changed. This way you can maintain
Note IP access after restoring configurations.
It is possible to use a provisioning file in another KMG that is compatible, that is, one that contains the
same telephony modules. However it is necessary to meet some criteria. When using only VoIP (SBC), the
procedure is simpler. When KMG has telephony interfaces (TDM), some requirements must be observed.
10. Requirements
● The KMG model in which the settings file will be applied must support the same number of
simultaneous calls or more. Therefore, it is not possible to restore the configurations of a KMG 3200,
which supports up to 2,000 calls, onto a KMG 2000, which supports up to 240 calls. But it is possible to
do otherwise.
● If there are external telephony modules, they must be arranged in the same order and the same quantity
as the gateway in operation. Otherwise, the device structure will be incompatible and the backup will not
be supported.
10. Procedure
1. Ensure that gateways meet the requirements described above.
2. Check if the KMG that will have the provisioning file, already has the licenses applied. Check the
"Management" → "Licenses" menu.
3. Load the configuration file as described in the "Restore configurations" section.
4. Restart the machine to validate the settings.
10. Update
This section allows for managing KMG version update files.
All available packets are displayed. The "Remove" and "Update" options are displayed for each file. By
clicking on the "Remove" button, the update file will be removed from the system. By clicking on the Update button,
the file will be installed on the system and the system will be automatically restarted after the installation is finished.
To upload a new update file, click on the "Select File" button, choose the file to be uploaded, shown at
the bottom of the file list. Click on "Submit" and wait for the upload to end.
10. Troubleshooting
My E1 links won’t align
● Make sure the device to which KMG is connected has the same protocol settings. Remember that when
using ISDN, one end must be set as "ISDN Network" and the other end as "ISDN User".
● The KMG may perform or receive synchronization through the E1/T1 link. If the E1/T1 link is connected
to a public central hub, this option must be enabled for it to "receive" synchronization. If it is connected
to a PBX system, this option should usually be set as to "generate" synchronization.
● The CRC4 checker is enabled in the KMG configuration. If the device connected to the E1/T1 link is set
as CRC4-enabled, then this option must also be enabled in the KMG settings; otherwise it will not be
enabled.
The E1/T1 link is aligned, but the ISDN channels are down
I have no access to the device because the network interface is not responding
● Check if the TX/RX pin of an E1 is incorrectly connected to the TX/RX pin of another E1.
● Check if KMG is configured with the same Codecs as those of the SIP Server trunk.
● Check if the RTP ports are the same as those of the SIP Server trunk.
● The KMG sends in an Ethernet broadcast network packet all network addresses configured on all
network interfaces.
● The packet uses Ethernet Type 0xF00D, which can be used to filter a traffic capture. We recommend the
free software Wireshark to perform the packet capture.
● There is also a verification if at least one network interface is configured. If none is configured within five
minutes of the KMG being booted, then the first one will be configured with address 10.10.10.10 and
network mask 255.0.0.0.
● Depending on the model, the first one may be eth0 or eth1.
You can find the manual and other documents on our website at www.khomp.com. To register
and access our documentation, please follow these steps:
You can also contact our technical support team by e-mail at [email protected] or by
phone at +55 (48) 3722-2930.