BlackBerry AtHoc IPAWS Installation Manual
BlackBerry AtHoc IPAWS Plug-in for NDS
Installation and Configuration Guide
NDS 2.9.2, IPAWS 2.9.27
2021-02-03Z
| | 2
Contents
Overview........................................................................................................... |
5 |
Support for WEA2.0................................................................................................................................................ |
6 |
Hardware and software requirements............................................................... |
8 |
Hardware and firmware requirements.................................................................................................................. |
8 |
Software.................................................................................................................................................................. |
8 |
Install and configure the plug-in for NDS.......................................................... |
9 |
Install the plug-in.................................................................................................................................................... |
9 |
Open the NDS console........................................................................................................................................... |
9 |
Configure the IPAWS plug-in settings.................................................................................................................. |
9 |
Configure the database server............................................................................................................................ |
10 |
Verify the IPAWS plug-in installation.................................................................................................................. |
11 |
Manage organization accounts for the plug-in.................................................................................................. |
12 |
Create a customer account..................................................................................................................... |
12 |
Create a user............................................................................................................................................. |
12 |
Enable the IPAWS plug-in for the account............................................................................................. |
13 |
Restart NDS processes........................................................................................................................................ |
13 |
Verify the IPAWS plug-in process is running.......................................................................................... |
13 |
Add the IPAWS certificate............................................................................... |
14 |
Prerequisites......................................................................................................................................................... |
14 |
Convert the certificate......................................................................................................................................... |
14 |
Upload the converted certificate......................................................................................................................... |
14 |
Replace an expired certificate................................................................................................................. |
15 |
Remove a certificate................................................................................................................................. |
15 |
Configure the certificate for the NDS account.................................................................................................. |
15 |
Configure IPAWS in the BlackBerry AtHoc management system..................... |
17 |
Enable the Inbound Event Manager for IPAWS................................................................................................. |
17 |
Configure the IPAWS package on the BlackBerry AtHoc server...................................................................... |
17 |
Configure the event codes list for IPAWS devices............................................................................................ |
17 |
Verify the event codes list....................................................................................................................... |
18 |
Set up BlackBerry AtHoc for IPAWS devices..................................................................................................... |
19 |
Public communication.............................................................................................................................. |
19 |
COG to COG communication................................................................................................................... |
19 |
Configure the IPAWS gateways............................................................................................................... |
20 |
Enable the IPAWS devices....................................................................................................................... |
21 |
Create a mass device endpoint for each COG....................................................................................... |
23 |
Create mass device endpoints for public alerting devices.................................................................... |
23 |
Send a test alert to target COGs............................................................................................................. |
23 |
Send a test alert to public alerting devices............................................................................................ |
24 |
| | iii
Configure BlackBerry AtHoc to receive alerts from external COGs................................................................. |
25 |
Create custom placeholders for the alert template............................................................................... |
26 |
Update the IPAWS alert template that notifies the operator................................................................. |
26 |
COG incoming alerts................................................................................................................................. |
27 |
Test the incoming alert............................................................................................................................ |
27 |
Monitor system health......................................................................................................................................... |
27 |
Create an IPAWS health monitor............................................................................................................. |
28 |
View system status through BlackBerry AtHoc system health............................................................. |
30 |
BlackBerry AtHoc home page system status ....................................................................................... |
32 |
Upgrade the IPAWS plug-in............................................................................. |
33 |
Copy the upgraded package to the NDS server................................................................................................ |
33 |
Update the IPAWS plug-in on NDS..................................................................................................................... |
33 |
Update IPAWS settings in the BlackBerry AtHoc management system.......................................................... |
33 |
Appendix A: CAP Payload XML....................................................................... |
35 |
Glossary.......................................................................................................... |
37 |
BlackBerry AtHoc Customer Support Portal.................................................... |
38 |
Documentation feedback................................................................................. |
39 |
Legal notice.................................................................................................... |
40 |
| | iv
Overview
In an emergency, response officials need to provide the public with life-saving information quickly. The Integrated Public Alert and Warning System (IPAWS), a modern version of the national alert and warning infrastructure, helps organizations collaborate and alert the public in order to save lives and property.
The Open Platform for Emergency Networks (OPEN) enables the sharing of emergency alerts and incident-related data between different standards-compliant incident management systems. IPAWS OPEN serves as the IPAWS Alerts Aggregator, collecting and routing IPAWS emergency alerts to and from emergency systems that serve the public. IPAWS OPEN integrates with the various alert dissemination methods of IPAWS.
Figure 1: Alert dissemination through BlackBerry AtHoc
IPAWS provides a process for emergency communities at the federal, state, territorial, tribal, and local levels to communicate with each other through alerts. IPAWS helps integrate alerting systems that use Common Alerting Protocol (CAP) standards with the IPAWS infrastructure.
The BlackBerry AtHoc IPAWS plug-in provides support for sending alerts from one Collaborative Operating Group (COG) to other COGs and to public alerting systems such as the Emergency Alert System (EAM), and Wireless Emergency Alerts (WEA).
Using the AtHocNotification Delivery Service (NDS) console, users first configure the plug-in and set up accounts. They then use BlackBerry AtHoc to set up the IPAWS gateways and configure the IPAWS device. In BlackBerry AtHoc, they also create a mass device endpoint for each device as well as their own COG and other COGs with which they want to communicate. Operators can then send alerts through the BlackBerry AtHoc management system and can customize the content for the IPAWS devices. Additionally, users can use the out of the box IPAWS COG to COG Alert Template to notify operators that other COGS have sent alerts to their local system.
| Overview | 5
Support for WEA2.0
In BlackBerry AtHoc release 7.10 and later releases, the NDS IPAWS plug-in supports both WEA 1.0 and WEA 2.0.
With WEA 2.0, when a specific event type is selected in the Device Options in BlackBerry AtHoc, NDS appends a relevant WEA handling code to the payload before sending it to IPAWS.
The following table shows the mapping of event types and WEA handling codes:
Handling |
Event type |
Imminent |
Public safety |
Amber |
WEA test |
Presidential |
code |
|
threat |
|
|
|
(restricted) |
|
|
|
|
|
|
|
AVW |
Avalanche |
X |
|
|
|
|
|
Warning |
|
|
|
|
|
|
|
|
|
|
|
|
CDW |
Civil |
X |
|
|
|
|
|
Danger |
|
|
|
|
|
|
Warning |
|
|
|
|
|
|
|
|
|
|
|
|
CEM |
Civil |
X |
|
|
|
|
|
Emergency |
|
|
|
|
|
|
Message |
|
|
|
|
|
|
|
|
|
|
|
|
EQW |
Earthquake |
X |
|
|
|
|
|
Warning |
|
|
|
|
|
|
|
|
|
|
|
|
EVI |
Evacuation |
X |
|
|
|
|
|
Immediate |
|
|
|
|
|
|
|
|
|
|
|
|
FRW |
Fire |
X |
|
|
|
|
|
Warning |
|
|
|
|
|
|
|
|
|
|
|
|
HMW |
Hazardous |
X |
|
|
|
|
|
Materials |
|
|
|
|
|
|
Warning |
|
|
|
|
|
|
|
|
|
|
|
|
LEW |
Law |
X |
|
|
|
|
|
Enforcement |
|
|
|
|
|
|
Warning |
|
|
|
|
|
|
|
|
|
|
|
|
NUW |
Nuclear |
X |
|
|
|
|
|
Power |
|
|
|
|
|
|
Plant |
|
|
|
|
|
|
Warning |
|
|
|
|
|
|
|
|
|
|
|
|
RHW |
Radiological |
X |
|
|
|
|
|
Hazard |
|
|
|
|
|
|
Warning |
|
|
|
|
|
|
|
|
|
|
|
|
SPW |
Shelter |
X |
|
|
|
|
|
In-place |
|
|
|
|
|
|
Warning |
|
|
|
|
|
|
|
|
|
|
|
|
| Overview | 6
Handling |
Event type |
Imminent |
Public safety |
Amber |
WEA test |
Presidential |
code |
|
threat |
|
|
|
(restricted) |
|
|
|
|
|
|
|
VOW |
Volcano |
X |
|
|
|
|
|
Warning |
|
|
|
|
|
|
|
|
|
|
|
|
BLU |
Blue Alert |
|
X |
|
|
|
|
|
|
|
|
|
|
LAE |
Local Area |
|
X |
|
|
|
|
Emergency |
|
|
|
|
|
|
|
|
|
|
|
|
TOE |
911 |
|
X |
|
|
|
|
Telephone |
|
|
|
|
|
|
Outage |
|
|
|
|
|
|
Emergency |
|
|
|
|
|
|
|
|
|
|
|
|
CAE |
Child |
|
|
X |
|
|
|
Abduction |
|
|
|
|
|
|
Emergency |
|
|
|
|
|
|
|
|
|
|
|
|
DMO |
Practice/ |
|
|
|
X |
|
|
Demo |
|
|
|
|
|
|
Warning |
|
|
|
|
|
|
|
|
|
|
|
|
RMT |
Required |
|
|
|
X |
|
|
Monthly |
|
|
|
|
|
|
Test |
|
|
|
|
|
|
|
|
|
|
|
|
RWT |
Required |
|
|
|
X |
|
|
Weekly |
|
|
|
|
|
|
Test |
|
|
|
|
|
|
|
|
|
|
|
|
EAN |
Presidential |
|
|
|
|
X |
|
Alert |
|
|
|
|
(Restricted |
|
|
|
|
|
|
for |
|
|
|
|
|
|
President |
|
|
|
|
|
|
only. Not |
|
|
|
|
|
|
applicable |
|
|
|
|
|
|
to state, |
|
|
|
|
|
|
territorial, |
|
|
|
|
|
|
tribal, or |
|
|
|
|
|
|
local.) |
|
|
|
|
|
|
|
| Overview | 7
Hardware and software requirements
This section describes the hardware and software requirements for the IPAWS plug-in.
Hardware and firmware requirements
The IPAWS plug-in has the following minimum hardware and firmware requirements:
•A minimum of two Dual-Core Dual CPUs (such as Xeon 51xx family, Xeon E53xx family, or X53xx family), 2 GHz or higher
•One database server core for every two application server cores
•4 GB for each server
•Dual, redundant Intel NICs and power supplies
•If using BroadCOM NICs, ensure that the latest drivers are installed. Disable the TCP Chimney feature as described in the following Microsoft article: http://support.microsoft.com/kb/951037
•The installation procedure requires at least 20 GB free for data.
•Disk space for storage on a RAID 5, RAID 0+1, or RAID 10 configured disk system. The exact allocation of disks depends on the hardware configuration.
Note: Limit SQL RAM usage to 60% of the total system RAM.
Software
The IPAWS plug-in has the following minimum software requirements:
•Notification Delivery Server (NDS) 2.9.27
•BlackBerry AtHoc management system 7.9 or later release
•64-bit Windows Server 2016
•Microsoft SQL Server 2016
•Internet Information Services (IIS)
•Microsoft .NET Framework 4.7.2
| Hardware and software requirements | 8
Install and configure the plug-in for NDS
The following sections describe how to install and configure the IPAWS plug-in on the NDS server.
Install the plug-in
The IPAWS plug-in provides the ability to send and receive IPAWS alerts between Collaborative Operating Groups (COGs) using the BlackBerry AtHoc cloud service.
Note: The upgrade steps are the same as the installation steps. To install the plug-in, complete the following steps:
1.Log in to the NDS server.
2.Stop the BlackBerry AtHoc services:
a.From IIS, select the application server.
b.On the Actions screen, click Stop.
c.Navigate to Windows Services and stop AtHocDeliveryServices.
3.Copy the IPAWS plug-in .zip file, AtHoc.NDS.PlugIn.IPAWS_build.zip, that you received from BlackBerry AtHoc support to a temporary folder.
4.On the file Properties screen, click the General tab.
5.Click Unblock and then extract the contents of the compressed file to a temporary directory.
6.In the temporary directory, rename the following folder: AtHoc.Delivery.Plugin.IPAWS_build to the folder name:IPAWS
7.Copy the IPAWS folder to the following location:
<NDSServer>\Program Files (x86)\AtHocENS\DeliveryServer\Plugins\
Where <NDSServer> is the name of the server where the NDS is installed.
Open the NDS console
Use the NDS console to manage the NDS.
Prerequisite:The NDS host services must be set up and you must have NDS administration privileges.
1. Open the NDS console in Admin Mode using the following server address:
\\AtHocENS\DeliveryServer\Tools\NDSConsole
For detailed instructions on how to install and configure the NDS console, see the BlackBerry AtHoc Notification Delivery Service Installation and Configuration Guide.
Configure the IPAWS plug-in settings
1.Open the NDS console on the NDS server in administrator mode.
2.Navigate to Management > Configuration.
3.Click New Configuration.
4.In the New Key field, enter the following value: nds.plugins.ipaws
| Install and configure the plug-in for NDS | 9
5. From Windows Explorer, open the following file:
AtHocENS/DeliveryServer/Plugins/ipaws/AtHoc.NDS.Plugins.IPAWS.dll.config
6. Copy the contents and close the file.
<nds.plugins.ipaws>
<supportedDevices>
<device type="IPAWSNWEM" enabled="true" secondsTimeout="600" requiredInilizations="None" maxTasksPerInit="50" maxTasksPerExecution="50" maxTasksCanProcess="50" alertCancelOffsetInMin="5" certExpirationReminderInDays="40" />
<device type="IPAWS" enabled="true" secondsTimeout="600" requiredInilizations="None" maxTasksPerInit="50" maxTasksPerExecution="50" maxTasksCanProcess="50" alertCancelOffsetInMin="5" certExpirationReminderInDays="40" />
</supportedDevices>
<supportedEvents>
<event type="Health" enabled="true" /> <event type="GetMessage" enabled="true" /> </supportedEvents>
</nds.plugins.ipaws>
7.Optionally, configure the value of the alertCancelOffsetInMin attribute. The IPAWS plug-in determines when to send an alert termination or cancel message to the IPAWS FEMA server based on the value of
the alertCancelOffsetInMin attribute. An alert termination or cancel message is sent only when the time difference between the alert expiration time set during alert creation and the actual alert termination time is greater than the alertCancelOffsetInMin value. If the alert ends after the specified end time for the alert, or the difference between the alert expiration time set during alert creation and the actual alert termination time is less than the alertCancelOffsetInMin value, no alert termination or cancel message is sent. Note: The value for the alertCancelOffsetInMin attribute must be the same for both devices.
8.Optionally, configure the value of the certExpirationReminderInDays attribute. The default is 40 days. When the certificate expiration date is less than or equal to the configured number of days, a warning message is logged in the Event Viewer before every alert publish. The message contains the expiration date of the certificate and the number of remaining days the certificate is valid.
Note: The value for the certExpirationReminderInDays attribute must be the same for both devices.
9.Return to the NDS console and paste the file contents in the Value field.
10.Click Save.
11.Restart the NDS processes.
For detailed information, see Restart the NDS processes.
Configure the database server
Before you begin:
•You will need the following information before you configure the database server:
•The database server name.
•The SA user password.
•The name of the ngdelivery database.
•Place the IPAWSConfiguration folder that you obtained from AtHoc sales in a folder on your local computer. This folder contains the IPAWSConfiguration.bat and IPAWSConfiguration.sql files.
| Install and configure the plug-in for NDS | 10
1.Open the IPAWSConfiguration folder on your local system.
2.Right-click the IPAWSConfiguration.bat file. Click Edit and open the file using Notepad.
3.Add the database server instance name, ngdelivery database server name, and the SA user password to the IPAWSConfiguration.bat file as shown in the following example:
@echo off
@echo Configuring the IPAWS Plugin
rem update the database information in the below statement. Remove the <> from <value> and add the respective values.
for %%G in (IPAWSConfiguration.sql) do sqlcmd -S <DatabaseServerInstanceName> - d <NGDeliveryDBName> -U sa -P "<SAUserPassword>" -i "&&G"
PAUSE
4.Save and close the IPAWSConfiguration.bat file.
5.Open the IPAWSConfiguration.sql file.
6.Verify that the @deviceType values are IPAWS and IPAWSNWEM.
DECLARE @deviceType1 NVARCHAR(50)
DECLARE @deviceType2 NVARCHAR (50)
DECLARE @SQL AS VARCHAR (MAX)
SELECT @deviceType1='IPAWS'
SELECT @deviceType2='IPAWSNWEM'
IF NOT EXISTS (SELECT * FROM NGDeliveryAccount.dbo.DatacenterSiteDetail a INNER JOIN ProductInfo b ON a.SiteId=b.SiteId WHERE a.DeviceType=@deviceType1)
BEGIN
INSERT INTO NGDeliveryAccount.dbo.DatacenterSiteDetail([DataCenterId], [SiteId] ,[DeviceType],[CreatedOn])
SELECT 1,siteid , @deviceType1,GETUTCDATE() FROM ProductInfo
END
IF NOT EXISTS (SELECT * FROM NGDeliveryAccount.dbo.DatacenterSiteDetail a INNER JOIN ProductInfo b ON a.SiteId=b.SiteId WHERE a.DeviceType=@deviceType2)
BEGIN
INSERT INTO NGDeliveryAccount.dbo.DatacenterSiteDetail([DataCenterId], [SiteId] ,[DeviceType],[CreatedOn])
SELECT 1,siteid , @deviceType2,GETUTCDATE() FROM ProductInfo
END
IF COL_LENGTH('NGDeliveryAccount.dbo.DatacenterSiteDetail', 'ResourceType') IS NOT NULL
BEGIN
SET @SQL = 'UPDATE NGDeliveryAccount.dbo.DatacenterSiteDetail SET ResourceType =''RATE'' WHERE DeviceType = ''IPAWS''OR DeviceType = ''IPAWSNWEM'''
EXEC(@SQL)
END
When you log in to the database server, there are IPAWS and IPAWSNWEM entries in the DeviceType column in the ngdeliveryaccount > DatacenterSiteDetail table and the ResourceType is RATE.
Verify the IPAWS plug-in installation
1.Navigate to the following folder: ..\AtHocENS\DeliveryServer\Tools\NDSConsole and run the AtHocNDSConsole.exe file.
2.In the NDS console, navigate to Console > Testing.
| Install and configure the plug-in for NDS | 11
3. Verify that the IPAWS and the IPAWSNWEM devices are included in the Supported Devices section.
Manage organization accounts for the plug-in
This section describes how to create the organization account and the user for IPAWS on the NDS server. The NDS account manages all NDS plug-ins that you have.
Do not perform these tasks if you already have an NDS account.
Create a customer account
Create an account for each client site. This account serves all the organizations (formerly called "virtual systems" or "VPS"s) that use IPAWS on the system. The account is associated with an NDS user that manages the NDS plug-ins.
1.Open the NDS console from the NDS server in admin mode.
2.Navigate to Management > Account.
3.On the Account Management screen, click New Account.
4.On the New Account screen, enter the Display Name, which is the name used when configuring the IPAWS delivery gateway in BlackBerry AtHoc management system. Keep the following defaults:
•Status: Active
•Enable anonymization: Selected
5.Click Save.
Create a user
Create a user who is associated with the customer account and manages the NDS account and plug-ins.
1.In the NDS console, navigate to Management > User.
2.Click New User.
3.On the New User screen, enter values in the Login Name, Password, and Confirm Password fields.
This login name and password is used to configure the delivery gateway in the BlackBerry AtHoc management system.
4.In the Status field, select Active from the list.
5.Optionally, add a description.
6.Click Save.
7.To associate the user with an account:
a.On the User Management screen, select the user name.
b.Right-click an account name and click API.
The user is then associated with the IPAWS account.
| Install and configure the plug-in for NDS | 12
Enable the IPAWS plug-in for the account
After you have created the user and associated it with the IPAWS account, you must enable the IPAWS plug-in.
1.In the NDS console, navigate to Management > Account.
2.On the Account Management screen, select the account that you created in the Create a customer accountsection.
3.Click the Account Resource tab.
4.Select the IPAWS and IPAWSNWEM device type check boxes.
5.Ensure that the value in the Resource Type column is Rate.
6.Click Save.
Restart NDS processes
After you have configured or modified the plug-in settings, restart the NDS processes.
1.From the NDS server, open the Server Manager as an administrator.
2.Navigate to Configuration > Services.
3.Restart the AtHocDeliveryService service.
Verify the IPAWS plug-in process is running
1.Open the NDS console and start NDS.
2.Open the Task Manager and check the AtHocNDSConsole.exe*32 process.
3.If the AtHocNDSConsole.exe*32 process is not running, perform the following steps:
a.Open a command prompt and run as administrator.
b.Navigate to the following directory: NDSServer\Program Files (x86)\AtHocENS\DeliveryServer \Plugins\IPAWS.
c.Enter Run AtHocNDSConsole.exe*32.
| Install and configure the plug-in for NDS | 13
Loading...