Compass Install & Maintenance Guide
Compass Install & Maintenance Guide
COMPASS DECISION
MANAGEMENT
SYSTEM™
VERSION 2.2.2.X
INSTALL AND
MAINTENANCE GUIDE
MOTOROLA SOLUTIONS COMPASS DECISION MANAGEMENT SYSTEM™
2 OVERVIEW 6
Installation components 6
Integrations 7
5 UPGRADES 14
Upgrading Motorola Solutions Compass Decision Management System™ 14
9 FIREWALL REQUIREMENTS 29
10 CONFIGURE ANTI-VIRUS 30
Prevent data write issues 30
Prevent network communication failure 30
11 MANAGING CERTIFICATES 31
Replace a self-signed certificate with a trusted certificate 31
12 UNINSTALL COMPASS 32
13 TROUBLESHOOTING 33
Database update 33
Reset database 33
Other tools 34
This guide is written for users of the Motorola Solutions Compass Decision Management System™
software version 2.2.2.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.
Indicates a hazardous situation which, if not avoided, may seriously impair operations.
Motorola Solutions Compass Decision Management System™ is a web application that manages security
systems from different vendors in a single platform, with step-by-step procedures and auditing tools.
Compass can be installed in the following ways:
• On a single server.
• On a primary server and fail-over server.
► For more information, refer to the Motorola Solutions Compass Decision Management System™
User Guide.
INSTALLATION COMPONENTS
Compass installations include several components.
COMPASS Server
Used for configuring sites and devices, handling alarms, viewing live and recorded videos, and getting
reports and charts. COMPASS server runs on the Apache® Tomcat 7 web server.
Compass Manager
Used for checking if all Compass components and drivers are working properly. For drivers, Compass
Manager works like a load balancer - when a new task appears, Compass Manager checks the load of
each driver, and assigns the task to the driver with the lower load.
CompassLicenseServer
The HTTP service wrapper for the licensing tool.
Compass ServicesAdapter
The gateway, encryption and authentication tool used between drivers and Compass Backend. Compass
ServicesAdapter allows incompatible API versions to communicate with each other.
Compass VideoAdapter
Used for transferring HTML5 videos from drivers to COMPASS server.
ElasticSearch
Full text storage and search engine for alarms and events data. Used to generate reports' charts with
Kibana.
Kibana
Data visualization tool used to generate reports' charts with the data from ElasticSearch.
Compass Database (Compass DB)
The database where all Compass information is stored. Compass uses MariaDB as its default database
server.
INTEGRATIONS
Compass communicates with several equipment types, for example, cameras, intrusion/fire panels, and
other sensors from several manufacturers.
To communicate with each manufacturer Compass requires the installation of a specific integration driver.
To install each integration driver, refer to the specific Integration Guide for your device(s).
The integration driver can be installed in the COMPASS server. Server drivers from different
manufacturers can run in the same COMPASS server. The installation of integration drivers in
remote servers is also supported.
When an integration driver is installed, Compass automatically runs two instances of each driver. In
some cases it can be recommended to run more than two instances. Refer to the specific
Integration Guide for your driver(s).
For certain drivers, a configuration where the driver runs in a remote server only, and not in the
COMPASS server is not recommended. Refer to the specific Integration Guide for your driver(s).
This section provides information on the installation of Motorola Solutions Compass Decision Management
System™ on a single server.
For the installation of each integration driver, refer to the corresponding Integration Guide.
REQUIREMENT ✓
A static Mac address is only required if the Windows Server runs on a Virtual machine (VM).
It is recommended that you setup a Windows shared folder on a backup server to allow Compass to
backup database information automatically.
Make sure there are no previous installations of Windows Roles or MySQL/MariaDB databases.
INSTALL COMPASS
The installation process for Compass is different for the single server and for the remote server.
SINGLE SERVER
To install Compass on a single server:
1. Unzip the provided Compass software installer package.
2. Run COMPASS_v2.1.[X].[X]_Setup.exe as administrator.
3. On the COMPASS Database and Plugin Setup page, enter the data given in Table 2.
4. Select Next.
5. On the COMPASS Server Setup page, enter the data given in Table 3.
6. Select Next.
7. On the COMPASS Backup Setup page:
a. Select the backup folder for the Compass automatic backup function.
b. Select the backup frequency for the Compass automatic backup function.
We recommend a daily backup.
Compass needs to backup to a folder outside of the server. The recommended configuration is one
of the following:
• A shared network folder with no access credentials.
• A pen drive in the Compass physical server so Compass can backup automatically.
8. Select Next.
9. Accept the License Agreement.
10. Select Next.
11. On the Select Destination Location page, specify the installation location for COMPASS.
12. Select Next.
13. On the Select Components page, select COMPASS Base.
14. Select Next.
15. On the Ready to Install page, select Install to start the Compass installation.
16. Select OK to confirm the installation of a self-signed certificate. See "Managing certificates"
on page 31.
17. On the Welcome to the Sentinel Runtime Installation Wizard page, select Next to install
Gemalto License Manager.
18. Accept the License Agreement.
19. Select Next.
20. On the Ready to Install the Application page, select Next to start the installation.
21. Select Finish.
The Sentinel Run-time Environment Installation dialog opens.
22. Select OK.
23. On the Completing the COMPASS Setup WIzard page, select Finish to exit setup.
After installation, it is recommended that you replace the automatically installed self- signed
certificate with your own certificate.
After installation, open the latest version of Google Chrome or Firefox and enter the following URL:
https://<compassserverIP>.
PARAMETERS DESCRIPTION
PARAMETERS DESCRIPTION
AFTER INSTALLATION
After installation, make sure you have completed the requirements given in Table 4.
REQUIREMENT ✓
Activated a license to use the application features. See "License Manager installation" on page 12. ઙ
Added a trusted CA-signed certificate to the COMPASS server. See "Managing certificates" on page 31. c
Configured the software. See the Configuration Guide. c
For information on installing drivers for your devices, refer to the specific Integration Guide for your
device(s).
After installation, if you cannot access the Compass login page, do one or more of the following, as
necessary:
• Confirm that all Compass services are running. If one of the services if not running, try to
restart.
• Make sure that you are using the correct URL.
• Make sure that the ports used by the COMPASS server are not being used by other
applications. See "Firewall requirements" on page 29.
• Confirm with your Network Administrator that the workstation you are using to access the
COMPASS server can route IP traffic to COMPASS server ports. See "Firewall requirements"
on page 29.
If some services do not run after installation, you may need to set up exceptions in the anti-virus software
running on COMPASS servers. For more information, refer to your anti-virus software manual.
OTHER SOFTWARE
The following softwares are recommended to use with Compass:
• Notepad++: Download Notepad++.
• 7zip: Download 7zip.
You must install Motorola Solutions License Manager with an up-to-date license on the server.
Compass will request that you change your password when you first login.
USERNAME PASSWORD
Administrator admin
Compass will request that you change your password when you first login.
When the trial license expires, contact your reseller to get a permanent license.
USERNAME PASSWORD
Administrator admin
Before the upgrade starts, the Motorola Solutions Compass Decision Management System™ installer
makes a backup of all the current version application files to the bck folder.
The new application files are then extracted to a folder with _newversion as a suffix. This keeps the
Compass instance running until it is necessary to stop all services and replace old files with new files.
The process stops Compass services for a minimum time at the cost of requiring more disk space.
To successfully upgrade the system, you must upgrade Motorola Solutions Compass Decision
Management System™ then update the database.
The anti-virus may check all files which can slow the copy process.
The transfer of files and folders to a backup folder can take up to 40 minutes, depending on the
computer configuration.
The integration driver must be installed on a remote server, or multiple remote servers, when
recommended in the driver Integration Guide. Motorola Solutions Compass Decision Management
System™ components must be installed in each remote server to support the manufacturer driver.
A single server must be installed before you can install drivers on a remote server. See "Single
server" on page 9.
Before you begin, follow the pre-installation checklist. See "Before you begin" on page 8.
For information on installing drivers for your devices, refer to the specific Integration Guide for your
device(s).
PARAMETERS DESCRIPTION
Driver Port The first port number of the driver port range.
PARAMETERS DESCRIPTION
1
If you are updating from Agora/Agora-Indigo to Compass, your domain will remain agora.local, and
the computer names will remain Agora-Primary and Agora-Secondary.
Replace these within the commands given in this section.
This section provides information about the active-passive failover architecture. The role of the failover
architecture is to activate the secondary Motorola Solutions Compass Decision Management System™
instance when the functionality of the primary Compass instance is compromised.
The active-passive failover architecture consists of the following elements:
• Two identical servers with Compass installed:
• The primary Compass instance.
This is the active in-production instance.
• The secondary Compass instance.
This is the back-up instance, ready to be manually put in production at any time.
• A database and file system synchronization mechanisms.
Used to activate the secondary Compass instance in a state as close as possible to the state
of the primary Compass instance.
• The database synchronization mechanism.
Based on the primary/replica replication functionality provided by MariaDB. The
changes that Compass makes to the database are logged by the server, and
asynchronously replicated to the replica.
• The synchronization of the media and report PDF files stored in the file system Data path.
Based on Microsoft's Distributed File System (DFS) replication functionality. See "DFS
replication" on page 23.
SYSTEM SETUP
This section provides information about the setup of the Compass primary instance and the Compass
secondary instance.
PRE-CONFIGURATION
Pre-configuration of the Compass primary instance and the Compass secondary instance consists of
assigning a static hostname to each instance.
To set the hostnames of the Compass instances:
1. Open the Run command window.
2. In the Run command window, run the following commands:
a. dism /online /enable-feature /featurename:OEM-Appliance-
OOBE
b. C:\Windows\System32\Sysprep\Sysprep.exe /generalize /oobe
/reboot
The system reboots and reloads with the new configuration. The Initial Configuration Tasks
window is displayed.
3. From the Provide Computer Information category, select Provide computer name and
domain.
The System Properties window opens.
4. Select the Computer Name tab.
5. Select the Change button.
The Computer Name/Domain Changes window opens.
3. In Server Manager, install Active Directory Domain Services and create a domain:
a. Select the notification icon.
b. In the Post-deployment Configuration message, select Promote this server to a domain
controller.
The Active Directory Domain Services Configuration Wizard window opens.
c. On the Deployment Configuration page, under Select the deployment operation, select
Add a new forest.
d. In the Root domain name field, enter compass.local, and select Next.
e. On the Domain Controller Options page, from the Forest functional level list, select
Windows Server 2016.
f. Under Specify domain controller capabilities, make sure the Domain Name System
(DNS) server checkbox is selected.
g. In the Password field, enter a new password for the Directory Services Restore Mode
(DSRM) administrator.
This password will be used to repair or restore an Active Directory database, if needed.
h. Select Next.
i. On the DNS Options page, select Next.
j. After the wizard verifies the NetBIOS domain name, select Next.
k. On the Paths page, select Next.
The default values for Database folder, Log files folder, and SYSVOL folder are used.
l. On the Review Options page, review the summary of your selections, and select Next.
m. On the Prerequisites Check page, when the validation of prerequisites is complete,
select Install.
n. When the installation is complete, select Close.
The server restarts.
4. To reconnect to your server, you need to log in:
a. Select Switch User, and then select Other User.
b. In the user name field, enter compass.local\Administrator.
c. Enter the password that you created.
d. Select the Login button.
d. On the Server Selection page, from the server list select the COMPASS server, and
select Next.
e. On the Server Roles page, select Active Directory Domain Services.
f. If the Add features that are required for Active Directory Domain Services window
opens, select the Include management tools (if applicable) checkbox, and select Add
Features.
g. On the Features page, select the .NET Framework 3.5 Features checkbox.
h. Make sure that under .NET Framework 3.5 Features, HTTP Activation and Non-HTTP
Activation are not selected.
i. Select Next.
j. On the AD DS page, select Next.
k. On the Confirmation page, select Install.
l. If prompted, install any requested additional components.
m. On the Results page, you can view the installation progress.
When the installation is complete and the role is successfully added, select Close.
3. In Server Manager, install Active Directory Domain Services, and set this instance as a
domain controller of compass.local:
a. Select the notification icon.
b. In the Post-deployment Configuration message, select Promote this server to a domain
controller.
The Active Directory Domain Services Configuration Wizard window opens.
c. On the Deployment Configuration page, under Select the deployment operation, select
Add a domain controller to an existing domain.
d. In the Domain field, enter compass.local.
e. Next to Supply the credentials to perform this operation, select the Change button.
f. In the user field, enter Administrator.
g. In the password field, enter the previously created domain administrator password.
h. Select Next.
i. On the Domain Controller Options page, under Specify domain controller capabilities,
make sure the Domain Name System (DNS) server and Global Catalog (GC) checkboxes
are selected.
j. In the Password field, enter a password.
This can be the same password you created for the primary instance.
k. Select Next.
l. On the DNS Options page, select Next.
m. After the wizard verifies the NetBIOS domain name, select Next.
n. On the Paths page, select Next.
The default values for Database folder, Log files folder, and SYSVOL folder are used.
o. On the Review Options page, review the summary of your selections, and select Next.
p. On the Prerequisites Check page, when the validation of prerequisites is complete,
select Install.
q. When the installation is complete, select Close.
r. Restart the server.
4. To reconnect to your server, you need to log in:
Additional settings
The DNS server service can be memory-consuming. To prevent such issues, do as follows:
1. In the Network Connections control panel, set the DNS server to the IP of the Compass
primary instance as follows:
a. Right-click the target adapter and select Properties.
b. In the Networking tab of the network properties window, clear the Internet Protocol
Version 6 (TCP/IPv6) checkbox.
c. Save your changes.
2. In the command-line interface, run the following commands:
Dnscmd /Config /SocketPoolSize 10
Dnscmd /Config /EnableEDnsProbes 0
3. Restart the DNS Server service.
The installation procedure is the same for the Compass primary instance and the Compass
secondary instance.
Each Compass instance requires its own license, created specifically for its server hardware.
System Properties are not covered by the database replication mechanism. For this reason, if you
need to change the Compass System Properties configuration, you need to do this on both
Compass instances, and in each System Properties section respectively.
DATABASE REPLICATION
To set up database replication, do as follows:
1. On the Compass secondary instance, open the command-line interface.
2. Run the following command:
net stop COMPASSManager
3. Run the following command:
DFS REPLICATION
The DFS replication management role is assumed by the Compass secondary instance. You also need to
install this role for the Compass primary instance, so that the primary instance performs DFS replication in
case of the secondary instance failover.
To create a new DFS replication group and configure the data folders on both Compass instances, do as
follows:
1. In Server Manager, select Tools > DFS Management.
2. On the DFS Management page, right-click Replication and select New Replication Group.
3. On the Replication Group Type page, select Multipurpose replication group, and click Next.
4. On the Name and Domain page, in the Name of the replication group field, enter Compass
Replication as the replication group name.
1. On PC with the Compass instance, go to Desktop, or any other folder where you want to
create the shortcut.
2. Right-click in the folder and from the context menu, select New > Shortcut.
The Create shortcut window opens.
3. In the Type the location of the item field, enter the string below:
"C:\Program Files (x86)\COMPASS\runtime\x86\jre\bin\java.exe"
-classpath classes;lib/* -Djava.library.path=lib
pt.observit.failover/FailoverTool activate
4. Click Next.
5. In the Type a name for this shortcut field, enter Activate Compass, and select Finish.
The shortcut icon is created.
6. Right-click the shortcut icon and from the context menu, select Properties.
The Properties window opens.
7. In the Start in field, enter the path below.
C:\Program Files (x86)\COMPASS\bin
8. Select OK.
The FailoverTool activate command used in step 3 stops the failover database
synchronization mechanism.
► For more information on activating the Compass secondary instance, see "Activate the Compass
secondary instance" on page 25.
To activate the database replica role on the Compass primary instance:
1. On the Compass secondary instance, create a database dump:
a. Open the command-line interface.
b. Run the command provided below.
Replace target_db_dump_path with an actual file path, for example,
C:\Users\Compass\Desktop\filename.
cd %COMPASS_PATH%\bin && ..\runtime\x86\jre\bin\java.exe -
classpath classes;lib/* -Djava.library.path=lib
pt.observit.failover/FailoverTool dump_primary 'target_db_
dump_path
2. Move the created database dump file to a location on the Compass primary instance.
3. Activate the database replica role:
a. On the Compass primary instance, open the command-line interface.
b. Run the command provided below.
Replace db_dump_path with an actual file path, for example,
C:\Users\Compass\Desktop\dumpfilename.
cd %COMPASS_PATH%\bin && ..\runtime\x86\jre\bin\java.exe -
classpath classes;lib/* -Djava.library.path=lib
pt.observit.failover/FailoverTool secondary_setup Compass-
Primary 'db_dump_path'
4. When the procedure is finished, run the following command to confirm that the
synchronization mechanism works correctly:
cd %COMPASS_PATH%\bin && ..\runtime\x86\jre\bin\java.exe -
classpath classes;lib/* -Djava.library.path=lib
pt.observit.failover/FailoverTool secondary_status
To enable the Compass Replication DFS replication group:
1. From the menu Start, select Administrative Tools > DFS Management.
2. On the DFS Management page, select Replication > Compass Replication.
3. In the Memberships tab, right-click the Replicated Folder row and from the context menu,
select Enable.
4. In the confirmation window, select Yes.
5. Repeat step 3 and step 4 for the second Replicated Folder row.
6. To check the DFS replication status:
a. Open the command-line interface.
b. Run the command below.
dfsrdiag ReplicationState /all
► For more information on activating the database replica role on the Compass primary instance,
see "The Compass primary instance in the replica role" on page 25.
To activate the Compass primary instance:
1. On the Compass primary instance, open the folder with the Compass shortcut.
2. Run the shortcut.
The Compass primary instance is now active and put into production.
To revert the Compass secondary instance to the database replica role:
1. On the Compass primary instance, create a database dump:
a. Open the command-line interface.
b. Run the command below.
Replace target_db_dump_path with an actual file path, for example,
C:\Users\Compass\Desktop\filename.
cd %COMPASS_PATH%\bin && ..\runtime\x86\jre\bin\java.exe -
classpath classes;lib/* -Djava.library.path=lib
pt.observit.failover/FailoverTool dump_primary 'target_db_
dump_path
This process will override the Compass database on the primary instance. Make sure this database
is up to date.
2. Move the created database dump file to a location on the Compass secondary instance.
3. Activate the database replica role:
a. On the Compass secondary instance, open the command-line interface.
b. Run the command below.
Replace db_dump_path with an actual file path, for example,
C:\Users\Compass\Desktop\dumpfilename.
cd %COMPASS_PATH%\bin && ..\runtime\x86\jre\bin\java.exe -
classpath classes;lib/* -Djava.library.path=lib
pt.observit.failover/FailoverTool secondary_setup Compass-
Second 'db_dump_path'
4. When the procedure is finished, run the following command to confirm that the
synchronization mechanism works correctly:
cd %COMPASS_PATH%\bin && ..\runtime\x86\jre\bin\java.exe -
classpath classes;lib/* -Djava.library.path=lib
pt.observit.failover/FailoverTool secondary_status
.NET is a developer platform including tools, programming languages, and libraries used for building
applications running under Windows. .NET Framework is responsible for running websites and other
services/applications under Windows.
To find out more about .NET Framework, click here.
Make sure HTTP Activation and Non-HTTP Activation under .NET Framework 3.5 Features are not
selected.
When setting up a network of Motorola Solutions Compass Decision Management System™ equipment
that includes firewalls, the following information should be used to configure the firewalls.
Some ports must be reserved for the COMPASS server and its components. The default port configuration
is given in Table 9.
5601 Kibana No
9200 Elasticsearch No
* A minimum of two ports will be reserved by the driver, depending on the number of devices connected to it.
For example, using the default configuration, if drivers are installed for three different manufacturers, the ports
used will be: 9100, 9102, 9104, 9106, 9108, and 9110.
When anti- virus software runs an automated scan on a heavily used Motorola Solutions Compass
Decision Management System™ server, it can prevent video data from being written.
Some anti-virus software packages are equipped with live process scanning and incorporated firewalls.
These features can cause communication failures between cameras and Network video recorders (NVRs),
or between NVRs and clients.
To prevent this, you may need to set up exceptions in the anti-virus software running on COMPASS
servers. For more information on how to exclude locations and applications from scanning, see your anti-
virus software manual.
By default, the Motorola Solutions Compass Decision Management System™ server uses a self-signed
certificate to secure client communications. This self- signed certificate is included in the Compass
installation, and the keystore is generated automatically during installation.
The keystore certificate includes the following information:
• Subject alternate names (SAN) property.
• The IP and hostnames of all network interfaces available on the COMPASS server.
Motorola Solutions recommends that you use a trusted CA-signed certificate or other intermediate
certificate, for example, a Windows CA or custom CA certificate.
You must be a Windows Administrator to make these changes.
By default, the self-signed certificate used by Compass is flagged by browsers as not secure.
REQUIREMENT ✓
If there are drivers installed, you will need to uninstall them first.
When you use Motorola Solutions Compass Decision Management System™, it can be necessary to carry
out troubleshooting.
DATABASE UPDATE
To update the database, do as follows:
1. Open https://127.0.0.1 in your browser.
2. If a database update is required, the Login page is displayed.
3. Select Log in.
4. On the Sign in page, enter the default credentials given in Table 11.
5. Select Sign in.
6. On the System Manager page, select Update DB.
7. After completion of the update the Database successfully updated message is shown.
8. Select Shutdown server.
After shutdown the operating system will restart. This action will validate the database with
the update.
USERNAME PASSWORD
Administrator admin
RESET DATABASE
To reset the Compass database, do as follows:
1. Drop the COMPASS database.
2. Create the COMPASS database again on the MariaDB server..
3. From your browser, open https://127.0.0.1/manager.
4. Enter the default credentials given in Table 12 and select Sign In.
5. On the System Manager page, select Create DB.
You must wait until the database updates successfully.
6. Select Shutdown server, and wait for several minutes.
7. From your browser, open http://127.0.0.1.
8. Login with the default credentials given in Table 12.
Compass will request that you change your password.
USERNAME PASSWORD
Administrator admin
OTHER TOOLS
uses several tools to integrate with Compass.
Processexp
Proccessexp is available in the Compass tools folder. The primary function is to list all system processes.
Baretail
The primary function of Baretail is to show driver logs. To determine the driver, do as follows:
1. From Compass, select Configuration.
2. Select System Status.
3. Select Agents.
4. Expand the agents to find which driver is used by your device.
Examples of Motorola Solutions Compass Decision Management System™ frequently asked questions are
given in Table 13.
ISSUE SOLUTION
I already have an
No. Motorola Solutions uses a slightly modified version of ElasticSearch/Kibana to
ElasticSearch/Kibana
ensure reliability and performance.
installation. Can I use it?
If you had a backup database before upgrading, recover it and update the
I got an error message with
database again. See "Database update" on page 33.
Database Update after
If you do not have a backup database or you continue to receive the same error
upgrading Compass
message, contact Customer Support.
Some services do not run You may need to set up exceptions in your anti-virus software. For more
after installation information, see your anti-virus software manual.
How do I live stream video? Use VLC and Onvif Device Manager to open a live stream.
You can log in to Compass using your credentials. Go to Configuration > System
Status to view a list of logs and their status. from here, you can restart some
Where are the log files? components and download log files.
Alternatively, from Windows Explorer, access the %COMPASS_PATH% directory
and open the logs folder. You will see several log files from Compass.
ISSUE SOLUTION
My problem isn't listed If what you want to do is not available, contact your Compass reseller.