Hid Biometric Manager Administration Guide
Hid Biometric Manager Administration Guide
Biometric Manager™
Administration Guide
Powering
Trusted Identities
Powering HID® Biometric Manager™
Trusted Identities Administration Guide
Copyright
© 2019-2020 HID Global Corporation/ASSA ABLOY AB. All rights reserved.
This document may not be reproduced, disseminated or republished in any form without the prior written
permission of HID Global Corporation.
Trademarks
HID GLOBAL, HID, the HID Brick logo, the Chain Design, iCLASS SE, Seos, HID Mobile Access, HID Reader
Manager, HID Elite, HID Origo and HID Biometric Manager are trademarks or registered trademarks of HID
Global, ASSA ABLOY AB, or its affiliate(s) in the US and other countries and may not be used without
permission. All other trademarks, service marks, and product or service names are trademarks or
registered trademarks of their respective owners.
Contacts
For additional offices around the world, see www.hidglobal.com/contact/corporate-offices.
Americas and Corporate Asia Pacific
611 Center Ridge Drive 19/F 625 King’s Road
Austin, TX 78753 North Point, Island East
USA Hong Kong
Phone: +1 866 607 7339 Phone: +852 3160 9833
Europe, Middle East and Africa (EMEA) Brazil
3 Cae Gwyrdd Condomínio Business Center
Green Meadow Springs Av. Ermano Marchetti, 1435
Cardiff CF15 7AB Galpão A2 - CEP 05038-001
United Kingdom Lapa - São Paulo / SP Brazil
Phone: +44 (0) 2920 528 500 Phone: +55 11 5514-7100
What's new
Date Description Revision
June 2020 Updates to support HID Biometric Manager Service Pack 2.2 (RB25F Reader Firmware A.4
Version 1.5.1.22 and HID Biometric Manager Software Version 1.0.1103.59811)
Introduction 5
1.1 Document purpose 6
1.2 Intended audience 6
1.3 Related material 6
1.4 Physical Access Control System overview 7
1.5 HID Biometric Manager 8
1.5.1 Credential Database 8
1.5.2 Data Import 8
1.5.3 Reader Service 8
1.6 Browser compatible device 8
1.7 RB25F 8
1.8 Panels and Door Controllers 9
1.9 Network setups examples 10
HID Biometric Manager overview 11
2.1 System requirements 12
2.2 TCP Port usage 12
2.3 HID Biometric Manager initial setup 13
2.3.1 HID Biometric Manager software install 13
2.3.2 HID Biometric Manager initial login 15
2.4 Resetting administration password 18
2.4.1 Configure time zone setting 19
2.5 Device installation and configuration 21
2.5.1 Configure device settings 23
2.5.2 Device firmware update 26
2.5.3 Reset a device 29
2.5.4 Uninstall a device 30
2.6 Enrollment 31
2.6.1 Enroll people 31
2.6.2 Enroll Cards 33
2.6.3 Enroll Biometrics 36
2.7 Load HID Elite keys 39
2.7.1 Create Biometric Manager operators 41
2.7.2 Configure software/firmware update settings 43
2.7.3 Setting static IP for HBM network 45
2.7.4 Setting static IP for a specific device 46
2.8 Enforce Seos read 47
2.9 Device profiles 48
2.9.1 Create a device profile 48
Powering
Trusted Identities
Powering HID® Biometric Manager™
Trusted Identities Administration Guide
HID Reader Manager™ Solution User Guide The HID Reader Manager solution, HID Reader Manager App for iOS
(iOS) (PLT-03683) devices, and the HID Reader Manager Portal.
HID Reader Manager Solution User Guide The HID Reader Manager solution, HID Reader Manager App for Android
(Android) (PLT-03858) devices, and the HID Reader Manager Portal.
HID Mobile Access SIS Portal User Guide Procedures for Mobile Access Administrators to manage mobile users and
(PLT-03613) credentials through the HID Mobile Access SIS Portal.
HID Mobile Access App User Guide Installation, configuration, and use of the HID Mobile Access App for iOS
(PLT-02077) and Android devices.
1.7 RB25F
The RB25F is a biometric card and fingerprint reader. It authenticates users according to one of five
modes, see Acronyms and terminology as configured by the HID Biometric Manager. These are fingerprint
only, card only, and two variations of card with finger. One stores the fingerprint data on the card, the other
stores the fingerprint data on the RB25F device.
When the credential holder is authenticated, the data is output to a third party controller.
Scenario 1 - DHCP network, RB25F devices have dynamic IP, Server has a static IP
In this system setup the server has a static IP or the DHCP server assigns an IP with a permanent lease.
RB25F devices have an Ethernet connection on the same LAN as the server running Biometric Manager.
The network is configured so that the DCHP server dynamically assigns IPs (which may have a limited
lease time) to RB25F.
Scenario 2 - DHCP network, RB25F devices have dynamic IP, Server has a dynamic IP
In this system setup the server has a DHCP assigned IP.
RB25F devices have an Ethernet connection on the same LAN as the server running Biometric Manager.
The network is configured so that the DCHP server dynamically assigns IPs (which may or may not have
limited lease time).
HID Biometric Manager is installed on the server using the setup install wizard. During installation of RB25F
devices in Biometric Manager, you must select and use the default server hostname. In the event where the
server IP address changes, the hostname will reflect back to the server hostname.
Note: Setting HID Biometric Manager to a static IP will cause issues on this network.
Powering
Trusted Identities
Powering HID® Biometric Manager™
Trusted Identities Administration Guide
HID® Biometric Manager™ is a web application® that streamlines the management and configuration of
RB25F devices and allows application operators to manage people enrollment, credentials and fingerprint
templates. HID Biometric Manager uses the following operator roles to control access to management
tasks:
n Super Administrator: The super administrator is the initial default user account (cannot be deleted).
This operator installs and initially configures Biometric Manager software, and creates/administers
operator roles within the application see HID Biometric Manager initial setup.
n Administrator: This operator role has full access to Biometric Manager web application with
functions to install and manage RB25F devices see Device installation and configuration and enroll
people in the system, add credentials, collect and store associated biometric data see Enrollment.
n Device Administrator: This operator role is intended for HID partner technicians involved in the setup
and maintenance of the Biometric Management environment as well as configuration and update of
the RB25F. This operator role has limited access to user information.
n Enrollment: This operator role has full access to Biometric Manager web application. however is
limited to the day-to-day activities of enrolling people in the system, adding credentials, collecting
and storing associated biometric data see Enrollment.
5. Read the License Agreement. Select I accept the agreement, and click Next.
Note: If you do not accept the License Agreement, click Cancel to end the installation setup process.
6. Follow the installation wizard prompts until the setup has finished installing HID Biometric Manager
on your machine.
3. Enter the initial default admin User Name (admin) and Password (password) and click LOGIN.
4. For security reasons it is recommended that the default admin login credentials are immediately
changed. Click on the System option and select Operators.
5. Click on the Edit icon [ ] associated with the displayed system admin user.
8. Exit HID Biometric Manager and login again using the default username (admin) and new password.
This method is used when the user cannot log in to change the administrator password as shown in HID
Biometric Manager initial login
3. Select the Time Zone arrow icon to access a list of selectable time zones.
5. On the Date/Time screen click the Save icon to save your time zone setting.
3. In the Install dialog, click SCAN NETWORK to ensure the complete list of available devices are
shown.
Note: If no devices are found check the ports listed in TCP Port usage are open. The Search function
can be used to search the list of displayed devices.
5. When the installation has completed the Devices screen displays the installed device.
Note: Installed devices are automatically added to the default device profile named Devices. The
default device profile can be edited or new profiles can be added to the system.
8. On the Devices screen select Advanced. On the Advanced screen you have options to:
n SYNC: Syncs all device settings in HID Biometric Manager to the device.
n FACTORY DEFAULT: Restores all device settings to the original factory defaults, see Reset a
device.
n REBOOT DEVICE: Reboots the device.
n UPDATE FIRMWARE: Updates device firmware.
n CHANGE PASSWORD: Change the device password. The device password provides device
security on the LAN if secure mode is not enabled.
n ENABLE SECURE MODE/DISABLE SECURE MODE: This turns on encryption in the
communication channel.
n READ: Read mobile keys from the device.
n CLEAR: Remove mobile keys read from the device.
n WRITE: Write mobile keys to the device. Before Mobile keys can written to the device, keys
have to loaded onto HID Biometric Manager, see Biometric Manager Mobile Access setup.
9. Click SYNC option. For the selected device all settings are copied from HID Biometric Manager to
the RB25F.
Device firmware updates can take up to approximately eight minutes per device, including updates of the
reader board. Updates may complete faster depending on the HID Mobile Access Portal connection and
the number of uninterrupted updates.
Important: It is recommended that device firmware updates should be carefully scheduled as all devices
are updated and will be unavailable for use during the firmware update period.
To update device firmware:
1. Select the System option and click Update.
2. Click CHECK FOR UPDATES. Review the displayed firmware update information and click Install to
trigger the firmware update process.
A partial update means that the system was not able to complete the secondary step of applying
advanced updates, for example, as a result of the connection to the HID Mobile Access Portal not being
setup (see Biometric Manager Mobile Access setup) or being interrupted.
A partially updated device will run the installed level of firmware however features, such as mobile access,
and firmware fixes will not be available.
3. On the Devices screen select Advanced and the FACTORY DEFAULT option.
4. Select FACTORY DEFAULT to confirm the action.
Note: Where communication between HID Biometric Manager and the RB25F is not possible, factory
default reset can be carried out at the reader, see HID iCLASS SE RB25F User Guide (PLT-04900).
2.6 Enrollment
Enrolling people in the system, adding credentials and collecting associated biometric data can be carried
out by an Administrator operator or a Enrollment operator.
The enrolled person record is displayed on the People screen. To add additional people, click on the New
icon [ ] and enter the new persons details.
Note: To display people that have an inactive status, click the filter icon [ ] and select the Show Inactive
People option.
The operator can now collect and add biometric data associated with this enrolled person, see Enroll
Biometrics.
The manually entered card details are displayed with the decimal Credential Number converted to
hexadecimal in the Credential Identifier field.
Note: The credential recorded in HID Biometric Manager must also be present in the third party PACS
software running on the PACS Server.
4. In the Enroll Biometric dialog select the fingers you wish to enroll and click Next.
Note: If you intend to make use of the Template on Card option as the authentication mode you will
only be able to copy two of these templates to the card. However the system can store all ten
fingers, if needed.
6. For the highlighted finger you will be prompted to <Place finger on sensor> followed by <Lift
finger>. It is recommended that you follow the on-screen prompts, in the correct sequence, to ensure
a successful finger scan.
Note: For information regarding the correct method of presenting fingers to the scanner during the
biometric enrollment process, see HID iCLASS SE® RB25F User Guide (PLT-04900).
7. Continue to follow the on-screen prompts until you have successfully scanned the first finger three
times. Click Next.
Note: A score of at least one star per scan is needed. A poor score will require that you scan the
finger another three times.
8. You will be prompted to proceed onto the next finger scan. Follow the on-screen instructions until
you have successfully scanned the next finger three times.
9. When all of the selected fingers have been successfully scanned, click Done. The enrolled
fingerprints are associated with the top credential in the credential list.
Note: If the top credential in the credential list is deleted then enrolled fingerprints are associated
with the next credential in the list. If all credentials are deleted then the biometrics are also
deleted.
5. Click CHECK FOR UPDATES to check if software/firmware updates are available. Update Status
information is displayed on the screen.
n If new HID Biometric Manager software is available and selected, the installation progress is
displayed in your browser. Once the installation is complete the HID Biometric Manager Server
application will automatically shut down and re-start. You will be prompted to log back into
the HID Biometric Manager.
n If new device firmware is available, see Device firmware update.
3. Enter a Name and optional Description for the new device profile, then click the Save icon [ ].
Note: Select the arrow icon associated with Authentication Mode to select an Authentication Mode.
Device Profile attributes can now be edited. See Edit a device profile.
4. The created device profile is listed on the Device Profiles screen. To edit a profile, highlight a device
profile from the displayed list. The Edit/Delete icons appear on the screen for the highlighted device
profile.
5. Click on the Edit icon [ ] associated with the device profile to access the profile attributes. See
Edit a device profile.
3. On the Device screen, if not already displayed, select Details. On the Details screen you can edit the
device profile Name and Description and select the Authentication Mode (for a definition of the
Authentication Modes, see Acronyms and terminology.
Note: The authentication mode set here is the default when no authentication mode schedule has
been configured.
9. On the Device screen, select Devices to view the list of devices that belong to this device profile. Any
changes made to this device profile will be applied to these listed devices.
10. Click the Add icon [ ] to add a device to this device profile.
Low level communications only The device has power and can be found through LAN or Ethernet but there
and the device can't be used. is an operating error.
No communications with device. Communication has been lost between the device and HID Biometric
Manager.
The device has lost power or a tamper event has taken place.
High level communications in Communication between the connected devices and HID Biometric
place but device is busy. Manager is stable but the device is experiencing a high level of usage.
The Devices page displays the real-time status for all connected devices.
When the DHCP option under the Network window is toggled off, the Network window will expand. The
details can be manually entered to suit the user.
Under the Control tab, a relay can be selected and activated to determine a connection through the device
debug page. This is useful during the installation of the device. If the door strike is wired to the internal
relay, it can be activated to confirm connection.
4. Select the fingers (maximum of two) you wish to be written to the card and click WRITE TO CARD.
5. You will have approximately five seconds to present the supported card to the RB25F device in
order to write the profiles to the card. The LED bar will flash while writing to the card. Keep the card
in the reader field until the LED bar returns to it’s default color.
6. You will be notified when the card has been successfully written to.
For a Template on Card authentication mode, the enrolled person can now enter the door by presenting
this card, immediately followed by the correct finger scan on the RB25F.
6. Once started, check that the recovery process has created a new certificate with the recovery server
information and not the original server information. This can be verified through the HID Biometric
Manager Server window.
8. Log into HBM and uninstall all connected devices. Do not Factory Default.
9. Factory default all devices using the pins on the reverse of the unit, see HID iCLASS SE RB25F User
Guide (PLT-04900).
10. Wait one minute for devices to reboot after factory default.
11. Re-install all devices within HBM.
12. Test the communication between devices and HBM.
To filter displayed events select the Filters option. Any current filters in use are displayed. Click ADD
FILTER to create a new filter based on a Name, Event, or Device. Click the Save icon [ ] to save any
added filters.
Note: If no filters are used then the default filter is applied. This displays events only for the calendar day.
Click RUN REPORT to create a report of HID Biometric Manager transactions. Once the report is created
click the save report icon [ ] to save the report to a PDF or CSV file.
To filter report content select the Filters option. Any current filters in use are displayed. Click ADD FILTER
to create a new filter based on a Controller, Date/Time, Event, or Person/Asset. Click the Save icon [ ] to
save any added filters.
Note: If no filters are used then the default filter is applied. This displays events only for the calendar day.
Powering
Trusted Identities
Powering HID® Biometric Manager™
Trusted Identities Administration Guide
This section provides details on the prerequisites that must be in place in order to setup a connection
between HID Biometric Manager™ and the HID Mobile Access® Portal. The section also details how to verify
HID Reader Manager™ Technician account details in Biometric Manager and how to load HID Mobile
Access (MOB) keys onto the RB25F.
3. On the HID Update Settings page enter the Reader Manager Technician (this should be the Portal
admin or a company employee) account details (User ID/Password) and click VERIFY ACCOUNT.
If the Reader Technician account has not been authorized for any MOB keys then no keys are listed under
List of Mobile Identifiers. If MOB keys have been assigned to the account then these will be listed in.
2. Present the mobile device to the RB25F and check the Live! screen to see events showing the mobile
access read and the associated credential identifier.
Note: Mobile Access read will only work if the RB25F is in one of the authentication modes that
support card read, i.e. Card Only, Card or Finger, or Card + Finger. Mobile Access will not work
if the RB25F is in finger mode.
Powering
Trusted Identities
Powering HID® Biometric Manager™
Trusted Identities Administration Guide
New installations
1. Verify that the HID Biometric Manager software is at version 1.0.1103.59811, and RB25F is at firmware
version 1.5.1.22.
2. If required, update the devices firmware and software to the latest version.
Note: As this is a new install, the device configuration can be done after verification. If required, update
the device firmware.
Powering
Trusted Identities
Powering HID® Biometric Manager™
Trusted Identities Administration Guide
Term Definition
Authentication Mode Template on Card: The RB25F is waiting for a Credential (Card) to be presented. It
(RB25F) retrieves all the biometric templates from the credential.
If the presented finger matches the biometric templates retrieved from the
credential a Grant Access is recommended. This is a 1:1 Verification match against
Template on Card (ToC). The sensor is not armed (blue light off) until the Credential
is presented.
Card + Finger: The RB25F is waiting for a Credential (Card) to be presented. It
looks up the user ID and all associated biometric templates in it’s local device
database. If the presented finger matches the biometric templates retreated from
the local database a Grant Access is recommended. This is a 1:1 Verification match
against Template on Device (ToD). The sensor is not armed (blue light off) until the
Credential is presented.
Finger Only: The RB25F is waiting for a finger to be presented that is stored in its
local device database. If the presented finger matches one stored in the database a
Grant Access is recommended. This is a 1:N Identification match against Template on
Device (ToD). The sensor is always armed (blue light on).
Card Only: The RB25F is waiting for a Credential (Card) to be presented. It reads
the PACS data only and always recommends a Grant Access. The sensor is never
armed (blue light off).
The RB25F is waiting for either a Credential (Card) to be presented or a finger,
stored in its local device database, to be presented. This authentication mode is
particularly useful during initial enrollment setup.
Biometric spoofing Biometric spoofing is a method of fooling a biometric identification management
system. An artificial object (for example, a fingerprint mold made of silicon) is
presented to the biometric scanner that imitates the unique biological properties of
a person which the system is designed to measure.
BLE Bluetooth Low Energy (formerly marketed as Bluetooth Smart) is a wireless
personal area network technology.
ERR The Equal Error Rate (EER) is the common value indicating that the proportion of
false acceptances (FAR) is equal to the proportion of false rejections (FRR). The
lower the EER value, the higher the accuracy of the biometric system.
False Accept Rate (FAR) The False Accept Rate (FAR) is the measure of the likelihood that the biometric
security system will incorrectly accept an access attempt by an unauthorized user.
False Reject Rate (FRR) The False Reject Rate (FRR) is the instance of a security system failing to verify or
identify an authorized person.
FTA Failure To Acquire. The biometric system failure to extract usable identification data
from a biometric sample.
Identification (of Identity) Typically finding a matching template in a large database of templates. 1:N matching.
LFD Live Finger Detection. This is used in some markets instead of Spoof. It is also used
to refer to insuring a severed finger is not being presented at the sensor.
MINEX Minutia Interoperability Exchange. The MINEX program is dedicated to the
evaluation and development of the capabilities of fingerprint minutia matchers
running on ISO/IEC 7816 smart cards.
M-Series Mercury Platform Series of Products.
MSI Multi-Spectral Imaging.
OSDP Open Supervised Device Protocol (OSDP) is an access control communications
standard developed by the Security Industry Association (SIA) to improve
Term Definition
interoperability among access control and security products.
PAD Pressure Attack Detection.
PD Presence Detection.
ROC Receiver Operating Characteristic.
SDK Software Development Kit.
SIA Structure Image Acquisition.
Tap The Tap gesture with a mobile device for door opening.
The Tap operation is typically used when the mobile device is in close proximity to
the reader. Approximately 12 inches (30 cm).
Twist and Go The Twist gesture with mobile device for door opening.
The Twist operation is typically used when the mobile device is at a longer distance
from the reader. Approximately 6 feet (2 meters).
ToC Template on Card. The PACS data is read from the card.
ToD Template on Device. The PACS data is read from the device database.
vCOM V-Series Command Protocol.
Verification (of Identity) Typically a fingerprint template is stored on a card and checked against a finger
presented to the finger print sensor. 1:1 matching.
Revision history
Date Description Revision
June 2020 Updates to support HID Biometric Manager Service Pack 2.2 (RB25F Reader Firmware A.4
Version 1.5.1.22 and HID Biometric Manager Software Version 1.0.1103.59811)
December 2019 Updates to support HID Biometric Manager Service Pack 2.1 (RB25F Reader Firmware A.3
Version 1.5.0.86 and HID Biometric Manager Software Version 1.0.886.57608)
September 2019 Updates to support RB25F Service Pack 1 (RB25F Reader Firmware Version 1.5.0.82 and A.2
HID Biometric Manager Software Version 1.0.774.56514)
June 2019 Minor update to Section 3.2.1 HID Biometric Manager software install. A.1
February 2019 Initial release. A.0