VideoXpert 3.X Security Expert Integration User Guide

Transcription

1 VideoXpert 3.X Security Expert Integration User Guide USER GUIDE 20-Mar-19

2 Contents 1. Introduction Abbreviations Version Information Integration Component Version Security Expert Version System Overview... 4 Figure 1: System Overview Installation Prerequisites Installation Steps Step 1 Start installation Step 2 Install Complete System Operations System Start up Check Integration service is running Log-in to Security Expert Client Setup Security Expert DVR Configuration Camera Setup Setup the Status Page Editor Status Page View Setup Doors View the Events in Status Page View Event Injection from Security Expert to VideoXpert Event Injection from VideoXpert to Security Expert Using VxMaps with Security Expert Setup using VxToolbox Seeing Access Control using VxMaps Plugin in OpsCenter Using the Access Control System Viewer Using the Rules Engine with Security Expert Issues and Limitations Troubleshooting Steps References VideoXpert 3.X Security Expert Integration 2 User Guide

3 13. Support VideoXpert 3.X Security Expert Integration 3 User Guide

4 1. Introduction This document is the user guide for VideoXpert Integration with Security Expert. 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 PTZ Pan Tilt Zoom Table 1: Abbreviations 3. Version Information 3.1. Integration Component Version # Component Name Version Description 1 SecurityExpertVideoIntegtrationInstaller 3.x Security Expert integration driver Table 2: Integration Component Version 3.2. Security Expert Version # Component Name Version Remarks 1 Security Expert Table 5: OnGuard Version 4. System Overview VideoXpert to Security Expert Integration enables the interaction between Security Expert and VideoXpert systems. This VideoXpert integration brings in opportunity to end users by extending Security Expert software s Security surveillance capabilities using VideoXpert functionalities such as live and recorded streaming, PTZ. VideoXpert provides live streams from various IP cameras that are placed at various places in the building. This VideoXpert integration helps the end users to manage their complete building security using Security Expert. VideoXpert 3.X Security Expert Integration 4 User Guide

5 Figure 1: System Overview 5. Installation 5.1. Prerequisites Following are the prerequisites which need to be installed before installing the Security Expert Video Integration Installer. 1. Security Expert v or higher Security Expert software should be installed and licensed for the proper functioning of the integration. 2. Security Expert SOAP Service v or higher Note: The Security Expert SOAP Service must communicate with the Security Expert server machine. Install the Security Expert SOAP Service in the Security Expert server or make sure the name of the server is given in the while configuring the service. VideoXpert 3.X Security Expert Integration 5 User Guide

6 5.2. Installation Steps Security Expert SOAP Service configuration Step 1 Start installation Right click on the SecurityExpertVideoIntegrationInstaller exe file and Run as administrator to start the installation. Installation wizard starts with the following window. VideoXpert 3.X Security Expert Integration 6 User Guide

7 Installation home screen On clicking the Exit Installer button a message box shown to confirm the exit Exit Installer screen VideoXpert 3.X Security Expert Integration 7 User Guide

8 On clicking Begin Installation button, the Configure Service Port window will be shown. Configure the details of the IP Address of the Security Expert SOAP Service host User name of the Security Expert server Password of the Security Expert Server Name of the Site configured in the Security Server. Specify the Organization name mentioned while installing Security Expert Server. Service port By default the service port will be and user can change the port if required. Set this service port number in DVR configuration window in Security Expert. Figure 4: Begin Installation On clicking Install button, the installation process starts and the following window will be shown. VideoXpert 3.X Security Expert Integration 8 User Guide

9 Step 2 Install Complete Click Close button to finish the installation. Installation progress 6. System Operations Before installing SecurityExpertVideoIntegrationInstaller exe make sure all the prerequisites are installed System Start up After the complete installation, add the VideoXpert in Security Expert and get camera list, live streaming, archive streaming and PTZ operations by the following steps Check Integration service is running 1. Open the Services snap-in: Go to Run command, Type services.msc and press Enter 2. Scroll down and locate Pelco Video Service Integration service from Services 3. Ensure that Pelco Video Service Integration has started automatically. If they haven't, right click the service and select Start. VideoXpert 3.X Security Expert Integration 9 User Guide

10 Figure 2: Pelco Video Service Integration in Services list Log-in to Security Expert Client Log-in to security expert with user credentials Figure 3: Security Expert Login screen Setup Security Expert DVR Configuration 1. DVR should be configured first, for that please select the menu MONITORING->SETUP->DVR VideoXpert 3.X Security Expert Integration 10 User Guide

11 Figure 4: DVR configuration menu 2. Click on ADD and provide the DVR details. Figure 5: DVR configuration setting VideoXpert 3.X Security Expert Integration 11 User Guide

12 3. Select DVR type as custom and provide the below details 1. IP Address: IP Address of VX System 2. DVR Port: Port number of VX System 3. Service Port: Service port given during the Installation of Security Expert Integration Installer. 4. Username: user name of VX System 5. Password: password of VX System 4. Click on SAVE after providing the DVR details Camera Setup 1. For configure the camera, please select the menu MONITORING->SETUP->CAMERA 2. Click on ADD and provide camera details. Figure 6: Camera configuration Menu VideoXpert 3.X Security Expert Integration 12 User Guide

13 Figure 7: Camera configuration settings 3. Select Type as DVR and choose the DVR given in the previous step from the drop down menu. 4. Then click on the button corresponding to DVR Camera Name to populate the camera list in the DVR VideoXpert 3.X Security Expert Integration 13 User Guide

14 Figure 8: Camera List 5. Select Camera from the list and click on SAVE Setup the Status Page Editor Configure the status page in this section to display camera and event windows. 1. For configuring this view, select the Menu MONITORING->SETUP->STATUS PAGE EDITOR VideoXpert 3.X Security Expert Integration 14 User Guide

15 Figure 9: Status Page Editor Menu 2. Click on ADD and then enter the Name for status page and choose the status page layout. Figure 10: Status Page Editor Settings 3. Then click on OK. 4. Then choose the Record, Columns and Rows according to the Type and then SAVE. Example: For setting camera stream in First row First column of Status Page view, we have set Type as Camera, choose camera in Record, set column as 1, and set Rows as 1. VideoXpert 3.X Security Expert Integration 15 User Guide

16 Figure 11: Status Page Editor setting sample Status Page View This will show the Camera Live stream and the event windows which configured in the previous step. 1. For viewing this view, select the Menu MONITORING->STATUS PAGE VIEW VideoXpert 3.X Security Expert Integration 16 User Guide

17 Figure 12: Status Page View 2. PTZ Controls The small arrow at the top right of the camera stream window shows the PTZ controls. User can do Pan, Tilt and Zoom operations by clicking on the PTZ control buttons. VideoXpert 3.X Security Expert Integration 17 User Guide

18 Figure 13: PTZ controls Setup Doors 1. For setting up Doors in Security Expert, select PROGRAMMING->DOORS Figure 14: Door settings VideoXpert 3.X Security Expert Integration 18 User Guide

19 2. Click on ADD and provide Door details 3. Select a camera containing recordings as the Camera (Entry) or Camera (Exit) in the graphics tab View the Events in Status Page View 1. For viewing the Events, please select MONITORING->STATUS PAGE VIEW The above step (mentioned in 5.1.8) will add an event in the event window in status page with a yellow camera icon. Figure 15: Status Page View- Events list 2. Right click on the event and select Camera (Archived). This will show the archive window corresponding to the time of the event log. 3. Modify the date and time in Archive View Controls and click on Archive View button for showing the Archive streaming VideoXpert 3.X Security Expert Integration 19 User Guide

20 Figure 16: Status Page View- Camera archive The archive window shows three stream windows 1. 5 seconds looping window seconds image slider window 3. Live View Event Injection from Security Expert to VideoXpert Beginning with version , certain access events are automatically mapped to VX events. Namely: VideoXpert 3.X Security Expert Integration 20 User Guide

21 system/access_door_opened system/access_door_closed system/access_door_faulted system/access_door_forced system/access_door_propped system/access_door_locked system/access_door_unlocked system/access_denied system/access_granted These events may also be mapped to external events if you so choose. 1. Make sure that Security Expert SOAP Service is installed in Server. By default the Security Expert SOAP Service port will be If Security Expert SOAP Service port is changed during SOAP service installation, the port should be updated in client endpoint address of the C:\Program Files (x86)\pelco\security Expert Integration\PelcoVideoComponent.exe.config config file. Figure 17: SOAP Endpoint Address in Configuration file 2. Open C:\Program Files (x86)\pelco\security Expert Integration\ExternalEvents.xml file. Then Add external events with name and event id as mentioned in Security Expert Events List.xlsx document to the ExternalEvents file. Figure 18: External Events Configurations 3. Open Event Mapper short cut from Desk Top(In Security Expert Server Machine) 1. Click on Connect button to connect with VideoXpert and create situations. VideoXpert 3.X Security Expert Integration 21 User Guide

22 Figure 19:: Event Mapper Configurations 2. Click on Properties button and change the Situation properties if any 3. Then Save 4. Restart the Pelco Video Service Integration service in Services List 5. Make sure to check Monitor Events from this DVR/NVR during configuring DVR to subscribe to events. VideoXpert 3.X Security Expert Integration 22 User Guide

23 Figure 20: Setting for Monitor Events from this DVR/NVR 6. Restart Security Expert DVR B service in services.msc and wait for 1 minute before starting Security Expert application. Figure 21: Restart Security Expert DVR B service 7. Open Door Programming and modify the Door VideoXpert 3.X Security Expert Integration 23 User Guide

24 Figure 22: Door Programming 8. Open Status Page View and see the door modified event VideoXpert 3.X Security Expert Integration 24 User Guide

25 Figure 23: Status Page View 9. Open VideoXpert OpsCenter s Event Viewer or the Access Control System Viewer to see the events from Security Expert Figure 24: Security Expert Events listed in VideoXpert OpCenter Event Viewer portal Note: Restart Pelco Video Service Integration first and then Restart Security Expert DVR Service B in server if you make any changes to DVR List. VideoXpert Integration Security Expert 19 User Guide VideoXpert 3.X Security Expert Integration 25 User Guide

26 Event Injection from VideoXpert to Security Expert 1. Make sure that Security Expert v or higher is installed in server and client machine. 2. Make sure that SecurityExpertVideoIntegrationInstaller is installed in server machine. 3. Make sure to check Monitor Events from this DVR/NVR during configuring DVR to subscribe to events. Figure 25: Setting for Monitor Events from this DVR/NVR 4. Restart Pelco Video Service Integration in services.msc 5. Restart Security Expert DVR Service B in services.msc and wait for 1 minute before starting Security Expert application. Figure 26: Restart Security Expert DVR B service VideoXpert 3.X Security Expert Integration 26 User Guide

27 6. Events logged from VideoXpert can be viewed in client. Security Expert Event types and VideoXpert situations are listed in the below table. Security Expert Event Online Event Offline Event Motion Detected Event Motion Ceased Event Camera Input Activated Temperature Event Storage Event Diagnostic Event Physical Offline Event Physical Online Event Vx Situations system/data_source_online system/device_online system/data_source_offline system/device_offline analytic/motion analytic/no_motion system/alarm_active hardware/temperature hardware/volume_full system/stream_loss system/stream_restored hardware/input_loss hardware/input_restored VideoXpert 3.X Security Expert Integration 27 User Guide

28 Property Changed Event Video Analytics Event admin/device_modified admin/device_decommissioned admin/device_commissioned admin/device_assigned admin/device_unassigned All analytic events except motion and no motion VideoXpert 3.X Security Expert Integration 28 User Guide

29 Figure 27: VideoXpert Events Listed Note: Restart Pelco Video Service Integration first and then Restart Security Expert DVR Service B in server if you make any changes to DVR List. VideoXpert 3.X Security Expert Integration 29 User Guide

30 7. Using VxMaps with Security Expert Beginning with version of the Security Expert Integration, you can add access points to maps Setup using VxToolbox Using VxToolbox, you may go to the Maps tab. While editing a map, you can select the Other Devices tab to view the access points available for the map. You may then drag and drop your access point to the map Seeing Access Control using VxMaps Plugin in OpsCenter In the VX OpsCenter application, you can drag VxMaps from the plugins section to a cell. If you select a map with access control points. For more information, please refer to the VideoXpert documentation. VideoXpert 3.X Security Expert Integration 30 User Guide

31 8. Using the Access Control System Viewer The Access Control System Viewer is an OpsCenter plugin available on partnerfirst.pelco.com. It is specifically designed to work with access control systems, including Security Expert. You need at least version of the Security Expert integration for support of the Access Control System Viewer. You will need to set up the Access Control System Viewer by pressing the icon that looks like a gear. The Server Name can be any text string that helps you identify this server. The IP address needs to match the IP address of the machine where you installed the Security Expert integration. The port must be Using the Rules Engine with Security Expert Using the rules engine in VideoXpert, you can add more activities to a Security Expert event like moving a PTZ to a preset, bookmark recording, activate a relay, etc. Please refer to VideoXpert documentation for more information about adding a rule into VideoXpert using Vx-Toolbox. To use the rules engine with a specific door, you will need to use the event properties device_id for an external event or Access Point Id for system events. Below are the details of a System/Access Door Locked. Notice that in this case, the Access Point Id is 6. You may retrieve the event properties in the Event Viewer in VX OpsCenter by selecting Copy Details on an event. VideoXpert 3.X Security Expert Integration 31 User Guide

32 The door number will match what was set up in the PROGRAMMING->DOORS menu of Security Expert in the DataBase ID column like below. The following screen demonstrates how to move two different cameras to specific presets based on which door was unlocked. VideoXpert 3.X Security Expert Integration 32 User Guide

33 The rule s text is copied below for clarity: if (eventproperties["access_point_id"] == "6") { datasourceid = "uuid:3c b6b-90bd-1e4b-3b0a93ea9104:video" actions.triggerpreset(datasourceid, "PRESET9") } if (eventproperties["access_point_id"] == "7") { datasourceid = "uuid:3c b6b-90bd-1e4b-3b0a93ea9104:video" actions.triggerpreset(datasourceid, "PRESET3") } The datasourceid can be found in VxToolbox, or in OpsCenter. VideoXpert 3.X Security Expert Integration 33 User Guide

34 VideoXpert 3.X Security Expert Integration 34 User Guide

35 10. Issues and Limitations Unable to test the PTZ Command string functionality as it triggers from an event. For testing events, it needs a simulator software. On Camera live window of Security Expert Software, PTZ controls are displayed as enabled for non PTZ cameras also. Unable to test the events like Temperature, Storage, Diagnostic, Physical Offline, Physical Online from VideoXpert to Security Expert as not possible to simulate those events. Unable to test in multi core or multi CMG setup due to network limitations. Randomly occurs crash on security expert server due to some memory issue in security expert machine Fails to install the Security expert Video Integration plugin in Windows Server 2012 R2 Standard version in some case. Fundamental reason for this issue is the fact that the.net Framework is failed to install in some installations of Windows Server The root cause of which is related to a Windows Update. The blocking error message is as below. The update corresponding to KB needs to be installed before you can install this product on Windows 8.1 or Windows Server 2012 R2. This issue happens with some Windows Server 2012 deployments only. The workaround identified for this issue is to manually deploy Windows Update. The following windows patch files: KB & KB are installed as prerequisite. After that installation of Microsoft.net framework is successful and Security expert Video Integration plugin is installed successfully. Fails to stream the live video automatically after changing the video configuration of camera. In this case, we need to manually refresh the Status Page view for the stream update. Run-time error occurs in Security Expert on longevity testing in Security Expert server. It is due to some memory issue and manually refreshing is the only solution for stream update. 11. Troubleshooting Steps If any crash is occurring in the PelcoVideoComponent.exe, Restart Pelco Video Service Integration first and then Restart Security Expert DVR Service B for running the application smoothly. 12. References # Documents/Inputs Description 1 Discussions Technical and requirement analysis discussion between internal and external stakeholders 2 AN-187_Pelco_DVR_Integration.pdf.pdf Pelco DVR Integration manual 3 VideoXpert integration experience Learnings from the development and testing of VideoXpert integration modules. 4 EcoStruxure Security Expert brochure.pdf Security Expert brochure for understanding about it 5 SX-SRVR Operations Server-Client Installation Guide of Security Expert. Installation Guide.pdf 6 SX-SRVR Operator Reference Manual.pdf Operator Manual of Security Expert 7 GXVideoServerSDK for DVR.pdf Reference Manual of ProtegeGX Video Server SDK Video Server VideoXpert 3.X Security Expert Integration 35 User Guide

36 8 GXVideoSDK for Client Application.pdf Reference Manual of ProtegeGX Video Client SDK Client Application Table 5: References 13. Support If the instructions provided fail to solve your problem, contact Pelco Product Support at (USA and Canada) or (international) for assistance. VideoXpert 3.X Security Expert Integration 36 User Guide

37 Pelco by Schneider Electric 625 W. Alluvial, Fresno, California USA (800) Tel (800) Fax +1 (559) International Tel +1 (559) International Fax Pelco, the Pelco logo, and other trademarks associated with Pelco products referred to in this publication are trademarks of Pelco, Inc. or its affiliates. ONVIF and the ONVIF logo are trademarks of ONVIF Inc. All other product names and services are the property of their respective companies. Product specifications and availability are subject to change without notice. Copyright 2018, Pelco, Inc. All rights reserved VideoXpert 3.X Security Expert Integration 37 User Guide