Пользовательские вкладки, поля и фильтры в досье

Часто необходимо, чтобы досье в веб-интерфейсе содержало дополнительные вкладки и поля, по которым можно осуществлять поисковые запросы.

См.также

Для того чтобы создать пользовательские поля досье в биометрической базе данных Tarantool, см. Пользовательские метаданные лиц досье в Tarantool.

Для добавления пользовательских вкладок и полей в досье выполните следующие действия:

  1. Подготовьте список пользовательских вкладок и полей для добавления в досье.

  2. Откройте файл конфигурации /etc/findface-security/config.py.

    sudo vi /etc/findface-security/config.py
    
  3. В разделе FFSECURITY раскомментируйте секцию CUSTOM_FIELDS и измените ее примерное содержимое с учетом следующих правил:

    • 'items': список полей в досье. Опишите каждое поле следующими параметрами:

      • 'name': внутреннее имя поля, string.

      • 'label': название поля в веб-интерфейсе, string.

      • 'display': формат отображения (form или list), string или array.

      • 'tab': вкладка, на которой располагается поле. Если не задана, поле появится на главной странице досье (той, что с фотографией).

      • 'editable': редактируемость поля, boolean.

      • 'type': тип данных поля, string. Возможные значения:

        • list: требует задания items, дополнительного параметра для списков (см. ниже), ожидает объекты {id, name} в словарях;

        • valuelist: ожидает элементы примитивных типов.

        • objectlist: позволяет создавать массивы объектов нужного типа.

        • datetime: примитивный тип данных, отображаемый как список datetime.

        • date: примитивный тип данных, отображаемый как выбор даты.

        • boolean: примитивный тип данных, отображаемый как флажок.

        • string: примитивный тип данных string.

      • дополнительные параметры для списков (type=list, type=valuelist):

        • multiple: возможность выбора нескольких элементов в списке, boolean.

        • items: словарь, используемый как источник данных для списка.

        • allow_create: возможность добавления новых элементов в список, boolean.

        • custom_id: пользовательское поле для id (type=list).

      • дополнительные параметры для списков объектов (type=objectlist).

        • object: объекты, используемые как источник данных для списка объектов.

        • simple: указывает, что поле ожидает данные примитивного типа вместо объектов, например, ожидает строки с телефонными номерами.

    • 'filters': список фильтров для поиска по пользовательским полям. Параметры:

      • 'name': внутреннее имя фильтра,

      • 'label': название фильтра в веб-интерфейсе,

      • 'field': связанное поле в формате [имя поля].

    • 'tabs': список вкладок в досье. Первая вкладка в списке соответствует главной странице досье.

    FFSECURITY = {
    
    ...
    
        # Edit CUSTOM_FIELDS section to customize dossier content.
        # Below is an example for integration FindFace Security with Sigur.
        'CUSTOM_FIELDS': {
            'dossier_meta': {
                'items': [
                    {
                        'name': 'personid',
                        'default': '',
                        'label': 'PersonID',
                        'display': ['list', 'form'],
                        'description': 'Sigur person ID'
                    },
                    {
                        'name': 'firstname',
                        'default': '',
                        'label': 'First Name',
                        'display': ['list', 'form'],
                        'description': 'Sigur first name'
                    },
                    {
                        'name': 'lastname',
                        'default': '',
                        'label': 'Last Name',
                        'display': ['list', 'form'],
                        'description': 'Sigur last name'
                    },
                    {
                        'name': 'version',
                        'default': '',
                        'label': 'Version',
                        'display': ['list', 'form'],
                        'description': 'Sigur photo version'
                    }
                ],
                'filters': [
                    {
                        'name': 'personid',
                        'label': 'Sigur person ID filter',
                        'field': 'personid'
                    }
                ]
            }
        },
    
  4. Вы увидите, что новая форма досье появилась в веб-интерфейсе.