Aprenda mais como testar os seus pipelines ou cápsulas usando o Painel de execução na Digibee Integration Platform.
Esta funcionalidade se chamava "Test mode" até junho de 2023.
O Painel de Execução permite testar um pipeline ou cápsula em um ambiente de teste enquanto você desenvolve seu fluxo. Ele utiliza valores de Globals, Contas, Relacionamentos e serviços Multi-Instância, possibilitando validar a lógica de implementação e depurar o fluxo em tempo real.
Visão geral do Painel de execução
Você pode acessar o Painel de execução no canto inferior esquerdo do Canvas ou pelo atalho Cmd (CTRL) + D. O painel é dividido em quatro abas:
Teste: Insira os dados de teste e execute o fluxo.
Resultados: Visualize os dados de entrada e saída em modo leitura. Mais informações sobre casos de teste executados também ficam disponíveis nesta aba.
Mensagens: Revise os resultados da execução de cada conector individualmente.
Logs: Acompanhe logs informativos, de erros e alertas relacionados à execução.
Você também pode importar e exportar execuções diretamente pelo Painel de execução.
Aba Teste
A aba Teste permite inserir dados, executar o teste e revisar os resultados.
Coluna Parâmetros (apenas em cápsulas)
A coluna Parâmetros aparece ao testar uma execução em uma cápsula. Nessa seção, você deve inserir os valores de parâmetros e contas, com base no formulário de configuração da cápsula. Isso simula uma execução real, proporcionando o mesmo fluxo de trabalho que os usuários terão no futuro.
Coluna Payload
A coluna Payload é onde você insere os dados para o teste. Após inserir os dados, você pode:
Selecionar uma instância específica
Se o pipeline estiver configurado como multi-instância, o dropdown Multi-instance será exibido. Você deverá selecionar a instância que deseja testar. Para mais detalhes, consulte a documentação sobre Multi-Instância.
Salvar o payload
Você pode salvar o payload inserido para uso futuro no pipeline ou cápsula que está construindo.
Clique em Salvar como Payload para armazená-lo. Os payloads são salvos por pipeline ou cápsula e não podem ser acessados em outros pipelines ou cápsulas.
Depois de salvo, você pode acessar seus payloads clicando em Payloads, onde poderá selecionar, excluir ou adicionar novos payloads.
Os payloads não podem ser editados após o salvamento. Caso faça alterações no payload, será necessário salvá-lo como um novo.
Formatar o JSON
Para melhorar a legibilidade, use o ícone de varinha mágica no canto superior direito da coluna Payload para formatar automaticamente o JSON.
Coluna Saída
Depois que o teste for executado, os resultados serão exibidos na coluna Saída. Nela, você pode:
Fazer o download ou copiar a saída
No canto superior direito, você encontrará botões para:
Fazer o download da saída JSON como um arquivo.
Copiar a saída para a área de transferência.
Buscar por JSONPath
Na parte inferior da coluna Saída, você pode aplicar uma expressão JSONPath para filtrar elementos específicos do JSON retornado.
Aba Resultados
A aba Resultados oferece uma visualização somente leitura dos dados de entrada e saída do pipeline. Isso é especialmente útil durante a execução de casos de teste, pois qualquer falha de asserção é exibida nessa aba, facilitando a validação.
Aba Mensagens
A aba Mensagens exibe o resultado da execução de cada conector no pipeline. Cada conector recebe o payload do conector anterior, processa-o conforme sua função e gera um novo payload em resposta.
Lista de mensagens
A coluna à esquerda da aba Mensagens mostra as primeiras 5.000 mensagens. A lista inclui:
Nome: O nome da mensagem, que corresponde ao Step Name do conector.
Tempo: O tempo de execução do conector em milissegundos.
Para localizar uma mensagem específica, use o campo Buscar por mensagens abaixo da lista. Você pode pesquisar pelo nome completo ou parcial da mensagem, ou por um parâmetro do conector.
Pré-visualização da mensagem
Ao selecionar uma mensagem, sua pré-visualização será exibida na coluna à direita. Na pré-visualização, você pode:
Fazer o download ou copiar a mensagem
No canto superior direito, há opções para:
Fazer o download da mensagem como arquivo.
Copiar a mensagem para a área de transferência.
Buscar por JSONPath
Na parte inferior da pré-visualização, você pode aplicar uma expressão JSONPath para filtrar elementos específicos da saída JSON.
Aba Logs
A aba Logs exibe informações sobre os eventos registrados durante a execução do pipeline no Painel de execução.
Lista de logs
A lista de logs apresenta as seguintes informações:
Tipo do log: A classificação do log, indicada por um ícone. Os tipos disponíveis são:
Info: Logs informativos.
Erros: Logs que capturam erros durante a execução.
Alerta: Logs que indicam alertas.
Timestamp: A data e hora em que o passo foi executado no pipeline.
Mensagem do log: A descrição de cada log.
Na aba Logs, você pode:
Filtrar logs por tipo.
Copiar a mensagem de qualquer log.
Buscar logs específicos utilizando parte ou toda a mensagem do log
Exportação e importação
O Painel de execução permite importar ou exportar uma execução.
Exportar
Para fazer o download de um arquivo com a configuração do pipeline ou cápsula e os dados de execução, clique em Exportar execução. Certifique-se de que todos os dados de execução estejam totalmente carregados na tela antes de exportar, para evitar a perda de informações.
O arquivo exportado contém os seguintes dados:
pipelineId: O ID do pipeline ou cápsula.
pipelineName: O nome do pipeline ou cápsula.
currentFlowSpec: Os dados do fluxo no Canvas no momento da exportação, incluindo todos os conectores e suas configurações.
executedFlowSpec: Os dados do fluxo no Canvas no momento da execução, incluindo todos os conectores e suas configurações.
realm: O realm do pipeline ou cápsula.
execution: Os dados da execução, como Payload, Saída, Mensagens e Logs.
Se o pipeline não for executado antes da exportação, o arquivo conterá apenas as informações do pipeline ou cápsula, como o ID, o nome, o currentFlowSpec e o executedFlowSpec.
Importar
Para carregar um arquivo do seu computador com as configurações de um pipeline ou cápsula e os dados da execução, clique em Importar execução.
Após a importação, os dados de execution aparecerão no Painel de Execução. No entanto, os dados de currentFlowSpec e executedFlowSpec não serão exibidos no Canvas.
Além disso, só é possível executar os dados de um arquivo importado se você estiver no mesmo pipeline ou cápsula em que a execução foi exportada, e se o fluxo original ainda existir.
Executando o fluxo
Executar um fluxo permite que você teste e valide seu pipeline e cápsula, garantindo que funcionem conforme esperado. É possível executar o fluxo completo ou apenas uma parte dele, dependendo das suas necessidades.
Como executar o fluxo inteiro
Você pode executar o fluxo inteiro utilizando uma das seguintes opções:
Pressione Cmd (Ctrl) + Enter.
Abra o Painel de execução e clique em Executar.
Abra o Painel de execução, clique na seta ao lado de Executar e selecione Executar pipeline ou Executar cápsula.
Independentemente de haver conectores selecionados, essas opções sempre executarão o fluxo inteiro.
Como executar parte do fluxo
Para executar uma parte específica do fluxo:
Etapa 1: Selecione os conectores
Escolha os conectores desejados utilizando uma das seguintes opções:
Segure Shift e arraste o mouse sobre os conectores.
Segure Shift e clique em cada conector individualmente.
Certifique-se de que os conectores selecionados estejam conectados e em sequência. Saltar um conector no meio da sequência invalidará a seleção.
Etapa 2: Execute a seleção
Após selecionar os conectores, execute a parte escolhida do fluxo de uma das seguintes formas:
Pressione Cmd (Ctrl) + Shift + Enter.
Abra o Painel de execução, clique na seta ao lado de Executar e selecione Executar seleção.
Como executar a partir de um passo específico
Você pode iniciar a execução do pipeline a partir de qualquer passo escolhido, garantindo que todos os passos seguintes no fluxo sejam executados. Para isso, siga estes passos:
Clique no conector onde deseja iniciar a execução.
Abra o Painel de execução.
Clique no menu suspenso ao lado de Executar e selecione Executar daqui. Você também pode utilizar o atalho Ctrl + Alt + Enter para Windows ou Cmd (⌘) + Option (⌥) + Enter para macOS.
O pipeline será então executado a partir do passo selecionado e continuará com o restante do fluxo.
Informações adicionais
Abaixo você encontrará alguns detalhes importantes sobre o Painel de execução e teclas de atalho úteis.
Inatividade do Painel de execução
Se o Painel de execução ficar inativo por 24 horas sem uso, ele será desativado. Ao reabrir o Canvas, pode levar até 3 minutos para o Painel ficar ativo novamente.
Teclas de atalho
Cmd (Ctrl) + D: Abrir ou fechar o Painel de execução.
Cmd (Ctrl) + Enter: Executar o fluxo inteiro.
Cmd (Ctrl) + Shift + Enter: Executar os conectores selecionados.
Ctrl + Alt + Enter (Windows): Executar a partir do passo selecionado.
Cmd (⌘) + Option (⌥) + Enter (macOS): Executar a partir do passo selecionado.
