Jitterbit Harmony Connector SDK¶

Visão Geral¶

Os conectores permitem que os usuários finais da Jitterbit se conectem e interajam com os endpoints, e um conector customizado construído com o Jitterbit Harmony Connector SDK aumenta as capacidades dos endpoints com os quais um projeto do Jitterbit Harmony Cloud Studio pode se conectar e interagir. Os conectores construídos com o Connector SDK não são limitados a APIs HTTP/REST (como ocorre com o Connector Builder), e sim podem utilizar qualquer API fornecida por um endpoint.

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

Esta documentação é o ponto de partida no desenvolvimento de um conector, e ela presume que você já seja familiarizado(a) com a Jitterbit, o Jitterbit Harmony, o Jitterbit Harmony Cloud Studio, os Jitterbit Harmony Private Agents e desenvolvimento em Java. Por favor consulte as partes relacionadas da nossa documentação na Jitterbit Success Central caso você não esteja familiarizado(a) com a 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 Cloud Studio como qualquer outro conector. Quando uma conexão está configurada, eles fornecem atividades específicas - conforme determinadas pelo(a) desenvolvedor(a) do conector - que podem ser usadas como fontes ou alvos numa operação. Eles são executados em Private Agents e funcionam com o Cloud Studio.

O Jitterbit Harmony Dropbox Connector é um conector customizado desenvolvido usando o Connector SDK, mostrado no Cloud Studio junto com as suas atividades: Process File, Fetch File, Get File e Put File:

Este conector do Jitterbit Harmony interage com o Dropbox, fornecendo tanto leitura quanto escrita de arquivos de e para o Dropbox. O exemplo está disponível como código fonte por meio do repositório GitHub jitterbit/dropbox-conector e é usado como base para o Tutorial do Conector Dropbox.

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

• Conector: Uma coleção de atividades que interagem com um sistema. Um conector precisa implementar a interface JitterbitConnector.

• Atividade: Representa a menor unidade de execução dentro de uma operação Jitterbit. Corresponde a um nó dentro de uma operação do Cloud Studio. Toda atividade precisa implementar uma interface JitterbitActivity com as seguintes duas partes:

  • Configuration: Feita por um usuário final usando a interface de usuário do Cloud Studio.

  • Execution: Executa uma atividade de acordo com as configurações do usuário.

• Endpoint: Representa uma conexão com um sistema, com as informações do endpoint fornecidas por um usuário final configurando uma conexão usando a interface de usuário do Cloud Studio.

• Payload: Representa a solicitação/resposta (entrada/saída) de uma atividade durante a execução; mapeia com uma interface Payload.

• Solicitação/Resposta: A solicitação e a resposta de uma atividade desenvolvida com o Connector SDK sempre estará em formato XML.

• adapter.json: Um arquivo JSON contendo a interface de usuário declarativa associada com uma conexão de endpoint e as atividades que compõem um conector. Sendo o(a) desenvolvedor(a), você estabelece os parâmetros que precisam ser configurados e os tipos associados com cada parâmetro. Para interfaces mais complexas, existem widgets disponíveis como parte da interface de usuário do Cloud Studio.

• Schema XML: Um arquivo XML XSD contendo a declaração das estruturas de dados usadas para a solicitação ou a resposta de cada atividade. Estes arquivos XSD são o contrato entre o Jitterbit Harmony e o conector, e são eles que determinam como os dados são mapeados entre o Jitterbit Harmony e o conector.

Implementação de Conectores¶

O Connector SDK permite que os desenvolvedores criem conectores customizados para que os usuários finais configurem endpoints, cujas atividades podem ser utilizadas como fontes ou alvos dentro da interface de usuário do Cloud Studio. Existem várias interfaces que o(a) desenvolvedor(a) precisa completar ao escrever um conector; elas são descritas com códigos de amostra relacionados no artigo Implementação de Conectores.

Registro de Conectores¶

Todos os conectores a serem utilizados no Jitterbit Harmony precisam estar registrados, e os desenvolvedores precisam registrar seus conectores antes de construí-los e colocá-los em pacotes. Instruções detalhadas para registrar o seu conector e estabelecer valores apropriados no arquivo manifesto são fornecidas no arquivo Registro de Conectores.

Interface de Usuário de Conectores no Cloud Studio¶

A interface de usuário do conector, conforme mostrada no Cloud Studio, é definida por um arquivo JSON (por padrão chamado de adapter.json) incluído no arquivo JAR que envolve o conector.

Os elementos da interface do usuário disponíveis - incluindo os ícones e os widgets, com amostras de código para criá-los - são descritos no artigo Componentes da Interface de Usuário do Connector SDK.

Sincronização de Conectores¶

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 estes conectores públicos são automaticamente instalados e atualizados conforme necessário nos agentes, tanto para os Cloud Agent Groups públicos quanto para os Private Agents (começando na versão do Harmony 10.1).

O arquivo JAR do conector público será baixado em 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 tenha sido adicionada e configurada.

Os conectores privados são conectores construídos por desenvolvedores terceiros (por exemplo, você) e são instalados nos Private Agents diretamente mediante a cópia do arquivo JAR para o diretório connectors do Private Agent.

As APIs estão disponíveis para login, registro, listagem e exclusão de conectores. Veja o artigo REST APIs para mais detalhes sobre as APIs e Registro para exemplos de como usar as APIs com Postman.