Skip to main content

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.

Use this page to generate a Report from an existing Template. Generation is the moment Reporter applies a Template to data and creates a file that can be monitored, viewed, and downloaded.

Objective


Create a generated Report for a specific operational need, period, entity, status, or submission. For example, generate a monthly CSV for May transactions, an XML file for a regulatory submission, or a PDF summary filtered to one customer segment.

When to use


Use this task when:
  • the Template is ready;
  • the Data Source used by the Template is available. It may be an internal source already configured for the environment or an external source added from Data Sources;
  • an operator needs to produce a Report file;
  • the Report needs optional filters, such as date range, status, type, or entity.
Do not use this task to change the Template structure. Update the Template first, then generate a new Report.

Before you start


Confirm:
  • the selected Template is the correct one for the obligation;
  • the Template output format matches the file you need to deliver;
  • the Data Source used by the Template is available and tested when the report depends on a connection that may have changed;
  • you know whether the Report should include all data or a filtered subset;
  • the filter values are precise enough for the reporting period.
Reports are generated asynchronously. A new Report starts in Processing and only becomes available for download when it reaches Finished.

Step by step


1

Open the Reports page

Go to Reports and click New Report.
2

Select the Template

In the Template step, choose the Template that defines the output structure and format. Click Next.
3

Add filters when needed

In the Filters step, add one or more filters to narrow the data. This step is optional. If the Report should include all available data, click Next.
4

Review the setup

In the Review step, check the selected Template and applied filters.
5

Generate the Report

Click Generate Report. The wizard shows generation progress and closes after the request is submitted.
6

Monitor the status

The Report appears in the list with Processing status. Wait until it reaches Finished before downloading.

Field guide


FieldWhat to enterExample
TemplateRequired Template selected in the Template step. The technical value sent to the API is templateId.Monthly tax CSV
Search templatesOptional UI search. It filters the loaded Template list by name or file name and is not sent in the generation payload.tax
DatabaseRequired only when a filter row is used. Select the Data Source connection; the payload uses this value as database.production-postgres
TableRequired only when a filter row is used. Select a table from the connection schema.transactions
FieldRequired only when a filter row is used. Select the field to compare.created_at
OperatorRequired only when a filter row is used. Use eq, gt, gte, lt, lte, between, in, or nin.Between / between
ValuesRequired only when a filter row is used. between needs exactly two values; in and nin accept comma-separated values; other operators use one value.2026-05-01, 2026-05-31

Filter examples


FilterResult
status Equal activeIncludes only active records.
created_at Between 2026-05-01, 2026-05-31Includes records from May 2026.
type In credit,debitIncludes either transaction type.
amount Greater Than 1000Includes records with amount above 1000.

Status and next action


StatusWhat it meansOperator action
ProcessingReporter is generating the file.Wait. The list refreshes automatically.
FinishedThe file is ready.View, preview, or download the Report.
ErrorReporter found an error during generation.Review the message and generate again after correction.
PendingExtractionReporter is waiting for data extraction before final processing.Wait or review Data Source health if it does not progress.

Expected result


A new Report appears on the Reports page. When it reaches Finished, operators can preview or download the generated file.

Common errors and care points


The Template controls layout and output format. If the wrong Template is selected, generate a new Report with the correct Template.
Failed or outdated connections can cause generation errors. Test the Data Source before generating operational Reports when connection health is uncertain, especially for external databases or recently changed credentials.
Empty filters can include all available data. Confirm whether the Report should cover all records or only a specific period, status, or entity.
Download is only available after the Report reaches Finished.

Next steps


Create report

Generate Reports programmatically.

Check report status

Poll generation status before download.