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

> Ative 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 **Envio Regulatório** é a página do Reporter onde você entrega documentos regulatórios. O Reporter guarda o contrato de cada documento: os campos de que o arquivo dele precisa. Você ativa 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.

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

## Abrir o Envio Regulatório

***

No menu à esquerda da página do **Reporter**, clique em **Envio Regulatório**. A página tem dois painéis:

* **Catálogo de documentos**: os documentos que este ambiente consegue entregar. Cada cartão mostra o título e a versão do documento. O cartão também informa se o documento inclui um mapeamento de referência da Lerian. Com um mapeamento de referência, você o corrige. Sem um, você mapeia os campos desde o início.
* **Suas assinaturas**: os documentos que você entrega. A tabela mostra **Documento**, **Versão adotada**, **Versão do mapeamento**, **Status**, **Prontidão** e **Ações**. O **Status** é **Ativa** ou **Inativa**.

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.

## Ativar um documento

***

<Steps>
  <Step title="Abrir o diálogo">
    Em um cartão do **Catálogo de documentos**, clique em **Ativar**. O diálogo **Ativar documento** abre.
  </Step>

  <Step title="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.
  </Step>

  <Step title="Escolher a versão">
    Deixe **Versão** em branco para fixar a versão publicada mais recente. Para fixar outra versão, digite essa versão.
  </Step>

  <Step title="Ativar">
    Clique em **Ativar**. O diálogo **Documento ativado** mostra o que o mapeamento inicial consegue ler agora e o que ele não consegue ler.
  </Step>
</Steps>

A ativação fixa a versão. Para mudar a versão depois, use **Adotar outra versão**. Veja [Gerenciar uma assinatura](#manage-a-subscription).

## Mapear os campos

***

No menu (<Icon icon="ellipsis-vertical" />) de uma assinatura, selecione **Abrir mapeamento**. A página do mapeamento tem duas seções:

* **O que este mapeamento lê**: as consultas do mapeamento. Cada consulta lê uma tabela de uma das suas Fontes de Dados. Para adicionar uma consulta, clique em **Adicionar consulta**.
* **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.

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

## Verificar a prontidão

***

Na coluna **Prontidão** de uma assinatura ativa, clique em **Verificar agora**. O Reporter verifica o mapeamento contra os seus bancos de dados como eles estão agora. O resultado abre abaixo da linha.

| 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, uma tabela que o seu banco de dados não tem ou uma coluna que a tabela não tem. 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. |

Para verificar de novo, clique em **Verificar de novo**.

## Gerar um rascunho

***

<Steps>
  <Step title="Abrir o diálogo">
    No menu (<Icon icon="ellipsis-vertical" />) de uma assinatura ativa, selecione **Gerar um rascunho**.
  </Step>

  <Step title="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.
  </Step>

  <Step title="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.
  </Step>

  <Step title="Abrir o envio">
    Clique em **Abrir a entrega**.
  </Step>
</Steps>

O rascunho é um Relatório com o status `Draft`. Ele também aparece na página [Relatórios](/pt/products/reporter/console/managing-reports).

## Corrigir e aprovar o envio

***

A página do envio mostra o status, os campos em branco, 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

<Steps>
  <Step title="Abrir o diálogo">
    Na página do envio de um `Draft`, clique em **Corrigir um valor**.
  </Step>

  <Step title="Encontrar o valor">
    Informe o **Conjunto** e o **Campo**. Para selecionar uma linha, clique em **Adicionar chave** para cada chave da linha e informe a **Chave** e o **Valor** dela. Deixe as chaves vazias para um conjunto com uma linha.
  </Step>

  <Step title="Informar a correção">
    Informe o **Valor corrigido**. Em **Por quê (registrado na trilha de auditoria)**, escreva por que o valor muda. O motivo é obrigatório.
  </Step>

  <Step title="Aplicar">
    Clique em **Aplicar correção**.
  </Step>
</Steps>

O Reporter gera o arquivo de novo a partir das mesmas linhas, então nenhum outro valor muda. As **Correções** mostram cada alteração, quem a fez e o motivo.

### Aprovar o rascunho

<Steps>
  <Step title="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.
  </Step>

  <Step title="Confirmar">
    Clique em **Aprovar como declaração**.
  </Step>
</Steps>

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

<h2 id="manage-a-subscription">
  Gerenciar uma assinatura
</h2>

***

O menu (<Icon icon="ellipsis-vertical" />) de uma assinatura ativa também tem estes itens:

* **Definir instituição**: muda a instituição dos próximos envios. Os relatórios já gerados mantêm a instituição deles. Este item aparece quando o tenant tem várias instituições.
* **Adotar outra versão**: muda a versão que você entrega. Deixe **Versão a adotar** em branco para usar a versão publicada mais recente. O Reporter recusa uma versão que não existe. Os envios já produzidos mantêm a versão deles. Depois que você adota uma versão, o diálogo mostra o que a nova versão faz com o seu mapeamento.
* **Desativar**: para a entrega do documento. A assinatura continua na lista como **Inativa**. 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 a página **Envio Regulatório**, é preciso ter `regulatory:get`. Para ativar ou reativar um documento, gerar um rascunho, corrigir um valor e adotar outra versão, é preciso ter `regulatory:post`. Para mapear os campos dele e definir a instituição dele, é 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](/pt/products/reporter/console/managing-institutions) para cadastrar as instituições que entregam documentos.
* Use [Gerenciando Fontes de Dados](/pt/products/reporter/console/managing-data-sources) para cadastrar as Fontes de Dados que um mapeamento lê.
* Use [Gerenciando Relatórios](/pt/products/reporter/console/managing-reports) para encontrar um envio entre os seus Relatórios.


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