LT Compass Iug
LT Compass Iug
LT Compass Iug
4
Installation and
Upgrade Guide
Compass 1.6.4 Installation & Upgrade Guide
31-00314-01
1 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
CONTENTS
About Compass 1.6.4.................................................................................................................................... 5
About this guide ............................................................................................................................................ 5
What’s new in Compass 1.6.4 ...................................................................................................................... 5
Installation specifications .............................................................................................................................. 6
Compass installation overview ...................................................................................................................... 7
Primary Compass Workstation (server) .................................................................................................... 7
Compass as a service ............................................................................................................................... 7
Secondary Compass Workstation (client) ................................................................................................. 7
Compass upgrade process ........................................................................................................................... 8
Compass new installation process ................................................................................................................ 9
Compass Config Tool installation process .................................................................................................. 10
Installation overview .................................................................................................................................... 10
Pre-installation ............................................................................................................................................ 11
Data gathering ......................................................................................................................................... 11
Uninstall Compass .................................................................................................................................. 14
Manual housekeeping ............................................................................................................................. 17
Install Compass ........................................................................................................................................... 18
Install Compass from an ISO image ....................................................................................................... 18
Upgrading the Primary Compass Workstation (server) .......................................................................... 23
Compass workstation configuration .................................................................................................... 28
Set the LocalAdministrator password ................................................................................................. 29
Primary Compass Workstation (server) .................................................................................................. 29
Installation prerequisites ..................................................................................................................... 30
Install Niagara license for a new job ................................................................................................... 31
Install SQL Express............................................................................................................................. 32
Set or create Rep/Job ......................................................................................................................... 35
Obtaining an SSL certificate from a Certificate Authority (CA) ........................................................... 38
Create a self-signed certificate............................................................................................................ 39
Import certificate into stores ................................................................................................................ 43
Configure BACnet settings .................................................................................................................. 47
Network configuration ......................................................................................................................... 48
Configure SQL .................................................................................................................................... 55
Configure LDAP settings (if used) ....................................................................................................... 58
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 2
Compass 1.6.4 Installation & Upgrade Guide
31-00314-01
3 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 4
Compass 1.6.4 Installation & Upgrade Guide
31-00314-01
5 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
INSTALLATION SPECIFICATIONS
IMPORTANT! These are Compass specifications only. Your system may require more CPU
cores or memory.
NOTE: If the SQL Server and Compass are on the same machine, the memory must be
increased by 4GB – 16GB (depending on the version) or you may require additional storage.
Table 1. Compass Specifications
Chrome
COMPASS -1-SM up to 50 Quad-core 8GB
NOTE: Compass is designed,
developed, and tested to function best
COMPASS-1-XS*** up to 25 using the Chrome browser. Other Quad-core 8GB
browsers may be compatible; however,
Alerton strongly recommends Chrome.
COMPASS-1-XXS*** up to 10 Quad-core 8GB
Visio 2016 Standard or Pro (32 bit) Visio
2019 Standard or Pro (32 bit)
* The number of supported devices in the Enterprise model can be extended in 1000 device increments by applying
one or more device packs (COMPASS-1-ENTDP).
** CPU Cores and Memory recommendations are minimums – increasing the number of cores and amount of
memory improves performance and provides for a better user experience.
*** All Compass licenses support SQL Enterprise database configuration; except for COMPASS-1-XS and
COMPASS- 1-XXS.
Operating Systems: Alerton strongly recommends using the most up-to-date Windows OS; be it Windows 10 or
Windows Server 2019 for the Compass Primary Workstation (server). For Secondary Workstations (client) Alerton
recommends Windows 10.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 6
Compass 1.6.4 Installation & Upgrade Guide
COMPASS AS A SERVICE
In some environments, the Primary Compass Workstation, may be required to run in a secured
environment and to launch itself automatically upon the start/restart of the computer/VM. Using
a “service manager” Compass can be configured to meet this requirement. Specific
prerequisites must be met however in the configuration of this mode of operation. Those
prerequisites and the configuration steps are outlined in Appendix E – Configuring Compass to
run as a service
31-00314-01
7 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
Gather
Uninstall
Information / Manual
Compass or
Settings / Data Housekeeping
Envision
Points
Install on
Install
existing
Compass
Workstation?
No
Restore Rep/
Primary
Job from Yes
Compass Server?
Backup (Full)
Yes
No
Restore Rep/
Job Client
Components
from Backup
Start Compass
Config Tool
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 8
Compass 1.6.4 Installation & Upgrade Guide
Pre-Installation
Gather
Information /
Settings / Data
Points
Install Compass
Install
Compass
Start Compass
Config Tool
31-00314-01
9 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
No No
Install License(s)
Create Self-signed
Select or Create Using SSL or Certificate or get
Yes
Rep/Job LDAP? Commercial
Certificate
No
INSTALLATION OVERVIEW
1. Pre-Installation
2. Install Compass
3. Compass Workstation Configuration
4. First Launch / Complete / Verify
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 10
Compass 1.6.4 Installation & Upgrade Guide
PRE-INSTALLATION
It’s important to have a complete understanding of what you’re dealing with prior to attempting
to install Compass 1.6.4.
The installation process changes with each release of Compass making it easier to install and
deploy. Carefully follow the installation instructions in this guide and do not skip any steps.
DATA GATHERING
Before starting the Installation process please gather the information mentioned below for New
installation and Upgrade process:
Table 2. Installation Process - New Install
31-00314-01
11 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
Compass and SQL can run on the same machine. If not on the same computer/VM, have the
following information:
• The host name of the SQL Server/VM
• Version of SQL and Edition
• SQL Instance being / to be used
• Port number if not standard TCP/1433
The credentials of an SQL account (like the sa account for SQL Authentication) or a Windows
account that has been granted the ‘sysadmin’ role on the SQL Server.
Check if the install is Typical or Custom:
• If it is a Typical install, then it will be saved on C: drive
• If it is Custom install, then it will be saved on a drive of choice on the system.
LDAP domain - Contact IT department for this information.
NOTE: LDAP is dependent on TLS/SSL.
NOTE: Once Compass is installed, run it the first time as an Administrator to run the
Alerton/Honeywell Driver service, which launches the BACnet/Ethernet driver and makes it
available to Compass.
Table 3. Installation Process - Upgrade
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 12
Compass 1.6.4 Installation & Upgrade Guide
31-00314-01
13 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
UNINSTALL COMPASS
If you are upgrading from a previous version of Compass, uninstall the previous version first.
Press the Windows + I keys on the keyboard to raise the Windows Settings. Click Apps.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 14
Compass 1.6.4 Installation & Upgrade Guide
In the Apps & features pane, locate and click Compass to expand it. Click Uninstall, then click
Uninstall again.
NOTE: In these examples, we are upgrading from Compass 1.6.
NOTE: Uninstalling Compass will also uninstall the Compass Config Tool. The BACnet Ethernet
Protocol (x64) driver will remain.
If you receive a message that some files or services cannot be updated while running, this is
normal. Click OK to continue uninstalling Compass, and then manually reboot the operating
system after the uninstall process has completed.
31-00314-01
15 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
NOTE: If using the Programs and Features applet available through Control Panel, Windows
may not properly refresh the list of installed programs when Compass is uninstalled. Though
uninstalled with Compass, the Compass Config Tool may still indicate (falsely) that it is still
installed. Exiting the Programs and Features applet and reloading it or clicking the refresh
button will refresh the list and resolve the errant entries. This behavior does not exist if using the
Apps and Features app from Settings > Apps > Apps and Features for systems running
Windows 10.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 16
Compass 1.6.4 Installation & Upgrade Guide
MANUAL HOUSEKEEPING
After uninstalling Compass:
• Delete the Drop-Ins folder
• Delete the Config Tool folder
• Delete everything from the SYSTEM folder except Licenses, Security, CertManagement
and Certificates folders.
• If you have custom Lexicon folders or files, back those up too.
• Restart the operating system.
NOTE: It is recommended to save these folders off someplace else for safe keeping.
31-00314-01
17 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
INSTALL COMPASS
INSTALL COMPASS FROM AN ISO IMAGE
Double-click setup.exe to launch the Compass installer.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 18
Compass 1.6.4 Installation & Upgrade Guide
Click Next
If you are installing Compass for the first time, it will install prerequisites before starting the
installation process.
31-00314-01
19 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
Accept the terms in the license agreement, and then click Next.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 20
Compass 1.6.4 Installation & Upgrade Guide
31-00314-01
21 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
If you are installing the software for the first time, a security dialog box may appear to confirm
installation protocol installation. Check the box to “Always trust software from Alerton Inc.” click
Install.
View the new features in compass 1.6.4 and then click Finish to close the InstallShield Wizard.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 22
Compass 1.6.4 Installation & Upgrade Guide
NOTE: It is not necessary to reboot the operating system after installation unless prompted to
do so.
31-00314-01
23 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 24
Compass 1.6.4 Installation & Upgrade Guide
Verify that the Restore to field is properly set to the installation of Compass and its Rep/Job
folders, and then click Restore.
NOTE: If installing a Secondary Compass Workstation (Client), select Client Components from
the Restore pulldown
NOTE: If the backup being restored is from Envision, the Restore to field will likely state
C:\Alerton\BACtalk\3.0\<REP>\<JOB>. If so, it will need to be manually updated to reflect the
correct path to Compass, typically C:\Alerton\Compass\1.0\<REP>\<JOB>
31-00314-01
25 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
If the database server is not installed on the machine/computer, User will have to restore it
manually.
Figure 19. Restore warning if not running from Primary Compass Workstation (Server)
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 26
Compass 1.6.4 Installation & Upgrade Guide
Once the restoration is complete, click OK, and then click Close.
31-00314-01
27 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
Press the Windows key to raise the start menu, locate and expand Alerton, click Compass
Config Tool
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 28
Compass 1.6.4 Installation & Upgrade Guide
NOTE: The password is case-sensitive and must be at minimum of eight and a maximum of 20
characters; any keyboard character is valid.
Because the Config Tool is to be used for all Compass installations (Primary Workstation and
Secondary Workstations) a prompt will appear asking which type of installation you are running
the Config Tool against – a Primary Compass Workstation (server) or Secondary Compass
Workstation (client).
NOTE: If this is not the Primary Compass Workstation (server), please refer to Appendix D –
Setting up Compass as a Secondary Compass Workstation (client).
31-00314-01
29 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
INSTALLATION PREREQUISITES
The first launch of the configuration tool will check to see if prerequisites have been installed.
Subsequent launches of the Config Tool will not trigger this dialog but can be triggered manually
by selecting Tools / Set Workstation Type from the menu. Click OK to install.
NOTE: It is important to wait for the completion of these prerequisites before attempting any
further configuration changes otherwise an error may result. On computers/VMs that are
configured with minimal resources this could be an extended period. Watch the status and wait
for the message stating prerequisites have successfully been installed.
NOTE: IN RARE CASES, IT MAY BE NECESSARY TO REINSTALL PREREQUISITES. E.G.
IF PREREQUISITES ARE ONLY PARTIALLY INSTALLED DUE TO A WINDOWS UPDATE
BEING REQUIRED. IN SUCH CASES PREREQUISITES MAY BE INSTALLED FROM THE
ACTIONS MENU.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 30
Compass 1.6.4 Installation & Upgrade Guide
31-00314-01
31 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 32
Compass 1.6.4 Installation & Upgrade Guide
When prompted for the location to extract the SQL Server files to, retain the default location
SQL Server Express 2014 begins extracting and installing the setup files needed for installation.
31-00314-01
33 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 34
Compass 1.6.4 Installation & Upgrade Guide
31-00314-01
35 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
The Create Rep/Job dialog box will appear. Enter the Rep name and Job name. If the Rep/Job
is to be located at another location, click Change Location to make that change. Click Create
Rep\Job to create the Rep/Job folder structure.
NOTE: Rep and Job names cannot contain the text substrings SRC, HREF, or PRNT.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 36
Compass 1.6.4 Installation & Upgrade Guide
The Compass Config Tool dialog box will appear confirming the successful creation of the
Rep/Job folder.
31-00314-01
37 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
1. Launch IIS Manager and double click on the Server Certificates icon and then click on
Create Certificate Request... in the actions panel
2. Send the certificate request to the chosen Certificate Authority. This may involve
emailing the certificate request file to the authority or, perhaps, pasting the contents into
a web page, depending on the authority chosen.
3. The response from the authority will at a minimum consist of a response file which may
be in one of several formats (.cer, .p7r etc). You need then to click on Complete
Certificate Request... in the actions panel and you will be prompted to select the
response file received from the authority. In addition, you may have to install any
intermediate certificates that the authority has provided.
4. After the certificate has been installed it will appear in the Server Certificates panel in
IIS Manager. You will then need to select this certificate and export it to a .pfx file.
5. Finally, in the configuration tool, select and install the exported .pfx file.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 38
Compass 1.6.4 Installation & Upgrade Guide
31-00314-01
39 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
Common Name This will be the name available in the SSL Certificate drop down list. It
is recommended to keep this name simple, memorable, and without
any special characters to include periods and underscores.
Certificate Password Set a password for the certificate. Reenter the password to validate it.
Click Generate after entering the above details.
Specify a name and location for the certificate that is saved as a .PFX file.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 40
Compass 1.6.4 Installation & Upgrade Guide
31-00314-01
41 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
You will be notified once the generated certificate is saved at the specified location. Click OK to
close the following message.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 42
Compass 1.6.4 Installation & Upgrade Guide
NOTE: If the Enable SSL checkbox is checked the buttons SQL Server Settings, LDAP
Settings and Apply will be disabled until a certificate is installed (either self-signed or a
certificate purchased from a Certificate Authority)
31-00314-01
43 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
Certificate Friendly Name: A simple name for the certificate or use the CN used for the
certificate. Avoid using special characters to include periods and underscores. (Keep the
Certificate Name simple. Don’t keep any space or non-Alpha-Numeric character).
Password: Enter the password that you set while generating a self-signed certificate.
Also Import Into Trusted Root: Checking this option will also import the certificate into
the Trusted store for both Windows and Niagara. This option must be selected for a self-
signed certificate but not for a certificate purchased from a Certificate Authority.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 44
Compass 1.6.4 Installation & Upgrade Guide
Click OK to clear the message that the certificate was successfully imported.
31-00314-01
45 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
Now user can see the Selected Certificate next to Current SSL Certificate in the Main Config
Tool Window
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 46
Compass 1.6.4 Installation & Upgrade Guide
31-00314-01
47 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
NETWORK CONFIGURATION
Select the Network Adapter
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 48
Compass 1.6.4 Installation & Upgrade Guide
Below Compass BACnet Settings, three more settings can be done as shown below:
NOTE: To aid in first time configuration of devices, which come out of the factory with only
BACnet/Ethernet enabled, Compass can now run with BACnet/Ethernet, BACnet/IPv4, and
BACnet/IPv6 all enabled.
31-00314-01
49 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
BACnet/Ethernet Settings
Network number should match the BACnet/Ethernet network number in Global Controller in the
same IP subnet.
BACnet/IPV4 Settings
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 50
Compass 1.6.4 Installation & Upgrade Guide
Network number should match the IPv4 BACnet/IP Virtual Net number in your Global Controller
Network Architecture.
NOTE: Compass has been updated to support a maximum of 256 BDT entries in the BDT
tables up from the current 32. Only the ENTERPRISE license will enable the BDT entries 32 -
255. This includes an update for migrating the existing compass DCF to support the new
maximum size.
31-00314-01
51 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
IPv4 BDT
IPv4 BDT is limited to IP addresses. The Description property can be used where device
instance is # or building.
BACnet/IPv6 Settings
Network number should match the IPv6 BACnet/IPv6 Virtual Net number in your Global
Controller Network Architecture.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 52
Compass 1.6.4 Installation & Upgrade Guide
IPv6 BDT
Like IPV4 but IPv6 addresses and DNS names can be used.
Niagara BACnet settings
Recommended configuration is shown below:
NOTE: When using this configuration, the Network Number must be unique in the BACnet
network (like MS/TP network) since this is an Internal Virtual Network number.
31-00314-01
53 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
NOTE: Depending on the Upgrade scenario the Compass BACnet Ip Addresses may have
changed – Ensure that you have all the Original General System Setup Compass BACnet and
Niagara BACnet settings recorded and available. When using the new default Niagara BACnet
settings, you no longer need to define a second BACnet/IP address for the Compass Server
NIC.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 54
Compass 1.6.4 Installation & Upgrade Guide
CONFIGURE SQL
Click Configure SQL. The SQL Server Configuration window is displayed. Fill in the details
for the SQL Server as per the information gathering steps completed prior to the beginning of
this installation. For a default, Conventional database installation with Compass and SQL on the
same Computer/VM, the defaults will likely be enough. Closely review the data you gathered
though and adjust accordingly.
31-00314-01
55 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
For a new Job you may see the following dialog. Click Yes
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 56
Compass 1.6.4 Installation & Upgrade Guide
31-00314-01
57 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
NOTE: You may need to contact the IT department responsible for the Compass server to
obtain this information.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 58
Compass 1.6.4 Installation & Upgrade Guide
NOTE: To configure websites with the Enable SSL option checked, an SSL Certificate must first
be installed.
NOTE: If you are configured behind a firewall and using port-forwarding, the port to be
forwarded to will be the Compass website port (typically port 80 or 443).
31-00314-01
59 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
Once the websites have been created and deployed, click OK to close the dialog box.
After applying all the changes, you must log off and log in for changes to take effect. Click OK.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 60
Compass 1.6.4 Installation & Upgrade Guide
Verify and Fix Checklist contains several routines that verify certain aspects of the system’s
configuration. Problems are classified as “warning”, which means that normal system operation
may be possible, and “error”, which means normal system operation is not possible. If a check
results in a warning or error, you can use the Fix button to attempt to fix the problem and then
run the verification scan again. If the Fix operation doesn’t resolve the problem, you will need to
perform further troubleshooting.
31-00314-01
61 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
Click on the Verify and Fix Checklist option and the following dialog is displayed.
Click Scan to run the verification tests. If an error occurs, Click on Fix, and the issue will be
scanned and fixed.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 62
Compass 1.6.4 Installation & Upgrade Guide
From the Tools menu click on the Config Tool Logs option to display the dialog below
If the user clicks on View in Folder, a file selection dialog is displayed, and the user can display
the contents of the log file may be displayed to help with trouble shooting
31-00314-01
63 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
This file will contain any error or warning messages output generated by the verify and fix
operations as well as other logging information collected in the Compass Config Tool.
NOTE: User can run Config tool while Compass is already running but changes will take place
only after next Compass restart.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 64
Compass 1.6.4 Installation & Upgrade Guide
FIRST LAUNCH
To Launch Compass for the final configuration steps, from the Compass icon on the desktop,
right-click and choose Run as Administrator.
NOTE: Run as Administrator for the first launch of Compass is necessary to complete some
final administrator-level tasks and finish the installation. Subsequent launches of Compass do
not require Run as Administrator and the shortcut for Compass should not be set to do so.
31-00314-01
65 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
For this first launch, you must log on as the LocalAdministrator user.
Click OK, which will cause the start up to show Initialization failed. You then need to go to the
network card properties and ensure that the Alerton/Honeywell BACnet/Ethernet Driver 3.0 is
installed and enabled. If it is not installed, you can manually install it following the steps below.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 66
Compass 1.6.4 Installation & Upgrade Guide
31-00314-01
67 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
Below BACtalk driver select “This feature, and all sub-features, will be installed on local
hard drive” option.
Click Install and all the settings will be modified for BACtalk driver and user will be able to login
and run Compass as an Administrator.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 68
Compass 1.6.4 Installation & Upgrade Guide
CREATE A USER
When you log in as the Local Administrator and create a new job, the job does not have any
user profiles created for it; you must create them from scratch. Until the Local Administrator
creates user profiles, only the Local Administrator can access the job (in offline mode).
31-00314-01
69 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 70
Compass 1.6.4 Installation & Upgrade Guide
Enter the User ID, Password, re-type the password to confirm it, and then click OK.
A warning message will display stating that privileges have not been set for this user. Click OK
to clear this message as those will be set at the group level.
31-00314-01
71 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
CREATING A GROUP
Click the Groups tab, and then click Add.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 72
Compass 1.6.4 Installation & Upgrade Guide
Enter the Group ID, on the General tab, enter a Description for the group, set the desired
Security level, and Starting display.
31-00314-01
73 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
Click the Group Device Access and Privileges Tab. Click the command button next to the
Authorized devices field.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 74
Compass 1.6.4 Installation & Upgrade Guide
Enter the list of devices or range of devices. To grant access to all devices, click Add full
device range. Click OK.
31-00314-01
75 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
Check all the Privileges to assign to this group. When finished, click OK
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 76
Compass 1.6.4 Installation & Upgrade Guide
31-00314-01
77 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
Highlight the desired user, and then click Select. Add another user to the group or click OK to
finish adding users.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 78
Compass 1.6.4 Installation & Upgrade Guide
IMPORTANT! Compass uses passwords to authenticate station and platform users, encrypt
stored data, and protect data in transmission. It is particularly important to handle passwords
correctly. If an attacker acquires a user’s password, then they can access the system with the
same permissions as the hacked user. In the worst case, an attacker might gain access to a
super user account or platform account and compromise the entire system.
If an account like the legacy pass account exists, then remove that account from the system or
change the password for it to a strong password.
31-00314-01
79 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 80
Compass 1.6.4 Installation & Upgrade Guide
31-00314-01
81 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
Under Time Sync tab, select the desired Send time sync every period value.
Click Add to select recipients of the time sync. In this instance, it is a Device Instance. Select
the desired Device Instance from the pull down, click OK.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 82
Compass 1.6.4 Installation & Upgrade Guide
31-00314-01
83 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
As per the minimum system requirements for Compass as of this writing, the minimum
recommended amount of memory ranges from 4GB to 32GB depending on the model of
Compass deployed. There is a parameter that specifies the maximum amount of memory
allocated by the Compass-NBT component. If this value is set too low, higher CPU usage will
occur. The recommended minimum setting is 25% of the installed memory. The default setting
is 2GB (2048M), which is appropriate for all Compass models up to Compass-1-MD. The table
below provides guidelines for setting this parameter for each Compass model based on
minimum recommended specifications.
NOTE: If more RAM is installed in the computer/VM than the minimum recommended, adjust
the calculation accordingly using the 25% of installed memory recommendation as noted above.
The Xmx parameter is within the nre.properties file. Use a text editing utility like Notepad or
Notepadd++ to edit this file. The file path is typically
C:\Alerton\Compass\1.0\System\Lib\nre.properties for standard installations. Edit the following
line:
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 84
Compass 1.6.4 Installation & Upgrade Guide
Option A
Option B
Option C
31-00314-01
85 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
Option D
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 86
Compass 1.6.4 Installation & Upgrade Guide
• Run the utility Compact Compass Access Database for Compass installations or
Compact BACtalk Access Database for Envision for BACtalk installations.
• Delete any .before-compaction files
• Copy the tempmdb folder to another location out of the project folder and then Empty the
folder.
Check FQDN of and verify DNS entries on network – ensure hostname does not contain an
underscore “_” – change the PC name if necessary and reboot (required).
31-00314-01
87 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
The Compass Config Tool is required to be run for all installations of the Primary Compass
Workstation (Server) or Secondary Compass Workstation (Client). The configurable settings
within the Compass Config Tool are settings that have all been removed from within Compass
and now reside within this tool so as not to create any confusion on their use.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 88
Compass 1.6.4 Installation & Upgrade Guide
MENU ITEMS
31-00314-01
89 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
File
Exit Self-explanatory
Actions
Create Self-Signed Certificate This will create a self-signed certificate for SSL use.
Reinstall Prerequisites Though prerequisites are installed the first time the
Config Tool is launched, should the need arise that
anything becomes out of sync, the necessary
prerequisites can be re-installed through this menu
entry.
Install SQL Express 2014 For initial installations of Compass, SQL Express must
be installed. This is not necessary for currently existing
installations of SQL Express or SQL Server Standard
and Enterprise Editions installed locally or remotely (on
another computer/VM).
Change Workstation Type This launches the dialog to alter the installation of
Compass from a Primary Compass Workstation (server)
to a Secondary Compass Workstation (client) or the
opposite.
Change LocalAdministrator Password This provides the ability to change the Local
Administrator Password from the Config Tool.
Tools
Verify and Fix Checklist Verify and Fix Checklist contains several routines that
verify certain aspects of the system configuration.
Problems are classified as “warning”, which means that
normal system operation may be possible, and “error”,
which means normal system operation is not possible. If
a check results in a warning or error, you can use the
Fix button to attempt to fix the problem before running
the verification scan again. If the Fix operation doesn’t
resolve the problem, further troubleshooting will be
required.
Config Tool Logs This file will contain any error or warning messages
output generated by the verify and fix operations as well
as other logging information collected in the Compass
Config Tool.
Help
Open Installation and Upgrade Guide Self-explanatory
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 90
Compass 1.6.4 Installation & Upgrade Guide
About
Compass Config Tool Version Self-explanatory
NOTE: Since the Compass Config Tool is decoupled
from Compass and will be distributed outside of the
Compass release, this version number will change more
frequently. The latest version of the Config Tool will be
available on the Alerton Support Network (ASN).
31-00314-01
91 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
SSL/LDAP tab under General System Setup in earlier versions. The Rep/Job selector here will
allow you to select an existing Rep/Job in the case of an upgrade or create a new Rep/Job for a
fresh installation.
NOTE: Compass and the Web User Interface (UI) are dependent on the FQDN being set for
name resolution and thus using an IP address in the web browser will not work.
WEBSITE CONFIGURATION
This group manages the configuration of the web sites allowing one to select the ports used by
each site as well as choosing to use SSL or not. If SSL is used, then an SSL Certificate must be
selected. This selection is based on the information gathering phase before installing Compass
as to if a self-signed, commercial or enterprise certificate will be used. In any case, the menu
item to install certificates is used and will then populate the SSL Certificate pulldown with
entries.
PROGRESS BAR
At the bottom of the screen on the left is the progress bar. During certain operations, a green
bar will grow to the right indicating the progress of the current operation.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 92
Compass 1.6.4 Installation & Upgrade Guide
Compass database
This is the connection string information telling Compass where it’s databases are to be created
and/or maintained. By default, it will be the same computer/VM that Compass where Compass
is installed. If this is not the case based on the information gathering performed before the
installation, adjust these settings accordingly.
31-00314-01
93 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
Database authentication
These two settings dictate the account that gets used as the IIS account for IIS to interact with
SQL.
Use Windows authentication
If Compass and SQL reside on the same computer or VM, or if the computers or VMs used for
Compass and SQL reside within a Windows domain, Windows Authentication should be used.
Choosing the appropriate physical configuration from the options below will dictate the IIS User
Account used.
SQL Server is on the same machine as Compass
Self-explanatory
Self-explanatory
This is set automatically based on the prior two settings. If it is desired to use an alternative
account, it can be manually input here.
If Compass and SQL are standalone computers/VMs, or if either reside within a Windows
domain, but the other remains standalone, then SQL Authentication must be used. The SQL
User used here does not have to already exist as a login on the SQL Server as the Config Tool,
with the SQL Account with Admin Privileges on the Compass Database that was selected above
can create the login and grant it the appropriate privileges.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 94
Compass 1.6.4 Installation & Upgrade Guide
After the above steps have been completed, launching the Compass Config Tool will prompt to
set the LocalAdministrator password for this installation.
31-00314-01
95 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
Additionally, selecting from the menu Actions / Change Workstation Type will launch the same
dialog.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 96
Compass 1.6.4 Installation & Upgrade Guide
Compass should now be launched using Run as Administrator (only for the first launch) and
then log in normally. Once started you can then close Compass and start it normally.
NOTE: For very large sites with numerous displays (2000+), mapping a drive for a Secondary
Compass Workstation (client) in order to edit displays is discouraged for performance reasons.
If this is a requirement it is advised to synchronize display folders between computers/VMs.
31-00314-01
97 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
REQUIREMENTS
• You must be running Windows 10 or later.
• You must be running Compass 1.0 or later.
• You must have Administrator privileges on the local computer because this procedure
installs system software.
• Compass must have auto-login enabled since services need to start without user
interaction. To enable this, go to the Startup/Shutdown tab of the General System Setup
dialog, and check Enable for Auto Login. Then specify a User ID and a Password. This
is the user account that Compass will run under when running as a service.
• Since services must start without user interaction, the welcome dialog that displays at
startup should be suppressed. This can be done by editing the bactalk.ini file that
resides in the Compass installation directory. Under the [BACtalk] group, add the
following line: BYPASS_WELCOME=Y
LIMITATIONS
The default account associated with starting the software as a service is the LocalSystem
account. It is highly recommended that the user is changed to a different one that has the
minimum privileges required to run the application.
Some software features are not available when it is running as a service. These include Editing
Graphic Displays, VisualLogic, ActiveX, Set Rep/Job, and BACtalk Builder. Because of these
limitations, run Compass as an application when you design and engineer jobs, and then run
the software as a service after the job is up and running. If you need to use these features after
setting up the software to run as a service, stop the service (see Stopping the Compass
Service), run the software as an application, make the changes, exit the application, and then
restart the service (see Starting the Compass Service).
Download a copy of the latest release of NSSM (https://nssm.cc/download) and extract the files
(such as C:\nssm)
Use NSSM to create the service, click All Programs, click Accessories, right-click Command
Prompt, and then select Run as Administrator. Within the Command Prompt, navigate to the
NSSM 64 bit executable.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 98
Compass 1.6.4 Installation & Upgrade Guide
The NSSM service installer will pop up. In the Application tab click on the “…” next to the Path
text field. Navigate to the Compass System directory (default path is
C:\Alerton\Compass\1.0\System\) and select the bactalk.exe.
31-00314-01
99 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
Click the Details tab, type the Display name Compass Service, and type Compass Service
using NSSM as the description. Select Startup type Automatic.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 100
Compass 1.6.4 Installation & Upgrade Guide
Click the Exit actions tab, and then type 60000 in the Throttling section. In the Restart section,
select Restart application, and then type 60000 in the Delay restart by text field.
Start the Compass service (see Starting the Compass Service). Each time the system is
restarted, the software launches automatically.
31-00314-01
101 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
• Select Start > Settings > Control Panel > Administrative Tools > Services. The Services
utility opens.
• Select CompassService.
• Click Action and then click Properties.
• Set Startup type: to Disabled.
The service will not start the next time the server is rebooted.
• Select Start > Settings > Control Panel > Administrative Tools > Services. The Services
utility opens.
• Select CompassService.
• Click Action and then click Start.
• Select Start > Settings > Control Panel > Administrative Tools > Services. The Services
utility opens.
• Select CompassService.
• Click Action and then click Stop.
This will still allow Compass to run as an application, but will stop the service until you restart it
or reboot the server.
• Select Start > Settings > Control Panel > Administrative Tools > Services. The Services
utility opens.
• Select CompassService.
• Right-click and select Properties. Go to the Log On tab.
• Select the This account radio button, enter the user account and password, and then
click OK. (Note that the BACtalk account is just an example, the actual user name can
be anything you want.)
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 102
Compass 1.6.4 Installation & Upgrade Guide
NOTE: The only difference between an Enterprise certificate and a Commercial certificate is
who signed your certificate. The process is the same for both.
This approach provides a seamless experience for corporate users that already have the signer
root certificate in their certificate store. It may require distribution of signer root certificate to non-
corporate workstations
SELF-SIGNED CERTIFICATE
Using a self-signed certificate eliminates the SSL-related warnings encountered when using the
web interface of Compass at the Primary Compass Workstation (Server).
DISABLE SSL
Use this option only if your system is behind a firewall on a closed and trusted network.
Running Compass with SSL disabled is highly not recommended and should only be considered
as a last resort. Web browsers are starting to display a warning when a user visits a site that
isn't using HTTPS, which could be disconcerting to the user and could result in support
inquiries.
31-00314-01
103 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
NOTE: LDAP requires SSL to be enabled to allow users to log into the system from a web
browser.
NOTE: If unsure about this process, it is recommended to use tool provided by the CA of your
choice to ensure you are making the proper request.
Launch the Internet Information Server (IIS) Manager utility. Ensure the correct server is
selected from within the Connections pane. Double-click on the Server Certificates icon.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 104
Compass 1.6.4 Installation & Upgrade Guide
31-00314-01
105 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
Input the Distinguished Name Properties and click Next (NOTE: “Common name” is your
FQDN)
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 106
Compass 1.6.4 Installation & Upgrade Guide
Choose a cryptographic service provider and bit length and click Next.
31-00314-01
107 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
Specify a file name and location for the request. Click Finish.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 108
Compass 1.6.4 Installation & Upgrade Guide
A quick review of the file output reveals a txt file like the following:
Once a response has been received from the CA, on the same computer/VM the request was
made perform the following steps.
31-00314-01
109 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
Launch IIS Manager. Ensure the correct server is selected in the Connections Pane. In the
Actions Pane select Complete Certificate Request.
Select the file returned by the CA, provide a friendly name, select Personal for the certificate
store for the new certificate and click OK.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 110
Compass 1.6.4 Installation & Upgrade Guide
Note that in addition to specifying the Certificate Authority Response you may need to install
one or more intermediate certificates. If this is necessary, then the Certificate Authority will
provide full instructions.
After ensuring that all required intermediate certificates are installed, then return to the IIS
Manager Server Certificates display and select the installed certificate for export:
31-00314-01
111 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 112
Compass 1.6.4 Installation & Upgrade Guide
Choose name, location and password for the .pfx file you are exporting and click OK.
Launch the configuration tool and enter the LocalAdministrator password, and then, when the
main window is displayed, click on Install Certificate.
31-00314-01
113 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
When the dialog box is displayed select the .pfx file you have previously exported, enter the
friendly name and the password and click Import. Note it is not necessary to check the Also
Import into Trusted Root checkbox for a certificate purchased from a Certificate Authority.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 114
Compass 1.6.4 Installation & Upgrade Guide
When connecting to the SQL Server in question, using SQL Authentication, append the non-
standard port number to the name of the server connecting to.
NOTE: When using SQL Authentication, the database must already be created and the login
name and password established ensuring that login is the owner of the database. See the SQL
DBA or IT Department for assistance in creating.
In this example of a conventional job, port 8384 is appended to the server name entry:
SQLSERVER\SQLEXPRESS,8384
31-00314-01
115 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
In this example of an enterprise job, port 8385 gets appended to the server name entry:
SQLSERVER ,8385
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 116
Compass 1.6.4 Installation & Upgrade Guide
Should an entry in the Device Cache become invalid, there are three methods to correct:
1. Perform a device scan within Device Manager and save the results.
2. Run Repair Device Cache from the Advanced tab within Device Manager – this will
rebuild the Device Cache for all devices.
3. From within the Web User Interface, using the Reinitialize Device icon from the vertical
menu on the left. This allows for the reinitialization of a single device and does not
require one to be at the Primary Compass Workstation (server).
NOTE: Another use case for the use of the Reinitialize Device icon is when the state text values
of a Multi-State Value object are updated, and it is not desirable to wait the 60 seconds for the
update to become effective.
Possible error messages observed within the Web User Interface should a device’s Device
Cache entry become invalid, its cause and resolution:
31-00314-01
117 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
APPENDIX I – TROUBLESHOOTING
CERTIFICATE DOES NOT INSTALL TO NIAGARA CERTIFICATE STORES
ISSUE:
Install certificates does not install certs into the Niagara certificate stores. Something prohibits
the importing of the certificates into the Niagara certificate stores and instead sets the certificate
to “Allowed Hosts”; in this state, it will not work.
SYMPTOM:
Typical symptom is when doing View / Top Display, browser launches but Compass comes up
with statement that Compass is not running.
You may also see entries within the NBTlog.txt file similar to the following:
ERROR [17:46:49 04-Apr-18 PDT][web.server] HTTPS server failed to start on port [446]
invalid server certificate requested
WORKAROUND:
Create a user named “Admin” and set its password – that is all that is needed. Do not set a
security level or assign to any group.
In General System Setup, beneath the SSL and LDAP tab, click the Certificate Manager button.
Use this newly created account to login to the Certificate Manager.
Review the tabs for Key Store and Trust Store and the certificate is likely not there. Review of
the Allowed Hosts tab should reveal the entry.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 118
Compass 1.6.4 Installation & Upgrade Guide
Close Compass.
Launch the Config Tool, repeat only the install Certificate step done before using the same
certificate. Upon successful install, exit the Config Tool – do not perform any other action.
31-00314-01
119 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
During a fresh installation of Compass, IIS will be installed as part of the prerequisites.
Compass is set by default to run at port 80. If IIS was installed prior to Compass being installed,
its default web site will already be bound to port 80. You must resolve this conflict before
Compass can run. (REF #KERMI-9618) (REF # KERMI-9622)
SYMPTOM:
Attempts to install Compass results in a warning message that a port conflict exists.
RESOLUTION:
There are several possible resolutions to this issue, choose the one that best suits your
situation.
Option 1: Alter the port binding of the default web site within IIS Manager setting it to an
alternative port that isn’t planned to be used by Compass.
Option 2: Stop the default site from running. This option may also require that the port
binding be changed prior to disabling the site.
Option 3: Delete the default web site. This should be the last option tried if there is any
uncertainty regarding the use of the default site.
NOTE: The Compass Config Tool will automatically remove the default site from an IIS
installation that it performs. The above necessary steps are only required when a pre-existing
IIS installation is present.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 120
Compass 1.6.4 Installation & Upgrade Guide
WINDOWS DRIVES MAPPED USING A LOCAL USER ACCOUNT ARE NOT VISIBLE IN THE
COMPASS CONFIG TOOL
ISSUE:
When a user maps a drive, Windows only allows the user who mapped the drive to see it.
However, the Configuration Tool runs with elevated privileges, which is a different user account
than the one who created the mapped drive. This means that the user must select the UNC file
path instead of the mapped drive.
SYMPTOM:
Using the Compass Config Tool, attempts to reference any mapped drive for a field input may
result in the drive not being listed. Example: The rep/job path for a Primary or Secondary
Compass Workstation. (REF #KERMI-9933)
WORKAROUNDS:
Option 1: Use Universal Naming Convention (UNC) syntax for providing the path to the rep/job
Example: \\HostName\SharedFolder
Option 2: Update the Registry to allow sharing mapped drives across user accounts.
Resources:
Microsoft: Mapped drives are not available from an elevated prompt when UAC is configured to
“Prompt for credentials” in Windows
Microsoft: Programs may be unable to access some network locations after you turn on User
Account Control in Windows Vista or newer operating systems
31-00314-01
121 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
SYMPTOM:
Backup cancelled message. (REF #KERMI-8271)
CONDITIONS:
We have identified several different conditions where this issue might arise.
Condition1:
Enterprise Job that was converted from a Conventional database configuration. Enterprise
configuration with Compass on one machine, SQL Server running on another.
Resolution1:
Delete the [Express] stanza and the lines beneath it (up to the next stanza) from the profile.ini of
the REP/JOB.
NOTE: This appears to only affect configurations as noted above and so far, only upgraded –
not fresh installations.
###
Condition2:
Conventional job that was upgraded on another PC, a backup performed, then restored to the
new or upgraded PC.
The file ownership of the REP\JOB\database\REP JOB.bak file is owned by another non-
existent user and thus the service account used by SQL Server is unable to overwrite it due to
the lack of authority to do so.
Resolution2:
Once the backup has been restored and data validated to be sound within the running system,
delete or rename the C:\Alerton\Compass\1.0\<REP>\<JOB>\database\REPJOB.bak file in the
REP/JOB folder.
###
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 122
Compass 1.6.4 Installation & Upgrade Guide
Condition3:
Conventional job with SQL Express installed locally. Through a Group Policy deployment or
other means, the file level permissions to the Alerton\Compass\1.0\REP\JOB folder structure
has been changed and the “Authenticated User” either removed or permissions changed from
MODIFY (M) to READ (R) or READ/EXECUTE (RX). A quick run of “iCACLS
C:\Alerton\Compass\1.0” should reveal any negative changes to the file or folder permissions.
Resolution3:
1. Open a File Explorer window and traverse the file system until you get to the
installation location of Compass – typically C:\Alerton\Compass\1.0
2. Highlight the REP folder for the REP\JOB in question. Right-click and select
Properties.
3. Select the Security tab and select Authenticated Users in the Group or user names
window.
4. Click the Advanced button.
5. On the permissions tab of the Advanced Security Settings window, click the Add
button beneath the Permission entries box.
31-00314-01
123 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 124
Compass 1.6.4 Installation & Upgrade Guide
10. Back at the Permission Entry window, ensure for the Authenticated Users principal
that the type is set to Allow and Applies to is set to This folder, subfolders and files.
Next, ensure the basic permissions is set to Modify which would mean Modify, Read
& execute, List folder contents, Read, & Write should all be checked.
11. Click OK.
31-00314-01
125 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide
12. Back at the Advanced Security Settings window, click the Enable inheritance button
and ensure the check box is checked for “Replace all child object permission
entries…”
13. Click Apply.
14. A Windows Security dialog will appear warning of the change in settings regarding
inherited permissions. Click OK.
15. Again, back at the Advanced Security Settings window, Click OK.
31-00314-01
©2019 Honeywell
Compass 1.6.4 Installation & Upgrade Guide | Dec 2019 126
Compass 1.6.4 Installation & Upgrade Guide
31-00314-01
127 Compass 1.6.4 Installation & Upgrade Guide Dec 2019
©2019 Honeywell