Zum Inhalt springen

Jitterbit Connector SDK

Übersicht

Connectoren ermöglichen es Endbenutzern in Jitterbit, sich mit Endpunkten zu verbinden und mit ihnen zu interagieren. Ein benutzerdefinierter Connector, der mit dem Connector SDK erstellt wurde, erweitert die Möglichkeiten der Endpunkte, mit denen ein Integrationsprojekt verbunden werden kann und mit denen interagiert werden kann. Connectoren, die mit dem Connector SDK erstellt wurden, sind nicht auf HTTP/REST-APIs beschränkt (wie im Connector Builder), sondern können jede API verwenden, die von einem Endpunkt bereitgestellt wird.

Die Erstellung eines Connectors mit dem Connector SDK erfordert, dass ein Entwickler mit den gängigen Java-Entwicklungspraktiken und -tools wie Maven, Docker, Postman und Git vertraut ist.

Diese Dokumentation ist der Ausgangspunkt für die Entwicklung eines Connectors und setzt voraus, dass Sie bereits mit Jitterbit, Harmony, Integration Studio, Jitterbit-Agenten und Java-Entwicklung vertraut sind. Bitte sehen Sie sich die entsprechenden Teile unserer Dokumentation auf der Jitterbit-Dokumentationsseite an, wenn Sie mit Jitterbit nicht vertraut sind.

Die aktuelle Version des Connector SDK ist Version 1.0.0.

Konzepte des Connector SDK

Connectoren, die mit dem Connector SDK erstellt wurden, erscheinen im Integration Studio wie jeder andere Connector. Sobald eine Verbindung konfiguriert ist, bieten sie spezifische Aktivitäten – wie vom Connector-Entwickler festgelegt –, die als Quellen oder Ziele in einem Vorgang verwendet werden können. Sie laufen auf privaten Agenten und arbeiten mit dem Integration Studio.

Der Dropbox-Connector ist ein benutzerdefinierter Connector, der mit dem Connector SDK entwickelt wurde und im Integration Studio mit seinen Aktivitäten angezeigt wird: Datei verarbeiten, Datei abrufen, Datei erhalten und Datei hochladen:

Dropbox-Aktivitäten

Dieser Jitterbit-Connector interagiert mit Dropbox und ermöglicht sowohl das Lesen als auch das Schreiben von Dateien von und nach Dropbox. Das Beispiel ist als Quellcode über das GitHub-Repository jitterbit/dropbox-connector verfügbar und wird als Grundlage für das Dropbox Connector Tutorial verwendet.

Warnung

Der Beispiel-Dropbox-Connector ist nicht für den produktiven Einsatz. Er dient als Ausgangspunkt für die Entwicklung von Jitterbit-Connectors, die mit dem Connector SDK erstellt wurden.

Aus der Entwicklungsperspektive sind dies die Hauptbestandteile eines Jitterbit-Connectors:

  • Connector: Eine Sammlung von Aktivitäten, die mit einem System interagiert. Ein Connector muss das JitterbitConnector-Interface implementieren.
  • Activity: Stellt die kleinste Ausführungseinheit innerhalb einer Jitterbit-Operation dar. Sie entspricht einem Knoten innerhalb einer Integration Studio-Operation. Jede Aktivität muss ein JitterbitActivity-Interface mit diesen zwei Teilen implementieren:
    • Configuration: Wird von einem Endbenutzer über die Integration Studio-Benutzeroberfläche durchgeführt.
    • Execution: Führt eine Aktivität gemäß der Benutzerkonfiguration aus.
  • Endpoint: Stellt eine Verbindung zu einem System dar, wobei die Endpunktinformationen von einem Endbenutzer bereitgestellt werden, der eine Verbindung über die Integration Studio-Benutzeroberfläche konfiguriert.
  • Payload: Stellt eine Anfrage/Antwort (Eingabe/Ausgabe) einer Aktivität während der Ausführung dar; entspricht einem Payload Interface.
  • Request/Response: Die Anfrage und Antwort einer Aktivität, die mit dem Connector SDK entwickelt wurde, sind immer im XML-Format.
  • adapter.json: Eine JSON-Datei, die die deklarative Benutzeroberfläche enthält, die mit einer Endpunktverbindung und den Aktivitäten, die einen Connector bilden, verbunden ist. Als Entwickler legen Sie die Parameter fest, die konfiguriert werden müssen, und die Typen, die mit jedem Parameter verbunden sind. Für komplexere Schnittstellen stehen Komponenten zur Verfügung als Teil der Integration Studio-Benutzeroberfläche.
  • XML Schema: Eine XML XSD-Datei, die die Deklaration der Datenstrukturen enthält, die für die Anfrage oder Antwort jeder Aktivität verwendet werden. Diese XSD-Dateien sind der Vertrag zwischen Harmony und dem Connector und bestimmen, wie Daten zwischen Harmony und dem Connector abgebildet werden.

Hinweis

Diese Begriffe sind spezifisch für benutzerdefinierte Connectoren, die mit dem Connector SDK entwickelt wurden, und unterscheiden sich leicht von denen, die in der Integration Studio-Benutzeroberfläche verwendet werden.

Connector-Implementierung

Das Connector SDK ermöglicht es Entwicklern, benutzerdefinierte Connectoren zu erstellen, die Endbenutzer zur Konfiguration von Endpunkten verwenden können, deren Aktivitäten als Quellen oder Ziele innerhalb der Benutzeroberfläche des Integration Studio genutzt werden können. Es gibt eine Reihe von Schnittstellen, die der Entwickler beim Schreiben eines Connectors ausfüllen muss; sie werden mit entsprechenden Codebeispielen in Connector-Implementierung beschrieben.

Connector-Registrierung

Alle Connectoren, die in einem Integrationsprojekt verwendet werden sollen, müssen registriert werden, und Entwickler müssen ihre Connectoren registrieren, bevor sie diese erstellen und paketieren. Detaillierte Anweisungen zur Registrierung Ihres Connectors und zum Festlegen geeigneter Werte in der Manifestdatei sind in Connector-Registrierung beschrieben.

Connector-Benutzeroberfläche im Integration Studio

Die Benutzeroberfläche des Connectors, wie sie im Integration Studio angezeigt wird, wird durch eine JSON-Datei (standardmäßig adapter.json genannt) definiert, die im JAR-Archiv enthalten ist, das den Connector paketiert.

Verfügbare UI-Elemente—einschließlich Symbole und Komponenten, mit Codebeispielen zu deren Erstellung—werden in Connector SDK UI-Komponenten beschrieben.

Connector-Synchronisierung

Öffentliche Connectoren sind Connectoren, die von Jitterbit erstellt und gewartet werden. Sie sind für alle Benutzer auf allen Agenten verfügbar. Die JAR-Dateien für diese öffentlichen Connectoren werden automatisch installiert und bei Bedarf auf Agenten aktualisiert, sowohl für die Gruppen öffentlicher Cloud-Agenten als auch für private Agenten (seit Harmony-Version 10.1).

Die JAR-Datei des öffentlichen Connectors wird bei Bedarf auf einen Agenten heruntergeladen, sobald ein Connector konfiguriert wurde und entweder die Schaltfläche Test der Konfiguration geklickt oder eine Aktivität hinzugefügt und konfiguriert wurde.

Private Connectoren sind Connectoren, die von Drittentwicklern (wie Ihnen) erstellt werden und direkt auf privaten Agenten installiert werden, indem die JAR-Datei in das Verzeichnis connectors des privaten Agenten kopiert wird.

APIs sind verfügbar für das Anmelden, Registrieren, Auflisten und Löschen von Konnektoren. Siehe REST APIs für Details zu den APIs und Registrierung für Beispiele zur Verwendung der APIs mit Postman.