Cohort sync: Difference between revisions

Latest revision as of 10:33, 20 March 2023

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.

The following video explains both Cohort sync and an alternative, Cohort enrolment method:

Cohorts: Bulk enrol

Enabling cohort sync

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

Cohort themes

If cohort themes have been enabled in the Theme settings page of Site administration, then a specific cohort theme may be selected when creating or editing the cohort:

Cohort badges

Site administrators may now award badges to members of cohorts.See the documentation Managing badges for more information.

Syncing a cohort to a course

To sync a cohort to a course

Note: in order for the 'Cohort sync' option to show up here, at least one Cohort must exist and be available at either the site level or the category level in the category the course is in. If there are no Cohorts available, then this option will not appear in the pull down list.

Go to Course administration > Enrolment methods and select 'Cohort sync' in the dropdown menu.
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.

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

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.

@@ Line 1: / Line 1: @@
 {{Enrolment}}
-Cohorts, or site-wide groups, enable all members of a cohort to be enrolled in a course in one action, either manually or synchronised automatically.
+==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.
-'''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.{{New features}}
+The following video explains both Cohort sync and an alternative, Cohort enrolment method:
+{{MediaPlayer | url = https://youtu.be/Vw5KZQELGgg | desc = Cohorts: Bulk enrol}}
-==Enrolling a cohort in a course==
+==Enabling cohort sync==
-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'')
+To use cohort sync, it must be enabled by an administrator in ''Site administration > Plugins > Enrolments > Manage enrol plugins''.
+==Cohort themes==
-===Adding a whole cohort===
+If cohort themes have been enabled in the Theme settings page of Site administration, then a specific cohort theme may be selected when creating or editing the cohort:
-Available cohorts may be selected from ''Course administration>Enrolment methods'' and then selecting from the dropdown the  'Cohortsync' method
-[[File:Cohortsync.png|thumb|center|400px]]
+[[File:Cohorttheme1.png|thumb|center|300px]]
-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.
+==Cohort badges==
-When synchronising a cohort it is also possible to automatically add all cohort members to the group:
+Site administrators may now award badges to members of cohorts.See the documentation [[Managing badges]] for more information.
-{|
+==Syncing a cohort to a course==
-|[[File:24cohortsync.png|thumb|Adding a cohort to a group]]
-|}
+To sync a cohort to a course
+Note: in order for the 'Cohort sync' option to show up here, at least one Cohort must exist and be available at either the site level or the category level in the category the course is in. If there are no Cohorts available, then this option will not appear in the pull down list.
+# Go to ''Course administration > Enrolment methods'' and select  'Cohort sync' in the dropdown menu.
+# Choose the required cohort and then click the 'Add method' button.
-The required capabilities for setting up a cohort sync are:
+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.
-* 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===
+[[File:enrolmentmethods29.png|thumb|center|300px]]
-{{New features}}
-Cohort members may be enrolled from ''Course administration>Enrolled users'' and clicking the 'Enrol users' button, and then 'Browse cohorts'
-[[File:newcohortenrol.png|thumb|center|400px]]
+Enrolling cohorts this way means that if members are added or removed from the cohort they are added or removed in the course too - i.e., enrolment is synchronised.
-Enrolling cohorts this way means that members may  be removed individually from the course, ie, there is no cohort synchronisation.
+{|
+|[[File:cohort29.png|thumb|center|500px]]
+|}
-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==
+[[File:cohortcreatenewgroup.png]]
-This is not supported by Moodle at the moment.
+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.
-See MDL-36951 regarding enrolling system cohorts at category level
+===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
-See [[Category enrolments]] where it is recommended that cohort sync be used in preference to category enrolments.
+The default "Teacher" (editingteacher) role has all these capabilities.
 ==See also==
@@ Line 55: / Line 58: @@
 [[es:Sincronización de cohorte]]
 [[ja:コーホート同期]]
+[[fr:Synchronisation de cohorte]]

Documentation