File body

Specifies the body information in the output file created by a step based on the BuildFileFromProperties step template. Use this property to include the values of document properties in the output file. You also can use this property to include the values of job properties in the output file.

If you include references to job properties, the values for those job properties in the output file are the same in each document.

The document properties file in the spool directory for the job provides input to the BuildFileFromProperties step. In the output file, the value of this property is repeated for each document in the document properties file.

The step writes the value of this property to the output file only when both these conditions apply:

  • The File body property specifies a value, typically referencing one or more valid document properties.
  • The spool directory for the job contains a document properties file.

Default
None
Database name
Job.FileBody
Usage notes:
  • The output file can be in any format, including XML, JSON, and CSV.
  • To include document and job values in the output, specify document and job properties in the file body using symbol notation. The symbols are placeholders for the values of the document and job properties.

    This example for creating XML output uses four symbols to specify the Document number (database name Doc.ID), Current pages (Doc.CurrentPages), Customer name (Doc.Custom.CustomerName), and Customer account number (Doc.Custom.AccountNumber) document properties in the file body:

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

    For more information about symbol notation and how to use it, refer to the help system.

  • For an example of XML output created by defining values for this property, File header, and File footer, see the topic about the BuildFileFromProperties step template in the help system.