reportbuilder

These docs are still under construction. Contact simon ~dot~ coggins ~at~ totaralms {dot} com for more details or suggestions for improvements.

Report Builder technical documentation

Specification. We are currently working on porting Report Builder, see http://tracker.moodle.org/browse/MDL-30193 for more details. Here is an outline of the work remaining.

A list of potential report sources is being compiled. This will help us decide what report sources are most helpful to implement.

User Stories.

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