Web-Services verwenden

RICOH ProcessDirector auf den Erhalt von Web-Service-Anforderungen vorbereiten

Bevor Sie Web-Service-Anforderungen übermitteln können, müssen Sie einen RICOH ProcessDirector-Benutzer und ein Kennwort für die zu verwendenden Web-Services erstellen. Achten Sie darauf, dass die Benutzer-ID in RICOH ProcessDirector über die erforderliche Berechtigungsstufe verfügt, um die gewünschten Aktionen im Web-Service auszuführen. Für die Beispiele in diesem Kapitel ist die Berechtigung Bediener ausreichend. Wenn Sie das Lightweight Directory Access Protocol (LDAP) zur Authentifizierung verwenden, erstellen Sie in LDAP einen Benutzer zur Verwendung mit den Web-Services. Der LDAP-Benutzer muss zu einer Gruppe gehören, die über die entsprechenden Berechtigungen in RICOH ProcessDirector verfügt.

Alle Benutzer müssen ihr Kennwort bei der ersten Anmeldung ändern. Melden Sie sich also mit der soeben erstellten Benutzer-ID bei der RICOH ProcessDirector-Benutzerschnittstelle an, und ändern Sie das Kennwort. Wenn Kennwörter so konfiguriert sind, dass sie nach einem bestimmten Zeitraum ablaufen, müssen Sie sich dementsprechend anmelden und dieses Kennwort ändern.

Web-Service-Anforderungen vorbereiten

Beachten Sie beim Erstellen von Anforderungen, die folgenden Punkte:

• Der Web-Service-Benutzer muss sich anmelden, bevor Aktionen möglich sind.

  Um Web-Service-Anforderungen zu übermitteln, müssen Sie zunächst den Web-Service GET /users/login verwenden, um sich bei RICOH ProcessDirector als Web-Service-Benutzer anzumelden und ein Identitätsnachweis-Token zu erhalten. Das Token muss im Header aller Web-Service-Anforderungen enthalten sein, die Sie übermitteln, bis Sie den Web-Service POST /users/logout/{name} verwenden.

• Merkmalnamen müssen im Datenbankformat verwendet werden, nicht im Format der Benutzerschnittstelle.

  Soll ein Merkmalname in eine Anforderung aufgenommen werden, muss also der Datenbankname des Merkmals verwendet werden. Wenn Sie beispielsweise GET /objects/{objectType} verwenden möchten, um den Wert Klasse eines Jobs abzurufen, fügen Sie Job.Class als attribute-Wert in die Anforderung ein. Die Datenbanknamen von Merkmalen sind in der Feldhilfe für jedes Merkmal, im Hilfesystem des Produkts, in von den Web-Services erhaltenen Ergebnissen und unter Datenbanknamen der Merkmale zu finden.

• Merkmalwerte müssen im Datenbankformat verwendet werden, nicht im Format der Benutzerschnittstelle.

  Achten Sie beim Einschließen eines Wertes in eine Abfrage darauf, dass es sich um einen gültigen Wert handelt. Normalerweise sind für numerische Felder numerische Werte und für Textfelder Textwerte erforderlich. Einige Merkmale verfügen jedoch über eine beschränkte Werteliste.

  Alle Merkmale mit einer Dropdown-Liste akzeptieren nur bestimmte Werte. Zusätzlich sind die Werte in diesen Listen nicht immer mit den in der Datenbank gespeicherten Werten identisch. Beispielsweise lauten die Werte für das Merkmal Lochen in der Benutzerschnittstelle wie folgt:

  • 2 links
  • 2 rechts
  • Links oben
  • Links oben vertikal
  • Links unten
  Die Datenbankwerte lauten jedoch wie folgt:
  • 2_at_left
  • 2_at_right
  • Top_left
  • Top_left_vertical
  • Bottom_left

  In Web-Service-Anforderungen ist der Datenbankwert zu verwenden. Die Datenbankwerte von Merkmalen sind im Hilfesystem des Produkts und unter Datenbanknamen der Merkmale zu finden.

• Positionsgebundene Jobmerkmale müssen Phase, Schritt, und Workflow-Namen, in dieser Reihenfolge, nach dem Merkmalnamen haben. Schließen Sie die einzelnen der drei Namen in Klammern ein.

  In diesem Beispiel gibt die JSON-Zeichenfolge eine Steuerdatei auf einem Linux -System als Wert des Jobmerkmals Identifizieren der PDF-Steuerdatei (Datenbankname Job.identifypdfcontrolfile) an:

  "Job.IdentifyPDFControlFile[Prepare][IdentifyPDFDocuments][PullPDFSample]":"/aiw/aiw1/testfiles/PullPDF.ctl"

  Das Jobmerkmal ist auf dem Schritt IdentifyPDFDocuments in der Phase Vorbereitung des PullPDFSample-Workflow.