.. _custom-metadata:

Dossier Face Custom Metadata in Tarantool
======================================================

It is often necessary to assign additional metadata to the dossier faces in your Tarantool-based biometric database.

.. seealso::
   To create dossier custom tabs, fields, and filters in the web interface, see :ref:`custom-tabs`.
 
To set the face custom metadata, do the following:

#. Prepare the list of custom meta fields you want to assign to a dossier face in Tarantool.
#. Open the ``findface-security`` configuration file. 

   .. code::

      sudo vi /etc/findface-security/config.py
      
#. Into the ``FFSECURITY`` section, uncomment the ``CUSTOM_FIELDS`` -> ``dossier_face`` section and modify the exemplary content, considering the following:

   * ``field_name``: field name;
   * ``type``: data type;
   * ``default``: field default value. If a default value exceeds ‘1e14 – 1', use a string data type to specify it, for example, ``"123123.."`` instead of ``123123..``.

   .. code::

      FFSECURITY = {

      ...

      'CUSTOM_FIELDS': {
        ...
              'dossier_face': {
                  'items': [
                      {
                          "field_name": "tag_name_1",
                          "type": "string",
                          "default": "change_me"
                      },
                      {
                          "field_name": "tag_name_2",
                          "type": "uint",
                          "default": 123
                      },
                      {
                          "field_name": "tag_name_3",
                          "type": "bool",
                          "default": True
                      },
                  ]
              }
      },

#. :ref:`Add the new meta fields <modify-schema>` to the Tarantool database structure.  

#. You can work with the new meta fields through :ref:`HTTP API <api>` using the ``dossier-faces`` methods.