Alerts is an Appspace feature that can enable system-wide alert broadcasts of important or critical messages such as weather warnings or emergency announcements across a network, immediately or at a scheduled time to target devices, via a channel. The alert broadcast will automatically take over the channel that is currently running on the device and display a full-screen message.

To configure an alert, you must first define your messaging categories and allocate color codes to them, i.e. Fire Alert, Emergency Evacuation Messaging, Service Expiry Notification, and such. You then create a messaging template and categorize it according to the messaging category you created.

Finally, you can broadcast the message across your network on a channel.

On the Alerts dashboard, you can:

  • Create broadcast messages targeted to all sites, a group of sites, or a single site.
  • Sync broadcast messages to registered sites within Appspace.
  • View active and scheduled broadcasts.
  • Use the Broadcast Trigger API to generate a web handler based on the user’s selection of the site and broadcast template. Once configured, external systems utilize the API method call, in the form of a URL, to instruct Alerts to broadcast the selected template to the chosen site(s).
  • Deactivate broadcasts currently in progress.

The following are content file types supported on Alerts.

  • Images – JPEG, JPG, PNG, TIFF
  • Cards – Alert card, Announcement card, Web View card

This article provides instructions to create and broadcast alerts. You can also trigger a broadcast using a custom URL on a web browser. Follow the instructions below to configure alerts:

Prerequisites

Important
Cards are supported in Alerts with Appspace App 1.21 and later only.
Note
  1. – Alerts on a card is only broadcasted after a few attempts.
  2. – Alerts on a card deactivates automatically after broadcasting for about 5 seconds.

Create an Alert Category

  1. Log in to the Appspace console.
  2. Click the ☰ Appspace menu, and select Alerts.
  3. Click the Categories tab, and click ADD.
  4. Enter the Name, Description, and select the ColorCode for this alert category.
  5. Click Save, and proceed to the Create an Alert Template section below.

Create an Alert Template

  1. Log in to the Appspace console.
  2. Click the ☰ Appspace menu, and select Alerts.
  3. Click the Templates tab, and click ADD.
  4. Enter the Name, and select a previously created category from the Category drop-down menu.
     
  5. Select an Alert card, Announcement card, or image from the library to be displayed in the broadcast.
    Note
    To display alert messaging via cards, we recommend using the Alert Card. For more information and instructions on how to configure the Alert card, click the Cards: Display Alert Messaging article.
  6. Click Save, and proceed to Configure the Alert Broadcast Settings section below.

Configure Alert Broadcast Settings

  1. Log in to the Appspace console.
  2. Click the ☰ Appspace menu, and select Alerts.
  3. Click the Dashboard tab, and select AllSites, or a specific device group to broadcast the alert.
  4. Click the Broadcast icon.
  5. Select a previously created alert template from the Template drop-down menu.
  6. Set the Timeout duration for the alert broadcast, or check the Manual deactivation only checkbox to ensure the alert broadcast is only deactivated by a user manually.
  7. Select the following alert broadcast actions when triggered:
    • Broadcast Now – Broadcast the alert message immediately when triggered.
    • Scheduled – Broadcast at a scheduled date and time, with a recurring option.
Note
Repeat this process as many times as needed until you’ve defined all scheduled message broadcasts needed for your organization’s broadcasting needs.

Assigned broadcasts on parent sites will also be saved to their child site(s). However, this inheritance will be over-ridden when a child site is assigned a different broadcast template altogether.

Create Broadcast Trigger URL

The Broadcast Trigger API is part of Alerts and is used to generate a web handler based on the user’s selection of the site and broadcast template. A resulting web handler will then be generated with the proper Site ID and Broadcast ID.

By selecting the Trigger icon on the target site containing a broadcast, it will automatically generate an API method call in the form of a URL. When an external system calls the API method, it will instruct Alerts to broadcast the selected template to the chosen site(s).

  1. Log in to the Appspace console.
  2. Click the ☰ Appspace menu, and select Alerts.
  3. Click the Dashboard tab, and select AllSites, or a specific device group to broadcast the alert.
    Important
    The Alerts Dashboard displays the group device structure, rather than the network structure, thus the Alerts broadcast message would be displayed on all devices within that device group.
  4. Click the Trigger icon.
  5. Select a previously created alert template from the Template drop-down menu.
  6. Once selected, the ActivationURL and DeactivationURL will be generated, which can be used to activate or deactivate the alert broadcast via HTTP on a web browser.
    • To activate the alert broadcast, copy and paste the ActivationUrl on a web browser.
    • To deactivate the alert broadcast, copy and paste the DeactivationUrl on a web browser.
Note
Each template corresponds to its unique activation and deactivation URL.
Related Articles