Velocity Integration with Bosch Intrusion Detection System (IDS)_v3.8.4
Bosch Intrusion Detection System
Bosch IDS plugin acts as an interface to the following models such as B4512, B5512, B6512, B8512, and B9512. It fetches panel information, executes panel/area/point/output commands, monitors events/alarms, and displays the same in Velocity.
Bosch IDS Panel System Requirements in Velocity
The following lists the required configuration:
Software | Version |
---|---|
Velocity | 3.8.4.xxxx |
Velocity IDS Framework | 1.0.0.146 |
Velocity Bosch IDS Plugin | 1.0.3.198 |
Licensing
Licensing Velocity Integration and Bosch IDS Plugin
Prerequisites
To obtain Bosch IDS plugin license you will need a licensed Velocity 3.8.4, and a personal computer with email access so you can provide Identiv with information about your Velocity system and receive a license key.
Contact Identiv Sales department to purchase a license for “Velocity IDS Plugin - Bosch”.
They should ask you to send them an email message containing the Server ID of your Velocity Server (exchanging this information via email instead of by phone ensures receiving the license key). The Server ID is obtained from the Velocity License Manager.
Open the Velocity License Manager.
If the Velocity Service Control Manager icon is displayed in the Windows task-bar, right-click on it and choose Velocity License Manager from the pop-up menu.
If the Velocity Service Control Manager icon is not displayed in the Windows taskbar, click the upwards-pointing triangle on the left side of the taskbar to show the hidden icons for additional programs.
Click the button after the Server ID to copy that information to the Windows Clipboard, and then paste it into an email message to Identiv so that we can create your license key. (If you don’t have email access on your Velocity Server, you can paste the information into a text file and transfer it between computers using a USB drive.)
Close the Velocity License Manager.
After you receive an email containing your license key, copy all the characters between the -- License Key Start and the -- License Key End -- lines (as shown by the yellow highlighted portion of the following screen capture).
If your Velocity Server is on a different computer, paste your license key into the Windows Notepad accessory, save it as a text file, and transfer it between computers using a USB drive. Make sure that the word wrap option is turned off, which is indicated by the absence of a check mark in front of the Format ▶ Word Wrap command.
Paste the full license key information into the Add / Renew License pane and click the Add / Renew button.
The “License value has been updated successfully” dialog displays.
Click OK to close this dialog, and then verify that the Velocity License Manager shows a new row of information about Velocity IDS Plugin-Bosch.
Licensing of the Velocity IDS Bosch plug-in is now completed, so you can close the Velocity License Manager.
The license key is only valid on the computer with the specified Server ID; it cannot be used on a different computer.
Installation
Installing Bosch IDS Plugin
Prerequisite: To install Velocity IDS Bosch plugin, the user must be logged into Windows using an account that has local Administrator privileges, you must be a member of the Velocity Administrators Role, have an active license for the integration, know the name and password of the Velocity Services Account (specified when Velocity was installed).
Close the Velocity application.
Run the Bosch IDS Plugin. The IDS framework gets installed along with the Bosch IDS plugin.
The installer displays various status messages while the installation proceeds.
Click Yes to back up the database prior to the update.
Click Yes to start the services after the update completes.
Click Yes to start Velocity when the Update completes.
When the following screen is displayed, type in the name and password of the Velocity Services Account and click the OK button. (The name and password of the Velocity Services account were specified when Velocity was installed.)
The default Velocity Services account is named “VelocityServices”. Be sure to prefix the account name with “.\” to specify its a local account. For example: .\VelocityServices
To verify that the name and password you entered for the Velocity Services account was correct, try to start the new service by right-clicking on the Velocity Service Control Manager icon (while the other Velocity Services are running) and choosing Start Velocity IDS Service from the pop-up menu.
To confirm successful installation of IDS service,
Open Velocity application. Select Event Viewer and scroll down to check IDS Service Online software event is generated.
Bosch IDS Panel
Remote Procedure Software (RPS) Configuration
To communicate with Velocity the panel must first be configured using the Bosch RPS tool to set the Automation Device and Automation password properties.
In RPS Menu, navigate to Automation/Remote App -> Automation Device.
In the Automation Device screen, select Mode 2 from the options to be the Data Value and click OK.
Adding a Bosch IDS Panel
The Bosch IDS panel must be configured with a valid IP Address, Port, and Automation Passcode.
Launch Velocity and navigate to Administration->Interfaces Configuration->Velocity Integrations-> IDS Integration.
Double click Add new IDS Panel…
The Add New Panel screen is displayed.
Enter the Name, Vendor, Model Type, Timezone, IP Address, Port, and Automation Passcode.
Click OK.
After the new panel is added, the Areas, Points, and Outputs are automatically displayed and populated below the panel.
Monitoring Bosch IDS Panels
The Bosch IDS panel status displays the current status of all connected panel areas, points, and outputs. The mapped IDS events and the alarms that get generated can be monitored from Event Viewer or Graphics.
Bosch IDS Panel Areas
Areas in the IDS Panel define a group of points. The IDS Areas folder displays the areas that are defined in the Bosch Panel.
In the Administration menu, navigate to Interface Configuration->Velocity Integrations->IDS Integration. Select your IDS Panel to see the Areas.
Right click on an area to view the list of supported commands.
The events include all alarms that are notified based on the configured areas. The table lists the supported event command types with descriptions.
Command | Description |
---|---|
Silence Bells | Allows to silence the alarm bell generated by an event |
Activate Bells | Allows to activate the alarm bell generated by an event |
Disarm | Allows to Disarm (OFF) |
All on Instant | Turns on all points with no entry or exit delay |
All on Delay | Turns on all points with entry or exit delay |
Part on Instant | Turns on only some of the points with no entry or exit delay |
Part on Delay | Turns on only some of the points with entry or exit delay |
Force All on Delay | Forces all points to turn on with entry or exit delay |
Force All on Instant | Forces all points to turn on with no entry or exit delay |
Force Part on Delay | Forces only some of the points to turn on with entry or exit delay |
Force Part on Instant | Forces only some of the points to turn on with no entry or exit delay |
Stay One Arm | Arm in stay mode |
Away Arm | Arm in away mode |
Force Stay One Arm | Force arm in stay mode |
Force Away Arm | Force arm in away mode |
Reset Sensors | Resets the sensors in the area from a previous action and returns to normal operation |
Bosch IDS Panel Points
Points refer to single points such as doors, windows, fire detection sensors, etc. A group of points comprises an area such as lobby, conference room, etc.
In the Administration menu, navigate to Interface Configuration->Velocity Integrations->IDS Integration. Select your IDS Panel to see the Points
Right click configured areas to view the list of supported commands.
The table lists the supported command types:
Command | Description |
---|---|
Bypass Point | Bypasses the selected point |
Unbypass point | Un-bypasses the selected point |
Bosch IDS Panel Outputs
Outputs in IDS refers to automatic control of devices in areas such as entry/exit gates or lighting in secured zones.
The table lists the supported command types
Command | Description |
---|---|
Control Output ON | Turns the output relay ON |
Control Output OFF | Turns the output relay OFF |
Status Viewer
The Status Viewer allows you to view the status of Panels, Areas, Points, and Outputs.
Viewing IDS Panel Objects in Status Viewer
Select Status Viewer from Main menu.
Click Configure Status Group.
Enter the Status Group name In the Status Viewer Properties window.
From the Filter drop-down list, select the type of component you want to include in this status group. The 'Available' pane is populated with all devices/points corresponding to the selected Filter.
Click the right arrow button, to move the highlighted components in the 'Available' pane to the 'Selected' pane.
Click OK to save and return to the Status Viewer.
The status viewer displays the status of the component that is added Online, through Battery status, and AC Power status.
The Status Group for the corresponding Areas display as shown.
The Status Group for the corresponding Points display as shown.
The Status Group for the corresponding Outputs displays as shown.
Graphics Viewer
The Velocity Graphics module provides a visual interface for interacting with IDS Panels, Areas, Points, and outputs. Graphics supports two different kinds of IDS Objects:
Traditional VIO IDS related objects (Panels, Area, Points, and Outputs).
The new IDS Area construct which allows you to draw a representation of an IDS Area on a map in order to monitor the associated IDS Area’s Arm and Secure states.
VIO objects allow you to plot specific IDS objects (panels, areas, points, and outputs) to monitor and control the Velocity Alarm state as well as execute device specific commands. The Velocity Alarm state is the same state as shown in the Velocity Alarm Viewer and you may ACK and Clear Velocity alarms from VIOs just like you can from the Velocity Alarm Window.
Difference between IDS Area VIO object and an IDS Area
To illustrate the difference between IDS Area VIO object and an IDS Area consider the following example:
An IDS area goes into alarm and a Velocity Alarm event is displayed in the Velocity Alarm Viewer and the associated IDS Area VIO object in Graphics animates to show that the VIO is in an alarm state. The operator may then acknowledge and clear the Velocity Alarm from either the IDS Area VIO or from the Velocity Alarm Viewer. However, the secure state of the IDS Area construct remains in alarm until the alarm is cleared from the IDS panel (usually from the IDS keypad).
Plotting IDS VIO Objects
To place Velocity VIO Objects on a drawing:
Select the Object Library check box in the Main menu, the Object Library pane displays.
Expand the Topology folder till you reach the underlying panel, area, points, and output components that you need to place in the drawing are displayed.
Drag the required component from the selected folder to the drawing, and carefully position them at the correct location.
If required, you can modify other features of the objects by right clicking on the object.
The options in the pop-up menu:
Delete: Removes the velocity object from the drawing area.
Set as Primary: Indicates the Velocity objects in the map that gets automatically enabled when set as primary. For example, if you place area 1 on three different maps, you can set area 1 as the primary. Then, if area 1 detects an illegal entry, area 1 automatically appears on the canvas with the area 1 alarm icon displayed.
Configure Device…: Allows to bring up the corresponding configuration screen for that device. For example, if you select this option for a reader, the Reader Properties screen for that reader appears.
IDS Area
The IDS Area feature allows you to visually represent an IDS Area by drawing it on a map. The IDS Area visually displays the Area’s Arm State as well as the Area’s Secure state. The border of the IDS Area represents the Arm State and the inside of the IDS Area represents the secure state. You can color code all supported Arm States to quickly visually identify how the area is armed.
Creating IDS Area
Click Graphics in the Main menu.
In design mode, click Design->Draw and select IDS Area.
Draw the desired area on the map.
The Map IDS constructs to a specific IDS panel Area and configures the IDS Area border and interior as shown
Interacting with IDS VIO Objects and IDS Area Constructs
In Graphics mode, right click anywhere on the selected IDS Area construct and execute the desired IDS Area command as shown.
In Graphics mode, right click on selected IDS Area VIO and execute the desired command as shown.
Right click to select IDS Point and execute the command in the map as shown.
Right click to select IDS Output and your desired command as shown.
Roles and Permissions
The Roles in Velocity streamline the process of assigning rights and privileges to operators by the Velocity server.
Adding Role based Operator to access IDS Panels, Areas, Points, and Outputs
Login as Velocity Superuser in Velocity Server.
Navigate from Main Menu-> Administration-> Roles->Operators.
The Role Operators window displays.
Select Application Permissions->IDS Panels and enable the role for the desired functions (Add/Delete/Save/View). The operator must have view permission in order to access the IDS panel and perform any operation.
Select IDS Panels or IDS Areas or IDS Points or IDS Outputs individually to give specific access.
Restricting Alarms and Events using Velocity Roles
The Velocity settings has an option to restrict alarms and events based on operator roles in Velocity. To enable this option:
Right click Velocity Service Control Manager icon on Windows taskbar and select Settings.
The Velocity Settings window displays.Go to System->Advanced in Velocity Settings.
Enable Restrict alarms and events using Velocity Roles checkbox and click OK.
Limitation
Bosch IDS plugin has the following limitation
When changes to the Area/Point/Output names of the IDS panel occur through the RPS tool, the new names will not appear in Velocity until the IDS panel has reconnected to Velocity. The workaround is disabling and re-enabling the panel or restarting the Velocity IDS service.