Note: You are currently viewing documentation for Moodle 2.0. Up-to-date documentation for the latest stable version is available here: Managing roles.

Managing roles: Difference between revisions

From MoodleDocs
(adding and testing a new role re-write, example roles link)
(Manage roles, Allow role assignments, Allow role overrides, Allow role switches)
 
(70 intermediate revisions by 17 users not shown)
Line 1: Line 1:
{{Roles}}
{{Roles}}
{{Moodle 1.7}}
An administrator can manage roles in  ''Settings > Site administration > Users > Permissions > Define roles''.


Location: ''Administration > Users > Permissions > Define roles''
==Manage roles==


From Moodle 1.7 onwards administrators may choose to add or edit roles.
The 'Manage roles' tab contains a list of roles on your site. The edit column contains icons for editing, deleting roles and copying roles, and for moving them up or down in the list (affecting the way that roles are listed around Moodle).


==Predefined roles==
[[Image:Manageroles2.png]]


Moodle comes with 7 predefined roles:
To edit a role:
#Go to ''Settings > Site administration > Users > Permissions > Define roles''.
#Click the edit icon opposite the role you want to edit e.g. student.
#On the edit role page, change permissions as required for each capability.
#Scroll to the bottom of the page and click the "Save changes" button.


*Administrator
See [[Creating custom roles]] for information about adding a new role.
*[[Course creator]]
*[[Teacher]]
*Non-editing teacher
*[[Student]]
*[[Guest access|Guest]]
*Authenticated user (1.8)


Each role may be edited via the link next to its name.
==Allow role assignments==
{{Moodle 1.8}}
Role permissions may be reset or a duplicate role created using the buttons at the top of the View role details page (from Moodle 1.8 onwards).


==Permissions==
The 'Allow role assignments' tab is for setting which roles each role can assign other users to.
The permissions matrix allows a very granular approach to assigning rights to a role (a class of users).  Assigning or editing permissions should be done with great care.  A change can produce a profound unwanted effect, or an annoying effect that will be hard to understand the cause.


There are over 150 lines of capabilities where any of 4 different permissions can be assigned.  The capabilities are grouped in 21 categories.
[[File:Allowroleassignments.png]]
[[Image:Roles_Define_Permissions_crop.JPG|frame|center|Top of the permissions table]]


The permissions for each of the pre-defined roles are shown with a grey background (from Moodle 1.8 onwards).
===Enabling teachers to assign other teachers===
By default, teachers can only assign other users the roles of non-editing teachers, students and guests. If you want teachers to be able to assign other teachers in their course, you can allow the role assignment:


===Permission terms===
#Click on ''Settings > Site administration > Users > Permissions > Define roles''.
From lowest to highest, from general to specific.
#Click the Allow role assignments tab.
#Click the checkbox where the teacher row and column intersect.
#Click the "Save changes" button.


*Inherit - pass along from before [lowest level, always loses]
==Allow role overrides==
*Allow - let happen or permit [same level as prevent]
*Prevent - stop [same level as allow]
*Prohibit - forbid [highest level, always wins]


===Permission examples===
The 'Allow role overrides' tab is for setting which roles can be overridden by each role. Note that the settings only apply to users who have the capabilities [[Capabilities/moodle/role:override|moodle/role:override]] or [[Capabilities/moodle/role:safeoverride|moodle/role:safeoverride]] allowed.
'''Inherit''': if no permission is defined, then the capability permission is inherited from a context that is more general than the current context.  


'''Allow and prevent''' will cancel each other out if set for the same capability at the same context level. If this happens, we refer to the previous context level to determine the permission for the capability.
==Allow role switches==


'''Prohibit''': If we set prohibit on a capability, it means that the capability cannot be overridden. Prohibit always wins and creates a permanent stop.
The 'Allow role switches' tab is for setting which roles a user may switch to, based on which roles they already have. In addition to an entry in this table, a user must also have the moodle/role:switchroles capability to be able to switch.
 
Since the capabilities in each role could be different and participants can be assigned different roles,  there could be a conflict in capabilities. The hierarchy of permissions  resolves this by saying that the capability defined for a more specific context will win, unless an prohibit is encountered in a less specific context.
 
Example 1. Mark has a student role in Course One, which allows  all students to write into the wikis "Everyone" and "Homework".  But Mark also got assigned a Visitor role at a module context level (for the wiki "Honors") and Visitors are prevented writing in the Honors wiki.  Thus Mark can write into the "Everyone" and "Homework" wikis but not in "Honors".
 
Example 2. Jeff has been assigned to a "naughty student" role that prohibits him from postings in any forums for the whole site. However his teacher assigned him a "facilitator" role in "Science forum" in the course Science and Math 101. Since a higher context prohibit permission always wins, Jeff is unable to post in "Science forum".
 
==Legacy capabilities==
 
* Legacy capabilities were implemented for backward compatibility.
* Allowing a legacy capability does NOT provide a new role with all capabilities of a pre-Moodle 1.7 role.
* It is not necessary to to allow any legacy capabilities unless using old 3rd party code that was not designed for Moodle 1.7 and doesn't yet support roles.
 
==Adding a new role==
 
#Give the role an appropriate name. If you need to name the role for multiple languages you can use [[Multi language content|multi-lang syntax]] if you wish, such as <code><nowiki><span lang="en" class="multilang">Teacher</span> <span lang="es_es" class="multilang">Profesor</span></nowiki></code>. If multi-lang syntax is used then ''Filter all strings'' should be set in [[Filter settings]].
#Give the role a meaningful short name. The short name is necessary for other plugins in Moodle that may need to refer to the role (e.g. when uploading users from a file or setting enrolments via an enrolment plugin).
#Optional: Give the role a description so that everyone has a common understanding of it.
 
==Testing a new role==
 
#Create test user and assign new role to them.
#Either logout as admin and then login as test user or use a different browser to login as test user.
 
==Example roles==
 
*[[Inspector role|Inspector]]
 
==See also==
*The capability [[Capabilities/moodle/role:manage|moodle/role:manage]]
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=57812 Create a Parent of a student role] forum discussion
 
[[Category:Administrator]]
[[Category:Roles]]


[[es:Gestionar_roles]]
[[es:Gestionar_roles]]
[[eu:Rolak_kudeatu]]
[[fr:Définir les rôles]]
[[fr:Définir les rôles]]
[[ja:ロールの管理]]
[[de:Rollen verwalten]]

Latest revision as of 14:52, 20 October 2011


An administrator can manage roles in Settings > Site administration > Users > Permissions > Define roles.

Manage roles

The 'Manage roles' tab contains a list of roles on your site. The edit column contains icons for editing, deleting roles and copying roles, and for moving them up or down in the list (affecting the way that roles are listed around Moodle).

Manageroles2.png

To edit a role:

  1. Go to Settings > Site administration > Users > Permissions > Define roles.
  2. Click the edit icon opposite the role you want to edit e.g. student.
  3. On the edit role page, change permissions as required for each capability.
  4. Scroll to the bottom of the page and click the "Save changes" button.

See Creating custom roles for information about adding a new role.

Allow role assignments

The 'Allow role assignments' tab is for setting which roles each role can assign other users to.

Allowroleassignments.png

Enabling teachers to assign other teachers

By default, teachers can only assign other users the roles of non-editing teachers, students and guests. If you want teachers to be able to assign other teachers in their course, you can allow the role assignment:

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

Allow role overrides

The 'Allow role overrides' tab is for setting which roles can be overridden by each role. Note that the settings only apply to users who have the capabilities moodle/role:override or moodle/role:safeoverride allowed.

Allow role switches

The 'Allow role switches' tab is for setting which roles a user may switch to, based on which roles they already have. In addition to an entry in this table, a user must also have the moodle/role:switchroles capability to be able to switch.