API do GBDS

Arquivo de Configuração

Os parâmetros de configuração da API do GBDS são definidos em um arquivo de configuração contendo todos os parâmetros e seus respectivos valores. Parâmetros omitidos assumem seu valor padrão. Essa seção descreve as propriedades do arquivo de configuração.

Localização do Arquivo

O arquivo de configuração está localizado em: /etc/griaule/conf/gbsapi/gbdsapi.properties.

Propriedades do Arquivo

O arquivo de configuração deve seguir alguns requerimentos para que possa ser interpretado corretamente pelo GBDS. Esses requerimentos são:

1. O nome do arquivo e sua localização devem ser exatamente iguais ao descrito na seção Localização do Arquivo

2. Deve haver somente um parâmetro de configuração por linha.

3. Cada parâmetro de configuração deve ter forma {parâmetro}={valor}, sem quebras de linha;

4. Cada valor deve ser separado por uma vírgula quando atribuído a um mesmo parâmetro.

Parâmetros de Configuração

Essa seção descreve cada um dos parâmetros de configuração da API do GBDS que podem estar listados no arquivo de configurações e como eles afetam a operação do sistema.

Segurança

Veja o Manual de Segurança do GBDS para mais informações sobre as configurações de segurança do GBDS.

gbscluster.api.security.enabled

Esse parâmetro define se os métodos de segurança para autenticação e autorização estão habilitados.

Valor Padrão:

true

Valores possíveis:

• true

• false

gbscluster.api.security.keystore

Esse parâmetro define o caminho para a keystore contendo a senha do usuário de vinculação LDAP e a chave de assinatura do token JTW.

Valor Padrão:

Vazio

gbscluster.api.security.ldap.url

Esse parâmetro define a URL de conexão para o servidor LDAP.

Valor Padrão:

Vazio

gbscluster.api.security.ldap.userSearchBase

Esse parâmetro define o Distinguished Name (DN) para o repositório do usuário no servidor LDAP.

Valor Padrão:

Vazio

gbscluster.api.security.ldap.userSearchAttribute

Esse parâmetro define o atributo do usuário que será usado como nome de usuário durante a autenticação.

Valor Padrão:

Vazio

gbscluster.api.security.ldap.userGroupMembershipAttribute

Esse parâmetro define o atributo do usuário que contém sua informação de associação de grupo.

Valor Padrão:

Vazio

gbscluster.api.security.ldap.bindUserDN

Esse parâmetro define o Distinguished Name do usuário vinculado.

Valor Padrão:

Vazio

gbscluster.api.security.token.ttlInMilliseconds

Esse parâmetro define o tempo de vida, em milissegundos, do Token JWT.

Valor Padrão:

Vazio

Valores possíveis:

1800000 (30 min) to 10800000 (3 horas)

Valor recomendado:

3600000 (1 hora)

gbscluster.api.security.authorization.ranger.configurationDirectory

Esse parâmetro é opcional e define o diretório com a informação de configuração específica do GBDS para o Apache Ranger.

Valor Padrão:

Vazio

gbscluster.api.security.authorization.rolePermissionMapFile

Esse parâmetro é opcional e define o arquivo com funções/permissões mapeados para as aplicações do GBDS.

Valor Padrão:

Vazio

gbds.cluster.kafka.task.topic

Esse parâmetro define o tópico do Kafka onde as tarefas serão alocadas.

Valor Padrão:

gbds-tasks

gbds.cluster.zookeeper.quorum

Esse parâmetro define o hostname e a porta na qual o servidor zookeeper pode ser encontrado. Cada valor deve ser separado por vírgulas se mais de um valor estiver disponível.

Valor Padrão:

<hostname>:<port>

gbscluster.kafka.broker

Esse parâmetro define o endereço do Kafka Broker e deve ser refletido nas configurações do Kafka.

Valor Padrão:

<hostname>:6667

gbscluster.kafka.producer.acks

Esse parâmetro define o número de acknowledgments que o produtor requer que o líder tenha recebido antes de considerar o pedido completo. Esse parâmetro controla a durabilidade dos registros que são enviados.

Valor Padrão:

1

Valores possíveis:

• 0

• 1

• all

Veja a Documentação do Kafka para mais informações.

gbscluster.kafka.producer.buffer.memory

Esse parâmetro define a memória total que o produtor pode usar para o buffer de registros aguardando para serem enviados ao servidor, em bytes.

Valor Padrão:

67108864

gbscluster.kafka.producer.batch.size

Esse parâmetro define o tamanho máximo do lote (batch) que o produtor pode enviar em uma única requisição quando múltiplos registros estão sendo enviados para a mesma partição.

Valor Padrão:

8196

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

Esse parâmetro define o número de bytes de mensagem para a tentativa de consulta a cada partição/tópico em cada requisição de consulta.

Valor Padrão:

1248576

gbscluser.dispatcher.requests.topic

Esse parâmetro define o tópico usado para escutar novas requisições. Não há relação nenhuma entre esse parâmetro e gbscluster.kafka.group.

Valor Padrão:

requests

gbscluser.dispatcher.requests.nthreads

Esse parâmetro define o número de threads a serem usadas para os consumidores de requisições. Por padrão, é definido para o número de partições que o tópico de requisições possui.

Valor Padrão:

1

gbscluser.dispatcher.requests.partitions

Esse parâmetro define o número de partições usadas pelo Kafka para armazenamento de tópicos de requisição.

Valor Padrão:

1

gbscluser.dispatcher.requests.replication

Esse parâmetro define o fator de replicação usado pelos tópicos do Kafka.

Valor Padrão:

3

gbscluster.hdfs.person.location

Esse parâmetro define a localização onde os arquivos XML ANSI/NIST serão salvos.

Valor Padrão:

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

gbscluster.hdfs.host

Esse parâmetro define o endereço de host do HDFS e deve refletir as configurações do HDFS.

Valor Padrão:

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

gbscluster.transport.http.url

Esse parâmetro define a URL de transporte HTTP.

Valor Padrão:

http://<hostname>

gbscluster.transport.http.port

Esse parâmetro define a porta de transporte HTTP.

Valor Padrão:

6516

gbscluster.search.verify.primary.fingerprints

Esse parâmetro define se as operações de busca devem ser executadas sobre templates de digitais.

Valor Padrão:

true

Valores possíveis:

• true

• false

gbscluster.search.verify.primary.faces

Esse parâmetro define se as operações de busca devem ser executadas sobre templates de face.

Valor Padrão:

true

Valores possíveis:

• true

• false

gbscluster.search.verify.primary.iris

Esse parâmetro define se as operações de busca devem ser executadas sobre templates de íris.

Valor Padrão:

false

Valores possíveis:

• true

• false

gbscluster.search.verify.primary.palmprints

Esse parâmetro define se as operações de busca devem ser executadas sobre templates de palmares.

Valor Padrão:

false

Valores possíveis:

• true

• false

gbscluster.search.verify.primary.newborn-palmprints

Esse parâmetro define se as operações de busca devem ser executadas sobre templates de palmar de recém-nascidos.

Valor Padrão:

false

Valores possíveis:

• true

• false

gbscluster.search.iris.verify.matchthreshold

Esse parâmetro define a pontuação mínima para uma comparação de íris ser considerada um casamento durante uma operação de busca.

Valor Padrão:

26

gbscluster.search.fingerprints.ul.verify.matchthreshold

Este parâmetro define a pontuação mínima para que uma comparação de impressão digital de UL seja considerada um casamento durante a operação de pesquisa.

Valor Padrão:

35

gbscluster.search.palmprints.ul.verify.matchthreshold

Este parâmetro define a pontuação mínima para que uma comparação de palmar de UL seja considerada um casamento durante a operação de pesquisa.

Valor Padrão:

35

gbscluster.activate.quality.duplicities

Esse parâmetro define quando considerar uma transação de cadastro com duplicidades como ENROLL_FAILED (false) ou ENROLL_PENDING (true).

Valor Padrão:

false

Valores possíveis:

• true

• false

gbscluster.enroll.fingerprints.verify.matchthreshold

Esse parâmetro define a pontuação mínima para considerar uma comparação 1:1 entre digitais um casamento durante uma operação de busca.

Valor Padrão:

25

gbscluster.enroll.fingerprints.verify.anglethreshold

Esse parâmetro define o ângulo a ser considerado quando comparando dois dedos durante uma operação de busca.

Valor Padrão:

180

Range:

0 to 180 (-1 terá o mesmo efeito que 180)

gbscluster.update.faces.verify.matchthreshold

Esse parâmetro define o limiar a ser usado durante a comparação de biometrias faciais em operações de busca. Definir um valor alto para esse parâmetro pode, possivelmente, resultar em um aumento de ocorrências de falsos negativos.

Valor Padrão:

60

gbscluster.enroll.newborn-palmprints.verify.matchthreshold

Esse parâmetro define a pontuação mínima para considerar uma comparação 1:1 de palmares de recém-nascidos um casamento durante uma operação de busca.

Valor Padrão:

35

gbscluster.enroll.fingerprints.ul.anglethreshold

Esse parâmetro define o ângulo a ser considerado quando comparando duas impressões digitais latentes não resolvidas.

Valor Padrão:

180

Range

0 to 180 (-1 causará o mesmo efeito que 180)

gbscluster.update.consider.fingerprints

Esse parâmetro define se digitais devem ser consideradas ao gerar exceções de atualização.

Valor Padrão:

true

Valores possíveis:

• true

• false

gbscluster.update.consider.faces

Esse parâmetro define se imagens de face devem ser consideradas ao gerar exceções de atualização.

Valor Padrão:

false

Valores possíveis:

• true

• false

gbscluster.update.consider.faces.beforeFingerprints

Esse parâmetro define se as faces devem ser analisadas antes das impressões digitais ao gerar exceções de atualização. Se false, a análise de face é feita após a análise da impressão digital.

Valor Padrão:

false

Valores Possíveis:

• true

• false

gbscluster.update.minimum.fingers

Esse parâmetro define o número mínimo de casamentos entre dedos necessário para uma operação de atualização ser aceita.

Valor Padrão:

4

gbscluster.min.quality

Esse parâmetro define a qualidade mínima necessária para uma impressão digital, de modo que não seja gerada uma transação de ENROLL_PENDING.

Valor Padrão:

50

gbscluster.update.min.quality

Esse parâmetro define a qualidade mínima necessária para uma impressão digital, de modo que não seja gerada uma transação de UPDATE_PENDING.

Valor Padrão:

50

gbds.enroll.fingerprints.min-nr-template

Esse parâmetro define o número mínimo de templates de impressão digital necessário para uma transação ser processada. Se a transação não contiver o número requerido de digitais, ela irá falhar.

Valor Padrão:

0

gbds.enroll.faces.min-nr-template

Esse parâmetro define o número mínimo de templates de face requeridos para a transação ser processada. Se a transação não conter o número requerido de templates, ela ira falhar.

Valor Padrão:

0

gbds.enroll.iris.min-nr-template

Esse parâmetro define o número mínimo de templates de íris requeridos para a transação ser processada. Se a transação não conter o número requerido de templates, ela ira falhar.

Valor Padrão:

0

gbds.enroll.palmprint.min-nr-template

Esse parâmetro define o número mínimo de templates de digitais palmares requeridos para a transação ser processada. Se a transação não conter o número requerido de templates, ela ira falhar.

Valor Padrão:

0

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

Esse parâmetro define o número mínimo de templates de palmares de recém-nascidos necessário para a transação ser processada. Se a transação não contiver o número requerido de templates, ela irá falhar.

Valor Padrão:

0

gbscluster.update.fingerprints.verify.matchthreshold

Esse parâmetro define a pontuação mínima para considerar uma comparação 1:1 de digitais como um casamento durante uma operação de verificação.

Valor Padrão:

35

gbscluster.update.fingerprints.verify.anglethreshold

Esse parâmetro define o ângulo a ser considerado quando comparando duas impressões digitais durante a operação de verificação.

Valor Padrão:

180

Range:

0 to 180 (-1 causará o mesmo efeito de 180)

gbscluster.enroll.fingerprints.verify.duplicities.matchthreshold

Ao realizar a verificação de qualidade, durante a operação de cadastro, uma comparação entre dedos é executada checando duplicatas na transação.

Esse parâmetro define a pontuação mínima para que uma impressão digital verificada seja considerada duplicada ao realizar a validação entre dedos.

Valor Padrão:

45

gbscluster.enroll.fingerprints.verify.sequencecheck.matchthreshold

Esse parâmetro define o limiar mínimo para uma captura principal ser considerada um casamento contra seu respectivo índice no controle de sequência.

Se a comparação entre os dedos capturados e seus respectivos dedos no controle de sequência (exemplo 4-4-2 ou 2-2-1) retornar pontuação de coincidências acima desse limiar, será considerado um casamento pela checagem de sequência.

Valor Padrão:

20

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

Esse parâmetro define a pontuação mínima para uma captura específica ser considerada um casamento contra seu respectivo índice no controle de sequencial.

Se a comparação entre o dedo definido pelo índice e seu respectivo dedos no controle de sequência (exemplo 4-4-2 ou 2-2-1) retornar pontuação de coincidências acima desse limiar, será considerado um casamento pela checagem de sequência.

Essa configuração é opcional e, se não definida, o GBDS usará o valor de limiar global definido em gbscluster.enroll.fingerprints.verify.sequencecheck.matchthreshold.

Essa configuração deve ser repetida no arquivo de configuração para cada dedo individual que se deseja definir um limiar diferente do global.

O <index> na configuração deve ser mudado de acordo com o dedo desejado. Os valores possíveis são:

• left_little

• left_ring

• left_middle

• left_index

• left_thumb

• right_thumb

• right_index

• right_middle

• right_ring

• right_index

O índice deve ter o formato de STRING de acordo com a lista acima. Qualquer outro valor será considerado inválido e descartado.

gbscluster.enroll.fingerprints.identify.sequencecorrection.matchthreshold

Esse parâmetro define a pontuação mínima para a captura principal ser considerada um casamento quando comparando contra todas as outras digitais no controle de sequência.

Essa comparação é realizada depois de ser identificado problemas no controle de sequência para checar se as digitais das capturas principais estão trocadas. Se a digital da captura principal não bater com sua respectiva captura no controle de sequência, o sistema resolverá automaticamente o problema cortando a imagem do controle de sequência e substituindo a captura principal.

O número máximo de correções realizadas é determinado pelo parâmetro ```gbscluster.enroll.fingerprints.sequencecorrection.maxcorrections. Se o número de correções for maior que o valor definido, nenhuma correção será feita para o perfil e o status da transação será definido como PENDING`.

Esse parâmetro define a pontuação mínima para as capturas roladas serem considerada um casamento quando comparado contra todas as capturas pousadas do controle de sequência.

Valor Padrão:

20

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

Esse parâmetro define a pontuação mínima para a captura principal ser considerada um casamento quando comparando contra todas as outras digitais no controle de sequência.

Essa comparação é realizada depois de ser identificado problemas no controle de sequência para checar se as digitais das capturas principais estão trocadas. Se a digital da captura principal não bater com sua respectiva captura no controle de sequência, o sistema resolverá automaticamente o problema cortando a imagem do controle de sequência e substituindo a captura principal.

O número máximo de correções realizadas é determinado pelo parâmetro gbscluster.enroll.fingerprints.sequencecorrection.maxcorrections. Se o número de correções for maior que o valor definido, nenhuma correção será feita para o perfil e o status da transação será definido como PENDING.

{% hint style="info" %} Essa configuração é opcional e, se não definida, o GBDS usará o valor de limiar global definido em gbscluster.enroll.fingerprints.identify.sequencecorrection.matchthreshold. {% endhint %}

{% hint style="info" %} Essa configuração deve ser repetida no arquivo de configuração para cada dedo individual que se deseja definir um limiar diferente do global. {% endhint %}

O <index> na configuração deve ser mudado de acordo com o dedo desejado. Os valores possíveis são:

• left_little

• left_ring

• left_middle

• left_index

• left_thumb

• right_thumb

• right_index

• right_middle

• right_ring

• right_index

{% hint style="warning" %} O índice deve ter o formato de STRING de acordo com a lista acima. Qualquer outro valor será considerado inválido e descartado. {% endhint %}

gbscluster.enroll.fingerprints.sequencecorrection.maxcorrections

Esse parâmetro define o número máximo de correções automáticas realizadas antes de considerar uma transação como PENDING e enviá-la para revisão manual. Se o número de correções requerido for maior que o especificado nesse parâmetro, nenhuma correção será realizada e a transação original será enviada para revisão manual.

Valor Padrão:

4

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

Esse parâmetro define se as imagens do controle de sequência devem ser cortadas para cadastros onde não há nenhuma imagem de impressões digitais individuais disponível.

Valor Padrão:

false

Valores possíveis:

• true

• false

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

{% hint style="warning" %} Esta configuração foi descontinuada a partir da versão 4.7.0. Consulte as configurações que a substituem: gbscluster.fingerprints.extraction.enroll.type e gbscluster.fingerprints.extraction.verify.type. {% endhint %}

Esse parâmetro define se o CAB deve ser extraído para novas biometrias.

Valor Padrão:

false

Valores possíveis:

• true

• false

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

{% hint style="warning" %} Esta configuração foi descontinuada a partir da versão 4.7.0. Consulte as configurações que a substituem: gbscluster.fingerprints.extraction.enroll.type e gbscluster.fingerprints.extraction.verify.type. {% endhint %}

Valor Padrão:

false

Valores possíveis:

• true

• false

gbscluster.fingerprints.extraction.enroll.type

Esse parâmetro define o preset de extrator da ginger a ser usado para Cadastro e Atualização.

Valor Padrão:

GRIAULE_2024

Valores possíveis:

• GRIAULE_FAST: versão mais simples e rápida do GRIAULE_BASIC (nunca usado na API).

• GRIAULE_BASIC: antigo "…cab.enabled = false", extração padrão para Verificação.

• GRIAULE_2020: antigo "…cab.enabled = true", antiga extração padrão para Cadastro, Atualização.

• GRIAULE_2024: nova extração padrão para Cadastro, Atualização.

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

gbscluster.fingerprints.extraction.verify.type

Esse parâmetro define o preset de extrator da ginger a ser usado para Verificação.

Valor Padrão:

GRIAULE_BASIC

Valores possíveis:

• GRIAULE_FAST: versão mais simples e rápida do GRIAULE_BASIC (nunca usado na API).

• GRIAULE_BASIC: antigo "…cab.enabled = false", extração padrão para Verificação.

• GRIAULE_2020: antigo "…cab.enabled = true", antiga extração padrão para Cadastro, Atualização.

• GRIAULE_2024: nova extração padrão para Cadastro, Atualização.

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

gbds.rdb.driverClassName

Esse parâmetro define o nome de classe usado pelo banco de dados relacional para armazenar latentes não resolvidas.

Valor Padrão:

com.mysql.jdbc.Driver

gbds.rdb.url

Esse parâmetro define a URL do banco de dados relacional que será acessada.

Valor Padrão:

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

gbds.rdb.username

Esse parâmetro define o nome de usuário a ser usado para acesso ao banco de dados relacional.

Valor Padrão:

root

gbds.rdb.password

Esse parâmetro define a senha a ser usada para acesso ao banco de dados relacional.

Valor Padrão:

Vazio

gbds.rdb.dialect

Esse parâmetro define o dialeto a ser usado no banco de dados relacional.

Valor Padrão:

org.hibernate.dialect.MySQLDialect

gbds.rdb.showSql

Esse parâmetro define se as declarações do SQL devem ser incluídas nos logs da aplicação.

Valor Padrão:

false

Valores possíveis:

• true

• false

gbds.biometric.best-of-biometrics.enabled

Esse parâmetro habilita o best-of-biometrics. Quando habilitado, o conjunto de biometrias da pessoa é a consolidação das melhores biometrias obtidas de todas as transações da pessoa ao longo do tempo.

{% hint style="warning" %} Essa flag DEVE ter o mesmo valor nas configurações do GBDS e da API do GBDS. {% endhint %}

Valor Padrão:

false

gbds.biometric.face.template.format

Define o formato do template para face.

Os valores possíveis são: TPT_FORMAT_1 ou TPT_FORMAT_2.

{% hint style="warning" %} Os formatos de face não são intercambiáveis. Faces que tiveram enroll feito em um formato não darão match com faces feitas em outro formato. {% endhint %}

{% hint style="danger" %} O valor dessa configuração deve ser o mesmo nos arquivos application.conf e gbdsapi.properties {% endhint %}

gbds.peopleList.countFromRDB

Este parâmetro define o comportamento da paginação na chamada da API people/list. Definir como true, a lista de pessoas sempre contará o total de pessoas usando o filtro de restrição passado. Em grandes bancos de dados pode comprometer o desempenho. Definir como false restringirá a resposta apenas aos valores count, pageSize e currentPage.

Valor Padrão:

true

gbds.person.canDeleteOnException

Este parâmetro permite a exclusão de pessoas em exceção. É válido tanto para a referência como para a pessoa entrante.

Valor Padrão:

false

gbds.searches.verify.saveOnRdb.enabled

Define se a operação de verificação será salva na tabela gbds.transaction do RDB.

Valor Padrão:

true

{% hint style="danger" %} Esse valor deve ser o mesmo no application.conf e no gbdsapi.properties {% endhint %}

gbds.searches.identify.saveOnRdb.enabled

Define se a operação de identificação será salva na tabela gbds.transaction do RDB.

Valor Padrão:

true

{% hint style="danger" %} Esse valor deve ser o mesmo no application.conf e no gbdsapi.properties {% endhint %}

gbds.template.face.multiplicity

Define se o GBDS irá utilizar somente um formato de template de face, ou novo e antigo simultaneamente.

Valor Padrão:

ONLY_NEWEST

Valores Possíveis:

• ONLY_NEWEST - GBDS irá usar somente o mais novo formato de template.

• MULTIPLE - GBDS irá usar tanto o antigo como o novo formato de template.

gbds.search.verify.adjust-resolution

Quando essa configuração está ativada, verificações e atualizações na API e a verificação pós-match no GBDS ajustarão a resolução realizando uma verificação de correspondência, diminuindo a pontuação em dedos e palmas.

Valor Padrão:

true

Valores Possíveis:

• true

• false

gbds.update.exception.reextract

Esse parâmetro determina a reextração em atualizações que gerariam exceções. Apenas biometrias sem correspondência são reextraídas do entrante e referência, mas se a configuração para salvar a reextração (gbds.update.exception.reextract.save) for true, todas as biometrias de impressão digital são reextraídas. Antes da reextração da referência, a API verificará se os templates de referência já foram extraídos com o extrator escolhido. Se sim, a reextração não é realizada.

Valor Padrão:

NONE

Valores Possíveis:

• NONE, não reextrair.

• REGULAR, usar o extrator atual na referência (extrator configurado atualmente).

• GRIAULE_2018, usar GRIAULE_2018 para reextrair entrante e referência.

gbds.update.exception.reextract.save

Este parâmetro permite salvar no HBase transaction e people as reextrações de biometrias de consulta e referência. Se true, salva os modelos completos na transaction e os master record templates na people, não envia os modelos para o GBDS (não há novo TGUID para processar). Na transaction do RDB, a coluna ginger_extractor_type é atualizada na referência e na consulta e extraction_time é atualizada na consulta (soma a referência e o tempo de extração da consulta).

Valor Padrão:

false

Valores Possíveis:

• true

• false

Microsserviço de Extração de Templates

gbds.extraction.service

Este parâmetro habilita o microsserviço de extração. Se este parâmetro for definido como false, o GBDS usará o serviço de extração integrado.

Valor Padrão:

true

gbds.extraction.service.face.count

Esse parâmetro define quantas instâncias de microsserviço de extração de face estarão disponíveis.

Valor Padrão:

1

gbds.extraction.service.ginger.count

Esse parâmetro define quantas instâncias de microsserviço de extração de impressões digitais, palmares, palmares de recém-nascido e controle de sequência estarão disponíveis.

Valor Padrão:

5

gbds.extraction.service.girl.count

Esse parâmetro define quantas instâncias de microsserviço de extração de íris estarão disponíveis.

Valor Padrão:

1

gbds.extraction.service.hostname

Esse parâmetro define o hostname do microsserviço de extração. Se for especificado como localhost, a API assumirá o controle da ativação/desativação dos serviços. Se outro nome de host for definido, a ativação/desativação deverá ser feita manualmente.

Valor Padrão:

localhost

gbds.extraction.service.initialPort

Esse parâmetro define o número da porta inicial para os microsserviços de extração. Cada instância do microsserviço aumentará sua porta em 1. Isso significa que a primeira instância de microsserviço habilitada terá uma porta com o número definido, a segunda o número+1, a terceira o número+2 e sucessivamente.

Valor Padrão:

30000

gbds.extraction.service.logLevel

Esse parâmetro define o nível de log do microsserviço de extração. INFO registrará as saídas dos scripts no log da API. DEBUG registrará as saídas dos scripts e o log do extrator diretamente no log da API.

Valor Padrão:

INFO

Valores Possíveis:

• INFO

• DEBUG

gbds.extraction.service.timeout

Esse parâmetro define o timeout para o microsserviço de extração em segundos.

Valor Padrão:

60

gbds.extraction.service.maxTries

Este parâmetro define o número máximo de tentativas de extração que o GBDS executará na mesma transação antes de retornar um erro.

Valor Padrão:

3

gbds.extraction.service.linkLibSegfault

Este parâmetro habilita o rastreamento de falhas de segmentação no serviço de extração.

Valor Padrão:

false

gbds.extraction.service.checkTimeoutSecs

Timeout (em segundo) para verificar se o microsserviço de extração de templates foi criado.

Valor Padrão:

10

api.uniqueId

Este parâmetro define o ID da API e é OPCIONAL. É usado para iniciar manualmente um microsserviço de extração e identificar qual microsserviço está vinculado a qual API. O valor pode ser qualquer valor de string sem espaços em branco ou caracteres especiais.

Serviço de Extração de Qualidade

gbds.extraction.quality.service

Esse parâmetro habilita o serviço de extração de qualidade.

Valor Padrão:

true

gbds.extraction.quality.api.uniqueId

Este parâmetro define o ID da API e é OPCIONAL. É usado para iniciar manualmente o serviço de extração de qualidade e identificar qual serviço está vinculado a qual API. O valor pode ser qualquer valor de string sem espaços em branco ou caracteres especiais.

{% hint style="warning" %} Se você estiver utilizando múltiplas APIs, atente-se para a configuração gbds.extraction.quality.api.uniqueId.list {% endhint %}

gbds.extraction.quality.api.uniqueId.list

Essa configuração define os IDs das APIs que processarão a extração de qualidade em segundo plano. Existem duas maneiras de definir os ids:

• Separados por vírgulas, com o líder primeiro, todos os outros ids são definidos como runners.

• Json

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

api_id é SEMPRE obrigatório e não pode estar vazio, enquanto type é opcional.

{% hint style="warning" %} Apenas um LÍDER (leader) pode ser definido. {% endhint %}

Essa configuração não altera nenhum outro comportamento do serviço de extração de qualidade.

gbds.extraction.quality.fillTransactionQualityPropertiesTable

Esse parâmetro define se as propriedades de qualidade (Valor do NFIQ, número de minúcias, tamanho de imagem, etc.) extraídos pelo serviço de extração de qualidade devem ser guardados na tabela gbds.transaction_quality_properties.

{% hint style="warning" %} Habilitar esse parâmetro pode aumentar drasticamente o requerimento de espaço do RDB {% endhint %}

Valor Padrão:

false

gbds.extraction.quality.service.linkLibSegfault

Este parâmetro habilita o rastreamento de falhas de segmentação no serviço de extração de qualidade.

Valor Padrão:

false

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

Este parâmetro determina o tamanho do bloco de transações a ser enviado à thread pool para extração de qualidade.

Valor Padrão:

20

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

Este parâmetro determina o fator a ser multiplicado pelo tamanho da thread pool para determinar o tamanho médio da fila de processamento.

Valor Padrão:

3

gbds.faces.extraction.quality.api

Este parâmetro habilita o serviço de extração de qualidade de face em cadastros e atualizações por meio da chamada de API.

Valor Padrão:

true

gbds.enroll.face.min.quality

Define o limiar mínimo de qualidade para uma imagem de face ser aceita em uma operação de enroll.

Valor Padrão:

50

gbds.update.face.min.quality

Define o limiar mínimo de qualidade para uma imagem de face ser aceita em uma operação de update.

Valor Padrão:

50

gbds.faces.extraction.quality.background

Este parâmetro habilita o serviço de extração de qualidade de face em segundo plano. Quando habilitado, o extrator irá olhar a tabela gbds.transaction onde as linhas finger_quality_extracted tiverem o valor false, e, a partir do tguid da transação, pegará o template do HBase com o mesmo tguid e realizará a extração de qualidade nesse template.

{% hint style="info" %} Habilitar esse parâmetro NÃO habilita a extração de qualidade via chamada de API {% endhint %}

Valor Padrão:

false

gbds.fingerprints.extraction.quality.api

Este parâmetro habilita o serviço de extração de qualidade de impressões digitais em cadastros e atualizações por meio da chamada de API.

Valor Padrão:

true

gbds.fingerprints.extraction.quality.background

Este parâmetro habilita o serviço de extração de qualidade de impressões digitais em segundo plano. Quando habilitado, o extrator irá olhar a tabela gbds.transaction onde as linhas finger_quality_extracted tiverem o valor false, e, a partir do tguid da transação, pegará o template do HBase com o mesmo tguid e realizará a extração de qualidade nesse template.

{% hint style="info" %} Habilitar esse parâmetro NÃO habilita a extração de qualidade via chamada de API {% endhint %}

Valor Padrão:

false

gbds.extraction.quality.service.finger.count

Este parâmetro define quantas instâncias de serviços de extração de qualidade de impressões digitais estarão disponíveis.

Valor Padrão:

1

gbds.extraction.quality.service.face.count

Este parâmetro define quantas instâncias de serviços de extração de qualidade de faces estarão disponíveis.

Valor Padrão:

1

gbds.extraction.quality.service.initialPort

Esse parâmetro define o número da porta inicial para o serviço de extração de qualidade. Cada instância do serviço aumentará sua porta em 1. Isso significa que a primeira instância do serviço habilitada terá uma porta com o número definido, a segunda o número+1, a terceira o número+2 e sucessivamente.

Valor Padrão:

31000

gbds.extraction.quality.service.logLevel

Esse parâmetro define o nível de log do serviço de extração de qualidade. INFO registrará as saídas dos scripts no log da API. DEBUG registrará as saídas dos scripts e o log do extrator diretamente no log da API.

Valor Padrão:

INFO

Valores Possíveis:

• INFO

• DEBUG

gbds.extraction.quality.service.timeout

Esse parâmetro define o timeout para o serviço de extração de qualidade em segundos.

Valor Padrão:

60

gbds.extraction.quality.service.hostname

Esse parâmetro define o hostname do serviço de extração de qualidade. Se for especificado como localhost, a API assumirá o controle da ativação/desativação dos serviços. Se outro nome de host for definido, a ativação/desativação deverá ser feita manualmente.

Valor Padrão:

localhost

gbds.extraction.quality.service.maxTries

Este parâmetro define o número máximo de tentativas de extração que o GBDS executará na mesma transação antes de retornar um erro.

Valor Padrão:

3

gbds.extraction.quality.service.checkTimeoutSecs

Timeout (em segundos) para verificar se o microsserviço de extração de qualidade foi criado.

Valor Padrão:

10

Base Biográfica Externa

gbds.biographicBase.enabled

Flag para ligar/desligar o acesso ao servidor Biobase. Quando desligado, biographicBaseStatus não é retornado nas chamadas de get/list transaction/person.

Valor Padrão:

false

Valores Possíveis:

• true

• false

gbds.biographicBase.endpoints

Lista separada por vírgulas com todos os URLs do servidor Biobase, com host e porta.

Valor Padrão:

Vazio

Valores Possíveis:

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

gbds.biographicBase.get.timeout.ms

Timeout de requisições get do servidor Biobase. É usado em chamadas de API get transaction ou get person.

Valor Padrão:

500

gbds.biographicBase.list.timeout.ms

Timeout de requisições list do servidor Biobase. É usado em chamadas de API list transaction ou list people. Nas chamadas list, o Biobase Server é chamado apenas uma vez para todas as transações/pessoas que serão retornadas.

Valor Padrão:

500

gbds.biographicBase.logLevel

Nível de log nas chamadas ao servidor Biobase.

Valor Padrão:

INFO

Valores Possíveis:

• INFO: registra a URL de solicitação do servidor.

• NONE: nenhum log de solicitação do servidor.

• TIME: registra a URL de solicitação do servidor e o tempo decorrido.

• DEBUG: registra a URL de solicitação do servidor, o tempo decorrido e os corpos de solicitação/resposta.

gbds.biographicBase.clientID

ID do cliente de autenticação.

Valor Padrão:

Vazio

gbds.biographicBase.clientSecret

Senha do cliente de autenticação.

Valor Padrão:

Vazio

gbds.biographicBase.lookAllServers

Flag para procurar em todos os servidores em casos de não autorização ou pessoas não encontradas.

• Para autorização:

  • Quando estiver LIGADO e um Servidor Biobase retornar não autorizado, a API irá procurar todos os outros servidores tentando se autenticar.

  • Quando estiver DESLIGADO, a API irá procurar apenas o Servidor Biobase atual para autenticação, retornando não autorizado ou autorizado.

• Para pessoas não encontradas:

  • Quando estiver LIGADO e a chamada do Servidor Biobase não retornar todas as pessoas, a API tentará todos os outros servidores até que todas as pessoas sejam encontradas. Se a lista de pessoas consolidada de todos os servidores ainda estiver incompleta, mesmo depois de passar por todos os servidores, ela será deixada como está.

  • Quando estiver DESLIGADO, a API irá olhar apenas para o servidor Biobase atual para todas as pessoas na solicitação. Mesmo que uma pessoa ainda não esteja na lista de pessoas, a lista é deixada como está.

Valor Padrão:

false

Valores Possíveis:

• true

• false

gbds.biographicBase.autoUpdate

Envia dados biográficos para a BioBase ao cadastrar/atualizar/trusted.

Valor Padrão:

true

Valores Possíveis:

• true

• false

gbds.biographicBase.sendPguidAsKey

Envia PGUID como chave em qualquer atualização da BioBase.

Valor Padrão:

true

Valores Possíveis:

• true

• false

gbds.biographicBase.sendTguidAsKey

Envia TGUID como chave em qualquer atualização da BioBase.

Valor Padrão:

false

Valores Possíveis:

• true

• false

Configuração do Serializador de Templates

Essa seção descreve os parâmetros de configuração relacionados ao serializador de templates. Esses parâmetros de configuração são projetador para permitir o uso do GBDS Batch Extractor.

{% hint style="info" %} Veja o manual do GBDS Batch Extractor para informações adicionais sobre seu uso. {% endhint %}

Sempre que o GBDS realizar uma operação de cold boot, ele tentará recuperar os templates de uma família de colunas padrão. Se o template não existir nessa coluna, o GBDS tentará recuperá-lo da família de colunas de reserva.

Os parâmetros de configuração do serializador são:

Família de Colunas Padrão

Esses parâmetros são divididos por modalidades biométricas. Os templates nessa família de colunas não possuem codificação e o formato usado é de 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

O valor padrão para esses parâmetros é tpt.

Família de Colunas Reserva

Esses parâmetros referem-se às famílias de colunas anteriormente usadas para armazenar os templates biométricos. São separados por modalidade 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

Os valores padrão representam as famílias de colunas usadas antes da mudança desses parâmetros, e são, respectivamente: fingerprints, palmprints, faces, e iris.

Codificação Reserva em base64

A família de colunas reserva suporta codificação. Os parâmetros a seguir definem se a família de colunas é codificada em 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

O valor padrão para esses parâmetros é true.

Configurações de Notificação de Email

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

Esse parâmetro habilita o serviço de notificação de email. Quando true, toda busca de identificação de face enviará um email com a imagem solicitada para usuários ou grupos determinados.

Valor Padrão:

false

Valores Possíveis:

• true

• false

gbds.transparency.email-notifier.log-level

Esse parâmetro define o nível de log do serviço de notificação de email.

Valor Padrão:

INFO

Valores Possíveis:

• INFO

• TIME

• NONE

• DEBUG.

gbds.transparency.email-notifier.timeout

Esse parâmetro define o timeout em segundos do serviço de notificação de email.

Valor Padrão:

60

gbds.transparency.email-notifier.url

Esse parâmetro define a URL do serviço de notificação de email.

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

Este parâmetro permite que o serviço de notificação por email envie a notificação para solicitação de pesquisa de identificação facial.

Valor Padrão:

false

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

Esse parâmetro permite que o serviço de notificação por email processe a ação definida para uma pessoa por meio das tabelas de transparência quando a pessoa aparecer nos resultados da pesquisa.

Valor Padrão:

false

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

Esse parâmetro permite que o serviço de notificação por email envie mensagens quando os resultados da pesquisa corresponderem às pessoas de interesse.

Valor Padrão:

false