User's Guide (v 1.5)
Description
The User Profile Plugin enhances the functionality for Confluence user profiles. The user profiles can be centrally extended with additional elements. On top of that the plugin supports the synchronization of any attribute from LDAP-based external user repositories (e.g. Active Directory, OpenLDAP) and the user profile by extending the LDAP integration functionality of Confluence. So the users are no longer required to update their personal data manually. Each profile element is searchable (additional ones too). User profiles can be displayed via two different macros.
Your benefit: The data of synchronized user profiles is always up to date and can be used to display business cards or to search for contacts.
Content
Editing the User Profile
The edit modes for user profiles have been extended so that both administrators as well as users are able to adjust the data for additional profile elements. Elements of profiles for external (LDAP) users that are synchronized are not editable.
Searching the User Profiles
With the User Profile Plugin the data of all user profile elements is searchable. Thus users can be found by any information they provided in their profile. Hits will be displayed as link to the according user profile in the search result list.
In the following example a user was found by his phone number:
Extended Search
In addition to making all profile elements searchable, the User Profile Plugin also allows to search for data of a specific profile element. To do this you have to prepend your search phrase by the Default Title (see above) of the profile element directly followed by a colon (:). Please be aware that the search is case sensitive with respect to the default title.
The following examples will illustrate how the extended search is working:
Let's assume an additional profile element with the name "Hobby" was created. To find all users, whose hobby is tennis, the following query has to be used:
Hobby:tennis
Please note that the search term "tennis" is directly following the default title (Hobby), separated by a colon and that "Hobby" starts with a capital "H".
If you want to search for users having both tennis and soccer as hobby, the query would look like this:
Hobby:(tennis soccer)
If the default title contains a space (or any other character used by Lucene query syntax), this has to be escaped by prepending it with a backslash:
My\ Hobby:tennis
Lucene experts might already have noticed that this is Lucene query syntax. The default title "Hobby" is stored as Lucene document field and can thus be used to directly access information for the according profile element. This is the same for any other profile element. So there are lots of possibilities to refine your search 
Demonstration of search functionality:
Profile Macro
Displays the profile information of a user. Different modes allow to define which profile information of a user should be displayed.
Parameters
Parameter | Default | Description |
|---|---|---|
user | none | Required parameter, the username of the user for whom the profile should be displayed |
mode | full | Optional parameter, the mode defines which elements of the user profile will be shown:
|
| named fields | none | Fields to be displayed if the mode "namedFields" is chosen. If you want to see multiple fields separate them with commas, e.g. "email" or "phone, website". For the default Confluence profile elements use the following keys:
|
edit | false | Optional parameter, if "true" an edit link is provided for the owner of the user profile |
Demonstration of profile macro :
Profilelist Macro
Displays the profile information of several users, according to some given criteria.
Demonstration of profilelist macro :
Parameters
Parameter | Default | Description |
|---|---|---|
criteria | none | Required Parameter, the criteria defines which user profiles will be shown. All user profiles that match the specified criteria will be shown. |
elementsperpage | 6 | Optional Parameter, defines how many user profiles will be displayed per page |
All Versions