* The preview only display some random pages of manuals. You can download
full content via the form below.
Avigilon Interface Guide August 2015
SATEON Avigilon Interface Guide Issue 2.0, released August 2015
Disclaimer Copyright © 2015, Grosvenor Technology. All rights reserved. SATEON and the SATEON logo are trademarks or registered trademarks of Grosvenor Technology. All other brands, names, or trademarks appearing in this document are acknowledged as the trademarks of their respective owners. No part of this document may be reproduced in any form or by any means for any purpose without the written permission of Grosvenor Technology. Whilst we make every effort to ensure the accuracy of our publications, Grosvenor Technology assumes no responsibility or liability for any errors or inaccuracies that may appear in this document.
www.grosvenortechnology.com
SATEON Avigilon Interface Guide
2
Version 2.0 August 2015
Contents
Preface ..............................................................................................................................4 About the Avigilon interface to SATEON ..........................................................................................4 About this guide ...............................................................................................................................4 Related documents...........................................................................................................................5 Technical support .............................................................................................................................5
Introduction ......................................................................................................................6 Overview of the Avigilon interface ...................................................................................................6 Prerequisites .....................................................................................................................................6 Installation ................................................................................................................................6 Checking the service .................................................................................................................7 Checking the licence .................................................................................................................7
Setting up the Avigilon interface ........................................................................................9 Updating the SATEON database .......................................................................................................9 Setting up the connection ..............................................................................................................10 Defining the events that are sent ...................................................................................................11 Viewing the Avigilon forwarding rule .....................................................................................11 Adding the Avigilon POS Alarm topic to event rules...............................................................13
Troubleshooting .............................................................................................................. 15 Avigilon interface events reported in SATEON ...............................................................................15 Avigilon Event Gateway events...............................................................................................15 Avigilon Forwarding Rule events ............................................................................................16 Configuration errors .......................................................................................................................16 Incorrect IP address/port ........................................................................................................17 Invalid licence file....................................................................................................................17 Checking log files ............................................................................................................................17
SATEON Avigilon Interface Guide
3
Version 2.0 August 2015
Preface
This document provides information on configuring the SATEON Avigilon interface, which enables events to be sent from SATEON to an Avigilon Control Centre system. The interface has been documented for SATEON Release 2.9: it may not include changes incorporated in later versions of the software. Representations of screens in this document are shown for general illustration only: there may be some differences in the screens you see, depending on the operating system and the computer configuration. Date of latest update: August 2015.
About the Avigilon interface to SATEON SATEON is a powerful yet easy-to-use browser-based access control system that allows users to manage and monitor physical access to sites. It integrates access control, alarm and incident monitoring and comprehensive reporting facilities. SATEON supports interfaces to third-party security systems such as alarms and CCTV systems. The Avigilon interface is based on the Event Gateway, an optional SATEON module that enables users to configure and send commands to one or more external systems when certain system events occur.
About this guide This document explains how to configure the Avigilon interface, test its operation and view associated information within the SATEON interface. It is aimed at installers and system managers who are responsible for setting up and configuring interfaces to third-party systems. It assumes familiarity with SATEON. Note: This guide does not provide information on any configuration of the Avigilon Control Centre system that may be necessary.
SATEON Avigilon Interface Guide
4
Version 2.0 August 2015
Related documents The following SATEON documents may also be useful:
SATEON Installation Guide. This guide explains how to install SATEON, including details of software prerequisites and licensing.
SATEON Access Control Guide. This guide explains how to set up the access control features of SATEON, including setting up system hardware, people and tokens.
SATEON Control Centre Guide. This document explains how to use the Control Centre module to view reported events in real-time and control and monitor system equipment.
SATEON Event Configuration Guide. This document explains how to set up the way in which system events are displayed, reported and used.
SATEON Event Gateway Guide. This document provides full details on installing and setting up the Event Gateway module, which is required to implement the Avigilon interface.
Technical support For further assistance with SATEON, please contact Grosvenor Technology Technical Support as follows: Email (EMEA):
[email protected]
Email (US):
[email protected]
Email (APAC):
[email protected]
Website:
www.grosvenortechnology.com
SATEON Avigilon Interface Guide
5
Version 2.0 August 2015
Section 1
Introduction
Overview of the Avigilon interface The Avigilon interface is based on the Event Gateway, an optional SATEON module that provides a generic interface to third-party systems, such as CCTV systems, with minimal configuration. The Event Gateway provides the Windows service that manages communication between the main SATEON system and the Avigilon video system. A SQL script is provided that updates the appropriate database tables. You then need to set up the IP address and port of the Avigilon system, and define the events that are to be forwarded to Avigilon. Once configured, the interface will run with no further intervention, sending commands to the Avigilon Control Centre when specific events occur within the SATEON system.
Prerequisites Before configuring the interface, you need to ensure that the Event Gateway module is installed and its associated Windows service is running. You also need to ensure that the system is licensed for the Event Gateway.
Installation The Event Gateway module is normally installed as part of the SATEON installation, whether you use the “one-step” SATEON installation process (Sateon Setup.exe), or the advanced installation (Sateon Installer.msi). However it is not visible in the user interface unless a valid licence is present.
SATEON Avigilon Interface Guide
6
Version 2.0 August 2015
If it has not been installed it will be necessary to install it separately. See the Event Gateway Guide for full details.
Checking the service The associated Event Gateway service should start automatically following installation. If necessary, you can manage it from the Administrative Tools > Services dialog:
Events occurring within the Event Gateway are logged and can be viewed within the Windows Event Viewer or in the SATEON Real Time Diagnostics tool. For details, see Checking log files on page 17.
Checking the licence The Avigilon interface requires the Event Gateway module which is an optional, separately licensed SATEON feature. You need to ensure that the licence includes support for the SATEON Event Gateway capability, and if necessary, upgrade your licence file. You can add a new licence from the System Configuration > System Administration > Licensing page within SATEON. For full details on how to add a licence file, see the SATEON Installation Guide. For a new installation the licence needs to be validated within 30 days for SATEON to continue to work. Note: If you do not have a valid licence file yet, contact Grosvenor Technical Support as soon as possible. The Licencing page shows the maximum number of third-party systems supported by the Event Gateway module:
SATEON Avigilon Interface Guide
7
Version 2.0 August 2015
Note: The number of licensed interfaces includes all Event Gateway interfaces, not just Avigilon interfaces.
SATEON Avigilon Interface Guide
8
Version 2.0 August 2015
Section 2
Setting up the Avigilon interface
Setting up the Avigilon interface is straightforward. The steps are as follows:
Run a SQL script to update the database.
Configure the connection in the SATEON user interface.
Define the SATEON events that are sent to Avigilon.
Updating the SATEON database A SQL script called avigilon interface.sql is provided to update the SATEON database to support the Avigilon interface.
To run the script 1.
Copy the file to a suitable location on the SATEON database server.
2.
Open SQL Server Management Studio and connect to the SATEON database server.
3.
Open the avigilon interface.sql script file.
4.
In the Available Databases drop-down, select the Sateon database:
SATEON Avigilon Interface Guide
9
Version 2.0 August 2015
5.
Click the Execute button and ensure the script runs successfully.
The script will create the data needed for the Avigilon interface – the Event Gateway connection, the Forwarding Rule and the Event Topic.
Setting up the connection The SQL script creates an Event Gateway connection for the Avigilon interface. You need to edit this to set the IP address and port of the Avigilon system.
To set up the Avigilon connection 1.
Log in to SATEON and choose Access Control > System Integration.
2.
Choose Event Gateway and select the Avigilon POS Transaction Engine interface that was created by the SQL script:
3.
Edit the Connection String field to specify the IP address and port of the Avigilon system in the format
:.
SATEON Avigilon Interface Guide
10
Version 2.0 August 2015
Other parameters are not required, though you can change the Description if you wish. 4.
Click Save.
5.
At this point you need to restart the SATEON Event Gateway service from the Administrative Tools > Services dialog.
Defining the events that are sent The SQL script creates a forwarding rule which defines the format of a command that can be sent to the Avigilon system. The command is in the form of a text string which will trigger an action when received by the Avigilon system. This rule does not need to be amended, but you need to define the events that trigger the rule.
Viewing the Avigilon forwarding rule You can view the forwarding rule as follows: 1.
Choose Access Control > System Integration.
2.
Choose Event Gateway Forwarding Rule and select the Avigilon POS Alarm object that was created by the SQL script.
3.
The Basic tab associates the forwarding rule with the interface:
SATEON Avigilon Interface Guide
11
Version 2.0 August 2015
4.
The Formatting tab defines the command that will be sent over the interface to the Avigilon system. You do not need to change this.
Note: Do not change the information on the Formatting tab. If any changes are made to the command format it will not work. 5.
The Trigger tab defines the event topic that will trigger the sending of the command:
The Trigger Type is set to Topic Based Trigger indicating that the sending of the command is dependent on a topic (i.e. when any event tagged with this topic occurs). The Topic is set to the Avigilon POS Alarm topic. Note that the Avigilon POS Alarm topic is created by the SQL script, but by default no events are associated with it. You need to create or edit event rules to define which actual events the topic is associated with.
SATEON Avigilon Interface Guide
12
Version 2.0 August 2015
Adding the Avigilon POS Alarm topic to event rules Event rules are used to associate actual events with topics. You need to link the Avigilon topic with one or more event rules in your system.
To edit an event rule 1.
Choose Event Configuration > Event Management > Event Rules. All current rules are listed.
2.
Select the rule that that you want to add the Avigilon POS Alarm topic to, for example Door Forced:
Note: Alternatively you can create a new event rule. For details, see the SATEON Event Configuration Guide. 3.
On the Topics tab you can add the Avigilon POS Alarm topic.
SATEON Avigilon Interface Guide
13
Version 2.0 August 2015
4.
Click Save to save the changes to the event rule.
You can add the Avigilon POS Alarm topic to multiple event rules in order to define the events that will be reported to the Avigilon system.
SATEON Avigilon Interface Guide
14
Version 2.0 August 2015
Section 3
Troubleshooting
Avigilon interface events reported in SATEON Various conditions that occur when using the Avigilon interface, such as failed connections, are reported to the SATEON Event Service. These can be displayed within the SATEON Control Centre and used to trigger system actions. The following tables summarise the events that can be raised from the Avigilon interface at interface level and at forwarding definition level.
Avigilon Event Gateway events Events that may be raised on an Event Gateway (including an Avigilon interface) are as follows: Event
Explanation
Output Interface Connected
Indicates that connection has been made successfully.
Output Interface Connection Attempt Failed
Indicates that a connection attempt has failed.
Output Interface Disabled
The interface has been disabled by a SATEON user.
Output Interface Disconnected
An interface connection has been disconnected or has failed.
Output Interface Enabled
The interface has been switched to Enabled by a SATEON user.
SATEON Avigilon Interface Guide
15
Version 2.0 August 2015
Avigilon Forwarding Rule events Events that may be raised on a forwarding rule (including a command sent to Avigilon) are as follows: Event
Explanation
Forwarding Rule Message Sent
Confirmation that a command has been successfully sent via the output adapter.
Send Failed on Forwarding Rule
Warning that a command could not be sent within the specified timeout period.
Configuration errors Configuration errors can prevent successful communication between the Avigilon system and SATEON. Therefore when the interface is first set up, and if any changes are made (such as changing the IP address) we advise that you check the SATEON Control Centre page to ensure connection is made correctly.
To view connection status in the Control Centre 1.
Choose Control Centre.
2.
Choose the Devices tab.
3.
Select Event Gateway from the Devices list:
When you select the Avigilon interface in the Instances list, its state appears in the pane on the right.
SATEON Avigilon Interface Guide
16
Version 2.0 August 2015
Note: The interface and the forwarding rules will not appear in the Devices list until SATEON has registered their details. Ensure you have edited the connection details and saved your changes as described in Setting up the connection on page 10. You may need to click the Refresh button on the SATEON user interface to update the display.
Incorrect IP address/port If the IP address/port specified for the Avigilon system within the SATEON user interface is incorrect, or the remote system is disconnected, SATEON will be unable to communicate with it The Connection State will be returned as BadConnectionString:
Invalid licence file If the SATEON licence file does not support the Event Gateway, you will be able to configure the Avigilon interface, but no communication will be possible. If you attempt to connect more third-party systems than the licence supports, the ones that exceed the maximum licensed number will be ignored. For example, if your licence supports two interfaces, you can configure and view the second but the third will be ignored.
Checking log files In the case of problems during operation, such as commands not being sent, we recommend that you check the Event Gateway logs. You can configure and monitor the logs using the SATEON Real-Time Diagnostics Tool. It is generally installed as part of a standard Sateon installation and is located in the ..Grosvenor Technology Ltd/SATEON/Utilities folder.
To set up logging using the Real-Time Diagnostics tool 1.
Locate and open the SATEON Real Time Diagnostics (by default installed in Program Files (x86) Grosvenor Technology Ltd > SATEON > Utilities).
SATEON Avigilon Interface Guide
17
Version 2.0 August 2015
2.
In the Sources pane, select the checkbox for the Event Gateway.
3.
In Event options, select Enable Debug Channels to view debug messages and select Enable Verbose Messages if you want more detailed information. Once options are set, events will appear in the main screen as they occur. When you select a specific message, more information will appear in the pane at the bottom of the page.
Note: Once any issues are resolved, you can clear the Debug and Verbose checkboxes if you no longer need this level of reporting. You can also monitor the logs raised using the Windows Event Viewer (Control Panel > System and Security > Administrative Tools).
SATEON Avigilon Interface Guide
18
Version 2.0 August 2015