Notación de símbolos de RICOH ProcessDirector

Puede utilizar la notación de símbolos de RICOH ProcessDirector en fórmulas para describir el origen de información que RICOH ProcessDirector evalúa para definir el valor de una propiedad de trabajo.

Sintaxis de símbolo

En RICOH ProcessDirector, esta es la sintaxis básica de un símbolo, que puede utilizar en fórmulas de símbolos:

${Name}

Name es un nombre de propiedad de base de datos en RICOH ProcessDirector o un parámetro que se pasa con el trabajo. RICOH ProcessDirector evalúa los parámetros que se pasan con un trabajo mediante un archivo de control, como un archivo de reglas que analiza los parámetros y valores JCL. Nombre también puede ser un método en RICOH ProcessDirector como, por ejemplo getFileName, getAbsoluteFileName, getControlFileName o getChildFileName. El valor Nombre es sensible a las mayúsculas y minúsculas.

Ejemplos

${Get*Method}
Este símbolo hace que RICOH ProcessDirector llame a un método interno y devuelva un valor evaluado. Para ver cómo puede utilizar RICOH ProcessDirector este tipo de símbolo, consulte el paso RunExternalProgram de la Fase de preparación del flujo de trabajo PDF. En el paso RunExternalProgram se especifica la propiedad Mandato externo:
  • Linux: cp ${getControlFileName()} /aiw/aiw1/samples/${Job.ID}.info.csv
  • Windows: copy ${getControlFileName()} C:\aiw\aiw1\samples\${Job.ID}.info.csv

El símbolo ${getControlFileName()} indica a RICOH ProcessDirector copiar la plantilla del archivo de control externo al subdirectorio tmp del directorio de spool y resuelve todos los símbolos que contiene el archivo de control.

El paso RunExternalProgram de la Fase de preparación del flujo de trabajo PDF especifica la propiedad Plantilla del archivo de control externo:

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

Cuando RICOH ProcessDirector crea el trabajo que utiliza el flujo de trabajo y establece sus valores de propiedad iniciales, utiliza el valor que devolvió el método getControlFileName para resolver el mandato externo en:

  • 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.PropertyName}
Este símbolo hace que RICOH ProcessDirector consulte su base de datos para obtener el valor de una propiedad de trabajo RICOH ProcessDirector específica.

Para ver cómo puede utilizar RICOH ProcessDirector este tipo de símbolo, revise el contenido de la plantilla del archivo de control job_info.cfg. Esta plantilla del archivo de control se encuentra en /aiw/aiw1/control_files/external_programs en Linux o en C:\aiw\aiw1\control_files\external_programs en Windows.

Cuando RICOH ProcessDirector crea un archivo de control a partir de esta plantilla, resuelve los valores de estos símbolos de acuerdo con las propiedades de trabajo de RICOH ProcessDirector reales que representan: ${Job.ID}${Job.Name}${Job.JobType}${Job.SubmitTime}${Job.RequestedPrinter}${Job.InputFile.Size}${Job.JobSize}${Job.TotalPages}${Job.TotalSheets} Por ejemplo: 

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

    Nota:
  • También puede utilizar cualquiera de las propiedades del sistema en la fórmula de símbolos que RICOH ProcessDirector evalúa. Por ejemplo, ${WorkflowSystem.Transform.Server.Address}.
${Math}
Este símbolo hace que RICOH ProcessDirector sume, reste, multiplique o calcule el módulo de dos valores que pueden ser propiedades de trabajo o números. También puede generar un número aleatorio en un intervalo específico.
La sintaxis de este símbolo es:

${Math(valor1,operador,valor2)}

  • valor1 y valor2 son las propiedades de trabajo en notación simbólica (como ${Job.CurrentTime}) o números. Los números pueden contener valores fraccionales, como 2,45, si la propiedad que utiliza la fórmula de símbolos es compatible con valores de coma flotante.
  • operador es +, -, * o mod para suma, resta, multiplicación o módulo respectivamente.

Por ejemplo, para sumar 5 minutos al tiempo actual y almacenarlo en la propiedad Job.Info.Attr2, utilice ${Math(${Job.CurrentTime}, +, 5)}.

Sólo los propiedades que utilizan valores enteros, numéricos o de indicación de fecha se pueden usar en los campos valor de esta fórmula. Sólo las propiedades compatibles con valores de notación de símbolos se pueden establecer utilizando esta fórmula.
Si cualquier valor es una propiedad de indicación de fecha, los únicos operadores compatibles con + y -, y el otro valor debe ser un entero. Las unidades del valor entero son minutos.
Algunas propiedades parecen tener valores de indicación de fecha (como Job.TimeSubmitted), pero se definen como series, por lo que no se pueden utilizar como valores en un símbolo Math. El símbolo Math se puede introducir en campos de plantillas de pasos en el creador de flujos de trabajo, incluida la plantilla de pasos AssignJobValues, y en campos del cuaderno de propiedades de trabajo.
Para módulo, valor1 debe ser un número entero que sea 0 o mayor y valor2 debe ser un número entero que sea 1 o mayor.
Para generación de números aleatorios, la sintaxis de este símbolo es:
  • ${Math(rand, valor1, valor2)}
Por ejemplo, para generar un número aleatorio de 1 a 10, utilice ${Math(rand, 1, 10)}.
    Nota:
  • valor1 y valor2 son las propiedades de trabajo en notación simbólica (como ${Job.Copies}) o números.
  • valor1 y valor2 deben ser números enteros que sean cero o mayores.
  • El resultado devuelto es un número entero entre valor1 y valor2, ambos incluidos.
  • Los números aleatorios que se generan no son criptográficamente aleatorios.
${RulesFileParameter}
Este símbolo hace que RICOH ProcessDirector consulte un archivo de parámetros incluido con un archivo de entrada. Consulta un valor de parámetro específico a otro programa o producto.

Por ejemplo, cuando el dispositivo de entrada LPDPDF recibe un archivo de entrada, utiliza el archivo de control receive_lpd_pdf_jobtype.cfg para analizar los parámetros que acompañan al archivo de entrada.

El archivo de control receive_lpd_pdf_jobtype.cfg se encuentra en este directorio:

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

(Linux)

(Windows)

Un archivo de control receive_lpd_pdf_jobtype.cfg puede contener esta información:

orighost=mywindowshost
origuser=annsmith
origname=TestPDF.pdf

Los símbolos para estos valores de parámetros son:

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

Para ver cómo puede utilizar RICOH ProcessDirector este tipo de símbolo, revise el archivo receive_lpd_pdf_jobtype.cfg en este directorio:

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

Notas de uso para fórmulas de símbolos

Estas restricciones de uso se aplican a la utilización de fórmulas de símbolos de RICOH ProcessDirector:

Objetos soportados
RICOH ProcessDirector sólo soporta el uso de fórmulas de símbolos para definir los valores de las propiedades de trabajo. No puede utilizar fórmulas de símbolos para definir valores de propiedad de ningún otro tipo de objeto, como por ejemplo un dispositivo de entrada. La fórmula de símbolos que evalúa RICOH ProcessDirector para establecer el valor puede ser otra propiedad de trabajo, una propiedad de servidor primario o una llamada de método, por ejemplo: ${Job.InputFile}, ${Printer.Model} y ${getControlFileName()}. No obstante, una fórmula de símbolos concreta no puede contener una propiedad de trabajo y una propiedad de sistema o una llamada a método al mismo tiempo.
    Nota:
  • El cambio del valor de una propiedad de sistema podría afectar a muchas fórmulas de símbolos de las propiedades de trabajo. Dado que RICOH ProcessDirector actualiza todas las fórmulas de símbolos al mismo tiempo, la operación puede tardar un periodo largo de tiempo en completarse.
Propiedades excluidas
RICOH ProcessDirector no admite la definición del valor de la propiedad Job.Class con una fórmula de símbolos.
Apariencia en la interfaz de usuario de RICOH ProcessDirector
Puede especificar fórmulas de símbolos en flujos de trabajo y plantillas de pasos a través de la página Administración de la interfaz de RICOH ProcessDirector.

Al visualizar los cuadernos de propiedades de estos objetos, las fórmulas de símbolos siempre se muestran en su formato de fórmula, por ejemplo, ${Job.InputFile} como el valor de la propiedad Nombre de trabajo. En el cuaderno de propiedades de un trabajo que utiliza un flujo de trabajo con pasos que especifican las fórmulas de símbolos, las propiedades de trabajo afectadas muestran sus valores evaluados a partir de las fórmulas. Por ejemplo, el valor de la propiedad Nombre de trabajo es el nombre real del archivo de entrada, por ejemplo reports.pdf.

Múltiples niveles de fórmulas
La evaluación de fórmulas puede ampliarse a un grupo de fórmula relacionadas. Por ejemplo:
  • Job.Name=${Job.Description}
  • Job.Description=${Job.CustomerName}
  • Job.CustomerName=${Job.Locations}
En este caso, cuando la propiedad de trabajo Job.Locations tiene un valor, RICOH ProcessDirector establece el valor de la propiedad Job.CustomerName. Esto, a su vez, permite que RICOH ProcessDirector defina el valor de la propiedad Job.Description y, a continuación, de la propiedad Job.Name.
Fórmulas circulares
Una fórmula circular es aquélla en que una propiedad recibe un valor de una fórmula de símbolos y después se utiliza para proporcionar un valor para otra propiedad relacionada. Por ejemplo:
  • Job.Name=${Job.Description}
  • Job.Description=${Job.CustomerName}
  • Job.CustomerName=${Job.Name}

RICOH ProcessDirector no soporta este uso y emite un mensaje de error.

Profundidad máxima para múltiples niveles de fórmulas
En el ejemplo de múltiples niveles de fórmulas, la profundidad de la fórmula es tres. RICOH ProcessDirector admite una profundidad de hasta 99 fórmulas relacionadas. Emite un mensaje de error si encuentra una profundidad de fórmula mayor que 99.
Utilización de propiedades posicionales en fórmulas de símbolos para definir los valores de las propiedades de trabajo no posicionales
Las propiedades posicionales son propiedades que pueden aparecen en varias fases y pasos y que pueden tener distintos valores en cada lugar. Por ejemplo, un administrador puede configurar un flujo de trabajo para que la propiedad de trabajo Códigos de retorno válidos del paso RunExternalProgram aparezca en varias fases y pasos del flujo de trabajo y tenga un valor distinto cada vez. Los nombres de fases y pasos son los nombres de secciones del cuaderno de propiedades de trabajo con los nombres de propiedad individuales y los valores para cada instancia en su propia sección. RICOH ProcessDirector no permite utilizar las propiedades posicionales en fórmulas de símbolos que establecen valores para propiedades no posicionales, porque no existe ningún mecanismo para especificar el valor de la propiedad posicional que se debe utilizar.
Utilización de propiedades posicionales en fórmulas de símbolos para definir los valores de otras propiedades de trabajo posicionales
Las propiedades posicionales pueden utilizar fórmulas de símbolos que especifican otras propiedades posicionales. RICOH ProcessDirector busca el valor de la propiedad posicional que evalúa en la fórmula de símbolos en la misma fase y el mismo paso que especifica la propiedad posicional que realiza la solicitud.
Prioridad de los valores de propiedad definidos mediante fórmulas de símbolos
Si existen varios métodos que especifican un valor para la misma propiedad, RICOH ProcessDirector siempre utiliza el valor que especifica la fórmula de símbolos. Si existe una fórmula de símbolos para un valor de propiedad, RICOH ProcessDirector hace lo siguiente:
  • Descarta cualquier valor especificado en un archivo de control.

    Por ejemplo, si el flujo de trabajo especifica ${Job.InputFile} como el valor de la propiedad Nombre de trabajo y un archivo de control, como /aiw/aiw1/control_files/rules/ (Linux) o C:\aiw\aiw1\control_files\rules\ (Windows)receive_lpd_pdf_jobtype.cfg, especifica: DEFINE ${Job.Name} AS "${ORIGHOST}".

    RICOH ProcessDirector establece el valor de la propiedad Nombre de trabajo del archivo de entrada del trabajo y no el valor que especifica el parámetro ORIGHOST para el trabajo.

  • Descartar cualquier valor especificado explícitamente en el cuaderno de propiedades del trabajo para una propiedad de trabajo que utiliza por omisión el flujo de trabajo con una fórmula de símbolos. Debe suprimir la fórmula de símbolos del flujo de trabajo y volver a procesar el trabajo para utilizar un valor especificado explícitamente.
Validación de fórmulas de símbolos
RICOH ProcessDirector valida la sintaxis y el contenido de la fórmula de símbolos y emite mensajes para los condiciones de error. Por ejemplo, los dos siguientes darían lugar a errores: Job.Description=${Job.CustomerName y Job.Description=${Job.XYZ} El primer ejemplo es un error de sintaxis porque no tienen llaves de cierre y el segundo ejemplo es un nombre de propiedad de trabajo desconocido.

Related information:

Uso de los métodos RICOH ProcessDirector
Sintaxis para los archivos de control de RICOH ProcessDirector
RunExternalProgram
Nombres de propiedad de base de datos
Configuración de plantillas de pasos para ejecutar pasos externos que utilizan la línea de mandatos o archivos de control
Configuración de plantillas de pasos para ejecutar pasos externos que utilizan carpetas activas
Tema principal: Integración con otras aplicaciones