# Working with Reports

# Introduction

<span class="rvts6">The Voxel Farm platform features a spatial reporting system. This system allows to run a custom program, a report, across a large scope of space. As the program goes over space, it can analyze different layers of spatial data and perform useful computations or discoveries with the data.</span>

<span class="rvts6">Even if the report code is deceptively simple and serial, the platform is able to execute reports in a massively parallel fashion. This is achieved by running many instances of the same report program in parallel, each one looking at a different region of space. The platform integrates the results produced by the swarm of reporting nodes into a single, coherent result set.</span>

<span class="rvts6">This section covers how to run existing Report programs. To see how to create new Report programs, please visit the Report Program</span><span class="rvts6"> section of the Developer manual.</span>

# Viewing Reports

<span class="rvts6">The WebUI keeps track of all Report entities in the Project's Catalog and provides a dedicated section in the UI to access them. To access the reports, select the "Reports" section in the WebUI:</span>

![](https://demo.voxelfarm.com/help/lib/NewItem98.png)

<span class="rvts6">The reports are organized using the same hiearchy of Folders in the Project.</span>

<span class="rvts6">To view a Report, click on its name on the Tree View. The Report results will show as a table in the right panel.</span>

<span class="rvts6">Use the "Download CSV" link to download a CVS file with the results of the Report.</span>

# Creating a Report

<span class="rvts6">To create a new Report entity, go to the Project Catalog, browse to the Folder that you want to contain the Report, and click on the "Add" button.</span>

<span class="rvts6">This will display a list of Entities to add. Chose "Report" from the list:</span>

![](https://demo.voxelfarm.com/help/lib/NewItem99.png)

<span class="rvts6">This will display a modal dialog prompting for information about the report:</span>

![](https://demo.voxelfarm.com/help/lib/NewItem111.png)

<span class="rvts6">  
</span>

<div class="rvps2" id="bkmrk-name-provide-a-name-"><table border="1" cellpadding="7" cellspacing="-1"><tbody><tr valign="top"><td valign="top" width="132"><span class="rvts6">Name</span>

</td><td valign="top" width="491"><span class="rvts6">Provide a name for the report</span>

</td></tr><tr valign="top"><td valign="top" width="132"><span class="rvts6">Region</span>

</td><td valign="top" width="491"><span class="rvts6">Select one of the regions available in the Project as the scope where the Report will run. Visit the </span>[Working with Regions](https://demo.voxelfarm.com/help/WorkingwithRegions.html)<span class="rvts6"> section to see how to define a new region.</span>

</td></tr><tr valign="top"><td valign="top" width="132"><span class="rvts6">Resolution</span>

</td><td valign="top" width="491"><span class="rvts6">Allows to select the voxel resolution that will be used to compute the Report.</span>

</td></tr><tr valign="top"><td valign="top" width="132"><span class="rvts6">Program</span>

</td><td valign="top" width="491"><span class="rvts6">Select which Report Program will be used to compute the Report. For more about these special programs, see the </span>[Report Programs](https://demo.voxelfarm.com/help/ReportPrograms.html)<span class="rvts6"> section.</span>

<span class="rvts6">  
</span>

<span class="rvts6">Based on the input expected by the program, the dialog will contain other custom input fields.</span>

</td></tr></tbody></table>

</div><span class="rvts6">Click on the "Create" button to start the Report. While it is computed, the Report will appear list in the "Pending" section of the Project.</span>

<span class="rvts6">Once the report completes, it will become accessible for viewing and downloading.</span>