SafeZone(-edge)
MILESTONE XPROTECT INTEGRATION
Configuration Guide
August 2016 | VERSION 3.0.0 (R24)
SafeZone-edge | Outputs & VMS Integration Configuration Guide
SAFEZONE(-EDGE) WITH MILESTONE VMS ..................................................... 3
Introduction .................................................................................................................................. 3
How to read this document ...................................................................................................... 3
SafeZone(-edge) integration ...................................................................................................... 4
Integration architecture ....................................................................................................................... 4
Prerequisites........................................................................................................................................... 5
Licensing .................................................................................................................................................. 5
INSTALLATION AND FIRST CONFIGURATION STEPS ..................................... 7
Installation ..................................................................................................................................... 7
Software installation on the host running the Management Client and/or the Smart Client.
................................................................................................................................................................... 8
Software installation on the host running the XProtect Recording Server .............................. 8
Adding AXIS devices running SafeZone-edge to XProtect ............................................... 11
Adding SafeZone servers ................................................................................................................... 12
Adding SafeZone servers installed on EdgeVis IP250 encoders .............................................. 14
Deleting a server / refreshing server channels............................................................................. 16
XPROTECT CORPORATE OR EXPERT .............................................................. 19
Configuration ............................................................................................................................. 19
Alarms, events and bookmarks configuration through the Management Client Plugin ..... 19
Metadata configuration through the Management Client Plugin ............................................ 22
Metadata recording activation ......................................................................................................... 34
How to use trigger further actions .................................................................................................. 42
How to start image recording using User Defined Events .....................................................................42
How to send an email using User Defined Events ...................................................................................44
How to open/close a dry contact using User Defined Events ...............................................................46
How to trigger an alarm from an Analytics Event .....................................................................................47
Introduction
Page 1
SafeZone-edge | Outputs & VMS Integration Configuration Guide
Operating the Smart Client..................................................................................................... 49
Alarms .................................................................................................................................................... 49
User defined events ............................................................................................................................ 50
Bookmarks ............................................................................................................................................ 52
Metadata display ................................................................................................................................. 54
XPROTECT ENTERPRISE..................................................................................... 56
Configuration ............................................................................................................................. 56
Alarms and Analytics events configuration through the Management Client Plugin .......... 56
How to use Analytics Events to trigger Alarms ............................................................................. 57
How to use Manual Global Events to trigger further actions .................................................... 59
Operating the Smart Client..................................................................................................... 62
Alarms .................................................................................................................................................... 62
Manual Global events ......................................................................................................................... 64
Introduction
Page 2
SafeZone-edge | Outputs & VMS Integration Configuration Guide
SafeZone(-edge) with Milestone VMS
SafeZone(-edge) integrates with XProtect Video Management Systems (VMS) from
Milestone, providing operators with immediate and informative feedback on potential
security incidents.
Introduction
The integration between XProtect product family and SafeZone(-edge) (both the Edge and the Server versions)
depends on the XProtect Product that is used:


For XProtect Corporate and Expert (starting from version 2014), it is possible:
o
To trigger “User Defined” events when SafeZone(-edge) generates an alarm
o
To trigger “Video Analytics” events when SafeZone(-edge) generates an alarm
o
To trigger “Alarms” when SafeZone(-edge) generates an alarm
o
To insert a bookmark in the corresponding video sequence
o
To display the live metadata generated by SafeZone(-edge) on top of the corresponding video
stream in Milestone Smart Client
o
To record the metadata generated by SafeZone(-edge) with the corresponding video stream,
and to display them together when playing the video sequence in playback mode
For XProtect Enterprise, Professional and Express it is possible:
o
To trigger “Manual Global Events” when SafeZone(-edge) generates an alarm
o
To trigger “Video Analytics” events when SafeZone(-edge) generates an alarm
o
To trigger “Alarms” when SafeZone(-edge) generates an alarm
The following sections describe and detail how to configure both XProtect and SafeZone(-edge) in order to
achieve these two types of integration, for each “family product”. Be aware that even inside the same “family”
(for example, Enterprise/Professional/Express) there are some differences in the configuration depending on
the specific XProtect product that is used (Enterprise or Professional or Express).
How to read this document
The next sections describe:

The software architecture (i.e. which software modules should be installed and where)

How to install the software

What prerequisites should be respected and what Milestone licenses are needed

How to connect your SafeZone-edge and SafeZone to your Milestone system
These sections are independent from the specific XProtect product installed and should be read by every user.
Introduction
Page 3
SafeZone-edge | Outputs & VMS Integration Configuration Guide
At the end of the first chapter, your system will already be able to receive Alarms, Analytics Events and User
Defined Events/Manual Global Events. If that is enough for your needs, you can stop reading there.
If you need metadata display and recording (available in Corporate/Expert only) or if you need to trigger further
actions by tweaking the XProtect configuration, then you can go to the chapter that is relative to your specific
product, either XProtect Corporate or Expert (first chapter) or XProtect Enterprise, Professional or Express
(second chapter).
In those chapters, you will learn:

[XProtect Corporate only] How to connect the metadata from your SafeZone(-edge) to your Milestone

How to leverage the Milestone Alarms, User Defined Events (in Corporate) or Manual Global Events (in
Enterprise/Professional/Express) and Analytics Events to trigger further actions in your Milestone
system (like activating a recording, sending an e-mail or an SMS or trigger an hardware output)

How to operate the smart client
SafeZone(-edge) integration
[This section applies to both XProtect Corporate and XProtect Express/Professional/Enterprise]
Integration architecture
The integration between SafeZone(-edge) and XProtect is based on a set of software modules running on the
XProtect servers.
The following picture displays a typical XProtect installation:
MIP Plugin for SafeZone(-edge)
MIP Plugin for SafeZone(-edge)
SafeZone(-edge) Alarm
& Metadata Bridge
Server running
SafeZone
EdgeVis IP250
running SafeZone
Axis cameras/encoders
running SafeZone-edge
Cameras connected to both SafeZone and
Milestone XProtect
Camera connected to both EdgeVis
IP250 and Milestone XProtect
Depicted in green are the additional software modules that make the integration between SafeZone(-edge) and
XProtect:
SafeZone(-edge) integration
Page 4
SafeZone-edge | Outputs & VMS Integration Configuration Guide


The “MIP Plugin for SafeZone(-edge)” is installed on every PC running either the XProtect Management
Client or the XProtect Smart Client.
o
When run by the Management Client, it simplifies and automatizes the configuration of the
system and allows to configure the automatic generation of Bookmarks and or User Defined
events (that, in turn, can trigger a large set of tasks as answer to an alarm)
o
When run by the Smart Client, it displays the metadata generated by SafeZone(-edge) on top
of the corresponding video streams, both in live mode and in playback mode
The “SafeZone(-edge) Alarm & Metadata Bridge”1 runs as a Windows Service on one XProtect
Recording Server (or Management Server) (optionally it can be installed and run on any other server
connected by LAN to the Axis cameras). It feeds the XProtect Recording Server with the metadata
coming from SafeZone(-edge). The XProtect Recording Server records them on disk and makes them
available to the Smart Client for live and playback display.
Prerequisites
The integration pack has the following prerequisites:

Microsoft .net 4.5 must be available on the PC where the integration pack is installed. If it is not
available, it will be automatically installed by the Integration pack installer

Either Milestone XProtect Corporate/Expert 2014 (7.0d) or 2016 (10.0a or 10.1a)

Or Milestone XProtect Enteprise 2014 (8.6d) or 2016 R2 (10.1a)

SafeZone-edge 2.0.0 or a later version.
Important additional prerequisites are:

The Axis cameras running SafeZone-edge must be time-synchronized with the XProtect Server (i.e. the
cameras and the server where XProtect is installed must be configured on the same TimeZone and
have the same time). We strongly recommend to configure all the cameras and the XProtect server to
use a time-server to synchronize and to stay synchronized over time.

The SafeZone-edge instances running on the Axis cameras must be properly configured (calibrated
and with scenarios defined to trigger alarms) before integrating them with XProtect. Cf the “SafeZone
and SafeZone-edge Setup Guide” to know how to proceed with calibration and configuration.

The SafeZone server(s) must be time-synchronized with the XProtect Server (i.e. the SafeZone server(s)
and the XProtect server must be configured on the same TimeZone and have the same time). We
strongly recommend to configure all the SafeZone servers and the XProtect server to use a time-server
to synchronize and to stay synchronized over time.

The SafeZone instances running on the SafeZone server must be properly configured (calibrated and
with scenarios defined to trigger alarms) before integrating them with XProtect. Cf the “SafeZone and
SafeZone-edge Setup Guide” to know how to proceed with calibration and configuration.
Licensing
[This section only applies to XProtect Corporate/Expert, no additional Milestone licenses are needed for Enterprise]
In order for the XProtect Corporate system to receive and record the metadata, an additional DLK is needed
(independently from the number of metadata channels received by the system). This license is a standard DLK
license to purchase from Milestone. For example:
1 The exact complete name of the corresponding Windows Service is “Digital Barriers SafeZone(-edge) Bridge to Milestone
XProtect), short name “SZBridge”
SafeZone(-edge) integration
Page 5
SafeZone-edge | Outputs & VMS Integration Configuration Guide

The system has 50 cameras connected; all of them have SafeZone-edge installed. The system must
record and display the SafeZone-edge metadata. In this case, the total number of required DLK is 51.

The system has 50 cameras connected; half of them have SafeZone-edge installed. The system must
record and display the SafeZone-edge metadata. In this case, the total number of required DLK is 51.

The system has 50 cameras connected; half of them have SafeZone(-edge) installed, the other half
feeds a SafeZone server that analyses the 25 video streams. The system must record and display the
SafeZone(-edge) metadata. In this case, the total number of required DLK is 51.

The system has 50 cameras connected; half of them have SafeZone-edge installed. The system must
receive the alarms triggered by SafeZone-edge and react on them, but metadata recording and display
is not required. In this case, the total number of required DLK is 50.
SafeZone(-edge) integration
Page 6
SafeZone-edge | Outputs & VMS Integration Configuration Guide
Installation and first configuration
steps
This chapter is common to both XProtect Corporate/Expert and XProtect Enterprise/Professional/Express. The
first part describes how to install the software and on which host(s) the software should be installed. The
second part describes how to connect your SafeZone-edge devices and your SafeZone server(s) to your
XProtect System.
At the end of this chapter, your system will already be able to receive Alarms, Analytics Events and User Defined
Events/Manual Global Events.
Installation
The installer executable (“DB SafeZone(-edge) Bridge to Milestone XProtect X.Y.Z.W.exe”) installs both the
SafeZone(-edge) Alarm & Metadata Bridge and the MIP Plugins for SafeZone(-edge). At the installation, a dialog
allows the user to choose the component(s) to install:
The user must run the installer and choose the “MIP Plugins for SafeZone(-edge)” component on every PC
where the XProtect Smart Client is installed and where the user wants the metadata display (if metadata display
is not a requirement, this installation can be omitted).
The user must also run the installer and choose the “MIP Plugins for SafeZone(-edge)” on every PC where the
XProtect Management Client is installed and the user wants to administer (configure) the SafeZone(-edge)
integration.
Installation
Page 7
SafeZone-edge | Outputs & VMS Integration Configuration Guide
Finally, the user must run the installer and choose the “SafeZone(-edge) Alarm & Metadata bridge” on either the
XProtect Recording Server, or the XProtect Management Server or any other server directly connected by a
good quality network (LAN) to the Axis cameras running SafeZone(-edge).
Software installation on the host running the Management Client
and/or the Smart Client.
Before installing the MIP Plugin for the XProtect Management Client, the Management Client must be
already installed on the target host.
In addition, before installing the MIP Plugin for the XProtect Smart Client, the Smart Client must be
already installed on the target host.
1.
As administrator, execute the “DB SafeZone(-edge) Bridge to Milestone XProtect X.Y.Z.W.exe” installer
2.
Click “Next”
3.
Accept the EULA and click “Next”
4.
If you plan to run the Metadata Bridge on another host, untick the “SafeZone(-edge) Alarm & Metadata
bridge” component. In any case, let the “MIP Plugins for SafeZone(-edge)” ticked. Click “Next”
5.
Click “Install”
6.
When the installation finished, click on “Finish”
Software installation on the host running the XProtect Recording Server
Before installing the SafeZone(-edge) Alarm & Metadata Bridge, the XProtect System must be already
installed and running on the same host or on a host connected to the Metadata Bridge one by a LAN.
1.
As administrator, execute the “DB SafeZone(-edge) Bridge to Milestone XProtect X.Y.Z.W.exe” installer
Installation
Page 8
SafeZone-edge | Outputs & VMS Integration Configuration Guide
2.
Click “Next”
3.
Accept the EULA and click “Next”
4.
If you have a Management Client installed on this host and you plan to configure the system with it, tick
the “MIP Plugins for SafeZone(-edge)” component too. In any case, let the “SafeZone(-edge) Alarm &
Metadata Bridge” component ticked. Click “Next”
5.
Click “Install”
6.
When the installation finished, click on “Finish”
7.
The SafeZone(-edge) Metadata Bridge Configuration opens:
Installation
Page 9
SafeZone-edge | Outputs & VMS Integration Configuration Guide
8.
“Hostname or ip” field must be filled with the DNS name or ip address of the XProtect Corporate
server. 127.0.0.1 can be used if the Corporate server is installed on the same host
9.
“Port” is the port configured in the XProtect Server for SDK connections. If this value has not been
customized in your installation, the default value of 0 (that means “use the default value”) should be
fine, otherwise use the custom port value you set up
10. Choose if the login uses an existing Windows user or a Milestone user defined in the XProtect System
11. Then fill the “login” field. For a Windows user, it is necessary to prefix the login name with user domain,
as in “domain\username”. For a Milestone User, only the username should be used
12. Then fill the “password” field. If you are using a Windows User, do not forget to provide the user
password in this field
13. Click on the “Test” button to check if the connection succeeds. If not, fix the problem by providing the
correct information. If yes, you can click on the “Save” button.
14. The provided information will allow the SafeZone(-edge) Alarm & Metadata Bridge2 to connect to the
XProtect Server.
2 The exact name of this service in Windows Service Control Panel is “DB SafeZone(-edge) Bridge to Milestone XProtect”
Installation
Page 10
SafeZone-edge | Outputs & VMS Integration Configuration Guide
Adding AXIS devices running SafeZone-edge to XProtect
This section describes how you can add the SafeZone-edge instances running on AXIS ACAP devices connected
to your XProtect system.
The screenshot displayed in the next section comes from an XProtect Corporate/Expert installation, but
the different steps are the same for XProtect Enterprise/Professional/Express.
If you have AXIS devices with SafeZone-edge installed, you need first to add them to XProtect as video sources
(this is a mandatory step) and then you need to add them to the MIP Plugin configuration so that they can be
used as alarm and (under Corporate/Expert) as metadata sources also. In order to do that, follow these steps:
1.
Add all the AXIS devices to XProtect as video sources (cf XProtect documentation)
2.
Click on “MIP Plug-ins”, “Digital Barriers”, “SafeZone(-edge)”
3.
Select the “SafeZone-edge cameras” tab
4.
Click on “Refresh camera list” button
5.
The MIP Plugins scans all the video devices of the XProtect system (skipping the disabled ones) and
selects the AXIS ones having SafeZone-edge installed. The list of the selected devices is displayed in the
central widget, alongside with the version of the installed package.
Sometime it may happen – especially when new cameras has been added to the system just
before – that these last ones are not found by the MIP Plugin. In this case, just refresh the
Management client configuration by using the “F5” key and then click on “Refresh camera list” button
again.
6.
Save the configuration
6
3
4
5
2
The selected cameras are now added to the system and automatically used as alarm and metadata sources.
Adding AXIS devices running SafeZone-edge to XProtect
Page 11
SafeZone-edge | Outputs & VMS Integration Configuration Guide
Adding SafeZone servers
If you have SafeZone servers that you want to use as alarm or metadata sources, you need to add them to the
MIP Plugin configuration.
With respect to an AXIS device running SafeZone-edge, you need to perform an additional configuration step,
which consists in associating to specific SafeZone “stream” (i.e. a video channel configured on the SafeZone
server) the corresponding video stream in XProtect. Proceed this way:
1
3
4
5
6
2
7
1.
Select the “SafeZone servers” tab
2.
Click on “Add a new SafeZone server” button
3.
A new dialog opens, select the “Direct Connection” tab
4.
Enter the SafeZone ip address or hostname
5.
The default port to use is 5000, do not change this value
6.
Username and password fields are disabled because not necessary
7.
Click on “Connect to server”. If the connection succeeds, a success message is displayed and the “OK”
button becomes enabled:
Adding AXIS devices running SafeZone-edge to XProtect
Page 12
SafeZone-edge | Outputs & VMS Integration Configuration Guide
8
8.
Click on the “OK” button
9.
The server is displayed in the “SafeZone servers and video channels” widget:
14
9
10
12
11
10. Now select one of the server streams
Adding AXIS devices running SafeZone-edge to XProtect
Page 13
SafeZone-edge | Outputs & VMS Integration Configuration Guide
11. Select in the “Associated Milestone cameras” list the XProtect Video source that will be associated to
alarms coming from the selected stream of the SafeZone server. The MIP plugin automatically tries to
guess the associated XProtect camera using the XProtect camera name and the SafeZone stream
name (so if they are equal or similar, the right XProtect camera will be automatically preselected). If the
preselected XProtect camera is not the correct one, select the “Show all cameras…” entry of the list and
all the XProtect Cameras will be displayed in the list.
12. [This option is available in Corporate/Expert only] If you don’t want to display the metadata in live or
playback mode, untick the corresponding option
13. Repeat the previous 2 steps for every SafeZone server stream
14. Click on “Save” button
Adding SafeZone servers installed on EdgeVis IP250 encoders
You can also add SafeZone servers installed on EdgeVis IP250 encoders. In order to add them, you need to
have credentials on the EdgeVis server to which the corresponding EdgeVis IP250 encoder is connected.
1
3
4
5
2
1.
Select the “SafeZone servers” tab
2.
Click on “Add a new SafeZone server” button
3.
On the new widget, click on “Through EdgeVis Server” tab
4.
Enter the credentials (ip/hostname, login and password) to the EdgeVis server
5.
Click on “Connect to server” button
6.
If the credentials are correct, “Encoder” list is populated with all the Encoders that the provided
credentials grant access to:
Adding AXIS devices running SafeZone-edge to XProtect
Page 14
SafeZone-edge | Outputs & VMS Integration Configuration Guide
8
6-7
9
7.
Select the Encoder you want to add
8.
If the chosen Encoder supports the “SecureConnect” functionality, a confirmation message is displayed
and the “OK” button is enabled
9.
Click on the “OK” button
10. The SafeZone server is added to the “SafeZone servers and video channels” widget
Adding AXIS devices running SafeZone-edge to XProtect
Page 15
SafeZone-edge | Outputs & VMS Integration Configuration Guide
10
11
12
11. Select the SafeZone added video stream
12. Select the associated XProtect video stream
13. Click on “Save” button to save the configuration
Deleting a server / refreshing server channels
If you want to remove a SafeZone server, select it and click on “Delete this SafeZone server” button.
If the server video streams have changed (some have been deleted and/or some have been added), select the
SafeZone server and click on “Refresh server channels” button. Then configure the XProtect camera associated
to the new video streams as described in the previous sections.
In both cases, do not forget to save the configuration by clicking on “Save” button.
At this stage of the configuration process, if you activated the alarm, analytics events or bookmarks
generation, you should be able to receive them in XProtect without further steps. However, to trigger
further, more advanced rules within XProtect additional steps are necessary in order to leverage the Analytics
Events and the User Defined Events. Those are described in the “Alarms and Analytics events configuration
through the Management Client Plugin
Adding AXIS devices running SafeZone-edge to XProtect
Page 16
SafeZone-edge | Outputs & VMS Integration Configuration Guide
Before configuring the software, both the MIP Plugin for the Management Client and the SafeZone-edge Alarm
& Metadata Bridge must be installed. In addition, the Alarm & Metadata Bridge must also be configured to be
able to access the XProtect System (as described in the previous section).
To configure the software, follow these steps:
1.
Open the Management client, and add to the XProtect system all the cameras you need. You need to
add both the Axis cameras and/or encoders running SafeZone-edge and the video devices whose
video stream is analysed by SafeZone
2.
Click on “MIP Plugins”, “Digital Barriers”, “SafeZone-edge” and you will get this configuration screen:
3.
Click on the “Alarm configuration” tab
4.
If you want to automatically trigger an XProtect alarm when SafeZone-edge generates one, tick the
“Automatically trigger alarms on SafeZone-edge alarm reception” option
5.
If you want to automatically trigger an XProtect Video Analytics Event when SafeZone-edge generates
an alarm, tick the “Automatically trigger analytics events” option
6.
In most of the cases, you don’t need to manually specify the destination ip address and listening port
for alarms (i.e., the port that the SafeZone(-edge) Alarm & Metadata Bridge will use to listen for
incoming alarms from SafeZone(-edge) and its ip address as used by the SafeZone(-edge) instances to
send alarms). In some special cases, like when there is a NAT or port forwarding between the
SafeZone(-edge) devices and the host where the Alarm & Metadata bridge runs), you might want to set
them manually. In this case, tick the “Set Manually” option and fill the ip address (or DNS hostname)
and port that the SafeZone(-edge) devices should use to send their alarms to the Alarm & Metadata
7.
“Configuration Reset” button will drop the current configuration and allows you to restart with a new
configuration from scratch.
Adding AXIS devices running SafeZone-edge to XProtect
Page 17
SafeZone-edge | Outputs & VMS Integration Configuration Guide
8.
Do not forget to save the configuration changes by clicking on the button
9.
When saving a new configuration, the SafeZone(-edge) Alarm & Metadata Bridge is automatically
restarted to take into account the new configuration.
How to use Analytics Events to trigger ” section.
Adding AXIS devices running SafeZone-edge to XProtect
Page 18
SafeZone-edge | Outputs & VMS Integration Configuration Guide
XProtect Corporate or Expert
Configuration
Through the MIP Plugins for SafeZone-edge running in the XProtect Management Client it is possible to
configure different aspects of the system:

It is possible to scan the list of cameras defined within XProtect and automatically select those where
SafeZone-edge is installed (as explained in the previous chapter)

Then the plugin automatically configures a Metadata Source providing a metadata channel for each
Axis camera with SafeZone-edge installed. The Metadata Source is implemented and executed by the
“SafeZone(-edge) Alarm & Metadata Bridge” and must be added to the XProtect System. It is possible to
increase the number of video channels provided by the Metadata Source to plan future extensions of
the system. The unused channels should be disabled once the metadata source has been added (see
the following sections for details)

The plugin allows the user to deactivate the automatic generation of XProtect Alarms when a
SafeZone-edge triggers an alarm (the alarm generation is activated by default)

The plugin allows the user to deactivate the automatic generation of a XProtect bookmarks when
SafeZone-edge triggers an alarm (the bookmark generation is activated by default)

The plugin allows the user to automatically generate two User Defined events (one corresponding to
the start of the alarm, and one to the end) per alarm generated by SafeZone-edge. The user can then
delete the unused or redundant User Defined events and/or manually define additional ones more
tailored on his needs.
The following sections explain systematically how to configure a system and details the different available
options.
Alarms, events and bookmarks configuration through the Management
Client Plugin
Before configuring the software, both the MIP Plugin for the Management Client and the SafeZone(edge) Alarm & Metadata Bridge must be installed. In addition, the Metadata Bridge must also be
configured to be able to access the XProtect System (as described in the previous section).
To configure the software, follow these steps:
1.
Open the Management client
2.
Click on “MIP Plugins”, “Digital Barriers”, “SafeZone-edge”
3.
Select the “Alarm & Metadata Configuration” tab
Configuration
Page 19
SafeZone-edge | Outputs & VMS Integration Configuration Guide
3
4
2
5
6
4.
Skip for now the configuration of the Metadata source, this will be detailed in a next section (and it is
not necessary if you don’t want to display or record metadata)
5.
Configure alarms and bookmarks:
6.

If you want to automatically trigger an XProtect alarm when SafeZone-edge generates one,
tick the “Automatically trigger alarms on SafeZone-edge alarm reception” option

If you want to automatically trigger an XProtect Video Analytics Event when SafeZone-edge
generates an alarm, tick the “Automatically generate analytics events” option

If you want to automatically insert in the corresponding XProtect video stream a bookmark,
tick the “Automatically generate bookmarks” option

In most of the cases, you don’t need to manually specify the destination ip address and
listening port for alarms (i.e., the port that the SafeZone(-edge) Alarm & Metadata Bridge will
use to listen for incoming alarms from SafeZone(-edge) and its ip address as used by the
SafeZone(-edge) instances to send alarms). In some special cases, like when there is a NAT or
port forwarding between the SafeZone(-edge) devices and the host where the Alarm &
Metadata bridge runs), you might want to set them manually. In this case, tick the “Set
Manually” option and fill the ip address (or DNS hostname) and port that the SafeZone(-edge)
devices should use to send their alarms to the Alarm & Metadata
If you want the SafeZone-edge alarms to trigger XProtect User Defined Events, you need to define
these events. You can use the “Generate user defined events” button to automatically generate some
of them. The button will parse the scenarios defined in each SafeZone(-edge) device and generate a
couple of User Defined Events (one for the start, the other for the stop of the scenario) that the
SafeZone(-edge) Alarm & Metadata Bridge will trigger when SafeZone(-edge) generates the
corresponding alarm. For example, by clicking the button on a system with 1 Axis SafeZone-edge
camera (192.168.2.246) with 4 scenarios (named “conditional-1”, “intrusion-1”, “loitering-1” and “zonecrossing-1”) and a SafeZone stream with 1 “intrusion-1” scenario, the configuration plugin generates
these XProtect User Defined Events:
Configuration
Page 20
SafeZone-edge | Outputs & VMS Integration Configuration Guide
7.
Save the configuration
8.
You can retrieve the User Defined Events by clicking on “Rules and Events”, “User-defined Events”:
If you are not interested in all of them, for example, if you are not interested in the “STOP” User-defined
events, simply remove the not wanted ones. The SafeZone(-edge) Alarm & Metadata Bridge does not find
them and hence does not generate them.
You can also modify them to make them more generic, for example to make a single User Defined Event to
be triggered by several different alarms. To do that, you can edit the User Defined Event name and replace
one or more of the fields <ScenarioName>, <ScenarioType> and <CameraName> with the keyword “ALL”.
Configuration
Page 21
SafeZone-edge | Outputs & VMS Integration Configuration Guide
Every User Defined Event that is supposed to be triggered on a SafeZone(-edge) alarm must have a name that
respects a specific format: “DB SafeZone(-edge) <ScenarioName> <ScenarioType> on camera <CameraName>”
where:

<ScenarioName> is the name of the scenario as defined in the SafeZone Setup (cf the SafeZone
documentation). Usually it looks like “Intrusion-1”, but can be customized at configuration phase
through the SafeZone Setup. If you want the User Defined Event to be triggered by any scenario, use
“ALL” as <ScenarioName>.

<ScenarioType> is either “START”, “STOP” or “ALL”. Use “ALL” if you want the User Defined Event to be
triggered for both START and STOP alarms

<CameraName> is the name of the camera as defined in XProtect. When SafeZone(-edge) triggers an
alarm, it does so by analysing images from a camera/encoder that must also be present in XProtect.
For SafeZone-edge, this is the camera/encoder where SafeZone-edge is installed, and for SafeZone this
is the camera/encoder that has been associated to the SafeZone video stream (cf section “Error!
eference source not found.” on page Error! Bookmark not defined.). <CameraName> is the name of
the associated XProtect Camera. Use “ALL” if the Manual Global Event must be triggered by SafeZone(edge) alarms associated to any XProtect camera.
If you want to use an XProtect Camera Name as <CameraName>, you must replace the spaces
in the name by the “underscore” (_) character. Alternatively, you can rename the XProtect
Camera and remove all spaces from the camera name, or use ALL as <CameraName>.
The three parameters <ScenarioName>, <ScenarioType>, <CameraName> are all case insensitive, so
lowercase and uppercase letters are considered the same.
Here some examples of User Defined Events and by which SafeZone(-edge) alarms they will be triggered:

“DB SafeZone(-edge) Intrusion-1 START on camera ALL”: will be triggered by any SafeZone(-edge)
alarms START related to a scenario called “Intrusion-1” from any camera

“DB SafeZone(-edge) ALL ALL on camera IP250”: will be triggered by any SafeZone(-edge) alarm START
or STOP related to any scenario from the XProtect Camera “IP250”

“DB SafeZone(-edge) ALL START on camera ALL”: will be triggered by any SafeZone(-edge) alarm START
related to any scenario from any camera

“DB SafeZone(-edge) ZoneCrossing-1 STOP on camera IP250”: will be triggered by any SafeZone(-edge)
alarms STOP related to the scenario “ZoneCrossing-1” from XProtect camera “IP250”
If you rename a camera, remember to adapt the corresponding User Defined Events accordingly
At this stage of the configuration process, if you activated the alarm, events or bookmarks generation,
you should be able to receive them in XProtect without further steps. If you are not interested in
metadata display and recording, you can stop here and you will not need the DLK license that is necessary to
add the metadata source to Milestone. If you want to have the live and/or recorded metadata too, continue the
configuration as explained in the section “Metadata configuration through the Management Client Plugin”.
Metadata configuration through the Management Client Plugin
Before being able to add the metadata source to the XProtect System, the SafeZone(-edge) Alarm &
Metadata Bridge must be fully installed and configured as described in the previous section (i.e. by
providing the XProtect login credentials and IP address).
Before displaying or recording the metadata in XProtect, you need to configure the Metadata Source that
XProtect will use to pull the metadata streams from SafeZone(-edge). Milestone consider the Metadata Source
as a normal Video Source, and you will have to add it as if it were a Video Source on its own.
1.
Open the Management client
Configuration
Page 22
SafeZone-edge | Outputs & VMS Integration Configuration Guide
2.
Click on “MIP Plugins”, “Digital Barriers”, “SafeZone-edge”
3.
Select the “Alarm & Metadata Configuration” tab
3
4
2
5
4.
6
Then configure the parameters of the metadata source:

Except if you have special needs, do not set the MAC address manually. The default choice
should be good in almost all cases. If you want to provide your own MAC (for example,
because you plan to add more than one metadata source to the system) you can tick the “Set
manually” checkbox and either use the “Get another one” button or to provide manually the
one you want to use in the specific field
The Metadata source MAC address is tied to the DLK license of Milestone. If you
change it after having added the metadata source to XProtect, you must re-associate
the DLK to the new mac address.

The metadata source listening port is where the metadata source will listen for incoming
connections from XProtect. The metadata source logically behaves like a physical device (like a
multi-channel encoder) but distributes metadata streams instead of video streams. This
listening port is the equivalent to the port 80 of an HTTP-based network device. The default
value of 50000 should be fine, unless another application already uses this port on the host.
This can be verified by using the “Check if free” button (this button requires the SafeZone(edge) Alarm & Metadata Bridge to be running).

The number of provided metadata channels will be automatically set to the number of
SafeZone(-edge) found or configured in the system. If you want more metadata channels (for
example because you know you will add more SafeZone(-edge) instances in the future), you
can increase this number here.
If you already added the metadata source to the Milestone system, in order to
increase or decrease the number of video channels it is necessary to remove it and
add it again or to use the “Replace hardware” functionality (cf. XProtect User Guide)

The Management Client will request a metadata source password when adding the metadata
source to the system. If you want to see the password, click and hold the “Show in plaintext”
button.
If you already added the metadata source to the Milestone system and you change
the password, XProtect will not be able to retrieve the metadata anymore. In this case,
it is necessary to update the password value in the metadata source settings.
Configuration
Page 23
SafeZone-edge | Outputs & VMS Integration Configuration Guide
5.
The “Display metadata channel” opens a dialog that displays what SafeZone(-edge) instance is feeding a
given metadata channel with metadata
6.
“Configuration Reset” button will drop the current configuration and allows you to restart with a new
configuration from scratch.
Now that the metadata source is correctly configured, you need to add it to the XProtect system so that
XProtect can pull metadata our from SafeZone(-edge):
2
1
1.
In the Management Client, click on “Servers”, “Recording Servers”
2.
Select the Server and right-click on it, choose “Add hardware”
Configuration
Page 24
SafeZone-edge | Outputs & VMS Integration Configuration Guide
3.
Choose “Manual” and click “Next”
3
3
4.
Add a new couple of login/password using “root” as login and the password you set for the Metadata
source, then click “Next”
4
Configuration
Page 25
SafeZone-edge | Outputs & VMS Integration Configuration Guide
5.
Then select “Other”, “MIP Driver” as device type and click “Next”:
5
5
5
6.
Enter the IP address of the host where the SafeZone-edge Alarm & Metadata Bridge is installed. Use
the public external IP address of the host, even if it is installed locally, as 127.0.0.1 will not work. You
can use “netstat –an” and look to which IP address is associated to the listening socket open on port
TCP/50000 (or the port that has been chosen for the metadata source). For example, in the following
image the address to use is 192.168.90.66
6
Configuration
Page 26
SafeZone-edge | Outputs & VMS Integration Configuration Guide
6
6
Choose the “MIP Driver” Hardware Driver, because “(Auto-Detect)” will not work. Click on “Next”
7.
The metadata source will be detected and accepted by XProtect. Click “Next” again
7
8.
Enable (tick) as metadata channels as the Axis cameras running SafeZone-edge that will send metadata
to the system. Usually this means all the metadata channels available on the source, except if you
increased the number of channels manually to prepare future extensions. In this case, we recommend
ticking only the effectively used channels. For example, the following image shows how to enable the
two channels provided by the metadata source. Then click “next”
Configuration
Page 27
SafeZone-edge | Outputs & VMS Integration Configuration Guide
8
8
9.
Choose a group (or create a new one) for the “Default metadata group”, then click on “Finish”:
9
9
9
9
9
10. Select the newly added Metadata source “MIP Driver (192.168.90.66)” and check that XProtect is
correctly retrieving the metadata from the source by looking at the “1/0” animation in the “stream”
windows (if XProtect is retrieving metadata from the source, a set of “1/0” comes out from the central
cubes.):
Configuration
Page 28
SafeZone-edge | Outputs & VMS Integration Configuration Guide
10
10
10
11. If you don’t see any “1/0” near the central cube, there is a problem with the metadata retrieval,
probably due to the lack of a default rule:
11a. Check that you have a “Default Start Metadata Feed Rule” in the “Rules and Events” section,
and that the rule looks like in the following image:
11b. If the rule is missing, you must define it, proceed this way:
Configuration
Page 29
SafeZone-edge | Outputs & VMS Integration Configuration Guide
11c. In the “Rules and Events” section, right click on the “Rules” item and select “Add Rule”
Configuration
Page 30
SafeZone-edge | Outputs & VMS Integration Configuration Guide
11d. In the windows that opens, choose a meaningful name for the rule, than select “Perform an
action in a time interval” and click on “Next >”
Configuration
Page 31
SafeZone-edge | Outputs & VMS Integration Configuration Guide
11e. Choose “Always” and click on “Next >”
Configuration
Page 32
SafeZone-edge | Outputs & VMS Integration Configuration Guide
11f. Tick “Start feed on <devices>”, then click on “recording devices”
11g. Select “All Metadata” (or alternatively select a sub-set of the metadata input devices,
according to your needs) and then click on “Add” and on “OK”. Then click on “Next >” in the
“Manage Rule” window
Configuration
Page 33
SafeZone-edge | Outputs & VMS Integration Configuration Guide
11h. Select “Perform stop action when time interval ends” and click on “Next >”.
11i.
Click on “Finish” in the final window.
At the end of these steps, the XProtect system is correctly retrieving the metadata from SafeZone-edge and it is
able to display them in live mode on top of the corresponding video stream. However, XProtect does not record
the metadata, and hence the metadata cannot be played back when replying a recorded sequence. In order to
record them, you have to add a special rule in the management client.
Metadata recording activation
To activate the metadata recording, you have to define a rule in the XProtect System.
1.
Open the Management Client
Configuration
Page 34
SafeZone-edge | Outputs & VMS Integration Configuration Guide
2.
Click on “Rules and Events”, and then on “Rules”, then right-click on the “Rules” window:
2
3
3.
Choose “Add Rule”
4.
Choose a meaningful name and description for the new rule. Then choose “Perform an action in a time
interval” and choose “Next”
Configuration
Page 35
SafeZone-edge | Outputs & VMS Integration Configuration Guide
4
4
4
4
Configuration
Page 36
SafeZone-edge | Outputs & VMS Integration Configuration Guide
5.
Tick “Always” and click “Next”
5
5
Configuration
Page 37
SafeZone-edge | Outputs & VMS Integration Configuration Guide
6.
Tick “Start recording on <devices>”, then click on “recording device”
6
6
7.
Select all the metadata channels and move them to the right panel, into “Selected” by using the “Add:”
button. Then click on “OK” button:
Configuration
Page 38
SafeZone-edge | Outputs & VMS Integration Configuration Guide
7
7
7
7
Configuration
Page 39
SafeZone-edge | Outputs & VMS Integration Configuration Guide
8.
Click on “next” button:
8
Configuration
Page 40
SafeZone-edge | Outputs & VMS Integration Configuration Guide
9.
Select “Perform stop action when time interval ends” and click on “next” button:
9
9
10. Click on “Finish” button
11. To check that the metadata are correctly recorded, go to “Servers”, “Recording Servers”, expand your
recording server, then expand the “MIP Driver” and check that the icon near the MIP Driver channels
has a red square:
Configuration
Page 41
SafeZone-edge | Outputs & VMS Integration Configuration Guide
11
You might want to further tune this rule to, for example, only record the metadata when an event occurs. This is
possible, please consult the XProtect Documentation on how to define and customize rules.
In order to display the metadata in playback mode, the corresponding video stream must be recorded
too. The default setting to record video streams in Corporate is “on motion detection”. That means that
if there is not enough motion to trigger the video stream recording, even if the metadata recording is “always
on” it will not be possible to play it back.
How to use trigger further actions
The User Defined Events and Analytics Events triggered by the DB SafeZone(-edge) Alarm and Metadata Bridge
can be used to trigger further actions, more specifically:


Using the User Defined Events, specific rules can be used to:

Start image and metadata recording on alarms from SafeZone (or, in case a permanent
recording is in place, to raise the quality – resolution and/or framerate – of the recording

To send an email to specific recipients, containing images or videos from the camera that
triggered the alarm

To action an hardware output like a dry or wet contacts
Using the Analytics Event, a specific alarm can be triggered
How to start image recording using User Defined Events
1.
Select “Rules and Events”, then “Rules”
2.
Right-click on “Rule”
Configuration
Page 42
SafeZone-edge | Outputs & VMS Integration Configuration Guide
3.
Choose “Add Rule…”
2
3
1
4.
In the new dialog that opens, give to the rule a meaningful name and (optional) a description
5.
Choose the rule type “Perform an action on event…”
6.
Click on “event”
7.
In the new dialog that opens, unfold the User Defined Events group
8.
Select the event of interest
9.
Click on “ok”
4
5
7
8
6
9
10. On the previous dialog, click on “Next >”
Configuration
Page 43
SafeZone-edge | Outputs & VMS Integration Configuration Guide
10
11. On the next screen, choose an adapted time profile if you wish, or click “Next >” again
12
13
12. Select the action “Start recording on <devices>”
13. Click on “Recording device” and select the associated cameras that you want to record on the selected
User Defined Event, then click on “Next >”
14. Repeat the same steps to define the action to perform on “Stop” (if any) (for example, “stop the
recording after 60 seconds”)
15. Finish the rule definition by clicking on “Finish” button.
How to send an email using User Defined Events
In order to be able to send an email when SafeZone(-edge) triggers a specific User Defined Events, it is
necessary to define first an smtp server and then a notification profile:
1.
Click on the general menu “Tools” and then on “Options”
2.
In the dialog that opens, select the “Mail server” option and fill the corresponding information
Configuration
Page 44
SafeZone-edge | Outputs & VMS Integration Configuration Guide
3.
You have to provide a sender email, the ip/hostname of the smtp server address and, if it requires
authentication, the User name and Password to use
4.
Once finished, click the “OK” button
7
5
6
5.
Click on “Rules and Events”
6.
Click on “Notification Profiles”
7.
Right click on “Notification Profiles” and then select “Add Notification Profile”
8.
In the dialog that opens, give to the new notification profile a meaningful name and an optional
description, then click on the “Next >” button
Configuration
Page 45
SafeZone-edge | Outputs & VMS Integration Configuration Guide
9.
Customize the notification email using the next dialog and then click on “Finish”
Now you can define a rule that will send a notification using this profile. Repeat the steps 1-15 of the previous
section “How to start image recording using User Defined Events”, but choose as action to trigger “Send
notification to <profile>” and choose the email Notification Profile that you just defined:
How to open/close a dry contact using User Defined Events
In order to activate an output, you have to define a rule as described in the section “How to start image
recording using User Defined Events”. Repeat the corresponding steps 1-15, but choose “Set device output to
<state>” as the action to trigger:
Configuration
Page 46
SafeZone-edge | Outputs & VMS Integration Configuration Guide
And then choose the device output and the state that you want.
How to trigger an alarm from an Analytics Event
Analytics Events can be used to trigger an Alarm in the XProtect system. However, in order to be able to choose
an Analytics Event as a trigger for an alarm, the Analytics Event must be defined in the Management Client. If not
defined, the Analytics Event will still be triggered if the option is ticked, and as such, the Event Server and the
Smart Client will receive them, but it will not possible to use it to trigger a further Alarm.
To define an Analytics Event, proceed this way:
1.
Click on “Rules and Events” in the left pane
2.
Click on “Analytics Events”
3
1
2
3.
Right-click on “Analytics Events” in the central pane and click on “Add New…”
4.
Give to the Analytics Event a name following the pattern “DB SafeZone(-edge) ALERT_TYPE
START_STOP”, where ALERT_TYPE is one of the following values: “Intrusion”, “Loitering”, “ZoneCrossing”,
“Conditional” and START_STOP is one of the following values: “START” or “STOP”. For example, if you
want to trigger a rule when the Analytics Event associated with the start of an intrusion is received,
name the Analytics Event “DB SafeZone-edge Intrusion START”
5.
If you want, add a description to the Analytics Event
6.
Do not forget to save the configuration
Configuration
Page 47
SafeZone-edge | Outputs & VMS Integration Configuration Guide
4
5
Now the Analytics Event can be used to trigger an Alarm, as displayed in the next image. It is also further to
specify exactly which video camera must generate the Analytics Event for the corresponding Alarm to be
triggered, thus allowing to trigger different Alarms for different cameras.
Please refer to the Milestone Documentation for further details on how to define an Alarm.
Configuration
Page 48
SafeZone-edge | Outputs & VMS Integration Configuration Guide
Operating the Smart Client
This section describes how to receive and use in the Smart Client the metadata, the alarms, the user defined
events and the bookmarks. For a much more detailed description of the Smart Client functionalities, refer to the
Milestone documentation.
Alarms
Alarms are received in the Smart Client “Alarm Management” section:
By clicking on one of the alarm in the list, the corresponding video sequence is displayed in the video player.
Alarms can also be displayed in a tile of the “Live” tab, by commuting to the “Setup” mode and dragging the
“Alarm list” item into a free tile:
Operating the Smart Client
Page 49
SafeZone-edge | Outputs & VMS Integration Configuration Guide
If you are not interested in alarm reception in the Smart Client, you can deactivate the automatic triggering of
alarms by the SafeZone-edge Alarm & Metadata Bridge by using the Configuration Tool, as described in section
“Software installation on the host running the XProtect Recording Server
User defined events
Once the necessary User-defined Events have been defined, they can be received and monitored in the Smart
Client:
1.
Commute in the “Setup” mode
2.
If not already done, drag the “Alarm List” in a free time as described in the previous section
3.
Select the Alarm List tile
Operating the Smart Client
Page 50
SafeZone-edge | Outputs & VMS Integration Configuration Guide
4.
In the “Properties” section of the left panel, change the “Alarm” value of the combo box to “Event”:
5.
The SafeZone-edge triggered events are displayed in the corresponding tile when you commute back
from the “Setup” mode:
Operating the Smart Client
Page 51
SafeZone-edge | Outputs & VMS Integration Configuration Guide
6.
You can also switch from alarms to User-defined Events in the “Alarm Manager” tab, by following the
same procedure
Bookmarks
If the corresponding option is activated, bookmarks are automatically inserted in the corresponding video
stream when SafeZone-edge triggers an alarm. They can be retrieved in the Smart Client, for example in the
“Playback” tab:
Operating the Smart Client
Page 52
SafeZone-edge | Outputs & VMS Integration Configuration Guide
The Smart Client displays the bookmarks as grey “ticks” on the timeline.
Bookmarks can also be used to search for sequences in the “Sequence Explorer” tab:
1.
Click on the “Sequence Explorer” tab
2.
Select the camera(s) of interest
3.
Select “bookmarks” in the combo box
4.
Enter the string to search for in the bookmarks name, for example “SafeZone-edge”
5.
The corresponding “bookmarked” sequences are displayed in the lower pane
6.
The bookmark details are displayed in the right pane, and the corresponding sequence with the
metadata overlay is displayed in the video player
Operating the Smart Client
Page 53
SafeZone-edge | Outputs & VMS Integration Configuration Guide
1
6
2
3
4
5
Metadata display
The Smart Client automatically displays the metadata on top of the corresponding video stream, both in live and
in playback mode, in every video player in the Smart Client.
A typical metadata looks like in the following image:
Operating the Smart Client
Page 54
SafeZone-edge | Outputs & VMS Integration Configuration Guide
1
3
2
4
1.
The upper right corner of the image contains a colored spot, whose color is:
a.
Red, if SafeZone-edge is running and an alarm is triggering for the camera (in the screenshot
example, an intrusion alarm is generated by SafeZone-edge)
b.
Green, if SafeZone-edge is running and no alarm is triggered for the camera (for example, for
an intrusion scenario, if the person is walking outside the intrusion zone)
c.
Gray during a short period (30-60 seconds) after SafeZone-edge has been started. During this
phase SafeZone-edge is initializing and cannot generate alarms.
2.
A rectangle surrounds the persons and/or vehicles detected in the scene. The color of the bounding
box is red for persons and blue for vehicles
3.
The zones on ground relatives to the scenario(s) defined on the camera are displayed in blue. In this
screenshot the intrusion zone is displayed. In the previous screenshot (the one inside Security Desk)
one camera displays an intrusion zone and the other the two zones of a Zone-crossing scenario
4.
The approximate actor trajectory is displayed in red (for a person) or blue (for a vehicle)
The same overlay is also automatically displayed when the corresponding recorded video sequence is played
back.
Operating the Smart Client
Page 55
SafeZone-edge | Outputs & VMS Integration Configuration Guide
XProtect Enterprise
Configuration
Through the MIP Plugins for SafeZone-edge running in the XProtect Management Client it is possible to
configure different aspects of the system:

It is possible to scan the list of cameras defined within XProtect and automatically select those where
SafeZone-edge is installed (as explained in the first chapter)

The plugin allows the user to deactivate the automatic generation of XProtect Alarms when a
SafeZone-edge triggers an alarm (the alarm generation is activated by default)

The plugin allows the user to deactivate the automatic generation of XProtect Analytics Events when a
SafeZone-edge triggers an alarm (the Analytics Events is activated by default).
The following sections explain systematically how to configure a system and details the different available
options.
Alarms and Analytics events configuration through the Management
Client Plugin
Before configuring the software, both the MIP Plugin for the Management Client and the SafeZone-edge
Alarm & Metadata Bridge must be installed. In addition, the Alarm & Metadata Bridge must also be
configured to be able to access the XProtect System (as described in the previous section).
To configure the software, follow these steps:
10. Open the Management client, and add to the XProtect system all the cameras you need. You need to
add both the Axis cameras and/or encoders running SafeZone-edge and the video devices whose
video stream is analysed by SafeZone
11. Click on “MIP Plugins”, “Digital Barriers”, “SafeZone-edge” and you will get this configuration screen:
Configuration
Page 56
SafeZone-edge | Outputs & VMS Integration Configuration Guide
3
4
5
6
7
2
12. Click on the “Alarm configuration” tab
13. If you want to automatically trigger an XProtect alarm when SafeZone-edge generates one, tick the
“Automatically trigger alarms on SafeZone-edge alarm reception” option
14. If you want to automatically trigger an XProtect Video Analytics Event when SafeZone-edge generates
an alarm, tick the “Automatically trigger analytics events” option
15. In most of the cases, you don’t need to manually specify the destination ip address and listening port
for alarms (i.e., the port that the SafeZone(-edge) Alarm & Metadata Bridge will use to listen for
incoming alarms from SafeZone(-edge) and its ip address as used by the SafeZone(-edge) instances to
send alarms). In some special cases, like when there is a NAT or port forwarding between the
SafeZone(-edge) devices and the host where the Alarm & Metadata bridge runs), you might want to set
them manually. In this case, tick the “Set Manually” option and fill the ip address (or DNS hostname)
and port that the SafeZone(-edge) devices should use to send their alarms to the Alarm & Metadata
16. “Configuration Reset” button will drop the current configuration and allows you to restart with a new
configuration from scratch.
17. Do not forget to save the configuration changes by clicking on the button
18. When saving a new configuration, the SafeZone(-edge) Alarm & Metadata Bridge is automatically
restarted to take into account the new configuration.
How to use Analytics Events to trigger Alarms
Analytics Events can be used to trigger an Alarm in the XProtect system. However, in order to be able to choose
an Analytics Event as a trigger for an alarm, the Analytics Event must be defined in the Management Client. If not
defined, the Analytics Event will still be triggered if the option is ticked, and as such, the Event Server and the
Smart Client will receive them, but it will not possible to use it to trigger a further Alarm.
Configuration
Page 57
SafeZone-edge | Outputs & VMS Integration Configuration Guide
To define an Analytics Event, proceed this way:
1.
Click on “Events and Outputs” in the left pane and then right click on “Analytics Events”
2.
Click on “Create New”
1
2
3.
Give to the Analytics Event a name following the pattern “DB SafeZone(-edge) <ALERT_TYPE>
<START_STOP>”, where <ALERT_TYPE> is one of the following values: “Intrusion”, “Loitering”,
“ZoneCrossing”, “Conditional” and <START_STOP> is one of the following values: “START” or “STOP”. For
example, if you want to trigger a rule when the Analytics Event associated with the start of an intrusion
is received, name the Analytics Event “DB SafeZone(-edge) Intrusion START”
4.
If you want, add a description to the Analytics Event
5.
Do not forget to save the configuration
Now the Analytics Event can be used to trigger an Alarm, as displayed in the next image. It is also possible to
specify exactly which video camera must generate the Analytics Event for the corresponding Alarm to be
triggered, thus allowing to trigger different Alarms for different cameras.
Configuration
Page 58
SafeZone-edge | Outputs & VMS Integration Configuration Guide
Please refer to the Milestone Documentation for further details on how to define an Alarm.
How to use Manual Global Events to trigger further actions
It is possible to define Manual Global Events that are associated to specific cameras, SafeZone(-edge) scenarios
and scenario types (start/stop). The advantage of Manual Events is that in turn they can trigger specific actions
like sending emails, sending SMS or triggering hardware outputs (like dry or wet contacts).
The DB SafeZone-edge Alarm & Metadata Bridge automatically looks for defined Manual Global Events that
respect a certain format and if it founds them, it triggers automatically those satisfying the alarm conditions. It is
for example possible to define:

A Manual Event that is triggered on every alarm START from any camera

A Manual Event that is triggered on every alarm START of a specific camera

A Manual Event that is triggered on a specific scenario of a specific camera

Any combination of the previous three
Every Manual Global Event that is supposed to be triggered on a SafeZone(-edge) alarm must have a name that
respects a specific format: “DB SafeZone(-edge) <ScenarioName> <ScenarioType> on camera <CameraName>”
where:

<ScenarioName> is the name of the scenario as defined in the SafeZone Setup (cf the SafeZone
documentation). Usually it looks like “Intrusion-1”, but can be customized at configuration phase
through the SafeZone Setup. If you want the Manual Global Event to be triggered by any scenario, use
“ALL” as <ScenarioName>.

<ScenarioType> is either “START”, “STOP” or “ALL”. Use “ALL” if you want the Manual Global Event to be
triggered for both START and STOP alarms

<CameraName> is the name of the camera as defined in XProtect. When SafeZone(-edge) triggers an
alarm, it does so by analysing images from a camera/encoder that must also be present in XProtect.
For SafeZone-edge, this is the camera/encoder where SafeZone-edge is installed, and for SafeZone this
Configuration
Page 59
SafeZone-edge | Outputs & VMS Integration Configuration Guide
is the camera/encoder that has been associated to the SafeZone video stream (cf section “Error!
eference source not found.” on page Error! Bookmark not defined.). <CameraName> is the name of
the associated XProtect Camera. Use “ALL” if the Manual Global Event must be triggered by SafeZone(edge) alarms associated to any XProtect camera.
If you want to use an XProtect Camera Name as <CameraName>, it cannot contain spaces. You can
rename the XProtect Camera and remove all spaces from the camera name, or use ALL as
<CameraName>.
The three parameters <ScenarioName>, <ScenarioType>, <CameraName> are all case insensitive, so
lowercase and uppercase letters are considered the same.
Here some examples of Manual Global Events and by which SafeZone(-edge) alarms they will be triggered:

“DB SafeZone(-edge) Intrusion-1 START on camera ALL”: will be triggered by any SafeZone(-edge)
alarms START related to a scenario called “Intrusion-1” from any camera

“DB SafeZone(-edge) ALL ALL on camera IP250”: will be triggered by any SafeZone(-edge) alarm START
or STOP related to any scenario from the XProtect Camera “IP250”

“DB SafeZone(-edge) ALL START on camera ALL”: will be triggered by any SafeZone(-edge) alarm START
related to any scenario from any camera

“DB SafeZone(-edge) ZoneCrossing-1 STOP on camera IP250”: will be triggered by any SafeZone(-edge)
alarms STOP related to the scenario “ZoneCrossing-1” from XProtect camera “IP250”
In order to define a new Manual Global Event, proceed this way:
1.
Unfold the left menu entry “Events and Outputs”
2.
Unfold the sub-menu entry “Manual Events”
3.
Right-click on sub-menu entry “Global”
4.
Click on “Properties”
Configuration
Page 60
SafeZone-edge | Outputs & VMS Integration Configuration Guide
1
2
3-4
5
7
8
9
6
5.
Select “Global”
6.
Click on “Add” button
7.
Fill the Even Name
8.
Tick, if you wish, the “Send e-mail if this event occurs” option
Configuration
10
Page 61
SafeZone-edge | Outputs & VMS Integration Configuration Guide
9.
Tick, if you wish, the “Send SMS if this event occurs”
10. Click on “OK” button
Now you can use the Manual Global Event to trigger a Hardware Output:
3
2
1
4
1.
Right click on “Output Control on Event” entry of menu “Events and Outputs”, then click on “Properties”
2.
In the new widget, choose the Manual Global Event of interest in the left column
3.
Select the Output Hardware you want to activate in the right column
4.
Click on “OK” button
Operating the Smart Client
This section describes how to receive and use in the Smart Client the alarms and the Manual Global events. For
a much more detailed description of the Smart Client functionalities, refer to the Milestone documentation.
Alarms
Alarms are received in the Smart Client “Alarm Management” section:
Operating the Smart Client
Page 62
SafeZone-edge | Outputs & VMS Integration Configuration Guide
By clicking on one of the alarm in the list, the corresponding video sequence is displayed in the video player.
Alarms can also be displayed in a tile of the “Live” tab, by commuting to the “Setup” mode and dragging the
“Alarm list” item into a free tile:
Operating the Smart Client
Page 63
SafeZone-edge | Outputs & VMS Integration Configuration Guide
If you are not interested in alarm reception in the Smart Client, you can deactivate the automatic triggering of
alarms by the SafeZone-edge Alarm & Metadata Bridge by using the Configuration Tool, as described in section
“Software installation on the host running the XProtect Recording Server
Manual Global events
Once the necessary Manual Global Events have been defined, they can be received and monitored in the Smart
Client:
1.
Commute in the “Setup” mode
2.
If not already done, drag the “Alarm List” in a free time as described in the previous section
3.
Select the Alarm List tile
Operating the Smart Client
Page 64
SafeZone-edge | Outputs & VMS Integration Configuration Guide
4.
In the “Properties” section of the left panel, change the “Alarm” value of the combo box to “Event”:
5.
The SafeZone-edge triggered events are displayed in the corresponding tile when you commute back
from the “Setup” mode:
Operating the Smart Client
Page 65
SafeZone-edge | Outputs & VMS Integration Configuration Guide
6.
You can also switch from Alarms to Manual Global Events in the “Alarm Manager” tab, by following the
same procedure
Operating the Smart Client
Page 66