Biometrics Settings - Rest PKI Core

EnrollmentBatch Settings (v4.1.0)

These settings control the bulk biometric enrollment of subjects from a ZIP file of face images, one image per subject. Each image is an entry of the batch. The maximum size of the ZIP file is the application's general upload limit, General:MaxFileSize (default 104857600 (100 MiB)): raise it to import larger batches. The file is uploaded in segments of 2 MiB or 5 MiB, depending on the blob storage provider, so General:MaxRequestBodySize (default 136 MiB) must not be set below that.

Under section Bio:EnrollmentBatch:

• MaxFileLengthOnInMemoryStorage (v5.1.0, default: 1073741824 (1 GiB)): maximum size, in bytes, of the ZIP file when the configured blob storage provider loads the whole file into memory every time it is read (the Google Cloud Storage and Database providers). When it applies, the smaller of this value and General:MaxFileSize is the limit, and a larger file is refused as too large. Use 0 for no additional limit.
• UploadTicketLifetime (v5.1.0, default: 7.00:00:00 (7 days)): how long an upload can take, from the moment it starts until the batch is created from it. After that the upload is discarded and must be repeated. Format: d.hh:mm:ss.
• EntryMaxLength (v4.1.0, default: 26214400 (25 MiB)): maximum size, in bytes, of each image in the ZIP file. An entry with a larger image is not enrolled and is reported as too large.
• EntriesInsertBulkSize (v4.1.0, default: 1000): number of entries the application records in the database at a time while it loads the entries of a new batch.
• DatabaseCooldownTime (v4.1.0, default: 00:00:01 (1 second)): pause between each of those database insertions, to limit the load on the database. Format: d.hh:mm:ss.
• ConcurrentEntriesPerBatch (v5.1.0, default: 1): number of entries of one batch sent to the biometric provider at the same time. Raise it according to the provider's capacity. A batch is always processed by a single instance of the application, so adding instances does not increase this number for a batch.
• MaxAttemptsPerEntry (v5.1.0, default: 5): number of attempts to enroll an entry that fails with a temporary error (for example, a call to the biometric provider times out). When all the attempts fail, the entry is reported as failed after retries, and it is retried if the batch is resumed after completing.
• RetryBackoff (v5.1.0, default: 00:00:30 (30 seconds)): delay before an entry that failed with a temporary error is tried again. The delay is multiplied by the number of the attempt, so the second retry waits twice as long as the first. Format: d.hh:mm:ss.
• EntryTimeout (v5.1.0, default: 00:02:00 (2 minutes)): maximum time for all the biometric provider calls of one entry. An entry that exceeds it is handled as a temporary error and retried. Values below 1 second are raised to 1 second, and values above 5 minutes are lowered to 5 minutes. Format: d.hh:mm:ss.
• PauseAfterConsecutiveTransientFailures (v5.1.0, default: not set): number of consecutive temporary errors, within one run of the batch, after which the batch pauses itself instead of trying the remaining entries. When not set, it is 3 times ConcurrentEntriesPerBatch (3 with the default). Values below 1 are handled as 1.
• PauseDuration (v5.1.0, default: 00:05:00 (5 minutes)): how long a batch waits before it continues after pausing itself. The wait is multiplied by the number of consecutive runs without progress, up to MaxPauseDurationMultiplier. Format: d.hh:mm:ss.
• MaxPauseDurationMultiplier (v5.1.0, default: 6): maximum value of the multiplier applied to PauseDuration. With the defaults, the wait grows from 5 to at most 30 minutes.
• MaxConsecutiveRunFailures (v5.1.0, default: 10): number of consecutive runs without progress after which the batch is suspended. A suspended batch is not processed again until a user resumes or aborts it in the dashboard.
• MaxRunDuration (v5.1.0, default: 00:03:00 (3 minutes)): how long one run of a batch takes on new work before it hands over to a new background job; the entries already in progress are finished first. Ending a run this way is not a pause and does not count as a run without progress, unless none of the entries it worked on reached an outcome. Values below 1 second are raised to 1 second. The upper limit is 10 minutes minus the EntryTimeout minus 1.5 minutes (6.5 minutes with the default EntryTimeout), and larger values are lowered to it. Format: d.hh:mm:ss.
• ProgressLogInterval (v5.1.0, default: 1000): number of processed entries between the progress lines in the application log, which show the processing rate and the estimated time to completion.

JobSchedules Settings

Under section JobSchedules:

• SweepBioEnrollmentBatches (v5.1.0, default: */10 * * * *): schedule, as a cron expression, of the background job that looks after enrollment batches. It resumes batches whose processing was interrupted and removes leftover copies of batch files that no batch uses. By default, it runs every 10 minutes.