Changes between Version 40 and Version 41 of BluePrint/Reporting


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

--

Legend:

Unmodified
Added
Removed
Modified
  • BluePrint/Reporting

    v40 v41  
    3333* All report types should be fully integrated with the [wiki:BluePrintSearch S3Search] module, to allow results to be filtered.
    3434* Provide documentation on how to integrate data from Sahana Eden with other reporting & visualisation tools & APIs
     35* Provide some reports suitable for displaying inside popups on Map Polygons [wiki:BluePrintGISFeatureLayers]
    3536
    3637=== Report Gallery ===
     
    4041
    4142
    42 
    43 
    44 e.g. for BluePrintImpact
    45 
    46 These can be implemented as an [wiki:S3XRC_ResourceReport S3XRC Custom method]
    47 
    4843== Use-Cases ==
    4944
     
    5146=== Design Options ===
    5247
    53 ==== Custom S3XRC Method ===
     48==== Custom S3XRC Method ====
     49Instructions: [wiki:S3XRC_ResourceReport S3XRC Resource Report][[BR]]
     50
    5451The custom S3XRC would allow reporting for Sahana Eden resources. Vars could be be used to specify how the report is generated, eg:
    5552* What type of report to generate.
    5653* What fields would be represented on what graph axises.
    5754
    58 === Chart Module ===
     55==== Chart Module ====
    5956''OLD - this section may now be redundant, but my provide some ideas''
    6057This 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.
     
    7168|| '''Variable''' || List || Pivot Tables || Bar Charts || Pie Charts || Scatter Charts || Maps || Timeline || Motion Chart ||
    7269||  Data (list)  || n      ||  1                  ||  2           ||  1               ||  -                  || n (layers)        ||  1 (although a record can be represented  || 2 (Color & Size)   ||
    73 || X Axis        ||       ||  x                 ||                  ||                 ||  x                    ||          ||               || x                     ||
     70|| X Axis        ||       ||  x                 ||                  ||                 ||  x                    ||          ||               ||  x                    ||
    7471|| Y Axis        ||       ||  x                 ||                  ||                 ||  x                    ||          ||               ||  x                    ||
    7572||                   ||       ||                    ||                  ||                 ||                        ||          ||               ||                      ||
     
    8885* ReportLab
    8986
     87=== Charts ===
    9088
    9189
    9290
     91
     92
     93
     94== Tools / Libraries / APIs ==
     95
    9396=== Charts ===
    94 For quick visualisations in the browser, we have included [http://www.jqplot.com jqPlot].
    95 
    96 We have included the [http://healthscapes.org Healthscapes] !SaVaGe library to easily output SVG graphs:
    97  * [wiki:DeveloperGuidelinesSVG]
    98  * We should have a recommended tested SVG plugin for Internet Explorer < 9
    99   * http://www.savarese.com/software/svgplugin/ (not 64-bit)
    100   * http://www.adobe.com/svg/viewer/install/ (Not maintained - e.g. no Windows 7 support)
    101   * Background page: http://www.w3.org/Graphics/SVG/IG/wiki/SVG_Plugin_for_IE
    102 
    103 T2 includes a basic barchart function:
     97* Current the following chart tools are included in Sahana Eden:
     98 * [http://www.jqplot.com jqPlot].
     99 * [http://matplotlib.sourceforge.net/faq/howto_faq.html#matplotlib-in-a-web-application-server Matplotlib]
     100 * The [http://healthscapes.org Healthscapes] !SaVaGe library is included to easily output SVG graphs. See: [wiki:DeveloperGuidelinesSVG]
     101  * Outputs SVG graphs
     102  * We should have a recommended tested SVG plugin for Internet Explorer < 9
     103   * http://www.savarese.com/software/svgplugin/ (not 64-bit)
     104   * http://www.adobe.com/svg/viewer/install/ (Not maintained - e.g. no Windows 7 support)
     105   * Background page: http://www.w3.org/Graphics/SVG/IG/wiki/SVG_Plugin_for_IE
     106* http://www.reynoldsftw.com/2009/02/6-jquery-chart-plugins-reviewed/
     107 * Recommends [http://code.google.com/p/flot/ Flot]: "''From an interaction perspective, Flot by far will get you as close as possible to Flash graphing as you can get with jQuery.''"
     108* [http://www.web2pyslices.com/main/slices/take_slice/12 Cairo] can generate nice charts from the back-end
     109* T2 includes a basic barchart function:
    104110{{{
    105111def barchart(data,width=400,height=15,scale=None,
     
    114120}}}
    115121
    116  * [http://matplotlib.sourceforge.net/faq/howto_faq.html#matplotlib-in-a-web-application-server Matplotlib] can generate visualisations
    117  * [http://www.web2pyslices.com/main/slices/take_slice/12 Cairo] can generate nice charts from the back-end
     122=== Spreadsheets ===
     123* Excel files are currently written using [http://pypi.python.org/pypi/xlwt xlwt].
     124* [http://sourceforge.net/projects/pyexcelerator PyExcelerator]
     125* Docs on Python Excel libraries: http://www.python-excel.org/
     126* Thread recommending xlwt: http://groups.google.com/group/web2py/browse_thread/thread/375307e92df40ca8
     127* [http://appyframework.org/pod.html Pod] to create Open Document Format
    118128
    119 === Map ===
    120 We want to be able to provide reports suitable for displaying inside popups on Map Polygons:
    121  * [wiki:BluePrintGISFeatureLayers]
    122 
    123 === PDF ===
    124 For more formal reports (which can also be retrieved via webservices using the PDF representation of the REST Controller), we currently use [http://reportlab.org ReportLab]. This also supports Graphics (via [http://www.pythonware.com/products/pil/ PIL])
    125 
    126 === Spreadsheets ===
    127 Excel files are currently written using [http://pypi.python.org/pypi/xlwt xlwt].
    128 
    129 == References ==
    130 
    131 === Other Available Tools ===
    132 === PDF ===
    133 Other options:
    134  * http://www.reynoldsftw.com/2009/02/6-jquery-chart-plugins-reviewed/
    135   * Recommends [http://code.google.com/p/flot/ Flot]: "''From an interaction perspective, Flot by far will get you as close as possible to Flash graphing as you can get with jQuery.''"
    136  * [http://www.xhtml2pdf.com Pisa] uses [http://reportlab.org ReportLab] to generate PDF from HTML
    137  * [http://code.google.com/p/jspdf jsPDF] uses pure !JavaScript to create PDFs
    138  * [http://geraldo.sourceforge.net Geraldo] builds on !ReportLab, and we used to use this, but no longer
    139  * Use S3XRC & hence XSLT to generate XML-FO which can be converted to PDF
    140   * http://xmlgraphics.apache.org/fop/
    141   * http://pypi.python.org/pypi/zopyx.convert/
    142   * [http://osdir.com/ml/python.reportlab.user/2003-10/msg00206.html Recommend ReportLab over FOP]
    143 
    144 ==== Spreadsheets ====
    145  * [http://sourceforge.net/projects/pyexcelerator PyExcelerator]
    146  * Docs on Python Excel libraries: http://www.python-excel.org/
    147  * Thread recommending xlwt: http://groups.google.com/group/web2py/browse_thread/thread/375307e92df40ca8
    148  * [http://appyframework.org/pod.html Pod] to create Open Document Format
    149 
    150 ==== Flash ====
     129=== Flash ===
    151130Could be something to use Flash? (although best-avoided, if possible, to minimise client support)
    152131 * PyAMF: http://pyamf.org
     
    157136  * from Python: http://code.google.com/p/open-flash-chart-python/
    158137
     138=== Other ===
     139
     140
     141== References ==
    159142=== Sahana Phase 2 ===
    160143http://wiki.sahanafoundation.org/phase2/doku.php/doc:reports:english