Honeywell Pro-Watch

XProtect Access
Integration
User’s Manual
v1.0
Honeywell Pro-Watch XProtect Access Integration User’s Manual V. 1.0

Target Audience for this Document

This installation and configuration part of this document is aimed at system administrators of both the Milestone
XProtect software and the Honeywell Pro-Watch software.
The operation part of this document is aimed at users with basic knowledge of the Milestone XProtect software.

www.milestonesys.com Page 2 Target Audience for this Document

Honeywell Pro-Watch XProtect Access Integration User’s Manual V. 1.0

Contents
................................................................................................................................ 1

COPYRIGHT, TRADEMARKS & DISCLAIMERS ............................. 5

Copyright ................................................................................................................ 5
Trademarks ............................................................................................................. 5
Disclaimer ............................................................................................................... 5

GENERAL DESCRIPTION................................................................ 6
Limitations ......................................................................................................................... 6
Warning ........................................................................................................................ 6
Introduction .......................................................................................................................... 6
Solution overview ................................................................................................................ 7

INSTALLATION ................................................................................ 8
Prerequisites ........................................................................................................................ 8
Installation procedure .......................................................................................................... 8
Configuration ........................................................................................................................ 9
Required configuration of Honeywell Pro-watch .......................................................... 9
Adding Honeywell Pro-Watch system to Milestone XProtect .................................... 11
XML files.............................................................................................................................. 12
LogLevel.xml ................................................................................................................... 12
ProWatchEvents.xml....................................................................................................... 13
<Type>Properties.xml ..................................................................................................... 13

OPERATION ................................................................................... 14
Events and Categories ...................................................................................................... 14
Alarm setup ........................................................................................................................ 16
Alarm manager tab ......................................................................................................... 18
Map functionality ............................................................................................................. 18
Alarm overview and alarm handling ................................................................................ 19
Associated cameras ........................................................................................................ 19

www.milestonesys.com Page 3 Contents

Honeywell Pro-Watch XProtect Access Integration User’s Manual V. 1.0

Status details................................................................................................................... 19
Access Control tab ............................................................................................................ 20
See a list of doors ........................................................................................................... 20
See a list of events .......................................................................................................... 21
Filter the list by different criterias .................................................................................... 21
See video for a particular door and execute commands on a door ................................ 22
Live Tab ............................................................................................................................... 22
Setting up the live view ................................................................................................... 22
Additional information ....................................................................................................... 23

www.milestonesys.com Page 4 Contents

Honeywell Pro-Watch XProtect Access Integration User’s Manual V. 1.0

Copyright, Trademarks & Disclaimers

Copyright
© 2017 Milestone Systems A/S.

Trademarks
XProtect is a registered trademark of Milestone Systems A/S.
Microsoft and Windows are registered trademarks of Microsoft Corporation.
All other trademarks mentioned in this document are trademarks of their respective owners.

Disclaimer
This document is intended for general information purposes only, and due care has been taken in its preparation.
Any risk arising from the use of this information rests with the recipient, and nothing herein should be construed
as constituting any kind of warranty.
Milestone Systems A/S reserve the right to make adjustments without prior notification.
All names of people and organizations used in this document's examples are fictitious. Any resemblance to any
actual organization or person, living or dead, is purely coincidental and unintended.
This product may make use of third party software for which specific terms and conditions may apply. When that
is the case, you can find more information in the file 3rd_party_software_terms_and_conditions.txt located in your
Milestone surveillance system installation folder.

www.milestonesys.com Page 5 Copyright, Trademarks & Disclaimers

General description

Limitations
The current version will only support AccessDoors and partially support AccessPoints. It is strongly recommended
that an access point is turned in to an access door in the outbound configuration defined in Pro-Watch. The
limitations means that AccessZones and IODevices is ignored.
The initial state of an access door with regards to whether the door is locked and closed is determined by the
“Status” property for “Door Position” and “Lock” property of the IO devices associated with the access door.
To understand the above please refer to result from querying the HSDKPNLApplicationModule for an access door
in a browser. Browse to “<Ip address> /HSDKPNLApplicationModule/pacs/accessDoors/ “. The “<Ip address>”
referes to the ip address of the server hosting the Pro-Watch HSDKPNLApplicationModule.
An access point in XProtect Access must be attached to a door. So a Pro-Watch access point is automatically
associated with a door. The correctness of the initial state of an access point cannot be quarantined. Initially it will
be set to locked and closed.
In addition alarms from Pro-Watch is automatically acknowledged at the time they are received by the plug-in, and
not when the operator acknowledge it in the XProtext Smart Client.

Warning
The Honeywell HSDK supports only a single system querying for events. This means that only a single XProtect
Event Server must access the HSDK at a time. If more than one event server accesses the HSDK, the receving of
events will become unpredictable.
Example.
The HSDK comes with a “HSDK Test Client” running, this quering for events (setting up a watch), together with a
XProtect Event Server, will lead to unpredictable behavior.

Introduction
The Honeywell Pro-Watch integration is an XProtect Access plug-in, which supports a number of features
including:
 Control of access points and access doors directly from the Milestone XProtect software
 Events from Honeywell Pro-Watch are directly supported so they can be used for i.e. alarms and rules
 Status monitoring of Honeywell Pro-Watch objects such as access doors and access points
 Cardholders are integrated directly into Milestone XProtect software including image support
 Reading the configuration of the Pro-Watch system
 Association of cameras and access points to provide live monitoring of events

6
Solution overview
The solution conists of an XProtect Event Server plug-in which communicates with the Honeywell Software
Development Kit as illustrated here:

<Event Server> <-> <HSDK> <-> <Pro-Watch System> <-> <Panel>

The event server plug-in reads an xml file which is installed along with the plug-in. This xml file contains a list of
defined events.

7
Installation

Prerequisites
Installed Honeywell Software
 Honeywell Pro-Watch 4.2
 HSDK 2.1.36.0 (an application module is required for communication – see configuration paragraph)
This integration is supported by the following Milestone XProtect software:
 Milestone XProtect Corporate 10.a or newer
 Milestone XProtect Expert 10.a or newer
 Milestone XProtect Enterprise 10.a or newer
 Milestone XProtect Professional 10.a or newer
 Milestone XProtect Express 10.a or newer

Installation procedure
To install the integration simply run the installation file named ‘ProWatchInstallation_x64.msi’, the integration only
support 64-bit Windows.
Follow the steps in the installation wizard to complete the installation.
The following folders are created once the installation has completed:
C:\Program Files\Milestone\MIPPlugins\ProWatchAccessControlPlugin
C:\ProgramData\Milestone\ProWatchAccessControlPlugin

The first folder contains the actual data files of the plug-in which are loaded by the event server and offers the
actual integration functionality.
The second folder contains a number of configurable data files which are described in detail in the configuration
paragraph.

The XProtect Event Server must be restarted to enable the integration.

8
Configuration

Required configuration of Honeywell Pro-watch

The communication between the Honeywell Pro-Watch system and the Milestone XProtect software requires an
HSDK application module as described earlier.

This is an example of an application module based on the HSDK:

The Lobby URI is the end point used for communication with the Milestone XProtect software.

9
To expose objects to the Milestone XProtect system they must be added to the outbound configuration as
illustrated here:

After the installation has completed the XProtect Event Server and the Management Client must be restarted.

10
Adding Honeywell Pro-Watch system to Milestone XProtect
Inorder to integrate the Honeywell Pro-Watch system to a Milestone XProtect system you need to open either the
Management Application (XProtect Enterprise) or the Management Client (XProtect Corporate) depending on the
Milestone XProtect system enterprise or corporate.
This manual will display screenshots from the Management Client but very similar functionality is available in the
Management Application.
To add the Honeywell Pro-Watch system locate the ‘Access Control’ node and use the right-click menu to start
the process as illustrated here:

On the ‘Integration plug-in’ dropdown select ‘Pro-Watch’, and add the information to the screen shown below:

11
Name: Defines the name of the integration.
Integration plug-in: The selected integration.
IP Address: The IP address of the HSDK Lobby URI.
Port: Port number of HSDK Lobby URI.
Https: Defines if https should be used for connecting to Lobby, adjust port to match.
User name: User with administration rights on the Honeywell Pro-Watch system.
Password: Password of the admi user.
Application Name: The name of the application module.
Event Polling Interval: Defines the event polling interval, should normally be left on default value.
State Polling Interval: Defines the state polling interval, should normally be left on default value.

XML files
XML files are used to configure the Honeywell Pro-Watch XProtect Access plug-in.
These files are typically found in the folder “c:\ProgramData/Milestone/ProWatchAccessControlPlugin”. The files
are installed together with the installation of the plug-in. Addtiontions and changes to the files can be done after
installation. Typically for the changes to take effect the XProtect Event Server must be restarted.

LogLevel.xml
In this file the verbosity of the logging can be specified. Under normal operation the value should be set to “error”.
Meaning that only errors are logged, when debugging set it to “debug”. The two log files are found in
“C:\ProgramData\Milestone\XProtect Event Server\logs” and “C:\ProgramData\Milestone\XProtect Event
Server\logs\MIPLogs”. The latter will show information on events received from Pro-Watch when the log level is
“debug”, which is helpful in test and debugging.
12
ProWatchEvents.xml
This file contains a list of events and the object types they apply to. The snippet below shows an entry in the file,
defining the event “Access Granted” with the address number 500 for the types “Access Point”´, “AccessPointExtn
” and AccessDoor. The address is a number supplied by Pro-Watch. Adding events is difficult because one must
know the address of the event in Pro-Watch. Your Pro-Watch representative should be able to help you with that.
<ProWatchEvent Address="500" Description="Access Granted">
<Types>
<Type>Access Point</Type>
<Type>AccessPointExtn</Type>
<Type>AccessDoor</Type>
</Types>
</ProWatchEvent>
Changes to the ProWatchEvents file will not take effect until the configuration is reloaded from the XProtect
Management Client or Management Application. Restarting the XProtect Event Server is not required.

<Type>Properties.xml
Files having the suffix “Properties”. And the possible prefixes: “AccessDoor”, “AccessPointExtn”, “AccessPoint”
and “AccessUser”. An example of a complete name is “AccessDoorProperties.xml”.
These XML files specifies the properties shown for an object of type <Type>, see the folder for examples. When
the file is not present all properties will be shown. When present only the properties specified in the file will be
displayed. The property name will be the name received from Pro-Watch, but a different name can be specified as
shown in the snippet below. Adding “displayName="In Alarm" for the property “InAlarm” will cange the properties
name from “InAlarm” to “In Alarm” when displayed in the XProtect Smart Client or XProtect Management Client /
XProtect Management Application.

<DisplayProperties>
<Property name="Version"/>
<Property name="ID"/>
<Property name="Present_Value"/>
<Property name="InAlarm" displayName="In Alarm"/>
<Property name="Out_Of_Service" displayName="Out Of Service"/>
</DisplayProperties>
The XProtect Event Server must be restarted for any changes to take effect.
Be aware that only ascii characters can be used, no special languages characters. Using other characters
will result in an error that will prevent the XProtect Event Server from starting.

13
Operation
Since the Honeywell Pro-Watch XProtect Access Integration is developed as an XProtect Access plug-in the user
interface for all operations is part of the standard XProtect product (XProtect Management Client / XProtect
Management Application or XProtect Smart Client).
Below is a short guide to utilizing the build in XProtect Access functionality of the standard products.

Events and Categories

Events from Honeywell Pro-Watch is forwarded and handled by the integration. Because of the large amount of
different events available in the Honeywell Pro-Watch system, it is advisable to group these in order to manage
them. Events belonging to the same group will generate the same behavior in the Smart Client. There are 7 build
in “Event Categories” by which the events can be grouped and it is possible to add user defined categories. Think
of a category as a label that assignes behavior to an event. An event can belong to more than one category. One
category is “Alarm”. The events “Lost Card Attempt”, “Door Kept Open” and “Forced Door” are good candidates
for the “Alarm” category because it is most likely events that an operator should react upon and they are serious.
All the build in categories have predefined behavior, the “Alarm” category will give the operator visual clues in the
XProtect Smart Client that alerts him to take action.
The events can be viewed and assigned to categories in the XProtect Management Client / XProtect
Management Application.

Above the event “500: Access Granted” is attached to the category “Access granted”.
To the left of the “500: Access Granted” is a check mark, this means that the event is active and can generate
behavior in the XProtect Smart Client.
Unchecked events are ignored and will not generate behavior in the XProtect Smart Client.
The “500: Access Granted” event belongs to the category “Access granted”. When this event occurs on a door,
the operator is notified visually. On the below screenshot, the operator is notified that access has been granted to
a credential holder. The notification is shown to the right of the video footage from camera monitoring the door,
where the access was granted. Below access was granted to the card holder “Jane Doe”.age

14
As mentioned attaching events to categories groups the events and enables unified behavior for a group of
events. Below the event “409: Deactivated Card Attempt” is attached to the “Access request” category.

The XProtect Smart Client behavior on events attached to the “Access request” category is to show a screen
enabling the operator to grant or deny access. The screen will show the video associated with request and the
credential holder requesting access.
There is default behavior assocated with the “Access request” categories but also the possibility to change this
behavior.
For example: On an access request a screen is shown, this screen can also be called a fly in, the screen “flies” in
from the left on top of the XProtect Smart Client. This fly in shows footage from the camera toghether with
information on the credential holder requesting access. It also provides a button enabling the operator to grant
access.
In Honeywell Pro-Watch the command “MomentarilyUnlock” is associated with an access request. This means
that on the fly in a button labeled “MonentaryUnLock” enables the operator to grant access. This behavior is build
in and defined in a rule named “Default Show Access Request Notification Rule” (In the Management Client tree-
view select “Rules and Events” and then “Rules”). The behavior can be changed by making a different rule and
specifying it under the tab “Access Request Notification”.

15
Both events and categories can be used in a rule creation. As it can be seen from the screen shot below both
events and categories are integrated in the “Select an Event” screen and makes it easy to setup rules based on
the events introduced by the XProtect Access plug-in.

Alarm setup
Some events are severe and should generate an alarm. These events should be assigned to the the Alarm
Category mentioned above and an alarm definition should be setup. Alarms are setup in the XProtect
Management Client / XProtect Management Application under “Alarms” see the picture below.

16
On the right hand you can set the properties for an alarm. Events from the access control system are available.
To create an alarm on all access control events that belong to the Alarm category, choose the settings shown
below.

17
In addition to selecting events and categories a source can be specified. The source can be all the objects
defined in the access control configuration. But typically “All doors” should be selected.

When an alarm is received there will be several visual clues in the XProtect Smart Client alerting the operator to
take action on the alarm.

Alarm manager tab

Functionality overview
1. Map functionality
2. Alarm overview
3. Alarm handling
4. Associated cameras
5. Status details

Map functionality
With the map functionality doors can be added to a map. Add doors by entering setup mode. In the tools window
click the “Add Access Control” image (see below) and select the items that should be added to the map.
The doors will be shown as with icons indicating the doors state. A read door with closed padlock is closed and
locked, a green door with an open padlock unlocked and closed etc. On the image below the status of the
Honeywell Pro-Watch server is also displayed, so in addition to doors other elements can be added too.
If a door gets an alarm the this will be indicated on the map by a flashing red circle around the door icon.

18
More information about map functionality can be found in the XProtect Smart Client User’s Manual.

A possible usage of the map functionality would be to make a floor layout containing the doors. This would enable
Part of the functionality added to the XProtect Smart Client is the Alarm manager tab. Alarms are handled under
this tab a screen dump is shown below.

Alarm overview and alarm handling

In addition to a map, the “Alarm Manager” tab contains an area that filters the alarms in 4 groups and enables the
processing of alarms. The filter groups are “New”, “In progress”, “On hold” and “Closed”. The operator can move
an alarm from the “New” filter to the “In progress” filter by right clicking on the door with the alarm on the map and
choose “Acknowledge Alarm”. The same and more functionality is available in the list displaying the content of the
filters. Just right click on the line showing the alarm and choose the appropriate functionality.

Associated cameras
Video footage is shown for the door selected on the map. If the door is associated with a camera.

Status details
Honeywell Pro-Watch provides a lot of information about a door. This information is available as “Status details”
for a door. Right click on the door on the map and select “Status details”. To summarise a door has state, is it
locked or unlocked, closed or open, this state is reflected in the icon for the door as mentioned above. It also has
status details which is a list of properties, a property name and a value.
Below a right click on the green door, gives a menu on which the “Status Details” can be selected. To the right of
the menu the properties is shown. The door is Unlocked and Closed and has the properties Name, ID etc.

19
Access Control tab
On the access control tab
1. See a list of doors
2. See a list of events
3. Filter the list by different criterias
4. See video for a particular door
5. Execute commands on a door.

See a list of doors

The “Access Control” tab is in one of two modes with regards to what it displays information about.
Events or Doors.

20
The above state is “Doors” the list shows information about doors. The list is filtered on the name of the door,
displaying only the doors with “Entry” in the name. In addition only doors of type “Artificial Door and Door” is
displayed in the list. The remaining two filters “All states” and “All doors” does not limit the number of doors
shown. If the “All states” filter is changed to “Door unlocked” and the “Entry two Door” is changed from being
locked to unlocked, the below would be displayed.

See a list of events

Just change the selection as shown below and use the filters appropriately. Observe that the search filter now
filters on the Cardholder, showing only events for cardholders having “John” in there name.

Filter the list by different criterias

The different filter criterias is mentioned above.

21
See video for a particular door and execute commands on a door
When either a door or an event is selected in the list, the associated video is displayed to the right of the list
toghether with other information. When a door is selected the available commands that can be executed on the
door e.g. Locking or Unlocking the door is available under the video. When an event is selected information about
the cardholder is displayed, when available.

Live Tab
The live tab is perhaps the most important tab because this is what the operator will be monitoring. The layout of
this tab is determined by the view item. It will though, always keep a list of events on the right side of the camera
displaying video for the associated door and the list of possible commands at the bottom of this list.

Setting up the live view

In the live tab go in to setup mode. Select a view and then select “Access Monitor” shown in yellow below and
drag it into the the view. Assign a door to each view item. That is all.

Acknowledge Alarms
The Smart Client opereator can acknowledge and close alarms. Alarms from Pro-watch that are acknowledged in
the Smart Client will also be acknowledged in Pro-Watch. Alarms that are closed in the Smart Client will be
cleared in Pro-Watch. In Pro-Watch alarms can be in 3 states, not acknowledged, acknowledged and cleared.
Milestone also has a state named “On hold”. Setting Pro-Watch alarms “on hold” in the Smart Client will not
change the state of the alarm in Pro-Watch.
Pro-watch alarms are only registered when the integration is loaded and the event server is running. That means
that if the event server is stopped, then alarms issued while the event server is stopped will not be shown in the
Smart Client and the alarms will not be displayed when the event server is restarted. In short historical events are
not read by Pro-watch integration.
22
Additional information
Additional information can be found in the:
XProtect Smart Client Users manual
XProtect Advanced VMS Administrator manual

20166Administrator Manual

Milestone Systems offices are

located across the world. For
details about office addresses,
phone and fax numbers, visit
www.milestonesys.com.

23