Note: This documentation is for Moodle 2.7. For up-to-date documentation see Enrolment key.

Enrolment key: Difference between revisions

From MoodleDocs
(see also)
(updated screenshots)
 
(29 intermediate revisions by 12 users not shown)
Line 1: Line 1:
== About ==
{{Course enrolment}}
*A course enrollment key is what keeps unwanted people out of your course.
A course enrolment (or enrollment) key is one method of restricting [[Self enrolment]] to a smaller group. The default setting is not to set a key and allow anyone to enrol themselves into the course.
*If you leave this blank, then anyone who has created a Moodle username on this site will be able to enroll in your course simply by going in to it.
*If you put something here, then students who are trying to get in for the FIRST TIME ONLY will be asked to supply this word or phrase.
*The idea is that you will supply the key to authorized people using another means like private email, snail mail, on the phone or even verbally in a face to face class.
*If this password "gets out" and you have unwanted people enrolling, you can unenroll them (see their user profile page) and change this key. Any legitimate students who have already enrolled will not be affected, but the unwanted people won't be able to get back in.[[Image:Enrollmentkey.png|frame|right|only your students will know your enrollment key]]


== Function ==
An enrolment key is often used as a simple method of having someone else beside the teacher determine if a particular student can self enrol in the course. The idea is that one or more people will supply the course key to authorized people. Sometimes this distrubution is private email, snail mail, on the phone or even verbally in a face to face meetings such as a class or counselor's office.
The enrol(l)ment key is a Moodle setting that any teacher or admin user can set on a course by course basis. It is an integral security function that can control which Moodle site users are able to enrol(l) themselves as students in the course. To locate and use this setting:


# '''Login''' to Moodle as an admin or teacher
 
# '''Navigate''' to the desired course
==Setting an enrolment key within a course==
# Locate the '''Administration''' block and click on '''Settings'''
*In the course administration block, click ''Users>Enrolment methods''
# Scroll down and locate the '''Enrollment key''' form field
*Make sure self enrolment is enabled (has its eye open) and then click the edit icon on the right:
# Enter your desired key in the adjacent text field
 
# Scroll to the bottom of the page and click '''Save changes'''
[[File:enrolmentkeyupdated.png]]
 
*Add your enrolment key in the box provided. (Click ''Unmask'' to see what you are typing.)
[[File:selfenrolkey.png]]
 
*Click ''Save changes''
 
==Setting a group enrolment key==
*It is possible also to enrol students into the course and also directly into groups by use of a group enrolment key.
*To do this, you first need to add the course enrolment key as in the section above.
** If you do not set a master course enrolment key for the course, then anyone can enrol without a key and users will not be put into groups.
** Users in groups do not need to know the master course enrolment key, only their own group enrolment key.
** Users not in a group can use the master course enrolment key as usual
*Change the setting Use ''group enrolment keys'' to ''Yes''
*Save the changes and then in the Course administration settings, click ''Groups>Create groups
*Add an enrolment key to the group. This will be the key they type in to access the course. (The course enrolment key is simply there to keep others out)
 
''NOTE'': Be careful not to use the same enrolment key for more than one group as  this only causes confusion. Since the release of Moodle '''2.7.1''' a warning message will appear 'This enrolment key is already used for another group.'
 
**See also this screencast: Group enrolment keys in Moodle 2.0 [http://www.youtube.com/watch?v=4xzF7xerle0]
''
 
==Admin settings==
 
===Making an enrolment key required in every course===
*By default, enrolment keys are not set. However, if the administrator wants to ensure all teachers set enrolment keys then this can be forced in ''Administration>Site Administration>Plugins>Enrolments>Self enrolment'' This means that self enrolment settings will not "stick" until the teacher adds an enrolment key. '''NOTE''': It does NOT provide a site wide enrolment key.
 
===Using the password policy for enrolment keys===
*To ensure that teachers use secure keys that follow your Moodle's password policy, check the box in ''Administration>Site Administration>Plugins>Enrolments>Self enrolment''
 
===Giving users a hint of the enrolment key===
 
*By default, for security reasons,  Moodle will not give any clues as to what the enrolment key is. Checking the box in ''Administration>Site Administration>Plugins>Enrolments>Self enrolment'' will provide the first letter of the enrolment key if needed.
 
==Tips and Tricks==
 
*If the enrolment key for a course "gets out" and unwanted people self enrol:
**Change the key. Currently enrolled students will not need the key again.
**[[Unenrolment |Unenrol]] the unwanted users via [[Enrolled_users]] in the course administration block.
*Changing or placing a key does not impact currently enrolled students, nor does it impact students who may also be enrolled by an [[Enrolment plugins|enrolment plugin]].
* Guests may (optionally) be required to supply the enrolment key (as specified on the Course Settings page). They will be required to supply the code '''every time''' they enter the course.
* The "No" or "Date range" options in the "Course available" setting effectively disables the enrolment key feature, even if it is set.


==See also==
==See also==


*Tracker report [http://tracker.moodle.org/browse/MDL-10585 MDL-10585 Very difficult to control who is the teacher named on the 'you need an enrolment key from' page]
* [http://www.youtube.com/user/UsingMoodle?feature=mhum#p/u/0/4xzF7xerle0 Group enrolment keys in Moodle 2.0 video]
 
[[Category:Teacher]]
[[Category:Enrolment]]


[[de:Einschreibeschlüssel]]
[[fr:Clef d'inscription]]
[[fr:Clef d'inscription]]
[[pl:Klucz rekrutacyjny]]
[[ja:登録キー]]
[[es:Clave de inscripción]]

Latest revision as of 13:50, 7 November 2014

A course enrolment (or enrollment) key is one method of restricting Self enrolment to a smaller group. The default setting is not to set a key and allow anyone to enrol themselves into the course.

An enrolment key is often used as a simple method of having someone else beside the teacher determine if a particular student can self enrol in the course. The idea is that one or more people will supply the course key to authorized people. Sometimes this distrubution is private email, snail mail, on the phone or even verbally in a face to face meetings such as a class or counselor's office.


Setting an enrolment key within a course

  • In the course administration block, click Users>Enrolment methods
  • Make sure self enrolment is enabled (has its eye open) and then click the edit icon on the right:

enrolmentkeyupdated.png

  • Add your enrolment key in the box provided. (Click Unmask to see what you are typing.)

selfenrolkey.png

  • Click Save changes

Setting a group enrolment key

  • It is possible also to enrol students into the course and also directly into groups by use of a group enrolment key.
  • To do this, you first need to add the course enrolment key as in the section above.
    • If you do not set a master course enrolment key for the course, then anyone can enrol without a key and users will not be put into groups.
    • Users in groups do not need to know the master course enrolment key, only their own group enrolment key.
    • Users not in a group can use the master course enrolment key as usual
  • Change the setting Use group enrolment keys to Yes
  • Save the changes and then in the Course administration settings, click Groups>Create groups
  • Add an enrolment key to the group. This will be the key they type in to access the course. (The course enrolment key is simply there to keep others out)

NOTE: Be careful not to use the same enrolment key for more than one group as this only causes confusion. Since the release of Moodle 2.7.1 a warning message will appear 'This enrolment key is already used for another group.'

    • See also this screencast: Group enrolment keys in Moodle 2.0 [1]

Admin settings

Making an enrolment key required in every course

  • By default, enrolment keys are not set. However, if the administrator wants to ensure all teachers set enrolment keys then this can be forced in Administration>Site Administration>Plugins>Enrolments>Self enrolment This means that self enrolment settings will not "stick" until the teacher adds an enrolment key. NOTE: It does NOT provide a site wide enrolment key.

Using the password policy for enrolment keys

  • To ensure that teachers use secure keys that follow your Moodle's password policy, check the box in Administration>Site Administration>Plugins>Enrolments>Self enrolment

Giving users a hint of the enrolment key

  • By default, for security reasons, Moodle will not give any clues as to what the enrolment key is. Checking the box in Administration>Site Administration>Plugins>Enrolments>Self enrolment will provide the first letter of the enrolment key if needed.

Tips and Tricks

  • If the enrolment key for a course "gets out" and unwanted people self enrol:
    • Change the key. Currently enrolled students will not need the key again.
    • Unenrol the unwanted users via Enrolled_users in the course administration block.
  • Changing or placing a key does not impact currently enrolled students, nor does it impact students who may also be enrolled by an enrolment plugin.
  • Guests may (optionally) be required to supply the enrolment key (as specified on the Course Settings page). They will be required to supply the code every time they enter the course.
  • The "No" or "Date range" options in the "Course available" setting effectively disables the enrolment key feature, even if it is set.

See also