Changes between Version 39 and Version 40 of BluePrint/Reporting


Ignore:
Timestamp:
01/08/12 21:07:07 (10 years ago)
Author:
Michael Howden
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • BluePrint/Reporting

    v39 v40  
    33
    44== Description ==
    5 == Requirement ==
     5Sahana Eden can be used to collect and manage a large variety of data. For this data to add value it needs to be processed and shared in a way in which it can present the information people need to make decisions and plan activities. To achieve this Sahana Eden should be able to produce reports which analyse and visualize data in a flexible, user friendly and configurable way.
    66
    7 We need to be able to generate Pretty & Informative Reports from the database.
     7== Requirements ==
     8
     9=== Types of Reports ===
     10* List
     11* Pivot Tables
     12* Bar Charts
     13* Pie Charts
     14* Scatter Charts
     15* Maps
     16* Timeline
     17* Motion Chart
     18 * http://code.google.com/apis/chart/interactive/docs/gallery/motionchart.html
     19What else?
     20
     21=== Functionality ===
     22* The ability to easily switch between displaying the same data on various types of reports. eg:
     23 * List -> Map
     24 * Pivot Table -> PIe Chart
     25 * Map -> Graph ( for a particular location on the map )
     26* Drill down within an report to set search criteria, eg:
     27 * Select a single bar in a chart
     28  * Select a point, box, polygon on a map
     29  * Select a wedge in a pie chart
     30* Export Reports
     31 * Tables -> XLS
     32 * Maps/Graphs -> PNG
     33* All report types should be fully integrated with the [wiki:BluePrintSearch S3Search] module, to allow results to be filtered.
     34* Provide documentation on how to integrate data from Sahana Eden with other reporting & visualisation tools & APIs
     35
     36=== Report Gallery ===
     37
     38
     39=== Integration with ADAT ===
     40
     41
     42
    843
    944e.g. for BluePrintImpact
     
    1146These can be implemented as an [wiki:S3XRC_ResourceReport S3XRC Custom method]
    1247
    13 === Filtering ===
    14 We will want to be able to customise reports by allowing the user to filter the data (this could include fields in the resource, components and reference resources)
    15 
    16 An example is:
    17 eg http://demo.drrprojects.net/drrp/drrpp/project/search
    18 Code:
    19 https://code.launchpad.net/~michael-howden/sahana-eden/adpc
    20 
    21 ==== Location Filtering ====
    22 We need to be able to fitler by a location so that it shows data in all locations which are children of that location (eg villages in a district)
    23 
    2448== Use-Cases ==
    2549
    2650== Design ==
     51=== Design Options ===
    2752
    28 === Custom s3xrc method ===
    29 The custom s3xrc Would allow quick visualisations of resources on the server. There would need to be vars specifying which variables go in which axis in each resource.
     53==== Custom S3XRC Method ===
     54The custom S3XRC would allow reporting for Sahana Eden resources. Vars could be be used to specify how the report is generated, eg:
     55* What type of report to generate.
     56* What fields would be represented on what graph axises.
    3057
    31 === Report model/view/controller ===
    32 This module could provide the user with the ability to create and embed graphs in their instance of sahana. The idea is to provide the user with the ability display any set of data; it need not be tied to a resource or may be a more complex combination of variables than provided in the sahana framework. The graphs could be in svg format allowing for interactivity. The files themselves could also be stand alone so that they could be easily exported and saved locally.
     58=== Chart Module ===
     59''OLD - this section may now be redundant, but my provide some ideas''
     60This module could provide the user with the ability to create and embed charts in Sahana Eden. The idea is to provide the user with the ability display any set of data; it need not be tied to a resource or may be a more complex combination of variables than provided in the Sahana Eden framework. The graphs could be in svg format allowing for interactivity. The files themselves could also be stand alone so that they could be easily exported and saved locally.
    3361
    3462The basic workflow would be:
    35   * Create a graph with a web-form or file upload using report/scatter/create. There numerous settings that could be altered to create different a looks and feel. 
     63  * Create a charts with a web-form or file upload using report/scatter/create. There numerous settings that could be altered to create different a looks and feel. 
    3664    * Or it can be created with a call to the url with the data as vars, such as report/scatter/create?data={"x": [1, 2, 3], "y": [3, 4, 3], "title": "Test Title"}&settings={"width": 300, "height": 200}
    3765  * An entry gets created in the database for the graph. It can be retrieved an and inserted into a web-page in an object or embed tag, such as <object data="/eden/report/scatter/get.svg?id=1" />
     
    3967    * Or, the graphs can be represented without an entry in the database using report/scatter/create?view.svg={"x": [1, 2, 3], "y": [3, 4, 3], "title": "Test Title"}&settings={"width": 300, "height": 200}
    4068
     69=== Design Notes ===
     70* It may be useful to identify a common set of variables which are needed to generate different Types of Reports
     71|| '''Variable''' || List || Pivot Tables || Bar Charts || Pie Charts || Scatter Charts || Maps || Timeline || Motion Chart ||
     72||  Data (list)  || n      ||  1                  ||  2           ||  1               ||  -                  || n (layers)        ||  1 (although a record can be represented  || 2 (Color & Size)   ||
     73|| X Axis        ||       ||  x                 ||                  ||                 ||  x                    ||          ||               || x                     ||
     74|| Y Axis        ||       ||  x                 ||                  ||                 ||  x                    ||          ||               ||  x                    ||
     75||                   ||       ||                    ||                  ||                 ||                        ||          ||               ||                      ||
     76
     77
    4178== Implementation ==
    4279
    43 === Misc Existing Functionality ===
    44 (To be sorted)
     80=== Existing Functionality ===
     81* S3Chart (no documentation)
     82* BluePrintSearch
     83 * BluePrintGISLocationsSearch
     84DeveloperGuidelines/SaveSearchAndSubscription
     85BluePrintGISLocationsSearch
     86S3Cube
    4587* DeveloperGuidelinesSVG
    4688* ReportLab
     89
     90
     91
    4792
    4893=== Charts ===