Changes between Version 12 and Version 13 of S3/S3Report

Timestamp:

04/19/12 10:48:55 (13 years ago)

Author:

James O'Neill

Comment:

--

S3/S3Report

@@ -20 +20 @@
 Python 2.7 is recommended for S3Cube, however it would work with Python 2.6.
 
-== URL methods ==
+[=#url_methods]
+== URL Methods ==
 
 S3Cube responds to the {{{analyze}}} URL method, for ''all'' resources (generic method).
@@ -59 +60 @@
   - http://localhost:8000/eden/org/office/analyze?rows=type&aggregate=count
   - http://localhost:8000/eden/org/organisation/analyze?rows=sector_id
+
+== Report Options ==
+
+Table configurations can contain a `report_options` item, which is a Storage object. This object is used to configure reports and report options form.
+
+The `rows`, `cols`, `facts` and `aggregate` items are lists of available values for the user to select from.
+
+The `defaults` item is a Storage object that contains the default values for the report. It can contain a value for `rows`, `cols`, `fact`, `aggregate` and `totals` (as described in [#URLMethods URL Methods]).
+
+Here is an example of a `report_options` item:
+{{{#!python
+report_options=Storage(
+        rows=report_fields,
+        cols=report_fields,
+        facts=report_fields,
+        defaults=Storage(
+                rows="project_id",
+                cols="name",
+                fact="time_actual",
+                aggregate="sum",
+                totals=True
+        )
+}}}
+
+All items in `report_options` and `defaults` are optional.
+
 == Further Development ==
 
 The following enhancements are currently under development:
 
-  - Totals row and column
   - Support for JSON, CSV and XLS exports
   - Support for client-side graphs representation (via JSON)