3CX 911 Notifier User Guide

1.Introduction #

Whether you are a small school, or a large campus of buildings, you need to know immediately who dialed 911. With 3CX 911 Notifier, your emergency responders will know exactly where to go.

1.1. What is 3CX 911 Notifier?

With 3CX 911 Notifier, you will have complete control over 911 notifications. You can control the content of notifications, who is notified, and how they are notified (email, SMS, and phone call). Show emergency responders exactly where the problem is located. This is a “MUST HAVE” solution for educational facilities and businesses with multiple buildings.

1.2. Why 3CX 911 Notifier?

The important features of 3CX 911 Notifier include the following:

1. Know immediately who dialed 911

2. Call, email or text to any phone number or email address you added

3. Notify critical staff immediately when 911 has been dialed. Notifications include:

a. Who called (extension, mobile number, first and last name)

b. Where (address, floor, pillar, cubicle)

4. Notifications are easily customizable

5. Know exactly where the emergency exists and who made the phone call to 911

6. View the logs of all events to know how and who was notified and update notes accordingly for future reference

1.3. How to Use 3CX 911 Notifier?

3CX 911 Notifier is a onetime installation process. Once you install it, the product allows you to gain complete control over 911 notifications using a simple web portal.

2.Prerequisites #

Before you begin with the installation steps mentioned in this guide, you need to ensure that your computer meets the minimum requirements mentioned below for installing 3CX 911 Notifier.

1. 3CX Version 12 to 15.5 or above (Professional or Enterprise Version Only)

2. Windows 7, 8, Windows Server 2008 R2 and above

3. Microsoft SQL Server 2008 Express and above

4. Internet Information Server (IIS) 7.0 and above

5. .Net 4.6 or above

  • Since the add-on ‘3CX 911 Notifier’ includes a CFD application, you will need to install either Pro or Enterprise version of 3CX
  • Windows 8 has a much better Text-To-Speech engine compared to Windows 7
  • When installing SQL Server, we recommend you install it in “Mixed Mode” to include SQL Authentication, and install SQL Management Studio
  • When installing IIS, be sure to install Basic Authentication, .Net Extensibility, and ASP.Net 4.X

3.Installation #


Download software

You can order 3CX 911 Notifier on-line at http://www.voiptools.com.  Your order confirmation email will include your license key and a link to download the software.

 


Install Prerequisites

There are a number of prerequisites that must be installed prior to installing 3CX 911 Notifier. These prerequisites include Microsoft Internet Information Server (IIS) and Microsoft SQL Server


Install 3CX 911 Notifier

This User Guide contains step-by-step instructions to successfully install 3CX 911 Notifier.  Begin by extracting the installer from the downloaded zip file (Step 1 above), then run the setup program named NineOneOneNotifierInstaller.exe


Register your License Key

You must register your license key to activate 3CX 911 Notifier. Your license key is included in your order confirmation email, and can also be found in your order history on our website.


Configure General, Email and Voice Settings

To control the access and storage of 911 notifications, you need to configure certain settings by logging into 911 Notifier Web Portal.

3.1. Step by step Installation Procedure #

The following section guides you through a detailed walk-through of the installation process.

Step 1:  Download 3CX 911 Notifier

You can check for the software download link included in your order confirmation email. As an alternative, you can also find the link from your order history on our website.

Step 2:  Extract the installer from the downloaded .zip file
The file you downloaded in the above step is a compressed .zip file.

1. Position the mouse on the zip file and right-click.

2. From the popup menu, select Extract All to extract the software

Step 3: Start the installation process

1. From the extracted folder, find the file NineOneOneNotifierInstaller.exe

2. Double-click the file to start the VoIPTools Setup Wizard.

3. Click Next to continue.


Figure 1: Setup Wizard

Special note for Multi-tenant installations:

1. If you are installing 3CX 911 Notifier on a 3CX Cloud (Multi-tenant) server, an additional screen will display with a combo box containing a list of all installed tenants. Select the correct tenant and continue.

2. If you are installing 3CX 911 Notifier on a separate server and pointing it to a 3CX Cloud server, you will need to tell the installer the name of the specific tenant desired. Start the installer from a command window and include an additional parameter: tenantname=<your-tenant-name>. Passing the tenant name to the installer will pre-fill the combo box with the correct tenant name. For example:3CXNineOneOneNotifier.exe tenantname=the3CXtenantname

Step 4: Download the VoIPTools 3CX Relay (if required)

3CX permits one 3rd party application to communicate with the 3CX server at a time.  To overcome this limitation, VoIPTools created the 3CX Relay Service.  The Relay is a lightweight application that is installed directly on the 3CX server.  The Relay exposes the 3CX Call Control API (and other VoIPTools services) to all our applications, and manages requests and events between VoIPTools products and 3CX.  The Relay also makes it possible to install our VoIPTools products on a remote server (including over the internet).

1. If you have not previously installed the Relay on your 3CX Server, you can download the Relay installer by clicking on the Download Relay button. The Relay must be installed directly on the 3CX server.

2. If you are installing 3CX 911 Notifier directly on the 3CX server, you can install the Relay simply by clicking the Install/ Upgrade Relay button and following the Relay install instructions.

If you have already installed the Relay, you need not install it again unless a newer version is required.

Step 5: Test Relay Settings

1. In the Relay Services Host field, enter “localhost” if installing 3CX 911 Notifier on the 3CX server. If 3CX resides on a different server, enter the IP address or FQDN of the 3CX server.

2. In the Relay Services Port field, enter the value as 8700


The default port number is 8700 but will likely be different in multi-tenant environment

3. Click Test Relay Settings to confirm 3CX 911 Notifier can communicate with the Relay services running on the 3CX server.


Figure 2: Test VoIPTools 3CX Relay settings

4. Click Next to continue the installation.

Step 6: Configure the database
If this is your first install then, select a valid SQL server and if you are reinstalling then select the existing database.

1. When prompted for the database connection information, click Configure.


Figure 3: Configure Database

2. In the Connection Properties dialog box, enter the SQL server name. If using the free SQL Express edition, the default SQL Instance name is <your-server-name>\SQLExpress.

    • If you want to use ‘SQL Authentication’, then install SQL Server in ‘Mixed‘ mode.

 

  • If SQL Server is installed on a server other than the server where 3CX 911 Notifier is installed, you will need to configure SQL Server to allow remote connections


Figure 4: Connection Properties

3. Enter the login credentials.

a. If using Windows integrated security, select Use Windows Authentication. The VoIPTools installer will create a local windows user name as “VoIPToys” and will give sufficient rights to this user to create / update the SQL database.


Figure 5: Windows Authentication

b. If SQL Server authentication is desired, select Use SQL Server Authentication. Be sure to select a SQL Login that has sufficient permissions to alter the database and create SQL objects. Enter the User name and Password, and select appropriate database value from the Select or enter a database name drop down.


Figure 6: SQL Server Authentication

The first time you install 3CX 911 Notifier, DO NOT enter a database name. Choose Select or enter a database name and leave the database name blank. The installer will create the SQL database automatically and apply the necessary permissions. If upgrading 3CX 911 Notifier from a previous version, select the existing database from the list.

4. Click Test Connection button to confirm you can connect to SQL

5. Click OK to close the test results dialog

6. Click Next to continue the installation


Figure 7: Configure Database

Step 7: Run the Application

Once the installation is complete, click Run Application


Figure 8: Run Application

Step 8: 3CX 911 Notifier Setup

If you wish to run 3CX 911 Notifier as a user other than the default local VoIPToys user, you can specify the desired user in the 3CX 911 Notifier Setup screen. For example, you may need to change the user to a domain account if you are using SQL integrated security and a remote SQL server. Applying this change will perform several tasks.

Tasks:

1. Change the 3CX 911 Notifier IIS Application Pool login user

2. Recycle the IIS Appication Pool and Website

3. Change the 3CX 911 Notifier Windows Service login user

4. Grant the user “Login as a service right”

5. Restart the 3CX 911 Notifier Windows service

Figure 9: 3CX 911 Notifier Setup

  • Windows tab

1. In the 3CX 911 Notifier Setup screen, click Windows tab

2. In the Hub URL field, enter the Hub URL (in most cases, the default value should work)

3. In the Domain Name field, enter Windows Domain Name

4. In the User Name field, enter Network (domain) User Name

5. In the Password field enter password

6. Click Apply

  • Services tab

1. In the Services tab, click Start button beside the service you want to start

2. Click Stop button beside the service that you want to stop

3. Click Save to save the changes

Step 9: Check for default data in database server

To verify if you have successfully installed 3CX 911 Notifier application, you need to log into the data base and check for default data in the basic tables.

1. Log into the SQL database.

2. In the Object Explorer accordion, expand Databases and then expand Tables

3. From the tables list,

a. Open dbo.EmergencyNumbers table to see the emergency contact number “911”

b. Open dbo.Messages table to see message type for the emergency number as Email, SMS and Email Subject.

c. Open dbo.NotificationSettings table to see the emergency contact number “911”

d. Open dbo.Settings table to see the default database settings.

4.Installing the Desktop Alert Application #

In addition to sending emergency notifications by phone, email, and SMS text, you can also receive
notifications on your desktop.

The following instructions outline how to install the desktop notification application:

Before you launch the application, you need to ensure that the following prerequisites are installed:

  • Microsoft .Net Framework 4.6.1 (x86 and x64)

If the above component is already installed, you can launch the application. Otherwise, follow the instructions as mentioned below to install the component.

1. On the File Explorer, navigate to:
C:\ProgramData\VoIPToys\Data\Http\wwwroot\3CX 911 Notifier\Alert


Figure 10: Navigate to ‘3CX 911 Notifier\Alert’

2. Double-click 3CX911AlertUpdater to display Emergency Alert URLUpdate popup.

3. In the Emergency Alert URLUpdate popup, enter your URL in the format http://<FQDN>:5600
and click Update.


Figure 11: Update URL

4. In the Emergency Alert Application Update URL popup, click OK.


Figure 12: URL to install prerequisites

5. Open web browser and in the address bar, type the url:
http://<FQDN>:5600/Alert/3CX911EmergencyAlerter.htm

In the url mentioned above, replace <FQDN> with your local host value.

6. The following web page appears:


Figure 13: Install Prerequisites

7. Click Install to install the prerequisites.

8. You can now launch the application.

9. On the taskbar and in the notification area, click the Show hidden icons icon to display
notification area overflow


Figure 14: Show hidden icons: Notification Area Overflow

10. In the notification area overflow, right-click on the Emergency Alerts icon and in the right
click menu, click Preferences.


Figure 15: Notification area overflow: Emergency Alerts: Preferences

11. In the Preferences screen and in the Server URL field, enter the url:
http://<FQDN>:5610/signalr

In the url mentioned above, replace <localhost> with your FQDN value.


Figure 16: Server URL

12. Click Save to save the url and then click Close to close the Preferences screen.

13. In the notification area overflow, right-click on the Emergency Alerts icon and in the right
click menu, click Exit to exit from the Emergency Alerts.


Figure 17: Notification area overflow: Emergency Alerts: Exit

14. On the desktop, click 3CX 911 Notifier icon to launch the application.

5.Web Portal #

To access the 3CX 911 Notifier web portal, click the Web Portal button on the configuration program, or
click on the desktop icon that was created during the installation process (3CX 911 Notifier Web).

When connecting to the web portal, you will be asked to provide login credentials:

1. In the Extension field, enter your 3CX extension number

2. In the PIN field, enter your 3CX 911 Notifier PIN

3. Click Login button to login to your account


Figure 18: 3CX 911 Notifier Web Portal Login

5.1.Setting up 3CX 911 Notifier (Settings Screen) #

The Settings screen enables you to register 3CX 911 Notifier, configure general settings, email server, voice settings, and customize brand settings.

Hover over the mouse on Settings tab to display the drop down menu with the following menu options:

1. 911 Settings

2. Site Settings

5.1.1. 911 Settings
911 Settings enable you to register 3CX 911 Notifier, and configure general settings, email server and voice settings.
License tab (Registration)

For registration, you need to log into ‘3CX 911 Notifier’ web portal and perform the following tasks:

1. In the 3CX 911 Notifier web portal, hover over the mouse on Settings tab and from the drop down menu, select 911 Settings.

Figure 19: Select – 911 Settings

2. In the Settings screen, click License tab

3. In the Registration section, enter License Key and other details appropriately

4. Click Register


Figure 20: 3CX 911 Notifier Registration

Configure General Settings (General tab)

  • Culture setting controls how dates are displayed.
  • Start/ Stop – A windows Service (3CX 911 Notifier) runs in the background monitoring
    for emergency calls. You can monitor the status of this service here (Running, Stopped,
    Unknown).

If you make changes to ‘Settings’, it is necessary to stop and start the service.
  • Refresh link will update the status if changes to the service status were made directly in
    the Windows Service Snap-in.
  • Status field shows the current state of the Windows service (Started/ Stopped).

If you make changes to ‘Settings’, it is necessary to stop and start the service.


Figure 21: Configure General Settings

Configure Email Server (Email tab)

1. In the Email tab, under Email Server section, in the Server field, enter the IP address or Fully
Qualified Domain Name (FQDN) of your email server. Examples: 192.168.1.20 or
mail.mydomain.com

2. In the Port field, enter SMTP Port number. Default port number is 25.

3. In the From Email: field, enter the reply email addresses for email and SMS notifications.

4. In the Authentication section, enter Username and Password.

5. Click Test button to test if Email Server is able to communicate with 3CX Phone System.

6. Click Save to save the data.


Figure 22: Configure Email Server

Configure Voice Settings (Voice tab)
3CX 911 Notifier can call your contacts and “play” a recording. The recording can be prerecorded, or
dynamically created using Text-To-Speech. A dynamically created recording can list information about
the extension where the emergency number was dialed. The following settings make it possible for you
to modify some of the attributes of the voice used to make dynamic recording.

1. Under Voice Settings section, check Dynamic Recording check box to turn on Dynamic recordings.
Uncheck the check box if you want to use a prerecorded recording rather than Text-To-Speech.
Prerecorded messages are uploaded on the “Messages” tab.

2. From the Voice drop down, select the voice that you want to use for dynamic recordings. Usually,
this field displays all of the voices installed on the computer.

3. From the Volume drop down, select the volume that you want to apply for your recording.

4. From the Speech Rate drop down, select the desired speech rate to adjust the speed of the speech.

5. Click Save to save the data.


Figure 23: Configure Voice Settings

5.1.2. Site Settings

Site Settings enable you to customize branding settings for the application that include the following:

1. Customize the gradient color of ‘Application Header’

2. Customize grid color in screens that display grid data

3. Customize logo on the ‘Application Header’

4. Customize ‘Header Title Prefix’ on the ‘Application Header’


Figure 24: Settings: Site Settings Screen

Custom Brand Settings

1. Hover over the mouse on Settings tab and from the drop down menu, select Site Settings


Figure 25: Select Site Settings

2. In the Custom Branding Settings form, perform the following Brand Setting Customizations:

a. Customize Application Title Header – Gradient Color

i. Beside Header Gradient Color and from the Top Color palette, select the desired color that you want to display as the top color for the ‘Application Title Header’.


Figure 26: Header Gradient Color

ii. From the Bottom Color palette, select the desired color that you want to display at the bottom of the ‘Application Title Header’ in gradient to the selected Top Color.

b. Customize Grid Color

i. From the Grid Color palette, select the color that you want to display for the grid in screens that display grid data.


Figure 27: Grid Color Palette

ii. The final display after applying ‘Grid Color’ branding settings:


Figure 28: Display of Customized Grid Color

c. Customize Logo

i. If you are uploading the logo for the first time then, beside Upload New Logo field, click Browse and select the logo that you want to apply. You will now observe that the logo is added to the Custom Logo drop down list.

ii. From the Custom Logo drop down list, select the logo that you have just uploaded.


Figure 29: Custom Logo

d. Customize ‘Header Title Prefix’ Text

i. In the Header Title field, enter the text that you want the application to display as ‘prefix’ for the existing title in application header.


Figure 30: Custom Header Title Prefix

3. Once you perform desired customizations, click Apply.


Figure 31: Display of Customized Brand Settings

5.2.Log Screen #

Log screen displays list of all the event logs since the time you have installed 3CX 911 Notifier. The
information includes event date and time, extension, phone number, floor, pilar, cubicle, street, city,
state/ province, and postal code details.


Figure 32: Log Screen

5.3.Extensions Screen #

In the Extensions screen you can import extensions from either 3CX phone system or CSV file, and export the extension records in the available various formats like pdf, xls, xlsx, rtf or csv.

5.3.1. Import Extensions from 3CX Phone System

1. In the Extensions screen, select 3CX radio button

2. Click Import Extensions button

5.3.2. Import Extensions from CSV file

1. In the Extensions screen, select CSV radio button

2. Click Choose File button

3. Enter the file path and click Import Extensions button

5.3.3. Add New Extension

1. In the Extensions screen, click to add a new extension

2. In the Extension field, enter valid extension number

3. In the First and Last fields, enter the first and last name of the contact respectively

4. Enter valid Mobile, Floor, Pillar, Cubicle, Address, City, State/ Province and Zip Code details for the new extension

5. Click Save to save the extension

You can create multiple extensions (batch edits) before you save the data.


Figure 33: Extensions Screen

5.4.Contacts Screen #

5.4.1. Add New Contact

1. In the Contacts screen, click to add a new contact

2. In the First field, enter the First Name of the contact

3. In the Last field, enter the Last Name of the contact

4. In the Phone field, enter the Phone Number of the contact

5. In the Email field, enter valid Email Address of the contact

6. In the SMS Address field, enter valid SMS Address of the contact

7. From the Extension Group drop down, select the extension group to which you want to assign the contact to

8. Click Save to save the contact

You can create multiple contacts (batch edits) before you save the data.


Figure 34: Contacts Screen

5.5.Speed Dials Screen #

When a ‘Speed Dial’ group receives a call, all the contacts in the group will receive the notifications. The notifications include email or SMS or both. Simply check the email and/ or SMS check box to apply the notification type for the speed dial group.

‘Voice App’ and ‘Alarm’ are the two CFD extensions created manually with a unique id. ‘Voice App Extension’ is programmed on phone and its purpose is to connect the call to its associated contacts. Once the contact receives the call, the ‘Voice App Extension’ internally activates its respective ‘Alarm Extension’ so that it plays the respective audio file for the contact that has received the call.

Only ‘Voice App Extension’ is revealed to the customer and ‘Alarm Extension’ is confidential.

5.5.1. Create Speed Dial

1. In the Speed Dials screen, click to add a new speed dial

2. Enter valid Voice App Extension and Alarm Extension fields respectively

3. In the Description field, enter the description for the speed dial call

4. Check Email and/ or SMS check boxes to apply the notification type for the speed dial call

5. Check Repeat check box if you want to repeatedly play the ‘Audio’ file for the speed dial call

6. From the Audio drop down, select the audio file that you saved on your computer. This file will play as the alarm for the speed dial call

7. Click Publish link to create ‘Voice App Extension’ and ‘Alarm Extension’ in the PBX system

Once you publish the speed dial, ‘Voice App Extension’ and ‘Alarm Extension’ will be created in the PBX system with the name same as that of ‘Description’ you mentioned for the speed dial, extended by the terms ‘Notification’ and ‘Alarm’ for ‘Voice App Extension’ and ‘Alarm Extension’ respectively.

5.5.2. Expand Speed Dial to see Contacts

1. In the Speed Dials screen, click beside Voice App Extension to expand the speed dial

2. Contact Name pop up appears


Figure 35: Expand Speed Dial to see contacts list

5.5.3. Add New Contact to Speed Dial

1. Expand the Speed Dial to view its contacts

2. In the Contacts pop up, click to add a new contact to the speed dial

3. From the Contact Name drop down, select the contact you want to add to the group

4. Click Save to save the data

5.6.Emergency Numbers Screen #

In the Emergency Numbers screen, you can view the list of all the emergency numbers. You can also create a new emergency number here. When an emergency number receives a call, the notification is sent to all the extensions of the extension group to which the emergency number belongs to.

5.6.1. Create New Emergency Number

1. In the Emergency Numbers screen, click to add new emergency number

2. In the Number field, enter valid extension number

3. In the Description field, enter valid description in brief

4. In the Play File field, select the audio file that you already uploaded

5. Click Save to save the data

If you have not selected any audio file in the ‘Play File’ field then, the ‘SMS’ notification that you set for the extension will play as voice file for all the extensions that received the notification.


Figure 36: Emergency Numbers Screen

5.7.Messages Screen #

Messages screen enables you to create an email and SMS to send as notification for a specific speed dial group or emergency number. Here you can either create a new email and SMS message, or edit an existing one.


Figure 37: Messages Screen

5.7.1. Create Email Message

1. In the Messages screen, under Notification Messages, select the extension from the extension drop down to which you want to send the email notification

2. In the Email Subject field, enter the subject of the email

3. In the Design editor, type the email content that you want to send as notification to the selected speed dial group or emergency number

4. Click Update to create the email notification


Figure 38: Email Message – Notification Window

5.7.2. Create SMS Message

1. In the Messages screen, under Notification Messages, select the extension from the extension drop down to which you want to send the SMS notification

2. In the text box, type the SMS content that you want to send as notification to the selected speed dial group or emergency number

3. Click Update to create the SMS notification

4. IVR extension number


Figure 39: SMS Message – NotificiationWindow

6.Support #

If you need support, would like to request an enhancement to 3CX 911 Notifier, or are interested in discussing a custom solution, you can contact as at the following:

Address:   2306 Shimmering Bay Lane, Cincinnati, OH 45244-2760

Hours:       Monday – Friday (8:00 A.M. – 6:00 P.M. Central Standard Time)

Phone:      USA: +1 801-642-4655

Skype:       VoIPToys

Email:        info@VoIPTools.com

Web:          http://www.VoIPTools.com

Suggest Edit

Get the Best Solution for your Business

Whether through one of our commercial products, or a custom solution built to meet your specific needs, we can help you get the most out of your 3CX investment. Call us today!

Contact Us