Download Bio-Plugin™ Biometric System Installation

Bio-Plugin™ Biometric Software Installation Guide
Bio-Plugin™ Biometric System Installation
Bio-Plugin for AppServer Interaction
1
Revision Date: 04/22/11
Bio-Plugin™ Biometric Software Installation Guide
Table of Contents
M2SYS Biometric Software Overview ........................................................................................................... 3
What’s New in the BioPlugin Hybrid Installation? ........................................................................................ 4
Installation Overview .................................................................................................................................... 5
Upgrading From Legacy BioPlugin ................................................................................................................ 5
Server Installation ......................................................................................................................................... 7
Server Activation ........................................................................................................................................... 8
USB SmartLock ................................................................................................................................... 9
Machine-specific License ID ............................................................................................................. 10
Verifying Server Functionality ..................................................................................................................... 10
BioPlugin Server Configuration ................................................................................................................... 11
General Settings ............................................................................................................................... 12
Database Settings............................................................................................................................. 13
Encryption Settings .......................................................................................................................... 14
Advanced Settings ............................................................................................................................ 15
License Settings ................................................................................................................................ 17
Database Configuration .............................................................................................................................. 18
Client Installation ........................................................................................................................................ 18
Client Activation .......................................................................................................................................... 19
USB SmartLock ................................................................................................................................. 19
Biometric Reader LID ....................................................................................................................... 20
Machine-specific License ID ............................................................................................................. 21
Verifying Client Functionality ...................................................................................................................... 21
Appendix ..................................................................................................................................................... 23
Accessing the BioPlugin Server Preferences .................................................................................... 23
Generating a License ID.................................................................................................................... 23
Accessing the Windows Services Control Manager ......................................................................... 24
2
Revision Date: 04/22/11
Bio-Plugin™ Biometric Software Installation Guide
M2SYS Biometric Software Overview
Hybrid Biometric Platform
Hybrid Biometric Platform™ is a client/server biometric recognition system that supports
fingerprint, finger vein, palm vein, and iris biometrics. After a single integration with Hybrid
Biometric Platform™, developers can immediately utilize any of these biometric modalities. This
flexibility ensures that customers are never locked into a single biometric technology or
biometric device that might not reliably work for all users.
Bio-Plugin™
Bio-Plugin™, M2SYS' patent-pending biometric middleware technology, enables companies to
rapidly integrate Hybrid Biometric Platform™ without the costs that are typically associated
with low-level biometric SDK development and support. The combined technologies allow
developers to quickly deploy a run-time independent Hybrid Biometrics™ system that ensures
optimal performance regardless of user demographic, ethnicity, environmental conditions or
usability challenges. Subsequently, the technology augments return on investment, time-tomarket and project success rates.
Bio-Plugin™ consists of a small client application that communicates with the host software and
a high performance, back-end fingerprint recognition engine that performs all comparison
requests. The client application communicates to the host software through a unique, loosely
coupled interface and with the recognition engine through an M2SYS connection manager:
When a request to enroll, verify or identify a sample template is sent from the host application
to Bio-Plugin™, a biometric capture window appears that blends perfectly with the host
software. Although it appears to end-users as a fully integrated component of the host
software, Bio-Plugin™ actually processes all fingerprint activities separately, eliminating system
dependencies and the subsequent need to constantly recompile code.
3
Revision Date: 04/22/11
Bio-Plugin™ Biometric Software Installation Guide
What’s New in the BioPlugin Hybrid Installation?
The following are notable changes to the BioPlugin Hybrid installation process which may impact your
integration or deployment environments.
Relocation of Software Settings Files
To comply with Microsoft's latest best practice recommendations, the software settings files (client.ini
for the BioPlugin Client, and server.ini and m2sysservice.ini for the BioPlugin Server) have been relocated
to the Common Application Data folder. The physical location of the Common Application Data varies
depending on the version of Windows:
•
•
In Windows XP, C:\Documents and Settings\All Users\Application Data\BioPlugin\
In Windows Vista/7, C:\ProgramData\BioPlugin\
•
The registry value HKEY_LOCAL_MACHINE\Software\M2SYS\ClientINI will reflect the location
of the client setting file.
The registry value HKEY_LOCAL_MACHINE\Software\M2SYS\ServerINI will reflect the location
of the server setting file.
•
Because the ClientINI and ServerINI registry values no longer reflect the installation path of the
software, a new set of values will point to the installation folder of the BioPlugin Client and BioPlugin
Server software respectively. If you used the ClientINI or ServerINI registry values for any purpose other
than to locate the software settings files, you will need to change your references to use these new
values accordingly.
•
•
The registry value HKEY_LOCAL_MACHINE\Software\M2SYS\ClientInstallDir will point to the
installation folder of the BioPlugin Client.
The registry value HKEY_LOCAL_MACHINE\Software\M2SYS\ServerInstallDir will point to the
installation folder of the BioPlugin Server.
Database Structure Changes
To be able to handle the multiple forms of biometric template data in the Server software, the BioPlugin
database structure has been modified slightly (particularly, the Fingerprint table). Please take a look at
the Database.mdb file, or the SQL script files included in the BioPlugin Hybrid Server installation to see
these changes:
•
•
A new field "EngineType" has been added to the Fingerprint table (alphanumeric, 10
characters). This field will contain a biometric engine identifier to denote what type of template
each record contains.
The field names within the Fingerprint table which reference "Fingerprint" have been changed
to reference "Template"
• FingerprintID -> TemplateID
• FingerType -> TemplateType
• FingerFeature -> TemplateFeature
4
Revision Date: 04/22/11
Bio-Plugin™ Biometric Software Installation Guide
•
•
•
The field name "Resolution" has been changed to "TemplateSize"
The primary key on the table (PersonID, FingerprintID) has been changed to (PersonID,
EngineType, TemplateID)
The table name "Fingerprint" has been changed to "Templates"
Updated M2-S Driver
The driver software used by the BioPlugin Client to communicate with the M2-S reader has changed
from the DigitalPersona Gold Fingerprint Software to the DigitalPersona OneTouch for Windows
Software. The BioPlugin Hybrid Client installer will automatically remove the old driver software and
install the new driver software. If you have any other software on your computer that also uses the
DigitalPersona Gold software, it will most likely stop functioning. You may need to contact the vendor of
any such software to obtain an updated version that uses the DigitalPersona OneTouch software.
Elimination of Service Assistant
Due to increasingly strict security settings in recent Microsoft Windows operating systems, the
functionality of the Service Assistant system tray icon has started to become inconsistent. Because of
this fact, we have removed the Service Assistant completely from the latest BioPlugin Server installation.
Management of the BioPlugin Server service can still be performed through the Windows Services list.
Installation Overview
M2SYS’ BioPlugin is a 3-tier application system. The BioPlugin Client runs in the end user’s local PC, while
the Server component can run on a separate, centralized server and database elsewhere.
Installation typically involves three main steps:
1. Installing the BioPlugin Server software
2. Configuring the BioPlugin Server database connection (if applicable)
3. Installing the BioPlugin Client software
Client-specific settings such as window display customization and server location can be configured
through the various methods of the BioPlugin ActiveX control configuration methods. The "M2SYS
BioPlugin Server" Control Panel applet put in place during the server installation also allows the
configuration of other optional server software settings.
Upgrading From Legacy BioPlugin
BioPlugin Hybrid Installers
From an installation perspective, the BioPlugin Hybrid software is considered an update of the
fingerprint family of the legacy BioPlugin software (version 6.6 and prior). The product update code is
the same as that use in the BioPlugin 6.x fingerprint software installers.
5
Revision Date: 04/22/11
Bio-Plugin™ Biometric Software Installation Guide
If you install a BioPlugin Hybrid installer onto a computer where the BioPlugin 6.x fingerprint software is
already installed, the BioPlugin Hybrid installer will recognize the existing fingerprint software as a
previous version and automatically remove the outdated 6.x files and put the new hybrid files in their
place. The BioPlugin 6.x fingerprint software will no longer be listed in the installed programs list, being
replaced by the BioPlugin Hybrid software listing.
If you install a BioPlugin Hybrid installer onto a computer where the BioPlugin 6.x finger vein software is
already installed, the BioPlugin Hybrid installer will not recognize the existing finger vein software as a
previous version and will thus simply overwrite the 6.x files with the new hybrid files (if you install the
software to the same folder). Both the BioPlugin 6.x finger vein software and the BioPlugin Hybrid
software will be listed in the installed programs list. While the BioPlugin Hybrid software will be
completely functional after this type of installation, we recommend against it to prevent future
confusion.
Recommended Upgrade Procedure
•
Currently running the BioPlugin 6.x fingerprint software
1. Install the BioPlugin Hybrid software. (Existing software settings will be moved and
maintained in new application data location.)
•
Currently running the BioPlugin 6.x finger vein software
1. Uninstall the BioPlugin 6.x finger vein software. (Existing software settings will be left
behind.)
2. Install the BioPlugin Hybrid software. (Left behind software settings will be moved and
maintained in new application data location.)
Note: The BioPlugin Hybrid release incorporates a new communication layer between the Client and
Server software, to facilitate the Server being able to recognize which biometric engine the Client
request is using. This new communication format is not compatible with the legacy BioPlugin Server, so
you must be sure to upgrade to the Hybrid BioPlugin Server before upgrading any Clients that are
communicating with it.
1. Upgrade BioPlugin Server
2. Upgrade BioPlugin Client(s)
Mixing Legacy BioPlugin Clients and BioPlugin Hybrid Server
Since the legacy BioPlugin Client software does not use the new hybrid communication layer, the
BioPlugin Hybrid Server will not know how to handle legacy BioPlugin Client requests (it will not know
which biometric engine the requests should use) unless it is explicitly told how to do so. If you will have
legacy BioPlugin Clients communicating with the BioPlugin Hybrid Server, you will need to configure the
Server appropriately to allow this.
The BioPlugin Hybrid Server can be configured to handle requests from either legacy fingerprint
BioPlugin Client software, or from legacy finger vein BioPlugin Client software. You cannot have both
6
Revision Date: 04/22/11
Bio-Plugin™ Biometric Software Installation Guide
legacy fingerprint and legacy finger vein BioPlugin Clients communicating with the same BioPlugin
Hybrid Server.
Upgrading a non-Access Database
As outlined in the “What's New?” section of this document, the BioPlugin Server database structure was
modified slightly to facilitate support for multiple biometric template types. If you are using the default
Microsoft Access database, these database structure changes will be applied automatically when the
BioPlugin Hybrid Server starts up for the first time. If you are using any other database, the BioPlugin
Hybrid Server may not be able to apply these changes automatically. Please refer to the Microsoft
Access database file, or the SQL script files included with the BioPlugin Hybrid Server installation to
make the necessary modifications to the "Fingerprint" table.
Add EngineType field (alphanumeric, 10 characters)
Rename FingerprintID field to TemplateID
Rename FingerType field to TemplateType
Rename FingerFeature field to TemplateFeature
Rename Resolution field to TemplateSize
Update the primary key constraint on Fingerprint table (only needed if there is already a
primary key constraint on the table)
• Composite key of PersonID, EngineType, and TemplateID fields
7. Rename Fingerprint table to Templates
1.
2.
3.
4.
5.
6.
Once these structural changes have been made, you will just need to insert the appropriate biometric
engine identifier value into the EngineType field to tell the BioPlugin Hybrid Server what type of
templates the records are. Typically, since you will be upgrading a single fingerprint or finger vein
database, this value will be the same for all records:
•
•
"FP1" for a fingerprint database
"FV1" for a finger vein database
The database will now be compatible with the BioPlugin Hybrid Server.
Server Installation
First, download the BioPlugin Server MSI file provided to you via email, or insert your BioPlugin CD.
1.
2.
3.
4.
5.
6.
Run the BioPlugin Server installation MSI file
Click "Next" to proceed through the first two dialog screens
Read and accept the License Agreement
Enter your user information
Change the installation folder if desired (the default should be fine for most situations)
Review the installation settings, and click "Install"
7
Revision Date: 04/22/11
Bio-Plugin™ Biometric Software Installation Guide
The BioPlugin Server software will now be installed.
IMPORTANT: After installation, the BioPlugin Server software must be activated before it will run
successfully.
Server Activation
IMPORTANT: Before the BioPlugin Server will be able to run, the software must be activated.
The BioPlugin Server software can be activated in one of two ways:
•
•
USB SmartLock
Machine-specific License ID
Once the BioPlugin Server software is activated, the BioPlugin Server service can be started manually
through the Windows Service control manager. The BioPlugin Server service will also automatically start
at Windows boot-up.
After the software is activated, you can configure the remaining server settings through the control
panel entry.
8
Revision Date: 04/22/11
Bio-Plugin™ Biometric Software Installation Guide
IMPORTANT: If the Service Assistant icon does not stay green, check the server log files for any error
conditions that may be preventing the software from running.
Note: You will need to stop and restart the BioPlugin Server software to apply any settings or license
changes.
USB SmartLock
1. Connect the blue "Server" USB SmartLock to the USB port of the computer
where the BioPlugin Server software is installed
2. Wait for the device to be detected by Windows (this may take a minute)
To confirm that the USB SmartLock activation was successful, open the M2SYS BioPlugin Server entry in
the Windows Control Panel.
Under the License tab, the USB SmartLock status should be "CONNECTED". The Current License Details
section will provide the details of the software license in the connected USB SmartLock.
IMPORTANT: The USB SmartLock must remain connected to the computer for the BioPlugin Server
software to continue to run.
Note: If both the BioPlugin Client and BioPlugin Server software are installed on the same computer,
connecting just the blue "Server" USB SmartLock will activate both Client and Server installations on that
computer.
9
Revision Date: 04/22/11
Bio-Plugin™ Biometric Software Installation Guide
Machine-specific License ID
To activate your software by using a machine-specific License ID, you will need to open the open the
M2SYS BioPlugin Server entry in the Windows Control Panel to generate this value.
Under the License tab in the License ID section, you will see an Installation ID is automatically provided
for you. By supplying this Installation ID to your software vendor, you will be provided a License ID to
enable your BioPlugin Server installation.
If you purchased your software from M2SYS directly, you can generate your own License ID on the
M2SYS License Page. If you purchased your software from another software vendor, you will need to
contact that vendor to obtain your License ID.
Once a valid License ID has been entered, the Current License Details section will provide the details of
the entered software license.
Note: If both the BioPlugin Client and BioPlugin Server software are installed on the same computer,
entering just a server License ID will activate both Client and Server installations on that computer.
Verifying Server Functionality
Once the BioPlugin Server software is installed and activated, you can verify its basic functionality
manually by following these steps:
1. Check the Windows Service control manager for the “M2SYS BioPlugin Server” service. If this
service does not have a status of "Started", try right-clicking and starting it manually from here.
10
Revision Date: 04/22/11
Bio-Plugin™ Biometric Software Installation Guide
2. Check the contents of the BioPlugin Server log files from the General tab of the BioPlugin Server
control panel window.
•
Core Server log file: At the bottom of the file it should say:
Loading DB....
??? Engine Cache size: 0
Mapped the sharedmem file.
>>>>>>Server started. Waiting for client request
•
•
•
•
•
The cache size value reported is the number of records loaded from the database. If
this line does not exist, server is not connecting to the database.
• Verify the database connection string is correct.
• Check for any ODBC or similar error messages detailing the database
connection problem.
If there is a "No USB License Key" message, the USB SmartLock was not properly
connected.
If there is a "License Error" message, the BioPlugin Server License ID was not
entered correctly.
• Check the License tab of the BioPlugin Server control panel window.
Confirm the License ID was entered correctly.
If the server is running properly, the last line in the Core Server log file will be
"Server started. Waiting for client request…"
Client Manager log file: At the bottom of the file it should say:
Listening on Port: 1200
Waiting for Core Server to be ready...
Binding process completed...
Waiting for client calls ...
•
•
If "Waiting for Core Server to be ready" is continuously repeated and the log never
goes any further, the Core Server process is probably not running. Check the Core
Server log file for any errors that might indicate a reason for this.
If there is a "error calling bind()" message, some other process is already bound to
the TCP/IP port the BioPlugin Server is trying to use. You may need to further
investigate what other process might be using that port, or reconfigure the
BioPlugin Server to use a different port.
BioPlugin Server Configuration
In many cases, the BioPlugin Server software will be ready to operate after installation without any
additional configuration required. However, there are various settings that can be modified to control
various aspects of the software's behavior. These include:
11
Revision Date: 04/22/11
Bio-Plugin™ Biometric Software Installation Guide
•
•
•
•
•
General settings
Database settings
Encryption settings
Advanced settings
License settings
To access these settings, you will need to open the “M2SYS BioPlugin Server” entry in the Windows
Control Panel.
General Settings
Use TCP/IP Port
Used to specify which TCP/IP port the BioPlugin Server software will use to accept incoming biometric
requests from the BioPlugin Client(s). By default, this value is set to 1200, but can be configured to any
valid TCP/IP port.
Be sure that the port specified is not already being used by another application, and that any firewall
software on the computer is not blocking incoming TCP requests on this port.
Note: If this value is changed, you must also properly configure the BioPlugin Client(s) to communicate to
the same port.
Core Server log file location
Specify the location of the log file generated by the Core Server service.
12
Revision Date: 04/22/11
Bio-Plugin™ Biometric Software Installation Guide
Server Logs
These logs can be used to review the detailed status of the BioPlugin Server services. Any error
conditions that may result in the BioPlugin Server being unable to run will generally be reported here.
•
•
Core Server Log - License activation and database connectivity
Client Manager Log - TCP/IP port connectivity
Database Settings
Connection String
Tells the BioPlugin Server how to communicate with the desired database where the biometric data is
stored.
Sample Connection String Templates
Some sample connection strings for the various database environments supported by BioPlugin Server.
These are just samples to get you started, and may need additional customization to be able to connect
to your particular database environment. For more sample database connection strings, please visit
www.ConnectionStrings.com
Note: The Microsoft Access (Default) template can always be used to go back to connecting to the
original default Access database file.
Store connection string in an encrypted format once Server starts
13
Revision Date: 04/22/11
Bio-Plugin™ Biometric Software Installation Guide
If this is enabled, the BioPlugin Server software will replace the plaintext database connection string
stored in the server settings file with an encrypted copy. This can help keep any database login
credentials used in the connection string secure.
Connection Retry Attempts
How many times the BioPlugin Server should attempt to connect to the specified database (with a 15second delay between attempts) before giving up. This number may be increased if your database
environment is slow to initialize at boot up, to ensure that the BioPlugin Server is eventually able to get
connected once the database is available.
Encryption Settings
Enable Database Encryption
Enable further encryption of identifier and biometric data stored in the database.
WARNING: Modification of the database encryption settings will render existing BioPlugin database
contents inaccessible. Only modify these settings on a blank database. Once database encryption has
been enabled for this installation, it cannot be disabled again.
Encryption Key
The key used to encrypt the biometric data in the database. If you do not wish to create the key
yourself, the Use Default Key button can be used.
14
Revision Date: 04/22/11
Bio-Plugin™ Biometric Software Installation Guide
Advanced Settings
Fingerprint Comparison Engine Matching Threshold
This controls how strict or lenient the biometric comparison engine is when comparing scanned
fingerprints against biometric data stored in the database. A higher value will make the system more
strict, increasing the security level. A lower value will make the system more lenient, making it more
user-friendly. The default setting of 100 should work fine for most environments.
WARNING: Setting this value too low can cause the comparison engine being too lenient, resulting in
false positive matches to biometric comparisons. If you intend to adjust this setting, it is recommended
that you do so in small increments, testing the system performance after each adjustment.
Identification Behavior
Customize the one-to-many identification behavior of the BioPlugin Server software.
Compare against both "left" and "right" templates per person
By default, the BioPlugin system stores two biometric templates (e.g. a "left" finger and a "right"
finger, or a "left" hand and a "right" hand) for each person. With this option selected, the BioPlugin
Server will compare against both "left" and "right" biometric templates whenever a single template
identification operation is performed.
Compare against only single template ("left") per person
15
Revision Date: 04/22/11
Bio-Plugin™ Biometric Software Installation Guide
If the BioPlugin system is being used in such a way where only a single biometric template is ever
being registered for each person, there is no need to search two biometric templates for each
person. With this option selected, the BioPlugin Server will only compare against one template per
person, potentially reducing the comparison time by 50%.
Search persons from all database segments (Location IDs)
The BioPlugin system supports logical segmentation of the biometric data stored in its database. If this
functionality is being used, this option can control the identification behavior. If enabled, the BioPlugin
Server will search the specified data segment (Location ID) first, and if no match is found, will continue
searching the remainder of the database. If disabled, the BioPlugin Server will search the specified data
segment (Location ID) and if no match is found, it will stop and return the appropriate "no match found"
result.
Prevent duplicate templates from being registered to multiple persons
If enabled, during the biometric registration process, the BioPlugin system will check the template(s)
scanned during the registration to ensure that the template(s) are not already registered under a
different person's record. This will ensure that each registered biometric template is unique in the
system. If disabled, the BioPlugin system will not check teample(s) scanned during the registration
process to ensure that the template(s) are not already registered. This will potentially allow the same
biometric template to be registered under multiple person records.
WARNING: Disabling this option can result in unexpected results if identification (one-to-many)
comparisons are performed, and should only be disabled if the BioPlugin system is being used strictly in a
verification (one-to-one) capacity.
Legacy BioPlugin Client Support
Control the handling of requests from legacy (version 6.x) versions of the BioPlugin Client software.
Allow requests from legacy BioPlugin Fingerprint Clients
In addition to requests from Hybrid BioPlugin Clients, also allow the BioPlugin Server to handle
requests from existing legacy BioPlugin Client installations utilizing fingerprint scanners. Requests
from legacy BioPlugin Clients utilizing finger vein scanners will be refused.
Allow requests from legacy BioPlugin Finger Vein Clients
In addition to requests from Hybrid BioPlugin Clients, also allow the BioPlugin Server to handle
requests from existing legacy BioPlugin Client installations utilizing finger vein scanners. Requests
from legacy BioPlugin Clients utilizing fingerprint scanners will be refused.
Do not allow requests from any legacy BioPlugin Clients
Requests from all legacy BioPlugin Clients will be refused.
View BioPlugin Server Configuration File
Open the BioPlugin Server configuration file to allow manual inspection and/or modification of the
system settings.
16
Revision Date: 04/22/11
Bio-Plugin™ Biometric Software Installation Guide
WARNING: Extreme care should be taken if manual modification of system settings is performed.
License Settings
USB SmartLock
Displays the status of the USB SmartLock component, if one is connected. A connected USB SmartLock
will activate the BioPlugin Server software.
License ID
Displays the machine-specific Installation ID for this BioPlugin Server installation, which can be used to
generate a License ID to activate the BioPlugin Server software. If a License ID has been entered, it will
be displayed here.
Current License Details
Displays the details of the currently utilized method of license activation.
•
•
•
•
•
If no license activation method is available, it will instruct you to connect a USB SmartLock or
enter a License ID.
If a USB SmartLock is connected, it will display the details of its contents.
If a valid License ID has been entered, it will display the details of its contents.
If an invalid License ID has been entered, it will inform you that the License ID is invalid.
If both a USB SmartLock and valid software License ID are present, the USB SmartLock takes
precedence.
17
Revision Date: 04/22/11
Bio-Plugin™ Biometric Software Installation Guide
Database Configuration
By default, the BioPlugin Server software is configured to use a Microsoft Access database file, which is
included in the BioPlugin Server installation folder. If you wish to use a different type of database
environment, or a different Access database file, you will need to do the following:
1. Create the necessary database structure (tables and fields) in the desired database environment
2. Modify the database connection string that the BioPlugin Server software uses to communicate
with that database
Creating the database structure
There are a number of sample .SQL script files for the common SQL-compliant database environments
provided in the BioPlugin Server installation folder which can be used to help you create the necessary
tables and fields for the BioPlugin Server software. For Microsoft Access, you can recreate the necessary
tables and fields by duplicating the structure in the provided Database.mdb file.
Modify the database connection string
Once the necessary database structure is in place, the BioPlugin Server software must be told how to
communicate with the database. This is done through its database connection string setting in the
M2SYS BioPlugin Server control panel entry.
There are a number of sample connection strings provided to serve as a starting point for connecting to
the more common SQL-compliant database environments, however, these sample templates will
generally need to be modified to reflect your specific database. For more sample database connection
strings, please visit www.ConnectionStrings.com
Note: You will need to stop and restart the BioPlugin Server to apply any settings changes.
Client Installation
First, download the BioPlugin Client MSI file provided to you via email, or insert your BioPlugin CD.
1.
2.
3.
4.
5.
6.
Run the BioPlugin Client installation MSI file
Click "Next" to proceed through the first two dialog screens
Read and accept the License Agreement
Enter your user information
Change the installation folder if desired (the default should be fine for most situations)
Review the installation settings, and click "Install"
18
Revision Date: 04/22/11
Bio-Plugin™ Biometric Software Installation Guide
The BioPlugin Client software will now be installed. Connect the USB biometric scanner to the computer
when prompted at the end of the installation.
If the BioPlugin Server is installed on a different computer than the Client, either change the IP value in
the Server section of the client.ini file to correctly reference the IP address or hostname of the machine
where the BioPlugin Server software is installed, or use the SetServerInfo method at runtime (see the
BioPlugin Integration Document for more details).
After finishing installation and rebooting, the BioPlugin Client will start automatically.
IMPORTANT: If you are running the BioPlugin Client on the same computer as the BioPlugin Server,
the BioPlugin Client will run without needing separate activation. If, however, you are running the
BioPlugin Client to communicate with a remote instance of the BioPlugin Server, the BioPlugin Client
will prompt you for your software license activation before it will run successfully.
Client Activation
If the BioPlugin Client requires activation to run, it will display the Biometric Client: License Activation
window. The BioPlugin Client software can be activated in one of three ways:
•
•
•
USB SmartLock
License ID (LID) from biometric reader
Machine-specific License ID
Once it has been activated, the BioPlugin Client software will automatically start at boot-up.
USB SmartLock
1. Connect the green "Client" USB SmartLock to the USB port of the
computer where the BioPlugin Client software is installed
2. Wait for the device to be detected by Windows (this may take a minute)
3. The BioPlugin Client License Activation window will disappear
19
Revision Date: 04/22/11
Bio-Plugin™ Biometric Software Installation Guide
automatically
IMPORTANT: The USB SmartLock must remain connected to the computer for the BioPlugin Client
software to continue to remain activated.
Biometric Reader LID
Some biometric readers supported by BioPlugin have a unique hardware identifier that can be used to
active the BioPlugin Client software. These include:
•
•
M2-S fingerprint reader
• Has a unique LID (License ID) printed on the bottom of the device.
• Enter the LID number into the Client License Activation screen to activate the BioPlugin
Client software.
M2-EasyScan fingerprint reader
• Has a unique LID (License ID) built into the device itself.
• As long as the device remains connected to the computer, the BioPlugin Client software
will be activated.
Not all models of biometric reader supported by the BioPlugin software have an LID number. If yours
does not, you will need to activate the software using one of the other two methods.
Note: If the biometric reader whose LID was used to activate the BioPlugin Client software is
disconnected, or moved to a different computer, the BioPlugin Client software will require activation and
prompt for a License ID again when it is next restarted.
20
Revision Date: 04/22/11
Bio-Plugin™ Biometric Software Installation Guide
Machine-specific License ID
In the BioPlugin Client License Activation window, you will see an Installation ID is automatically
provided for you. By supplying this Installation ID to your software vendor, you will be provided an
License ID to enable your BioPlugin Client installation.
If you purchased your software from M2SYS directly, you can generate your own License ID on the
M2SYS License Page.
If you purchased your software from another software vendor, you will need to contact that vendor to
obtain your License ID.
Verifying Client Functionality
Once the BioPlugin Client software is installed and activated, you can verify its basic functionality
manually by following these steps:
1.
2.
3.
4.
5.
6.
7.
Open Command Prompt window (Start -> Run -> "cmd")
Change to where BioPlugin Client was installed (“cd \Program Files\BioPlugin”)
Manually call the single-template Scanning window “m2sysplugin.exe IS 0”
The biometric scanning window will appear in the center of the screen.
Perform the scan using the method appropriate for the biometric device you are using.
You should see a graphical representation of the biometric scan appear in the scanning window.
At the top of the dialog you will see the message "Fingerprint processed" (or finger vein, or palm
vein, etc.) This indicates that client is communicating with the server.
• If a "Server connection failed" or "Invalid server name" message is displayed, confirm:
• In the client.ini you have the correct IP or hostname specified for the BioPlugin
Server
21
Revision Date: 04/22/11
Bio-Plugin™ Biometric Software Installation Guide
The BioPlugin Server software is running properly (Service Assistant icon is
green, no errors in log files, etc.)
• There is no firewall software on the server computer blocking the incoming TCP
requests on the appropriate port (1200 by default)
8. Manually stop the scanning window when finished "m2sysplugin.exe IS -1"
•
22
Revision Date: 04/22/11
Bio-Plugin™ Biometric Software Installation Guide
Appendix
Accessing the BioPlugin Server Preferences
The majority of BioPlugin Server software configuration can be accomplished through the “M2SYS
BioPlugin Server” entry in the Windows Control Panel. In order to access this:
1. Click the Start Button
2. Click Control Panel
• If you see "Pick a category" at the top of the Control Panel window, click “Switch to Classic
View” or “View by: Large Icons” depending on your version of Windows
3. Open the M2SYS BioPlugin Server entry from the Control Panel list
Note: You will need to stop and restart the BioPlugin Server to apply any settings changes.
Generating a License ID
If you purchased your software from M2SYS directly, you can generate the necessary License ID to
activate your software on the M2SYS License Page.
23
Revision Date: 04/22/11
Bio-Plugin™ Biometric Software Installation Guide
1. Logon to your account on the M2SYS License Page at www.m2sys.com/license-index.htm
2. Enter the Installation ID for your software installation from the License screen of the BioPlugin
Server or BioPlugin Client software.
3. Select the appropriate BioPlugin license type
• Integration Server license for internal development and testing of the BioPlugin Server
• Production Server license for a production deployment of the BioPlugin Server
• Client license for the BioPlugin Client
4. Enter a descriptive comment for the installation (Q/A Testing, Customer ABC, etc.)
5. Click the Generate button to generate your Server License ID
6. Enter the generated value into the License ID field in the BioPlugin Software license screen
Note: If you purchased your software from another software vendor, you should contact that company
for assistance in activating the M2SYS software.
Accessing the Windows Services Control Manager
Checking the status of the M2SYS BioPlugin Server service, as well as starting and stopping the service,
can be accomplished through the Windows Services control manager.
1. Click the Start Button
2. Click Control Panel
• If you see "Pick a category" at the top of the Control Panel window, click “Switch to Classic
View” or “View by: Large Icons” depending on your version of Windows
3. Open the Administrative Tools entry from the Control Panel list
4. Double-Click the Services entry to open the Windows Services control manager
Once open, find the M2SYS BioPlugin Server entry in the Services list. If the BioPlugin Server is running,
the Status field will show Started. To start the service, right-click on it and select Start. To stop the
service, right-click on it and select Stop.
24
Revision Date: 04/22/11