Conceitos de domínio
Antes de integrar, entenda o modelo de domínio do Leankeep. Quase todos os endpoints orbitam estes conceitos.
Hierarquia de ativos
A manutenção sempre incide sobre ativos, organizados hierarquicamente:
Empresa
└── Unidade (pertence a exatamente uma Cidade; Cidade pertence a um Estado)
└── Área
└── Equipamento
Relações adicionais:
- Uma Unidade pode pertencer a zero ou mais SubGrupoUnidade; um SubGrupoUnidade a zero ou mais GrupoUnidade.
- Uma Área pode pertencer a um SubGrupoArea; um SubGrupoArea deve pertencer a um GrupoArea.
- Uma ação de manutenção pode acontecer em nível de Unidade, Área ou Equipamento.
Os dois tipos de manutenção
Preventiva — Atividades
Planejada e periódica. Estrutura:
Plano de Atividades
└── Atividade
└── Aplicação (onde executa: Unidade | Área | Equipamento)
└── Tarefa (instância agendada, gerada periodicamente)
As Tarefas são geradas automaticamente conforme a periodicidade. Algumas atividades podem gerar ocorrências — por exemplo, uma medição fora do limite esperado abre uma ocorrência corretiva.
Ver o fluxo completo em Fluxo de atividades.
Corretiva — Ocorrências
Reativa. Uma Ocorrência é um problema a resolver:
- Deve ter um ou mais Solicitantes (Emitentes).
- Pode ter um ou mais Executores e uma ou mais Fotos.
- Para resolver, aplicam-se uma ou mais Ações Corretivas, cada uma com um status (
TipoAcaoCorretivaEmpresa). - A Correção agrupa Emitentes, Executores e Fotos.
Ver o fluxo completo em Fluxo de ocorrências.
Regra de fallback de executor
Conceito crítico ao lidar com tarefas e agendamento. Existem três níveis de executor; o executor efetivo segue esta prioridade:
- Executor da Tarefa
- Executor da Aplicação — usado se a Tarefa não tiver executor
- Executor da Atividade — usado se a Aplicação não tiver executor
Sempre que sua integração criar ou alterar tarefas/agendamento, considere essa cascata.
Modelo de acesso
Há três tipos de usuário, com escopos distintos:
| Tipo | Escopo |
|---|---|
| Administrador | Uma única empresa. |
| Operacional | Uma única empresa. |
| Chamado | Uma única empresa. |
Observações importantes:
- Para Administrador, Operacional e Chamado, o acesso não é automaticamente concedido a todas as Unidades da empresa.
- Algumas empresas impõem restrição por área para usuários
Chamado— nesse modo, o acesso fica limitado a uma lista explícita de Áreas. - Usuários podem pertencer a um Setor, ter um Cargo e participar de múltiplas Equipes.
O escopo de empresa é resolvido a partir do token JWT — ver Autenticação.
Glossário rápido
| Termo | Significado |
|---|---|
| Ativo | Unidade, Área ou Equipamento sob manutenção. |
| Atividade | Tarefa preventiva planejada e periódica. |
| Aplicação | Vínculo entre uma Atividade e o ativo onde ela executa. |
| Tarefa | Instância agendada de uma Atividade. |
| Ocorrência | Problema corretivo a resolver (também chamado Anomalia no código). |
| Ação Corretiva | Intervenção aplicada para resolver uma ocorrência. |
| Emitente / Solicitante | Quem reporta uma ocorrência. |
| Executor | Quem executa a tarefa ou ação corretiva. |
| Típica | Modelo pré-configurado de ocorrência por empresa (AnomaliaTipica). |