comp730:Massabesic Reporting Group


 * 1) summary This is the wiki page for the reporting group.

= Introduction =

Last Updated: May 5, 2015

Purpose: The reports page gives users the option to view a variety of reports. The user can choose to display all reports, or select a filter to display a report by year, group, or boat ramp. All data is being retrieve from the NHVBSR database. If the database is kept up to date, the reports page will dis[;ay the most recent information. There is another feature that allows the user to export a report to an excel file. This is great if a user wants to their own file of the report to keep or send to someone else.

Users:
 * Administrators
 * Group Coordinators
 * Lake Hosts

Features:
 * Display and filter reports from the NHVBSR database
 * Export report to file

= File Structure =

Model:Report.php
All Summaries Functions: - functions used to display all summaries


 * allStates - selects and sums the data entries per state.
 * allBoatTypes selects and sums the data entries per boat type.
 * allPreviousInteractions - selects and sums the data entries for previously interacted and never interacted.
 * allDrained - selects and sums the data entries for drained and not drained.
 * allRinsed - selects and sums the data entries for rinsed and not rinsed.
 * allDried - selects and sums the data entries for dried and not dried.
 * allAwareness - selects and sums the data entries for high, medium, and low awareness types.
 * allSpeciesFound - selects and sums the data entries for species found and not found.
 * allSpecimenSent - selects and sums the data entries for sent to DES and not sent to DES.

- Group by Ramp uses similar functions, but named as "allStatesRamp", "allBoatTypesRamp", etc.

- Group by Lake Host Group uses similar functions, but named as "allStatesGroup", "allBoatTypesGroup", etc.

- Group by Date uses similar functions, but named as "allDateStates", "allDateBoatTypes", etc.

Controller:Report.php
Functions:
 * index - displays build report to show the summaries on the report page of the lake host project.
 * allReports - create template and table for all reports data to be displayed in.
 * rampReports - create template and table for reports by ramp data to be displayed in.
 * groupReports - create template and table for reports by group data to be displayed in.
 * allDateReports - create template and table for reports by date data to be displayed in.

View:Report
Files:


 * allDateReports.php
 * allReports.php
 * groupReports.php
 * rampReports.php
 * index.php

The views pull information from build report and functions from model / controller to be displayed on reporting page section of the web page. The report's page is used to display the summary totals of the lake host project. To achieve this we selected the data from the summary table of the database and summed it up. We have multiple tables being displayed to help make the page more readable. Using just one table was not ideal, as the data was overflowing off the screen and a scroll bar was needed to read the data.

Views:
 * All Reports - displays all report summaries if called upon by the user. If no data is available or there is no database connection, an error message will be displayed.


 * Report by Date - displays reports summaries filtered by date if called upon by the user. If no data is available or there is no database connection, an error message will be displayed.


 * Report by Boat Ramp - displays reports summaries filtered by boat ramp if called upon by the user. If no data is available or there is no database connection, an error message will be displayed.


 * Report by Group - displays reports summaries filtered by group if called upon by the user. If no data is available or there is no database connection, an error message will be displayed.