Page tree
Skip to end of metadata
Go to start of metadata


The Customized User List macro will help you to display all kind of user groups. You can use it to create a phone book, display your team members, create an e-mail list etc.

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.

Please note that this macro only displays users who logged in to your system at least once.

Freshly created users who never logged in to the system won't be displayed since they are not indexed within the system yet.




Search options

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 .



Display options

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.

Due to security reasons, you can only configure visible fields since release 1.11.1.

Order by

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.



You can use a subset of the Confluence search syntax for the profile field value, e.g., "W*" to find all users from Washington and Wiesbaden.

Feel free to get in contact with us if you encounter any issues.


Pagination

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. 



Filter options

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

OperatorResult/MeaningExample
=

exact match

cup.location="New York"

~

contains

cup.location~"York"

~ and ?/*

contains with operators

cup.department~"Marketi*"

cup.department~"Mar??ting"

in ()contains any of listcup.department in ("HR", "Marketing")
not in ()contains none of listcup.department not in ("HR", "Marketing")
AND / OR

concatenation

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=!=~!~>>=<<=INNOT INANDORNOT( ... )
Input(tick)
(tick)




(tick)
(tick)(tick)(tick)(tick)
Textarea(tick)
(tick)




(tick)
(tick)(tick)(tick)(tick)
Select(tick)
(tick)




(tick)
(tick)(tick)(tick)(tick)
Multiselect(tick)
(tick)




(tick)
(tick)(tick)(tick)(tick)
Cascade(tick)
(tick)




(tick)
(tick)(tick)(tick)(tick)
Date(tick)
(tick)




(tick)
(tick)(tick)(tick)(tick)
User(tick)
(tick)




(tick)
(tick)(tick)(tick)(tick)
Language(tick)
(tick)




(tick)
(tick)(tick)(tick)(tick)
Country

(tick)






(tick)(tick)(tick)(tick)
LDAP(tick)
(tick)




(tick)
(tick)(tick)(tick)(tick)
Dependent(tick)
(tick)




(tick)
(tick)(tick)(tick)(tick)
Phone(tick)
(tick)




(tick)
(tick)(tick)(tick)(tick)
IM(tick)
(tick)




(tick)
(tick)(tick)(tick)(tick)

More information about CQL can be found in the official CQL documentation by Atlassian.