Notação simbólica do RICOH ProcessDirector

Sintaxe Simbólica

No RICOH ProcessDirector, essa é a sintaxe básica de um símbolo que pode ser utilizada em fórmulas simbólicas:

Nome corresponde ao nome da propriedade do banco de dados no RICOH ProcessDirector ou a um parâmetro que é enviado com a tarefa. O RICOH ProcessDirector avalia os parâmetros que são enviados com uma tarefa por meio de um arquivo de controle como um arquivo de regras que analisa os parâmetros e valores JCL. Nome também pode ser um método no RICOH ProcessDirector, como getFileName, getAbsoluteFileName, getControlFileName ou getChildFileName. O valor Nome faz distinção entre maiúsculas e minúsculas.

Exemplos

${Get*Method}

Este símbolo faz com que o RICOH ProcessDirector use um método interno e retorne um valor avaliado. Para ver como o RICOH ProcessDirector pode usar este tipo de símbolo, veja a etapa RunExternalProgram na fase Preparar do fluxo de trabalho de PDF. A etapa RunExternalProgram especifica essa propriedade do comando External:

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

O símbolo ${getControlFileName()} instrui o RICOH ProcessDirector a copiar o modelo de arquivo de controle externo no subdiretório tmp do diretório de spool e a resolver todos os símbolos que o modelo de arquivo de controle contém.

A etapa RunExternalProgram na fase Preparar do fluxo de trabalho de PDF especifica essa propriedade do Modelo de arquivo de controle externo:

/aiw/aiw1/control_files/external_programs/job_info.cfg no AIX ou Linux ou C:\aiw\aiw1\control_files\external_programs\job_info.cfg no Windows

Quando o RICOH ProcessDirector cria a tarefa que utiliza o fluxo de trabalho e configura seus valores de propriedade iniciais, ele utiliza o valor que o método getControlFileName retornou para resolver o comando externo da seguinte maneira:

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

${Job.nome da propriedade}

Este símbolo faz com que o RICOH ProcessDirector consulte seu banco de dados quanto ao valor de uma propriedade de tarefa específica do RICOH ProcessDirector.

Para ver como o RICOH ProcessDirector pode usar este tipo de símbolo, consulte o conteúdo do modelo de arquivo de controle job_info.cfg. Esse modelo de arquivo de controle está em /aiw/aiw1/control_files/external_programs no AIX ou Linux ou em C:\aiw\aiw1\control_files\external_programs no Windows.

Quando o RICOH ProcessDirector cria um arquivo de controle a partir desse modelo, ele resolve os valores para os símbolos ${Job.ID}, ${Job.Name}, ${Job.JobType}, ${Job.SubmitTime}, ${Job.RequestedPrinter}, ${Job.InputFile.Size}, ${Job.JobSize}, ${Job.TotalPages} e ${Job.TotalSheets} para as propriedades reais da tarefa do RICOH ProcessDirector. Por exemplo:

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

Obs.:
• Também é possível utilizar qualquer uma das propriedades do sistema em uma fórmula simbólica avaliada pelo RICOH ProcessDirector. Por exemplo, ${WorkflowSystem.Transform.Server.Address}.

${Math}

Esse símbolo faz com que o RICOH ProcessDirector some, subtraia, multiplique ou calcule o módulo de dois valores que podem ser propriedades de tarefa ou números. Ele também pode gerar um número aleatório em um intervalo especificado.

A sintaxe deste símbolo é:

${Math(value1,operador,value2)}

• value1 e value2 são propriedades de tarefa em notação simbólica (como ${Job.CurrentTime}) ou números. Os números poderão conter valores fracionais, como 2,45, se a propriedade que estiver usando a fórmula simbólica tiver suporte para valores de ponto flutuante.
• operador é +, -, * ou mod para soma, subtração, multiplicação e módulo, respectivamente.

Por exemplo, para incluir 5 minutos no horário atual e armazená-lo na propriedade Job.Info.Attr2, use ${Math(${Job.CurrentTime}, +, 5)}.

Somente propriedades que usam valores inteiros, numéricos ou de registro de data e hora podem ser usados nos campos valor nesta fórmula. Somente as propriedades com suporte para valores de notação simbólica podem ser configurados usando essa fórmula.

Se algum dos campos de valor for uma propriedade de registro de data e hora, os únicos operadores suportados serão + e -, e os outros valores terão que ser números inteiros. As unidades do valor inteiro são minutos.

Algumas propriedades parecem ter valores de registro de data e hora (como Job.TimeSubmitted), mas são definidas como cadeias; portanto, não podem ser usadas como valores em um símbolo "Math". O símbolo de Matemática pode ser inserido em campos nos modelos de etapa no Criador do espaço de trabalho, incluindo o modelo de etapa AssignJobValues, e em campos nos blocos de nota de propriedades de tarefa.

Para módulo, valor1 deve ser um número inteiro igual ou maior que 0 e valor2 deve ser um número inteiro igual ou maior que 1.

Para a geração de números aleatórios, a sintaxe desse símbolo é:

• ${Math(rand, valor1, valor)}

Por exemplo, para gerar um número aleatório de 1 a 10, use ${Math(rand, 1, 10)}.

Obs.:
• valor1 e valor2 são propriedades de tarefa em notação simbólica (como ${Job.Copies}) ou números.
• valor1 e valor2 devem ser inteiros iguais ou maiores que zero.
• O resultado retornado é um inteiro entre valor1 e valor2, incluindo os valores em si.
• Os números aleatórios gerados não são criptograficamente aleatórios.

${RulesFileParameter}

Este símbolo faz com que o RICOH ProcessDirector consulte um arquivo de parâmetro que acompanha um arquivo de entrada. Ele consulta um valor de parâmetro específico de outro programa ou produto.

Por exemplo, quando o dispositivo de entrada LPDPDF recebe um arquivo, ele usa o arquivo de controle receive_lpd_pdf_jobtype.cfg para analisar parâmetros que o acompanham.

O arquivo de controle receive_lpd_pdf_jobtype.cfg está localizado neste diretório:

/aiw/aiw1/control_files/rules (Linux)

C:\aiw\aiw1\control_files\rules (Windows)

Um arquivo de controle receive_lpd_pdf_jobtype.cfg pode conter estas informações:

orighost=mywindowshost
origuser=annsmith
origname=TestPDF.pdf

Os símbolos para os valores destes parâmetros são:

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

Para ver como o RICOH ProcessDirector pode utilizar esse tipo de símbolo, consulte o arquivo receive_lpd_pdf_jobtype.cfg neste diretório:

/aiw/aiw1/samples/rules (Linux)

C:\AIW\AIW1\samples\rules (Windows)

Obs.:
• Consulte Sintaxe de arquivos de controle do RICOH ProcessDirector para obter informações mais detalhadas sobre esta implementação.

Observações de Uso para Fórmulas Simbólicas

Estas restrições de uso se aplicam ao uso de fórmulas simbólicas do RICOH ProcessDirector:

Objetos suportados

O RICOH ProcessDirector tem suporte para o uso de fórmulas simbólicas apenas para configurar os valores das propriedades da tarefa. Você não pode utilizar fórmulas simbólicas para configurar valores de propriedade para qualquer outro tipo de objeto, como um dispositivo de entrada ou uma impressora. A fórmula simbólica que o RICOH ProcessDirector avalia para configurar o valor pode ser outra propriedade da tarefa, uma propriedade do servidor principal ou uma chamada de método, como: ${Job.InputFile}, ${Printer.Model} e ${getControlFileName()}. No entanto, uma determinada fórmula simbólica não pode conter uma propriedade da tarefa e uma propriedade do sistema ou uma chamada de método ao mesmo tempo.

Obs.:
• A alteração do valor de uma propriedade do sistema pode afetar muitas fórmulas simbólicas para propriedades da tarefa. Uma vez que o RICOH ProcessDirector atualiza todas as fórmulas simbólicas de uma vez, a operação pode levar algum tempo para ser concluída.

Propriedades excluídas

O RICOH ProcessDirector não tem suporte para a configuração do valor da propriedade Job.Class com uma fórmula simbólica.

Aparência na interface com o usuário do RICOH ProcessDirector

Você pode especificar fórmulas simbólicas em fluxos de trabalho e em modelos de etapa através da página Administração da interface do RICOH ProcessDirector.

Durante a visualização dos blocos de notas da propriedade para esses objetos, as fórmulas simbólicas são sempre exibidas em seu formato de fórmula, como ${Job.InputFile}, como o valor da propriedade Nome da tarefa. No bloco de notas de propriedades de uma tarefa que utiliza um fluxo de trabalho com etapas que especificam fórmulas simbólicas, as propriedades da tarefa afetadas exibem seus valores avaliados a partir das fórmulas. Por exemplo, o valor da propriedade Nome da tarefa é o nome real do arquivo de entrada, como reports.pdf.

Vários níveis de fórmulas

A avaliação de fórmulas pode se estender para um grupo de fórmulas relacionadas. Por exemplo:

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

Neste caso, quando a tarefa Job.Locations tem um valor, o RICOH ProcessDirector configura o valor da propriedade Job.CustomerName. Isso, por sua vez, permite que o RICOH ProcessDirector configure o valor da propriedade Job.Destination e, em seguida, o da propriedade Job.Name.

Fórmulas circulares

Uma fórmula circular é aquela em que a propriedade recebe um valor de uma fórmula simbólica e depois é utilizada para fornecer um valor para outra propriedade relacionada. Por exemplo:

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

O RICOH ProcessDirector não tem suporte para este uso e emite uma mensagem de erro.

Profundidade máxima para vários níveis de fórmulas

Em vários níveis de exemplo de fórmulas, a profundidade de fórmula é três. O RICOH ProcessDirector tem suporte para uma profundidade de até 99 fórmulas relacionadas. Ele emite uma mensagem de erro se encontrar uma profundidade de fórmula superior a 99.

Uso de propriedades posicionais em fórmulas simbólicas para configurar valores para propriedades de tarefa não posicionais

Propriedades posicionais são aquelas que podem aparecer em várias fases e etapas e que podem ter valores diferentes em cada lugar. Por exemplo, um administrador pode configurar um fluxo de trabalho para que a propriedade de tarefa Códigos de retorno válidos na etapa RunExternalProgram apareça em várias fases e etapas no fluxo de trabalho e sempre tenha um valor diferente. Na interface com o usuário atualizada, os nomes da fase e da etapa são os nomes de seções no bloco de notas de propriedade da tarefa com nomes e valores de propriedade individuais para cada instância mostrada em sua própria seção. O RICOH ProcessDirector não permite o uso de propriedades posicionais em fórmulas simbólicas que configuram valores para propriedades não posicionais, pois não há mecanismo para especificar qual ocorrência da propriedade posicional será usada.

Uso de propriedades posicionais em fórmulas simbólicas para configurar valores para outras propriedades de tarefa

As propriedades posicionais podem usar fórmulas de símbolo que especificam outras propriedades posicionais. O RICOH ProcessDirector procura pelo valor da propriedade posicional que será avaliado na fórmula simbólica na mesma fase e etapa especificada pela propriedade posicional solicitante.

Precedência de valores da propriedade configurados por fórmulas simbólicas

Quando existem vários métodos que especificam um valor para a mesma propriedade, o RICOH ProcessDirector sempre utiliza o valor especificado pela fórmula simbólica. Quando há uma fórmula simbólica para um valor de propriedade, o RICOH ProcessDirector efetua o seguinte:

• Descarta qualquer valor especificado em um arquivo de controle.

  Por exemplo, suponha que o fluxo de trabalho especifique ${Job.InputFile} como o valor da propriedade Nome da tarefa e um arquivo de controle, como /aiw/aiw1/control_files/rules/ (AIX e Linux) ou C:\aiw\aiw1\control_files\rules\ (Windows)receive_lpd_pdf_jobtype.cfg, especifique: DEFINE ${Job.Name} AS "${ORIGHOST}".

  O RICOH ProcessDirector define o valor da propriedade Nome da tarefa como o nome do arquivo de entrada para a tarefa, não como o valor especificado pelo parâmetro ORIGHOST.

• Descarta qualquer valor especificado explicitamente no bloco de notas de propriedades da tarefa para uma propriedade da tarefa que o fluxo de trabalho padroniza com uma fórmula simbólica. Você deve excluir a fórmula de símbolo do fluxo de trabalho e processar a tarefa novamente para usar um valor explicitamente especificado.

Validação de fórmulas simbólicas

O RICOH ProcessDirector valida a sintaxe e o conteúdo da fórmula simbólica e emite mensagens para condições de erros. Por exemplo, essas duas fórmulas resultariam em erros: Job.Description=${Job.CustomerName e Job.Description=${Job.XYZ} O primeiro exemplo é um erro de sintaxe sem chave de fechamento, e o segundo é um nome de propriedade de tarefa desconhecido.