Erstellen einer API Operation im Jitterbit Design Studio
Einführung
Auf dieser Seite wird beschrieben, wie Sie eine API Entity Operation erstellen. Die Jitterbit-Entity und API Entity Operation werden verwendet, um eine OData Service API zu erstellen. Wenn die API Entity Operation abgeschlossen ist, wird die Operation einer OData Service API zugewiesen.
Tipp
- Sie müssen Design Studio verwenden (nicht Integration Studio), um eine API Entity Operation zu erstellen.
- Bevor Sie eine API Entitätsoperation erstellen können, müssen Sie Folgendes abgeschlossen haben:
- Operationen befinden sich innerhalb eines Projekts. Bevor Sie eine API Entity Operation erstellen können, müssen Sie die Anweisungen zum Erstellen eines neuen Projekts befolgen in Design Studio.
- API Entitätsoperationen werden einer Jitterbit-Entität zugewiesen. Sie müssen den Anweisungen unter Erstellen einer Jitterbit-Entität folgen, bevor Sie eine API Entitätsoperation erstellen.
- Ein Projekt kann mehrere Entitäten enthalten. Jede Entität kann eine oder mehrere API Entitätsoperationen enthalten, aber nur eine Operation pro HTTP-Methode.
Erstellen einer API Operation
-
Öffnen Sie Ihr Projekt in der Anwendung Design Studio. Der Bildschirm „Erste Schritte“ sollte Folgendes anzeigen:
- Das Panel auf der linken Seite des Design Studio listet die Projektelemente auf, die Sie zum Erstellen Ihrer Integration verwenden, z. B. Operationen, Transformations, Scripts usw. Scrollen Sie im Panel nach unten zu Operationen.
- Klicken Sie mit der rechten Maustaste auf Operationen und wählen Sie Neue Operation aus dem Dropdown-Menü.
-
Das Popup-Fenster Typ auswählen zeigt die Liste der im Design Studio verfügbaren Operation an. Wählen Sie API Entity Operation aus der Optionsliste aus und klicken Sie dann auf Weiter:
-
Das Popup-Fenster Entity Wizard sollte ähnlich wie das unten gezeigte Bild angezeigt werden. Eine Entität definiert die Daten, die einem OData Dienst zur Verfügung stehen und besteht aus einem Endpoint, einer Auswahl von Objekten und einer Auswahl von bestimmten Feldern. Alle im Projekt verfügbaren Entitäten werden unter dem Ordner Jitterbit Entities aufgelistet:
- Neue Jitterbit-Entität erstellen: Wählen Sie diese Option, wenn eine Entität im Projekt nicht verfügbar ist und nicht wie oben gezeigt im Entitätsassistenten aufgeführt ist. Der Entitätsassistent führt Sie dann durch die Erstellung der Entität, die Auswahl der Tabellen oder Objekte und die Auswahl der Felder. Folgen Sie den Anweisungen unter Jitterbit-Entität erstellen, während Sie im Entity Wizard fortfahren.
- Verwenden Sie eine vorhandene Jitterbit-Entität im Projekt: Sie können die Entität vor dem Erstellen Ihrer Operation erstellen, indem Sie den Anweisungen unter Erstellen einer Jitterbit-Entität folgen. Alle in Ihrem Projekt verfügbaren vorhandenen Entitäten werden unter dem Ordner Jitterbit-Entitäten im oberen rechten Bereich des Entitäts-Assistenten aufgelistet, wie oben gezeigt. Wenn Sie in der Liste der verfügbaren Entitäten auf eine vorhandene Entität klicken, wird automatisch Vorhandene Jitterbit-Entität im Projekt verwenden ausgewählt.
-
In diesem Beispiel wird die Entität Kunden ausgewählt. Klicken Sie unten auf dem Bildschirm auf Weiter, um fortzufahren:
-
Der Bildschirm Transformations zeigt Folgendes an:
-
Pass-Through-Transformations:
- Jitterbit erstellt standardmäßig einen Pass-Through-Operation.
- Lassen Sie die Kontrollkästchen Transformation und Transformation leer, wenn keine benutzerdefinierte Zuordnung erforderlich ist.
-
In diesem Beispiel haben wir uns für die grundlegende Pass-Through-Transformation entschieden und keines der Kontrollkästchen aktiviert:
-
Klicken Sie unten im Fenster auf Fertig. Der Pass-Through Operation wird erstellt und auf der Tab Vorgänge von Design Studio angezeigt:
-
Ich brauche benutzerdefinierte Zuordnungen in:
- Transformation: Aktivieren Sie das Kontrollkästchen, wenn eine benutzerdefinierte Zuordnung der Anforderung erforderlich ist.
- Transformation: Aktivieren Sie das Kontrollkästchen, wenn eine benutzerdefinierte Zuordnung der Antwort erforderlich ist.
-
In diesem Beispiel sind sowohl das Kontrollkästchen Transformation als auch das Kontrollkästchen Transformation aktiviert:
-
Die Schaltfläche Weiter wird automatisch aktiviert. Klicken Sie auf Weiter.
- Im Entity Wizard wird eine Warnmeldung angezeigt: „Benutzerdefinierte Transformation wird nur mit GET-Entitäten (OData APIs) unterstützt.“
-
Klicken Sie unten im Fenster auf Fertig. Der Operation wird erstellt und im Design Studio angezeigt mit einer benutzerdefinierten Anfrage und einer benutzerdefinierten Transformation:
-
Klicken Sie mit der rechten Maustaste auf die Transformation Kunden - Anfrage und wählen Sie Kunden - Anfrage bearbeiten, um den Feldzuordnungsbildschirm auf der Tab Transformations zu öffnen. Sie können bei Bedarf benutzerdefinierte Zuordnungen mit Skripten erstellen:
-
Wiederholen Sie diesen Schritt bei der Transformation Kunden - Antwort, um die Antwortfelder entsprechend zuzuordnen.
- Sobald die Zuordnung abgeschlossen ist, klicken Sie auf Speichern-Symbol in der Symbolleiste. Klicken Sie auf Bereitstellen -Symbol in der Symbolleiste, um das gesamte Projekt auf Harmony einsetzen.
-
-
Nächster Schritt: Siehe OData Dienstkonfiguration zur Verwendung der neuen Entität und der API Operation.