Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Page Properties
hiddentrue

Drupal URL:

https://knowledge.star2star.com/kb/3380

Source Document URL:

https://docs.google.com/document/d/10GvymBKGgqFfpBA87zYclpoJq4ecyJF7190q_bFUqS8/edit

Salesforce KB URL:

Overview

The Urgent Notify application provides the ability to create event-based notifications that are sent to a designated response team. For example, if someone at your organization dials 911, the Urgent Notification Notify app can send a notification to your crisis team, with details of the call.

Different Urgent Notify notifications can be configured set by creating Notification Rulesmultiple configurations. Each Rule configuration monitors a dialed number from selected locations or extensions, and then sends a notification to a designated team.

How to Access the Urgent Notify App.

Access the Urgent Notify App. via TeamHub

You may also launch the Urgent Notify app from TeamHub,

  • Open the TeamHub app.

  • Select “Home” in the left side menu.

  • Click the VIEW APPS button. in the App Gallery tile.

  • Scroll to the Urgent Notify tile and click the OPEN button.

How to Create a new Configuration:

  • Select the Configuration Configurations option from the menu on the Left side of the page.

  • Click the   the  + Configuration  Configuration  button in the top right corner of the window.

  • Enter the required information as described in the Urgent Notification Configuration section below.

How to Edit an existing Configuration:

  • Select the Configuration option from the menu on the Left side of the page.Hover over the Configuration to be edited.

  • Click the Pencil ” Icon Actions Icon ( ) on the right side of the desired configuration rowand Select Edit.

  • If the selected Configuration is active, click the  INACTIVEDEACTIVATE   buttonbutton, at in the bottom last step of the configuration pagewizard.

  • Make the desired changes as described in the Urgent Notification Configuration section below.

How to Delete an existing Configuration:

  • Select the Configuration option from the menu on the Left side of the page.Hover over the Configuration to be edited.

  • Click the Trash ” Icon Actions Icon ( ) on the right side of the desired configuration rowand Select DELETE.

Image RemovedImage Added

How to Activate & Deactivate a Configuration

Activate a Configuration

  • Click the   ACTIVE   button Actions Icon ( ) on the right side of the desired configuration and Select Edit.

  • Click the  ACTIVATE  button, at the bottom last step of the configuration pagewizard.

Deactivate a Configuration

  • Click the Actions Icon ( ) on the right side of the   INACTIVEdesired configuration and Select Edit.

  • Click the   DEACTIVATE   button, at the bottom last step of the configuration pagewizard.

Urgent Notification Configuration

Note: If a field is required it will state required on the right side of the field.

1. 

Name

Basic Info

Enter the following information and then click to the   NEXT   button button in the bottom right corner of the screen.

  • Configuration Name *

    • Enter a name for this configuration.

  • Timezone

    • Select the timezone to be used.

  • SMS *Number

    Email when errors occur
    • Enter Select the SMS number that will be used to send out the notifications.

  • Timezone *

    • Select the timezone to be used.

    • The numbers you may use here have to be 10DLC format numbers, purchased through the SMS Campaign Registry App, and associated with an active campaign created in the same app.

    • A pre-populated list of these type of numbers will appear when clicking the dropdown. If you don’t have any of these numbers available, you may click on the Buy a Number button available at the top of the dropdown.

    • For more information about 10DLC numbers and campaigns, read the SMS Campaign Registry App article.

  • Error Email

    • Enter an email address that error messages can be sent to.

Image RemovedImage Added

2. Trigger Number

This section of the configuration defines what will trigger the urgent notification. Enter the following information and then click to the  NEXT   button button in the bottom right corner of the screen.

3.  Contacts
  • When this number is DialedTrigger: *

    • Enter a number or extension that when dialed will trigger the urgent notification.  (Example: 911)

    …by the following locations or extensions

    Several options are allowed with this information.  
  • What locations and Extension do you want to monitor for the trigger selected above

    • All Locations and Extensions Checked - if this field is checked

      then if

      and when the trigger number entered above is dialed by any location or extension within the

      company

      organization, the urgent notification will be triggered.

      If “All locations”
    • All Locations and Extensions Un-Checked - If this field is uncheck, search and

      you

      select

      /check 1 or more locations, then if the trigger number entered above is dialed by any extension within the selected locations the urgent notification will be triggered.
    • If “All locations” is uncheck and you select/check 1 or more Extensions, then if the trigger number entered above is dialed by any selected extension the urgent notification will be triggered.

Image Removed
    • the Locations and/or Extensions that will trigger this notification by dialing the trigger number.

Image Added

3.  People Notified

This section of the configuration defines who will be notified and the notification method. In this section the list of existing contacts is displayed with the option to Add, Edit, Delete, or Add Contacts.

Image Removed

or Delete Contacts.

Image Added

Remove Contacts from the Contacts list

Hover or the desired contact and click the Delete icon.

Add or edit Contacts in the Contact list

After clicking the  + Contact  button to add a contact or the Edit ( 🖉 ) icon to edit a contact, enter the following information and then click the   NEXT   button button in the bottom right corner of the screen.

  • Name - Enter the name of the contact.

  • Email or Phone - Enter how the contact is notified.

    • Email - Enter the email address where the notification is to be sent.

    • Phone Message - Enter the Text messaging number where the notification is to be sent. 

  • Click the   Save   button button

Image Removed

Image Added

Image Removed

Image Added

4.  External Data

This section is optional and is for advanced users. In this section you can configure the notification flow to retrieve information from an external website. The information retrieved can be added as output data which then can be added to the notification messages.

Note: As stated this section is optional and is for advanced users. If you need assistance please contact Sangoma Sales Engineering or Professional Services.

Select/Check the checkbox next to the “Get additional Data?”. The following screen is displayed.

Image Removed

To create output data enter the following information and then click the   NEXT   button in the bottom right corner of the screen.

  • HTTP Method *

    • Select the Get or Post options.

  • Enter URL *

    • Enter the required URL where the data is to be retrieved.

  • HEADERS

    • If header data is required click the   + HEADER  button and enter the Name and Value.

  • Parameters

    • If parameters are required click the   + PARAMETER  button and enter the parameter data.

  • Valid HTTP Codes *

    • Enter the success return codes that will be returned from the request.

  • Generate Sample Data

    Once the required information has been entered, generate the sample data by clicking the
      GENERATE SAMPLE   button.
  • Outputs

    • To create the output data, generate the sample data as described above. 

    • In the generated sample data area: 

      • Expand the section that has the data to be added to the output section (I.e… data). 

      • Hover over the field to be added as output.

      • Click the Click to Add button.

  • Image Removed
    • Once the data has been added it will appear in the OUTPUTS area.

    Note: Only the fields listed in the OUTPUTS area are available to use as variables in the messages. 

    5.

    To get a complete guide on how to configure external data, click on the EXTERNAL DATA button.

    To activate the usage of external data, select/check the checkbox next to the “Get additional Data”.

    Image Added

    5. Notification Message

    This section of the configuration defines the message that will be sent. Enter the following information and click the   NEXT   button in the bottom right corner of the screen.

    • Enter SMS Message - This is the body of the SMS message that will be sent to the contacts when an Urgent Notification is triggered. This message will only be sent to the recipients that have a valid phone number added in the Contacts section.

    • Enter Email Message - This is the subject and body of the email message that will be sent to recipients when an Urgent Notification is triggered. This message will only be sent to the recipients that have valid email addresses entered in the Contacts section.

    • Variables: Variables can be added to the SMS and email messages.

    This can provide more details about the call
    • A variable is used to provide information in the notification that will vary based on the notification. Variables in the notification are surrounded by brackets. An example use of variables might be {{dialer_name}} called from extension {{number_dialed}}, resulting in John Hopkins called from extension 1234. To see a complete list of available variables, including any external data you may have created it the External Data step, click the SEE ALL VARIABLES button. To add a variable:

      • Enter a left bracket { and a list of the available variables is displayed.

      • select the desired variable.

    Example message with variables:

    _name}} just dialed {{number_dialed}} from {{location
      • .

     

    Example of the message sent: 

    “Susan Parker just dialed 911 from the Atlanta Office.”

    • Available Variable:

      • datetime

      • dialer_number

      • extension_id

      • extension_uuid

      • dialer_name

      • location_id

      • location_name

      • location_uuid

      • Number_dialed

      • Additional variables may be available from the Data section

    Image Removed6.
    Image Added

    6. Recipient Response

    If no response is required from the contacted personnel, ensure that the “ Should contacts respond? '' checkbox is unchecked, and proceed to the Test and Activate steps below.

    If a response is required from the contacted personnel, ensure the “ Should contacts respond? '' checkbox is selected/checked ( ☑ ). If the “ Should contacts respond? ” checkbox is selected/checked, a link will be added at the end of the SMS and/or email messages that are sent out.When a message recipient clicks the link, the recipient will be provided the information and responses configured below. notification.

    All responses along with the date and time that the response was received will be recorded for reporting purposes. 

    When a notification recipient clicks the link, the recipient will be provided the information and responses configured below.

    Image Added

    Response Configuration

    • Enter Response Title - Enter a title for the response.

    • Enter Response bodyForm Explainer - Enter a statement that provides guidance for responding to the

      message 

      Options * message.

    • Response Actions - At least 2 response options actions are required.

      • Add an response optionaction:

        • Click the “ + OPTIONACTION “ button to add a new optionaction

        • Label - Enter a label for the response button.

        • Redirect URL or Phone Number:

          • URL - Optionally a URL can be provided to redirect the respondent to a different website.

        • Click the SAVE button.

      • Edit an existing option:- Hover over an existing option and click the Edit ( 🖉 ) icon. 

      • Delete - Hover over an existing option and click the Delete icon. 

    Image Added
    • Footers -

    Footers are option, and appear at the bottom of the Response form. Footers can be used to provide links to websites with additional information or instructions.

    • Add an response Footer:

      • Click the “ + ACTION “ button to add a new footer.

      • Label - Enter a label for the response button.

      • Link - Enter the required link/URL.

      • Click the SAVE button.

      • Edit - Hover over an existing Footer click the Edit ( 🖉 ) icon. 

      • Delete - Hover over an existing

        option

        Footer and click the Delete

        /Trash

        icon. 

    • Proceed to the Test and Activate steps below.

    Image Removed

    Test and Activate

    • Test

      • Click the Test bottom

      • Follow the instructions as provided.

    • Activate

      • Click the   ACTIVEACTIVATE   button at the bottom of the page.

    Table of Contents
    minLevel1
    maxLevel6
    outlinefalse
    typelist
    printablefalse
    Page Properties
    hiddentrue

    Click here ( https://sangoma.atlassian.net/wiki/spaces/PMGMT/overview ) to locate this Product Manager.

    Source Document URL:

    Original KB URL:

    Access level (Everyone, Partners, Internal)