Documentação em desenvolvimentoBeta Aberto clique aqui para participar
docs.cloudmes.ai
CloudMES Docs

Onboarding

Checklist guiado exibido para novas empresas (e acessível pelo menu) até a operação mínima estar pronta ou o tutorial ser ignorado.

Objetivo

Garantir que existam produto, máquina, operação, ordem, sequenciamento, tipos de evento, turnos e o primeiro start no Cockpit antes de operar em escala. O progresso é calculado automaticamente pelo backend.

Como usar

  1. Ao entrar no app, você pode ser redirecionado para Onboarding (acessar diretamente).
  2. Siga os itens na ordem sugerida; cada linha tem link para a tela de cadastro.
  3. Ao concluir um cadastro e voltar, o item marca como feito (recalculado via API).
  4. Quando todos os passos obrigatórios estiverem completos, o Cockpit fica liberado como fluxo principal.
  5. Ignorar onboarding dispensa o checklist (útil em ambientes já configurados); o menu pode ocultar o item conforme política da empresa.

Checklist de onboarding

Itens do checklist

PassoO que validaDocumentação
Cadastre um produto≥ 1 produto com código e unidadeProdutos
Cadastre uma máquina≥ 1 máquina ativaMáquinas
Cadastre uma operaçãoOperação vinculada a produtoOperações
Cadastre uma ordemOrdem com operações e quantidadesOrdens
Faça um sequenciamentoItem na fila de uma máquinaSequenciamento
Revise os tipos de eventoTipos padrão (Produção, Setup, etc.)Tipos de evento
Revise os turnosHorários de turno da plantaTurnos
Inicie uma ordem no cockpitOrdem/operação iniciada na máquinaCockpit

O link “tipos de evento” no app aponta para /dashboard/eventos (mesma tela documentada em Tipos de evento).

Dados e integrações

  • GET/PATCH/onboarding/checklist/
  • Detecção automática de cada passo (produtos, máquinas, ordens, sequências, eventos no cockpit, etc.)

Perguntas frequentes

Posso pular o onboarding?
Sim, com Ignorar onboarding. Administradores podem reabrir a tela pelo menu se o módulo estiver habilitado.

Um passo não marca como concluído
Confira o critério da tabela (ex.: ordem precisa ter operações com quantidade; sequenciamento exige registro em Sequenciamento). Aguarde alguns segundos e recarregue.

Já tenho dados importados (Bling, massa)
Itens podem completar sozinhos se os registros atendem às regras. Revise Preferências de produção e Turnos manualmente.

Erros comuns

  • Checklist não carrega: sessão expirada — faça login novamente.
  • Cockpit bloqueado: complete os passos ou ignore o tutorial (permissão de administrador).

Relacionado