Canvas
7 min
Visão geral do Canvas
O Canvas da Fluid é a área visual onde você modela integrações como fluxos de passos conectados. Cada passo representa uma ação (ex.: chamar uma API, transformar dados, aguardar, disparar e-mail), e o conjunto forma um processo automatizado, testável e versionado.
Conceitos-chave
- Conector: componente que integra um serviço/sistema (API, banco, ERP etc.).
- Passo: uma instância configurada de um conector no seu fluxo.
- Fluxo: sequência orquestrada de passos que resolve um caso de uso.
- Canvas: a superfície de arrastar-e-soltar onde você constrói o fluxo.
- Dados entre passos: use as convenções de entrada/saída do Canvas (ex.: .input e .step) para referenciar dados já produzidos.
Anatomia do Canvas
- Top Bar
- Testar: executa o fluxo (ou um passo) para validações rápidas.
- Salvar: registra alterações em rascunho.
- Publicar: promove a versão atual para execução.
- Histórico de versões: consulta, compara e restaura versões.
- AI Assistant: auxilia com dicas, geração de exemplos e inspeção de erros. Veja mais sobre em Documentação de fluxos com IA
- Área de Desenho
- Arraste conectores, posicione passos, conecte nós e organize o layout.
- Renomeie passos para facilitar entendimento (ex.: get-users).
- Gavetas Laterais
- Conectores / Meus Modelos: catálogo para arrastar novos passos.
- Monitoramento: painel de logs em tempo real e histórico de execuções.
Fluxo de trabalho recomendado
- Modelagem Inicial
- Comece pelo caminho feliz (entrada → transformações → saída).
- Acrescente validações e ramificações para exceções.
- Configuração de Passos
- Defina entradas, parâmetros, headers/credenciais e mapeie saídas.
- Padronize nomes de variáveis e chaves de resposta.
- Teste e Depuração
- Use Testar durante a construção.
- Acompanhe o Monitoramento para ver latência, payloads e respostas por passo.
- Ajuste até obter Sucesso em todos os passos críticos.
- Versionamento e Publicação
- Salvar para consolidar mudanças.
- Revise o Histórico, compare diffs e adicione comentários de release.
- Publicar quando estiver pronto para produção.
Monitoramento
- Tempo Real
- Visualize a execução passo a passo (status, duração e mensagens).
- Filtre por status, pesquise por ID de execução e reexecute quando aplicável.
- Histórico
- Consulte execuções anteriores, identifique padrões de falha e gargalos.
- Use as informações para otimizar tempo de resposta e confiabilidade.
Tratamento de erros
- Boas Práticas
- Antecipe falhas prováveis (timeouts, validação de schema, credenciais).
- Crie ramificações de erro (try/catch) com mensagens claras e contexto útil.
- Registre logs acionáveis (o que ocorreu, onde e com quais dados mínimos).
- Estruture respostas de erro para facilitar reprocesso e alerta.
Privacidade e segurança
- Dados Sensíveis
- Aplique mascaramento/anonimização quando necessário.
- Use o princípio do menor privilégio nas credenciais.
- Evite logar PII ou segredos; guarde-os em cofres apropriados.
- Governança
- Documente propósitos, fontes e destinos de dados.
- Controle versões e mudanças via comentários de publicação.
Checklist de Qualidade
- Modelagem
- Fluxo claro do início ao fim e nomes descritivos.
- Entradas/saídas mapeadas com .input/.step.
- Confiabilidade
- Tratamento de erros com mensagens úteis e caminhos alternativos.
- Timeouts e retries configurados conforme o conector.
- Observabilidade
- Logs concisos e suficientes para diagnóstico.
- Métricas de duração por passo observadas e otimizadas.
- Segurança
- Segredos fora do código e PII não logada.
- Permissões mínimas e revisadas.
- Governança
- Versão comparada e comentada antes de publicar.
- Mudanças documentadas (o que/por quê/impacto).
Dicas Rápidas
- Prefira pequenos passos coesos a passos “faz-tudo”.
- Valide schemas (entrada/saída) para evitar efeito dominó.
- Centralize trechos reutilizáveis em Flowkits/Modelos.
- Faça testes locais frequentes; publique apenas quando tiver métricas estáveis.
Glossário Essencial
- Canvas: área visual de construção de fluxos.
- Conector: componente que integra serviços.
- Passo: instância configurada de um conector.
- Fluxo: orquestração de passos.
- Monitoramento: painel de logs e execuções.
- Scheduler: agendamento de execução recorrente.
- Flowkit: pacote de fluxos reutilizáveis.
- Publicar: promover versão para execução oficial.
Limitações e Observações
- A profundidade de logs depende da configuração de cada passo.
- Agendamentos e reprocessos devem respeitar limites e quotas dos sistemas de destino.
- Integrações com dados sensíveis exigem políticas adicionais de segurança e auditoria.