Jitterbit Connector SDK¶

Übersicht¶

Konnektoren ermöglichen es Endbenutzern in Jitterbit, sich mit Endpoints zu verbinden und mit ihnen zu interagieren, und ein mit dem Connector SDK erstellter benutzerdefinierter Konnektor erweitert die Fähigkeiten der Endpoints, mit denen sich ein Integrationsprojekt verbinden und mit denen es interagieren kann. Mit dem Connector SDK erstellte Konnektoren sind nicht auf HTTP/REST- APIs beschränkt (wie Connector Builder), kann aber jede von einem Endpoint bereitgestellte API verwenden.

Zum Erstellen eines Connectors mit dem Connector SDK muss ein Entwickler mit der Standard-Java-Entwicklung vertraut sein Praktiken und Tools wie Maven, Docker, Postman und Git.

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

Die aktuelle Version des Connector SDK ist Version 1.0.0.

Konzepte des Connector-SDK¶

Mit dem Connector SDK erstellte Konnektoren werden in Integration Studio wie alle anderen Konnektoren angezeigt. Sobald eine Verbindung konfiguriert sind, stellen sie spezifische Aktivitäten bereit - wie vom Connector-Entwickler festgelegt - die als Quellen oder Ziele in einer Operation. Sie laufen auf privaten Agenten und arbeiten mit Integration Studio.

Der Dropbox-Connector ist ein benutzerdefinierter Connector entwickelt mit dem Connector SDK, angezeigt in Integration Studio mit seinen Aktivitäten: Datei verarbeiten, Datei abrufen, Datei abrufen und Datei ablegen:

Dieser Jitterbit-Connector interagiert mit Dropbox, ermöglicht das Lesen und Schreiben von Dateien von und zu Dropbox. Das Beispiel ist als Quellcode über das GitHub Repository jitterbit/dropbox-connector und dient als Grundlage für das Dropbox Connector-Tutorial.

Aus Entwicklungsperspektive sind dies die Hauptelemente eines Jitterbit-Connectors:

• Connector: Eine Sammlung von Aktivitäten, die mit einem System interagieren. Ein Connector muss Folgendes implementieren: JitterbitConnector Schnittstelle.
• Aktivität: Stellt die kleinste Ausführungseinheit innerhalb einer Jitterbit Operation dar. Sie entspricht einer Knoten innerhalb einer Integration Studio Operation. Jede Aktivität muss einen JitterbitActivity Schnittstelle mit diesen zwei Teilen:
  • Configuration: Wird von einem Endbenutzer mithilfe der Integration Studio-Benutzeroberfläche durchgeführt.
  • Execution: Führt eine Aktivität entsprechend der Benutzerkonfiguration aus.
• Endpoint: Stellt eine Verbindung zu einem System dar, wobei die Endpoint von einem Endbenutzer bereitgestellt werden, der ein Verbindung mithilfe der Integration Studio Benutzeroberfläche.
• Payload: Stellt eine Anfrage/Antwort (Eingabe/Ausgabe) einer Aktivität während der Ausführung dar; wird abgebildet auf Payload Schnittstelle.
• Anfrage/Antwort: Die Anfrage und Antwort einer mit dem Connector SDK entwickelten Aktivität erfolgt immer im XML-Format.
• adapter.json: Eine JSON-Datei mit der deklarativen Benutzeroberfläche einer Endpoint und der Aktivitäten, aus denen ein Connector besteht. Als Entwickler legen Sie die zu konfigurierenden Parameter fest und die Typen, die jedem Parameter zugeordnet sind. Für komplexere Schnittstellen gibt es verfügbare Komponenten als Teil der Integration Studio Benutzeroberfläche.
• XML-Schema: Eine XML-XSD-Datei, die die Deklaration der für die Anfrage oder Antwort verwendeten Datenstrukturen enthält jeder Aktivität. Diese XSD-Dateien sind der Vertrag zwischen Harmony und dem Connector und bestimmen, wie Daten werden zwischen Harmony und dem Connector zugeordnet.

Connector-Implementierung¶

Mit dem Connector SDK können Entwickler benutzerdefinierte Konnektoren für Endbenutzer erstellen, um Endpoints zu konfigurieren, deren Aktivitäten können als Quellen oder Ziele innerhalb der Integration Studio Benutzeroberfläche verwendet werden. Es gibt eine Reihe von Schnittstellen, die die Entwickler müssen diese beim Schreiben eines Connectors ausfüllen. Sie werden mit den zugehörigen Codebeispielen in Connector-Implementierung.

Connector-Registrierung¶

Alle Konnektoren, die in einem Integrationsprojekt verwendet werden sollen, müssen registriert werden, und Entwickler müssen ihre Konnektoren registrieren, bevor sie sie erstellen und verpacken. Detaillierte Anweisungen zum Registrieren Ihres Konnektors und zum Festlegen entsprechender Werte in der Manifestdatei finden Sie unter Konnektorregistrierung.

Connector-Benutzeroberfläche im Integration Studio¶

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

Verfügbare UI-Elemente - einschließlich Symbole und Komponenten, mit Codebeispielen zum Erstellen - werden in Connector SDK UI-Komponenten beschrieben.

Connector-Synchronisierung¶

Öffentliche Konnektoren sind von Jitterbit erstellte und verwaltete Konnektoren. Sie sind für alle Benutzer auf allen Agenten verfügbar. Die JAR-Dateien für diese öffentlichen Konnektoren werden automatisch auf Agenten installiert und bei Bedarf aktualisiert, sowohl für die öffentlichen Cloud-Agentengruppen und für private Agenten (ab Harmony Version 10.1).

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

Private Konnektoren sind Konnektoren, die von Drittpartei (wie Ihnen selbst) erstellt und auf privaten Agenten direkt, indem Sie die JAR-Datei in den privaten Agenten kopieren connectors Verzeichnis.

APIs stehen zum Anmelden, Registrieren, Auflisten und Löschen von Konnektoren zur Verfügung. Siehe REST- APIs für Einzelheiten zu die APIs und Registrierung für Beispiele zur Verwendung der APIs mit Postman.