Note: You are currently viewing documentation for Moodle 1.9. Up-to-date documentation for the latest stable version is available here: Enrolment key.

Enrolment key: Difference between revisions

From MoodleDocs
(see also)
(Addition for 2+ method)
 
(12 intermediate revisions by 6 users not shown)
Line 1: Line 1:
== About ==
A course enrolment (or enrollment) key is one method to restrict [[Internal enrolment]] (student self enrolments) to a smaller group. The default setting is not to set a key.
*A course enrollment key is what keeps unwanted people out of your 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
== Setting an enrolment key (up until Moodle 1.9)==
# '''Navigate''' to the desired course
The enrolment key is a Moodle setting that any teacher or admin user can set on a course by course basis.
# Locate the '''Administration''' block and click on '''Settings'''
 
# Scroll down and locate the '''Enrollment key''' form field
To locate and use this setting:
# Enter your desired key in the adjacent text field
 
# Scroll to the bottom of the page and click '''Save changes'''
# Login to Moodle as an admin or teacher
# Navigate to the desired course
# Locate the Course Administration block  
# Click on Settings in that block
# Scroll down and locate the Enrolment key field
# Enter the key in the adjacent text field ("bratwurst" in the example)
# Scroll to the bottom of the page and click "Save changes"
 
[[Image:Enrollmentkey.png|frame|center|The enrolment key area in course settings]]
 
== Setting an enrolment key (Moodle 2+)==
See https://docs.moodle.org/en/Course_settings#Enrolments
 
==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 [[Assign roles]] 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.
* In Moodle 1.8.3 onwards, you can control who is named as supplying the key in the [[Internal enrolment]] settings.
* In Moodle 1.9.3 onwards, the enrolment key hint may be disabled in the [[Internal enrolment]] settings.
* In Moodle 1.9.4 onwards, enrolment key usage and/or complexity may be enforced in the [[Internal enrolment]] settings.


==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]
*[[Internal enrolment]] - to set the role of the people who hold the course enrolment key
*[[Create group]] - for information on setting group enrolment keys
*[[Keyholder role]] - for an administrator to set the person named as holding the course enrolment key
 


[[Category:Teacher]]
[[Category:Teacher]]
Line 24: Line 44:


[[fr:Clef d'inscription]]
[[fr:Clef d'inscription]]
[[pl:Klucz rekrutacyjny]]
[[ja:登録キー]]

Latest revision as of 23:02, 18 March 2011

A course enrolment (or enrollment) key is one method to restrict Internal enrolment (student self enrolments) to a smaller group. The default setting is not to set a key.

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 (up until Moodle 1.9)

The enrolment key is a Moodle setting that any teacher or admin user can set on a course by course basis.

To locate and use this setting:

  1. Login to Moodle as an admin or teacher
  2. Navigate to the desired course
  3. Locate the Course Administration block
  4. Click on Settings in that block
  5. Scroll down and locate the Enrolment key field
  6. Enter the key in the adjacent text field ("bratwurst" in the example)
  7. Scroll to the bottom of the page and click "Save changes"
The enrolment key area in course settings

Setting an enrolment key (Moodle 2+)

See https://docs.moodle.org/en/Course_settings#Enrolments

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 Assign roles 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.
  • In Moodle 1.8.3 onwards, you can control who is named as supplying the key in the Internal enrolment settings.
  • In Moodle 1.9.3 onwards, the enrolment key hint may be disabled in the Internal enrolment settings.
  • In Moodle 1.9.4 onwards, enrolment key usage and/or complexity may be enforced in the Internal enrolment settings.

See also

  • Internal enrolment - to set the role of the people who hold the course enrolment key
  • Create group - for information on setting group enrolment keys
  • Keyholder role - for an administrator to set the person named as holding the course enrolment key