Integrate VMS
The Video Management System (VMS) is a video management system that integrates and manages video from multiple cameras, allowing for recording and playback. Integrating BioStar X with VMS allows you to manage access control and video security on a single platform.
You can use the following features through VMS integration.
-
Real-time monitoring: You can view real-time video from cameras connected to doors.
-
Integrated event management: You can understand security situations by linking access events with video.
-
Efficient evidence collection: You can quickly search and replay recorded video from specific points in time.
-
Bookmark function: You can add video tags to important event moments for easy retrieval and review.
Before you start
To integrate with the Video Management System (VMS), please check the following items.
-
The VMS integration feature is available as an add-on option for Essential or higher licenses. For more information on licensing policies, see License Policy.
-
Make sure that the VMS server is correctly installed and configured. The VMS server must be in a state that can connect online with BioStar X.
- Use a VMS that is compatible with BioStar X. You can use the Nx Witness v5.1.5 or v6.x.x VMS.
- Prepare the IP address, port number, and administrator account information of the VMS server. This information is needed to connect the VMS server with BioStar X.
VMS server integration settings
Follow the steps below to integrate the VMS server with BioStar X.
Activate VMS integration
-
Click Settings on the Launcher page.
-
Click Video → VMS Integration on the left sidebar.
-
If this is your first time accessing, log in with the BioStar X administrator account.
-
Set the VMS Integration option to Use.
-
Enter the VMS server information.
-
Server Address: Enter the IP address of the VMS server.
-
Port: Enter the port number of the VMS server.
-
Login ID: Enter the administrator account ID of the VMS server.
-
Password: Enter the administrator account password of the VMS server.
-
-
Once you have entered all the VMS server information, click the Apply button at the bottom right of the screen.
-
If the integration with the VMS server fails and an error message appears, check the server address and administrator account information again. It is also necessary to check whether the VMS server is online and if network connections are blocked due to firewall settings.
-
For more information on the settings in the VMS Event/Bookmark section, see #vms-event-bookmark.
Install the certificate on the VMS server
To play back recorded video from the VMS server, you must use HTTPS protocol. Standard SSL certificates are issued for domain names, so they aren't valid when accessing the VMS server by its IP address. Therefore, you need to create a separate certificate that includes the VMS server's IP address.
You must install a certificate whether the VMS server and BioStar X are installed on the same server or on separate servers.
The NX Witness Certificate Setup section becomes available only when the VMS Integration option is set to Use.
-
On the server where VMS is installed, click Download certificate installer to download the certificate installer.
-
Run the downloaded vmsCertMaker.exe file.
-
Enter the IP address in the VMS server IP field.
Use the IPv4 address format. e.g., 192.168.0.10
-
Enter an IP address in the correct format to enable the Next button. Click Next.
-
Select the VMS certificate installation path.
-
For compatible VMS, the installer detects the installation path automatically.
-
If the installer does not detect the installation path automatically, click Browse for folder and select the path manually.
The installation path of the certificate may vary depending on the VMS. Refer to the examples below.
-
BioStar 2 VMS: C:\Windows\System32\config\systemprofile\AppData\Local\Suprema Inc\Suprema Inc. Media Server\ssl
-
Digital Watchdog: C:\Windows\System32\config\systemprofile\AppData\Local\Digital Watchdog\Digital Watchdog Media Server\ssl
-
Hanwha Wave: C:\Windows\System32\config\systemprofile\AppData\Local\Hanwha\Hanwha Media Server\ssl
-
NX: C:\Windows\System32\config\systemprofile\AppData\Local\Network Optix\Network Optix Media Server\ssl
-
-
If multiple VMS certificate paths exist, all paths appear. Click Select another folder and select the desired path.
-
-
Click Next or Proceed with selected folder.
-
After certificate generation completes, the Certificate generated successfully message appears.
-
The certificate installation path appears when you click OK. Confirm that the certificate file (cert.pem) exists.
-
After certificate installation completes, click Close.
-
Reboot the VMS server.
If certificate installation fails, the message shows the reason. Review the message, then take the required action.
Install the certificate on the client PC
If the following situations occur, you can install the certificate from the VMS server onto the client PC to resolve the issue.
-
When accessing Video Management System (VMS) through the browser, and a 'Not secure' warning appears
-
When real-time video plays on the Monitoring page but recorded video does not play
Enrolling the certificate only on the client PC, without installing it on the VMS server, prevents normal operation.
-
Access BioStar X through your web browser.
-
Download the HTTPS certificate installer (cert-register.zip) from the login screen or Settings → System → HTTPS.
-
Unzip the downloaded file and run cert-register.exe file. The Enroll Certificate window appears.
-
Select VMS for Target System and enter the following information.
-
Server Address: IP address of the VMS server
-
Port: Port number of the VMS server (default: 7001)
-
-
Click Enrollment.
-
Check the security warning message and click Yes.
Restart the web browser and check if the recorded video from the VMS server plays normally on the Monitoring page.
Check and set the camera
If the VMS server is integrated normally, you can check the connected cameras in the Video → Video menu. For more information, see Set Up the Camera.
Troubleshooting
If the service does not work after first integration with the VMS server, manually restart it as follows.
-
Click Start → BioStar X → BioStar X Service Manager on Windows.
-
In the All Services list, click Stop for the services below to stop them.
-
BioStar X Unified Gateway Service
-
BioStar X Core Web Service
-
-
When the status of the requested service changes from Pending to Stopped, click Start to restart the service.
VMS event and bookmark settings
You can transmit bookmark tags and event tag information to the integrated VMS server. At this point, you can choose to transmit event logs, door names, device names, and user IDs together. Select the desired options and click Apply at the bottom right of the screen.
-
Language: Choose the language for the event and bookmark tags transmitted to the VMS server. You can select either Korean or English.
-
Bookmark Tag: Bookmark tags allow you to easily locate and review videos stored on the VMS server with designations and names for quick identification. Select the information to send with the bookmark tag.
-
Event Tag: You can transmit events that occurred at specific moments to the VMS server for logging. Select the information to send with the event tag.
-
For more information on the bookmark function in VMS, refer to the following link.
-
For more information on the event function in VMS, refer to the following link.
-
If bookmark or event tags include the following characters, the system removes them before sending them to the VMS server.
-
Event tag:
\',#%=&<> -
Bookmark tag:
<'
-
Disconnect VMS server integration
To disconnect the integrated VMS server, follow the steps below. Disconnecting VMS integration will delete all video settings, registered cameras, and rules.
-
Click Settings on the Launcher page.
-
Click Video → VMS Integration on the left sidebar.
-
Set the VMS Integration option to Not Use.
-
Click Apply at the bottom right of the screen.
-
Check the contents of the message window and click Yes.