BCC Services Configuration

Introduction

This document describes the configuration parameters of BCC Services, their options and default values.

File Location

In the default installation, the configuration file (bcc-services.properties) will be located in C:\Griaule\BCC\conf.

Properties

The configuration file must follow some requirements to be interpreted correctly. These requirements are:

1. The name and location of the file must be exactly as mentioned in this manual;

   Invalid configuration parameters will be ignored and a default value will be used.

2. There must be exactly one configuration parameter per line;

3. Each configuration parameter must be in the format {parameter}={value}, without line breaks;

Configuration Parameters

This section describes the configuration parameters that can be listed in the file bcc-services.properties and how they affect the system's operation.

useFingerprintQualityLib

This parameter defines whether the fingerprint quality library should be used in rolled captures.

Possible Values:

• true

• false

useFingerprintSDKAsService

This parameter defines whether the Fingerprint SDK should be used as a separate service.

This parameter applies only to the 32-bit version.

Possible Values:

• true

• false

reinitializeSDKOnCapture

This parameter defines whether the application will reinitialize the Fingerprint SDK on each capture.

Possible Values:

• true

• false

useChecksum

This parameter defines whether checksum should be used to import and export files.

Possible Values:

• true

• false

useCryptography

This parameter defines whether encryption should be used to import and export files.

Possible Values:

• true

• false

distance.crop.face

This parameter defines the resolution of the width and height of the cropped face.

Possible Values:

• CROP_480X640

• CROP_1200X1600

templateFormat

This parameter defines the format in which templates should be exported.

Possible Values:

• ANSI

• ISO

• CLASSIC

• DEFAULT

• FORENSIC

• GR001

• GR002

• GR003

• GR006

• GR007

useLabels

This parameter defines whether the labels will be sent to GBDS.

Possible Values:

• true

• false

enroll.labels

This parameter defines which labels will be sent to GBDS when useLabels is set to true. A maximum of six labels can be defined, these labels must be separated by commas.

Example:

enroll.labels=label1,label2,label3,label4,label5,label6

report.folder.path

This parameter defines the folder path to automatically save reports.

ebts.exporting.enabled

This parameter defines whether EBTS exporting will be enabled for BCC Services.

Possible Values:

• true

• false

ebts.exporting.path

This parameter defines the path where the exported EBTS files will be located.

ebts.ori

This parameter defines the issuer code of the EBTS file.

gbds.keyStore.path

Path to the keystore file. This parameter is required if the application is communicating with GBDS over SSL.

gbds.keyStore.password

Encrypted keystore password file. This parameter is required if the application is communicating with GBDS over SSL.

gbds.trustStore.path

Path to the truststore file. This parameter is required if the application is communicating with GBDS over SSL.

gbds.trustStore.password

Encrypted truststore password file. This parameter is required if the application is communicating with GBDS over SSL.

config.generalTabOnly

This parameter, when set to true, will list only the General tab in the BCC Services settings tabs, hiding others.

Possible Values:

• true

• false

responsible.fytech.quality

This parameter defines the minimum quality threshold for fingerprint captures of the person responsible for the baby when using the Fytech sensor.

baby.palm.fytech.quality

This parameter defines the minimum quality threshold for baby palm print captures when using the Fytech sensor.

Default Value:

65

capture.baby.fingerprints

This parameter defines whether the baby's fingerprint should be captured.

Possible Values:

• true

• false

baby.finger.fytech.quality

This parameter defines the minimum quality threshold for baby fingerprint captures when using the Fytech sensor.

fytech.timeout

This parameter defines the timeout when using the Fytech sensor.

Default Value:

20

save.baby.palms.as.png

This parameter defines whether the baby's palm prints should be saved in .png format.

Possible Values:

• true

• false

bodyImageShapes

This parameter defines how the selection of the body part for auxiliary images will be. There are two possible values, simplified and full. Simplified will select an entire area (for example, arm), and full will give the user the possibility to select more areas of an anatomical part with more specific names.

Possible Values:

• true

• false

minimun.biometrics

This parameter defines the minimum number of biometrics required to perform an enroll.

minimum.real.captured.fingers

This parameter defines the minimum number of fingers without anomaly required to perform an enroll.

maximum.anomalies

This parameter defines the maximum number of fingers with anomalies accepted in an enroll operation.

application.modules

This parameter defines which application modules are installed. This parameter can contain more than one value which must be separated by spaces.

Possible Values::

• FACE

• SIGNATURE

• PALM

• AUXILIARY_IMAGES

• IRISES

Example:

application.modules=FACE SIGNATURE PALM

match.sequence

This capture defines whether the capture of individual fingerprints should be compared with the sequence control capture.

Possible Values:

• true

• false

face.camera.type

This parameter defines which type of camera the application will use for face captures.

Possible Values:

• WEBCAM

• CANON_EOS

• CANON_POWERSHOT

face.webcam.device

This parameter defines the index of the webcam that will be used for face capture. If there is only one webcam installed, this number should be 0.

face.flash.mode

This parameter defines whether the flash function will be enabled or not for face capture.

Possible Values:

• ON

• OFF

This parameter only works with Canon Powershot cameras.

face.camera.rotation

This parameter defines the rotation of the image obtained by the face capture device.

Possible Values:

Any integer number of 0 a 359.

body.camera.type

This parameter defines which type of camera the application will use to capture the body.

Possible Values:

• WEBCAM

• CANON_EOS

• CANON_POWERSHOT

body.webcam.device

This parameter defines the index of the webcam that will be used for body capture. If there is only one webcam installed, this number should be 0.

body.flash.mode

This parameter defines whether the flash function will be enabled or not for body capture.

Possible Values:

• ON

• OFF

This parameter only works with Canon Powershot cameras.

body.camera.rotation

This parameter defines the rotation of the image obtained by the body capture device.

Possible Values:

Any integer number of 0 a 359.

capture.type

This parameter defines the type of capture for individual fingerprints.

Possible Values:

• FLAT

• ROLLED

signature.type

This parameter defines which Topaz signature device will be used to capture signatures.

Possible Values:

• SignatureGem1X5

• SignatureGem4X5

• SignatureGemLCD

• SignatureGemLCD4X3New

• SignatureGemLCD4X5

• ClipGem

• ClipGemLGL

signature.device

This parameter defines the brand of the signature device that will be used.

Possible Values:

• WACOM

• TOPAZ

• MSP

• SIGNOTEC

signature.imageType

This parameter defines in which image format the signature will be saved.

Possible Values:

• JPEG

• TIFF

• PNG

iris.device

This parameter defines which iris device will be used.

Possible Values:

• CROSSMATCH

• IRITECH

• HUMMINGBIRD

advance.mode

This parameter defines the advancement after a capture. If set to automatic the BCC Services will advance to the next capture after each capture. If configured as semi-automatic, it will show a screen with the capture to the operator and it will be necessary to manually advance the capture.

Possible Values:

• AUTOMATIC

• SEMI_AUTOMATIC

sequenceControl.type

This parameter defines which type of sequence control will be used. It is possible to configure for 4-4-2, 2-2-1 or no sequence control capture.

Possible Values:

• CTRL_221

• CTRL_442

• NONE

minQuality

This parameter defines the minimum percentage of finger template quality for the capture to be accepted.

Possible Values:

Any integer number in the range of 0 a 100.

triesToAccept

This parameter defines the number of attempts allowed to accept low quality finger templates.

whiteBalance.mode

This parameter defines the white balance mode option when using a professional camera.

Possible Values:

• AUTO

• CUSTOM

whiteBalance.blueAmber

This parameter defines the blue-amber offset of the white balance when custom mode is activated.

Possible Values:

Any integer number in the range of -9 a 9.

whiteBalance.greenMagenta

This parameter defines the green-magenta offset of the white balance when custom mode is activated.

Possible Values:

Any integer number in the range of -9 a 9.

processLiveView

This parameter defines whether brightness, contrast and zoom should be processed in Live View.

This parameter only works with Canon EOS cameras.

Possible Values:

• true

• false

nfiq.minimum

This parameter defines the minimum NFIQ quality value to accept a capture.

NFIQ quality is an integer number in the range of 1 to 5 and a lower number represents better quality.

nfiq.action

This parameter defines the action that BCC will take if the capture is above the minimum nfiq quality. KEEP will keep the capture, REMOVE will remove the capture.

Possible Values:

• KEEP

• REMOVE

nfiq.anomaly

This parameter defines how BCC will classify a capture that was kept when the NFIQ capture was above the minimum.

Possible Values:

• NONE

• LOW_QUALITY

• AMPUTED

• SCAR

• MARK

• BANDAGED

• The types of anomalies are:

theme

This parameter defines the BCC theme.

Possible Values:

• DARK

• LIGHT

theme.color

This parameter defines the theme color of the BCC.

Possible Values:

• BLUE_GRAY

• BLUE

• BROWN

• CYAN

• DEEP_PURPLE

• GREY

• INDIGO

• LIGHT_GREEN

• ORANGE

• PINK

• RED

• TEAL

cropImages

This parameter defines whether BCC should crop fingerprint captures and image exports. If false, the image will remain as obtained by capture/profile.

Possible Values:

• true

• false

jpegQuality

This parameter defines the quality of all .jpeg images generated or manipulated.

Possible Values:

Any integer number in the range of 0 a 100.

signatureBitDepth

This parameter defines the bit depth of the signature image.

Possible Values:

• GREYSCALE (8-bit)

• COLOR (24-bit)

anomalySetType

This parameter defines the type of anomaly selection that can be classified by the user in BCC. There are two possible values, simplified and technical.

Simplified will have more generic values like AMPUTATED, SCAR, DAMAGED MARK.

The technical will have more specific values for the anomaly, allowing the user to select the cause of the anomaly.

Possible Values:

• SIMPLIFIED

• TECHNICAL

fingerVerifyThresold.<finger>

This parameter allows the user to set a verification threshold for individual fingers.

Each finger can have its threshold. For each finger, this parameter must be repeated with the finger name.

This parameter is valid for the FINGER and will be applied to the finger on BOTH HANDS.

Example:

fingerVerifyThresold.little=15

fingerVerifyThresold.ring=15

fingerVerifyThresold.middle=15

fingerVerifyThresold.index=15

fingerVerifyThresold.thumb=15

fingerVerifyThresold.default

This parameter allows the user to set the global verification thresholds for fingerprints.

If no individual threshold is used, the default threshold will be used.

faceVerifyThresold.default

This parameter defines the face verification threshold.

sequence221

This parameter defines the capture order for the 2-2-1 sequence control. Each finger is delimited by space and the capture is delimited by comma.

Possible Values:

Finger names or finger indexes can be used as values, as shown below:

Finger Name	Index
left_little	0
left_ring	1
left_middle	2
left_index	3
left_thumb	4
right_thumb	5
right_index	6
right_middle	7
right_ring	8
right_little	9

Example:

To set the following capture sequence:

• Left little and ring

• Left middle and index

• Left thumb

• Right little and ring

• Right middle and index

• Right thumb

The parameter must be one of the two options:

sequence221=LEFT_LITTLE,LEFT_RING LEFT_MIDDLE,LEFT_INDEX LEFT_THUMB RIGHT_RING,RIGHT_LITTLE RIGHT_INDEX,RIGHT_MIDDLE RIGHT_THUMB

sequence221=0,1 2,3 4 8,9 6,7 5

sequence442

This parameter defines the capture order for the 4-4-2 sequence control. Each finger is delimited by space and the capture is delimited by comma.

Possible Values:

Finger names or finger indexes can be used as values, as shown below:

Finger Name	Index
left_little	0
left_ring	1
left_middle	2
left_index	3
left_thumb	4
right_thumb	5
right_index	6
right_middle	7
right_ring	8
right_little	9

Example:

To set the following capture sequence:

• Left little, ring, middle and index

• Right little, ring, middle and index

• Left thumb and right thumb

The parameter must be one of the two options:

sequence442=LEFT_LITTLE,LEFT_RING,LEFT_MIDDLE,LEFT_INDEX RIGHT_INDEX,RIGHT_MIDDLE,RIGHT_RING,RIGHT_LITTLE LEFT_THUMB,RIGHT_THUMB

sequence442=0,1,2,3 6,7,8,9 4,5

sequenceMain

This parameter defines the capture sequence of individual fingerprints. Each fingerprint capture is delimited by a space.

Possible Values:

Finger names or finger indexes can be used as values, as shown below:

Finger Name	Index
left_little	0
left_ring	1
left_middle	2
left_index	3
left_thumb	4
right_thumb	5
right_index	6
right_middle	7
right_ring	8
right_little	9

Example:

To set a capture sequence, enter the indices or finger names as shown below:

sequenceMain=LEFT_LITTLE LEFT_RING LEFT_MIDDLE LEFT_INDEX LEFT_THUMB RIGHT_THUMB RIGHT_INDEX RIGHT_MIDDLE RIGHT_RING RIGHT_LITTLE

sequenceMain=0 1 2 3 4 5 6 7 8 9

sequencePalm

This parameter defines the capture sequence for palm capture. Each palm capture is delimited by a space.

Possible Values:

Palm Area	Index
left_interdigital	31
left_thenar	32
left_hypothenar	33
right_interdigital	34
right_thenar	35
right_hypothenar	36
left_full	40
left_writer	41
right_full	45
right_writer	46

Example:

To set the following capture sequence:

thenar, hypothenar and interdigital

• Left Interdigital

• Left Thenar

• Right Interdigital

• Right Thenar

The parameter must be one of the two options:

sequencePalm=LEFT_INTERDIGITAL LEFT_THENAR RIGHT_INTERDIGITAL RIGHT_THENAR

sequencePalm=31 32 34 35

babySequencePalm

This parameter defines the capture sequence for baby palm capture. Each palm capture is delimited by a space.

BCC Services can perform two captures of the same palm. The best will be sent as the main capture and the other will be sent as an auxiliary image.

Palm Area	Index
left_palm	200
left_palm_2	201
right_palm	210
right_palm_2	211

Possible Values:

• LEFT_PALM

• LEFT_PALM2

• RIGHT_PALM

• RIGHT_PALM2

minutiaOrientation

This parameter defines how BCC Services will display the minutiae angle indicator.

Possible Values:

• DEFAULT

• ISO