Home/Support/Tools/SAFR Genetec Relay/SAFR Genetec Api Integration Guide

1 Introduction

1.1 Introduction

SAFR Genetec API Integration enables SAFR to interoperate with Genetec Security Center (GSC) by inserting events and bookmarks for person or actions events in SAFR into GSC or issuing an Access Granted API call to Genetec Synergis using Cloudlink. Generated events can be used for monitoring or invoking Genetec Actions. Bookmarks inserted by SAFR enable search on archived videos. Access can be granted for virtual or physical doors. These capabilities greatly enhance a Genetec operator's ability to focus on the important activities impacting security.

Events and bookmarks generated by SAFR include person attributes such as date and time, location, person type (e.g. staff, visitor, etc.), id class (known, threat, concern, stranger) and person name. This information can be used in event to action rules in Genetec or for purposes of searching video archives.

Access granted events are issued by sending the recognized cardholder credentials to the panel and associated the active grant with the door associated with the camera.

This guide covers the installation and configuration of the SAFR Relay application only. For complete SAFR and SAFR SCAN documentation please visit http://docs.real.com.

1.2 Downloads

Download the following files required by SAFR – Genetec API Integration.

SAFR – Genetec API Integration is built with the following python script and supporting files. These are not required. They are provided only if you wish to extend the integration. These files are provided as-is with no support.

1.3 SAFR Genetec API Integration vs. SAFR Genetec SDK Integration

SAFR offers two integrations with the Genetec Security Center

  • SAFR Genetec Security Center SDK Integration
    • Uses Genetec SDK to facilitate SAFR Video Gateway on Windows computers to integrate with Genetec Security Center in the following ways:
      • List and select cameras in Genetec
      • Generate events
      • Insert Bookmarks into archived video
      • Insert overlays into live and archived video
    • This integration only works with 3rd party cameras. It cannot be used with SAFR SCAN or SAFR Camera.
  • SAFR Genetec
    • Uses Genetec WebAPI to facilitate SAFR Video Gateway on Windows or Linux, SAFR Camera, or SAFR SCAN to integrate with Genetec Security Center in the following ways:
      • Generate events
      • Insert Bookmarks into archived video
      • Issue Access Granted commands to Genetec Synergis
    • This integration does not offer the convenience of listing and selecting Genetec cameras (linkage is performed via configuration file) and does not add overlays to video in Genetec.

SAFR also develops an integration to Genetec Synergis for importing persons and credentials into SAFR. This integration is complementary and can be used in conjunction with either of the SAFR VMS integrations.

1.4 Integration Overview and Requirements

A typical deployment requires the following:

  • A machine running Genetec Security Center.
  • A machine running Genetec Security Desk and Genetec Config Tool.
  • Genetec Cloudlink if access granted from camera is required
  • One or more of the following:
    • Machines running the SAFR Video Gateway to process videos.
    • SAFR Camera
    • SAFR SCAN
  • If you’re doing a SAFR on-premises deployment, you’ll also need a machine running SAFR Server. SAFR Server can run on the same machine as one of the Desktop Clients, provided the host machine meets the system requirements.

Diagram of a software security center

Description automatically generated

Video streams from 3rd Party cameras are connected to the Genetec Security Center and to SAFR Video Gateway. Video from 3rd party cameras processed by SAFR is a resource intensive activity and may requires one or more servers. Once processed, SAFR sends events, bookmarks to Genetec.

Video streams from SAFR Camera or SAFR SCAN are connected to Genetec Security Center for monitoring and archiving. SAFR Camera and SAFR SCAN are also connected to SAFR Server to deliver events which are associated with the correct Genetec video stream and used to send events and bookmarks to Genetec.

SAFR Desktop is also used to perform various management activities.

1.4.1 System Requirements

Genetec has the following system requirements:

  • One machine running Genetec Security Center Version 5.7 or later.
  • One machine running Genetec Security Desk and Genetec Config Tool.
  • Genetec Cloudlink if access is granted from cameras
  • Each machine running a Genetec product must meet the following system requirements:

SAFR has the following system requirements:

  • Each machine running the SAFR Desktop Client must meet the following requirements:
    • SAFR Software version 3.6 or later.
    • Windows or Linux (See SAFR System requirements for versions)
    • Processor or VM with at least 4 CPU Cores
    • 12 GB RAM
    • 300 GB Storage
    • If processing 3rd party cameras additional resources system requirements as described on the SAFR system requirements page.

1.5 Licensing

1.5.1 Genetec Licensing

SAFR Genetec Security Center API Integration requires 1 x GSC-1SDk-RealN-FR license per camera or SCAN devices connected in Genetec. This license should be requested from Genetec.

This Genetec part number must be added to your Genetec connection license and that license reapplied.

The GSC-1SDk-RealN-FR license is independent of Genetec camera licenses. You will also need a Genetec device license for each camera connected.

Genetec Synergies licenser required for access control.

1.5.2 SAFR Licensing

SAFR Camera SC800 and SCAN devices already come with licenses. Therefore, no additional licenses are required per device. A SAFR Server license/account will be required to install SAFR Platform. Please request it from your SAFR local team.

SAFR requires additional licenses for 3rd party cameras. Please request information about licensing of 3rd party cameras from your SAFR local team.

1.6 Install and Configure the Genetec Security Center

  1. Download the latest version of Genetec Security Center from the Genetec Portal.
  2. Run the installer. For details about which install options to select, see the Security Center Installation and Upgrade Guide.

1.7 Install and Configure SAFR Software

Review SAFR documentation at http://docs.real.com for information on installing and licensing SAFR Software.