Confluence Docs 3.0 : Userlister Macro This page last changed on Jun 09, 2009 by ggaskell. The Userlister macro displays a list of users registered in Confluence, based on their group membership. On this page: Usage with the Macro Browser Usage with the Wiki Markup Editor Parameters Examples Listing all Users Specifying a Group Listing Only Online Users ## Usage with the Macro Browser To insert the userlister macro into a page using the Macro Browser, Open your desired Confluence page, then click the 'Edit' button. The 'Edit Page' mode opens. Next, click the Macro Browser icon on the editor toolbar. The Macro Browser will open in the middle of the screen. In the Macro Browser, type the name of your desired macro into the search box at the top right of the window. Macros with a matching name will appear in the centre pane. Click on the desired macro to see its options screen. Here, you can set the macro parameters then click 'insert' to put the macro into the page. Once you've found the userlister macro, click 'insert' to add it to your page. ## Usage with the Wiki Markup Editor
What you need to type | What you will get
--- | ---
    {userlister:groups=*}
## Parameters Parameters are settings for Confluence macros that allow the user to control their content or presentation. The table below lists relevant parameters for this macro. Parameter names are displayed differently in the macro browser interface and in wiki markup. Below, parameter names used in the macro browser are indicated in Bold text, while their equivalents in wiki markup are indicated in (`bracketed`) text. If the latter is not shown, then in wiki markup, the parameter's name should be omitted and only its value should be added immediately after the colon symbol (`:`).
Parameter | Required? | Default | Description
--- | --- | --- | ---
Group(s) (`groups`) | yes | none | Use parameter name 'group' or 'groups' to specify one or more groups whose Confluence users you want to list, using a comma-separated list of group names. To see all users registered in a Confluence installation, specify an asterisk ('*') for this parameter's value.
Display Online/Offline Users (`online`) | no | none | Specify 'true' to generate a list of online users. Specify 'false' to generate a list of offline users.
## Examples #### Listing all Users Here is an example that lists all the users registered on your Confluence site.
    {userlister:groups=*}
#### Specifying a Group Here is an example that lists the users that belong to the group 'my-staff'.
    {userlister:groups=my-staff}
#### Listing Only Online Users In order to make this feature functional, a System Administrator needs to enable the User Log In Listener for your Confluence site. Here is an example that lists all currently online users in the 'my-staff' group.
    {userlister:groups=my-staff|online=true}
| List of online users can be misleading When the parameter 'online=true' is used, Confluence uses a context listener to generate the list of online users. A context listener is a J2EE term for something that listens for events in the application server. We listen for session open and close events, so a user is 'online' if they have a session on the application server. Some application servers don't correctly despatch close events for sessions – in these cases, the list of online users may be misleading.
##### RELATED TOPICS Working with Macros Configuring the userlister Macro in the Administrators Guide Take me back to the Confluence User Guide. Attachments: userlistener macro.PNG (image/png)

Document generated by Confluence on Nov 05, 2009 23:35