Linter: Validação de construção do canvas

Aprenda mais sobre a função Linter, que permite validar a construção de pipelines e cápsulas no canvas.

O canvas exibe alertas durante a construção de pipelines e cápsulas que ajudam os desenvolvedores a identificar e corrigir problemas comuns mais rapidamente.

Localizar problemas

Para cada componente que apresenta um problema durante a criação do fluxo, o canvas exibe um alerta com detalhes e informações. Muitas das validações têm o propósito de aviso e não demandam correções nem são intrusivas no processo de criação do seu fluxo.

Alertas

Os problemas validados durante a construção do pipeline ou cápsula são divididos em Erros e Avisos. Essa divisão de alertas ajuda o desenvolvedor a entender o nível de gravidade do problema apontado pelo canvas.

Erros

Os alertas de Erro apontam falhas graves na construção do pipeline ou cápsula. Eles devem ser corrigidos ou não será possível salvar o projeto

O canvas exibe erros da seguinte categoria:

  • Estrutura: erros estruturais que impedem o processamento do fluxo de integração.

Avisos

Os alertas de Aviso exibem pontos de melhoria na construção do pipeline ou cápsula.

O canvas exibe avisos da seguinte categoria:

  • Boas práticas: hábitos de construção que tornam seu pipeline ou cápsula mais saudável, e podem facilitar futuras manutenções e melhorias.

Lista de alertas

Para cada problema encontrado durante a construção de pipelines ou cápsulas, um alerta é mostrado em seu componente de origem e em uma lista. Os alertas são divididos seguindo as categorias acima e é possível visualizar quantos alertas de cada tipo há separadamente.

A partir da lista é possível:

  • Visualizar a imagem e nome do componente com problema junto a uma descrição e link para a documentação com orientações sobre como resolvê-lo.

  • Esconder os alertas temporariamente clicando no ícone de olho.

  • Navegar entre os sub-níveis até o componente com erro clicando no ícone de alvo.

  • Abrir o formulário de configuração do componente para editá-lo clicando no ícone de engrenagem.

Para visualizar a lista, clique no botão Problemas, representado por um ícone de alerta na barra de tarefas do lado esquerdo.

Corrigir problemas

Todas as validações do canvas apresentam informações que te ajudam a corrigir o problema. Passe o mouse sobre o ícone de alerta para que as informações sejam exibidas. Desse modo, você poderá lê-las e verificar a aplicabilidade de cada sugestão no seu pipeline ou cápsula.

Esta página lista todos os possíveis alertas desenvolvidos até agora, contendo detalhes e informações de como você pode corrigir e aprimorar seu fluxo.

Choice

  1. O componente Choice precisa ter um "when" configurado (estrutura)

O Choice permite o desvio de fluxo dentro de um pipeline ou cápsula. Para utilizar esse componente corretamente, é necessário configurar suas condicionais "when". Cada when define uma condição que realiza um desvio no fluxo para uma linha de execução específica. É necessário ter pelo menos 1 condição when configurada.

Desse modo, defina pelo menos uma condição when para evitar a interrupção do fluxo.

  1. O componente Choice precisa ter um "otherwise" configurado (estrutura)

O Choice permite o desvio de fluxo dentro de um pipeline ou cápsula. Para utilizar esse componente corretamente, é necessário configurar seu comando "otherwise". O otherwise é o comando a ser executado quando nenhuma das condições when é atendida. É necessário ter 1 condição otherwise configurada.

Portanto, defina o comando otherwise a ser executado caso nenhuma das condições when for considerada verdadeira.

Componentes de subfluxo

Os seguintes problemas se referem aos componentes que permitem a estruturação de subpipelines, ou seja, subfluxos do pipeline ou cápsulas. Subpipelines são estruturados a partir dos seguintes componentes:

  1. O OnProcess precisa ter ao menos um componente conectado (estrutura)

O OnProcess define um dos subfluxos do pipeline. Estruture e conecte o subpipeline OnProcess para que o fluxo não seja interrompido.

  1. O OnException precisa ter ao menos um componente conectado (boas práticas)

O OnException é o subpipeline onde é implementado o fluxo que trata uma exceção na execução do OnProcess. Estruture e conecte o subfluxo OnException para que o fluxo não seja interrompido.

Essa regra não se aplica ao componente Block Execution.

  1. Existe ao menos um problema dentro de OnProcess (estrutura)

O OnProcess define um dos subfluxos do pipeline ou cápsula. Verifique os problemas do subpipeline OnProcess para prosseguir com a criação do seu fluxo.

  1. Existe ao menos um problema dentro de OnException (estrutura)

O OnException é o subpipeline onde é implementado o fluxo que trata uma exceção na execução do OnProcess. Verifique os problemas do subfluxo OnException para prosseguir com a criação do seu pipeline ou cápsula.

Parallel

  1. O componente Parallel precisa ter ao menos uma execução configurada (estrutura)

O Parallel permite a configuração de linhas de execução paralelas dentro do fluxo. Conecte o Parallel a outro componente para evitar a interrupção do fluxo.

O Parallel deve ser sempre seguido por outro componente para que o fluxo possa ser executado.

  1. O componente Parallel deve ter ao menos duas execuções configuradas (boas práticas)

O Parallel permite a configuração de uma ou mais linhas de execução paralelas dentro do fluxo. Como boa prática, recomendamos que utilize o Parallel apenas quando seu fluxo precisar de duas execuções ou mais ocorrendo simultaneamente.

Triggers

  1. Trigger não configurado. Para implantar o pipeline, configure o trigger (estrutura)

O trigger define como a execução do pipeline será iniciada. Para configurar o trigger, selecione uma das opções disponibilizadas pela Digibee Integration Platform. A seguir, conecte-o ao início do fluxo para implantar o pipeline posteriormente. Para mais informações, acesse a documentação dos triggers.​

Você pode salvar o pipeline mesmo sem configurar o trigger. No entanto, não será possível implantá-lo.

Componentes descontinuados

  1. Versão do componente descontinuada. Existe uma versão nova deste componente (boas práticas)

A versão do componente que você está tentando utilizar foi descontinuada. Isso significa que há uma nova versão incrementada e melhorada disponível para uso.

Exemplo: O componente SOAP possui três versões, SOAP V1, SOAP V2 e SOAP V3. Recomendamos a versão mais atual do componente, a SOAP V3.

A versão descontinuada do componente ainda pode ser utilizada. No entanto, é importante informar que incrementos e melhorias são feitos na última versão do componente.

Cápsulas

  1. Esta Cápsula não pode ser usada aqui porque ela não existe neste realm (estrutura)

A cápsula que você está tentando utilizar não existe no realm no qual você está operando. Você precisa apagá-la ou substituí-la por outro componente, fluxo ou uma cápsula existente neste realm.

Session Management

  1. O campo não foi declarado anteriormente (boas práticas)

Não foi possível utilizar o campo (operação GET) porque o mesmo não foi declarado (operação PUT) anteriormente.

  1. O campo foi declarado, mas não está sendo usado (boas práticas)

O campo foi declarado anteriormente (operação PUT), mas não está sendo utilizado.

Configure um novo componente Session Management para utilizar (operação GET) ou deletar (operação DELETE) o campo declarado anteriormente.

Atualizado