.. _guests:

***************************************
Face Monitoring and Dossier Database
***************************************

This chapter is all about monitoring detected faces and creating the dossier database. Each dossier has to contain one or several photos of a person and belong to a certain classification list (watch list), black or white in the simplest case. You can create several watch lists, subject to a person status or hazard level.


.. tip::
   To create dossiers in bulk, use the :ref:`batch photo upload <batch-upload>` functionality.

.. rubric:: In this section:

.. contents::
   :local:

.. _unmatched-list:

Monitoring Unmatched Faces
==================================

FindFace Security features one pre-configured watch list that is used for monitoring only unmatched faces. This watch list cannot be removed from the system. To edit its settings or deactivate it, navigate to the :guilabel:`Preferences` tab. Click :guilabel:`Watch Lists` and then click :guilabel:`Unmatched` in the table.

    |unmatched_en|
 
     .. |unmatched_en| image:: /_static/unmatched_en.png
        :scale: 60%

     .. |unmatched_ru| image:: /_static/unmatched_ru.png
        :scale: 60%

.. note::
   To view only unmatched faces in the event list, select :guilabel:`Unmatched` in the :guilabel:`Watch lists` filter on the :guilabel:`Events` tab (refer to :ref:`events` for details).

.. _create-list:

Create Watch List
=================================

To create a custom watch list, do the following:

.. tip::
   Besides the :guilabel:`Unmatched` watch list, there is also a default preconfigured watch list to monitor matched faces. This watch list cannot be removed from the system.

#. Navigate to the :guilabel:`Preferences` tab. Click :guilabel:`Watch Lists`.
#. Click :guilabel:`+`.

    |create_list_en|
 
     .. |create_list_en| image:: /_static/create_list_en.png
        :scale: 60%

     .. |create_list_ru| image:: /_static/create_list_ru.png
        :scale: 60%

#. From the :guilabel:`Label` palette, select a color which will be shown in notifications for this list. Keep in mind that the right color makes for quicker response of security and hospitality managers.

    |list_en|
 
     .. |list_en| image:: /_static/list_en.png
        :scale: 60%

     .. |list_ru| image:: /_static/list_ru.png
        :scale: 60%

#. Specify the watch list name. Add a comment if needed.
#. Select a camera group(s) which will be used to monitor the watch list. If no groups specified, the watch list will be monitored by all active cameras in the system.
#. Check :guilabel:`Require acknowledgment` if it is mandatory that events associated with the list be manually acknowledged.
#. Check :guilabel:`Enable sound alert` to turn on sound notifications for the list if needed.
#. By default, all watch lists in the system are applied the :ref:`generic confidence threshold <settings>`. To set an individual threshold for the watch list, check :guilabel:`Confidence Threshold` and specify the threshold value. 

   .. include:: /_inclusions/threshold_important.rst

#. Check :guilabel:`Active`.
#. Click :guilabel:`Save`.
#. On the :guilabel:`Permissions` tab, assign privileges on the watch list, specifying which user roles are allowed to change/view the watch list settings.

    |list_permissions_en|
 
     .. |list_permissions_en| image:: /_static/list_permissions_en.png
        :scale: 60%

     .. |list_permissions_ru| image:: /_static/list_permissions_ru.png
        :scale: 60%

#. Click :guilabel:`Save`.

.. _create-dossier:

Create Dossier Manually
====================================

To create a dossier manually, do the following:

#. Navigate to the :guilabel:`Dossiers` tab.
#. Click :guilabel:`+`.

    |create_dossier_en|
 
     .. |create_dossier_en| image:: /_static/create_dossier_en.png
        :scale: 60%

     .. |create_dossier_ru| image:: /_static/create_dossier_ru.png
        :scale: 60%

#. Attach a photo, related documents, and specify the name of a person. If necessary, add a comment.

   .. important::
      A face in the photo must be of high quality, i.e. close to a frontal position. Distance between pupils: 60 px. Supported formats: WEBP, JPG, BMP, PNG. Photos that do not meet the requirements will be rejected with a detailed error description.

   |dossier_en|
 
    .. |dossier_en| image:: /_static/dossier_en.png
        :scale: 60%

    .. |dossier_ru| image:: /_static/dossier_ru.png
        :scale: 60%

#. From the :guilabel:`Watch lists` drop-down menu, select a classification list (or several lists, one by one) for the dossier.
#. Check :guilabel:`Active`. If a dossier is inactive, it is excluded from the real time face identification.
#. Click :guilabel:`Save`. If a similar dossier already exists in the database, you will be able to merge it with the new one, create the new dossier anyway, or cancel creation.

.. _batch-upload:

Batch Photo Upload
========================

To create dossiers in bulk, use the batch photo upload. Do the following:

.. tip::
   If you need to upload a large number of photos (more than 10,000), use :ref:`bulk-upload`.

.. important::
   Faces in photos must be of high quality, i.e. close to a frontal position. Distance between pupils: 60 px. Supported formats: WEBP, JPG, BMP, PNG. Photos that do not meet the requirements will be rejected with a detailed error description.

#. Navigate to the :guilabel:`Dossiers` tab.
#. Click :guilabel:`+`.

    |create_dossier_en|
 
#. Click :guilabel:`Batch Dossier Upload`.

    |batch_upload_en|
 
     .. |batch_upload_en| image:: /_static/batch_upload_en.png
        :scale: 40%

     .. |batch_upload_ru| image:: /_static/batch_upload_ru.png
        :scale: 40%

#. Select multiple image files, or a folder.

    |configure_upload_en|
 
     .. |configure_upload_en| image:: /_static/configure_upload_en.png
        :scale: 60%

     .. |configure_upload_ru| image:: /_static/configure_upload_ru.png
        :scale: 60%

#. You can use image file names as a basis for names and/or comments in dossiers to be created. Select the necessary option(s). Then configure the automatic name/comment generation rule by appending a custom prefix and/or postfix to the file name.

   .. tip::
      To avoid merging the 3 words into one, use underscore or another symbol in the prefix and postfix.

#. From the :guilabel:`Watch lists` drop-down menu, select a classification list for the dossiers.
#. Use the :guilabel:`Parallel Upload` option to specify the number of photo upload streams. The more streams you use, the faster it takes to complete the upload, however it requires more resources as well.
#. From the :guilabel:`Group Photo` drop-down menu, select the system behavior upon detecting several faces in a photo: reject the photo, upload the biggest face, or upload all faces.
#. Click :guilabel:`Start` to launch the photo upload.

   .. important::
      To view the batch photo upload log, click :guilabel:`Logs`. You can then download the log in the ``.csv`` format if needed.

      |batch_upload_log_en|
 
       .. |batch_upload_log_en| image:: /_static/batch_upload_log_en.png
          :scale: 50%

       .. |batch_upload_log_ru| image:: /_static/batch_upload_log_ru.png
          :scale: 50%


Filter Dossiers by Watch List
=================================

You can find all dossiers created in FindFace Security on the :guilabel:`Dossiers` tab. Use the :guilabel:`Watch lists` filter to filter dossiers by list.

      |filter_dossier_en|
 
       .. |filter_dossier_en| image:: /_static/filter_dossier_en.png
          :scale: 60%

       .. |filter_dossier_ru| image:: /_static/filter_dossier_ru.png
          :scale: 60%


Purge Dossier Database
============================

You can purge the entire dossier database in one click. To do so, navigate to the :guilabel:`Preferences` tab. Click :guilabel:`Watch Lists`. Click :guilabel:`Delete All Dossiers`.

      |dossier_delete_en|
 
       .. |dossier_delete_en| image:: /_static/dossier_delete_en.png
          :scale: 60%

       .. |dossier_delete_ru| image:: /_static/dossier_delete_ru.png
          :scale: 60%