reportbuilder: Difference between revisions
From MoodleDocs
No edit summary |
No edit summary |
||
| Line 11: | Line 11: | ||
==Beginner Topics== | ==Beginner Topics== | ||
* [[ | * [[reportbuilder/Overview|Overview]] TODO | ||
* [[ | * [[reportbuilder/Hello_World_Source|Hello World Source]] | ||
* [[ | * [[reportbuilder/Adding_a_Column|Adding a Column]] | ||
* [[ | * [[reportbuilder/A_Basic_Join|A Basic Join]] | ||
* [[ | * [[reportbuilder/Adding_a_Filter|Adding a Filter]] | ||
* [[ | * [[reportbuilder/Setting_Default_Columns_and_Filters|Setting Default Columns and Filters]] | ||
==Intermediate Topics== | ==Intermediate Topics== | ||
* [[ | * [[reportbuilder/Column_Display_Functions|Column Display Functions]] | ||
* [[ | * [[reportbuilder/Combining_Multiple_Fields|Combining Multiple Fields]] | ||
* [[ | * [[reportbuilder/Advanced_Column_Options|Advanced Column Options]] | ||
* [[ | * [[reportbuilder/Advanced_Filter_Options|Advanced Filter Options]] TODO | ||
* [[ | * [[reportbuilder/Predefined_Common_Options|Predefined Common Options]] TODO | ||
* [[ | * [[reportbuilder/General_Report_Options|General Report Options]] TODO | ||
* Storing files: Report sources, embedded report definitions and language strings | * Storing files: Report sources, embedded report definitions and language strings | ||
* Dynamic joins, column options and filter options | * Dynamic joins, column options and filter options | ||
| Line 31: | Line 31: | ||
==Advanced Topics== | ==Advanced Topics== | ||
* [[ | * [[reportbuilder/Content_Restrictions|Content Restrictions]] TODO | ||
* [[ | * [[reportbuilder/Access_Restrictions|Access Restrictions]] TODO | ||
* [[ | * [[reportbuilder/Parameter_Restrictions|Parameter Restrictions]] TODO | ||
* [[ | * [[reportbuilder/Advanced_Joins|Advanced Joins]] TODO | ||
* [[ | * [[reportbuilder/Required_Columns|Required Columns]] TODO | ||
* [[ | * [[reportbuilder/Grouping_and_Aggregation|Grouping and Aggregation]] TODO | ||
* [[ | * [[reportbuilder/Preprocessors|Preprocessors]] TODO | ||
* Creating new filter options | * Creating new filter options | ||
Revision as of 07:02, 8 June 2012
These docs are still under construction. Contact simon ~dot~ coggins ~at~ totaralms {dot} com for more details.
Report Builder technical documentation
See http://tracker.moodle.org/browse/MDL-30193 for more details
Report builder has an API intended to make it easy to extend the functionality in a number of ways. The primary feature is the ability to write report sources, that allow the user to generate reports based on specific data from within moodle.
It is also possible to create new content and access restrictions, filter types, and display functions.
Beginner Topics
- Overview TODO
- Hello World Source
- Adding a Column
- A Basic Join
- Adding a Filter
- Setting Default Columns and Filters
Intermediate Topics
- Column Display Functions
- Combining Multiple Fields
- Advanced Column Options
- Advanced Filter Options TODO
- Predefined Common Options TODO
- General Report Options TODO
- Storing files: Report sources, embedded report definitions and language strings
- Dynamic joins, column options and filter options
Advanced Topics
- Content Restrictions TODO
- Access Restrictions TODO
- Parameter Restrictions TODO
- Advanced Joins TODO
- Required Columns TODO
- Grouping and Aggregation TODO
- Preprocessors TODO
- Creating new filter options
Embedded Reports
- Overview
- Access restrictions in embedded reports
- Embedded reports in My Reports list
- Resetting to defaults
- Embedded parameters
Troubleshooting
- Common Exceptions (automatic check errors)
- Other errors
- Debugging tools
- Choosing a base table / Performance
