Notifications Administration Quick Reference Guide

The Notifications plug-in allows WebEOC Nexus users to subscribe to status boards and receive messages in the form of emails and desktop notifications when new records or updates are posted to those boards. WebEOC Nexus administrators can enable the Notifications feature on any status board.

  1. Access the Admin View.

  2. In the main menu, click the integrations icon integrations icon. The Integrations page opens.

  3. Click the Notifications tab. The Notifications page opens.

    Notifications page.

  4. If your email server is using Office 365, update the authentication to OAuth 2.0, if you have not already updated it.

    To verify if this update has already been done, click Edit, then verify the Authentication Method. If it does not display OAuth 2.0 (Microsoft Exchange Online), perform the following steps:

    1. In the Server field, delete the server information.

    2. Select the Use SSL checkbox.

    3. For Authentication Method, select OAuth 2.0 (Microsoft Exchange Online). The fields update with associated information.

    4. Enter your Client ID and your Tenant ID in a valid GUID format. Contact your SMTP provider for this information.

    5. Click Acquire. A token code is generated and the first in a series of Microsoft and Juvare windows appears.

    6. In the next Microsoft account window, select the account that you want to authenticate.

    7. At the “Are you trying to sign in to <ApplicationName>?” prompt, click Continue, then close the last window in the series.

      Juvare acquires and authenticates the token. After the successful completion of the authentication, a confirmation message, highlighted in green, appears above the Authentication Method field.

    8. In the Username field, enter the email address that you used to authenticate.

    9. Click Save. Authentication is complete.

  5. If you are not already there, return to the Admin window. Navigate to the Plugins: Notifications: Email Settings section and, in the Sender Address field, enter the email address that appears on the notifications.

  6. In the Display Name field, enter the name to appear in the From field for messages sent using this tool.

  7. In the System Settings section, in the WebEOC API URL field, enter the appropriate URL address.

    The URL must be configured for the plug-in to operate correctly.

  8. Click Save.

An icon is shown on Notifications-enabled boards, allowing users to quickly identify boards configured for notifications. Initially, an envelope icon is automatically set as the default icon. You can change this icon through the Actions menu on the Notifications page.

Actions menu, showing the Manage Default Icon menu option.

  1. Access the Admin View.

  2. In the main menu, click the integrations icon integrations icon. The Integrations page opens.

  3. Click the Notifications tab. The Notifications page opens.

    Notifications page.

  4. In the upper right corner, click Actions and select Manage Default Icon.

  5. On the Notifications: Manage Default Icon page, click Browse.

    Notifications: Manage Default Icon page.

  6. Locate the appropriate image and click Open.

  7. Click Save.

You can change the default icon at any time. If you want to revert back to the system’s default icon:

  1. Navigate to the Notifications: Manage Default Icon page and click Actions in the upper right corner.

  2. Select Use System Default Icon from the menu.

  3. In the pop-up window, click Yes.

The envelope icon is once again shown as the current default icon on both the Notifications: Manage Default Icon page and in the Icon section of the Notifications page.

To enable the Notifications plug-in, you must add it to a board’s Input and Display views.

  1. Access the Admin View.

  2. In the main menu, click the workflows icon workflows icon. The Workflows page opens.

  3. On the Boards tab, locate the appropriate board and click its name.

  4. Select the Notifications check box in the Include section, then click Save.

  5. Locate the same board and click its name again.

  6. In the Tools section, click Board Editor. The Board Editor page opens.

  7. Click the input view of the board you want to add Notifications to.

  8. In the HTML section, click either the Advanced Code Editor or Plain Code Editor tab.

    Advanced Code Editor tab with selected code snippet.

  9. Locate the <body> tag, and paste the following code directly below it:

    Copy Code 

                        <div style="display: none">
                            <notificationicon>
                                <field name="field1" />
                                <field name="field2" />
                                <field name="field3" />
                                <field name="field4" />
                            <subject name="SubjectField" />
                            <body name="BodyField" />
                            </notificationicon>
                        </div>
                    

    Make sure to replace field names in the code with the actual board fields you want included in the email. The order of the fields in the code determines the order in which they appear in the email. If necessary, add or remove fields in the <notificationicon> tag. Field and body tags are mutually exclusive; if a body tag is present, field tags are ignored.

  10. Click Save.

When adding notifications to a board’s Input view, the following tags can be useful in customizing the subject and body of notification emails and displayed desktop notification pop-up messages.

Notification email tags
Subject

When not defined, emails and desktop pop-ups are sent with the board’s name as the subject.

  • <notificationicon><subjectname="SubjectField"/></notificationicon>

    The subject for the notification email is based on the record value from the designated field.

  • <notificationicon><subject>{{shelter_name}} is now {{shelter_ status}}</subject></notificationicon>

Body

When not defined, emails are sent with the field name and value pairs listed in the body.

  • <notificationicon><body name="BodyField" /></notificationicon>

    The body for the notification email is based on the record value from the designated field.

  • <notificationicon><body>{{shelter_name}} is now {{shelter_status}} </body></notificationicon>

Record field values are taken from the record, triggering a notification. Field names surrounded by double curly brackets are replaced with actual field values. Empty strings are used when actual field values do not exist in the Input View.

For example, such a notification may read “Downtown Public Shelter is now Open.”

Adding the <notificationicon/> tag to a board’s Display view places an icon on the board. WebEOC Nexus users can use the icon to access and modify their notification subscriptions settings.

To add notifications to a board’s Display view

  1. Access the Admin View.

  2. In the main menu, click the workflows icon workflows icon. The Workflows page opens.

  3. On the Boards tab, locate the appropriate board and click its name.

  4. In the Tools section, click Board Editor. The Board Editor page opens.

  5. Click the Display view of the board you want to add Notifications to.

  6. In the HTML section, click the preferred Editor tab and paste the <notificationicon/> tag in the desired location.

    Advanced Code Editor, with the notification icon line selected.

    Do not paste inside the <eocrepeatallrecords> tag; doing so results in one icon being shown per displayed record.

  7. Click Save.

Users can only subscribe to a board that has the Notifications plug-in enabled using the processes described above.

Be sure to let users know which boards support Notifications when you finish adding the plug-in to a board’s Input and Display view.

You can enable Notifications for multiple Input and Display views of a board. Additionally, subscriptions are table-based. Therefore, settings are shared between all views that use the same table.

The board permission tag can be used to limit Notifications access to only certain system users with access to a given display view. To enable this, add <boardpermission name="Notifications"> <notificationicon/></boardpermission> to the display view and ensure the permission is assigned when making the group assignment.

For the Display view, you have the option to set an icon’s size. Adding width and height attributes to the <notificationicon> tag overrides the icon’s original dimensions (54px by 32px).

For example, <notificationicon width="70px" height="50px"/>.

Any size, in pixels or percent, can be specified. However, it is recommended you use icons of the correct size to avoid large scale changes or icon distortion. If width and height attributes are not defined, the size of the original icon is used.

You can easily inject Notifications into the Actions drop-down menu, a feature standard for all WebEOC version 8.0 boards. If a board has an Actions drop-down menu, the process for adding Notifications to the menu is the same for each instance.

To insert notifications into the Actions drop-down menu

  1. Access the Admin View.

  2. In the main menu, click the workflows icon workflows icon. The Workflows page opens.

  3. On the Boards tab, locate the appropriate board and click its name.

  4. In the Tools section, click Board Editor. The Board Editor page opens.

  5. Click the display view containing the Actions button you want to add notifications to.

  6. In the HTML section, click either the Advanced Code Editor or Plain Code Editor tab.

  7. Insert the <notificationicon action=""> tag just before the <ul> tag.

    Actions > Notifications menu item highlighted.

  8. Click Save. In this instance, Notifications appears as the last item in the drop-down list.

Related Concepts

Notifications