Vorbereitung zum Abrufen von SOAP-Web-Services-Eingaben

Zum Abrufen einer Eingabe von einem SOAP-Web-Service für eine Anwendung identifizieren Sie die Parameter, die zum Aufrufen des SOAP-Web-Service verwendet werden. Testen Sie den Datenaustausch zwischen RICOH ProcessDirector und der Anwendung. Definieren und konfigurieren Sie dann eine SOAP-Web-Service-Eingabeeinheit.
Als Vorbereitung zum Abrufen von SOAP-Web-Services-Eingaben:
  1. Lernen Sie die Voraussetzungen für die Kommunikation mit dem SOAP-Web-Service für die Anwendung:
    • Die Werte für die Authentifizierung bei der Anwendung
    • Die Werte für die Anforderung von Daten vom SOAP-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.

  2. 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.
    • Importieren Sie WSDL-Dateien für alle Web-Services, die Sie aufrufen möchten.

      RICOH ProcessDirector erstellt SOAP-Anforderungsobjekte aus SOAP-Vorgängen in der WSDL-Datei. Geben Sie ein Präfix an, das RICOH ProcessDirector beim Erstellen der Objekte den Namen der SOAP-Vorgänge hinzufügt. Ein SOAP-Anforderungsobjekt ermöglicht es RICOH ProcessDirector, die SOAP-Version und andere Informationen zu ermitteln, die erforderlich sind, um einen richtigen Aufruf an den Web-Service zu senden.

    Weitere Informationen finden Sie in den entsprechenden Aufgaben.

  3. Führen Sie einen manuellen Test zur Authentifizierung bei der Anwendung und Anforderung einer Antwort vom SOAP-Web-Service durch. Ü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 SOAP-Clients testen.
  4. Entscheiden Sie, wie die SOAP-Web-Service-Eingabeeinheit Aufträge aus den Daten in der vom Web-Service zurückgegebenen Antwort erstellen soll.
    • Jedes Mal, wenn die Eingabeeinheit eine Antwort erhält, kann sie einen Job mit allen XML-Daten in der Antwort erstellen.
    • Die Eingabeeinheit kann die Antwort mithilfe eines xPath-Ausdrucks untersuchen.

      Wenn die Eingabeeinheit im Ausdruck angegebene XML-Elemente findet, erstellt sie einen Job für jedes passende Element. Jeder Job enthält das passende Element und alle darin verschachtelten Elemente. Wenn die Eingabeeinheit zwei oder mehr Elemente findet, kann sie unabhängige Jobs oder untergeordnete Jobs erstellen.

      Wenn die Eingabeeinheit keine passenden Elemente findet, erstellt sie keinen Job.

  5. Definieren Sie eine SOAP-Web-Service-Eingabeeinheit:
    1. Klicken Sie auf die Registerkarte Verwaltung.
    2. Klicken Sie im linken Teilfenster auf Einheiten Eingabeeinheiten.
    3. Klicken Sie auf Hinzufügen SOAP-Web-Service.
  6. 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-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.
  7. Auf der Registerkarte Anforderung:
    1. 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.
    2. 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.

      In diesem Beispiel enthalten die Nutzdaten die folgenden Elemente: <Token>, <Zeitraum>, <Start> und <Ende>. Der Wert jedes Elements ist ein Symbol:

      <Token>${WebService.Credential}</Token> <Zeitraum> <Start>${WebService.LastSuccessRequestTime}</Start> <Ende>${WebService.CurrentRequestTime}</Ende> </Zeitraum>

      Die Eingabeeinheit löst die Symbole auf, wenn sie XML-Eingaben abfragt.

    3. Setzen Sie das Merkmal SOAP-Anforderung auf die SOAP-Anforderung, die RICOH ProcessDirector erstellt hatte, als Sie die WSDL-Datei importiert haben.
      Beispiel: Sie möchten die SAOP-Anforderung GetOrdersByDate verwenden. Sie haben den Namen der SOAP-Anforderungen PrintShop vorangestellt, als Sie diese importiert haben. Wählen Sie PrintShop-GetOrdersByDate.
    4. 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 in der Antwort zu untersuchen und jedes Mal einen Job zu erstellen, wenn ein XML-Element gefunden wird, wählen Sie Nur, wenn der Behandlungstyp Muster entspricht.
    5. Wenn Sie Nur, wenn der Behandlungstyp Muster entspricht ausgewählt haben:
      • Setzen Sie das Merkmal Antwort-Muster für Übereinstimmung auf den XPath-Ausdruck, der das XML-Element identifiziert, das Sie für jeden Job verwenden möchten.

        Beispiel: Sie möchten jeweils einen Job für jeden Auftrag, und die Daten in der Antwort enthalten ein Auftragselement. Geben Sie den XPath-Ausdruck ein, der für das Bestellelement im XML-Element steht.

      • 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.
    6. Wenn in Ihrer Umgebung ein Proxyserver mit Web-Services kommunizieren muss, legen Sie das Merkmal Proxy verwenden auf den richtigen Proxyserver fest.
    7. 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.
  8. 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 SOAP-Web-Service.

    Wenn die Anwendung keine Authentifizierung erfordert, lassen Sie alle Authentifizierungsmerkmale leer.

  9. Optional: Legen Sie auf der Registerkarte Erweitert optionale Merkmale für Ihre Umgebung fest.
  10. 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.

Beispiel

Die mitgelieferte REST-Web-Service-Eingabeeinheit RestfulWebServiceSample ist vergleichbar mit einer SOAP-Web-Service-Eingabeeinheit. Die MarcomCentral Connect-Funktion enthält eine mitgelieferte SOAP-Web-Service-Eingabeeinheit.