Cohort sync: Difference between revisions

Latest revision as of 06:55, 2 February 2015

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.

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 feature
in Moodle 2.8!

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

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:

Adding a cohort to a group

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

New feature
in Moodle 2.8!

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

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.

@@ 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.
+'''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}}
 ==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'').
+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'')
-[[File:Cohortsync.png]]
+===Adding a whole cohort===
+Available cohorts may be selected from ''Course administration>Enrolment methods'' and then selecting from the dropdown the  'Cohortsync' method
-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:Cohortsync.png|thumb|center|400px]]
-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.
+When synchronising a cohort it is also possible to automatically add all cohort members to the group:
+{|
+|[[File:24cohortsync.png|thumb|Adding a cohort to a group]]
+|}
 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
+Default "Teacher" (editingteacher) role has all these capabilities.
+===Adding cohort members===
+{{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 members may  be removed individually from the course, ie, there is no cohort synchronisation.
 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
+Default "Teacher" (editingteacher) role has all these capabilities.
 ==Enrolling a cohort in a category==
-See [[Category enrolments]] where it is recommended that cohort sync be used in preference to cohort enrolments.
+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==
 * [[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:コーホート同期]]

Documentation