- Created by Administrator on May 21, 2019
Display a filtered list of users with their avatar and name and additional information like phone number or position for e.g., a phone book
Configure which users to include in the list and which profile fields to display
Customized User List Macro
Create customized lists of users
The Customized User List Macro enables you to display a list of users filtered by a profile field value. For example this macro can be used to create a simple phone book for your department (see first image) or to list your team members on your team homepage or similar use cases, where you want to display a custom list of users. You are also able to configure which profile fields are shown in the list. The user list will only show people that have access to confluence.
The second image shows the configuration options for the macro:
- Choose the profile field you want to filter on (e.g., "Location").
- Enter the value you want to filter for (e.g., "Wiesbaden").
- Add as many profile fields as you want to narrow your search request.
- Displayed profile fields
Choose the profile fields you want to be displayed as additional columns in the list (e.g., "Phone" and "Position"). The users avatar and name are always displayed.
- Ordered by
Choose the profile field by which the list will be initially ordered. You can still order the list manually by clicking on the headlines in the table view.
The given example will display a list of all users whose profile field "Country" has the value "Deutschland" and will include their avatar, name, phone number, position, branch, country and e-mail.
Due to security reasons, you can only configure visible fields since release 1.11.1.
Use Confluence Query Language for more flexibility
The Customized User List macro gives you now an expert mode where you can use the Confluence Query Language (CQL). CQL allows much more complex searches for users. To use CQL just switch the "Filter mode" to "Expert mode" and enter the CQL search string. For that you need to know the keys (this are not the names you gave to the fields!) of available Linchpin User Profile fields. You can find all available fields directly in the macro configuration, just click on "CQL help".
CQL Search examples:
contains with operators
|contains any of list||cup.department in ("HR", "Marketing")|
|contains none of list||cup.department not in ("HR", "Marketing")|
cup.location="New York" AND (cup.department="marketing" OR cup.department="hr")
The following table shows which operators can be used with witch field types
|CUP Field Type||=||!=||~||!~||>||>=||<||<=||IN||NOT IN||AND||OR||NOT||( ... )|
More information about CQL can be found in the official CQL documentation by Atlassian.
- No labels
This content was last updated on 05/21/2019.
This content hasn't been updated in a while. That doesn't have to be a problem. Some of our pages live for years without becoming obsolete. Please click this link if you want us to update this page. Old content can be incorrect, misleading or outdated. Please get in contact with us via a form on this page, our live chat or via email with email@example.com if you are in doubt, have a question, suggestion, or want changes from us.