chore: adiciona Docker, scripts e documentacao
- Adiciona Dockerfile e docker-compose para containerizacao - Adiciona docker-entrypoint.sh com inicializacao - Adiciona scripts/seed-admin.js para criar admin inicial - Adiciona docs/ com logos originais CambioReal - Atualiza README.md com instrucoes de uso - Atualiza queries.js com metricas de portfólio Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
root
272
docs/GUIA-USUARIO.md
Normal file
272
docs/GUIA-USUARIO.md
Normal file
@@ -0,0 +1,272 @@
|
||||
# Guia do Usuario - BI Agentes
|
||||
|
||||
Manual de uso do dashboard de transacoes para agentes CambioReal.
|
||||
|
||||
---
|
||||
|
||||
## Indice
|
||||
|
||||
1. [Acessando o Sistema](#acessando-o-sistema)
|
||||
2. [Visao Geral do Dashboard](#visao-geral-do-dashboard)
|
||||
3. [Usando os Filtros](#usando-os-filtros)
|
||||
4. [Entendendo os KPIs](#entendendo-os-kpis)
|
||||
5. [Interpretando os Graficos](#interpretando-os-graficos)
|
||||
6. [Tabela de Transacoes](#tabela-de-transacoes)
|
||||
7. [Perguntas Frequentes](#perguntas-frequentes)
|
||||
|
||||
---
|
||||
|
||||
## Acessando o Sistema
|
||||
|
||||
### Login
|
||||
|
||||
1. Abra o navegador e acesse o endereco fornecido pelo administrador
|
||||
2. Na tela de login, digite:
|
||||
- **E-mail**: Seu email cadastrado
|
||||
- **Senha**: Sua senha pessoal
|
||||
3. Clique em **Entrar**
|
||||
|
||||
```
|
||||
┌─────────────────────────────────┐
|
||||
│ BI Agentes │
|
||||
│ CambioReal - Dashboard │
|
||||
│ │
|
||||
│ E-mail: [_________________] │
|
||||
│ │
|
||||
│ Senha: [_________________] │
|
||||
│ │
|
||||
│ [ Entrar ] │
|
||||
└─────────────────────────────────┘
|
||||
```
|
||||
|
||||
**Dica:** Se aparecer a mensagem "E-mail ou senha incorretos", verifique se digitou corretamente. Caso persista, contate o administrador.
|
||||
|
||||
### Logout
|
||||
|
||||
Para sair do sistema, clique no botao **Sair** no canto superior direito do dashboard.
|
||||
|
||||
---
|
||||
|
||||
## Visao Geral do Dashboard
|
||||
|
||||
Apos o login, voce vera o dashboard com suas transacoes:
|
||||
|
||||
```
|
||||
┌────────────────────────────────────────────────────────────────────┐
|
||||
│ [Nome do Agente] - Agente [ID] [Ao vivo] [Sair] │
|
||||
├────────────────────────────────────────────────────────────────────┤
|
||||
│ De: [____] Ate: [____] Granulacao: [___] Fluxo: [___] [Aplicar] │
|
||||
├────────────────────────────────────────────────────────────────────┤
|
||||
│ │
|
||||
│ ┌────────┐ ┌────────┐ ┌────────┐ ┌────────┐ │
|
||||
│ │ KPI 1 │ │ KPI 2 │ │ KPI 3 │ │ KPI 4 │ <- Indicadores │
|
||||
│ └────────┘ └────────┘ └────────┘ └────────┘ │
|
||||
│ │
|
||||
│ ┌─────────────────┐ ┌─────────────────┐ │
|
||||
│ │ Grafico 1 │ │ Grafico 2 │ <- Graficos │
|
||||
│ └─────────────────┘ └─────────────────┘ │
|
||||
│ │
|
||||
│ ┌─────────────────────────────────────────┐ │
|
||||
│ │ Tabela de Transacoes │ <- Detalhes │
|
||||
│ └─────────────────────────────────────────┘ │
|
||||
│ │
|
||||
└────────────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
**Importante:** Voce ve apenas suas proprias transacoes. Outros agentes nao tem acesso aos seus dados.
|
||||
|
||||
---
|
||||
|
||||
## Usando os Filtros
|
||||
|
||||
Os filtros ficam na barra abaixo do cabecalho. Use-os para refinar a visualizacao:
|
||||
|
||||
### Periodo (De / Ate)
|
||||
|
||||
Selecione a data inicial e final para ver transacoes em um periodo especifico.
|
||||
|
||||
**Exemplo:** Para ver transacoes de janeiro:
|
||||
- De: `2024-01-01`
|
||||
- Ate: `2024-01-31`
|
||||
|
||||
### Granulacao
|
||||
|
||||
Escolha como agrupar os dados nos graficos:
|
||||
|
||||
| Opcao | Uso |
|
||||
|-------|-----|
|
||||
| **Dia** | Ver detalhes diarios (periodos curtos) |
|
||||
| **Mes** | Visao mensal (padrao, recomendado) |
|
||||
| **Ano** | Comparar anos inteiros |
|
||||
|
||||
### Fluxo
|
||||
|
||||
Filtre por tipo de operacao:
|
||||
|
||||
| Opcao | Significado |
|
||||
|-------|-------------|
|
||||
| **Todos** | BRL→USD e USD→BRL juntos |
|
||||
| **BRL → USD** | Apenas envios (reais para dolares) |
|
||||
| **USD → BRL** | Apenas recebimentos (dolares para reais) |
|
||||
|
||||
### Cliente
|
||||
|
||||
Selecione um cliente especifico ou deixe em "Todos" para ver todas as transacoes.
|
||||
|
||||
### Aplicar
|
||||
|
||||
**Importante:** Apos alterar os filtros, clique em **Aplicar** para atualizar a tela.
|
||||
|
||||
---
|
||||
|
||||
## Entendendo os KPIs
|
||||
|
||||
Os KPIs (Indicadores-Chave) mostram um resumo do periodo selecionado:
|
||||
|
||||
### Transacoes
|
||||
Quantidade total de operacoes realizadas.
|
||||
|
||||
### Volume BRL
|
||||
Soma de todos os valores em reais movimentados.
|
||||
|
||||
**Exemplo:** Se teve 3 transacoes de R$ 10.000, R$ 20.000 e R$ 15.000, o volume e R$ 45.000.
|
||||
|
||||
### Volume USD
|
||||
Soma de todos os valores em dolares movimentados.
|
||||
|
||||
### Taxa Media
|
||||
Media ponderada da taxa de cambio cobrada (BRL/USD).
|
||||
|
||||
**Ponderada significa:** Transacoes maiores tem mais peso no calculo.
|
||||
|
||||
### Spread Medio
|
||||
Porcentagem media de lucro sobre a taxa PTAX.
|
||||
|
||||
**O que e PTAX?** Taxa de cambio oficial do Banco Central.
|
||||
|
||||
**Exemplo:** Se a PTAX e 5,00 e voce cobra 5,05, o spread e 1% (0,05 / 5,00).
|
||||
|
||||
### IOF Total
|
||||
Soma do IOF (Imposto sobre Operacoes Financeiras) recolhido.
|
||||
|
||||
### Ticket Medio
|
||||
Valor medio em USD por operacao.
|
||||
|
||||
**Calculo:** Volume USD / Numero de Transacoes
|
||||
|
||||
### Clientes Ativos
|
||||
Quantos clientes diferentes fizeram transacoes no periodo.
|
||||
|
||||
---
|
||||
|
||||
## Interpretando os Graficos
|
||||
|
||||
### Volume BRL / USD por Periodo
|
||||
|
||||
Grafico de barras mostrando a evolucao do volume ao longo do tempo.
|
||||
|
||||
- **Barras verdes** = Volume em BRL (eixo esquerdo)
|
||||
- **Barras azuis** = Volume em USD (eixo direito)
|
||||
|
||||
**Como ler:**
|
||||
- Barras mais altas = mais volume naquele periodo
|
||||
- Compare meses para identificar sazonalidade
|
||||
|
||||
### Volume por Cliente (Top 10)
|
||||
|
||||
Grafico horizontal mostrando os 10 maiores clientes por volume USD.
|
||||
|
||||
**Como usar:**
|
||||
- Identifique seus clientes mais importantes
|
||||
- Foque atencao nos maiores volumes
|
||||
|
||||
### Taxa Cobrada vs PTAX
|
||||
|
||||
Grafico de linha comparando sua taxa com a taxa oficial.
|
||||
|
||||
- **Linha roxa** = Sua taxa cobrada (media ponderada)
|
||||
- **Linha azul** = PTAX oficial
|
||||
|
||||
**O que observar:**
|
||||
- A distancia entre as linhas e seu spread
|
||||
- Quanto maior a distancia, maior sua margem
|
||||
|
||||
---
|
||||
|
||||
## Tabela de Transacoes
|
||||
|
||||
A tabela mostra todas as transacoes individuais do periodo.
|
||||
|
||||
### Colunas
|
||||
|
||||
| Coluna | Descricao |
|
||||
|--------|-----------|
|
||||
| **Data/Hora** | Quando a transacao foi realizada |
|
||||
| **Cliente** | Nome do cliente |
|
||||
| **Valor BRL** | Valor em reais |
|
||||
| **Valor USD** | Valor em dolares |
|
||||
| **IOF %** | Aliquota de IOF aplicada |
|
||||
| **IOF R$** | Valor do IOF em reais |
|
||||
| **PTAX** | Taxa oficial do BC no momento |
|
||||
| **Taxa Cobrada** | Sua taxa de cambio |
|
||||
| **Spread** | Diferenca entre taxa cobrada e PTAX |
|
||||
| **Spread %** | Spread em porcentagem |
|
||||
| **Status** | Situacao da operacao |
|
||||
|
||||
### Organizacao
|
||||
|
||||
As transacoes sao separadas por fluxo:
|
||||
- **BRL → USD** (fundo roxo claro) - Envios
|
||||
- **USD → BRL** (fundo azul claro) - Recebimentos
|
||||
|
||||
### Navegando
|
||||
|
||||
- Use a barra de rolagem horizontal para ver todas as colunas
|
||||
- A tabela ordena por data (mais antigas primeiro)
|
||||
|
||||
---
|
||||
|
||||
## Perguntas Frequentes
|
||||
|
||||
### Posso ver transacoes de outros agentes?
|
||||
|
||||
**Nao.** Cada agente ve apenas suas proprias transacoes. O sistema garante isolamento total dos dados.
|
||||
|
||||
### Os dados sao atualizados em tempo real?
|
||||
|
||||
**Sim.** A cada vez que voce carrega o dashboard ou aplica filtros, os dados sao buscados diretamente do sistema.
|
||||
|
||||
### O que fazer se os graficos nao aparecerem?
|
||||
|
||||
1. Verifique sua conexao com a internet (os graficos usam biblioteca externa)
|
||||
2. Tente recarregar a pagina (F5)
|
||||
3. Se persistir, contate o suporte tecnico
|
||||
|
||||
### Como exportar os dados?
|
||||
|
||||
*Em breve!* Estamos desenvolvendo funcionalidade de exportacao para Excel/CSV.
|
||||
|
||||
### A sessao expira?
|
||||
|
||||
**Sim.** Apos 8 horas de inatividade, voce precisara fazer login novamente.
|
||||
|
||||
### Posso acessar de celular?
|
||||
|
||||
**Sim.** O dashboard e responsivo e funciona em dispositivos moveis, porem a experiencia e melhor em telas maiores.
|
||||
|
||||
### O que significa PTAX?
|
||||
|
||||
PTAX e a taxa de cambio oficial divulgada pelo Banco Central do Brasil. E usada como referencia para calcular o spread das operacoes.
|
||||
|
||||
---
|
||||
|
||||
## Suporte
|
||||
|
||||
Em caso de problemas:
|
||||
1. Verifique usuario e senha
|
||||
2. Tente recarregar a pagina
|
||||
3. Contate o administrador do sistema
|
||||
|
||||
---
|
||||
|
||||
*CambioReal - BI Agentes v1.0*
|
||||
Reference in New Issue
Block a user