Cohort sync: Difference between revisions

Latest revision as of 09:25, 27 November 2019

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.

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.

Enrolling a cohort in a course

To enrol a cohort in 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 - ie, 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.
+==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:
+[[File:Cohorttheme1.png|thumb|center|300px]]
+==Cohort badges==
+Site administrators may now award badges to members of cohorts.See the documentation [[Managing badges]] for more information.
 ==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 (''Settings > Site administration > Plugins > Enrolments'') and then add it to the required Course: (''Settings > Course administration > Users > Enrolment Methods'').
+To enrol a cohort in 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.
-[[File:Cohortsync.png]]
+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.
-At this stage the ''Cohort-Sync'' instance for the course is edited and the appropriate Cohort selected. The role to which the Cohort users are assigned is also selected at this point (typically Student).
+[[File:enrolmentmethods29.png|thumb|center|300px]]
-Visiting the ''Settings > Course administration > Users > Enrolled Users'' page will show users enrolled via the ''Cohort-Sync'' plugin.
+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.
-Note that, by default, a teacher cannot add this plugin to their course. It needs to be configured by an Administrator or a user with the Manager role. Also note, that the user should be a Manager on a site level, not on the category or course level, otherwise the user will not see the option. If you want the user with the Manager role on the category level to see this enrol option, then you must add some cohorts on the category level, not on the site level.
+{|
+|[[File:cohort29.png|thumb|center|500px]]
+|}
+[[File: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
-* moodle/cohort:config in the course context
+* enrol/cohort:config in the course context
-* moodle/cohort:view in the same context as category
+* moodle/cohort:view in the course context
-The required capabilities for manually enrolling cohort members are:
-* the same as cohort sync (note: this is a bug MDL-28431)
-* enrol/manual:enrol in course context
-* moodle/course:enrolreview in course context
-==Enrolling a cohort in a category==
+The default "Teacher" (editingteacher) role has all these capabilities.
-See [[Category enrolments]] where it is recommended that cohort sync be used in preference to category enrolments.
 ==See also==
 * [[Cohorts]] for information on how to create a cohort
+* [https://moodle.org/plugins/view.php?plugin=enrol_groupsync Enrolment: Cohort members to group] plugin for users already enrolled via different method
 [[de:Einschreibung über globale Gruppen]]
+[[es:Sincronización de cohorte]]
 [[ja:コーホート同期]]
+[[fr:Synchronisation de cohorte]]

Documentation