Jitterbit Connector SDK

Overview

Los conectores permiten a los usuarios finales en Jitterbit conectarse e interactuar con puntos finales, y un conector personalizado construido con el SDK de Conectores amplía las capacidades de los puntos finales a los que un proyecto de integración puede conectarse e interactuar. Los conectores construidos con el SDK de Conectores no están limitados a APIs HTTP/REST (como lo está el Constructor de Conectores), sino que pueden utilizar cualquier API proporcionada por un punto final.

Crear un conector con el SDK de Conectores requiere que un desarrollador esté familiarizado con las prácticas y herramientas estándar de desarrollo en Java, como Maven, Docker, Postman y Git.

Esta documentación es el punto de partida en el desarrollo de un conector y asume que ya estás familiarizado con Jitterbit, Harmony, Integration Studio, agentes de Jitterbit y desarrollo en Java. Consulta las partes relacionadas de nuestra documentación en el sitio de documentación de Jitterbit si no estás familiarizado con Jitterbit.

La versión actual del SDK de Conectores es la versión 1.0.0.

Connector SDK concepts

Los conectores construidos con el SDK de Conectores aparecen en Integration Studio igual que cualquier otro conector. Una vez que se configura una conexión, proporcionan actividades específicas—según lo determinado por el desarrollador del conector—que pueden usarse como fuentes o destinos en una operación. Se ejecutan en agentes privados y funcionan con Integration Studio.

El conector de Dropbox es un conector personalizado desarrollado utilizando el SDK de Conectores, mostrado en Integration Studio con sus actividades: Procesar Archivo, Obtener Archivo, Recuperar Archivo y Enviar Archivo:

Este conector de Jitterbit interactúa con Dropbox, proporcionando tanto la lectura como la escritura de archivos desde y hacia Dropbox. El ejemplo está disponible como código fuente a través del repositorio de GitHub jitterbit/dropbox-connector y se utiliza como base para el Tutorial del Conector de Dropbox.

Desde una perspectiva de desarrollo, estos son los principales elementos de un conector de Jitterbit:

• Conector: Una colección de actividades que interactúa con un sistema. Un conector necesita implementar la interfaz JitterbitConnector.
• Actividad: Representa la unidad más pequeña de ejecución dentro de una operación de Jitterbit. Se corresponde con un nodo dentro de una operación de Integration Studio. Cada actividad necesita implementar una interfaz JitterbitActivity con estas dos partes:
  • Configuración: Realizada por un usuario final utilizando la interfaz de usuario de Integration Studio.
  • Ejecución: Ejecuta una actividad de acuerdo con la configuración del usuario.
• Endpoint: Representa una conexión a un sistema, con la información del endpoint proporcionada por un usuario final que configura una conexión utilizando la interfaz de usuario de Integration Studio.
• Carga útil: Representa una solicitud/respuesta (entrada/salida) de una actividad durante la ejecución; se mapea a una interfaz Payload.
• Solicitud/Respuesta: La solicitud y respuesta de una actividad desarrollada con el SDK de Conectores siempre estará en formato XML.
• adapter.json: Un archivo JSON que contiene la interfaz de usuario declarativa asociada con una conexión de endpoint y las actividades que componen un conector. Como desarrollador, estableces los parámetros que necesitan ser configurados y los tipos asociados con cada parámetro. Para interfaces más complejas, hay componentes disponibles como parte de la interfaz de usuario de Integration Studio.
• Esquema XML: Un archivo XML XSD que contiene la declaración de las estructuras de datos utilizadas para la solicitud o respuesta de cada actividad. Estos archivos XSD son el contrato entre Harmony y el conector, y determinan cómo se mapea la información entre Harmony y el conector.

Implementación del conector

El SDK de Conectores permite a los desarrolladores crear conectores personalizados para que los usuarios finales configuren puntos finales, cuyas actividades pueden ser utilizadas como fuentes o destinos dentro de la interfaz de usuario de Integration Studio. Hay una serie de interfaces que el desarrollador debe completar al escribir un conector; se describen con ejemplos de código relacionados en Implementación del conector.

Registro del conector

Todos los conectores que se utilizarán en un proyecto de integración deben ser registrados, y los desarrolladores necesitan registrar sus conectores antes de construirlos y empaquetarlos. Las instrucciones detalladas para registrar su conector y establecer los valores apropiados en el archivo de manifiesto se describen en Registro del conector.

Interfaz de usuario del conector en Integration Studio

La interfaz de usuario del conector tal como se muestra en Integration Studio está definida por un archivo JSON (por defecto llamado adapter.json) incluido en el archivo JAR que empaqueta el conector.

Los elementos de la interfaz de usuario disponibles—incluidos íconos y componentes, con ejemplos de código para crearlos—se describen en Componentes de la interfaz de usuario del SDK de Conectores.

Sincronización del conector

Los conectores públicos son conectores construidos y mantenidos por Jitterbit. Están disponibles para todos los usuarios, en todos los agentes. Los archivos JAR para estos conectores públicos se instalan y actualizan automáticamente según sea necesario en los agentes, tanto para los grupos de agentes de la nube pública como para los agentes privados (a partir de la versión 10.1 de Harmony).

El archivo JAR del conector público se descargará a un agente según sea necesario una vez que se haya configurado un conector y se haya hecho clic en el botón Test de la configuración o se haya añadido y configurado una actividad.

Los conectores privados son conectores construidos por desarrolladores de terceros (como usted) y se instalan en agentes privados directamente copiando el archivo JAR al directorio connectors del agente privado.

Las API están disponibles para iniciar sesión, registrar, listar y eliminar conectores. Consulte REST APIs para obtener detalles sobre las API y registro para ejemplos de uso de las API con Postman.