1. No category

Fingerprint Component Functional Specifications
for SSID Card Registration Software
Version History
Version No.
Prepared By
Description
Date
Action
0.1
NIC
Draft
07/05/2015
Updated
Fingerprint Component Functional Specifications v1.0
Index
Notes........................................................................................................................................... 3
Scope .......................................................................................................................................... 3
Initialize Fingerprint Scanner ........................................................................................................ 4
Enrol Fingerprint .......................................................................................................................... 4
Verify Fingerprint ......................................................................................................................... 5
Release Fingerprint Scanner ......................................................................................................... 5
Flow Chart of functions ................................................................................................................ 7
Appendix A : Error Messages ........................................................................................................ 8
Certification ................................................................................................................................. 8
SSID Card Registration System | Ministry of Labour and Employment
2
Fingerprint Component Functional Specifications v1.0
SCOPE
This document lists the functional specifications of the fingerprint component to be developed for
SSID Card Registration Software developed by MoLE. The fingerprint component will enable the
service providers to integrate their Fingerprint Scanners with the software. The Fingerprint Scanners
Capture & Provide the Image and minutia template as per UID ISO standards.
This document describes the functions required in the component for capturing of fingerprint and
error handling.
NOTES



Fingerprint Component should be developed in C#.Net and compatible to .Net Framework 3.5. It
should be in the form of Dynamic Linked Library [DLL] which can be used by the host EPI
Software.
The namespace of Printing Component should be SSID64KLibrary and class name should be
FingerprintComponent. The class and methods should be made public.
The name of DLL should be SSIDFPComponent.dll
SSID Card Registration System | Ministry of Labour and Employment
3
Fingerprint Component Functional Specifications v1.0
LIST OF FUNCTIONS AND THEIR SPECIFICATIONS
1. Initialize Fingerprint Scanner
Function Name
InitializeFPScanner
Definition
public bool InitializeFPScanner (ref string errorMessage)
Arguments
errorMessage: If there is an error, appropriate message should be assigned
to this variable.
Description
This function should check for fingerprint scanner availability and
initialize/connect the fingerprint scanner, if available. Initialization may
include creating handle for fingerprint scanner, starting communication
channel, etc.
Return Value
If the function is successfully executed, it should return True, else False with
the appropriate error assigned to reference variable errorMessage. Please
refer Appendix A for list of common errors.
2. Enrol Fingerprint
Function Name
EnrolFingerprint
Definition
public bool EnrolFingerprint (System.Windows.Forms.PictureBox
pictureBox, System.Windows.Forms.Label statusLbl, ref Image
fingerprintImage, ref byte[] fingerprintMinutia, ref string errorMessage)
pictureBox: The pictureBox from the host application will be passed to this
variable. This pictureBox should be used to display the enrolling fingerprint
by the DLL.
Arguments
statusLbl: The Label object from the host application will be passed to this
variable. The fingerprint component should use it to display the
status/notification/score of fingerprint.
fingerprintImage: This is a reference variable to which the enrolled
fingerprint’s image will be assigned. This image has to be the final image
which is enrolled.
SSID Card Registration System | Ministry of Labour and Employment
4
Fingerprint Component Functional Specifications v1.0
fingerprintMinutia: This is a reference variable to which the enrolled
fingerprint’s Minutia will be assigned. This Minutia has to be the in Byte
with UID ISO format which is enrolled.
errorMessage: If there is an error, appropriate message should be assigned
to this variable.
Description
This function should make sure that the fingerprint device is initialized and
then start the fingerprint enrolment. The number of times the fingerprint is
to be captured for enrolment may vary depending on device. This needs to
be taken care by the FingerprintComponent.
Return Value
If the function is successfully executed, it should return True, else False with
the appropriate error assigned to reference variable errorMessage. Please
refer Appendix A for list of common errors.
3. Verify Fingerprint
Function Name
VerifyFingerprint
Definition
public bool VerifyFingerprint (System.Windows.Forms.PictureBox
pictureBox, System.Windows.Forms.Label statusLbl, ref Image
fingerprintImage,ref byte[] fingerprintMinutia, ref string errorMessage)
pictureBox: The pictureBox from the host application will be passed to this
variable. This pictureBox should be used by the DLL to display the
fingerprint which is being captured for verification.
statusLbl: The Label object from the host application will be passed to this
variable. The fingerprint component should use it to display the
status/notification/score of fingerprint.
Arguments
fingerprintImage: This is a reference variable to which the fingerprint’s
image will be assigned. This image will be used for verification by the host
application.
fingerprintMinutia: This is a reference variable to which the fingerprint’s
Minutia will be assigned. This Minutia will be used for verification by the
host application.
errorMessage: If there is an error, appropriate message should be assigned
to this variable.
SSID Card Registration System | Ministry of Labour and Employment
5
Fingerprint Component Functional Specifications v1.0
Description
This function should make sure that the device is initialized and then start
the fingerprint capturing for verification. The function will not have to verify
any fingerprint; just capture the fingerprint image which can be used for
verification by the host application. Some devices may have different
parameters to capture the fingerprint for verification.
Return Value
If the function is successfully executed, it should return True, else False with
the appropriate error assigned to reference variable errorMessage. Please
refer Appendix A for list of common errors.
4. Release Fingerprint Scanner
Function Name
ReleaseFPScanner
Definition
public bool ReleaseFPScanner (ref string errorMessage)
Arguments
errorMessage: If there is an error, appropriate message should be assigned
to this variable.
Description
This function should disconnect the fingerprint scanner, release handle; if
any and free all resources occupied by the FingerprintComponent DLL
Return Value
If the function is successfully executed, it should return True, else False with
the appropriate error assigned to reference variable errorMessage. Please
refer Appendix A for list of common errors.
SSID Card Registration System | Ministry of Labour and Employment
6
Fingerprint Component Functional Specifications v1.0
Flow Chart of functions
InitializeFPScanner
On Error
EnrolFingerprint
On Error
Error Message
On Error
Error Message
ReleaseFPScanner
VerifyFingerprint
On Error
Error Message
Where does it go in case of Error message, does it allow indefinite tries or should we
define a max limit before they need to try with another finger?
SSID Card Registration System | Ministry of Labour and Employment
7
Fingerprint Component Functional Specifications v1.0
Appendix A : Error Messages
List of common fingerprint scanner errors are stated below. These are minimum errors
which need to be returned by the fingerprint component. Any other error not listed below
and specific to a fingerprint scanner, should be mandatorily returned by the fingerprint
component.
Error No.
1
2
3
4
5
6
Error Message
Fingerprint scanner is not connected
Fingerprint scanner’s surface is not clean
Error while capturing fingerprint for enrolment
Error while capturing fingerprint for verification
Error while disconnecting fingerprint scanner
Fingerprint capture timeout
Note: The above error mechanism will help identify the error on field which will improve the
overall efficiency.
Certification
The component has to be tested and signed by MoLE before it can be used with
Application.
SSID Card Registration System | Ministry of Labour and Employment
8