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

# Envio Regulatório

> Assine um documento regulatório para uma instituição, mapeie suas tabelas para os campos dele e depois gere, corrija e aprove o envio no módulo Reporter do Lerian Console.

O Reporter tem três telas regulatórias, no grupo **Regulatórios** do menu à esquerda. O Reporter guarda o contrato de cada documento: os campos de que o arquivo dele precisa. Você assina um documento, mapeia suas tabelas e colunas para os campos dele e gera um rascunho. Depois você corrige o rascunho, se necessário, e o aprova. O rascunho aprovado se torna o envio.

| Tela | O que ela faz |
| - | - |
| **Catálogo** | Lista os documentos que este ambiente consegue entregar. Você assina aqui. |
| **Meus regulatórios** | Lista as suas assinaturas. Aqui você verifica a prontidão, abre o mapeamento e gerencia versões. |
| **Entregas** | Lista os rascunhos e os envios aprovados. Aqui você gera, corrige, aprova e baixa. |

Um envio é feito para uma instituição. Cadastre pelo menos uma instituição na página [Instituições](https://docs.lerian.studio/pt/products/reporter/console/managing-institutions.md) antes de assinar um documento.

## Explorar o catálogo

***

No menu à esquerda da página do **Reporter**, abra **Regulatórios** e depois **Catálogo**. Cada cartão mostra o título e a versão do documento.

A linha **Mapeamento de referência** de um cartão informa se a Lerian inclui um mapeamento para o Midaz. Com um mapeamento de referência, você assina sem mapear nada. O mapeamento de referência exige uma rubrica COSIF em toda rota de operação e o CNPJ da organização. Sem um, você mapeia os campos desde o início.

Quando uma versão mais nova de um documento está disponível, o cartão mostra **Atualizar**. Esse botão atualiza todas as assinaturas ativas que estão atrás. Uma assinatura inativa mantém a versão dela. Uma assinatura continua gerando com a versão adotada até você atualizá-la.

Quando o catálogo está vazio, nenhum documento regulatório está montado neste ambiente. Um administrador monta o catálogo regulatório no serviço Reporter.

## Assinar um documento

***

**1. Abrir o diálogo**

Em um cartão do **Catálogo**, clique em **Assinar**. O diálogo **Assinar documento** abre.

**2. Escolher a instituição**

Com uma instituição, o diálogo usa essa instituição. Com várias, escolha a instituição que entrega o documento.

**3. Escolher o mapeamento**

Quando o documento inclui um mapeamento de referência, escolha **Usar o mapeamento de referência do Midaz** ou **Mapear minha própria base**. **Mapear minha própria base** começa de um mapeamento vazio. Sem um mapeamento de referência, o diálogo não pergunta.

**4. Assinar**

Clique em **Assinar**. O diálogo **Documento assinado** mostra o que o mapeamento inicial consegue ler agora e o que ele não consegue ler.

A assinatura fixa a versão publicada mais recente do documento. Para mudar a versão depois, use **Atualizar**. Veja [Gerenciar uma assinatura](#manage-a-subscription).

## Mapear os campos

***

Em **Meus regulatórios**, selecione **Abrir mapeamento** no menu () de uma assinatura. A página do mapeamento mostra a versão do mapeamento e duas seções:

* **O que este mapeamento lê**: as consultas do mapeamento. Uma consulta lê uma tabela de uma das suas Fontes de Dados, ou as linhas de outra consulta. Para adicionar uma consulta que lê uma tabela, clique em **Adicionar consulta**. Uma consulta pode juntar tabelas, filtrar linhas e calcular um valor e dar a um valor o sinal de mais ou de menos a partir de outra coluna. Ela também pode agrupar e somar linhas, e ler cada item de uma lista em uma coleção do MongoDB. **Pré-visualizar as linhas** mostra as primeiras linhas que uma consulta retorna. Ela não salva nada.
* **O que o documento pede**: uma linha para cada campo que o regulador declara. Para cada conjunto, escolha a consulta que preenche as linhas dele. Depois escolha de onde cada campo é lido. Um conjunto que o documento deixa consolidar também aceita consultas das suas outras Fontes de Dados.

| De onde o campo é lido | O que você informa |
| - | - |
| **Uma coluna da consulta deste conjunto** | A coluna da consulta que preenche o conjunto. |
| **Uma coluna casada com as linhas publicadas** | A coluna. Esta opção aparece quando o documento publica linhas para o conjunto. |
| **O mesmo valor sempre** | O valor. |
| **Um valor informado quando a declaração é gerada** | O parâmetro do documento que preenche o campo. |
| **Preenchido por uma pessoa no rascunho** | Um valor, ou uma nota que diz o que ainda falta. O Reporter recusa um campo sem valor e sem nota. |

Clique em **Salvar mapeamento**. Se o Reporter recusar o mapeamento, a página mostra o motivo e mantém as suas alterações.

Um mapeamento de referência abre bloqueado. Para editá-lo, clique em **Editar mapeamento** e confirme que você o tira da referência. Você ainda pode adicionar fontes das suas outras Fontes de Dados aos conjuntos que permitem isso, sem desbloquear a referência. Para recomeçar, clique em **Recomeçar**, depois selecione **Restaurar o mapeamento de referência do Midaz** ou **Começar de um mapeamento em branco**. Quando você restaura o mapeamento de referência, as fontes adicionais continuam. Os envios já gerados mantêm o mapeamento que os gerou.

## Verificar a prontidão

***

Em **Meus regulatórios**, o Reporter verifica cada assinatura ativa contra os seus bancos de dados como eles estão agora. A coluna **Prontidão** mostra o resultado. Clique no resumo para abrir ou fechar os detalhes. As assinaturas desativadas ficam ocultas até você selecionar **Mostrar desativadas**.

| Resultado | O que significa |
| - | - |
| **Pronto** | Cada campo de que o documento precisa está preenchido. |
| **Faltam N campos obrigatórios** | Nada preenche esses campos ainda. O resultado lista esses campos. |
| **Não vai gerar** | O mapeamento lê uma Fonte de Dados que ninguém cadastrou, ou uma tabela ou coleção que o seu banco de dados não tem. Ele também pode ler uma coluna ou campo que não existe. Ou os registros de uma coleção do MongoDB guardam valores de um tipo que o mapeamento não consegue ler. Ou o mapeamento pede algo que o Reporter não consegue executar. |
| **Verificado em parte** | Uma tabela respondeu, mas não disse quais colunas tem. |
| **Não verificado** | Um banco de dados não respondeu, ou nenhuma consulta rodou contra os seus bancos de dados. |

Os avisos aparecem à parte e não bloqueiam a geração. Para verificar de novo, abra o mapeamento e clique em **Verificar agora**.

## Gerar um rascunho

***

**1. Abrir o diálogo**

Abra **Entregas** e clique em **Nova entrega**. Escolha um documento que você assina. A lista mostra apenas assinaturas ativas. Clique em **Continuar**.

**2. Preencher os parâmetros**

O documento define os parâmetros de que o envio precisa. Escreva um mês de competência como `YYYY-MM` e uma data como `YYYY-MM-DD`. Alguns documentos são entregues em meses específicos. O campo informa quais meses.

**3. Gerar**

Clique em **Gerar**. O diálogo **Rascunho gerado** lista os campos em branco. Um campo em branco é um campo que o mapeamento não conseguiu preencher. Ele não é uma falha de geração.

**4. Abrir o envio**

Clique em **Abrir a entrega**.

O rascunho é um Relatório com o status `Draft`. Ele aparece em **Entregas**. Ele não aparece na fila de [Relatórios gerados](https://docs.lerian.studio/pt/products/reporter/console/managing-reports.md).

## Encontrar um envio

***

**Entregas** lista todos os documentos regulatórios gerados: rascunhos para revisar, envios aprovados e gerações que falharam, com o motivo. Filtre a lista por documento ou por instituição. Para ver uma assinatura, selecione **Ver entregas** no menu dela em **Meus regulatórios**.

A lista mostra apenas as gerações atuais. Um rascunho mais novo ou um envio aprovado da mesma assinatura, do mesmo período e da mesma remessa toma o lugar de um rascunho mais antigo, que vira histórico. Uma geração que não termina como rascunho não substitui nada. Para listar os mais antigos, selecione **Mostrar gerações substituídas**. Um rascunho substituído não pode ser corrigido nem aprovado.

## Corrigir e aprovar o envio

***

A página do envio mostra o status, os campos em branco, o **Conteúdo do arquivo**, as **Correções** e a **Procedência**. A **Procedência** mostra o documento, a versão do documento, a versão do mapeamento, o horário da geração, os parâmetros e o checksum do arquivo (SHA-256).

Enquanto um campo obrigatório estiver em branco, você não pode aprovar nem baixar o envio. A página lista cada campo em branco.

### Corrigir um valor

**1. Escolher a célula**

Na página do envio de um `Draft`, encontre o valor em **Conteúdo do arquivo**. Busque em um conjunto ou selecione **Só corrigidas**. Clique na célula. O diálogo **Corrigir** abre com o conjunto, a linha e o campo já escolhidos.

**2. Informar a correção**

Informe o **Novo valor**. Em **Por quê (registrado na trilha de auditoria)**, escreva por que o valor muda. O motivo é obrigatório.

**3. Aplicar**

Clique em **Aplicar correção**.

Uma correção é uma intervenção manual no arquivo. O Reporter não recalcula nada. Se o valor soma em outras linhas, ou se outras linhas somam nele, corrija essas também. Quando o dado está errado na origem, corrija a origem e gere de novo. Um aviso lista as linhas acima de uma correção que você não corrigiu. Ele não bloqueia a aprovação.

Algumas células ficam bloqueadas. Um campo que identifica a linha não pode mudar. Um campo derivado segue o campo de que vem. O CNPJ da instituição é fixo na origem.

As **Correções** mostram cada alteração, quem a fez e o motivo.

### Aprovar o rascunho

**1. Abrir o diálogo**

Na página do envio de um `Draft`, clique em **Aprovar**. O Console esconde **Aprovar** enquanto um campo obrigatório estiver em branco.

**2. Confirmar**

Clique em **Aprovar como declaração**.

O rascunho se torna o envio, com o status `Final`. Um envio `Final` recusa correções, e a procedência dele não muda.

### Baixar e substituir

Clique em **Baixar** na página do envio para obter o arquivo. O formato do arquivo vem do envio. Você pode baixar um envio `Draft` ou `Final` sem campo obrigatório em branco.

Quando o documento declara uma remessa de substituição, um envio `Final` também oferece **Gerar substituição**. O botão aparece apenas enquanto a assinatura está ativa.

## Gerenciar uma assinatura

***

Em **Meus regulatórios**, a linha de uma assinatura pode mostrar estes itens:

* **Atualizar**: aparece quando o catálogo tem uma versão mais nova. Os envios já produzidos mantêm a versão deles. Depois da atualização, o diálogo mostra o que a nova versão faz com o seu mapeamento.
* **Histórico de versões** no menu (): lista cada versão adotada, da mais nova para a mais antiga.
* **Definir instituição** no menu: aparece quando o tenant tem várias instituições e a assinatura não tem nenhuma. Ele define a instituição dos próximos envios. Uma assinatura que já tem instituição a mantém. Para entregar o documento para outra instituição, assine-o de novo pelo **Catálogo**.
* **Desativar** no menu: para a entrega do documento. A assinatura continua na lista como **Inativa** depois que você seleciona **Mostrar desativadas**. Nada é excluído, e os relatórios já gerados a partir dela continuam legíveis.

Para restaurar uma assinatura inativa com o mapeamento e a versão dela, clique em **Reativar** na linha dela. Quando o documento não tem uma assinatura ativa, o cartão dele no catálogo também tem **Reativar**. O cartão também oferece uma nova assinatura. Ele mostra **Começar do mapeamento da Lerian** quando o documento inclui um mapeamento de referência, e **Começar de um mapeamento vazio** quando não inclui. O mapeamento que você editou continua salvo na assinatura desativada.

## Permissões

***

Para abrir as telas regulatórias, é preciso ter `regulatory:get`. Para abrir **Entregas**, a página do envio e **Baixar**, também é preciso ter `reports:get`. Para assinar ou reativar um documento, gerar um rascunho, corrigir um valor e atualizar uma versão, é preciso ter `regulatory:post`. Para salvar um mapeamento e definir uma instituição, é preciso ter `regulatory:put`. Para desativar uma assinatura, é preciso ter `regulatory:delete`. Para aprovar um rascunho, é preciso ter `regulatory-approval:post`.

## Próximos passos

***

* Use [Gerenciando instituições](https://docs.lerian.studio/pt/products/reporter/console/managing-institutions.md) para cadastrar as instituições que entregam documentos.
* Use [Gerenciando Fontes de Dados](https://docs.lerian.studio/pt/products/reporter/console/managing-data-sources.md) para cadastrar as Fontes de Dados que um mapeamento lê.
* Use [Gerenciando Relatórios](https://docs.lerian.studio/pt/products/reporter/console/managing-reports.md) para os relatórios operacionais gerados a partir de Templates.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.