Chapter 9 Reporting
This chapter will outline the Report Tool offered by Opencontour, which allows the users to manipulate previously established properties in a .CSV file which will be exported from the software.
Quick Access
9.1 Report Module
To open the report window, click Report Tool button in the Utility Menu.
When executing a report, different browsers may display different export prompts to capture the data. Reports are generated over the Mineplan layer by specifying a grouping parameter, for example, pm (period mined).
Report Window
9.1.1 Report Input Overview
This section will detail how the inputs work within the Report module:
| Input Name | Description |
|---|---|
| # Incl | This first column allows users to select which expressions they would like to select to run when they click Run Report. Pressing the top box will select/de-select all expressions in the window |
| Report Expression | This box allows the user to input the expression or value that they would like to attribute to see exported into the report. For more information on how to use Javascript, please navigate to 7.2 JavaScript General Guide |
| Data Type Column | This column lets the user select from a dropdown menu what type of data type they would like to be reporting out for each expression. The current data type options available are: Sum, Value, Min, Max, Average, and Count |
| Description | Allows the user to make various notes on the expression, describe what the expression is doing |
9.1.2 Choose Layer
This dropdown menu will allow the user to select the layer than they would like to report data from. It automatically defaults to the Mineplan layer.
9.1.3 Add Report
This button allows the user to import their report template into the project. The report must be in a .JSON format in order to import correctly.
9.1.4 Loaded Reports
This dropdown displays all of the reports that are currently available to select within the project. Once a report is selected, it should populate in the input boxes below accordingly.
Reports may be deleted from this list by clicking the Delete button when the report is selected from the menu.
9.1.5 Report Name
Allows user to manipulate or set a name for the report they are working on.
9.1.6 Boilerplate
Opencontour offers 12 boilerplate reports that the user may choose to select from and edit if they do not have any reports setup by themselves. These reports can be used to analyze phase and destination tons, ounces by phase mined, equipment summaries, and other useful facets.
9.1.7 Saving and Exporting Report Templates
There are several ways that a user may choose to save and/or export their work within the Report module:
- SaveReport - Simply pressing the SaveReport button allows the user to save all the work they have done within the window if they wish to temporarily navigate to another window within the project.
- SaveReport + Export - This combination will enable the user to save the current report template that they are working on as a .JSON file.
- SaveReport + Export + All - This combination will allow the user to save all of the loaded report templates in their project as a single .JSON file
9.1.8 Report Order
This feature allows the user to select the order in which they would like to execute multiple reports at one time.
9.1.9 Grouping and Running Reports
Once the user has created their report expressions and attributed the correct data type to each, the next step is to attribute the proper grouping so that the report can be generated successfully. Using the dropdown labeled Grouping at the top of the window, the user can choose a property from the selected layer that the final report will group the data by.
Once the grouping has been selected, the user may then click the Run Report button. This will output the report(s) as a .CSV file that can be saved onto one's computer.
9.2 Tutorial Project Part 7: Reporting Out the Project
This will be the final section of the tutorial project, which will teach the user how they can go about exporting information from their project to a .CSV format, so that they may have the information on file for future reference.
9.2.1 Loading Reports
- The reports that will be analyzed for this project will be taken from the Boilerplate dropdown, and are as follows:
- pm_report
- Equipment_report
- Once they have both been loaded in, organize them in the Report Order bar, then click the Run Report button
Project Report Window
