VideoXpert Integration - Symmetry Professional User Guide

Transcription

1 VideoXpert Integration - Symmetry Professional User Guide USER GUIDE V Jul-17

2 Contents 1. Introduction Abbreviations Version Information Integration Component Version VideoXpert Version Symmetry Professional Version System Overview Installation Manual System Operations System Start up Configuration setup Event Mapping System Operations Procedure Recorder and Camera Configuration Live and PTZ functionalities Playback Alarms/Events System Configurations Issues and Limitations Troubleshooting Steps References Support VideoXpert Integration Symmetry Professional 2 User Guide

3 1. Introduction This document is the user guide for VideoXpert Integration with Symmetry Professional. The objective of this document is to provide information about the system usage, functions, configurations and known issues. 2. Abbreviations # Abbreviation Definition 1 VMS Video Management System 2 VX VideoXpert 3 VxSDK VideoXpert Software Development Kit 4 DS Digital Sentry 5 ACS Access Control System 6 PTZ Pan Tilt Zoom Table 1: Abbreviations 3. Version Information 3.1. Integration Component Version # Component Name Version Description 1 VideoXpertSymmetryInstaller.exe 1.2 AMAG Symmetry Access Control Integration driver Installer Table 2: Integration Component Version 3.2. VideoXpert Version # Component Name Version Remarks 1 VideoXpert Core Nil 2 VideoXpert Professional Nil 3 VideoXpert Media Gateway Nil 4 VideoXpert Storage Nil 5 VxSDK 2.0 Nil Table 3: VideoXpert Version 3.3. Symmetry Professional Version # Component Name Version Remarks 1 Symmetry Software XML Open Integration 8.1 Module Table 4: Symmetry Professional Version 4. System Overview The proposed solution is an integration driver for Symmetry Professional. This integration helps Symmetry to connect with VideoXpert. The integrated system provides end user benefit to use any one system to access information from both. Users who are more comfortable with using Symmetry may use the same to access cameras, feeds and events from VideoXpert deployed in the same infrastructure. Users who are VideoXpert Integration Symmetry Professional 3 User Guide

4 more comfortable with VideoXpert, may use Admin Portal or OpsCenter Client to view or acknowledge access control events from Symmetry. Symmetry integration driver extends the capabilities of Symmetry system by integrating VideoXpert s cutting-edge technology. VideoXpert provides live streams and events from various IP cameras that are placed in different entry exit points. The integration driver shall be using VxSDK for all its interfacing needs with VideoXpert. 5. Installation Manual Refer VideoXpert Integration - Symmetry Professional [Installation Manual].docx 6. System Operations Before installing VideoXpertSymmetryInstaller-1.2.exe make sure all the prerequisites are installed. Prerequisites are documented in VideoXpert Integration - Symmetry Professional [Installation Manual].docx 6.1 System Start up After the complete installation below shown configurations shall be done before Symmetry operations. VideoXpert Integration Symmetry Professional 4 User Guide

5 Configuration setup Purpose: To receive analytic/motion alarms using camera webpage 1. Enter the IP Address of the camera in the web browser. 2. Enter the credentials to login. 3. Open Events and click on Analytic configuration. 4. Select a behaviour and draw a zone for Analytic Alarms. 5. Save the details and Run the profile. Fig 1.Configure Analytic Alarms Event Mapping Purpose: to send or receive alarms/events from Symmetry to VideoXpert and vice versa. 1. To map the Symmetry events with VideoXpert events, user have to set the required Symmetry events by accessing the file ExternalEvents.xml from the path C:\Program Files (x86)\security Management System\Plugins\VideoXpert Symmetry Integration Driver. VideoXpert Integration Symmetry Professional 5 User Guide

6 Fig 2.Configure External Events (Symmetry Events) Name List of possible Symmetry events need to be mapped and injected into VideoXpert. 2. Run the VideoXpertEventMapper.exe shortcut icon displayed on the desktop (application installed machine) using Administrator privilege and while double clicking the icon following window will be shown. Fig 3.Symmetry-VideoXpert EventMapper VideoXpert Integration Symmetry Professional 6 User Guide

7 3. Enter the IP, Username, Password and Port (default value: 443) to connect to the VideoXpert system and click on Connect button. 4. Enter the Symmetry Username and Password to connect to the Symmetry system. 5. Enter the Situation Type, Situation Name and its required properties and click on the Save button. 6. The user shall be able to cancel the event mapping procedure by clicking on the Cancel button. Note: SourceDeviceId used across the application is Guid (unique) and shall to be used while injecting external events into VideoXpert based on situations. Representations External Events Event Template Situation Type Situation Name Severity AckNeeded Notify AudibleLoopDelay AudiblePlayCount AutoAcknowledge SnoozeIntervals Audible Notify The external events means Symmetry events which need to be injected into VideoXpert. The event template for creating external situations. Type of the situation to be created in VideoXpert. Name of the situation to be created in VideoXpert (Maximum of 64 characters). Severity of the generated event, from 1 (highest) to 10(lowest). If true, generated events shall have an initial ack_state of ack_needed. If false, generated events shall have an initial ack_state of no_ack_needed. If true, events generated from this Situation shall generate notifications that are sent to authorize clients. Additionally, these notifications will be sent out whenever generated events have a change of ack_state. Seconds to wait between audible notifications (see: audible_play_count. Defaults to 0. Play audible notification this many times, separated by the audible_loop_delay. Defaults to 1. Number of seconds after which a generated event ack_state will be set to auto_acked. If less than 0, a generated event must be manually acknowledged. If 0, a generated event must be set to auto_acked immediately (prior to any notifications being sent). List of default snooze intervals, in seconds, for generated events. Note that these are default options and that they do not limit the amount of time the generated events may be snoozed for. True specifies that a notification sound is to play on supporting clients when receiving a notification for Events corresponding to this Situation. VideoXpert Integration Symmetry Professional 7 User Guide

8 Expand Banner Log True if the notification banner on clients should be expanded by default. Defaults to True. If true, events generated from this Situation shall be persisted as long as possible. If false, generated events shall immediately be discarded; unlogged events are hidden from clients (this supersedes all other situation configuration). 6.2 System Operations Procedure After the complete installation and System Startup procedures, add the VideoXpert in Symmetry and import cameras using the following steps Recorder and Camera Configuration 1. Login to Symmetry using valid credentials. 2. Select the Install tab and click on Digital Video. 3. Pelco Video Server option shall be listed under the Devices list as in the figure shown below. Fig 4.Install-Video&Audio-Digital Video 4. Click on New button to add a new VideoXpert system/click on Find to list the VideoXpert systems already added. (Refer Fig 5 shown below) VideoXpert Integration Symmetry Professional 8 User Guide

9 Fig 5.Install- Digital Video Device-Pelco Video Server 5. Enter the Description, IP Address, Username and Password to connect VideoXpert system. 6. Enter the location and category (optional) and check the Import Cameras option and click on Connect. Import Camera Checking on Import Cameras option and clicking Connect will automatically import all the cameras connected to the VideoXpert System. The imported cameras shall be found by choosing the Pelco Camera option from the Device list. 7. If VideoXpert system is connected then the Offline button image shown on the right side of fig 5 shall be shown as Online. 8. Click on Save to save the details to Symmetry and a new entry shall found as shown in the Fig 6. Fig 6.Install- Video & Audio System Added VideoXpert Integration Symmetry Professional 9 User Guide

10 9. Select the Pelco Camera option as listed under the Devices list as in the figure shown below. Fig 7.Install-Video&Audio-Digital Video 10. Click on New button to add a new Pelco camera/click on Find to list the camera already added to the VideoXpert system. (Refer Fig 8 shown below) Fig 8.Install-Video&Audio-Add Camera 11. Enter the Description. 12. Select the Video Recorder and Video Channel and click on Copy (If the name and Camera number of the Video Channel need to be copied). VideoXpert Integration Symmetry Professional 10 User Guide

11 13. Select the Location and Category (optional). 14. If a Video Channel is selected and online then the Checking button image shown on the right side of the Fig 8 shall change to Online/Offline respective to the device status. 15. Click on Save button to save the camera details. 16. The saved camera details shall be listed as shown in the fig below. Fig 9.Install-Video&Audio-Camera added Live and PTZ functionalities 1. After the recorder and camera configuration, Select the Home tab and click on Virtual Matrix and following window shall be displayed. Fig 10.Home-Video & Audio-Virtual Matrix VideoXpert Integration Symmetry Professional 11 User Guide

12 2. Controls: The controls in left pane of virtual matrix contains the PTZ controls. The number denotes the PTZ presets saved while adding camera. The pan, tilt and zoom functionalities shall be executed by moving the up, down, left or right arrows as show in the Fig Cameras and Multimedia: The cameras and groups are displayed here. Select the camera and drag to the cell. Video of the selected camera will be played. Refer Fig 11 Fig 11.Home-Video & Audio-Virtual Matrix Camera Streaming Refer AMAG-Symmetry-Software-User-Guide-issue pdf for the detailed functionalities of Virtual Matrix controls Playback 1. After the recorder and camera configuration, Select the Home tab and click on Video Playback and following window shall be displayed. VideoXpert Integration Symmetry Professional 12 User Guide

13 Fig 12.Home-Video & Audio-Video Playback 2. Select the camera, provide the start time, end time and click search button. The search result will be displayed. Double click or drag and drop the search result to the cell to play playback video. Refer Fig Use the player controls to operate the playback video. Refer AMAG-Symmetry- Software-User-Guide-issue pdf for the button functionalities. Fig 13.Home-Video & Audio-Video Playback- Recorded Video Features such as Snapshot, Tags, Save video buttons will be enabled when the stream is in pause mode. Refer Fig 14 VideoXpert Integration Symmetry Professional 13 User Guide

14 6.2.4 Alarms/Events Fig 14.Home-Video & Audio-Video Playback- Feature Buttons enabled 1. Following are the list of VideoXpert events that shall be listed in Symmetry. analytic/abandoned_object analytic/no_abandoned_object analytic/adaptive_motion analytic/no_adaptive_motion analytic/directional_motion analytic/no_directional_motion analytic/motion analytic/no_motion analytic/object_count analytic/no_object_count analytic/object_removal analytic/no_object_removal analytic/sabotage analytic/no_sabotage system/alarm_active system/alarm_inactive system/device_offline system/device_online 2. There is an option to clear or acknowledge alarms or events from Symmetry. But in either case there is only acknowledge option for alarms or events to VideoXpert. 3. The event name listed in the what field of All Alarms tab is shown in the figure 14. The VideoXpert event sent to Symmetry contains the information s of the VideoXpert events, camera name and the alarmid. The alarmid mentioned is the unique identifier. VideoXpert Integration Symmetry Professional 14 User Guide

15 Note: The return details after acknowledge the events from Symmetry doesn t contains the alarmid of the VideoXpert event. Instead sending a unique id created by Symmetry. In order to acknowledge the same event in VideoXpert, the alarmid of VideoXpert event is added in the Who field of Symmetry. 1. The user shall be able to search the events based on the SearchEventDurationInDays and SearchEventCount by setting the values in the ServerConfig.xml file from the path C:\Program Files (x86)\security Management System\Plugins\VideoXpert Symmetry Integration Driver. 2. The alarms/events priority in Symmetry is in the range 0(Lowest) to 80(highest) and for VideoXpert it s in the range 1(lowest) to 10(highest). In order to avoid mismatching priority mapping functionality is implemented while adding VideoXpert events to Symmetry. 3. The user shall be able to set the PriorityRange by accessing the ServerConfig.xml file from the path C:\Program Files (x86)\security Management System\Plugins\VideoXpert Symmetry Integration Driver. Default value is 50. The priority mapping of VideoXpert and Symmetry is shown below. # VideoXpert Severity Level Symmetry Priority Level If multiple symmetry clients accessing a single VideoXpert system and Symmetry server, in order to avoid event duplication user need to uninstall VideoXpertEventInjector service from all client machines by running the UninstallService.bat with administrator privilege from the path C:\Program Files (x86)\security Management\Plugins\VideoXpert Symmetry Integration Driver\Scripts. Functionality 1. Select the Home tab and click on Alarms and following window shall be displayed shown below. VideoXpert Integration Symmetry Professional 15 User Guide

16 Fig 15.Home-Monitoring-Alarms 2. The Symmetry or VideoXpert alarms/events shall be displayed in the All Alarms tab. 3. The user shall be able to clear the alarms by clicking the Clear button from the Alarm Panel. Refer Fig 15 Fig 16.Acknowledge Alarm Refer AMAG-Symmetry-Software-User-Guide-issue pdf for the detailed functionalities. VideoXpert Integration Symmetry Professional 16 User Guide

17 7. System Configurations 8. Issues and Limitations Installer Repair feature is not under current scope and not tested in this version. VideoXpert Symmetry DV Plugin Playback video with an invalid start time and valid end time will not work. Playback video will not work if audio is recording along with video. Event property pop up window in VideoXpert EventMapper is not able to close until SnoozeInterval property is set. After installation user have to manually register the plugin by executing C:\Program Files (x86)\security Management System\Plugins\VideoXpert Symmetry Integration Driver\Scripts\SymmetryRegister.bat. If events are not listed in Symmetry make sure the VideoXpertEventInjector is running. The endpoint address filed in VideoXpertEventInjector should be configured manually to use the machine where the XML Open Integration Module is installed. Event status updated in VX Admin Portal is in inactive state until the properties is filled in VideoXpert EventMapper. While executing PTZ functionalities the operations shall take some time (2-5 seconds) to reflect in video stream. If the user is not connected to VideoXpert system and tries to stream video then the plugin shall trigger an auto connect, so it shall take some time to start stream. User will get an error message if trying to connect using invalid IP address. Even though user will be able to save the server details. If the user is not connected to VideoXpert system and tries to view camera properties then the plugin shall trigger an auto connect, so it shall take some delay to load forms. Bookmark feature is implemented in Symmetry and not under the plugin s scope. Recording gaps will be shown as separate clips in Video Playback window. Stopping multiple streams at once shall take some delay to close the Video Player dialog. During export from symmetry if user tries to delete the export from VideoXpert (e.g.: using OpsCenter), the export may crash. If the user is not connected to VideoXpert system and tries to open Video Server page, then the status of the device shall show as Unknown. Adding multiple VideoXpert systems is not supported. If VideoXpert system is connected and any changes in VideoXpert devices like camera goes offline or removed, Changed IP etc., then user have to remove all the cameras from the Pelco Camera list and reconnect the VideoXpert and need to import the camera once again. Only online camera shall be listed in the Pelco Camera list while connecting to VideoXpert. VideoXpert Integration Symmetry Professional 17 User Guide

18 Symmetry doesn t allow special characters to enter into the Password field of lnstall- Digital Video Device-Pelco Video Server window. It is highly recommended to create a user in VideoXpert AdminPortal with password not having special characters. Symmetry Professional When alarm-triggered recordings overlap, Instant Replay starts from wrong time. Work around to play from a specific start time, Ctrl-drag the clip into the cell after the playback window appears. Camera number starts from 3 instead of 1. Camera IP address displayed is the IP address of the recorder and not the camera s actual IP. Updates within one virtual matrix are not automatically refreshed in the other until the matrix is closed and re-opened. After clearing all configurations and uninstalling the Pelco VideoXpert integration driver, Pelco Video Server is still an option in Install -> Video & Audio -> Digital Video and causes Symmetry to crash when New is clicked. After installing a camera with a camera number of 9999, subsequent cameras will alternate between a correct camera number and an invalid number. Command center filters: The filtering on the recording status of digital video cameras is specific to Symmetry s own NVR, reporting of recording status for 3rd party video servers/recorders is not supported. When playing user recorded video, Skip to Next feature does not work. Exporting of video from 3rd party video servers/recorders is not supported. The NVR Status screen at Maintenance->Video->Video Status does not include information about cameras connected to DVRs. If a Symmetry client loses communications with the Symmetry server, the client may become unresponsive for up to 10 minutes. Deleting the camera with the lowest Symmetry camera number, Symmetry will not reuse that camera number for the next camera added. With no archive server setup, the Reports->History->Video Archive Audit shows an archive date of 12/31/ :00 for all cameras. Time zones cannot be set on a camera-by-camera basis, only for the recorder (VideoXpert) as a whole. Occasionally, when deleting cameras, Symmetry will crash. Occasionally when executing PTZ commands symmetry will crash. Symmetry Privacy Zones are not supported. Occasionally, when stopping the SMS services on the server, SMS Integration Server hangs in a Stop Pending state. Switching from 2x2 matrix to single quadrant view does not work. Symmetry video SDK doesn t support audio. 9. Troubleshooting Steps Cameras not listed after connecting VideoXpert System This scenario shall be occurred in three cases. VideoXpert Integration Symmetry Professional 18 User Guide

19 1. User haven t added the camera license to Symmetry 2. User didn t check the import cameras checkbox in Pelco Video Server dialog Solutions: Try connecting VideoXpert after checking import cameras check box. Go to Install > Digital Video >Pelco Camera >New Select Video Recorder and see if Video Channel dropdown contains cameras. 3. Cameras in VideoXpert is offline or not commissioned. Go to Admin Portal and see if devices are online and commissioned. Digital Video and Video Playback windows goes to not responding state This scenario will be occurred if there are multiple streams from high resolution camera. User shall wait for a moment to let the stream close. Alarms/Events are not listing in Symmetry to VideoXpert or vice versa. 1. This scenario shall be occurred if VideoXpertEventInjector service is not running in the machine. Steps 1. Go to Computer Management (Right-click on my Computer-> Manage) 2. Click on Services under Services and Applications 3. Select the VideoXpert Event Injector service and click on Start to run the service. 2. Log file shows HTTP request to ' has exceeded the allotted timeout. shall be found if the connection to the Open XML Integration module web service is denied. a) Go to the installation directory (C:\Program Files (x86)\security Management System\Plugins\VideoXpert Symmetry Integration Driver) and open the VideoXpertEventInjector.exe.config b) Verify the endpoint IP address mentioned is same as the IP address of the machine where XML Open Integration module is installed. Duplicate Alarms/Events found in Symmetry or VideoXpert. VideoXpert Integration Symmetry Professional 19 User Guide

20 This scenario shall be found if VideoXpertEventInjector service is running in multiple client machines accessing same Symmetry server or VideoXpert systems. 10. References # Documents/Inputs Description 1 Discussions Technical and requirement analysis discussions between all internal and external stakeholders. 2 VideoXpert SDK Documentation of VideoXpert SDK 3 AMAG-Symmetry-Software- User Guide of AMAG Symmetry software. User-Guide-issue pdf 4 XML Open Integration Module Installation and User Guide, issue pdf User Guide of XML Open Integration module. 5 VideoXpert integration Learnings from the development and testing of VideoXpert experience integration modules. 11. Support If the instructions provided fail to solve your problem, contact Pelco Product Support at (USA and Canada) or (international) for assistance. VideoXpert Integration Symmetry Professional 20 User Guide

21 REVISION HISTORY Version Date Description Amended By Approved By Apr-17 Initial Draft Amaljith TM Vijo Varghese Apr-17 Updated with Review Comments Amaljith TM Vijo Varghese Apr-17 Updated Amaljith TM Vijo Varghese Jul-17 Updated for release Arun C B Vijo Varghese VideoXpert Integration Symmetry Professional 21 User Guide

22 VideoXpert Integration Symmetry Professional 22 User Guide