View a Report in the Report Writer

A variety of reports can be generated by Patchworks to summarize the results of the scenario. The reports are accessible from the Reports control panel. Reports usually provide information in three formats: as HTML files (.HTML), as PNG images (.PNG) and as CSV data files (.CSV). The HTML reports include the histogram as well as a formatted table of the information. The HTML reports are the default rendering and are intended to be viewed with your favourite web browser. The CSV (Comma Separated Values) files are data files that can be used in other applications (like Excel) for further analysis.

The HTML reports are available to be viewed at any time from the Report Writer control panel. These reports are generated from the current values of the simulation. When a scenario is saved however, all of the reports are saved in all three formats to a folder of your choosing (HTML, PNG, CSV). These reports can be viewed later and manipulated outside of the Patchworks program. Some reports define the current conditions in the model, and these can be loaded back in at a later time to reset the model to exact state it was at when it was saved. More information about saving and loading scenario results is available in Working with scenarios. Let's look at a couple of reports from the sample dataset.

  1. Choose the Reports tab from the Patchworks panel (next to the Legend and Target tabs).

  1. In the Report control panel you will notice a number of reports. The list will look like Figure 17, “The Reports Tab.”. The default report format is indicated by the icon to the left of the title. A Table icon indicates a raw data report in CSV format. A document icon represents an HTML format report for viewing in a web browser. A folder icon indicates a logical grouping of similar reports. You can click on the open folder icon (+) to the left of the folder to see the contents of the group.


The Reports panel can be widened to see the full title of the reports by placing the mouse over the dividing bar (between the control panel and map viewer). Press the mouse and drag the division to the right until the full title is visible.

Figure 17. The Reports Tab.

When the reports tab is highlighted, all the reports generated for this simulation are listed in a hierarchial menu of folders and files.

  1. Scroll down to the very bottom of the list to find the report entitled Volume flow. This report summarizes the harvest volume information from the model. Click on the report to open it in your web browser (see Figure 18, “The harvest volume report.”).

Figure 18. The harvest volume report.

Most reports show the name of the scenario, an image, and a table with data relating the image.

Notice the words Current Scenario have been appended to the title. This label identifies that the results have been generated 'live' from the Patchworks model. When you save a scenario, the name you give to it will be appended to the end of the title to permanently identify which scenario the data came from.

The volume flow report contains a stacked bar chart representing conifer and deciduous harvest volume, as well as a table of the same values organized by period. Depending on the report and the compatibility of your web browser, the chart may be displayed as an interactive applet. The applet provides functions such as zooming, adjustiment of charting parameters, and display of data values as the mouse is hovered over the bars.

Report definitions are declared in the PIN file, and can be customized to display the information you need from the simulation. Detailed information about the types of report templates and how to add reports is provided in Report Syntax and Creating Reports.