Zum Inhalt springen

API SOAP Request-Aktivität in Jitterbit Studio

Einführung

Eine API-Aktivität vom Typ SOAP Request verwendet die vorkonfigurierte API-Verbindung und ruft Daten ab, wenn eine benutzerdefinierte API von API Manager sie aufruft. Sie ist für die Verwendung als Ziel zum Datenverbrauch in einem Vorgang vorgesehen.

Die API-Aktivität SOAP Request kann nur mit einem WSDL-Schema konfiguriert werden. Zum Interagieren mit einer API-Verbindung unter Verwendung eines JSON-, XML-, CSV- oder XSD-Schemas wird stattdessen eine nicht-SOAP-basierte API Request-Aktivität verwendet. Zum Interagieren mit einer SOAP-Verbindung ohne benutzerdefinierte API wird der SOAP-Connector verwendet.

Weitere Informationen zur Beziehung zwischen API-Connector-Aktivitäten und API Manager-APIs finden Sie in folgenden Ressourcen:

Erstellen einer API SOAP Request-Aktivität

Eine Instanz einer API-Aktivität vom Typ SOAP Request wird über die vorkonfigurierte API-Verbindung unter Verwendung ihres Aktivitätstyps SOAP Request erstellt.

Um eine Instanz einer Aktivität zu erstellen, wird der Aktivitätstyp auf die Design-Canvas gezogen oder der Aktivitätstyp kopiert und auf die Design-Canvas eingefügt. Einzelheiten finden Sie unter Erstellen einer Aktivitäts- oder Toolinstanz in Komponentenwiederverwendung.

Eine vorhandene API-Aktivität vom Typ SOAP Request kann von folgenden Orten aus bearbeitet werden:

Konfigurieren einer API SOAP Request-Aktivität

Führen Sie folgende Schritte aus, um eine API-Aktivität vom Typ SOAP Request zu konfigurieren:

Schritt 1: Name eingeben und Einstellungen festlegen

Geben Sie in diesem Schritt einen Namen für die Aktivität an und wählen Sie die Methode zum Hochladen des WSDL-Schemas aus. Die einzelnen Elemente der Benutzeroberfläche in diesem Schritt sind nachfolgend beschrieben.

  • Name: Geben Sie einen Namen zur Identifizierung der Aktivität ein. Der Name muss für jede API-Aktivität vom Typ SOAP Request eindeutig sein und darf keine Schrägstriche / oder Doppelpunkte : enthalten.

  • URL hochladen, Datei hochladen oder Vorhandene auswählen: Verwenden Sie die Schaltfläche, um die Quelle der hochzuladenden oder wiederzuverwendenden WSDL-Datei auszuwählen. Es können Dateien bis zu einer Größe von 5 MB hochgeladen werden.

    • URL hochladen: Geben Sie die URL der WSDL-Datei in das Textfeld ein und klicken Sie auf Hochladen. Die URL muss ohne Authentifizierung erreichbar sein. Wenn die URL eine Authentifizierung erfordert oder keine gültige WSDL-Datei zurückgibt, zeigt Studio beim Hochladen einen Fehler an (siehe WSDL-Upload-Anforderungen). Wenn eine WSDL mit demselben Namen wie eine vorhandene WSDL hochgeladen wird, siehe Mögliche Fehler weiter unten auf dieser Seite.

    • Datei hochladen: Klicken Sie auf Durchsuchen (rechts), um lokal eine WSDL- oder ZIP-Datei zu durchsuchen. Eine ZIP-Datei kann alle XSD-Dateien enthalten, von denen die WSDL abhängig ist. Wenn die ZIP-Datei mehrere WSDL-Dateien enthält, wählen Sie die root-WSDL aus, wenn Sie dazu aufgefordert werden. Klicken Sie dann auf Hochladen. Wenn der Upload einen Validierungsfehler anzeigt, siehe WSDL-Upload-Anforderungen.

Hinweis

Jede schemaLocation muss mit einem relativen Verweis auf eine lokale Datei aufgelöst werden. Das bedeutet normalerweise, dass man statt eines Tupels wie:

xsi:schemaLocation='http://schemas.xmlsoap.org/wsdl/mime/ http://ws-i.org/profiles/basic/1.1/wsdlmime-2004-08-24.xsd'

folgendes bereitstellen würde:

xsi:schemaLocation='http://schemas.xmlsoap.org/wsdl/mime/ wsdlmime-2004-08-24.xsd'

Im obigen Beispiel befindet sich die XSD-Datei wsdlmime-2004-08-24.xsd entweder im selben Verzeichnis oder auf einem Pfad relativ zur geladenen WSDL.

  • Existierende auswählen: Verwenden Sie die Dropdown-Liste, um aus einer bereits im aktuellen Projekt verwendeten WSDL-Datei auszuwählen.

  • Port: Verwenden Sie die Dropdown-Liste, um den entsprechenden Port auszuwählen.

  • Service und Binding: Diese Felder werden standardmäßig basierend auf der bereitgestellten WSDL und dem Port automatisch ausgefüllt und können nicht bearbeitet werden.

  • Operation: Verwenden Sie die Dropdown-Liste, um die Methode aus der bereitgestellten WSDL auszuwählen, die Sie mit dieser Aktivität ausführen möchten.

  • Speichern und beenden: Falls aktiviert, klicken Sie, um die Konfiguration für diesen Schritt zu speichern und die Aktivitätskonfiguration zu schließen.

  • Weiter: Klicken Sie, um die Konfiguration für diesen Schritt vorübergehend zu speichern und zum nächsten Schritt zu gehen. Die Konfiguration wird erst gespeichert, wenn Sie auf der letzten Seite auf die Schaltfläche Fertig klicken.

  • Änderungen verwerfen: Klicken Sie nach Änderungen, um die Konfiguration zu schließen, ohne Änderungen an einem beliebigen Schritt zu speichern. Eine Meldung fordert Sie auf, zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Schritt 2: Daten-Schemas überprüfen

Die aus dem Endpunkt generierten Request- oder Response-Schemas werden angezeigt:

  • Daten-Schemas: Die Request- und Response-Schemas für diese Aktivität werden angezeigt. Diese Daten-Schemas werden von benachbarten Transformationen geerbt und werden erneut während der Transformationszuordnung angezeigt.

  • 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: Klicken Sie nach Änderungen, um die Konfiguration zu schließen, ohne Änderungen an einem beliebigen Schritt zu speichern. Eine Meldung fordert Sie auf, zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Mögliche Fehler

Die folgenden Abschnitte behandeln Fehler, die während der Aktivitätskonfiguration auftreten können.

WSDL kann nicht hochgeladen werden

Wenn Sie eine WSDL durch erneutes Hochladen einer mit dem gleichen Namen versehenen ersetzen, indem Sie URL hochladen oder Datei hochladen verwenden, und die Operationen der Ersatz-WSDL nicht mit denen übereinstimmen, die von vorhandenen Aktivitäten verwendet werden, oder wenn in Verwendung befindliche WSDL-Operationen in der Ersatz-WSDL fehlen, kann dieser Fehler auftreten:

Dialogtext

WSDL kann nicht hochgeladen werden
Diese WSDL kann nicht ersetzt werden, da WSDL-Operationen fehlen, die von den unten aufgelisteten vorhandenen Aktivitäten verwendet werden. Löschen Sie diese Aktivitäten aus der Registerkarte „Komponenten" des Projektbereichs und versuchen Sie es erneut.

  • Aktivitäten, die gelöscht werden müssen
    Aktivität 1 (API)

  • Undefinierte WSDL-Operationen, die von diesen Aktivitäten verwendet werden
    Operation 1

Zur Behebung müssen Sie sicherstellen, dass WSDL-Operationen genauso benannt sind wie diejenigen, die derzeit von vorhandenen Aktivitäten verwendet werden.

Bereitstellung fehlgeschlagen

Wenn Sie eine Operation bereitstellen, deren SOAP-Request-Aktivität die WSDL-Datei ersetzt hat, erhalten Sie möglicherweise diesen Fehler:

Failed to deploy - Client Error: There is no uploaded file with client path ... Upgrade to the 8.4.0 Studio or higher and deploy the project again.

Zur Behebung führen Sie diese Schritte aus:

  1. Öffnen Sie die Aktivität, bei der die WSDL-Datei ersetzt wurde.

  2. Wählen Sie in Schritt 1 die WSDL-Datei erneut aus, die für die Aktivität verwendet werden soll, und klicken Sie dann auf Weiter.

  3. Klicken Sie in Schritt 2 auf Fertig.

  4. Stellen Sie die Operation bereit.

Wenn Sie stattdessen Failed to deploy - Internal Error: No WSDL with locator erhalten, lesen Sie SOAP-Bereitstellungsfehler: "No WSDL with locator" im Connector-Troubleshooting-Handbuch.

Nächste Schritte

Nach der Konfiguration einer API-Aktivität SOAP Request können Sie die Konfiguration des Vorgangs durch Hinzufügen und Konfigurieren anderer Aktivitäten oder Tools als Vorgangsschritte abschließen. Sie können auch die Vorgangseinstellungen konfigurieren, mit denen Sie Vorgänge verketten können, die sich in demselben oder in verschiedenen Workflows befinden.

Menüaktionen für eine Aktivität sind im Projektbereich und auf der Design-Canvas zugänglich. Einzelheiten finden Sie unter Menü "Aktivitätsaktionen" in Connector-Grundlagen.

API-Aktivitäten SOAP Request können als Ziel mit diesen Vorgangsmustern verwendet werden:

Wenn Sie bereit sind, stellen Sie den Vorgang bereit und validieren Sie das Verhalten, indem Sie die Vorgangsprotokolle überprüfen.

Hinweis

Vorgänge mit einer API-Aktivität SOAP Request als ersten Vorgangsschritt können nicht manuell ausgeführt werden, indem Sie die Vorgangsoptionen Deploy and Run oder Run verwenden. Diese Vorgänge erfordern stattdessen Daten, die bei einem API-Aufruf mithilfe einer benutzerdefinierten API bereitgestellt werden, die über den API Manager erstellt wurde. Eine API kann von einer Anwendung aus aufgerufen werden oder – wenn die API GET unterstützt – können Sie die URL in einen Webbrowser einfügen, um die API manuell zu nutzen.

Wichtig

Vorgänge, die durch eine benutzerdefinierte API des API Manager ausgelöst werden, verfügen über zusätzliche Protokollierung, die aktiviert werden kann. Einzelheiten zu den Inhalten von Vorgangsprotokollen und zum Aktivieren zusätzlicher Protokollierung finden Sie unter API-Anfrage- und Antwortdaten in Vorgangsprotokolle.

Konfigurieren einer benutzerdefinierten API des API Manager

Nachdem der Vorgang konfiguriert und bereitgestellt wurde, konfigurieren Sie eine benutzerdefinierte API mit dem API Manager.

Hinweis

Nachdem Sie eine benutzerdefinierte API für den Aufruf eines Studio-Vorgangs konfiguriert haben, können Sie den Vorgang nicht löschen, ohne die API zu löschen oder die API-Konfiguration so zu ändern, dass sie den Vorgang nicht mehr aufruft.