MOTOROLA SOLUTIONS

COMPASS DECISION
MANAGEMENT
SYSTEM™
VERSION 2.2.0.X

INTEGRATION
SPECIFICATION
MOTOROLA SOLUTIONS COMPASS DECISION MANAGEMENT SYSTEM™

THIS MANUAL WAS CREATED ON MONDAY, OCTOBER 18, 2021.

DOCUMENT ID: IU-AG-MAN027-1-DRAFT1
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.

INTEGRATION SPECIFICATION
PAGE 2
V1-DRAFT1
TABLE OF CONTENTS

Copyright, trademarks, and disclaimers 2

Trademarks 2
Disclaimer 2

1 ABOUT THIS GUIDE 5

Safety notices 5

2 GOALS OF THE INTEGRATION 7

3 SUPPORTED FIRMWARE, BRANDS, AND MODELS 8

Licensing requirements 8

4 BRANDS, MODELS AND CONFIGURATIONS 10

Brands and models supported 10
Licensing requirements 10

5 LIST OF ASSUMPTIONS AND TECHNICAL CONSTRAINTS 11

Supported features 11
Testing document 13
Use cases 13
Supported cases 13
Unsupported cases 13
Client 13
Support contacts 13

6 FUNCTIONAL SPECIFICATIONS 14
Global and physical devices 14
Global device connection data fields 14
Physical device connection data fields 14
Logical devices 14
Multifunctional Icons 15
Users info [Access Control only] 16

7 TECHNICAL SPECIFICATIONS 17
General explanation of the integration 17
System diagram 17
Firewall requirements 17
Data mapping and transformation rules 17
Flowcharts 17
Class Diagram 17
Alarm Mapping 17

INTEGRATION SPECIFICATION
PAGE 3
V1-DRAFT1
MOTOROLA SOLUTIONS COMPASS DECISION MANAGEMENT SYSTEM™

Protocols 18
Installation requirements outside Compass 18
Logging messages 19
Test standalone application 19
Testing and development setup 19
Change requests 19

INTEGRATION SPECIFICATION
PAGE 4
V1-DRAFT1
1 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.

Indicates a hazardous situation which, if not avoided, may seriously impair operations.

Additional information relating to the current section.

INTEGRATION SPECIFICATION
PAGE 5
V1-DRAFT1
MOTOROLA SOLUTIONS COMPASS DECISION MANAGEMENT SYSTEM™

INTEGRATION SPECIFICATION
PAGE 6
V1-DRAFT1
 MOTOROLA SOLUTIONS COMPASS DECISION MANAGEMENT SYSTEM™

2 GOALS OF THE INTEGRATION

Before you create a driver integration guide, you must determine the following:
• Why will the client use the integration?
• In the context of the application, how will the client use the integration? For example:
• Receiving all alarms and technical alarms from the alarm receiver with information
on the elements that triggered the alarm
• Displaying information from the alarm panel, including zone and/or detector, and
alarm category.

INTEGRATION SPECIFICATION
PAGE 7
V1-DRAFT1
 MOTOROLA SOLUTIONS COMPASS DECISION MANAGEMENT SYSTEM™

3 SUPPORTED FIRMWARE, BRANDS,

AND MODELS

This section of the integration guide should include the following information:
• The necessary modules for the integration to work correctly, for example, Honeywell
Notifier requires a gateway
• The modules that the integration will also support but are not explicitly required for
operation
• The subsystem firmware and software versions supported by the integration
• List the brand/model pairs shown by Compass wen adding a new global or physical
device, refer to Table 1
• If necessary, the firmware and software versions used for driver development and/or
certification purposes

TABLE 1 BRAND/MODEL PAIRS EXAMPLE

BRAND MODEL

Brand 1 Model A/Configuration X

Brand 1 Model A/Configuration Y

Brand 2 Model A

If the list of brand/model pairs is too long, refer to an annex.

LICENSING REQUIREMENTS
List the license(s) required to use the integrated subsystem in Compass. If a trial license is sufficient for
use during the development cycle, this must be stated.

INTEGRATION SPECIFICATION
PAGE 8
V1-DRAFT1
MOTOROLA SOLUTIONS COMPASS DECISION MANAGEMENT SYSTEM™

INTEGRATION SPECIFICATION
PAGE 9
V1-DRAFT1
4 BRANDS, MODELS AND
CONFIGURATIONS

BRANDS AND MODELS SUPPORTED

This section of the integration guide should include the following information:
• Modules necessary for the integration to work (for example, Honeywell Notifier needs a
gateway).
• Modules that the integration will also support but are not required (for example, Honeywell
Galaxy RIOs).
• List the Brand/Model pairs shown by Compass when adding a new global device (if list is too
long, refer to an Annex).
• List the Brand/Model pairs shown by Compass when adding a new physical device (if list is
too long, refer to an Annex).
The exemplary values are given in Table 2.

TABLE 2 BRANDS AND MODELS SUPPORTED

BRAND MODEL

Brand 1 Model A / Configuration X

Brand 1 Model A / Configuration Y

Brand 2 Model A

LICENSING REQUIREMENTS
You must consider:
• What type of license is needed to use the integrated sub-system in Compass
• If a trial license is sufficient for use during the development cycle.

INTEGRATION SPECIFICATION
PAGE 10
V1-DRAFT1
5 LIST OF ASSUMPTIONS AND
TECHNICAL CONSTRAINTS

SUPPORTED FEATURES
List all features that the integration supports.

TABLE 3 CONNECTION AND PROPERTIES

FEATURE REQ SDK VAL DEV TEST

Login confirmation

Check equipment Model and Firmware Version

Get current system date and time

Get current configuration (Cameras, I/O, Detectors)

TABLE 4 VIDEO SYSTEM

FEATURE REQ SDK VAL DEV TEST

Live video and post-alarm

Get snapshot from live video

Recorded video and pre-alarm

Get snapshot from recorded video

Get streaming profiles

PTZ commands

Get preset list

Goto preset

Save preset

Delete preset

Goto home

Playback control

Get next frame

Get previous frame

Set play direction

Jump seconds

Resume livestream

Send output commands

INTEGRATION SPECIFICATION
PAGE 11
V1-DRAFT1
MOTOROLA SOLUTIONS COMPASS DECISION MANAGEMENT SYSTEM™

FEATURE REQ SDK VAL DEV TEST

Get inputs and outputs status

Bookmarks

VideoWall

Protect one evidence

TABLE 5 ACCESS CONTROL SYSTEM

FEATURE REQ SDK VAL DEV TEST

Get users

Get roles

Get access groups

Get AC zones

Get AC zone user accesses

Add user to zone

Remove user from zone

Clear anti passback

Clear anti passback for all

Search AC User

Get AC User photo

Search AC User with photo

AC Lock access point

AC Unlock access point

AC Reset access point

Grant access

Send output commands

Get inputs and outputs states

TABLE 6 INTRUSION/FIRE PANELS

FEATURE REQ SDK VAL DEV TEST

Arm/disarm panels

Panel acknowledge

Reset panel

Activate/Deactivate siren

Activate/Deactivate panel

Inhibit/uninhibit detectors

INTEGRATION SPECIFICATION
PAGE 12
V1-DRAFT1
MOTOROLA SOLUTIONS COMPASS DECISION MANAGEMENT SYSTEM™

TABLE 7 ALARM RECEIVER

FEATURE REQ SDK VAL DEV TEST

Receive Analytics alarms

Receive Technical alarms

Alarm acknowledge

TESTING DOCUMENT
Include a link to the applicable testing document(s).

USE CASES
You must identify the Compass supported and unsupported cases.

SUPPORTED CASES
When listing cases that are supported by Compass, include the following:
• Description of the Compass use cases supported by the driver
• A brief explanation of the integrated system key features (the differentiator) and how these
will be used in, or by, Compass.

UNSUPPORTED CASES
When listing cases that are not supported by Compass, you must include a description of the Compass use
cases that the driver does not support, and why they are not supported.

CLIENT
You must describe the following:
• The client infrastructure, including quantities
• The client’s current operation with the subsystem
• How the client will operate the subsystem through Compass
• All client requirements, if applicable.

SUPPORT CONTACTS
Include contacts for the following:
• Manufacturer development support
• Manufacturer
• Distributor.

INTEGRATION SPECIFICATION
PAGE 13
V1-DRAFT1
6 FUNCTIONAL SPECIFICATIONS

Describe the association rules between alarm sensors and cameras.

GLOBAL AND PHYSICAL DEVICES

You must consider the following information:
• Will the integration be used in a multi-site scenario?
• Does the integration need to be supported as a global device?
• Does the sub-system support being used simultaneously in two sites in Compass?

GLOBAL DEVICE CONNECTION DATA FIELDS

The list of the global device connection data fields are given in Table 8.

TABLE 8 GLOBAL DEVICE CONNECTION DATA FIELDS

NAME FIELD TYPE DEFAULT VALUE EXPLANATION

IP address StringValue 192.168.0.1 IP address of the recorder

Port DoubleValue 443 Port to be used by Compass when connecting to the sub-system

PHYSICAL DEVICE CONNECTION DATA FIELDS

The list of the physical device connection data fields are given in Table 9.

TABLE 9 PHYSICAL DEVICE CONNECTION DATA FIELDS

DEFAULT
NAME FIELD TYPE EXPLANATION
VALUE

Username to be used by Compass when connecting to the sub-

Username StringValue admin
system

Password to be used by Compass when connecting to the sub-

Password EncryptedValue
system

LOGICAL DEVICES
Include the following information:

• Is it possible to create the logical devices list automatically? If yes, which method is used to
get a list (SQL query, Web services, etc.)
• Creation Rule: What is the criteria to create each type of logical device? Always? If enabled
in the configuration? If present in the list reported by the sub-system?
• List of supported logical devices and functions which it implements:
• Types of logical devices that should be created (fire, intrusion, generic detectors, alarm
sensors, inputs, outputs, arm panels, cameras).
• Describe the states of each logical device, and how the states change.

INTEGRATION SPECIFICATION
PAGE 14
V1-DRAFT1
MOTOROLA SOLUTIONS COMPASS DECISION MANAGEMENT SYSTEM™

• Specific values of Hardware IDs.

• Need for creation of transversal devices (ALL, USER, EVENT, MODULE).
• Need for creation of multifunctional icons.
The exemplary values for logical devices are given in Table 10.

TABLE 10 LOGICAL DEVICES

DEVICE DEVICE CREATION USER HARDWARE

NAME FUNCTION ICON
TYPE STATE RULE INTERACTION ID

When used,
If pressed,
Compass will
Red Compass
send a
Red when will send
command to
the door is commands to
the subsystem
[DOOR_ unlocked. Automatic, lock. If [DOOR_
so that the
NAME] Output Green one for each pressed when ID]_
referenced
Unlock when the door Green UNLOCK
door will
door Compass will
remain open
locked. send
until the Lock
commands to
command is
unlock.
sent.

Receive all
Automatic,
alarms that
Alarm one for each
Catch All don’t match None None ALL
Sensor physical
other Alarm
device
Sensors

• Creation of additional inputs to represent the real time status of some devices.
The exemplary additional inputs with their real time statuses are given in Table 11.

TABLE 11 STATUSES OF ADDITIONAL INPUT DEVICES REPRESENTED IN REAL TIME

ELEMENT INPUT DEVICES

Is in Alarm
Is in tamper
Has tamper event to be acknowledged
For each partition
Has alarm to be acknowledged
Is in auto arm
(...)

Is in alarm
Is in tamper
For each zone
Is in test
(...)

(...) (...)

MULTIFUNCTIONAL ICONS
The exemplary values for multifunctional icons are given in Table 12.

INTEGRATION SPECIFICATION
PAGE 15
V1-DRAFT1
MOTOROLA SOLUTIONS COMPASS DECISION MANAGEMENT SYSTEM™

TABLE 12 MULTIFUNCIONAL ICONS

CREATION LOGICAL DEVICES ON

MFI'S MAIN FUNCTION ICON MFI'S NAME
RULE THE MFI

- Logical Detector
if checked “true” <groupID> - <zoneID>
For each From the Logical Detector
in conn. data <zoneName>
Zone - Inhibit/Uninhibit
- Zone Outputs <zoneTypeName>
- Zone Inputs

if checked “true” From “Arm Panel” -

in conn. data: Arm/Disarm
- Arm Panel From “Force Arm Panel” -
Force Arm/Disarm
- Force Arm Panel
For each From “Arm Panel Output” <groupID> - <groupName>
- Abort Arm Panel
Group - Arm <default function>
- Partial Arm
From “Force Arm Panel
Panel
Output” - Force Arm
- Group Outputs
From “Reset Panel” -
- Group Inputs Reset

USERS INFO [ACCESS CONTROL ONLY]

The users info fields description [Access Control only] are given in Table 13.

TABLE 13 USERS INFO

SYSTEM FIELD DESCRIPTION COMPASS FIELDS DESCRIPTION

Title + First Name + Last Name Name

SystemId

SocialId

Schedule

AccessGroupName

Expiration date [NEW REQUEST]

INTEGRATION SPECIFICATION
PAGE 16
V1-DRAFT1
7 TECHNICAL SPECIFICATIONS

GENERAL EXPLANATION OF THE INTEGRATION

• Is the API/SDK thread safe?
• What limits exist for simultaneous requests to the subsystem?
• Describe the solution’s architecture (Compass, panels, intermediate systems).
• Describe if there are communication modules in the equipment.
• Name the communication protocol used (and brief explanation).
• For video drivers, is the pre-alarm video clip downloaded or streamed?
• List the documentation collected and necessary to understand the configuration of the
equipment, as well as the communication protocol (e.g. driver uses ODBC to connect to
integrated system to poll for alarms).

SYSTEM DIAGRAM
• Insert diagram image.

FIREWALL REQUIREMENTS
List of the default ports needed for the integration to work with Compass (one table for each operational
mode) (Table 14).

TABLE 14 FIREWALL REQUIREMENTS

BRAND/MODEL DESCRIPTION SOURCE DESTINATION PROTOCOL/PORT

Compass Server

Compass Server

Compass Server

DATA MAPPING AND TRANSFORMATION RULES

• Describe how the raw event data will be translated to event data.

FLOWCHARTS
• Insert flowchart.

CLASS DIAGRAM
• Insert diagram image.

ALARM MAPPING
• Describe which rules to be included on the Alarm Mapping.

INTEGRATION SPECIFICATION
PAGE 17
V1-DRAFT1
MOTOROLA SOLUTIONS COMPASS DECISION MANAGEMENT SYSTEM™

• Fill the table below with the alarm mapping to be included in the driver (Table 15).
• Is there the need for dynamic alarm mapping? At what level is it implemented (global or
physical)? What is the syntax for the pairs?
• Examples of syntax: “[alarm code]=[alarm mapping in Compass]”.
• No alarms can be mapped to a physical device, all alarms must be mapped to logical
devices (logical devices can be created just to receive alarms).

TABLE 15 ALARM MAPPING

EVENT CODE DESCRIPTION COMPASS ALARM TYPE

TABLE 16 ALARM MAPPING

SIA COMPASS
SIA ALARM DESCRIPTION COMPASS ALARM
CODE DEVICE

An attempt to substitute an alternate alarm panel for a secure ALARMPANEL_

AA TECHNICAL
panel has been made GENERIC

Output with
ALARMPANEL_
AB An event message was not sent due to User action hwID
GENERIC
ID: outputID

ALARMPANEL_
AN An analog fire sensor has been restored to normal operation Zone
GENERIC

PROTOCOLS
Include the following information:
• A brief explanation of the protocol used between Compass and the integrated system
• What technologies the driver uses, for example, SDK, API, DLL
• How the driver logs in. What user is required, what restrictions/rights this user needs?
• How failover is handled
• What process the driver uses to verify that the equipment is online
• How alarms are fetched from the integrated system, for example, from table active_alarms,
from DLL callback.

INSTALLATION REQUIREMENTS OUTSIDE COMPASS

Include the following information:
• List of components (and where to get them) that must be installed to support the driver, for
example, the SDK that must be installed, DLLs that must be registered
• List of steps to perform to get the driver working, for example, install SDK or register DLL.
The list must be ready to copy, paste and execute
• Does the driver require a system account?

INTEGRATION SPECIFICATION
PAGE 18
V1-DRAFT1
MOTOROLA SOLUTIONS COMPASS DECISION MANAGEMENT SYSTEM™

LOGGING MESSAGES
Include the following information:
• What driver actions must be logged, for example, connection data setup, login, test
connection
• The information that each log message must include, for example, device information,
address used.

TEST STANDALONE APPLICATION

Include the following information:
• What functions must be tested by the standalone application, and in which mode (automatic
or manual)
• The configuration parameters of the standalone application, for example, user credentials,
device address.

TESTING AND DEVELOPMENT SETUP

Testing and development setup must include:
• IP
• PORT
• PIN
• Credentials.

CHANGE REQUESTS
<Date> - <title> [state/Compass version]
None.

INTEGRATION SPECIFICATION
PAGE 19
V1-DRAFT1