Difference between revisions of "Assign roles"

Jump to: navigation, search

Note: You are currently viewing documentation for Moodle 3.3. Up-to-date documentation for the latest stable version of Moodle is probably available here: Assign roles.

m (Czech link)
(updating)
 
(52 intermediate revisions by 13 users not shown)
Line 1: Line 1:
 
{{Roles}}
 
{{Roles}}
 +
==Context and roles==
  
==Locations that assign roles==
+
*Apart from the manager and course creator, users do not normally have a site-wide (or system) role. Even though you may be a teacher offline, when you are in Moodle you could have a teacher role in the course you teach in but a student role in another course where you are studying for a diploma.
 +
*Because of the way Moodle works, assigning roles is done for a particular context. A site and course are examples of two different contexts. When you create a new role or tweak a pre-existing role via ''Administration > Site Administration > Users > Permissions > Define roles'', you are asked in which context(s) you want the role to be assigned:
 +
[[File:rolecontexttypes.png]]
  
[[Image:Assign roles.png|thumb|Assign roles in Moodle 1.9]]
+
*Here are some examples of contexts; how to get to the assign roles screen, and when/why you would assign roles here:
Assigning roles is done for/in a particular context. A site and course are examples of two different contexts.  While the process is similar for each context, the approach to role assignment page may be different.  Here are several contexts and ways to find the assign roles.
 
  
*System context: ''Administration > Users > Permissions > Assign global roles'' (this context is named "site" in Moodle 1.7)
+
===System context===
*Site context: ''Administration > Front Page > Front Page roles'' (from Moodle 1.8 onwards)
 
*Course category context: Assign roles link in course categories page
 
*Course context: Assign roles link in course administration block
 
*Module context: Roles tab in editing activity page
 
*Block context: Assign roles link in course block (editing on)
 
*User context: Roles tab in user profile page
 
  
{{Moodle 1.9}}In Moodle 1.9 onwards, the assign roles page lists the names of users assigned to each role (unless there are more than 10 users, in which case this is stated).
+
To assign a role in the system context, go to 'Assign system roles' in the Site administration.
  
==Contexts==
+
Any roles assigned here apply across the whole site. It makes sense therefore that only roles that need this functionality can be assigned here. The [[Manager]] role and [[Course creator]] role are examples of two such roles. Assigning a teacher or student here would result in their being able to teach/study in every single course on the site, which is not usually desirable.
 +
 
 +
=====Assigning system roles by CSV=====
 +
 
 +
Where certain custom roles are applied in the system context, it is possible to upload users to that role in bulk by adding the field ''sysrole1'' (etc) to a CSV file.
 +
 
 +
[[File:GlobalRoles1.png|thumb|500px|center|sysrole column]]
 +
 
 +
When previewed, there is a column indicating their system role:
 +
 
 +
[[File:GlobalRoles2.png|thumb|center|500px|Preview screen]]
 +
 
 +
Once uploaded, the users are present on the 'Assign system roles' screen:
 +
 
 +
[[File:GlobalRoles3.png|thumb|center|500px|Assign system roles screen]]
 +
 
 +
See [[Upload users]] for information on adding users to roles via CSV.
 +
 
 +
===Front page context===
 +
*''Administration > Site Administration > Front Page>Users>Permissions>Assigned roles
 +
*Those with a role in the system context do not need to be assigned a role here as well.
 +
*However you might want to allow a teacher to manage items on the front page; in this instance, you would assign them the role on the Front page.
 +
 
 +
===Course Category context===
 +
*See [[Category enrolments]]
 +
*Users may be enrolled in the category to save enrolling them in each individual course in that category.
 +
 
 +
===Course context===
 +
[[File:enrolusers.png|thumb|Enrol users]]
 +
* Go to ''Administration > Course administration > Enrolled users''
 +
* Click the "Enrol users" button and click those users you wish to enrol
 +
 
 +
The dropdown menu at the top shows roles for which you are allowed to enrol; typically those users with lower roles than you. See [[Enrolled users]] for more details.
 +
 
 +
===Block context===
 +
*(Within the block) ''Administration > Assign roles''
 +
*You may wish to assign roles to a block if, for instance you want specific people to see the block but for it to be hidden from others
 +
 
 +
=== Activity Module context===
 +
*(Within the activity settings) ''Administration > Locally assigned roles''
 +
*An example of this is assigning a student the teacher role locally in an individual activity like a forum so they can moderate their classmates' posts while still retaining the student role in the rest of the course.
 +
 
 +
===User context===
 +
 
 +
The user context is used for roles such as mentor, team leader or the [[Parent role]]. The role to be assigned must have 'User' ticked as the context type where it is to be assigned.
 +
 
 +
To assign a user the role of mentor in the context of their mentee, click the mentee's profile, then Preferences then 'Assign roles relative to this user'.
 +
 
 +
If a mentor has lots of mentees, the role of mentor can be assigned to them all in one go as follows:
 +
 
 +
# Put all mentees in a cohort
 +
# Go to ''Site administration > Users > Permissions > Assign user roles to cohort''
 +
 
 +
==Hierarchy==
  
 
By assigning a role to a user in a certain context, you grant them the permissions contained in that role for the current context and all lower contexts.
 
By assigning a role to a user in a certain context, you grant them the permissions contained in that role for the current context and all lower contexts.
Line 23: Line 72:
  
 
*System (no parent)
 
*System (no parent)
*Site (parent = system) - Moodle 1.8 onwards
+
*Front page (parent = system) -  
*Course category (parent = system)
+
*Course category (parent = parent category or system)
 
*Course (parent = category or system)
 
*Course (parent = category or system)
*Module (parent = course or system/site(1.8 onwards))
+
*Module (parent = course or system)  
*Block (parent = course or system/site(1.8 onwards))
+
*Block (parent = course or system)
 
*User (parent = system)
 
*User (parent = system)
  
Inheritance will kick in if a role is assigned at a higher level. For example if a user is assigned a Teacher role in a particular course category then the user will have this role in ALL courses within the category.
+
Roles can be inherited. For example if a user is assigned a Teacher role in a specific course category then the user will have this role in ALL courses within the category. Tip: use the override feature in a specific context for exceptions.
  
Roles will only work if the role assignment is made in the correct context. For example, a Teacher role should be assigned in the course or course category context, a Forum moderator for a particular forum should be assigned in the module context.
+
Roles will only work if the role assignment is made in the correct context. Some examples: a Teacher role should be assigned to a user in the course or course category context, a Forum moderator for a particular forum should be assigned in that specific forum.
  
The [[Inspector role]] is an example of a role assigned in the system context. The [[Forum moderator role]] is an example of a role assigned in the module context. The [[Parent role]] is an example of a role assigned in the user context.
+
==Assigning someone the role of Site administrator==
  
==Assigning a role==
+
*Site administrators are assigned via a special page: ''Administration > Site Administration > Users > Permissions > Site Administrators''. Select the name from the right and move it over to the left:
 +
[[File:managesiteadmins.png]]
 +
*The original (primary) administrator cannot be deleted.
  
[[Image:Roles Assign Student.JPG|thumb|Assigning users the role of student i.e. enrolling them on the course]]"Student", "Teacher", "Course Creator" are some of the predefined roles that come with Moodle. The site administrator may have created additional roles.
+
==Checking a user's role assignments==
To assign a role:
 
#Choose the type of role you wish to assign. For example, if we wanted to assign a Student role to Martin, we'd choose "Student" from the list of roles.
 
#Once you have chosen a role, two lists appear: a list of users who currently have that role (Student Demo in the example), and a list of users who don't. We can select Martin in the second list, and use the left-facing arrow button to add Martin to the list of Students. Multiple users may be selected by holding down the Apple or Ctrl key whilst clicking on the users' names.
 
  
Removing someone from a role is done by moving the user from the left column to the right.
+
To check a user's role assignments go to their profile page, then under the Administration heading, click on 'Preferences'. On the Preferences page, under the 'Roles' heading click on 'This user's role assignments'.
  
==Hidden assignments==
+
==Hidden roles==
  
To hide which role a user is assigned to, click the Hidden assignments check box before assigning the role to the user. This feature is useful for example if you don't want everyone with teacher rights listed in the course description.
+
If you want to provide users with access to the course, but don't want them to be visible in the participants list, use the [[Other users]] link in the course administration menu (''Administration > Course Administration > Users > Other Users''). Assigning roles here provides course access, and editing rights according to the permissions set for the role assigned without actually enrolling the user in the course. This is similar to the functionality of the "hidden user" check box in previous versions of Moodle.
  
Note: The role assignment is not hidden from admins or teachers i.e. users with the [[Capabilities/moodle/role:viewhiddenassigns|viewhiddenassigns capability]].
+
Note: By default, the only role which can be assigned to other users is the manager role. To enable other roles, such as teacher to be assigned, the capability [[Capabilities/moodle/course:view|moodle/course:view]] should be allowed for the role (see below).
  
 
==Enabling teachers to assign the role of teacher==
 
==Enabling teachers to assign the role of teacher==
Line 55: Line 103:
 
By default, teachers are only allowed to assign the roles of non-editing teacher, student and guest. To enable teachers to assign the role of teacher:
 
By default, teachers are only allowed to assign the roles of non-editing teacher, student and guest. To enable teachers to assign the role of teacher:
  
#Access ''Administration > Users > Permissions > Define roles''.
+
#Access ''Site Administration > Users > Permissions > Define roles''.
 
#Click the tab "Allow role assignments".
 
#Click the tab "Allow role assignments".
 
#Click the checkbox where the teacher row and column intersect.
 
#Click the checkbox where the teacher row and column intersect.
Line 62: Line 110:
 
==Beware of assignments that don't make sense==
 
==Beware of assignments that don't make sense==
  
There are many role assignments that do not make sense as the underlying functionality does not exist. Just because you give someone the "right" to do something does not guarantee that the interface or facility actually exists within the context that you have assigned that right. For example, you can assign a user the right to create new categories at the Category context, however there is no interface within Moodle to do that (category creation is only available at the site level).  
+
There are many role assignments that do not make sense as the underlying functionality does not exist. Just because you give someone the "right" to do something does not guarantee that the interface or facility actually exists within the context that you have assigned that right. For example, you can assign a user the right to create new categories in the category context. However there is no interface within Moodle to do that (category creation is only available at the system level).
  
 
==Multiple assignments==
 
==Multiple assignments==
  
A significant part of the roles infrastructure is the ability to assign a user into multiple roles (at the same time). The capabilities of each role are merged to produce the effective set of capabilities. In particular it is perfectly possible for a user to be both a Teacher and Student in the same course. This differs from the behavior of Moodle prior to the introduction of roles. You should be careful to ensure that if you change a user's role that you remove them from any other roles as required as this will no longer be done automatically.
+
A significant part of the roles infrastructure is the ability to assign a user into multiple roles (at the same time). The capabilities of each role are merged to produce the effective set of capabilities. For example, a user could be both a Teacher and Student in the same course. You should be careful to ensure that if you change a user's role that you remove them from any other roles as required as this will no longer be done automatically.
  
==Global roles==
+
==See also==
 
+
*[[Creating custom roles]]
Roles assigned in the site (1.7) or system context (1.8 onwards) are called global roles and apply across the entire site, including the front page. For example, a user assigned the global role of Teacher will have this role in every course on the site.
+
*[[Enrolment]]
 
+
*[[Managing roles]] - for administrators
In many sites only admins and course creators will be assigned global roles.
+
*[[Useful things a teacher can do with roles]]
 
 
The [[Demo teacher role|Demo teacher]] Restricted user role is an example of a global role.
 
  
==Front page roles==
+
Using Moodle forum discussions:
 
+
*[http://moodle.org/mod/forum/discuss.php?d=59900 Discrepancies between Assign Roles lists and Participants list]
You can assign roles and set up role overrides for your front page in exactly the same way as for a course.
+
*[http://moodle.org/mod/forum/discuss.php?d=66782 What happens if a user has multiple roles in a course?]
 
 
To enable users to engage in front page activities, you need to either assign all users the front page role of student or set up authenticated user overrides. For example, if you want users to be able to view forum discussions and reply to posts, you can override the authenticated user role and allow these permissions.
 
 
 
==See also==
 
*[[Manage roles]] - for administrators
 
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=59900 Discrepancies between Assign Roles lists and Participants list] and [http://moodle.org/mod/forum/discuss.php?d=66782 What happens if a user has multiple roles in a course?] forum discussions
 
  
[[Category:Teacher]]
 
 
[[Category:Roles]]
 
[[Category:Roles]]
  
[[cs:Přidělení rolí]]
+
[[de:Rollen zuweisen]]
 
[[es:Asignar_roles]]
 
[[es:Asignar_roles]]
[[fr:Attribuer des rôles]]
+
[[eu:Rolak_esleitu]]
 +
[[fr:Attribution des rôles]]
 
[[ja:ロールの割り当て]]
 
[[ja:ロールの割り当て]]
[[ru:Назначение ролей]]
 

Latest revision as of 13:56, 30 August 2017


Context and roles

  • Apart from the manager and course creator, users do not normally have a site-wide (or system) role. Even though you may be a teacher offline, when you are in Moodle you could have a teacher role in the course you teach in but a student role in another course where you are studying for a diploma.
  • Because of the way Moodle works, assigning roles is done for a particular context. A site and course are examples of two different contexts. When you create a new role or tweak a pre-existing role via Administration > Site Administration > Users > Permissions > Define roles, you are asked in which context(s) you want the role to be assigned:

rolecontexttypes.png

  • Here are some examples of contexts; how to get to the assign roles screen, and when/why you would assign roles here:

System context

To assign a role in the system context, go to 'Assign system roles' in the Site administration.

Any roles assigned here apply across the whole site. It makes sense therefore that only roles that need this functionality can be assigned here. The Manager role and Course creator role are examples of two such roles. Assigning a teacher or student here would result in their being able to teach/study in every single course on the site, which is not usually desirable.

Assigning system roles by CSV

Where certain custom roles are applied in the system context, it is possible to upload users to that role in bulk by adding the field sysrole1 (etc) to a CSV file.

sysrole column

When previewed, there is a column indicating their system role:

Preview screen

Once uploaded, the users are present on the 'Assign system roles' screen:

Assign system roles screen

See Upload users for information on adding users to roles via CSV.

Front page context

  • Administration > Site Administration > Front Page>Users>Permissions>Assigned roles
  • Those with a role in the system context do not need to be assigned a role here as well.
  • However you might want to allow a teacher to manage items on the front page; in this instance, you would assign them the role on the Front page.

Course Category context

  • See Category enrolments
  • Users may be enrolled in the category to save enrolling them in each individual course in that category.

Course context

Enrol users
  • Go to Administration > Course administration > Enrolled users
  • Click the "Enrol users" button and click those users you wish to enrol

The dropdown menu at the top shows roles for which you are allowed to enrol; typically those users with lower roles than you. See Enrolled users for more details.

Block context

  • (Within the block) Administration > Assign roles
  • You may wish to assign roles to a block if, for instance you want specific people to see the block but for it to be hidden from others

Activity Module context

  • (Within the activity settings) Administration > Locally assigned roles
  • An example of this is assigning a student the teacher role locally in an individual activity like a forum so they can moderate their classmates' posts while still retaining the student role in the rest of the course.

User context

The user context is used for roles such as mentor, team leader or the Parent role. The role to be assigned must have 'User' ticked as the context type where it is to be assigned.

To assign a user the role of mentor in the context of their mentee, click the mentee's profile, then Preferences then 'Assign roles relative to this user'.

If a mentor has lots of mentees, the role of mentor can be assigned to them all in one go as follows:

  1. Put all mentees in a cohort
  2. Go to Site administration > Users > Permissions > Assign user roles to cohort

Hierarchy

By assigning a role to a user in a certain context, you grant them the permissions contained in that role for the current context and all lower contexts.

The list of contexts in hierarchical order is as follows:

  • System (no parent)
  • Front page (parent = system) -
  • Course category (parent = parent category or system)
  • Course (parent = category or system)
  • Module (parent = course or system)
  • Block (parent = course or system)
  • User (parent = system)

Roles can be inherited. For example if a user is assigned a Teacher role in a specific course category then the user will have this role in ALL courses within the category. Tip: use the override feature in a specific context for exceptions.

Roles will only work if the role assignment is made in the correct context. Some examples: a Teacher role should be assigned to a user in the course or course category context, a Forum moderator for a particular forum should be assigned in that specific forum.

Assigning someone the role of Site administrator

  • Site administrators are assigned via a special page: Administration > Site Administration > Users > Permissions > Site Administrators. Select the name from the right and move it over to the left:

managesiteadmins.png

  • The original (primary) administrator cannot be deleted.

Checking a user's role assignments

To check a user's role assignments go to their profile page, then under the Administration heading, click on 'Preferences'. On the Preferences page, under the 'Roles' heading click on 'This user's role assignments'.

Hidden roles

If you want to provide users with access to the course, but don't want them to be visible in the participants list, use the Other users link in the course administration menu (Administration > Course Administration > Users > Other Users). Assigning roles here provides course access, and editing rights according to the permissions set for the role assigned without actually enrolling the user in the course. This is similar to the functionality of the "hidden user" check box in previous versions of Moodle.

Note: By default, the only role which can be assigned to other users is the manager role. To enable other roles, such as teacher to be assigned, the capability moodle/course:view should be allowed for the role (see below).

Enabling teachers to assign the role of teacher

By default, teachers are only allowed to assign the roles of non-editing teacher, student and guest. To enable teachers to assign the role of teacher:

  1. Access Site Administration > Users > Permissions > Define roles.
  2. Click the tab "Allow role assignments".
  3. Click the checkbox where the teacher row and column intersect.
  4. Click the "Save changes" button.

Beware of assignments that don't make sense

There are many role assignments that do not make sense as the underlying functionality does not exist. Just because you give someone the "right" to do something does not guarantee that the interface or facility actually exists within the context that you have assigned that right. For example, you can assign a user the right to create new categories in the category context. However there is no interface within Moodle to do that (category creation is only available at the system level).

Multiple assignments

A significant part of the roles infrastructure is the ability to assign a user into multiple roles (at the same time). The capabilities of each role are merged to produce the effective set of capabilities. For example, a user could be both a Teacher and Student in the same course. You should be careful to ensure that if you change a user's role that you remove them from any other roles as required as this will no longer be done automatically.

See also

Using Moodle forum discussions: