Einsatzszenario für die Verarbeitung von JSON-Aufträgen mit Web-Services

Lernen Sie die Voraussetzung der Website für Buchbestellungen

Die Druckerei lernt die Voraussetzungen für die Kommunikation mit den REST-Web-Services für die Website für Buchbestellungen. RICOH ProcessDirector muss 3 Web-Services aufrufen:

• Ein Aufruf eines Web-Service ruft JSON-Informationen zu jeder Buchbestellung auf. Wenn Aufträge auf der Website warten, liefert der Web-Service einen JSON-Auftrag als Reaktion auf jeden GET-Aufruf zurück. Wenn keine Aufträge warten, reagiert der Web-Service nicht auf den Aufruf.

  Beispiel für den Inhalt eines JSON-Auftrags:

  {"Order": {"orderId": "ORD1238875463", "customername": "Ricoh"}}

• Ein Aufruf eines anderen Web-Service ruft JSON-Informationen über die Job-Tickets für das Buch und seinen Einband ab.

  Beispiel für eine JSON-Job Ticket-Information:

  {"JobTicket": [{ "itemnumber": "1182563839", "copies":"4","media" : "Letter Plain","file" : "http://localhost:15080/restapi/Brochure.pdf","type" : "Brochure","title" : "RPDBestSeller"}, { "itemnumber": "1934194376", "copies":"4","media" : "Letter Preprinted","file" : "http://localhost:15080/restapi/Cover.pdf","type" : "Cover" ,"title" : "RPDBestSeller" }]}

• Ein Aufruf eines dritten Web-Service sendet die Artikelnummer für jedes abgeschlossene Job-Ticket für einen Auftrag. Wenn beide Artikelnummern für einen Auftrag gesendet wurden, erstellt der Web-Service eine PDF-Datei mit einer Liste der Auftrags- und Artikelnummern. Der Web-Service legt die PDF-Datei in einem Verzeichnis ab.

  Inhalt einer Beispiel-PDF-Datei:

  10000001.2 mit der Artikelnummer 1182563839 wurde verarbeitet 10000001.1 mit der Artikelnummer 1934194376 wurde verarbeitet

Um die Aufrufe der Web-Services durchzuführen, lernt der RICOH ProcessDirector-Administrator:

• Die Werte, die für die Authentifizierung bei der Website für Buchbestellungen erforderlich sind.
• Die Werte, die für die Anforderung von Daten von jedem Web-Service erforderlich sind.
• Das Format der Daten, die in der Antwort von jedem Web-Service geliefert werden.

Der Administrator verwendet ein Browser-Plug-In, um manuelle Tests durchzuführen, die Antworten von den REST-Web-Services anfordern. Beispiele für Plug-ins sind u. a. RESTClient für Mozilla Firefox und Boomerang für Google Chrome.

Vorbereiten auf die Verarbeitung der JSON

Der Administrator prüft den Inhalt der JSON-Aufträge und Job Tickets, die von den REST-Web-Services zurückgeliefert werden, und identifiziert Informationen, die RICOH ProcessDirector benötigt. Als nächstes wertet der Administrator die RICOH ProcessDirector-Funktionen aus, die Web-Services und die Verarbeitung von XML und JSON aufrufen. Der Administrator trifft eine Entscheidung bezüglich der RICOH ProcessDirector-Objekte und Gruppen von Schritten, mit denen die Aufträge und Job Tickets verarbeitet und die erforderlichen Informationen extrahiert werden. Der Administrator definiert die XPath-Ausdrücke und XSLT-Stylesheets, die von den Objekten und Schritten benötigt werden.

1. Um Aufträge und Job Tickets in RICOH ProcessDirector zu verarbeiten, identifiziert der Administrator JSON-Objekte, welche die erforderlichen Informationen liefern. Der Administrator weist die Werte dieser Objekte RICOH ProcessDirector-Jobmerkmalen zu.
   • Um den Web-Service aufzurufen, der JSON-Informationen über die Job Tickets abruft, muss der Netzwerkadministrator die Auftrags-ID liefern. Der Administrator möchte eventuell auch den Namen des Kunden in RICOH ProcessDirector verfolgen.

     Zwei Mitglieder des JSON-Auftragsobjekts liefern diese Werte: orderId und customername.

     Diese Tabelle zeigt die 2 JSON-Mitglieder und die Namen der RICOH ProcessDirector-Jobmerkmale, die der Administrator verwendet, um die Informationen zu extrahieren.

     JSON-Mitglied	Datenbankname des Jobmerkmals	Benutzerschnittstellenname des Jobmerkmals
     orderId	Job.Info.Attr3	Benutzerdefiniert 3
     customername	Job.CustomerName	Kundenname

   • Um für jedes Job Ticket separate Jobs zu erstellen, muss der Administrator die Artikelnummer verwenden. Um die PDF-Dateien für Bücher und Einbände herunterzuladen und zu drucken, muss der Administrator die Datei-, Kopien- und Medieninformationen im Job Ticket verwenden. Der Administrator möchte außerdem den Buchtyp und -titel in RICOH ProcessDirector verfolgen.

     Sechs Mitglieder des JSON-Job-Ticket-Objekts liefern diese Werte: file, itemnumber, type, title, copies und media.

     Diese Tabelle zeigt diese 6 JSON-Mitglieder und die Namen der RICOH ProcessDirector-Jobmerkmale.

     JSON-Mitglied	Datenbankname des Jobmerkmals	Benutzerschnittstellenname des Jobmerkmals
     itemnumber	Job.Info.Attr1	Benutzerdefiniert 1
     file	Job.Info.Attr2	Benutzerdefiniert 2
     type	Job.Info.Attr4	Benutzerdefiniert 4
     title	Job.Info.Attr5	Benutzerdefiniert 5
     copies	Job.Copies	Angeforderte Jobkopien
     media	Job.Media	Medien

2. Vor der Erstellung des RICOH ProcessDirector-Prozesses prüft der Administrator die RICOH ProcessDirector-Objekte und Schrittschablone, die REST-Web-Services aufrufen:
   • REST-Web-Service-Eingabeeinheit
   • REST-Web-Service-Benachrichtigung
   • Schrittschablone CallRESTService

   Jeder von Ihnen kann DELETE-, GET-, PATCH- oder POST-Aufrufe durchführen, und jeder kann JSON oder XML verarbeiten.

   Die Eingabeeinheit kann aus jeder Antwort einen Auftrag erstellen, oder die Antwort für einen JSONPath- oder XPath-Ausdruck auswerten. Wenn die Eingabeeinheit eine Auswertung durchführt, kann sie jedes Mal, wenn sie den Ausdruck findet, einen Job erstellen.

3. Der Administrator untersucht auch die RICOH ProcessDirector -Schrittschablonen, die XML verarbeiten:
   • Ein auf der Schrittschablone ApplyXSLTransform basierender Schritt kann eine Eingabe in einem Format in eine Ausgabe in einem anderen Format konvertieren. Beispiel: der Schritt kann XML in diese Ausgabe konvertieren:
     • Eine Textdatei mit RICOH ProcessDirector Job- oder Dokumentenmerkmalen.
     • Eine Datei mit XML in einem anderen Format zur Eingabe in den Schritt CreateJobsFromXML.
   • Ein auf der Schrittschablone CreateJobsFromXML basierender Schritt kann durch die Auswertung der Inhalte einer XML-Eingabedatei einen oder mehrere XML-Jobs erstellen. Der Schritt kann die Jobs als unabhängige Jobs oder untergeordnete Jobs an einen festgelegten Workflow übermitteln.

   Da ApplyXSLTransform und CreateJobsFromXML kein JSON verarbeiten, kann ein auf der Schrittschablone ConvertJSONToXML basierender Schritt JSON in XML zur Eingabe in diese Schritte konvertieren.

4. Der Administrator entscheidet über die grundlegenden Komponenten des RICOH ProcessDirector-Prozesses.
   • Zum Abrufen von JSON-Aufträgen von der Website für Buchbestellungen wählt der Administrator eine REST-Web-Service-Eingabeeinheit.

     Da jeder Antwort einen einzigen Auftrag enthält, richtet der Administrator die Eingabeeinheit zum Erstellen eines Jobs aus jeder Antwort ein.

   • Zum Abrufen von JSON-Job Tickets für jeden Auftrag, wählt der Administrator 3 Schritte:
     • Ein Schritt ConvertJSONToXML konvertiert die JSON-Aufträge in XML zur Eingabe in einen Schritt ApplyXSLTransform.
     • Der Schritt ApplyXSLTransform konvertiert die Werte für Auftrags-ID und Name des Kunden in die Jobmerkmale RICOH ProcessDirector Benutzerdefiniert 3 und Name des Kunden.
     • Mit dem Wert des Merkmals Benutzerdefinierten 3 ruft ein Schritt CallRESTService die JSON-Job Tickets ab.
   • Um einen Job für jedes Job Ticket zu erstellen, wählt der Administrator 2 Schritte:
     • Ein Schritt ConvertJSONToXML konvertiert die JSON-Job Tickets in XML zur Eingabe in einen Schritt CreateJobsFromXML.
     • Der Schritt CreateJobsFromXML erstellt einen separaten Job für jedes Job Ticket durch Auswertung der Antwort mithilfe eines XPath-Ausdrucks.
   • Um Informationen aus den Job Tickets zu extrahieren und sie zum Herunterladen von PDF-Druckdateien zu verwenden, wählt der Administrator 3 Schritte:
     • Ein Schritt ApplyXSLTransform konvertiert die Werte in den XML-Job Tickets in RICOH ProcessDirector-Jobmerkmale. Beispielsweise wird die URL der herunterzuladenden Datei in den Wert des Jobmerkmals Benutzerdefiniert 2 konvertiert.
     • Mit dem Wert des Jobmerkmals Benutzerdefiniert 2 lädt ein Schritt DownloadFile die PDF-Druckdateien herunter.
     • Ein Schritt AssignJobValues legt den Eingabedatenstrom zur PDF fest, um den anderen Schritten im Workflow die Art der Datei mitzuteilen, die Sie verarbeiten.
   • Wenn beide PDF-Jobs in einem Auftrag gedruckt werden, möchte der Administrator die Website für Buchbestellungen benachrichtigen, dass der Auftrag versandfertig ist. Da die Website REST verwendet, wählt der Administrator eine REST-Web-Service-Benachrichtigung.
5. Für den Schritt CreateJobsFromXML benötigt der Administrator einen XML Path Language (XPath)-Ausdruck, der die Job Tickets identifiziert. Zur Definition des Ausdrucks prüft der Administrator den XML für die Job Tickets.
6. Für jeden Schritt Schritt ApplyXSLTransform benötigt der Administrator ein XSLT-Stylesheet zum Konvertieren von XML-Elementen in Jobmerkmale. Der Administrator verwendet ein XSLT-Tool (wie Altova MapForce), um 2 XSLT-Stylesheets zu erstellen:
   • Ein XSLT-Stylesheet "Auftrag-an-Überschreibungsdatei" konvertiert die Elemente Auftrags-ID und Name des Kunden des Auftrags in Jobmerkmale.
   • Ein XSLT-Stylesheet "Job-Ticket-an-Überschreibungsdatei" konvertiert die Elemente Datei, Artikelnummer, Typ, Titel, Kopien und Medien des Job Tickets in Jobmerkmale.

   Jeder Schritt ApplyXSLTransform gibt die Jobmerkmale in eine Textdatei aus. Der Wert jedes Merkmals Ausgabedatei legt eine Überschreibungsdatei im Spool-Verzeichnis für den Job fest.

   Mit den Werten in der Überschreibungsdatei legt RICOH ProcessDirector die Werte der Merkmale für den Job fest. Werte aus den Aufträgen werden verwendet, um Job-Tickets abzurufen. Werte aus den Job-Tickets werden verwendet, um Druckdateien herunterzuladen und zu verarbeiten.

Den Workflow einrichten

Der Administrator richtet einen Workflow mit 2 Verzweigungen ein.

1. Der -Administrator erstellt ein Workflow mit dem Namen ProcessBookOrders und richtet die Merkmale des Schritts SetJobPropsFromTextFile ein.
2. Der Administrator fügt dem Workflow in diesem Auftrag 10 Schritte hinzu:
   • DetectInputDataStream

     Dieser Schritt setzt das Merkmal Eingabedatenstrom auf JSON.

   • ConvertJSONtoXML

     Dieser Schritt verwendet die Standardwerte für die JSON-Eingabedatei und die XML-Ausgabedatei.

   • ApplyXSLTransform

     Dieser Schritt verwendet das XSLT-Stylesheet "Auftrag-an-Überschreibungsdatei" um eine Textdatei zu erstellen, welche die Werte für die Merkmale Benutzerdefiniert 3 und Name des Kunden festlegt. Der Schritt gibt die Textdatei als Überschreibungsdatei im Spoolverzeichnis für den Job aus. RICOH ProcessDirector verwendet die Überschreibungsdatei, um die Werte der Merkmale Benutzerdefiniert 3 und Name des Kunden für den Job festzulegen.

   • AssignJobValues

     Dieser Schritt setzt den Wert des Merkmals Jobname auf ORDER-order ID.

   • CallRESTService

     Dieser Schritt für einen GET-GET-Aufruf zu einem anderen Web-Service für die Website für Buchbestellungen durch. Der Schritt definiert die Auftrags-ID als Wert des Merkmals Anforderungsparameter:

     orderId:${Job.Info.Attr3}

     Die Web-Service liefert JSON-Informationen im Job Ticket zurück.

   • ConvertJSONtoXML

     Dieser Schritt verwendet die Standardwerte für die JSON-Eingabedatei und die XML-Ausgabedatei.

   • CreateJobsFromXML

     Der Administrator setzt den Wert des XPath-Ausdrucks //JobTicket und den Wert des Workflows für neue Jobs auf ProcessBookOrders. Um die Verbindung zwischen den neuen Jobs und dem ursprünglichen Job für den Auftrag beizubehalten, setzt der Administrator den Wert des Merkmals Untergeordnete Jobs erstellen auf Ja. Zum Festlegen der Auftrags-ID als den Namen des Jobs setzt der Administrator den Wert des Merkmals Namen für neues Jobmerkmal auf ${Job.Info.Attr3}.

     Die XML-Jobs, die in den Schritt gelangen, wechseln zum nächsten Schritt, während die neuen untergeordneten Jobs durch eine separate Verzweigung des Workflows gesendet werden.

   • RunHotFolderApplication

     Der Administrator fügt diesen Schritt hinzu, um mit dem Web-Service zu kommunizieren, der PDF-Dateien erstellt und sie in einem Ordner für Sofortdruck ablegt. Erst fragt der Web-Service einen Ordner für Sofortdruck für Auftragsjobs ab. Nachdem der Web-Service pro Auftrag 2 Anforderungen von der Benachrichtigung RestfulWebServiceSampleNotify empfängt, legt der Web-Service eine PDF-Datei in einem anderen Ordner für Sofortdruck ab. Der Schritt RunHotFolderApplication legt den Ordner für Sofortdruck für Auftragsjobs als Wert für das Merkmal Sendeordner fest. Der Schritt legt den Ordner für Sofortdruck mit PDF-Dateien als Wert für das Merkmale Abrufordner fest.

     Hinweis:
     • Dieses Szenario enthält einen Schritt RunHotFolderApplication, da der Beispiel-Workflow RestfulWebServiceWF diesen Schritt für den Datenaustausch mit dem Beispiel-Web-Service verwendet. Anstatt eine PDF-Datei zurückzuliefern, wenn ein Auftrag abgeschlossen ist, könnte der Web-Service eine andere Funktion ausführen. Beispielsweise könnte der Web-Service eine E-Mail-Nachricht an die Verpackungsabteilung senden und diese benachrichtigen, dass der Auftrag bereit zur Abholung ist.

   • AssignJobValues

     Dieser Schritt setzt den Wert des Merkmals Eingabedatenstrom auf PDF, damit die vom Web-Service erstellten PDF-Dateien im Workflow zu sehen sind.

   • RetainCompletedJobs
3. Der Administrator verbindet den Schritt RetainCompletedJobs mit dem Schritt RemoveJobs.
4. Der Administrator erstellt eine zweite Verzweigung zur Verarbeitung diere untergeordneten Jobs für die Bücher und deren Einbände.
   • Zwischen den Schritten SetJobPropsFromTextFile und DetectInputDataStream fügt der Administrator eine am Anschluss geltende Regel hinzu.
     • Regelname: Parent
     • Reihenfolge der Ausführung: 1
     • Merkmal: Jobnummer
     • Vergleich: Nicht ähnlich wie
     • Wert: *.*

     Die Regel sendet JSON-Jobs, welche die Eingabeeinheit abruft, an den Schritt DetectInputDataStream.

   • Der Administrator fügt einen Schritt ApplyXSLTransform2 in die Phase Empfang ein und verbindet sie mit dem Schritt SetJobPropsFromTextFile.

     Der Schritt verwendet das das XSLT-Stylesheet "Job-Ticket-an-Überschreibungsdatei" zum Erstellen einer Überschreibungsdatei, welche die Werte für die Merkmale Benutzerdefiniert 2, Benutzerdefiniert 1, Benutzerdefiniert 4, Benutzerdefinierte 5, Angeforderte Jobkopien und Medien setzt. Benutzerdefiniert 2, Benutzerdefiniert 1, Benutzerdefiniert 4 und Benutzerdefiniert 5 sind Datei, Artikelnummer, Typ und Titel.

   • Zwischen den Schritten SetJobPropsFromTextFile und ApplyXSLTransform2 fügt der Administrator eine am Anschluss geltende Regel hinzu.
     • Regelname: Child
     • Reihenfolge der Ausführung: 2
     • Merkmal: Jobnummer
     • Vergleich: Ähnlich wie
     • Wert: *.*

     Die Regel sendet untergeordnete Jobs, die der Schritt CreateJobsFromXML erstellt an den Schritt ApplyXSLTransform2.

   • Da der Schwerpunkt dieses Szenarios auf den Web-Services liegt, ist der Druckteil einfach. Ein Produktionsprozess könnte die Bücher und deren Einbände durch verschiedene Schritte in verschiedenen Workflows oder Verzweigungen zu verschiedenen Drucker senden.
5. Der Administrator fügt dem Workflow in diesem Auftrag 6 Schritte hinzu:
   • DownloadFile

     Dieser Schritt lädt PDF-Dateien für das Buch und dessen Einband von einer Website herunter. Der Schritt setzt den Wert des Merkmals URL für die herunterzuladende Datei auf Benutzerdefiniert 2, welche die Informationen zum Herunterladen der Datei vom Job Ticket enthält.

   • AssignJobValues

     Dieser Schritt setzt Wert von 3 Jobmerkmalen:

     • Angeforderter Drucker
     • Eingabedatenstrom
     • Jobname

     Der Wert von Jobname ist ${Job.Info.Attr5}-${Job.Info.Attr4}: Buchtitel, ein Bindestrich und Typ des Druckjobs (Buch oder Einband).

   • OptimizePDF
   • CountPages
   • CreatePageRanges
   • PrintJobs
     Hinweis:
     • Da der Schwerpunkt dieses Szenarios auf Web-Services liegt, besteht der Druckteil des Workflows aus nur 4 Schritten. Ein Produktionsprozess könnte die Bücher und deren Einbände durch viele weitere Schritte in separaten Verzweigungen (oder separaten Workflows) zu verschiedenen Druckern senden.
6. Der Administrator schließt den Workflow ab, indem er den Schritt PrintJobs mit dem Schritt RetainCompletedJobs verbindet.

Diese Abbildung zeigt die Eingabeeinheit, den Workflow und die Benachrichtigung. Die schwarze Linie zeigt an, dass der Schritt CreateJobsFromXML die untergeordneten Jobs an den Workflow ProcessBookOrders übermittelt.

Einrichten der Eingabeeinheit

Auf der Registerkarte "Allgemein" der REST-Web-Service-Eingabeeinheit setzt der Administrator den Wert des untergeordneten Workflow-Merkmals auf ProcessBookOrders. Das Eingabegerät übermittelt JSON-Aufträge, die vom Web-Service für die Website für Buchbestellungen abgerufen wurden, an den Workflow. Der Administrator legt ein Abfrageintervall von 30 Sekunden fest, um Aufträge schnell abzurufen, wenn mehrere von ihnen auf der Website warten. Weitere Merkmale werden abgestimmt auf die Umgebung der Druckerei festgelegt.

Auf der Registerkarte "Anforderung" legt der Administrator die Werte fest, die zum Abrufen von JSON-Aufträgen vom REST-Web-Service benötigt werden. Da jede Antwort einen JSON-Auftrag enthält, setzt der Administrator den Wert des Merkmals Jobs aus der Antwort erstellen auf Immer. Das Netzwerk der Druckerei benötigt keinen Proxyserver.

Auf der Registerkarte "Authentifizierung" legt der Administrator die Werte fest, die für die Authentifizierung beim REST-Web-Service benötigt werden.

E-Mail-Benachrichtigungen einrichten

Auf der Registerkarte "Anforderung" der REST-Web-Service-Benachrichtigung legt der Administrator die Werte fest, die vom REST-Web-Service, der die Benachrichtigung erhält, benötigt werden. Das Netzwerk der Druckerei benötigt keinen Proxyserver.

Auf der Registerkarte "Authentifizierung" legt der Administrator die Werte fest, die für die Authentifizierung beim REST-Web-Service benötigt werden.

Auf der Registerkarte "Ereignis" legt der Administrator die Ereignisinformationen für die Benachrichtigung fest:

• Ereignistyp: Job
• Merkmal: Aktueller Jobstatus
• Aktion: Ändert sich zu
• Wert: Aufbewahrt

Auf der Registerkarte "Bedingungen" legt der Administrator die Informationen für die Benachrichtigungsbedingungen fest:

• Wenden Sie eine oder alle der folgenden Bedingungen an = Alle
• Merkmal 1: Workflow
• Vergleich 1: =
• Wert 1: ProcessBookOrders
• Merkmal 2: Jobnummer
• Vergleich 2: Ähnlich wie
• Wert 2: *.*

Die Zusammenfassung der Bedingungsanweisung lautet:

Job.JobType = 'RestfulWebServiceWF' AND Job.ID like '*.*'

Wenn alle untergeordneten Jobs für einen Auftrag den Schritt RetainCompletedJobs erreichen, ruft die Benachrichtigung den Web-Service auf. Der Web-Service erstellt eine PDF-Datei mit der Artikelnummer jedes Job Tickets im Auftrag. Der Web-Service legt die Datei in einem Ordner für Sofortdruck ab, der vom Schritt RunHotFolderApplication beobachtet wird. Die PDF-Datei wird in der Job-Tabelle angezeigt. Mitarbeiter in der Druckerei können die PDF-Datei ansehen, um zu bestätigen, dass das Buch und der Einband für den Auftrag gedruckt wurden.

Jobs über den Workflow verarbeiten

Der Workflow RestfulWebServiceWF, der mit der Web Services Enablement-Funktion geliefert wird, ist ähnlich dem Workflow ProcessBookOrders. Um zu sehen, wie Jobs über den Workflow ProcessBookOrders verarbeitet werden, führen Sie den Workflow RestfulWebServiceWF aus. Weitere Informationen finden Sie im zugehörigen Aufgabenthema zum Ausführen eines Workflows, der die über REST-Web-Services abgerufenen Aufträge verarbeitet.