.. _reports:

*****************************
Reports
*****************************


.. rubric:: In this chapter:

.. contents::
   :local:

Report Types
======================

The following reports are available:

* Standard reports on the system entities:

  * :ref:`events <events>`
  * :ref:`episodes <episodes>` 
  * :ref:`search <search>`
  * :ref:`clusters <clusters>` 
  * :ref:`cameras <cameras>`
  * :ref:`cards <cards>`
  * :ref:`analytical data <analytics>`
  * :ref:`audit logs <audit-logs>`
  * :ref:`areas <areas>`, area activations, area activation records 

* Work time reports that allow you to regard the exact moments of staff entering and exiting an enterprise or a designated area and calculate the total time spent at it. Can be built either on the :guilabel:`Events` or :guilabel:`Areas` tab. 

Build Standard Report
========================

To build a standard report on a system entity, do the following: 

#. Navigate to the tab associated with the required entity: :guilabel:`Events`, :guilabel:`Episodes`, :guilabel:`Search`, :guilabel:`Clusters`, :guilabel:`Cameras`, :guilabel:`Cards`, :guilabel:`Analytics`, :guilabel:`Audit Logs`, :guilabel:`Areas`.
#. Set filters for the report.
#. Click :guilabel:`Create Report`.

    |build_report_en|

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

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

#. Specify the report name.
#. If you are on the :guilabel:`Events` or :guilabel:`Areas` tab, select the report type :guilabel:`Standard report` (as there are two types of reports available).
#. If applicable, choose whether to save the report images as links, thumbnails, or full frames. 

    |standard_report_en|

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

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

#. Click :guilabel:`Create`. The report will be available for download on the :guilabel:`Reports` tab.

     |report_en|

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

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


Build Work Time Report
=============================


A work time report can be built on the following tabs:

* :guilabel:`Events`: work time personalized general report. Requires specifying cameras of entry and exit. 
* :guilabel:`Areas`: work time non-personalized report regarding usage of a specific area. Considers moments of entering and exiting an area with a given ID. 


.. rubric:: :guilabel:`Events`

To build a work time report on the :guilabel:`Events` tab, do the following: 

#. Set filters for the report.
#. Click :guilabel:`Create Report`.

    |build_report_en|

#. Specify the report name.
#. Select the report type: :guilabel:`Work time report`.
#. Select the entrance camera.
#. Select the exit camera.
#. If applicable, choose whether to save the report images as links, thumbnails, or full frames. 

    |work_report_events_en|

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

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

#. Click :guilabel:`Create`. The report will be available for download on the :guilabel:`Reports` tab.



.. rubric:: :guilabel:`Areas`:


To build a work time report on the :guilabel:`Areas` tab, do the following: 

#. Set filters for the report.
#. Click :guilabel:`Create Report`.

    |build_report_areas_en|

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

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

#. Specify the report name.
#. Select the report type: :guilabel:`Work time report`.
#. Specify the area ID.

    |work_report_areas_en|

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

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

#. Click :guilabel:`Create`. The report will be available for download on the :guilabel:`Reports` tab.

Work with Reports
=======================

You can access reports previously created in the system on the :guilabel:`Reports` tab. The following operations are available:

* Download selected reported into the XLSX format.
* Update selected reports. 
* Delete selected reports.

     |report_en|


Configure Saving Images in Reports
========================================

When building certain reports, you will be able to choose to save the report images as links, thumbnails, or full frames. It is possible to configure the image parameters. To do so, open the ``/etc/findface-security/config.py`` configuration file and alter the default JPEG quality and the maximum height of thumbnails and full frames, subject to your free disc space.

.. code::

   sudo vi /etc/findface-security/config.py

   # reports image saving options
   'REPORT_THUMBNAIL_JPEG_QUALITY': 75,
   'REPORT_THUMBNAIL_MAX_HEIGHT': 100,
   'REPORT_FULLFRAME_JPEG_QUALITY': 75,
   'REPORT_FULLFRAME_MAX_HEIGHT': 250,