fbf bioserver 2 - fulcrum biometrics...fbf bioserver – quick start guide about fbf bioserver...

14
Quick Start Guide This Quick Start Guide provides information and guidance on installation and commissioning FbF bioServer. Fulcrum Biometrics, Inc. USA 16108 University Oak San Antonio, TX 78249 Office: +1-800-430-4601 Intl: +1-210-257-5769 Fax: +1-210-348-3691 [email protected] www.fulcrumbiometrics.com Version: 0.1, No: BSRVR20-QS01 FbF bioServer 2.0 Released on: August 26, 201

Upload: others

Post on 12-Feb-2021

5 views

Category:

Documents


0 download

TRANSCRIPT

  • FbF bioServer – Quick Start Guide

    1

    Quick Start Guide

    This Quick Start Guide provides information and

    guidance on installation and commissioning FbF

    bioServer.

    Fulcrum Biometrics, Inc. USA 16108 University Oak San Antonio, TX 78249 Office: +1-800-430-4601

    Intl: +1-210-257-5769Fax: +1-210-348-3691

    [email protected]

    www.fulcrumbiometrics.com

    Version: 0.1, No: BSRVR20-QS01

    FbF bioServer 2.0

    Released on: August 26, 201

    mailto:[email protected]://www.fulcrumbiometrics.com/

  • FbF bioServer – Quick Start Guide Content

    Fulcrum Biometrics LLC 2

    Content

    1. Introduction ........................................................................................................................... 3

    2. About FbF bioServer .............................................................................................................. 4

    3. Requirements for FbF bioServer ............................................................................................ 5

    4. Installation ............................................................................................................................. 6

    4.1 Installation through WE7S: .......................................................................................... 7

    4.2 Installation through Standalone Installer:................................................................... 9

    5. FbF bioServer Administration Application ........................................................................... 12

    6. Uninstall FbF bioServer ........................................................................................................ 14

  • FbF bioServer – Quick Start Guide Introduction

    Fulcrum Biometrics LLC 3

    1. Introduction This Quick Start Guide provides information and guidance on installation and commissioning

    FbF bioServer. To make this document short and easily accessible to users, only basic

    functionality and most common scenarios have been considered.

    To make this guide more comprehensive and to attract your attention to a important facts

    and information, this guide uses notation icons. All these notation icons are listed below

    with their meanings:

    Attention Required

    Important Information

    [email protected] www.fulcrumbiometrics.com

    Email Address. Click it to open the default emailing program Website Link. Click it to open the website in you default internet browser

    Detailed information on other prospective of FbF bioServer can be obtained from the

    following sources:

    1. For information on Maintenance and Administration, refer to “FbF bioServer - User and

    Administration Manual“.

    2. For information on how to develop client application, refer to “FbF bioServer -

    Developer’s Guide”.

    3. For any other information, contact Fulcrum Biometrics Support Team at

    [email protected]

    mailto:[email protected]://www.fulcrumbiometrics.com/[email protected]

  • FbF bioServer – Quick Start Guide About FbF bioServer

    Fulcrum Biometrics LLC 4

    2. About FbF bioServer The FbF bioServer is a high-speed, high-volume biometric transaction-processing engine

    with an objective of eliminating the time and cost required to develop and integrate a

    scalable biometric matching server. FbF bioServer is compromised of various components

    which are:

    1. FbF WCF Web Service: A WCF Service capable of receiving requests and send responses

    back to the client application built over Windows Communication Framework Classes.

    2. FbF Web Service: A simple web service hosted by IIS Server 7.0 which acts as another

    gateway for client applications to contact FbF bioServer. As web services are the most

    widely used channel for server communication, FbF Web Service allows rapid

    integration of FbF bioServer APIs into client applications

    3. FbF Matching Engine: It is the core component of FbF bioServer which is responsible for

    performing all the biometrics operations being carried out in bioServer.

  • FbF bioServer – Quick Start Guide Requirements

    Fulcrum Biometrics LLC 5

    3. Requirements for FbF bioServer AREA REQUIREMENTS

    Operating System Windows 7 Windows 7 Embedded Standard Windows Server 2008

    Processor Intel® Pentium® IV, 2GHz or faster processor (or equivalent)

    Memory Requirements 2GB of RAM or higher

    Installation Footprint Approximately 100 MB

    Database Microsoft SQL Server 2008 R2 or higher

    Web Server Technology IIS Server 7.0 or higher

    Logical ports used by application

    80: To send request to Standard Service from other machines.

    8523: To access FbF bioServer’s WCF based web service. 8534: To access FbF bioServer’s Web Service.

  • FbF bioServer – Quick Start Guide Installation

    Fulcrum Biometrics LLC 6

    4. Installation There are two methods of installing FbF bioServer on a machine. Two methods are listed

    below:

    1. Windows Embedded 7 Standard: Windows Embedded 7 Standard operating system

    image (ISO) with FbF bioServer pre-installed and pre-configured on it.

    2. Standalone Installer: A bioServer installation program which basically installs and

    configures bioServer on existing operating system.

  • FbF bioServer – Quick Start Guide Installation (WE7S)

    Fulcrum Biometrics LLC 7

    4.1 Installation through WE7S:

    RAR files available on the download link provided to you are the segments of DVD ISO

    image of FbF bioServer 2.0 WE7S. Follow the procedure below in order to re-generate

    the ISO image using these segments. Please note that you need to have latest version

    of WinRAR software installed on your machine to perform step 3 and 4 below.

    1. Click on the download link. It will take you to the “FbF BioServer 2.0 WE7S” License

    Agreement and Download page.

    2. This page displays the “End User License Agreement (EULA)” of bioServer. Please

    read it carefully.

    3. If you agree to the EULA: a. Please enter your Name and Email Id in the “Name and Email-Id” field b. Check the “I Agree” checkbox and click “Continue” button to go to the

    Download Page. 4. On download page, select any one or all the parts of the ISO image that you want

    to download. If you have selected more than one part, FileAnyWhere will zip all

    the selected part together in a single file and start the download of the same.

    5. Once you have downloaded all the 18 part of the ISO image on your computer,

    place them in a single directory\folder.

    6. Right click on any one of it and start the extraction process using WinRAR

    software. Provide the desired location to save the ISO image when asked by

    WinRAR software.

    7. WinRAR will automatically locate and start extraction of all the parts (starting with

    first) and will save the complete ISO image in the end of the extraction process on

    the provided location.

    8. Once you have recreated the ISO image, you can use it to install either on a virtual

    machine or a read hardware.

    9. To install it on a virtual machine, simply create a new virtual machine and provide

    the ISO image as OS installation media.

    10. To install it on a real hardware, you will first have to burn the ISO image on a DVD

    media. Also, it is highly advisable to burn the DVD in 4x speed. High speed burning

    may result in non-functional DVDs.

  • FbF bioServer – Quick Start Guide Installation (WE7S)

    Fulcrum Biometrics LLC 8

    11. Insert the bioServer DVD media burned using the downloaded ISO image into the

    DVD drive of the machine where you want install bioServer WE7S and boot your

    computer using the same.

    12. Once computer boots using the bioServer DVD media, it will automatically start

    the bioServer WE7S install on the host computer. Follow the on screen instructions

    to install the bioServer in desired configuration.

    Please make sure that you use “Create DVD from ISO image” option to create installation DVD. Simple burning the ISO image as file on the DVD will not work.

    All the Data will be lost on the drive where FbF bioServer WE7S will be installed. Users are recommended to perform thorough backup of the drive where they are planning to install bioServer WE7Sif they have any useful data on it.

    During the bioServer WE7S installation, you will be asked for your preference on following settings. Choose the options as per your requirements. 1. Windows Embedded 7 License Agreement 2. Logical Drive partition to install bioServer WE7S. You can also Create, Delete

    or Format partitions at this stage. Please remember that all the data will be lost on drive on which Create, Delete or Format option will be used.

    3. Country and Language Settings 4. System Date and Time

  • FbF bioServer – Quick Start Guide Installation (Standalone)

    Fulcrum Biometrics LLC 9

    4.2 Installation through Standalone Installer:

    Standalone installer helps you to install FbF bioServer on a machine that already has

    an Operating System installed on it and meets all the above mentioned requirements.

    Follow the list of instructions below which will guide you through the process step by

    step.

    1. Run the “FbF bioServer.exe” file standalone installer provided to you as bioServer

    installation program.

    2. Installation program will display FbF bioServer End User License Agreement (EULA). Please read the license agreement carefully and if you agree to it, click the “Accept” button to indicate your acceptance and continue installation.

    3. Installer will then run a various checks on your computer for the FbF bioServer

    Pre-requisites (required framework and other software dependencies). After the

    tests are complete, setup will display a report as visible in the image above. If any

    of the pre-requisite is not present on the target machine, you should install the

    pre-requisite manually and start the FbF bioServer installation again.

    Sometime Installer is not able to detect MS SQL Server instance on the machine thus provides you with an option to move forward.

    If you decide to move forward, installer assumes that there is a SQL Server instance on the machine which you are aware of. If you are not sure about the presence of SQL Server on your machine then contact your Administrator to provide you with the details. The image for the scenario has been shown above.

  • FbF bioServer – Quick Start Guide Installation (Standalone)

    Fulcrum Biometrics LLC 10

    4. Provide the installer with the directory name where you want to install FbF

    bioServer. Default installation path is:

    a) For 32-bit OS: “c:\Program Files\Fulcrum Biometrics\FbF bioServer”

    b) For 64-bit OS: “c:\Program Files (x86)\Fulcrum Biometrics\FbF bioServer”

    5. Provide installer with database server details, so that installer can setup a database for FbF bioServer. You will have to provide the credentials of database user “sa” or any other user with equivalent privileges.

    6. If any database with name used by FbF bioServer for its internal database is already present on the server, then installer is designed to overwrite the database after a warning as visible in the image.

    If you wish to take the backup of the existing database, then click “No” and run the FbF bioServer setup again after the backup is complete

  • FbF bioServer – Quick Start Guide Installation (Standalone)

    Fulcrum Biometrics LLC 11

    7. Enter the Taxonomy details which were provided to you at the time purchase.

    8. Enter the License Server IP Address and Port Number. It is recommended to use

    you bioServer machine also as your License Server. In this case, use following

    values.

    If you wish to create\host license server on some machine other than bioServer

    then use the corresponding IP Address and Port Number.

    Providing a wrong License Server IP Address and port will make FbF bioServer unable to acquire different license. FbF bioServer does not starts perform any operations in the absence of required licenses.

    To learn how to create\host a License Server, read the License Server section in FbF bioServer User and Administration Guide.

    License Server IP Address 127.0.0.1 License Server Port Number 5000

  • FbF bioServer – Quick Start Guide Administration

    Fulcrum Biometrics LLC 12

    5. FbF bioServer Administration Application FbF bioServer Administration Application is installed with all the version of FbF bioServer. It

    can be launched by clicking on the “FbF bioServer Admin” shortcut created on the User’s

    Desktop.

    FbF bioServer Administration utility allows users and administrators to monitor bioServer’s

    state and easily change different configurations parameters. Below is a snap shot of FbF

    bioServer Administration Utility and brief description of controls marked with number.

    1. FbF bioServer State: Its shows the current state of the FbF bioServer like Initializing,

    Started, Stepped etc (Ex. In above figure, FbF bioServer is in Stopped state). This section

    also allows user to start\stop FbF BioServer by clicking at the corresponding buttons.

    2. Home Tab: This tab allows user to modify the internal configuration related to matching

    and data processing.

    This application must be started under Administrator privileges else it will fail to start.

  • FbF bioServer – Quick Start Guide Administration

    Fulcrum Biometrics LLC 13

    a) Add New: Use this button to add a new instance of matching engine.

    b) Edit: Use this button if you want to modify an existing instance of matching server.

    While Adding or Editing a matching server, user interface will allow you to choose different possibilities for following configurations:

    Server Configuration Tab: This tab allows you to modify FbF bioServer database and

    license related configuration as showing in the image below. Before changing License IP

    and port, make sure that you have a license server running on the provided network

    location else application will display a message as shown in the image.

    FbF bioServer need to be stopped before making any changes in the configuration. This is to avoid conflicts between the configuration being used by the bioServer while its running and the new configuration.

  • FbF bioServer – Quick Start Guide Uninstall

    Fulcrum Biometrics LLC 14

    6. Uninstall FbF bioServer FbF bioServer can also be uninstalled from Add\Remove feature option of Control Panel.

    Steps to Uninstall FbF bioServer are follows:

    1. Open “Add\Remove Feature” option of the Control Panel and let it list all the programs

    currently installed on the machine.

    2. Locate and select the entry for FbF bioServer with name “FbF bioServer” and click

    Uninstall to start the un-installation process.

    3. A pop up may occur stating some of the FbF bioServer services will also be uninstalled,

    Click Ok to continue un-installation.

    4. Once Uninstall of FbF bioServer is completed it will prompt for a Windows restart, Click

    Ok, so that changes made to machine can come into effect. If you plan to restart later

    then choose “Restart Later” option.