Notification
Notifications are used to notify users about events happening in Oort. In order to receive notifications, you need to have a role listening a notification channel. At the moment, notifications are purely informative and the only action we can perform is marking them as read. They are useful to inform about changes done by other users on a shared record, application, …
Location
This feature is visible on any page of Oort in the top right corner next to the log out button.
Button with notifications
Button without notifications
Basic usage
You can configure custom notifications easily using these stages:
- Update some roles properties so they listen to a specific channel: Roles->Edit->Channels.
- Set up a quick action button which can notify on the same channel.
- Select some records and click on the quick action button.
You can then mark notifications as read by clicking on them in the notifications list.
Feature description
There are two types of notifications, default notifications and custom notifications.
Notifications are using GraphQL subscriptions and are going through the RabbitMQ server. It means that in theory, we could send notifications to external clients if they subscribe to the right channel.
The notification object has multiple attributes which are listed in the following table:
| action | This is the header of your notification which will be displayed in the notifications list. |
| content | This is the document linked to the notification. It can be the application created, the list of selected records, … |
| createdAt | This is the date where the notification was created. |
| channel | This is the channel on which the notification has been sent. |
| seenBy | This is the array of users which have already marked the notification as read. |