System Notifications: sending 'pop-up' messages to users of Roam and the Web Application

note_awesome

Additional Setup required to support this Functionality

For this functionality to work, it is necessary to establish and define a Notification Hub.

Please refer to the Global Settings for more information.

What are System Notifications?

System notifications are messages, consisting of a header and the message body itself, which can be sent to Users of the web application, and of Roam.

If a user is logged into either a Roam device, or the web application, when the notification is sent, then the notification will "pop-up" (for about 5 seconds in the web application).

Should notifications have been sent to a user while the user had been logged out of any device, then the system will 'catch up' and display all the notifications which the user has missed when the user logs in next.

Web Application users can view notifications, and directly access the corresponding records, directly from the notification icon in the top menu.

System Notification Designer

The System Notification Designer is a cut-down version of the Email Designer, and therefore the same principles apply when it comes to adding the content for the Subject and Message fields.

  • The main difference is around the To: field:
    • System Messages will be sent to Users of Roam and the web application, and not to an email address.
    • Therefore, as a Designer you can only select one or several relationships to a Person related Component for the To: field.
      Examples are: Assigned To, Responsible Supervisor.
      You cannot select or define fields, or enter hard-coded addresses.
  • Due to technical constraints outside our apps, the number of characters in the notification payload needs to be limited (e.g. current maximum payload for notifications in iOS is 2048kb). The limits are as follows:

    - Title: max of 255 bytes
    - Message body: max of 1245 bytes

note_awesome

A background task runs every day checking for notifications greater than 3 months and clears them out.

See Also

Form Actions

How to define Form Actions

Creating Action Group, and the individual Actions

Filtering and Finding Action Groups

Email Actions: When you need to send Emails from the application

Rest Callouts: interacting with external Systems via REST Calls

Set Value Actions: When the System needs to copy or manipulate Field Values in the Web Application

Analytics Rules