Notation des symboles RICOH ProcessDirector

Les utilisateurs autorisés peuvent utiliser la notation des symboles RICOH ProcessDirector dans des formules pour décrire la source d'information analysée par RICOH ProcessDirector afin de définir la valeur d'une propriété de travail.

Syntaxe des symboles

Dans RICOH ProcessDirector, il s'agit de la syntaxe de base d'un symbole que vous pouvez utiliser dans les formules de symboles :

${Nom}

Nom est un nom de propriété de base de données dans RICOH ProcessDirector ou un paramètre transmis avec le travail. RICOH ProcessDirector évalue les paramètres transmis avec un travail via un fichier de contrôle, comme un fichier de règles qui analyse les valeurs et les paramètres JCL. Nom peut également correspondre à une méthode dans RICOH ProcessDirector, comme getFileName, getAbsoluteFileName, getControlFileName ou getChildFileName. La valeur Nom est sensible à la casse.

Exemples

${Get*Method}
Si vous indiquez ce symbole, RICOH ProcessDirector appellera une méthode interne et renverra une valeur analysée. Pour savoir comment RICOH ProcessDirector peut utiliser ce type de symbole, consultez l'étape RunExternalProgram de la phase Préparer du flot de travaux PDF. L'étape RunExternalProgram spécifie cette propriété Commande externe :
  • Linux : cp ${getControlFileName()} /aiw/aiw1/samples/${Job.ID}.info.csv
  • Windows : copy ${getControlFileName()} C:\aiw\aiw1\samples\${Job.ID}.info.csv

Le symbole ${getControlFileName()} indique à RICOH ProcessDirector de copier le modèle de fichier de contrôle externe dans le sous-répertoire tmp du répertoire spoule et de résoudre les symboles éventuels contenus dans le fichier de contrôle.

L'étape RunExternalProgram de la phase Préparer du flot de travaux PDF spécifie cette propriété Modèle de fichier de contrôle externe :

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

Lorsqu'RICOH ProcessDirector crée le travail qui utilise le flot de travaux et définit ses valeurs de propriété initiales, il utilise la valeur renvoyée par la méthode getControlFileName pour émettre la commande externe :

  • 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.nom_propriété}
Si vous indiquez ce symbole, RICOH ProcessDirector interroge sa base de données pour y rechercher la valeur d'une propriété de travail RICOH ProcessDirector spécifique.

Pour savoir comment RICOH ProcessDirector peut utiliser ce type de symbole, consultez le modèle de fichier de contrôle job_info.cfg. Ce modèle de fichier de contrôle se trouve dans /aiw/aiw1/control_files/external_programs sous Linux ou C:\aiw\aiw1\control_files\external_programs sous Windows.

Lorsqu'RICOH ProcessDirector crée un fichier de contrôle à partir de ce modèle, il fait correspondre les valeurs des symboles ${Job.ID}, ${Job.Name}, ${Job.JobType}, ${Job.SubmitTime}, ${Job.RequestedPrinter}, ${Job.InputFile.Size}, ${Job.JobSize}, ${Job.TotalPages} et ${Job.TotalSheets} aux propriétés de travail RICOH ProcessDirector réelles. Par exemple : 

${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

    Remarque:
  • Vous pouvez également utiliser les propriétés système d'une formule de symboles analysée par RICOH ProcessDirector. Par exemple, ${WorkflowSystem.Transform.Server.Address}.
${Math}
Si vous indiquez ce symbole, RICOH ProcessDirector ajoute, soustrait, multiplie ou calcule le module de deux valeurs qui peuvent être des propriétés de travail ou des nombres. Il peut également générer un nombre aléatoire dans une plage spécifiée.
La syntaxe de ce symbole est la suivante :

${Math(valeur1,opérateur,valeur2)}

  • Valeur1 et valeur2 sont les propriétés du travail en notation symbolique (comme ${Job.CurrentTime}) ou des nombres. Les nombres peuvent contenir des valeurs fractionnaires, comme 2,45, si la propriété utilisant la formule de symbole prend en charge les valeurs à virgule flottante.
  • opérateur est +, -, * ou mod pour l'addition, la soustraction, la multiplication et le module, respectivement.

Par exemple, pour ajouter 5 minutes à l'heure actuelle et les stocker dans la propriété Job.Info.Attr2 property, use ${Math(${Job.CurrentTime}, +, 5)}.

Seules les propriétés qui utilisent des entiers, des valeurs numériques ou des valeurs d'horodatage peuvent être utilisées dans les champs valeur de cette formule. Seules les propriétés qui prennent en charge les valeurs en notation symbolique peuvent être définies à l'aide de cette formule.
Si valeur est une propriété d'horodatage, seuls les opérateurs + et -sont pris en charge, et l'autre valeur doit être un entier. La valeur entière est exprimée en minutes.
Certaines propriétés semblent avoir des valeurs d'horodatage (telles que Job.TimeSubmitted) mais sont définies comme des chaînes, de sorte qu'elles ne peuvent pas être utilisées comme des valeurs dans un symbole mathématique. Le symbole mathématique peut être entré dans les champs des modèles d'étape dans le Générateur de flots de travaux, y compris le modèle d'étape AssignJobValues, et dans les champs des blocs-notes de propriétés des travaux.
Pour le module, valeur1 doit être un nombre entier supérieur ou égal à 0 et valeur2 doit être un nombre entier supérieur ou égal à 1.
Pour la génération de nombres aléatoires, la syntaxe de ce symbole est la suivante :
  • ${Math(rand, valeur1, valeur2)}
Par exemple, pour générer un nombre aléatoire compris entre 1 et 10, utilisez ${Math(rand, 1, 10)}.
    Remarque:
  • valeur1 et valeur2 sont les propriétés du travail en notation symbolique (comme ${Job.Copies}) ou des nombres.
  • valeur1 et valeur2 doivent être des entiers supérieurs ou égaux à zéro.
  • Le résultat renvoyé est un nombre entier compris entre valeur1 et valeur2 incluses.
  • Les nombres aléatoires générés ne sont pas cryptographiquement aléatoires.
${Paramètre_fichier_règles}
Si vous indiquez ce symbole, RICOH ProcessDirector interroge un fichier de paramètres accompagnant le fichier en entrée. Il y recherche une valeur de paramètre spécifique à un autre programme ou produit.

Par exemple, lorsque l'unité d'entrée LPDPDF reçoit un fichier en entrée, elle utilise le fichier de contrôle receive_lpd_pdf_jobtype.cfg pour effectuer l'analyse syntaxique des paramètres accompagnant le fichier en entrée.

Le fichier de contrôle receive_lpd_pdf_jobtype.cfg se trouve dans le répertoire suivant :

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

(Linux)

(Windows)

Un fichier de contrôle receive_lpd_pdf_jobtype.cfg peut contenir les informations suivantes :

orighost=mywindowshost
origuser=annsmith
origname=TestPDF.pdf

Les symboles de ces valeurs de paramètres sont les suivants :

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

Pour voir comment RICOH ProcessDirector peut utiliser ce type de symbole, passez en revue le fichier receive_lpd_pdf_jobtype.cfg dans le répertoire suivant :

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

Remarques sur les formules de symboles

Les restrictions d'utilisation suivantes s'appliquent aux formules de symboles utilisées dans RICOH ProcessDirector :

Objets pris en charge
RICOH ProcessDirector prend en charge l'utilisation de formules de symboles uniquement pour définir les valeurs des propriétés du travail. Vous ne pouvez pas utiliser de formules de symboles pour définir des valeurs de propriétés pour d'autres types d'objets, comme une unité d'entrée ou une imprimante. La formule de symboles qu'RICOH ProcessDirector analyse pour définir la valeur peut être une autre propriété de travail, une propriété de serveur principal ou un appel de méthode, comme : ${Job.InputFile}, ${Printer.Model} et ${getControlFileName()}. Toutefois, une formule de symboles ne peut pas contenir à la fois une propriété de travail et une propriété système ou un appel de méthode.
    Remarque:
  • Modifier la valeur d'une propriété système peut affecter de nombreuses formules de symboles des propriétés de travail. L'opération peut prendre un certain temps car RICOH ProcessDirector met à jour toutes les formules de symboles en même temps.
Propriétés exclues
RICOH ProcessDirector ne peut pas définir la valeur de la propriété Job.Class à l'aide d'une formule de symboles.
Affichage dans l'interface utilisateur RICOH ProcessDirector
Vous pouvez indiquer des formules de symboles dans les flots de travaux et les modèles d'étape via la page d'administration de l'interface RICOH ProcessDirector.

Dans les blocs-notes de propriétés relatifs à ces objets, les formules de symboles apparaissent toujours dans le format de formule initial, par exemple ${Job.InputFile} pour la valeur de la propriété Nom du travail. Dans le bloc-notes de propriétés d'un travail dont le flot comporte des étapes qui définissent des formules de symboles, les propriétés affectées affichent les valeurs calculées à partir des formules. Par exemple, la valeur de la propriété Nom du travail correspond au nom effectif du fichier en entrée, comme reports.pdf.

Formules interdépendantes
L'analyse de formules peut s'étendre à un groupe de formules ayant des relations de dépendance. Par exemple :
  • Job.Name=${Job.Description}
  • Job.Description=${Job.CustomerName}
  • Job.CustomerName=${Job.Locations}
Dans ce cas, lorsque la propriété de travail Job.Locations a une valeur, RICOH ProcessDirector définit la valeur de la propriété Job.CustomerName. Celle-ci, à son tour, permet à RICOH ProcessDirector de définir la valeur de la propriété Job.Description, puis celle de la propriété Job.Name.
Formules circulaires
Une formule circulaire est une formule dans laquelle une propriété reçoit une valeur d'une formule de symboles, puis est utilisée pour fournir une valeur à une autre propriété qui lui est liée. Par exemple :
  • Job.Name=${Job.Description}
  • Job.Description=${Job.CustomerName}
  • Job.CustomerName=${Job.Name}

RICOH ProcessDirector ne prend pas en charge cette syntaxe et émet un message d'erreur.

Profondeur maximale pour les formules interdépendantes
Dans l'exemple des formules interdépendantes, la profondeur de formule est de trois. RICOH ProcessDirector prend en charge une profondeur allant jusqu'à 99 formules interdépendantes. Il émet un message d'erreur en cas de profondeur de formules supérieure à 99.
Utilisation de propriétés positionnelles dans les formules de symboles afin de définir les valeurs de propriétés de travail non positionnelles
Les propriétés positionnelles sont des propriétés qui peuvent apparaître dans plusieurs phases et étapes et avoir des valeurs différentes à chaque emplacement. Par exemple, un administrateur pourrait configurer un flot de travaux de sorte que la propriété Codes retour valides à l'étape RunExternalProgram apparaisse dans plusieurs phases et étapes du flot de travaux et ait à chaque fois une valeur différente. Les noms de phase et d'étape représentent les noms de sections sur le bloc-notes des propriétés du travail, où les noms et les valeurs de propriété individuelle pour chaque instance sont présentés dans la section correspondante. RICOH ProcessDirector ne prend pas en charge l'utilisation des propriétés positionnelles dans les formules de symboles qui définissent les valeurs de propriétés non positionnelles, car aucun mécanisme n'indique l'occurrence de la propriété positionnelle à utiliser.
Utilisation de propriétés positionnelles dans les formules de symboles afin de définir les valeurs d'autres propriétés de travail positionnelles
Les propriétés positionnelles peuvent utiliser des formules de symboles qui spécifient d'autres propriétés positionnelles. RICOH ProcessDirector recherche la valeur de la propriété positionnelle, qu'il évalue dans la formule de symboles, dans la phase et l'étape spécifiées par la propriété positionnelle à l'origine de la demande.
Présence des valeurs de propriétés définies par des formules de symboles
Lorsqu'il existe plusieurs méthodes qui spécifient une valeur pour la même propriété, RICOH ProcessDirector utilise toujours la valeur spécifiée par la formule de symboles. Lorsqu'il existe une formule de symboles pour une valeur de propriété, RICOH ProcessDirector effectue les actions suivantes :
  • Élimine toute valeur définie dans un fichier de contrôle.

    Par exemple, si le flot de travaux définit ${Job.InputFile} comme valeur pour la propriété Nom du travail et qu'un fichier de contrôle, tel que /aiw/aiw1/control_files/rules/ (Linux) ou C:\aiw\aiw1\control_files\rules\ (Windows)receive_lpd_pdf_jobtype.cfg, indique : DEFINE ${Job.Name} AS "${ORIGHOST}".

    RICOH ProcessDirector attribue à la valeur de la propriété Nom du travail le nom du fichier en entrée associé au travail, et non la valeur définie par le paramètre ORIGHOST du travail.

  • Éliminer toute valeur de propriété de travail indiquée explicitement dans le bloc-notes de propriétés d'un travail et à laquelle le flot de travaux attribue par défaut une formule de symboles. Vous devez supprimer la formule de symboles du flot de travaux et traiter à nouveau le travail pour qu'une valeur indiquée explicitement soit utilisée.
Validation des formules de symboles
RICOH ProcessDirector valide la syntaxe et le contenu de la formule de symboles et émet des messages en cas d'erreur. Ainsi, les deux exemples suivants généreraient une erreur : Job.Description=${Job.CustomerName et Job.Description=${Job.XYZ}. Le premier, en raison d'une erreur de syntaxe (absence de parenthèse fermante) et le second parce que la formule contient un nom de propriété de travail inconnu.

Related information:

Utilisation des méthodes RICOH ProcessDirector
Syntaxe des fichiers de contrôle RICOH ProcessDirector
RunExternalProgram
Noms des propriétés de base de données
Configuration de modèles d'étape externe utilisant une ligne de commande ou un fichier de contrôle
Configuration des modèles d'étape pour les étapes externes utilisant des dossiers prioritaires.
Rubrique parente : Intégration avec d'autres applications