On this page
DEPRECATED SINCE LUP 3.7
Create customized lists of users
The Customized User List macro allows you to display a list of users filtered by a profile field.
You can, for example, display a list of all users located within the USA. Or holding a specific position. Or perhaps speaking a specific language.
Furthermore you can decide which profile fields should be displayed in the list. By default, only the user's full name and avatar will be displayed.
Filter mode selection
You have the option between the "Default mode" and the "Expert mode" when selecting the filter mode.
With the expert mode you can select people via CQL statements. Here, you can see the result when using the CQL statement for the location "USA".
The example above shows the result when using the CQL statement
cup.land7 with the country
To find examples of CQL usage as well as a list of all available CQL statements click on the "CQL help" button.
Choose the profile field you want to use as a filter (for example "Languages"). Then, enter the value you want to use as a filter (for example "English").
Add as many profile fields as you want to narrow down your search (optional). If you wish to remove filters, click on the x button .
By default, only the user's full name and avatar will be displayed inside the list. But you can display another profile fields manually.
Enter the profile fields you wish to display into the Displayed profile fields area. Click inside this field and the macro will display any available profile field.
You can select what profile field the list should be ordered by. Later, any user can change the order manually.
Click on the arrow pointing down to display a list of all available profile fields. Choose the profile field that you wish to order the list by.
Activate the Pagination checkbox if you wish to reduce the amount of results per page.
Once activated, a Results per page field will be displayed. Click on the button with two triangles to open a list. Select the value of your choice.
Use Confluence Query Language for more flexibility
To enable the use of Confluence Query Language, select the Expert mode (CQL) inside Filter mode.
The Confluence Query Language (CQL) allows for much more complex searches.
Enter your CQL search string here.
You will need to know the right Linchpin User Profiles field keys. Please note that these are not the names you gave to the fields.
The good news is, that the macro offers a list of all available keys. To view the list, click on the CQL help button. Now click on the Available fields button. With the help of the copy button you can quickly copy the right keys into your filter field.
CQL Search examples
|~ and ?/*
contains with operators
|contains any of list
|cup.department in ("HR", "Marketing")
|not in ()
|contains none of list
|cup.department not in ("HR", "Marketing")
|AND / OR
cup.location="New York" AND (cup.department="marketing" OR cup.department="hr")
The following table shows which operators can be used with specific field types.
|CUP Field Type
|( ... )
More information about CQL can be found in the official CQL documentation by Atlassian.