Vorbereitung zum Abrufen von REST-Web-Services-Eingaben
- 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.
- Entscheiden Sie, wie die REST-Web-Service-Eingabeeinheit Jobs aus den Daten erstellen
soll, die in der vom Web-Service zurückgegebenen Antwort enthalten sind.
- Jedes Mal, wenn die Eingabeeinheit eine Antwort erhält, kann sie einen Job mit allen XML- oder JSON-Daten in der Antwort erstellen.
- Die Eingabeeinheit kann die Antwort mithilfe eines XPath- oder JSONPath-Ausdrucks
untersuchen.
Wenn die Eingabeeinheit im Ausdruck angegebene XML-Elemente oder JSON-Objekte findet, erstellt sie einen Job für jedes passende Element oder Objekt. Jeder Job enthält das passende Element oder Objekt sowie alle darin verschachtelten Elemente oder Objekte. Wenn die Eingabeeinheit zwei oder mehr Elemente oder Objekte findet, kann sie unabhängige Jobs oder untergeordnete Jobs erstellen.
Wenn die Eingabeeinheit keine passenden Elemente findet, erstellt sie keinen Job.
- Definieren Sie eine REST-Web-Service-Eingabeeinheit:
- Klicken Sie auf die Registerkarte Verwaltung.
- Klicken Sie im linken Teilfenster auf .
- Klicken Sie auf .
Als Alternative können Sie die mitgelieferte REST-Web-Service-Eingabeeinheit RestfulWebServiceSample kopieren. - Auf der Registerkarte Allgemein:
- Geben Sie einen Namen für die Eingabeeinheit ein.
- Setzen Sie das Merkmal Abfrageintervall auf die Zeit, die die Eingabeeinheit zwischen Web-Service-Aufrufen warten soll.
- Nachdem Sie einen Workflow zur Verarbeitung der XML- oder JSON-Jobs definiert haben, setzen Sie das Merkmal Untergeordneter Workflow auf den Namen dieses Workflows.
- Geben Sie Werte für die anderen Merkmale ein, die Sie festelegen wollen.
- Auf der Registerkarte Anforderung:
- Setzen Sie das Merkmal Anforderungs-URL auf die URL des Web-Service, der die Daten zurückliefert, die RICOH ProcessDirector zum Erstellen eines oder mehrerer Jobs verwendet.
- Legen Sie die Merkmale Anforderungsmethode und Anforderungsinhaltstyp mit den Werten fest, die vom Web-Service verlangt werden.
- Geben Sie für den Wert des Merkmals Nutzlast anfordern den Text der Web-Service-Anforderung ein, die die Eingabeeinheit an die Anwendung
übermittelt.Um eine Anmeldeinformation oder ein Token und einen Zeitraum festzulegen, die dem Wert des Merkmals Abfrageintervalls entsprechen, verwenden Sie Symbole für diese Merkmale:
Datenbankname des Merkmals Benutzerschnittstellenname des Merkmals Anmerkungen WebService.Credential Nein RICOH ProcessDirector speichert die Anmeldeinformation des Web-Service oder Tokens in diesem Merkmal. WebService.CurrentRequestTime Nein RICOH ProcessDirector setzt den Wert dieses Merkmals auf den Beginn des Abfrageintervalls. WebService.LastSuccessRequestTime Registerkarte "Status": Zeit der letzten erfolgreichen Anforderung Wenn die Eingabeeinheit erfolgreich mit der Anwendung kommuniziert, setzt RICOH ProcessDirector den Wert dieses Merkmals entsprechend dem Wert des Merkmals WebService.CurrentRequestTime. Eine erfolgreiche Kommunikation führt zur einem Antwortcode 200, selbst wenn keine Daten empfangen werden, die RICOH ProcessDirector zur Erstellung von Jobs verwenden könnte. - Hinweis:
- Diese drei Jobmerkmale sind Beispiele für XML-Werte für das Merkmal Nutzlast anfordern und für JSON-Werte für das Merkmal Parameter anfordern. Die Voraussetzungen für den Web-Service bestimmen, welche Merkmale für die Übermittlung dieser und anderer Werte verwendet werden können.
In diesem XML-Beispiel enthalten die Nutzdaten die folgenden Elemente: <Token>, <Zeitraum>, <Start> und <Ende>. Die Werte der drei Elemente sind Symbole:
<Token>${WebService.Credential}</Token> <Zeitraum> <Start>${WebService.LastSuccessRequestTime}</Start> <Ende>${WebService.CurrentRequestTime}</Ende> </Zeitraum>
Die Eingabeeinheit löst die Symbole auf, wenn sie eine Eingabe abruft.
- 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 drei Parameter: Token, Start und Ende. Der Wert jedes Schlüsselworts ist ein RICOH ProcessDirector-Symbol. Jedes Symbol enthält eines der folgenden Merkmale: WebService.Credential, WebService.LastSuccessRequestTime, und WebService.CurrentRequestTime.
token:${WebService.Credential} start:${WebService.LastSuccessRequestTime} end:${WebService.CurrentRequestTime}
Die Eingabeeinheit löst die Symbole auf, wenn sie eine Eingabe abruft.
- Wählen Sie einen Wert für das Merkmal Erstellen von Jobs aus der Antwort, um festzulegen, wie die Eingabeeinheit Jobs aus der Eingabe erstellt:
- Um jedes Mal einen Job zu erstellen, wenn die Eingabeeinheit eine Antwort erhält, wählen Sie Immer.
- Um das XML-Element oder JSON-Objekt in der Antwort zu untersuchen und jedes Mal einen Job zu erstellen, wenn ein XML-Element oder JSON-Objekt gefunden wird, wählen Sie Nur, wenn der Behandlungstyp Muster entspricht.
- Wenn Sie Nur, wenn der Behandlungstyp Muster entspricht ausgewählt haben:
- Setzen Sie das Merkmale Antwort-Muster für Übereinstimmung auf den XPath-Ausdruck zur Identifizierung des XML-Elements oder JSONPath-Ausdrucks, welches das JSON-Objekt identifiziert.
- Setzen Sie das Merkmal Untergeordnete Jobs erstellen auf Ja, wenn Sie untergeordnete Jobs erstellen möchten, wenn die Eingabeeinheit zwei oder mehr Übereinstimmungen findet. Die Eingabeeinheit erstellt außerdem einen übergeordneten Job ohne Daten. Wenn die Eingabeeinheit eine Übereinstimmung, wird ein unabhängige Job erstellt.
- Setzen Sie das Merkmal Untergeordnete Jobs erstellen auf Nein, wenn Sie unabhängige Jobs unabhängig davon erstellen möchten, wie viele Übereinstimmungen die Eingabeeinheit findet.
- Wenn in Ihrer Umgebung ein Proxyserver mit Web-Services kommunizieren muss, legen Sie das Merkmal Proxy verwenden auf den richtigen Proxyserver fest.
- Setzen Sie das Merkmal Zeitzonenverschiebung auf die Verschiebung in Stunden zwischen der Koordinierten Weltzeit (UTC) und der
Zeitzone, die von dem Web-Service verwendet wird.Beispiel: Wenn der Web-Service die Pacific Standard Time verwendet, setzen Sie das Merkmal auf -8.
- Hinweis:
- Stellen Sie sicher, dass Sie dieses Merkmal ändern, wenn an einem Ort, der den Web-Service hostet, zwischen Standard- und Sommerzeit umgeschaltet wird. Andernfalls können Sie während der verlorenen oder gewonnenen Stunde die Daten verlieren, die RICOH ProcessDirector zum Erstellen von Jobs verwendet.
- Wenn der Web-Service UTC verwendet, geben Sie 0 ein oder lassen Sie das Feld leer.
- Legen Sie auf der Registerkarte Authentifizierung die Werte zur Authentifizierung bei der Anwendung fest.Weitere Informationen finden Sie in der entsprechenden Aufgabe über die Authentifizierung bei einem REST-Web-Service.
Wenn die Anwendung keine Authentifizierung erfordert, lassen Sie alle Authentifizierungsmerkmale leer.
- Optional: Legen Sie auf der Registerkarte Erweitert optionale Merkmale für Ihre Umgebung fest.
- Klicken Sie auf OK, wenn Sie fertig sind.
Wenn Sie die Einrichtung Ihrer Eingabeeinheiten, Benachrichtigungen und Workflows abgeschlossen haben, testen Sie den Datenaustausch zwischen RICOH ProcessDirector und der Anwendung.
Überprüfen Sie die mitgelieferte REST-Web-Service-Eingabeeinheit RestfulWebServiceSample.