BCC Services

Introduction

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

File Location

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

File properties

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

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

    Invalid configuration parameters will be disregarded 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 form {parameter}={value}, without line breaks;

Configuration Parameters

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

useFingerprintQualityLib

This parameter defines if the fingerprint quality library should be used on rolled captures.

Possible Values:

  • true

  • false

useFingerprintSDKAsService

This parameter defines if the fingerprint as a separated service.

This parameter only applies to 32-bits version.

Possible Values:

  • true

  • false

reinitializeSDKOnCapture

This parameter defines if the application will reinitialize the fingerprint SDK on each capture.

Possible Values:

  • true

  • false

useChecksum

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

Possible Values:

  • true

  • false

useCryptography

This parameter defines if cryptography should be used to import and export files.

Possible Values:

  • true

  • false

distance.crop.face

This parameter defines the cropped face width x height resolution.

Possible Values:

  • CROP_480X640

  • CROP_1200X1600

templateFormat

This parameter defines the format that templates should be exported.

Possible Values:

  • ANSI

  • ISO

  • CLASSIC

  • DEFAULT

  • FORENSIC

  • GR001

  • GR002

  • GR003

  • GR006

  • GR007

useLabels

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

Possible Values:

  • true

  • false

enroll.labels

This parameter defines what labels will be sent to GBDS when useLabels is set to true. A maximum of six labels can be defined and it is needed to be separated by commas.

Example:

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

report.folder.path

This parameter defines the folder path to save reports automatically.

ebts.exporting.enabled

This parameter defines if EBTS exporting will be enabled for BCC.

Possible Values:

  • true

  • false

ebts.exporting.path

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

ebts.ori

This parameter defines the code of the EBTS file issuer.

gbds.keyStore.path

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

gbds.keyStore.password

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

gbds.trustStore.path

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

gbds.trustStore.password

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

config.generalTabOnly

This parameter, when set true, will list only the General tab under configurations tabs in BCC, hiding others.

Possible Values:

  • true

  • false

responsible.fytech.quality

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

baby.palm.fytech.quality

This parameter defines the minimum quality threshold of palmprint captures of the baby when using the Fytech sensor.

Default Value:

65

capture.baby.fingerprints

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

Possible Values:

  • true

  • false

baby.finger.fytech.quality

This parameter defines the minimum quality threshold of fingerprint captures of the baby 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 if the baby's palmprints should be saved in .png format.

Possible Values:

  • true

  • false

bodyImageShapes

This parameter defines how will be the body part selection for auxiliary images. There are two possible values, simplified and full. Simplified will select a whole area (e.g. arm), where full will give the user the possibility to select a most specific anatomic-named area.

Possible Values:

  • true

  • false

minimun.biometrics

This parameter defines the minimum number of biometrics needed to perform a enroll.

minimum.real.captured.fingers

This parameter defines the minimum number of fingers without anomaly needed to perform a enroll.

maximum.anomalies

This parameter defines the maximum number of fingers with anomaly accepted in a enroll operation.

application.modules

This parameter defines which application modules are installed. This parameter can contain more than one value and the values are space delimited.

Possible Values::

  • FACE

  • SIGNATURE

  • PALM

  • AUXILIARY_IMAGES

  • IRISES

Example:

application.modules=FACE SIGNATURE PALM

match.sequence

This capture defines if the main fingerprints' capture should be matched against the sequence control capture.

Possible Values:

  • true

  • false

face.camera.type

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

Possible Values:

  • WEBCAM

  • CANON_EOS

  • CANON_POWERSHOT

face.webcam.device

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

face.flash.mode

This parameter defines if the flash function will be activated 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 from 0 to 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 in body capture. If there is only one webcam installed, this number should be 0.

body.flash.mode

This parameter defines if the flash function will be activated 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 from 0 to 359.

capture.type

This parameter defines the capture type of fingerprints' main captures.

Possible Values:

  • FLAT

  • ROLLED

signature.type

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

Possible Values:

  • SignatureGem1X5

  • SignatureGem4X5

  • SignatureGemLCD

  • SignatureGemLCD4X3New

  • SignatureGemLCD4X5

  • ClipGem

  • ClipGemLGL

signature.device

This parameter defines which signature device will be used.

Possible Values:

  • WACOM

  • TOPAZ

  • MSP

  • SIGNOTEC

signature.imageType

This parameter defines 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 advance after a capture. If it is set to automatic, it will advance to the next capture after every capture. If it is set to semi-automatic, it will show a screen with the capture to the operator and it will be needed to manually advance the capture.

Possible Values:

  • AUTOMATIC

  • SEMI_AUTOMATIC

sequenceControl.type

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

Possible Values:

  • CTRL_221

  • CTRL_442

  • NONE

minQuality

Minimum finger template quality percentage to capture be accepted.

Possible Values:

Any integer in the range of 0 to 100.

triesToAccept

This parameter defines the number of tries to enabled acceptance of low-quality finger templates.

whiteBalance.mode

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

Possible Values:

  • AUTO

  • CUSTOM

whiteBalance.blueAmber

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

Possible Values:

Any integer in the range of -9 to 9.

whiteBalance.greenMagenta

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

Possible Values:

Any integer in the range of -9 to 9.

processLiveView

This parameter defines if 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.

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

nfiq.action

This parameter defines the action 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 capture NFIQ was above the minimum.

Possible Values:

  • NONE

  • LOW_QUALITY

  • AMPUTED

  • SCAR

  • MARK

  • IGNORED

  • DAMAGED

theme

This parameter defines BCC Theme.

Possible Values:

  • DARK

  • LIGHT

theme.color

This parameter defines BCC theme color.

Possible Values:

  • BLUE_GRAY

  • BLUE

  • BROWN

  • CYAN

  • DEEP_PURPLE

  • GREY

  • INDIGO

  • LIGHT_GREEN

  • ORANGE

  • PINK

  • RED

  • TEAL

cropImages

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

Possible Values:

  • true

  • false

jpegQuality

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

Possible Values:

Any integer in the range from 0 to 100.

signatureBitDepth

This parameter defines the signature image bit depth.

Possible Values:

  • GREYSCALE (8-bit)

  • COLOR (24-bit)

anomalySetType

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

Simplified will have most generic values as "AMPUTED, SCAR, MARK DAMAGED".

Technical will have more specific values for the anomaly, enabling the user to select the cause of the anomaly.

Possible Values:

  • SIMPLIFIED

  • TECHNICAL

fingerVerifyThresold.<finger>

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

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

This parameter is valid for the FINGER and will be applied in the finger in 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 2-2-1 sequence control. Each finger is space-delimited and the capture is comma-delimited.

Possible Values:

It can be used finger names or finger index 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 define the following sequence of capture:

  • Left little and left ring

  • Left middle and left index

  • Left thumb

  • Right ring and right little

  • Right index and right middle

  • 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 4-4-2 sequence control. Each finger is space-delimited and the capture is comma-delimited.

Possible Values:

It can be used finger names or finger index 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 define the following sequence of capture:

  • Left little, left ring, left middle, and left index

  • Right ring, right little, right index, and right middle

  • 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 for main fingerprints. Each fingerprint capture is space delimited.

Possible Values:

It can be used finger names or finger index 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 define a sequence of capture, input the indexes 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 palmprint capture is space delimited.

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 define the following sequence of capture:

  • 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 palmprint capture is space delimited.

BCC can realize two captures of the same palm. The better one 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 in which way BCC will show the minutiae angle indicator.

Possible Values:

  • DEFAULT

  • ÌSO

Last updated