GBS CardScan is a web application that scans identification cards containing biometric data such as fingerprints, palmprints, faces, signatures, and textual biographical data and enrolls such data to the GBS biometric database. It employs customizable extraction fields, allowing operations with multiple card layouts.
This manual has been updated for CardScan version 1.1.0.
2. Access and Authentication¶
GBS CardScan must be accessed with a web browser. Google Chrome is the recommended choice. The URL for access is specific to each deployment; If necessary, contact Griaule support to obtain the correct URL.
Authentication is required to access the application. The credentials required by GBS CardScan are username and password.
3. User Interface¶
3.1. Home Screen¶
The home screen shows the main features of the application:
These are distributed in 3 groups: Request, List, and Edit. These features can also be accessed from the navigation bar at the top of the page.
This feature group is used to capture and enroll scanned cards with biometric, biographical, and label data. This can be performed in 3 ways: Unitary Card, Multiple on file cards, and Multiple on server cards.
3.2.1. Unitary Card¶
This request type is used to process a single form.
A unitary card request needs 4 parameters:
A free-form identifier for the request.
Scanning resolution of the image(s). For best results, this should be the same resolution as the selected layout.
The form layout used for interpreting the image. A thumbnail of the selected layout will be shown.
One or more images containing the scanned form. If the form has multiple pages and/or is double-sided, multiple images should be submitted, one per page.
After entering the parameters and submitting the images, the user can reorder the uploaded images to match the layout order by dragging the icons located on the left side of the screen. Images can also be deleted by clicking the “X” icon:
Click on Send request to send the image(s) to the server for processing.
To check the progress of the operation, go to List > Processes at the top menu.
3.2.2. Multiple on file cards¶
This request type is used to process an archive containing multiple scanned cards. This archive must be a single Zip file containing all the scanned images.
CardScan will process the files following the lexicographical order of their names. It is recommended to start each file name with numbers, to ensure a predictable processing sequence.
3.2.3. Multiple on server cards¶
This request type is used to process a list of files located on the server that runs the CardScan service. It will process the files following the lexicographical order of their names. It is recommended to start each file name with numbers, to ensure a predictable processing sequence. This request type is intended for large-scale data migration and may require administrator credentials on the server.
This feature group allows the user to list the profiles generated for enrollment when processing requests, to list submitted requests and inspect their status, and inspect operation logs.
This section shows a list of the existing profiles created by the system. It is possible to filter the list by process ID, profile ID, key, biographic, and/or status to locate specific profiles.
Clicking on a profile line shows the details of the selected profile such as the original card image(s) and the biometric images (fingerprints, palmprints, face, signature, etc.) extracted from the card.
On this page is also possible to edit textual fields obtained by OCR (optical character recognition), remove the profile, refresh the page and reprocess the profile info.
18.104.22.168. Editing OCR fields¶
In the profile details page the user can edit textual fields such as Biographics, Keys, and Labels by clicking on Edit:
After clicking on Edit, the profile fields become editable by the user. The profile fields are displayed as shown in the image below. The fields can be Keys, Biographics, or Labels. When the OCR is unable to extract the information of Biographics, Keys, or Labels from the scanned image, these should be manually entered with this option.
22.214.171.124. Sending the profile to GBDS¶
If the card was processed without errors, the button Send to GBDS will be enabled, allowing the user to submit the profile for enrollment in the GBS biometric database.
Once the profile is sent to GBDS, OCR fields can no longer be altered.
126.96.36.199. Profile status¶
All profiles have a status indicating its current situation. The profile status is often related to its process’s status. When a process has the Processing status, the profiles associated with it may have the following status values:
Segmentation in progress.
Error in the segmentation process.
Segmentation finished successfully, waiting for the user to send it to GBDS.
Once processing is complete, the profile status may assume other values:
Profile deleted before being sent to GBDS.
Profile workflow finished (enrollment in GBDS complete).
Error in the segmentation process.
Error processing the profile.
Ready to be sent to GBDS.
Sending to GBDS
Sending to GBDS.
Sent to GBDS
Successfully sent to GBDS
Successfully enrolled, can transition to Done.
Failure in GBDS enrollment.
Pending analysis (MIR)
Pending quality review.
Quality approved, can transition to Done.
Pending analysis (ETR)
Enrollment generated an exception, pending resolution in ETR.
Same biometrics (ETR)
ETR resolution: Same biometrics found (registration fraud).
Different biometrics (ETR)
ETR resolution: Different biometrics (update fraud).
ETR resolution: Recollect needed.
ETR resolution: approved in ETR, can transition to Done.
The processes section shows a list of existing processes and their details. The list also can be filtered by date, username, process ID, process name, process ID, and/or status.
Clicking on a process line opens a page with its details and options to reload the process information, show the associated profiles and process logs:
188.8.131.52. Process Status¶
Every process has a status indicating its current situation. It may assume the following values:
Process received and created.
Process being validated.
Detecting layout automatically.
Layout not detected
Error: Unable to detect layout.
Layout detection successful: Valid layout detected.
Ready to be segmented. Waiting for user validation.
Profiles generated successfully, the user may send them to GBDS.
Error in the process.
3.3.3. Operation Logs¶
The operation logs section shows a list of the existing operation logs and their details.
Unlike the previous lists, the operation logs do not offer a detailed view of each log entry.
This feature group allows the user to edit the application settings, as well as layouts and fields.
This section allows the user to change general configurations of the application:
It is possible to change the application theme from dark to light, the language, the date/time format, and the search type. These settings affect only the user interface, not the card processing operations.
This section shows a list of the existing layouts and allows the user to edit, clone, and remove them. Please notice that a layout can only be edited and deleted when there’s no process are associated with it.
Clicking on a layout in the list will open a page showing a preview of the highlighted areas:
This section shows a list of the existing fields that can be used as keys, biographics, or labels in layouts. It is possible to create, edit and remove these fields.
Clicking on New Field will open a dialog that allows the user to enter the details of the new field. The user should fill in the field name, description, input type, field type, mark it as required (or not), and as enabled (or not) for CardScan layouts.
When editing a field, the user is not allowed to change its name.
A layout is a representation of a specific model of biometric card. Each distinct card model should have a corresponding layout in the system.
In the following example, we can see the redacted fingerprints, sequence control, and biographic information of a person:
To create a corresponding layout, the user needs to specify the regions of the image where there is biometric, biographic, and label data.
4.1. Creating a new layout¶
To create a layout, click on New Layout:
The layout creation screen will be shown:
4.1.1. Import file or Acquire image¶
The first step in creating a layout is to import an image file to be used as its basis:
An important step is to specify the resolution of the imported image (given in dots per inch, dpi). The resolution can be manually set on the right sidebar:
The user can also click on Adjust resolution on the toolbar on the left side:
Select the desired unit of measurement and inform the distance that will be marked on the image:
In this example, the first (1) step informs 5 cm as the distance that will be marked on the image for measurement. The second step (2) is marking the distance on the image. After steps 1 and 2, the application will automatically inform the resolution (3), in this case: 354 dpi.
The minimum resolution allowed is 300 dpi.
The following information can be added to the layout:
A free-form identifier for the layout.
Description of the layout. A description of the layout (e.g.: “state records form, 1985-1993”)
The language the information is written on the cards.
4.1.3. Create region¶
Next, the user should specify one or more regions of the image that contain biometric, biographical, or label data.
In the tools menu, click on Extract region from rectangle tool:
Click and drag the mouse to define a rectangle, and then use the right sidebar to enter the details of the region:
It is possible to adjust the position and size of the region. In this screen, the user can also alter the following settings:
No rotation: no change in the region created
Rotate 90° Clockwise: rotate the created region by 90 degrees clockwise
Rotate 90° Anti-Clockwise: rotate the created region by 90 degrees anti-clockwise
Invert: 180° rotation
Fingerprint: choose this option if the region has fingerprints.
Palmprint: choose this option if the region has palmprints.
Signature: choose this option if the region has a signature.
Key: choose this option if the region has a key for this person. This key will be stored on the GBS database.
Biographic: choose this option if the region has biographic information for this person. This information will be stored on the GBS database.
Label: choose this option if the region has a label for this person. This label will be stored on the GBS database.
Fingerprint capture subtype:
Single Fingerprint: choose this option if the created region corresponds to a single finger capture.
Two Thumbs: choose this option if the created region corresponds to a capture of two thumbs.
Two Fingerprints: choose this option if the created region corresponds to a capture of two fingers.
Four Fingerprints: choose this option if the created region corresponds to a capture of four fingers.
This option is affected by the subtype. If the subtype is a single finger, the user should select the index of one finger. If the subtype is a two-finger, the user should inform the indexes of the two fingers.
Palmprint capture subtype:
Face capture subtype:
OCR (key): This option indicates a key field that will be interpreted by OCR (optical character recognition)
Barcode (key): This option indicates a key field that will be read as a barcode
OCR (biographic): This option indicates a biographic field that will be interpreted by OCR
Barcode (biographic): This option indicates a biographic field that will read as a barcode
OCR (label): This option indicates a label field that will be interpreted by OCR
Barcode (label): This option indicates a label field that will read as a barcode
When region creation is completed, the image will have the regions assigned as shown below:
To adjust any created region, click on it. Its details will be highlighted on the sidebar and a list of options will be shown: