Moodle Configurable Reports Plugin All Variables and Filters

Configurable Reports is a popular plugin for Moodle that allows administrators to create custom reports for Moodle and make them available to their end users. In working with this plugin I have noticed that it can be difficult to track down all the variables and filters you can use in creating reports. Below are a list of all of the options.

Variables

%%CATEGORYID%%

%%COURSEID%%

%%CURRENTUSER%%

%%DEBUG%%

%%FILTER_VAR%%

%%STARTTIME%%','%%ENDTIME%%

%%USERID%%

%%WWWROOT%%

Filters

%%FILTER_CATEGORIES:

%%FILTER_COURSEMODULEID:

%%FILTER_COURSEMODULEFIELDS:

%%FILTER_COURSEMODULE:

%%FILTER_COURSES:

%%FILTER_COURSEENROLLEDSTUDENTS:

%%FILTER_USERS:

%%FILTER_ROLE:

%%FILTER_SEARCHTEXT:

%%FILTER_SEMESTER:

%%FILTER_STARTTIME:

%%FILTER_ENDTIME:

%%FILTER_SUBCATEGORIES:

%%FILTER_COURSEUSER:

%%FILTER_SYSTEMUSER:

%%FILTER_YEARHEBREW:

%%FILTER_YEARNUMERIC:

Using Variables

Variables can be used anywhere inside of your SQL query. 

Using Filters

When using a filter you need at least one static WHERE condition then you list one or more filters. For example

WHERE 1

%%FILTER_COURSES:c.id%%

You can technically add multiple filters, but once a user applies one filter to a report all filters for report are applied. So it can be a little tricky to have multiple filters on the same report. For example if you add a course and date filter to a report, then if you just want to filter by course you have to make sure your date filters are set to date range that covers all courses.

Many of the filters are hard code to be drop down menus which are sorted by database id number instead of alphabetically. This can be problematic if you have a large number of users, courses, or categories. However, you can use one search text filter per report, which can be used to work around the issue in some cases.

Many filters require a logical operator to specify how the filter works. For example

%%FILTER_STARTTIME:l.TIME:>%% %%FILTER_ENDTIME:l.TIME:<%%