BuildFileFromProperties

このステップテンプレートに基づくステップは、ジョブの RICOH ProcessDirector ジョブプロパティーと文書プロパティーの値を含む出力ファイルを作成します。このファイルは、XML、JSON、CSV など任意の形式で作成できます。

出力ファイルを作成するために、このステップは最初にファイルヘッダープロパティーの値を出力ファイルに書き込みます。次に、文書プロパティーファイル内の文書ごとに 1 回ずつ、ファイル本文プロパティーの値をファイルに書き込みます。最後に、ファイルフッタープロパティーをファイルに書き込みます。

これら3つのプロパティー値すべてで、RICOH ProcessDirector シンボル表記を使用できます。シンボルは、ファイルの作成時にファイルに含めるジョブおよび文書の値のプレースホルダーとなります。

ジョブプロパティーでは、ファイルヘッダープロパティーとファイルフッタープロパティーの値にシンボルを使用できますが、文書プロパティーでは使用できません。

ジョブプロパティーと文書プロパティーの両方で、ファイル本文プロパティーの値にシンボルを使用できます。出力ファイルでは、ジョブ値は各文書で同じです。

このステップは、ジョブのスプールディレクトリーの文書プロパティーを入力として使用します。ファイル名の形式は jobid.document.dpf で、jobid はジョブ番号です。例：10000009.document.dpf。ファイルの最初の行には、それぞれの文書プロパティーのデータベース名が含まれています。それぞれの追加行には、1 つの文書の各プロパティーの値が含まれています。

例

この例では、ステップがどのように 14 ページに渡るBank Statements 02032017という名前のジョブの 3 つの文書に対応する XML 出力ファイルを作成するのかを示します。

この例では、次の 2 つのジョブプロパティーの値を含む XML 要素を作成します。

ジョブ名 ( Job.Name)
合計ページ数 ( Job.TotalPages)

括弧内はプロパティーのデータベース名です。

この例では、次の 4 つの文書プロパティーの値を含む XML 要素を作成します。

文書番号 ( Doc.ID)
現在のページ ( Doc.CurrentPages)
カスタマー名 ( Doc.Custom.CustomerName)
カスタマーアカウント番号 ( Doc.Custom.AccountNumber)

ファイルヘッダープロパティーの値は、次のとおりです。

<?xml version="1.0" encoding="utf-8"?>
<InputFile>
  <PDF>${Job.Name}</PDF>
  <TotalPages>${Job.TotalPages}</TotalPages>

ファイル本文プロパティーの値は、次のとおりです。

<Document>
  <DocNumber>${Doc.ID}</DocNumber>
  <PageCount>${Doc.CurrentPages}</PageCount>
  <Customer Custname="${Doc.Custom.CustomerName}" CustAccount="${Doc.Custom.AccountNumber}" />
</Document>

ファイルkフッタープロパティーの値は、次のとおりです。

</InputFile>

ジョブのスプールディレクトリーにある文書プロパティーファイルは、次のとおりです。

Doc.ID,Doc.CurrentPages,Doc.Custom.CustomerName,Doc.Custom.AccountNumber
1,4,Jane Smith,SA349088
2,4,Chris Lopez,SA347202
3,6,John Gray,SA340655

XML 出力ファイル:

<?xml version="1.0" encoding="utf-8"?>
<InputFile>
  <PDF>Bank Statements 02032017</PDF>
  <TotalPages>14</TotalPages>
  <Document>
    <DocNumber>1</DocNumber>
    <PageCount>4</PageCount>
    <Customer Custname="Jane Smith" CustAccount="SA349088" />
  </Document>
  <Document>
    <DocNumber>2</DocNumber>
    <PageCount>4</PageCount>
    <Customer Custname="Chris Lopez" CustAccount="SA347202" />
  </Document>
  <Document>
    <DocNumber>3</DocNumber>
    <PageCount>6</PageCount>
    <Customer Custname="John Gray" CustAccount="SA340655" />
  </Document>
</InputFile>

ジョブプロパティーデフォルト

ファイルヘッダー:
ファイル本文:
ファイルフッター:
出力ファイル:

使用上の注意:

ジョブプロパティーの値を含むが文書プロパティーの値を含まない出力ファイルを作成する場合は、ファイル本文プロパティーの値を空白のままにします。
ステップは、次の条件がどちらも適用される場合にのみ、ファイル本文プロパティーの値を出力ファイルに書き込みます。
- ファイル本文プロパティーに値 (一般的には 1 つ以上の有効な文書プロパティー) が指定されている。
- ジョブのスプールディレクトリーに文書プロパティーファイルが含まれている。
XML または JSON の出力を作成したら、CheckFileStructure ステップテンプレートに基づくステップを使用して、検証できます。
ファイルヘッダー、ファイル本文、およびファイルフッターの各プロパティーに値が指定されていない場合は、空白のファイルが作成されます。

RICOH ProcessDirector™ for Linux

BuildFileFromProperties