Enrol an entity

Enrolling an entity means storing a person, their attributes, biometric objects, or properties in the biometric store.

BioClient.Web offers these enrol verbs:

enrol

This method enrols or updates the person with their attributes, and enrols selected biometric objects, and saves or updates person properties.

Usage

Call the Javascript method bioClient.enrol(). This method is defined in bioclient-plugin.js and calls build_enrol to build the BioClient.Web command, and calls enrolled to process the response. See The BioClient Javascript plugin for information on how to use and customise the BioClient Javascript plugin.

Event handlers

The JS method bc_addButtonEvents defines event handlers for this method for all buttons and anchors of class enrol. It is recommended to use these event handlers.

Remarks

The method enrols the person into the biometric store, identified by the uniqueName. If no unique name is provided, the current, default adapter is used.

This method enrols or updates the person. If the person does not yet exist, they are stored. If the person already exists, their attributes are updated. The person is identified by their unique name. If incoming attributes are null or None, the existing attributes are not changed.

This method enrols biometric features and samples of the current person. If the sampleClass or featureClass is null, all samples or features are enrolled. If the sampleClass or featureClass is zero, no samples or features are enrolled. If the sampleClass or featureClass is non-zero, only samples or features of the specified class are enrolled.

Input parameters

Parameter Type Value Remark
command string enrol The command to be executed.
adapterType AdapterTypes Store The adapter type. Always Store.
storeName string The unique name of the store adapter to use. If null, the current adapter is used.
name string The unique name of the identity to be enrolled or updated.
status PersonStatus The status attribute of the person. If None, the current status is not changed.
substatus int? The substatus attribute of the person. If null, the current substatus is not changed.
group int? The group attribute of the person. If null, the current group is not changed.
subgroup int? The subgroup attribute of the person. If null, the current subgroup is not changed.
sampleClass int? The class of samples of the current person to enrol. If null, all samples are enrolled. If zero, no samples are enrolled.
featureClass int? The class of features of the current person to enrol. If null, all features are enrolled. If zero, no features are enrolled.

Output parameters

Parameter Type Value Remark
command string enrol The command which was executed.
status string Success The success or failure status.
person person The enrolled or updated person and their attributes.
person_msg string A friendly result message, relating to the person.
person_sev string success The severity of the person result message.
capture_msg string A friendly result message, relating to biometrics. Might be the same as the person message.
capture_sev string success The severity of the biometrics result message.
props [ props ] An array of enrolled properties.
sets [ subtype ] An array of enrolled subtypes.
features [ feature ] An array of enrolled features.
samples [ sample ] An array of enrolled samples.

enrol-current

This method enrols or updates the current person, and enrols selected biometric objects, and saves or updates person properties.

Usage

Call the Javascript method bioClient.enrol_current(). This method is defined in bioclient-plugin.js and calls build_enrol_current to build the BioClient.Web command, and calls enrolled_current to process the response. See The BioClient Javascript plugin for information on how to use and customise the BioClient Javascript plugin.

Event handlers

The JS method bc_addButtonEvents defines event handlers for this method for all buttons and anchors of class enrol-current. It is recommended to use these event handlers.

Remarks

The method enrols the person in the biometric store, identified by the uniqueName. if no unique name is provided, the current, default adapter is used.

This method enrols or updates the person. If the person does not yet exist, they are stored. If the person already exists, their attributes are updated. The person is identified by their unique name. If attributes of the current person are null or None, the existing attributes are not changed. As this method enrols or updates the current person, it does not need teh status or group parameters, instead the attributes of the current person are used.

This method enrols biometric features and samples of the current person. If the sampleClass or featureClass is null, all samples or features are enrolled. If the sampleClass or featureClass is zero, no samples or features are enrolled. If the sampleClass or featureClass is non-zero, only samples or features of the specified class are enrolled.

Input parameters

Parameter Type Value Remark
command string enrol The command to be executed.
adapterType AdapterTypes Store The adapter type. Always Store.
storeName string The unique name of the store adapter to use. If null, the current adapter is used.
name string The unique name of the identity to be enrolled or updated.
sampleClass int? The class of samples of the current person to enrol. If null, all samples are enrolled. If zero, no samples are enrolled.
featureClass int? The class of features of the current person to enrol. If null, all features are enrolled. If zero, no features are enrolled.

Output parameters

Parameter Type Value Remark
command string enrol The command which was executed.
status string Success The success or failure status.
person person The enrolled or updated person and their attributes.
person_msg string A friendly result message, relating to the person.
person_sev string success The severity of the person result message.
capture_msg string A friendly result message, relating to biometrics. Might be the same as the person message.
capture_sev string success The severity of the biometrics result message.
props [ props ] An array of enrolled properties.
sets [ subtype ] An array of enrolled subtypes.
features [ feature ] An array of enrolled features.
samples [ sample ] An array of enrolled samples.

References