> For the complete documentation index, see [llms.txt](https://docs.griaule.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.griaule.com/gbs/en/applications/controlpanelweb.md).

# Control Panel

## Introduction

The **GBS Control Panel** is an application developed to easily change GBDS configuration parameters. The Control Panel provides a visual interface where the user controls parameter values and compares current values with historical configuration values.

This manual is updated for version 1.3.1 of GBS Control Panel.

### Access and Authentication

You must access the Control Panel with a browser, and Google Chrome is recommended. The access URL is specific to each deployment. If necessary, contact Griaule support to obtain the correct URL for your environment.

Authentication is required to access the application. The credentials required for the Control Panel are username and password.

![login screen](/files/34db0d8ec473456798cca2215b53436b35d40180)

At the bottom of the screen, there is an option to change the language. This option is also available in settings after login.

### Simultaneous Logins and Browser Registration

Only one session per user is allowed. It is not possible to log in simultaneously with the same profile more than once in the application. If a user is already connected and another access occurs using the same username and password, the user with the older session will be notified and disconnected on the next action.

![](/files/f569ef3b48d1a119f73a4ff2dfd7ba7534e0dc7f)

In addition, only one browser can be used at a time. When trying to log in using a different browser, the user will be informed that the new browser must be authenticated. Authenticating a new browser will revoke access for the previous browser.

![](/files/cbf87bb6072f4fb81dfe34161dd19bff88ea3514)

To authenticate a new browser, click Authenticate and then enter the verification code that will be sent to the email address linked to the user's account.

![](/files/63648dbd6d74bdff5b79b2c3fbfc47a2c6824a76)

If authentication is successful, a notification will appear in the upper-right corner of the screen after login.

![](/files/47d6fd39b853bbf6bc01fa50a65f68d29d9f7739)

### Reset Password

You can reset your password if you forget it.

To reset your password, on the login screen, click Forgot your password?:

![](/files/e99147a65eb2d5392f10645b4b2824d393fb9a90)

Then enter the profile username and click Submit.

![](/files/8ef082db2c2850b61c5a97be74f5557510f3a30e)

An email containing a verification code will be sent to the email address linked to that profile. Enter the verification code and click Send code.

![](/files/5f65f9e71e81cfedb1599e881005cad1955de9ed)

If the code is correct, you will be able to create a new password. Enter the new password twice. Make sure you meet the password requirements; they are listed below the new password field and will turn green when met. Finally, to confirm the reset, click Reset password.

![](/files/8b5f7b3b56aa3c2dc85154a8927705d0e2982cc2)

## User Interface

### Main Screen

When you log in, the main Settings page is displayed.

![main screen](/files/dcd77d07b074c18f75cb798508e1b5cbf7751ecf)

This page shows the application name and the settings you can change. It is possible to access the History page and check the active version.

### Settings Panel

In the Settings page menu, you can see the Active Version and the parameter values for this version. You can also select an older version from the drop-down menu and check its values. The value verification procedure can also be done in the History tab.

On this page, you can change the current configuration parameters. To do so, enter the desired new values in the fields and click the Save button in the lower-right corner of the screen. It will change the parameters and update the version number.

{% hint style="info" %}
Both the Save and Discard buttons will be available only if some change has been made to the configuration parameters.
{% endhint %}

### History Panel

The History page allows you to compare configuration parameters between the various version changes of the desired application.

![history screen tab](/files/bc8c94c368a6d139478f0dc87e1de7e80b51746c)

On this page, you can compare the current version (marked with a green label) with a version selected from the drop-down menu. The list will show the versions being compared, the version's initial operation date, and the property values.

Properties with different values are highlighted in red, while properties with the same value will not be highlighted.

It is also possible to restore the configuration parameters from a previous version. To do so, select the desired version and click the Restore to version # button.

## GBDS Configuration Parameters

This section presents the parameters that the Control Panel can change in GBDS, relates their names to the configuration names in the configuration files, and explains their functionality.

* Face enroll minimum templates - Defines the minimum number of face templates required for the transaction to be processed.

  > Parameter name in GBDS: gbds.enroll.faces.min-nr-template
* Fingerprint enroll minimum templates - Defines the minimum number of fingerprint templates required for the transaction to be processed.

  > Parameter name in GBDS: gbds.enroll.fingerprints.min-nr-template
* Iris enroll minimum templates - Defines the minimum number of iris templates required for the transaction to be processed.

  > Parameter name in GBDS: gbds.enroll.iris.min-nr-template
* Newborn palmprint enroll minimum templates - Defines the minimum number of newborn palmprint templates required for the transaction to be processed.

  > Parameter name in GBDS: gbds.enroll.newborn-palmprint.min-nr-template
* Palmprint enroll minimum templates - Defines the minimum number of palmprint templates required for the transaction to be processed.

  > Parameter name in GBDS: gbds.enroll.palmprint.min-nr-template
* Fingerprint enroll minimum quality - Defines the minimum quality for a fingerprint enrollment transaction to not generate an exception.

  > Parameter name in GBDS: gbscluster.min.quality
* Turn on RDB system configuration on GBDS API - Enable system configuration by the relational database.

  > Parameter name in GBDS: gbds.rdbSystemConfiguration.api.enabled
* Fingerprint update verify threshold - Defines the minimum score to consider a fingerprint match in a 1:1 comparison in a search operation.

  > Parameter name in GBDS: gbscluster.enroll.fingerprints.verify.matchthreshold
* Face update verify threshold - Defines the threshold used when matching faces during a search operation.

  > Parameter name in GBDS: gbscluster.update.faces.verify.matchthreshold
* Fingerprint update minimum quality - Defines the minimum quality required for a fingerprint extraction to not generate an update exception.

  > Parameter name in GBDS: gbscluster.update.min.quality
* Fingerprint update minimum biometrics - Defines the minimum number of fingerprint biometric matches for an update operation to be accepted.

  > Parameter name in GBDS: gbscluster.update.minimum.fingers
* Face update exception enabled - Defines when facial images should be considered for generating update exceptions.

  > Parameter name in GBDS: gbscluster.update.consider.faces
* Fingerprint update exception enabled - Defines whether fingerprints should be considered for generating update exceptions.

  > Parameter name in GBDS: gbscluster.update.consider.fingerprints

## Settings

On this screen, there are four options for users to choose their preferences:

* Theme: **dark** or **light**;
* Language;
* Time format: **12-hour (AM/PM)** or **24-hour**;
* Date format: **dd/mm/yyyy**, **mm/dd/yyyy** or **yyyy/mm/dd**;

![settings screen](/files/6c9784ff4e431a537a98f00010d767d6463f9c28)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.griaule.com/gbs/en/applications/controlpanelweb.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
