Download as pdf or txt
Download as pdf or txt
You are on page 1of 43

BiomAPI Installation Manual

Document Information

Attribute Value
Document Name BiomAPI Installation Manual
Project Name BiomAPI
Date Created 07th May 2014
Author Ashik Meeran.M
Document Version 1.0.0

CONFIDENTIAL 1 of 43
BiomAPI Installation Manual

Copyright Information

This Software is the proprietary product of Precision Biometric and is protected by the
copyright laws and international provisions. You may not use, copy, modify, or transfer the software
or documentation, or any copy, except as expressly provided in this agreement.

I. Procedure:

1. Software Requirements

2. Package Installation

3. Configuring the Biometric SDK

4. Testing the Biometric SDK

5. Frequently Asked Questions (FAQ)

6. Support Contact Details

CONFIDENTIAL 2 of 43
BiomAPI Installation Manual

1) Software Requirements

Operating System : XP and above


RAM : 512 MB and above
USB Port : at least one USB port should be enabled
Jre : latest java runtime environment

CONFIDENTIAL 3 of 43
BiomAPI Installation Manual

2) Package Installation

1. Login into the system as administrator

2. Download the Biometric SDK to the local system and unzip it.

3. Right click the BiomAPI.exe and select Run As Administrator

CONFIDENTIAL 4 of 43
BiomAPI Installation Manual

4. Please close all running browsers & unplug the fingerprint scanner from the system and
press ok button to proceed the installation otherwise click cancel button to cancel the
installation.

5. If the Biometric SDK (BiomAPI) is already installated in the local system, the
following screen will appear otherwise proceed to the next step

a) Click ok to remove the installed version or cancel to cancel the installation.

b) Click the uninstall button to remove the Biometric SDK from the local
system.

CONFIDENTIAL 5 of 43
BiomAPI Installation Manual

CONFIDENTIAL 6 of 43
BiomAPI Installation Manual

c) Click the close button to close the uninstallation wizard

CONFIDENTIAL 7 of 43
BiomAPI Installation Manual

6. Click the I Agree to proceed the installation.

CONFIDENTIAL 8 of 43
BiomAPI Installation Manual

7. Make sure that all the check boxes are checked and click Next button

CONFIDENTIAL 9 of 43
BiomAPI Installation Manual

8. Click Install button to continue the installation

CONFIDENTIAL 10 of 43
BiomAPI Installation Manual

CONFIDENTIAL 11 of 43
BiomAPI Installation Manual

9. Click Next to continue

CONFIDENTIAL 12 of 43
BiomAPI Installation Manual

10. Check license aggrement check box and click install

CONFIDENTIAL 13 of 43
BiomAPI Installation Manual

11. Click Finish to continue

CONFIDENTIAL 14 of 43
BiomAPI Installation Manual

12. Click Next to continue.

CONFIDENTIAL 15 of 43
BiomAPI Installation Manual

CONFIDENTIAL 16 of 43
BiomAPI Installation Manual

13. Click Finish to continue

CONFIDENTIAL 17 of 43
BiomAPI Installation Manual

14. Press Close button to close the installation wizard.

15. Save all the data and press Yes to reboot the system now otherwise No to ignore
the reboot.

Note:

It is highly recommended to reboot the system after successful installation of


Biometric SDK

CONFIDENTIAL 18 of 43
BiomAPI Installation Manual

3) Configuring Biometric SDK


3.1) Configuring Java Runtime Environment:

1. Check whether latest Java Runtime Environment is installed in the system, otherwise
download the latest jre from the following location
http://java.com/en/download/index.jsp

2. Go to Control Panel and double click on Java


3. Remove the Temporary files from java runtime environment
a) In General tab, click on settings
b) Click the button Delete Files
c) Make sure that all the check boxes are checked

d) Press ok to delete the temporary files


e) If the following screen appears, Press ok to continue.

CONFIDENTIAL 19 of 43
BiomAPI Installation Manual

f) Uncheck the checkbox “keep temporary files on my computer” and click ok.

CONFIDENTIAL 20 of 43
BiomAPI Installation Manual

4. If you are using JRE version 1.7 update 51, Add the URL to the Security site list
a) Select the tab Security, Click the button “Edit Site List”

CONFIDENTIAL 21 of 43
BiomAPI Installation Manual

b) And then click the button “Add”.

CONFIDENTIAL 22 of 43
BiomAPI Installation Manual

c) Enter the following URL to the location text box


i. file://C:\\Program Files\\Legend
Systems\\BiomAPI\\TestLegendScanner.html.
ii. Application URL

d) Press ok to finish.

CONFIDENTIAL 23 of 43
BiomAPI Installation Manual

3.2) Configuring Internet Explorer:

1. Add the Server IP address to the Trusted Sites

1.1. In internet explorer, Click Tools and then Internet Option


1.2. Click Security tab, then click Trusted Sites > Sites.
1.3. Type the IP address into the Add this web site to the zone field, click Add.
1.4. Server IP address is added to the websites field.

2. Change the Active x Settings

2.1 Go to Control Panel > Internet Options


2.2 Click the security tab and then click the Trusted Sites
2.3 Click the Custom level button
2.4 Select enable for “Download signed Activex Controls” and “Initialize and script
Active x controls not marked as safe for scripting” as shown in the figure

CONFIDENTIAL 24 of 43
BiomAPI Installation Manual

3. Turn off popup blocker

a) Clicks Tools and then Internet options


b) Go to privacy tab
c) Make sure that “Turn on pop blocker“ is not checked

CONFIDENTIAL 25 of 43
BiomAPI Installation Manual

CONFIDENTIAL 26 of 43
BiomAPI Installation Manual

4. If it is internet explorer 9 / 10, Disable Activex filter

d) Go to Settings and then safety


e) Make sure that Activex Filtering is not checked

5. Clear the cache and cookies in the browsers

a) In internet explorer, Click Tools and then Internet options


b) Click the “Delete” button
c) Select the checkbox for Cookies, Temporary Internet Files and Preserve Favorites
website Data

CONFIDENTIAL 27 of 43
BiomAPI Installation Manual

d) Click “Delete”

CONFIDENTIAL 28 of 43
BiomAPI Installation Manual

3.3) Configuring Firefox:

1. Clear the cache and cookies in the browser


a) Go to History and select “Clear Recent History”
b) Change the “Time range to clear” to ”Everything”
c) Select the checkbox Cookies, Cache, Offline Website Data

d) Click Clear Now


2. Enable the Addon
a) Goto Tools->Add-ons and then extensions
b) In that check whether java is enabled or not if not enable it.

CONFIDENTIAL 29 of 43
BiomAPI Installation Manual

3.4) Configuring Google Chrome:

1. Clear the cookies and cache from the browser


a) Click the Marked icon as shown in figure

b) And go to “settings” and then select the “Show Advanced settings”


c) Click the button “Clear browsing data”

CONFIDENTIAL 30 of 43
BiomAPI Installation Manual

d) Select the option “the beginning of time” and select the checkbox Delete cookies
and other site and plug-in data, empty the cache.
e) Click the clear browsing data

Note: Please make the Biometric Configuration for the entire users who are going to use the
fingerprint scanner.

CONFIDENTIAL 31 of 43
BiomAPI Installation Manual

4. Testing the Scanner

1. Connect the fingerprint scanner to the system


2. Move to the Installation folder.
3. Locate TestLegendScanner.html
4. Open TestLegendScanner.html with Internet Explorer*.
5. Check the two check box as shown in the figure and click on run to proceed

6. Click “OK”

CONFIDENTIAL 32 of 43
BiomAPI Installation Manual

7. If the OS is Window XP, Click on the “To help protect …….” And Select “Allow Blocked
Content…” as shown in the figure otherwise click on Allowed blocked content.

8. Click “Yes”

9. Click “TestScanner” button


10. Click “Yes”

CONFIDENTIAL 33 of 43
BiomAPI Installation Manual

11. Swipe Your Finger in Constant Speed until Green Images appears three times, if you didn’t
swipe properly it take more times and it’s normal.

12. Click “OK”, close the window.


CONFIDENTIAL 34 of 43
BiomAPI Installation Manual

13. Start using your application.

CONFIDENTIAL 35 of 43
BiomAPI Installation Manual

5) Frequently Asked Questions (FAQ)


Are you still facing problem in using the Biometric SDK after configuring it? Please look in
to the following section

5.1) Is there no response after clicking the fingerprint capture button in


TestLegendScanner.html in internet explorer?

If your answer is yes. Please do the following steps to fix the issue.

1. Go to Tools->Internet Options, Click Advanced tab and uncheck the Disabling Script
Debugging (Internet explorer) and then press ok to close the wizard.
2. Open the TestLegendScanner.html in internet explorer and do the process as listed in the
Testing the scanner section
3. If the internet explorer give the following error

a. Login into the system as Administrator and close the all the running Internet
Explorer before doing the following steps
b. Go to start->All programs->Accessories->command prompt, if the OS above
Windows XP right click it and select Run as Administrator otherwise just click it to
open
c. Go to the Biometric SDK Installation location in command prompt

Eg: cd “C:\Program Files\Legend Systems\BiomAPI”

CONFIDENTIAL 36 of 43
BiomAPI Installation Manual

d. Type Register.bat and press enter.


e. Click ok

f. If the command prompt gives any error, please check the below
i. If the following error appears, please check whether you have the
administrator privilege to run the batch file or make sure that gone through
the above steps properly.

ii. If any other error appears, please contact the support team for further
assistance or make a screen shot of the error and drop a mail to the
support team or concern person
4. After success completion of above steps, test the scanner using the
TestLegendScanner.html

CONFIDENTIAL 37 of 43
BiomAPI Installation Manual

5.2) Is there no response after clicking the fingerprint capture button in


TestLegendScanner.html in chrome or Firefox?

If your answer is yes. Please do the following steps:

1. Make sure that Java add on is installed and enabled in the browsers
a. In Firefox, Click Tools->Addon, click the Plugins and check whether Java
Deployment Toolkit and Java™ Platform are in Always Activate option, if not,
please make the option to Always Activate
b. In Google chrome, Go to Settings->Click on Show Advanced Settings and click the
button Content Settings in privacy, Scroll down to find JavaScript and select the
radio button under the option Allow all sites to run JavaScript(recommended)
2. Enable Java Console
a. Go to Control Panel->Java, Click the Advanced tab
b. Select the radio button Show Console and press ok
3. Make sure that the Installation Path is present in the Environmental Variables
a. Right Click My Computer and go to Properties
b. Select Advanced tab and click the Environment Variables
c. Under System Variables, search for the variable PATH and click the edit button

d. Search for the Biometric SDK installation path in the Variable value textbox, if
not present copy the Biometric SDK installation path and paste it in the textbox
with followed by semicolon (;) as shown in the figure otherwise go to next step.

CONFIDENTIAL 38 of 43
BiomAPI Installation Manual

e. Press ok to close the wizard


4. Clear the cache and cookies in the browser (To know how to clear the cache & cookies,
check the section 3.4 & 3.5 in Configuring the Biometric SDK)
5. Open the TestLegendScanner.html in google chrome or Firefox and click the fingerprint
capturing button.
6. If there is still problem exist, contact the support team for further assitance or send the error
screen shot to the support team or concern person.

5.3) Are you getting the following screen shot when you are trying to capture fingerprint
from the TestLegendScanner or from the Application URL?

1. Please check whether the TestLegendScanner page or Application URL is added in the
java security list. For configuring the URL, please check the Configuring Java Runtime
Environment (3.2) under Configuring the Biometric SDK section.
2. Go to Control Panel->Java
a. In security tab, Lower the security level to minimum
b. In Advanced tab, select the Disable verification option in Mixed code
(sandboxed vs trusted) security verification

CONFIDENTIAL 39 of 43
BiomAPI Installation Manual

3. If there is still problem exist, contact the support team for further assitance or send the error
screen shot to the support team or concern person.

5.4) Is there no response after clicking the fingerprint capture button in the application URL
in internet explorer?

1. Make sure that fingerprint scanner is working properly in the TestLegendScanner.html


which is present in the Biometric SDK installation location.
2. If it is not working, please check the 5.1 section to fix this issue otherwise go to the next
step
3. Check whether the application URL is added in the trusted sites
a. In Tools->Internet options, Go to security tab and select the Trusted Sites
b. Click the button Sites
c. Check the whether Application URL is added in the trusted sites, if not please go
to the Configuring Internet explorer(3.3) to know the step for doing the same.
4. Check whether the Activex Settings are configured properly as listed below:
a. In Tools->Internet options, Go to Security tab and select the Trusted Sites
b. Click the button Custom level
c. Make sure that the following settings are properly configured under Activex
Controls and Plugins

i. Allow previously unsed ActiveX to run with out prompt - Enable

CONFIDENTIAL 40 of 43
BiomAPI Installation Manual

ii. Run ActiveX control and plugins - Enable

iii. Script ActiveXcontrol marked safe for scripting - Enable

iv. Only allow approved domains to use ActiveX without prompt -Disable

v. Allow Activex filtering (only in IE 10) -Disable

vi. Download Signed Activex Controls - Enable

vii. Initialize and script Activex Controls not safe for scripting - Enable

d. Go to Security Tab and enable Scripting

CONFIDENTIAL 41 of 43
BiomAPI Installation Manual

CONFIDENTIAL 42 of 43
BiomAPI Installation Manual

6) Support Contact Details


For any assistance feel free to contact Legend Systems Support Team.

Phone number : 044-3377 5210


E.Mail:biometricsupport@precisionit.co.in

CONFIDENTIAL 43 of 43

You might also like