Create roles
If you have the Manage Role Permissions permission (in Security), you can create any number of roles for your organization and give individual users any number of roles for different org units in your system. You can create a role from new or by copying an existing role.
To create a new role:
- From the Admin Tools menu, click Roles and Permissions > Create/Copy.
- To create a new role without using an existing role's properties, click Start Fresh.
- On the New Role page, enter your role details.
- Click Save.
- On the Edit Role Interactions page, select your role interaction details.
- Click Save.
To create a role by copying an existing role:
- From the Admin Tools menu, click Roles and Permissions > Create/Copy.
- To create a new role using an existing role's properties, from the Choose a role drop-down list, select the role you want to copy.
- Enter a name for your new role.
- Click Copy.
- In the Customize Your Role area, do any of the following:
- To customize role settings, click Edit Settings. Make your changes. Click Save and Close.
- To customize permissions, click Edit Permissions. From the Filter by Tool drop-down list, select the tool for which you want to customize permissions. Click Apply Filter. Make your changes. Click Save and Close.
- To customize role interactions, click Edit Role Interactions. Make your changes. Click Save.
- To customize how your role maps, click Edit IMS Mappings. Make your changes. Click Save.
- Click I'm finished - return to role list.
Delete roles
Deleting a role removes it from the system permanently and cannot be undone.
- From the Admin Tools menu, click Roles and Permissions.
- From the context menu of the role you want to delete, click Delete.
- If the role is currently associated with existing users, do one of the following:
- To unenroll users currently using the role, select Remove these enrollments. Any users enrolled in the organization the role you are deleting are also deleted.
- To select a replacement role for those users, select Choose a replacement role. From the Role drop-down list, select a role.
- Click Delete.
Edit role permissions and properties
You can change the functionality available to users by changing the permissions associated with a role. Each role has separate permissions for each type of org unit; when you assign a user a role in a specific org unit, they receive the role’s permissions for that type of org unit. Permissions are very granular; they allow you to control what type of functionality a role has access to for each tool in the system.
- From the Admin Tools menu, click Roles and Permissions.
- Click the role for which you want to edit permissions.
- From the Filter by Tool drop-down list, select a tool. Click Apply Filter.
- From the Choose Org Unit Types link, select or deselect the check boxes for the org units you want to view. Click Apply Filter.
- Make your changes.
- Do one of the following:
- To continue editing permissions for the role, click Save. Repeat the previous steps.
- To finish editing permissions for the role, click Save and Close.
Edit a role's properties
A role’s properties include its name and description, tool behavior settings, appearance in the Classlist tool, and access to course offerings.
- From the Admin Tools menu, click Roles and Permissions.
- From the context menu of the role for which you want to edit properties, click Edit Settings.
- Make your changes.
- Click Save and Close.
Import permissions
You can import permissions from a .csv file and apply them to an existing role. This enables you to copy permissions from another organization, restore permissions previously exported, and import permissions created manually in a .csv file.
- From the Admin Tools menu, click Roles and Permissions.
- Click Import/Export.
- Select Import role permissions from a CSV file.
- Click Next.
- From the Import permissions for the role drop-down list, select a role.
- Click Next.
- In the Import File area, click Browse. Locate your .csv file. Click Open.
- Click Next > Import.
Import file format
Each row in the .csv file contains the value for a single permission. Rows follow the format [tool name], [permission name], [org unit type], [value].
All values should be enclosed in double quotation marks.
Comments can be inserted into the file by beginning a line with a double slash (//). Empty lines are ignored.
|
Value
|
Description
|
|---|
|
Tool name
|
The name of the tool the permission belongs to, as listed on the Edit Role Permissions page. For example, Blog, Competencies, or Manage Courses.
|
|
Permission name
|
The name of the permission, as listed on the Edit Role Permissions page. For example, See Updates Widget.
|
|
Org unit type
|
The name of the type of org unit where the permissions are applied, as listed on the Edit Role Permissions page. For example, Course Offering, Organization.
|
|
Value
|
Indicates whether the permission is enabled (indicated by Yes, Y, 1, or True) or disabled (indicated by No, N, 0, or False)
|
For example:
// This file gives a role permission to create public blog entries
// and receive notification on comments, but not create an RSS feed
"Blog","See the Blog tool","Organization","Yes"
"Blog","Add / edit / delete Blog entries","Organization","Yes"
"Blog","Create public blog entries","Organization","Yes"
"Blog","Make Blog Externally Available","Organization","Yes"
"Blog","Receive email notification on comments","Organization","Yes"
"Blog","Publish blog as an RSS feed","Organization","No"
Export permissions
You can export permissions to a .csv file and copy them to another organization, edit them manually in a .csv file, or save them as a backup.
- From the Admin Tools menu, click Roles and Permissions.
- Click Import/Export.
- Select Export role permissions to a CSV file.
- Click Next.
- From the Export permissions for the role drop-down list, select a role.
- Click Next.
- On the Preview Export page, click Export.
- On the Download Export page, click the file name to download the file.
- Click Done .
View the event log for a role
The event log records a history of all changes made to each role’s permissions and properties, including the time the change was made and the user who made the change.
- From the Admin Tools menu, click Roles and Permissions.
- From the context menu of the role for which you want to view a history of changes, click Event Log.
- Do one of the following:
- To see all changes for the role, leave the search field empty and click the Search icon.
- To see changes for a specific tool or date range, select the Tool or Log Date options or enter a term in the search field. Click the Search icon.