-
Notifications
You must be signed in to change notification settings - Fork 84
docs: add ORA reminder notifications how-to #1446
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
sarina
merged 5 commits into
openedx:main
from
AhtishamShahid:docs/add-ora-reminders-how-to
May 8, 2026
+101
−2
Merged
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
da126a2
docs: add ORA reminder notifications how-to
AhtishamShahid fbebb8e
docs: address PR review feedback on ORA reminders how-to
AhtishamShahid 8728b59
fix: updated table headings
AhtishamShahid 435a70a
Apply suggestions from code review
sarina 652b1a0
Apply code review suggestions
sarina File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| .. _ora-reminder-notifications: | ||
|
|
||
| ORA Reminder Notifications | ||
| ########################## | ||
|
|
||
| .. tags:: site operator, how-to | ||
|
|
||
| ORA reminders send periodic nudges to learners who have submitted a response | ||
| but have not yet completed their required **peer** or **self** review steps. | ||
|
|
||
| Enabling | ||
| ******** | ||
|
|
||
| Set ``ENABLE_ORA_REMINDERS`` to ``True`` in your Django settings: | ||
|
|
||
| .. code-block:: python | ||
|
|
||
| ENABLE_ORA_REMINDERS = True | ||
|
|
||
| The notification type ``ora_reminder`` must also be registered in openedx-platform's | ||
| ``openedx.core.djangoapps.notifications.base_notification`` (already included | ||
| starting with Verawood release). | ||
|
|
||
| Configuration Settings | ||
| ********************** | ||
|
|
||
| All settings have sensible defaults and only need to be overridden when you | ||
| want non-default behaviour. | ||
|
|
||
| .. list-table:: | ||
| :header-rows: 1 | ||
| :widths: 35 10 55 | ||
|
|
||
| * - Setting | ||
| - Default | ||
| - Description | ||
| * - ``ORA_REMINDER_INITIAL_DELAY_HOURS`` | ||
| - ``0`` | ||
| - Hours after submission before the **first** reminder is sent. Gives | ||
| learners time to complete reviews on their own before being nudged. | ||
| * - ``ORA_REMINDER_INTERVAL_HOURS`` | ||
| - ``48`` | ||
| - Hours between consecutive reminders after the first one. | ||
| * - ``ORA_REMINDER_MAX_COUNT`` | ||
| - ``3`` | ||
| - Maximum number of reminders sent per learner per ORA submission. | ||
| Once this limit is reached the reminder row is deactivated. | ||
| * - ``ORA_REMINDER_SWEEP_INTERVAL_SECONDS`` | ||
| - ``1800`` | ||
| - How often (in seconds) the sweeper re-schedules itself. Each run | ||
| processes all rows whose ``next_reminder_at`` has passed. | ||
| * - ``ORA_REMINDER_SWEEP_BATCH_SIZE`` | ||
| - ``1000`` | ||
| - Maximum rows processed per sweep cycle. If more rows are due they | ||
| will be picked up on the next sweep. Rows are ordered oldest-first so | ||
| no reminder is permanently skipped. Increase this value for deployments | ||
| with a large number of concurrent active learners. | ||
| * - ``ORA_REMINDER_CHECK_AGAIN_HOURS`` | ||
| - ``12`` | ||
| - Hours to wait before re-checking when a peer-step reminder is due | ||
| but no peer submissions are available for the learner to review yet. | ||
| Prevents sending useless reminders to very early submitters. | ||
|
|
||
| To override these settings, create a Tutor plugin that patches the LMS | ||
| settings using the ``openedx-lms-common-settings`` | ||
| `patch <https://docs.tutor.edly.io/reference/patches/index.html>`_, | ||
| which applies to both production and development environments. | ||
|
|
||
| For example, create a file ``ora_reminders_plugin.py``: | ||
|
|
||
| .. code-block:: python | ||
|
|
||
| from tutor import hooks | ||
|
|
||
| hooks.Filters.ENV_PATCHES.add_item(( | ||
| "openedx-lms-common-settings", | ||
| """ | ||
| ORA_REMINDER_INITIAL_DELAY_HOURS = 48 | ||
| ORA_REMINDER_INTERVAL_HOURS = 72 | ||
| ORA_REMINDER_MAX_COUNT = 2 | ||
| """ | ||
|
sarina marked this conversation as resolved.
Outdated
|
||
| )) | ||
|
|
||
| Then install and enable it in your Tutor environment, according to the `Tutor documentation <https://docs.tutor.edly.io/reference/patches/index.html>`_. | ||
|
|
||
|
|
||
| **Maintenance chart** | ||
|
|
||
| +--------------+-------------------------------+----------------+--------------------------------+ | ||
| | Review Date | Reviewer | Release |Test situation | | ||
| +--------------+-------------------------------+----------------+--------------------------------+ | ||
| | 2026-05-05 | Ahtisham Shahid | Verawood | Pass | | ||
| +--------------+-------------------------------+----------------+--------------------------------+ | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.