.. _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-objects>`
  * :ref:`clusters <clusters>` 
  * :ref:`video sources <cameras>`
  * :ref:`records <record-index>`
  * :ref:`analytical data <people-analytics>`
  * :ref:`audit logs <audit-logs>`
  
* 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 on the :guilabel:`Events` 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:`Search`, :guilabel:`Episodes & Events`, :guilabel:`Clusters`, :guilabel:`Video Sources`, :guilabel:`Record index`, :guilabel:`Audience analysis`, :guilabel:`Audit Logs`.
#. Click the :guilabel:`More filters` button. Set filters for the report.

    |report_filter_records_en|

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

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

#. Click :guilabel:`Apply and create report`.

    |report_build_en|

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

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

#. Specify the report name.
#. If you are on the :guilabel:`Events` 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. 
#. Click :guilabel:`Add`. The report will be available for download on the :guilabel:`Reports` tab.

    |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%


 

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


A work time report can be built on the :guilabel:`Events` tab. It requires specifying entrance and exit cameras. 

To build a work time report, do the following: 

#. Set filters for the report.
#. Click :guilabel:`Apply and create report`.

    |report_build_en|

#. Specify the report name.
#. Select the report format.
#. Select the report type: :guilabel:`Work time report`.
#. If applicable, choose whether to save the report images as links, thumbnails, or full frames. 
#. Select the entrance camera.
#. Select the exit camera.
#. Click :guilabel:`Add`. The report will be available for download on the :guilabel:`Reports` tab.

    |report_events_work_en|

     .. |report_events_work_en| image:: /_static/report_events_work_en.png
        :scale: 70%

     .. |report_events_work_ru| image:: /_static/report_events_work_ru.png
        :scale: 70%



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

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

* Download selected reports.
* Update selected reports. 
* Delete selected reports.

    |report_tab_en|

     .. |report_tab_en| image:: /_static/report_tab_en.png
        :scale: 65%

     .. |report_tab_ru| image:: /_static/report_tab_ru.png
        :scale: 65%


.. seealso::
   :ref:`report-images`