Difference between revisions of "Cohort sync"

Jump to: navigation, search

Note: You are currently viewing documentation for Moodle 3.2. Up-to-date documentation for the latest stable version of Moodle is probably available here: Cohort sync.

m (add-ons -> plugins name change)
 
(16 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
{{Enrolment}}
 
{{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''.
  
 
==Enrolling a cohort in a course==
 
==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'') and then add it to the required Course: (''Administration> Course administration > Users > Enrolment Methods'').
+
To enrol a cohort in a course
  
{|
+
# Go to ''Course administration > Enrolment methods'' and select  'Cohort sync' in the dropdown menu.
|[[File:Cohortsync.png|thumb|Adding  the cohort sync enrolment method]]
+
# Choose the required cohort and then click the 'Add method' button.
|}
 
  
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).
+
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.
  
==Adding a cohort to a group==
+
[[File:enrolmentmethods29.png|thumb|center|300px]]
  
The cohort members can be added to a pre-made group at this stage also if desired. If any  members are added or removed from the cohort, they are automatically added or removed from the group. Note that such members cannot be unenrolled manually from the groups screen and that additionally, there is information about their cohort below their name on the group 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.
  
 
{|
 
{|
|[[File:24cohortsync.png|thumb|Adding a cohort to a group]]
+
|[[File:cohort29.png|thumb|center|500px]]
 
|}
 
|}
  
 +
[[File:cohortcreatenewgroup.png]]
  
Visiting the ''Administration > Course administration > Users > Enrolled Users'' page will show users enrolled via the ''Cohort-Sync'' plugin.
+
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.
 
 
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.
 
  
 +
===Capabilities===
 
The required capabilities for setting up a cohort sync are:
 
The required capabilities for setting up a cohort sync are:
 
* moodle/course:enrolconfig in the course context
 
* 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==
 
 
 
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.
+
The default "Teacher" (editingteacher) role has all these capabilities.
  
 
==See also==
 
==See also==

Latest revision as of 11:37, 15 June 2017

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

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