BuildFileFromProperties

Ein Schritt, der auf dieser Schrittvorlage basiert, erstellt eine Ausgabedatei, die die Werte des RICOH ProcessDirector-Jobs und die Dokumentenmerkmale für einen Job enthält. Die Datei kann ein beliebiges Format haben, einschließlich XML, JSON und CSV.

Zum Erstellen der Ausgabedatei schreibt der Schritt zunächst den Wert des Merkmals Datei-Header in die Ausgabedatei. Dann schreibt der Schritt den Wert des Merkmals Dateistruktur in die Datei, einmal für alle Dokumente in der Datei der Dokumentmerkmale. Zum Schluss schreibt der Schritt den Wert des Merkmals Fußzeile der Datei in die Datei.

Sie können die RICOH ProcessDirector-Symbolschreibweise in allen drei Merkmalswerten verwenden. Die Symbole sind Platzhalter für den Job und die Dokumentwerte, die Sie in der Datei hinzufügen möchten, wenn der Schritt diese erstellt.

Sie können in den Merkmalen Datei-Header und Fußzeile der Datei Symbole für Jobmerkmale verwenden, jedoch nicht für Dokumentmerkmale.

Sie können Symbole für sowohl Job- als auch Dokumentmerkmale im Wert für das Merkmal Dateistruktur verwenden. In der Ausgabedatei sind die Jobwerte für jedes Dokument gleich.

Der Schritt verwendet die Datei der Dokumentmerkmale im Spoolverzeichnis für den Job als Eingabe. Der Dateiname hat das Format jobid.document.dpf, wobei jobid die Jobnummer darstellt. Beispiel: 10000009.document.dpf. Die erste Zeile in der Datei enthält den Namen der Datenbank für alle Dokumentmerkmale. Jede zusätzliche Zeile enthält Werte für jedes der Merkmale aus einem einzigen Dokument.

Beispiel

Dieses Beispiel erläutert, wie der Schritt eine XML-Ausgabedatei für drei Dokumente in einem Job namens Bank Statements 02032017 mit 14 Seiten erstellt.

Das Beispiel erstellt XML-Elemente, die den Wert von zwei Jobmerkmalen enthalten:

  • Jobname ( Job.Name)
  • Gesamtzahl Seiten ( Job.TotalPages)

Die Datenbanknamen der Merkmale werden in Klammern dargestellt.

Das Beispiel erstellt XML-Elemente, die den Wert von vier Dokumentmerkmalen enthalten:

  • Dokumentnummer ( Doc.ID)
  • Aktuelle Seiten ( Doc.CurrentPages)
  • Kundenname ( Doc.Custom.CustomerName)
  • Kundenkontonummer ( Doc.Custom.AccountNumber)

Wert des Merkmals Datei-Header:

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

Wert des Merkmals Dateistruktur:

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

Wert des Merkmals Fußzeile der Datei:

</InputFile>

Die Dokumentmerkmaldatei wird im Spoolverzeichnis für den Job gespeichert:

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-Ausgabedatei:

<?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>

Standardwerte für Jobmerkmale

  • Datei-Header:

  • Dateistruktur:

  • Fußzeile der Datei:

  • Ausgabedatei:

Hinweise zur Verwendung:

  • Für die Erstellung einer Ausgabedatei, die die Werte der Jobmerkmale jedoch nicht die Dokumentmerkmale enthält, muss der Wert des Merkmals Dateistruktur frei bleiben.
  • Der Schritt schreibt den Wert des Merkmals Dateistruktur in die Ausgabedatei nur dann, wenn diese beiden Bedingungen zutreffen:
    • Das Merkmal Dateistruktur gibt einen Wert an, der sich typischerweise auf ein oder mehrere gültige Dokumentmerkmale bezieht.
    • Das Spoolverzeichnis für den Job enthält eine Dokumentmerkmaldatei.
  • Wenn Sie eine XML- oder JSON-Ausgabe erstellt haben, können Sie diese validieren, indem Sie einen Schritt verwenden, der auf der Schrittvorlage CheckFileStructure basiert.
  • Wenn für die Merkmale Datei-Header, Dateistruktur und Fußzeile der Datei keine Werte bereitgestellt werden, erstellt der Schritt eine leere Datei.

Übergeordnetes Thema: Bereitgestellte Schrittschablonen