 |
Resumo | Discourse Workflows permite que administradores criem automações avançadas por meio de um construtor visual para automatizar quase tudo na sua comunidade. |
 |
Guia de Instalação | Este plugin está incluído no núcleo do Discourse. Não há necessidade de instalar o plugin separadamente. |
Workflows é um construtor de automação visual que permite que administradores criem automações avançadas e com várias etapas usando um canvas de arrastar e soltar — conectando gatilhos, condições, ações e nós de controle de fluxo para automatizar quase tudo no seu site Discourse.
Discourse Workflows está disponível nos planos Business ou Enterprise.
Conceitos-chave
Se você estiver familiarizado com outras ferramentas de automação, provavelmente reconhecerá a maioria do vocabulário usado nos Workflows:
- Workflow: Uma automação salva composta por nós conectados.
- Nó: Uma única etapa em um workflow: gatilhos, condições, ações e controle de fluxo/utilitários.
- Gatilho: O ponto de início de um workflow. Um gatilho pode ser manual ou iniciado por um evento específico — criação de um tópico, acionamento de um agendamento ou recebimento de um webhook.
- Condição: Um nó de roteamento que avalia uma regra e divide o fluxo em ramificações. Por exemplo, um nó Se roteia o fluxo com base em uma avaliação verdadeira ou falsa.
- Ação: Um nó que realiza algo específico — criar uma publicação, conceder um distintivo, 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 de workflow ou configurações do site.
Criando um workflow
Para criar um workflow:
- Vá para Admin > Plugins > Workflows e clique em Novo workflow.
- Nomeie 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, detalhes sobre as entradas do nó serão exibidos no lado esquerdo e detalhes sobre as saídas do nó serão exibidos no lado direito da tela. Você pode precisar executar o workflow uma vez antes de ver todos os vários detalhes.
- Quando estiver pronto para colocar em produção, clique em Publicar.
Dicas:
- Use post-its, localizados no menu de três pontos no canto superior direito do construtor, para documentar o que seu workflow faz. Os post-its não têm nenhum efeito no workflow, mas facilitam a compreensão de modelos e workflows compartilhados.
- 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 de equipe ou recriar workflows de outros sites.
Expressões e dados dinâmicos
Campos que aceitam expressões mostram 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 da publicação do item atual |
{{ $json.user.username }} |
O nome de usuário do usuário associado ao item atual |
{{ $vars.my_variable }} |
O valor de uma variável de workflow chamada my_variable |
{{ $site_settings.title }} |
O título do seu site |
{{ $execution.id }} |
O ID exclusivo da execução atual |
{{ $('Nome do Nó').item.json.property }} |
Saída de um nó upstream 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árias funcionalidades que ajudam você a gerenciar seus workflows existentes.
Execuções
Toda vez 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 a hora em que foi concluída e seu status:
- Concluído: Executou até o fim sem erro.
- Erro: Falhou em um nó específico; clique na execução para ver o erro e os dados que o causaram.
- Em execução: Processando atualmente.
- Aguardando: Pausado devido a um nó de Espera; aguardando uma resposta em um formulário, modal, aprovação de chat; ou um nó de Chamar Workflow aguardando a conclusão de um sub-workflow.
- Limitado por taxa: O workflow foi ignorado devido à limitação de taxa.
- Ignorado: O gatilho foi acionado, mas o workflow não estava publicado.
Você pode clicar no botão Mostrar para uma análise 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 geral do workflow. Você também pode Exportar o log, se necessário, para fins de compartilhamento ou solução de problemas.
Configurações
Na guia Workflows → Configurações, você pode:
- Configurar um workflow de erro que deve ser acionado se houver falhas quando este workflow for executado. 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 de agendamento. O workflow usará o fuso horário do site como padrão se isso não estiver definido.
- Excluir o workflow.
Isso é permanente, portanto, você deve considerar exportar seu workflow (acessível no menu de três pontos no canto superior direito do construtor de workflow) antes de prosseguir.
Versões
Toda vez que você fizer uma atualização no workflow, salvaremos a(s) versão(ões) anterior(es). Isso facilita Reverter mudanças que não funcionaram como você esperava.
Variáveis
Variáveis são pares chave-valor limitados a um único workflow. Defina-as no painel Variáveis do workflow e referencie-as em qualquer lugar com {{ $vars.nome_da_chave }}. Use variáveis para armazenar valores de configuração (como um ID de categoria ou um nome de usuário de destinatário) que você deseja poder alterar sem editar o gráfico do workflow.
Credenciais
Alguns nós — como solicitação HTTP ou Agente de IA — precisam se autenticar em 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
Tabelas de dados são tabelas estruturadas e persistentes internas ao plugin Workflows. Use o nó Tabela de dados para ler ou gravar nelas. Elas suportam tipos de coluna string, number, boolean e date.
Tabelas de dados são úteis para:
- Deduplicação — registre quais usuários ou tópicos um workflow já processou
- Estado — rastreie se um tópico está em uma etapa específica de um processo
- Consultas — armazene mapeamentos (como ID do tópico → membro da equipe designado) que seus workflows podem consultar
Execuções
Você pode ver todas as execuções de todos os workflows na guia Execuções. O formato e a função são muito semelhantes às execuções específicas de workflow, mas mostram em todos os workflows para facilitar o monitoramento.
Modelos
Quando você cria um novo workflow, pode começar com 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 post-its explicando como funcionam e são uma boa maneira de aprender o sistema.
Interessado em ver mais modelos? Trabalharemos para expandir a biblioteca de modelos disponíveis ao longo do tempo, mas por favor nos avise se houver um modelo que você gostaria de ver aqui para facilitar o uso dos 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.
