Skip to content

Milestone XProtect Integration

Milestone XProtect is one of the most popular Video Management Systems. IRIS+ Professional is able to send alarms to this system so you can manage incidents in your well-known platform.

Mobotix HUB

This guide in its entirety is also applicable to the Mobotix HUB software solution - simply follow the steps laid down below, as you would with Milestone XProtect.

Consult the following table for the different feature sets of Milestone XProtect editions:

XProtect Edition / Feature [Alarm Manager] [E-mail notification] Recording on Alarm
Corporate ✓ ✓ ✓
Expert ✓ ✓ ✓
Professional+ ✓ ✓ ✓
Express+ ✓ ✓ ✓

The Essential+ edition does not have alarm functionality, therefore it is not supported by IRIS+ Professional.

Tested versions

This guide has been tested on the following editions:

  • Milestone XProtect 2021 R2
  • Milestone XProtect 2022 R3
  • Milestone XProtect 2024 R1

Before you start

In this guide it is assumed that Milestone XProtect is installed on a computer in your network and you know how to configure it when using it without IRIS+ Professional. For further details, please visit the official site of Milestone.

Requirements:

  • Cameras are reachable from both IRIS+ Professional and Milestone XProtect, and IRIS+ Professional is able to connect to Milestone XProtect.
  • Please make sure that each camera you intend to use in IRIS+ Professional is also registered in Milestone XProtect, as described in the [Milestone documentation here].
  • You have administrator privileges on the device running Milestone XProtect (both for Microsoft Windows and within Milestone XProtect).

Milestone XProtect configuration

User

IRIS+ Professional requires access to Milestone XProtect, therefore a new user should be created with administrator privileges.

  1. In the Milestone XProtect Management Client, go to the Site Navigation panel Security Roles.

  2. Click on Administrators in the Roles panel.

  1. Find the Users and Groups tab at the bottom of the Role Settings panel. Click the Add... dropdown and select the Basic user option.

  1. In the Select Basic Users to add to Role pop-up, click the New button.

  2. A new pop-up appears. Fill in the form with new user credentials and click OK. Use a complex password with capital and small letters, numbers and special characters.

  3. Add this basic user to the Administrators by clicking OK.

Event

  1. In the Milestone XProtect Management Client, open Tools in the upper menu bar Options select the Analytics Events tab.

Under Analytics events, tick the box beside Enabled then press OK.

  1. In the Site Navigation panel, go to Rules and Events Analytics Events.

  2. Right click on the Analytics Events panel Add new.

  1. Set a name for the Event.

  2. Click the Save button in the top left corner.

Recording Rule

If your system is not recording continuously, it is recommended to start recording on each triggered alarm. A Rule should be created for this purpose.

If your system has a custom recording logic, you can skip this step.

  1. In the Milestone XProtect Management Client, go to the Site Navigation panel Rules and Events Rules.

  2. Right-click on the Rules panel Add Rule

  1. Set any Name.

  2. As the Type of rule, select Perform action on event. Click on the blue underlined "event" word in the lower panel.

  1. In the pop-up, select Events Analytics Events select the Analytics Event you created before. Click OK.

  1. Click on the blue underlined "devices/..." line in the lower panel (after "from").

  1. In the pop-up, select Cameras All cameras. Click the Add button. Click OK.

  1. Click Next.

  2. Skip the Conditions Step (2). Click Next again.

  3. In the Actions Step (3) select Start recording on devices. Click on the blue underlined "recording device" words in the lower panel.

  1. In the pop-up, select Use devices from metadata. Click OK.

  1. The recording will start immediately on alarm. You can set other (even negative) values by clicking on the blue underlined "immediately" word in the lower panel.

  2. Click the Next button.

  3. In the Stop Criteria (4) step, select Perform stop action after time. Click the blue underlined "time" word in the lower panel and set the length of the recordings. Click OK.

  1. Click Next.

  2. Skip the "Stop actions" (5) step. Click Finish. The new rule is created.

Alarm

Now an Alarm needs to be configured in Milestone XProtect.

  1. In the Milestone XProtect Management Client, go to the Site Navigation panel Alarms Alarm Definitions.

  2. Right-click on the Alarm Definitions panel Add new.

  1. Fill the form. Make sure that the alarm is Enabled.

  2. Set any Name for the alarm.

This alarm will represent all notifications which come from IRIS+ Professional.

  1. Set the Triggering event to Analytics Events, then select the Analytics Event you created before.

  2. At the Sources setting, click the Select... button. A pop-up will appear.

  3. Click on the Servers tab. Select the All Cameras node and click the Add button. Click OK.

  1. If you are familiar with Milestone XProtect, you can configure the rest of the settings as you wish or you can leave them as they are.

  1. Click the Save button in the top left corner (once enabled).

All done. You will receive alarms in the Alarm Manager.

Cameras

Each camera's [Technical name] in IRIS+ Professional should match its [GUID] in Milestone XProtect.

  1. In the Milestone XProtect Management Client, go to the Site Navigation panel Cameras.

  2. In the Devices panel, find the Cameras root node and click on it.

  3. Now, without clicking anywhere else, hold the Ctrl key and click on the specific camera.
  4. In the Properties panel on the right, under the Info tab, you will find the ID (GUID).

  1. Select the ID value and copy it to your clipboard.

Make sure that you don't copy any leading or tailing spaces. It is recommended to note down the required IDs.

  1. Paste it in IRIS+ Professional as the Technical name. Please create each camera setting in IRIS+ Professional accordingly.

Receiving alarms in Milestone XProtect

Whenever an Alarm is triggered by IRIS+ Professional, it should be visible in Milestone XProtect Smart Client under the Alarm Manager tab with annotations.

Alarm metadata

  • Name: The name of the alarm in Milestone XProtect.
  • Message: U-Alarm (cannot be changed).
  • Type: The name of the query in IRIS+ Professional.

Creating a custom view in Smart Client

  1. In the Milestone XProtect Smart Client, open the LIVE tab of the window.
  2. Click the Setup button in the upper right corner of the window Certain elements of the interface will turn orange, indicating that they are now editable.

  1. On the left sidebar, select a View Group click Create new view. Choose any layout that contains at least one wide rectangle; in this example, layout 1+1+4 under category 4:3.

  1. On the left sidebar, under System overview, open Alarms click and drag the Alarm List and Alarm Preview items into the wide rectangles you created in the above step (into the two left-side rectangles in our example of a 1+1+4 grid).

  1. From the Camera menu on the left sidebar, drag any cameras of your choosing into the remaining rectangles.

  2. Click the Setup button in the upper right corner of the window to exit editing and save your changes to the interface.

IRIS+ Professional configuration

Queries can be configured to send detections to Milestone XProtect, appearing as Analytics Events.

  1. Create a query you want to integrate with Milestone XProtect.

  2. Fill in the query's parameters, then select the Alarm Integration tab in the query editor.

  3. Under Milestone XProtect Analytics Event Integration, tick Enable, then fill in the following fields:

  • Milestone XProtect host address: http://<ip_address>:<port>

Where <ip_address> is the IP address of the server running Milestone XProtect, and <port> is the port number enabled earlier for the Analytics Event service (9090 by default).

  • Analytics event name: Type the name of the Analytics Event you created in Milestone XProtect.
  • Event display name: The display name of the event that will be shown in the event list.
  • Description (optional): A description of your event.
  • Timestamp offset (in seconds): The time offset between the Milestone XProtect Analytics Event and the query trigger.