Syntax

   FACTORY_DEF <ReaderKeyword> ReportFactory
   [FACTORY_NAME <factory name>]
   [INPUT FEATURE_TYPE <feature type>
      [<attribute name> <attribute value>]*
      [<feature function>]*]*
   [COLUMN <attribute name> [<column title>] <width>]+
   [COLUMN_SEPARATOR <separator>]
   [REPORT_TITLE <title>]
   [REPORT_FILENAME <report filename>]
   [NO_COLUMN_HEADERS]
   [COLUMN_HEADERS (YES|NO)]
   [APPEND [(YES|NO)]]
   [SUPPRESS_EMPTY_REPORT [(YES|NO)]]
   [WRITE_UTF8_REPORT [(YES|NO)]]
   [OUTPUT REPORTED
      FEATURE_TYPE <feature type>
      [<attribute name> <attribute value>]*
      [<feature function>]*]*

Overview

   This factory outputs one line for each feature that enters it into a columnar
   report. The columns in the report are populated by attributes in the feature.
   The report may be routed to an external file or it can be dumped into the FME
   log file.

Clauses

   The ReportFactory makes use of several additional clauses to fully specify
   its operation.

   COLUMN <attribute name> [<column title>] <width>

      Defines an output column in the report. If no column title is present, the
      attribute name will be used as the column title. If the attribute's value
      could not fit in the width given, then it will be truncated to that width.
      At least one column definition must be present. There is no limit on the
      total number of column definitions.

      Example: COLUMN zValue Z 8

   COLUMN_SEPARATOR <separator>

      The character used as the separator between columns in the report.

      Default: :

      Example: COLUMN_SEPARATOR "|"

   REPORT_TITLE <title>

      The title to be output as the first line of the report.

      Default: None

      Example: REPORT_TITLE "Pt. Errors"

   NO_COLUMN_HEADERS

      Specifies that the headers normally written to the top of the report to
      name the report and its columns are to be suppressed.

   APPEND

      Specifies that the report is to be appended to the specified file if it
      already exists rather than replacing it.

   SUPPRESS_EMPTY_REPORT

      Specifies that if not features are processed by the factory, then no
      report is generated. Otherwise an empty report will be generated.

   WRITE_UTF8_REPORT

      Specifies the encoding of the report file. It this flag is set, then the
      file is encoded in UTF-8, otherwise it is encoded in the current system
      encoding.

   REPORT_FILENAME <filename>

      The file name for the report. If no file name is given, then the report
      will be output to the FME log file.

      The <filename> parameter may contain FME functions, meaning a different
      filename may result for different features. Ergo, multiple report files
      are a possibility.

      Default: None (log file)

      Example: REPORT_FILENAME c:\rp.txt

Output Tags

   The ReportFactory supports the following output tag.

   REPORTED

      All features that enter the factory are output through this clause.

TO BE RESOLVED

   COLUMN_HEADERS clause added to Syntax section above, but not documented.