Aufrufen eines REST-Web-Service aus einem Workflow
- Lernen Sie die Voraussetzungen für die Kommunikation mit dem REST-Web-Service für
die Anwendung:
- Die Werte für die Authentifizierung bei der Anwendung
- Die Werte für die Abfrage von Daten vom REST-Web-Service
- Das Format der Daten, die in der Antwort geliefert werden
Nähere Informationen finden Sie in der Dokumentation zur Anwendung, oder wenden Sie sich an das Unternehmen, das die Anwendung hostet.
- Zur Vorbereitung von RICOH ProcessDirector auf die Kommunikation mit der Anwendung gehen Sie wie folgt vor:
- Wenn die Anwendung ein Sicherheitszertifikat verlangt, installieren Sie das Zertifikat auf dem primären RICOH ProcessDirector-Computer.
- Wenn Ihre Umgebung einen Proxyserver für die Kommunikation mit Web-Services verlangt, richten Sie das Systems hierfür ein.
Weitere Informationen finden Sie in den entsprechenden Aufgaben.
- Führen Sie einen manuellen Test zur Authentifizierung bei der Anwendung durch, bei
dem eine Antwort vom REST-Web-Service verlangt wird. Überprüfen Sie, ob die Web-Service
die gewünschte Antwort zurückgibt.Viele Browser haben Plug-Ins, wie Boomerang für Google Chrome, die Web-Service-Aufrufe zu REST-Clients testen.
- Wenn der Web-Service Nutzdaten enthält, entscheiden Sie, wie Sie diese Information
bereitstellen wollen:
- Sie können die Nutzdaten als Wert für das Merkmal Nutzlast anfordern eingeben.
- Sie können die Nutzdaten in einer Textdatei speichern, auf die der Schritt CallRESTService während der Verarbeitung von Jobs zugreifen kann.
- Klicken Sie auf die Registerkarte Workflow.
- Klicken Sie auf den Namen des Workflows, den Sie ändern möchten.
- Optional: Deaktivieren Sie den Workflow, indem Sie auf den Schalter links neben dem Workflow-Namen
klicken. Wenn Sie den Workflow während der Bearbeitung nicht deaktivieren, werden Jobs, die diesen Workflow verwenden, weiterhin durch die Schritte des Workflows geführt. Wenn Sie speichern, wird der Workflow vorübergehend deaktiviert und dann wieder aktiviert. Jobs, die in dem Workflow verarbeitet werden, könnten in eine fehlerhafte Situation geraten.
- Überprüfen Sie die in dem Workflow enthaltenen Schritte und die Standardwerte, die sie festlegen.
- Fügen Sie dem Workflow an der entsprechenden Stelle einen auf der Schrittschablone CallRESTService basierenden Schritt hinzu.
- Legen Sie Werte für Merkmale des Jobs fest.
- Setzen Sie das Merkmal Anforderungs-URL auf die URL des Web-Service, den der Schritt aufruft.Die URL kann entweder das HTTP- oder das HTTPS-Protokoll nutzen.
- Setzen Sie das Merkmal Methode anfordern auf den vom Web-Service geforderten Wert.
- Setzen Sie das Merkmal Kennwort auf das Kennwort, das der Schritt für den REST-Web-Service zur Authentifizierung
bei der Anwendung liefert.Geben Sie das Kennwort als Wert dieses Merkmals ein. Um das Kennwort für den REST-Web-Service zu liefern, geben Sie das Merkmal Job.WebService.Password als Symbol im Merkmal Nutzlast anfordern, Anforderungsheader oder Parameter anfordern an: ${Job.WebService.Password}. Informationen zur Festlegung, welches Merkmal verwendet werden soll, finden Sie in der Dokumentation des Web-Service.
- Legen Sie das Merkmal Anforderungsnutzdatentyp fest:
- Um den Text der Web-Service-Anforderung als Wert für das Merkmal Nutzlast anfordern festzulegen, wählen Sie TEXT.
- Um den Text der Web-Service-Anforderung in einer Textdatei festzulegen, auf die der Schritt CallRESTService während der Verarbeitung von Jobs zugreifen kann, wählen Sie DATEI.
- Hinweis:
- Wenn Sie keine Nutzdaten angeben, ignoriert RICOH ProcessDirector den Wert dieses Merkmals.
- Wenn der Web-Service Nutzdaten beinhaltet, legen Sie das Merkmal Nutzdaten anfordern fest:
- Wenn Sie das Merkmal Anforderungsnutzdatentyp auf TEXT setzen, geben Sie die Last als Wert für dieses Merkmal ein.
- Wenn Sie das Merkmal Anforderungsnutzdatentyp auf DATEI setzen, geben Sie den vollständigen Verzeichnispfad, den Namen und die Erweiterung
der Textdatei als Wert dieses Merkmals ein.
Geben Sie die Last als Inhalt der Textdatei ein.
Um das Passwort in der Last zu senden, legen Sie das Merkmal Job.WebService.password als Symbol fest.
In diesem XML-Beispiel wird die Auftrags-ID als der Wert des Jobmerkmals Benutzerdefiniert 3 ( Job.Info.Attr3) gespeichert. Die Last enthält das Kennwort als Wert des Elements <Token> und Auftrags-ID als Wert des Elements <OrderID>:
<Token>${Job.WebService.Password}</Token><OrderID>${Job.Info.Attr3}</OrderID>
Der Schritt löst die Symbole auf, wenn er den REST-Web-Service aufruft.
- Legen Sie die Werte für die Merkmale Anforderungsheader und Parameter anfordern nach Bedarf fest.
Jedes Header-Feld bzw. jeder Parameter ist ein Schlüsselwort-/Wertepaar. Jedes Paar muss auf einer separaten Zeile stehen und mit einem Doppelpunkt (:) oder Gleichheitszeichen (=) getrennt sein.
Das Schlüsselwort und der Wert können mehrere Wörter sein. RICOH ProcessDirector verwendet das erste Semikolon oder Gleichheitszeichen auf jeder Zeile, um die Wörter in das Schlüsselwort-/Wertepaar aufzuteilen.
Dieses Beispiel enthält zwei Parameter: token und orderId. Der Wert jedes Schlüsselworts ist ein RICOH ProcessDirector-Symbol. Jedes Symbol enthält eines der folgenden Merkmale: Job.WebService.Password und Job.Info.Attr3.
token:${Job.WebService.Password}orderId:${Job.Info.Attr3}
Der Schritt löst die Symbole auf, wenn er den REST-Web-Service aufruft.
- Wenn in Ihrer Umgebung ein Proxyserver mit Web-Services kommunizieren muss, legen Sie das Merkmal Proxy verwenden auf den richtigen Proxyserver fest.
- Legen Sie das Merkmal Antwortdatei auf den vollständigen Pfad und den Namen der Datei fest, die RICOH ProcessDirector verwendet, um die Antwort von der Anwendung zu speichern.Normalerweise lautet dieser Wert ${getFileName(print,json,write)} oder ${getFileName(print,XML,write)}, je nach Art der Antwort, die von der Anwendung zurückgegeben wird.Nachdem die Antwort in der Datei gespeichert wurde, kann sie durch andere Schritte im Workflow verarbeitet werden.
- Setzen Sie das Merkmal Anforderungs-URL auf die URL des Web-Service, den der Schritt aufruft.
- Klicken Sie auf OK, wenn Sie fertig sind.
- Speichern und aktivieren Sie den Workflow.
Wenn Sie die Workflows abgeschlossen haben, testen Sie den Datenaustausch zwischen RICOH ProcessDirector und der Anwendung.
Beispiel
Das Web Services Enablement-Feature umfasst einen RestfulWebServiceWF-Workflow mit einem CallRESTService-Schritt.