reportbuilder: Difference between revisions
From MoodleDocs
(Created page with "See http://tracker.moodle.org/browse/MDL-30193 for more details =Report Builder technical documentation= These docs are still under construction. Contact simon ~dot~ coggins ~a...") |
No edit summary |
||
| Line 1: | Line 1: | ||
=Report Builder technical documentation= | |||
See http://tracker.moodle.org/browse/MDL-30193 for more details | See http://tracker.moodle.org/browse/MDL-30193 for more details | ||
These docs are still under construction. Contact simon ~dot~ coggins ~at~ totaralms {dot} com for more details. | These docs are still under construction. Contact simon ~dot~ coggins ~at~ totaralms {dot} com for more details. | ||
| Line 9: | Line 9: | ||
It is also possible to create new content and access restrictions, filter types, and display functions. | It is also possible to create new content and access restrictions, filter types, and display functions. | ||
=Beginner Topics= | ==Beginner Topics== | ||
* [[Docs/tech/reportbuilder/Overview|Overview]] TODO | * [[Docs/tech/reportbuilder/Overview|Overview]] TODO | ||
| Line 18: | Line 18: | ||
* [[Docs/tech/reportbuilder/Setting_Default_Columns_and_Filters|Setting Default Columns and Filters]] | * [[Docs/tech/reportbuilder/Setting_Default_Columns_and_Filters|Setting Default Columns and Filters]] | ||
=Intermediate Topics= | ==Intermediate Topics== | ||
* [[Docs/tech/reportbuilder/Column_Display_Functions|Column Display Functions]] | * [[Docs/tech/reportbuilder/Column_Display_Functions|Column Display Functions]] | ||
| Line 29: | Line 29: | ||
* Dynamic joins, column options and filter options | * Dynamic joins, column options and filter options | ||
=Advanced Topics= | ==Advanced Topics== | ||
* [[Docs/tech/reportbuilder/Content_Restrictions|Content Restrictions]] TODO | * [[Docs/tech/reportbuilder/Content_Restrictions|Content Restrictions]] TODO | ||
| Line 40: | Line 40: | ||
* Creating new filter options | * Creating new filter options | ||
=Embedded Reports= | ==Embedded Reports== | ||
* Overview | * Overview | ||
| Line 48: | Line 48: | ||
* Embedded parameters | * Embedded parameters | ||
=Troubleshooting= | ==Troubleshooting== | ||
* Common Exceptions (automatic check errors) | * Common Exceptions (automatic check errors) | ||
Revision as of 07:00, 8 June 2012
Report Builder technical documentation
See http://tracker.moodle.org/browse/MDL-30193 for more details
These docs are still under construction. Contact simon ~dot~ coggins ~at~ totaralms {dot} com 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
