Griaule Biometric Suite

https://docs.griaule.com
Admin
Griaule Biometric Suite (GBS) is a comprehensive multimodal biometric identification system (ABIS)...
Tokens:532,287
Snippets:3,238
Trust Score:7.4
Update:1 month ago
Show doc for...
Tokens:
Raw
### Complete ViewController example

Source: https://docs.griaule.com/sdks/bcc-face/bccmobilefaceios.md

A functional example of a ViewController implementing the BCCFaceDelegate and starting a capture session.

```swift
import UIKit
import BCCFace

class ViewController: UIViewController {
	override func viewDidLoad() {
		super.viewDidLoad()
	}

	@IBAction func startCapture(_ sender: UIButton) {
		BCCFaceBuilder(self, delegate: self)
			.removeSmileCheck()
			.removeHeadRotation()
			.addPassiveLiveness()
			.buildCameraSettings(.frontSwitchable)
			.enableFlashButton(true)
			.initializeCapture(navigationController)
	}
}

extension ViewController: BCCFaceDelegate {
	func faceCaptureDidFinish(
		data: BCCFace.BCCFaceReturnData,
		analytics: BCCFace.BCCFaceAnalytics
	) {
		// ...
	}

	func faceCaptureDidAbort(
		analytics: BCCFace.BCCFaceAnalytics
	) {
		// ...
	}
}
```

--------------------------------

### START operation examples

Source: https://docs.griaule.com/integracao-do-gbds/gbsintegration.md

Examples of possible returns when using the START operation with the values "Jo", "Jose Arruda", "123", and "123.456". The START operation tokenizes words/numbers by separators and filters values that start with the given token.

```default
Jose Arruda
John Doe
Marie Johnson
```

```default
Jose Arruda
Jose Silva
Pedro Thomas Arruda
```

```default
1234567
123.456
456-123
a-b 123
```

```default
123.456
123.456.789-90
```

--------------------------------

### GET /checkid/{guid}

Source: https://docs.griaule.com/apis/spidx/spidx-api-specification.md

Retrieves the attributes of a transaction using its GUID.

```APIDOC
## GET /checkid/{guid}

### Description
This method returns the attributes of a transaction, given its GUID.

### Method
GET

### Endpoint
/checkid/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - The GUID of the transaction.

### Response
#### Success Response (200)
- **biometricPackage** (BiometricPackage) - Contains biometric data.
- **biographicPackage** (BiographicPackage) - Contains biographic data.
- **userInformation** (UserInformation) - Contains user-related information.

#### Response Example
{
  "biometricPackage": {
    "biometricsGuid": "string",
    "biometricList": [
      {
        "content": "string",
        "index": 0,
        "biometricProperties": {
          "width": 0,
          "height": 0,
          "resolution": 0
        }
      }
    ],
    "walletAdress": "string"
  },
  "biographicPackage": {
    "biographicList": [
      {
        "type": "FULL_NAME",
        "value": "string"
      }
    ]
  },
  "userInformation": {
    "spidx": "string",
    "deduplicationStatus": "ENQUEUED",
    "verificationStatus": "MATCH"
  }
}

#### Error Responses
- **404** - transaction does not exist
- **422** - Unprocessable Entity
- **500** - internal error
```

--------------------------------

### Executar script de setup

Source: https://docs.griaule.com/componentes-web/gbsappssetup.md

Executa o script de configuração inicial para a aplicação especificada.

```sh
/var/lib/tomcats/setup.sh <app_name>
```

--------------------------------

### Executar setup do Solr

Source: https://docs.griaule.com/ferramentas-auxiliares/apacheranger.md

Torne o script executável, execute a instalação e verifique as notas de instalação.

```sh
chmod +x setup.sh
./setup.sh

less /usr/gdp/hadoop/solr/8.11.2/ranger_audit_server/install_notes.txt
```

--------------------------------

### Executar script de pré-instalação (Passo 2)

Source: https://docs.griaule.com/componentes-web/gbsappssetup.md

Executa o script setup_webapps.sh passando o nome da aplicação desejada (ex: bcc, cardscan, etr).

```sh
./setup_webapps.sh <app_name>
```

--------------------------------

### Operator Capture Response Example

Source: https://docs.griaule.com/apis/spid-services.md

Example JSON response for the GET capture/operator-capture endpoint.

```json
{
	"status": "CLIENT_CAPTURE_NOT_DONE",
	"message": "The client capture hasn't been completed",
	"id": "id1"
}
```

--------------------------------

### Example Podfile configuration

Source: https://docs.griaule.com/sdks/bcc-face/bccmobilefaceios.md

A complete example of a Podfile for a target named BCCs-Sample, including framework settings and build configurations.

```ruby
platform :ios, '15.0'

target 'BCCs-Sample' do
	use_frameworks!

	pod 'GoogleMLKit/FaceDetection'
	pod 'lottie-ios'
end

post_install do |installer|
	installer.pods_project.targets.each do |target|
		target.build_configurations.each do |config|
			config.build_settings['DEVELOPMENT_TEAM'] = "YOUR_DEVELOPMENT_TEAM_KEY"
			config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
		end
	end
end
```

--------------------------------

### GET /exceptions/reprocess/{guid}

Source: https://docs.griaule.com/apis/gbds-5/exceptions.md

Retrieves the progress and result of reprocessing a specific exception identified by its GUID.

```APIDOC
## [GET] /exceptions/reprocess/{guid}

### Description
Provides the progress and result of reprocessing a specific exception identified by the GUID.

### Method
GET

### Endpoint
/exceptions/reprocess/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - The GUID of the exception to reprocess.

### Response
#### Success Response (200)
- **guid** (string) - The GUID of the exception.
- **exceptions** (array of ReprocessException) - List of reprocessed exceptions.
- **status** (string) - Status of the reprocessing. Possible values: ENQUEUED, COUNTING, LISTING, PROCESSING, PROCESSED.
- **index** (integer) - Current index in the reprocessing.
- **processed** (integer) - Number of processed items.
- **total** (integer) - Total number of items.
- **httpResponse** (HttpResponse) - HTTP response details.

#### Response Example
{
  "guid": "string",
  "exceptions": [
    {
      "index": 0,
      "aguid": "string",
      "entrantTguid": "string",
      "entrantPguid": "string",
      "entrantReextracted": true,
      "referenceTguid": "string",
      "referencePguid": "string",
      "referenceReextracted": true,
      "type": "ENROLL",
      "oldStatus": "ANALYSIS",
      "newStatus": "ANALYSIS",
      "message": "string",
      "httpResponse": {
        "httpCode": 0,
        "body": "string"
      }
    }
  ],
  "status": "ENQUEUED",
  "index": 0,
  "processed": 0,
  "total": 0,
  "httpResponse": {
    "httpCode": 0,
    "body": "string"
  }
}
```

--------------------------------

### Initialize BCCFaceBuilder with basic configuration

Source: https://docs.griaule.com/sdks/bcc-face/bccmobilefaceandroid.md

Example of initializing the BCCFaceBuilder with camera settings.

```kotlin
BCCFaceBuilder(this, this)
	.enableFlipCameraButton(false)
	.setCameraInitialDirection(CameraFacingDirection.BACK)
```

--------------------------------

### Remote Verify Result Response Example

Source: https://docs.griaule.com/apis/spid-services.md

Example JSON response for the GET /capture/remoteVerify/result/{tguid} endpoint.

```json
{
	"status": "Done",
	"message": "Remote verify with status SEARCH_MATCH"
}
```

--------------------------------

### Create user and enable Kafka plugin

Source: https://docs.griaule.com/ferramentas-auxiliares/apacheranger.md

Create the kafka user and execute the enable-kafka-plugin.sh script.

```sh
useradd kafka
passwd kafka
./enable-kafka-plugin.sh
```

--------------------------------

### Configurar variáveis de ambiente do Maven no GHDP

Source: https://docs.griaule.com/ferramentas-auxiliares/apacheranger.md

Edite o arquivo /etc/profile.d/hadoop_setup.sh para adicionar as variáveis M2_VERSION, M2_HOME e M2, necessárias para o Ranger.

```sh
vim /etc/profile.d/hadoop_setup.sh
```

```sh
...
# MAVEN (to Ranger)
export M2_VERSION=$(ls -A /usr/local/ | grep apache-maven- | grep -v .gz | awk -F '-' '{print $3}')
export M2_HOME=/usr/local/apache-maven-$M2_VERSION
export M2=$M2_HOME/bin
...
```

--------------------------------

### Verify Operator Response Example

Source: https://docs.griaule.com/apis/spid-services.md

Example JSON response for the /verify/operator GET request showing the initialization of a verification scene.

```json
{
	"status": "OPERATOR_VERIFYING",
	"message": "The operator verify scene has been initialized",
	"id": "id1"
}
```

--------------------------------

### Logout Response Example

Source: https://docs.griaule.com/apis/spid-services.md

Example JSON response for the /logout GET request indicating a successful logout when no operator is active.

```json
{
	"status": "LOGIN_NOT_ACTIVE",
	"message": "Log out successful. There is no active operator"
}
```

--------------------------------

### Exemplo do arquivo config.properties

Source: https://docs.griaule.com/componentes-web/controlpanelwebconfig.md

Exemplo completo de um arquivo de configuração contendo propriedades de banco de dados, locale, configurações do GBDS e parâmetros de rede do servidor.

```properties
# GBS Control Panel Server

jdbc.driverClassName=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://192.168.0.189:3306/controlpanel?useSSL=false
jdbc.username=root
jdbc.password=CDrt8vbewA2YAubPNOLZkw==
jdbc.dialect=org.hibernate.dialect.MySQLDialect
jdbc.showSql=true

locale=en_us

gbds.url=http://192.168.0.189:8085
gbds.user=gbds.authenticate
gbds.key=Griaule.123
gbds.logLevel=INFO
gbds.timeout=300

fingerprint.useSDK=false

gbds.controlPanelUser=control_panel_server
sync.logLevel=INFO
same.user.simultaneous.login=false
notification.delay=5

server.standalone.port=8185

control-panel.ip=127.0.0.1
control-panel.port=8121
control-panel.protocol=http
```

--------------------------------

### Realizar o deploy das aplicações

Source: https://docs.griaule.com/instalacao-do-gbds/gbds4ansibleinstall.md

Após mover os arquivos .war para o diretório /opt/griaule/tools/deploy_application/files, execute este comando para realizar o deploy.

```shell
/opt/griaule/tools/deploy_application/deploy_application.sh --services
```

--------------------------------

### GET /gbs-spid-server/service/cluster/get-enroll-result/{sessionGuid}/{transactionGuid}

Source: https://docs.griaule.com/apis/spid/deprecated.md

Retrieves the result of an enrollment transaction using its transaction GUID. This endpoint is part of the deprecated API and requires both a session GUID and a transaction GUID as path parameters.

```APIDOC
## [GET] /gbs-spid-server/service/cluster/get-enroll-result/{sessionGuid}/{transactionGuid}

### Description
This method returns the result of an enrollment transaction, given its TGUID.

### Method
GET

### Endpoint
/gbs-spid-server/service/cluster/get-enroll-result/{sessionGuid}/{transactionGuid}

### Parameters
#### Path Parameters
- **sessionGuid** (string) - Required - The session GUID.
- **transactionGuid** (string) - Required - The transaction GUID (TGUID).

### Response
#### Success Response (200)
- **ServiceResult** (object) - The result of the enrollment transaction.

#### Error Responses
- **400** (ErrorResponse) - Bad Request
- **403** (ErrorResponse) - Forbidden
- **404** (ErrorResponse) - Not Found
- **409** (ErrorResponse) - Conflict
- **415** (ErrorResponse) - Unsupported Media Type
- **422** (ErrorResponse) - Unprocessable Entity
- **500** (ErrorResponse) - Internal Server Error
- **503** (ErrorResponse) - Service Unavailable
```

--------------------------------

### Configurar as aplicações

Source: https://docs.griaule.com/instalacao-do-gbds/gbds4ansibleinstall.md

Executa o script de configuração automática das aplicações instaladas.

```shell
/opt/griaule/tools/auto_appconfig/auto_appconfig.sh --services
```

--------------------------------

### GBDS monitor version response example

Source: https://docs.griaule.com/release-notes/gbds.md

Example JSON response from the GBDS GET /monitor/version endpoint, showing the new libMultibio and matcherMultibio fields.

```json
{
    "data": {
        "version": "5.2.0-SNAPSHOT",
        "build": "5000",
        "libMultibio": "0.3.6",
        "matcherMultibio": "0.3.6"
    }
}
```

--------------------------------

### Remote Approval Response Examples

Source: https://docs.griaule.com/apis/spid-services.md

Example JSON responses for the GET /gbs-spid-services/api/capture/remoteApproval/{tguid} endpoint, covering success, error, and inactive login scenarios.

```json
{
	"status": "Done",
	"message": "Remote approval initialized"
}
```

```json
{
	"status": "Error",
	"message": "..."
}
```

```json
{
	"status": "Login not active",
	"message": "There is no valid operator logged in"
}
```

--------------------------------

### Valores originais e ajustados do ExecStart no systemd

Source: https://docs.griaule.com/ferramentas-auxiliares/elk.md

Linha ExecStart original e a modificação necessária para apontar o Logstash para o arquivo de configuração smartsense.conf em /etc/logstash/conf.d/.

```properties
ExecStart=/usr/share/logstash/bin/logstash "--path.settings" "/etc/logstash"
```

```properties
ExecStart=/usr/share/logstash/bin/logstash "--path.settings" "/etc/logstash" "-f" "/etc/logstash/conf.d/smartsense.conf"
```

--------------------------------

### GET /gbs-spid-server/transaction/{guid}

Source: https://docs.griaule.com/apis/spid/transaction.md

Retrieves transaction details for a given GUID. The response includes the transaction ID, status, type, and associated biometric information.

```APIDOC
## GET /gbs-spid-server/transaction/{guid}

### Description
Retrieves transaction details for a given GUID. The response includes the transaction ID, status, type, and associated biometric information.

### Method
GET

### Endpoint
/gbs-spid-server/transaction/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - The unique identifier of the transaction.

### Response
#### Success Response (200)
- **id** (string) - The transaction ID.
- **status** (string) - The status of the transaction. Possible values: OK, SEARCH_PENDING, SEARCH_ENQUEUED, SEARCH_MATCH, SEARCH_NOT_MATCH, SEARCH_FAILED, ENROLL_PENDING, ENROLL_ENQUEUED, ENROLL_CACHE_OK, ENROLL_OK, ENROLL_FAILED, ENROLL_EXCEPTION, DELETE_OK, DELETE_FAILED, DELETE_PENDING, REMOTE_CAPTURE_ACCEPTED, REMOTE_CAPTURE_REFUSED, REMOTE_CAPTURE_PENDING, REMOTE_CAPTURE_AVAILABLE, REMOTE_CAPTURE_STORED, FRAUD, ERROR, ENROLL_REJECTED, PERSON_NOT_FOUND.
- **type** (string) - The type of transaction. Possible values: ENROLL, UPDATE, SEARCH, VERIFY, DELETE.
- **transaction** (object) - Contains biometric data.
  - **Biometrics** (array) - List of biometric objects, each with an **index** (integer).
  - **MissingBiometrics** (array) - List of missing biometric objects, each with **index** (integer), **type** (string: AMPUTATED or UNAVAILABLE), and **reason** (string).

#### Response Example
{
  "id": "string",
  "status": "OK",
  "type": "ENROLL",
  "transaction": {
    "Biometrics": [
      {
        "index": 0
      }
    ],
    "MissingBiometrics": [
      {
        "index": 0,
        "type": "AMPUTATED",
        "reason": "string"
      }
    ]
  }
}

#### Error Responses
- **400** - Bad Request
- **401** - Unauthorized
- **403** - Forbidden
- **404** - Not Found
- **409** - Conflict
- **415** - Unsupported Media Type
- **422** - Unprocessable Entity
- **500** - Internal Server Error
- **503** - Service Unavailable

Error responses contain an **ErrorResponse** object with:
- **errors** (array) - List of errors, each with **type** (string: VALIDATION_ERROR, PROCESSING_ERROR, INTERNAL_ERROR, SECURITY_ERROR) and **message** (string).
- **type** (string) - The error type: VALIDATION_ERROR, PROCESSING_ERROR, INTERNAL_ERROR, SECURITY_ERROR.
```

--------------------------------

### Configurar aliases (Passo 3)

Source: https://docs.griaule.com/componentes-web/gbsappssetup.md

Executa o script setup_aliases.sh para criar aliases e depois aplica o arquivo .bashrc com source.

```sh
./setup_aliases.sh <app_name>
```

```sh
source ~/.bashrc
```

--------------------------------

### Iniciar APISIX com arquivo de configuração personalizado

Source: https://docs.griaule.com/instalacao-do-gbds/apisix.md

Use o comando apisix start -c para especificar o caminho do arquivo de configuração ao iniciar o APISIX. O APISIX usará as configurações desse arquivo e retornará à configuração padrão para qualquer item não configurado.

```sh
apisix start -c <path to config file>
```

--------------------------------

### Get exception reprocessing - OpenAPI specification

Source: https://docs.griaule.com/apis/gbds-5/exceptions.md

OpenAPI 3.0.1 specification for the GET /exceptions/reprocess/{guid} endpoint. Defines the request path parameter 'guid' and the response schema 'ReprocessExceptions' with fields for status, progress, and exception details. The status enum includes ENQUEUED, COUNTING, LISTING, PROCESSING, and PROCESSED.

```json
{"openapi":"3.0.1","info":{"title":"GBDS API","version":"5.1.16"},"servers":[{"url":"http://<ip>:8085/gbds/v2"}],"paths":{"/exceptions/reprocess/{guid}":{"get":{"tags":["exceptions"],"operationId":"getReprocess","parameters":[{"name":"guid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReprocessExceptions"}}}}},"description":"Provides the progress and result of reprocessing a specific exception identified by the GUID.","summary":"Get exception reprocessing"}}},"components":{"schemas":{"ReprocessExceptions":{"type":"object","properties":{"guid":{"type":"string"},"exceptions":{"type":"array","items":{"$ref":"#/components/schemas/ReprocessException"}},"status":{"type":"string","enum":["ENQUEUED","COUNTING","LISTING","PROCESSING","PROCESSED"]},"index":{"type":"integer","format":"int32"},"processed":{"type":"integer","format":"int64"},"total":{"type":"integer","format":"int64"},"httpResponse":{"$ref":"#/components/schemas/HttpResponse"}}},"ReprocessException":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"aguid":{"type":"string"},"entrantTguid":{"type":"string"},"entrantPguid":{"type":"string"},"entrantReextracted":{"type":"boolean"},"referenceTguid":{"type":"string"},"referencePguid":{"type":"string"},"referenceReextracted":{"type":"boolean"},"type":{"type":"string","enum":["ENROLL","UPDATE","VERIFY","IDENTIFY"]},"oldStatus":{"type":"string","enum":["ANALYSIS","DIFFERENT_FINGERS","SAME_FINGERS","INCORRECT_ENROLL","RECOLLECT","MERGE_TRANSACTIONS","APPROVE","REJECT","ERROR","REFUSED"]},"newStatus":{"type":"string","enum":["ANALYSIS","DIFFERENT_FINGERS","SAME_FINGERS","INCORRECT_ENROLL","RECOLLECT","MERGE_TRANSACTIONS","APPROVE","REJECT","ERROR","REFUSED"]},"message":{"type":"string"},"httpResponse":{"$ref":"#/components/schemas/HttpResponse"}}},"HttpResponse":{"type":"object","properties":{"httpCode":{"type":"integer","format":"int32"},"body":{"type":"string"}}}}}}
```

--------------------------------

### GET /notification/trackTguid/{tguid}

Source: https://docs.griaule.com/apis/gbds-5/notification.md

Retrieves all notifications associated with a given Transaction GUID (TGUID), including those linked by Person GUID (PGUID), new TGUID, and enroll PGUID.

```APIDOC
## [GET] /notification/trackTguid/{tguid}

### Description
Get all notifications related to a TGUID. Using the provided TGUID, this method will return all notifications for the TGUID and associated to it by PGUID, newTguid, and enrollPguid.

### Method
GET

### Endpoint
/notification/trackTguid/{tguid}

### Parameters
#### Path Parameters
- **tguid** (string) - Required - Transaction GUID.

### Response
#### Success Response (200)
- **data** (array of NotificationObject) - List of notifications.
- **pagination** (object) - Pagination details.
  - **total** (integer) - Total number of notifications with the given filters.
  - **count** (integer) - Number of notifications in the current page.
  - **pageSize** (integer) - Number of notifications per page.
  - **currentPage** (integer) - Current page number. Zero-based.
  - **totalPages** (integer) - Total number of pages. Starts at 1.

#### NotificationObject Properties
- **operation** (NotificationOperationEnum) - Operation for TGUID.
- **tguid** (string, uuid) - Transaction GUID.
- **newTguid** (string, uuid) - New Transaction GUID, when it was edited during quality analysis.
- **pguid** (string, uuid) - Person GUID.
- **enrollPguid** (string, uuid) - Enroll Person GUID, when an exception treatment is performed.
- **status** (string) - Status for TGUID.
- **sender** (string) - Sender of the notification. `null` if the sender was GBDS.
- **uguid** (string, uuid) - UL GUID.
- **treatment** (string) - Exception treatment.
- **update** (boolean) - `true` if it is an update.
- **trusted** (boolean) - On enrollment notifications, `true` if it is a trusted enroll.
- **origin** (string) - Indicates notification origin. Enum: ["API", "GBDS"].
- **additionalData** (object) - Map of strings with additional data.
- **relatedTransactions** (array of PersonRelatedTransaction) - List of transactions related to the notification transaction.
- **nguid** (string, uuid) - Notification GUID.
- **timestamp** (integer, int64) - Timestamp.
- **acks** (array) - List of clients that have acknowledged the notification.

#### Response Example
{
  "data": [
    {
      "operation": "string",
      "tguid": "string",
      "newTguid": "string",
      "pguid": "string",
      "enrollPguid": "string",
      "status": "string",
      "sender": "string",
      "uguid": "string",
      "treatment": "string",
      "update": true,
      "trusted": true,
      "origin": "API",
      "additionalData": {},
      "relatedTransactions": [],
      "nguid": "string",
      "timestamp": 0,
      "acks": []
    }
  ],
  "pagination": {
    "total": 0,
    "count": 0,
    "pageSize": 0,
    "currentPage": 0,
    "totalPages": 0
  }
}
```

--------------------------------

### Initialize BCCFingerBuilder

Source: https://docs.griaule.com/sdks/bcc-finger/bccmobilefingerios.md

Basic example showing how to initialize a new capture session using the BCCFingerBuilder class.

```swift
// Para inicializar uma nova captura
BCCFingerBuilder(self, delegate: self).initializeCapture()
```

--------------------------------

### GET /gbs-spid-server/remote-capture/biometrics/{tguid}

Source: https://docs.griaule.com/apis/spid/remote.md

Retrieves biometric data for a given transaction GUID (tguid).

```APIDOC
## GET /gbs-spid-server/remote-capture/biometrics/{tguid}

### Description
Retrieves biometric data for a given transaction GUID (tguid).

### Method
GET

### Endpoint
/gbs-spid-server/remote-capture/biometrics/{tguid}

### Parameters
#### Path Parameters
- **tguid** (string) - Required - The transaction GUID for which biometrics are requested.

### Response
#### Success Response (200)
- **index** (integer) - Index of the biometric record.
- **content** (string) - Biometric content.
- **width** (integer) - Width of the biometric image.
- **height** (integer) - Height of the biometric image.
- **resolution** (integer) - Resolution of the biometric image.

#### Response Example
{
  "index": 0,
  "content": "string",
  "width": 0,
  "height": 0,
  "resolution": 0
}

#### Error Responses
- **400** - Bad Request - ErrorResponse
- **401** - Unauthorized - ErrorResponse
- **403** - Forbidden - ErrorResponse
- **404** - Not Found - ErrorResponse
- **409** - Conflict - ErrorResponse
- **415** - Unsupported Media Type - ErrorResponse
- **422** - Unprocessable Entity - ErrorResponse
- **500** - Internal Server Error - ErrorResponse
- **503** - Service Unavailable - ErrorResponse
```

--------------------------------

### Exemplo do arquivo config.properties

Source: https://docs.griaule.com/componentes-web/homescreenconfig.md

Arquivo de configuração completo para o GBS Apps. Os parâmetros entre < > devem ser substituídos pelos valores adequados, conforme aviso na documentação.

```properties
# **********************************************************************************************
#
#      /$$   /$$  /$$$$$$  /$$      /$$ /$$$$$$$$
#     | $$  | $$ /$$__  $$| $$$    /$$$| $$_____/
#     | $$  | $$| $$  \ $$| $$$$  /$$$$| $$
#     | $$$$$$$$| $$  | $$| $$ $$/$$ $$| $$$$$
#     | $$__  $$| $$  | $$| $$  $$$| $$| $$__/
#     | $$  | $$| $$  | $$| $$\  $ | $$| $$
#     | $$  | $$|  $$$$$$/| $$ \/  | $$| $$$$$$$$
#     |__/  |__/ \______/ |__/     |__/|________/
#
#       /$$$$$$   /$$$$$$  /$$$$$$$  /$$$$$$$$ /$$$$$$$$ /$$   /$$
#      /$$__  $$ /$$__  $$| $$__  $$| $$_____/| $$_____/| $$$ | $$
#     | $$  \__/| $$  \__/| $$  \ $$| $$      | $$      | $$$$| $$
#     |  $$$$$$ | $$      | $$$$$$$/| $$$$$   | $$$$$   | $$ $$ $$
#      \____  $$| $$      | $$__  $$| $$__/   | $$__/   | $$  $$$$
#      /$$  \ $$| $$    $$| $$  \ $$| $$      | $$      | $$\  $$$
#     |  $$$$$$/|  $$$$$$/| $$  | $$| $$$$$$$$| $$$$$$$$| $$ \  $$
#      \______/  \______/ |__/  |__/|________/|________/|__/  \__/
#
# **********************************************************************************************
# DATABASE (RDB)
jdbc.driverClassName=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://<rdb_ip>:3306/sphinx?useSSL=false
jdbc.username=<rdb_username>
jdbc.password=<rdb_encrypted_password>
jdbc.dialect=org.hibernate.dialect.MySQLDialect
jdbc.showSql=false

# **********************************************************************************************
# GBDS CONNECTION (& AUTHENTICATION LDAP ONLY)
gbds.url=http://<gbds_ip>:8085
gbds.user=<gbds_username>
gbds.key=<gbds_password>
gbds.logLevel=INFO
gbds.additionalHeaders={}
gbds.flushDebugRequests=false
gbds.timeout=300
gbds.listExceptions.labels=

# **********************************************************************************************
# GUI SETTINGS
home-screen.ip=<home_screen_ip>
home-screen.port=8128
home-screen.protocol=<protocol>
locale=en_us

# **********************************************************************************************
# OTHER SETTINGS
gbds.latent.search.url=null
gbds.proxy.url=null
gbds.proxy.port=0

keystore.path=<keystore_path>
keystore.password=<keystore_password>
truststore.path=<truststore_path>
truststore.password=<truststore_password>

# **********************************************************************************************
# SESSION SETTINGS
same.user.simultaneous.login=true
fingerprint.useSDK=false
image.convert.useJnbis=false
filter.people.pguid=ALL
faceQuality.qtdeMinErrors=2
session.expirationTime.server=8h
session.expirationTime.web=8h
notification.last.timestamp=15

ldap.url=http://<ldap_ip>:8082/
ldap.user=<ldap_username>
ldap.password=<ldap_password>
codeValidTime=10
deviceTime=6

# **********************************************************************************************
# EMAIL
email.host=smtp.gmail.com
email.host.port=587
email.from=<email_address>
email.password=<email_password>
email.python.path=python
email.use.script.python=true

profile.cacheSize=100
profile.cacheTime=5m
locale=pt_br
```
Tokens:
Raw