GROUND REPORT 1.5 DOCUMENTATION

GENERAL INFORMATION

Notes

USE OF THE GRAPHING/REPORTING IS ENTIRELY OPTIONAL.

THE BACKEND DB DOES ALL THE WORK.

YOU CAN USE WHATEVER GRAPHING OR REPORTING UTILITY YOU LIKE TO CREATE GRAPHS OR REPORTS ON THE PROCESSED DATA THATS IN THE DB.

Directory Listing

GROUNDREPORT_HOME
  |
  `-bin
  |
  `-docs
  |   |
  |   `-db_schema
  |   |
  |   `-www
  |       |
  |       `samples
  |
  `-etc
  |
  `-includes
  |   |
  |   `-en
  |
  `-lib
  |
  `-output
  |   |
  |   `-archives
  |   |
  |   `-images
  |   |
  |   `-reports
  |
  `-style
  |   |
  |   `-css
  |   |
  |   `-xsl
  |
  `-watermark  

Language Support

Currently there is only an english version of the text included in the reports.
To support your language simply create a new directory under the includes directory and give it a short name representing your language.

   EG. $GROUNDREPORT_HOME/includes/en
          $GROUNDREPORT_HOME/includes/fr
          $GROUNDREPORT_HOME/includes/es
          $GROUNDREPORT_HOME/includes/de

Copy in the files from the en (english) directory.
Translate the text in the files to your language.

   NB. do not translate the variable names or the XML tags

Change the lang option in the groundReport.properties file to the short name of your directory.
If you're feeling generous you could always donate your translation back to the project.

TODO List

Reports

Create more reports:    Detailed report/Article

Create better CSS for xhtml report

Scripts

Create script to create descriptions file from test scripts.

Graphs

Create more graphs that are relevant:

   Response Time @ 95th Percentile graphs
   Normal distribution stats graphs?

Place mean value markers on distribution graphs
Place 95th percentile value markers on percentile graphs

Make graphs prettier:

   Choose better colours
   Make formatting nicer
   Look at generating smoother lines

Database

Investigate further changes for db:

   is it worth doing moving the quantile buckets from 1second to 10 seconds for smoother graphs?
   Look at incremental refreshes of materialised views to reduce impact of multiple large datasets.

Application

Clean up the code

Look at creating a web interface

Look at moving to restructure text from docbook xml to give greater flexibility over report look and feel.