SDK del Conector Harmony¶

Descripción general¶

Los conectores permiten a los usuarios finales en Jitterbit conectarse e interactuar con los extremos, y se creó un conector personalizado con Harmony Connector SDK amplía las capacidades de los extremos a Harmony Integration Studio el proyecto puede conectarse e interactuar. Los conectores creados con Connector SDK no se limitan a las APIs HTTP/REST (al igual que el Creador de conectores), pero puede usar cualquier API proporcionada por un extremo.

La creación de un conector con Connector SDK requiere que un desarrollador esté familiarizado con el desarrollo estándar de Java prácticas y herramientas, 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á familiarizado con Jitterbit, Harmony, Harmony Integration Studio, Harmony Agentes Privados y Desarrollo Java. Consulte las partes relacionadas de nuestra documentación en el sitio de documentación de Jitterbit si no está familiarizado con Jitterbit.

La versión actual del Connector SDK es la versión 1.0.0.

Conceptos del SDK del Conector¶

Los conectores creados con Connector SDK se muestran en Integration Studio como cualquier otro conector. Una vez que se establece una conexión configurados, proporcionan actividades específicas, según lo determine el desarrollador del conector, que se pueden usar como fuentes o objetivos en una operación. Se ejecutan en Agentes Privados y funcionan con Integration Studio.

El Conector Dropbox Harmony es un conector personalizado desarrollado usando el Connector SDK, mostrado en Integration Studio con sus actividades: Procesar archivo, Obtener archivo, Obtener archivo y poner archivo:

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

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

• Conector: Una colección de actividades que interactúa con un sistema. Un conector necesita desplegar el JitterbitConnector interfaz.
• Actividad: Representa la unidad de ejecución más pequeña dentro de una operación de Jitterbit. Coincide con un nodo dentro de una operación de Integration Studio. Cada actividad necesita desplegar un JitterbitActivity interfaz con estos dos partes:
  • Configuration: Realizado por un usuario final mediante la interfaz de usuario de Integration Studio.
  • Execution: Ejecuta una actividad según la configuración del usuario.
• Extremo: Representa una conexión a un sistema, con información de extremo proporcionada por un usuario final que configura un conexión mediante la interfaz de usuario de Integration Studio.
• Payload: Representa una solicitud/respuesta (entrada/salida) de una actividad durante la ejecución; mapas a un Payload interfaz.
• Solicitud/Respuesta: La solicitud y respuesta de una actividad desarrollada con el Connector SDK siempre estará en formato XML.
• adapter.json: Un archivo JSON que contiene la interfaz de usuario declarativa asociada con una conexión de extremo y la actividades que componen un conector. Como desarrollador, usted establece los parámetros que deben configurarse y el tipos asociados a 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 los datos se asignan entre Harmony y el conector.

Despliegue del conector¶

Connector SDK permite a los desarrolladores crear conectores personalizados para que los usuarios finales configuren extremos, cuya las actividades se pueden usar como orígenes o destinos dentro de la interfaz de usuario de Integration Studio. Hay una serie de interfaces que el el desarrollador debe completar al escribir un conector; se describen con ejemplos de código relacionados en Despliegue del conector.

Registro del conector¶

Todos los conectores que se utilizarán en Harmony deben estar registrados, y los desarrolladores deben registrar su conectores antes de construirlos y empaquetarlos. Instrucciones detalladas para registrar su conector y configuración 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 que se muestra en Integration Studio está definida por un archivo JSON (llamado de forma predeterminada adapter.json) incluido en el archivo JAR que empaqueta el conector.

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

Sincronización de conectores¶

Los conectores públicos son conectores creados 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 en Nube pública y para 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 y ya sea la configuración Test se hizo clic en un botón o se agregó y configuró una actividad.

Los conectores privados son conectores creados por desarrolladores de externo (como usted) y se instalan en Private Agentes directamente copiando el archivo JAR al Agente privado connectors directorio.

Las APIs están disponibles para iniciar sesión, registrar, enumerar y eliminar conectores. Vea APIs REST para detalles de las APIs y Registro para ver ejemplos del uso de las APIs con Postman.