BlackBerry AtHoc Industrial Strobe Beacon Configuration Guide

BlackBerry AtHoc Networked Crisis Communication
Industrial Strobe Beacon
Configuration Guide
Release 7.4, January 2018
Copyright © 2015–2018 BlackBerry Limited. All Rights Reserved.
This document may not be copied, disclosed, transferred, or modified without the prior written consent of
BlackBerry Limited. While all content is believed to be correct at the time of publication, it is provided as general purpose information. The content is subject to change without notice and is provided “as is” and with no
expressed or implied warranties whatsoever, including, but not limited to, a warranty for accuracy made by
BlackBerry Limited. The software described in this document is provided under written license only, contains valuable trade secrets and proprietary information, and is protected by the copyright laws of the United
States and other countries. Unauthorized use of software or its documentation can result in civil damages
and criminal prosecution.
Trademarks
Trademarks, including but not limited to ATHOC, EMBLEM Design, ATHOC & Design and the PURPLE
GLOBE Design are the trademarks or registered trademarks of BlackBerry Limited, its subsidiaries and/or
affiliates, used under license, and the exclusive rights to such trademarks are expressly reserved. All other
trademarks are the property of their respective owners. Users are not permitted to use these marks without
the prior written consent of AtHoc or such third party which may own the mark.
This product includes software developed by Microsoft (http://www.microsoft.com).
This product includes software developed by Intel (http://www.intel.com).
This product includes software developed by BroadCom (http://www.broadcom.com).
All other trademarks mentioned in this document are the property of their respective owners.
Patents
This product includes technology protected under patents and pending patents.
BlackBerry Solution License Agreement
https://us.blackberry.com/legal/blackberry-solution-license-agreement
Contact Information
BlackBerry AtHoc
2988 Campus Drive, Suite 100
San Mateo, CA 94403
Tel: 1-650-685-3000
Email: athocsupport@blackberry.com
Web: http://www.athoc.com
Contents
CHAPTER 1: PRODUCT REQUIREMENTS
1
Hardware and firmware requirements
Software requirements
1
1
CHAPTER 2: REGISTER THE INDUSTRIAL STROBE BEACON DELIVERY GATEWAY ON
BLACKBERRY ATHOC
Enable the device on the server
Configure the delivery gateway
Configure the device
Create the Strobe mass device endpoints
2
2
3
4
5
CHAPTER 3: IIM SETUP
7
Set up filters in the IIM
Update the indexURL
7
8
CHAPTER 4: CONTACT BLACKBERRY ATHOC TECHNICAL SUPPORT
i
9
Chapter 1: Product requirements
Chapter 1: Product requirements
The following section describes the hardware and software requirements to configure strobe
devices.
Hardware and firmware requirements
Strobe Light has the following minimum hardware and firmware requirements:
l
l
For each connected strobe light, you need to have the following items:
o
An available RS232 computer port
o
A line level input into an auxiliary audio input module
You need at least one strobe beacon (two units for redundancy) in each isolated control and
audio network, with the listed requirements.
Software requirements
Strobe Light has the following minimum software requirements:
l
IP Integration Module Agent: Version 1.1.0
l
IIM Capnode with capnode_obf.jar build 46 or later
1
Chapter 2: Register the Industrial Strobe Beacon delivery gateway on BlackBerry AtHoc
This section describes the steps to configure the strobe light on the BlackBerry AtHoc management system. The delivery gateway for strobe lights is Industrial Strobe Beacon.
Enable the device on the server
2
Configure the delivery gateway
3
Configure the device
4
Create the Strobe mass device endpoints
5
Enable the device on the server
Before you start configuring the devices for BlackBerry AtHoc, you must enable the device on the
BlackBerry AtHoc server. When you enable the device, it appears in the list of gateways on the Settings screen and in the list of devices in the Devices section.
To enable the Industrial Strobe Beacon device, perform the following steps:
1. Open Internet Explorer and launch the BlackBerry AtHoc server.
2. Navigate to the following folder: ../Program Files (x86)/AtHocENS/ServerObjects/Tools and run the AtHoc.Applications.Tools.InstallPackage file.
In the Configure Device Support screen, select the Industrial Strobe Beacon check box.
2
Industrial Strobe Beacon Configuration Guide
3. Click Enable.
4. Click Close.
Configure the delivery gateway
To configure the gateway, perform the following steps:
1. Log in to BlackBerry AtHoc management system as an administrator.
2. In the navigation bar, click the
(Settings) icon.
3. In the Devices section, select Industrial Strobe Beacon.
4. Click Copy Default Settings. In the CAP Parameter Defaults section, the Sender field displays IWSAlerts.
3
Chapter 2: Register the Industrial Strobe Beacon delivery gateway on BlackBerry AtHoc
5. Click Save.
Configure the device
Perform the following steps to configure the strobe device to receive alerts from BlackBerry AtHoc:
1. In the navigation bar, click the
(Settings) icon.
2. In the Devices section, click Devices.
3. Click Industrial Strobe Beacon.
4. Click Edit.
5. In the Details section, fill in the fields as shown in the following image.
4
Industrial Strobe Beacon Configuration Guide
6. In the Delivery Gateway section, click on the Add a Delivery Gateway list and select Industrial Strobe Beacon.
7. Click the Configure link to open the text entry field and verify the XML with the below XML
template.
8. Click Save.
9. To make the strobe device available for alert targeting, click Enable.
10. To return to the Settings screen, click Return to Device Manager.
Create the Strobe mass device endpoints
To create Strobe mass device endpoints for each device, perform the following steps:
5
Chapter 2: Register the Industrial Strobe Beacon delivery gateway on BlackBerry AtHoc
1. In the navigation bar, click the
(Settings) icon.
2. In the Devices section, click Mass Device Endpoints. The Mass Device Endpoints screen
opens.
3. Click New, and then select the Strobe device.
4. In the General section, enter an Endpoint Name. Enter a value between 4 and 80 characters
long. The following special characters are not allowed: ( ' ^ = < > )
5. In the General section, enter a Common Name. Enter a value between 4 and 80 characters
long. The following special characters are not allowed: (` ! $ % ^ ( ) = { } , ; : ? " < > | [space])
6. In the Configuration section, enter an address for the Strobe device. Use a unique value for
the second number in the address for each endpoint. For example, P,0,1 and P1,1.
Syntax: P<n>,1
Where n is the unique number for the pole. This number will be added to the address in the IIM
filter.
7. Click Save.
6
Chapter 3: IIM setup
The following sections describe how to set up IIM. Ensure that the version of IIM that you are running is at least build 46 of capnode_obf (check the value in the build.number file).
Set up filters in the IIM
7
Update the indexURL
8
Set up filters in the IIM
1. Connect to the IIM strobe light.
2. Open the CapCon Console.
3. Click on the Filter tab.
4. In the Node Address field, enter the end point value for the device.
Syntax: INDUSTRIAL_STROBE_1_<n>
Where n = the second number in the mass device end point address. See Create the Strobe
mass device endpoints.
5. For the CAP server, click the Advanced Filter tab.
6. Select the OR this filter with the simple filter option.
7. Add the CAP station name in the <restriction> tags.
7
Industrial Strobe Beacon Configuration Guide
8. Click Apply Advanced Filter Parameters to save.
Update the indexURL
For the indexURL, you should provide both the BlackBerry AtHoc and the CapServer links.
For Cap Server, you must do a special configuration. IIM uses a build that automatically appends
?ast=<MACID> to indexURL, which can cause bad strings to show up in the CapCon report list.
Append &ast=1234 after the normal string. This change prevents the IIM from appending the
?ast. The change also allows the Cap Server to ignore it. For example, see the bold:
indexURL=https\://integration6.athoc.com/Syndication/CAP_
INDUSTRIALSTROBE/2061062/capindex/;https\://cwscapqa.alertingsolutions.com/capserver/Poll?id\=CapCon_<account>_<member>&ast=1234
8
Chapter 4: Contact BlackBerry AtHoc technical support
Chapter 4: Contact BlackBerry AtHoc technical support
If you encounter any problems or have questions regarding the BlackBerry BlackBerry AtHoc software, contact BlackBerry AtHoc Technical Support using any of the following methods:
l
Web Site Form: https://support.athoc.com/customer-support-portal/-login.html
l
Telephone: (888) GO-ATHOC (462-8462)
l
Email: athocsupport@blackberry.com
Tip: The Web-based support form is the primary method for contacting BlackBerry AtHoc technical support.
9