SA-Announce for SIP PBX Systems User Guide

219 Pages·2015·10.36 MB·English

SA-Announce Notification Platform
User Manual for SIP PBX Systems
Version 9.0.17
©2015 Syn-Apps LLC
About Syn-Apps
Syn-Apps L.L.C. was founded in 2001 as a consulting firm focused
on developing software for IP telephony platforms. Since that time,
Syn-Apps has evolved as a market leader in enterprise-wide paging
and notification solutions designed to improve business processes,
increase safety, and streamline internal and external
communication. Since 2001, over 2,000 organizations have
integrated our notification software with phones, paging systems, IP
speakers, and hundreds of other internal systems and services.
Syn-Apps has an extensive knowledge base in numerous
development technologies. In addition, Syn-Apps has a strong
background in network design and networking fundamentals. We
believe this combination of experience in a broad range of
technologies allows us to offer our customers an end-to-end
application development solution.
We believe that in order to have a successful application
deployment, one should not only understand the development
environment, but also understand how the application will interact
with the rest of network. Syn-Apps has extensive networking
experience based on a number of network development and design
projects for many Fortune 100 companies. We believe that this
enables us to become a valuable asset to any development team.
Syn-Apps developers have a wide variety of development
experience in many diverse industries. Our developers have been
employed by, or consulted for companies such as Oracle, Microsoft,
Cisco, General Motors, General Dynamics, Bloomberg, and many
others. All of our developers have a keen understanding of the
software development life cycle and know how to develop successful
applications.
At Syn-Apps we understand the importance of a team environment
and are comfortable developing and sharing information to ensure
that the best of breed product is produced.
Contents 3
Table of Contents
Part 1 SA-Announce Overview 8
Part 2 Application Features 12
Part 3 Manual Conventions 16
Part 4 Information Center 18
Part 5 System Requirements 21
1 Applic..a..t.i.o..n.. .S..e..r..v.e..r.. .R..e..q..u..i.r.e..m...e..n..t.s........................................................................................ 22
Windows 2003.. .S..e...r.v..e...r. ........................................................................................................................................... 23
Windows 2008.. .S..e...r.v..e...r. ........................................................................................................................................... 24
Disabling U.A...C..................................................................................................................................................... 25
Disabling P.u..b..l.ic.. .F..i.r.e..w....a..ll.................................................................................................................................... 25
Disabling IE.. .E..n..h..a..n..c..e..d.. .S..e..c..u..r.i.t.y.......................................................................................................................... 25
Verifying II.S.. .I.n..s..t.a..ll.a..t.i.o..n...................................................................................................................................... 26
Installing A.S..P....N...E..T.............................................................................................................................................. 26
Windows 2012.. .S..e...r.v..e...r. ........................................................................................................................................... 28
2 Netwo..r.k.. .R..e..q..u..i.r..e..m...e..n..t.s........................................................................................................ 29
Firewall Ports. ......................................................................................................................................................... 29
Multicast Req.u..i.r..e..m....e..n..t..s.. ...................................................................................................................................... 29
Part 6 Installation Procedure 31
1 Upgra..d..i.n..g.. .S..A..-.A..n..n..o..u..n..c..e...................................................................................................... 32
Part 7 Configuration Utility 35
Part 8 Post Installation Instructions 38
1 SIP T.r.u..n..k.. .S..e..t.u..p................................................................................................................... 39
2 ATA S..e..t.u..p............................................................................................................................ 41
3 IP Sp.e..a..k.e..r.. .S..e..t.u..p................................................................................................................. 43
4 Group.. .C..r.e..a..t.i.o..n..................................................................................................................... 44
Part 9 Initial Application Configuration 46
1 First T..i.m...e.. .L..o..g..i.n................................................................................................................... 46
2 Broad..c.a..s..t. .S..e..r.v..i.c..e.. .S..e..t.t.i.n..g..s.................................................................................................. 47
Advanced Set.t.i.n...g..s.. ................................................................................................................................................ 48
3 Multic..a..s.t. .C..o..n..f.i.g..u..r..a..t.i.o..n........................................................................................................ 49
4 User M...a..n..a..g..e..m...e..n..t............................................................................................................... 52
Part 10 Notification Group Configuration 56
1 Notific..a..t.i.o..n.. .G...r.o..u..p.. .S..e..t.u..p...................................................................................................... 57
2 Email................................................................................................................................... 60
©2015 Syn-Apps LLC
3
4 SA-Announce for SIP PBX Systems User Guide
3 Deskt.o..p.. .C..l.i.e..n..t.s.................................................................................................................... 61
4 Cloud. .S...e..r.v..i.c.e..s..................................................................................................................... 62
5 Extern..a..l............................................................................................................................... 64
6 IP Sp.e..a..k.e..r..s......................................................................................................................... 65
7 Syn-A.p..p..s.. .P..a..g..i.n..g.. .R..e..l.a..y..s...................................................................................................... 67
8 Static. .S..t.r..e..a..m...s..................................................................................................................... 69
9 Beaco..n..s............................................................................................................................... 70
10 Valco.m.................................................................................................................................. 71
11 Mass .N..o..t.i.f.i.c..a..i.t.o..n.................................................................................................................. 72
Part 11 Creating Emergency Alert Groups 74
Part 12 SA-Announce Scheduler 78
1 Creat.i.n..g.. .S..c..h..e..d..u..l.e..s. .U..s..i.n..g.. .t.h..e.. .S..c..h..e..d..u..l.e..r. .T..o..o..l.................................................................... 80
2 Editin.g.. .a.. .S..c..h..e..d..u..l.e............................................................................................................... 86
Editing Assoc.i.a..t.e...d.. .S..c..h...e..d..u...l.e..d.. .E..v..e...n..t.s... .............................................................................................................. 87
3 Audio. .U...p..l.o..a..d....................................................................................................................... 88
Customizing A...u..d...i.o.. .F..e..e...d..b..a..c..k... ............................................................................................................................ 90
Audio File D...e..s..c..r.i.p..t.io..n..s....................................................................................................................................... 91
Part 13 Sending A Text Message 94
Part 14 SA-Announce Reporting 97
1 Notific..a..t.i.o..n.. .G...r.o..u..p.. .R..e..p..o..r.t.................................................................................................... 98
2 Notif.i.c..a..t.i.o..n.. .A..c..t.i.v..i.t.y. .R...e..p..o..r.t................................................................................................ 100
3 Sche..d..u..l.e..s. .A...c.t.i.v..i.t.y.. .R..e..p..o..r.t.................................................................................................. 101
4 Text. .A..c..t.i.v..i.t.y. .R...e..p..o..r.t........................................................................................................... 102
5 Logi.n.. .A..c..t.i.v..i.t.y. .R...e..p..o..r.t......................................................................................................... 103
6 User.s. .R...e..p..o..r.t...................................................................................................................... 104
Part 15 Syn-Apps Analytics 106
Part 16 Web Service (API) 110
Part 17 Email Settings 114
Part 18 AMBER Alert Settings 116
Part 19 Weather Alert Settings 120
1 Wea.t.h..e..r. .A...l.e..r.t. .S..u..p..p..o..r.t.e..d.. .E..v..e..n..t.s........................................................................................ 123
Part 20 Syn-Apps Paging Relay Configuration 127
1 Supp..o..r.t.e..d.. .P...a..g..i.n..g.. .R..e..l.a..y..s.................................................................................................. 129
2 Syn-.A..p..p..s.. .P..a..g..i.n..g.. .R..e..l.a..y.. .S..e..t.u..p............................................................................................ 129
©2015 Syn-Apps LLC
Contents 5
3 Enab..l.e.. .F..e..a..t.u..r.e..s.. .U..s.i.n..g.. .t.h..e.. .S...y.n..-.A...p..p..s. .P..a..g..i.n..g.. .R...e..l.a..y........................................................... 132
Activating Em...e..r..g..e..n...c..y.. .A..l.e...r.t.. .G..r..o..u...p..s.. ................................................................................................................ 132
Single Zone .S..p..e...a..k..e..r.. .C...o..n..f..i.g..u..r..a..t.i.o...n.. ................................................................................................................ 134
600 ohm Out.p..u..t.. ................................................................................................................................................... 135
RCA Line-Ou.t. .I.n...t.e..g...r.a..t..i.o..n.. ................................................................................................................................... 136
Contact Clos.u...r.e...s.. ................................................................................................................................................ 137
Part 21 Syn-Apps Desktop Notification Client
Configuration 140
1 Supp..o..r.t.e..d.. .D...e..s.k..t.o..p.. .N..o..t.i.f.i.c..a..t.i.o..n.. .C..l.i.e..n..t.s.............................................................................. 141
2 Syn-.A..p..p..s.. .D..e..s.k..t.o..p.. .N..o..t.i.f.i.c..a..t.i.o..n.. .C..l.i.e..n..t. .S...e..t.u..p....................................................................... 141
Windows Re.q..u..i.r..e..m....e..n...t.s.. .................................................................................................................................... 141
Macintosh Re...q..u..i.r..e..m....e..n...t.s.. .................................................................................................................................. 141
DNC Configu.r.a..t..i.o..n.. ............................................................................................................................................... 142
Automatic.. .C..o..n..f.i.g..u..r.a..t.i.o..n................................................................................................................................... 142
Manual Co..n..f..ig..u..r..a..t.io..n........................................................................................................................................ 145
Part 22 Syn-Apps IP Speaker Configuration 147
1 Supp..o..r.t.e..d.. .S...y.n..-.A...p..p..s. .I.P.. .S...p..e..a..k.e..r..s...................................................................................... 149
2 Syn-.A..p..p..s.. .I.P.. .S..p..e..a..k..e..r. .S..e..t.u..p................................................................................................ 149
Part 23 Legacy Algo Speaker Configuration 153
1 Lega..c..y. .A...l.g..o.. .S..p..e..a..k..e..r. .S..e..t.u..p............................................................................................... 155
Part 24 AND IP Speaker Configuration 157
1 Supp..o..r.t.e..d.. .A...N..D.. .I.P.. .S...p..e..a..k.e..r..s.............................................................................................. 159
2 AND. .I.P.. .S..p..e..a..k..e..r. .S..e..t.u..p........................................................................................................ 159
Part 25 Atlas IP Speaker Configuration 162
1 Supp..o..r.t.e..d.. .A...t.l.a..s. .I.P.. .S...p..e..a..k.e..r..s............................................................................................. 164
2 Atlas.. .I.P.. .S..p..e..a..k..e..r. .S..e..t.u..p....................................................................................................... 164
Part 26 CyberData IP Speaker Configuration 167
1 Supp..o..r.t.e..d.. .C...y.b..e..r..D..a..t.a.. .S..p..e..a..k..e..r.s......................................................................................... 168
2 Cybe..r.D..a..t.a.. .S...p..e..a..k.e..r.. .S..e..t.u..p.................................................................................................. 168
Part 27 Valcom IP Speaker Configuration 171
1 Supp..o..r.t.e..d.. .V...a..l.c.o..m... .S...p..e..a..k.e..r..s............................................................................................. 172
2 Valc.o..m... .I.P.. .S..p..e..a..k..e..r. .S...e..t.u..p.................................................................................................. 173
Part 28 Alertus Configuration 176
1 Supp..o..r.t.e..d.. .A...l.e..r.t.u..s. .D...e..v.i.c..e..s................................................................................................. 178
2 Alert.u..s.. .D..e..v..i.c..e.. .S..e..t.u..p.......................................................................................................... 178
Part 29 Everbridge Configuration 180
1 Ever.b..r.i.d..g..e.. .S..e..t.u..p................................................................................................................ 181
©2015 Syn-Apps LLC
5
6 SA-Announce for SIP PBX Systems User Guide
Part 30 Twitter Configuration 184
Part 31 Analog Paging System Integration 186
1 Supp..o..r.t.e..d.. .A...n..a..l.o..g.. .S..y..s.t.e..m...s................................................................................................ 187
2 Supp..o..r.t.e..d.. .A...n..a..l.o..g.. .I.n..t.e..r.f.a..c..e..s............................................................................................. 187
Part 32 Advanced Paging Configuration 189
1 SA-A..n..n..o..u..n..c.e.. .M...u..l.t.i.c..a..s.t. .R...o..u..t.e..r./.S..w...i.t.c..h.. .C..o..n..f.i.g..u..r.a..t.i.o..n......................................................... 189
2 Mult.i.-.S..i.t.e.. .C..e..n..t.r.a..l.i.z..e..d.. .S..A...-.A..n..n..o..u..n..c..e.. .S..e..r.v..e..r...................................................................... 190
Part 33 Troubleshooting Guide 192
1 Insta.l.l.a..t.i.o..n.. ./. .C...o..n..f.i.g..u..r.a..t.i.o..n................................................................................................. 193
Windows Env.. .I.s...s..u..e...s.. .......................................................................................................................................... 193
Installation Is..s...u..e..s... .............................................................................................................................................. 194
Licensing Iss...u..e..s... ................................................................................................................................................ 195
Configuratio.n.. .I.s..s...u..e..s... ......................................................................................................................................... 196
Upgrade Pro.c..e..d..u...r.e... .T..r..o..u..b...l.e..s..h...o..o..t..i.n..g.. ............................................................................................................. 198
Reconfigu..r.e.. .S...Q..L.. .S...e..r.v..e..r................................................................................................................................. 202
2 Web. .I.n..t.e..r.f.a..c..e.. .(.G...U..I.)........................................................................................................... 204
GUI Log File .......................................................................................................................................................... 205
Group Creati.o...n.. .................................................................................................................................................... 206
Text Messag..e.. ...................................................................................................................................................... 207
Other .......................................................................................................................................................... 208
3 Broa.d..c..a..s..t.e..r. .S..e..r.v..i.c..e........................................................................................................... 209
Service Start. .I.s...s..u..e...s.. ........................................................................................................................................... 210
Endpoint Com....m...a..n...d.. .I.s..s...u..e..s... .............................................................................................................................. 211
Audio Issues.. ........................................................................................................................................................ 212
4 Sche..d..u..l.e..r. .S..e..r..v.i.c..e.............................................................................................................. 213
5 Phon..e.. .S..e..r..v.i.c..e..s.................................................................................................................. 214
API .......................................................................................................................................................... 214
Part 34 Help and Support 216
1 Docu..m...e..n..t.a..t.i.o..n................................................................................................................... 216
2 Know...l.e..d..g..e.. .B..a..s..e................................................................................................................ 217
3 Prep.a..r..e.. .R..e..p..o..r.t.................................................................................................................. 218
©2015 Syn-Apps LLC
SA-Announce
Overview
Part
1
8 SA-Announce for SIP PBX Systems User Guide
1 SA-Announce Overview
SA-Announce Notification System for SIP PBX Systems
The SA-Announce Notification System is a feature-rich notification system that provides text and audio
notifications across an enterprise. The notifications can be in real time, such as emergency alerts and live audio
notifications, or they can be scheduled via the scheduling system. SA-Announce integrates the phone system
with a large number of disparate endpoints such as the Syn-Apps Paging Relay, Syn-Apps IP speakers, Cloud
Services, Syn-Apps Desktop Client, Grandstream ATA's, Legacy Analog Overhead Systems, AND IP speakers,
Atlas IP speakers, CyberData IP speakers Valcom IP speakers, Email, Alertus and Everbridge devices.
Notifications can be made by picking up the phone and dialing the notification group directory number (as well as
other methods such as automated via a relay or web). The SA-Announce Notification System has numerous
audio streaming models that can be used to accommodate almost any notification requirements from one
centralized server. Non-multicast enabled wide-area networks (WAN) can provide notifications to all remote sites
using one centralized SA-Announce server with the addition of the Syn-Apps Paging Relay appliance. Streaming
models include unicast, server sourced multicast, Paging Relay assisted multicast, and phone sourced
multicast.
Recent feature additions for SA-Announce include:
Version / Feature Description
SA-Announce 9.0.17
Bug Fixes & Software General software maintenance, bug fixes, and performance enhancements made to
Maintenance SA-Announce.
Updated Service SA-Announce now receives AMBER Alerts from the DOJ (Department of Justice).
Provider for AMBER
Alerts
Regroup Notifier Regroup notifier is now supported by SA-Announce.
Facebook Integration Discontinued support for Facebook integration.
SA-Announce 9.0.16
Bug Fixes & Software General software maintenance, bug fixes, and performance enhancements made to
Maintenance SA-Announce.
SA-Announce 9.0.15
Bug Fixes & Software General software maintenance, bug fixes, and performance enhancements made to
Maintenance SA-Announce.
SA-Announce 9.0.14
New User Interface Updated UI with a fresh color scheme and improved navigation.
SA-Announce SA-Announce Scheduler has been redesigned to use a new graphical scheduler
Scheduler tool that allows for easy scheduled event creation, including recurring events.
New Calendar-Based Event Scheduler - Easily create and manage
customizable events. All events per schedule are now visible in one centralized
location, providing users with a simplified management experience. Users have
the option to view events by day, week, or month
Recurring Events - Schedule event frequencies and duration
Customized Labels - Color-code specific scheduled events for better
organization
Note: The Overrides tab is no longer available, (formerly found by navigating to:
Schedules >> Scheduled Broadcasts >> Overrides), as the graphical scheduler
©2015 Syn-Apps LLC
SA-Announce Overview 9
tool can be easily manipulated to create schedule overrides. The SA-Announce
Configuration Utility will update any existing schedules, including their overrides, to
the new format required by the graphical scheduler tool.
Algo Speakers Now supports legacy Algo speakers. Refer to Legacy Algo Speaker Configuration
for details. Algo IP Speaker support coming soon!
Paging Relay GPIO Paging Relays can now be configured to activate their GPO (general purpose
Emergency Alert output) Contact Closure for a specified time on a per-group basis.
Activation
SA-Announce 9.0.13
Paging Relay Syn-Apps' Paging Relay can now be used to activate SA-Announce Emergency
Alert groups using Paging Relay GPIO.
SA-Announce 9.0.12
Reporting Built-in reports gather and export detailed information regarding notification group
configuration data and system user permissions.
Syn-Apps Analytics Provides a holistic view of all notification activity including both on and off-premise
services. Generates complete activity reports including: Group name, Activation
date/time, Initiator, Associate Endpoints, etc.
SA-Announce 9.0.11
Windows 2012 Server Syn-Apps SA-Announce now supports Windows 2012 server.
SA-Announce 9.0.10
Cloud Services Syn-Apps Cloud Services is now in beta and can be used to send notifications to
mobile devices, internet messengers, SMS and Cisco Digital Media signage.
Contact [email protected] for further details.
Active Directory System users can now be authenticated against an Active Directory.
Integration
SA-Announce 8.3.14
Server Redundancy Join multiple SA-Announce servers into a cluster to facilitate automated failover.
SA-Announce 8.3.13
Weather Alerts Weather Alerts have been updated to use the NWS CAP feed. Short duration
events such as Tornado Warnings can now be monitored. Additional events such
as Civil Warnings and 911 Telephone Outage are also available.
SA-Announce 8.2.0
Group Opening Tone Assign custom audio files to serve as the notification group opening tone.
AND Speaker Text Text messages now allow configuration of the text color, scroll speed and number
Opti of loops for AND IP speakers.
ons
Schedule Time Zone Schedules now have an associated time zone for large deployments.
SA-Announce 8.0.0
AND IP Speaker SA-Announce now supports AND IP Speakers.
Support
Desktop Notification SA-Announce now supports the Syn-Apps Desktop Notification Client allowing
Client users to target PC desktops with live and stored audio messages, text messages,
polls, AMBER alerts and weather alerts.
The SA-Announce Notification System has been created using ASP.NET 3.5 to provide a rich user interface.
Menus and lists that contain multiple items are searchable, highlight the menu or list in question and begin to
type, the selection indicator will select the first matching item in the list.
Tables and grids are sortable by clicking on the column header or the column you wish to sort on. All entries in
©2015 Syn-Apps LLC
10 SA-Announce for SIP PBX Systems User Guide
the GUI are validated on the client side to prevent typographical errors. Tables and grids that can contain
thousands of entries use a client side caching model that will allow for good performance without overloading the
client or server system.
©2015 Syn-Apps LLC