The summary of Procedure

  1. Install BioStar 2.
  2. Install one of Milestone XProtect VMS (with professional license or higher).
  3. Install BioStar 2 Integration for Milestone XProject.

  4. Add IP Camera in Milestone XProtect VMS.
  5. Create new Access Control to connect Milestone to BioStar 2.
  6. Utilize XProtect Smart Client.

Before you integrate Milestone with BioStar 2, check the Prerequisites below.




Step 1: Install BioStar 2

Refer to the below link if you do not know how to install BioStar 2.
BioStar 2 Installation

If you use port number 443 and 9000 for BioStar 2, you should change it into other numbers. This is because the port number for BioStar 2 will have collided with the port number used when XProtect Management Client 2017 R3 is installed. When you set the port number 443 and 9000 for BioStar 2 and then try to install XProtect Management Client 2017 R3, you will get the below error.

When you set the port number 443 for BioStar 2 and then try to install XProtect Management Client 2017 R3, you will get the below error.


Therefore we recommend that you change the port number for HTTPS on BioStar 2 and 9000 port to avoid port conflict issues. Also, even if you changed HTTPS port for BioStar 2, the icon and configuration file do not be changed automatically. So, please update manually the icon and 'server_url.conf' file to the port number for BioStar 2's HTTPS.



Step 2: Install one of Milestone XProtect VMS (with professional license or higher)

You can download the installation file of Milestone XProtect VMS in the below link.

https://www.milestonesys.com/support/resources/download-software/

While you install the application, it is required to activate Milestone’s license.



Step 3: Install BioStar 2 Integration for Milestone XProject

You should install two installation files below.
Please click the link to download the installation files. (https://www.supremainc.com/en/solutions/suprema-integration-milestone.asp?sKIND_TYPE=GD01501)

  • AC Plugin for BioStar2.exe is used to connect the access control system and XProtect VMS.
  • WorkspacePluginforBioStar2.exe provides the functionality for using BioStar 2 in the XProtect Smart Client.

You can refer to BioStar2 Integration for Milestone XProtect Setup Guide to install them.

After succeeding in installation of two applications, start the Milestone XProtect Event Server manually. You can find it in the system tray and right-click on the below icon.




Step 4: Add IP Camera in Milestone XProtect VMS

When you run XProtect Management Client 2017 R3 and connect to your PC, you can see the below screen.




Prepare IP camera.
Go to Servers > Recording Servers.
Right click one of Recording Servers and select Add Hardware.




Select Express (recommended) and then click Next button.




Add new user and enter User Name & Password for IP camera. Then, click Next button.




If you enter the information correctly, available camera will be found. To add IP camera, click Next button.




Click Next button.




Click folder icon and select one default camera group. Then, click Finish button.




If you succeed in add IP camera, you can see your camera in the Recording Servers’s tree.




Step 5: Create new Access Control to connect Milestone to BioStar 2

Right click Access Control and select Create new.




Enter all items.

  • Name: Enter name of Access Control you want to use
  • Integration plug-in: Select BioStar2 Server
  • Address: Enter URL for access to BioStar 2 (including port number)
  • User: Login ID for BioStar 2
  • Password: Password for BioStar 2






If you fail to connect to the access control system (BioStar 2 AC), you will get the below error.
Please check if all settings are correct.



If you succeed in connection to the access control system (BioStar 2 AC), you can see below picture.




If BioStar 2 connected to Milestone successfully, the below screen will appear.
After selecting IP camera you will use in the right panel, drag the cameras to the access points for each door in the left list.




If you succeeded in integrate Milestone with BioStar2 with IP camera, you can see below picture.




Once you succeed in integration between BioStar 2 and Milestone, you can add/edit the access control properties at any time.
To manage them, you need to select one of Access Control.

At the bottom, there are 5 tabs you can configure.



  • General Settings: You can update the access control system name, network settings and login information.
  • Doors and Associated Cameras: You can associate the cameras with access points.
  • Access Control Events: You can activate or deactivate the access control event from BioStar 2, also create and assign the user-defined categories.
  • Access Request Notifications: You can create an access control action or command which is performed by the operator on the associated access points. For example, when a card holder requests the door open, XProtect display a notification and then operator sending a door open command.
  • Cardholders: You can view or search the cardholder information. The cardholder information is synchronized with user information of BioStar 2. In BioStar 2, user information includes user name, access group, RFID card number, fingerprint template, face template and PIN.



Major Features

Feature 1: Access Control Events

This function is used for classifying Access Control Events into certain Event Category. In general, there are a variety of different events in each access control system. To manage them efficiently in Milestone, you should map all access control events to certain Event Category.




If you want to create customized Event Category, you can make it by clicking User-defined Categories button.






Feature 2: Cardholders

The user who is enrolled in BioStar 2 is synchronized with the cardholder in Milestone.

List of all Users
BioStar 2:




Milestone:




User Details
BioStar 2:




Milestone:




Although the information on user/door/device is changed except for real-time events in BioStar 2, it will not be updated in Milestone automatically. In these cases, you should click Refresh Configuration button in Milestone (Access Control > General Settings). Otherwise, the user information between BioStar 2 and Milestone are different.



Step 6: Utilize XProtect Smart Client

If you succeed in integration with Milestone with BioStar2, you can monitor real-time video, identify the detected alarm from the door, access to BioStar 2 and check the event logs displayed in BioStar 2 by utilizing XProtect Smart Client.


  • Live
  • Alarm Manager
  • BioStar2
  • Access Control



Major Features

Feature 1: Live

In Milestone XProtect Smart Client, you can monitor real-time video recorded by IP camera. After you select the camera you associated in Milestone XProtect management, drag it into the right panel.




Then, you can see the real-time video recorded by IP camera.




In addition, you can adjust direction or zoom in/out by clicking the icon located in left-bottom side.




You can customize the View in Live tab.
For example, if you want to monitor video and check the information on users who authenticate their identity with PIN/Fingerprint template at the same time, click Setup button.



Then, you can see various options you can configure. First of all, click Create New View icon.



After that, you can select one option you want to customize in the view. By clicking the icon shaped pencil, you can modify the name. Then, Click Set button.



Next, drag Access Monitor in System Overview. In the Access Monitor Settings, you should specify the settings for the Access Monitor and click OK button.



Once you click OK button, you can see the customized view. Please note that you should click Setup button again to escape the setting of View. If you see below screenshot, you can monitor video and the information on users who authenticate their identity to enter the door simultaneously.





If someone fails to authenticate their identity, the notification will be displayed in the right-bottom side and display the real-time video.




Feature 2: Alarm Manager

If an alarm occurs in BioStar 2, the alarm message will be generated in Milestone.

BioStar 2:




Milestone:




In Milestone, Alarm Manager will judge if generated event should be dealt with alarm based on Access Control Events tab and Alarm Definitions.

[How to configure the alarm]

This setting is required to view or acknowledge the access control event alarms of BioStar 2 in XProtect Smart Client. The alarm can be set in Setting menu of BioStar 2 and if the event alarm happens, XProtect Smart Client displays the alarm in Alarm Manager.

Go to Alarms in the Site Navigation and select Alarm Definitions. Then, right click Alarm Definitions and click Add New.




Enter Name in Alarm definition section.
Select Access Control Event Categories and one of Events you want to set in Trigger section. In below picture, I selected Alarm.
Selet one option for Sources in Trigger section. In below picture, I selected All doors.




At this point, please check Access Control Events which Alarm event is allocated. You can map Alarm event to certain Access Control Events. In below picture, I set Alarm event for the Access Control Event, “Access denied (Blacklist)“.




Feature 3: BioStar2

In Milestone XProtect Smart Client, you can access to BioStar 2 and add/modify the data (e.g. User, Device, Door) in BioStar 2.




Feature 4: Access Control

You can check Events, Doors and Cardholders for BioStar 2 in Milestone.




You can also create the PDF report for Event records by clicking Access report button.