 |
Resumo | O Discourse Workflows permite que administradores criem automações avançadas por meio de um construtor visual para automatizar quase tudo em sua comunidade. |
 |
Guia de Instalação | Este plugin está incluído no núcleo do Discourse. Não é necessário instalar o plugin separadamente. |
O Workflows é um construtor visual de automação que permite que administradores criem automações avançadas e de múltiplas etapas usando um canvas de arrastar e soltar — conectando gatilhos, condições, ações e nós de controle de fluxo para automatizar quase qualquer coisa em seu site Discourse.
O Discourse Workflows está disponível nos planos Business ou Enterprise.
Conceitos principais
Se você estiver familiarizado com outras ferramentas de automação, provavelmente reconhecerá a maior parte do vocabulário usado no Workflows:
- Workflow: Uma automação salva composta por nós conectados.
- Nó: Um único passo em um workflow: gatilhos, condições, ações e utilitários de controle de fluxo.
- Gatilho: O ponto de partida de um workflow. Um gatilho pode ser manual ou iniciado por um evento específico — a criação de um tópico, a execução de um agendamento ou um webhook recebido.
- Condição: Um nó de roteamento que avalia uma regra e divide o fluxo em ramificações. Por exemplo, um nó If direciona o fluxo com base em uma avaliação verdadeira ou falsa.
- Ação: Um nó que realiza uma tarefa específica — criar um post, conceder uma medalha, chamar uma API externa, etc.
- Item: Os dados que fluem entre os nós. Os itens são objetos JSON que você pode inspecionar nos logs de execução e referenciar usando expressões.
- Expressão: Um valor dinâmico escrito como
{{ ... }}que é resolvido em tempo de execução e usado para referenciar dados de nós anteriores, variáveis ou configurações do site.
Criando um workflow
Para criar um workflow:
- Vá para Admin > Plugins > Workflows e clique em Novo workflow.
- Dê um nome ao seu workflow.
- Clique em Adicionar primeira etapa e escolha seu gatilho.
- Use o botão + para adicionar nós adicionais.
- Clique duas vezes em um nó para configurá-lo. No painel de configuração, os detalhes sobre as entradas do nó serão mostrados no lado esquerdo e os detalhes sobre as saídas do nó serão mostrados no lado direito da tela. Você pode precisar executar o workflow uma vez antes de ver todos os detalhes variados.
- Quando estiver pronto para colocar em produção, clique em Publicar.
Dicas:
- Use notas adesivas, localizadas no menu de três pontos no canto superior direito do construtor, para documentar o que seu workflow faz. As notas não têm nenhum efeito no workflow, mas tornam os modelos e workflows compartilhados mais fáceis de entender.
- Use o nó de log durante o desenvolvimento para enviar valores de depuração para o log de execução sem impactar o comportamento do workflow.
- Você pode exportar e importar workflows como JSON para compartilhá-los com colegas da equipe ou movê-los entre sites. Veja Exportando e importando workflows abaixo para saber o que é e o que não é transferido.
Expressões e dados dinâmicos
Os campos que aceitam expressões exibem um botão {/} no editor. Clique nele para navegar pelos dados disponíveis do gatilho e dos nós anteriores e inserir uma referência.
Expressões comuns
| Expressão | O que retorna |
|---|---|
{{ $json.topic.title }} |
O título do tópico do item atual |
{{ $json.post.url }} |
A URL do post do item atual |
{{ $json.user.username }} |
O nome de usuário do usuário associado ao item atual |
{{ $workflow_vars.my_variable }} |
O valor de uma variável de workflow chamada my_variable |
{{ $vars.my_variable }} |
O valor de uma variável global chamada my_variable |
{{ $site_settings.title }} |
O título do seu site |
{{ $execution.id }} |
O ID exclusivo da execução atual |
{{ $('Node Name').item.json.property }} |
Saída de um nó anterior específico, referenciado pelo seu nome no canvas |
Valores estáticos e dinâmicos
Campos que começam com = são tratados como expressões. Campos sem um = inicial são tratados como texto simples. O seletor de expressões cuida disso automaticamente para você.
Gerenciando workflows
Existem vários recursos que ajudam você a gerenciar seus workflows existentes.
Execuções
Sempre que um workflow é executado, o Discourse registra uma execução. Vá para Workflows → Execuções para ver o histórico.
Cada execução mostra a data e hora em que foi concluída e seu status:
- Concluída: Executada até o fim sem erros.
- Erro: Falhou em um nó específico; clique na execução para ver o erro e os dados que o causaram.
- Executando: Atualmente sendo processada.
- Aguardando: Pausada devido a um nó de Espera; aguardando uma resposta em um formulário, modal, aprovação de chat; ou um nó de Chamada de Workflow aguardando a conclusão de um sub-workflow.
- Limitada por taxa: O workflow foi ignorado devido ao limite de taxa.
- Ignorada: O gatilho foi disparado, mas o workflow não estava publicado.
Você pode clicar no botão Mostrar para ter uma visão mais detalhada da execução do workflow. Isso mostra cada etapa do workflow, que você pode expandir para ver os detalhes exatos, e a duração dessa etapa.
Na parte inferior da página, você pode ver a duração total do workflow. Você também pode Exportar o log, se necessário, para fins de compartilhamento ou solução de problemas.
Configurações
Na aba Workflows → Configurações, você pode:
- Configurar um workflow de erro que deve ser disparado se houver falhas durante a execução deste workflow. Se o workflow tiver um gatilho de erro, ele lidará com os erros conforme definido por esse gatilho.
- Definir o fuso horário para gatilhos agendados. O workflow usará por padrão o fuso horário do site se isso não estiver definido.
- Excluir o workflow.
Esta ação é permanente, então você deve considerar exportar seu workflow (acessível no menu de três pontos no canto superior direito do construtor de workflows) antes de prosseguir.
Versões
Sempre que você fizer uma atualização no workflow, salvaremos a(s) versão(ões) anterior(es). Isso facilita Reverter alterações que não funcionaram como você esperava.
Exportando e importando workflows
Use o menu de três pontos no canto superior direito do construtor de workflows para Exportar um workflow como um arquivo JSON e Importar para carregar um. Usos comuns: compartilhar um workflow com colegas da equipe ou movê-lo de um site de staging para produção.
Importar adiciona os nós do arquivo ao workflow que você tem aberto; ele não cria um novo workflow. Para copiar um workflow, crie um workflow vazio primeiro e depois importe para ele. As alterações importadas são salvas como rascunho até que você publique.
Incluídos na exportação: nós e sua configuração, conexões, notas adesivas e definições de variáveis de workflow.
Não transferidos, então configure-os no site de destino antes de publicar:
- Credenciais: as referências de credenciais são removidas na importação. Crie as credenciais no site de destino e selecione-as novamente em cada nó.
- Tabelas de dados: tabelas, colunas e linhas não são exportadas. Recrie-as e selecione-as nos nós de Tabela de Dados.
- Valores de variáveis: as definições de variáveis de workflow são importadas, mas não seus valores. Defina-as na aba Variáveis do workflow. Se uma variável com a mesma chave já existir, a importação manterá a existente e mostrará quais chaves foram ignoradas. Variáveis globais não são exportadas.
- Configurações do workflow: o workflow de erro e o fuso horário não são aplicados. Configure-os novamente na aba Configurações.
- Referências específicas do site: IDs, nomes e URLs de categorias, grupos, usuários, canais de chat, consultas do Data Explorer e workflows chamados são mantidos como estão e podem não corresponder ao site de destino. Variáveis de workflow facilitam a alteração desses valores.
Variáveis
Existem dois tipos de variáveis:
- Variáveis de workflow têm escopo limitado a um único workflow. Defina-as na aba Variáveis do workflow e referencie-as com
{{ $workflow_vars.key_name }}. Elas têm um tipo (string, inteiro, booleano, enum, categoria, lista de categorias, grupo, lista de grupos, lista de tags ou lista), então os valores são validados e selecionados com o seletor correto. Alterações nas definições e valores seguem o fluxo de rascunho/publicação do workflow. - Variáveis globais são compartilhadas por todos os workflows. Defina-as em Workflows → Variáveis e referencie-as com
{{ $vars.key_name }}.
Use variáveis de workflow para valores que mudam entre sites ou usos, como uma categoria, um grupo ou um destinatário, para que você possa reutilizar o workflow sem editar seus nós.
Credenciais
Alguns nós — como solicitação HTTP ou Agente de IA — precisam autenticar com serviços externos. Armazene chaves de API e segredos em Workflows → Credenciais em vez de colá-los diretamente nos campos dos nós. As credenciais são criptografadas em repouso e podem ser reutilizadas em vários workflows.
Tipos de credenciais suportados:
- Autenticação Básica (nome de usuário + senha)
- Token Bearer
- Autenticação por Cabeçalho (nome e valor de cabeçalho personalizados)
Tabelas de dados
As tabelas de dados são tabelas estruturadas persistentes internas do plugin Workflows. Use o nó Tabela de dados para ler delas ou escrever nelas. Elas suportam tipos de colunas string, number, boolean e date.
As tabelas de dados são úteis para:
- Deduplicação — registrar quais usuários ou tópicos um workflow já processou
- Estado — rastrear se um tópico está em uma determinada etapa de um processo
- Buscas — armazenar mapeamentos (como ID do tópico → membro da equipe atribuído) que seus workflows podem consultar
Execuções
Você pode visualizar todas as execuções de todos os workflows na aba Execuções. O formato e a função são muito semelhantes às execuções específicas do workflow, mas mostram informações de todos os workflows para facilitar o monitoramento.
Modelos
Quando você cria um novo workflow, pode começar a partir de um modelo em vez de um canvas em branco. Os modelos são workflows pré-construídos para casos de uso comuns — eles são anotados com notas adesivas explicando como funcionam e são uma ótima maneira de aprender o sistema.
Interessado em ver mais modelos? Trabalharemos para expandir a biblioteca de modelos disponíveis com o tempo, mas, por favor, nos avise se houver um modelo que você gostaria de ver aqui para facilitar seu uso do Workflows.
Você também pode exportar qualquer workflow como um arquivo JSON para compartilhá-lo com outras pessoas ou usá-lo como seu próprio ponto de partida.
