Atch 01 - PWS Attachment 8.3 SiRcom - Administrator Guide.pdf

SiRcom Smart Alert (SiSA) Mass Notification System (MNS)

Administrator Guide

Version 1.0

January 2024

Table of Contents

1.0 SiRcom SMART Alert Administration

1.1 Overview

1.2 Purpose

1.3 System Requirements

1.4 Folder Paths and Glossary

1.5 Accessing the Administration Tool

2.0 Adding/Removing Devices from SiSA

2.1 Adding Units

2.2 Removing Units

2.3 Editing Units

2.4 Offline Maps

2.4.1 Static Maps/Site Plans

3.0 User Management

3.1 Add/Remove Local Users

3.1.1 Create New Local User or Administrator

3.1.2 Edit/Delete Local User or Administrator

4.0 System Maintenance/Settings

4.1 System Maintenance

4.3 Advanced Settings

4.3.1 Network Settings

4.3.2 Serial Settings

4.3.3 Third-Party Radio Integration

4.3.4 System-wide Advanced Audio Settings

4.3.5 Send Cancel/Stop Settings

4.3.6 System Features

4.4 Alarms & Stored Messages

4.5 Quick-Select Zones/Unit Groups

4.6 Scripts & Scenarios

4.7 Action Buttons

4.8 Digital Events

4.9 Themes

5.0 System Backup/Restore

5.1 System Backup

5.2 System Restore

5.3 Legacy Database Migrations

6.0 Additional Resources

6.1 Contact Information

1.0 SiRcom SMART Alert Administration

1.1 Overview

The SiRcom SMART Alert Software (SiSA) is an on-premise or cloud-based mass notification management system designed to facilitate efficient and effective communication during emergency situations. SiSA offers a comprehensive set of features and capabilities to streamline the alerting process, ensuring the timely delivery of critical information to the intended recipients. With its user-friendly interface and robust functionality, SiSA empowers organizations to enhance their emergency preparedness and response.

Key Features of SiSA:

● Centralized Dashboard: Provides a unified system view, allowing users to monitor and manage alerts, recipients, templates, and settings.

● Message Creation and Customization: Enables users to create, edit, and customize alert messages with various formats, including text, images, and multimedia.

● Recipient Management: Allows for the creation and management of recipient groups, ensuring targeted and efficient alert distribution.

● Multi-channel Alert Delivery: Supports sending alerts through multiple communication channels, such as SMS, email, voice calls, social media, and more.

● Template Library: Offers pre-built templates for common emergency scenarios, simplifying the message creation process.

● Administrative Controls: Provides administrators with granular control over system settings, user roles, and permissions.

1.2 Purpose

The SiRcom Smart Alert (SiSA) administrator guide is an overview of the instructions and essential information for individuals responsible for managing and maintaining a system, application, or network. The guide aims to provide administrators with the knowledge and resources needed to effectively oversee and optimize the performance, security, and functionality of the system or software they are responsible for.

1.3 System Requirements

Before using the SiRcom SMART Alert Software (SiSA), ensure that your system meets the following minimum requirements:

Hardware Requirements: May not apply to all clients

● Processor: 2.0 GHz dual-core or higher

● RAM: 4 GB or higher

● Storage: Minimum 10 GB free disk space

● Display: Minimum resolution of 1280x720 pixels

Software Requirements: May not apply to all clients

● Operating System: Windows 10, macOS 10.12 (or later), or Linux with a modern web browser

● Web Browser: Google Chrome (latest version recommended), Mozilla Firefox, Microsoft Edge, or Safari

Note: The system requirements may vary based on the organization's size and specific deployment configurations.

1.4 Folder Paths and Glossary

SISA SiRcom SMART Alert

{Public Folder} C:\SiRcom\resources\app.asar.unpacked\Public\

AD Active Directory

MNS Mass Notification System

EMNS Electronic/Enterprise Mass Notification System (SMS/Email, etc.)

Siren/Unit Any end-device that receives and disseminates audible and visual alerts

GV Giant Voice (Outdoor Warning Siren)

ISU Integrated Speaker Unit (Indoor/Outdoor Alerting Unit)

SiBo/SiTouch SiRcom Touchscreen Interface

WAVES Wireless Audio Visual Emergency System by Eaton (discontinued as of this document)

RTU Remote (Radio) Terminal Unit - enables communication with UHF/VHF radios via IP

WAVES RTU Remote (WAVES) Terminal Unit - enables communication with WAVES CRLU via IP

CRLU WAVES PRIMARY CONTROL UNIT

IBS Integrated Base Station

CCU Central Control Station (the server that is running SiSA)

SiSA Database Geojson File - located at {Public Folder}\database --- file extension: *.geojson

SiSA Config File JSON file - located at {Public Folder}\config.json -- file extension *.json

GUI Graphical User Interface

1.5 Accessing the Administration Tool

You may sign in to the Administrator Tool by launching the SiSA Application using the shortcut on the desktop. Upon launch, tap “Administration” and “Administration Tool” from the window menu in the top left corner of your screen.

Sign in to the Administrator Tool using the default administrator account info:

Username: admin Password: 1234

NOTE: Update your default username/password immediately after deploying a new instance of SiSA to prevent unauthorized access!

After signing into the Administrator Portal, you are presented with 3 options. “Manage Map”, “Manage Users,” and “Manage App”.

● To configure the map/units on the system, see Section 2.

● To configure/add/edit/delete users, see Section 3.

● To configure system settings, see Section 4.

CUI

USMC-SiSA-Administrator_v1.0

2.0 Adding/Removing Devices from SiSA

2.1 Adding Units

To add a unit, navigate to the manage map section of the manage admin page. On this page click on the unit icon on the left toolbar, highlighted in red here.

When selected, click on the map to place your unit.

You will then be able to fill out all of the correct unit details.

When you are finished, click “add”, then make sure to click “save” or “save & close” to save the changes to the map.

2.2 Removing Units

To delete a unit, click on the trash icon on the left side of the screen. From there, click on the unit you would like to delete. When you are finished, make sure to “save” or “save & close” to save your changes.

Click “Save Map” to save your changes to the database.

2.3 Editing Units

To edit a unit, click on the unit icon on the map, then proceed by pressing “edit unit”.

Unit/Siren Fields include unit type, the siren/unit model, the maximum volume of that particular unit, and more. Depending on the unit type, the options may change, so please utilize the edit options to configure it to your specific configuration needs.

Click “Update” and then “Save Map” to save your changes to the database.

2.4 Offline Maps

SiSA is capable of serving rich map tiles from the SiRcom Map Server and locally from the server for offline deployments. Offline maps for the Continental United States (CONUS) can be requested by visiting https://support.hqesystems.com and submitting a request. Offline maps are provided to license holders for no additional cost. Offline maps must be stored in the following location(s):

{Public Folder}\plugins\offline-maps\tiles\{satellite or streets}

The map tiles requested can be for satellite maps or street maps, depending on the availability of the targeted area.

Map files are provided as a self-extracting zip file, and will be loaded into the proper directory without requiring intervention by the operator.

If offline maps are used, System Administrators must set “Offline Maps” to “Yes” in the SiSA System Administrator tool as seen below.

2.4.1 Static Maps/Site Plans

SiSA is also capable of utilizing a single PNG as a map overlay without traditional map tiles. In order to do so, System Administrators should load a map.png file in the following directory “{Public Folder}\plugins\static-map”

Additionally, the System Administrator should identify and update the “{Public Folder}\config.json” file with the correct latitude and longitude for the NorthEast and SouthWest limits of the selected PNG. This will ensure that all the units on the SiSA map have relevant GPS positions.

An example of the configuration parameters are as follows:

"NORTH_EAST_LAT": 34.098012,

"NORTH_EAST_LNG": -118.298288,

"SOUTH_WEST_LAT": 34.097594,

"SOUTH_WEST_LNG": -118.299297,

https://support.hqesystems.com

3.0 User Management

3.1 Add/Remove Local Users

3.1.1 Create New Local User or Administrator

When creating a new user, provide their Full Name, User ID (typically 4 digits, often the last 4 digits of the user’s DoD ID number), username (can be an email address), and password.

Additionally, Administrators can choose an Account Type (Operator, Technician, Administrator).

Click “Add User” to save the new user to the database.

3.1.2 Edit/Delete Local User or Administrator

Select the user on the left sidebar, the user information will then be displayed and you are able to edit any relevant information about the user.

Click “Delete User” or “Update User” to save your changes to the database.

4.0 System Maintenance/Settings

4.1 System Maintenance

SiRcom SMART Alert (SiSA) is platform agnostic, and can be installed on a host of operating systems, to include Microsoft Windows 7-11, Apple macOS 10+, and Linux CentOS, Ubuntu, and RedHat.

HQE Systems provides quarterly updates on the first Friday of each quarter. Updates are pushed to HQE’s Update Distro - which varies from customer to customer.

Within the general settings tab you configure basic information like your site name, organization, and location. The server settings can also be configured, as well as the default map and views.

4.3 Advanced Settings

Click on the “Show Advanced Settings” button. Advanced settings include Network Settings, Serial Settings, Radio Settings, Network Settings, WAVES Settings, Audio Settings and Features.

4.3.1 Network Settings

Advanced network settings are available to allow for different networking configurations.

4.3.2 Serial Settings

Advanced serial settings are available to allow for data broadcasting through the serial port.

NOTE: This setting is set to “No” when using WAVES integration. See section 4.3.4 for WAVES configuration.

4.3.3 Third-Party Radio Integration

Configure SiSA to communicate utilizing advanced radio communication techniques, such as P25 Trunking, Tetra, and integrations with Motorola SDS, Hytera, etc.

4.3.4 System-wide Advanced Audio Settings

Configure audio settings and timing delays for different SiSA hardware configurations, and scripts.

Note: If the system is using AtHoc integration, change the AtHoc Support drop down to “IIM”.

If the system is a strictly WAVES based system then change the ISU Support to “No”. If a change needs to be made to the delay, timeout or buffer settings the measurement is in milliseconds. These settings are typically only used in systems that utilize conventional UHF/VHF radios, and are used for audio synchronization.

4.3.5 Send Cancel/Stop Settings

Dynamically control when the “STOP/CANCEL” command is sent to units/sirens.

Note: These settings should remain as configured by default in most situations. In the event that it is desired for SiSA to send a STOP/CANCEL command after a non-audio activation, select “Yes” for that specific function. This is used to minimize unnecessary RF broadcasts.

4.3.6 System Features

System-wide enable / disable specific features within SiSA. Changing these settings outside the parameters of your license may be in violation of your Terms and Conditions.

Note: To enable or disable any of the above features, select “Yes” or “No” from the drop down.

Note: a full system restart will be required for these settings to take effect.

4.4 Alarms & Stored Messages

Allows you to check what alarms / stored messages are stored on the system, and then configure their length for your use case.

Note: If an alarm or stored message is not being used, delete the length field so that it is blank and hit save. This will remove that alarm and/or stored message from the front-end GUI for the operators.

4.5 Quick-Select Zones/Unit Groups

Quick zone groups allow you to quickly select a group of units. Create a Zone ID, a Zone Name, and then select the units you would like in the zone and click “Create Zone”.

NOTE: Select any combination of end-devices to create your dynamic zone.

4.6 Scripts & Scenarios

Create custom scripts depending on a variety of pre-made scenarios. Scripts and Scenarios can be activated through a variety of functions, to include actions buttons, which can be configured in Section 4.7.

To create a script, press “Create New”

1. Provide a Script/Scenario Name

2. Click “Add” to add a new line to the bottom of the script queue, or click “Insert” after selecting a specific item in the queue to add an action above it.

3. Select the Script Action from the drop down list and provide the required information

4. Be sure to save your script by clicking “Save” prior to closing the window.

4.7 Action Buttons

Customize the action buttons on your home screen, or add new ones.

Note: You must choose a script/scenario, and are able to choose if buttons should be visible and available to operators, technicians, or both. Additionally, you can create a “HOT” button, which is an action button that has pre-defined end devices, which will override the operator’s map based selection.

NOTE: Tap the white box to select an icon for your action button!

4.8 Digital Events

Configure a digital event to activate depending on certain scenarios.

Note: Digital Events allow for equipped end-devices to automatically trigger a predefined script/scenario if one of the I/O pins is activated/deactivated (high/low).

A digital event can range from a pop-up dialog to full system activation, and can be customized based on the specific end-device that is reporting the I/O change.

4.9 Themes

The user interface can be customized to your preferred look and feel. Simply click each box, enter in the hexadecimal color code or choose a color utilizing the popup dialog.

5.0 System Backup/Restore

5.1 System Backup

While in the admin section, scroll down to where you can see “Backup Database”.

You will then be able to navigate to a secure folder and save your database backup.

5.2 System Restore

To restore a system that has suffered a total failure, you can take action in one of two ways:

1. At the Central Control Station with the GOOD Database:

● Minimize SiSA Alert

● Navigate to {Public Folder}

● Copy the following files to external drive or CD:

○ Config.json

○ The entirety of “database” folder

○ The entirety of the “audio” folder

2. At the Alternate Central Control Station, go through the following steps:

● Log out all users and restart the computer

● Once the computer boots back up, login in as “SiRcom.” There is no password to login.

● Empty the recycling bin by right clicking on the trash can icon and clicking “empty”

● Navigate to {Public Folder}

○ Copy config.json from your CD/External Drive and overwrite existing config.json

○ Copy entire “database” folder and overwrite existing “database” directory

● Close all open windows

● Launch “SiSA Alert” from the desktop

● Login to SiSA and test the system

○ Default username: operator

○ Default password: 1234

5.3 Legacy Database Migrations

For legacy versions of SiSA (version < 2.0), please follow the instructions on screen to import your database.

Note: If you navigate to {Public Folder} and copy/save the public folder, this is an alternative way of backing up the entire system.

6.0 Additional Resources

In addition to this user manual, the following resources and references are available to provide further guidance and support for using SiSA:

1. Knowledge Base: Access our comprehensive knowledge base that contains articles, guides, and tutorials on various aspects of SiSA. You can find answers to frequently asked questions, troubleshooting tips, and best practices.

2. Video Tutorials: Explore our video tutorials that provide step-by-step instructions and demonstrations on using SiSA's key features. These tutorials cover various topics, from creating and sending alerts to managing recipient lists and generating reports.

3. Webinars: Join our webinars conducted by SiRcom experts to learn more about specific functionalities, advanced features, and tips and tricks for optimizing your use of SiSA.

These webinars offer an interactive platform to ask questions and interact with other SiSA users.

4. User Community: Connect with fellow SiSA users through our user community platform.

Share insights, best practices, and experiences, and engage in discussions related to SiSA's usage, features, and industry trends.

6.1 Contact Information

If you have any questions or concerns or need technical support while using SiSA, please don't hesitate to contact our dedicated Value Added Reseller’s support team. We are here to assist you.

For this account, please refer to the following Value Added Reseller:

Value Added Reseller: HQE Systems, Inc.

Support Email: Support@HQESystems.com Support Phone: (800) 967-3036 Support Hours: Urgent: 24/7/365 Non-Urgent: M-F 9-5 PM PST

Feel free to contact us anytime, and our team will be happy to assist you with any queries or assistance you may need.

Please note that this user manual is a comprehensive guide for using the SiRcom SMART Alert (SiSA) Software. It includes detailed step-by-step instructions and explanatory content to ensure users can easily navigate and utilize the software's features. Images and specific function details can be added in their respective sections to provide a complete and ready-to-use user manual.