IndigoVision Controller Interface Guide. October 2014

Transcription

1 \\ IndigoVision Controller Interface Guide October 2014

2 SATEON Software Integrations IndigoVision Controller Interface Guide Issue 1.1, released October 2014 Disclaimer Copyright 2014, 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. While 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. SATEON 2 Issue 1.1

3 Contents Preface... 5 About the IndigoVision Controller Interface... 5 About this guide... 5 Related documents... 6 Technical support... 6 Introduction to the IndigoVision interface... 7 Overview of the interface... 8 Functionality... 9 Prerequisites... 9 The events configuration file ToIv.conf... 9 The IndigoVision interface table IV_LOG Importing events using Import Alarm Sources Setting up and licensing the IndigoVision module Installing the IndigoVision controller interface New installations Existing installations What is installed MS-SQL Binding Module Licensing the IndigoVision interface Installing a licence Validating a licence Configuring the IndigoVision interface Setting up the IndigoVision MS-SQL Binding Module Setting up the events to be sent to IndigoVision Setting up an event topic Setting up an event rule SATEON 3 Issue 1.1

4 Setting up the IndigoVision module within SATEON Setting up an IndigoVision controller Amending the event data sent SATEON 4 Issue 1.1

5 Preface This document provides information on the IndigoVision Controller Interface module of SATEON, which provides an interface between the SATEON access control system and IndigoVision CCTV controllers. This version of the document relates to SATEON Release 2.8. It may not include changes incorporated in later versions of the software. Representations of screens 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: October About the IndigoVision Controller Interface 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 IndigoVision Controller interface is an optional, separately licensable module that provides an interface between the SATEON system and an IndigoVision CCTV controller. About this guide This document provides details on setting up the IndigoVision Controller Interface module and configuring SATEON to send events to the IndigoVision system. It is aimed at installers and system managers who are responsible for setting up the interface and security staff who are responsible for monitoring the system. Note: This document assumes that the IndigoVision Controller is fully configured and operational. For details of setting up the IndigoVision Controller itself, see the manufacturer s documentation. SATEON 5 Issue 1.1

6 This guide includes the following information: Section 1 Introduction to the IndigoVision interface. This section provides an overview of the IndigoVision controller interface. Section 2 Setting up and licensing the IndigoVision module. This section explains how to install the IndigoVision interface module and upgrade the licence. Section 3 Configuring the IndigoVision interface. This section details how to configure SATEON to send events to the IndigoVision controller. Related documents The following SATEON documents may also be useful: The Installation Guide. This guide explains how to install SATEON, including details of hardware requirements and software prerequisites. The Access Control Guide. Describes how to set up core elements of SATEON, including system hardware, people and the tokens used to gain access to the site. The Control Centre Guide. Explains the SATEON Control Centre, which allows security staff to view and monitor events, to deal with reported incidents and to manage or control specific elements of the system. The Event Configuration Guide. Details how to set up the way in which system events are reported, tagged and used within the system. For details of setting up and managing the IndigoVision equipment, please consult the appropriate IndigoVision product manuals, in particular the following: MS-SQL Binding Module 1.0 Administrator s Guide IndigoVision Import Alarm Sources Tool Administrator s Guide Technical support For further assistance with SATEON, please contact Grosvenor Technology Technical Support as follows: (EMEA): (US): Website: ac-emeasupport@grosvenortechnology.com ac-ussupport@grosvenortechnology.com SATEON 6 Issue 1.1

7 Section 1 Introduction to the IndigoVision interface This section provides an overview of the IndigoVision Controller interface and the way it is configured. For a summary of the IndigoVision panel interface, see Overview of the interface on page 8. For information about the configuration file that defines the events that are sent to the IndigoVision controller, see The events configuration file ToIv.conf on page 9. For details of the database table that is used to hold events to be sent to IndigoVision, see The IndigoVision interface table IV_LOG on page 11. SATEON 7 Issue 1.1

8 Overview of the interface The SATEON access control system can be integrated with the one or more IndigoVision controllers to enable events occurring in the access control system to trigger CCTV controls. Integration is managed by a separate, licensable SATEON module which manages communication between one or more IndigoVision controllers and the main SATEON system. It is set up as follows: Within the SATEON user interface, the triggering events that are to be sent to IndigoVision need to be defined. This information is used to create a configuration file in a location accessible to the IndigoVision control centre. Note: The IndigoVision MS-SQL Binding Module also needs to be installed on the SATEON server to enable the IndigoVision system to communicate with SATEON. For details, see the appropriate IndigoVision documentation. SATEON 8 Issue 1.1

9 Functionality The IndigoVision Controller module includes the following functionality: It enables a defined set of events occurring within the SATEON system to be sent to the IndigoVision system. In operation, this works as follows: When an event tagged with the appropriate topic occurs, an entry is made in a specific database table, IV_Log. The SATEON IndigoVision service sends data from this table to the IndigoVision control centre. This can be used to trigger any events within the IndigoVision system, such as moving a camera, switching a recorder or triggering a relay. It allows a SATEON system user to update the events configuration file from within the Control Centre. Prerequisites To configure the IndigoVision system to communicate with SATEON, you need to install and configure the MS-SQL Binding Module on the SATEON server. For details, see Setting up the IndigoVision MS-SQL Binding Module on page 22. The SATEON IndigoVision interface module is licensed separately. If necessary, an upgraded licence file needs to be installed, which defines the maximum number of IndigoVision systems that are supported by SATEON. For details, see. The events configuration file ToIv.conf The events that are sent to the IndigoVision controller are defined in a plain-text, comma separated file called ToIv.conf. There is one line in this file for each event to be mapped. Each line consists of: A numeric identifier for IndigoVision A numeric identifier for SATEON A description made up of the name of the entity and the event. Note: In this implementation the SATEON identifier and the IndigoVision identifier will be the same. SATEON 9 Issue 1.1

10 For example: This file is automatically created when the IndigoVision interface is first set up within SATEON. It identifies the SATEON objects and the events that occur on them that are reported to IndigoVision. Note the following important points: Separate event numbers are provided for each separate entity (for example Reader 1 and Reader 2 in the example above) Each individual entry in the file has a specific identifier. This is the number by which the event is reported to IndigoVision, and this is unchanging. Even if the set of events reported change, an assigned number will not be reused. If the set of events to be reported is changed, the file can be regenerated from the SATEON user interface at any time. If the set of events to be reported is subsequently changed, you need to run a Refresh command from the SATEON interface, so that the changes are reflected in SATEON. SATEON 10 Issue 1.1

11 Note: Each time you create a new ToIv.conf file, you will need to restart the IndigoVision MS-Sql Binding Module service from the Administrative Tools > Services dialog. The IndigoVision interface table IV_LOG The IndigoVision interface table IV_LOG table is used to exchange data between the SATEON system database and the IndigoVision system. When events tagged with the specified topic occur, they will be placed in the IV_LOG table. The information is this table is as follows: Column Name LOGDEVDESCRP EVNT_DAT REC_DAT INSERTED_DAT CARDNO LNAME FNAME EVNT_ADDR EVNT_DESCRP IV_ALARM_STRING READFLAG Description Name of the entity within SATEON that triggered the event. The time and date that the event occurred. The time and date that SATEON reported the event (this may be a different time zone). The time and date that the event was inserted into the IV_LOG table The token ID associated with the event, where relevant. The last name of the person associated with the event, where relevant. The first name of the person associated with the event, where relevant. The SATEON event number. The description of the event. The IndigoVision event number. This field is false when inserted; it is set to True when the IndigoVision system has read the field. SATEON 11 Issue 1.1

12 Importing events using Import Alarm Sources For systems running SMS4, IndigoVision s suite of management software, it is possible to import events using the IndigoVision Import Alarm Sources tool. The Import Alarm Sources tool automatically loads the events and alarm sources specified in the ToIv.conf configuration file to an IndigoVision Control Centre site database. This tool is supported and supplied from IndigoVision directly. Contact IndigoVision for more information. SATEON 12 Issue 1.1

13 Section 2 Setting up and licensing the IndigoVision module This section explains how to install the IndigoVision interface module and upgrade the licence file. For installation information, see Installing the IndigoVision controller interface on page 14. For details of licensing, see Licensing the IndigoVision interface on page 17. SATEON 13 Issue 1.1

14 Installing the IndigoVision controller interface The IndigoVision interface is an optional SATEON module and is not installed as part of the standard default SATEON installation. Note: To install optional features, you must use the advanced installer, Sateon Installer.msi. The one-step installer cannot be used. Brief instructions are given here; for full details, see the SATEON Installation Guide. New installations For a new installation you need to run a customised installation to ensure that the IndigoVision Controller options are selected. To ensure the IndigoVision options are included 1. On the release media, navigate to \Installer\Sateon\ and run SATEON installer.msi. 2. On the first screen, press Next. 3. After reading the Licence Agreement, select the checkbox to accept the agreement and click Next. The following dialog appears 4. Click the Customise button. 5. On the Destination Folder dialog, accept the default or click Change to select an alternative location. SATEON 14 Issue 1.1

15 6. Click Next. The Custom Setup dialog appears: 7. In the tree structure, only the databases and services required for core functionality are selected by default. Expand the structure and select the IndigoVision Database within SATEON Databases and the IndigoVision Service within SATEON Services. 8. Click Next and continue to follow instructions on the dialogs. 9. Click Install to begin the installation, then when it is completed, click Finish. Note: For multi-tier installations, ensure the IndigoVision service and database are installed on the appropriate PCs/servers. Existing installations For an existing installation you will need to re-run the installer to add the add the IndigoVision options. To add the IndigoVision options to an existing installation 1. On the release media, navigate to \Installer\Sateon\ and run SATEON installer.msi. 2. On the first screen, press Next. SATEON 15 Issue 1.1

16 3. Choose Change. 4. In the tree structure, select the features to be installed. Ensure this includes the IndigoVision Database within SATEON Databases and the IndigoVision Service within SATEON Services. 5. Click Next. 6. Follow the instructions on the dialogs. Click Change to begin the installation, then when it is completed, click Finish. SATEON 16 Issue 1.1

17 What is installed The elements installed are as follows: The Sateon IndigoVision database. The IndigoVision service and associated executables. These are installed in the default location (C:\Program Files\Grosvenor Technology Ltd (x86)\sateon\services) unless another has been specified. The service is started automatically following installation. If necessary, you can manage it from the Control Panel > Administrative Tools > Services dialog. A log file called indigovision.yyyymmdd.log s created in C:\Program Files\Grosvenor Technology Ltd (x86)\sateon\services\logs when the service starts. MS-SQL Binding Module You also need to install the IndigoVision MS-SQL Binding Module on the SATEON server. This can be obtained directly from IndigoVision. Note that it requires a licence. For details, see the MS-SQL Binding Module 1.0 Administrator s Guide Licensing the IndigoVision interface As the IndigoVision Controller interface is an optional SATEON feature, it requires a licence which includes this feature. For a new installation you need to ensure that the licence includes support for the IndigoVision Controllers. If you have added IndigoVision support to an existing installation, you will need a new licence file. You must ensure your licence covers the maximum number of IndigoVision controllers that you intend to support. SATEON 17 Issue 1.1

18 Note: If you do not have a valid licence file yet, contact Grosvenor Technical Support as soon as possible. See Technical support on page 6. Installing a licence Whether this is a new installation or an upgrade, you need to install a licence. To install a SATEON licence 1. Choose System Configuration > System Administration > Licensing to display details of the current licence. If this is a new SATEON installation the Licensing page is displayed immediately after log-in as the licence file must be installed before you can access the system. 2. On the Systems Administration > Licensing page click the Add/Alter Licence button: The following dialog appears 3. Do one of the following: If you have the encrypted licence data, cut the entire string from the source or document and paste it into the text box. If you have a licence in file format, ensure it is in an accessible location. Select Upload Licence and click the Click to Start Upload button. A file selection dialog appears; navigate to the appropriate file and click Open. Note: The filename is of the format <licencenumber><product><date>.gtl SATEON 18 Issue 1.1

19 4. Click Save. 5. When the licence is successfully loaded, you will be prompted to log out. When you log back in, the main SATEON page appears. If you select System Configuration > System Administration > Licensing, details of the licence appear. At this point the licence is loaded but not verified. It will need to be verified within 30 days for SATEON to continue to work Validating a licence For a new installation the licence needs to be validated within 30 days for SATEON to continue to work. Note: If you have upgraded an existing installation the licence will not need to be validated. 1. Select System Configuration > System Administration > Licensing to show details of the licence. If it has not been validated the status will appear as VALID (Unverified) as follows: 2. Click Validate Licence button. A dialog will appear showing a validation code number: SATEON 19 Issue 1.1

20 3. Contact Grosvenor Technical Support (see Technical Support on page 6). You will need to provide your Licence ID number and the 16-digit Validation Code. 4. Technical Support will give you a 16-digit licence Verification Code. Enter it in the Verification Code box and press Verify. The following dialog appears: 5. Click Finish. You will be logged out. When you log back in, select System Settings > System Administration > Licensing. The licence status will appear as follows and the new licence will include IndigoVision support: The maximum number of IndigoVision controllers that the installation will support is indicated. Note that if only one controller is supported the Value is On, rather than 1. If you attempt to connect more IndigoVision controllers than the licence supports, the ones that exceed the maximum licensed number will be ignored. For example, if your licence supports two IndigoVision controllers, you can configure and view the second controller but the third will be ignored. SATEON 20 Issue 1.1

21 Section 3 Configuring the IndigoVision interface This section explains how to set up the IndigoVision controller within SATEON and the events to be sent to it. For information about configuring the MS-SQL Binding module, see Setting up the IndigoVision MS-SQL Binding Module on page 22. For details of defining the events that are sent to IndigoVision, see Setting up the events to be sent to IndigoVision on page 24. For details of setting up the IndigoVision controller and establishing communication, see Setting up the IndigoVision module within SATEON on page 27. For information about updating details of events sent to IndigoVision, see Amending the event data on page 29. SATEON 21 Issue 1.1

22 Setting up the IndigoVision MS-SQL Binding Module To configure the IndigoVision system to communicate with SATEON, you need to install and configure the MS-SQL Binding Module. Note: The MS-SQL Binding Module is a compulsory requirement which you need to obtain directly from IndigoVision. Note that it requires a licence. Once installed, you need to edit the system.conf configuration file to set up the name of the SQL host machine and the database that contains the IV_LOG table. For more information, see the MS-SQL Binding Module 1.0 Administrator s Guide. To edit the system.conf file 1. Open the file with a suitable text editor. 2. Locate the Database section. 3. Set the DatabaseHost value to the name of the server that the SQL Database is installed on and the database name within SQL, e.g. SV-SATEON-04\SATEON 4. Set the DatabaseName value to the name of the database containing the IV_LOG table, which will always be SateonIndigoVision. See the highlighted lines in the following example file: [AlarmServer] MANDATORY: The IP address of the Alarm Server (NVR) must be specified IP= [SystemEvents] SystemEvents are events that may be sent to Control Center to report the status of, or problems with, the Binding Module. The number assigned to a system event is a user-defined event number which corresponds to an external system input number of an alarm source in Control Center. If BMOffline is defined, an event with this number will be sent to the NVR/Alarm Server whenever the Binding Module is about to go offline. Reasons for going offline include a manual service stop request, the host pc shutting down, or when the USB license dongle is removed or expires (trial dongles only). BMOffline=1 If BMOnline is defined, an event with this number will be sent to the NVR/Alarm Server whenever the Binding Module has successfully started up. BMOnline=2 If the 3rdPartyOffline property is defined, an event with this number will be sent to the NVR/Alarm Server whenever the MS Sql database connection is lost. SATEON 22 Issue 1.1

23 3rdPartyOffline=3 If the 3rdPartyOnline property is defined, an event with this number will be sent to the NVR/Alarm Server whenever the MS Sql databaseconnection is established. 3rdPartyOnline=4 [Log] The log level. The default log level is "info", which will log each alarm sent to the NVR/Alarm Server and all errors. Change to "err" to minimize the log output to just errors. Change to "debug" to maximize log output. Logging level err (minimize output, log errors only) info (log alarms and errors) debug (maximize output, log all information) Level=info [Database] Name of the host with MS Sql database [MANDATORY] DatabaseHost=SV-SATEON-04\SATEON Name of the database that holds the IV_LOG table [MANDATORY] DatabaseName=PWNT DatabaseName=SateonIndigoVision Encoded database Username This parameter is optional and needed for SQL authentication only Please use the encode utility to determine this value This value must be a hexadecimal string - eg ABCDEF Username=00 Encoded database password This parameter is optional and needed for SQL authentication only Please use the encode utility to determine this value This value must be a hexadecimal string - eg ABCDEF Password=00 In this example, SV-SATEON-04 is the server that the SQL database is installed on. SATEON is the database name within SQL The database name will always be SateonIndigoVision SATEON 23 Issue 1.1

24 Setting up the events to be sent to IndigoVision You need to specify the events that are to be sent to the IndigoVision controller. For example they may be all the events occurring in a particular area or those related to specific elements in the access control system. A brief summary of setting up event reporting is given here. For full details of setting up the reporting of events, see the SATEON Event Configuration Guide. Event topics are basically labels or tags that will be used to identify events you are interested in reporting. For example you can set up a topic called Events for IndigoVision. Event rules define the relationship between actual events, event groups and topics. For example, you can set up a rule that associates serious events in a particular area with a IndigoVision topic. Setting up an event topic An event topic is basically a label or tag that will be used to identify the events you are interested in. You can then use the event topics in various ways, enabling great flexibility and control over the way in which events are reported and used. A number of event topics are included in the system by default, and you can create any number of extra ones. You can create as many topics as you want, depending on your reporting needs. For example, to define the events to be sent to IndigoVision you may create a topic called Events for IndigoVision. Since an event topic is simply a label, it is only of use once you associate it with particular events in an Event Rule. To set up an event topic 1. Choose Event Configuration > Event Topics. All current topics are listed. 2. Click the Add button. 3. In the Description field, enter a name for the new event topic: 4. Click Save. Once you have set up a suitable topic, you can set up event rules to define what actual events the topic you have just created relates to. SATEON 24 Issue 1.1

25 Setting up an event rule Event rules are used to associate actual events with topics, which are basically labels. Each rule defines: An Event Group which defines which system elements are reported on. A System Mode which defines the situation in which events are reported. A Time Zone which defines when events are reported. For example, you could set up an event rule to associate the Events for IndigoVision topic with Door Forced and Door Wedged events at particular doors, or failed reads at a specific reader. This rule can then be associated with a mode (such as Normal) and a Time Zone (such as Office Hours). To create a new event rule 1. Choose Event Configuration > Event Rules. All current rules are listed. 2. Click the Add button. 3. On the Basic tab, enter the following fields: Description Rule Type Event Group System Mode Time Zone Name of the new event rule. Choose the object that the rule applies to, such as Door or Area. Choose a previously set up event group that defines the group of hardware objects that this rule relates to. Choose the mode that defines the circumstances when this rule applies. Choose the time zone that defines the times when this rule applies. 4. On the Events tab you can choose the specific events that will trigger this rule. You can choose from all the events that apply to this element type. SATEON 25 Issue 1.1

26 To include events in the current rule, select them and click the right-arrow button. For example for a Reader rule, the events could be selected as follows: 5. On the Topics tab you can specify which topics (i.e. labels) will be used to identify this rule, e.g. the Events for IndigoVision topic set up earlier. To associate a topic with the current rule, select it and click the right-arrow button. SATEON 26 Issue 1.1

27 6. Click Save to save the new event rule. Setting up the IndigoVision module within SATEON Within the SATEON user interface you need to set up details of the IndigoVision controller and establish communication. Setting up an IndigoVision controller You can set up details of a configured IndigoVision system from the System Integration option on the main Access Control page: The main System Integration page initially appears showing details of any configured third-party interfaces. SATEON 27 Issue 1.1

28 To set up an IndigoVision controller 1. On the System Integration page, choose IndigoVision Controller. Note: If you are unable to see or amend the IndigoVision Controller on this page, please check your licence and the security rules that have been set up. 2. Click the Add button at the bottom of the filter pane. A set of blank fields appears. 3. Enter the following fields: Description UNC Path to IndigoVision Configuration file Topic Provide an identifying name for the IndigoVision controller. This identifies a location in which the IndigoVision configuration file ToIv.conf will be created. It must be in the form of a UNC path: \\server\fileshare. This can specify a location within the IndigoVision file system if access is available; otherwise the file created can be manually copied to IndigoVision. Choose the topic that defines the events that will be sent to the IndigoVision system. Note: The topic must already exist. See Setting up the events to be sent to IndigoVision on page Click Save. This results in a Refresh command being sent to the IndigoVision service. An event configuration file is created in the specified location, and the database table is updated. Note: Whenever the set of events sent to IndigoVision is amended, a further Refresh command is required. In addition, you need to restart the IndigoVision Binding Module Service (within Windows Services) to ensure any changes have been recorded in the IndigoVision service. For details, see Amending the event data sent below. SATEON 28 Issue 1.1

29 Amending the event data sent From time to time you may need to change the set of events passed to IndigoVision from SATEON. To do this you need to do the following steps: Reconfigure event reporting within SATEON. Recreate the ToIv.conf configuration file by running a Refresh command. Restart the IndigoVision Binding Module service. To reconfigure the events To amend the set of events, you need to either: Amend the events labelled with the selected event topic within the Event Configuration module (see Setting up the events to be sent to IndigoVision on page 24), or Within the IndigoVision interface set-up, associate the IndigoVision controller with an different event topic (see Setting up the IndigoVision module within SATEON on page 27). To recreate the event configuration file To change the events that are sent to IndigoVision you will need to update the ToIv.conf configuration file by running a Refresh command. 1. Choose Control Centre. 2. Select the Devices tab. 3. Select IndigoVision Controller from the Devices list, and if multiple controllers are configured, choose the appropriate one from the Instances list. 4. Click the Refresh button on the right-hand panel: This will generate a new version of the ToIv.conf configuration file with the entities/events defined in the appropriate topic. SATEON 29 Issue 1.1

30 Note: When a file is regenerated, each individual event in the file will keep its original identifier. Even if the set of events reported change, an assigned number will not be reused. To restart the service Each time you create a new ToIv.conf file, you need to restart the IndigoVision Binding service. 1. Open the Services dialog (Control Panel > Administrative Tools > Services). 2. Locate the IndigoVision Ms-Sql Binding Module service; right-click and select Restart. SATEON 30 Issue 1.1