tutor-contrib-notifications 21.0.0

Tutor companion plugin that manages Open edX notification jobs

Tutor companion plugin for Open edX notification jobs on Ulmo / Tutor 21.x.

This repository is meant to be installed alongside the official openedx/tutor-contrib-platform-notifications plugin.

The official plugin provides the notification tray, MFE integration and core notification configuration under the Tutor plugin name notifications. This repository complements it under the Tutor plugin name notification-jobs by keeping job automation for notification-related management commands:

• Course updates

• Recurring nudges

• Daily digests

• Weekly digests

This plugin will expose manual Tutor jobs for all of them and, on Kubernetes, will create CronJobs for the scheduled digests.

Course updates (aka course highlight emails)

If your Open edX system adminstrator has configured your instance of the Open edX platform to send course highlight emails, you can send automatic email messages to learners in your course that contain three to five “highlights” of upcoming course content. A highlight is a brief description of an important concept, idea, or activity in the section. Your Open edX system administrator provides the template for this course highlight email, and you enter the highlights for the email in Studio.

To learn more about this feature, see Course Highlight Email.

Recurring nudges

Recurring nudges are emails that are sent 3 and 10 days after a learner enrolls in a course.

To learn more about this feature, see Recurring Nudges.

Email notifications

Notifications help you stay updated on important activity in your courses. You can receive notifications via the notification tray in real time, or through email summaries delivered periodically.

Notifications are sent daily and weekly, and can be configured in the account settings page.

Event that trigger notifications are course updates, forum activities and ORA submissions.

To learn more about this feature, see Email Notifications.

Installation

Install both the official notifications plugin and this companion plugin.

pip install git+https://github.com/openedx/tutor-contrib-platform-notifications.git
pip install git+https://github.com/aulasneo/tutor-contrib-notifications.git

Usage

Enable both plugins:

tutor plugins enable notifications
tutor plugins enable notification-jobs
tutor {local|k8s} do init --limit notifications
tutor {local|k8s} start

This plugin adds the following manual jobs:

tutor {local|k8s} do send-daily-digest
tutor {local|k8s} do send-weekly-digest
tutor {local|k8s} do send-course-update
tutor {local|k8s} do send-recurring-nudge

For Kubernetes users, this plugin sets up CronJobs to run daily and weekly digests at the configured schedules. Users of a Tutor local installation will still have to configure cron outside Tutor.

Configuration

• NOTIFICATIONS_DAILY_SCHEDULE: Set the schedule for the daily emails. Default is “0 10 * * *” (every day at 10am UTC).

• NOTIFICATIONS_WEEKLY_SCHEDULE: Set the schedule for the weekly emails. Default is “0 10 * * 0” (every Sunday at 10am UTC).

• NOTIFICATION_JOBS_SITE_DOMAIN: Optional site domain passed to send-course-update and send-recurring-nudge. Default is “{{ LMS_HOST }}”. Set it to an empty value to run those jobs for all sites.

• NOTIFICATIONS_SEND_COURSE_UPDATE: Enable course updates. Default is True.

• NOTIFICATIONS_SEND_RECURRING_NUDGE: Enable recurring nudges. Default is True.

• NOTIFICATIONS_SEND_DAILY_DIGEST: Enable daily digests. Default is True.

• NOTIFICATIONS_SEND_WEEKLY_DIGEST: Enable weekly digests. Default is True.

Notes:

• After changing the schedules, you will need to restart the cronjobs with tutor k8s start.

License

This software is licensed under the terms of the AGPLv3.