Enrolment method settings
    • 19 Oct 2022
    • 7 minutes to read

    Enrolment method settings


    Article Summary

    When configuring enrolment methods at the site level as a Site Administrator, you can change a number of site-wide default settings.

    Some of these settings can also be changed at the course level.

    Manual enrolment

    SettingDescriptionNotes

    Enrolment expiration action

    Specifies what happens when user enrolments reach expiration date. 

    Please note that the Unenrol user from course option purges grades, group memberships, preferences and other user-related data from the courses.

    Hour to send enrolment expiry notifications

    Specify hour for sending expiration notifications.

    -

    Add instance to new courses

    If this is enabled, then whenever a new course is created, manual enrolments will be automatically added to new courses.

    -

    Enable manual enrolments

    This specifies if enrol instances are enabled by default in new courses, it is strongly recommended to keep this setting enabled.

    -

    Default role

    This sets the default role, which is normally Learner, and may be altered by an Editing Trainer in a course.

    -

    Default enrolment start

    Set the time and date that Learners will be enrolled in a course. The default is Now, but it can also be set to Today, and Course start.

    -

    Default enrolment duration

    This sets the default length of enrolment in new courses.

    -

    Notify before enrolment expires

    Specifies if the Trainer (or optionally Learners) should be notified before the expiration.

    -

    Notification threshold

    Specify how many weeks, days, hours, minutes or seconds in advance users are notified before the enrolment expiration.

    -

    Self enrolment

    SettingDescriptionNotes

    Require an enrolment key

    If this box is ticked then all courses with self enrolment enabled will need to have an enrolment key. The setting won't save until the Trainer adds a key - this is something to be aware of as this can cause confusion.

    -

    Use password policy

    Tick this box if you want enrolment keys set by Trainers to follow the password policy of the site.

    -

    Show hint

    Tick this box if you are prepared to allow the first letter of a key to be given as a hint.

    -

    Enrolment expiration action

    Specifies what happens when user enrolments reach expiration date. Please note that the Unenrol user from course option purges grades, group memberships, preferences and other user-related data from the courses.

    -

    Hour to send enrolment expiry notifications

    Specify the hour for sending expiration notifications.

    -

    Add instance to new courses

    If the Site Administrator selects this, then any new course created will include the self enrolment plugin.

    -

    Allow existing enrolments

    Add the self enrolment method to new course.

    -

    Allow new enrolments

    Users can self enrol in new course by default.

    -

    Use group enrolment keys

    The setting for group enrolment keys in a course will be set to yes by default.

    -

    Default role assignment

    Normally, when users self enrol they have the Learner role. If necessary that role can be changed by default here, for example if your Totara has a dedicated role you wish to use instead.

    -

    Enrolment duration

    This sets the default enrolment length for new courses (but again, may be altered by the course Trainer).

    -

    Notify before enrolment expires

    Specifies if Trainers (or optionally Learners) should be notified before the expiration.

    -

    Notification threshold

    Specify how many days in advance should users be notified before the enrolment expiration.

    -

    Unenrol inactive after

    This sets the default time after which a learner will be unenrolled if they haven't accessed the courses (Trainers may change this).

    -

    Max enrolled users

    Adding a number here will specify the maximum number of users who can self enrol into new courses. Trainers in the course can change this. If it is left at 0, there will be no maximum.

    -

    Send course welcome message

    If this option is selected you can select the email address that the welcome message is shown as being sent from: 

    • Send as first contact marked as course contact: The user is set under Quick-access menu > Appearance > Courses > Course contact
    • Send as first enrolment key holder: The user that has the enrol/self:holdkey permission under Course administration > Users > Permissions
    • Send as no-reply address: The user that is set under the quick-access menu via Plugins > Message outputs > email > No-reply address

    If the welcome message for the self-enrolment plugin is set to be from the course contact but there are no course contacts enrolled or the role is not enabled, the message will instead come from the no-reply email address. The message should display as "Do not reply to this email" <noreply@1217.test> (the no-reply email address would be specific to your site).

    If the message is sent from the course contact and more than one user has this role, the email is sent from the first user to be assigned the role. If the user is assigned the role in the course context, this overrides any role in the system context. If no users are assigned to the role at the course context it will go to the next user with the role at the system context.

    Audience sync

    SettingDescriptionNotes

    Default role

    The role that will be assigned to members of the audience.

    By default this is the Learner role.

    External unenrol action

    When a user is no longer a member of the audience they will be unenrolled from any enrolled learning for the audience. You can choose whether to:

    • Unenrol the user from course: This will remove the user and delete most of their data from the course
    • Disable course enrolment and remove roles: Suspends the user enrolment whilst retaining user data such as activity grades from the course

    -

    Program enrolments

    SettingDescriptionNotes

    Add instance to new courses

    Add the program enrolment plugin to new courses.

    -

    Default role

    The role that will be assigned to users when enrolled in a program.

    -

    Enrolment duration

    Default length of time that the enrolment is valid (in seconds). If set to zero, the enrolment duration will be unlimited by default.

    -

    External unenrol action

    There are a few options:

    • Unenrol user from course: This will delete most of the user's data from the course.
    • Disable course enrolment: User enrolment is suspended (the user can't access the course, but user data and settings are kept) and roles are kept as is. You might use this because in some cases. the user needs a role with some capability to be visible in the user interface, such as in the gradebook, assignments, etc.
    • Disable course enrolment and remove roles: The enrolment is suspended and roles assigned by the program enrolment instance are removed. Please note that user may disappear from gradebook and other areas.

    -

    Flat file enrolment settings

    SettingDescriptionNotes

    File location

    You should specify an absolute path for the upload file where it can be read and modified by the web server process. The file is automatically deleted after processing. 

    -

    File encoding

    Make sure you save the file (for example in a text editor) with the same encoding.

    -

    Notify enrolled users

    You can choose to have an email sent to notify the Learners when the file has been processed.

    -

    Notify user responsible for enrolments

    You can choose to have an email sent to notify the Trainers when the file has been processed.

    -

    Notify administrator

    You can choose to have an email sent to notify the Site Administrator when the file has been processed.

    -

    External unenrol action

    Select action to carry out when user enrolment disappears from external enrolment source. There are a few options:

    • Unenrol user from course
    • Keep user enrolled
    • Disable course enrolment and remove role

    Please note that some user data and settings are purged from course during course unenrolment.

    Enrolment expiration action

    Select action to carry out when user enrolment expires, there are three options to choose from:

    • Keep user enrolled
    • Disable course enrolment and remove roles
    • Unenrol user from course

    Please note that some user data and settings are purged from course during course unenrolment.

    Flat file role mapping

    You can change the default role mappings (currently Moodle role short names) to Totara role short names.

    -

    Publish as LTI tool settings

    SettingDescriptionNotes

    Custom instance name

    The name to be given to the LTI instance once you publish it. This should be clear, concise and descriptive if possible.

    -

    Tool to be published

    Choose from the entire course or a particular activity.

    -

    Enrolment duration

    Length of time that the enrolment is valid, starting with the moment the user enrols themselves from the remote system. If disabled, the enrolment duration will be unlimited.

    -

    Start date

    If enabled, users can access from this date onward only.

    -

    End date

    If enabled, users can access until this date only.

    -

    Maximum enrolled users

    The maximum number of remote users who can access the tool. If set to zero, the number of enrolled users is unlimited.

    -

    Role for teacher

    The role assigned in the tool to the remote Trainer.

    -

    Role for student

    The role assigned in the tool to the remote Learner.

    -

    Secret

    A string of characters which is shared with the remote system (LTI consumer) to provide access to the tool.

    -

    Grade synchronisation

    Whether grades from the tool are sent to the remote system (LTI consumer).

    -

    Require course or activity completion prior to grade synchronisation

    You can decide if you want to require users to complete the activity/course before any grades are synced.

    -

    User synchronisation

    Whether a scheduled task synchronises enrolled users in the remote system with enrolments in this course, creating an account for each remote user as necessary, and enrolling or unenrolling them as required.

    If set to no, at the moment when a remote user accesses the tool, an account will be created for them and they will be automatically enrolled.

    -

    User synchronisation mode

    Whether remote users should be enrolled and/or unenrolled from this course.

    -

    User default values

    You can set the default user values including:

    • Email display
    • City/town
    • Country
    • Timezone
    • Preferred language
    • Institution

    -



    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.