SMARTPROTECT INTEGRATIONS SmartProtect Q-Guard Event Integration Installation and Configuration Guide V 1.0.0
Contents Target Audience:... 3 Copyright, trademarks and disclaimers... 3 Prerequisites... 4 Introduction... 4 System Architecture... 5 Installing the System... 6 Event Database... 6 Event Processing Server... 7 Milestone Advanced XProtect Plugin... 7 Configuring the System... 11 SmartProtect Event Server: Server Configuration... 11 XProtect Management Plugin: General System Configuration... 14 Zones... 15 Zone Camera Mapping... 16 Object Classification... 17 Settings... 18 Rules... 20 XProtect Smart Client Plugin: Adding a View Item... 20 Using the System... 23 Zones... 23 Cameras... 25 Live Tracks... 26 Live Track List... 26 Alarms... 27
[2]
TARGET AUDIENCE: This Document is intended for system administrators as well as operators. COPYRIGHT, TRADEMARKS AND DISCLAIMERS COPYRIGHT Smartprotect TRADEMARKS SmartProtect is a registered Trademark. DISCLAIMERS This Document is intended for General Information purposes only and due care has been taken in its preparation. Any risk arising from the use of this information rests with the recipient, and nothing herein should be construed as constituting any kind of warranty. SmartProtect reserves the right to make adjustments without prior notification. All names of people and organizations used in this document's examples are fictitious. Any resemblance to any actual organization or person, living or dead, is purely coincidental and unintended. This product may make use of third party software for which specific terms and conditions may apply. [3]
I N T R O D U C T I O N PREREQUISITES.NET Framework 4.5.2 Milestone XProtect Corporate 2017 R3 product range or Milestone XProtect Professional and Plus 2017 R3 product range, excluding products that do not support plugins. SQL Server 2014 SQL Server 2014 Express is included in the installation, however for larger sites with high transaction volumes, SQL Server 2014 Standard or Enterprise would be recommended. Network access between all components of the system, including the SQL Server and the Milestone XProtect Smart Client. INTRODUCTION The SmartProtect Q-Guard Event Integration System, integrates Milestone s XProtect system with Quanergy s Q-Guard System. The Integration combines Q-Guard multi sensor LIDAR system data with the video management capabilities of XProtect to provide improved situational awareness for system operators. This improvement is achieved by providing the operator with real time object tracking data including object classification and then combining this with video. [4]
I N S T A L L A T I O N SYSTEM ARCHITECTURE [5]
I N S T A L L A T I O N INSTALLING THE SYSTEM The installation process is started when the Installation file ( SPQuanergyInstaller VX.X.X.X.EXE ) is executed. Elevated privileges is required for the Installer to run correctly. Please Select the Relevant Features to be installed and click Next to start the Process: Figure 1 EVENT DATABASE Select the Database Features to be installed: Install a New SQL Server Express Instance, or; Use an existing SQL Server Instance Click Next to Continue. [6]
I N S T A L L A T I O N Figure 2 If a New Instance Installation is selected, the SQL Server 2014 installer will proceed to install a new instance of the DBMS software. This installation may take several minutes to complete. When choosing to use an existing instance, the connection to the instance must be specified. Default File Paths may be selected, or the system will require selection of the SQL Database file locations. EVENT PROCESSING SERVER Select an installation path (or default) and click Next. The installation will concluded by adding an Icon to your desktop for the SmartProtect Quanergy Lidar Server. MILESTONE ADVANCED XPROTECT PLUGIN Select the Correct Milestone Product family when prompted, and Click Next to continue. [7]
I N S T A L L A T I O N Figure 3 Select the Product Features to be installed for Milestone XProtect, and click Next to continue. [8]
I N S T A L L A T I O N Figure 4 [9]
I N S T A L L A T I O N Figure 5 In order to uninstall the system, navigate to Programs and Features and uninstall the SmartProtect Quanergy Lidar System. The system will need confirmation to delete the system database. Figure 6 [10]
C O N F I G U R A T I O N CONFIGURING THE SYSTEM SMARTPROTECT EVENT SERVER: SERVER CONFIGURATION Just after initial installation, the SmartProtect Quanergy Lidar Server Shortcut on the desktop must be clicked in order to start the Tray Icon. When clicking, please be patient as the system will search for available database connections, and this may take several seconds. If the database connection fails, the connection dialog will be displayed. Figure 5 [11]
C O N F I G U R A T I O N Figure 8 The SmartProtect Event Server, can be configured by right clicking on the Service Tray Icon. From this menu the server can be started, stopped or restarted. Settings can be altered and system status messages can be seen by selecting SmartProtect Lidar Server Status Messages. Selecting SmartProtect Lidar Server Settings, will display the basic settings window as seen in Figure 9. The Database Connection of the Service may be altered by clicking the Change button, in the SQL Server Details group box. If the Default SQL Server Express Installation was done, the default Username and Password for SQL Server Authentication is: sa and Sm@rtprotect. Specify credentials to be used to connect to connect to the Milestone XProtect Management server, in the XProtect Server Details group box. [12]
C O N F I G U R A T I O N Figure 9 Under Other Settings, the service Default Log Level can be changed. All settings other than Normal is used for debugging. Click Apply to Apply settings to the Server. The Status area will give feedback regarding the application of the settings that has been changed. [13]
C O N F I G U R A T I O N XPROTECT MANAGEMENT PLUGIN: GENERAL SYSTEM CONFIGURATION The system configuration can be accessed by logging into the XProtect Management Client. The SmartProtect Event Plugin can be found by navigating to the bottom of the Site Navigation pane, and expanding the MIP Plug-ins node, and then expanding the Quanergy Mip Plugin nodes. Figure 10 The Configuration interface consists of several TAB pages, each configuring a different part of the system. [14]
C O N F I G U R A T I O N ZONES Figure 6 The Zones tab is automatically populated by the system from the data received from Q-Guard. The Colour for each zone may be altered in this Interface. [15]
C O N F I G U R A T I O N ZONE CAMERA MAPPING Figure 7 For implementation of the milestone rules and alarms system, cameras need to be associated with zones. This interface enables dragging and dropping of multiple cameras to each zone, to make this association. Rules for different object types and zones can then be created in the XProtect Management Client. [16]
C O N F I G U R A T I O N OBJECT CLASSIFICATION Object classes are automatically populated by the system. The colours associated with each type can be altered in this interface. Figure 8 [17]
C O N F I G U R A T I O N SETTINGS This TAB is meant only for advanced users. [18] Figure 9 The Settings TAB contains a large amount of important system settings that in most cases should be left unchanged. Some settings will influence system performance and can be used to fine tune performance for large sites. The Settings items marked in Yellow should be configured before system startup. Here follows a Short description of settings and their functions: Connection: o Database_Connection: SQL Server Database connection. Map: o Default_Zoom_Level: The map zoom level at start up. o Map_Provider: Provider for the map data. o Map_Provider_License_Key: Key for paid map provider. Milestone: o Default_Encoding: Milestone Communication code page. o Management_Server_Authorization_Type: Windows / Basic User o Management_Server_Host_Name: Hostname or IP of Milestone XProtect Management Server. o Management_Server_Username: Username for XProtect Management Server. o Management_Server_Password: Password for XProtect Management Server.
C O N F I G U R A T I O N o Tracklist_Send_Frequency_Ms: The Frequency at which track data is sent to the Milestone system. o Zonelist_Send_Frequency_Ms: The Frequency at which zone object data is sent to the Milestone system. o Object_Linger_Time_Sec: The amount of time an object lingers after disappearing from view. Misc: o Bulk_Insert_Batch_Size: Maximum size of database insert operations. o Bulk_Insert_Timeout_Sec: Database insert timeout. o Database_Maintenance_Frequency_Min: Frequency at which old data is purged. o Maximum_Data_Age_Days: Maximum age of data in the database. o Default_Object_Class_Colour: Default colour assigned when a new object classification is encountered. o Default_Zone_Colour: Default colour assigned when a new zone is encountered. o Forward_Ignored_Tracks: True/False Send ignored tracks to milestone. o Log_File_Path: Path of log files. o Log_Name: Log file name for the Mip Plugin. o Server_Log_Name: Log file name for the SmartProtect server. o Log_Level: Level of logging required. o Map_Tail_Legth_Sec: Track Tail Length. o Max_Live_Object_Age_Min: Age of object that are considered active. o Server_Config_Refresh_Freq_Sec: How often is server configuration automatically refreshed. QGuard_Sensor: o Master_Sensor_Heading: (Degrees) 0 deg = north. o Master_Sensor_Latitude: Latitude. o Master_Sensor_Longitude: Longitude. o Reverse_X_Axis: True/False. o Reverse_Y_Axis: True/False. o Recerse_Z_Axis: True/False. QGuard_Sockets: o Data_Encoding: Code page of the QGuard communications. o Keep_Alive_Ms: Maximum amount of time we expect to wait for a message from QGuard. o Max_Keep_Alives_Missed: Maximum amount of expected messages missed, before the connections is deemed to be in a faulted state. o Max_Received_Message_Queue_Length: Maximum number of messages that will be buffered in memory. o Object_List_Port_Number: Port number for track data. o Zone_List_Port_Number: Port number for zone data. o QGuard_Hostname: Hostname or IP Address of the QGuard server. o Read_Frequency_Ms: The frequency at which data is read from the socket. o Timeout_Ms: Socket read timeout. Server_Tray: o Server_Tray_URL: URL for tray communication. [19]
C O N F I G U R A T I O N o o o Service_Display_Name: Display name of the service. Service_Name: Name of the Service. Tray_Log_Name: Name of the log file for the tray system. RULES Figure 10 The System automatically populates the rules system in milestone. These rules are available to generate alarms to trigger any action available in the XProtect system. XPROTECT SMART CLIENT PLUGIN: ADDING A VIEW ITEM In order to add the Quanergy Mip Plugin to a view in the XProtect Smart Client, in the Live workspace, first click the Setup button at the top right corner of the window. [20]
C O N F I G U R A T I O N Figure 11 In the Views pane, add a group, or select an existing group, then add a new view. Figure 12 [21]
C O N F I G U R A T I O N In the System Overview pane, select the Quanergy Mip Plugin, and drag and drop the view item into the view you just created. Click Setup again to leave setup mode. Figure 13 [22]
O P E R A T I O N USING THE SYSTEM ZONES All the Zones that has been configured in the Q-Guard Client, will automatically be populated in the plugin in the Milestone Smart Client. Figure 14 (Q-Guard Client) [23]
O P E R A T I O N Figure 15 [24]
O P E R A T I O N CAMERAS Camera that has been added to Milestone with GIS coordinates, will automatically appear on the Map in the Smart Client plugin. Any of these cameras may be clicked to display live video. Figure 16 (Video Popup) [25]
O P E R A T I O N LIVE TRACKS Real time tracks will appear in the Smart Client plugin as they are detected by the Q-Guard system. Figure 17 LIVE TRACK LIST The pane on the left side of the plugin shows real time track and zone data for tracks detected. The colour of each track and also each zone is the colour of the Object Class as configured in the Management Client. As a track enters or exists a zone the zone will appear and disappear from the track list zone column. [26]
O P E R A T I O N ALARMS If alarms have been configured in the Management Client, these alarms will appear in the Smart Client Alarm Manager, with details and associated video. Figure 18 [27]