Business Intelligence (BI) próprio da CEBI

• O que é e o que faz
• Manual de instalação
• Manual de atualização
• Manual do usuário

O que é e o que faz

O Business Intelligence (BI) da CEBI Informática é uma plataforma web de painéis gerenciais (dashboards), desenvolvida pela própria CEBI. Ele transforma dados vindos de outros sistemas em indicadores, gráficos e tabelas prontos para consulta, acompanhamento e apresentação — sem que o usuário precise programar nem montar consultas.

Para que serve

• Acompanhar indicadores de uma operação (faturamento, inadimplência, ordens de serviço, chamados etc.) em um só lugar.
• Comparar e analisar: por período, por categoria (bairro, tipo de serviço, situação…) e com filtros.
• Apresentar resultados em reuniões e em TVs, com atualização automática.
• Compartilhar painéis com quem não usa o sistema, por link somente leitura (público ou com senha).

Como funciona

O uso segue quatro etapas:

Etapa	O que acontece
1. Fonte de dados	Cadastra-se o endereço de uma API (REST) que devolve uma lista de registros em JSON. O BI busca os dados, detecta os campos (valores, datas, categorias, situações) e os atualiza automaticamente na frequência escolhida.
2. Novo dashboard	Escolhe-se a fonte e o BI gera o painel automaticamente, já com indicadores, gráficos e filtros adequados aos dados.
3. Edição	O usuário ajusta o que quiser: adiciona, remove, move e redimensiona componentes, troca títulos e cores.
4. Publicação	O painel publicado pode ser consultado, filtrado, exportado, apresentado e compartilhado por link.

Principais funcionalidades

• Geração automática de dashboards a partir dos dados, com modelos prontos: Visão geral, Comparativo, Acompanhamento e Análise detalhada (ou tela em branco).
• Componentes: indicadores (KPI) com comparação ao período anterior, gráficos de linha, área, barras (verticais e horizontais), pizza/donut, ranking e tabela.
• Filtros: filtros pré-definidos no topo do painel e filtro por clique — ao clicar em uma barra, fatia ou linha de ranking, todo o painel passa a mostrar só aquele valor.
• Paletas de cores prontas (Corporativo, Executivo, Financeiro, Moderno etc.) ou personalizada a partir da cor da marca.
• Exportação do painel em imagem (PNG/JPG) e PDF, e dos dados em Excel (.xlsx) e CSV, respeitando os filtros aplicados.
• Modo apresentação em tela cheia, com relógio e atualização automática a cada 30 segundos.
• Compartilhamento por link somente leitura, público ou protegido por senha, com expiração (7, 15, 30 dias ou sem expiração) e controle de acessos na tela Publicações.
• Atualização automática dos dados de cada fonte (a cada 15 min, 1 hora, 6 horas, diária ou manual).
• Identidade visual da empresa (nome e logotipo) aplicada ao sistema, às exportações e aos links.
• Auditoria de todas as ações (criação, edição, publicação, exclusão, login…).
• Funciona no computador, no tablet e no celular, com modo claro e escuro.

Segurança

• Acesso com e-mail e senha individuais e controle de permissões por perfil (visualizar, criar, editar, excluir) para cada área do sistema.
• Links compartilhados são somente leitura: quem recebe não edita nem exporta, e o link pode ser revogado a qualquer momento.
• Senhas e tokens de acesso às fontes de dados são guardados criptografados.
• Toda ação relevante fica registrada na Auditoria.

Arquitetura e tecnologia

Parte	Tecnologia
Tela (frontend)	React 18 + TypeScript, Vite, Tailwind CSS, Recharts (gráficos), Zustand
API (backend)	.NET 8 (ASP.NET Core, C#), Entity Framework Core, autenticação JWT
Banco de dados	Oracle 19c (SQLite como alternativa local de desenvolvimento)
Publicação	IIS no Windows Server

O usuário acessa a tela pelo navegador; a tela conversa com a API do BI, que guarda painéis, fontes e usuários no Oracle e busca os dados nas APIs de origem. Por isso as APIs de origem precisam estar acessíveis a partir do servidor do BI (não do computador do usuário).

Limitações atuais

• As fontes de dados são APIs REST que respondem a uma consulta simples (GET) com uma lista de registros em JSON. Conexão direta a bancos de dados ou planilhas ainda não está disponível.
• Cada dashboard usa uma única fonte de dados.

Documentação relacionada

• Manual de instalação — como instalar o BI em um Windows Server.
• Manual de atualização — como atualizar uma instalação existente para uma versão nova.
• Manual do usuário — como usar o sistema, passo a passo e com imagens.

Manual de instalação

Este manual descreve como instalar o Business Intelligence (BI) da CEBI em um Windows Server. Ele se destina à equipe de infraestrutura (TI).

Visão geral

O BI tem duas partes obrigatórias, publicadas no IIS do mesmo servidor, e uma parte opcional para demonstrações:

Parte	Pasta no pacote	Porta padrão	Função
API do BI	api/	5080	Conversa com o banco Oracle, busca os dados das fontes e atende a tela.
Tela (frontend)	frontend/	5173	A aplicação que os usuários abrem no navegador.
APIs de demonstração	api-demo/	8092 e 8093	Dados fictícios para apresentações (opcional).

Importante: a tela procura a API no mesmo servidor, na porta 5080 (se a tela abre em http://servidor:5173, ela chama http://servidor:5080/api). Para usar outro servidor ou outra porta para a API, é preciso gerar a tela de novo — fale com a equipe do BI.

Conteúdo do pacote

BI-2026.10.7.1/
├── INSTALAR.bat          → instalação automática (recomendada)
├── Instalar-BI.ps1       → script executado pelo INSTALAR.bat
├── api/                  → API do BI (.NET 8), já compilada
├── frontend/             → tela do BI (arquivos estáticos), já compilada
├── api-demo/             → APIs de demonstração (Node.js)
└── README-INSTALACAO.md  → este guia, em texto

1. Pré-requisitos

Item	Observação
Windows Server 2016 ou mais novo	2019 ou 2022 recomendados.
IIS	O instalador instala sozinho, se faltar (inclui Application Initialization).
.NET 8 – ASP.NET Core Hosting Bundle	https://dotnet.microsoft.com/download/dotnet/8.0 → coluna ASP.NET Core Runtime → Windows → Hosting Bundle. Deve ser instalado depois do IIS (se o IIS for instalado depois, rode o instalador do Hosting Bundle de novo e escolha Reparar).
IIS URL Rewrite	https://www.iis.net/downloads/microsoft/url-rewrite
Node.js 18+ (LTS)	https://nodejs.org — somente para as APIs de demonstração.
Acesso ao Oracle	O servidor precisa alcançar o banco (padrão 192.168.4.2, porta 1521, serviço bi).
Usuário no Oracle	Schema próprio do BI com permissão para criar tabelas e quota no tablespace — a API cria as tabelas sozinha na primeira inicialização.
Portas livres	5080 e 5173 (BI) e 8092/8093 (demonstração).

O driver do Oracle já vem dentro da API — não é preciso instalar o Oracle Client no servidor.

2. Instalação automática (recomendada)

1. Instale os pré-requisitos acima (Hosting Bundle, URL Rewrite e Node.js).
2. Copie o BI-2026.10.7.1.zip para o servidor e extraia o zip inteiro.
3. Dê dois cliques em INSTALAR.bat. Ele pede permissão de administrador sozinho.
4. Responda às perguntas:
   • Oracle: servidor, porta, serviço, usuário e senha (o instalador testa a conexão);
   • Administrador inicial do BI: nome, e-mail e senha.
5. Aguarde a etapa 8/8 – Testando. Ao final aparece "BI INSTALADO COM SUCESSO" e o endereço de acesso para os usuários.

O que o instalador faz

Etapa	Ação
1/8	Confere Windows, IIS, Hosting Bundle, URL Rewrite, Node.js e se as portas estão livres. Instala o IIS, se faltar.
2/8	Pede os dados do Oracle (e testa o acesso) e do administrador inicial.
3/8	Copia a aplicação para C:\BI (api, frontend, api-demo).
4/8	Cria C:\BI\api\appsettings.Production.json com uma chave de segurança aleatória e os endereços do servidor liberados; o arquivo fica legível só por administradores e pela própria API.
5/8	Publica no IIS os sites BI-API (porta 5080) e BI-Web (porta 5173). A API fica sempre ligada (tem rotina de atualização automática das fontes) e guarda as chaves de criptografia em C:\BI\dados\chaves.
6/8	Libera as portas 5080 e 5173 no firewall do Windows.
7/8	APIs de demonstração: cadastra os nomes api.saneamento.cebi e api.os.cebi e cria tarefas agendadas que as deixam ligadas sozinhas, inclusive após reiniciar o servidor.
8/8	Testa a API, a tela e as APIs de demonstração e mostra os endereços de acesso.

Opções do instalador

Executar pelo PowerShell como administrador:

Opção	Uso
.\Instalar-BI.ps1 -InstallDir D:\BI	Instala em outra pasta.
.\Instalar-BI.ps1 -SemDemo	Não configura as APIs de demonstração.
.\Instalar-BI.ps1 -UrlsExtras "http://bi.cebi.local:5173"	Libera um endereço extra (por exemplo, um nome cadastrado no DNS).

O log de cada execução fica em C:\ProgramData\BI-instalacao-<data>.log (as senhas digitadas não são gravadas).

Segurança: a senha inicial do administrador é apagada do arquivo de configuração ao final de uma instalação bem-sucedida — ela só é usada na primeira inicialização. Troque essa senha no primeiro acesso.

3. APIs de demonstração

São usadas nas apresentações: a fonte de dados é cadastrada ao vivo no BI. Como quem busca os dados é a API do BI (no servidor, não no navegador), elas precisam rodar no mesmo servidor da API do BI.

O INSTALAR.bat já as configura. Para instalar ou atualizar somente as APIs de demonstração, use o pacote pequeno BI-demo-2026.10.7.1.zip: extraia e dê dois cliques em INSTALAR-DEMO.bat.

API	Endereço para cadastrar no BI
Água/Esgoto	http://api.saneamento.cebi:8092/v1/ligacoes
Ordens de Serviço	http://api.os.cebi:8093/v1/ordens

• Os nomes api.saneamento.cebi e api.os.cebi são cadastrados no arquivo hosts do próprio servidor (apontando para ele mesmo). Como alternativa, podem ser cadastrados no DNS da empresa.
• As portas 8092/8093 não precisam ser liberadas no firewall.
• No servidor, as APIs aparecem no Agendador de Tarefas como "BI - API Demo Agua" e "BI - API Demo Ordens de Servico".
• Plano B (sem Node.js): a API do BI já traz dados fictícios embutidos: http://localhost:5080/api/demo/vendas.

4. Verificar a instalação

1. No navegador, acesse http://<servidor>:5173.
2. Entre com o e-mail e a senha do administrador.
3. Em Fontes de Dados → + Nova Fonte, cadastre http://api.saneamento.cebi:8092/v1/ligacoes, clique em Testar conexão e confirme a mensagem "Conexão OK".
4. O rodapé da tela mostra a versão instalada (ex.: Versão: 2026.10.7.1).

5. Solução de problemas

Sintoma	Causa provável	Solução
Instalador para em "Falta o .NET 8 – ASP.NET Core Hosting Bundle"	Hosting Bundle ausente ou instalado antes do IIS.	Instale (ou Repare) o Hosting Bundle e rode o INSTALAR.bat de novo.
"A API não respondeu" na etapa 8/8	Oracle inacessível ou usuário/senha incorretos.	Conferir C:\BI\api\appsettings.Production.json e o acesso ao Oracle. Detalhes: Visualizador de Eventos → Logs do Windows → Aplicativo (origem IIS AspNetCore Module V2).
Ao cadastrar fonte: "No such host is known (api.saneamento.cebi…)"	Os nomes das APIs de demonstração não estão cadastrados no servidor.	Rodar o INSTALAR-DEMO.bat (ou o INSTALAR.bat) no servidor da API do BI.
Ao cadastrar fonte: conexão recusada	A API de demonstração não está ligada.	Conferir as tarefas "BI - API Demo…" no Agendador de Tarefas e se o Node.js está instalado.
Aviso "CONFLITO: a porta … já é usada por …"	Outro sistema do servidor usa a porta.	Avisar a equipe do BI para gerar o pacote com outra porta.
Tela abre, mas mostra "Não foi possível conectar ao servidor"	A API (porta 5080) está parada ou bloqueada no firewall.	Conferir o site BI-API no Gerenciador do IIS e a regra de firewall "BI - API (5080)".

6. Instalação manual (sem o instalador)

Use apenas se não for possível executar o INSTALAR.bat.

1. API: copie a pasta api/ para o servidor. Copie appsettings.Production.example.json para appsettings.Production.json e preencha:
   • ConnectionStrings:Oracle — usuário, senha e endereço do Oracle;
   • Jwt:Key — chave secreta com no mínimo 32 caracteres, única deste servidor;
   • Seed:AdminEmail / Seed:AdminPassword — administrador inicial (criado só se o banco não tiver usuários);
   • Frontend:BaseUrl — endereço(s) da tela, separados por vírgula (ex.: http://servidor:5173);
   • DataProtection:KeysPath — pasta fixa para as chaves de criptografia (ex.: C:\BI\dados\chaves), com permissão de escrita para a API.
2. Publique a pasta api/ no IIS (porta 5080), com pool de aplicativos sem código gerenciado, sempre ligado (AlwaysRunning, idle timeout 0) e preload habilitado. O web.config já está pronto.
3. Tela: publique a pasta frontend/ no IIS (porta 5173). O web.config incluído já configura as rotas (requer o URL Rewrite).
4. Libere as portas 5080 e 5173 no firewall.

Na primeira inicialização, a API cria as tabelas no Oracle e o usuário administrador automaticamente.

7. Segurança

• Troque a senha inicial do administrador no primeiro acesso.
• Não compartilhe o appsettings.Production.json: ele contém a senha do Oracle e a chave de segurança.
• Mantenha Auth:ReturnDevLinks como false em produção.
• Avalie publicar com HTTPS (certificado no IIS).
• Se o servidor usar o mesmo banco Oracle de outro ambiente do BI, painéis e usuários são mantidos, mas fontes de dados com senha/token precisam ter essa senha informada de novo (cada servidor tem as próprias chaves de criptografia).

Manual de atualização

Este manual descreve como atualizar uma instalação existente do Business Intelligence (BI) para uma versão nova. Ele se destina à equipe de infraestrutura (TI).

Para a primeira instalação, consulte o Manual de instalação.

Como identificar a versão

A versão instalada aparece no rodapé de todas as telas do BI, inclusive na tela de login — por exemplo, Versão: 2026.10.7.1. A versão segue o formato Ano.Mês.Dia.Build.

Cada pacote novo é entregue como BI-<versão>.zip, com a mesma estrutura do pacote de instalação (INSTALAR.bat, api/, frontend/, api-demo/).

O que é mantido e o que é substituído

Item	Na atualização
Painéis, fontes de dados, usuários, links compartilhados, auditoria	Mantidos — ficam no banco Oracle.
Configuração (C:\BI\api\appsettings.Production.json): Oracle, chave de segurança, endereços	Mantida.
Chaves de criptografia (C:\BI\dados\chaves)	Mantidas.
Sites do IIS, firewall, tarefas agendadas	Mantidos (e conferidos).
Programas (C:\BI\api, C:\BI\frontend, C:\BI\api-demo)	Substituídos pela versão nova.
Estrutura do banco	Atualizada automaticamente pela API na primeira inicialização, quando a versão nova exigir.

Atenção: qualquer arquivo alterado manualmente dentro de C:\BI\api, C:\BI\frontend ou C:\BI\api-demo (por exemplo, o web.config) é sobrescrito pela versão nova. A única exceção é o appsettings.Production.json.

1. Antes de atualizar

1. Avise os usuários: o BI fica indisponível por alguns minutos durante a atualização.
2. Faça cópia de segurança de:
   • C:\BI\api\appsettings.Production.json;
   • a pasta C:\BI\dados;
   • a pasta C:\BI inteira (para voltar à versão anterior, se necessário);
   • o schema do BI no Oracle (com o DBA) — recomendado, porque a atualização pode alterar a estrutura do banco e essa alteração não é desfeita automaticamente.
3. Copie o pacote novo (BI-<versão>.zip) para o servidor e extraia o zip inteiro em uma pasta nova (não extraia por cima de C:\BI).

2. Atualizar (recomendado: com o instalador)

1. Na pasta do pacote novo, dê dois cliques em INSTALAR.bat (ele pede permissão de administrador).
2. O instalador reconhece que o BI já está instalado e:
   • não pergunta de novo os dados do Oracle nem do administrador — mostra "Configuracao existente mantida";
   • para os sites do BI no IIS;
   • substitui os programas pelos da versão nova;
   • liga os sites novamente e confere IIS, firewall e APIs de demonstração.
3. Aguarde a etapa 8/8 – Testando. Na primeira inicialização da versão nova, a API pode levar 1 a 2 minutos para responder, se precisar atualizar a estrutura do banco.
4. Ao final deve aparecer "BI INSTALADO COM SUCESSO".

Se o BI tiver sido instalado em outra pasta (opção -InstallDir), rode o instalador com a mesma opção, pelo PowerShell como administrador: .\Instalar-BI.ps1 -InstallDir D:\BI.

3. Depois de atualizar

1. Abra o BI no navegador e confira a versão no rodapé.
2. Peça aos usuários que recarreguem a página com Ctrl+F5, para o navegador não usar a versão antiga guardada.
3. Abra um painel e confira se os dados aparecem.
4. Em caso de aviso amarelo ou erro no instalador, guarde o log C:\ProgramData\BI-instalacao-<data>.log e envie para a equipe do BI.

4. Atualizar só as APIs de demonstração

Quando a atualização envolver apenas as APIs de demonstração, a equipe do BI envia o pacote pequeno BI-demo-<versão>.zip:

1. Extraia o zip no servidor da API do BI.
2. Dê dois cliques em INSTALAR-DEMO.bat.
3. Ao final deve aparecer "APIS DE DEMONSTRACAO PRONTAS".

Esse pacote não mexe na tela, na API do BI, no IIS nem no banco.

5. Atualização manual (sem o instalador)

Use apenas se não for possível executar o INSTALAR.bat.

1. Faça as cópias de segurança do item 1.
2. No Gerenciador do IIS, pare os pools de aplicativos BI-API e BI-Web.
3. Substitua o conteúdo de C:\BI\api pelo da pasta api/ do pacote novo, preservando o appsettings.Production.json.
4. Substitua o conteúdo de C:\BI\frontend pelo da pasta frontend/ do pacote novo.
5. Inicie os pools BI-API e BI-Web.
6. Faça as conferências do item 3.

6. Voltar à versão anterior

Se a versão nova apresentar problema:

1. Pare os pools BI-API e BI-Web no IIS.
2. Restaure a cópia da pasta C:\BI feita antes da atualização.
3. Se a versão nova tiver alterado a estrutura do banco, peça ao DBA para restaurar o backup do schema do BI — a versão anterior pode não funcionar com a estrutura nova.
4. Inicie os pools e confira a versão no rodapé.
5. Informe a equipe do BI, enviando o log da instalação.

Histórico de versões

Versão	Principais mudanças
2026.10.7.1	Nova interface (visual renovado, tema claro/escuro); filtro por clique nos gráficos mais fluido; instalador automático (INSTALAR.bat); APIs de demonstração incluídas, com nomes próprios (api.saneamento.cebi, api.os.cebi); a API aceita vários endereços da tela (Frontend:BaseUrl separado por vírgula).
2026.6.12.1	Primeira versão entregue para publicação no servidor.

Manual do usuário

Apresentação

O Business Intelligence (BI) da CEBI Informática é a plataforma de painéis gerenciais da empresa. Com ele, o usuário conecta uma fonte de dados, gera um dashboard automaticamente a partir desses dados, ajusta o que for necessário e publica o resultado para consulta e apresentação, inclusive por link compartilhado.

O uso do sistema segue, em geral, quatro etapas:

• “Fontes de Dados”: cadastrar a API que fornece os dados e revisar os campos detectados;
• “Novo dashboard”: escolher a fonte e gerar o painel, que já nasce montado;
• Edição: ajustar componentes, cores e títulos, e publicar;
• Visualização e “Publicações”: consultar, filtrar, exportar, apresentar e compartilhar.

Nota: Os dados exibidos nas imagens deste manual são fictícios, de demonstração. Algumas opções só aparecem para usuários com a permissão correspondente.

Acessando o sistema

O acesso é feito pelo navegador de internet, no endereço informado pela equipe de TI, com e-mail e senha individuais.

Passo a passo:

1. Abra o navegador e acesse o endereço do BI.
2. Na tela “Entrar”, informe o “E-mail” e a “Senha”. Para conferir o que foi digitado, clique em “Mostrar”.
3. Clique em “Entrar”.

Importante: O botão “Entrar” só é liberado depois que os dois campos forem preenchidos.

Esqueci minha senha

Passo a passo:

1. Na tela de login, clique em “Esqueci minha senha”.
2. Informe o “E-mail” cadastrado e clique em “Enviar link”.
3. Abra o e-mail recebido e clique no link de redefinição.
4. Na tela “Redefinir senha”, informe a “Nova senha” (mínimo de 8 caracteres), repita-a em “Confirmar senha” e clique em “Redefinir senha”.
5. Entre no sistema com a nova senha.

Dica: Para voltar à tela de login sem enviar o link, clique em “Voltar ao login”.

Tela inicial e navegação

Após o login, o sistema abre a tela “Meus dashboards”. No primeiro acesso a lista está vazia e o sistema convida a criar o primeiro dashboard.

O menu lateral, à esquerda, organiza as funcionalidades em grupos. Clique no nome do grupo para abri-lo ou fechá-lo:

• “Dashboards”: “Dashboards” (lista de painéis), “Fontes de Dados” e “Publicações” (links compartilhados);
• “Administração”: “Auditoria”;
• “Sistema”: “Configurações”.

No rodapé do menu ficam as opções “Modo escuro” (ou “Modo claro”), que alterna as cores da tela e fica memorizada no navegador, e “Sair”, que encerra a sessão.

Dica: A seta ao lado do nome da empresa, no topo do menu, recolhe o menu lateral e deixa só os ícones, ampliando a área de trabalho. Clique novamente para expandir.

Nota: Em celulares, o menu fica recolhido: toque no ícone de três traços, no topo da tela, para abri-lo.

Fontes de dados

A fonte de dados é a origem das informações dos dashboards: um endereço de API (REST) que devolve uma lista de registros em formato JSON. O BI busca esses dados, guarda uma cópia e a atualiza automaticamente na frequência escolhida.

Cadastrar uma nova fonte

Passo a passo:

1. No menu lateral, clique em “Fontes de Dados” e depois em “+ Nova Fonte”.
2. Em “Nome”, informe como a fonte será identificada no sistema.
3. Em “URL base”, informe o endereço da API.
4. Se os registros vierem dentro de outro campo da resposta, informe-o em “Caminho até a lista” (por exemplo: data.items). Se a resposta já for a lista, deixe em branco.
5. Em “Autenticação”, escolha “Nenhuma”, “API Key (header)” ou “Bearer token”, conforme a API. Nos dois últimos casos, informe a chave ou o token no campo que aparece.
6. Em “Frequência de atualização dos dados”, escolha de quanto em quanto tempo o BI deve buscar os dados novamente.
7. Clique em “Testar conexão”. Se estiver tudo certo, o sistema mostra “Conexão OK” com a quantidade de registros e campos encontrados.
8. Clique em “Salvar e mapear”. O sistema busca os dados e abre a tela de mapeamento.

Importante: Quem acessa a API é o servidor do BI, e não o computador do usuário. Por isso o endereço precisa estar acessível a partir do servidor.

Mapear os campos

No mapeamento, o sistema mostra os campos detectados, já classificados por tipo. Basta revisar e ajustar o que for necessário.

Passo a passo:

1. Revise o nome amigável de cada campo: é o nome que aparece para quem usa os dashboards (por exemplo, “Valor Em Aberto” em vez de valor_em_aberto).
2. Se a classificação estiver errada, altere o “Tipo” do campo: “Métricas (valores)”, “Datas”, “Categorias”, “Status / Situação”, “Identificadores” ou “Texto”. O campo muda para o grupo correspondente.
3. Nas métricas, escolha o “Formato” (“Número”, “Moeda” ou “Percentual”) e o “Resumir por” (“Soma”, “Média”, “Contagem”, “Mínimo” ou “Máximo”).
4. Clique em “Salvar mapeamento”.

Dica: O tipo dos campos define o que é possível montar: “Datas” permitem gráficos de evolução no tempo, e “Categorias” e “Status / Situação” permitem agrupar em barras, pizzas e rankings.

Consultar, atualizar e manter as fontes

Clique em uma fonte da lista para ver os detalhes: situação (“Conectada” ou “Inativa”), data da última atualização, quantidade de registros, frequência, tipo de autenticação, endereço (“Endpoint”) e os campos detectados. Nessa tela estão disponíveis:

• “Atualizar”: busca os dados na API imediatamente;
• “Mapear campos”: reabre o mapeamento;
• menu “⋮”: “Editar” (alterar nome, endereço, autenticação ou frequência), “Desativar” / “Ativar” e “Excluir”.

Importante: Uma fonte em uso por algum dashboard não pode ser excluída. Exclua os dashboards ou, se quiser apenas impedir novos usos, desative a fonte.

Criando um dashboard

O dashboard é gerado automaticamente a partir da fonte escolhida: o sistema analisa os campos e monta indicadores, gráficos e filtros. A pré-visualização mostra exatamente o painel que será criado.

Passo a passo:

1. Na tela “Meus dashboards”, clique em “+ Novo dashboard”.
2. Em “Fonte de dados”, escolha a fonte. A pré-visualização é gerada na hora.
3. Se desejar, informe o “Nome do dashboard”. Se ficar em branco, o sistema usa o nome sugerido.
4. Opcionalmente, abra “Layout” para escolher outro modelo de painel e “Paleta de cores” para escolher as cores.
5. Clique em “Criar dashboard”. O painel é criado como “Rascunho” e aberto para edição.

Modelos disponíveis em “Layout”:

• “Visão geral” (padrão): indicadores no topo, evolução no tempo e distribuição;
• “Comparativo”: barras e ranking para comparar valores entre categorias;
• “Acompanhamento”: tabela de registros com indicadores de apoio;
• “Análise detalhada”: série temporal, recortes por categoria e tabela completa;
• “Tela em branco”: painel vazio, para montar componente por componente.

Nota: Só é possível criar dashboards a partir de fontes ativas. Sem nenhuma fonte ativa, o sistema exibe o aviso “Nenhuma fonte ativa”.

Editando o dashboard

A tela de edição tem três áreas: à esquerda, os “Componentes” que podem ser adicionados; no centro, o painel; e à direita, o “Configurar” do componente selecionado.

Passo a passo:

1. Para adicionar um componente, clique no tipo desejado em “Componentes”: “KPI”, “Linha (tempo)”, “Área (tempo)”, “Barras”, “Barras horizontais”, “Pizza/Donut”, “Tabela” ou “Ranking”. Ele é incluído no final do painel.
2. Para mover um componente, arraste-o pela alça que aparece ao passar o mouse. Para redimensionar, arraste o canto inferior.
3. Clique em um componente para configurá-lo no painel à direita: “Título”, “Tamanho” (“P”, “M”, “G” ou “Full”), “Dimensão” (ou “Eixo X (data)”), “Métrica”, “Agregação” e as opções de cor e de exibição de cada tipo.
4. Para remover um componente, clique no “X” que aparece no canto dele.
5. Para renomear o dashboard, clique no título, no topo da tela, e digite o novo nome.
6. Clique em “Salvar” para guardar as alterações, ou em “Publicar” para salvar e liberar o dashboard para consulta e compartilhamento.

Importante: Remover um componente não pede confirmação. Se sair da tela sem salvar, o sistema pergunta se deseja descartar as alterações.

Cores do dashboard

O botão com o nome da paleta (por exemplo, “Corporativo”), no topo da tela, abre a “Paleta do dashboard”. Escolha uma das paletas e, se desejar, alterne entre “Cor única” e “Múltiplas cores”. Na paleta “Personalizada”, escolha a cor principal da marca e o sistema deriva os demais tons.

Outros recursos da edição

• “Gerar”: refaz o painel automaticamente a partir dos dados, substituindo os componentes atuais. Logo em seguida, o botão “Desfazer geração” permite voltar ao que havia antes;
• “Pré-visualizar”: mostra o painel como ficará, sem as áreas de edição. Clique em “Editando” para voltar;
• filtros no topo do painel: o valor escolhido durante a edição fica salvo como padrão do dashboard;
• ícone de lixeira: exclui o dashboard.

Visualizando um dashboard

Para abrir um dashboard, clique no título dele ou em “Abrir”, na tela “Meus dashboards”. O cabeçalho mostra a fonte, a data da última atualização dos dados, o autor e a data de criação; logo abaixo ficam os filtros do painel.

Botões disponíveis no cabeçalho:

• “Exportar”: gera imagem, PDF ou planilha (ver adiante);
• “Compartilhar”: gera um link de acesso (somente para dashboards publicados);
• “Tela cheia”: exibe só o painel, ocupando a tela inteira. Para sair, clique em “Sair” ou pressione ESC;
• “Apresentar”: abre o modo de apresentação;
• “Publicar” / “Despublicar”: altera a situação do dashboard;
• “Editar”: abre a tela de edição.

Filtrar clicando nos gráficos

Ao clicar em uma barra, fatia de pizza, linha de ranking ou valor de categoria em uma tabela, todo o dashboard passa a mostrar somente os dados daquele valor.

Passo a passo:

1. Clique no valor desejado em um dos gráficos (por exemplo, um bairro).
2. O valor aparece em destaque ao lado do título do gráfico e em “Filtros ativos”, abaixo do cabeçalho. Os demais componentes são recalculados.
3. Para remover o filtro, clique novamente no mesmo valor, no “X” do destaque ou em “Limpar tudo”.

Nota: Os gráficos de linha e de área não filtram por clique. Os filtros aplicados na visualização são temporários e não alteram o dashboard salvo.

Exportar

No botão “Exportar” estão disponíveis:

• grupo “Dashboard”: “Imagem PNG”, “Imagem JPG” e “PDF”, com a aparência atual do painel;
• grupo “Dados”: “Excel (.xlsx)” e “CSV (.csv)”, com os registros da fonte e os filtros ativos aplicados.

Modo apresentação

O botão “Apresentar” exibe o dashboard em tela cheia, sem menus, ideal para TVs e reuniões. O topo mostra o logotipo, o título, a data e a hora, e o painel é atualizado automaticamente a cada 30 segundos. O filtro por clique continua funcionando.

Dica: Para sair do modo apresentação, pressione ESC ou clique no “X”, no canto superior direito.

Compartilhando um dashboard

Dashboards publicados podem ser compartilhados por link, com acesso somente leitura: quem recebe o link visualiza o painel e usa os filtros, mas não edita nem exporta.

Passo a passo:

1. Abra o dashboard e clique em “Compartilhar”. O link é gerado automaticamente.
2. Em “Tipo de acesso”, mantenha “Público” ou escolha “Protegido por senha”. Nesse caso, informe a “Senha de acesso” (mínimo de 4 caracteres) e clique em “Salvar”.
3. Em “Expiração do link”, escolha “7 dias”, “15 dias”, “30 dias” ou “Sem expiração”.
4. Clique em “Copiar” e envie o link para os destinatários.
5. Clique em “Fechar”.

Importante: Se o link for protegido por senha, envie a senha separadamente do link.

Nota: Só é possível compartilhar dashboards publicados. Se o dashboard estiver como rascunho, publique-o antes.

Gerenciar os links: Publicações

A tela “Publicações” reúne todos os links gerados, com a quantidade de acessos e a situação de cada um (“Ativo”, “Expirado” ou “Inativo”).

No menu “⋮” de cada link estão as opções “Copiar link”, “Abrir dashboard”, “Alterar senha” e “Revogar acesso”. O botão “Publicar dashboard”, no topo, gera um novo link para qualquer dashboard publicado.

Importante: “Revogar acesso” desativa o link imediatamente e não pode ser desfeito. Para voltar a compartilhar, gere um novo link.

Como o destinatário acessa

Quem recebe o link abre o painel diretamente no navegador, sem precisar de login. Se o link for protegido, o sistema pede a senha de acesso antes de exibir o painel. Se o link tiver sido revogado ou expirado, ou se o dashboard tiver sido despublicado, o sistema informa que o painel não está mais disponível.

Organizando os dashboards

A tela “Meus dashboards” lista os painéis em cartões (“Galeria”) ou em tabela (“Lista”), separados nas abas “Ativos”, “Favoritos” e “Arquivados”.

• “Buscar dashboard…”: localiza pelo nome do dashboard ou da fonte;
• “Filtros”: filtra por “Tipo”, “Status” (“Publicado” ou “Rascunho”) e “Fonte de dados”;
• estrela: marca ou desmarca o dashboard como favorito;
• “Galeria” / “Lista”: alterna a forma de exibição (a escolha fica memorizada).

Ações do dashboard

O menu “⋮” de cada dashboard reúne as ações disponíveis:

• “Editar”: abre a tela de edição;
• “Duplicar”: cria uma cópia do dashboard;
• “Compartilhar”: gera o link de acesso (dashboards publicados);
• “Publicar” / “Despublicar”: altera a situação;
• “Arquivar” / “Restaurar”: tira o dashboard da lista principal sem excluí-lo. O dashboard restaurado volta como rascunho;
• “Excluir”: remove o dashboard definitivamente, após confirmação.

Importante: A exclusão não pode ser desfeita. Na dúvida, prefira “Arquivar”.

Configurações

Em “Configurações” (grupo “Sistema”) define-se a identidade visual da empresa, exibida no menu, no modo apresentação, nas exportações e nos links compartilhados.

Passo a passo:

1. No menu lateral, clique em “Sistema” e em “Configurações”.
2. Em “Nome da empresa”, informe o nome a ser exibido.
3. Em “Logotipo”, clique em “Enviar” e escolha a imagem (de preferência PNG ou SVG com fundo transparente). Para retirar o logotipo, clique em “Remover”.

Nota: As alterações são salvas automaticamente e aplicadas na hora, como mostra a “Pré-visualização”. O botão “Restaurar padrão” volta ao nome e à aparência originais.

Auditoria

A tela “Auditoria” (grupo “Administração”) registra as ações realizadas na plataforma: data e hora, usuário, ação (criação, edição, publicação, exclusão, login etc.), tipo do registro e detalhes. É uma tela somente de consulta.

Dica: Use “Filtros” para consultar por “Ação” ou por “Entidade” (dashboard, fonte, compartilhamento etc.).

Versões do manual

Versão 1.0 – Versão inicial do manual (sistema versão 2026.10.7.1), contemplando os itens:

• Acesso ao sistema e recuperação de senha
• Fontes de dados: cadastro, mapeamento e manutenção
• Dashboards: criação automática, edição, cores, visualização, filtros, exportação e modo apresentação
• Compartilhamento por link e Publicações
• Organização dos dashboards, Configurações e Auditoria