reportbuilder: Difference between revisions
From MoodleDocs
No edit summary |
No edit summary |
||
| (18 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{obsolete}} | |||
{{Work in progress}} | |||
=Report Builder technical documentation= | =Report Builder technical documentation= | ||
We are currently working on porting Report Builder, see [[Report_Builder_Specification|the Report Builder specification]] for more details. | |||
The original user stories (which will no longer be followed) [[reportbuilder/spec_as_user_stories|are available here]]. | |||
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. | [[reportbuilder/API|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. | It is also possible to create new content and access restrictions, filter types, and display functions. | ||
| Line 11: | Line 15: | ||
==Beginner Topics== | ==Beginner Topics== | ||
* [[ | * [[reportbuilder/Overview|Overview]] | ||
* [[ | * [[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]] | ||
* [[ | * [[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 35: | ||
==Advanced Topics== | ==Advanced Topics== | ||
* [[ | * [[reportbuilder/Advanced_Joins|Advanced Joins]] TODO | ||
* [[ | * [[reportbuilder/Grouping_and_Aggregation|Grouping and Aggregation]] TODO | ||
* [[ | * [[reportbuilder/Content_Restrictions|Content Restrictions]] TODO | ||
* [[ | * [[reportbuilder/Access_Restrictions|Access Restrictions]] TODO | ||
* [[ | * [[reportbuilder/Parameter_Restrictions|Parameter Restrictions]] TODO | ||
* [[ | * [[reportbuilder/Required_Columns|Required Columns]] TODO | ||
* [[ | * [[reportbuilder/Preprocessors|Preprocessors]] TODO | ||
* Creating new filter options | * Creating new filter options | ||
==Embedded Reports== | ==Embedded Reports== | ||
* Overview | * [[reportbuilder/embeddedoverview|Overview]] | ||
* Access restrictions in embedded reports | * Access restrictions in embedded reports | ||
* Embedded reports in My Reports list | * Embedded reports in My Reports list | ||
| Line 50: | Line 54: | ||
==Troubleshooting== | ==Troubleshooting== | ||
* Common Exceptions (automatic | * Common Exceptions (automatic error checks) | ||
* Other errors | * Other errors | ||
* Debugging tools | * Debugging tools | ||
* Choosing a base table / Performance | * Choosing a base table / Performance | ||
* [[reportbuilder/benchmarks|Performance benchmarks]] | |||
Latest revision as of 13:38, 14 October 2021
| Warning: This page is no longer in use. The information contained on the page should NOT be seen as relevant or reliable. |
Note: This page is a work-in-progress. Feedback and suggested improvements are welcome. Please join the discussion on moodle.org or use the page comments.
Report Builder technical documentation
We are currently working on porting Report Builder, see the Report Builder specification for more details.
The original user stories (which will no longer be followed) are available here.
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
- 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
- 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
- Advanced Joins TODO
- Grouping and Aggregation TODO
- Content Restrictions TODO
- Access Restrictions TODO
- Parameter Restrictions TODO
- Required Columns 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 error checks)
- Other errors
- Debugging tools
- Choosing a base table / Performance
- Performance benchmarks
