User list portlet
From VYRE
| User list portlet | |
|---|---|
| module: | Users and groups module |
| supplier: | VYRE Ltd. |
The User list portlet is used to generate a list of users from a specific user realm
Contents |
[edit] Edit mode
The edit mode of this portlet is divided into 3 main sections:
- Users
- Sorting
- Pagination
[edit] The Users tab
[edit] Realm
Select the realm from which you would like to list users from the drop-down of available realms
[edit] XSL Stylesheet
Select the desired XSL Stylesheet that you want to use to transform the output XML.
[edit] List mode
The list mode determines the search mode that is applied, it consists of four options:
[edit] Use incoming search query
Selecting this option will return a list of users based on an incoming search query. The search query is passed to the page using the User search portlet.
[edit] List users from a profile group
Selecting this option requires you to select a profile group from the drop-down list of availble profile groups.
Check the Use incoming search parameters check-box is selected to filter the resulting profile group user list according to a search query passed to the page using the User search portlet.
[edit] List all users from the realm
This option simply returns all users from a specific user realm. Please note: No filtering or search parameters can be used with this option.
[edit] List users from a group
Selecting this option requires you to select one or more user groups from the list of groups available. To select groups highlight the required groups in the Available groups select box and click the >> button. You can select mutliple groups by holding the ctrl key when highlighting a group. You can remove groups in a similar fashion by clicking on the << button.
It is possible to restrict the list of available groups to only those that the current logged in user is a member of by checking the Restrict to groups the currently loggedin user is in check-box.
[edit] The Sorting tab
Here you can define the sort method that is applied to the resulting output XML.
[edit] First sort field
Select the desired field by which to sort your users from the list available in the drop-down. These consist of:
- Score this will sort according to relevence to a search query that is submitted to this portlet
- Username
- Full name
- Creation Date
- Modification Date
Checking the Sort in descending order (does not apply for score) checkbox will reverse the sorting method selected to descending order as opposed to the default ascending order.
For example selecting a combination of sort by Creation date with the Sort in descending order checkbox checked will sort your user list with the newest users listed first.
[edit] Second sort field
It is possible to apply a second sort field, This works in the same was as the First sort field and is applied after the first sort field. Similar to the first sort field it is possible to sort in descending order by checking the corresponding checkbox. To use the second sort field check the Use second sort field checkbox.
'For example: a combination of sort by Creation date and sort by Username will first list users sorted by the date they were created. Any users with a matching creation date will then by sorted by username.
[edit] The Pagination tab
Here you can define the type (if any) of pagination that is applied to your XML output.
[edit] Divide into pages
To paginate your list of users check the divide into pages checkbox.
[edit] Users per page
Enter the number of users per page that you would like.
Please note: this field is only relevant when the divide into pages checkbox is checked.
[edit] Position of navigation bar
Select the desired position of the navigation bar by selecting the appropriate radion button. Options available are:
- Above only - This will display the pagination options above the list of users
- Below only - This will display the pagination options below the list of users
- Above and Below - This will display the pagination options both above and below the list of users
- Don't display - This will disable the pagination options altogether. The list of users, however, will remain paginated only showing the number of users entered in the Users per page form above
You can also specify which elements of Unify's default pagination are displayed by selecting the appropriate checkboxes. They consist of the following options:
- Show page form - This displays a form to enter the page number you wish to jump to
- Show first/last buttons - This displays text links to jump to the first or last pages of the user list
- Show next/previous buttons - This displays text links to jump to the next or preceding pages of the user list
- Show page number - This displays a list of page numbers (1,2,3 etc.), these are links that allow you to jump any desired page
