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

Cohort sync: Difference between revisions

From MoodleDocs
m (rewrote the introduction)
(rewording intro)
Line 1: Line 1:
{{Enrolment}}
{{Enrolment}}
Cohorts enable all members of a cohort to be enrolled in a course in one action, either manually via the cohort sync process  and then synchronised automatically by adding or removing members of the cohort.
==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 syncronises cohort membership with course enrolment.
'''Note:''' 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.


==Enrolling a cohort in a course==
==Enrolling a cohort in a course==
Line 9: Line 8:


===Adding a whole cohort===
===Adding a whole cohort===
Available cohorts may be selected from ''Course administration>Enrolment methods'' and then selecting from the dropdown the  'Cohortsync' method
Available cohorts may be selected from ''Course administration>Enrolment methods'' and then selecting from the dropdown the  'Cohortsync' method.
 
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.


[[File:enrolmentmethods29.png|thumb|center|300px]]
[[File:enrolmentmethods29.png|thumb|center|300px]]

Revision as of 13:27, 14 April 2016

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 syncronises cohort membership with course enrolment.

Enrolling a cohort in a course

In order to actually enrol users from a Cohort into courses the Cohort-Sync Enrollment plugin needs to be added to the enrollment methods for the course. The Administrator will first need to enable the Cohort-Sync enrolment plugin site wide (Administration > Site administration > Plugins > Enrolments)

Adding a whole cohort

Available cohorts may be selected from Course administration>Enrolment methods and then selecting from the dropdown the 'Cohortsync' method.

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

Default "Teacher" (editingteacher) role has all these capabilities.

Adding cohort members

Cohort members may be enrolled from Course administration > Enrolled users and clicking the 'Enrol users' button, and then 'Browse cohorts'

newcohortenrol.png

Enrolling cohorts this way means that members may be removed individually from the course, ie, there is no cohort synchronisation.

The required capabilities for manually enrolling cohort members are:

  • enrol/manual:enrol in course context
  • moodle/course:enrolreview in course context

Default "Teacher" (editingteacher) role has all these capabilities.

Enrolling a cohort in a category

This is not supported by Moodle at the moment.

See MDL-36951 regarding enrolling system cohorts at category level

See Category enrolments where it is recommended that cohort sync be used in preference to category enrolments.

See also