Manage the current record

BioClient.Web has the concept of a current record. The current record represents a person with their attributes, biometric objects, or properties in the biometric store. This data is kept locally in the BioClent service, and is manipulated by many API calls.

Capturing a sample or feature adds the sample or feature to the current record. Retrieving a person from the store sets the current reord to the retrieved data.

BioClient.Web offers these verbs to manage the current record:

clear-current

This method clears the current record and removes all data from it.

Usage

Call the Javascript method bioClient.clear_current(). This method is defined in bioclient-plugin.js and calls build_clear_current to build the BioClient.Web command, and calls clear_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 clear-current. It is recommended to use these event handlers.

Remarks

This method clears the current record, but does not clear any enrolments from the store.

Input parameters

Parameter Type Value Remark
command string clear-current The command to be executed.

Output parameters

Parameter Type Value Remark
command string clear-current The command which was executed.
status string Success The success or failure status.
person_msg string A friendly result message, relating to the current record.
person_sev string success The severity of the current record result message.

get-person

This method retrieves the current person (and all their properties and biometrics) in the biometric controller, provided the name matches the name of the current person.

Usage

Call the Javascript method bioClient.get_person(). This method is defined in bioclient-plugin.js and calls build_get_person to build the BioClient.Web command, and calls got_person 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 get-person. It is recommended to use these event handlers.

Remarks

This method retrieves the current person only if the name matches the name of the current person. If name is empty, then any current person will be retrieved. If the name of the current person is empty, then name must be empty too.

Input parameters

Parameter Type Value Remark
command string get-person The command to be executed.
name string The unique name of the identity expected in the current record.

Output parameters

Parameter Type Value Remark
command string get-person The command which was executed.
status string Success The success or failure status.
person_msg string A friendly result message, relating to the current record.
person_sev string success The severity of the current record result message.
name string The unique name of the identity found in the current record.

get-samples

This method retrieves all samples of the current person in the biometric controller.

Usage

Call the Javascript method bioClient.get_samples(). This method is defined in bioclient-plugin.js and calls build_get_samples to build the BioClient.Web command, and calls got_samples 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 get-samples. It is recommended to use these event handlers.

Remarks

This method retrieves all samples of the current person, irrespective of the name of the current person, and irrespective of the sample classes.

Input parameters

Parameter Type Value Remark
command string get-samples The command to be executed.

Output parameters

Parameter Type Value Remark
command string get-samples The command which was executed.
status string Success The success or failure status.
person_msg string A friendly result message, relating to the current record.
person_sev string success The severity of the current record result message.
samples { sample } An array of samples of the current record.

References