Report Output and Formatting

A Standard Report will automatically generate three formats: HTML, PNG and CSV. Each of these sub-reports contains the same data, however it is formatted appropriately for the output style. It is important that NO file extension is included when defining the filename parametre since the ".html", ".png" and ".csv" files are automatically created. The defautl report provided by the Report Writer is the HTML, however this format provides links to the other two formats.

The CSV sub-report contains comma separated text values which can be read into a text editor or spreadsheet application. This sub-report contains the simplest formatting, with the first row containing the column headings and subsequent rows containing values for each period. The first column in the table contains the period number, with a column heading of 'PERIOD'. Subsequent columns contain the unique target names 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:


The HTML sub-report contains a table holding similar information to the CSV report. Column headings are based on the unique values found within the 'TARGET' column, and are displayed in a nested format according to the following recipe:

Figure 133. Standard Report HTML Table

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

In this particular example the 'TARGET' or targetPrefix was specified as 'product.area.' therefore, the remainder of the individual target names (managed.DF, managed.LA, managed.PL...) were used to created the nested column headings (Green).

Besides the table, the HTML report also contains a title, the name of the scenario, an embedded PNG version of the report, optional supplementary HTML 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 unique target. The Y-axis is automatically scaled to fit the data, and labeled with the units parameter. The X-axis displays period numbers.

Figure 134. PNG Sub-Report produced by Standard 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.