Pular para o conteúdo principal
Use esta página para criar um Data Source quando o Reporter precisar ler de um banco externo ou de uma conexão que ainda não está configurada. Se o relatório usa dados internos de produtos Lerian, como Midaz ou CRM, o Data Source pode já existir.

​
Objetivo

Configurar uma conexão externa que Templates e Relatórios possam usar. Por exemplo, crie um Data Source chamado production-postgres que aponta para um banco externo de reporting, ou compliance-readonly para um usuário de banco somente leitura usado pelos operadores de reporting.

​
Quando usar

Use esta tarefa quando:
  • o Data Source necessário ainda não está disponível no Reporter;
  • um novo banco precisa alimentar relatórios;
  • um processo de relatório existente precisa de uma conexão somente leitura separada;
  • os operadores precisam que schemas e campos estejam disponíveis no Template Builder ou em filtros de relatório.
Antes de adicionar um, verifique se o Data Source interno necessário já existe. Criar uma conexão externa duplicada é desnecessário quando o Reporter já tem a fonte configurada. Não use esta tarefa para corrigir uma conexão existente. Use Editar um Data Source e Testar uma conexão de Data Source.

​
Antes de começar

Tenha estes dados em mãos:
  • host, porta e nome do banco;
  • usuário e senha;
  • nomes dos schemas, quando o banco usa schemas;
  • requisitos de SSL e certificado CA, quando exigidos pela infraestrutura;
  • um nome de conexão claro, como production-postgres ou compliance-readonly.
Use credenciais destinadas ao acesso de reporting. Um Data Source dá ao Reporter acesso para ler dados usados em Templates e Relatórios.

​
Passo a passo

1

Abra Data Sources

Vá para Data Sources e clique em Adicionar Data Source.
2

Preencha os dados de conexão

Em Adicionar Data Source, informe Nome da Conexão, Tipo de Banco de Dados, Host, Porta, Nome do Banco de Dados, Usuário e Senha.
3

Configure schemas quando necessário

Para os tipos de banco em que o Console exibe Schemas (atualmente PostgreSQL no seletor), adicione os schemas que o Reporter deve inspecionar. Digite o nome do schema e clique em Add, ou pressione Enter.
4

Configure SSL quando necessário

Expanda Configuração SSL, ative Habilitar SSL, selecione Modo SSL e cole o Certificado CA se sua infraestrutura exigir.
5

Adicione metadados quando útil

Expanda Metadata para adicionar campos chave-valor que ajudem os operadores a classificar a conexão.
6

Crie o Data Source

Clique em Criar.
7

Teste a conexão

O novo Data Source aparece com status Desconectado. Rode Testar Conexão antes de usá-lo em Templates ou Relatórios.

​
Guia de campos

CampoO que informarExemplo
Nome da ConexãoNome obrigatório visível ao operador. Campo técnico: configName. Validação no Console: 3 a 100 caracteres.production-postgres
Tipo de Banco de DadosEngine de banco obrigatório. O Console atualmente oferece POSTGRESQL e MONGODB. Campo técnico: type.POSTGRESQL
HostEndereço obrigatório do servidor de banco, não a URL de uma aplicação. Campo técnico: host.db.example.com
PortaPorta obrigatória do banco. Campo técnico: port; faixa válida 1 a 65535.5432
Nome do Banco de DadosNome obrigatório do banco que o Reporter consultará. Campo técnico: databaseName.ledger
UsuárioUsuário obrigatório do banco. Campo técnico: username.reporter_readonly
SenhaSegredo obrigatório ao criar um Data Source. Campo técnico: password.Armazenado pelo formulário
SchemasLista opcional de schemas para os tipos de banco suportados. Armazenado como metadata.schemas; as entradas são aparadas, convertidas para minúsculas e deduplicadas.public, pix, transactions
Habilitar SSLToggle opcional de SSL. Quando ativado, o payload de conexão inclui ssl.Ativado
Modo SSLObrigatório quando SSL está ativado. Use disable, require, verify-ca ou verify-full. Campo técnico: ssl.mode.verify-ca
Certificado CAObrigatório para verify-ca e verify-full. Campo técnico: ssl.ca.Certificado CA em PEM
Campos chave/valor de MetadataDados opcionais de classificação. Apenas linhas com chave não vazia são enviadas. Campo técnico: metadata.environment = production

​
Resultado esperado

O novo Data Source externo aparece na página Data Sources com status Desconectado até ser testado. Após um teste bem-sucedido, os operadores podem usar os campos dele em Templates e Relatórios.

​
Erros comuns e pontos de atenção

Host deve ser o endereço do servidor de banco, como db.example.com, não a URL de uma aplicação ou painel administrativo.
Se o banco usa schemas e o schema necessário não está listado, os operadores podem não ver as tabelas e campos esperados.
Se a infraestrutura exige SSL ou certificado CA, a conexão pode falhar até que Configuração SSL corresponda a esse requisito.
Nomes como db1 são difíceis de usar com segurança. Prefira nomes que mostrem ambiente e propósito, como production-compliance-readonly.

​
Próximos passos

API equivalente

Endpoint Criar connection