Jitterbit Connector SDK

Visão Geral

Conectores permitem que usuários finais no Jitterbit se conectem e interajam com endpoints, e um conector personalizado construído com o Connector SDK estende as capacidades dos endpoints com os quais um projeto de integração pode se conectar e interagir. Conectores construídos com o Connector SDK não estão limitados a APIs HTTP/REST (como é o caso do Connector Builder), mas podem usar qualquer API fornecida por um endpoint.

Criar um conector com o Connector SDK requer que um desenvolvedor esteja familiarizado com práticas e ferramentas padrão de desenvolvimento em Java, como Maven, Docker, Postman e Git.

Esta documentação é o ponto de partida no desenvolvimento de um conector e assume que você já está familiarizado com Jitterbit, Harmony, Integration Studio, agentes Jitterbit e desenvolvimento em Java. Consulte as partes relacionadas de nossa documentação no site de documentação do Jitterbit se você não estiver familiarizado com Jitterbit.

A versão atual do Connector SDK é a versão 1.0.0.

Conceitos do Connector SDK

Conectores construídos com o Connector SDK aparecem no Integration Studio assim como qualquer outro conector. Uma vez que uma conexão é configurada, eles fornecem atividades específicas—conforme determinado pelo desenvolvedor do conector—que podem ser usadas como fontes ou destinos em uma operação. Eles são executados em agentes privados e funcionam com o Integration Studio.

O conector do Dropbox é um conector personalizado desenvolvido usando o Connector SDK, mostrado no Integration Studio com suas atividades: Processar Arquivo, Buscar Arquivo, Obter Arquivo e Enviar Arquivo:

Este conector Jitterbit interage com o Dropbox, fornecendo tanto a leitura quanto a gravação de arquivos de e para o Dropbox. O exemplo está disponível como código-fonte através do repositório GitHub jitterbit/dropbox-connector e é usado como base para o Tutorial do Conector do Dropbox.

Do ponto de vista do desenvolvimento, estes são os principais elementos de um conector Jitterbit:

• Conector: Uma coleção de atividades que interage com um sistema. Um conector precisa implementar a interface JitterbitConnector.
• Atividade: Representa a menor unidade de execução dentro de uma operação Jitterbit. Ela corresponde a um nó dentro de uma operação do Integration Studio. Cada atividade precisa implementar uma interface JitterbitActivity com estas duas partes:
  • Configuração: Realizada por um usuário final usando a interface do usuário do Integration Studio.
  • Execução: Executa uma atividade de acordo com a configuração do usuário.
• Endpoint: Representa uma conexão a um sistema, com informações do endpoint fornecidas por um usuário final configurando uma conexão usando a interface do usuário do Integration Studio.
• Payload: Representa uma solicitação/resposta (entrada/saída) de uma atividade durante a execução; mapeia para uma interface Payload.
• Solicitação/Resposta: A solicitação e a resposta de uma atividade desenvolvida com o SDK de Conectores estarão sempre em formato XML.
• adapter.json: Um arquivo JSON contendo a interface de usuário declarativa associada a uma conexão de endpoint e as atividades que compõem um conector. Como desenvolvedor, você define os parâmetros que precisam ser configurados e os tipos associados a cada parâmetro. Para interfaces mais complexas, há componentes disponíveis como parte da interface do usuário do Integration Studio.
• Esquema XML: Um arquivo XSD XML contendo a declaração das estruturas de dados usadas para a solicitação ou resposta de cada atividade. Esses arquivos XSD são o contrato entre o Harmony e o conector, e determinam como os dados são mapeados entre o Harmony e o conector.

Implementação do Conector

O SDK do Conector permite que desenvolvedores criem conectores personalizados para que os usuários finais configurem pontos de extremidade, cujas atividades podem ser usadas como fontes ou destinos dentro da interface do Integration Studio. Existem várias interfaces que o desenvolvedor deve completar ao escrever um conector; elas são descritas com exemplos de código relacionados em Implementação do Conector.

Registro do Conector

Todos os conectores a serem usados em um projeto de integração precisam ser registrados, e os desenvolvedores devem registrar seus conectores antes de construí-los e empacotá-los. Instruções detalhadas para registrar seu conector e definir valores apropriados no arquivo de manifesto estão descritas em Registro do Conector.

UI do Conector no Integration Studio

A interface do conector, conforme exibida no Integration Studio, é definida por um arquivo JSON (por padrão chamado adapter.json) incluído no arquivo JAR que empacota o conector.

Os elementos de UI disponíveis—incluindo ícones e componentes, com exemplos de código para criá-los—são descritos em Componentes de UI do SDK do Conector.

Sincronização do Conector

Conectores públicos são conectores construídos e mantidos pela Jitterbit. Eles estão disponíveis para todos os usuários, em todos os agentes. Os arquivos JAR para esses conectores públicos são instalados e atualizados automaticamente conforme necessário nos agentes, tanto para os grupos de agentes da nuvem pública quanto para agentes privados (a partir da versão 10.1 do Harmony).

O arquivo JAR do conector público será baixado para um agente conforme necessário, uma vez que um conector tenha sido configurado e o botão Test da configuração tenha sido clicado ou uma atividade adicionada e configurada.

Conectores privados são conectores construídos por desenvolvedores de terceiros (como você) e são instalados em agentes privados diretamente copiando o arquivo JAR para o diretório connectors do agente privado.

APIs estão disponíveis para login, registro, listagem e exclusão de conectores. Veja REST APIs para detalhes das APIs e registro para exemplos de uso das APIs com o Postman.