Biometric User Guide - 14072023
Biometric User Guide - 14072023
i
Version 2, July 2023
ii
Table of contents
List of Figures 2
1. Introduction 3
1.1 Overview 3
1.2 Rationale 3
1.3 Objective 3
2. Installation of Biometric Components 3
2.1 Redistributable Software 3
2.2 Device drivers 5
2.2.1 Installing ZKTeco drivers 5
2.2.2 Installing SecuGen fingerprint device drivers 7
3. Biometric Module Setup 8
3.1 Biometric Central Level Activation 9
3.2 Biometric Facility Level Activation 9
3.3 BRA Facility Server Setup 10
3.4 BRA Client Setup 12
4 Client Biometric Registration 15
4.1 Existing Client Biometric Registration 15
4.1.1 How to Register fingerprints at CTC 15
4.1.2 How to Register biometry at Dispensing area 17
4.2 New client Biometric Registration 21
4.3 Client Biometric Attendance/Verification 21
5 Biometric Dashboard 23
5.1 Facility Biometric Fingerprint Dashboard 23
5.2 Central Biometric Fingerprint Dashboard 25
5.2.1 Overall biometry quick summary 25
5.2.2 Overall biometry detailed summary 26
5.2.3 Overall biometry performance summary 27
6 Annexes 30
6.1 License Deactivation 30
6.1.1 Client Application License 30
6.1.2 Server License 32
6.2 FAQ 33
1
List of Figures
Figure 1: Run as administrator ...................................................................................................................... 4
Figure 2: Redistributable installation process............................................................................................... 4
Figure 3: ZKTeco setup .................................................................................................................................. 5
Figure 4: ZKTeco Installation progress .......................................................................................................... 6
Figure 5: Run as administrator ...................................................................................................................... 7
Figure 6: SecuGen WBF Driver ...................................................................................................................... 7
Figure 7: SecuGen Installation progress ....................................................................................................... 8
Figure 8: Biometric facility activation ........................................................................................................... 9
Figure 9: Biometric module menu .............................................................................................................. 10
Figure 10: Facility not activated notification .............................................................................................. 10
Figure 11: BRA Setup menu ........................................................................................................................ 11
Figure 12: Activating facility server license ................................................................................................. 11
Figure 13: Biometric module configuration II ............................................................................................. 12
Figure 14: Client application setup window ............................................................................................... 12
Figure 15: Activating Client License ............................................................................................................ 14
Figure 16: Biometric Registration at reception page .................................................................................. 16
Figure 17: Fingerprint icon .......................................................................................................................... 16
Figure 18: Fingerprint Capturing page ........................................................................................................ 16
Figure 19: Fingerprint client Details ............................................................................................................ 17
Figure 20: Client’s reference codes............................................................................................................. 17
Figure 21: Dispensing Register Data entry page ......................................................................................... 18
Figure 22: Identification not Match ............................................................................................................ 18
Figure 23: NO FACILITY MATCH for Client window ..................................................................................... 19
Figure 24: Fingerprint pattern failed error ................................................................................................. 19
Figure 25: Finger selection .......................................................................................................................... 20
Figure 26: Fingerprint Identification failed window ................................................................................... 20
Figure 27: Dispensing register details ......................................................................................................... 21
Figure 28: Patient registration entry........................................................................................................... 21
Figure 29: Biometric verification window ................................................................................................... 22
Figure 30: Rejection confirmation popup ................................................................................................... 22
Figure 31: De-attach existing fingerprint .................................................................................................... 23
Figure 32: Facility Dashboard...................................................................................................................... 24
Figure 33: Overall Biometry Quick Summary .............................................................................................. 26
Figure 34: Overall Biometry Detailed Summary ......................................................................................... 27
Figure 35: Overall Biometry Performance Summary .................................................................................. 28
Figure 36: Facilities Biometry Summary ..................................................................................................... 29
Figure 37: Run as Administrator ................................................................................................................. 30
Figure 38: Login credentials ........................................................................................................................ 31
Figure 39: Licensing..................................................................................................................................... 31
Figure 40: Deactivate .................................................................................................................................. 32
Figure 41: Locate LIC file ............................................................................................................................. 32
Figure 42: Pasted LIC File ............................................................................................................................ 32
Figure 43: Server license on client application ........................................................................................... 33
2
1. Introduction
1.1 Overview
Biometric module has been incorporated into the CTC2 database to perform client
registration, verification and identification by using fingerprint. This module cuts across
several other modules including the CTC2 module and Pharmacy module. The
biometric module generates several reports and visualization which can be accessed on
Biometric dashboard.
1.2 Rationale
The HIV program in the country is facing limitations in the following aspects;
i. Managing duplicates in HIV cases
ii. Confirming the actual rate of lost to follow-up cases
iii. Determining the actual rate of client retention
iv. HIV client information disclosure
The limitations above can be solved by biometric identification system for all clients in
the HIV continuum of care.
1.3 Objective
The main objective of introducing biometric registration is to improve unique
identification of clients, quality of services and data in HIV service delivery points in
Tanzania.
3
Figure 1: Run as administrator
NOTE: After completing installation of ‘Redistributable’ software, you MUST restart your
computer for these configurations to take effect, before installation of fingerprint scanner
device drivers.
4
2.2 Device drivers
These are computer programs that operate or control a particular type of device that is
attached to a computer. Since CTC2 database can use any type of fingerprint scanner,
each will use its own provided drivers. This section explains the installation steps of
drivers for biometric devices supported by neurotechnology. To know the list of
biometric supported devices, open this link List of supported fingerprint readers and
sensors with their properties (neurotechnology.com).
Before installation, identify your device’s brand and then install its corresponding
drivers. Below are examples for installation of fingerprint scanners for two device
models: ZKTeco, and SecuGen.
2.2.1 Installing ZKTeco drivers
1. Navigate to ZKTeco device drivers’ folde, Right-click on the executable setup file
then ‘Run as administrator’ as shown below.
2. Click ‘Yes’ to allow the application to make changes for the application to start
installing.
5
Figure 4: ZKTeco Installation progress
6
2.2.2 Installing SecuGen fingerprint device drivers
1. Navigate to the ‘Device Drivers’ folder, Right-click on the executable setup file then
‘Run as administrator’
7
Figure 7: SecuGen Installation progress
8
Biometrics activation is performed at two levels: Centrally and at facility.
3.1 Biometric Central Level Activation
Central level activation is performed by first getting authorization from NACP to activate
your facility. Regional staff in collaboration with their Implementing Partners have to
send an email requesting this authorization from NACP. After this request has been
approved, the facility will be activated at Central level.
3.2 Biometric Facility Level Activation
This section allows the user to enable the facility to use the biometric fingerprint module.
Follow the below steps for activating a facility to use biometrics:
1. Click on the ‘Biometric Module’ button from the home page of the CTC2
Database.
2. Click Biometric Registration Assistant Setup.
3. Click Biometric Facility Activation and confirmation message will appear, click
Yes and the facility will successfully be activated.
9
4. After the facility has been activated, “Log off”, then “Login” again for the
configurations to take effect, then other biometrics menu will be accessible.
Note: Facilities which have not yet received authorization from NACP to start using
Biometrics, they will receive a message informing them that the facility has not yet been
activated.
10
Figure 11: BRA Setup menu
ii. Fill in the fields “License Mode”,” Serial No” and proceed to activate the license
as it is done in the client license setup section.
11
3.4 BRA Client Setup
This section allows the setup of fingerprint scanning device to be used, and client
application license activation.
12
Things to Note:
i. The configuration window is set to be active for a maximum of 3 minutes for each
session opened. After these 3 minutes, the setup windows have to be closed and
opened again.
ii. Auto scan on form start-up: This feature enables automated fingerprint scanning
when the client verification/identification window is opened, otherwise user will
need to click “Scan Finger” to initiate the fingerprint scanning process. This is an
optional feature to use depending on user experience.
iii. Allow biometric specifications override: This feature allows a change of fingers
which can be scanned when the “client identification/verification” window is
opened by user. This allows a change of fingers which can be scanned outside
those identified in the biometrics SOP. In case the button to allow biometry,
specification override is not checked and the admin cannot check it, then
navigate to “Utilities” module, find the “Allow Biometrics Specifications Override”
button, click it to allow the override.
iv. Biometric Device: Device selected in this section should be the one connected
with computer.
v. Biometric Device SDK Compatibility: Select ZKFinger SDK if used fingerprint
scanner is from ZKTeco Manufacturer, and select Neurotechnology for any other
type of fingerprint scanner.
Client Licensing
The client computer needs a license key in order to facilitate fingerprint template
generation. To obtain the key, click on the “Licensing” tab and request the serial number
as shown below.
Note: The configuration window is set to be active for a maximum of 3 minutes for each
session opened. Also, to activate the licence Internet access is required.
13
Figure 15: Activating Client License
Note:
i. For standalone computer, it means BRA client and server exist in one computer,
follow procedure BRA Facility Server Setup followed by BRA Client Setup.
ii. For a separate facility server (server only) follow procedure BRA Facility Server
Setup.
iii. For a separate client computer (client only) follow procedure BRA Client Setup.
iv. To activate the licence Internet access is required.
14
v. In the case of a mobile computer serving multiple facilities, the BRA facility
server setup and the BRA client setup are only required to be done once,
regardless of the number of facilities being served.
vi. During license activation, user might receive error message informing that
license file has been used many times, in case this happens, follow the following
steps.
a. For client application license Go to
C:\NACP\BRA\BRAClient\Neurotechnology\Licenses\ and for facility
server license Go to
C:\NACP\CTC2WebExtension\Neurotechnology\Licenses.
b. Delete RequestedSerialNo.rsn file.
c. Open the Biometrics licensing tab again, and right click to request a new
license.
d. Repeat this process until you receive an unutilized license file with a “.lic”
extension.
15
Figure 16: Biometric Registration at reception page
2. Press left followed by right index finger on the fingerprint capturing device.
After saving client biometric information facility reference code will be generated locally.
The central reference will be generated if there is active internet connection. The codes
will be displayed at the bottom of the registration forms.
17
Figure 21: Dispensing Register Data entry page
Note 1:
i. If client’s fingerprint is successfully captured, matching will be done at facility
server and central server if there is internet connectivity.
ii. If there is no internet connectivity, matching will be done against other fingers
stored at facility server only. Offline saved fingerprints will be automatically
uploaded to the central server if there is an internet connection.
iii. NO MATCH FOUND; displays when the client fingerprint identification does not
match with any stored fingerprints in facility and central web server.
iv. NO FACILITY MATCH for Client; displays when the client fingerprint
identification does not match with any stored fingerprints in the facility server in
absence of internet connection.
18
Figure 23: NO FACILITY MATCH for Client window
Note 2:
If the device failed to detect the clients finger pattern, error will be displayed and you will
need to click OK and recapture the fingerprint.
Note 3:
If the client’s index finger has defect (deformity, no finger, no pattern), on the specific
hand select alternative finger in the order; thumb, middle, ring, pinky fingers.
For a client with one palm select two fingers from the existing palm to scan, follow order
as above.
19
Figure 25: Finger selection
Note 4:
If the fingerprint capturing session expired, error will be displayed and you will need to
click OK and recapture the fingerprint.
20
4.2 New client Biometric Registration
This registration part includes clients who have not been registered in the CTC2
database. The clients include; On Transit (OT), Transfer In (TI) without fingerprint and
newly enrolled into care and treatment services.
How to Register:
Step 1: Enter clients’ details.
On Transit client’s information will be entered on the dispensing register in the
pharmacy module.
The Transfer in and newly enrolled client’s information will be entered on patient
registration form in the CTC2 module.
21
Figure 29: Biometric verification window
22
Note:
5 Biometric Dashboard
This section shows visualization, gives access to reports and status of clients enrolled
into biometric registration Assistant system. There are two biometric fingerprint
dashboards, Facility and Central biometric fingerprint dashboard.
5.1 Facility Biometric Fingerprint Dashboard
The dashboard shows visualization and gives access to report at the facility level. The
dashboard can be accessed with health care provider at the facility without internet
connectivity.
How to navigate to facility Dashboard
23
Go CTC2 main menu Click on Biometric module Click on Biometric
Registration Assistant dashboard.
24
Care - CURR visited without biometry: This includes total number of clients receiving
care visited but their fingerprints were not captured.
Total Clients: This includes all registered clients in CTC and Pharmacy modules.
Clients with Biometric registration: This includes cumulative number of clients with
biometric at the facility.
Clients without Biometric registration: This includes all registered clients in CTC and
Pharmacy modules without biometric at the facility.
Clients with central reference code: These are clients assigned with reference code
at the central server after been processed.
Clients without central reference code: Includes clients not assigned with reference
code at the central server after been processed.
Duplicate clients: All clients whose captured fingerprints matched with one or more
clients.
25
Figure 33: Overall Biometry Quick Summary
26
Figure 34: Overall Biometry Detailed Summary
27
Figure 35: Overall Biometry Performance Summary
28
Figure 36: Facilities Biometry Summary
29
6 Annexes
6.1 License Deactivation
In situations where it is necessary to deactivate a license installed on a specific facility
computer, the process details the following environment/conditions:
1. Prior to formatting the computer where the license is currently installed.
2. The facility no longer has a need for utilizing the computer that holds the license.
2. Click yes.
3. Login to the desktop application with the provided credentials.
30
Figure 38: Login credentials
5. Right click on the license then click Deactivate (Note: You need to be online when
deactivating the license).
31
Figure 40: Deactivate
32
Note 1: Server license cannot be disabled in the web, copying and pasting the LIC file
enabled the deactivation to be done on the client application side.
Note 2: Both the client and server license when deactivated will automatically be moved
to the archive folder.
Which client’s finger is required to be used? The client's index finger on both the left and
right hands.
Which finger should be used once the The client's other fingers will be used in the
client's index finger or fingers are deformed sequence starting with the thumb, middle
or client has no hand? finger, ring finger, or little/pinky finger of the
particular hand.
What should be done once the client The index finger and thumb of the available
doesn't have one hand? hand will be registered.
What should be done once the client Fingerprints won't be taken to such a client.
doesn't have both hands?
If a client's fingerprints are taken at the No, the client's fingerprints will only be taken
CTC, will they be required to taken at one point only on the particular day
fingerprints at the Pharmacy also on the
same day?
Will fingerprints enable a client to receive NO, fingerprints will just enable the facility to
care at another facility without their CTC1 identify the client but the clients is required
card? to have their CTC1 card during the visit at
the new facility or a transfer form for the
Transfer In clients.
What should be done when the client's Reject the displayed information and save
fingerprints match with another clients’ the new information
information?
Should I be connected to the internet so as No. The internet will be required only while
to access the biometric system? sending the clients information to the Central
server. It is advised to connect to the internet
at least once a day and particularly during
registration of Transfer in and On transit
clients
For the outreach/community clients, will Such client's fingerprints will be taken once
they be taken their fingerprints? they visit the facility.
34