ol-openedx-course-sync 1.0.0

An Open edX plugin to sync course changes to its reruns.

OL Open edX Course Sync

An Open edX plugin to sync course changes to its reruns.

Version Compatibility

It supports Open edX releases from Sumac and onwards.

Installing The Plugin

For detailed installation instructions, please refer to the plugin installation guide.

Installation required in:

• CMS (for course sync functionality)

• LMS (for problem attempts reset and rescore functionality)

Configuration

CMS Configuration

• Add a setting OL_OPENEDX_COURSE_SYNC_SERVICE_WORKER_USERNAME for the service worker and all the sync operations will be done on behalf of this user.

  • For Tutor, you can run:

    tutor config save --set OL_OPENEDX_COURSE_SYNC_SERVICE_WORKER_USERNAME={USERNAME}

  • If you have a private.py for the CMS settings, you can add it to cms/envs/private.py.

Usage

Course Sync (CMS)

• Install the plugin and run the migrations in the CMS.

• Add the parent/source organization in the CMS admin model CourseSyncOrganization.

  • Course sync will only work for this organization. It will treat all the courses under this organization as parent/source courses.

• The plugin will automatically add course re-runs created from the CMS as the child courses.

  • The organization can be different for the reruns.

• Target/rerun courses can be managed in the CMS admin model CourseSyncMapping.

• Now, any changes made in the source course will be synced to the target courses.

Problem Actions (LMS)

The plugin provides a management command to reset learner attempts or rescore problems across the source course and all its synced target courses.

Command: sync_problem_actions

Syntax:

python manage.py lms sync_problem_actions <action> <source_course_key> <problem_id> [OPTIONS]

Actions:

• reset_attempts: Resets learner attempts for a problem

• rescore: Rescores learners for a problem

Options:

• --username USERNAME: Username to run the task as (default: ‘courses_service_worker’)

• --only-if-higher / --no-only-if-higher: Whether to rescore only if the new score is higher (default: True)

Examples:

Reset attempts for a problem across all synced courses:

python manage.py lms sync_problem_actions reset_attempts \
    "course-v1:ORG+COURSE+RUN" \
    "block-v1:ORG+COURSE+RUN+type@problem+block@abc123" \
    --username courses_service_worker

Rescore a problem for all learners across all synced courses:

python manage.py lms sync_problem_actions rescore \
    "course-v1:ORG+COURSE+RUN" \
    "block-v1:ORG+COURSE+RUN+type@problem+block@abc123" \
    --username courses_service_worker \
    --only-if-higher