Notification capabilities

You can manage how different users can interact with centralised notifications using a number of capabilities, which are outlined here.

Notification management capabilities

General notification capability

The totara/notification:managenotifications capability allows users to manage all notifications in the context for which it is granted. This includes:

• Enabling and disabling notification triggers
• Adding, editing and deleting notifications
• Setting default delivery channels (in the system context only)

If granted in a certain context, the capability allows users to manage all notification triggers and associated notifications in that context and all descendent contexts. For example, if the capability is assigned to a user for a course category, then the user will be able to manage all notifications in all programs, certifications and courses within that category, as well as all activities within those courses.

Assigning the capability to a user at the system level also grants the user access to the Notifications menu item in the quick-access menu.

The Site Manager role has this capability by default.

Capabilities from plugins and components

Some components implement their own capabilities, which allow administration of the notifications specifically relating to that component. For example, programs and certifications have the totara/program:configuremessages capability, which allows users to manage only program and certification notifications.

If one of these capabilities is granted in a context, then the user will be able to manage only those notifications in that context and any descendent contexts. For example, if the program management notification capability is granted in the system context then the user will be able to manage program and certification notifications in the system context and in all programs and certifications.

Granting one of these component- or plugin-specific capabilities in the system context also grants the user access to the Notifications item in the quick-access menu.

The notifications that a user can manage are filtered to only those which they have the capability to manage. For example, a user with the capability to manage seminar notifications granted in the system context will be able to access the notifications management interface at the site and course level, but will be able to manage only seminar notifications in those pages.

Notification auditing capabilities

General notification auditing capabilities

The totara/notification:auditnotifications capability allows users to audit centralised notifications in the context it is granted. This capability grants access to all three of the notification logs (Notification events, Sent notifications and Delivery log).

If granted in a certain context, the capability allows users to audit all notifications in that context and all descendent contexts. For example, if granted in a course category context then it allows auditing of all notifications in all programs, certifications and courses within that category, as well as all activities within those courses.

Granting the capability in the system context grants the user access to the Notifications item in the quick-access menu.

If granted in a user context, the capability allows a user to audit all notifications relating to the target user. This capability could be added to the Staff Manager role, and would allow Staff Managers to view the notifications of their staff. To view notifications relating to a specific user, go to the target user's profile and click the View notification logs link.

The Site Manager role has this capability by default.

Additionally, the totara/notification:auditownnotifications capability allows users to view logs for their own notifications. To allow all logged-in users on a site to view their own notification logs, this capability can be granted for the Authenticated User role. To allow only some users to audit their own notification, the capability can be granted in a role which is given to a subset of users, or in a role applied at a system, tenant, or individual context.

Using capabilities from plugins and components

Some components implement their own capabilities which allow auditing of the notifications specifically relating to that component. For example, programs and certifications have the totara/program:auditmessages capability, which allows users to audit only program and certification notifications.

If one of these capabilities is granted in a context, then the user will be able to audit only those notifications in that context and any descendent contexts. For example, if the program auditing notification capability is granted in the system context then the user will be able to audit program and certification notifications in the system context and in all programs and certifications.

Granting one of these component- or plugin-specific capabilities in the system context grants the user access to the Notifications item in the quick-access menu.

The notifications that a user can audit are filtered to only those which they have the capability to audit. For example, a user with the capability to audit seminar notifications granted in the system context will be able to access the notifications management interface at the site and course level, but will be able to audit only seminar notifications in those pages.