March 31 2021 Documentation
Total Page:16
File Type:pdf, Size:1020Kb
SAFR® Documentation SAFR Facial Recognition SAFR® Documentation Documentation Version = 3.014 Publish Date = March 31, 2021 Copyright © 2021 RealNetworks, Inc. All rights reserved. SAFR® is a trademark of RealNetworks, Inc. Patents pending. This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited. The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing. 1 Contents 1 What’s New 7 2 SAFR Overview 8 3 SAFR System Requirements 11 4 Getting Started with SAFR Platform on Windows or macOS 21 5 Connect Desktop Clients 25 6 Getting Started with SAFR Platform on Linux 26 7 Getting Started with SAFR Desktop with a Cloud Account 29 8 Camera Best Practices 31 9 Set up ONVIF IP Cameras 38 10 Connect Cameras to SAFR 39 11 Connect to a Video Feed 42 12 Interpret Video Feed Overlays 47 13 View Video Feeds Status 49 14 Manage People in the Person Directory 52 15 Importing and Registering People 53 16 Image Quality Metrics Guidance 56 17 Use Event Analytics to Gain Insight 60 18 Actions Overview 62 19 Actions Relay Event Service (ARES) 65 20 SAFRActions.config 66 21 SAFR Actions 77 22 SAFR Server Clusters 79 23 Add Secondary Servers 83 24 Database and Object Storage Redundancy 86 25 SSL Certificate Installation 94 26 On-Premise Licensing 99 27 SAFR Support Scripts 101 28 SAFR Server Backup and Restore 103 29 SAFR Platform Command Line Install Options 111 2 30 Video Recognition Gateway (VIRGO) 114 31 VIRGO System Requirements 115 32 VIRGO Installation Guide 117 33 VIRGO in the Video Feeds Window 120 34 VIRGO Command Line Interface 125 35 Video Feeds Properties 130 36 Processing Video Files 153 37 VIRGO Tools 166 38 Factory Configuration File 167 39 Docker 172 40 GPU Support 175 41 Service Logging 178 42 Service Monitoring 180 43 VIRGO Architecture 182 44 Troubleshooting 185 45 Desktop Client 188 46 Camera Feed Analyzer 189 47 View Menu Options 190 48 Operator Console 192 49 Search by Image View 194 50 People Window 196 51 Events Window 199 52 Person Activity Window 201 53 Video Feeds Window 203 54 Account Preferences 205 55 Camera Preferences 206 56 Detection Preferences 211 57 Tracking Preferences 216 58 Recognition Preferences 218 59 Events Preferences 223 3 60 User Interface Preferences 226 61 Manage Users Preferences 228 62 Cloud Licensing 231 63 SAFR Desktop Command Line Install Options 232 64 Connect a Face Recognition Panel 234 65 Connect a Registration Kiosk 236 66 Customize a Registration Kiosk 238 67 Configure a Mobile Device into Locked Mode 240 68 Install SAFR Beam 251 69 Mobile Accounts Preferences 252 70 Mobile Detection Preferences 253 71 Mobile Recognition Preferences 255 72 Mobile Events Preferences 257 73 Mobile User Interface Preferences 259 74 Web Console 260 75 Status Page 261 76 People Page 269 77 Events Page 270 78 Video Feeds Pages 271 79 Reports Page 273 80 Traffic Dashboard 274 81 Queue Dashboard 277 82 Attendance Dashboard 279 83 Traversal Dashboard 281 84 Traffic Report 284 85 Mask Detection Dashboard 286 86 SMS Watchlist Alarms Dashboard 288 87 Occupancy Areas Editor 291 88 Occupancy Dashboard 294 89 Occupancy Alarm Dashboard 297 4 90 Occupancy Report 300 91 Face Detection-Person Detection Tie-In 303 92 Identity Recognition Thresholds 305 93 Identity Synchronization Configuration 307 94 Pose Liveness Detection 309 95 RGB Liveness Detection 310 96 SAFR Avigilon Integration Guide 311 97 SAFR Avigilon Operation Guide 317 98 SAFR Digifort Integration Guide 320 99 SAFR Digifort Operation Guide 327 100SAFR Genetec Integration Guide 336 101SAFR Genetec Operation Guide 345 102SAFR Genetec FaceRec Integration Guide 356 103SAFR Genetec FaceRec Operation Guide 365 104SAFR Geutebrueck Integration Guide 375 105SAFR Geutebrueck Operation Guide 385 106SAFR Milestone Integration Guide 388 107SAFR Milestone Operation Guide 392 108SAFR Video Insight Integration Guide 407 109SAFR Video Insight Operation Guide 411 110March 2021 Release Notes 414 111February 2021 Release Notes 416 112December 2020 Release Notes 418 113November 2020 Release Notes 419 114October 2020 Release Notes 421 115August 2020 Release Notes 423 116July 2020 Release Notes 424 117June 2020 Release Notes 426 118May 2020 Release Notes 427 119April 2020 Release Notes 428 5 120March 2020 Release Notes 430 121January 2020 Release Notes 433 122December 2019 Release Notes 435 123November 2019 Release Notes 438 124September 2019 Release Notes 441 125August 2019 Release Notes 444 6 1 What’s New The following features are new in the March 2021 SAFR release: • SMS Watchlist Alarms Dashboard • RGB Liveness Detection 7 2 SAFR Overview SAFR is an exceptionally accurate AI-powered facial recognition that provides a new level of visibility and situational awareness for security professionals. You can easily integrate access control peripherals such as cameras, door locks, or alert systems in order to manage access to a location based on people’s identities. SAFR runs on a variety of operating systems, including Windows, macOS, Linux, iOS, and Android. 2.1 SAFR Components SAFR consists of the following components: • SAFR Server: Available for Windows, macOS, and Linux. SAFR Server consists of a recognition engine, an event server, several databases, and the Web Console. The databases contain stored face images of enrolled people, the identity information for the stored faces, and recognition events that have been generated by the SAFR system. SAFR Server runs as several background services that automatically start on system reboot and are kept active by the operating system. They must be running at all times for the SAFR system to be operational. In order to be functional, all other SAFR components must maintain a connection to a SAFR Server. Note that if you’re doing a cloud deployment you’ll be connecting to a SAFR Server in the cloud that RealNetworks maintains. • Desktop Client: Available for Windows and macOS. The Desktop Client is one of the primary ways that administrators and operators can interact with the SAFR system. As such, the client can be used to enable camera connectivity, monitor video camera feeds, register users, view recognition events, and more. • Mobile Client: Available for Android and iOS. The Mobile Client converts a mobile device into a registration kiosk or a recognition panel. Registration kiosks allow people to self-register their face into the Identity Database so they can be approved for access or granted other privileges. Recognition panels enable the mobile device to scan the faces of people that walk by and compare those faces against faces in the Identity Database. Mobile devices set up as recognition panels can also provide visual or audio feedback to the person viewing the mobile device based on actions that a SAFR administrator has configured. • Video Recognition Gateway (VIRGO): Available as a standalone download for macOS and Linux. It’s also available as part of the SAFR Desktop and SAFR Platform download packages. VIRGO is a daemon system which receives video feeds from one or more cameras and recognizes and tracks faces in those video streams in real time. It generates tracking events and sends those events to an event server. The VIRGO video feeds can be controlled either by the command line tool or by the Video Feeds window in the Desktop Client or the Web Console. • Web Console: Available on all platforms. The Web Console provides administrators and operators web-based access to the SAFR system. As such, the Web Console can be used to generate analytical reports, monitor video camera feeds, register users, view recognition events, and more. • Actions Relay Event Service (ARES): Available as a standalone download for all platforms. ARES is a cross-platform Java application that acts as the event listener that dispatches configured actions in response to events. ARES can provide replies on any event handled by the client that originates an event and is normally installed as a service when either SAFR Platform or SAFR Desktop are installed. It is constantly active and is automatically started by the operating system on power-up. • SAFR Actions: SAFR Actions is a GUI that facilitates configuring SAFRActions.config. SAFRAc- tions.config is the file that defines all the defined actions for your SAFR System, as well as a couple fields that are used to connect ARES (and SAFR Actions) to your primary SAFR Server, whether that 8 server is local or in the cloud. See Actions for more information about actions in SAFR. In addition to the SAFR components listed above, SAFR also relies on a couple additional non-SAFR components: • IP Cameras: As you might expect, Internet Protocol (IP) cameras are absolutely integral to SAFR. Both the Desktop Client and VIRGO automatically detect integrated, USB, and Open Network Video Interface Forum (ONVIF) IP cameras. If an IP camera does not support ONVIF or doesn’t have ONVIF enabled, you can still manually add it to the SAFR system as described here. • Physical access control devices: Door locks, electronic gates, etc. can all be used by SAFR to grant or deny access to people, depending on whether or not they’re identified as having the proper authorization. • Notification systems: Email can be used to discretely notify specified people of various events, while general alarms can be used to alert everybody in the vicinity when unauthorized people attempt to force entry.