Overview

Integration of Genetec’s Security Center with IRIS+ offers a video analytics solution/ service whereby events of interest are detected through real-time analysis of multiple video sources and sent to Genetec’s Security Center. This guide outlines how to deploy and configure the integration of IRIS+ and Genetec Security Center View which Genetec Security Center versions are supported here: Supported Integrations

Configure Security Center

Enable Web-based SDK Role in the Security Center

Note: The following is no longer required for Genetec Security Center version 5.11 with VMS Gateway 2.0.0.164 or later. Starting with this version, .NET SDK is used for all required connections, using a single certificate.

• In Security Center, the Web SDK Role must be enabled for Genetec to interoperate with analytics. 
• To enable the Web-based SDK Role in Security Center:
  1. Open the Security Center Config Tool and log in
  2. Click the Home button
  3. Click the System icon
  4. Click the Roles icon within the System sub-screen:
  5. If the Web SDK Role is already defined, it will appear in the Roles list. If not: Click the + Add an entity button and select the ‘Web-based SDK’ from the list
  6. In the Entity name field, enter WebSDK
  7. Click the Next button
  8. Click the Create button
  9. Click Close. The new role appears in the roles list:



Verify Genetec Certificate

For new IRIS+ customers:

• IRIS+ certificate - Genetec part number: GSC-1SDK-AgentVi-innoVi certificate 

3 connections are required

For Genetec Security Center version 5.11 with VMS Gateway 2.0.0.164 or later, only a single connection is required

For customers migrating from savVi, who already have Genetec installed:

• savVi certificate - a limited number of connections (1 to 39). Genetec part number: GSC-1SDK-savVi. 

3 connections are required*

For Genetec Security Center version 5.11 with VMS Gateway 2.0.0.164 or later, only a single connection is required 

• savVi Site certificate – unlimited number of connections. Genetec part number: GSC-SDK-savViSITE. 

A single savVi SITE certificate is required 

Note: for displaying IRIS+ in Genetec Security Desk (see this link) – an additional Genetec Certificate is required.

Usage of the 3 connections: 

• One connection is consumed by the Genetec web SDK (used for VMS connectivity checks and to send events) 
• One connection is consumed by the Genetec .NET SDK to login and fetch the cameras list 
• One connection is consumed by the Genetec .NET SDK to send overlays to the VMS 

Open Genetec Security Center Config Tool, in the main menu, select About and select Certificates. Verify your deployment has an IRIS+ certificate or at least one savVi certificate. The following example shows 10 savVi certificates:

Enable Genetec Integration in IRIS+ Portal

Before you start

These steps assume that your IRIS+ account has been set up and that folders, devices, and cameras have been configured. If that is not the case, first access IRIS+ tutorials from the IRIS+ Support hub to configure your account. In IRIS+, a service account is required to later link Genetec to IRIS+, if the Core integration type is used (described in section 5.2). The IRIS+ service account provides a token, which is the identifier used to link the IRIS+ account to Genetec.

To generate an IRIS+ Service Account token, perform the following:

1. Browse to your IRIS+ account, Settings tab
2. Click the Users tab
3. Click the Add button, select Create service account
4. Enter a meaningful Service Account name such as “Customer 1”. Enter a description (optional)
5. Click Create service account
6. From the user's list, select the created Service Account user, click the arrow next to the Edit button and select Get Token
7. Define token expiration if required (by default token never expires)
8. Click Get token and copy and save the generated token (to be used in the IRIS+ VMS Gateway configuration in the next chapter):
9. Close the window

Download Integration Components

Identify the Genetec Security Center version installed at your deployment. Download files from:

Version 5.9

innovi-genetec-integration-for-version-5.9.zip Extract the following files: 1. Genetec SDK: Security_Center_v5.9.0.0_b167.90_SDK.exe 2. innoVi VMS Gateway Installer: innoVi_VMS_Gateway_Installer_2.0.0.112.exe Version 5.10

innovi-genetec-integration-for-version-5.10.zip Extract the following files: 1. Genetec SDK: Security_Center_v5.10.0.0_b357.0_SDK 2. innoVi VMS Gateway Installer: innoVi_VMS_Gateway_Installer_2.0.0.136.exe Version 5.11

innovi-genetec-integration-for-version-5.11.zip Extract the following files: 1. Genetec SDK: Security_Center_v5.11.0.0_b143.4_SDK 2. innoVi VMS Gateway Installer: innoVi_VMS_Gateway_Installer_2.0.0.164.exe

Embedded plugin installer

innovi-genetec-embedded-plugin-installer Extract the following file: 1. innoVi_Genetec_embedded_plugin_installer_1.0.0.15

Install Integration Components

Perform the following steps to install the downloaded integration components. The Genetec SDK and the IRIS+ VMS Gateway should be installed on a server able to connect to the Genetec VMS and to IRIS+ core API (either Irisity hosted or Customer hosted). This server can be either the Genetec VMS server or a dedicated separate server able to connect to the Genetec VMS.

Genetec SDK

Install the Genetec SDK: 

• For Genetec version 5.9: Run the file Security_Center_v5.9.0.0_b167.90_SDK.exe 
• For Genetec version 5.10: Run the file Security_Center_v5.10.0.0_b357.0_SDK.exe
• For Genetec version 5.11: Run the file Security_Center_v5.11.0.0_b143.4_SDK.exe

IRIS+ VMS Gateway

The IRIS+ VMS Gateway is a Windows service connecting IRIS+ to Genetec, transferring the IRIS+-generated events to Genetec. When installing the IRIS+ VMS gateway, or troubleshooting connectivity problems, it is important to understand that the gateway can be both a client and a server, as follows: The gateway is a client of the VMS server When Edge Integration is deployed, the gateway is a server to which IRIS+ edge devices, either customer-hosted or Irisity-hosted, connect to push analytics events and/or metadata to the gateway, via different ports. The gateway then delivers them to the VMS When installing the gateway and entering its configuration settings, or when opening ports in the firewall of the servers hosting the gateway and/or the VMS server, it is important not to confuse the different functions and client/server incoming/outgoing call direction of the various ports and URLs

IRIS+ VMS Gateway – for Genetec Security Center 5.9

Perform the following steps:

1. Install the IRIS+ VMS Gateway. If a previous version of the gateway is already installed, uninstall this version. Select the relevant installer for Genetec version 5.9. Run the IRIS+ VMS Gateway Installer file as administrator. Two options are available for the gateway to integrating with IRIS+:
   • Edge
     • Events and metadata for overlay are transferred from the IRIS+ Edge to Genetec
   • Core
     • Events are transferred from the IRIS+ core to Genetec
2. When the following window is displayed, populate the relevant fields:
   • VMS Settings (relevant for both Core and Edge integration options)
     • VMS Type - select Genetec Security Center 
     • Address - IP address of the Genetec VMS 
     • Port - Port to communicate with the Genetec VMS. The default port is 5001 
     • User - username to log in to the Genetec VMS  
     • Password - password to log in to the Genetec VMS 
     • Show Overlays (for Edge integration only) - define if overlays should be displayed for events shown in the Genetec client. Default is set to checked 
   • Integration Settings 
     • Events Integration Type – Select Edge or Core. The following screenshots show the displayed window following each Events Integration Type selection:

• IRIS+ URL
  • Edge - not applicable
  • Core - The default URL: (http://api.irisity.io) is for an Irisity-hosted deployment. For a customer-hosted deployment, replace this URL with the applicable URL assigned for your deployment
• IRIS+ Account Token
  • Edge - Not applicable 
  • Core - Paste the token you have generated in section 3 
• Events Integration Port – applicable only for Edge integration. This is the IRIS+ VMS Gateway port on the Windows server. The value is automatically populated with a default value and is editable
• Events Integration URL – applicable only for Edge integration. The URL field is read-only and cannot be updated. This is the IP address of the Windows server on which the IRIS+ VMS Gateway is being installed. The value of the URL is automatically populated. Keep the IP address to be used later when configuring an IRIS+ Integration Target
• Metadata Integration Port & Metadata Integration URL - Same as the Events fields above, used for overlays display

Click Next to proceed with the installation until finished

IRIS+ VMS Gateway – for Genetec Security Center 5.10 & 5.11

Health events are supported only in Genetec version 5.10 & 5.11.

Perform the following steps: 

1. Install the IRIS+ VMS Gateway. If a previous version of the gateway is already installed, uninstall this version. Select the relevant installer for Genetec version 5.10 or 5.11. Run the IRIS+ VMS Gateway Installer file as administrator. Two options are available for the gateway to integrate with IRIS+:
   • Edge Events and metadata for overlay are transferred from the IRIS+ Edge to Genetec
   • Core Events are transferred from the IRIS+ core to Genetec

When the following window is displayed, populate the relevant fields:

1. VMS Settings (relevant for both Core and Edge integration options)
   • VMS Type - select Genetec Security Center
   • Address - IP address of the Genetec VMS
   • Port - Port to communicate with the Genetec VMS. The default port is 5001
   • User - username to log in to the Genetec VMS
   • Password - password to log in to the Genetec VMS
   • Show Overlays (for Edge integration only) - define if overlays should be displayed for events shown in the Genetec client. Default is set to checked
2. Integration Settings Define the integration type: Core or Edge.
   • Core Receive analytics events from the core – Check to set
     • IRIS+ URL
       • The default URL (http://api.irisity.io) is for an Irisity-hosted deployment. For a customer-hosted deployment, replace this URL with the applicable URL assigned for your deployment
     • IRIS+ Account Token
       • Core - Paste the token you have generated in section 3
     • Receive health events from the core – Check to set Check any of the four available health events and set relevant Rule Ids:
       • New Error 
       • Close Error
       • New Warning
       • Close Warning
   • Edge
     • Receive analytics events and metadata from Edge device – Check to set
     • Events Port – this is the IRIS+ VMS Gateway port on the Windows server. The value is automatically populated with a default value and is editable
     • Events URL – the URL field is read-only and cannot be updated. This is the IP address of the Windows server on which the IRIS+ VMS Gateway is being installed. The value of the URL is automatically populated. Keep the IP address to be used later when configuring an IRIS+ Integration Target
     • Metadata Port & Metadata URL - Same as the Events fields above, used for overlays display
3. Click Apply to proceed with the installation until finished

IRIS+ VMS Gateway – Continued

If you are using a Genetec savVi certificate, follow these steps:

• Run services.msc to open the list of Windows services 
• Stop the innoVi VMS Gateway Service  
• In the folder C:\Program Files (x86)\AgentVi\innoVi\innoViVMSGateway\certificates : 
  • Remove the file innoViGateway.Service.exe.cert 
  • Rename the file innoViGateway.Service-savVi.exe.cert to innoViGateway.Service.exe.cert  
• Start the innoVi VMS Gateway Service 

Once the installation is complete, the service is started. The gateway service will then connect to the Genetec VMS to fetch the cameras list

Follow these steps to verify that the gateway service successfully communicates with the VMS:

• Wait one minute to allow the service to communicate with the VMS 
• Open the file:  "C:\Program Files (x86)\AgentVi\innoVi\innoViVMSGateway\logs\VMSAdapter.log".   See if it contains a list of camera names fetched from the VMS, or otherwise error notifications indicating a problem 
• Possible errors: 
  • Wrong details entered during the Gateway install (examples: IP, port number, credentials). To change any of the required parameters, refer to “Updating configuration parameters of the integration” section below 
  • Wrong or incomplete configuration of the VMS server (license, firewall, configuration, cameras not yet added, some VMS services are down, etc.) 
  • Connection is successful; however, a functional failure of the gateway occurs due to the refusal or failure of the VMS to correctly respond to the gateway. Verify the installed gateway Windows service has sufficient Windows permissions. If not, change the gateway service settings to log on as a Windows user with the necessary permissions. Restart the service and verify (in the VMSAdapter.log) the gateway service operates properly  

Restart IRIS+ VMS Gateway if one of the following changes occurs:

• A change in IRIS+ VMS Gateway settings 
• A change in the Genetec Security Center cameras list while the Core integration type is used 

Updating configuration parameters of the integration: 

If you want to change any of the integration parameters following the installation, there is no need to uninstall and reinstall the IRIS+ VMS Gateway. A dedicated utility is available to update the parameters. Run the utility from the shortcut here: C:\Program Files (x86)\AgentVi\innoVi\innoViVMSGateway\innoViGatewaySettings.

Genetec Embedded Plugin

Install the innoVi Genetec Embedded Plugin on any machine running Genetec Security Desk. Close Genetec Security Desk before installing the plugin. Run the file innoVi Genetec Embedded Plugin installer.

Customer Hosted Deployment - Ensure connectivity

If a specific workstation cannot reach the IRIS+ Portal, IRIS+ API, perform the following:

• Download the file innoVi.app.certs.zip from this link: https://tinyurl.com/y6skkttw 
• Load the certificates according to this article: https://www.ssl.com/how-to/install-supporting-certificates-for-email-client-authentication-and-document-signing-on-windows-10/ 
• To ensure the certificates were added successfully: 

Browse to the IRIS+ portal at IRIS+ Portal and ensure it is accessible 

Browse to the IRIS+ portal at IRIS+ Portal and ensure you get the following response:  {"code":0,"key":"2.1.xxxx","data":"Navigate to /doc/ for API documentation"} 

Define Edge Integrations in IRIS+

The Edge Integrations in IRIS+ are the IRIS+ Edge-specific definitions required for IRIS+ to integrate with Genetec. The Integration Targets in IRIS+ are the system-wide definitions required for IRIS+ to integrate with Genetec. You will define the endpoints that can receive the events and metadata sent by the IRIS+ Edge.

To define the Integration Targets in IRIS+, do the following:

1. Log in to your IRIS+ account.
2. From the top module bar, select Settings.
3. Select Integration Targets.
4. Click the Add button. The Integration Target screen appears.
5. Define the two integration targets as follows:
   • Event Integration Define the following:
     1. Target name: Define a meaningful name such as Genetec Events
     2. Ensure the toggle switch is Enabled
     3. Type: Keep default values HTTP and POST
     4. URI: Paste the URI of the Events Integration URI field in the IRIS+ VMS Gateway Installer If the gateway and the edge devices are NOT on the same LAN, then you should replace the internal IP in the URI with the public IP of the gateway’s computer. Find the public IP by searching for a publicly available website with a free service providing this information. The public IP address should be forwarded on the local firewall to the local gateway IP on port 8098.
     5. Click Save. The integration Target is defined and is listed in the Integration Targets list
   • Metadata Integration (for overlay display in Genetec) Define the following
     1. Target name: Define a meaningful name such as Genetec Overlay
     2. Ensure the toggle switch is Enabled
     3. Type: Change to WS and GET
     4. URI: Paste the URI of the Metadata Integration URI field in the IRIS+ VMS Gateway Installer If the gateway and the edge devices are NOT on the same LAN, then you should replace the internal IP in the URI with the public IP of the gateway’s computer. That IP can be found by searching "What is my IP" in Google. The public IP address should be forwarded on the local firewall to the local gateway IP on port 8099.
     5. Click Save. The integration Target is defined and is listed in the Integration Targets list

Perform the following for each IRIS+ Edge you want to integrate with Genetec. To define the Edge Integration in IRIS+, do the following:

1. Log in to your IRIS+ account
2. Select Physical View
3. Select the IRIS+ Edge for which you want to define the integration
4. Select Integrations
5. Click Edit
6. Enable Events Integration and select the relevant Integration Target you have previously defined (in this example – Genetec Events)
7. Enable Metadata Integration and select the relevant Integration Target you have previously defined (in this example – Genetec Overlay)
8. Click Save

Synchronize Genetec Server Time to IRIS+ Edge Time

Before you start IRIS+ supports time sync to the IRIS+ Edge device time. The IRIS+ device and the Genetec server time definitions must therefore be synchronized. Verify that the NTP (Network Time protocols) are synchronized.

To Verify that the Genetec Server time is synchronized to IRIS+ Edge device time, do the following:

1. Open Windows Date and Time panel and select Internet Time
2. Click the Change Settings button
3. Ensure the synchronization checkbox is enabled.



Map Cameras in Genetec to IRIS+

Cameras in Genetec Security Center are set up with two identifiers: camera name and GUID. For IRIS+ to recognize the cameras in Genetec Security Center, the IRIS+ VMS Gateway extracts the cameras’ names and GUIDs to the following file: C:\Program Files (x86)\AgentVI\innoVi\innoViVMSGateway\GenetecCameras.ini Here is an example of the output file (2 cameras):

• AXIS Q7436=00000001-0000-babe-0000-accc8e3e4e5b
• AXIS Q7436=00000001-0000-babe-0000-accc8e3e4e5d

Perform the following in IRIS+:

For each camera requiring analytics, define the camera in IRIS+ including the specific video URL for this camera, and populate the External ID (as displayed in the following window) with the relevant Genetec camera GUID:

Manually set resolution for overlay - non-vendor "generic" RTSP cameras

The problem:

To compute pixel coordinates of overlay rectangles in Genetec, the gateway must know the camera’s resolution. However, in the case of generic RTSP streams, the Genetec SDK does not provide resolution information. A “Generic Stream” in Genetec is a Video Unit for which the camera vendor is not specified, only the RTSP URL to stream is provided. In such case, in the Genetec Config Tool, in the Video Unit’s properties, the “Manufacturer:“ field shows “Generic Stream” instead of “Pelco”, Axis” etc.

The solution:

• Manually provide the gateway with the resolution of the stream. 
• In C:\Program Files (x86)\AgentVi\innoVi\innoViVMSGateway, open the GenetecCameras.ini and the GenetecManualResolutions.ini files.
• Perform the following steps for each “Generic Stream” camera:
  1. In the Genetec config tool à Tasks à Video à Archiver, expand to see the list of video units
  2. Select the “Generic Stream” camera
  3. Select the unit’s video camera
  4. Click the video preview to start the preview video streaming. Wait for the streaming to start
  5. Click on the “i” (information) icon to read the stream’s resolution (width X height measured in pixels)In the GenetecCameras.ini file, find the camera by its name (the part before the “=” delimiter) and copy its Genetec camera ID (the part after the “=” delimiter)
  6. In the file GenetecManualResolutions.ini, in the [Resolutions] section, add a new line in the format cameraID=widthXheight, using the copied camera ID from item 6 above and the width and height values from item 5 above
• Save the updated GenetecManualResolutions.ini file.
• Restart the IRIS+ VMS Gateway service
• Example of GenetecManualResolutions.ini file: [Resolutions] 00000001-0000-babe-0008-72e790ef7b2a=2592X1944 00000001-0000-babe-0008-4d389b647f06=1920X1080 00000001-0000-babe-0008-4a2f4fb804d0=1920x1080

Note: To view RTSP generic streaming in IRIS+ portal, enable UDP Support when you add a specific video URL for this camera.

Trigger Real-Time Detection Alarms in Security Center

To enable alarms to be received in Genetec Security Desk:

• Define a Genetec Custom Event for each IRIS+ detection rule type you are deploying in your environment. For example, if you are implementing Moving in an Area and Crossing a Line rule types, define two Genetec Custom Events, each corresponding to a rule type. It does not matter if the rule type is configured on a single or multiple IRIS+ sensors; in both cases, it is sufficient to define one Custom Event for this rule type. 
• For Genetec Security Center 5.10: Define custom events for the four available health events 
• Define a Genetec Alarm for each IRIS+ rule type that you are deploying in your environment. Following the above example, you need to define two alarms 
• Define Genetec Actions that cause each of the defined Custom Events to trigger its corresponding Alarm 

In the steps below, a single detection rule type Person Moving is used as an example. This process must be repeated for each rule type you implement.

To define a Custom Event:

1. Log in to the Security Center Config Tool 
2. Select Tasks from the main menu 
3. Select System 
4. Select General Settings 
5. Select Events > Custom events 
6. To Add an item: click the '+' sign (circled red in the above screen)
7. When prompted with the Create dialog, define a meaningful name for the event that corresponds to the rule type. Also, capture the Custom Event ID ('Value' field) since you need to use this ID in IRIS+ rule settings. In this example, the value is 777 (can be set automatically by the application or defined by the user)
8. Click Save and Apply.
9. For Genetec Security Center version 5.10: Health events defined in the config tool:

To define an Alarm:

1. Select Tasks from the main menu 
2. Select Alarms  
3. Add a new alarm (click the + Alarm icon) 
4. Enter the alarm name. Provide a meaningful name, e.g., Moving Person detected, as it is later shown in Genetec Security Desk when the alarm is received 
5. Click Apply
6. Select recipient(s) for the alarm: add the Security Center's user (the login username) and click Apply
7. At the top bar, select Properties
8. In the Video Display option field, select Live and Playback
9. In the Play field, select 4 seconds
10. For Genetec Security Center version 5.10: Alarms defined in the config tool:

To link the Custom Event to an Alarm:

1. Select System -> General Settings 
2. Select Actions and click the + below the Actions table to add an item. The Actions wizard pops up: 
3. In the first line of the window above (“When:” “occurs”): open the list - all Events will be listed. Find the previously added Custom Event and select it
4. In the Action list, select Trigger Alarm
5. Open the Alarms list and select the alarm defined earlier for the selected event
6. Click Save to save the configuration changes

Link IRIS+ and Genetec Security Center Events

To link IRIS+ analytics events with Genetec Security Center Custom Event, select the Rules tab for the relevant camera and define the same value for External ID as the Custom Event ID value which you defined in Genetec Security Center. In our example, this value is 777.

• Click Save to save the input. 

View Alarms in Genetec Security Desk

This section shows how to view event alarms in Genetec Security Desk.

To view Alarms

1. Log in to Security Desk 
2. Access Tasks > Operation > Alarm Monitoring to see the alarms list, and below it, the events from the related cameras 

To view alarm overlays

1. The user has to have the privilege called “Display video overlays”; it is enabled by default for admin users. For regular users: log in to “Config Tool” application à User Management and verify that “Display video overlays” is enabled.
2. Click the Security Desk tab in the Security Desk application; choose “Options” and then “Visual” à “Display overlay video controls” option has to be enabled.
3. Click “Video” “Default Options” and verify “Show overlays” is “ON”
4. In the Live video display, right-click Camera Overlays and verify it is enabled.

Display IRIS+ in Genetec Security Desk

• Once the IRIS+ Genetec Embedded Plugin is installed, an IRIS+ icon is added to the Genetec Security Desk home screen: 
• Click the IRIS+ icon. A login window is displayed in a new tab. Log in to IRIS+ using your credentials. The default URI is https://portal.irisity.io. If the first login fails, a URI field pops up. Update the URI to match your deployment. The updated URI is saved.
• IRIS+ portal is now available:

Troubleshooting

• The logs for the innoVi VMS Gateway Service are available as follows: 
  • Installer log name: “innoViVMSGatewayInstall.log” 
  • Installer log path: “C:\innoVi\logs”. 
  • IRIS+ VMS Gateway Service logs path: “C:\Program Files (x86)\AgentVI\innoVi\innoViVMSGateway\logs”. 
• Irisity Customer Support may ask for these logs for further troubleshooting. 
• To troubleshoot events properly created in IRIS+ and transferred to Genetec, you can add a clip to both IRIS+ and Genetec, simulating events. 
• If the Genetec server is down or the Web SDK role is either deactivated or does not exist, the service log will show the following message: DATE & TIME [145] ERROR BaseVideoPlugin.VideoPlugin - VMS 1 is disconnected. IRIS+ side is not aware of the specific failure reason. You will need to investigate the Genetec side to find out the actual reason for the disconnect. 
• If you want to uninstall the IRIS+ VMS Gateway and reinstall it again, stop the IRIS+VMS Gateway service before uninstalling.

Contact Irisity Support

E-mail: success@irisity.com

Phone: +46 771 41 11 00