Skip to main content
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. Start with Templates if internal product Data Sources are already configured. 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.
  • Institutions define who a Report is for, and which rows each institution reads.
  • Templates define the structure and output format of the file.
  • Reports are the files that Reporter generates from a Template. You can monitor, view, and download them.
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. It also tells you which Template, output format, and filters you need.

​
Prerequisites

If one of these items is absent, stop there first. Reporter can only generate useful files when you know the Template, the intended output, and the relevant data connection.

​
Minimum setup sequence

1

Confirm access and choose the first report

Start from the Reporter overview. Confirm that the team knows which report to create 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 that Data Source. Test it before you build 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. The Console tests the connection when you save it.Use Adding a Data Source and Testing a Data Source connection.
3

Register the institutions

Register each institution that the tenant reports for, with its CNPJ and its scope. A Report reads for one institution or for all of them. A regulatory filing is made for one institution.Use Managing Institutions. Use Propose from Midaz to start from the organizations that Midaz already holds.
4

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.
5

Generate a Report

On the Reports page, create a report from the Template. Select the Template. Choose the institution and fill in the parameters when the wizard asks. 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.
6

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 Error or Partial failure, inspect the details. Then run it again after you fix the Data Source, Template, or filter inputs. Use Downloading a report when the file is ready.
7

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.

​
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.
An external connection may exist, but its credentials and network access 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 you must automate, integrate, or debug the same workflow with engineering support.

Reporter API reference

Use when you must automate or integrate the Reporter workflow through APIs.