SA-Announce User Guide

262 Pages·2016·13 MB·English

SA-Announce Notification Platform
User Manual for Avaya®
Version 9.1
© 2016 Syn-Apps L.L.C.
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 15
Part 4 Information Center 17
Part 5 System Requirements 20
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........................................................................................ 21
2 AVAY.A.. .R..e..q..u..i.r..e..m...e..n..t.s.......................................................................................................... 22
Configure AV.A..Y...A.. .A...u..r..a..®... ..................................................................................................................................... 23
Setup of A.v..a..y..a.. .9..6..x..x.. .S..e..r..ie..s.. .P..h..o..n..e..s................................................................................................................. 23
Configure A...v..a..y..a.. .A...u..r.a..®... .U..t.i.li.t.y.. .S..e..r..v..e..r.............................................................................................................. 25
Configure A...v..a..y..a.. .A...u..r.a..®... .C..o..m...m..u..n..i.c..a..t.i.o..n.. .M..a..n..a..g..e..r............................................................................................ 28
Configure IP Netw...o..r.k.. .R..e..g..i.o..n....................................................................................................................... 29
Administer IP Cod..e..c.. .S..e..t.............................................................................................................................. 29
Administer IP Nod..e.. .N..a..m...e..s........................................................................................................................... 30
Administer SIP Si.g..n..a..li.n..g.. .G...r.o..u..p.................................................................................................................... 30
Administer SIP Tr.u..n..k.. .G..r..o..u..p......................................................................................................................... 31
Administer Route. .P..a..t.t.e..r.n.............................................................................................................................. 32
Administer Privat.e.. .N..u..m...b..e..r.i.n..g...................................................................................................................... 32
Administer AAR A...n..a..l.y..s..is............................................................................................................................. 33
Administer Statio.n..s...................................................................................................................................... 33
Configure A...v..a..y..a.. .A...u..r.a..®... .S..e..s..s..i.o..n.. .M..a..n..a..g..e..r....................................................................................................... 34
Add SIP Domain ......................................................................................................................................... 36
Add Location ......................................................................................................................................... 37
Add SIP Entity - C..o..m..m...u..n..i.c..a..t.io..n.. .M...a..n..a..g..e..r.................................................................................................... 38
Add Adaptation ......................................................................................................................................... 39
Add SIP Entity - S..A..-..A..n..n..o..u..n..c..e..................................................................................................................... 40
Add Entity Link - .C..o..m...m..u..n..i.c..a..t.i.o..n.. .M..a..n..a..g..e..r................................................................................................... 41
Add Entity Link - .S..A...-.A...n..n..o..u..n..c..e................................................................................................................... 41
Add Time Ranges......................................................................................................................................... 42
Add Routing Polic..y....................................................................................................................................... 43
Add Dial Patterns......................................................................................................................................... 43
Configure AV.A..Y...A.. .I.P... .O..f..f.i.c..e.. .................................................................................................................................. 45
SIP Trunk C..o..n..f.i.g..u..r.a..t.i.o..n.. .f.o..r.. .IP.. .O...f.f..ic..e.................................................................................................................. 46
Enable SIP Trunks......................................................................................................................................... 47
Administer SIP Lin..e....................................................................................................................................... 48
Administer Incom.i.n..g.. .C..a..l.l .R...o..u..t.e.................................................................................................................... 52
Administer Short .C...o..d..e................................................................................................................................. 54
Refresh Settings......................................................................................................................................... 55
Configure A...V...A..Y...A... .9..6..0..0.. .a..n..d.. .9..6..x..1.. .S..e..r.i.e..s.. .I.P.. .D..e..s..k..p..h..o..n..e..s................................................................................ 56
SA-Annou.n..c..e.. .>..>.. .In..i.t.i.a..l .A...p..p..l.ic..a..t.i.o..n.. .C..o..n..f..ig..u..r..a..t.io..n.. .f..o..r. .I.P.. .O..f..f.i.c..e......................................................................... 64
3 Netwo..r.k.. .R..e..q..u..i.r..e..m...e..n..t.s........................................................................................................ 65
Part 6 Installation Procedure 67
1 Updat.e.. .P...r.o..c..e..d..u..r.e................................................................................................................ 68
© 2016 Syn-Apps L.L.C.
3
4 SA-Announce User Guide
Part 7 Configuration Utility 70
Part 8 Post Configuration Steps 73
1 Avaya.. .E..n..d..p..o..i.n..t. .C..o..n..f.i.g..u..r.a..t.i.o..n.............................................................................................. 74
2 SIP T.r.u..n..k.. .S..e..t.u..p................................................................................................................... 75
3 IP Sp.e..a..k.e..r.. .S..e..t.u..p................................................................................................................. 76
4 Group.. .C..r.e..a..t.i.o..n..................................................................................................................... 77
Part 9 Initial Application Configuration 79
1 First T..i.m...e.. .L..o..g..i.n................................................................................................................... 79
2 Broad..c.a..s..t. .S..e..r.v..i.c..e.. .S..e..t.t.i.n..g..s.................................................................................................. 80
Avaya Aura Ad..v..a..n...c..e..d.. .S...e..t.t..i.n..g..s... .......................................................................................................................... 81
Avaya IP Office... .A..d...v..a..n..c..e..d... .S..e..t..t.i.n..g...s.. .................................................................................................................... 82
Verification.. .S..t.e..p..s............................................................................................................................................... 84
Phone Feature...s.. ..................................................................................................................................................... 85
3 Multic..a..s.t. .C..o..n..f.i.g..u..r..a..t.i.o..n........................................................................................................ 87
4 User M...a..n..a..g..e..m...e..n..t............................................................................................................... 90
Part 10 Notification Group Configuration 94
1 Notific..a..t.i.o..n.. .G...r.o..u..p.. .T..y..p..e..s..................................................................................................... 95
Emergency Al.e...r.t.. ................................................................................................................................................... 96
Holler .......................................................................................................................................................... 98
Normal .......................................................................................................................................................... 100
Record-N-Pla.y.. ....................................................................................................................................................... 101
Text .......................................................................................................................................................... 103
2 Notif.i.c..a..t.i.o..n.. .G..r..o..u..p.. .S..e..t.u..p.................................................................................................... 104
3 Ema.i.l................................................................................................................................. 106
4 IP Ph..o..n..e..s........................................................................................................................... 107
5 Desk.t.o..p.. .C...l.i.e..n..t.s.................................................................................................................. 109
6 Clou.d.. .S..e..r..v.i.c..e..s................................................................................................................... 111
7 Exte.r.n..a..l............................................................................................................................. 112
8 IP Sp..e..a..k..e..r.s........................................................................................................................ 113
9 Syn-.A..p..p..s.. .P..a..g..i.n..g.. .R..e..l.a..y...................................................................................................... 115
10 Stati.c.. .S..t.r.e..a..m...s.................................................................................................................... 118
11 Valc.o..m................................................................................................................................ 119
12 Beac..o..n..s............................................................................................................................. 120
13 Mass.. .N..o..t.i.f.i.c..a..t.i.o..n................................................................................................................ 121
Part 11 Creating Emergency Alert Groups 123
Part 12 SA-Announce Scheduler 127
1 Crea.t.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.................................................................. 129
2 Editi.n..g.. .A.. .S..c..h..e..d..u..l.e............................................................................................................. 135
Editing Asso.c..i.a..t.e...d.. .S..c..h...e..d..u...l.e..d.. .E..v..e...n..t.s... ............................................................................................................ 135
© 2016 Syn-Apps L.L.C.
Contents 5
3 Audi.o.. .U..p..l.o..a..d...................................................................................................................... 137
Audio File De..s..c..r..i.p..t.i.o...n..s.. ...................................................................................................................................... 139
Part 13 Sending A Text Message 142
1 Mess..a..g..e.. .B..r.o..w...s.e..r............................................................................................................... 144
Part 14 SA-Announce Reporting 146
1 Notif.i.c..a..t.i.o..n.. .G..r..o..u..p.. .R..e..p..o..r.t.................................................................................................. 147
2 Notif.i.c..a..t.i.o..n.. .A..c..t.i.v..i.t.y. .R...e..p..o..r.t................................................................................................ 149
3 Sche..d..u..l.e..s. .A...c.t.i.v..i.t.y.. .R..e..p..o..r.t.................................................................................................. 150
4 Text. .A..c..t.i.v..i.t.y. .R...e..p..o..r.t........................................................................................................... 151
5 Logi.n.. .A..c..t.i.v..i.t.y. .R...e..p..o..r.t......................................................................................................... 152
6 User.s. .R...e..p..o..r.t...................................................................................................................... 153
Part 15 Syn-Apps Analytics 155
Part 16 Web Service (API) 159
Part 17 Email Settings 164
Part 18 AMBER Alert Settings 166
Part 19 Weather Alert Settings 170
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........................................................................................ 173
Part 20 Syn-Apps Paging Relay Configuration 177
Part 21 Syn-Apps Desktop Notification Client
Configuration 180
Part 22 Syn-Apps IP Speaker Configuration 183
1 Syn-.A..p..p..s.. .I.P.. .S..p..e..a..k..e..r. .S..e..t.u..p................................................................................................ 185
Part 23 Algo IP Speaker Configuration 189
1 Algo. .I.P.. .S...p..e..a..k.e..r.. .C..o..n..f.i.g..u..r.a..t.i.o..n........................................................................................... 189
Algo IP Spea.k..e..r.. .S..e...t.u..p... ....................................................................................................................................... 191
2 Lega..c..y. .A...l.g..o.. .S..p..e..a..k..e..r. .C..o..n..f.i.g..u..r.a..t.i.o..n................................................................................... 193
Legacy Algo .S...p..e..a..k...e..r.. .S..e..t..u..p.. .............................................................................................................................. 195
Part 24 AND IP Speaker Configuration 197
1 AND. .I.P.. .S..p..e..a..k..e..r. .S..e..t.u..p........................................................................................................ 201
Part 25 Atlas IP Speaker Configuration 204
1 Atlas.. .I.P.. .S..p..e..a..k..e..r. .S..e..t.u..p....................................................................................................... 206
Part 26 CyberData IP Speaker Configuration 209
© 2016 Syn-Apps L.L.C.
5
6 SA-Announce User Guide
1 Cybe..r.D..a..t.a.. .S...p..e..a..k.e..r.. .S..e..t.u..p.................................................................................................. 210
Part 27 Valcom IP Speaker Configuration 213
1 Valc.o..m... .I.P.. .S..p..e..a..k..e..r. .S...e..t.u..p.................................................................................................. 214
Part 28 Alertus Configuration 218
1 Alert.u..s.. .D..e..v..i.c..e.. .S..e..t.u..p.......................................................................................................... 220
Part 29 Everbridge Configuration 222
1 Ever.b..r.i.d..g..e.. .S..e..t.u..p................................................................................................................ 223
Part 30 Twitter Configuration 226
Part 31 Analog Paging System Integration 228
Part 32 Advanced Paging Configuration 230
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......................................................... 230
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...................................................................... 231
Part 33 Troubleshooting Guide 233
1 Insta.l.l.a..t.i.o..n.. ./. .C...o..n..f.i.g..u..r.a..t.i.o..n................................................................................................. 234
Windows Env.. .I.s...s..u..e...s.. .......................................................................................................................................... 235
Installation Is..s...u..e..s... .............................................................................................................................................. 236
Licensing Iss...u..e..s... ................................................................................................................................................ 236
Configuratio.n.. .I.s..s...u..e..s... ......................................................................................................................................... 237
Upgrade Pro.c..e..d..u...r.e... .T..r..o..u..b...l.e..s..h...o..o..t..i.n..g.. ............................................................................................................. 239
Reconfigu..r.e.. .S...Q..L.. .S...e..r.v..e..r................................................................................................................................. 243
2 Web. .I.n..t.e..r.f.a..c..e.. .(.G...U..I.)........................................................................................................... 246
GUI Log File .......................................................................................................................................................... 247
Group Creati.o...n.. .................................................................................................................................................... 247
Text Messag..e.. ...................................................................................................................................................... 248
Other .......................................................................................................................................................... 248
3 Broa.d..c..a..s..t.e..r. .S..e..r.v..i.c..e........................................................................................................... 249
Service Start. .I.s...s..u..e...s.. ........................................................................................................................................... 249
Endpoint Com....m...a..n...d.. .I.s..s...u..e..s... .............................................................................................................................. 250
Audio Issues.. ........................................................................................................................................................ 251
4 Sche..d..u..l.e..r. .S..e..r..v.i.c..e.............................................................................................................. 252
Part 34 Help and Support 254
© 2016 Syn-Apps L.L.C.
SA-Announce
Overview
Part
1
8 SA-Announce User Guide
1 SA-Announce Overview
SA-Announce Notification System for Avaya
The SA-Announce Notification System is a feature-rich notification system that couples with Avaya Aura®
Communication Manager and Avaya IP Office to provide 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 Avaya 9600 Series IP phones, Syn-Apps Paging Relay, Cloud Services, PC desktops, Syn-Apps IP
speakers, Algo IP speakers, Atlas IP speakers, AND IP speakers, CyberData IP speakers, Valcom IP speakers,
Email alerts, Everbridge, and Alertus 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 Platform 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 server sourced multicast, Paging Relay assisted multicast, and phone sourced multicast.
Recent feature additions for SA-Announce include:
Version/Feature Description
SA-Announce 9.1
IPAWS Syn-Apps' Cloud Services module, CAP Activator, now supports IPAWS,
FEMA's Integrated Public Alert and Warning System. See the CAP Activator
Admin Guide for more information.
Windows Servers Windows 2016 is now supported. See the Knowledge Base article 2016 Server
Hardware and Software Configuration Requirements.
Windows 2003 is no longer supported
Scheduler Copy Feature When you copy a schedule, you can choose to copy just the events, the
endpoints, or both.
Intercom/Holler Calls now automatically end the call at the receiving phone when the Intercom/
Holler call is ended at the initiating phone.
SIP External Dialers SA-Announce now supports external dialers. See the Analog Paging System
Integration topic for details.
Bug Fixes & Software General software maintenance and bug fixes made to SA-Announce.
Maintenance
SA-Announce 9.0.18
CAP Notifier CAP Notifier is our newest Cloud Services notifier. This notifier is based on the
Common Alert Protocol v1.2 specification. It allows your organization to create
your own CAP service so outside entities can consume notifications you
generate. See the CAP Notifier Admin Guide for more details.
CAP Activator CAP Activator allows you to monitor CAP alerts from external entities and pass
those alerts on to your endpoints when they meet the alert criteria you've
defined. The CAP Activator is based on the Common Alert Protocol v1.2
specification. See the CAP Activator Admin Guide for more details.
Backup and Restore The Backup and Restore utility is once again working properly. The Backup and
Restore Utility for SA-Announce Knowledge Base article provides instructions.
This utility is included in the SA-Announce upgrade.
Holler Group Types Holler/Holler-RP group types to talk-back enabled IP Speakers are supported.
We do not support Holler to phones (IP nor analog). Holler is an intercom
© 2016 Syn-Apps L.L.C.
SA-Announce Overview 9
Version/Feature Description
notification group type (Holler, Holler-RP, Insta-Holler). See the Holler topic for
details.
Text Messages All text messages are now sent in HTML format. Only one message is sent to a
device regardless of the number of lines attached to the device.
Bug Fixes & Software Scheduler issues have been resolved, as well as general software maintenance,
Maintenance bug fixes, and performance enhancements made to SA-Announce.
SA-Announce 9.0.17
Bug Fixes & Software General software maintenance, bug fixes, and performance enhancements
Maintenance made to SA-Announce.
Facebook Integration Discontinued support for Facebook integration.
Regroup Support Regroup notifier is now supported by SA-Announce.
Updated Service Provider SA-Announce now receives AMBER Alerts from the DOJ (Department of
for AMBER Alerts Justice).
SA-Announce 9.0.16
Bug Fixes & Software General software maintenance, bug fixes, and performance enhancements
Maintenance made to SA-Announce.
SA-Announce 9.0.15
Bug Fixes & Software General software maintenance, bug fixes, and performance enhancements
Maintenance made to SA-Announce.
SA-Announce 9.0.14
New User Interface Updated UI with a fresh color scheme and improved navigation.
SA-Announce Scheduler SA-Announce Scheduler has been redesigned to use a new graphical 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 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 speaker integration. 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.
© 2016 Syn-Apps L.L.C.
10 SA-Announce User Guide
Version/Feature Description
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.13
Weather Alerts Weather Alerts have been updated to use the new 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 Options Text messages now allow configuration of the text color, scroll speed and
number of loops for AND IP speakers.
Schedule Time Zone Schedules now have an associated time zone for large deployments.
SA-Announce 8.0.0
AND IP Speaker Support SA-Announce now supports AND IP speakers.
Desktop Notification Client SA-Announce now supports the Syn-Apps Desktop Notification Client allowing
users of SA-Announce to target PC desktops with live and stored audio
messages as well as text messages, 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 to be sorted. All entries in 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.
© 2016 Syn-Apps L.L.C.