Report Output and Formatting

This report generates reports in three formats: HTML, PNG, and CSV. Each sub-report contains the same data, formatted appropriately for the output style. When specifying the filename parameter do not supply a filename extension. This report will automatically create the corresponding ".html", ".png", and ".csv" files. The default report provided by the ReportWriter is the HTML format report, which also provides links to the other two formats. For the general layout of the Category Category Report see: General Report Format.

The CSV sub-report has the simplest formatting. The file contains comma separated text values, and can be read in a text editor or loaded into a spreadsheet. The first row contains the column headings. Subsequent rows contain values for each period. The first column in the table contains the period number, with a column heading of 'PERIOD'. The second column contains the final YEAR of the period. Subsequent columns contain the range labels sorted in alphabetical order, and the final column contains row totals with a column heading of 'TOTAL'. The following shows a sample of a CSV format file for Category Category Report:


The HTML sub-report contains a table holding similar information to the CSV report. Column and row headings are based on the category values. Besides the table, the HTML report also contains a title, the name of the scenario,an embedding of a PNG version of the report, optional supplementary HTML data (htmlText), a link to the CSV sub-report, and a link to an index report.

Figure 109. Category Pattern Report HTML Table

This figure shows an example of the table portion of the HTML report.

The PNG sub-report shows a stacked-bar chart with one bar for each row category, and one stack for each column. The Y-axis is automatically scaled to fit the data, and labeled with the units parameter. The X-axis is row categories.

Figure 110. PNG Sub-Report produced by a Category Category Report

The stacked bar chart is automatically created and embedded in the HTML document. Each bar represents a row category, and each stack represents a column.