RICOH ProcessDirectorシンボル表記

式でRICOH ProcessDirectorシンボルの表記を使用して、RICOH ProcessDirectorがジョブプロパティーの値を設定するために評価する情報源を記述することができます。

シンボルの構文

RICOH ProcessDirectorでは、これはシンボル式で使用できるシンボルの基本構文です。

${Name}

NameはRICOH ProcessDirectorのデータベースプロパティー名またはジョブで渡されるパラメーターです。 RICOH ProcessDirectorは、JCLのパラメーターおよび値を解析する規則ファイルなどの制御ファイルを使用して、ジョブで渡されるパラメーターを評価します。また、NameをRICOH ProcessDirectorメソッド（ getFileName、 getAbsoluteFileName、 getControlFileName、 getChildFileNameなど）にすることもできます。Name の値には大/小文字の区別があります。

例

${Get*Method}
このシンボルにより、RICOH ProcessDirectorは内部メソッドを呼び出し、評価された値を返します。どのようにRICOH ProcessDirectorがこのタイプのシンボルを使用するかを調べるには、PDFワークフローの準備フェーズ内の RunExternalProgramステップを参照してください。 RunExternalProgram ステップは、この 外部コマンドプロパティーを指定します。
  • Windows: copy ${getControlFileName()} C:\aiw\aiw1\samples\${Job.ID}.info.csv

${getControlFileName()}シンボルは、外部制御ファイルテンプレートをspoolディレクトリのtmpサブディレクトリーにコピーし、制御ファイルに含まれるすべてのシンボルを解決するようにRICOH ProcessDirectorに命令します。

PDF ワークフローの準備フェーズ内の RunExternalProgram ステップは、この 外部制御ファイルテンプレー」プロパティーを指定します。

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

RICOH ProcessDirectorがワークフローを使用して初期プロパティー値を設定するジョブを作成する際に、 getControlFileNameメソッドによって返された値を使用して外部コマンドを次のように解決します。

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

${Job.PropertyName}
このシンボルにより、RICOH ProcessDirectorは特定のRICOH ProcessDirectorジョブプロパティーの値についてDB2データベースを照会します。

どのようにRICOH ProcessDirectorがこのタイプのシンボルを使用できるかを調べるには、 job_info.cfg制御ファイルテンプレートの内容を参照してください。この制御ファイルテンプレートは、 C:\aiw\aiw1\control_files\external_programs にあります。

RICOH ProcessDirectorがこのテンプレートから制御ファイルを作成すると、${Job.ID}、${Job.Name}、${Job.JobType}、${Job.SubmitTime}、${Job.RequestedPrinter}、${Job.InputFile.Size}、${Job.JobSize}、${Job.TotalPages}、および${Job.TotalSheets} の各シンボルの値を実際のRICOH ProcessDirectorジョブプロパティーに解決します。例： 

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

    注意:
  • また、RICOH ProcessDirectorが評価するシンボル式で、任意のシステムプロパティーを使用することもできます。たとえば、 ${WorkflowSystem.Transform.Server.Address} などです。
${Math}
このシンボルがある場合、RICOH ProcessDirectorは、2つの値（ジョブプロパティーまたは数字）の加算、減算、乗算、または係数の計算を実行できます。また、指定された範囲で乱数を生成することもできます。
このシンボル式の構文は、次のとおりです。

${Math(value1,operator,value2)}

  • value1およびvalue2は、シンボル表記に含まれるジョブプロパティー（${Job.CurrentTime}、など）、または数字です。そのシンボル式を使用するプロパティーが浮動小数点値をサポートする場合は、数字に2.45などの小数も含めることができます。
  • operatorは、+、-、*、またはmodです（それぞれ加算、減算、乗算、係数を表します）。

たとえば、現在の時刻に 5 分を追加し、それをJob.Info.Attr2プロパティーに保存するには、${Math(${Job.CurrentTime}, +, 5)}を使用します。

この式のvalueフィールドには、整数、数値、またはタイムスタンプ値を使用するプロパティーのみ使用できます。シンボル式をサポートするプロパティーのみ、この式を使用して設定できます。
どちらか一方のvalueがタイムスタンプ値のプロパティーの場合、サポートされる演算子は＋と－のみで、もう一方の値は整数である必要があります。整数値の単位は、分です。
一部のプロパティーにタイムスタンプ値が設定されているように見える場合がありますが（Job.TimeSubmittedなど）、それらは文字列として定義されているため、Mathシンボルの式で値として使用することはできません。Mathシンボルは、ワークフロービルダー内でステップテンプレート（AssignJobValuesステップテンプレートなど）のフィールド、およびジョブプロパティーのノートブックのフィールドに入力できます。
係数の場合、value1は0以上の整数にする必要があり、value2は1以上の整数にする必要があります。
乱数生成の場合、このシンボルの構文は次のようになります。
  • ${Math(rand, value1, value2)}
たとえば、1から10までの乱数を生成するには、${Math(rand, 1, 10)}を使用します。
    注意:
  • value1およびvalue2は、シンボル表記でのジョブプロパティー（${Job.Copies}など）、または数字です。
  • value1とvalue2はゼロ以上の整数である必要があります。
  • 返される結果はvalue1とvalue2の間の整数（指定値も含む）です。
  • 生成される乱数は、暗号論的な乱数ではありません。
${RulesFileParameter}
このシンボルはRICOH ProcessDirectorに、入力ファイルに付随するパラメーターファイルを照会させます。別のプログラムや製品に固有のパラメーター値を照会します。

たとえば、LPDPDF 入力装置は、入力ファイルを受け取ったとき、receive_lpd_pdf_jobtype.cfg 制御ファイルを使用して、入力ファイルに付随するパラメーターを解析します。

receive_lpd_pdf_jobtype.cfg 制御ファイルは、次のディレクトリーにあります。

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

receive_lpd_pdf_jobtype.cfg 制御ファイルには、以下の情報を入れることができます。

orighost=mywindowshost
origuser=annsmith
origname=TestPDF.pdf

これらのパラメーター値のシンボルは、以下のとおりです。

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

どのようにRICOH ProcessDirectorがこのタイプのシンボルを使用できるかを調べるには、このディレクトリーのreceive_lpd_pdf_jobtype.cfgファイルを参照してください。

  • Windows: C:\AIW\AIW1\samples\rules

シンボル式の使用上の注意

RICOH ProcessDirectorシンボル式を使用するとき、次の使用上の制限事項が適用されます。

サポートされるオブジェクト
RICOH ProcessDirectorは、ジョブプロパティーの値を設定するシンボル式の使用のみをサポートしています。入力装置やプリンターなどの他のオブジェクトタイプのプロパティー値を設定するシンボル式を使用することはできません。値を設定するためRICOH ProcessDirectorが評価するシンボル式には、${Job.InputFile}、${Printer.Model}、および${getControlFileName()}などの、別のジョブプロパティー、1次サーバープロパティー、またはメソッド呼び出しにできます。ただし、特定のシンボル式には、ジョブプロパティーとシステムプロパティーまたはメソッド呼び出しの両方を同時に組み込むことはできません。
    注意:
  • システムプロパティーの値を変更すると、ジョブプロパティーの多くのシンボル式が影響を受ける可能性があります。RICOH ProcessDirectorはすべてのシンボル式を同時に更新するため、操作が完了するまで長い時間がかかる場合があります。
除外されるプロパティー
RICOH ProcessDirectorは、シンボル式による Job.Classプロパティーの値の設定をサポートしていません。
RICOH ProcessDirectorユーザーインターフェースの外観
RICOH ProcessDirectorインターフェースの［管理］ページで、ワークフローおよびステップテンプレートにシンボル式を指定できます。

これらのオブジェクトのプロパティーノートブックを表示する場合、シンボル式は常に、${Job.InputFile} などの公式のフォーマットでジョブ名プロパティーの値として表示されます。シンボル式を指定するステップとともにワークフローを使用するジョブのプロパティーノートブックでは、影響を受けるジョブプロパティーに、公式から評価された値が表示されます。たとえば、 ジョブ名プロパティーの値は、reports.pdf などの入力ファイルの実際の名前です。

複数レベルの公式
公式の評価は、関連する公式のグループに拡張することができます。例:
  • Job.Name=${Job.Description}
  • Job.Description=${Job.CustomerName}
  • Job.CustomerName=${Job.Locations}
この場合、 Job.Locationsジョブプロパティーに値があると、RICOH ProcessDirectorは Job.CustomerNameプロパティーの値を設定します。これにより、 RICOH ProcessDirectorは Job.Descriptionプロパティーの値を設定してから、 Job.Nameプロパティーの値を設定できます。
循環式
循環式は、プロパティーがシンボル式から値を受け取る公式で、別の関連プロパティーの値を提供するために使用されます。例:
  • Job.Name=${Job.Description}
  • Job.Description=${Job.CustomerName}
  • Job.CustomerName=${Job.Name}

RICOH ProcessDirectorはこの使用をサポートしていないため、エラーメッセージを出します。

複数レベルの公式の最大の深さ
循環式の例では、公式の深さは 3 でした。 RICOH ProcessDirectorは、99までの深さの関連する式をサポートしています。99 を超える深さの公式が検出されると、エラーメッセージが出されます。
シンボル式で定位置プロパティーを使用し、非定位置ジョブプロパティーの値を設定
定位置プロパティーとは、複数のフェーズおよびステップで使用でき、それぞれの位置で異なる値をとりうるプロパティーです。例えば、管理者は、RunExternalProgramステップの 有効な戻りコードジョブプロパティーをワークフロー内の複数のフェーズおよびステップに置き、それぞれが異なる値になるよう、ワークフローを構成することができます。フェーズおよびステップの名前はジョブプロパティーノートブックのセクションの名前で、各インスタンスに対する個別のプロパティーの名前と値がそれ自体のセクションに表示されます。RICOH ProcessDirectorでは、非定位置プロパティーの値を設定するシンボル式で定位置プロパティーを使用することはできません。これは、定位置プロパティーのどのオカレンスを使用するかを指定するメカニズムがないためです。
シンボル式で定位置プロパティーを使用し、他の定位置ジョブプロパティーの値を設定
定位置プロパティーは他の定位置プロパティーを指定するシンボル式を使用できます。RICOH ProcessDirectorは、要求側の定位置プロパティーが指定している同じフェーズおよびステップで、シンボル式で評価する定位置プロパティーの値を探します。
シンボル式によって設定されるプロパティー値の優先順位
同じプロパティーの値を指定するメソッドが複数存在する場合、RICOH ProcessDirectorは常に、シンボル式が指定する値を使用します。プロパティー値のシンボル式が存在する場合、RICOH ProcessDirectorは以下を行います。
  • 制御ファイルに指定されている値をすべて廃棄します。

    例えば、ワークフローがジョブ名プロパティーの値として${Job.InputFile}を指定していると仮定した場合、C:\aiw\aiw1\control_files\rules\receive_lpd_pdf_jobtype.cfgなどの制御ファイルはDEFINE ${Job.Name} AS "${ORIGHOST}"を指定します。

    RICOH ProcessDirectorは、ジョブ名プロパティーの値をジョブのORIGHOSTパラメーターが指定する値ではなく、ジョブの入力ファイルの名前に設定します。

  • ワークフローがシンボル式でデフォルト設定する、ジョブプロパティーのジョブプロパティーノートブックで明示的に指定された値をすべて廃棄します。シンボル式をワークフローから削除し、明示的に指定された値を使用するよう、ジョブを再処理する必要があります。
シンボル式の検査
RICOH ProcessDirectorはシンボル式の構文および内容を検証し、エラー条件に関するメッセージを出します。たとえば、Job.Description=${Job.CustomerNameおよびJob.Description=${Job.XYZ}はどちらもエラーになります。前者は閉じ括弧がないための構文エラーで、後者はジョブプロパティー名が不明です。

Related information:

RICOH ProcessDirector メソッドの使用
RICOH ProcessDirector制御ファイルの構文
RunExternalProgram
データベースプロパティー名
コマンド行または制御ファイルを使用する外部ステップ用にステップテンプレートをセットアップする
ホットフォルダーを使用する外部ステップ用にステップテンプレートをセットアップする
上位層のトピック： 参照情報