Creating custom roles: Difference between revisions

Latest revision as of 11:46, 20 October 2012

Creating a new role

To create a custom role:

Go to Settings > Site administration > Users > Permissions > Define roles.
Click the "Add a new role" button.
On the add a new role page, give the role a name e.g. 'Parent'. If you need to name the role for multiple languages you can use multi-lang syntax if you wish.
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).
Give the role a description (optional).
Select an appropriate role archetype (see below for further information).
Select the contexts where the role may be assigned e.g. 'User' for Parent role.
Set permissions as required.
Scroll to the top or bottom of the page and click the "Create this role" button.

Adding a new role

Setting the context types

Role archetypes

A role archetype

Is a hard-coded template for a role
Is used during upgrades when adding defaults for new capabilities - no archetype = no new capabilities during upgrade
Is used during when resetting a role to determine the defaults - no archetype = reset removes all capabilities

There is no need to set a role archetype for custom roles used for overrides or if the site admin wants to specify new capabilities manually after upgrading.

Creating a duplicate role

To create a duplicate role:

Go to Settings > Site administration > Users > Permissions > Define roles.
In the "edit" column on the right, click the x2 icon.
Give a name and set permissions for your new role; scroll down and click "create this role".
The list of roles will now show the "... copy 1" at the bottom, for example "Guest copy 1".

New role considerations

A newly-created role does not have the ability to assign or override any other roles. This is true even when the new role is a copy of a role that had such abilities. If such ability is needed, the administrator must grant it explicitly via the 'Allow role assignments' and 'Allow role overrides' tabs.

A new role is not automatically listed in course descriptions even if was created by copying a role that is listed, such as Teacher. If you want the new role to appear in the course listing, you must set it explicitly via Settings > Site administration > Appearance > Course managers.

Testing a new role

Settings > Switch role to Use the "Switch role to" link to see what another role will see in that context.

Since switching roles confines you to those roles you can assign in a course context, this method is only useful for testing course-scoped capabilities (i.e. it will not be useful for testing permissions that apply outside the course context, like moodle/user:edit).

Tip: You can always create test user and assign the new role to them. Then logout as admin and login as the test user. This is really the best way to test a new role.

Example custom roles

Parent - for providing parents/mentors/tutors with permission to view certain information about their children/mentees/tutees
Demo teacher - for providing a demonstration teacher account with a password which can't be changed
Forum moderator - for providing a user with permission in a particular forum to edit or delete forum posts, split discussions and move discussions to other forums
Calendar editor - for enabling a user to add site or course events to the calendar
Blogger - for limiting blogging to specific users only
Quiz user with unlimited time - for allowing a user unlimited time to attempt a quiz which has a time limit set
Question creator - for enabling students to create questions for use in quizzes
Course requester role - for restricting users who can make course requests
Cohort enroller - for allowing teachers to enrol category cohorts into their course
Template creator - for allowing teachers to save as "Public" a Feedback template.

@@ Line 1: / Line 1: @@
-{{Roles and capabilities}}
+{{Roles}}
-<p class="note">'''Please refer to [[TOC_with_notes#Roles and capabilities|these notes]] before editing this page.'''</p>
+==Creating a new role==
+To create a custom role:
+#Go to ''Settings > Site administration > Users > Permissions > Define roles''.
+#Click the "Add a new role" button.
+#On the add a new role page, give the role a name e.g. 'Parent'. If you need to name the role for multiple languages you can use [[Multi language content|multi-lang syntax]] if you wish.
+#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).
+#Give the role a description (optional).
+#Select an appropriate role archetype (see below for further information).
+#Select the contexts where the role may be assigned e.g. 'User' for Parent role.
+#Set permissions as required.
+#Scroll to the top or bottom of the page and click the "Create this role" button.
-Custom Roles are roles that are not part of the core code, not dowloaded with the installation files. There are always reasons to establish a custome role, and each custom role needs to be created. The basic process is the same for all custom roles so in this page we will create a role then use it as a [[Parent Role]].
+{|
+|-
+| [[Image:CustomRole01.png|thumb|Adding a new role]]
+| [[Image:customrole02.png|thumb|Setting the context types]]
+|-
+|}
-We can start this exercise by adding a role  the name of "Perant Test" to our Moodle and we are going to link this parent to "Stedunt Test", a test tole we have for students in our Moodle.
+==Role archetypes==
-Go to: '''Site Administration > Users > Permissions > Define Roles'''
+A role archetype
-Scroll to the bottom of the page and click on Add New Role button.
+* Is a hard-coded template for a role
+* Is used during upgrades when adding defaults for new capabilities - no archetype = no new capabilities during upgrade
+* Is used during when resetting a role to determine the defaults - no archetype = reset removes all capabilities
-This brings up the Adding a new role screen.
+There is no need to set a role archetype for custom roles used for overrides or if the site admin wants to specify new capabilities manually after upgrading.
-In the Role name dialog, enter the name of the role that you want to create, "Parent" and retype the name in the "Short name" dialog.
+==Creating a duplicate role==
-In the Summary dialog enter something like "Parent role"
+To create a duplicate role:
+*Go to ''Settings > Site administration > Users > Permissions > Define roles''.
+*In the "edit" column on the right, click the  x2 icon.
+*Give a name and set permissions for your new role; scroll down and click "create this role".
+*The list of roles will now show the "... copy 1" at the bottom, for example "Guest copy 1".
-Moodle 2 uses Roles in a context, so we have to place the Role into a context so we can use it. Scroll down to "Context where this role may be assigned" and click on the User checkbox.
+==New role considerations==
-This creates a Custom Role and it is the Context in which the role is to be used that determines what permissions the role actually begins with.
+A newly-created role does not have the ability to assign or override any other roles. This is true even when the new role is a copy of a role that had such abilities.  If such ability is needed, the administrator must grant it explicitly via the 'Allow role assignments' and 'Allow role overrides' tabs.
+A new role is not automatically listed in course descriptions even if was created by copying a role that is listed, such as Teacher. If you want the new role to appear in the course listing, you must set it explicitly via ''Settings > Site administration > Appearance > Course managers''.
+==Testing a new role==
+''Settings > Switch role to''
+Use the "Switch role to" link to see what another role will see in that context.
+Since switching roles confines you to those roles you can assign in a course context, this method is only useful for testing course-scoped capabilities (i.e. it will not be useful for testing permissions that apply outside the course context, like moodle/user:edit).
+''Tip:'' You can always create test user and assign the new role to them.  Then logout as admin and login as the test user.  This is really the best way to test a new role.
+==Example custom roles==
+*[[Parent role|Parent]] - for providing parents/mentors/tutors with permission to view certain information about their children/mentees/tutees
+*[[Demo teacher role|Demo teacher]] - for providing a demonstration teacher account with a password which can't be changed
+*[[Forum moderator role|Forum moderator]] - for providing a user with permission in a particular forum to edit or delete forum posts, split discussions and move discussions to other forums
+*[[Calendar editor role|Calendar editor]] - for enabling a user to add site or course events to the calendar
+*[[Blogger role|Blogger]] - for limiting blogging to specific users only
+*[[Quiz user with unlimited time role|Quiz user with unlimited time]] - for allowing a user unlimited time to attempt a quiz which has a time limit set
+*[[Question creator role|Question creator]] - for enabling students to create questions for use in quizzes
+*[[Course requester role]] - for restricting users who can make course requests
+*[[Cohort enroller]] - for allowing teachers to enrol category cohorts into their course
+*[[Template creator]] - for allowing teachers to save as "Public" a Feedback template.
+==See also==
+Using Moodle forum discussions:
+* [http://moodle.org/mod/forum/discuss.php?d=66782 What happens if a user has multiple roles in a course?]
+* [http://moodle.org/mod/forum/discuss.php?d=90140 logged in: what role am I?]
+[[Category:Site administration]]
+[[de:Neue Rollen anlegen]]

Documentation