API del GBDS

Archivo de Configuración

Los parámetros de configuración de la API del GBDS se definen en un archivo de configuración que contiene todos los parámetros y sus respectivos valores. Los parámetros omitidos asumen su valor por defecto. Esta sección describe las propiedades del archivo de configuración.

Ubicación del Archivo

El archivo de configuración está ubicado en: /etc/griaule/conf/gbsapi/gbdsapi.properties.

Propiedades del Archivo

El archivo de configuración debe seguir algunos requisitos para que pueda ser interpretado correctamente por el GBDS. Estos requisitos son:

1. El nombre del archivo y su ubicación deben ser exactamente iguales a lo descrito en la sección Ubicación del Archivo

2. Debe haber solamente un parámetro de configuración por línea.

3. Cada parámetro de configuración debe tener la forma {parâmetro}={valor}, sin saltos de línea;

4. Cada valor debe estar separado por una coma cuando se asigne al mismo parámetro.

Parámetros de Configuración

Esta sección describe cada uno de los parámetros de configuración de la API del GBDS que pueden estar listados en el archivo de configuraciones y cómo afectan la operación del sistema.

Seguridad

Consulte el Manual de Seguridad del GBDS para más información sobre las configuraciones de seguridad del GBDS.

gbscluster.api.security.enabled

Este parámetro define si los métodos de seguridad para autenticación y autorización están habilitados.

Valor Predeterminado:

true

Valores posibles:

• true

• false

gbscluster.api.security.keystore

Este parámetro define la ruta al keystore que contiene la contraseña del usuario de enlace LDAP y la clave de firma del token JWT.

Valor Predeterminado:

Vacío

gbscluster.api.security.ldap.url

Este parámetro define la URL de conexión para el servidor LDAP.

Valor Predeterminado:

Vacío

gbscluster.api.security.ldap.userSearchBase

Este parámetro define el Distinguished Name (DN) para el repositorio del usuario en el servidor LDAP.

Valor Predeterminado:

Vacío

gbscluster.api.security.ldap.userSearchAttribute

Este parámetro define el atributo del usuario que será usado como nombre de usuario durante la autenticación.

Valor Predeterminado:

Vacío

gbscluster.api.security.ldap.userGroupMembershipAttribute

Este parámetro define el atributo del usuario que contiene su información de pertenencia a grupos.

Valor Predeterminado:

Vacío

gbscluster.api.security.ldap.bindUserDN

Este parámetro define el Distinguished Name del usuario vinculado.

Valor Predeterminado:

Vacío

gbscluster.api.security.token.ttlInMilliseconds

Este parámetro define el tiempo de vida, en milisegundos, del Token JWT.

Valor Predeterminado:

Vacío

Valores posibles:

1800000 (30 min) a 10800000 (3 horas)

Valor recomendado:

3600000 (1 hora)

gbscluster.api.security.authorization.ranger.configurationDirectory

Este parámetro es opcional y define el directorio con la información de configuración específica del GBDS para Apache Ranger.

Valor Predeterminado:

Vacío

gbscluster.api.security.authorization.rolePermissionMapFile

Este parámetro es opcional y define el archivo con roles/permisos mapeados para las aplicaciones del GBDS.

Valor Predeterminado:

Vacío

gbds.cluster.kafka.task.topic

Este parámetro define el tópico de Kafka donde las tareas serán asignadas.

Valor Predeterminado:

gbds-tasks

gbds.cluster.zookeeper.quorum

Este parámetro define el nombre de host y el puerto en el que se puede encontrar el servidor zookeeper. Cada valor debe estar separado por comas si hay más de un valor disponible.

Valor Predeterminado:

<hostname>:<port>

gbscluster.kafka.broker

Este parámetro define la dirección del Kafka Broker y debe reflejarse en las configuraciones de Kafka.

Valor Predeterminado:

<hostname>:6667

gbscluster.kafka.producer.acks

Este parámetro define el número de acknowledgments que el productor requiere que el líder haya recibido antes de considerar la solicitud completa. Este parámetro controla la durabilidad de los registros que se envían.

Valor Predeterminado:

1

Valores posibles:

• 0

• 1

• all

Consulte la Documentación de Kafka para más información.

gbscluster.kafka.producer.buffer.memory

Este parámetro define la memoria total que el productor puede usar para el buffer de registros en espera de ser enviados al servidor, en bytes.

Valor Predeterminado:

67108864

gbscluster.kafka.producer.batch.size

Este parámetro define el tamaño máximo del lote (batch) que el productor puede enviar en una única solicitud cuando múltiples registros se envían a la misma partición.

Valor Predeterminado:

8196

gbscluster.kafka.consumer.fetch.message.max.bytes

Este parámetro define el número de bytes de mensaje para el intento de fetch por cada partición/tópico en cada solicitud de consulta.

Valor Predeterminado:

1248576

gbscluser.dispatcher.requests.topic

Este parámetro define el tópico usado para escuchar nuevas solicitudes. No hay ninguna relación entre este parámetro y gbscluster.kafka.group.

Valor Predeterminado:

requests

gbscluser.dispatcher.requests.nthreads

Este parámetro define el número de threads a usar para los consumidores de solicitudes. Por defecto, se define como el número de particiones que el tópico de solicitudes posee.

Valor Predeterminado:

1

gbscluser.dispatcher.requests.partitions

Este parámetro define el número de particiones usadas por Kafka para el almacenamiento de tópicos de solicitud.

Valor Predeterminado:

1

gbscluser.dispatcher.requests.replication

Este parámetro define el factor de replicación usado por los tópicos de Kafka.

Valor Predeterminado:

3

gbscluster.hdfs.person.location

Este parámetro define la ubicación donde los archivos XML ANSI/NIST serán guardados.

Valor Predeterminado:

hdfs://<hostname>:8020/tmp/gbscluster/

gbscluster.hdfs.host

Este parámetro define la dirección de host del HDFS y debe reflejar las configuraciones del HDFS.

Valor Predeterminado:

hdfs://<hostname or HA nameservice>:8020

gbscluster.transport.http.url

Este parámetro define la URL de transporte HTTP.

Valor Predeterminado:

http://<hostname>

gbscluster.transport.http.port

Este parámetro define el puerto de transporte HTTP.

Valor Predeterminado:

6516

gbscluster.search.verify.primary.fingerprints

Este parámetro define si las operaciones de búsqueda deben ejecutarse sobre templates de huellas dactilares.

Valor Predeterminado:

true

Valores posibles:

• true

• false

gbscluster.search.verify.primary.faces

Este parámetro define si las operaciones de búsqueda deben ejecutarse sobre templates de rostro.

Valor Predeterminado:

true

Valores posibles:

• true

• false

gbscluster.search.verify.primary.iris

Este parámetro define si las operaciones de búsqueda deben ejecutarse sobre templates de iris.

Valor Predeterminado:

false

Valores posibles:

• true

• false

gbscluster.search.verify.primary.palmprints

Este parámetro define si las operaciones de búsqueda deben ejecutarse sobre templates de palmas.

Valor Predeterminado:

false

Valores posibles:

• true

• false

gbscluster.search.verify.primary.newborn-palmprints

Este parámetro define si las operaciones de búsqueda deben ejecutarse sobre templates de palma de recién nacidos.

Valor Predeterminado:

false

Valores posibles:

• true

• false

gbscluster.search.iris.verify.matchthreshold

Este parámetro define la puntuación mínima para que una comparación de iris sea considerada una coincidencia durante una operación de búsqueda.

Valor Predeterminado:

26

gbscluster.search.fingerprints.ul.verify.matchthreshold

Este parámetro define la puntuación mínima para que una comparación de huella dactilar UL sea considerada una coincidencia durante la operación de búsqueda.

Valor Predeterminado:

35

gbscluster.search.palmprints.ul.verify.matchthreshold

Este parámetro define la puntuación mínima para que una comparación de palma UL sea considerada una coincidencia durante la operación de búsqueda.

Valor Predeterminado:

35

gbscluster.activate.quality.duplicities

Este parámetro define cuándo considerar una transacción de registro con duplicidades como ENROLL_FAILED (false) o ENROLL_PENDING (true).

Valor Predeterminado:

false

Valores posibles:

• true

• false

gbscluster.enroll.fingerprints.verify.matchthreshold

Este parámetro define la puntuación mínima para considerar una comparación 1:1 entre huellas dactilares una coincidencia durante una operación de búsqueda.

Valor Predeterminado:

25

gbscluster.enroll.fingerprints.verify.anglethreshold

Este parámetro define el ángulo a ser considerado al comparar dos dedos durante una operación de búsqueda.

Valor Predeterminado:

180

Rango:

0 to 180 (-1 tendrá el mismo efecto que 180)

gbscluster.update.faces.verify.matchthreshold

Este parámetro define el umbral a usar durante la comparación de biometrias faciales en operaciones de búsqueda. Establecer un valor alto para este parámetro puede, posiblemente, resultar en un aumento de ocurrencias de falsos negativos.

Valor Predeterminado:

60

gbscluster.enroll.newborn-palmprints.verify.matchthreshold

Este parámetro define la puntuación mínima para considerar una comparación 1:1 de palmas de recién nacidos una coincidencia durante una operación de búsqueda.

Valor Predeterminado:

35

gbscluster.enroll.fingerprints.ul.anglethreshold

Este parámetro define el ángulo a ser considerado al comparar dos huellas dactilares latentes no resueltas.

Valor Predeterminado:

180

Rango

0 to 180 (-1 causará el mismo efecto que 180)

gbscluster.update.consider.fingerprints

Este parámetro define si las huellas dactilares deben considerarse al generar excepciones de actualización.

Valor Predeterminado:

true

Valores posibles:

• true

• false

gbscluster.update.consider.faces

Este parámetro define si las imágenes de rostro deben considerarse al generar excepciones de actualización.

Valor Predeterminado:

false

Valores posibles:

• true

• false

gbscluster.update.consider.faces.beforeFingerprints

Este parámetro define si las caras deben analizarse antes que las huellas dactilares al generar excepciones de actualización. Si false, el análisis de rostro se realiza después del análisis de la huella dactilar.

Valor Predeterminado:

false

Valores Posibles:

• true

• false

gbscluster.update.minimum.fingers

Este parámetro define el número mínimo de coincidencias entre dedos necesario para que una operación de actualización sea aceptada.

Valor Predeterminado:

4

gbscluster.min.quality

Este parámetro define la calidad mínima necesaria para una huella dactilar, de modo que no se genere una transacción de ENROLL_PENDING.

Valor Predeterminado:

50

gbscluster.update.min.quality

Este parámetro define la calidad mínima necesaria para una huella dactilar, de modo que no se genere una transacción de UPDATE_PENDING.

Valor Predeterminado:

50

gbds.enroll.fingerprints.min-nr-template

Este parámetro define el número mínimo de templates de huella dactilar necesario para que una transacción sea procesada. Si la transacción no contiene el número requerido de huellas, fallará.

Valor Predeterminado:

0

gbds.enroll.faces.min-nr-template

Este parámetro define el número mínimo de templates de rostro requeridos para que la transacción sea procesada. Si la transacción no contiene el número requerido de templates, fallará.

Valor Predeterminado:

0

gbds.enroll.iris.min-nr-template

Este parámetro define el número mínimo de templates de iris requeridos para que la transacción sea procesada. Si la transacción no contiene el número requerido de templates, fallará.

Valor Predeterminado:

0

gbds.enroll.palmprint.min-nr-template

Este parámetro define el número mínimo de templates de huellas de palma requeridos para que la transacción sea procesada. Si la transacción no contiene el número requerido de templates, fallará.

Valor Predeterminado:

0

gbds.enroll.newborn-palmprint.min-nr-template

Este parámetro define el número mínimo de templates de palma de recién nacido necesario para que la transacción sea procesada. Si la transacción no contiene el número requerido de templates, fallará.

Valor Predeterminado:

0

gbscluster.update.fingerprints.verify.matchthreshold

Este parámetro define la puntuación mínima para considerar una comparación 1:1 de huellas dactilares como una coincidencia durante una operación de verificación.

Valor Predeterminado:

35

gbscluster.update.fingerprints.verify.anglethreshold

Este parámetro define el ángulo a ser considerado al comparar dos huellas dactilares durante la operación de verificación.

Valor Predeterminado:

180

Rango:

0 to 180 (-1 causará el mismo efecto de 180)

gbscluster.enroll.fingerprints.verify.duplicities.matchthreshold

Al realizar la verificación de calidad, durante la operación de registro, se ejecuta una comparación entre dedos buscando duplicados en la transacción.

Este parámetro define la puntuación mínima para que una huella dactilar verificada sea considerada duplicada al realizar la validación entre dedos.

Valor Predeterminado:

45

gbscluster.enroll.fingerprints.verify.sequencecheck.matchthreshold

Este parámetro define el umbral mínimo para que una captura principal sea considerada una coincidencia contra su respectivo índice en el control de secuencia.

Si la comparación entre los dedos capturados y sus respectivos dedos en el control de secuencia (por ejemplo 4-4-2 o 2-2-1) devuelve puntuaciones de coincidencia por encima de este umbral, se considerará una coincidencia por la verificación de secuencia.

Valor Predeterminado:

20

gbscluster.enroll.fingerprints.verify.sequencecheck.matchthreshold.<index>

Este parámetro define la puntuación mínima para que una captura específica sea considerada una coincidencia contra su respectivo índice en el control secuencial.

Si la comparación entre el dedo definido por el índice y sus respectivos dedos en el control de secuencia (por ejemplo 4-4-2 o 2-2-1) devuelve puntuaciones de coincidencia por encima de este umbral, se considerará una coincidencia por la verificación de secuencia.

Esta configuración es opcional y, si no se define, el GBDS usará el valor de umbral global definido en gbscluster.enroll.fingerprints.verify.sequencecheck.matchthreshold.

Esta configuración debe repetirse en el archivo de configuración para cada dedo individual que se desee definir con un umbral diferente al global.

El <index> en la configuración debe ser cambiado de acuerdo con el dedo deseado. Los valores posibles son:

• left_little

• left_ring

• left_middle

• left_index

• left_thumb

• right_thumb

• right_index

• right_middle

• right_ring

• right_index

El índice debe tener el formato de STRING de acuerdo con la lista anterior. Cualquier otro valor será considerado inválido y descartado.

gbscluster.enroll.fingerprints.identify.sequencecorrection.matchthreshold

Este parámetro define la puntuación mínima para que la captura principal sea considerada una coincidencia al comparar contra todas las otras huellas en el control de secuencia.

Esta comparación se realiza después de identificarse problemas en el control de secuencia para comprobar si las huellas de las capturas principales están intercambiadas. Si la huella de la captura principal no coincide con su respectiva captura en el control de secuencia, el sistema resolverá automáticamente el problema recortando la imagen del control de secuencia y sustituyendo la captura principal.

El número máximo de correcciones realizadas está determinado por el parámetro ```gbscluster.enroll.fingerprints.sequencecorrection.maxcorrections. Si el número de correcciones es mayor que el valor definido, no se realizará ninguna corrección para el perfil y el estado de la transacción se definirá como PENDING`.

Este parámetro define la puntuación mínima para que las capturas enrolladas sean consideradas una coincidencia cuando se comparan contra todas las capturas posadas del control de secuencia.

Valor Predeterminado:

20

gbscluster.enroll.fingerprints.identify.sequencecorrection.matchthreshold.<index>

Este parámetro define la puntuación mínima para que la captura principal sea considerada una coincidencia al comparar contra todas las otras huellas en el control de secuencia.

Esta comparación se realiza después de identificarse problemas en el control de secuencia para comprobar si las huellas de las capturas principales están intercambiadas. Si la huella de la captura principal no coincide con su respectiva captura en el control de secuencia, el sistema resolverá automáticamente el problema recortando la imagen del control de secuencia y sustituyendo la captura principal.

El número máximo de correcciones realizadas está determinado por el parámetro gbscluster.enroll.fingerprints.sequencecorrection.maxcorrections. Si el número de correcciones es mayor que el valor definido, no se realizará ninguna corrección para el perfil y el estado de la transacción se definirá como PENDING.

{% hint style="info" %} Esta configuración es opcional y, si no se define, el GBDS usará el valor de umbral global definido en gbscluster.enroll.fingerprints.identify.sequencecorrection.matchthreshold. {% endhint %}

{% hint style="info" %} Esta configuración debe repetirse en el archivo de configuración para cada dedo individual que se desee definir con un umbral diferente al global. {% endhint %}

El <index> en la configuración debe ser cambiado de acuerdo con el dedo deseado. Los valores posibles son:

• left_little

• left_ring

• left_middle

• left_index

• left_thumb

• right_thumb

• right_index

• right_middle

• right_ring

• right_index

{% hint style="warning" %} El índice debe tener el formato de STRING de acuerdo con la lista anterior. Cualquier otro valor será considerado inválido y descartado. {% endhint %}

gbscluster.enroll.fingerprints.sequencecorrection.maxcorrections

Este parámetro define el número máximo de correcciones automáticas realizadas antes de considerar una transacción como PENDING y enviarla para revisión manual. Si el número de correcciones requerido es mayor que el especificado en este parámetro, no se realizará ninguna corrección y la transacción original será enviada a revisión manual.

Valor Predeterminado:

4

gbscluster.enroll.fingerprints.sequencecontrol.copy-to-searchable-biometrics

Este parámetro define si las imágenes del control de secuencia deben ser recortadas para registros donde no hay ninguna imagen de huellas dactilares individuales disponible.

Valor Predeterminado:

false

Valores posibles:

• true

• false

gbscluster.fingerprints.extraction.cab.enabled (obsoleto)

{% hint style="warning" %} Esta configuración fue obsoleta a partir de la versión 4.7.0. Consulte las configuraciones que la sustituyen: gbscluster.fingerprints.extraction.enroll.type y gbscluster.fingerprints.extraction.verify.type. {% endhint %}

Este parámetro define si el CAB debe ser extraído para nuevas biometrias.

Valor Predeterminado:

false

Valores posibles:

• true

• false

gbscluster.fingerprints.extraction.fnet.enabled (obsoleto)

{% hint style="warning" %} Esta configuración fue obsoleta a partir de la versión 4.7.0. Consulte las configuraciones que la sustituyen: gbscluster.fingerprints.extraction.enroll.type y gbscluster.fingerprints.extraction.verify.type. {% endhint %}

Valor Predeterminado:

false

Valores posibles:

• true

• false

gbscluster.fingerprints.extraction.enroll.type

Este parámetro define el preset de extractor de ginger a usar para Registro y Actualización.

Valor Predeterminado:

GRIAULE_2024

Valores posibles:

• GRIAULE_FAST: versión más simple y rápida de GRIAULE_BASIC (nunca usado en la API).

• GRIAULE_BASIC: antiguo "…cab.enabled = false", extracción por defecto para Verificación.

• GRIAULE_2020: antiguo "…cab.enabled = true", antigua extracción por defecto para Registro, Actualización.

• GRIAULE_2024: nueva extracción por defecto para Registro, Actualización.

• GRIAULE_2018: antiguo "…fnet.enabled = true".

gbscluster.fingerprints.extraction.verify.type

Este parámetro define el preset de extractor de ginger a usar para Verificación.

Valor Predeterminado:

GRIAULE_BASIC

Valores posibles:

• GRIAULE_FAST: versión más simple y rápida de GRIAULE_BASIC (nunca usado en la API).

• GRIAULE_BASIC: antiguo "…cab.enabled = false", extracción por defecto para Verificación.

• GRIAULE_2020: antiguo "…cab.enabled = true", antigua extracción por defecto para Registro, Actualización.

• GRIAULE_2024: nueva extracción por defecto para Registro, Actualización.

• GRIAULE_2018: antiguo "…fnet.enabled = true".

gbds.rdb.driverClassName

Este parámetro define el nombre de clase usado por la base de datos relacional para almacenar latentes no resueltas.

Valor Predeterminado:

com.mysql.jdbc.Driver

gbds.rdb.url

Este parámetro define la URL de la base de datos relacional que será accedida.

Valor Predeterminado:

jdbc:mysql://<address>:<port>/gbds

gbds.rdb.username

Este parámetro define el nombre de usuario a usar para el acceso a la base de datos relacional.

Valor Predeterminado:

root

gbds.rdb.password

Este parámetro define la contraseña a usar para el acceso a la base de datos relacional.

Valor Predeterminado:

Vacío

gbds.rdb.dialect

Este parámetro define el dialecto a usar en la base de datos relacional.

Valor Predeterminado:

org.hibernate.dialect.MySQLDialect

gbds.rdb.showSql

Este parámetro define si las declaraciones SQL deben incluirse en los registros de la aplicación.

Valor Predeterminado:

false

Valores posibles:

• true

• false

gbds.biometric.best-of-biometrics.enabled

Este parámetro habilita el best-of-biometrics. Cuando está habilitado, el conjunto de biometrias de la persona es la consolidación de las mejores biometrias obtenidas de todas las transacciones de la persona a lo largo del tiempo.

{% hint style="warning" %} Esta flag DEBE debe tener el mismo valor en las configuraciones del GBDS y de la API del GBDS. {% endhint %}

Valor Predeterminado:

false

gbds.biometric.face.template.format

Define el formato del template para rostro.

Los valores posibles son: TPT_FORMAT_1 o TPT_FORMAT_2.

{% hint style="warning" %} Los formatos de rostro no son intercambiables. Rostros que fueron enrollados en un formato no harán match con rostros hechos en otro formato. {% endhint %}

{% hint style="danger" %} El valor de esta configuración debe ser el mismo en los archivos application.conf y gbdsapi.properties {% endhint %}

gbds.peopleList.countFromRDB

Este parámetro define el comportamiento de la paginación en la llamada de la API people/list. Definir como true, la lista de personas siempre contará el total de personas usando el filtro de restricción pasado. En grandes bases de datos puede comprometer el rendimiento. Definir como false restringirá la respuesta solo a los valores count, pageSize y currentPage.

Valor Predeterminado:

true

gbds.person.canDeleteOnException

Este parámetro permite la eliminación de personas en excepción. Es válido tanto para la referencia como para la persona entrante.

Valor Predeterminado:

false

gbds.searches.verify.saveOnRdb.enabled

Define si la operación de verificación se guardará en la tabla gbds.transaction del RDB.

Valor Predeterminado:

true

{% hint style="danger" %} Este valor debe ser el mismo en el application.conf y en el gbdsapi.properties {% endhint %}

gbds.searches.identify.saveOnRdb.enabled

Define si la operación de identificación se guardará en la tabla gbds.transaction del RDB.

Valor Predeterminado:

true

{% hint style="danger" %} Este valor debe ser el mismo en el application.conf y en el gbdsapi.properties {% endhint %}

gbds.template.face.multiplicity

Define si el GBDS usará solo un formato de template de rostro, o el nuevo y el antiguo simultáneamente.

Valor Predeterminado:

ONLY_NEWEST

Valores Posibles:

• ONLY_NEWEST - GBDS usará únicamente el formato de template más nuevo.

• MULTIPLE - GBDS usará tanto el formato antiguo como el nuevo de template.

gbds.search.verify.adjust-resolution

Cuando esta configuración está activada, las verificaciones y actualizaciones en la API y la verificación post-match en el GBDS ajustarán la resolución realizando una verificación de coincidencia, disminuyendo la puntuación en dedos y palmas.

Valor Predeterminado:

true

Valores Posibles:

• true

• false

gbds.update.exception.reextract

Este parámetro determina la reextracción en actualizaciones que generarían excepciones. Solo las biometrias sin correspondencia son reextraídas del entrante y la referencia, pero si la configuración para guardar la reextracción (gbds.update.exception.reextract.save) es true, todas las biometrias de huella dactilar son reextraídas. Antes de la reextracción de la referencia, la API verificará si los templates de referencia ya fueron extraídos con el extractor elegido. Si es así, la reextracción no se realiza.

Valor Predeterminado:

NONE

Valores Posibles:

• NONE, no reextraer.

• REGULAR, usar el extractor actual en la referencia (extractor configurado actualmente).

• GRIAULE_2018, usar GRIAULE_2018 para reextraer entrante y referencia.

gbds.update.exception.reextract.save

Este parámetro permite guardar en HBase transaction y people las reextracciones de biometrias de consulta y referencia. Si true, guarda los modelos completos en la transaction y los master record templates en people, no envía los modelos al GBDS (no hay nuevo TGUID para procesar). En la transaction del RDB, la columna ginger_extractor_type es actualizada en la referencia y en la consulta y extraction_time es actualizada en la consulta (suma la referencia y el tiempo de extracción de la consulta).

Valor Predeterminado:

false

Valores Posibles:

• true

• false

Microservicio de Extracción de Templates

gbds.extraction.service

Este parámetro habilita el microservicio de extracción. Si este parámetro se define como false, el GBDS usará el servicio de extracción integrado.

Valor Predeterminado:

true

gbds.extraction.service.face.count

Este parámetro define cuántas instancias de microservicio de extracción de rostro estarán disponibles.

Valor Predeterminado:

1

gbds.extraction.service.ginger.count

Este parámetro define cuántas instancias de microservicio de extracción de huellas dactilares, palmas, palmas de recién nacido y control de secuencia estarán disponibles.

Valor Predeterminado:

5

gbds.extraction.service.girl.count

Este parámetro define cuántas instancias de microservicio de extracción de iris estarán disponibles.

Valor Predeterminado:

1

gbds.extraction.service.hostname

Este parámetro define el hostname del microservicio de extracción. Si se especifica como localhost, la API asumirá el control de la activación/desactivación de los servicios. Si se define otro nombre de host, la activación/desactivación deberá hacerse manualmente.

Valor Predeterminado:

localhost

gbds.extraction.service.initialPort

Este parámetro define el número del puerto inicial para los microservicios de extracción. Cada instancia del microservicio aumentará su puerto en 1. Esto significa que la primera instancia de microservicio habilitada tendrá un puerto con el número definido, la segunda el número+1, la tercera el número+2 y sucesivamente.

Valor Predeterminado:

30000

gbds.extraction.service.logLevel

Este parámetro define el nivel de log del microservicio de extracción. INFO registrará las salidas de los scripts en el log de la API. DEBUG registrará las salidas de los scripts y el log del extractor directamente en el log de la API.

Valor Predeterminado:

INFO

Valores Posibles:

• INFO

• DEBUG

gbds.extraction.service.timeout

Este parámetro define el timeout para el microservicio de extracción en segundos.

Valor Predeterminado:

60

gbds.extraction.service.maxTries

Este parámetro define el número máximo de intentos de extracción que el GBDS ejecutará en la misma transacción antes de devolver un error.

Valor Predeterminado:

3

gbds.extraction.service.linkLibSegfault

Este parámetro habilita el rastreo de fallos de segmentación en el servicio de extracción.

Valor Predeterminado:

false

gbds.extraction.service.checkTimeoutSecs

Timeout (en segundos) para verificar si el microservicio de extracción de templates fue creado.

Valor Predeterminado:

10

api.uniqueId

Este parámetro define el ID de la API y es OPCIONAL. Se usa para iniciar manualmente un microservicio de extracción e identificar qué microservicio está vinculado a qué API. El valor puede ser cualquier cadena sin espacios en blanco ni caracteres especiales.

Servicio de Extracción de Calidad

gbds.extraction.quality.service

Este parámetro habilita el servicio de extracción de calidad.

Valor Predeterminado:

true

gbds.extraction.quality.api.uniqueId

Este parámetro define el ID de la API y es OPCIONAL. Se usa para iniciar manualmente el servicio de extracción de calidad e identificar qué servicio está vinculado a qué API. El valor puede ser cualquier cadena sin espacios en blanco ni caracteres especiales.

{% hint style="warning" %} Si está utilizando múltiples APIs, preste atención a la configuración gbds.extraction.quality.api.uniqueId.list {% endhint %}

gbds.extraction.quality.api.uniqueId.list

Esta configuración define los IDs de las APIs que procesarán la extracción de calidad en segundo plano. Existen dos maneras de definir los ids:

• Separados por comas, con el líder primero, todos los otros ids se definen como runners.

• Json

[
    {
        "apiId":"<api_id>",
        "type":"LEADER|RUNNER"
    }
]

api_id es SIEMPRE obligatorio y no puede estar vacío, mientras que type es opcional.

{% hint style="warning" %} Solo se puede definir un LÍDER (leader). {% endhint %}

Esta configuración no altera ningún otro comportamiento del servicio de extracción de calidad.

gbds.extraction.quality.fillTransactionQualityPropertiesTable

Este parámetro define si las propiedades de calidad (Valor NFIQ, número de minucias, tamaño de imagen, etc.) extraídas por el servicio de extracción de calidad deben guardarse en la tabla gbds.transaction_quality_properties.

{% hint style="warning" %} Habilitar este parámetro puede aumentar drásticamente el requerimiento de espacio del RDB {% endhint %}

Valor Predeterminado:

false

gbds.extraction.quality.service.linkLibSegfault

Este parámetro habilita el rastreo de fallos de segmentación en el servicio de extracción de calidad.

Valor Predeterminado:

false

gbds.extraction.quality.service.rows-on-select

Este parámetro determina el tamaño del bloque de transacciones a enviar al thread pool para la extracción de calidad.

Valor Predeterminado:

20

gbds.extraction.quality.service.submitted-queue-factor

Este parámetro determina el factor a multiplicar por el tamaño del thread pool para determinar el tamaño medio de la cola de procesamiento.

Valor Predeterminado:

3

gbds.faces.extraction.quality.api

Este parámetro habilita el servicio de extracción de calidad de rostro en registros y actualizaciones mediante la llamada de API.

Valor Predeterminado:

true

gbds.enroll.face.min.quality

Define el umbral mínimo de calidad para que una imagen de rostro sea aceptada en una operación de enroll.

Valor Predeterminado:

50

gbds.update.face.min.quality

Define el umbral mínimo de calidad para que una imagen de rostro sea aceptada en una operación de update.

Valor Predeterminado:

50

gbds.faces.extraction.quality.background

Este parámetro habilita el servicio de extracción de calidad de rostro en segundo plano. Cuando está habilitado, el extractor mirará la tabla gbds.transaction donde las filas finger_quality_extracted tengan el valor false, y, a partir del tguid de la transacción, tomará el template del HBase con el mismo tguid y realizará la extracción de calidad en ese template.

{% hint style="info" %} Habilitar este parámetro NO habilita la extracción de calidad vía llamada de API {% endhint %}

Valor Predeterminado:

false

gbds.fingerprints.extraction.quality.api

Este parámetro habilita el servicio de extracción de calidad de huellas dactilares en registros y actualizaciones mediante la llamada de API.

Valor Predeterminado:

true

gbds.fingerprints.extraction.quality.background

Este parámetro habilita el servicio de extracción de calidad de huellas dactilares en segundo plano. Cuando está habilitado, el extractor mirará la tabla gbds.transaction donde las filas finger_quality_extracted tengan el valor false, y, a partir del tguid de la transacción, tomará el template del HBase con el mismo tguid y realizará la extracción de calidad en ese template.

{% hint style="info" %} Habilitar este parámetro NO habilita la extracción de calidad vía llamada de API {% endhint %}

Valor Predeterminado:

false

gbds.extraction.quality.service.finger.count

Este parámetro define cuántas instancias de servicios de extracción de calidad de huellas dactilares estarán disponibles.

Valor Predeterminado:

1

gbds.extraction.quality.service.face.count

Este parámetro define cuántas instancias de servicios de extracción de calidad de rostros estarán disponibles.

Valor Predeterminado:

1

gbds.extraction.quality.service.initialPort

Este parámetro define el número del puerto inicial para el servicio de extracción de calidad. Cada instancia del servicio aumentará su puerto en 1. Esto significa que la primera instancia del servicio habilitada tendrá un puerto con el número definido, la segunda el número+1, la tercera el número+2 y sucesivamente.

Valor Predeterminado:

31000

gbds.extraction.quality.service.logLevel

Este parámetro define el nivel de log del servicio de extracción de calidad. INFO registrará las salidas de los scripts en el log de la API. DEBUG registrará las salidas de los scripts y el log del extractor directamente en el log de la API.

Valor Predeterminado:

INFO

Valores Posibles:

• INFO

• DEBUG

gbds.extraction.quality.service.timeout

Este parámetro define el timeout para el servicio de extracción de calidad en segundos.

Valor Predeterminado:

60

gbds.extraction.quality.service.hostname

Este parámetro define el hostname del servicio de extracción de calidad. Si se especifica como localhost, la API asumirá el control de la activación/desactivación de los servicios. Si se define otro nombre de host, la activación/desactivación deberá hacerse manualmente.

Valor Predeterminado:

localhost

gbds.extraction.quality.service.maxTries

Este parámetro define el número máximo de intentos de extracción que el GBDS ejecutará en la misma transacción antes de devolver un error.

Valor Predeterminado:

3

gbds.extraction.quality.service.checkTimeoutSecs

Timeout (en segundos) para verificar si el microservicio de extracción de calidad fue creado.

Valor Predeterminado:

10

Base Biográfica Externa

gbds.biographicBase.enabled

Flag para encender/apagar el acceso al servidor Biobase. Cuando está apagado, biographicBaseStatus no se devuelve en las llamadas de get/list transaction/person.

Valor Predeterminado:

false

Valores Posibles:

• true

• false

gbds.biographicBase.endpoints

Lista separada por comas con todas las URLs del servidor Biobase, con host y puerto.

Valor Predeterminado:

Vacío

Valores Posibles:

http://biobase-server-ip:8130,http://biobase-server-ip:8131

gbds.biographicBase.get.timeout.ms

Timeout de solicitudes get del servidor Biobase. Se usa en llamadas de API get transaction o get person.

Valor Predeterminado:

500

gbds.biographicBase.list.timeout.ms

Timeout de solicitudes list del servidor Biobase. Se usa en llamadas de API list transaction o list people. En las llamadas list, el Biobase Server es llamado solo una vez para todas las transacciones/personas que serán devueltas.

Valor Predeterminado:

500

gbds.biographicBase.logLevel

Nivel de log en las llamadas al servidor Biobase.

Valor Predeterminado:

INFO

Valores Posibles:

• INFO: registra la URL de solicitud del servidor.

• NONE: ningún log de solicitud del servidor.

• TIME: registra la URL de solicitud del servidor y el tiempo transcurrido.

• DEBUG: registra la URL de solicitud del servidor, el tiempo transcurrido y los cuerpos de solicitud/respuesta.

gbds.biographicBase.clientID

ID del cliente de autenticación.

Valor Predeterminado:

Vacío

gbds.biographicBase.clientSecret

Contraseña del cliente de autenticación.

Valor Predeterminado:

Vacío

gbds.biographicBase.lookAllServers

Flag para buscar en todos los servidores en casos de no autorización o personas no encontradas.

• Para autorización:

  • Cuando está ACTIVADO y un Servidor Biobase devuelve no autorizado, la API buscará en todos los demás servidores intentando autenticarse.

  • Cuando está DESACTIVADO, la API buscará solo el Servidor Biobase actual para autenticación, devolviendo no autorizado o autorizado.

• Para personas no encontradas:

  • Cuando está ACTIVADO y la llamada al Servidor Biobase no devuelve todas las personas, la API intentará con todos los otros servidores hasta que todas las personas sean encontradas. Si la lista de personas consolidada de todos los servidores aún está incompleta, incluso después de pasar por todos los servidores, se dejará tal cual.

  • Cuando está DESACTIVADO, la API observará solo el servidor Biobase actual para todas las personas en la solicitud. Incluso si una persona aún no está en la lista de personas, la lista se deja tal cual.

Valor Predeterminado:

false

Valores Posibles:

• true

• false

gbds.biographicBase.autoUpdate

Envía datos biográficos a la BioBase al registrar/actualizar/trusted.

Valor Predeterminado:

true

Valores Posibles:

• true

• false

gbds.biographicBase.sendPguidAsKey

Envía PGUID como clave en cualquier actualización de la BioBase.

Valor Predeterminado:

true

Valores Posibles:

• true

• false

gbds.biographicBase.sendTguidAsKey

Envía TGUID como clave en cualquier actualización de la BioBase.

Valor Predeterminado:

false

Valores Posibles:

• true

• false

Configuración del Serializador de Templates

Esta sección describe los parámetros de configuración relacionados con el serializador de templates. Estos parámetros de configuración están diseñados para permitir el uso del GBDS Batch Extractor.

{% hint style="info" %} Consulte el manual de GBDS Batch Extractor para información adicional sobre su uso. {% endhint %}

Siempre que el GBDS realice una operación de cold boot, intentará recuperar los templates de una familia de columnas predeterminada. Si el template no existe en esa columna, el GBDS intentará recuperarlo de la familia de columnas de reserva.

Los parámetros de configuración del serializador son:

Familia de Columnas Predeterminada

Estos parámetros están divididos por modalidades biométricas. Los templates en esta familia de columnas no tienen codificación y el formato usado es byteArray.

gbds.hbase.templates.fingerprint.cf.name
gbds.hbase.templates.palmprint.cf.name
gbds.hbase.templates.face.cf.name
gbds.hbase.templates.iris.cf.name
gbds.hbase.templates.newborn-palmprint.cf.name

El valor predeterminado para estos parámetros es tpt.

Familia de Columnas de Reserva

Estos parámetros se refieren a las familias de columnas anteriormente usadas para almacenar los templates biométricos. Están separados por modalidad biométrica.

gbds.hbase.templates.fallback.fingerprint.cf.name
gbds.hbase.templates.fallback.palmprint.cf.name
gbds.hbase.templates.fallback.face.cf.name
gbds.hbase.templates.fallback.iris.cf.name
gbds.hbase.templates.fallback.newborn-palmprint.cf.name

Los valores predeterminados representan las familias de columnas usadas antes del cambio de estos parámetros y son, respectivamente: fingerprints, palmprints, faces, y iris.

Codificación de Reserva en base64

La familia de columnas de reserva admite codificación. Los siguientes parámetros definen si la familia de columnas está codificada en base64:

gbds.hbase.templates.fallback.fingerprint.cf.is-base64-encoded
gbds.hbase.templates.fallback.palmprint.cf.is-base64-encoded
gbds.hbase.templates.fallback.face.cf.is-base64-encoded
gbds.hbase.templates.fallback.iris.cf.is-base64-encoded
gbds.hbase.templates.fallback.newborn-palmprint.cf.is-base64-encoded

El valor predeterminado para estos parámetros es true.

Configuraciones de Notificación de Correo Electrónico

gbds.transparency.search.identify.send-email.enabled

Este parámetro habilita el servicio de notificación por correo. Cuando true, toda búsqueda de identificación de rostro enviará un correo con la imagen solicitada a usuarios o grupos determinados.

Valor Predeterminado:

false

Valores Posibles:

• true

• false

gbds.transparency.email-notifier.log-level

Este parámetro define el nivel de log del servicio de notificación por correo.

Valor Predeterminado:

INFO

Valores Posibles:

• INFO

• TIME

• NONE

• DEBUG.

gbds.transparency.email-notifier.timeout

Este parámetro define el timeout en segundos del servicio de notificación por correo.

Valor Predeterminado:

60

gbds.transparency.email-notifier.url

Este parámetro define la URL del servicio de notificación por correo.

gbds.transparency.search.identify.request.notify.enabled

Este parámetro permite que el servicio de notificación por correo envíe la notificación para solicitud de búsqueda de identificación facial.

Valor Predeterminado:

false

gbds.transparency.search.identify.result.actions.enabled

Este parámetro permite que el servicio de notificación por correo procese la acción definida para una persona mediante las tablas de transparencia cuando la persona aparezca en los resultados de la búsqueda.

Valor Predeterminado:

false

gbds.transparency.search.identify.result.notify.enabled

Este parámetro permite que el servicio de notificación por correo envíe mensajes cuando los resultados de la búsqueda coincidan con las personas de interés.

Valor Predeterminado:

false