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# yaml-language-server: $schema=https://json-schema.axonivy.com/ivy/12.0.11/ivy.json
 2# sample ivy.yaml that configures the web channel
 3SecuritySystems:
 4  default:
 5    Notification:
 6      Cleanup:
 7        # notifications older than this will be deleted on a daily basis
 8        DaysUntilDeletion: 90
 9      #Decision whether a mail notification should be sent to an absent user.
10      #possible values are 'always', 'never' and 'noActiveSubstitute'
11      NotifyAbsentUser: always
12      Channels:
13        # each channel has it's own identifier
14        web:
15          # name of the channel to identify which channel it is
16          Name: web
17          # each channel can be enabled/disabled
18          Enabled: true
19          # each channel can define which events are subscribed by default
20          Events:
21            # if enabled, all events are subscribed
22            # otherwise, only events mentioned under 'Kinds' are subscribed
23            # possible values are 'enabled' and 'disabled'
24            AllKinds: enabled
25            # array of subscribed events
26            Kinds:
27            - new-task

Notification on absent users

There is a global option to disable notifications if a user is absent; if no property is set, they will act like NotifyAbsentUser:always.

  • Send a notification regardless of the user’s absence: always

  • Does not send a notification if the user is absent: never

  • Send a notification only the absent user does not have an active substitute: noActiveSubstitute

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.