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 path when you need to make Reporter usable from the Console for the first time. The sequence depends on your data source model: if internal product Data Sources are already configured, start with Templates; if you need an external database, add and test the Data Source first.

​
Before you start

Read the Reporter concepts map if you have not used Reporter before. It explains the operational chain:
  • Data Sources define where Reporter reads data from.
  • Templates define the structure and output format of the file.
  • Reports are generated from a Template and can be monitored, viewed, and downloaded.
Before opening the setup screens, decide which report you want to produce first. For example: “monthly tax report in CSV”, “daily operational report in PDF”, or “regulatory XML file filtered by date range”. That decision tells you whether the needed Data Source already exists, which Template is required, which output format is expected, and which filters you need.

​
Prerequisites

RequirementWhat must be readyWhere it is used
Reporter accessYour organization can access Reporter in the Console.All Reporter pages
Console permissionsYour user can manage Data Sources, Templates, and Reports for the organization.Data Sources, Templates, Reports
Data Source modelWhether the report uses an internal Data Source already configured for products such as Midaz or CRM, or an external database that must be added manually.Setup path
Database connection detailsHost, port, database name, user, password, and any required network or SSL information. Required only when adding an external Data Source.Data Sources
Source data contextThe database, table, fields, and filters that should feed the first report.Data Sources, Reports
Template inputEither an existing .tpl file or enough report structure to build one in the Template Builder.Templates, Template Builder
Output expectationThe required file format, such as CSV, XML, HTML, TXT, or PDF.Templates, Reports
API automation needA decision on whether setup will stay manual in the Console or be automated through the API.API reference
If one of these items is missing, stop there first. Reporter can only generate useful files when the Template, intended output, and relevant data connection are known.

​
Choose the setup path

Use this decision before following the steps:
ScenarioStart withWhy
The report uses internal product data already configured in Reporter.TemplatesInternal Data Sources for products such as Midaz or CRM may already exist, so the operator does not need to create a connection first.
The report uses an external or new database.Data SourcesReporter needs a manually configured and tested connection before templates or filters can use its fields.
The report fails because data is missing or unreachable.Data SourcesTest the connection and confirm schemas, tables, and fields before regenerating.

​
Minimum setup sequence

1

Confirm access and choose the first report

Start from the Reporter overview and confirm that the team knows which report will be created first. Use the overview when you need to explain what each Reporter area is for.Go to Reporter Module and Reporter concepts map.
2

Confirm the Data Source path

Check whether the needed Data Source already exists. Internal product Data Sources may already be configured for the environment. If the report depends on an external database or a missing connection, add and test that Data Source before building reports.On the Data Sources page, use existing connections when they are already present. Add a new connection only when the required source is not available, then run Test Connection before using it in a report.Use Adding a Data Source and Testing a Data Source connection.
3

Add or build a Template

The Template defines the report structure and output format. You can upload an existing .tpl file or build the Template visually in the Console.On the Templates page, use Adding a template. If the operator needs to assemble the layout from blocks, use the Template Builder.
4

Generate a Report

On the Reports page, create a report from the Template. Select the Template, apply filters when needed, review the setup, then generate the file.Use Generating a report. This is the point where a Template becomes a Report; before generation, it is only a reusable definition.
5

Monitor completion and download the file

Generated reports start in Processing. Wait until the status reaches Finished, then view or download the output file.If the report ends in Failed or Error, inspect the details and re-run it after fixing the Data Source, Template, or filter inputs. Use Downloading a report when the file is ready.
6

Track recurring delivery dates when needed

If the report has a recurring deadline, use the Overview page to add the delivery reminder. This keeps upcoming and overdue deliveries visible without changing how reports are generated.Use the reminder only for operational follow-up. It does not create or schedule reports automatically.

​
When to use the API reference

Use the Console for the first operational setup: confirming or creating the Data Source, testing connections when needed, adding or building the Template, generating the first Report, and downloading the file. Use the Reporter API reference when you need to automate or integrate the same workflow, such as:
  • creating or listing Templates from another system;
  • creating reports programmatically;
  • checking report status without opening the Console;
  • downloading generated files through an integration;
  • validating or managing connections outside the operator workflow.
Manual Console setup does not require the API reference. The API reference is for implementation work, automation, and troubleshooting with engineering teams.

​
What happens next

At the end of the setup path, you should have:
  • one relevant Data Source available for the report, either preconfigured internally or manually added and tested;
  • one Template that matches the required output format;
  • one generated Report with Finished status;
  • one downloaded file ready for delivery or validation;
  • optional delivery reminders in the Overview page when the report has recurring deadlines.
After that, the normal operating loop is simple: keep the relevant Data Source healthy when the report depends on one, update the Template when the file structure changes, generate Reports when needed, and download the final output.

​
Common sequencing mistakes

Some environments already include internal Data Sources for Lerian products such as Midaz or CRM. Check the existing list before adding a duplicate external connection.
The connection may exist, but credentials, network access, and schemas still need validation when the report depends on that source. Run Test Connection before relying on it.
The Template should match the required file format. Confirm whether the operation needs CSV, XML, HTML, TXT, or PDF before using it to generate reports.
Operators can complete the first setup in the Console. Use the API reference when the same workflow must be automated, integrated, or debugged with engineering support.

Reporter API reference

Use when the Reporter workflow must be automated or integrated through APIs.