| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Overview
The users-report macro generates a report for matching users, showing the values of the chosen metadata attached to the user.
For a user
with a personal space, the metadata is fetched from the personal space
without a personal space, the metadata is retrieved from their profile
Metadata can either be posted to a user's profile or to their personal space and then reports generated. For example,
every user in a company could be requested to attach personal metadata such as work phone, cell phone, location, etc. A company directory can then be generated that includes all of this information
The users-report macro can be used when setting up hierarchical space.
Parameters
Parameter | Required | Default | Notes | Version |
|---|---|---|---|---|
|
| The list of fields (columns) as a comma separated list to be included in the report. This can include added metadata and internal metadata .(for example User, Email, Space) | ||
| 500 | Limits the number of results |
Usage
To retrieve the metadata from users with personal spaces and from regular user profiles (without personal spaces), choose Users Report macro in the Confluence macro browser:
...
only the user admin has a personal user space
two users listed have no personal space
space metadata has been added to the admin user personal space to record their location
In an instance with a large number of users, this macro should be used with care.
Reference Markup
| Code Block | ||
|---|---|---|
| ||
{users-report:User,Location,Email,Extension,Mobile Phone} |
...