milestone XProtect Event Proxy User Guide
Event Proxy User Guide Copyright, Trademarks and Important Information Copyright © 2009 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.
Event Proxy User Guide Contents INTRODUCTION.......................................................... 4 Prerequisites ...................................................................................... 4 INSTALLATION ........................................................... 5 Event Proxy Components ...................................................................... 5 CONFIGURATION........................................................ 6 The Rules and Events Tab .................................
Event Proxy User Guide Introduction Milestone Event Proxy is an add-on program to the Milestone XProtect Enterprise and Professional surveillance systems. In order to minimise false alarms the Event Proxy acts as a filter on incoming input events from third party applications to the Milestone XProtect surveillance system. Third party applications communicate with the surveillance system through a custom made interface.
Event Proxy User Guide Installation To install the event proxy, run the EventProxyInstaller.exe file and follow the instructions in the setup program. After installation, the system is ready for configuration. Event Proxy Components The event proxy installation consists of: File Description VideoOS.EventProxy.EventProxyService.exe The application. Runs as a Windows service. VideoOS.EventProxy.ProxySetup.exe The GUI used to set up the system. VideoOS.Diagnostics.Logging.dll, VideoOS.EventProxy.
Event Proxy User Guide Configuration Double-click the VideoOS.EventProxy.ProxySetup.exe file to open the Event Proxy Setup 1.0 window which gives you access to all configuration features. IMPORTANT: This version of the Event Proxy supports characters from Windows code page 20127 only, i.e. American 7-bit characters. Use of national characters anywhere in events or rules may cause the system to malfunction.
Event Proxy User Guide The Rules and Events tab and the Communication tab. The Rules and Events Tab On the Rules and Events tab you are able to configure following settings: Input events (see Input Events on page 8 for more information) Output events (see Output Events on page 10 for more information) States (see States on page 11 for more information) Rules (see Rules on page 12 for more information) www.milestonesys.
Event Proxy User Guide The Communication Tab On the Communication tab you are able to configure following settings: How to receive input (see Receiving Input Events on page 14 for more information) How to send output events (see Sending Output Events on page 15 for more information) Logs (see Logs on page 15 for more information) Input Events You are able to add, edit and delete input events in the Rules and Events tab’s Input Events group box.
Event Proxy User Guide Editing an Input Event To edit an input event, do the following: 1. Select the required input event in the Input Events group box. 2. Click the Edit button, or press the F2 key on the keyboard. The Edit Input Event window opens. 3. Change the required settings, and click the OK button or press the Enter key on the keyboard to accept the changes.
Event Proxy User Guide Output Events You are able to add, edit and delete output events in the Rules and Events tab’s Output Events group box. The Output Events group box on the Rules and Events tab. Adding an Output Event To add an output event, do the following: 1. Click the Add button in the Output Events group box. Alternatively press the Insert key on the keyboard when the output events list view is active. The Create Output Event window opens. 2.
Event Proxy User Guide States You are able to add, edit and delete states in the Rules and Events tab’s Rules group box. Adding a State To add a state, do the following: 1. Click the Add button in the Sates group box. Alternatively press the Insert key on the keyboard when the states list view is active. The Create State window opens: 2. Enter a unique name for the state in the State Name text box. 3.
Event Proxy User Guide Deleting a State To delete a state, select the required state in the Stats group box, and press the Delete button. Rules You are able to add, edit and delete rules in the Rules and Events tab’s Rules group box. The Rules group box on the Rules and Events tab. Adding a Rule To add a rule, do the following: 1. Click the Add button in the Rules group box. Alternatively press the Insert key on the keyboard when the rules list view is active. The Create Rule window opens: www.
Event Proxy User Guide 2. Enter a unique name for the rule in the Rule name text box. 3. In the Output event combo box select which output event to trigger when the conditions of the rule (input events and logical expression) are fulfilled. 4. Enter how many seconds the rule should be active by entering the number of seconds in the Rule timeout (seconds) control.
Event Proxy User Guide text (i.e. “&” or “AND”) by toggling the Show operator as symbol check box. 6. Click the OK button or press the Enter key on the keyboard to accept the entered values.
Event Proxy User Guide The Receive input events on group box on the Communication tab. To configure how the event proxy should receive input events from a third party application, do the following: 1. From the Communication tab, select the TCP or UDP option button depending on it is a TCP or UDP-based event. 2. Enter the port number for the communication in the Port text box. 3.
Event Proxy User Guide The Logging group box on the Communication tab. To configure how much information you would like to log, select or deselect the following check boxes: Check box Description Log input events Logging of input event arrivals. Log output events Logging of output events sent. Log rule engine events Logging of rule engine events. A rule engine event is when the conditions of the rule (input events and logical expression) are fulfilled.
Event Proxy User Guide Milestone Systems offices are located across the world. For details about office addresses, phone and fax numbers, visit www.milestonesys.com. www.milestonesys.
