API SOAP Response Aktivität in Jitterbit Studio

Einführung

Eine API SOAP Response Aktivität gibt mithilfe ihrer vorkonfigurierten API-Verbindung Daten an eine API Manager Custom API zurück und ist als Ziel zum Verarbeiten von Daten in einem Vorgang vorgesehen.

Die API SOAP Response Aktivität lässt sich nur über ein WSDL-Schema konfigurieren. Zum Interagieren mit einer API-Verbindung mithilfe eines JSON-, XML-, CSV- oder XSD-Schemas verwenden Sie stattdessen eine Nicht-SOAP API Response Aktivität. Zum Interagieren mit einer SOAP-Verbindung ohne Custom API verwenden Sie den SOAP Connector.

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

• API Manager API Typen

• Custom API Konfiguration

• Eine einfache Custom API erstellen

Eine API SOAP Response Aktivität erstellen

Eine Instanz einer API SOAP Response Aktivität wird aus der vorkonfigurierten API-Verbindung mithilfe des Aktivitätstyps SOAP Response erstellt.

Zum Erstellen einer Aktivitätsinstanz ziehen Sie den Aktivitätstyp auf die Design-Leinwand oder kopieren Sie den Aktivitätstyp und fügen Sie ihn auf der Design-Leinwand ein. Weitere Informationen finden Sie unter Eine Aktivitäts- oder Tool-Instanz erstellen in Komponenten wiederverwenden.

Eine vorhandene API SOAP Response Aktivität lässt sich an folgenden Orten bearbeiten:

• Der Design-Leinwand (siehe Komponentenaktionsmenü in Design-Leinwand).
• Der Registerkarte Komponenten des Projektbereichs (siehe Komponentenaktionsmenü in Projektbereich Registerkarte Komponenten).

Eine API SOAP Response Aktivität konfigurieren

Führen Sie diese Schritte aus, um eine API SOAP Response Aktivität zu konfigurieren:

• Schritt 1: Namen eingeben und Einstellungen vornehmen
  Geben Sie einen Namen für die Aktivität ein und wählen Sie die Methode zum Hochladen des WSDL-Schemas.
• Schritt 2: Datenschemas überprüfen
  Alle vom Endpunkt generierten Request- oder Response-Schemas werden angezeigt.

Schritt 1: Namen eingeben und Einstellungen vornehmen

Geben Sie in diesem Schritt einen Namen für die Aktivität ein und wählen Sie die Methode zum Hochladen des WSDL-Schemas. Jedes Benutzeroberflächenelement dieses Schritts wird nachfolgend beschrieben.

• Name: Geben Sie einen Namen ein, um die Aktivität zu identifizieren. Der Name muss für jede API SOAP Response Aktivität eindeutig sein und darf keine Schrägstriche / oder Doppelpunkte : enthalten.

• URL hochladen, Datei hochladen oder Vorhandene auswählen: Verwenden Sie das Optionsfeld, um die Quelle der hochzuladenden oder wiederzuverwendenden WSDL-Datei (Web Services Description Language) auszuwählen. Es können Dateien mit einer Größe von bis zu 5 MB hochgeladen werden.

  • URL hochladen: Geben Sie die URL der WSDL-Datei in das Textfeld ein und klicken Sie dann auf die Schaltfläche Hochladen. Die URL muss ohne Authentifizierung zugänglich sein. Wenn die URL eine Authentifizierung erfordert oder keine gültige WSDL-Datei zurückgibt, zeigt Studio beim Hochladen einen Fehler an (siehe WSDL-Hochladeanforderungen). Beim Hochladen einer WSDL mit demselben Namen wie eine vorhandene WSDL siehe Mögliche Fehler später auf dieser Seite.

  • Datei hochladen: Verwenden Sie die Schaltfläche Durchsuchen rechts daneben, um lokal nach einer WSDL- oder ZIP-Datei zu suchen. Eine ZIP-Datei kann alle XSD-Dateien enthalten, von denen die WSDL abhängt. Wenn die ZIP-Datei mehr als eine WSDL-Datei enthält, wählen Sie die Root-WSDL aus, wenn Sie dazu aufgefordert werden. Klicken Sie dann auf die Schaltfläche Hochladen. Wenn beim Hochladen ein Validierungsfehler angezeigt wird, siehe WSDL-Hochladeanforderungen. Beim Hochladen einer WSDL mit demselben Namen wie eine vorhandene WSDL siehe Mögliche Fehler später auf dieser Seite.

    Hinweis

    Alle schemaLocation müssen mithilfe einer relativen Referenz in eine lokale Datei aufgelöst werden. Dies bedeutet normalerweise, dass Sie 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 angeben würden:

    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 in einem Pfad relativ zur zu ladenden WSDL.

  • Vorhandene auswählen: Verwenden Sie die Dropdown-Liste, um eine vorhandene WSDL-Datei auszuwählen, die zuvor im aktuellen Projekt verwendet wurde.

• 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 fortzufahren. Die Konfiguration wird erst gespeichert, wenn Sie auf der letzten Seite auf die Schaltfläche Fertig klicken.

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

Schritt 2: Datenschemas überprüfen

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

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

  Hinweis

  In einer Transformation bereitgestellte Daten haben Vorrang vor der Aktivitätskonfiguration.

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

Mögliche Fehler

In den folgenden Abschnitten werden Fehler behandelt, die bei der Aktivitätskonfiguration auftreten können.

WSDL konnte nicht hochgeladen werden

Wenn Sie eine WSDL ersetzen, indem Sie eine Datei mit demselben Namen mithilfe von URL hochladen oder Datei hochladen erneut hochladen, und die Operationen der Ersatz-WSDL nicht denselben Namen haben wie diejenigen, die von vorhandenen Aktivitäten verwendet werden, oder wenn verwendete WSDL-Operationen in der Ersatz-WSDL fehlen, kann dieser Fehler auftreten:

Stellen Sie zur Behebung sicher, dass WSDL-Operationen denselben Namen wie diejenigen haben, die derzeit von vorhandenen Aktivitäten verwendet werden.

Bereitstellung fehlgeschlagen

Bei der Bereitstellung einer Operation, deren SOAP Request-Aktivität die WSDL-Datei ersetzt hat, erhalten Sie möglicherweise diesen Fehler:

Bereitstellung fehlgeschlagen – Clientfehler: Es gibt keine hochgeladene Datei mit dem Clientpfad... Aktualisieren Sie auf Studio 8.4.0 oder höher und stellen Sie das Projekt erneut bereit.

Führen Sie diese Schritte aus, um das Problem zu beheben:

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

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

3. Klicken Sie in Schritt 2 auf Fertig.

4. Operation bereitstellen.

Falls stattdessen die Fehlermeldung Failed to deploy - Internal Error: No WSDL with locator angezeigt wird, siehe SOAP-Bereitstellungsfehler: "No WSDL with locator" im Connector-Fehlerbehebungshandbuch.

Nächste Schritte

Nach dem Konfigurieren einer API-Aktivität vom Typ SOAP Response die Konfiguration des Vorgangs abschließen, indem weitere Aktivitäten oder Tools als Vorgangsschritte hinzugefügt und konfiguriert werden. Die Vorgangseinstellungen können ebenfalls konfiguriert werden, einschließlich der Möglichkeit, Vorgänge zu verketten, die sich im selben oder in verschiedenen Workflows befinden.

Menüaktionen für eine Aktivität sind über den Projektbereich und die Design-Canvas zugänglich. Weitere Informationen finden Sie unter Aktivitätsaktionsmenü in Connector-Grundlagen.

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

• Archivmuster
• Skriptmuster
• Transformationsmuster
• Zwei-Ziel-Archivmuster (nur als zweites Ziel)
• Zwei-Ziel-HTTP-Archivmuster (nur als zweites Ziel)
• Zwei-Transformationsmuster (nur als zweites Ziel)

Wenn alles bereit ist, den Vorgang bereitstellen und das Verhalten durch Überprüfung der Vorgangsprotokolle validieren.

Konfigurieren einer benutzerdefinierten API des API Manager

Sobald der Vorgang konfiguriert und bereitgestellt ist, eine benutzerdefinierte API mit API Manager konfigurieren.