File header

Specifies the header information in the output file created by a step based on the BuildFileFromProperties step template. Use this property for static information required at the top of the file and to include the values of job properties in the output.
Default
None
Database name
Job.FileHeader
Usage notes:
  • The output file can be in any format, including XML, JSON, and CSV.
  • To include job values in the output, specify job properties in the file header using symbol notation. The symbols are placeholders for the values of the job properties.

    This example for creating XML output uses two symbols to specify the Job name (database name Job.Name) and Total pages (Job.TotalPages) job properties in the file header:

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

    The example includes a start-tag, <InputFile>. The end-tag, </InputFile>, is in the File footer property.

    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 body, and File footer, see the topic about the BuildFileFromProperties step template in the help system.