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

# Gerar um Relatório

> Gere um Relatório regulatório por meio de um assistente de quatro etapas que guia você da seleção do Template até a saída final compilada, pronta para envio.

Use esta página para gerar um Relatório a partir de um Template existente. A geração é o momento em que o Reporter aplica um Template aos dados e cria um arquivo que você pode monitorar, visualizar e baixar.

## Objetivo

***

Crie um Relatório gerado para uma necessidade operacional, período, entidade, status ou envio específico.

Por exemplo, gere um CSV mensal para as transações de maio, um arquivo XML para um envio regulatório, ou um resumo em PDF filtrado para um segmento de clientes.

## Quando usar

***

Use esta tarefa quando:

* o Template está pronto.
* a Fonte de Dados usada pelo Template está disponível. Ela pode ser uma fonte interna já configurada para o ambiente ou uma fonte externa adicionada em **Fontes de Dados**.
* um operador precisa produzir um arquivo de Relatório.
* o Relatório precisa de filtros opcionais, como intervalo de datas, status, tipo ou entidade.

Não use esta tarefa para alterar a estrutura do Template. Atualize o Template primeiro e depois gere um novo Relatório.

## Antes de começar

***

Confirme:

* o Template selecionado é o correto para a obrigação.
* o formato de saída do Template corresponde ao arquivo que você precisa entregar.
* a Fonte de Dados usada pelo Template está disponível. Teste a conexão quando o relatório depender de uma que pode ter mudado.
* você sabe se o Relatório deve incluir todos os dados ou um subconjunto filtrado.
* os valores dos filtros são precisos o suficiente para o período do relatório.

<Note>
  O Reporter gera Relatórios de forma assíncrona. Um novo Relatório começa em `Processing` e apenas fica disponível para download quando atinge `Finished`.
</Note>

## Passo a passo

***

<Steps>
  <Step title="Abrir a página Relatórios">
    Vá para **Relatórios** e clique em **Novo Relatório**.
  </Step>

  <Step title="Selecionar o Template">
    Na etapa **Template**, escolha o Template que define a estrutura e o formato de saída. Clique em **Próximo**.
  </Step>

  <Step title="Adicionar filtros quando necessário">
    Na etapa **Filtros**, adicione um ou mais filtros para restringir os dados. Esta etapa é opcional. Se o Relatório deve incluir todos os dados disponíveis, clique em **Próximo**.
  </Step>

  <Step title="Revisar a configuração">
    Na etapa **Revisão**, verifique o Template selecionado e os filtros aplicados.
  </Step>

  <Step title="Gerar o Relatório">
    Clique em **Gerar Relatório**. O assistente avança para a etapa **Gerar** e acompanha o progresso enquanto o Reporter cria o arquivo.
  </Step>

  <Step title="Monitorar o status">
    Quando a geração é bem-sucedida, o assistente oferece as ações **Baixar** e **Ver na Lista**. Se você fechar o assistente antes, o Relatório aparece na lista com status `Processing`. Espere até atingir `Finished` antes de baixá-lo.
  </Step>
</Steps>

## Guia de campos

***

| Campo              | O que informar                                                                                                                                                                                | Exemplo                  |
| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ |
| **Template**       | Template obrigatório selecionado na etapa **Template**. O valor técnico enviado à API é `templateId`.                                                                                         | `Monthly tax CSV`        |
| Buscar templates   | Busca opcional na interface. Ela filtra a lista de Templates carregada por nome ou nome de arquivo e não é enviada no payload de geração.                                                     | `tax`                    |
| **Banco de Dados** | Obrigatório apenas quando uma linha de filtro é usada. Selecione a conexão da Fonte de Dados; o payload usa esse valor como `database`.                                                       | `production-postgres`    |
| **Tabela**         | Obrigatório apenas quando uma linha de filtro é usada. Selecione uma tabela do esquema da conexão.                                                                                            | `transactions`           |
| **Campo**          | Obrigatório apenas quando uma linha de filtro é usada. Selecione o campo a comparar.                                                                                                          | `created_at`             |
| **Operador**       | Obrigatório apenas quando uma linha de filtro é usada. Use `eq`, `gt`, `gte`, `lt`, `lte`, `between`, `in` ou `nin`.                                                                          | **Entre** / `between`    |
| **Valores**        | Obrigatório apenas quando uma linha de filtro é usada. `between` exige exatamente dois valores; `in` e `nin` aceitam valores separados por vírgula; os demais operadores usam um único valor. | `2026-05-01, 2026-05-31` |

## Exemplos de filtro

***

| Filtro                                          | Resultado                                       |
| ----------------------------------------------- | ----------------------------------------------- |
| `status` **Igual** `active`                     | Inclui apenas os registros ativos.              |
| `created_at` **Entre** `2026-05-01, 2026-05-31` | Inclui registros de maio de 2026.               |
| `type` **Em** `credit,debit`                    | Inclui qualquer um dos dois tipos de transação. |
| `amount` **Maior que** `1000`                   | Inclui registros com valor acima de 1000.       |

## Status e próxima ação

***

| Status       | O que significa                                                                       | Ação do operador                                                                                                               |
| ------------ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `Processing` | O Reporter está gerando o arquivo.                                                    | Espere. A lista atualiza automaticamente.                                                                                      |
| `Finished`   | O arquivo está pronto.                                                                | Visualize, pré-visualize ou baixe o Relatório.                                                                                 |
| `Partial`    | Algumas seções de dados falharam. O Relatório cobre apenas as seções que responderam. | Revise as seções com falha nos detalhes do Relatório, verifique a saúde da Fonte de Dados e gere novamente depois da correção. |
| `Error`      | O Reporter encontrou um erro durante a geração.                                       | Revise a mensagem e gere novamente depois da correção.                                                                         |

## Resultado esperado

***

Um novo Relatório aparece na página **Relatórios**. Quando atinge `Finished`, os operadores podem pré-visualizar ou baixar o arquivo gerado.

## Erros comuns e pontos de atenção

***

<AccordionGroup>
  <Accordion title="Gerar com o Template errado">
    O Template controla o layout e o formato de saída. Se você selecionou o Template errado, gere um novo Relatório com o Template correto.
  </Accordion>

  <Accordion title="Usar uma Fonte de Dados que não foi testada">
    Conexões com falha ou desatualizadas podem causar erros de geração. Teste a Fonte de Dados antes de gerar Relatórios operacionais quando a saúde da conexão for incerta, especialmente para bancos de dados externos ou credenciais alteradas recentemente.
  </Accordion>

  <Accordion title="Usar filtros amplos por engano">
    Filtros vazios podem incluir todos os dados disponíveis. Confirme se o Relatório deve cobrir todos os registros ou apenas um período, status ou entidade específicos.
  </Accordion>

  <Accordion title="Esperar download imediato">
    O download apenas fica disponível depois que o Relatório atinge `Finished`.
  </Accordion>
</AccordionGroup>

## Próximos passos

***

* Use [Baixar um Relatório](/pt/products/reporter/console/downloading-a-report) quando o status for `Finished`.
* Use [Corrigir um Relatório](/pt/products/reporter/console/editing-a-report) se o arquivo gerado tiver dados, layout ou formato errados.
* Use [Testar a conexão de uma Fonte de Dados](/pt/products/reporter/console/testing-a-data-source) se a geração falhar por problemas de conexão ou esquema.

<CardGroup cols={2}>
  <Card title="Criar relatório" icon="code" href="/pt/reference/products/reporter/create-report">
    Gere Relatórios de forma programática.
  </Card>

  <Card title="Verificar status do relatório" icon="code" href="/pt/reference/products/reporter/check-report-status">
    Consulte o status da geração antes do download.
  </Card>
</CardGroup>
