IMAGUS GALLAGHER ACCESS

CONTROL INTEGRATION GUIDE

1 TABLE OF CONTENTS
2 Introduction ......................................................................................................................................... 3
2.1 Licences Requirement ............................................................................................................... 3
2.1.1 Gallagher Licences requirement ...................................................................................... 3
2.1.2 Imagus Licences requirement .......................................................................................... 3
2.2 Functionality ................................................................................................................................ 3
2.3 Compatibility................................................................................................................................ 3
3 Installation ............................................................................................................................................ 4
3.1 Install Controller API 8.XX.XX ................................................................................................... 4
3.2 Dual Authentication Enhancement (optional) ......................................................................... 5
3.3 Install Imagus Software.............................................................................................................. 6
3.4 Install Imagus Gallagher FTCAPI service ................................................................................ 9
4 Configuration .....................................................................................................................................11
4.1 Configure Gallagher REST Client ...........................................................................................11
4.2 Configure External System for Controller API ......................................................................14
4.2.1 Create an External System Server.................................................................................14
4.2.2 Create External System Items ........................................................................................16
4.2.3 Configure External System Item as Door Reader ........................................................16
4.2.4 Configure Dual Authorisation for Door (Optional)........................................................17
4.2.5 Create Facial Card Type..................................................................................................20
4.3 Configure Imagus System .......................................................................................................21
4.3.1 Checking Imagus Licence ...............................................................................................21
4.3.2 Configure Gallagher Server in Imagus Config .............................................................22
4.3.3 Setup Cameras for Imagus .............................................................................................26
4.3.4 Setup Door Camera Associations ..................................................................................27
4.3.5 Synchronising Access Control Data ..............................................................................30
5 Troubleshooting ................................................................................................................................36

2
Web: vixvizion.com Contact: [email protected]
 Copyright © 2022, by Vix Vizion Pty Ltd. All Rights Reserved.

2 INTRODUCTION
This document aims to provide a quick guide to setting up the Gallagher Access Control System
with Imagus Facial Recognition Software for facial authentication.

2.1 LICENCES REQUIREMENT

2.1.1 Gallagher Licences requirement

The minimum licences required for Imagus Integration are:

• REST API Alarms & Events (License C12772)

• REST API Cardholder (Licence C12784)
• REST API Status (Licence C12810)

Optional licences required for the following features:

• DualAuthEnhanced Customisation (Licence C12661): To allow dual authorisation of 2

credentials of the same cardholder.

• REST API Inbound Events (License C12820): To show event logs for Imagus related
feedback such as the quality report of photo Id, or person seen at the door.

2.1.2 Imagus Licences requirement

gallagheraccesspoints Number of doors allow to run face recognition

2.2 FUNCTIONALITY
1. Imagus facial recognition synchronizes all cardholders’ photo, Id, name and locks their
profiles in its own database and only uses this database to detect faces. Upon successful
synchronization, it adds a new card for each cardholder as a representation of facial
credential for that cardholder.

2. Imagus sends the facial request in the form of a virtual card badge whenever it detects a
face above absolute confidence. As a result, the Command Centre has an audit log of
who accessed the system as it would do for any other form of credentials.

2.3 COMPATIBILITY
This integration supports the following Gallagher software: * Gallagher Command Centre
vEL8.30.1236 (or later CC release) * Gallagher Controller 6000 Software: Package
vCR8.30.200724a and Application Software v8.30.687 (or later release) * To enable dual
authentication for the same person, a Gallagher Dual Authorisation Enhancement must be
installed on Command Centre Server.

3
Web: vixvizion.com Contact: [email protected]
3 INSTALLATION
The Imagus facial recognition integration requires the following software:

Provided by Gallagher These filse are add on from Gallagher to be installed on Gallagher
Command Centre

1. Gallagher Controller API 8.XX.XX: GallagherFTCAPISetup_8.XX.XX.msi

2. Dual Authentication Enhancement (optional installation if dual credentials of the same
cardholder are required for access): Gallagher Dual Authorisation Enhancement
Integration Setup 8.XX.XX.msi

Provided By Vix Vizion 1. Imagus server: Imagus_x64_3.X.XX.X.exe 2.

Imagus_Gallagher_FTCAPI_XX.X.X.0.exe

Imagus Server communicates with Controller API locally. Therefore component 1 and 2 must be
installed onto the same PC.

3.1 INSTALL CONTROLLER API 8.XX.XX

Always install the Controller API that is provided with the Command Centre installation media. It
will ensure that you have the correct version of FTCAPI for that particular command centre
version. Ensure to install this on to the PC where Imagus Software is installed.

1. Install the supplied VC_redist.x86.exe that can be found from the path /Utilities/Controller
API 8.XX.XX/Visual C++ Redistributable for Visual Studio 2017.

Note that the installation can be skipped if there is one existing. Windows can tell if there is one
upon running VC_redist.x86.exe.

4
Web: vixvizion.com Contact: [email protected]
 Copyright © 2022, by Vix Vizion Pty Ltd. All Rights Reserved.

Non-alarming redistribute Installation failure

2. Install the supplied GallagherFTCAPISetup_8.XX.XX.msi in API 8.XX.XX. Verify if the

folder Gallagher FTCAPI is presented in C:Files (x86)FTCAPI.

Gallagher FTCAPI Folder

3.2 DUAL AUTHENTICATION ENHANCEMENT (OPTIONAL)

1. Install the supplied Gallagher Dual Authorisation Enhancement Integration Setup
8.XX.XX.msi.

5
Web: vixvizion.com Contact: [email protected]
 2. Open Device Software under Configure in Gallagher Configuration Client. Verify if
DualAuthEnhanced_v8.XX.XX is present.
3. Open Controller Properties, navigate to the Software tab, look for the Customisations
area.
4. Drag DualAuthEnhanced_v8.XX.XX item in step 2 to the Customisations area in step 3.
5. Follow further instructions and check if DualAuthEnhanced_v8.XX.XX is installed as in
the highlighted box below

Dual Auth Enhanced Installation

3.3 INSTALL IMAGUS SOFTWARE

Pre-requisite: Please ensure that IIS is enabled before installation.

1. Run the supplied Installation File, and the screen below will be displayed.
2. An SSD drive is required for the Imagus Software installation.
3. Click on the ‘Install’ button to start the installation process.
4. Different installed and data locations can be altered before hitting the install button, as
shown below.

6
Web: vixvizion.com Contact: [email protected]
 Copyright © 2022, by Vix Vizion Pty Ltd. All Rights Reserved.

Installation Locations

5. Click “Yes” when the popup “User Account Control” appears to continue the setup.

7
Web: vixvizion.com Contact: [email protected]
User Account Control Pop up

6. Wait for Installing progress.

8
Web: vixvizion.com Contact: [email protected]
 Copyright © 2022, by Vix Vizion Pty Ltd. All Rights Reserved.

Imagus Installation Progress

7. Click on the ‘Exit’ button when the installation is complete.

3.4 INSTALL IMAGUS GALLAGHER FTCAPI SERVICE

This is an a add on service that utilise Gallagher Controller Api to listen to the controller’s card
swipe and is started by Imagus Alert Service. This file has to be installed on the machine that
has Imagus Server installed.

Install the service using the provided file Imagus_Gallagher_FTCAPI_XX.X.X.0.exe. The installer
will notify with the successful screen when finish.

9
Web: vixvizion.com Contact: [email protected]
Imagus Gallagher FTCAPI install finished screen

10
Web: vixvizion.com Contact: [email protected]
 Copyright © 2022, by Vix Vizion Pty Ltd. All Rights Reserved.

4 CONFIGURATION
The configuration must start with setting up REST Client in Gallagher Configuration Client. Then
establish the connection to the REST API by configuring the Gallagher connection in the Imagus
Config app. Any other configurations can be done in any order.

4.1 CONFIGURE GALLAGHER REST CLIENT

Refer to the section Creating a REST API Client Item in Gallagher document User Guide
Command Centre Configuration Client for REST Client Configuration. The configuration for
Imagus looks like:

Gallagher REST Client Configuration

Important Notes: * Leave Client Certificate Thumprint input box empty if Client Certificates is
not required * Ensure “Enable REST API” is checked on the Web Services section on Server
Properties, accessed through File/Server Properties in Configuration Client. If Client Certificates
is not require, ensure “Enable REST clients with no client certificate” checked.

11
Web: vixvizion.com Contact: [email protected]
Enable REST Api in Gallagher

• Ensure the hilighted priviledges are applied for the REST operator as in Fig1 and Fig2

12
Web: vixvizion.com Contact: [email protected]
 Copyright © 2022, by Vix Vizion Pty Ltd. All Rights Reserved.

Fig1: View Priviledges

13
Web: vixvizion.com Contact: [email protected]
Fig2: Edit Priviledges

4.2 CONFIGURE EXTERNAL SYSTEM FOR CONTROLLER API

Imagus facial recognition requests are processed via Gallagher’s Controller API Interface. This
interface communicates with Command Centre Server through External System. Any door used
for facial authentication needs to have a matching External system Item configured as a reader.
The detailed configuration is described further in this section.

4.2.1 Create an External System Server

1. Click Configure from the menu bar, then External Systems. The External Systems Master
List Window opens (in the tree view).
2. Right-click and select New…External System Server. By default, the General tab
displays, give the server a name and appropriate Division and Operator.
3. On the Setup tab, enter the IP Address of Imagus Server in the Host Name field.

14
Web: vixvizion.com Contact: [email protected]
 Copyright © 2022, by Vix Vizion Pty Ltd. All Rights Reserved.

4. Click on “Import Certificate” and

• If Imagus system is installed on the same computer with Gallagher Command Centre,
navigate to C:Files (x86)FTCAPI to find the GallagherFTCAPI.pem file.
• Otherwise, copy GallagherFTCAPI.pem from the above location on the Middleware or
Imagus server to Gallagher Command Centre, and navigate to this file.
5. Click “Apply” to apply the change. Then click “Export Configuration” to export
GallagherFTCAPI.ini to the same folder. Click “Apply” to apply the change again. If
Imagus Server is on a different system, copy the export GallagherFTCAPI.ini to the same
Gallagher FTCAPI folder on that system.

Important note : The host for external system server must be in the same subnet with the
controller. ### Create an External System

Refer to the section Configuring an External System Step 1- 9 in Gallagher document User
Guide Command Centre Configuration Client to create external system.

Important note * The external system must have its Identity as IMAGUSES. A mismatch won’t
allow Imagus to communicate with Command Centre Server. * When changing the host ip
address in External System Server, set the Connections controller and server of this External
System to “-None selected-” and press OK to clear the old associated server data, then set it
back to the right server and controller.

15
Web: vixvizion.com Contact: [email protected]
External System

4.2.2 Create External System Items

Refer to the section Configuring an External System Step 1- 9 in Gallagher document User
Guide Command Centre Configuration Client to create an external system.

Important note Each external system item is used as a reader for a door. For each door used
for facial recognition, a separate external system item must be created and have its Identification
field exactly match the door name. Note that the external system item Name field can be any
name.

An example of configuration is as below, a door name “Foyer Door” is used as facial recognition.
Therefore External System Item 1 is created with Identification “Foyer Door”.

Fig3: External System Item

4.2.3 Configure External System Item as Door Reader

1. Open Door Properties
2. Select Entry Zone
3. On Reader(s) section, choose either first or second reader drop-down boxes and select
the external system item that has matching Identification with the door name.

16
Web: vixvizion.com Contact: [email protected]
 Copyright © 2022, by Vix Vizion Pty Ltd. All Rights Reserved.

From the example in Fig3, External System Item 1 is chosen as the second reader under the
Entry Zone Tab in Foyer Door Property.

External System Item Configured In Door

4.2.4 Configure Dual Authorisation for Door (Optional)

Use this step only if dual authentication is required for a door.

Important Note: Dual Authorization of the same cardholder’s credentials only work if Dual
Authorisation Enhancement is installed.

1. Access Dual Authorisation through Access Zone property.

17
Web: vixvizion.com Contact: [email protected]
Dual Authorisation for the same cardholder

2. The dual authorisation is enabled through the associated Schedules of the access zone.
To view the related Schedules, go to the Access Mode tab in Access Zone Property; Fig
4 shows the schedule by clicking on the “View Schedule” button.

18
Web: vixvizion.com Contact: [email protected]
 Copyright © 2022, by Vix Vizion Pty Ltd. All Rights Reserved.

Access Mode

19
Web: vixvizion.com Contact: [email protected]
Fig 4: Access Zone Schedule

4.2.5 Create Facial Card Type

A facial card type needs to be created for Imagus to generate a card for each cardholder while
doing a people database sync.

1. On Gallagher Configuration Client, open the Card Types window under Configure.
2. On the Card Type window, right-click on space to open the context menu. Select New ->
Card Type.
3. Give the card type a name in General Tab, for example, “Face Card”.
4. Fill all the details in the Setup tab as in Fig 5.

20
Web: vixvizion.com Contact: [email protected]
 Copyright © 2022, by Vix Vizion Pty Ltd. All Rights Reserved.

Fig 5: Card Type

4.3 CONFIGURE IMAGUS SYSTEM

The setup in Imagus System involves setting the connection to Gallagher REST client created
earlier, choosing a people sync frequency, and then setting up door camera associations. When
a face is recognised through a camera, it will send the facial authentication to request access
through the associated door.

4.3.1 Checking Imagus Licence

1. Open Imagus Config, and log in. The default login username is “admin” and the
password “Imagus123”.
2. Navigate to Licencing tab
3. If a licence is never attached, Copy host Id by clicking on “COPY HOST ID”, and the host
Id needed for licence is copied to clipboard. Contact VixVizion with this host id for a
licence file.
4. Once a licence file is obtain, click on “ATTACH LICENCE” to enable licensing for Imagus
software.

21
Web: vixvizion.com Contact: [email protected]
Imagus Licence Panel

4.3.2 Configure Gallagher Server in Imagus Config

Take a note of the Command Centre Server Ip Address, REST API port, API Key, and
Thumbprint if the Client Certificate is required for REST API.

1. Open Imagus Config, and log in. The default login username is “admin” and the
password “Imagus123”. Ensure all services are green in the System Health tab

22
Web: vixvizion.com Contact: [email protected]
 Copyright © 2022, by Vix Vizion Pty Ltd. All Rights Reserved.

Vix Vizion Login Panel

2. Navigate to the Access Control tab under the menu.

23
Web: vixvizion.com Contact: [email protected]
Imagus Access Control

3. Fill in the details of REST API Fields that were noted earlier

24
Web: vixvizion.com Contact: [email protected]
 Copyright © 2022, by Vix Vizion Pty Ltd. All Rights Reserved.

Gallagher Configuration in Imagus

4. Configure People Sync Job Frequency by hitting “Set Job Schedule” to choose other
timing options. By default, the frequency is set at 2:00 Am. More Sync options are
described in Synchronising Access Control Data.

5. Hit “SAVE CHANGES”. The REST connection will be tested and verified with Green tick

upon SAVE CHANGES. The link can be tested anytime by hitting the “TEST
CONNECTION” button.

Notes on People Sync:

• Imagus requires at least one face image for each cardholder. The first time syncing will
be at the next configured time or next restart of the services or can be instantly run using
the Scheduled Tasks tool in Imagus Web Config (detailed in 3.3.3)

25
Web: vixvizion.com Contact: [email protected]
 • Upon a successful connection, check back Configuration Client Event Viewer within a
minute to see if all External System Items are connected to Imagus.

Not Connected

Connected

4.3.3 Setup Cameras for Imagus

Refer to the provided document Imagus Face Recognition and Configuration guide, section
Setting up Video Source to setup Cameras for Imagus. If Imagus is successfully installed, the
guide can be accessed through the webpage:
https://localhost/imagus/docs/ImagusFR%20Docs/IMAGUS%20Face%20Recognition%20Installation%20and%20Confi
guration%20Guide.html

26
Web: vixvizion.com Contact: [email protected]
 Copyright © 2022, by Vix Vizion Pty Ltd. All Rights Reserved.

4.3.4 Setup Door Camera Associations

1. Navigate to the address https://*ImagusServerAddress*/imagus where
*ImagusServerAddress* is the IP address of the Imagus Server. The page might
require a login. The default login username is “admin”, and the password is
“Imagus123”.

Web Login

2. The Gallagher Doors are automatically populated on the page. Click on a door or search
in the highlighted box to show the door-camera detail section.

27
Web: vixvizion.com Contact: [email protected]
Door Camera Configuration in Web Config

3. If a door is chosen for facial recognition, add a camera to that door by clicking on the

camera button open camera adding panel.

28
Web: vixvizion.com Contact: [email protected]
 Copyright © 2022, by Vix Vizion Pty Ltd. All Rights Reserved.

Adding a Camera to a door

4. Choose the camera of interest from the drop-down box and give it a friendly name. Hit
submit to save the configuration.
5. Verify if the camera preview box with optional buttons to change the camera or remove
it.

29
Web: vixvizion.com Contact: [email protected]
Added Camera preview panel

4.3.5 Synchronising Access Control Data

All cardholders’ data are automatically synced to the Imagus people database. Each cardholder
requires at least one photo Id ideally to be a frontal pose. Imagus uses specific quality
measurements to reject any photo that doesn’t have a proper face suitable for verification.

The synch frequency can be configured through either Imagus Config App or the Web
Configuration page.

On Imagus Config App: Under the Access Control Tab, click on the Set Job Schedule button to
reveal the sync schedule.

30
Web: vixvizion.com Contact: [email protected]
 Copyright © 2022, by Vix Vizion Pty Ltd. All Rights Reserved.

Sync Settings in Imagus Config App

On Imagus Web Configuration Page:

1. Navigate to the address https://*ImagusServerAddress/imagus* where

*ImagusServerAddress* is the IP address of the Imagus Server. The page might
require a login. The default login username is “admin,” and the password is
“Imagus123”.

2. Navigate to Config Settings => Scheduled Task => Access Control People
Synchronisation.

31
Web: vixvizion.com Contact: [email protected]
Sync Setting in Imagus Web Config Page

3. Click on the button to choose either editing the sync frequency or to start
the sync job instantly.

32
Web: vixvizion.com Contact: [email protected]
 Copyright © 2022, by Vix Vizion Pty Ltd. All Rights Reserved.

4. To edit the frequency, click on Update Job as in Fig 5. To start the synching process
immediately, click on Start Job as in Fig 6.

Fig 5: Sync Settings Editor

Fig 6: Start Synch Job

A good indication of whether cardholders are synced to Imagus is checking if the People Tab
has all cardholders presented with the tag as ‘accesscontrol’ as highlighted in Fig 7

33
Web: vixvizion.com Contact: [email protected]
Fig 7: Synced cardholder in Imagus System

Inside Command Centre, the cardholder has a new Face Card added.

34
Web: vixvizion.com Contact: [email protected]
 Copyright © 2022, by Vix Vizion Pty Ltd. All Rights Reserved.

Face Card automatically added upon synching

35
Web: vixvizion.com Contact: [email protected]
5 TROUBLESHOOTING
1. External System Item are not connected
• Refer to Important Notes in the configure sections as the first troubleshooting step.

• Ensure the host for external system server must be in the same subnet with the
controller, in this case the server Ip address of Imagus Server.

• Verify if Imagus Gallagher FTCAPI service is installed by checking if there are files under
the path Program Files/Imagus/Gallagher Integration.

• Open Windows Defender Firewall with Advanced Security tool and navigate to Inbound
Rules, verify if ImagusGallagherFTCAPIService entry exists with the correct installed
path of the service under Program column as in Fig 8

Fig 8: Imagus Gallagher FTCAPI Firewall Inbound Rules entry

• Verify if the external system item’s Identification field exactly match the door name where
the external system item is configured as a reader

• Try to Restart Imagus.Alert.Service under System Health menu in Imagus Config Tool.

3. Door List doesn’t appear in Imagus Web config

• Ensure the REST Client Operator has the required privileges as set up in REST Server
section.
3. Synching doesn’t work
• Ensure the REST Client Operator has the required privileges as set up in REST Server
section.
4. Dual Authorisation doesn’t work
• Ensure the person belongs to the group where they are allow to the Access Zone that
has is configured for Dual Authorisation.

36
Web: vixvizion.com Contact: [email protected]