Endbenutzerkonfiguration eines benutzerdefinierten Connectors im Jitterbit Integration Studio

Einführung

Nachdem ein benutzerdefinierter Connector veröffentlicht wurde, haben Mitglieder der Harmony-Organisation, in der er veröffentlicht wurde, Zugriff auf die Konfiguration und Nutzung des Connectors in Integration Studio Projekten. Diese Seite beschreibt, wo ein Endbenutzer benutzerdefinierte Connectoren finden kann und wie man sie verwendet.

Zugriff auf einen benutzerdefinierten Connector

In einem Integration Studio Projekt werden benutzerdefinierte Connectoren über die Design-Komponentenpalette aufgerufen und erscheinen wie jeder andere Connector.

Alle Connector Builder-Connectoren, die Sie selbst erstellt haben, sowohl unveröffentlicht als auch veröffentlicht, sind für Sie zugänglich. Die von anderen in der Organisation erstellten Connectoren sind für Sie nur zugänglich, wenn sie veröffentlicht sind, es sei denn, Sie sind ein Administrator der Harmony-Organisation.

Konfiguration der Verbindung eines benutzerdefinierten Connectors

Ein Connector bietet eine Schnittstelle zum Erstellen authentifizierter Verbindungen, die Grundlage für die Generierung von Instanzen von Aktivitäten. Diese Aktivitäten interagieren, sobald sie konfiguriert sind, über die Verbindung mit einem bestimmten Dienst.

Eine neue benutzerdefinierte Verbindung wird mit dem benutzerdefinierten Connector aus einem dieser Standorte erstellt:

• Der Projektendpunkte und Connectoren-Registerkarte der Design-Komponentenpalette (siehe Design-Komponentenpalette).
• Der Global Endpoints-Seite (siehe Erstellen eines globalen Endpunkts in Global Endpoints).

Ein vorhandener benutzerdefinierter Anschluss kann von diesen Standorten aus bearbeitet werden:

• Der Tab Projektendpunkte und -verbindungen in der Designkomponentenpalette (siehe Designkomponentenpalette).
• Der Tab Komponenten im Projektbereich (siehe Aktionen-Menü für Komponenten im Projektbereich Tab Komponenten).
• Die Seite Globale Endpunkte (siehe Einen globalen Endpunkt bearbeiten in Globale Endpunkte).

Die bereitgestellten Felder zur Konfiguration sind für jeden benutzerdefinierten Anschluss unterschiedlich und hängen davon ab, wie der Ersteller des Anschlusses den Anschluss konfiguriert hat. Häufige Elemente der Anschlusskonfiguration sind unten aufgeführt.

• Verbindungsname: Geben Sie einen Namen ein, um den benutzerdefinierten Anschluss zu identifizieren. Der Name muss für jeden benutzerdefinierten Anschluss eindeutig sein und darf keine Schrägstriche (/) oder Doppelpunkte (:) enthalten. Dieser Name wird auch verwendet, um den Endpunkt zu identifizieren, der sowohl die Verbindung als auch deren Aktivitäten bezeichnet.

• Authentifizierungs-URL: Dieses Feld ist vorhanden, wenn der benutzerdefinierte Anschluss so konfiguriert wurde, dass er die grundlegende Authentifizierung verwendet, und dieses Feld nicht vom Ersteller des Anschlusses ausgeblendet wurde. Wenn vorhanden, können Sie die URL bearbeiten, die mit den unten eingegebenen Anmeldeinformationen getestet werden soll.

  Vorsicht

  Wenn Sie die Authentifizierungs-URL bearbeiten, beachten Sie, dass die Methode zum Authentifizierungstest nicht sichtbar ist. Überprüfen Sie mit dem Ersteller des Anschlusses, ob die neue Test-URL mit der vom Ersteller des Anschlusses konfigurierten Methode übereinstimmt.

• Basis-URL: Dieses Feld ist vorhanden, wenn es nicht vom Ersteller des Connectors ausgeblendet wurde. Wenn vorhanden, können Sie die Basis-URL bearbeiten, die für alle vom Endbenutzer konfigurierten Aktivitäten verwendet wird. Schließen Sie keine Abfrageparameter oder Pfade ein, es sei denn, sie sollen für alle Aktivitäten verwendet werden (Sie können während der Aktivitätskonfiguration eindeutige Pfade und Parameter angeben.).

• Anmeldeinformationen: Felder zum Eingeben von Anmeldeinformationen sind vorhanden, wenn der benutzerdefinierte Connector so konfiguriert wurde, dass er die grundlegende Authentifizierung verwendet. Dazu gehören Benutzername- und Passwortfelder, deren Bezeichnungen mit den während der Erstellung des Connectors konfigurierten Anzeigenamen übereinstimmen.

• Anforderungsheader: Wenn der benutzerdefinierte Connector mit globalen Anforderungsheadern erstellt wurde, sind zusätzliche Felder vorhanden, die während der Erstellung des Connectors definiert wurden. Geben Sie einen Wert ein oder bearbeiten Sie den Standardwert (sofern angegeben) für den Header.

• Test: Dieses Feld ist vorhanden, wenn der benutzerdefinierte Connector so konfiguriert wurde, dass er die grundlegende Authentifizierung verwendet. Klicken Sie auf diese Schaltfläche, um die Verbindung mit der bereitgestellten Konfiguration zu überprüfen.

• Änderungen speichern: Klicken Sie, um die Konfiguration der Verbindung zu speichern und zu schließen.

• Änderungen verwerfen: Nachdem Sie Änderungen an einer neuen oder bestehenden Konfiguration vorgenommen haben, klicken Sie, um die Konfiguration ohne Speichern zu schließen. Eine Nachricht fragt Sie, ob Sie die Änderungen verwerfen möchten.

• Löschen: Nachdem Sie eine bestehende Verbindungs-Konfiguration geöffnet haben, klicken Sie, um die Verbindung dauerhaft aus dem Projekt zu löschen und die Konfiguration zu schließen (siehe Komponentenabhängigkeiten, Löschung und Entfernung). Eine Nachricht fragt Sie, ob Sie die Verbindung löschen möchten.

Aktivitäten des benutzerdefinierten Connectors

Nachdem Sie eine benutzerdefinierte Verbindung konfiguriert haben, können Sie eine oder mehrere Aktivitäten konfigurieren, die mit dieser Verbindung verbunden sind, um sie als Quelle oder Ziel innerhalb eines Vorgangs zu verwenden. Die verfügbaren Aktivitäten werden während der Connector-Erstellung definiert.

Ob die Aktivität als Quelle oder Ziel verwendet werden kann, hängt vom spezifischen Webdienst und den Anforderungs- und Antwortstrukturen ab, sofern vorhanden. Weitere Informationen darüber, was bestimmt, ob eine Aktivität als Quelle oder Ziel verwendet werden kann, finden Sie unter Teile eines Vorgangs in Vorgangserstellung und -konfiguration.

Erstellen einer benutzerdefinierten Connector-Aktivität

Eine Instanz einer Aktivität wird aus der konfigurierten Verbindung unter Verwendung eines Aktivitätstyps erstellt.

Um eine Instanz einer Aktivität zu erstellen, ziehen Sie den Aktivitätstyp auf die Entwurfsfläche oder kopieren Sie den Aktivitätstyp und fügen Sie ihn auf der Entwurfsfläche ein. Weitere Informationen finden Sie unter Erstellen einer Aktivitäts- oder Toolinstanz in Komponentenwiederverwendung.

Eine vorhandene Aktivität kann von diesen Orten aus bearbeitet werden:

• Die Entwurfsfläche (siehe Komponentenaktionsmenü in Entwurfsfläche).

• Der Komponenten-Tab im Projektbereich (siehe Komponentenaktionsmenü in Projektbereich Komponenten-Tab).

Konfigurieren einer benutzerdefinierten Connector-Aktivität

Der Bildschirm zur Aktivitätskonfiguration bietet eine Reihe von Schritten, die der Benutzer konfigurieren muss, die für jede Aktivität unterschiedlich sind und davon abhängen, wie der Ersteller des Connectors den Connector konfiguriert hat.

Der erste Schritt erfordert typischerweise, dass der Benutzer grundlegende Informationen wie einen Namen eingibt und Felder konfiguriert, wie sie während der Connector-Erstellung definiert wurden:

• Name: Geben Sie einen Namen ein, um die benutzerdefinierte Connector-Aktivität zu identifizieren. Der Name muss für jeden Aktivitätstyp, der mit der Verbindung verbunden ist, eindeutig sein und darf keine Schrägstriche (/) oder Doppelpunkte (:) enthalten.

• Path Parameters, Query String Parameters und Request Headers: Wenn der benutzerdefinierte Connector mit Pfadparametern, Abfragezeichenfolgenparametern oder Anforderungsheadern für die Aktivität erstellt wurde, sind zusätzliche Felder vorhanden, die während der Connector-Erstellung definiert wurden. Geben Sie einen Wert ein, bearbeiten Sie den Standardwert (sofern vorhanden) oder treffen Sie die entsprechenden Auswahlmöglichkeiten, die für den spezifischen Connector erforderlich sind.

• Save & Exit: Wenn aktiviert, klicken Sie, um die Konfiguration für diesen Schritt zu speichern und die Aktivitätskonfiguration zu schließen.

• Next: Klicken Sie, um die Konfiguration für diesen Schritt vorübergehend zu speichern und zum nächsten Schritt fortzufahren. Die Konfiguration wird nicht gespeichert, bis Sie die Schaltfläche Finished im letzten Schritt klicken.

• Discard Changes: Nach Änderungen klicken Sie, um die Konfiguration zu schließen, ohne die Änderungen an einem Schritt zu speichern. Eine Nachricht fragt Sie, ob Sie die Änderungen verwerfen möchten.

Der zweite Schritt zeigt alle Anforderungs- oder Antwortdatenschemas an, die während der Connector-Erstellung für die spezifische Aktivität bereitgestellt wurden:

• Data Schema: Die Anforderungs- und/oder Antwortdatenschemas werden angezeigt. Wenn die Operation eine Transformation verwendet, werden die Datenschemas später während des Transformation Mapping Prozesses erneut angezeigt, wo Sie auf Zielfelder mit Quellobjekten, Skripten, Variablen, benutzerdefinierten Werten und mehr abbilden können.

  Hinweis

  Daten, die in einer Transformation bereitgestellt werden, haben Vorrang vor der Aktivitätskonfiguration.

• Refresh: Klicken Sie auf das Aktualisierungssymbol oder das Wort Refresh, um die Schemata aus dem Connector Builder Connector Design neu zu generieren. Diese Aktion regeneriert auch das Schema an anderen Stellen im Projekt, an denen dasselbe Schema referenziert wird, wie z. B. in einer angrenzenden Transformation.

• Zurück: Klicken Sie, um die Konfiguration für diesen Schritt vorübergehend zu speichern und zum vorherigen Schritt zurückzukehren.

• Fertig: Klicken Sie, um die Konfiguration für alle Schritte zu speichern und die Aktivitätskonfiguration zu schließen.

• Änderungen verwerfen: Nach Änderungen klicken Sie, um die Konfiguration zu schließen, ohne die vorgenommenen Änderungen an einem Schritt zu speichern. Eine Nachricht fordert Sie auf, zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Nächste Schritte

Nachdem Sie die Aktivität eines benutzerdefinierten Connectors konfiguriert haben, vervollständigen Sie die Konfiguration des Vorgangs, indem Sie andere Aktivitäten oder Werkzeuge als Vorgangsschritte hinzufügen und konfigurieren. Sie können auch die Vorgangseinstellungen konfigurieren, die die Möglichkeit umfassen, Vorgänge zusammenzuführen, die sich in denselben oder unterschiedlichen Workflows befinden.

Sobald eine Aktivität erstellt wurde, sind die Menüaktionen für diese Aktivität im Projektbereich entweder in den Registerkarten Workflows oder Komponenten sowie auf der Entwurfskanvas zugänglich. Siehe Aktivitätsaktionsmenü für Details.

Die Vorgangsarten, mit denen Aktivitäten des benutzerdefinierten Connector Builders verwendet werden können, hängen davon ab, ob die Aktivität Daten bereitstellt (als Quelle) oder Daten empfängt (als Ziel), wie unten in Verwendet als Quelle und Verwendet als Ziel beschrieben.

Wenn Sie bereit sind, implementieren und führen Sie den Vorgang aus und validieren Sie das Verhalten, indem Sie die Vorgangsprotokolle überprüfen.

Verwendet als Quelle

Aktivitäten des benutzerdefinierten Connector Builders, die als Quelle verwendet werden, können mit diesen Vorgangsarten verwendet werden:

• Transformationsmuster
• Zwei-Ziel-Archivmuster (nur als erste Quelle)
• Zwei-Transformationsmuster (nur als erste Quelle)

Andere Muster sind nicht gültig, wenn Connector Builder-Aktivitäten als Quelle verwendet werden.

Als Ziel verwendet

Benutzerdefinierte Connector Builder-Aktivitäten, die als Ziel verwendet werden, können mit diesen Betriebsmustern verwendet werden:

• Transformationsmuster
• Zwei-Transformationsmuster (nur als zweites Ziel)

Andere Muster sind nicht gültig, wenn Connector Builder-Aktivitäten als Ziel verwendet werden.

Chunking verwenden

Viele Webservice-APIs haben Größenbeschränkungen. Wenn Sie auf Aufzeichnungsgrenzen stoßen, die von der API auferlegt werden, möchten Sie möglicherweise Chunking verwenden, um die Quelldaten in mehrere Teile zu splitten. Die Transformation wird dann für jedes Chunk separat durchgeführt, wobei jedes Quell-Chunk ein Ziel-Chunk erzeugt. Die resultierenden Ziel-Chunks kombinieren sich, um das endgültige Ziel zu erzeugen.

Für Anweisungen und bewährte Verfahren zur Verwendung von Chunking siehe Betriebsoptionen.