Fluxo de Trabalho

1) Acesso ao Cadastro de Fluxo de Trabalho

Para acessar a tela de Fluxo de Trabalho no BomControle:

• No menu superior, clique em Vendas.

• Em seguida, acesse a opção Cadastros.

• No menu de cadastros de Vendas, selecione Fluxo de Trabalho.

A tela de listagem de Fluxos de Trabalho será exibida (Figura 1). Nela, você verá os fluxos de trabalho já cadastrados em forma de grid (tabela). Cada linha corresponde a um fluxo de trabalho, mostrando seu Nome (e descrição) e as Etapas configuradas:

Figura 1 — Listagem de Fluxos de Trabalho (Pesquisa) 

• Coluna “Nome” – exibe o nome do fluxo de trabalho em destaque e, logo abaixo, a descrição cadastrada (quando houver). Isso ajuda a identificar o fluxo e seu propósito.

• Coluna “Etapas” – exibe, em formato resumido, os nomes de todas as etapas configuradas dentro de cada fluxo. Caso o fluxo não possua etapas cadastradas, aparecerá a indicação “Não cadastrado” (por padrão, porém, todo fluxo deve ter ao menos duas etapas – veja as regras adiante).

Além dessas colunas, há uma coluna de Ações no canto direito de cada linha:

• Ícone de estrela: indica se o fluxo de trabalho está marcado como padrão. Clicá-lo alterna o status de Fluxo Padrão (a estrela fica preenchida quando é o fluxo padrão ativo). Apenas um fluxo pode ser o padrão por módulo; ao marcar um fluxo como padrão, o sistema automaticamente remove a marcação do fluxo anteriormente definido como padrão.

• Ícone de editar (lápis): permite editar o fluxo de trabalho selecionado. Ao clicar, abre a tela de edição daquele fluxo, onde é possível alterar seus dados básicos e etapas.

• Ícone de cadeado: permite bloquear/desbloquear o fluxo de trabalho, ou seja, inativá-lo ou reativá-lo. Quando um fluxo está bloqueado (inativo), seu ícone aparece como um cadeado fechado; quando ativo, aparece como cadeado aberto. Fluxos bloqueados não podem ser selecionados para novas Ordens de Serviço no sistema (ficam ocultos nas listas de escolha). Importante: o sistema não permite bloquear um fluxo de trabalho marcado como padrão – para inativá-lo, primeiro defina outro fluxo como padrão.

Acima do grid de listagem, estão disponíveis filtros de pesquisa para localizar fluxos de trabalho específicos. Você pode buscar pelo Nome (ou parte do nome) do fluxo através de um campo de texto. Também é possível filtrar por status, exibindo apenas fluxos ativos ou bloqueados, conforme a necessidade (ex.: marcar “Mostrar bloqueados” para listar somente fluxos inativos). Caso nenhum filtro seja aplicado, a listagem exibirá todos os fluxos cadastrados (ativos aparecem primeiro, seguidos dos bloqueados).

Para adicionar um novo fluxo de trabalho, utilize o botão Cadastrar novo (normalmente posicionado acima ou abaixo do grid de listagem). Ao acioná-lo, a tela de cadastro será aberta para que você informe os dados do novo fluxo. A seguir, detalhamos o formulário de cadastro/edição.

2) Seção – Dados Básicos do Fluxo de Trabalho

A Figura 2 ilustra a seção Dados Básicos do formulário de Fluxo de Trabalho

Figura 2 — Dados Básicos do Fluxo de Trabalho 

2.1 Campos e regras de preenchimento (Dados Básicos)

Legenda: ✅ Campo obrigatório · ⚠️ Campo opcional

Nome:
- Regras de preenchimento: ✅ Obrigatório. Insira um nome descritivo para identificar o fluxo de trabalho. Este nome deve representar o processo ou pipeline que será controlado. Por exemplo: “Fluxo Padrão OS”, “Instalação Completa” etc. O campo aceita texto livre – escolha um título claro e direto. (O sistema não aceita salvar o registro sem um nome preenchido. Não há um limite rígido de caracteres visível, mas recomenda-se um nome sucinto.)
- Impacto no sistema: O nome do fluxo será exibido em diversas telas internas, como na listagem de fluxos (pesquisa), na seleção de fluxo ao criar uma Ordem de Serviço, e em relatórios ou filtros relacionados. Assim, usuários de outros módulos (ex.: na abertura de OS) verão este nome ao escolher um fluxo de trabalho para a Ordem de Serviço. Um nome claro facilita a correta seleção do fluxo pelos usuários.
- Observações: Evite nomes genéricos ou muito parecidos com outros fluxos já cadastrados, para não confundir os usuários. Caso haja múltiplos fluxos para diferentes finalidades, use nomes que reflitam a diferença (por ex., “Fluxo OS - Simples” vs. “Fluxo OS - Avançado”).

Descrição:
- Regras de preenchimento: ⚠️ Opcional. Campo livre para detalhar ou contextualizar o uso do fluxo de trabalho. Pode-se inserir até 150 caracteres. Use este espaço para anotações internas, como por exemplo: “Etapas padrão para ordens de serviço comuns” ou “Workflow para projetos especiais – requer aprovações extras”.
- Impacto no sistema: A descrição é exibida logo abaixo do nome na listagem de fluxos (conforme Figura 1), ajudando os usuários a compreender a finalidade do fluxo sem precisar editar para ver detalhes. Não é utilizada diretamente em outros módulos, servindo apenas como informação auxiliar.
- Observações: Mantenha descrições curtas e objetivas. Esse campo é útil especialmente se sua empresa tiver vários fluxos de trabalho – assim, outros usuários conseguem distinguir o uso de cada um pela descrição. Se não quiser adicionar detalhes, o campo pode ficar vazio sem problemas.

Padrão:
- Regras de preenchimento: ⚠️ Opcional (definido pelo usuário conforme necessidade). Trata-se de um marcador (toggle) que indica se este fluxo de trabalho será o fluxo padrão do módulo. Marque “Sim” para designá-lo como padrão, ou deixe “Não” caso contrário. Ao marcar como Padrão = Sim, o sistema automaticamente removerá a marcação de qualquer outro fluxo que estivesse como padrão, garantindo que apenas um fluxo de trabalho permaneça padrão por vez. Se nenhum fluxo estiver marcado, significa que não há fluxo padrão definido (nesse caso, o sistema ainda assim escolherá um fluxo disponível – normalmente o primeiro ativo – como referência em algumas operações).
- Impacto no sistema: O fluxo Padrão é utilizado de forma automática na abertura de novas Ordens de Serviço. Por exemplo, ao criar uma OS, o campo “Fluxo de Trabalho” virá preenchido por padrão com o fluxo marcado aqui (embora o usuário possa trocar, se houver outros disponíveis). Ter um fluxo padrão garante uniformidade no processo: se um usuário não selecionar manualmente um fluxo específico para uma nova OS, essa OS seguirá as etapas do fluxo padrão. Atenção: Como mencionado, um fluxo padrão não pode ser bloqueado/inativado diretamente. Para inativá-lo, é necessário primeiro definir outro fluxo como padrão ou remover a condição de padrão deste.
- Observações: Defina como padrão o fluxo mais comum ou recomendado para a maioria dos casos de uso. Fluxos alternativos podem ficar como não-padrão, sendo escolhidos apenas em situações específicas. Lembre-se de que marcar ou desmarcar essa opção afeta todo o módulo de Ordens de Serviço; avalie cuidadosamente antes de alterá-la em um ambiente produtivo.

3) Seção – Etapas do Fluxo de Trabalho

A seção Etapas (Figura 3) permite configurar e visualizar todas as etapas que compõem o fluxo de trabalho. As etapas representam as fases ou estados pelos quais uma Ordem de Serviço pode passar dentro daquele fluxo, em ordem sequencial do início ao fim.

Figura 3 — Seção de Etapas do Fluxo de Trabalho 

Na tela, as etapas geralmente são apresentadas em forma de lista (tabela), acompanhadas de botões para adicionar novas etapas e ícones para editar ou remover etapas existentes. Ao cadastrar um novo fluxo de trabalho, o BomControle preenche automaticamente um conjunto de etapas padrão para auxiliar o usuário – essas etapas iniciais podem ser alteradas conforme o processo específico de sua empresa. Por exemplo, em fluxos de Ordens de Serviço, o sistema sugere etapas como “Aguardando Análise”, “Analisando”, “Negociando”, “Executando”, “Concluído”, entre outras (vide figura), já em sequência. O usuário pode editar os nomes, ícones ou ordem dessas etapas sugeridas, bem como incluir etapas adicionais ou remover as não desejadas, ajustando o fluxo ao seu processo real.

Cada etapa possui os seguintes campos principais a serem configurados:

3.1 Campos e regras de preenchimento (Etapas)

Nome da Etapa:
- Regras de preenchimento: ✅ Obrigatório para cada etapa. Defina o nome de cada fase do processo. Deve ser um texto curto e claro indicando a situação da OS naquela etapa. Exemplos: “Aguardando Análise”, “Em Execução”, “Concluído”. Não podem existir duas etapas com nomes idênticos dentro do mesmo fluxo – embora o sistema não valide isso automaticamente, é recomendável usar nomes distintos para evitar confusão. (O sistema exige que haja pelo menos duas etapas cadastradas no fluxo para poder salvar, portanto certifique-se de adicionar no mínimo duas.)
- Impacto no sistema: Os nomes das etapas aparecerão para os usuários em vários contextos: na listagem de fluxos (coluna “Etapas”), no detalhe da Ordem de Serviço (indicando a etapa atual da OS), em filtros de Ordens de Serviço por etapa/status, e possivelmente em dashboards ou indicadores de quantas OS estão em cada etapa. Quando uma OS está vinculada a um fluxo, seu status passa a ser controlado pelo nome da etapa atual. Por exemplo, uma OS recém-criada pode iniciar na etapa “Aguardando Análise” e depois ser mudada para “Analisando” e assim por diante, conforme o trabalho avança. Esses nomes, portanto, representam os status do atendimento.
- Observações: Utilize termos familiares aos usuários e que reflitam o andamento real do trabalho. A ordem das etapas (ver abaixo) definirá o fluxo lógico; normalmente, atribui-se a primeira etapa para o início do processo e a última para a conclusão. Evite nomes muito longos – se necessário, você pode detalhar procedimentos internos nos campos de descrição da OS ou em treinamentos, mantendo aqui apenas o estágio resumido.

Ícone:
- Regras de preenchimento: ⚠️ Opcional, porém recomendado. Para cada etapa, pode-se selecionar um ícone representativo (pictograma) que será exibido junto ao nome da etapa em algumas telas, proporcionando identificação visual. Ao adicionar ou editar uma etapa, há um botão ou campo de seleção de ícone (representado por um pequeno símbolo gráfico); ao clicá-lo, abre-se uma galeria de ícones disponíveis para escolha (padrão Font Awesome). Se nenhum ícone for escolhido, o sistema poderá atribuir um ícone padrão automaticamente (ex.: “fa-dollar” inicial), mas é aconselhável escolher um que tenha relação com o significado da etapa (por exemplo, um ícone de relógio para “Aguardando”, um ícone de ferramenta para “Executando”, um check para “Concluído” etc.).
- Impacto no sistema: Os ícones selecionados aparecem ao lado dos nomes das etapas em certos componentes da interface, como em listas suspensas de etapa ou em indicadores gráficos, facilitando a rápida identificação visual do status. Embora sejam sutis, ajudam os usuários a reconhecer o estágio de uma OS sem depender apenas do texto (por exemplo, um ícone de cadeado pode indicar uma etapa de fechamento/arquivamento).
- Observações: A escolha do ícone é estética/informativa e não afeta a lógica do sistema. No entanto, padronize o uso de ícones para manter consistência (por exemplo, use sempre o mesmo ícone de “check” para etapas que signifiquem conclusão ou aprovação, em todos os fluxos). Caso não tenha certeza sobre qual ícone usar, você pode manter os sugeridos pelo sistema ou decidir não usar nenhum específico (o que não prejudica o funcionamento).

Ordem:
- Regras de preenchimento: ✅ Obrigatório para cada etapa. O campo Ordem determina a sequência das etapas no fluxo de trabalho. Insira um número inteiro para cada etapa, indicando sua posição na ordem do processo (quanto menor o número, mais cedo aquela etapa ocorre). Normalmente utiliza-se uma numeração crescente iniciando em 1 (ou 0) para a primeira etapa, 2 para a segunda, e assim por diante, sem repetir valores. Não é necessário que a numeração seja estritamente sequencial, mas deve manter a ordem relativa correta (o sistema ordena as etapas do fluxo com base nesse número). Por exemplo, você pode numerar de 10, 20, 30... se desejar intervalos; o importante é a ordenação.
- Impacto no sistema: A ordem atribuída influencia diretamente como as etapas são apresentadas e percorridas. O sistema sempre considera a etapa de menor ordem como a etapa inicial do fluxo (na criação de uma OS, essa será a etapa automaticamente definida). Da mesma forma, relatórios e filtros podem listar as etapas na ordem definida por este campo. Quando usuários alteram a etapa de uma Ordem de Serviço manualmente, espera-se que sigam a sequência lógica da ordem (embora o sistema não impeça saltos, a usabilidade supõe que se vá de ordem 0/1 para 2, etc.). Resumindo, a Ordem configura a linha do tempo do fluxo de trabalho.
- Observações: Mantenha a consistência da numeração – por exemplo, se um fluxo inicia em 0 ou 1, siga esse padrão nas demais etapas. Evite usar o mesmo número em duas etapas (empate de ordem), pois embora o sistema não trave, isso poderia embaralhar a sequência esperada. Você pode reordenar etapas a qualquer momento editando seus números (desde que isso faça sentido no andamento das OS em curso). Lembre-se de que mudar a ordem não altera retroativamente as OS já em determinada etapa, mas afetará qual é considerada primeira, segunda, etc., para novas OS.

Inclusão, Edição e Remoção de Etapas:
- Adicionar nova etapa: Utilize o botão Adicionar Etapa (ou equivalente, geralmente com um símbolo de “+”) para criar uma etapa. Ao clicar, preencha os campos Nome, Ícone e Ordem da nova etapa e então confirme (em alguns casos, há um botão dedicado “Salvar etapa”). A nova etapa aparecerá na lista de etapas do fluxo, já incorporada ao fluxoTrabalhoEtapa (conjunto de etapas) em edição. Repita o procedimento para quantas etapas forem necessárias. Lembre-se: só será possível salvar o fluxo de trabalho se houver pelo menos duas etapas definidas – caso contrário o sistema exibirá um aviso e impedirá a gravação.
- Editar etapa existente: Na listagem de etapas, clique no ícone de editar (lápis) ao lado da etapa que deseja modificar. Os campos da etapa serão carregados para edição (geralmente destacados em um formulário de etapa). Altere o que for necessário (nome, ícone ou ordem) e confirme para atualizar. A etapa editada será atualizada na lista.
- Remover etapa: Clique no ícone de excluir (lixeira) ao lado da etapa a ser removida. O sistema solicitará confirmação e, ao confirmar, a etapa será retirada da lista de etapas do fluxo (antes de salvar o fluxo, você ainda pode desistir fechando a tela sem salvar). Atenção: Existe uma restrição importante – não é possível excluir etapas que já tenham Ordens de Serviço atreladas a elas. Se alguma OS do sistema está atualmente naquela etapa, o sistema impedirá a exclusão e exibirá uma mensagem de erro (por exemplo: “Não é possível excluir etapas que tenham ordens de serviço atreladas.”). Isso visa preservar o histórico e integridade das OS. Nessa situação, a etapa indesejada poderia, alternativamente, ser renomeada (por exemplo, marcar como “(Inativa)”) ou movida para o final e não mais utilizada em novas OS, mantendo-a apenas para referência histórica.

• Impacto no sistema: A gestão das etapas (inclusão/edição/remoção) permite que o fluxo de trabalho evolua conforme as mudanças de processo da empresa. Após salvar o fluxo de trabalho com suas etapas, essas definições impactam diretamente o módulo de Ordens de Serviço: os usuários que forem movimentar uma OS de um estágio para outro verão apenas as etapas definidas aqui para selecionar; ao gerar relatórios de pipeline de serviços, as etapas configuradas servirão de base para contagem de OS em cada fase; etc. Se um fluxo de trabalho for marcado como padrão, as etapas configuradas nele serão aplicadas a praticamente todas as OS novas automaticamente – portanto, mantenha essa configuração coerente com a operação real. Para fluxos não padrão, as etapas serão aplicadas somente às OS cujo fluxo for explicitamente selecionado pelo usuário na criação.

• Observações: Planeje as etapas de um fluxo em conjunto com as áreas usuárias (ex.: equipe de suporte ou serviços) para garantir que reflitam as fases reais do trabalho. Evite criar etapas em excesso que não serão utilizadas, e certifique-se de que o pessoal entende quando deve mudar uma OS de uma etapa para a próxima. Uma configuração bem feita de fluxo de trabalho ajuda a controlar o andamento das Ordens de Serviço e a identificar gargalos (por exemplo, muitas OS paradas em “Aguardando Aprovação” podem indicar necessidade de intervenção). Lembre-se também que fluxos de trabalho diferentes podem ser criados para tipos distintos de OS, se necessário – por exemplo, um fluxo simplificado para serviços rápidos e outro mais detalhado para projetos longos.

4) Cadastro Técnico – Detalhes e Impactos no Sistema

Esta seção destina-se a documentar o comportamento técnico do cadastro de Fluxo de Trabalho e como ele interage com outras partes do BomControle, servindo de referência adicional.

• Local no sistema: O cadastro de Fluxo de Trabalho está localizado em Vendas > Cadastros > Fluxo de Trabalho no menu principal. Apesar de estar sob o menu Vendas, sua influência direta é no módulo de Ordens de Serviço (gerenciamento de serviços vendidos), atuando como um configurador de workflow para esse módulo.

• Entidade e uso interno: Cada Fluxo de Trabalho corresponde a uma entidade de workflow no sistema, composta por um cabeçalho (Dados Básicos: Nome, Descrição, Padrão, status de bloqueio) e uma coleção de Etapas. Internamente, as Ordens de Serviço possuem um campo de referência à etapa atual (ou seja, a um item específico dentre as etapas de um Fluxo de Trabalho). Assim, quando uma OS é criada, o sistema associa automaticamente a primeira etapa do fluxo selecionado à OS. À medida que a OS avança, essa referência é atualizada para a etapa seguinte escolhida pelo usuário.

• Campos da tela de pesquisa: na listagem de Fluxos de Trabalho, os campos apresentados (Nome, Descrição, Etapas, Padrão, Bloqueio) têm as seguintes características:

  • Nome: identifica o fluxo para o usuário; pode ser usado como critério de busca textual.

  • Descrição: informação auxiliar; exibida na listagem mas não utilizada para filtros.

  • Etapas: lista das etapas vinculadas; não é um campo isolado no banco, mas uma agregação mostrada na interface para fácil visualização.

  • Padrão: indicador booleano (sim/não) se o fluxo é o padrão do módulo; não se repete – apenas um registro terá valor verdadeiro.

  • Bloqueado: indicador booleano se o fluxo está inativo (bloqueado) ou ativo; fluxos bloqueados não aparecem para seleção em cadastros de OS e são ordenados por último na pesquisa. Alterar este status via interface só é possível através do botão de cadeado, respeitando a restrição de não bloquear o fluxo padrão ativo.

• Campos da tela de cadastro: no formulário de Fluxo de Trabalho, os campos e comportamentos técnicos relevantes incluem:

• Nome: string obrigatória. Se vazio, o formulário não é válido para salvar.

• Descrição: string opcional (até 150 caracteres). Valores maiores que o limite são truncados.

• Padrão: booleano (toggle). Se marcado true ao salvar, aciona uma rotina que remove a marcação de padrão de qualquer outro fluxo desse mesmo módulo antes de gravar este como padrão. Se desmarcado false, e nenhum outro fluxo estiver como padrão, o sistema poderá considerar o primeiro não bloqueado como padrão implícito em algumas funcionalidades.

• Etapas (lista): conjunto de objetos etapa com campos:

• Nome da etapa: string obrigatória. Não há validação de unicidade entre etapas via sistema, mas é esperado que sejam únicas.

• Ícone: string opcional (código/classe do ícone escolhido). Pode ficar vazio ou nulo – nenhum impacto além de não exibir ícone.

• Ordem: inteiro obrigatório. Usado para ordenação; deve ser preenchido em todas as etapas. Se duas etapas tiverem o mesmo número, ambas serão salvas e recuperadas, mas a ordem de apresentação pode não ser consistente (já que o sistema ordena ascendente, elas apareceriam juntas sem definição de prioridade entre si).

• Status (apenas outros módulos): Observação: No contexto de OS (Vendas), as etapas não possuem um campo de status associado. Em outros módulos (Service Desk e BPM), cada etapa pode mapear para um status específico de ticket ou processo, mas para Ordens de Serviço isso não se aplica – a própria etapa é o status da OS. Portanto, em fluxos do módulo Vendas, ignore qualquer referência a “Status” de etapa no cadastro (essas opções só aparecem em fluxos de outros módulos, se o sistema abranger).

• Validações ao salvar: Ao tentar salvar um Fluxo de Trabalho, o sistema verifica se há pelo menos 2 etapas na lista; caso contrário, impede a operação exibindo aviso. Verifica também se os campos obrigatórios (Nome do fluxo e Nome das etapas, Ordens das etapas) estão preenchidos – do contrário, o formulário permanece inválido até correção. Não há impedimento para salvar fluxos sem descrição ou sem ícones de etapas.

• Relação com Ordens de Serviço: Cada Ordem de Serviço, ao ser criada, permite escolher um Fluxo de Trabalho (padrão sugerido automaticamente). Depois de criada, a OS guarda referência tanto ao Fluxo selecionado quanto à etapa atual (uma OS sempre tem exatamente uma etapa atual, pertencente ao fluxo associado). O histórico de movimentação da OS entre etapas pode ser registrado em log/histórico da OS, mas o cadastro de fluxo em si não armazena histórico – ele apenas define quais etapas existem e suas ordens. 

Quando um fluxo de trabalho padrão é criado ou alterado, o sistema pode atualizar automaticamente as OS existentes sem fluxo definido para passarem a usar o novo fluxo padrão e sua etapa inicial (conforme regras de negócio internas do sistema, como visto na migração inicial de implementação). 

Ao alterar o nome de uma etapa, as OS que estiverem nessa etapa herdam o novo nome imediatamente, pois a referência é pelo objeto etapa (por ID) – ou seja, renomear “Executando” para “Em Andamento” faz com que todas as OS na etapa executando passem a mostrar “Em Andamento” como status atual. Ao excluir uma etapa (quando permitido), quaisquer OS que estivessem naquela etapa precisam ser movidas para outra etapa antes (o sistema não permitirá excluir enquanto houver vínculo).

• Integração com outros módulos: O Fluxo de Trabalho de Ordens de Serviço impacta principalmente o módulo de OS em Vendas > Dia (execução de serviços). Ele não afeta diretamente módulos financeiros ou emissão de nota, exceto indiretamente: por exemplo, uma OS só pode ser faturada ou encerrada quando atinge certa etapa (conclusão) conforme procedimento interno da empresa – mas essa regra de negócio (se houver) deve ser alinhada manualmente pela empresa. Em resumo, o fluxo serve para controle operacional das OS, não interferindo nos dados fiscais, financeiros ou contábeis, além de fornecer visibilidade de andamento.

• Considerações finais (técnicas): O cadastro de Fluxo de Trabalho é uma configuração de domínio que oferece flexibilidade para adequar o BomControle ao processo de cada cliente. É importante mantê-lo consistente e atualizado, pois alterações impactam usuários e possíveis integrações (ex.: se houver integração via API ou relatórios externos consultando status das OS, estes utilizarão as etapas definidas aqui). 

Em caso de dúvida sobre modificar um fluxo já em uso intenso (com muitas OS ativas), recomenda-se criar um novo fluxo e gradualmente migrar novas OS para ele, ao invés de alterar drasticamente um fluxo existente – isso evita confusão operacional. 

Do ponto de vista de suporte, ao solucionar problemas relacionados a Ordens de Serviço “travadas” ou paradas, verificar em qual etapa do fluxo elas estão é fundamental: pode-se descobrir, por exemplo, que uma OS ficou presa numa etapa que foi inadvertidamente bloqueada ou removida do fluxo (situação que não deveria ocorrer devido às validações, mas configurações indevidas poderiam causar incoerências). Logo, manter uma documentação interna dos Fluxos de Trabalho configurados e suas definições pode auxiliar na administração do sistema.