> For the complete documentation index, see [llms.txt](https://docs.openiam.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openiam.com/administration-guide/reports.md).

# Report builder

The report builder — browse the Data Catalog, build a report from entities or a view, filter and group it, run it to CSV or Excel, schedule and e-mail it, and manage the files it produces.

OpenIAM 2026.10.1 adds a **report builder** to the Webconsole: a Data Catalog of the entities OpenIAM knows about, a wizard and a designer that turn a selection of those entities into a report, and a report service that runs the report to a CSV or Excel file, on demand or on a schedule, and delivers the file by e-mail. This section explains all of it, for the people who build reports, the people who receive them, and the operators who keep the service running.

It replaces nothing yet: the [shipped reports](/administration-guide/reference/shipped-reports.md) of the older reporting engine still exist and still run from **Reports** in SelfService. The report builder is a separate feature with its own menu, its own database and its own service.

## Start here

| If you are…                                     | Read                                                                                                                                                                                   |
| ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Anyone who has just heard of the report builder | [Report builder overview](/administration-guide/reports/overview.md) — the vocabulary, what a report is made of, the rules every report obeys, the limits. No settings                 |
| Looking for the data                            | [Browse the Data Catalog](/administration-guide/reports/data-catalog.md) — entities, fields, relationships, the Database and OpenSearch backends, the access badges                    |
| Building your first report                      | [Create a report](/administration-guide/reports/create-a-report.md) — the ten-step wizard, from the name to the review                                                                 |
| Narrowing the rows                              | [Filters and parameters](/administration-guide/reports/filters-and-parameters.md) — every operator, custom logic, related-record conditions, "Ask when running"                        |
| Changing a report you already have              | [Design a report](/administration-guide/reports/design-a-report.md) — the designer tabs, calculated fields, grouping and totals                                                        |
| Naming the files it produces                    | [Name the output files](/administration-guide/reports/output-file-names.md) — the placeholders, the default, the example helper                                                        |
| Building something several reports can share    | [Views and SQL data sources](/administration-guide/reports/views-and-sql-sources.md) — the visual builder, joins, and the administrator-only SQL source                                |
| Finding, cloning or deleting reports            | [Manage reports](/administration-guide/reports/manage-reports.md) — the Reports list and the details page                                                                              |
| Collecting the output                           | [Run a report and download the file](/administration-guide/reports/run-and-download.md) — Run, Export, Preview, Run history, the Download center, retention                            |
| Automating it                                   | [Schedule and deliver a report](/administration-guide/reports/schedule-and-deliver.md) — the schedule sheet, time zones, delivery by e-mail or SFTP, attachments and links             |
| Watching the queue                              | [Job Monitor](/administration-guide/reports/job-monitor.md) — running, queued and recent runs, cancel, retry, error codes                                                              |
| Deciding who sees what                          | [Access and permissions](/administration-guide/reports/access-and-permissions.md) — owners, super administrators, templates, entity permissions, locked fields                         |
| Starting from a shipped report                  | [System templates](/administration-guide/reports/system-templates.md) — the templates OpenIAM ships and how to make one your own                                                       |
| Running the service                             | [Operate the report service](/administration-guide/reports/operate-the-report-service.md) — databases, the file store, the queue, the nightly purge, every property, the audit actions |

## Where it lives

Everything described here is under Webconsole → **Audit & Reports** → **Reports**. The branch has four leaves:

| Menu item    | Route                                    | What it is                               |
| ------------ | ---------------------------------------- | ---------------------------------------- |
| Reports      | `/webconsole-v2/audit/reports`           | Your reports and the system templates    |
| Data Catalog | `/webconsole-v2/audit/report-catalog`    | The entities and views reports can read  |
| Job Monitor  | `/webconsole-v2/audit/reports/jobs`      | The run queue; super administrators only |
| Downloads    | `/webconsole-v2/audit/reports/downloads` | Every file generated for you             |

There is no SelfService screen for the report builder in this release. The one SelfService page involved is the access request that **Request access** opens from a locked entity.

## The example that runs through every page

The same report appears on every page, so the numbers and names agree from one page to the next.

* **Contractor role access** — a report built by Dana Okafor, an IAM analyst, from the **User** entity joined to **User role membership** and **Role**. It keeps users whose employee type is `CONTRACTOR`, groups them by role name and counts the users per role. It runs every Monday at 08:00 Europe/Rome as an Excel file named `Contractor_role_access_2026-10-12.xlsx`, keeps each file for 30 days and e-mails it to `compliance@example.com`, the compliance team's shared mailbox.
* **Inactive users** — one of the shipped system templates, over the **Login** entity. Dana clones it, changes the window from 90 to 60 days and schedules the copy.
* **Inactive users (last login)**, the template itself, cannot be edited or scheduled. Cloning is the way to make it yours.

## Files in this folder that are not articles

* `anchors.json` maps product UI elements to the sections here. It is a build input for the frontend's "book icon" deep links, so editing it is a product change. The entry shape and the anchor naming convention are in `_FRONTEND-WIRING.md`, which also says what the frontend still has to do before the icons render for this section.
* `_OPEN-QUESTIONS.md` lists what could not be confirmed when these pages were written, and the product gaps the pages describe as they are.
* `_screenshots/report-shot-list.md` lists the screenshots the pages are written to carry, with file names and alt text, for whoever captures them.

None of the three is listed in `SUMMARY.md`.

## Related

* [Shipped reports](/administration-guide/reference/shipped-reports.md) — the older reporting engine's report definitions
* [Create a batch task](/administration-guide/automation/batch-tasks.md) — the scheduler that fires report schedules and the nightly purge
* [Mail and notifications](/administration-guide/platform/mail-and-notifications.md) — the mail setup report delivery depends on
* [Audit actions and retention](/administration-guide/reference/audit-actions-and-retention.md) — where the report builder's audit entries sit in the catalogue


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.openiam.com/administration-guide/reports.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.