Conceitos centrais

​

Workflows

​

Nós e arestas

​

Catálogo

• Os executores de catálogo são os componentes embutidos que um nó de workflow invoca. Eles incluem o conector HTTP genérico e as operações de provedores nativos como o ledger do Midaz e o Tracer.
• Os gatilhos definem os tipos de evento que podem iniciar um workflow (por exemplo, webhooks).

• Listar executores do catálogo e Listar gatilhos do catálogo para descobrir os tipos de executor e de gatilho.
• Listar provedores do catálogo (GET /v1/catalog/providers) para listar todos os provedores disponíveis.
• Obter provedor do catálogo (GET /v1/catalog/providers/{id}) para ver os detalhes de um provedor específico.
• Listar executores por provedor (GET /v1/catalog/providers/{id}/executors) para listar os executores disponíveis em um provedor específico.

​

Configurações de provedor

• config: os dados de conexão daquela instância, como a URL base e as credenciais de autenticação. Para a espécie padrão catalog, o Flowker valida esse mapa contra o JSON Schema do provedor de catálogo. Para external_openapi, ele usa um validador de configuração de OpenAPI externo. Uma leitura nunca retorna a credencial que o tipo de autenticação declara.
• allowedHosts: os hosts públicos que esta configuração pode chamar.
• allowedPrivateHosts: hosts privados nomeados que o seu time de operações permite que esta configuração alcance. Ele remove apenas a restrição do Flowker a endereços privados ou de loopback: se allowedHosts não estiver vazia, ela também deve incluir o host. Metadados de cloud e endereços link-local seguem bloqueados.
• schemaBindings: os schemas XSD ou OpenAPI vinculados a esta configuração, cada um com uma restrição opcional a operações OpenAPI específicas.

​

Como um workflow chega até ela

​

Templates

1. Liste os templates do catálogo.
2. Obtenha o detalhe do template para ver o schema de parâmetros dele.
3. Valide um conjunto de parâmetros contra esse schema.

​

Execuções

• executionId: identificador único desta rodada.
• status: estado atual (pending, running, completed ou failed).
• stepResults: a saída de cada nó de executor, condicional ou ação executado, em ordem. Os nós de gatilho começam o percurso do grafo e não criam registros de etapa de execução.
• finalOutput: o valor final gravado para a execução. Quando uma ação set_output produz um objeto, o Flowker usa esse objeto. Caso contrário, o Flowker devolve o contexto acumulado do workflow.

​

Idempotência

Idempotency-Key: 7f3e1a2b-4c5d-6e7f-8a9b-0c1d2e3f4a5b

​

Dashboard

• Resumo de workflows devolve os totais e a divisão por status (draft, active, inactive).
• Resumo de execuções devolve os totais e a divisão por status, com filtros opcionais de intervalo de tempo e de status.

{
  "total": 12847,
  "completed": 11903,
  "failed": 712,
  "pending": 130,
  "running": 102
}

• Monitorar a saúde das execuções: acompanhe as taxas de conclusão e de falha ao longo do tempo para notar cedo uma degradação.
• Montar páginas de status: mostre o throughput dos workflows e as métricas de sucesso em dashboards internos ou voltados ao cliente.
• Alertar em picos de taxa de falha: compare failed / total com um limiar para disparar alertas antes que os problemas se espalhem.

​

Como tudo se encaixa

1. Explore o catálogo para descobrir os provedores, os executores de catálogo, os gatilhos e os templates disponíveis.
2. Crie configurações de provedor para conectar o Flowker a instâncias ativas de serviços externos.
3. Defina workflows: cada nó de executor nomeia um executor de catálogo e a configuração de provedor pela qual ele chama.
4. Execute workflows para rodar o seu processo de negócio e recuperar os resultados.
5. Monitore: use o dashboard para os resumos operacionais e a API de execuções para o detalhe por etapa.