Changes between Version 9 and Version 10 of SumStatsPlugin

Timestamp:

Jan 3, 2012, 2:32:08 AM (12 years ago)

Author:

Rob Guttman

Comment:

--

SumStatsPlugin

@@ -2 +2 @@
 
 = Sums specified field in Roadmap and Milestone stats =
+
+'''UPDATE (2 Jan 2012)''': This plugin now also provides a [http://code.google.com/apis/chart/ Google Visualization API] data source at {{{/sumstats/query}}} that can populate a burndown chart such as provided by the Trac [wiki:VisualizationPlugin#Burndownchartonmilestonepages Visualization plugin] on milestone pages.
 
 == Description ==
@@ -10 +12 @@
 
 This plugin was inspired by the CustomRoadmapPlugin but overcomes its limitation of requiring a patch.  Additionally, this plugin allows for any field to be used to define a group, not just the default {{{status}}} field.  Lastly, I designed the plugin to be backwards compatible with the default ticket count behavior so that you can leverage as much or little of its enhancements as desired.
+
+The plugin also provides a [http://code.google.com/apis/chart/ Google Visualization API] data source at {{{/sumstats/query}}} that can populate a burndown chart.  See [below] for an example.
 
 == Configuration ==
@@ -99 +103 @@
 In general, the plugin maintains the same syntax and semantics as the {{{DefaultTicketGroupStatsProvider}}} to support backwards compatibility and ease of transition.  If the {{{.field}}} option is omitted, then the {{{status}}} field is presumed.  Note that a {{{.color}}} option is required for each group (except for any default {{{closed}}} or {{{new}}} group you have).  The "catch all" {{{*}}} value is also still supported (although there are currently no checks for duplicate "catch all" or otherwise redundant group definitions).
 
+
+
+== Google Visualization API Data Source - for Burndown Chart ==
+This plugin also provides a [http://code.google.com/apis/chart/ Google Visualization API] data source using the [http://code.google.com/apis/chart/interactive/docs/dev/gviz_api_lib.html python gviz client library] (which must be installed separately) that can populate a daily [http://en.wikipedia.org/wiki/Burn_down_chart burndown chart].  The [wiki:VisualizationPlugin#Burndownchartonmilestonepages Visualization plugin] can be used to display the burndown chart on milestone pages:
+
+[[Image(burndown.png)]]
+
+No additional configuration is required to enable the burndown data source.  It is accessed at:
+
+ http://<your-trac-domain>/sumstats/query
+
+The above request returns a data table (in json response format) of up to four columns:
+
+ * {{{day}}} - the day
+ * {{{total}}} - the total sum or count for the day (both losed as {{{fixed}}} and not closed)
+ * {{{todo}}} - the remaining (i.e., not closed) sum or count for the day
+ * {{{done}}} - the completed (i.e., closed as {{{fixed}}}) sum or count for the day
+
+The default response includes the {{{day}}}, {{{todo}}}, and {{{done}}} fields in that order.  To change which fields are returned and/or their order (e.g., to display the data in alternatively configured charts), you can add a (partial) query (i.e., the {{{tq}}} portion below):
+
+ http://<your-trac-domain>/sumstats/query?tq=select total,done
+
+Only the select phrase is used at this time to specify which columns to return and their order.  The {{{day}}} field is always the first column and should be omitted from the select phrase.  You may need to urlencode the {{{tq}}} value.
+
+Let me know if you need additional flexibility in the query and I'll consider adding it.
+
 == Recent Changes ==