#### Version 1.0.4
# Prerequisites
## Software and Licensing
### Microsoft System Requirements
- Microsoft® Windows® 10 Pro (64 bit)
- Microsoft® Windows® 10 Enterprise (64 bit)
- Microsoft® Windows® 10 Enterprise LTSB 2016 (version 1607 or later)
- Microsoft® Windows® 10 IoT Enterprise, version 1803 or later (64 bit), IoT Core
- Microsoft® Windows® Server 2016 (64 bit): Essentials, Standard and Datacenter
- Microsoft® Windows® Server 2019 (64 bit): Essentials, Standard and Datacenter
### XProtect System Requirements
- XProtect Express+, Professional+, Expert, Corporate 2023 R1 (23.1a) or above
- XProtect Event Server
- The Event Server is included as part of you XProtect installation. ***Note*** **_If this component has not been installed with your version follow the steps found in troubleshooting at the end of this document._**
- XProtect License
- No additional license is required for XProtect for this integration
### Bosch B&G Series
- IP Address of panel to be connected
- Automation Passcode of panel to be connected
### ORBNET Systems
- Installer – ‘Bosch B&G Series for XProtect Setup.msi’
Available to download from [https://orbnetsys.com/Bosch B&G/](https://orbnetsys.com/brivo/) once registered and signed into the website.
- License – The product is licensed based on the number on panels and alarm points.
- Please see the BG Series License Settings section of this document for further details on how to make a license request.
- 30-day trial license included
# Installation of Bosch B&G Series for XProtect
Begin with the server/machine running the XProtect Management and Event Server. Close any open
XProtect Management Clients first. Place the ‘Bosch B&G Series for XProtect Setup.msi’
From a folder on the desktop and double click and select ‘Install.’
During installation, a window will appear behind the installer to request restart of the XProtect Event Server.
# Configuration
## XProtect Management Setup
This integration allows for your B&G Series system to be directly connected the XProtect VMS (Video Management Software). It is designed to fit perfectly with any XProtect system. No matter your installation size, with XProtect you can control your video cameras and B&G Series system from a central interface in the XProtect Management and XProtect Smart Client applications.
Find and Select ORBNET Plugins in the XProtect Management client tree menu.
### BG Series License Settings
This page provides a dashboard overview of your ORBNET Systems licenses for the BG Series module.
From the point of installation, this ORBNET Systems software will provide a 30-day trial license. This will allow 10 Panels and up to 10,000 Alarm points to be connected. After the 30-day time has lapsed a license request will need to be made to validate the license.
The Licensed panels can be dynamically updated as required. Use the Revoke License and Apply License buttons with the panel in question selected to update.
#### License Request
>[!note]
>30-Day trial license included for first time installation.
When making a license request please ensure these fields are filled (highlighted in bold).
- 1a – Client Name
- 2a – Max. Active B or G Alarm Panels
- 2b – Max. Alarm Points
Click Export license request and save, email the license request to [
[email protected]](mailto:
[email protected]).
Once the activated license is returned used Import valid license to activate your system.
### BG Series Panels
For each panel you will need the IP address and Automation Passcode. This will be entered into XProtect to connect the panel to the XProtect system. Below shows where the Automation Passcode is gathered or changed within the Bosch Remote Programming Software (RPS).
From this menu in the XProtect Management Client you can add, remove, and manage the connected panels.
Right click the BG Series Panels text to access the Add New option.
A new controller will be added to the list. This section covers the connection details and licensing.
- **Panel Settings**
- Licensed – Selected panel is licensed indicator
- Enabled - Ticked option, untick to disable
- BG Series Panel IP – IP Address field
- Port – Panel Port (7700 default)
- Password – Automation Passcode for panel
- Refresh Configuration – This will query the panel to update with any missing or new components
- Select Cameras – For cameras that would be associated to the panel only
- Smart Client panel alarm instructions – The message that will display with the relevant alarm from this panel
When a new panel information is filled out click Refresh Configuration then OK on the below dialogue followed by the XProtect Save button , then the panel will be queried. The relevant connected devices will be downloaded from the panel. This can take a couple of minutes to complete.
Once this process is completed you will receive a pop-up message. This will show whether any changes have been detected. Press Ok when done, all changes will be shown in the relevant section.
### Areas
Within the Areas section of the plugin the enabled Areas from the panel will be shown.
This window provides access to the available Area settings.
Add related cameras using Select Cameras and alarm instructions for an operator in the Smart Client using Smart Client alarm instructions.
Areas as shown in the Bosch Remote Programming Software (RPS).
### Points
Within the Points section of the plugin the enabled Points in an Area from the panel will be shown.
This window provides access to the available Point settings.
Each of the points has an option to select the Point Type. This relates to the icon that is shown for each point relevant to the point type.
Add related cameras using Select Cameras and alarm instructions for an operator in the Smart Client using Smart Client alarm instructions.
For each Point, an icon set can be selected, this changes the icon used within the Smart client. Below shows each of the icon types and the four possible states (Disabled has just one state).
States are: [Alarm] : [Fault] : [Normal] : [Warning]
Points as shown in the Bosch Remote Programming Software (RPS).
### Doors
Within the Door section of the plugin the enabled Doors from the panel will be shown.
This window provides access to the available Door settings.
Add related cameras using Select Cameras and instructions for an operator in the XProtect Smart Client using the XProtect Smart Client alarm instructions.
Doors as shown in the Bosch Remote Programming Software (RPS).
### Outputs
Within the Outputs section of the plugin the enabled Outputs from the panel will be shown.
This window provides access to the available Door settings.
Add related cameras using Select Cameras and instructions for an operator in the XProtect Smart Client using the XProtect Smart Client alarm instructions.
Outputs as shown in the Bosch Remote Programming Software (RPS).
# Bosch B&G Series in XProtect Rules and Alarms
## Rules
XProtect Rules provide an action on event, this B&G Series integration provides In-bound events from a panel to XProtect and Out-bound actions from XProtect to a panel.
To access the B&G Series Control events in XProtect find Rules and Events > Rules section in the Management Client.
Select this and then right click Rules in the center column to Add rule…
- Perform and action on (`<event>`)
- Select and expand ORBNET Plugins
- Expand the BGSeries list to see all available events
Continued list of events
Once the event has been selected you can Select actions to perform when this event is triggered. These are out-bound actions triggered from XProtect to the Bosch B&G panel.
Each option can be selected by ticking the relevant box, more than one action can be triggered for the event used to trigger
### User-defined Events
Often overlooked the User-defined Event allows easy access to the control of an out-bound actions from XProtect and the Smart Client. The initial setup of the User-defined event is as a placeholder for a Rule.
Under Rules and Events select User-defined Events, right click and Add User-defined Event
This provides just a name field, fill this with a name relevant to the action you intend to add. Remember that this is the name of the event shown in the XProtect Smart Client.
Back in Rules create a new rule and select the User-defined event that was created.
- Perform an action on `<event>`
- Events > External Events > User-defined Events
- Click Next, Select the relevant action to be performed on the Bosch panel by selecting the tick box/s.
## Alarm definitions
In the XProtect Management alarms can be created from in-bound Bosch B&G Series panel events. These events are added to the Alarm stack in the XProtect Smart Client and will highlight an Area, Point, Door or Output on a Map with a round red circle when triggered.
The below alarm shows how to add a Triggering event:
- Select BGSeries from the dropdown list
- Select the relevant event from you B&G panel
- Select the Source for this event
If you wish to use Events triggered in the Alarm Definition you will have to create User-defined Event. Follow the steps in the last section.
# XProtect Smart Client
## Maps Setup
Once logged into the XProtect Smart Client enter Setup mode via the right-hand site menu.
Under Setup create a new layout (Recommended view layout 4:3 > 1x1), drag the Map component into the blank tile. Select a floorplan image representing your site layout using Browse. The name of the image will show as the map title for future reference.
All the Bosch B&G components can be added to a map created within the XProtect Smart Client.
Use Add Plug-In Element (Puzzle piece) from the Tools menu.
Once out of Setup mode the panel components (Areas, Points, Doors and Outputs) will show with the current states.
Below Area One and Area 3 are set, Area 2 is part set. All other points, doors and outputs are in a normal state. The center Bio alarm has a red ring, this would be flashing and shows an alarm definition has been triggered. There will also be a trigger shown in the alarm stack.
There are also several actions available to each component from the right click menu.
### Panels
| **PANELS** | **STATUS DETAILS** |
| ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
|  |  |
Relevant actions in list;
- [Show alarms] will switch to alarm stack and filter the alarms for the selected device
- [Acknowledge alarms] will do so in the XProtect Smart Client and at the Bosch panel
- [Disable all new alarms] will only do so in the XProtect Smart Client
- [Ignore stats] will only do so in the XProtect Smart Client
- ----------------------------------------------------------------------------------------
- [Status details] will show a floating screen with the relevant connected devices.
Component States
### Areas
| **AREAS** | **STATUS DETAILS** |
| ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
|  |  |
Relevant actions in list;
- [Show alarms] will switch to alarm stack and filter the alarms for the selected device
- [Acknowledge alarms] will do so in the Smart Client and at the Bosch panel
- [Disable all new alarms] will only do so in the Smart Client
- [Ignore stats] will only do so in the Smart Client
- ----------------------------------------------------------------------------------------
- [Disarm]
- [Master Instant Arm]
- [Master Delay Alarm]
- [Perimeter Instant Arm]
- [Perimeter Delay Alarm]
- [Silence Alarm]
- ----------------------------------------------------------------------------------------
- [Status details] will show a floating screen with the relevant connected devices.
#### Component States
### Points
| **POINTS** | **STATUS DETAILS** |
| ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
|  |  |
Relevant actions in list;
- [Show alarms] will switch to alarm stack and filter the alarms for the selected device
- [Acknowledge alarms] will do so in the Smart Client and at the Bosch panel
- [Disable all new alarms] will only do so in the Smart Client
- [Ignore stats] will only do so in the Smart Client
- ----------------------------------------------------------------------------------------
- [Bypass]
- [Unbypass]
- ----------------------------------------------------------------------------------------
- [Status details] will show a floating screen with the relevant connected devices.
#### Component States
States are: [Alarm] : [Fault] : [Normal] : [Warning]
### Doors
| **DOORS** | **STATUS DETAILS** |
| ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
|  |  |
Relevant actions in list;
- [Show alarms] will switch to alarm stack and filter the alarms for the selected device
- [Acknowledge alarms] will do so in the Smart Client and at the Bosch panel
- [Disable all new alarms] will only do so in the Smart Client
- [Ignore stats] will only do so in the Smart Client
- ----------------------------------------------------------------------------------------
- [Unlock]
- [Secure]
- [Cycle]
- [Lock]
- [Terminate Lockdown]
- ----------------------------------------------------------------------------------------
- [Status details] will show a floating screen with the relevant connected devices.
**Component States**
States are: [Alarm] : [Fault] : [Normal] : [Warning]
### Outputs
| **OUTPUTS** | **STATUS DETAILS** |
| ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
|  |  |
Relevant actions in list;
- [Show alarms] will switch to alarm stack and filter the alarms for the selected device
- [Acknowledge alarms] will do so in the Smart Client and at the Bosch panel
- [Disable all new alarms] will only do so in the Smart Client
- [Ignore stats] will only do so in the Smart Client
- ----------------------------------------------------------------------------------------
- [Activate Output]
- [Deactivate Output]
- ----------------------------------------------------------------------------------------
- [Status details] will show a floating screen with the relevant connected devices.
#### Component States
## Other Controls
### User-defined Event
Once logged into the Smart Client enter Setup mode via the right-hand site menu.
From a layout that is already created, find `Overlay Buttons > Device > {Server-Name} > Events > All Event Types > {User Created User-Defined Event}`
>[!note]
>See User-Defined Events section under Bosch B&G Series in XProtect Rules and Alarms in this document for more information.
Drag and drop this onto a tile, this will show as a push button over the camera tile.
When out of setup in Live mode, you will see the Overlay button only when the mouse is hovered over the camera tile. These can only be used in a camera tile.
As shown below, Open Door 1 and Trigger Output
# Troubleshooting
### Event Server Installation
If XProtect was installed via a custom installation, the Event service may not have been included as it is not always required.
From the server/machine with the XProtect Management service follow to
This will provide a XProtect installation page where you will be about to run the installer for the Event Server. This must be installed so the OBNET plugin can communicate with XProtect.
### Renaming of Devices
While it is possible to update the names of Areas, Points, Doors and Outputs in the XProtect Management application. These updated names will only remain until the panel configuration is refreshed next. Any name changes should be completed within the Bosch Remote Programming Software (RPS), after the configuration is refreshed the new names will show. This plugin checks for all differences between what is already loaded in the XProtect database and updates any changes using the system Bosch as the master.
The XProtect API does not allow us to control whether the Rename option is shown in the right click menu.
### Bosch B&G Panel Disconnections
Each Bosch B&G Panel can support a maximum of three TCP Connections. If your XProtect system is connected to a Bosch panel via this module, please make sure there are no other applications (e.g. legacy Bosch B&G Integration) trying to connect to the panel as well. The connection to the B&G Panels will drop the connection to the XProtect System if three other TCP clients try to connect to it. This can be demonstrated by opening three Telnet clients to the Bosch panel on the default 7700 port.
There is an included event (Max Panel Connections Reached) in the XProtect rule system that will alert when the maximum number of connections has been reached on the panel. Please use this as a notification to operators or system managers. Loss of this connection will stop all bi-directional control and system events within XProtect.
The panel may need to be rebooted or disconnected and reconnected to the network to re-enable a reconnection. Closing the other applications that are connected to the panel may speed up the reconnection time.