.. _reports:

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


FindFace CIBR provides a possibility of building reports on the following system entities:

  * :ref:`search results <search-objects>`
  * :ref:`global records <record-index>`
  * :ref:`audit log <audit-logs>`

.. rubric:: In this section:

.. contents::
   :local:



Build Report
=====================

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

#. Navigate to the tab associated with the required entity: :guilabel:`Search`, :guilabel:`Record Index` or :guilabel:`Audit Log`.
#. Perform the search if you are on the :guilabel:`Search` tab. See :ref:`search-objects`. Click the |report_icon| button to build the report, or the :guilabel:`More filters` button to set filters first.

    .. |report_icon| image:: /_static/report_icon.png
        :scale: 30%

    |report_filter_search_en|

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

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


#. If you are on the :guilabel:`Record index` tab, click the |report_icon| button to build the report, or the :guilabel:`More filters` button to set filters first.

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

#. If you are on the :guilabel:`Audit Log` tab, click the |report_icon| button to build the report, or the :guilabel:`More filters` button to set filters first.

    |report_filter_audit_en|

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

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

#. Set filters for the report. Filters are different for each system entities.
#. 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.
#. Check one or several report formats: XLS, JSON, CSV.
#. Choose whether to save the report images as links, thumbnails, or full frames. (Only for search results and global records).

    |report_en|

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

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

#. Click :guilabel:`Add`. 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.
* Update selected reports. 
* Delete selected reports.

     |report_tab_en|

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

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

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