BioConnect ID Enterprise v4.0 Installation Guide
BioConnect ID Enterprise v4.0 Installation Guide
0
Installation Guide
Revision 1.0
The goal of the BioConnect team is to make the software as easy as possible to install
and configure. If an unexpected problem occurs or if you would like some guidance,
please don’t hesitate to reach out using one of the contact methods listed below:
Support Website:
http://www.bioconnect.com/support/
Telephone:
Email:
Micro-Service Architecture:
-Improved system resiliency
-Core API implementation
-Other backend updates
Other Features:
-New ACM integrations supported
-In depth SDK/API connection feedback
-Additional card format presets
This chapter specifies the minimum and recommended hardware and software
requirements for BioConnect ID Enterprise Server and BioConnect ID Enterprise Client
installation. Before you can install BioConnect ID Enterprise, ensure that you have met
all the hardware and software requirements, PACS requirement and database
configurations requirement.
NOTE:
• If using Windows 7 (might need to run in compatibility mode- see Appendix C for
more information), Windows 8, Windows 8.1 or Windows 10, the BioConnect ID
Enterprise setup requires that you have administrative privileges.
• Adobe Reader is not required but highly recommended as you need it to read the
BioConnect ID Enterprise documentation.
HDD 10 GB 30 GB
RAM 4 GB 8 GB
Windows 7
Windows Server 2008 R2
OS Windows 8/8.1 Windows Server 2012 R2
Windows 10
Windows Server 2012/R2
Firewall: Open Ports Required TCP/UDP Ports 8000 (Server), 8001 (Gen 1), 51212 (Gen2), 1003 (Digitus)
x64 or x86 dual core processor with x64-capable quad core processor
CPU
speeds of 2.4 GHz or more with speeds of 2.3 GHz or more
HDD 10 GB 30 GB
Windows 7
Windows Server 2008 R2
OS Windows 8/8.1 Windows 8.1
Windows 10
Windows Server 2012/R2
NOTE:
Symmetry 7
AMAG Data Connect
Symmetry 8
ACM 5.4
-
Avigilon ACM 5.6
ACM 5.8 XML Connection
WinPak PE v4.0
Honeywell 6.6 - 7.2 API
WinPak PE v4.1
WinPak PE v4.4 8.3 - 8.5 API
NOTE:
Step 5. Click [Next] through Welcome page and Version Updates page.
• An internet connection
The software license restricts the number of devices that can be connected to the
software as well as other custom features.
Once you have the License Activation Code from us, select one of the three options
below (Online Activation/Offline Activation/Trial) to create / activate a license:
Enter the Activation Code and the number of devices included with your license and
click [Activate] to complete the licensing process. If successful, your license details will
be displayed on screen.
Offline:
Trial:
Click [Create Trial License] to begin your trial. Once you reach the Integration
Connections page of Setup Assistant, you’ll be asked to select the Access Control
platform being used with your BioConnect system.
Enter the windows account credentials that you want to use to run the BioConnect ID
Enterprise services. This account must be a local administrator on the server on which
it is being installed.
NOTE: If you want to confirm what your current windows account is, open Command
Prompt and type whoami to have it display your current login details:
The domain is either the prefix that everyone in your organization uses to login to
windows (Entertech\ywang) or is the local PC name if the account is simply a local
windows account.
Click [Next] and for this example we’ll choose [Express Setup].
Express Setup: This will install a BioConnect SQL Server 2008 R2 instance and
create the BioConnect ID Enterprise database automatically. (Recommended)
Custom Setup: This will allow you to choose where the BioConnect ID
Enterprise database is. If the database does not already exist, you will have to
create it manually using SQL Management Studio. (See Appendix B for more
information.)
Following configuration settings can be altered when you uncheck the [Use
Default Settings] box:
• Finger Template Type: click the drop-down menu to select the template
type (Suprema/ISO 198794-2/Ansi 378) you want to use for fingerprint
enrollment.
• Card ID Byte Order: click the drop-down menu to select the Card ID
Byte Order: LSB (Least Significant Bit) or MSB (Most Significant Bit).
Click Drop-down menu to select your ACM platform and click [Next] to continue with
the ACM Connection Configurations.
ACT: Once SQL Server finishes installing and creates the database, you will have to
connect the software to ACT. This is completed by entering the Server IP address and
full server name of the machine running ACT. You must also enter the password for the
Administrator account to ACTmanage.
Click [Save] and then click [Next] when you are ready to continue with Step 11- Service
Port Configuration.
AMAG: Once SQL Server finishes installing and creates the database, you will have to
connect the software to Symmetry. This is completed by entering the SQL Server login
details to access the Symmetry ‘multimax’ database. Click [Test] to confirm the
connection, and [Update] to save the configuration. (Refer to Appendix E for Symmetry
Configuration Details)
Click [Next] when you are ready to continue with Step 11- Service Port Configuration.
Generate Export CSV of all users to be brought into BioConnect. Ensure that that the
following settings are configured on the Avigilon XML Port configuration and designated
port is open and available on both systems:
ü “Installed” is checked-off
ü Schedule is set to “24 hours Active”
ü “Send Acknowledgements”, “Send Clears” and “Send Notes” are all checked off.
ü “User Audit” is the only value in the field on the right-hand column.
(NOTE: Do not make any changes to users in the Avigilon system while the CSV upload
Click [Save] and then click [Next] when you are ready to continue with Step 11- Service
Port Configuration.
Option 1- Brivo (Data Sync API): Once SQL Server finishes installing and creates
the database, you will have to connect the software to Brivo ACS. This is completed by
entering the Server Address, Login details and Account information (Account is required
for ACS Onsite Only).
Click [Save] and then click [Next] to continue with Step 11- Service Port Configuration.
Gallagher: Once SQL Server finishes installing and creates the database, you will have
to connect the software to Gallagher. This is completed by entering the SQL Server
login details to access the Gallagher database. Click [Test] to confirm the connection,
and [Update] to save the configuration. (NOTE: You will need to request SQL Server
Authentication for “Read Only” rights to the Gallagher database.)
Once finished, click [Next] to continue with Step 11- Service Port Configuration.
Once finished, click [Next] to continue with Step 11- Service Port Configuration.
Honeywell ProWatch: Once SQL Server finishes installing and creates the database,
you will have to connect the software to ProWatch. This is completed by either entering
the SQL server login details to access ProWatch database (recommended) or by
entering the server address of the Honeywell HSDK.
Option 1 (Recommended)- SQL Integration: You will need to provide the SQL
instance name and database name of the ProWatch Database. The below example is
the default database values for ProWatch database. Click [Test] to confirm the
connection, and [Update] to save the configuration.
NOTE: Please fill in random letters/characters (For example, “.”) in HSDK Integration
fields before clicking [Test]. These letters/characters will not be used to establish
database connection, but simply a placeholder to continue the process.
Option 2 (Alternative)- HSDK Integration: The default value is provided for you if
you are installing BioConnect ID Enterprise on the same server where the HSDK is
installed. You will also have to provide the Windows Account credentials of a user who
has full permissions within ProWatch. Click [Test] to confirm the connection, and
[Update] to save the configuration.
Honeywell WinPak: Once SQL Server finishes installing and creates the database,
you will have to connect the software to WinPak. This is completed by entering the SQL
Server login details to access the WinPak database. Click [Test] to confirm the
connection, and [Update] to save the configuration.
Once finished, click [Next] to continue with Step 11- Service Port Configuration.
IMRON: Once SQL Server finishes installing and creates the database, you will have to
provide the Server Address of the IS2000 server. The default SDK port is 80. Also enter
the location/login details of the IS2000 SQL database for synchronization. Click [Test] to
Once finished, click [Next] to continue with Step 11- Service Port Configuration.
Kantech: Once SQL Server finishes installing and creates the database, you will have
to connect the software to Entrapass. You will need to provide the URL address of the
Entrapass SmartService location. The below URL example is the default address for an
Entrapass server installed on the same machine as BioConnect ID Enterprise. You will
then need to provide the username and password for an Entrapass Operator. Click
[Save] to complete the configuration.
Once finished, click [Next] to continue with Step 11- Service Port Configuration.
Once finished, click [Next] to continue with Step 11- Service Port Configuration.
Lenel: Once SQL Server finishes installing and creates the database, you will have to
connect the software to OnGuard. This is completed by entering the location of the
DataConduIT server (Use “.” if it is on the local machine), as well as the SQL Server
connection for “Read-Only” or higher permissions to view the AccessControl database.
Click [Test] to confirm the connection, and [Update] to save the configuration.
Once finished, click [Next] to continue with Step 11- Service Port Configuration.
Once finished, click [Next] to continue with Step 11- Service Port Configuration.
Open Options: Once SQL Server finishes installing and creates the database, you will
have to connect the software to dnaFusion. This is completed by entering the Server
address or name where dnaFusion is installed, and entering the Flex API Key. Click
[Save] and [Next] when you are ready to continue. If BioConnect ID Enterprise is being
installed on the same machine as the DNAFusion server, please leave the default Server
Address as is.
PACOM: Once SQL Server finishes installing and creates the database, you will have to
connect the software to GMS. First, you will need to provide the GMS credentials of a
user who has full permissions within GMS. Second, you will need to provide the SQL
instance name and database name of the GMS database. The below example is the
default database values for a GMS server installed on the same machine as BioConnect
ID Enterprise. Click [Test] to confirm the connection, and [Update] to save the
configuration.
Once finished, click [Next] to continue with Step 11- Service Port Configuration.
Once finished, click [Save] and then click [Next] to continue with Step 11- Service Port
Configuration.
PCSC: Once SQL Server finishes installing and creates the database, you will have to
provide the Server Address of the PCSC LiNC-PLUS database. Enter the Server Name
and instance (if applicable), and the desired login credentials. Click [Test] to confirm
the connection, and [Update] to save the configuration.
Once finished, click [Next] to continue with Step 11- Service Port Configuration.
S2: Once SQL Server finishes installing and creates the database, you will have to
provide the IP address of the NetBox Controller. Enter the password for the Admin login
for the NetBox which will be used to connect for synchronization.
Software House: Once SQL Server finishes installing and creates the database, you
will have to connect the software to CCURE. You do this by entering the SQL Server
login details to access the CCURE database. If you are using CCURE 9000 v2.2 or
below, the database name will be SWHSystem. With v2.3 or above, the database will be
ACVSCORE. Ensure to also link the Audit database on the second tab. Click [Test] to
confirm each connection, and [Update] to save the configuration.
Once finished, click [Next] to continue with Step 11- Service Port Configuration.
Once finished, click [Next] to continue with Step 11- Service Port Configuration.
Verify the default port values (preloaded by Setup Assistant). Click [Save] to confirm
and then click [Next] to continue with Step 12- System Startup.
Click [Start] to automatically start the services and complete the first synchronize of all
data from your access control software. If this is an upgrade or reinstall and the
database already has cardholder records, still continue with the synchronize - You will
not lose any templates or data.
If any problems arise while the system attempts to startup, the diagnostic checklist
below the [Start] button will alert you to the source of the issue.
Click [Next] and then [Finish] to complete the Setup Assistant. The BioConnect ID
Enterprise client will automatically open.
Username: Entertech
Password: Bobcat
2. Once the setup completes, click [Finish]. The Setup Assistant will only open if the
client is installed on the server (localhost).
3. Click through the Setup Assistant until you reach the server Settings page. Enter the
IP Address of the Server. This will be used for the clients to connect into the BioConnect
ID Enterprise services. Select which ACM platform you’re integrating with from the
dropdown menu list. The port typically used for the BioConnect ID Enterprise client is
TCP:8000. This port will have to be open on the Server’s firewall for communication to
occur.
4. If you are using a BioMini USB Fingerprint enrollment capturing device, please install
the Suprema Fingerprint Scanner Driver included with the BioConnect ID Enterprise
package before connecting the device to the PC.
The Quick Enrollment section of the software is where all biometrics are captured. To
enroll a fingerprint:
It is critical for the success of the system that good enrollments are captured. Below is
an example of a good enrollment:
In the above example, you can see that the middle of the finger is placed in the middle
of the scanner. You can clearly see the ridges of the fingerprint and the quality score is
at 100% (Quality scores are only available when enrolling from the BioMini USB
scanner).
WARNING: Placing your fingers too low on the scanner, or not placing the finger flat
create poor enrollments. These will lead to low success rates and could also increase
the possibility of a False Accept (Having a fingerprint show up as another cardholder).
Although this is extremely unlikely, having a high volume of poor fingerprints
(Fingertips) in the software can lead to issues as fingertips do not have as much unique
data as the middle of the finger. Always ensure that you are capturing the best
fingerprints possible during the enrollment phase. These enrollments are going
to be the basis for all fingerprint matching going forward.
The maximum number of face templates that should be sent to a device for 1:N
matching (Matching with only your face/biometric only) is 1,000. To use more than
1,000 faces in a given location group, a 1:1 verification should be used (Either typing
the BioConnect ID into the device before verifying your face, or by presenting a card to
the device before verification.
You can enroll two face templates per user (Not required). If a user occasionally wears
glasses, it is best to enroll them both with and without glasses.
Delete Templates: Clicking [Delete Templates] will remove all of the user’s templates
from the system and devices. Once the templates are deleted, the user will have to re-
enroll before using the system again.
Sync with Device: Using the Sync with Devices function will re-send the templates to
the appropriate location device groups. If you want to change the device sync locations
after the enrollment process has been completed, make the location changes and click
[Sync with Device].
Solution:
The software is performing a number of steps in the background during this stage of
the installation process. Depending on the machine it is installing on, it is not
uncommon for the software to stay on this stage for several minutes. Please be patient
and the software installation will be complete.
Solution:
If you receive an error during installation that the BioConnect ID Enterprise services are
not running, the best troubleshooting step is to open the BioConnect ID Enterprise log
file and scroll all the way to the bottom:
On the next page you will find a few possible errors and how to resolve them.
BioConnect ID Enterprise installs in a free 30-day trial mode on a new PC. Once
this trial is expired, the services will not start, so you will want to ensure that you
have acquired a license before the end of this period. If the software has already
expired, you will need to contact BioConnect at “[email protected]” to
acquire a new license.
If you encounter issues during the BioConnect ID Enterprise installation that were not
covered here, please don’t hesitate to reach out to us or visit our support website.
Support Website:
http://www.bioconnect.com/support/
Telephone:
Email:
• Avoid using the Pinky Finger, as it is typically too small for good verification (as
shown in Figure 1).
Figure 1
• Place on the Center: Position center of fingerprint (core) to the center of the
sensor (as shown in Figure 2).
Fingerprint Core
Figure 2
• Maximum Contact Area: Place your finger to completely cover the sensor with
maximum contact surface (Figure 3 shows some examples of correct and wrong
positioning of finger).
• Hold Your Finger Still: Once you place finger on the sensor, hold your finger
still until enrollment process completes.
Figure 3
• In Figure 4, you can see that the finger core is placed in the middle of the
scanner. The ridges of the fingerprint clearly identified and the quality score is at
100% (Quality scores are only available when enrolling from the BioMini USB
scanner).
Figure 4
• Placing your fingers too low on the scanner, or not placing the finger flat create
poor enrollments. Examples below shown in Figure 5 will lead to low success
rates and could also increase the possibility of a False Accept (Having a
fingerprint show up as another cardholder).
Figure 5
1. In Server name field, you will need to provide the SQL instance name. The
below example is the default database values for a SQL server installed on the
same machine as BioConnect ID Enterprise.
2. In Database field, you can create a name for BioConnect ID Enterprise
Database. In this example, we name it ‘BioConnect_MAS’.
3. Select “Windows Authentication” in Authentication field.
4. Click [Create] to create a new BioConnect ID Enterprise Database.
5. Click [Test] to verify the Server name and Database are configured correctly.
6. Click [Update] to save the above configurations.
7. Click [Next] to continue with Step 9 (page 18).
To make sure BioConnect ID Enterprise Service function properly, installer may need to
run in compatibility mode. To perform compatibility mode setting, complete following
steps:
Refer to section 5 for BioConnect Master Server and BioConnect Slave Server
installation steps using BioConnect Setup Assistant.
NOTE:
• Trial License currently does not support BioConnect ID Enterprise Pro installation.
• For BioConnect Slave Server (SAS) installation, stop at Step 10- “Integration
Connections” and exit Setup Assistant.
(The SAS installation will not actually connect to any PACS. It will synchronize all
user data from the MAS.)
Database Configuration
1. In Server name field, you will need to provide the SQL instance name. In this
example, the SQL instance name is ETSDEV-SYMMETRY. (To find out SQL
instance name, log into SQL Server Management Studio as Administrator and the
dialogue window below will show up. Server name here “ETSDEV- SYMMETRY” is
the SQL instance name.)
6. Stop services by right clicking BioConnect Biometric Service and then click [Stop]
</appSettings>
<hibernate-configuration xmlns="urn:nhibernate-configuration-2.2">
1. Login to Symmetry and ensure that you have a DataConnect License installed. For
Symmetry Enterprise customers, this license is automatically included with the
Enterprise software, so an additional license is not necessary.
3. To enable the capture button, you must add the following text to the bottom of
the multimax.ini file. Open the configuration file by clicking the Windows Start
button > search for multimax.ini and open the file with NotePad.