MOTOROLA SOLUTIONS 2.2.0.X Compass Decision Management System

THIS MANUAL WAS CREATED ON MONDAY, NOVEMBER 8, 2021. DOCUMENT ID: IU-AG- MAN017-1-DRAFT2

COPYRIGHT, TRADEMARKS, AND DISCLAIMERS

COPYRIGHT © MOTOROLA SOLUTIONS – COMPASS DECISION MANAGEMENT SYSTEM™ VIDEO SECURITY & SOLUTIONS.

TRADEMARKS

Compass Decision Management System is a registered trademark of Motorola Solutions. Microsoft and Windows are registered trademarks of Microsoft Corporation. App Store is a service mark of Apple Inc. Android is a trademark of Google Inc. All other trademarks mentioned in this document are trademarks of their respective owners.

DISCLAIMER

This text is intended for general information purposes only, and due care has been taken in its preparation.
Any risk arising from the use of this information rests with the recipient, and nothing herein should be construed as constituting any kind of warranty. Motorola Solutions reserves the right to make adjustments without prior notification. All names of people and organizations used in the examples in this text are fictitious. Any resemblance to any actual organization or person, living or dead, is purely coincidental and unintended. This product may make use of third-party software for which specific terms and conditions may apply.

ABOUT THIS GUIDE

This guide is written for users of the Motorola Solutions Compass Decision Management System™ software version 2.2.0.x. It provides installation and configuration information for the system variants, as well as a description of the hardware and specifications.

Please ensure you read the instructions provided in the guide before using the system.

SAFETY NOTICES

This guide uses the following formats for safety notices:

Indicates a hazardous situation which, if not avoided, could result in death or serious injury.
Indicates a hazardous situation which, if not avoided, could result in moderate injury, damage the product, or lead to loss of data.
Notice Indicates a hazardous situation which, if not avoided, may seriously impair operations.
Additional information relating to the current section.

BEFORE YOU BEGIN

Before you begin, make sure you have completed the requirements given in Table

TABLE 1 PRE-INSTALLATION CHECKLIST

INTRODUCTION

Compass VoIP Gateway is an Asterisk Linux solution. The primary functions of CompassVoIP are as follows:

• Receiving concierge alarms.
• Making calls to the respective ordinances.
• Recording calls made during an alarm.

CompassVoIP and Motorola Solutions Compass Decision Management System™ usually operate on the same network, and on the same server that runs on a Virtual machine (VM). On the internal network,

Compass is connected to CompassVoIP through Asterisk Manager. Asterisk Manager allows Compass to receive all events.

Compass server uses port 5038 to connect to CompassVoIP but you can reconfigure it in the manager.conf file.

• For more information on ports used by CompassVoIP, see “List of ports used by CompassVoIP” on page 8.
• For more information on configuration files, see “CompassVoIP and Configuration files” on page 15.

To interconnect the internal VoIP network with the client’s VoIP network, you must configure a trunk between CompassVoIP and the client’s Private branch exchange (PBX).

If the client’s PBX and CompassVoIP are on different networks, we recommend that you use a VPN.
A VPN will ensure full interoperability between the two networks without NAT and firewall issues.

CompassVoIP follows the pattern given in Figure 1.

EXAMPLE CALL WORKFLOW

An example of a call workflow is given in Figure 2.

ASTERISK

Asterisk is an open-source software that can be configured in various ways, including the following:

• Media gateway.
• Media server.
• Voicemail.
• IP PBX.

The Asterisk software includes features that are available on proprietary PBX systems.

• For more information on Asterisk, see “Asterisk architecture” on page 12.

RECORDING IN COMPASSVOIP

The recording is done on the backend. When a user logs into Compass, an extension REC is created and the registration is done in CompassVoIP using an integrated softphone.

LIST OF PORTS USED BY COMPASS VOIP

The ports that CompassVoIP uses are given in Table 2.

TABLE 2 PORTS USED BY COMPASS VOIP

LIST OF CODECS SUPPORTED BY COMPASSVOIP

• CompassVoIP supports the following codecs:
• G. 711 A-law, 64kbit/s.
• G. 711 µ-law, 64kbit/s.
• G. 722, 64kbit/s.
• GSM, 13kbit/s.
• For more information about codecs, See “Codecs” on page 12.

INSTALL COMPASSVOIP

To install CompassVoIP, do as follows:

1. Download the specific VM.
   The VM is Ubuntu Server version 20.04.3.

2. Import the OVA file to your VMware Workstation, as shown in Figure 3

3. To connect to the VM, use the configurations given in Table 3, Table 4 and Table 5.

   • If necessary, use the following commands to shut down the firewall for testing:

         sudo iptables --policy INPUT ACCEPT

     sudo iptables -F You must enter the commands in the order specified If you do not, you can be locked out of the VM and must restart the installation.

When you are testing the firewall and there is a risk of being without access, run the command shutdown -r 10 before you begin the tests.
This command reboots the server after 10 minutes and the firewall rules reset, if the file has not been changed.
To cancel the reboot, run the command

            shutdown -c.

To make changes to the firewall configuration, edit the file /etc/iptables/Rules.v4 and restart the
start.
The password manager is required to configure CompassVoIP in the Compass interface. The file is available at /etc/Asterisk/manager.d/permission.conf.
By default, DTMF support is added to RFC2833. To change to another type, change the users.conf and Sip.conf files.
The type of dtmf depends on the equipment used

4. Run the following command to set up a static IP:

   sudo vi /etc/netplan/01-netcfg.yaml

   iface eth0 inet dhcp

   iface eth0 inet static address 192.168.0.131 netmask 255.255.255.0 network 192.168.1.0 broadcast 192.168.0.255 gateway 192.168.0.1

5. Restart the network interface by running the following command:

   service networking restart

TABLE 3 UBUNTU SERVER CONFIGURATION

TABLE 4 IPTABLES FIREWALL CONFIGURATION

TABLE 5 ASTERISK CONFIGURATION

ASTERISK ARCHITECTURE

Asterisk has been developed for maximum flexibility, thus, Asterisk is transparent to protocols, codecs, and hardware, and is compatible with all current and future technologies, without the requirement for changes to the core.
Asterisk works in a modular way. Loading modules separately permits more flexibility for the administrator, allowing the administrator to select the best and leanest configuration suitable for their needs.

CHANNELS

A channel can be interpreted as a connection that brings a call to Asterisk PBX, and is equivalent to the telephone line of a traditional telephone systems. A channel can be a connection to:

• A traditional analog phone.
• A Public switched telephone network (PTSN) line.
• A logical call, for example, an internet call.

All calls are originated or received on a separate channel. The types of channels supported by Asterisk include the following:

• SIP.
• H.323.
• IAX.
• PSTN.
• ISDN.

CODECS

Codecs are responsible for encoding or decoding audio signals to/from a digital data stream. Codecs influence the number of calls that can be made on the same link by encoding the audio signal in a form that uses less bandwidth. For example, voice traffic on PTSN network uses 64 Kbps of bandwidth; when a codec, such as GSM, is applied to voice traffic , the bandwidth is reduced to 13 Kbps.

PROTOCOLS

Protocols define the form, or language, that communication points, for example, terminals and gateways,
will use to communicate. Protocols are responsible for the following tasks:

• Signaling to establish a connection.
• Determining the destination point.
• Telephony signaling issues, including disconnection and call identifier.
• Routing between points.

The most frequently used protocols are H.323 and SIP. However, the Inter- Asterisk eXchange (IAX) protocol has had significant diffusion.

APPLICATIONS

Applications are the features found in Asterisk. These include:

• Voicemail.
• Music waiting servers.
• Conference rooms.
• Media gateway automatic response units (VoIP/PTSN).
• Call queues.
• Automated call distribution.
• Automatic dialing.

ASTERISK FOLDERS

The Asterisk folders are given in Table 6.

TABLE 6 ASTERISK FOLDERS

recording files
/var/spool/asterisk/outgoing| Folder monitored by Asterisk to execute call files
/var/spool/asterisk/system| Used by the System application
/var/spool/asterisk/voicemail| Contains voice mailbox folders
/var/log/asterisk| Asterisk log fils
/var/log/asterisk/cdr-csv| CDR call tickets
/var/log/asterisk/cdr-custom| Custom call logs

ASTERISK COMMANDS

Asterisk commands are given in Table 7.

TABLE 7 ASTERISK COMMANDS

asterisk -vvvvvvvvvvrc

| Use this command to connect to the Asterisk console

core show calls

| Check if there are any active calls within the Asterisk console

sip show peers

| Use this command to determine which extensions are registered in Asterisk

core show channels

| Lists the occupied channels

channel request hangup <channel Name>

| Makes a request to terminate the communication on an occupied channel

sip set debug on sip set debug off

| View all SIP packets that been received and sent

sip reload dialplan reload

| Changes settings

manager show connected

| Check if Compass is connected to the Asterisk Manager

sip unregister <exten>

| Forces the unregister of an extension

module show like <backspace>

| Shows the modules being used by Asterisk

confbridge list

| Lists active conferences

confbridge list <conference name>

| Lists all the people on a conference call

COMPASSVOIP AND CONFIGURATION FILES

To use CompassVoIP you need the following files:

[SIP.CONF]

In this file, all SIP server properties are configured. The port and user domain, and the codecs the user can use are also configured.

The [sip.conf] file is divided into the following two parts:

• The first part contains all general characteristics of the system, and the extensions the system can use.
• The second part defines the system extensions.

In some trunks it is necessary to configure a register string to force the registration of the trunk in PBX. The format of this register string is register =>

fromuser@fromdomain:secret@host.

The sip.conf file can become corrupted when two Compass servers are registered in the same CompassVoIP. You must make sure that you have one Compass server linked to a Compass VoIP.

[EXTENSIONS.CONF]

In the extensions.conf file, all the parts of the AgoraVoIP dial plan are configured. This file is made up of different contexts, calls for each extension will be received in the context for which they were configured in the sip.conf file (context=default) in this case for example the calls will be received in the default context.

[USERS.CONF]

This file is used to configure trunks.

Some trunks are stored in the sip.conf file. In some cases, this is done because some equipment is required to configure the registerString.

To configure a trunk between CompassVoIP and the client’s PBX, in the trunk section, change the current IP to the client’s PBX IP (host= ):

[MANAGER.CONF]

This file contains all manager configurations, and allows the configuration of registry ports and user permissions.

[CONFBRIDGE.CONF]

This file defines the type of users that exist in the conference, power, and limited. From this file it is possible to limit the number of people in a conference, and the messages displayed when a conference ends.

COMPASSVOIP TROUBLESHOOTING

When you use Compass VoIP it can be necessary to carry out troubleshooting.

ADD NEW EXTENSIONS IN COMPASSVOIP

To add new extensions, do as follows:

1. Open an SSH connection to the CompassVoIP machine.

2. Execute the following command and enter your password when prompted:observit@ubuntu:~$ sudo -sH

3. Change the directory to /etc/asterisk.

4. Edit the file sip.conf.

5. Search for an extension configuration block and copy it.

6. Change the extension to an extension not yet configured.

7. Save the changes, and open the file extensions.conf.

8. Save the changes, and enter the following command to access the Asterisk console as a root user:

   root@ubuntu:/etc/asterisk# asterisk -crvvvvvvvvvvvvvvvvvv

9. In the Asterisk console, reload the configurations using the following command:

   ubuntu*CLI> reload

Make a note of the username and password to configure on the SIP device.

THE CONNECTION STATUS BETWEEN THE COMPASS SERVER AND COMPASSVOIP IS

DISPLAYED IN RED

If the connection status between the Compass server and CompassVoIP is displayed in red, the Compass server is not registered in CompassVoIP, or the registration failed to renew. Compass stops recording calls. If this is the case, do as follows:

1. In the system properties, check if the IP username and password are correct.

2. Check if you can make a telnet connection to CompassVoIP IP and to 5038 port using the following command:

   telnet 5038 <compassVoIP IP> 5038

3. As a last resort, restart the backend.

CHANGE THE GREETING MESSAGE

When you make a call to the alarm extension, a greeting is played to indicate that your call will soon be answered by an operator. To change the greeting you must convert the greeting message file to the format supported by Asterisk.

To change the greeting message file, do as follows:

1. Convert your file to the format used by Asterisk on https://www.sangoma.com/audioconverter.

2. Copy the converted file to the Compass VoIP directory

   /var/lib/asterisk/sounds/en/

3. Change the dialplan to play a new greeting message:

   •     Edit the /etc/asterisk/extensions.conf file.

   • Change the line exten

          => 1099,n,Playback(hello-world) to exten => 1099,n,Playback(<your_file_name)
     
          **** ; Hangup call

     [default] ; alarm extension exten => 1099,1,No0p(${CALLERID(all)}) exten => 1099,n,Answer() exten => 1099,n,Ringing exten => 1099,n,Progress() exten => 1099,n,Ringing exten => 1099,n,wait (3) exten => 1099,n,Playback (hello-world)

4. Save the file and exit.

5. Restart Asterisk using the following commands:

   • In CompassVoIP run the following command:

         service asterisk restart

   • To access the asterisk command line run the following command:

         asterisk -vvvvvr

   • In the Asterisk command line run the following command:

         dialplan reload

     core reload

CISCO CALLMANAGER CONFIGURATION

To configure the trunk between Cisco CallManager and CompassVoIP, it is important to note the following:

• The CallerID may or may not be sent. This configuration is made on CallManager.
• When receiving calls from CallManager, it comes as CallerID@IPdoCallManager. Two contexts must be created on users.conf
• The registered extensions on CallManager can not be registered on CompassVoIP.
• The CallManager only allows G711 and G729 codecs, so on the CallManager itself you must allow all the codecs.
• All the configurations of extensions.conf and sip.conf are the same as the other trunks.

The correct configuration is similar to the following:

Notice:  You can only change the IP of CallManager for the configuration to work properly.

 **** Asterisk-Agora]
type = peer
username = Asterisk-Agora
fromuser - Asterisk-Agora
: secret =agoracip 4321
canreinvite = no
host =10.64.204.246
allow = !all, alaw, ulaw, gsm
qualify =yes
context = default
dtmfmode= info


[10.64.204.247]
type = peer
username - Asterisk-Agora2
fromuser = Asterisk-Agora2
; secret =agoracip 4321
canreinvite = no
host =10.64.204.247
allow = !all, alaw, ulaw, gsm
qualify Eyes
context = default
dtmfmode= info


[10.64.204.246]
type - peer
username = Asterisk-Agora2
fromuser = Asterisk-Agora2
;secret =agoracip4321
canreinvite = no
host =10.64.204.246
allow = !all, alaw, ulaw, gsm
qualify =yes
context = default
atmfmode= info  

LINUX COMMANDS

Linux commands are given in Table 8.

TABLE 8 LINUX COMMANDS

top

| List the status of CPU processes and memory usage

ifconfig

| List machine IP

cat /etc/network/interfaces

| Show interfaces file

df -h

| Show disk usage

ps -ax I   grep <process_name>

| List all processes with the specified name

Kill -9 <process- id>

| Kill processes with the specified ID

Is <folder> I   grep <filename>

| List files with the specified name from a directory

tcpdump -w <filename>.pcap

| Capture all packets

locate <filename>

| Findfile on system

pwd

| Show the directory where the file is located

FREQUENTLY ASKED QUESTIONS

Examples of Motorola Solutions Compass Decision Management System™ frequently asked questions are given in Table 9.

TABLE 9 COMPASS FREQUENTLY ASKED QUESTIONS

restart the Asterisk service.
There is no audio|

• Use Wireshark to observe RTP traffic on both sides.
• Use the codecs supported by CompassVoIP to validate both extensions.

Compass has stopped recording| Restart the backend.
How to change the DTMF mode?| Configuration must be done in the users.conf trunk file, and in the sip.conf file for each peer that uses DTMF. An example of DTMF configuration is given below.|

dtmfmode=auto
dtmfmode=rfc2833
dtmfmode=inband
dtmfmode=info  

How to use extensions with CompassVoIP and make calls?| Default settings do not support this functionality.
My problem isn’t listed| If what you want to do is not available, contact your Compass reseller.

References

• Audio Converter - Sangoma Technologies
• Audio Converter - Sangoma Technologies

Read User Manual Online (PDF format)

Download This Manual (PDF format)

Download this manual  >>