Add a Role link:The Principal Selector control provides the ability to filter and select users that have logins in the portal.
Portlets display the Principal Selector with one or both of the following:
a Role Selector
a User Selector
The Role Selector, itself, can be configured in one of three ways. One instance of the Role Selector allows you to select only global Base Roles. A second instance allows you to select only Context-Based Roles. A third instance allows you to select either or both of these role types.
The User Selector allows you to select from the list of registered users that have logins in the system.
The Principal Selector control appears on the Site Manager Base
Roles tab when the user clicks on that tab's Add a Role link:
This particular Principal Selector displays:
an Add Individual Users link (which launches the User Selector in a popup window)
a Role Selector list of global Base Roles
an All Users checkbox
an Include guests checkbox
Portlets configure the functionality of Principal Selector using one or more of the following options:
Filters and displays selectable categories of users (roles).
The Role Selector may be configured to display one or both of the following:
Context-based Roles
Base Roles
Here is a Role Selector that contains both:
The role selector shown above is an instance where the user can select context roles and/or base roles. The “context role” selector is displayed on top. The “base role” selector is shown on the bottom. (The context shown is the context from which the Principal Selector is called, in this case a course, "Civil War 1861-62").
For faculty members only, a link displays that allows them to access context roles from their other current courses (“Choose from roles in all my courses”). Clicking this link displays the other contexts (courses) underneath the current ones, formatted as shown in the first example.
If “All Users in [context name]” or “All Users” is clicked, then all the roles under the respective heading are checked and greyed out (as shown above). If a user wants to select guest/public roles, then “Include guests” must be checked. Some instances of the role selector may not have the include guests option and this is configured on a portlet by portlet basis. For base roles, clicking all users is essentially the same as selecting the base role "Users”. Clicking “All Users” plus “Include guests” is the same as selecting the base role “Everyone”.
The Role Selector can be configured to display only Base Roles (global categories of users) as follows:
Clicking on the All Users checkbox selects all roles below it. Clicking on the Include guests checkbox adds guest roles to the list below it.
Include guests checkbox
When checked displays all "Guest" roles in the Base Role list below it.
All Users checkbox
When checked, selects all Base Roles below it. Checking "All Users" is equivalent to selecting the "Users" role. Checking “All Users” plus “Include guests” is equivalent to selecting the Base Role, “Everyone”.
Displays context-based roles, which in a course context would appear as follows:
The context role selector displays alone or above the Base Role selector in the Principal Selector. If “All Users in [context name]” is checked, then all the context role checkboxes below it are selected.
All Users in [context] checkbox
When checked, selects all context roles below it.
Choose from roles in all my courses link
This link displays for faculty members only. Clicking this link displays all the context-based roles for all of the faculty's current courses, following on the current context's list of roles.
Add Individual Users link
This link launches the User Selector in a popup window.
If users are selected in the User Selector, the popup window closes, and the Role Selector screen displays text similar to the following:
10 Users Selected. Edit Users
Clicking on the Edit Users link reopens the User Selector in a popup window, which displays the previously selected users in the “Selected Users” box on the right-hand side of the control.
The User Selector displays in a popup window when the Role Selector's Add Individual Users or Edit Users link is clicked:
The User Selector contains 2 list boxes. The left list box displays the first 100 users, returned alphabetically by last name in the format: "Smith, David M". If more than 100 users are returned, some pagination icons display below the left list box to allow you to browse the pages of users. The right list box contains the selected users. After the user makes his selections and clicks OK, the User Selector closes, and the list of selected users is returned to the parent portlet.
The list of users in the left box may be filtered in a number of ways: at the top are radio buttons that allow the user to choose if they want to see “All Users” or just the users in the current context. There may be instances of the User Selector where only users in the current context are available. In this case, no radio buttons are displayed, and a header displays with the text, “Users in [name of context]”.
The role dropdown at the top of the left list box filters the list of users by role.
The User Selector also provides a smart search by name. As the user types letters in the search fields, the list is automatically filtered. For example, if the user types “S” in the last name field, the list filters down to all users whose last name begins with “S”. If the user then types “m”, the list filters down to all users whose last name begins with “Sm”. If the user enters “Smith”, the list filters down to all users whose last name is “Smith”.
The first and last name search fields work together in concert. For example if you type “Sm” in the last name field and “Jo” in the first name field, the list filters down to John Smith and Joyce Smith. If you simply type “J” in the first name field, the list filters down to all users whose first name begins with “J”.
When Site Administrators and users in the faculty role click on a user in the left list box, they are shown the student ID (host ID) and roles of the selected user in a text box at the top right of the screen.
The Principal Selector functionality may be configured differently in other portlets that also require you to select from all registered users and roles in the system:
Announcements (Manage menu -> New Announcement -> Sent To:)
Message Center (New message view - both limited and full access)
Bulletin Boards (Permitted Users in the add/edit category or topic views)
Forums (Permitted Users in the add/edit category and topic views)
Task Manager (Assign new task view)
Most portlets on tabs other than the Home tab have a Add
a Role link (to the Principal Selector). Read
each portlet's online help to learn how it configures the functionality
of Principal Selector.
There are no settings or preferences for this control.
There are no security settings for this control.