Userlister マクロ

The Userlister macro displays a list of users registered in Confluence, based on their group membership.

On this page:

Usage with the Macro Browser

To insert the userlister macro into a page using the Macro Browser,

Open your desired Confluence page or blog post, then click the 'Edit' button. The page or blog post opens in edit mode.
Click the Macro Browser icon on the toolbar. The macro browser window opens in the middle of the screen in 'macro selection' mode.
Scroll through the list of macros. Alternatively, start typing part of the name of your desired macro into the search box at the top right of the macro browser window. Macros with a matching name will appear in the main pane.
Click on the desired macro to access its parameters and preview parameter changes ('preview mode').
Set the macro parameters to your requirements. If desired, you can preview these changes by clicking 'Refresh'.
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

必要な入力項目	表示結果
{userlister:groups=*}

パラメーター

Parameters are options that you can include in Confluence macros to control the content or format of the macro output. The table below lists relevant parameters for this macro.

Parameter names are different in the macro browser and in wiki markup. Below we show the macro browser parameter names in bold text, and the equivalent wiki markup parameters in (bracketed) text. If we do not show any parameter name for the wiki markup, then you should leave out the parameter name and simply include the parameter value as the first parameter, immediately after the colon (:).

パラメーター	必須かどうか	既定	説明
Group(s) (`groups`)	はい	なし	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`)	いいえ	なし	Specify 'true' to generate a list of online users. Specify 'false' to generate a list of offline users.

例

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.

ページツリー