Schrittvorlagen für externe Schritte konfigurieren, die die Befehlszeile oder Steuerdateien verwenden

Richten Sie mit diesem Prozess eine Schrittvorlage für externe Schritte ein, in denen die Parameter zwischen RICOH ProcessDirector und dem externen Programm anhand einer Befehlszeile oder einer Steuerdatei übergeben werden.
Gehen Sie wie folgt vor, um eine Schrittvorlage für einen externen Schritt zu konfigurieren:
  1. Klicken Sie auf die Registerkarte Workflow.
  2. Klicken Sie im linken Teilfenster auf Schrittvorlagen.
  3. Klicken Sie mit der rechten Maustaste auf die Schrittvorlage RunExternalProgram, und wählen Sie Kopieren.
  4. Geben Sie einen Namen und eine Beschreibung für die neue Schrittvorlage an.
  5. Klicken Sie auf Extern.
  6. Aktualisieren Sie das Merkmal Externer Befehl.
    Dies sind der aktuelle Befehl und alle Befehlszeilenparameter, die RICOH ProcessDirector zur Ausführung des externen Programms ausgibt. Die Befehlszeichenfolge kann RICOH ProcessDirector-Symbolschreibweise aufweisen:
    • In dem folgenden Beispiel kopiert der Befehl copy die Datei JobNumber.print.pdf aus dem Spoolverzeichnis für den Job:
      copy -u ${getAbsoluteFileName(print, pdf, read)} C:\tmp\jobarchives
        Hinweis:
      • ${getAbsoluteFileName(print, pdf, read)} ist die RICOH ProcessDirector-Symbolformel, die den Namen der PDF-Druckdatei in dem Spoolverzeichnis zurückgibt. Ist die PDF-Druckdatei bei der Ausführung des externen Programms im Spoolverzeichnis nicht vorhanden, tritt ein Fehler auf.
    • In dem folgenden Beispiel liest das externe Programm Mein_Programm die Datei Jobnummer.print.pdf aus dem Spoolverzeichnis und schreibt eine aktualisierte Version der Datei unter Verwendung der Umleitung in das Spoolverzeichnis:
      Mein_Programm -i ${getFileName(print, pdf, read)} > ${getFileName(print, pdf, write)}
        Hinweis:
      • ${getFileName(print, pdf, read)} ist die RICOH ProcessDirector-Symbolformel, die den Namen der PDF-Druckdatei in dem Spoolverzeichnis zurückgibt. Ist die PDF-Druckdatei bei der Ausführung des externen Programms in dem Spoolverzeichnis nicht vorhanden, gibt RICOH ProcessDirector den Namen der Eingabedatei für den Job (Jobnummer.print.unknown) zurück. Ist diese Datei in dem Spoolverzeichnis nicht vorhanden, tritt ein Fehler auf.
    • In dem folgenden Beispiel liest das externe Programm auditstatistics die Datei Jobnummer.overrides.text aus dem Spoolverzeichnis und schreibt die neue Statistikdatei Jobnummer.statistics.text in das Spoolverzeichnis:
      auditstatistics inputfile=${getFileName(overrides, text, read)} outputfile=${getFileName(statistics, text, write)}
    • In dem folgenden Beispiel verwendet das externe Programm line2afp eine separate Parameterdatei, für die eine entsprechende RICOH ProcessDirector-Steuerdatei existiert, wenn die Funktion "AFP-Unterstützung" installiert ist. In der Steuerdatei ist eine RICOH ProcessDirector-Methode angegeben, mit der das externe Programm angewiesen wird, seine Ausgabe in das Spoolverzeichnis zu schreiben:
      line2afp parmdd=${getControlFileName()}
        Hinweis:
      • ${getControlFileName()} ist die RICOH ProcessDirector-Symbolformel, die den Namen der aufgelösten Steuerdatei zurückgibt. RICOH ProcessDirector generiert die Steuerdatei aus der angegebenen Steuerdateischablone.
      • Die Steuerdatei kann die Methode getChildFileName benutzen, um den Namen einer untergeordneten Datei zurückzugeben, damit das externe Programm eine Datei in das Unterverzeichnis children des Spoolverzeichnisses schreiben kann. Das externe Programm muss die Dateinamen von Dateien untergeordneter Jobs in dem folgenden Format schreiben:
        JobNumber.UsageType.DataType.n,Job.JobType=WorkflowName
        WorkflowName ist der Name des Workflows, den der untergeordnete Job benötigt. Der Workflow muss vorhanden und aktiviert sein.
      • Wenn Sie einem Workflow einen Schritt hinzufügen, der auf der Schrittvorlage RunExternalProgram basiert, ändern sich die Merkmale, für die in den Jobstandardwerten die Phase [Empfang] angegeben ist, in die Phase, der der Schritt hinzugefügt wird.
    • In dem folgenden Beispiel benutzt der externe Schritt den Windows-Befehl copy, um eine Kopie der Datei Jobnummer.print.pdf aus dem Spoolverzeichnis in ein Archivverzeichnis auf dem Windows-System zu kopieren:
      copy ${getAbsoluteFileName(print,pdf,read)} d:\archive\pdf
        Hinweis:
      • Auf dem Windows-System muss entweder das Basisprodukt oder ein Anwendungsserver installiert sein. Der Anwendungsserver muss mit dem primären Server verbunden sein.
      • Geben Sie das Windows-Verzeichnis in dem Windows-spezifischen Format als Verzeichnisnamen an.
      • Benutzen Sie native Windows-Befehle und keine SFU-Befehle, wo dies geeignet ist. Benutzen Sie beispielsweise den Befehl copy und nicht den Befehl cp. Nicht alle SFU-Befehle sind auf Windows-Systemen verfügbar.
      • Je nach Befehl muss nicht zwingend ein Verzeichnis auf dem Windows-System vorhanden sein. Der Befehl kann das Verzeichnis auf dem Windows-System erstellen.
      • Stellen Sie sicher, dass Sie die Schrittvorlage so optimieren, dass die Ausführung nur auf einem Windows-Anwendungsserver erfolgt. Da die Verzeichnisnamen auf einem Linux-System ein anderes Format haben als auf einem Windows-System, scheitert ein auf dieser Schrittvorlage basierender Befehl, wenn RICOH ProcessDirector versucht, den Schritt auf einem Nicht-Windows-System auszuführen.
  7. Haben Sie eine Steuerdateischablone für die Verwendung mit dem externen Programm erstellt, aktualisieren Sie das Merkmal Externe Steuerdateischablone. Legen Sie als Wert die Verzeichnisposition und den Namen der Steuerdateischablone fest. Wenn das externe Programm seine Parameter nur als Befehlszeilenparameter empfängt, löschen Sie alle Werte für dieses Merkmal.
  8. Aktualisieren Sie das Merkmal Gültige Rückkehrcodes.
    In diesem Kontext ist ein gültiger Rückkehrcode ein beliebiger Rückkehrcode, den das externe Programm zurückgibt und bei dem keine Benutzeraktion erforderlich ist. Trennen Sie die einzelnen Rückkehrcodenummern durch Kommas. Für jeden Rückkehrcode des externen Programms, der nicht im Wert für dieses Merkmal enthalten ist, setzt RICOH ProcessDirector den Job in den Fehlerstatus. Es Gibt zudem eine Nachricht in dem Protokoll für den Job aus, um Sie auf ein Problem aufmerksam zu machen, das von dem externen Programm berichtet wurde.

    Lautet der Wert für das Merkmal "Gültige Rückkehrcodes" beispielsweise 0,4 und wird das externe Programm mit dem Rückkehrcode 16 abgeschlossen, gibt RICOH ProcessDirector eine Nachricht aus, die ähnlich wie die folgende Nachricht aussieht:

    AIWI6073E Externer Schritt copy c:\aiw\aiw1\spool\default\10000016\10000016.print.unknown d:\archive\directory wurde mit Rückkehrcode 16 abgeschlossen, der als Fehler definiert ist.

  9. Gelten für die Installation bestimmte Sprachenvoraussetzungen, können Sie das externe Programm anweisen, Nachrichten in einer unterstützten Sprache zurückzugeben. In der Liste für das Merkmal Sprache für externes Programm sind die von RICOH ProcessDirector unterstützten Sprachen aufgeführt.
  10. Klicken Sie auf OK.
  11. Aktualisieren Sie alle Einstellungen auf der Registerkarte Optimierung, um den Schritt auf den Computern auszuführen, auf denen das externe Programm installiert ist.
  12. Klicken Sie mit der rechten Maustaste auf die Schrittvorlage, und wählen Sie Aktivieren.