Skip to content

Commit db0d940

Browse files
AhtishamShahidsarina
AhtishamShahid
and
sarina
authored
docs: add ORA reminder notifications how-to (#1446)
* docs: add ORA reminder notifications how-to Adds a new site operator how-to for configuring ORA reminder notifications, covering the enable flag and all configuration settings. Updates enable_notifications.rst to reference the new page. * docs: address PR review feedback on ORA reminders how-to - Fix RST label to use hyphenated form (ora-reminder-notifications) - Update edx-platform reference to openedx-platform, pinned to Verawood - Replace vague config example with Tutor plugin instructions using openedx-lms-common-settings patch, validated against official docs - Add reference link to Tutor patches documentation - Update maintenance charts for both files --------- Co-authored-by: Sarina Canelake <sarina@axim.org>
1 parent e995b4e commit db0d940

2 files changed

Lines changed: 101 additions & 2 deletions

File tree

‎source/site_ops/how-tos/enable_notifications.rst‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Enable Notifications
77

88
:ref:`Notifications <Notifications & Preferences>` keep you informed about activity in your
99
courses, alerting you via one or both of in-platform notifications and email notifications.
10-
They span activities such as Discussions updates, Course updates, and Grading updates.
10+
They span activities such as Discussions updates, Course updates, Grading updates, and ORA review reminders.
1111

1212
The **notification tray** allows learners to access platform notifications from
1313
the top-right corner of the Open edX interface. **Notification emails** keep them updated when
@@ -475,10 +475,16 @@ Why isn't my override working?
475475
* If a notification is marked as ``use_app_defaults: True`` in the code, it will ignore overrides in ``NOTIFICATION_TYPES_OVERRIDE``. You must override using ``NOTIFICATION_APPS_OVERRIDE`` instead.
476476

477477

478+
.. seealso::
479+
480+
:ref:`ora-reminder-notifications` — configure periodic nudges for learners who have not completed peer or self review steps in ORA assignments.
481+
478482
**Maintenance chart**
479483

480484
+--------------+-------------------------------+----------------+--------------------------------+
481-
| Review Date | Working Group Reviewer | Release |Test situation |
485+
| Review Date | Reviewer | Release |Test situation |
486+
+--------------+-------------------------------+----------------+--------------------------------+
487+
|2026-05-05 | Ahtisham Shahid | Verawood | Pass |
482488
+--------------+-------------------------------+----------------+--------------------------------+
483489
|2026-04-30 | Sara Burns | Verawood | Pass |
484490
+--------------+-------------------------------+----------------+--------------------------------+

‎source/site_ops/how-tos/ora_reminders.rst‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
.. _ora-reminder-notifications:
2+
3+
ORA Reminder Notifications
4+
##########################
5+
6+
.. tags:: site operator, how-to
7+
8+
ORA reminders send periodic nudges to learners who have submitted a response
9+
but have not yet completed their required **peer** or **self** review steps.
10+
11+
Enabling
12+
********
13+
14+
Set ``ENABLE_ORA_REMINDERS`` to ``True`` in your Django settings:
15+
16+
.. code-block:: python
17+
18+
ENABLE_ORA_REMINDERS = True
19+
20+
The notification type ``ora_reminder`` must also be registered in openedx-platform's
21+
``openedx.core.djangoapps.notifications.base_notification`` (already included
22+
starting with Verawood release).
23+
24+
Configuration Settings
25+
**********************
26+
27+
All settings have sensible defaults and only need to be overridden when you
28+
want non-default behaviour.
29+
30+
.. list-table::
31+
:header-rows: 1
32+
:widths: 35 10 55
33+
34+
* - Setting
35+
- Default
36+
- Description
37+
* - ``ORA_REMINDER_INITIAL_DELAY_HOURS``
38+
- ``0``
39+
- Hours after submission before the **first** reminder is sent. Gives
40+
learners time to complete reviews on their own before being nudged.
41+
* - ``ORA_REMINDER_INTERVAL_HOURS``
42+
- ``48``
43+
- Hours between consecutive reminders after the first one.
44+
* - ``ORA_REMINDER_MAX_COUNT``
45+
- ``3``
46+
- Maximum number of reminders sent per learner per ORA submission.
47+
Once this limit is reached the reminder row is deactivated.
48+
* - ``ORA_REMINDER_SWEEP_INTERVAL_SECONDS``
49+
- ``1800``
50+
- How often (in seconds) the sweeper re-schedules itself. Each run
51+
processes all rows whose ``next_reminder_at`` has passed.
52+
* - ``ORA_REMINDER_SWEEP_BATCH_SIZE``
53+
- ``1000``
54+
- Maximum rows processed per sweep cycle. If more rows are due they
55+
will be picked up on the next sweep. Rows are ordered oldest-first so
56+
no reminder is permanently skipped. Increase this value for deployments
57+
with a large number of concurrent active learners.
58+
* - ``ORA_REMINDER_CHECK_AGAIN_HOURS``
59+
- ``12``
60+
- Hours to wait before re-checking when a peer-step reminder is due
61+
but no peer submissions are available for the learner to review yet.
62+
Prevents sending useless reminders to very early submitters.
63+
64+
To override these settings, create a Tutor plugin that patches the LMS
65+
settings using the ``openedx-lms-common-settings``
66+
`patch <https://docs.tutor.edly.io/reference/patches/index.html>`_,
67+
which applies to both production and development environments.
68+
69+
For example, create a file ``ora_reminders_plugin.py``:
70+
71+
.. code-block:: python
72+
73+
from tutor import hooks
74+
75+
hooks.Filters.ENV_PATCHES.add_item((
76+
"openedx-lms-common-settings",
77+
"""
78+
ORA_REMINDER_INITIAL_DELAY_HOURS = 48
79+
ORA_REMINDER_INTERVAL_HOURS = 72
80+
ORA_REMINDER_MAX_COUNT = 2
81+
"""
82+
))
83+
84+
Then install and enable it in your Tutor environment, according to the `Tutor documentation <https://docs.tutor.edly.io/reference/patches/index.html>`_.
85+
86+
87+
**Maintenance chart**
88+
89+
+--------------+-------------------------------+----------------+--------------------------------+
90+
| Review Date | Reviewer | Release |Test situation |
91+
+--------------+-------------------------------+----------------+--------------------------------+
92+
| 2026-05-05 | Ahtisham Shahid | Verawood | Pass |
93+
+--------------+-------------------------------+----------------+--------------------------------+

0 commit comments

Comments
 (0)