> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# What is Reporter module?

> Configure Data Sources, build Templates, generate Reports, and download the output through a visual interface in the Lerian Console.

**Reporter** is a module inside the [Lerian Console](/en/lerian-console/about-lerian-console) for operating report generation from data already available in your environment.

Use it to define the structure of the output, generate a Report, review its status, and download the final file. When the report needs an external database or a connection needs validation, use **Data Sources** to manage that connection. Typical use cases include regulatory filings, internal audit extracts, recurring operational reports, and ad hoc reports for a specific period.

Reporter does not change how report generation behaves in the product. This page only explains how to operate the Reporter Module from the Console.

<Warning>
  Reporter is only available if you've acquired the Reporter product. Want access? [Get in touch with our team](https://lerian.studio/contact) to learn more.
</Warning>

## Who uses this page

***

This page is for operators who need to produce or manage Reports in the Console. That usually means operations, compliance, finance, regulatory, or support teams responsible for turning stored data into a file that can be reviewed, submitted, or archived.

Developers and integration teams may also use Reporter, but their main reference is the [Reporter API reference](/en/reference/reporter/reporter-developer-quick-start). The Console documentation explains the visual workflow. The API reference explains programmatic access.

## Start here first

***

If this is your first time using Reporter, start by understanding which setup path applies. Some environments already include internal Data Sources for Lerian products, such as Midaz or CRM. In that case, the operator can often start from **Templates** and **Reports**. Use **Data Sources** first when you need to add an external database or validate an existing connection.

<CardGroup cols={2}>
  <Card title="Setup Path" icon="clipboard-list-check" href="/en/lerian-console/reporter-console/reporter-setup-path">
    Choose the right path: use existing internal Data Sources, or add and test an external Data Source before generating Reports.
  </Card>

  <Card title="Concepts Map" icon="network-wired" href="/en/lerian-console/reporter-console/reporter-concepts-map">
    Understand how Data Sources, Templates, Reports, previews, and downloads relate.
  </Card>
</CardGroup>

## What you can operate

***

From the Reporter Module, you can:

* **Manage Data Sources** — Review, test, or register database connections that Reporter can read from during generation. Internal product connections may already exist; external databases are added from this area.
* **Build Templates** — Define the structure and output format of the Report, either by uploading a prepared `.tpl` file or building one visually in Template Builder.
* **Generate Reports** — Run a Template against connected data, with optional filters such as date range, status, or transaction type.
* **Review generation status** — Track whether a Report is `Processing`, `Finished`, `Failed`, or `Error`.
* **Preview and download output** — Open a finished Report in the Console and download the generated file in its configured format, such as CSV, XML, HTML, TXT, or PDF.
* **Track delivery reminders** — Use the Overview area to follow upcoming and overdue reporting deadlines.

## Operational areas

***

The Reporter sidebar is organized around the common operator workflow: understand the current state, define the output, generate and download files, then manage Data Sources when a connection needs to be added, tested, or changed.

<Card title="Overview" horizontal icon="gauge" href="/en/lerian-console/reporter-console/reporter-module">
  Monitor the current Reporter workspace: KPIs, delivery reminders, upcoming deadlines, and recent error count.
</Card>

<Card title="Data Sources" horizontal icon="database" href="/en/lerian-console/reporter-console/managing-data-sources">
  Review internal connections and configure or test external database connections Reporter uses to fetch data.
</Card>

<Card title="Templates" horizontal icon="file-code" href="/en/lerian-console/reporter-console/managing-templates">
  Create, update, preview, and delete Templates that define the Report layout and output format.
</Card>

<Card title="Reports" horizontal icon="file-chart-column" href="/en/lerian-console/reporter-console/managing-reports">
  Generate Reports, monitor their status, preview finished files, and download the result.
</Card>

## Overview area

***

When you open Reporter, you land on **Overview**. Use it as the operating dashboard for the module.

It includes:

* **About Reporter** — a short description of the module and a link to the documentation.
* **Templates** — total number of registered Templates.
* **Reports Generated** — total number of generated Reports.
* **Data Sources** — total number of configured database connections.
* **Errors** — errors recorded in the last 30 days.
* **Delivery Calendar** — recurring or one-off reporting deadlines shown by date.
* **Upcoming Deadlines** — the next reminders, their due dates, and their status.

Delivery reminders help operators manage reporting routines. They do not generate or submit Reports automatically. Report generation still happens from the **Reports** area.

## Main tasks

***

<CardGroup cols={2}>
  <Card title="Add a Data Source" icon="plus" href="/en/lerian-console/reporter-console/adding-a-data-source">
    Register an external database connection when the needed Data Source is not already configured.
  </Card>

  <Card title="Test a Data Source Connection" icon="plug" href="/en/lerian-console/reporter-console/testing-a-data-source">
    Confirm that credentials, network access, SSL settings, and schema visibility are correct.
  </Card>

  <Card title="Add a Template" icon="file-code" href="/en/lerian-console/reporter-console/adding-template">
    Upload a prepared `.tpl` file or build a Template visually with Template Builder.
  </Card>

  <Card title="Generate a Report" icon="play" href="/en/lerian-console/reporter-console/generating-a-report">
    Run a Template against your data and produce a downloadable file.
  </Card>

  <Card title="Download a Report" icon="download" href="/en/lerian-console/reporter-console/downloading-a-report">
    Save the final file from a finished Report generation.
  </Card>

  <Card title="Correct a Report" icon="pen" href="/en/lerian-console/reporter-console/editing-a-report">
    Learn what to change when a generated Report has the wrong data, layout, or format.
  </Card>
</CardGroup>

## Console vs API

***

Use the **Console** when an operator needs to configure, generate, review, and download Reports through the visual interface.

Use the **API** when a system needs to automate Reporter operations, integrate Reporter into another workflow, or manage Templates, Reports, and Data Source connections programmatically.

The same Reporter concepts apply in both places: Data Sources provide the data, Templates define the output, and Reports are the generated files. The Data Source may be preconfigured for internal Lerian products or manually added for external databases.

## Behavior note

***

This documentation update does not introduce a product behavior change. It clarifies how to operate the existing Reporter Module in the Console and where to use the API reference for integration work.