Introdução
Esta seção descreve as principais funcionalidades do sistema de Workflow, abordando desde o cadastro de novos fluxos (Blueprints e Functions), até a execução, reprocessamento, exclusão e listagem de fluxos de trabalho. Também são detalhadas as funcionalidades de integração, gerenciamento de chaves de APIs e templates, oferecendo uma visão completa sobre como operar a plataforma de forma eficiente.
O Workflow é projetado para ser altamente flexível e extensível, permitindo que fluxos de trabalho sejam disparados de diferentes formas, como por debug, triggers, eventos ou agendamentos. Abaixo, você encontrará uma breve explicação de cada funcionalidade disponível.
Funcionalidades Disponíveis
Cadastrar (Blueprint / Function)
Permite o cadastro de novos fluxos de trabalho, sejam eles Blueprints (fluxos que podem ser executados de forma independente ou configurados como templates reutilizáveis para criar novos Blueprints) ou Functions (fluxos específicos com uma função bem definida que podem ser utilizados dentro de Blueprints).
A criação inicial de fluxos, sejam eles do tipo Blueprints ou Functions, só pode ser feita pela interface da plataforma. No entanto, fluxos configurados como templates podem ser clonados via API, permitindo a criação de novos fluxos a partir desses modelos. Tanto Blueprints quanto Functions podem ser configurados como templates, possibilitando sua reutilização e replicação conforme necessário.
Executar um fluxo em modo debug
Esta funcionalidade permite executar um fluxo de trabalho em modo debug, útil para testar e validar a lógica do fluxo antes de colocá-lo em produção. Ela oferece uma visualização detalhada de cada etapa da execução.
Executar um fluxo a partir de uma trigger
Permite disparar um fluxo de trabalho automaticamente com base em uma trigger configurada. As triggers podem ser eventos internos ou ações realizadas por usuários.
Executar um fluxo a partir de um evento
Habilita a execução de fluxos de trabalho em resposta a eventos específicos recebidos de sistemas externos via Webhooks.
Executar um fluxo a partir de um schedule
Permite configurar a execução automática de um fluxo de trabalho em intervalos de tempo definidos, como diariamente, semanalmente ou a cada X minutos.
Exclusão de fluxo
Funcionalidade que permite excluir um fluxo de trabalho específico, garantindo que ele não seja mais executado ou listado entre os fluxos disponíveis.
Listar Workflows (Blueprints / Functions)
Permite listar todos os fluxos de trabalho cadastrados na plataforma, incluindo Blueprints e Functions, com a possibilidade de filtrar por parâmetros específicos.
Buscar um workflow por ID
Permite buscar um fluxo de trabalho específico usando seu ID único. Essa funcionalidade é útil para obter detalhes completos sobre um fluxo específico.
Listar execuções a partir de um filtro
Permite listar todas as execuções realizadas, aplicando filtros como data, status e tipo de fluxo.
Listar logs de uma execução
Habilita a listagem detalhada dos logs de uma execução específica, permitindo uma análise detalhada de cada etapa do fluxo de trabalho.
Listar integrações
Retorna a lista de integrações configuradas na plataforma, permitindo que fluxos de trabalho possam interagir com sistemas externos de forma automatizada.
Listar Chaves de APIs
Permite listar todas as chaves de APIs cadastradas na plataforma, essenciais para autenticação em chamadas externas.
Cadastrar Chaves de APIs
Funcionalidade que permite cadastrar novas chaves de APIs na plataforma, garantindo que sistemas externos possam se autenticar corretamente ao utilizar os fluxos de trabalho.
Excluir Chaves de APIs
Permite excluir chaves de APIs que não são mais necessárias, garantindo a segurança do sistema ao evitar acessos indevidos.
Listar templates
Retorna a lista de templates cadastrados, que podem ser usados como base para a criação de novos fluxos de trabalho.
Buscar um template por ID
Permite buscar um template específico usando seu ID, retornando todos os detalhes necessários para reutilização ou modificação.
Copiar um template
Funcionalidade que permite copiar um template existente, criando uma nova versão do fluxo de trabalho com base no modelo original.
Reprocessar um fluxo de execução com erro
Permite reprocessar uma execução de fluxo que falhou, garantindo a consistência dos dados e a continuidade das operações.
Reprocessamento em massa com upgrade de versão
Permite reprocessar múltiplas execuções de fluxos com falhas, aplicando um upgrade de versão para garantir que todos os fluxos sejam executados com a última versão do blueprint.