RICOH ProcessDirector-Symbolschreibweise

Symbolsyntax

In RICOH ProcessDirector sieht die Basissyntax eines Symbols, das Sie in Symbolformeln verwenden können, wie folgt aus:

Name ist ein Datenbankmerkmal in RICOH ProcessDirector oder ein mit dem Job übergebener Parameter. RICOH ProcessDirector wertet Parameter, die mit einem Job übergeben werden, über eine Steuerdatei (beispielsweise über eine Regeldatei, die JCL-Parameter und -Werte analysiert) aus. Name kann auch eine Methode in RICOH ProcessDirector wie beispielsweise getFileName, getAbsoluteFileName, getControlFileName oder getChildFileName sein. Bei dem Wert für Name muss die Groß-/Kleinschreibung beachtet werden.

Beispiele

${Get*Method}

Dieses Symbol weist RICOH ProcessDirector an, eine interne Methode aufzurufen und einen ausgewerteten Wert zurückzugeben. Wollen Sie wissen, wie RICOH ProcessDirector diesen Symboltyp verwenden kann, sehen Sie sich den Schritt RunExternalProgram in der Phase Vorbereitung des PDF-Workflows an. Der Schritt RunExternalProgram legt dieses Merkmal Externer Befehl fest:

• Linux: cp ${getControlFileName()} /aiw/aiw1/samples/${Job.ID}.info.csv
• Windows: copy ${getControlFileName()} C:\aiw\aiw1\samples\${Job.ID}.info.csv

Das Symbol ${getControlFileName()} weist RICOH ProcessDirector an, die externe Steuerdateivorlage in das Unterverzeichnis tmp des Verzeichnisses spool zu kopieren und alle in der Steuerdatei enthaltenen Symbole aufzulösen.

Der Schritt RunExternalProgram in der Phase Vorbereitung des PDF-Workflows legt dieses Merkmal Externe Steuerdateischablone fest:

• Linux: /aiw/aiw1/control_files/external_programs/job_info.cfg
• Windows: C:\aiw\aiw1\control_files\external_programs\job_info.cfg

Wenn RICOH ProcessDirector den Job erstellt, der diesen Workflow benutzt, und die Anfangsmerkmalwerte festlegt, benutzt es den Wert, der von der Methode getControlFileName zurückgegeben wurde, um den externen Befehl in Folgendes aufzulösen:

• Linux: cp /aiw/aiw1/spool/default/10000003/tmp/job_info.control.text /aiw/aiw1/samples/10000003.info.csv
• Windows: copy C:\aiw\aiw1\spool\default\10000003\tmp\job_info.control.text C:\aiw\aiw1\samples\10000003.info.csv

${Job.Merkmalname}

Dieses Symbol weist RICOH ProcessDirector an, in der Datenbank den Wert eines bestimmten RICOH ProcessDirector-Jobmerkmals abzufragen.

Wollen Sie wissen, wie RICOH ProcessDirector diesen Symboltyp verwenden kann, sehen Sie sich den Inhalt der Steuerdateivorlage job_info.cfg an. Diese Steuerdateivorlage befindet sich in /aiw/aiw1/control_files/external_programs unter Linux bzw. in C:\aiw\aiw1\control_files\external_programs unter Windows.

Wenn RICOH ProcessDirector eine Steuerdatei aus dieser Vorlage erstellt, löst es die Werte der Symbole ${Job.ID}, ${Job.Name}, ${Job.JobType}, ${Job.SubmitTime}, ${Job.RequestedPrinter}, ${Job.InputFile.Size}, ${Job.JobSize}, ${Job.TotalPages} und ${Job.TotalSheets} in die tatsächlichen RICOH ProcessDirector-Jobmerkmale auf. Beispiel:

${Job.ID}=10000001
${Job.Name}=Demo.pdf
${Job.JobType}=PDF
${Job.SubmitTime}=10:02.35
${Job.RequestedPrinter}=Sample
${Job.InputFile.Size}=2608549
${Job.JobSize}=26
${Job.TotalPages}=26
${Job.TotalSheets}=26

Hinweis:
• Sie können zudem ein beliebiges Systemmerkmal in einer Symbolformel verwenden, die RICOH ProcessDirector auswertet. Zum Beispiel, ${WorkflowSystem.Transform.Server.Address}.

${Math}

Dieses Symbol bewirkt, dass RICOH ProcessDirector die Summe, die Differenz, das Produkt oder den Betrag aus zwei Werten berechnet. Bei den Werten handelt es sich um Jobmerkmale oder Zahlen. Auch eine Zufallszahl innerhalb eines vorgegebenen Intervalls kann generiert werden.

Dieses Symbol weist die folgende Syntax auf:

${Math(value1,operator,value2)}

• value1 und value2 sind entweder Jobmerkmale in Symbolschreibweise (wie z. B. ${Job.CurrentTime}) oder Zahlen. Nummern können Bruchzahlen enthalten (wie z. B. 2,45), wenn das Merkmal, das die Symbolformel verwendet, Werte mit Gleitkommazahlen unterstützt.
• operator ist +, –, * oder mod, also entsprechend Addition, Subtraktion, Multiplikation und Betrag.

Beispiel: Um 5 Minuten zur aktuellen Zeit hinzuzufügen und das Ergebnis im Merkmal Job.Info.Attr2, zu speichern, schreiben Sie ${Math(${Job.CurrentTime}, +, 5)}.

In den Feldern Wert können in dieser Formel nur ganzzahlige, nummerische oder Zeitstempel-Werte verwendet werden. In dieser Formel können ausschließlich Merkmale festgelegt werden, die Werte in Symbolschreibweise unterstützen.

Wenn einer der Werte ein Zeitstempel-Wert ist, werden nur die Operatoren "+" und "-" unterstützt. Der verbleibende Wert muss ein ganzzahliger Wert sein. Ganzzahlige Werte werden in der Einheit "Minuten" angegeben.

Einige Merkmale scheinen über Zeitstempel-Werte zu verfügen (wie z. B. Job.TimeSubmitted), sind aber als Zeichenfolgen definiert und können daher nicht als Werte in mathematischen Symbolen verwendet werden. Das mathematische Symbol kann in Feldern auf Schrittvorlagen im Workflow-Ersteller, einschließlich der Schrittvorlage AssignJobValues, sowie in Feldern in Jobmerkmal-Notizbüchern eingegeben werden.

Für "mod" muss value1 eine Ganzzahl größer oder gleich 0 sein, und value2 muss eine Ganzzahl von 1 oder größer sein.

Für die Zufallszahlengenerierung lautet die Syntax dieses Symbols:

• ${Math(rand, value1, value2)}

Beispiel: Zum Generieren einer Zufallszahl zwischen 1 und 10 schreiben Sie ${Math(rand, 1, 10)}.

Hinweis:
• value1 und value2 sind entweder Jobmerkmale in Symbolschreibweise (z. B. ${Job.Copies}) oder Zahlen.
• value1 und value2 müssen Ganzzahlen größer oder gleich null sein.
• Das zurückgegebene Ergebnis ist eine Ganzzahl zwischen value1 und value2 inklusive.
• Die generierten Zufallszahlen sind keine kryptografisch sicheren Zufallszahlen.

${Regeldateiparameter}

Dieses Symbol weist RICOH ProcessDirector an, eine mit einer Eingabedatei übergebene Parameterdatei abzufragen. fragt einen Parameterwert ab, der für ein anderes Programm oder Produkt spezifisch ist.

Wenn die Eingabeeinheit namens LPDPDF eine Eingabedatei erhält, verwendet sie die Steuerdatei receive_lpd_pdf_jobtype.cfg, zur Analyse der Parameter, die mit der Eingabedatei für den Job übergeben werden.

Die Steuerdatei receive_lpd_pdf_jobtype.cfg befindet sich in diesem Verzeichnis:

• Linux: /aiw/aiw1/control_files/rules
• Windows: C:\aiw\aiw1\control_files\rules

(Linux)

(Windows)

Eine Steuerdatei receive_lpd_pdf_jobtype.cfg kann die folgenden Informationen enthalten:

orighost=mywindowshost
origuser=annsmith
origname=TestPDF.pdf

Die Symbole für diese Parameterwerte sind:

${ORIGHOST}
${ORIGUSER}
${ORIGNAME}

Wollen Sie wissen, wie RICOH ProcessDirector diesen Symboltyp verwenden kann, sehen Sie sich die Datei receive_lpd_pdf_jobtype.cfg in diesem Verzeichnis an.

• Linux: /aiw/aiw1/samples/rules
• Windows: C:\AIW\AIW1\samples\rules

Hinweis:
• Weitere Informationen zu dieser Implementierung enthält Syntax für RICOH ProcessDirector-Steuerdateien.

Hinweise zur Verwendung von Symbolformeln

Für die Verwendung von RICOH ProcessDirector-Symbolformeln gelten die folgenden Nutzungseinschränkungen:

Unterstützte Objekte

RICOH ProcessDirector unterstützt die Verwendung von Symbolformeln nur zum Festlegen der Werte von Jobmerkmalen. Sie können Symbolformeln nicht verwenden, um Merkmalwerte für andere Objekttypen wie beispielsweise eine Eingabeeinheit oder einen Drucker festzulegen. Die Symbolformel, die RICOH ProcessDirector zum Festlegen des Werts auswertet, kann ein anderes Jobmerkmal, ein Merkmal des primären Servers oder ein Methodenaufruf sein, beispielsweise: ${Job.InputFile}, ${Printer.Model} und ${getControlFileName()}. Eine bestimmte Symbolformel kann jedoch nicht gleichzeitig ein Jobmerkmal und ein Systemmerkmal oder einen Methodenaufruf enthalten.

Hinweis:
• Eine Änderung des Werts eines Systemmerkmals kann sich auf viele Symbolformeln für Jobmerkmale auswirken. Da RICOH ProcessDirector alle Symbolformeln gleichzeitig aktualisiert, kann die Operation längere Zeit dauern.

Ausgeschlossene Merkmale

RICOH ProcessDirector unterstützt das Festlegen des Werts für das Merkmal Job.Class mit einer Symbolformel nicht.

Darstellung in der RICOH ProcessDirector-Benutzerschnittstelle

Sie können Symbolformeln in Workflows und Schrittvorlagen über die Seite Verwaltung der RICOH ProcessDirector-Schnittstelle angeben.

Beim Anzeigen der Notizbücher der Merkmale für diese Objekte werden Symbolformeln immer in ihrem Symbolformelformat angezeigt, beispielsweise mit ${Job.InputFile} als Wert für das Merkmal Jobname. In dem Notizbuch der Merkmale für einen Job, der einen Workflow mit Schritten benutzt, in denen Symbolformeln angegeben sind, werden die betreffenden Jobmerkmale mit ihren ausgewerteten Werten der Formeln angezeigt. Beispielsweise wird als Wert des Merkmals Jobname der tatsächliche Name der Eingabedatei angezeigt (z. B. reports.pdf).

Mehrere Formelebenen

Die Auswertung von Formeln kann sich auf eine Gruppe zusammengehöriger Formeln erstrecken. Beispiel:

• Job.Name=${Job.Description}
• Job.Description=${Job.CustomerName}
• Job.CustomerName=${Job.Locations}

In diesem Fall, wenn das Jobmerkmal Job.Locations einen Wert hat, legt RICOH ProcessDirector den Wert des Merkmals Job.CustomerName fest. Dies wiederum ermöglicht RICOH ProcessDirector, den Wert des Merkmals Job.Description und dann den Wert des Merkmals Job.Name festzulegen.

Rückwirkende Formeln

Eine rückwirkende Formel ist eine Formel, bei der ein Merkmal einen Wert von einer Symbolformel erhält und dann benutzt wird, um einen Wert für ein anderes zugehöriges Merkmal bereitzustellen. Beispiel:

• Job.Name=${Job.Description}
• Job.Description=${Job.CustomerName}
• Job.CustomerName=${Job.Name}

RICOH ProcessDirector unterstützt diese Verwendung nicht und gibt eine Fehlermeldung aus.

Maximale Tiefe für mehrere Formelebenen

Im Beispiel für mehrere Formelebenen ist die Formeltiefe drei. RICOH ProcessDirector unterstützt eine Tiefe von bis zu 99 zusammengehörigen Formeln. gibt eine Fehlernachricht aus, wenn eine Formeltiefe feststellt, die größer als 99 ist.

Benutzung positionsgebundener Merkmale in Symbolformeln zum Festlegen von Werten für nicht positionsgebundene Jobmerkmale

Positionsgebundene Merkmale sind Merkmale, die in mehreren Phasen und Schritten vorkommen und an jeder Stelle einen anderen Wert haben können. Ein Administrator kann einen Workflow beispielsweise so konfigurieren, dass das Jobmerkmal Gültige Rückkehrcodes des Schritts RunExternalProgram in mehreren Phasen und Schritten im Workflow zu sehen ist und jedes Mal einen anderen Wert hat. Die Namen der Phasen und Schritte werden als Namen der Abschnitte des Notizbuchs der Jobmerkmale mit den einzelnen Merkmalnamen und -Werten für jede Instanz, die in ihrem eigenen Abschnitt angezeigt wird, angegeben. RICOH ProcessDirector erlaubt die Verwendung von positionsgebundenen Merkmalen in Symbolformeln nicht, mit denen Werte für nicht positionsgebundene Merkmale festgelegt werden, da es keinen Mechanismus gibt, mit dem angegeben werden kann, welches Vorkommen des positionsgebundenen Merkmals zu verwenden ist.

Benutzung positionsgebundener Merkmale in Symbolformeln zum Festlegen von Werten für andere positionsgebundene Jobmerkmale

Positionsgebundene Merkmale können Symbolformeln verwenden, in denen andere positionsgebundene Merkmale angegeben sind. RICOH ProcessDirector sucht den Wert des positionsgebundenen Merkmals, das in der Symbolformel ausgewertet ist, in der Phase und in dem Schritt, in der/dem das anfordernde positionsgebundene Merkmal angegeben ist.

Vorrangstellung von Merkmalwerten, die mit Symbolformeln festgelegt wurden

Sind mehrere Methoden zur Angabe eines Werts für dasselbe Merkmal vorhanden, benutzt RICOH ProcessDirector immer den in der Symbolformel angegebenen Wert. Wenn eine Symbolformel für einen Merkmalwert vorhanden ist, geht RICOH ProcessDirector wie folgt vor:

• Löscht alle in einer Steuerdatei angegebenen Werte.

  Nehmen wir beispielsweise an, dass der Workflow ${Job.InputFile} als Wert des Merkmals Jobname angibt, und eine Steuerdatei wie /aiw/aiw1/control_files/rules/ (Linux) oder C:\aiw\aiw1\control_files\rules\ (Windows)receive_lpd_pdf_jobtype.cfg Folgendes angibt: DEFINE ${Job.Name} AS "${ORIGHOST}".

  RICOH ProcessDirector setzt den Wert des Merkmals Jobname auf den Namen der Eingabedatei für den Job und nicht auf den im Parameter ORIGHOST für den Job angegebenen Wert.

• Löscht alle explizit angegebenen Werte in dem Notizbuch der Merkmale für ein Jobmerkmal, dessen Wert der Workflow standardmäßig über eine Symbolformel festlegt. Soll ein explizit angegebener Wert verwendet werden, muss die Symbolformel aus dem Workflow gelöscht und der Job erneut verarbeitet werden.

Auswertung von Symbolformeln

RICOH ProcessDirector wertet die Syntax und den Inhalt der Symbolformel aus und gibt Nachrichten für Fehlerbedingungen aus. Beispielsweise würde sowohl Beispielsweise würde sowohl Job.Description=${Job.CustomerName als auch Job.Description=${Job.XYZ} zu Fehlern führen, weil im ersten Beispiel ein Syntaxfehler durch eine fehlende rechte geschweifte Klammer aufgetreten und im zweiten Beispiel der Name des Jobmerkmals nicht bekannt ist.