Report Output and Formatting

A Period Range Report will automatically generate three formats: HTML, PNG and CSV. Each of these reports contains the same data and ranges, however it is formatted appropriately for the output style. NO file extension should be included when defining the filename because ".html", ".png" and ".csv" are automatically created for each Period Range Report.

The CSV sub-report contains comma separated text values which can easily be read into any text editor or spreadsheet application. This is the report with the simplest formatting, where the first row contains column headings and each subsequent row contains data values. The number of rows is equal to the number of specified periods, and each row ends with a TOTAL of all ranges in that period. The following example was taken from the range labels defined above.

PERIOD,Regen,1 - 20,21 - 40,41 - 60,61 - 80,81 - 100,101 - 120,121 - 140,140+,TOTAL


The HTML table holds identical information however it is presented in a well formatted table with clear headings and columns. The Column headings are derived from the Range Labels defined in the PIN file. The first column of this type of report is always the 'PERIOD" number and the last column is always a 'TOTAL' for the entire row (period totals).

Figure 136. Period Range Table in HTML format

The figure shows an example of the table portion of the HTML report. The colour-coded areas show columns common to all Period Range reports (Blue), range column headings (Green), and cell values (Tan).

The default report created by the Report Writer is the HTML version. This particular report contains the above table as well as, a title with scenario name, an embedded PNG version of the report, optional HTML text or data (additionalHTML), a link to the CSV sub-report and a link to an index report.

The PNG sub-report shows a stacked-bar chart with one bar for each period, and one stack for each designated range. The Y-axis is automatically scaled to fit the data, and labeled with the units parameter. The X-axis displays period numbers (for example T0, T1, T2...). A legend is created to the right of the chart to indicate the value of the illustrated ranges.

Figure 137. PNG Sub-Report produced by Period Range Report

The stacked bar chart is automatically created and embedded in the HTML document. See the General Report Format for the layout of common reports.