SDK do Conector Harmony¶

Visão geral¶

Os conectores permitem que os usuários finais no Jitterbit se conectem e interajam com os endpoints, e um conector personalizado construído com o Harmony Connector SDK estende as capacidades dos endpoints um Harmony Cloud Studio projeto pode se conectar e interagir. Os conectores criados com o SDK do conector não estão limitados a APIs HTTP/REST (assim como o Construtor de Conectores), mas pode usar qualquer API fornecida por um endpoint.

A criação de um conector com o SDK do conector requer que um desenvolvedor esteja familiarizado com o desenvolvimento Java padrão práticas e ferramentas, 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, Harmony Cloud Studio, Harmony Agentes Privados e Desenvolvimento Java. Consulte as partes relacionadas de nossa documentação no site de documentação do Jitterbit se você não estiver familiarizado com o Jitterbit.

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

Conceitos do SDK do Conector¶

Os conectores criados com o SDK do conector aparecem no Cloud Studio como qualquer outro conector. Uma vez que uma conexão é configurados, eles fornecem atividades específicas - conforme determinado pelo desenvolvedor do conector - que podem ser usadas como fontes ou alvos em uma operação. Eles rodam em Agentes Privados e trabalham com Cloud Studio.

O Conector do Dropbox do Harmony é um conector personalizado desenvolvido utilizando o Connector SDK, mostrado no Cloud Studio com suas atividades: Process File, Fetch File, Obter arquivo e colocar arquivo:

Este conector Harmony interage com Dropbox, fornecendo leitura e 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 Harmony:

• Conector: Uma coleção de atividades que interage com um sistema. Um conector precisa implementar o JitterbitConnector interface.
• Atividade: Representa a menor unidade de execução dentro de uma operação Jitterbit. Corresponde a um nó em uma operação do Cloud Studio. Toda atividade precisa implementar um JitterbitActivity interface com estes duas partes:
  • Configuration: Executado por um usuário final usando a IU do Cloud Studio.
  • Execution: Executa uma atividade de acordo com a configuração do usuário.
• Endpoint: Representa uma conexão com um sistema, com informações de endpoint fornecidas por um usuário final configurando um conexão usando a IU do Cloud Studio.
• Payload: Representa uma solicitação/resposta (entrada/saída) de uma atividade durante a execução; mapas para um Payload interface.
• Solicitação/Resposta: A solicitação e resposta de uma atividade desenvolvida com o SDK do Conector estará sempre em Formato XML.
• adapter.json: Um arquivo JSON contendo a IU declarativa associada a uma conexão de endpoint e o atividades que compõem um conector. Como desenvolvedor, você define os parâmetros que precisam ser configurados e o tipos associados a cada parâmetro. Para interfaces mais complexas, existem componentes disponíveis como parte da IU do Cloud Studio.
• Esquema XML: Um arquivo XML XSD 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 Connector SDK permite que os desenvolvedores criem conectores personalizados para que os usuários finais configurem endpoints, cujos as atividades podem ser usadas como origens ou destinos na IU do Cloud Studio. Existem várias interfaces que o desenvolvedor deve concluir ao escrever um conector; eles são descritos com exemplos de código relacionados em Implementação do conector.

Registro do conector¶

Todos os conectores a serem usados no Harmony devem ser registrados e os desenvolvedores precisam registrar seus conectores antes de construí-los e embalá-los. Instruções detalhadas para registrar seu conector e configuração os valores apropriados no arquivo de manifesto são descritos em Registro do Conector.

IU do conector no Cloud Studio¶

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

Os elementos de interface do usuário disponíveis, incluindo ícones e componentes, com amostras de código para criá-los, são descritos em Componentes de IU do SDK do conector.

Sincronização do conector¶

Conectores públicos são conectores construídos e mantidos pelo 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 em Nuvem públicos e para Agentes Privados (a partir do Harmony versão 10.1).

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

Conectores privados são conectores criados por desenvolvedores externo (como você) e são instalados em Private Agentes diretamente copiando o arquivo JAR para o Agente Privado connectors diretório.

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