Gallagher Security

Have more questions? Submit a request

Gallagher Security

image1.png

Native Integration Available

This integration requires a Class 3 License and a Device Server. Please contact your account manager for more details. Steps to configure your device can be found here.

Manufacturer: Gallagher Security (+​​1(800) 531-5908 | (816) 421-2005)
Product: Gallagher 8.7
Type: Device Integration & Alarm Receiver

 

Native Integration: Supported Features

The Gallagher Security integration supports the following features:

  • Alarms
  • Door Pulse 
  • System Synchronization
  • Alarm Acknowledgement

Native Integration: Requirements

Version Requirements

Validated against Gallagher versions: 7, 8.7, 9.10

 

License Requirements

A fully licensed Gallagher server (License: C13008 REST API LIC BUNDLE)

 

Network Requirements

From

To

Port

Use

Device Server

Gallagher Server

8904 TCP

Sync, Door Control, Alarms
REST API: "Server Base Port"

Finding the Gallagher Port

  1. In Gallagher Command Center, click Configuration Client
  2. In the File Menu click Server Properties
  3. In the new Server Properties window click Web Services
  4. Find the "REST API" Server Base Port (default 8904)

Permission Requirements

User configured on Gallagher with permissions for the alarms you want to receive in SureView

  • Acknowledge Alarms
  • Edit Alarms
  • Override - Open Door
  • View Events
  • View Events and Alarms
  • View Site

mceclip0.png

 

REST Client & API Key

To find the API Key you'll need to set up a REST Client.

  1. In the Gallagher Command Center, click Configuration Client
  2. Then click on the Configure menu and and choose Services and Workstations.
  3. In the new window, click Add, then select Rest Client.

  4. Set a REST Client Operator to a user that has permissions to access any alarm you want brought into SureView.

  5. Copy the API Key from the API Key tab - You will use this as the "Password" when setting up Gallagher in SureView

Native Integration: Device Setup

Prerequisites

Configuration

The following are the steps required to configured Gallagher to work with the Sureview.

Before you begin

Before you configure your Gallagher system to work with Sureview make sure you have the following:

  • A fully licensed Gallagher server (License: C13008 REST API LIC BUNDLE)
  • A configured SureView Device  Server with the "Gallagher" integration installed
  • All required ports configured (see Components and Communication)
  • A User configured on Gallagher with permissions for the alarms you want to receive in SureView
    • Acknowledge Alarms
    • Edit Alarms
      Override - Open Door
    • View Events
    • View Events and Alarms
    • View Site
  • The Gallagher API Key associated with the User
  • The List of Gallagher "DivisionIDs" that you want to Sync into SureView Areas

 

Finding the Gallagher Division ID

  1. Open the Gallagher Configuration Client
  2. Open Configure Menu
  3. Click Divisions
  4. Expand the tree to find individual site/area/division that you need
  5. Double click on the division - a pop-up will appear
  6. Hold control on the keyboard and double click the Pie Icon in the popup window
  7. A dialogue window appears. The Division ID is listed as "ID = xxxxx"
    mceclip0.png

 

Native Integration: Device Setup

mceclip4.png

Note: Gallagher is an advanced integration and must be configured using the using advanced "Device Setup" page and the "Device Configuration" feature.

 

Sync Configuration

mceclip1.png

  1. Device Setup
  2. Sync Tab
  3. Add device
  4. Complete the Sync Fields
    Field Value
    Title The friendly name of the Gallagher Server you are connecting to
    Type select "Gallagher"
    Host The local IP or Host address of the Gallagher Server (from the perspective of the SureView Device 'CloudLink' server)
    Port The Gallagher API Port - 8904 by default
    Username leave blank
    Password Your Gallagher API Key
    Parameters Gallagher Alarm Instructions can be added to the Event Details based on the instructions parameter. Supported values are 'instructions=None;', 'instructions=Full;', or 'instructions=Name;' (default).
    OpsLink

    The name of your connected SureView Device "Cloud Link" server.

    Note: This option is for SaaS customers only and will not be present or required for fully on-premise sureview deployments.

     

  5. Press Save Sync

Area Sync
Untitled.png

 

  1. Go to the "Syncs" tab (when adding or editing your Sync System)
  2. Click Add Area Sync
  3. Complete the Area Sync Fields
    Field Value
    Title The friendly name for the Area Sync
    Area Which SureView Area should the sync use when adding doors/alarms etc
    Identifier The Gallagher DivisionID that you would like to sync against
    Interval How often should the system sync into SureView?
    default: 24 hours
    Enabled Enable or Disable the automatic Sync default on
    Allow Update Area Allows the sync to automatically move synced doors/alarms to a different area

    Default off

    recommended to keep off
    Allow update Device Settings

    Allows the sync to automatically update the door/alarm settings

    Default off

     

    recommended to keep off

  4. Press Add
    mceclip4.png
  5. SureView will now automatically sync any Alarms/Doors into the appropriate Area(s) - this may take a few minutes to complete depending on the quantity of synced items. Once synced Gallagher will be ready to use and will start receiving SureView alarms.

  6. Unmatched Alarm Configuration

    If a Gallagher alarm is received by SureView Response but there isn't a synced Alarm Point/Response configured then the alarm will be triggered against the "Root Device/Alarm"

    This could happen if only a few select Divisions/Areas have been Synced into SureView but the Gallagher API User has permission to receive alarms for other Divisions/Areas that haven't yet been set up in SureView.

    Go to the the Alarms section
    mceclip0.png

  7. Click Add Alarm
  8. Complete the Create New Alarm fields
    Field Value
    Area Which Area the root alarms should be triggered against.
    Default/Recommended: Top Tenancy Level
    Event Type Leave as: Default
    Title The friendly name for the root alarm. Recommended:
    "Gallagher Root Alarm"
    Action Plan The action plan that would be associated with unmatched root alarms.
    Optional
    Input 1: Must be set to -1
    Input 2: Must be set to -1
    Extra Value Leave blank
    Priority This is an indication of how important the unmatched alarms are. The higher the number,

    It's recommended that this is kept as low (0 - 99)
    Linked Camera Leave Blank
    Grouping

    This allows you to decide how you want multiple instances of this alarm to be grouped when it goes into the Alarm Processing Queue. The options are:

    • By Area
      Multiple separate alarms that are triggered for the same Area will be grouped together for the operator to process as a single event.

    • By Alarm
      Multiple instances of this specific point will will be grouped together for the operator to process as a single event.

    • Not Grouped
      This alarm will never be grouped with any other. Each time it's triggered it will come into the Alarm Processing Queue as a separate, individual alarm event.

    Recommended: By Alarm

    Auto Handle

    If these alarms should be automatically handled (not shown to the operator, but saved into the history) or not.

     

    The options are

    • Yes
      Automatically handle the alarms - do not show them to operators

    • No
      Alarms should be shown to operators (if the alarm point isn't masked)
    • Not Set
      Use the system default for Gallagher and their alarm types

    Recommended: Not Set

  9. Press Save

Alarms

SureView automatically polls Gallagher for new Alarms every 0-2 seconds. Any alarms that the linked Gallagher User has permission to access which as corresponding synced Alarm Point in SureView will automatically trigger in the SureView Alarm Queue.

Event Queue

Event

Event Type - Alarm Title

Example

Door Forced - US.FL.TPA.123B.XX.Entrance

mceclip5.png

mceclip1.png

 

Alarm Processing Screen (Site Monitor)

mceclip6.png

mceclip2.png
Details
SureView Event Type - SureView Alarm Title - Type: Gallagher Event Type, Source:  Gallagher Source Name

Example

Door Forced - US.FL.TPA.123B.XX.Entrance - Type: Door Forced, Source: US.FL.TPA.123B.XX.Entrance

 

Note: In most cases the SureView Event Type and Alarm Title will match the Gallagher Event Type and Source Name. The extra information is provided so that if the SureView friendly names are customised the operator will still be able to see the original Gallagher text.

 

Alarm Acknowledgement

mceclip7.png

There are two options for Gallagher Alarm Acknowledgement

Option 1 - Basic Acknowledgement (default)

When Gallagher alarms are Acknowledged in SureView (by clicking on the alarm or clicking the "Ack All" button) the alarms will be automatically Acknowledged and Processed in Gallagher within 1 minute.

Note: Alarms can only be "Processed" in Gallagher automatically once the "causer" is no longer active.

 

Option 2 - Advanced Alarm Acknowledgement (optional)

Important: Advanced Alarm Acknowledgement must first be enabled on each Gallagher Sync System by the SureView Support Team. To request advanced alarm acknowledgement to be enabled please contact SureView Support

When Gallagher alarms are Acknowledged in SureView (by clicking on the alarm or clicking the "Ack All" button) the alarms will be automatically Acknowledged (including the name of the operator) in Gallagher within 1 minute.

When the Gallagher alarm event is closed in SureView (by clicking the "End" button) any associated Gallagher alarms will be "Processed" (including the name of the operator, outcome category and any outcome notes) in Gallagher within 1 minute.

Note: Alarms can only be "Processed" in Gallagher automatically once the "causer" is no longer active.

Door Control

Doors can be controlled with the "Momentary Unlock" feature from within Media Matrix

mceclip0.png

mceclip2.png

  1. In the Media Matrix sidebar "Controls" section you can view all nearby doors or Search for a specific Door.
  2. Click the Door you want to control
  3. Provide a reason for the action
  4. Click "Momentary Unlock"
    Note: Momentary Unlock  will "Pulse" the door, unlocking it for the duration configured in Gallagher

 

Alarm Instructions

Alarm instructions from Gallagher can be displayed within the SureView event. By default, the system will show the Name of the associated Alarm Instructions in the Event Details with the prefix "Instructions: ". This can be removed, if desired, by adding "instructions=None" to the end of the extraValue for the Gallagher Sync/Device. Supported values are Name (default), None, and Full (Show full instruction text).

 

Event Types & Gallagher Priorities

SureView Event Types for Gallagher are separated based on the event Priorities from the Gallagher system. Gallagher supports the following Priorities:

  • 9: Critical
  • 8: Very High
  • 7: High
  • 6: Medium High
  • 5: Medium
  • 4: Medium Low
  • 3: Low
  • 2: Very Low

Each has a corresponding Event Type on the Event Type configuration page in SureView (US or EU). These Event Types can be assigned different properties, such as Action Plans, Event Queue Priorities, AutoHandle/Ignore behavior, and so on.

Articles in this section

Was this article helpful?
0 out of 0 found this helpful
Share

Comments

0 comments

Please sign in to leave a comment.