Note: You are currently viewing documentation for Moodle 3.0. Up-to-date documentation for the latest stable version of Moodle may be available here: Cohort sync.

Cohort sync

From MoodleDocs

About cohort sync

Cohort sync is for automatically enrolling members of a cohort in a course. If a user is added or removed from the cohort, they are automatically enrolled or unenrolled respectively. In other words, cohort sync synchronises cohort membership with course enrolment.

Enabling cohort sync

To use cohort sync, it must be enabled by an administrator in Site administration > Plugins > Enrolments > Manage enrol plugins.

Enrolling a cohort in a course

To enrol a cohort in a course

  1. Go to Course administration > Enrolment methods and select 'Cohort sync' in the dropdown menu.
  2. Choose the required cohort and then click the 'Add method' button.

Teachers can add cohorts to courses by default but a manager or admin can hide certain cohorts from teachers by unchecking the 'Visible' box in the Cohort settings or by clicking the 'eye' icon on the Cohorts screen.

enrolmentmethods29.png

Enrolling cohorts this way means that if members are added or removed from the cohort they are added or removed in the course too - ie, enrolment is synchronised.

cohort29.png

If several cohorts need to be added to the course, a button "Add method and create another" allows the teacher or course manager to quickly repeat the process without having to return to the main screen and start again.

cohortcreatenewgroup.png

When synchronising a cohort it is also possible to automatically add all cohort members to the group. A new group can also be created when adding the cohort.

Capabilities

The required capabilities for setting up a cohort sync are:

  • moodle/course:enrolconfig in the course context
  • enrol/cohort:config in the course context
  • moodle/cohort:view in the course context

The default "Teacher" (editingteacher) role has all these capabilities.

See also