IRIS+™ VMS Gateway Integration Guide - Integrations (2024)

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

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 the necessary connections, using a single certificate.

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:

3 connections are required

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

3 connections are required*

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

A single savVi SITE certificate is required

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

Usage of the 3 connections:

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:

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 the IRIS+™ account, 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.

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

IRIS+ Genetec-integration-for-version-5.11.zip

Extract the following files:

IRIS+ Genetec-integration-for version.5.12.zip

Extract the following files:

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 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.

Install the Genetec SDK:

The IRIS+™ VMS Gateway is a Windows service connecting the 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 IRIS+™ VMS gateway can be both a client and a server, as follows: The IRIS+™ VMS gateway is a client of the Genetec VMS server When Edge Integration is deployed, the IRIS+™ VMS gateway is a server to which IRIS+™ Edge Device/s, either Customer-Hosted or Irisity-Hosted, connect to push analytics events and/or metadata to the IRIS+™ VMS gateway, via different ports. The IRIS+™ VMS gateway then delivers them to the Genetec VMS. When installing the IRIS+™ VMS gateway and entering its configuration settings, or when opening ports in the firewall of the servers hosting the IRIS+™ VMS 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

Health events are supported only in Genetec version 5.11 & 5.12

Perform the following steps:

Install the IRIS+™ VMS gateway. If a previous IRIS+™ VMS Gateway version is already installed, uninstall it. Select the relevant installer for the Genetec version 5.11 or 5.12. Run the IRIS+™ VMS gateway Installer file as administrator. Two options are available for the IRIS+™ VMS gateway to integrate with the IRIS+™ application:

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

VMS Settings (relevant for both Core and Edge integration options)

Example:

Integration Settings Define the integration type: Core or Edge.

Core IntegrationReceive 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, the default URL is (http://api.irisplus.app)

IRIS+™ Account Token

Core - Paste the token you have generated above

Receive health events from the core

Check to set Check any of the four available health events and set relevant Rule IDs:

Example:



Edge Integration

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 overlay display

Click Next to proceed with the installation until finished.

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

4. Start the IRIS+ 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 camera list

Follow these steps to verify that the IRIS+™ VMS 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)\Irisity AB\IRIS+ VMS Gateway\logs\VMSGateway.Service_xxxxx_part".See if it contains a list of camera names fetched from the VMS, or otherwise error notifications indicating a problem

Example:

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

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 on the desktop of the machine you installed the IRIS+™ VMS Gateway:

It will open the settings of the IRIS+™ VMS Gateway service for updates, correct or change the settings as required, and click "Apply" for the settings to take effect.

Install the IRIS+ Genetec embedded plugin on any machine running the Genetec Security Desk. Close the Genetec Security Desk before installing the plugin.



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:

3. Select Integration Targets.

4. Click the Add button. The Integration Target screen appears.

5. Define the two integration targets as follows:

6. Event Integration Define the following:

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.

7. Click Save. The integration Target is defined and is listed in the Integration Targets list

8. Metadata Integration (for overlay display in Genetec) Define the following

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.

9. 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:

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 previously

defined (in this example – Genetec Events)

7. Enable Metadata Integration and select the relevant Integration Target you previously

defined (in this example – Genetec Overlay)

8. Click Save

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:



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)\Irisity AB\IRIS+ VMS Gateway\GenetecCameras.ini Here is an example of the output file (3 cameras):

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:

The problem:

To compute pixel coordinates of overlay rectangles in Genetec, the IRIS+™ VMS 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:

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

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.

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 the 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.

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 6 seconds

10. In the Content cycling 12 seconds

11. Click Apply

To link IRIS+™ analytics events with Genetec Security Center Custom Event, select the Rules tab for the relevant camera and define the same value (777) for the External ID of the rule in IRIS+.

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