Difference between revisions of "Milestone XProtect - IC-Edge Integration"

Latest revision as of 14:13, 22 March 2024

Introduction

The interface between IC-EDGE and Milestone XProtect VMS is through an integration module which is available on the Downloads page of Zenitel Wiki.

This integration requires an Zenitel desktop station or softclient to be associated with the Milestone XProtect Smart Client, as SIP audio is routed through IC-Edge.

This article assumes that the reader is:

familiar with setup and operation of the Milestone XProtect VMS
that the Milestone XProtect VMS is operational, with all to the system connected cameras configured
that IC-EDGE is operational, with all the system connected intercom devices and softclients configured

Only points which are specific to this integration and to connected intercom stations/softclients and IP speakers are described.

Read more about the integration in the Solution Brochure.

Licensing

Milestone XProtect

The integration interface does not require a specific license from Milestone.

However, note that Zenitel stations are typically registered as ONVIF devices in XProtect, to e.g. stream and record audio/video from stations. This requires separate station licenses from Milestone. For an overview of the ONVIF features supported in Zenitel devices, please read our article ONVIF Settings

IC-EDGE

The integration does not require a license from Zenitel.

Installation

This section describes how to install the integration plugin. It is assumed that the Milestone XProtect VMS has been installed and is running. It is also assumed that the Milestone XProtect VMS has been licensed appropriately.

When installing (or uninstalling) the plugin all Milestone Clients (Management Client and Smart Client) must be closed.
The plugin is to be installed on the same machine where the Milestone XProtect Smart client is.

Download the msi setup file from the Downloads section on Zenitel Wiki.
Run the setup file, and follow the instructions on the screen
When prompted for the installation location, select the Milestone/MIP installation folder (e.g. C:\Program Files\Milestone\MIPPlugins).
Click "Close" to complete the installation.

Configuration

Basic plugin configuration

Open the XProtect Smart Client.
Open the "Configuration" window by clicking the "Configuration" icon in the toolbar.
In the "Configuration" window enter the IP address and port number of your Zenitel intercom system acting as the IC-Edge controller in the "IP Address" and "Port" fields, respectively.
Click the "Connect" button and wait for the system to retrieve the list of available intercom devices and softclients.
Select the operator's intercom device or softclient by choosing its directory number from the drop-down list.

Zenitel plugin configuration steps

Associating cameras with devices

Open the camera settings window.
On the left side, there will be a list of devices registered with the IC-Edge controller. On the right side, there will be a list of cameras registered within the XProtect system.
Click on a device in the left list to select it.
Click on an item in the right list to preview the video feed from that camera.
To associate a camera with a selected device, click the checkbox next to the camera's name.
Repeat steps 3-5 to associate additional cameras with the selected device.
Once satisfied with the configuration, close the camera settings window.
Click "Save and Close" on the configuration window to save the changes.

Assign camera to a station

Using the Call Handler

The Zenitel Call Handler (IC-Edge) plugin can be used for two scenarios: initiating calls and handling incoming calls.

Note that SIP audio is routed through IC-EDGE, so the call is established on a Zenitel desktop station or softclient.

If the Operator uses a desktop station, the Call Handler transfers the call from the Smart Client to the desktop station where the operator gets audio through the station connected handset, speaker or headset.

If the Operator uses the Zenitel softclient, the Call Handler transfers the call from the Smart Client to the softclient, which runs in background on the PC, and the operator gets audio through the PC connected microphone, speakers or headset.

Initiating Calls

In XProtect Smart Client on the Zenitel Audio tab select a device you wish to call and click on the green "Call" button.
A popup window will be displayed showing the active call, along with a video preview from an associated camera.

Popup window displaying the active call and associated camera

Answering Calls

When a call is received, a popup window will be displayed showing the incoming call, along with a video preview from an associated camera.
To answer the call, the operator has to answer it using the desktop station or softclient that is set as the operator directory number.
If there are multiple incoming calls, they will be displayed in call list.

Popup window displaying the active call and his associated camera with two queued calls

Using the Popup Window

The popup window displays the active call (if it was initiated by the operator) or a list of incoming calls, along with a video preview from an associated camera.
The popup window will display the camera feed from the first associated camera of the active call (if present) or if there are no active calls, the first queued device-associated camera will be displayed.
To manually switch the camera video feed to any active or queued device, select the desired device from the dropdown list in the popup window.
To hang up the active call, click the red "Hang-Up" button.
To answer a queued call, the operator has to answer it using the desktop station or softclient set as the operator directory number.

Previous versions

For configuration of previous versions of the plugin go to:

@@ Line 1: / Line 1: @@
 == Introduction ==
-The Zenitel Cal Handler (IC-Edge) is a plugin that allows users to integrate Milestone XProtect with Zenitel intercom systems. In this guide, we'll walk you through the installation process and explain how to
+The interface between IC-EDGE and Milestone XProtect VMS is through an integration module which is available on the [[Downloads#Interface_modules|Downloads page]] of Zenitel Wiki.
-configure the plugin to work with your setup.
 <br>
+This integration requires an Zenitel desktop station or softclient to be associated with the Milestone XProtect Smart Client, as SIP audio is routed through IC-Edge.
 <br>
+This article assumes that the reader is:
+<br>
+*familiar with setup and operation of the Milestone XProtect VMS
+*that the Milestone XProtect VMS is operational, with all to the system connected cameras configured
+*that IC-EDGE is operational, with all the system connected intercom devices and softclients configured
+<br>
+Only points which are specific to this integration and to connected intercom stations/softclients and IP speakers are described.
+Read more about the integration in the [https://www.zenitel.com/sites/default/files/Zenitel-Milestone_Integration_EN.pdf Solution Brochure].
+==Licensing==
+===Milestone XProtect===
+The integration interface does not require a specific license from Milestone.
+However, note that Zenitel stations are typically registered as ONVIF devices in XProtect, to e.g. stream and record audio/video from stations. This requires separate station licenses from Milestone.
+For an overview of the ONVIF features supported in Zenitel devices, please read our article [[ONVIF Settings]]
+===IC-EDGE===
+The integration does not require a license from Zenitel.
 == Installation ==
-#Download the zip file containing the plugin from the Zenitel website.
+This section describes how to install the integration plugin.
-#Extract the contents of the zip file to a location of your choice.
+It is assumed that the Milestone XProtect VMS has been installed and is running. It is also assumed that the Milestone XProtect VMS has been licensed appropriately.<br>
-#Run the setup file (the MSI or the EXE, depending on your system).
-#When prompted for the installation location, select the Milestone/MIP installation folder (e.g. C:\Program Files\Milestone\MIP).
+*When installing (or uninstalling) the plugin all Milestone Clients (Management Client and Smart Client) must be closed.
-#Click "Finish" to complete the installation.<br>
+*The plugin is to be installed on the same machine where the Milestone XProtect Smart client is.
-<br>
+#[[Downloads#Interface_modules|Download the msi setup file]] from the Downloads section on Zenitel Wiki.
+#Run the setup file, and follow the instructions on the screen
+#When prompted for the installation location, select the Milestone/MIP installation folder (e.g. C:\Program Files\Milestone\MIPPlugins).
+#Click "Close" to complete the installation.<br>
+<br style="clear:both;" />
 == Configuration ==
@@ Line 17: / Line 45: @@
 #Open the "Configuration" window by clicking the "Configuration" icon in the toolbar.
 #In the "Configuration" window enter the IP address and port number of your Zenitel intercom system acting as the IC-Edge controller in the "IP Address" and "Port" fields, respectively.
-#Click the "Connect" button and wait for the system to retrieve the list of available devices.
+#Click the "Connect" button and wait for the system to retrieve the list of available intercom devices and softclients.
-#Select the operator's device by choosing its directory number from the drop-down list.
+#Select the operator's intercom device or softclient by choosing its directory number from the drop-down list.
 <br>
-[[File:ZenitelCallHandler_IC-EdgeConfigurationGif.gif|thumb|center|800px|Animation of the Zenitel Cal Handler configuration process]]
+<table style="max-width:80%; border-style: double; border-color: #c7c7c7;">
+<tr style="rowspan:2;">
+<td style="display: block; vertical-align: bottom;">[[Image:ZenitelCallHandler_IC-EdgeConfigurationGif.gif|800px]]</td>
+</tr>
+<tr>
+<td style='background-color:#efefef;'>Zenitel plugin configuration steps</td>
+</tr>
+</table>
@@ Line 35: / Line 70: @@
 #Click "Save and Close" on the configuration window to save the changes.
 <br>
-[[File:ZenitelCallHandlerCameraConfiguration2_IC-Edge.JPG|thumb|center|800px|Screenshot of the camera assosiation process]]
+<table style="max-width:80%; border-style: double; border-color: #c7c7c7;">
+<tr style="rowspan:2;">
+<td style="display: block; vertical-align: bottom;">[[Image:ZenitelCallHandlerCameraConfiguration2_IC-Edge.JPG|800px]]</td>
+</tr>
+<tr>
+<td style='background-color:#efefef;'>Assign camera to a station</td>
+</tr>
+</table>
@@ Line 41: / Line 83: @@
 == Using the Call Handler ==
-The Zenitel Cal Handler (IC-Edge) plugin can be used for two scenarios: initiating calls and reacting to inbound calls.
+The Zenitel Call Handler (IC-Edge) plugin can be used for two scenarios: initiating calls and handling incoming calls.
+Note that SIP audio is routed through IC-EDGE, so the call is established on a Zenitel desktop station or softclient.
+If the Operator uses a desktop station, the Call Handler transfers the call from the Smart Client to the desktop station where the operator gets audio through the station connected handset, speaker or headset.
+If the Operator uses the Zenitel softclient, the Call Handler transfers the call from the Smart Client to the softclient, which runs in background on the PC, and the operator gets audio through the PC connected microphone, speakers or headset.
 ====Initiating Calls====
@@ Line 47: / Line 95: @@
 A popup window will be displayed showing the active call, along with a video preview from an associated camera.
 <br>
-[[File:ZenitelCallHandlerOperation1_IC_Edge.JPG|thumb|center|800px|Screenshot of popup window displaying the active call and associated camera]]
+<table style="max-width:80%; border-style: double; border-color: #c7c7c7;">
+<tr style="rowspan:2;">
+<td style="display: block; vertical-align: bottom;">[[Image:ZenitelCallHandlerOperation1_IC_Edge.JPG|800px]]</td>
+</tr>
+<tr>
+<td style='background-color:#efefef;'>Popup window displaying the active call and associated camera</td>
+</tr>
+</table>
 <br>
-====Answering queued Calls====
+====Answering Calls====
-#When an inbound call is received, a popup window will be displayed showing the queued call, along with a video preview from an associated camera.
+#When a call is received, a popup window will be displayed showing the incoming call, along with a video preview from an associated camera.
-#To answer the call, the operator has to answer it using a physical device selected as the operator directory number.
+#To answer the call, the operator has to answer it using the desktop station or softclient that is set as the operator directory number.
-#If there is an active call, the Call Handler will automatically hang up the active call and answer the inbound call.
+#If there are multiple incoming calls, they will be displayed in call list.
-#If there are multiple queued calls, they will be displayed in order of priority.
 <br>
-[[File:ZenitelCallHandlerOperation2_IC-Edge.JPG|thumb|center|800px|Screenshot of popup window displaying the active call and his associated camera with two queued calls]]
+<table style="max-width:80%; border-style: double; border-color: #c7c7c7;">
+<tr style="rowspan:2;">
+<td style="display: block; vertical-align: bottom;">[[Image:ZenitelCallHandlerOperation2_IC-Edge.JPG|800px]]</td>
+</tr>
+<tr>
+<td style='background-color:#efefef;'>Popup window displaying the active call and his associated camera with two queued calls</td>
+</tr>
+</table>
@@ Line 63: / Line 125: @@
 ====Using the Popup Window====
-* The popup window displays the active call (if it was initiated by the operator) or a list of queued calls, along with a video preview from an associated camera.
+* The popup window displays the active call (if it was initiated by the operator) or a list of incoming calls, along with a video preview from an associated camera.
 * The popup window will display the camera feed from the first associated camera of the active call (if present) or if there are no active calls, the first queued device-associated camera will be displayed.
 * To manually switch the camera video feed to any active or queued device, select the desired device from the dropdown list in the popup window.
 * To hang up the active call, click the red "Hang-Up" button.
-* To answer a queued call, the operator has to answer it using a physical device selected as the operator directory number.
+* To answer a queued call, the operator has to answer it using the desktop station or softclient set as the operator directory number.
-* If there are multiple queued calls, they will be displayed in order of priority. To answer a specific queued call, select it from the dropdown list in the popup window.
 <br>
@@ Line 77: / Line 137: @@
 * [[Milestone Xprotect - IC-Edge Integration (VS-Milestone Plugin)]]
 <br style="clear:both;" />
+[[Category: 3rd party integration]]
+[[Category: IC-EDGE Integrations]]