Saltar para o conteúdo principal

Botão de Workflow

Visão geral

O componente Botão de Workflow adiciona um botão em que o utilizador clica para disparar uma ação sob pedido. Tem dois alvos possíveis, mutuamente exclusivos - escolher um limpa o outro na configuração:

  • Executar um workflow (V1 ou V2) com gatilho manual.
  • Abrir o formulário de registo de uma feature à escolha, num dialog, para criar ou editar uma linha.

No seletor de componentes, aparece simplesmente como Workflow. Utilize-o para ações que devem ficar dependentes de um clique explícito - aprovações, transições de estado, envio de um documento, criação ou edição de um registo noutra feature - em vez de disparar automaticamente quando os dados mudam.

A dropdown Workflow lista os workflows com um gatilho manual. Os workflows mais antigos só são elegíveis quando o gatilho manual está limitado a uma única linha; os workflows mais recentes são elegíveis com qualquer âmbito de gatilho manual (o âmbito determina que dados a execução necessita - ver abaixo). Selecionar um workflow aqui limpa o alvo Abrir formulário, e vice-versa.

Configuração

DefiniçãoDescrição
WorkflowO workflow de gatilho manual que este botão executa. Mutuamente exclusivo com Abrir formulário da feature.
Abrir formulário da featureAlvo alternativo: em vez de disparar um workflow, o botão abre o formulário de registo (criar/editar) da feature escolhida, num dialog. Mutuamente exclusivo com Workflow.
Coluna com o ID da linha a editarSó aparece com uma feature escolhida acima. Coluna da feature onde o botão vive cujo valor, na linha atual, é o id da linha a editar na feature de destino. Ver Alvo: abrir formulário para o comportamento quando fica vazia ou sem correspondência.
Texto do BotãoEtiqueta apresentada no botão. Se ficar vazio, usa "Executar" por defeito.
Ícone do BotãoÍcone apresentado no botão: Play, Transform, Enviar, Atualizar, Confirmar, Configurar, Adicionar, Editar.
Mensagem de Confirmação (Opcional)Quando definida, é necessário aceitar um diálogo de confirmação com esta mensagem antes de o workflow ser executado. Deixe vazio para executar imediatamente ao clicar. Não se aplica ao alvo Abrir formulário (ver abaixo).
Mostrar em TabelasMostra o botão nas vistas de tabela. Ativado por defeito.
Mostrar em FormuláriosMostra o botão nas vistas de formulário. Desativado por defeito.
Parâmetros do workflowLista de pares nome→coluna: os valores dessas colunas na linha atual são injetados no lançamento do workflow. Quando o alvo é Abrir formulário e o resultado é uma linha nova, os mesmos pares pré-preenchem campos do formulário (nome do parâmetro = nome do campo de destino na feature aberta).

Mostrar em Tabelas e Mostrar em Formulários só controlam as vistas de Tabela e de Formulário. Todas as outras vistas que podem alojar este componente — Lista, Kanban, Calendário, Dashboard, Kiosk, Cards, Documento — apresentam sempre o botão.

Em vistas diferentes

Vista(s)Apresentação
TabelaPequeno botão de ícone preenchido na célula. A tooltip mostra o Texto do Botão (ou "Executar", se ficar vazio).
FormulárioBotão preenchido de largura total, com ícone e etiqueta.
Lista, Calendário, Dashboard, DocumentoO mesmo botão preenchido de largura total do Formulário — sempre apresentado, independentemente dos toggles acima.
Kanban, Kiosk, CardsChip de ação compacto com a etiqueta — sempre apresentado.

O que acontece ao clicar (alvo: workflow)

  1. Se não estiver selecionado nenhum workflow, ou se os dados de linha/feature de que o workflow necessita não estiverem disponíveis, o clique falha de imediato com um aviso — sem diálogo apresentado.
  2. Para workflows que declaram um âmbito (Genérico, Linha, Feature, Vista), o botão resolve primeiro esse âmbito:
    • Genérico — executa sem dados de linha. Funciona a partir de qualquer vista, incluindo dashboards.
    • Feature — recolhe todas as linhas da feature de origem do workflow. Funciona a partir de qualquer vista.
    • Linha — precisa do registo a que o botão está associado. Se o botão não estiver colocado dentro de uma linha de tabela ou de um formulário aberto (por exemplo, num dashboard), interrompe-se com: "Este workflow dispara a partir de uma linha — use o botão dentro de uma linha ou formulário".
    • Vista — não suportado por este botão. Ao clicar aparece: "Este workflow dispara a partir da vista — use a ação global da vista (barra de ferramentas)". Utilize antes a própria ação da barra de ferramentas da vista para workflows com âmbito de vista.
  3. Só depois de isso ser resolvido é que aparece o diálogo de confirmação, caso Mensagem de Confirmação (Opcional) esteja definida. Recusá-lo cancela a execução — nada mais acontece.
  4. Depois de confirmado (ou imediatamente, se não houver mensagem de confirmação), o workflow é executado e uma snackbar reporta o resultado ("Run iniciado." em caso de sucesso, uma mensagem de erro caso contrário).

Os workflows mais antigos sem âmbito definido exigem sempre que o botão esteja numa linha — falham com "Dados da linha não encontrados" em vez da mensagem de âmbito Linha acima. Também não reportam através de snackbar: abre-se um pequeno diálogo de progresso, que se fecha automaticamente assim que a execução terminar com sucesso.

O que acontece ao clicar (alvo: abrir formulário)

Não há confirmação nem tempo de espera neste alvo - o formulário abre de imediato ao clicar (a Mensagem de Confirmação e o Tempo de espera entre execuções não se aplicam aqui).

  1. Se a feature de destino estiver marcada como gerida por workflow, o clique falha com o aviso "Tabela gerida por workflow" - o formulário não abre.
  2. Resolução de criar vs. editar:
    • Com Coluna com o ID da linha a editar configurada: o valor dessa coluna na linha atual é o id a procurar na feature de destino. Vazio - cria uma linha nova. Preenchido mas sem correspondência - aviso "Linha a editar não encontrada na feature de destino", o formulário não abre. Encontrado - abre essa linha em edição.
    • Sem coluna configurada: se o botão estiver montado numa linha da própria feature de destino, abre essa linha em edição; caso contrário, cria uma linha nova.
  3. Ao criar uma linha nova, os pares configurados em Parâmetros do workflow pré-preenchem os campos correspondentes do formulário com os valores da linha atual (nome do parâmetro = nome do campo de destino). Em modo de edição não há prefill - o formulário mostra os dados já existentes da linha.

Dicas

  • Se o botão parecer não fazer nada, verifique se o âmbito do workflow selecionado corresponde ao local onde colocou o botão — um workflow com âmbito Linha precisa de estar dentro de uma linha ou formulário, não num dashboard.
  • Utilize Mensagem de Confirmação (Opcional) para ações destrutivas ou difíceis de reverter (eliminações, envio de emails, chamadas a APIs externas). Só se aplica ao alvo Workflow - o alvo Abrir formulário nunca pede confirmação.
  • Se não aparecer nenhum workflow na dropdown Workflow, o workspace ainda não tem nenhum workflow elegível com gatilho manual — crie um primeiro na secção de administração de Workflows.
  • Escolher uma feature em Abrir formulário da feature limpa o Workflow selecionado (e vice-versa) - os dois alvos não coexistem no mesmo botão.
  • Se a feature de destino do formulário estiver marcada como gerida por workflow, o botão bloqueia com o aviso "Tabela gerida por workflow" em vez de abrir o formulário.