Note:

If you want to create a new page for developers, you should create it on the Moodle Developer Resource site.

reportbuilder/Overview

From MoodleDocs
Revision as of 14:05, 24 June 2022 by Andrew Nicols (talk | contribs) (Note about plan not to migrate this page to the new developer resources. See template for more info.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)


Warning: This page is no longer in use. The information contained on the page should NOT be seen as relevant or reliable.


Back to Index

Report builder provides an interface to allow administrators to generate reports, customise their appearance, then make them available to groups of users. It is designed to be easily extensible, so developers can add to existing report sources and write their own to allow administrators to generate the kind of reports they are interested in.

Full list of features

Each report generated by a user is based on a "report source". Which defines:

  • Which set of data makes up each "record" of the table (e.g. courses, users, face-to-face sessions)
  • Which columns, filters and content restrictions are available to an administrator to include in a report
  • A default setup for the table that is generated when the report is first created (to help you get going quickly)

Report sources are written by developers and are just a PHP file containing the information needed to generate the report. There are some helper functions to allow developers to easily add commonly needed columns and filters (such as user profile fields, course information, etc).


Other topics

TODO

  • Data can be user input saved to db or embedded
  • Code, base source, individual sources.
  • File format and location of sources
  • Source classes and documentation
  • When it is necessary to rebuild a report when editing the source