IMPORTANTE: esta documentação foi descontinuada. Leia a documentação Canvas atualizada no nosso novo portal de documentação.
O Canvas é o ambiente de construção de pipelines da Plataforma Digibee. Através dele, você consegue desenvolver integrações simples ou complexas arrastando e soltando componentes pré-configurados com rapidez e precisão.
Todo pipeline é composto por um trigger e por pelo menos um componente, que devem ser conectados entre si para que possam estabelecer um fluxo de integração. No Canvas você consegue organizar e configurar o trigger e os componentes do seu pipeline de acordo com a sua necessidade de negócio.
Informações iniciais
Para criar seu pipeline, acesse a página de Build e clique em +CRIAR, selecionando a opção Pipeline.
Configurações do pipeline
Antes de partir para a construção do fluxo, é preciso configurar o pipeline. Para isso, clique na engrenagem no canto superior direito do Canvas.
Na página de configurações do pipeline, se necessário, configure os seguintes campos:
Descrição: descreva o pipeline.
“É multi-instância?”: acione esta opção caso o pipeline a ser criado seja multi-instância. Para saber mais sobre essa funcionalidade, leia o artigo Multi-instância.
Campo sensível: defina quais dados precisam ser mascarados durante a execução do fluxo.
InSpec: especifique a entrada do fluxo do pipeline.
OutSpec: especifique a saída do fluxo do pipeline.
Crie um fluxo
Após configurar o pipeline, você poderá partir para a construção do fluxo. Para saber mais sobre os elementos que constituem um pipeline, continue lendo.
Trigger
O primeiro passo para criar um fluxo é escolher um trigger. O trigger é o elemento que define como a execução do pipeline será iniciada - através de uma chamada externa, em resposta a um evento ou via agendamento, por exemplo. Atualmente, estão disponíveis diferentes tipos de trigger, são eles:
rest
event
scheduler (custom, midnight, 30min, 5min)
http
http-file
email
email-v2
kafka
rabbitmq
jms
Para defini-lo, basta clicar na engrenagem sobre o trigger e escolher entre as opções listadas, conforme o exemplo abaixo:
Componentes
Os componentes representam etapas do fluxo e são escolhidos de acordo com as suas necessidades de negócio. Combine todas as etapas do processo de integração que deseja realizar utilizando a lista de componentes à direita do Canvas.
Para excluir uma conexão ou um componente específico do fluxo, clique na lixeira e no X.
Para configurar o componente a ser utilizado, clique na engrenagem sobre ele para acessar o formulário de configuração. No exemplo abaixo, é possível visualizar o formulário do componente Google Drive.
Para saber mais a respeito de cada componente disponível em nossa lista, acesse a nossa Documentação de componentes.
Botões de controle do Canvas
Você pode facilmente navegar pelo pipeline através dos botões Reorganizar, Ampliar zoom e Reduzir zoom. O primeiro é utilizado para reorganizar os componentes utilizados de forma que facilite a visualização de cada etapa do fluxo; os outros dois são utilizados para controlar o zoom do Canvas.
Test mode
O Test mode é uma funcionalidade da Plataforma Digibee que permite que você execute e teste seu pipeline diretamente da área de desenvolvimento. Utilize o Test mode sempre que quiser avaliar o fluxo de integração, depurar e solucionar problemas. Para saber mais sobre essa funcionalidade, leia o artigo Test mode.
Salve o pipeline
Por fim, após construir seu fluxo de integração, clique em Salvar no canto superior direito da tela, e defina um nome, uma descrição (opcional) e o projeto no qual o pipeline estará alocado.
Caso deseje saber ainda mais sobre pipelines, leia o artigo Pipeline.