プロパティー条件ファイル

SetDocPropsFromConditions ステップテンプレートを基にしたステップは、このプロパティー条件ファイルで検出された条件に基づいて、現行ジョブで文書プロパティーを設定します。このファイルに定義される条件では、コンマ区切り値 (CSV) フォーマットが使用されます。サンプルのプロパティー条件ファイルは/aiw/aiw1/samples/doc/DocPropConditions.csvにあります。Postal Enablement機能がある場合は、/aiw/aiw1/samples/control_files/postalにサンプルファイルが追加されています。
    重要:
  • プロパティー条件ファイルを編集するには、テキストエディターで開きます。Microsoft Excel でファイルを編集しないでください。

プロパティー条件ファイルを使用して、条件付きまたは条件なしのプロパティーの値を設定できます。また、別個のインクルードファイルを使用して、「property = value」フォーマットを使用してプロパティーを定義することもできます。

条件を使用した値の設定

プロパティー条件ファイルの先頭行は、文書プロパティーまたはジョブプロパティーのデータベース名をコンマで区切ってリストにしたヘッダー行です。通常はヘッダー行の左端の部分に、1 つ以上の条件をテストするプロパティーを指定しますが、必ずしもこの順序でなくてもかまいません。

ヘッダー行の後に、1 行以上の条件行で、条件およびその行のすべての条件が真の場合に設定されるプロパティー値を定義します。各条件行は if-then ステートメントを表すと考えることができます。1 行に指定したすべての条件は論理的に AND 演算され、すべて真である必要があります。いずれかの条件が true ではない場合は、指定された値はいずれも設定されません。条件行では値をコンマで区切ります。

条件に基づいてプロパティー値を設定するプロパティー条件ファイルの内容の例を次に示します。

Doc.Custom.MailCategory,Job.Name,Doc.Run.PAVE
=USPS,,Yes
=USPS,~XYZ*,No
=NonUSPS,,No
=Exception,,No

最初のif-then条件では、郵便物カテゴリーがUSPSの場合、RICOH ProcessDirectorDoc.Run.PAVEプロパティーを Yesに設定すると記述しています。ジョブ名がXYZから始まる場合は、2行目によって Doc.Run.PAVEの値が Noに設定されます。

条件の一部であるプロパティーはすべて、値を受け取るプロパティーの左側に配置することをお勧めします。

条件の一部であるプロパティーは、以下の設定からの条件文字を使用します。

条件ファイルの条件文字

条件文字 条件 例/注記
=[value] 等しい =Fir
<>[value] 等しくない <>Fir
<[value] より小 4900000より小さい
>[value] より大 61000 より大きい
<=[value] より小か等しい 61207 以下
>=[value] より大か等しい 61207 以上
~[value] Like *(演算子) ~INSURE*.PDF
!~[value] Not Like *(演算子) !~*.PDF
"([val1],[val2],...)" In *(演算子) (先頭と終わりに括弧を付けて引用符で囲む必要があります) "(PRTA, PRTB)"
"!([val1],[val2],...)" Not In *(演算子) (先頭と終わりに括弧を付けて引用符で囲む必要があります) "!(PRTA, PRTB)"
(ブランク) ワイルドカード (*) 条件がブランクの場合は、常に true と見なされます。

    注意:
  • ポンド記号 (#) を使用してコメントを追加できます。完全な行のみをコメントにできます。また、行の先頭に # 文字を使用する必要があります。
  • スペースを使用して、キーワード文字と条件値を区切ることができます。
  • 位置プロパティーを設定する場合、プロパティー名[プロセス名][フェーズ名][ステップ名]または[フェーズ名][ステップ名]の2つの形式のうちのいずれかを選択できます。定位置プロパティーを使用して、他のプロパティーを設定することはできません。
  • 文字の ? と * は、Like 条件および Not Like 条件とともに使用されるワイルドカード文字です。疑問符 (?) は単一文字と一致し、アスタリスクは任意の数の文字と一致します。
  • 条件ファイル内で RICOH ProcessDirector のシンボル表記を使用して、特定の文書プロパティーまたはジョブプロパティーの現在値に基づいて条件を設定するか、値を割り当てることができます。シンボル表記構文の詳細については、インフォメーションセンターのRICOH ProcessDirector シンボル表記のトピックを参照してください。シンボル表記は、リテラル文字列値と併せて使用することもできます。詳しくは、以下を参照してください。
  • 条件フィールドに値のない等号 (=) がある場合は、ジョブのプロパティー値が NULL であれば条件は true です。フィールドに空の値がある場合は、その行のプロパティーは無視されます。これは、条件の一部ではなく、その値は変更されません。この規則のため、ステップはジョブプロパティーを NULL に設定できません。プロパティーを手動でnullに設定するには、式${null}を使用します。
  • 各行は別個に評価されます。
  • ジョブまたは文書のプロパティーに一致する条件があるすべての行が適用されます。各行は、それらの行がファイル内で出現する順序で適用されます。各行の中では、プロパティー値は左から右に適用されます。
  • 先行ブランクと末尾ブランクは、比較または設定操作が行われる前にフィールド値から除去されます。値内の (先行でも末尾でもない) ブランクは保存されます。

シンボル表記およびサブ文字列指定子によるプロパティー値の一部分の使用

条件でプロパティーの一部分のみ使用する場合 (プロパティー値の最初の 5 文字のみ使用するなど)、サブ文字列指定子を使用して、プロパティーの使用する部分を指定できます。

構文は次のとおりです。

  • ${property_name;substr;start;length}
ここで、
  • property_name は、プロパティーの名前 ( Job.Name) です。
  • start は、文字列内の開始位置です。
  • length は、条件で使用する文字数です。プロパティーの文字数を超える長さを入力した場合、プロパティーの残りの部分が使用されます。

    注意:
  • 文字列は、0基準の索引となります。例えば、先頭の文字は位置0で、5番目の文字は位置4です。

次の表にいくつかの例を示します。

サブ文字列値の例

プロパティー条件ファイル プロパティー値 結果
${Job.Name;substr;0;4} Job.Name = USPS-FullService USPS
${Job.Name;substr;5;8} Job.Name = USPS-OversizeFlat Oversize

シンボル表記による連結値の作成

シンボル表記を使用して、特定のプロパティーの現在値に基づいて条件を設定したり、値を割り当てるのに加えて、シンボルを組み合わせて連結された 1 つの値を作成したり、それらをリテラル文字列と共に使用できます。

次の表にいくつかの例を示します。

プロパティー値の連結の例

プロパティー条件ファイル 実際のプロパティー値 結果
Job.Custom.A,Job.Custom.Z

${Job.Custom.D}${Job.Custom.E},4

Job.Custom.D=5 および Job.Custom.E=9 Job.Custom.A=59

Job.Custom.Z=4

Doc.Custom.MailCategory,Job.Name,Doc.Run.PAVE

=USPS,${Job.Custom.D} Flat,No

Doc.Custom.MailCategory=USPSおよびJob.Custom.D=Oversize

Job.Name=Oversize Flat

Doc.Run.PAVE=No

条件を定義せずに値を設定する

条件ファイルのフォーマットは同じです。ヘッダー行にプロパティーデータベース名を、2 行目にプロパティー値をリストします。ただし、条件ファイルには行が 2 行しか含まれていません。複数行のプロパティー値を指定した場合、最後の行に指定した値のみが保存されます。

条件を使用せずにプロパティー値を設定するプロパティー条件ファイルの内容の例を次に示します。

Doc.Custom.MailCategory,Job.Name,Doc.Run.PAVE
USPS,PostalDiscount,Yes

別個のインクルードファイルを使用した値の設定

複数のワークフローで同一のプロパティーの集合を使用する場合は、これらのプロパティーを別個のインクルードファイルに定義し、プロパティー条件ファイルでそのインクルードファイルを参照できます。

別個のインクルードファイルを参照するには、プロパティー条件ファイルのヘッダー行に @include を記述し、プロパティー条件ファイルの 2 行目にインクルードファイルの相対パスまたは絶対パスを指定します。

    重要:
  • Windowsシステム上のインクルードファイルの絶対ディレクトリーパスを指定するには、Linuxの区切り文字(/)を使用します。例えば、Windowsシステム上のインクルードファイルがC:\Projects\data.txtにある場合、/Projects/data.txtを指定します。

@includeと別個のインクルードファイルへのパスを含むプロパティー条件ファイルの内容の例を次に示します。

Doc.Custom.MailCategory,Job.Name,@include
USPS,Priority,../prop-assignments/usps-properties.txt

この例では、[メールカテゴリー]プロパティーに USPS の値を割り当て、[ジョブ名]プロパティーに「優先順位」の値を割り当てます。そして、インクルードファイル usps-properties.txt への相対パスを指定しています。

インクルードファイルでは、「Property name = Value」のフォーマットを使用してプロパティー値を定義します。インクルードファイルのフォーマットを次の例に示します。

Doc.Insert.RecipientName=George Rogers
Job.CustomerName=CerbCo

条件ファイルは左から右に、かつ上から下に処理されます。次の表に、すでに設定されているプロパティーをプロパティー条件ファイルおよびインクルードファイルで指定変更する例を示します。(以下の例は説明を目的としたものであり、条件ファイルの実際の使用例を示すものではありません。)

条件ファイルおよびインクルードファイルの処理順序の例

プロパティー条件ファイル インクルードファイルでの指定 結果
Job.Name,@include

=,../prop-assignments/usps-properties.txt

Job.ID ジョブ名がまだ定義されていない場合は、インクルードファイルによって FlatFold と定義されます。
Doc.Custom.Zip, Doc.Custom.Location, Doc.Custom.Location, @include

<50000, EAST, NEW HAMPSHIRE, /Projects/data.txt

Job.CityPopulation = 42400 Zipが50000より小さい場合、条件ファイルによりLocation = EASTが設定され、次に条件ファイルによりLocation = NEW HAMPSHIREが設定されます。その後、インクルードファイル/Projects/data.txtによりCityPopulation = 42400が設定されます。

Doc.Custom.Location = NEW HAMPSHIRE

Job.CityPopulation = 42400

Doc.Custom.Zip, Doc.Custom.Location, @include, Doc.Custom.Location

<50000, EAST, /Projects/data.txt, NEW HAMPSHIRE

Doc.Custom.Location = CONCORD

Job.CityPopulation = 42400

Zipが50000より小さい場合、条件ファイルによりLocation = EASTが設定され、次にインクルードファイル/Projects/data.txtによりLocation = CONCORDおよびCityPopulation = 42400が設定されます。その後、条件ファイルによりLocation = NEW HAMPSHIREが設定されます。

Doc.Custom.Location = NEW HAMPSHIRE

Job.CityPopulation = 42400

Doc.Custom.Zip, Doc.Custom.Location, @include, @include

<50000, EAST, /Projects/data.txt, /Projects/data2.txt

/Projects/data.txt

Doc.Custom.Location = CONCORD

Job.CityPopulation = 42400

/Projects/data2.txt

Doc.Custom.Location = US ROUTE 202

Job.CityPopulation = 52400

Zipが50000より小さい場合、条件ファイルによりLocation = EASTが設定され、次にインクルードファイル/Projects/data.txtによりLocation = CONCORDおよびPopulation = 42400が設定されます。その後、インクルードファイル/Projects/data2.txtによりLocation = US ROUTE 202およびCityPopulation = 52400が設定されます。

Doc.Custom.Location = US ROUTE 202

Job.CityPopulation = 52400

    注意:
  • インクルードファイル名の一部として RICOH ProcessDirector のシンボル表記を使用できます。例えば、${Job.RequestedPrinter}.equipmentprops.txt というインクルードファイル名を使用した場合、システムは要求された各プリンター (Job.RequestedPrinter の各値) について、定義する正しいプロパティーのセットを選択できます。シンボル表記の構文については、関連する参照情報のトピックを参照してください。