4.30. Enabling the Weekly Learning Goals Feature

4.30.1. Overview

The feature adds a new Weekly Learning Goal widget to the course home page.

To use it, learners select a weekly learning goal and are automatically subscribed to goal reminder emails. The weekly reminders continue until the learner completes their course and/or their audit access ends. Learners can modify/cancel their goal and reminder settings at any time from the widget or via links in the email.

For more details on this feature or screenshots see this blog post.

Note

This feature is only available on the new learning micro frontend. If that is not already enabled for you, you can view instructions here.

4.30.2. Enable the feature

The following waffle flag needs to be enabled:

course_experience.enable_course_goals

To send goal reminder emails, you need to regularly run the following management command.

edx.org runs this command at the following cron schedule H */3 * * *

The script does a number of checks before sending emails. There are five main conditions that must be met in order for an email to be sent, otherwise an email will not be sent:

  1. The script will check the number of days left for a learner to successfully hit their goal compared to the learning goal selected by the learner (i.e. if the learner has chosen to learn once per week, three times per week, or five times per week)

  2. If you’re not actively enrolled in the course or your enrollment was this week

  3. If an audit user’s access expires this week, exclude them from the email since they may not be able to hit their goal anyway

  4. If a user has a downloadable certificate, we will consider them as having completed the course and opt them out of receiving emails

  5. We want to email users during the morning of their timezone

Note

For the emails to work you will need to have at least one email channel configured within https://github.com/edx/edx-ace