Immix

20 min

Overview

IRIS+™ is Irisity's AI-powered, open-architecture video analytics solution for security, safety, and business intelligence applications. IRIS+ eliminates the need for continuous monitoring of surveillance cameras and helps customers uncover otherwise hidden events, insights, and information. It automatically alerts you to security and safety incidents in real time, drawing your attention to an incident of interest and enabling effective responses, as events unfold. The integration aims to receive and view IRIS+™ detected events or health events in the integrated system. This guide serves as a reference point for the successful integration of IRIS+™ with Immix. The integration process requires steps to be performed in both the Immix system environment and in the IRIS+™ Portal.

IRIS+™ Immix Integration Workflow

We are ready to start integrating your IRIS+™ account into your existing Immix deployment. The following serves as a high-level workflow explaining the main steps to set up the integration.

Prepare Your Immix Environment for Integration To monitor IRIS+™ folders and the detected events or health events created by these folders, you will need to create a corresponding site in Immix. Additionally, an IRIS+™ device must specify the origin point of IRIS+™ events.
Define Integration Target in IRIS+™ The Integration Targets in IRIS+™ are the system-wide definitions required for IRIS+™ to integrate with your system. You will define the endpoint that can receive the events sent by IRIS+™.
Define Integration Actions in IRIS+™ Integration actions are folder-specific actions in IRIS+™ These actions define what type of events are sent to the integrated system - whether it is detected events showing the video clip of a breached rule or health events alerting to health issues for cameras or devices. The folders to be selected are those that hold the cameras and devices that you intend to monitor.
Identify IRIS+™ Folders The IRIS+™ folders that you intend to monitor must be defined by a unique ID. These folders have corresponding sites in Immix and the unique ID is the S' number you documented for each of the sites.
Identify IRIS+™ Camera The IRIS+™ cameras that you intend to monitor can be defined by a unique ID. This may be required for the event created from this camera to be associated with the correct camera in Immix.
Test the Integration An integration test is a way to ensure that events for monitored folders are being received by the integrated system. When creating a test rule or test events, make sure you choose cameras under the monitored folder.
To learn more about event naming format, refer to Event Format in the Immix chapter.

Prepare Your Immix Environment for Integration

Before you start

To monitor IRIS+™ folders and the detected events or health events created by these folders, you will need to create a corresponding site in Immix. Additionally, an IRIS+™ device must specify the origin point of IRIS+™ events.

To prepare your Immix environment for integration with IRIS+™, do the following:

Port setup: port 465 or 587 should be open in the Immix firewall. As the Irisity-hosted solution is based on Google Cloud, these are the only ports supported by Google. Keep these ports open for IRIS+™ incoming events
In Immix Setup, select Add a Site and fill in the relevant details. Perform this step for each of the IRIS+™ sites you would like to monitor. You can also edit an already existing site.
Add a device for IRIS+™ with the following details: Enter a meaningful Service Account name such as “Customer 1”. Enter a description (optional)
- Device Type: IRIS+™
- IP/Host: 34.90.111.200 (this is the IP address of the IRIS+™ hosted service)
- Port: leave empty
For each of the sites you have created, locate and document the relevant unique system number (S' Number):
- At the end of the site setup process, select View Summary. The Setup Report appears
- Write down and keep the Identifier (S' Number). In this example, the identifier to keep is 599

Define Integration Target in IRIS+™

Before you start

The Integration Targets in IRIS+™ are the system-wide definitions required for IRIS+™ to integrate with your system. You will define the endpoint that can receive the events sent by IRIS+™.

To define the Integration Target in IRIS+™, do the following:

Log in to your IRIS+™ account
From the top module bar, select Settings
Select Integration Targets
Click the Add button. The Integration Target screen appears
Define the following:
- Target name: Define a meaningful name such as Immix
- Ensure the toggle switch is Enabled
- Type: Select Immix
- Host/Port: Enter the Host IP in the first field and the Port number in the second field
- Credentials: These are not required as the alarms to Immix use NoAuth (Immix accepts these based on the IP whitelist and trusted domains @immixalarms.com)
Click Save. The integration Target is defined and is listed in the Integration targets list

Define Integration Actions in IRIS+™

Before you start

Integration actions are folder-specific actions in IRIS+™. These actions define what type of events are sent to the integrated system - whether it is detected events showing the video clip of a breached rule or health events alerting to health issues for camera or edge devices. The folders to be selected are those that hold the cameras and edge devices that you intend to monitor.

To define the integration action in IRIS+™, do the following:

Select the Administrator module
In the hierarchy tree, select the relevant folder, which holds the cameras you are monitoring (remember you prepared a corresponding site in Immix for this folder)
From the menu bar, select Integrations and click the Add button. A new Integration Action line entry appears
Expand the new integration action by clicking the arrow and define the following:
- Action Name: Enter a meaningful name such as the type of events being monitored
- Ensure the toggle switch is Enabled
- Type: Select whether to integrate a Detection event or a Health event
- Target: Select the relevant Integration Target that you previously created
Click save

Identify IRIS+™ Folders

Before you start

The IRIS+™ folders that you intend to monitor must be defined by a unique ID. These folders have corresponding sites in Immix and the unique ID is the S' number you documented for each of the sites.

To identify the IRIS+™ folders, do the following:

Open the Windows Date and Time panel and select Internet Time
Click the Change Settings button
From the menu bar, select Settings
Click the Edit button
In the External ID field, enter the S' number you documented in Immix for the corresponding site. In our example – it is 599
Click save

Identify IRIS+™ Cameras

Before you start

Each IRIS+™ camera may be defined by a unique ID. This may be required for the event created from this camera to be associated with the correct camera in Immix.

To identify the IRIS+™ cameras, do the following

Select the Administrator module
In the hierarchy tree, select the folder you are planning to monitor
Select the relevant camera
Click Edit
In the External ID field, enter the relevant Immix Camera unique ID
Click Save

Test the Integration

Before you start

An integration test is a way to ensure that events for monitored folders are being received by the integrated system. When creating a test rule or test events, make sure you choose cameras under the monitored folder.

To test the integration for detected events, do the following

As per the IRIS+™ training instructions, define a test rule for a camera in each of the monitored folders
Ensure that events are created in IRIS+™ under the Monitor module
Open your integrated environment and ensure that the same events have also been received

Event Format in Immix

The following sections list the IRIS+™ event status and the corresponding status that appears in Immix for both detected events and health events.

Detection Events Format

IRIS+ Status	Immix Status
INNOVI_UNKNOWNS	ObjectDetected
INNOVI_UNKNOWNS_UNKNOWN	ObjectDetected
INNOVI_UNKNOWNS_VEGETATION	ObjectDetected
INNOVI_UNKNOWNS_CLOUD	ObjectDetected
INNOVI_UNKNOWNS_OBJECT	ObjectDetected
INNOVI_PEOPLE	PersonDetected
INNOVI_PEOPLE_PERSON_STANDING	PersonDetected
INNOVI_PEOPLE_PERSON_ON_THE_GROUND	PersonDetected
INNOVI_PEOPLE_PERSON_OVERHEAD	PersonDetected
INNOVI_VEHICLE	VehicleDetected
INNOVI_VEHICLE_CAR	VehicleDetected
INNOVI_VEHICLE_CAR_COMPACT	VehicleDetected
INNOVI_VEHICLE_CAR_SUV	VehicleDetected
INNOVI_VEHICLE_BUS	VehicleDetected
INNOVI_VEHICLE_SCHOOL_BUS	VehicleDetected
INNOVI_VEHICLE_MINI_BUS	VehicleDetected
INNOVI_VEHICLE_CITY_BUS	VehicleDetected
INNOVI_VEHICLE_PICKUP_TRUCK	VehicleDetected
INNOVI_VEHICLE_VAN	VehicleDetected
INNOVI_VEHICLE_TRUCK	VehicleDetected
INNOVI_VEHICLE_TRUCK_SMALL	VehicleDetected
INNOVI_VEHICLE_TRUCK_MEDIUM	VehicleDetected
INNOVI_VEHICLE_TRUCK_SEMITRAILER	VehicleDetected
INNOVI_VEHICLE_TRACTOR	VehicleDetected
INNOVI_VEHICLE_NIGHT	VehicleDetected

Health Event Format

Cameras

Status is: "TamperAlarm" - in blocked/saturated/dark, or "VideoLoss" in all other health events The description is one of: "Frame rate is too low (IRIS+™ camera ID nnnnnn)" "Frame rate is too high (IRIS+™ camera ID nnnnnn)" "Scene is blocked (IRIS+™ camera ID nnnnnn)" "Scene is saturated (IRIS+™ camera ID nnnnnn)" "Scene is too dark (IRIS+™ camera ID nnnnnn)" "Communication failed (IRIS+™ camera ID nnnnnn)" "General error (IRIS+™ camera ID nnnnnn)" "RTSP error (IRIS+™ camera ID nnnnnn)" "Incompatible video (IRIS+™ camera ID nnnnnn)" "Resolution error (IRIS+™ camera ID nnnnnn)"

Edge devices

Status is: "SystemEvent"

The description is one of:

"High latency (IRIS+™ Edge ID nnnnnn)"

"Overloaded (IRIS+™ Edge ID nnnnnn)"

"No comm. with cloud (IRIS+™ Edge ID nnnnnn)"

IRIS+™ (Edge software handling multiple cameras)

Status is: "SystemEvent"

The description is one of:

"No comm. with cloud (IRIS+™ Agent ID nnnnnn)"

"High latency (IRIS+™ Agent ID nnnnnn)"

Contact Irisity Support

Customer Support: [email protected]