1. Archivo de configuración

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

1.1. Ubicación del archivo

El archivo de configuración se encuentra en /etc/griaule/conf/gbsapi/gbdsapi.properties.

1.2. Propiedades del archivo

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

1. El nombre y la ubicación del archivo deben ser exactamente como se menciona en la sección 1.1;
2. Debe haber exactamente un parámetro de configuración por línea;
3. Cada parámetro de configuración debe estar en la forma {parámetro}={valor}, sin saltos de línea;
4. Cada valor debe estar separado por una coma cuando se atribuye a un solo parámetro.

2. Parámetros de configuración

Esta sección describe cada parámetro de configuración de la API de GBDS que se puede listar en el archivo de configuración y cómo afectan la operación del sistema.

2.1. Seguridad

See also

Consulte el Manual de seguridad de GBDS para obtener más información sobre la configuración de seguridad de GBDS.

2.1.1. gbscluster.api.security.enabled

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

Valor predeterminado:

true

Valores posibles:

true, false

2.1.2. gbscluster.api.security.keystore

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

Valor predeterminado:

Vacío

2.1.3. gbscluster.api.security.ldap.url

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

Valor predeterminado:

Vacío

2.1.4. gbscluster.api.security.ldap.userSearchBase

Este parámetro define el Nombre distinguido (DN) para el repositorio de usuarios en el servidor LDAP.

Valor predeterminado:

Vacío

2.1.5. gbscluster.api.security.ldap.userSearchAttribute

Este parámetro define el atributo de usuario que se utilizará como nombre de usuario durante la autenticación.

Valor predeterminado:

Vacío

2.1.6. gbscluster.api.security.ldap.userGroupMembershipAttribute

Este parámetro define el atributo de usuario que contiene su información de membresía de grupo.

Valor predeterminado:

Vacío

2.1.7. gbscluster.api.security.ldap.bindUserDN

Este parámetro define el Nombre distinguido del usuario de enlace.

Valor predeterminado:

Vacío

2.1.8. gbscluster.api.security.token.ttlInMilliseconds

Este parámetro define el tiempo de vida, en milissegundos, del token JWT.

Valor predeterminado:

Vacío

Valores posibles:

1800000 (30 min) a 10800000 (3 horas)

Valor recomendado:

3600000 (1 hora)

2.1.9. gbscluster.api.security.authorization.ranger.configurationDirectory

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

Valor predeterminado:

Vacío

2.1.10. gbscluster.api.security.authorization.rolePermissionMapFile

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

Valor predeterminado:

Vacío

2.2. gbds.cluster.kafka.task.topic

Este parámetro define el tema de Kafka donde se asignarán las tareas.

Valor predeterminado:

gbds-tasks

2.3. gbds.cluster.zookeeper.quorum

Este parámetro define el nombre de host y el puerto a través del cual se pueden encontrar los servidores de zookeeper. Cada valor debe estar separado por comas si hay más de uno disponible.

Valor predeterminado:

<nombre de host>:<puerto>

2.4. gbscluster.kafka.broker

Este parámetro define las direcciones de los brokers de Kafka y debe reflejar las configuraciones de Kafka.

Valor predeterminado:

<hostname>:6667

2.5. gbscluster.kafka.producer.acks

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

Valor predeterminado:

1

Valores posibles:

0, 1, all

2.6. gbscluster.kafka.producer.buffer.memory

Este parámetro define la memoria total que el productor puede usar para almacenar en búfer registros que esperan ser enviados al servidor, en bytes.

Valor predeterminado:

67108864

2.7. gbscluster.kafka.producer.batch.size

Este parámetro define el tamaño máximo de lote que el productor puede enviar en una sola solicitud cuando se envían varios registros al mismo partición.

Valor predeterminado:

8196

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

Este parámetro define el número de bytes de mensajes que se intentarán recuperar para cada tema-partición en cada solicitud de recuperación.

Valor predeterminado:

1248576

2.9. gbscluser.dispatcher.requests.topic

Este parámetro define el tema utilizado para escuchar nuevas solicitudes. No hay relación entre este parámetro y gbscluster.kafka.group.

Valor predeterminado:

requests

2.10. gbscluser.dispatcher.requests.nthreads

Este parámetro define el número de hilos que se utilizarán para los consumidores de solicitudes. De forma predeterminada, se configura en el número de particiones que tiene el tema de solicitudes.

Valor predeterminado:

1

2.11. gbscluser.dispatcher.requests.partitions

Este parámetro define el número de particiones utilizadas por Kafka para el almacenamiento del tema de solicitudes.

Valor predeterminado:

1

2.12. gbscluser.dispatcher.requests.replication

Este parámetro define el factor de replicación utilizado para los temas de Kafka.

Valor predeterminado:

3

2.13. gbscluster.hdfs.person.location

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

Valor predeterminado:

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

2.14. gbscluster.hdfs.host

Este parámetro define la dirección del host de HDFS y debe coincidir con la configuración de HDFS.

Valor predeterminado:

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

2.15. gbscluster.transport.http.url

Este parámetro define la URL de transporte HTTP.

Valor predeterminado:

http://<hostname>

2.16. gbscluster.transport.http.port

Este parámetro define el puerto de transporte HTTP.

Valor predeterminado:

6516

2.17. gbscluster.search.verify.primary.fingerprints

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

Valor predeterminado:

true

Valores posibles:

true, false

2.18. gbscluster.search.verify.primary.faces

Este parámetro define si las operaciones de búsqueda deben ejecutarse en plantillas de rostros.

Valor predeterminado:

true

Valores posibles:

true, false

2.19. gbscluster.search.verify.primary.iris

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

Valor predeterminado:

false

Valores posibles:

true, false

2.20. gbscluster.search.verify.primary.palmprints

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

Valor predeterminado:

false

Valores posibles:

true, false

2.21. gbscluster.search.verify.primary.newborn-palmprints

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

Valor predeterminado:

false

Valores posibles:

true, false

2.22. gbscluster.search.iris.verify.matchthreshold

Este parámetro define la puntuación mínima para que una comparación de iris se considere una coincidencia durante las operaciones de búsqueda.

Valor predeterminado:

26

2.23. gbscluster.search.fingerprints.ul.verify.matchthreshold

Este parámetro define la puntuación mínima para que una comparación de huellas dactilares UL se considere una coincidencia durante la operación de búsqueda.

Valor predeterminado:

35

2.24. gbscluster.search.palmprints.ul.verify.matchthreshold

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

Valor predeterminado:

35

2.25. gbscluster.activate.quality.duplicities

Este parámetro define si se deben considerar las transacciones de inscripción con duplicidades como ENROLL_FAILED (false) o ENROLL_PENDING (true).

Valor predeterminado:

false

Valores posibles:

true, false

2.26. gbscluster.enroll.fingerprints.verify.matchthreshold

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

Valor predeterminado:

25

2.27. gbscluster.enroll.fingerprints.verify.anglethreshold

Este parámetro define el ángulo que se debe considerar al comparar dos huellas dactilares durante una operación de búsqueda.

Valor predeterminado:

180

Rango:

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

2.28. gbscluster.update.faces.verify.matchthreshold

Este parámetro define el umbral que se utilizará al comparar la biometría facial durante las operaciones de búsqueda. Asignar un valor alto a este parámetro puede aumentar posiblemente el número de falsos negativos.

Valor predeterminado:

60

2.29. gbscluster.enroll.newborn-palmprints.verify.matchthreshold

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

Valor predeterminado:

35

2.30. gbscluster.enroll.fingerprints.ul.anglethreshold

Este parámetro define el ángulo que se debe considerar al comparar dos latentes de huellas dactilares no resueltas.

Valor predeterminado:

180

Rango:

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

2.31. gbscluster.update.consider.fingerprints

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

Valor predeterminado:

true

Valores posibles:

true, false

2.32. gbscluster.update.consider.faces

Este parámetro define si se deben considerar las imágenes faciales al generar excepciones de actualización.

Valor predeterminado:

false

Valores posibles:

true, false

2.33. 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 es false, el análisis del rostro se realiza después del análisis de las huellas dactilares.

Valor predeterminado:

false

Possible values:

true, false

2.34. gbscluster.update.minimum.fingers

Este parámetro define el número mínimo de coincidencias de huellas dactilares requeridas para que una operación de “actualización” sea aceptada.

Valor predeterminado:

4

2.35. gbscluster.min.quality

Este parámetro define la calidad mínima requerida de una huella dactilar extraída para no generar una transacción “ENROLL_PENDING”. Valor predeterminado:

50

2.36. gbscluster.update.min.quality

Este parámetro define la calidad mínima requerida de una huella dactilar extraída para no generar una transacción “UPDATE_PENDING”.

Valor predeterminado:

50

2.37. gbds.enroll.fingerprints.min-nr-template

Este parámetro define el número mínimo de plantillas de huellas dactilares requeridas para procesar una transacción. Si la transacción no contiene el número requerido de plantillas, fallará.

Valor predeterminado:

0

2.38. gbds.enroll.faces.min-nr-template

Este parámetro define el número mínimo de plantillas de rostros requeridas para procesar una transacción. Si la transacción no contiene el número requerido de plantillas, fallará.

Valor predeterminado:

0

2.39. gbds.enroll.iris.min-nr-template

Este parámetro define el número mínimo de plantillas de iris requeridas para procesar una transacción. Si la transacción no contiene el número requerido de plantillas, fallará.

Valor predeterminado:

0

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

Este parámetro define el número mínimo de plantillas de palma requeridas para procesar una transacción. Si la transacción no contiene el número requerido de plantillas, fallará.

Valor predeterminado:

0

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

Este parámetro define el número mínimo de plantillas de palma de recién nacidos requeridas para procesar una transacción. Si la transacción no contiene el número requerido de plantillas, fallará.

Valor predeterminado:

0

2.42. 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

2.43. gbscluster.update.fingerprints.verify.anglethreshold

Este parámetro define el ángulo a considerar al comparar dos huellas dactilares durante una operación de “verificación”.

Valor predeterminado:

180

Rango:

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

2.44. gbscluster.enroll.fingerprints.verify.duplicities.matchthreshold

Al realizar la verificación de calidad durante una operación de inscripción, se ejecuta una comparación cruzada de huellas dactilares para verificar los dedos duplicados dentro de la transacción.

Este parámetro define la puntuación por encima de la cual se considera que una verificación de huella dactilar es una coincidencia al realizar la validación cruzada.

Valor predeterminado:

45

2.45. gbscluster.enroll.fingerprints.verify.sequencecheck.matchthreshold

Este parámetro define la puntuación mínima para que una huella dactilar de captura principal se considere una coincidencia con su índice respectivo en el control de secuencia.

Si la comparación entre una huella dactilar enrollada y su respectivo dedo en las capturas de control de secuencia (por ejemplo, 4-4-2 o 2-2-1) devuelve una puntuación de coincidencia por encima de este umbral, se considerará una coincidencia para la verificación de secuencia.

Valor predeterminado:

20

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

Este parámetro define la puntuación mínima para que una huella dactilar de captura principal dada se considere una coincidencia con su índice respectivo en el control de secuencia.

Si la comparación entre la huella dactilar enrollada dada y su respectivo dedo en las capturas de control de secuencia (por ejemplo, 4-4-2 o 2-2-1) devuelve una puntuación de coincidencia por encima de este umbral, se considerará una coincidencia para la verificación de secuencia.

Note

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

Note

Esta configuración debe repetirse en el archivo de configuración para cada índice de dedo deseado.

El <index> debe cambiarse según 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

Warning

El índice debe estar en formato STRING de acuerdo con la lista anterior. Cualquier otro valor se considerará inválido y se descartará.

2.47. gbscluster.enroll.fingerprints.identify.sequencecorrection.matchthreshold

Este parámetro define la puntuación mínima para que una huella principal capturada sea considerada una coincidencia al compararla con todas las huellas en el control de secuencia.

Esta comparación se realiza después de identificar un problema de control de secuencia para verificar si las huellas principales capturadas están intercambiadas. Si la huella principal capturada no coincide con su respectiva captura de control de secuencia, el sistema resolverá automáticamente el problema recortando la imagen de control de secuencia y sobrescribiendo 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 necesarias es mayor que el valor definido, no se realizarán cambios en el perfil y el estado de la transacción se definirá como “PENDIENTE”.

Valor predeterminado:

20

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

Este parámetro define la puntuación mínima para que una huella principal capturada sea considerada una coincidencia al compararla con todas las huellas en el control de secuencia.

Esta comparación se realiza después de identificar un problema de control de secuencia para verificar si las huellas principales capturadas están intercambiadas. Si la huella principal capturada no coincide con su respectiva captura de control de secuencia, el sistema resolverá automáticamente el problema recortando la imagen de control de secuencia y sobrescribiendo 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 necesarias es mayor que el valor definido, no se realizarán cambios en el perfil y el estado de la transacción se definirá como “PENDIENTE”.

Note

Esta configuración es opcional y, si no se proporciona, GBDS utilizará el valor de umbral global definido en gbscluster.enroll.fingerprints.identify.sequencecorrection.matchthreshold.

Note

Esta configuración debe repetirse en el archivo de configuración para cada índice de dedo deseado.

El <index> debe cambiarse 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

Warning

El índice debe estar en formato STRING de acuerdo con la lista anterior. Cualquier otro valor se considerará inválido y se descartará.

2.49. 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 “PENDIENTE” y enviarla a “revisión manual”. Si el número de correcciones requeridas es mayor que este parámetro, no se realiza ninguna corrección y se envía la transacción original a “revisión manual”.

Valor predeterminado:

4

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

Este parámetro define si las imágenes de control de secuencia deben recortarse para la inscripción cuando no hay imágenes de huellas individuales disponibles.

Valor predeterminado:

false

Valores posibles:

true, false

2.51. gbscluster.fingerprints.extraction.cab.enabled (obsoleta)

Important

Esta configuración está obsoleta a partir de la versión 4.7.0. Vea las configuraciones que la anulan: gbscluster.fingerprints.extraction.enroll.type y gbscluster.fingerprints.extraction.verify.type.

Este parámetro define si se deben extraer CAB de nuevas biometrías.

Valor predeterminado:

false

Valores posibles:

true, false

2.52. gbscluster.fingerprints.extraction.fnet.enabled (obsoleta)

Important

Esta configuración está obsoleta a partir de la versión 4.7.0. Vea las configuraciones que la anulan: gbscluster.fingerprints.extraction.enroll.type y gbscluster.fingerprints.extraction.verify.type.

Valor predeterminado:

false

Valores posibles:

true, false

2.53. gbscluster.fingerprints.extraction.enroll.type

Este parámetro define el tipo de preset de extracción que se utilizará para inscripción y actualización.

Valor predeterminado:

GRIAULE_2024

Valores posibles:

• GRIAULE_FAST: versión más simple y rápida de GRIAULE_BASIC (nunca utilizada en la API).
• GRIAULE_BASIC: antiguo “…cab.enabled = false”, extracción predeterminada para verificación.
• GRIAULE_2020: antiguo “…cab.enabled = true”, antigua extracción predeterminada para inscripción y actualización.
• GRIAULE_2024: nueva extracción predeterminada para inscripción y actualización.
• GRIAULE_2018: antiguo “…fnet.enabled = true”.

2.54. gbscluster.fingerprints.extraction.verify.type

Este parámetro define el tipo de preset de extracción que se utilizará para verificación.

Valor predeterminado:

GRIAULE_BASIC

Valores posibles:

• GRIAULE_FAST: versión más simple y rápida de GRIAULE_BASIC (nunca utilizada en la API).
• GRIAULE_BASIC: antiguo “…cab.enabled = false”, extracción predeterminada para verificación.
• GRIAULE_2020: antiguo “…cab.enabled = true”, antigua extracción predeterminada para inscripción y actualización.
• GRIAULE_2024: nueva extracción predeterminada para inscripción y actualización.
• GRIAULE_2018: antiguo “…fnet.enabled = true”.

2.55. gbds.rdb.driverClassName

Este parámetro define el nombre de la clase para la base de datos relacional que se utilizará para almacenar latentes no resueltos.

Valor predeterminado:

com.mysql.jdbc.Driver

2.56. gbds.rdb.url

Este parámetro define la URL de la base de datos relacional a la que se accederá.

Valor predeterminado:

jdbc:mysql://<dirección>:<puerto>/gbds

2.57. gbds.rdb.username

Este parámetro define el nombre de usuario que se utilizará para acceder a la base de datos relacional.

Valor predeterminado:

root

2.58. gbds.rdb.password

Este parámetro define la contraseña que se utilizará para acceder a la base de datos relacional.

Valor predeterminado:

Vacío

2.59. gbds.rdb.dialect

Este parámetro define el dialecto que se utilizará en la base de datos relacional.

Valor predeterminado:

org.hibernate.dialect.MySQLDialect

2.60. 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

2.61. gbds.biometric.best-of-biometrics.enabled

Este parámetro habilita el mejor de las biometrías, cuando está habilitado, la biometría de la persona es la consolidación de las mejores biometrías obtenidas de esa persona en todas las transacciones.

Warning

Esta bandera DEBE tener el mismo valor en GBDS API y GBDS.

Valor predeterminado:

false

2.62. gbds.biometric.face.template.format

Define el formato de plantilla para la cara.

Valores posibles: TPT_FORMAT_1 o TPT_FORMAT_2.

Important

Los formatos de cara no son intercambiables. Las caras inscritas en un formato no se emparejarán con las caras inscritas en otro formato.

Danger

Este valor debe ser el mismo en application.conf y gbdsapi.properties

2.63. gbds.peopleList.countFromRDB

Este parámetro define el comportamiento de la paginación en la llamada API people/list. Si se establece como verdadero, la lista de personas siempre contará el número total de personas utilizando el filtro de restricción pasado. En bases de datos grandes, puede comprometer el rendimiento. Si se establece como falso, la respuesta se restringirá a los valores de conteo, tamaño de página y página actual.

Valor predeterminado:

true

2.64. gbds.person.canDeleteOnException

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

Valor predeterminado:

false

2.65. gbds.searches.verify.saveOnRdb.enabled

Define si las búsquedas de verificación se guardarán en la tabla RDB gbds.transaction.

Valor predeterminado:

true

Danger

Este valor debe ser el mismo en application.conf y gbdsapi.properties

2.66. gbds.searches.identify.saveOnRdb.enabled

Define si las búsquedas de identificación se guardarán en la tabla RDB gbds.transaction.

Valor predeterminado:

true

Danger

Este valor debe ser el mismo en application.conf y gbdsapi.properties

2.67. gbds.template.face.multiplicity

Este parámetro define si GBDS utilizará un solo formato de plantilla de cara o nuevos y antiguos simultáneamente.

Valor predeterminado:

ONLY_NEWEST

Valores posibles:

• ONLY_NEWEST - GBDS solo utiliza el formato de plantilla más nuevo.
• MULTIPLE - GBDS utiliza tanto los nuevos como los antiguos formatos de plantilla.

2.68. gbds.search.verify.adjust-resolution

Cuando esta configuración está activada, la verificación y actualización en la API y la verificación posterior al emparejamiento en 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

2.69. gbds.update.exception.reextract

Este parámetro determina la reextracción de actualizaciones que generarían excepciones. Sólo los datos biométricos no coincidentes se vuelven a extraer de la entrada y la referencia, pero si la configuración para guardar la nueva extracción (gbds.update.exception.reextract.save) es true, se vuelven a extraer todos los datos biométricos de huellas dactilares. Antes de volver a extraer la referencia, la API comprobará si las plantillas de referencia ya se han extraído con el extractor elegido. Si es así, no se realiza la reextracción.

Valor predeterminado:

NONE

Valores posibles:

• NONE, no reextraer.
• REGULAR, usa el extractor actual en la referencia (extractor actualmente configurado).
• GRIAULE_2018, utilice GRIAULE_2018 para reextraer entradas y referencias.

2.70. gbds.update.exception.reextract.save

Este parámetro permite guardar consultas y reextracciones biométricas de referencia en transacciones y personas de HBase. Si es verdadero, guarda los modelos completos en la transacción y las plantillas de registro maestro en las personas, no envía los modelos a GBDS (no hay ningún TGUID nuevo para procesar). En la transacción RDB, la columna ginger_extractor_type se actualiza en la referencia y en la consulta y extraction_time se actualiza en la consulta (suma la referencia y el tiempo de extracción de la consulta).

Valor predeterminado:

false

Valores posibles:

true, false

3. Microservicio de extracción de plantillas

3.1. gbds.extraction.service

Este parámetro habilita el microservicio de extracción de plantillas. Si este parámetro se establece en false, GBDS utilizará el servicio de extracción integrado.

Valor predeterminado:

true

3.2. gbds.extraction.service.face.count

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

Valor predeterminado:

1

3.3. gbds.extraction.service.ginger.count

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

Valor predeterminado:

5

3.4. gbds.extraction.service.girl.count

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

Valor predeterminado:

1

3.5. gbds.extraction.service.hostname

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

Valor predeterminado:

localhost

3.6. gbds.extraction.service.initialPort

Este parámetro define el número de puerto inicial para los microservicios de extracción de plantillas. Cada instancia de microservicio aumentará su número de puerto en 1. Por ejemplo, considerando el puerto predeterminado 30000, la primera instancia usará el puerto 30000, la segunda usará el puerto 30001, la tercera, 30002, y así sucesivamente.

Warning

Asegúrese de permitir los puertos del firewall que utilizará el microservicio.

Valor predeterminado:

30000

3.7. gbds.extraction.service.logLevel

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

Valor predeterminado:

INFO

Valores posibles:

INFO, DEBUG

3.8. gbds.extraction.service.timeout

Este parámetro define el tiempo de espera para el microservicio de extracción de plantillas en segundos.

Valor predeterminado:

60

3.9. gbds.extraction.service.maxTries

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

Valor predeterminado:

3

3.10. gbds.extraction.service.linkLibSegfault

Este parámetro activa el seguimiento de fallas de segmentación en el microservicio de extracción.

Valor predeterminado:

false

3.11. gbds.extraction.service.checkTimeoutSecs

Tiempo de espera (en segundos) para verificar si se creó el microservicio de extracción de plantillas.

Valor predeterminado:

10

3.12. api.uniqueId

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

4. Servicio de extracción de calidad

4.1. gbds.extraction.quality.service

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

Valor predeterminado:

true

4.2. gbds.extraction.quality.api.uniqueId

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

Important

Si está utilizando MÚLTIPLES APIs, preste atención a la configuración gbds.extraction.quality.api.uniqueId.list.

4.2.1. gbds.extraction.quality.api.uniqueId.list

Esta configuración define las IDs de API que procesarán la extracción de calidad en segundo plano. Hay dos formas de definir las IDs:

• Separadas por comas, con el líder primero, todas las demás IDs se definen como corredores.
• Json

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

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

Important

Solo se puede definir un LÍDER.

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

4.3. 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 almacenarse en la tabla “gbds.transaction_quality_properties”.

Caution

Establecer esto en verdadero puede aumentar enormemente el requisito de espacio de la base de datos relacional.

Valor predeterminado:

false

4.4. gbds.extraction.quality.service.linkLibSegfault

Este parámetro activa el seguimiento de fallos de segmentación en el microservicio de extracción de calidad.

Valor predeterminado:

false

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

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

Valor predeterminado:

20

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

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

Valor predeterminado:

3

4.7. gbds.faces.extraction.quality.api

Este parámetro habilita el servicio de extracción de calidad de rostros en inscripciones y actualizaciones a través de la llamada API.

Valor predeterminado:

true

4.8. 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 inscripción.

Valor predeterminado:

50

4.9. 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 actualización.

Valor predeterminado:

50

4.10. gbds.faces.extraction.quality.background

Este parámetro habilita el servicio de extracción de calidad de rostros en segundo plano. Cuando está habilitado, el extractor buscará en la tabla “gbds.transaction” las filas con el valor “finger_quality_extracted” en falso y obtendrá el tguid de la transacción. Luego, obtendrá la plantilla HBase con el tguid y realizará la extracción de calidad en las plantillas.

Note

Habilitar este parámetro NO habilita la extracción de calidad a través de la llamada API.

Valor predeterminado:

false

4.11. gbds.fingerprints.extraction.quality.api

Este parámetro habilita el servicio de extracción de calidad de huellas dactilares en inscripciones y actualizaciones a través de la llamada API.

Valor predeterminado:

true

4.12. 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 buscará en la tabla “gbds.transaction” las filas con el valor “finger_quality_extracted” en falso y obtendrá el tguid de la transacción. Luego, obtendrá la plantilla HBase con el tguid y realizará la extracción de calidad en las plantillas.

Note

Habilitar este parámetro NO habilita la extracción de calidad a través de la llamada API.

Valor predeterminado:

false

4.13. 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

4.14. 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

4.15. gbds.extraction.quality.service.initialPort

Este parámetro define el número de puerto inicial para el servicio de extracción de calidad. Cada instancia del servicio de extracción aumentará su puerto en 1. Por ejemplo, considerando el puerto predeterminado 31000, la primera instancia usará el puerto 31000, la segunda usará el puerto 31001, la tercera, 31002, y así sucesivamente.

Warning

Asegúrese de permitir los puertos del firewall que utilizará el microservicio.

Valor predeterminado:

31000

4.16. gbds.extraction.quality.service.logLevel

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

Valor predeterminado:

INFO

Valores posibles:

INFO, DEBUG

4.17. gbds.extraction.quality.service.timeout

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

Valor predeterminado:

60

4.18. gbds.extraction.quality.service.hostname

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

Valor predeterminado:

localhost

4.19. gbds.extraction.quality.service.maxTries

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

Valor predeterminado:

3

4.20. gbds.extraction.quality.service.checkTimeoutSecs

Tiempo de espera (en segundos) para comprobar si se creó el microservicio de extracción de calidad.

Valor predeterminado:

10

5. Base Biográfica Externa

5.1. gbds.biographicBase.enabled

Flag para activar o desactivar el acceso al servidor Biobase. Cuando está desactivado, biographicBaseStatus no se devuelve

Valor predeterminado:

false

Valores posibles:

true, false

5.2. gbds.biographicBase.endpoints

Lista separada por comas con todas las URL del servidor Biobase, con host y puerta.

Valor predeterminado:

Vacío

Valores posibles:

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

5.3. gbds.biographicBase.get.timeout.ms

Tiempo de espera de “get request” del servidor Biobase. Se utiliza en llamadas API para “get transaction” o “get person”.

Valor predeterminado:

500

5.4. gbds.biographicBase.list.timeout.ms

Tiempo de espera de las solicitudes de “list” del servidor de Biobase. Se utiliza en llamadas API de “list transaction” o “list people”. En las llamadas de “list”, se llama al servidor Biobase solo una vez para todas las transacciones/personas que se devolverán.

Valor predeterminado:

500

5.5. gbds.biographicBase.logLevel

Nivel de registro en llamadas al servidor Biobase.

Valor predeterminado:

INFO

Valores posibles:

• INFO: registra la URL de solicitud del servidor.
• NONE: no hay registros de solicitudes 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.

5.6. gbds.biographicBase.clientID

ID de cliente de autenticación.

Valor predeterminado:

Vacío

5.7. gbds.biographicBase.clientSecret

Secreto del cliente de autenticación.

Valor predeterminado:

Vacío

5.8. gbds.biographicBase.lookAllServers

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

• Para autorización:

  • Cuando TRUE, y un servidor Biobase regresa sin autorización, la API buscará todos los demás servidores intentando autenticarse.
  • Cuando FALSE, la API solo buscará el servidor Biobase actual para autenticación y regresará no autorizado o autorizado.

• Para personas no encontradas:

  • Cuando TRUE y la llamada al servidor Biobase no devuelven a todas las personas, la API probará todos los demás servidores hasta encontrar a todas las personas. Si la lista consolidada de personas de todos los servidores aún está incompleta incluso después de revisar todos los servidores, se dejará como está.
  • Cuando FALSE, la API solo buscará en 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 como está.

Valor predeterminado:

false

Valores posibles:

true, false

5.9. gbds.biographicBase.autoUpdate

Envía datos biográficos a BioBase al inscribirse/actualizar.

Valor predeterminado:

true

Valores posibles:

true, false

5.10. gbds.biographicBase.sendPguidAsKey

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

Valor predeterminado:

true

Valores posibles:

true, false

5.11. gbds.biographicBase.sendTguidAsKey

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

Valor predeterminado:

false

Valores posibles:

true, false

6. Configuración del serializador de plantillas

Esta sección describe los parámetros de configuración relacionados con el serializador de plantillas. Estos parámetros de configuración están diseñados para permitir el uso de las Operaciones por lotes de GBDS.

See also

Consulte el manual de Operaciones por lotes de GBDS para obtener más información sobre cómo utilizarlo.

Cada vez que GBDS realiza una operación de arranque en frío, intenta recuperar las plantillas de la familia de columnas estándar. Si una plantilla no existe en la familia de columnas estándar, intenta recuperarla de la familia de columnas de respaldo.

Los parámetros de configuración para el serializador son los siguientes:

6.1. Familia de columnas estándar

Estos parámetros están divididos por modalidad biométrica. Las plantillas en estas familias de columnas no tienen codificación y el formato utilizado 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”.

6.2. Familia de columnas de respaldo

Estos parámetros se refieren a la familia de columnas utilizada anteriormente para almacenar las plantillas biométricas, separadas 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 la familia de columnas utilizada antes de cambiar estos parámetros y son, respectivamente: “fingerprints”, “palmprints”, “faces”, “iris”, “newborn-palmprints”.

6.3. Codificación base64 de respaldo

La familia de columnas de respaldo admite la codificación. Los siguientes parámetros definen si la familia de columnas de respaldo 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”.

7. Configuraciones del notificador de correo electrónico

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

Este parámetro habilita la función de notificación por correo electrónico. Cuando es verdadero, cada búsqueda de identificación de rostro envía un correo electrónico con la solicitud de imagen a los usuarios o grupos configurados.

Valor predeterminado:

false

Valores posibles:

true, false

7.2. gbds.transparency.email-notifier.log-level

Este parámetro define el nivel de registro del servicio de notificación de correo electrónico.

Valor predeterminado:

INFO

Valores posibles:

INFO, TIME, NONE, DEBUG.

7.3. gbds.transparency.email-notifier.timeout

Este parámetro define el tiempo de espera del servicio de notificación de correo electrónico, en segundos. Valor predeterminado:

60

7.4. gbds.transparency.email-notifier.url

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

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

Este parámetro habilita el servicio de notificación de correo electrónico para enviar notificaciones por correo electrónico para solicitudes de búsqueda de identificación facial.

Valor predeterminado:

false

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

Este parámetro habilita el servicio de notificación de correo electrónico para procesar la acción definida para una persona a través de las tablas de transparencia cuando la persona aparece en los resultados de búsqueda.

Valor predeterminado:

false

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

Este parámetro habilita el servicio de notificación de correo electrónico para enviar mensajes cuando los resultados de búsqueda coinciden con personas de interés.

Valor predeterminado:

false