Vorbereitung zum Senden des Status an REST-Web-Services
- 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.
- Treffen Sie eine Entscheidung zu dem Ereignis, das die Benachrichtigung auslösen soll,
und zu den Bedingungen, die bestimmen, wann die Benachrichtigung den Web-Service aufruft.Wenn Sie eine Benachrichtigung für ein Ereignis senden möchten, das nur auftritt, wenn ein bestimmter Workflow einen Job verarbeitet, geben Sie diesen Workflow als eine Bedingung an.
- Definieren Sie eine REST-Web-Service-Benachrichtigung:
- 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-Benachrichtigung RestfulWebServiceSampleNotify kopieren. - Geben Sie auf der Registerkarte Allgemein einen Namen für die Benachrichtigung ein.
- Auf der Registerkarte Anforderung:
- Setzen Sie das Merkmal Anfrage-URL auf die URL des Web-Service, den Sie benachrichtigen möchten.
- Setzen Sie das Merkmal Methode anfordern auf den vom Web-Service geforderten Wert.
- Geben Sie für den Wert des Merkmals Nutzlast anfordern den Text der Web-Service-Anforderung ein, die die Eingabeeinheit an die Anwendung
übermittelt.In diesem XML-Beispiel enthalten die Nutzdaten zwei XML-Elemente: <Token> und <OrderNumber>.
<Token>${WSNotification.WebService.Credential}</Token> <OrderNumber>${Job.Info.attr1}</OrderNumber>
Der Wert für jedes Element ist ein RICOH ProcessDirector-Symbol mit einem Merkmal. Wenn Sie für die Authentifizierung bei der Anwendung einen Web-Service verwenden, schließen Sie das Merkmal WSNotification.WebService.Credential in einem Symbol ein. Ersetzen Sie das andere Element und Merkmal mit den Elementen und Merkmalen, die Sie an die Anwendung senden möchten. Die Benachrichtigung löst die Symbole auf, wenn es den Status an den REST-Web-Service sendet.
- 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, orderNumber und customerName. Der Wert jedes Schlüsselworts ist ein RICOH ProcessDirector-Symbol. Jedes Symbol enthält eines der folgenden Merkmale: WSNotification.WebService.Credential, Job.Info.Attr1 und Job.CustomerName.
token:${WSNotification.WebService.Credential orderNumber} :${Job.Info.Attr1} customerName:${Job.CustomerName}
Die Eingabeeinheit löst die Symbole auf, wenn es den Status an den REST-Web-Service sendet.
- Wenn in Ihrer Umgebung ein Proxyserver mit Web-Services kommunizieren muss, legen Sie das Merkmal Proxy verwenden auf den richtigen Proxyserver fest.
- 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.
- Auf der Registerkarte Ereignis:
- Wählen Sie den Objekttyp aus, der beobachtet werden soll.
- Wählen Sie das Merkmal, die Aktion und den Wert aus, die überwacht werden sollen.
- Zur Definition eines weiteren Ereignisses klicken Sie rechts von einem Ereignis auf +.
- Zum Löschen eines Ereignisses klicken Sie rechts von einem Ereignis, das Sie löschen wollen, auf -.
Um beispielsweise eine Benachrichtigung senden, wenn sich der Status eines Jobs in Gehalten ändert, wählen Sie Aktueller Jobstatus, Änderung zu, und Gehalten. - Auf der Registerkarte Bedingungen:
- Wählen Sie das Merkmal und den Wert aus, die erfüllt sein müssen, bevor eine Benachrichtigung versendet werden kann.
- Zur Definition einer weiteren Bedingung klicken Sie rechts von einem Ereignis auf
+.Zur Festlegung der Art und Weise, wie die Bedingungen kombiniert werden, wählen Sie Beliebig, Alle oder Benutzerdefiniert.
- Zum Löschen einer Bedingung klicken Sie rechts von einer Bedingung, die Sie löschen wollen, auf -.
Um beispielsweise eine Benachrichtigung nur zu senden, wenn sich ein untergeordneter Job im Workflow ProcessWebOrders befindet, legen Sie zwei Bedingungen fest:- Workflow = ProcessWebOrders
- Jobnummer gleich*.*
Um die Bedingungen nur anzuwenden, wenn ein Job beide erfüllt, wählen Sie Alle.
- 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-Benachrichtigung RestfulWebServiceSampleNotify.