Notification

The Axon Ivy Engine sends notifications to users such as when a new task is assigned to a user. Different channels can be operated. Built-in channels are the following:

By default, only the web channel is active, which displays all notifications. Each channel can be configured individually.

 1# sample ivy.yaml that configures the web channel
 2SecuritySystems:
 3  default:
 4    Notification:
 5      Cleanup:
 6        # notifications older than this will be deleted on a daily basis
 7        DaysUntilDeletion: 90
 8      Channels:
 9        # each channel has it's own identifier
10        web:
11          # name of the channel to identify which channel it is
12          Name: web
13          # each channel can be enabled/disabled
14          Enabled: true
15          # each channel can define which events are subscribed by default
16          Events:
17            # if enabled, all events are subscribed
18            # otherwise, only events mentioned under 'Kinds' are subscribed
19            # possible values are 'enabled' and 'disabled'
20            AllKinds: enabled
21            # array of subscribed events
22            Kinds:
23            - new-task

Events

You can configure which events are sent over which channels. If nothing is configured all Events are distributed over the given channel. If you disable Events:AllKinds and specify Events:Kinds for a channel only those events are sent. However, users can individually set the notification settings in Axon Ivy Portal. All available events are:

  • new-task: If a user has a new task assignment (also on delegation)

  • business: If new business relevant event happens or new business information is available

Cleanup

By default, notifications are deleted from the database if they are older than 90 days. This duration can be adjusted using the Cleanup:DaysUntilDeletion property.