BuildFileFromProperties

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

出力ファイルを作成するために、このステップは最初にファイルヘッダープロパティーの値を出力ファイルに書き込みます。次に、文書プロパティーファイル内の文書ごとに 1 回ずつ、 ファイル本文プロパティーの値をファイルに書き込みます。 区切り文字プロパティーに値がある場合、 ファイル本文テキストが出現するたびに、最後の値を除いてその値が挿入されます。最後に、 ファイルフッタープロパティーをファイルに書き込みます。

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

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

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

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

これらの例は、Bank Statements 02032017という14ページのジョブ内の3つの文書について、ステップでどのようにXML、CSV、JSON出力ファイルを作成するかを示しています。

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

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

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

この例では、 4 個の文書プロパティーの値を内容とする要素を作成しています:

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

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

XML

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

JSON

{
  "JobName": "{Job.Name}",
  "TotalPages": {Job.TotalPages},
  "Documents": [

CSV

JobName,TotalPages,DocNumber,PageCount,Custname,CustAccount

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

XML

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

JSON

{
    "DocNumber": {Doc.ID},
    "PageCount": {Doc.CurrentPages},
    "Custname": "{Doc.Custom.CustomerName}",
    "CustAccount": "{Doc.Custom.AccountNumber}"
  }

CSV

{Job.Name},{Job.TotalPages},{Doc.ID},{Doc.CurrentPages},{Doc.Custom.CustomerName},{Doc.Custom.AccountNumber}

区切り文字プロパティーの値は、次のとおりです。

JSON

    注意:
  • XMLまたはCSVファイルを生成する場合、区切り文字プロパティーを空のままにすることができます。

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

XML

</InputFile>

JSON

  ]
}

    注意:
  • CSVファイルを生成する場合、ファイルフッタープロパティーは空のままにしておくことができます。

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

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>

JSON出力ファイル(区切り文字プロパティー付き)

{
  "JobName": "Bank Statements 02032017",
  "TotalPages": 14,
  "Documents": [
    {
      "DocNumber": 1,
      "PageCount": 4,
      "Custname": "Jane Smith",
      "CustAccount": "SA349088"
    },
    {
      "DocNumber": 2,
      "PageCount": 4,
      "Custname": "Chris Lopez",
      "CustAccount": "SA347202"
    },
    {
      "DocNumber": 3,
      "PageCount": 6,
      "Custname": "John Gray",
      "CustAccount": "SA340655"
    }
  ]
}

CSV出力ファイル

JobName,TotalPages,DocNumber,PageCount,Custname,CustAccount
Bank Statements 02032017,14,1,4,Jane Smith,SA349088
Bank Statements 02032017,14,2,4,Chris Lopez,SA347202
Bank Statements 02032017,14,3,6,John Gray,SA340655

ジョブプロパティーデフォルト
  • ファイルヘッダー:

  • ファイル本文:

  • 区切り文字:

  • ファイルフッター:

  • 出力ファイル:

使用上の注意:

  • ジョブプロパティーの値を含むが文書プロパティーの値を含まない出力ファイルを作成する場合は、ファイル本文プロパティーの値を空白のままにします。
  • ステップは、次の条件がどちらも適用される場合にのみ、ファイル本文プロパティーの値を出力ファイルに書き込みます。
    • ファイル本文プロパティーに値 (一般的には 1 つ以上の有効な文書プロパティー) が指定されている。
    • ジョブのスプールディレクトリーに文書プロパティーファイルが含まれている。
  • 区切り文字プロパティで1つ以上の文字を使用して、本文の各出現箇所を区切ることができます。

  • XMLまたはJSONの出力を作成したら、CheckFileStructureステップテンプレートに基づくステップを使用して、検証できます。
  • ファイルヘッダーファイル本文、および ファイルフッターの各プロパティーに値が指定されていない場合は、空白のファイルが作成されます。