DW Spectrum & BioStar 2 Integration Guide
-----------------------------------
Affected Roles: Owner, Administrator
Related Digital Watchdog VMS Apps: DW Spectrum IPVMS
Complexity: Medium
Software Version: DW Spectrum IPVMS v4.2 or higher
Last Edit: July 6, 2022
-----------------------------------
Suprema BioStar Integration
The Suprema BioStar 2 software can be integrated with DW Spectrum IPVMS Systems to act as middleware to synchronize event alerts between the IPVMS software and BioStar2 and to bookmark events for easy video retrieval and playback.
This article will outline how to integrate the Suprema BioStar 2 software to utilize the DW Spectrum IPVMS Event Alarm features.
Source: Suprema Integration Guide
Prerequisites
- DW Spectrum IPVMS
- DW Spectrum IPVMS v4.2 or newer
- BioStar 2
- BioStar 2 v2.7.10 or newer
- Operating System
- Windows 10 Pro or newer (x64)
or
-
- Windows Server 2016 or newer (x64)
Part 1: Initial Setup
Section 1.1 - Installation
The Suprema and DW Spectrum software can be installed on any computer within the network. However, it is recommended to install both programs on either the BioStar 2 or hosting DW Spectrum Server computer.
To begin the Suprema Integration:
- Use the setup programs to install the BioStar 2 and DW Spectrum Server programs on the host computer.
Section 1.2 – Logging In
Begin by logging in to the BioStar 2 web interface:
- Open a web browser on the hosting computer where the Suprema Integration with DW Spectrum is being hosted.
Enter “https://localhost:5051” into the address bar (URL) of the web browser to connect with the BioStar 2 web client.
**NOTE: Do not use the IP address or access the Suprema Integration from another computer for this setup.
- Upon reaching the login screen, enter the Username and Password that is being used for BioStar 2, then click the “Login” button.
If the BioStar 2 server is not installed on the local computer or if the default port (443) has been changed, click the gear icon ⚙ to change the connection settings.
Part 2: Settings Menu Configuration
After logging in to BioStar 2, click the “Settings” tab and configure the following settings:
- BioStar 2
- Host – this should represent the IP address of the BioStar 2 server computer. If you are using the server computer itself, the loopback address 127.0.0.1 will show.
- HTTPS Port – this should represent the port number that is being used for BioStar 2 (default is 443).
- Username – enter the operator User ID for BioStar 2
- Password – enter the operator Password for BioStar 2
- DW Spectrum
- Host – enter the IP address of the DW Spectrum Server computer. If you are using the server computer itself, use the loopback address 127.0.0.1
- HTTPS Port – enter the port number that is being used for the DW Spectrum System (default is 7001)
- Username – enter the operator User ID for DW Spectrum. It is recommended to use a user profile that has permissions for receiving Event Alarm notifications.
- Password – enter the operator Password for DW Spectrum
- Bookmark Duration (ms) – enter the desired duration of Bookmarks to be created in DW Spectrum (20000 ms = 20 seconds; do not use commas)
- Bookmark PreEvent (ms) – enter the amount of time to offset the start of Bookmark footage in DW Spectrum before the time that the Event Alarm occurred. For example, if an event occurred at 11:40:45, the bookmark will start at 11:40:35 when the Bookmark PreEvent setting is 10000 ms (10000 ms = 10 seconds; do not use commas)
- Save Settings – click the Save Settings button to apply the setting configurations
**NOTE: If BioStar 2 and the DW Spectrum Server are on different computers, make sure that they are allowed to communicate with each other with their specified ports through any firewalls or network security applications.
Part 3: Template Menu
Section 3.1 – Template Overview
The Template menu will include the following:
- Group
- New – click to create a new template group
- Edit – click to rename a template group
- Delete – select a group then click to delete the template group
- Search – enter a group name to search through the Group list
- Event
- Search – enter an event type to search through the Event list
- Select All – click to select all event types shown on the current page
- Clear All – click to deselect all event types shown on the current page
- Save – click to save a template group
Section 3.2 – Create a New Template Group
To create a new template group:
- In the Template menu, click the New button.
- Enter a name for the template group and click the Save button.
- Select the new template group from the Group list.
- Select the desired event types from the Event list that will be used with the new template group.
- Click the Save button to apply the changes.
Section 3.3 – Edit a Template Group
To edit an existing template:
- Select the template group from the Group list.
- Select the additional event types or deselect event types from the Event list.
- Click the Save button to apply the changes.
Part 4: DW-Bookmark Menu
Section 4.1 – DW-Bookmark Overview
Bookmarks are used to mark sections of archived video for easy retrieval and viewing. Bookmarks can be created for event types or with a preset template in the “DW-Bookmark” menu.
The DW-Bookmark menu will include the following:
| No. | Item | Description |
| 1 | Device | Search - search for a host device (server) |
| 2 | Camera | Search - search for cameras |
| 3 | Template | Template - select a template group |
| Apply - click to save the current bookmark settings | ||
| 4 | Event | Search - search for event types |
| Select All - click to select all event types shown on the current page | ||
| Clear All - click to deselect all event types shown on the current page |
Section 4.2 – Configuring Bookmark Settings
To setup a bookmark:
- In the DW-Bookmark menu, select a device (server) from the Device list.
- Select the associated cameras in the Camera list. You may select up to 15 cameras for each device.
- Select the associated event types from the Event list. You may select up to 50 event types per camera.
- Click the Apply button to save the event. Devices and cameras that are successfully connected will display a link
icon.
Part 5: Service Menu
The Service tab will allow you to restart or stop the BioStar 2 integration service.
The Service menu contains the following:
- Restart Service – click to start or restart the Suprema BioStar 2 Integration with DW Spectrum
- Stop Service – click to stop the Suprema BioStar 2 Integration with DW Spectrum. The integration will be disabled until the service is started again manually or the hosting computer has been rebooted.
Troubleshooting
