---
title: "users-report macro"
canonical: "https://support.appfire.com/space/COMALACM/655891474/users-report%20macro"
format: markdown
---
> Macro (aura-html)

## <span style="color: #091e42">Overview</span>

<span style="color: #091e42">The </span>`users-report`<span style="color: #091e42"> </span><span style="color: #333333">macro generates a report for matching users, showing the values of the chosen metadata attached to the user.</span>

For a user

- <span style="color: #333333">**With a personal space**</span><span style="color: #333333"> - metadata is fetched from the personal space</span>
- <span style="color: #333333">**Without a personal space**</span><span style="color: #333333"> - metadata is retrieved from their profile</span>

Metadata can either be posted to a user's profile or to their personal space and then reports generated. For example, <span style="color: #333333">every user in a company could be requested to attach personal metadata such as work phone, phone, location, etc. A company directory can then be generated that includes all of this information</span>

<span style="color: #333333">The </span>`users-report`<span style="color: #333333"> macro can be used when </span><span style="color: #333333">[setting up hierarchical space](https://appfire.atlassian.net/wiki/spaces/COMALACM/pages/655759770)</span><span style="color: #333333">.</span>

## Parameters

| Parameter | Required | Default | Notes | Version |
| --- | --- | --- | --- | --- |
| `value-name` | :check_mark: |  | <span style="color: #000000">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)</span> |  |
| `maxResults` |  | 500 | <span style="color: #091e42">Limits the number of results</span> |  |

## 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:

![image](media://fd99654f-93af-4712-8bf6-563901d99cbd)

The `users-report` macro can be configured to add internal metadata for each user and Comala Metadata app-created space metadata from each user space.

![image](media://b9b862b6-d70e-4bad-902f-5151574bd430)

The macro retrieves metadata for the report from any chosen metadata attached to the personal user space and then, if no personal space exists for the user, from the user profile:

- 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

```plaintext
{users-report:User,Location,Email,Extension,Mobile Phone}
```

## Related macros

> Macro (children)

## Related pages

- [Reporting and Searching](https://appfire.atlassian.net/wiki/spaces/COMALACM/pages/656577723)