Username Password
Bookmark and Share

User List

User List allows you to display a list of users in a given user group. The list of users is generated based on WebGUI's users and groups system, and the asset allows you to display users according to user profile fields. This feature can be used to list, search for, and sort users according to user profile information such as username, first name, last name, or email address.

1. Select User List from the New Content menu of the Admin Bar. The “Add User List” screen will open.

2. Enter a title for your user list in the “Title” field.

3. The “Menu Title” is the title as it appears in the site navigation. You can leave this blank and WebGUI will insert a menu title for you (by default, WebGUI will use the “Title”).
The URL can also be left blank and WebGUI will generate a URL for you.

4. In the “Description” field, enter a short description of the user list. Here is where you could provide instructions for the user. This text will appear between the user list title and the actual user list.

5. Choose your display settings from the “Display” tab.


A. If the “Hide from navigation?” field is set to “Yes,” your user list “menu title” will not appear in your navigation.

B. If “Open in new window?” is set to “Yes,” the user list will open in a new browser window when clicked on from the navigation (this happens only when the user list is accessed through the navigation).

C. If “Display the title?” is set to “Yes,” the title of your user list entered in the “Properties” tab will be displayed to users at the top of your user list asset.

D. You can choose a “Style Template” and choose to make the page printable.

E. The “Printable Style” is the template used for a printer friendly version of this asset.

F. You can choose a “Template” to determine the appearance and functionality of this asset. The “Template” field works in conjunction with the “Alphabet Search Field,” which contains a number of user profile fields by which to sort search results.

If set to “Default UserList,” the selected “Alphabet Search Field” may be searched alphabetically. For example, if Last Name is selected in the “Alphabet Search Field,” the search results will be sorted alphabetically by last name. Search terms can also be entered in the search field to find users whose profiles contain those terms in any field.

If set to “UserList with multiple search keywords,” search terms can be entered into each of multiple search fields to find users whose profiles contain those terms in corresponding fields.



If set to “UserList with search field selection,” search terms can be entered in the search field to find users whose profiles contain those terms in the selected search fields. An example is shown below.

G. Under “Group to show,” select the group of users to be shown in the user list. This corresponds to group in the WebGUI Groups system. Only the users in the selected group are shown in the user list. By default this value is set to “Everyone.” You can narrow the asset to display only registered users, only users in a given subscription group, or users in departments within your organization.

H. Under “Group to hide,” select the group of users to be hidden in the user list. By default, this value is set to “Admins.”

I. In the “Users per page” field, enter the number of users to be displayed per page of the user list. Results will be paginated if they exceed this amount.

J. In the “Alphabet” field, the letters of the alphabet are listed and separated by commas. This is the alphabet used for the alphabet search. If you are working with a language that does not use the default values (a,b,c...), you may enter new values, separating each value with a comma.

K. Under “Alphabet Search Field,” select the profile field to be searched using the alphabet search. For example, selecting Last Name will alphabetize all search results according to users' last names; selecting First Name will alphabetize users' by their first names. These fields correspond to the WebGUI user profile fields. If you, or a site administrator, have created custom user profile fields through the User Profile screen in the Admin Console, they will display as a selection here.

L. If “Show only visible fields as named tmpl_vars” is set to Yes, then only fields that are set to “Visible” in the user profile settings will be available as named tmpl_vars.

M. Select to display search results in an ascending or descending “Sort Order.”

N. Upon entering the asset, all users in the “Group to show” are displayed by default. For example, if your “Group to show” field is set to Registered Users, all registered users on your site will be displayed upon entering the application. The search can then be used to narrow those results. Under “Sort By,” select the profile field by which users will be alphabetically sorted (last name, first name, etc).

O. If “Override Email Public” is set to Yes, the user's profile setting to “Make email address public” is ignored, and email addresses will always be shown.

P. If “Override Profile Public” is set to Yes, the user's profile setting to “Make profile public” is ignored, and profiles will always be shown. So, private profiles will be shown, despite being made private in the user's profile.

6. Choose your security settings from the “Security” tab. This is the default Security tab common amongst most assets.

7. If you wish, enter metadata in the “Metadata” tab. The metadata tab is the standard tab seen amongst all assets. If you need to apply meta data for the purpose of content profiling, do so here.

8. When all your settings are complete, click save.

After saving, you will be taken back to the page and the asset will be displayed.




In this example, “Content Managers” were selected as the “Group to show” in the asset's Display tab. Users designated as “Content Managers” are therefore shown by default upon initially viewing the asset.

You can change the order in which users are displayed within each field by clicking on a column's heading. In this example, users are sorted in ascending alphabetical order according to last name. To change this, the Last Name column heading could be clicked on, and users would be rearranged in a descending alphabetical order according to their last names.

Keywords: Assets registered users users

Search | Most Popular | Recent Changes | Wiki Home
© 2022 Plain Black Corporation | All Rights Reserved