MoodleDocs - User contributions [en]

Header and footer

2020-07-27T08:46:49Z

Libertymoodle: /* 'Get the mobile app' rewording link */

{{Site appearance}}
You can easily add links and other information to the top and bottom, and header and footer of your Moodle site.

== Customising the header==
*The administrator can add links, metatags, CSS or Java Script to the header section of your page via ''Site administration > Appearance > Additional HTML''
*You can specify HTML or CSS or JavaScript that you want added to every page without altering the Moodle code files.
* Add your HTML/CSS to the' Within HEAD' box

{|
| [[File:headerbox.png|thumb|400px|Adding HTML]]
| [[File:headerlink.png|thumb|400px|The resulting text]]
|}

===Dropdown menus===
Although not strictly in the 'header' section, custom dropdown menus may be added to the top of your site via ''Site administration > Appearance > Themes > Theme settings'' and adding your links to the Custom menu box, using the examples given to help you.

[[File:custommenu.png|thumb|center|500px|Example of a site with custom dropdown menus]]

==Customising the footer==

*As with header options in the section above, the administrator can add links, CSS or Java Script to the footer section of your page via ''Site administration > Appearance > Additional HTML''
*This might be useful for adding Google Analytics, for example.
* Add your HTML/CSS to the 'Before BODY is closed' box.

===Footer link to Moodle docs===

*Moodle Docs is an abbreviation for ''Moodle documentation''.
*By default, managers, teachers and non-editing teachers (and any other users with the capability [[Capabilities/moodle/site:doclinks|moodle/site:doclinks]]) have "Moodle Docs for this page" links at the bottom of each page in Moodle for accessing context-specific documentation.

[[File:MoodleDocsforthispageScreenshot.png|thumb|center|400px|'Moodle Docs for this page' link]]

*An administrator can change Moodle Docs settings in ''Administration > Site administration > Appearance > Moodle Docs''. The link can be made to open in a new window; the docs language may be forced, and the docs link may be removed by removing the link from the Moodle docs document root field.
*If you have your own custom documentation online or wish to link to other documentation online, you can change the link in this Moodle docs document root field.
*You can download the Moodle Docs files for several branches and languages of Moodle Docs from [http://wimski.org/docs/ http://wimski.org/docs/]. These files can be hosted in a local intranet and this may be useful for places that have strict internet policies that prevent Moodle users from reaching [https://docs.moodle.org/en/Main_page The Moodle Docs site].

=='Get the mobile app' link==

In Moodle 3.4 onwards, the link 'Get the mobile app' in the footer encourages users to make use of the [[Moodle Mobile]] app.

By default, the link is https://download.moodle.org/mobile however the setting 'App download page' (in 'Mobile appearance' in the Site administration) can be changed e.g. for sites using a branded mobile app.

To prevent the 'Get the mobile app' link being displayed in the footer, simply remove the URL from the 'App download page' setting so that the field is blank and then save changes.

If mobile services are not enabled for the site, then the 'Get the mobile app' link is not displayed.

==Theme settings options==
Some themes allow you to add custom CSS and footer text via their settings pages The standard 'Clean' and 'More' themes offer this option, via ''Site administration > Appearance > Themes > Clean/More''

{|
| [[File:morefootnotebox.png|thumb|400px|Adding content to the footer in the More settings page]]
| [[File:morefootnote.png|thumb|400px|The resulting text]]
|}

==Customising the 'main body' section==
*As with header and footer options, you can add code and script to the main body of the page.
*This might be useful for adding a banner image, a text heading or an alert message for example.
* Add your content to the 'When BODY is opened' box.

==See also==

* [[Theme settings]] for details of how to set up custom menu items
* [http://wimski.org/docs/ http://wimski.org/docs/] for downloading offline Moodle Docs pages.

[[de:Kopf- und Fußzeile]]
[[es:Encabezado y pie de página]]
[[fr:Entête et pied de page]]

Automated course backup

2020-04-15T15:32:54Z

Libertymoodle: /* Setting an automated course backup schedule - add Windows path */

{{Backup}}
==Automating course backups==

Automated course backups runs the same functions as individual [[Course backup|course backups]]. It's a good idea to schedule backups for when your server isn't usually busy. Running the backup tool over all the courses can be processor-intensive, so you shouldn't run it when there are a lot of students trying to access the server. You should always alert users with an announcement on the first page that if they log on during the backup hours they may notice a decrease in performance.

In order to make scheduled backups, you have to set up CRON to run periodically. Please refer to the [[Cron|cron instructions]].

==Setting an automated course backup schedule==

/To set the backup schedule:
#Go to ''Administration > Site administration > Courses > Backups > Automated backup setup''.
#Set backup_auto_active to enabled.
#Select the days of the week to run the backup.
#Set the execution time for the backup process. For most servers, early morning will be the best time. Keep in mind the time zone your server is using.
#Set the "Save to..." path. If you can, choose a backup path on another machine or on a different drive than the one Moodle is on. You don’t want to lose your backups at the same time you lose your Moodle site if the drive fails. If you leave the field blank, then backup zip files will be saved in the backup folder of each course files folder. On a Linux server the path might look like: '''/home/(your user or domain)/public_html/archive/''' or if it's below the publicly accessible folders: '''/home/(your user or domain)/archive/'''. On Windows the path might look like: '''D:\Archive\'''.
If the path is not recognized a red X is shown after saving, otherwise a green check.
#Set all other options appropriately.
#Click the "Save changes" button.

'''Tip''': To save disk space, you can choose to delete backups older than a specified number of days. If so, you should also specify a minimum number of backups to be kept. (The settings 'Delete backups older than' and 'Minimum number of backups kept' are new in Moodle 3.0 onwards.)

Once you've set up your backup schedule, Moodle will automatically create archives of all the courses on the server at the time you specified. Once the backup is complete, Moodle will send you an email describing the status of the backup.

==Backups report==

A last execution log of scheduled course backups can be found in ''Administration > Site administration > Reports > Backups''. It displays a list of all course backups made, the time taken to create them, their status (see below), and the next scheduled automated backup execution time.

Clicking the 'View logs' icon next to the course name (1 in screenshot below) will display a detailed backup log for a particular course, including date, hour and minute when each step of the backup was performed (2). This log is useful for troubleshooting backup errors.

[[File:backuplogs.png|thumb|500px|center|]]

===Backup status===

*'''OK''' - The course backup was successfully completed.
*'''Skipped''' - The course was skipped (not backed up) because the course was unavailable to students and had not been changed in the last 31 days. This is not an error, but a feature designed to save process time.
*'''Unfinished''' - The backup was not finished. This might have happened because the job to execute backups ran out of time or resources (e.g., the cron running the backups ran out of time before finishing all the courses waiting). The unfinished jobs should be completed when the next scheduled backups are repeated.
*'''Error''' - There were errors in the backup process for the course, so a backup was not completed. For additional details about the error (1) check the backup log for the affected course (i.e. click the 'View logs' icon next to the course name) or (2) back up the course manually with debugging turned on to see what error message is displayed.

==Course versus site backups==

*Automated course backups are more expensive in terms of time and CPU usage. The recovery time to have your site running again is longer.
*Course backups are useful for obtaining "fresh" copies of courses to be re-used or distributed individually, however they should never be used as a primary backup system (unless your hosting doesn't allow the preferred [[Site backup|site backups]]).

==Capabilities==

Both the [[Capabilities/moodle/backup:downloadfile|download course backup files capability]] and the [[Capabilities/moodle/restore:userinfo|restore user data from a course backup capability]] are required to be able to download automated course backups. There is also a [[Capabilities/moodle/restore:viewautomatedfilearea|restore courses from the automated backup storage capability]].

[[Category:Report]]
[[Category:Site administration]]

[[eu:Ikastaroen_segurtasun-kopia_automatikoa]]
[[fr:Sauvegarde (administrateurs)#Rapports Sauvegardes]]
[[ja:自動コースバックアップ]]
[[de:Automatische Kurssicherung]]
[[es:Respaldo de curso automatizado]]

Configurable reports

2020-03-17T15:55:33Z

Libertymoodle: /* Filters Issue */

{{Infobox plugin
|type = Block
|entry = https://moodle.org/plugins/view.php?plugin=block_configurable_reports
|tracker = http://tracker.moodle.org/browse/CONTRIB/component/10753
|discussion = https://moodle.org/mod/forum/view.php?id=7979
|maintainer = [[User:Juan Leyva|Juan Leyva]], [[User:Sara Arjona Téllez|Sara Arjona Téllez]]
|float = right
}}

== Installation ==

# Download the Configurable Reports installation file and unzip it to the '''\blocks''' directory in your Moodle folder.
# Be sure that the final name of the directory is: configurable_reports, the full path in your Moodle installation will be blocks/configurable_reports
# Login to Moodle as Administrator and click Notifications under Site Administration.

For more information see [[Installing contributed modules or plugins]]

== Overview ==

This block is a Moodle custom reports builder. It its also connected to a [https://github.com/jleyva/moodle-configurable_reports_repository public repository of sample reports] (only plugin version 2.3 and above)

It is designed in a modular way to allow developers to create new plugins in less than an hour.

'''Who can create custom reports?'''

Anyone with block, managereports or manageownreports permissions at SITE level or COURSE level.

'''What type of reports can I create?'''

- Courses reports, with information regarding courses.

- Categories reports, with information regarding categories. A courses report can be embedded in this type of report.

- Users reports, with information regarding users and their activity in a course.

- Timeline reports, this is a special type of report that displays a timeline. A course or user report can be embedded in this timeline showing data depending on the start and end time of the current row.

- Custom SQL Reports, custom SQL queries. This block can use the same SQL queries as [https://moodle.org/plugins/view.php?plugin=report_customsql Tim Hunt's Custom SQL queries] plugin.

Note for developers: You can create your own type of reports.

'''Who can view the reports?'''

When you create a report you can select which users can view it.

The reports are displayed in a block in the course or site frontpage.

== Creating a report ==

This is a very simple process.

If you are going to create a report for a course, you have to add the block in the course and click in the "Manage reports" link.

On the other hand, for site reports, add the block in the frontpage and click in the "Manage reports" link.

You must enter a name, an optional description, and you have to choose the type of report, pagination and exports formats.

Depending on the report choosen, there will be more or less tabs. These are the tabs for the courses and users report:

'''Columns''': Here you can choose the differents columns of your report depending on the type of report. (Course Name, User firstname, etc..)

'''Conditions''': Here you can define the conditions (i.e, only courses from this category, only users from Spain, etc.)

'''Ordering''': Here you can choose how to order the report using fields and directions.

'''Filters''': Here you can choose which filters will be displayed.

'''Template''': You can modify the report's layout by creating a template.

'''Permissions''': Here you can choose who can view a report.

'''Calculations''': Here you can add calculations for columns, i.e: average of number of users enrolled in courses

'''Plots''': Here you can add graphs to your report based on the report columns and values.

'''View report''': Self explanatory

== Tutorial ==

=== Creating a users' report ===

Requirements: ''Users from Spain, but not from Madrid, in this course. This report can be viewed only by users from Spain. A filter based on the user's city must be displayed. A pie plot showing the users' cities is required. A calculation table showing the total forum post views is required. The report must be ordered by users' lastname.''

Let's see how easy it is!

First of all, install the block.

Go to the course where the report will be created.

Add an instance of the Custom Reports block.

Click on "Manage reports"

Click on "Add report"

Enter a name, a description and choose "Users report" as Type of Report

The report will be saved and you will be redirected to the first Tab named "Columns".

'''Adding Columns'''

Here you can define the report table properties, width, align, cell padding, cell spacing, etc.

Add a Column called "User profile field"

Choose the field "firstname" and enter a name for the column in the text field. You can leave the rest of elements blank.

Repeat the process above for the lastname and city fields.

Add a Column called "User module actions".

Choose a module from the list, in this example, a forum.

'''Adding Conditions'''

Click on the Conditions Tab.

Add a Condition named "User field Condition".

Choose the column "Country", the Operator "=", and enter the value "ES" (this is the international code for Spain as Moodle stores it).

Add a Condition named "User field Condition".

Choose the column "city", the Operator "<>", and enter the value "Madrid".

Add a Condition named "Users in current report course".

These are the main conditions of the reports. Note that at the bottom there is a text box called condition, with this text:

"c2 and c1 and c3"

Here you can define a logic condition, in this case, we don't need to edit this condition but you can create complex expressions like:

(c1 and c2) or (c4 and c3)

'''Adding Ordering'''

Click on the Ordering Tab.

Add a ordering named "User field ordering".

Choose the column "Lastname" and the ordering "ASC" (Ascending).

'''Adding Filters'''

Click on the Filters Tab.

Add a filter named "User field filter".

Choose city.

'''Adding Permissions'''

Click on the Permissions Tab.

Choose "User field Value".

Choose the column "Country", and enter the value "ES".

Here you can add more permissions and a logic condition to be achieved.

'''Adding Calculations'''

Click on the Calculations tab.

Choose Sum.

Choose the column "User module actions".

'''Adding Plots'''

Click on the Plots tab.

Choose "Pie".

Choose the colum "City" as Name and Value.

Finally, add a few users in Moodle with the country Spain, and different cities, Madrid, Barcelona, Seville, etc. and test the report.

You can download the report in different formats (ods and xls), remember to check these options in the report page.

[[blocks/configurable_reports/#Users_report | See screenshot]]

=== Creating a SQL Report ===

You can find a lot of SQL Reports here: [[ad-hoc contributed reports]]

Since this block supports Tim Hunt's CustomSQL Queries Reports, you can use any query.

Remember to add a "Time filter" if you are going to use reports with time tokens.

First of all, install the block.

Go to the course where the report will be created.

Add an instance of the Custom Reports block.

Click on "Manage reports".

Click on "Add report

Enter a name, description, choose "SQL" as Type of Report

The report will be saved and you redirect to the first Tab named "Custom SQL"

Add this query (''Courses activity''):

<code sql>
SELECT COUNT(l.id) hits, l.course courseId, c.fullname coursename
FROM prefix_log l INNER JOIN prefix_course c ON l.course = c.id
GROUP BY courseId
ORDER BY hits DESC
</code>

==== Adding a calculation ====
# Go to Calculations Tab
# Add a Sum calculation, choose the hits column

==== Adding a Plot ====
# Go to Plot
# Add a Pie graph, choosing coursename as Name and hits as value

So, here you have a report with a Graph and calculations based on a SQL Query.

Note: Bar charts are currently not displaying on systems using PHP 7: https://github.com/jleyva/moodle-block_configurablereports/issues/101

==== Filters ====

Filters add a control to the report that allows the user to select a subset of data when the report runs. Filters require two steps:

# Select the filter you want to use on the "Filters" tab
# Add SQL code to make the filter affect the output.

These are the filters that can be used to constrain your report:

<code sql>
%%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:
</code>

'''Using Filters'''

When using a filter you need at least one static WHERE condition, followed by one or more filters. For example

<code sql>
WHERE 1
%%FILTER_COURSES:c.id%%
</code>

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 coded 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
<code sql>
%%FILTER_STARTTIME:l.TIME:>%% %%FILTER_ENDTIME:l.TIME:<%%
</code>

You can add a Course filter; it's very easy.
# Go to filters, choose Courses
# Edit the Custom SQL query:

<code sql>
SELECT COUNT(l.id) hits, l.course courseId, c.fullname coursename
FROM prefix_log l INNER JOIN prefix_course c ON l.course = c.id
%%FILTER_COURSES:l.course%%
GROUP BY courseId
ORDER BY hits DESC
</code>

Note that we are adding a token called: %%FILTER_COURSES:l.courseid%%

Go to View report, and you will see a Courses Filter, choose a Course and click on Add, here you have a report filtered.

You can also add a Starttime and endtime filter

# Go to filters, choose Start / End date filter
# Go to Custom SQL tab, this is the new query:

<code sql>
SELECT COUNT(l.id) hits, l.course courseId, c.fullname coursename
FROM prefix_log l INNER JOIN prefix_course c ON l.course = c.id
%%FILTER_COURSES:l.course%%
%%FILTER_STARTTIME:l.time:>%% %%FILTER_ENDTIME:l.time:<%%
GROUP BY courseId
ORDER BY hits DESC
</code>

If you want to filter text (for example, lastname)

# Go to filters, choose Search Text filter
# Go to Custom SQL tab and type your query. Here is an example for querying the user table:

<code sql>
SELECT u.firstname, u.lastname
FROM prefix_user u
WHERE 1=1
%%FILTER_SEARCHTEXT:u.lastname:~%%
ORDER BY u.lastname
</code>

Replace WHERE 1=1 with your WHERE criteria. If you do not have any where criteria and do not specify WHERE 1=1, you will receive a SQL error.

One more example (for filtering a group of courses by category)

<code sql>
SELECT COUNT(l.id) hits, c.fullname as Course,c.id as CourseID
,(SELECT Count( ra.userid ) AS Users FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
WHERE ra.roleid = 5 AND ctx.instanceid = c.id) AS Students
FROM prefix_log l INNER JOIN prefix_course c ON l.course = c.id
%%FILTER_CATEGORIES:c.category%%
GROUP BY l.course
ORDER BY hits DESC
</code>

Go to View report, now you can filter by time also.

'''Filter Issue'''

CONTRIB-4414 describes an issue where if you use the date filtering function and specify the end date as, for example: 6/11/13, Configurable Reports only searches for end dates up until 6/11/13 12:00 AM. The afternoon data for 6/11/13 is not included, so data for 6/11/13 2:30 PM will be excluded.

The workaround to include the entire end date for the full 24 hour period is to change:

<code>
%%FILTER_ENDTIME:table.field:<%%
</code>
to:
<code>
%%FILTER_ENDTIME:table.field-86399:<%%
</code>

==== SQL variables ====

If you place one of these strings in your SQL queries, it will be replaced by the appropriate value (current course id, current user id, Moodle www root (url), etc.)

<code sql>
%%CATEGORYID%%
%%COURSEID%%
%%CURRENTUSER%%
%%DEBUG%%
%%FILTER_VAR%%
%%STARTTIME%%','%%ENDTIME%%
%%USERID%%
%%WWWROOT%%
</code>

[[blocks/configurable_reports/#SQL_report | See screenshot]]

=== Creating a timeline report ===

''This report assumes that you have created at least one user or course report''

Timeline reports are a special type of reports. A timeline report displays a timeline in which a course report or user report can be embedded.

In this example we are going to create a report showing the user logins to the site during the last month (day per day).

Create a User report (see tutorial above) with three columns (firstname, lastname and user statistics)

Select the statistic (User logins)

Create a Timeline report, in the Timeline tab you can select the dates or days of the report (in this case, the last 30 days) and the interval of time for every row.

Add three "Other report column" columns, selecting all the previous user report columns.

And that's all, you can create a new type of plot (line graph). This graph is suitable for data depending on time.

== Advanced options ==

=== Export and import of reports ===

Embedded reports exporting is not working because the reports include references to another reports. A workaround is edit the imported report for changing the references in the "Other report field" column.

Reports that uses the user module outline column can't be exported either

=== Use the same report in different courses ===

(Available only in Configurable Report version 2.3 and above)

In order to use the same report in different courses you have to check the "Global report" option where creating a new report. This report will be then displayed in all the courses where the configurable report block is displayed and the block instance settings are set to "Display global reports".

If you don't want to display global reports in a certain block instance you can always edit the instance settings for selecting "No" in the "Display global reports" block setting.

Notice that these types of reports inherit the context of the course where is displayed, so any condition related to course inside the report is calculated using the course where the report is being viewed

=== Reports can run on a different DB then the current (production) DB ===

(Available only in Configurable Report version 2.3 and above)

This functionality is for using a copy of the same moodle database, not for queries to other database sources.

Go to Admin -> Plugins -> Blocks -> Configurable Report settings

=== DataTables for the report table ===

(Available only in Configurable Report version 2.3 and above)

Go to Admin -> Plugins -> Blocks -> Configurable Report settings to enable this functionality

=== CodeMirror.js for highlighting SQL query code ===

(Available only in Configurable Report version 2.3 and above)

Go to Admin -> Plugins -> Blocks -> Configurable Report settings to disable this functionality

=== Using GITHUB as a repository to distribute and manage sharable SQL queries ===

(Available only in Configurable Report version 2.3 and above)

Go to Admin -> Plugins -> Blocks -> Configurable Report settings to point to your own repository

=== Cron SQL queries ===

(Available only in Configurable Report version 2.3 and above)

=== Settings to control security of SQL Queries ===

(Available only in Configurable Report version 2.3 and above)

Go to Admin -> Plugins -> Blocks -> Configurable Report settings to change the security level

=== Templates ===

You can customize the report output using a template.

Just enable the Template option in the same name tab.

This is an example html code for displaying a list of users:

Header:

<code html4strict>
<p align="center"><b>##reportname##</b></p>
<table width="60%" align="center">
<tr>
<td>
</code>

Record:

<code html4strict>
<table width="100%">
<tr>
<td><img src="http://yourmoodle.com/user/pix.php/[[id]]/f1.jpg"></td>
<td><h2>[[Firstname]] [[Lastname]]</h2>
City: [[City]]
</td>
</tr>
</table>
<br>
</code>

Footer:

<code html4strict>
</td>
<td valign="top">
##graphs##
<br /><br />
##exportoptions##
</td>
</table>
</code>

=== Embedded reports ===

An embedded report consists in a report's set of columns that are embedded in another report.

You can embed a user report into a course report, in this case, the resulting rows will be expanded duplicating each row for each user.

{| class="wikitable"
|-
! Type of report
! Reports that can be embedded
|-
| Courses
| Users
|-
| Categories
| Courses
|-
| Timeline
| Users, courses
|}

Imagine you have a courses report, you can embed a user report, every row of the course report will be cloned for each user.

To embed a report just add a "Other report" column, a list of your reports will be showed.

Inside a course report you can embed a user report and the other way.

==== Timeline reports ====

Timeline reports are a special type of reports. A timeline report displays a timeline in which a courses report or users report can be embedded.

Timeline reports should be used when your user or course report includes statistics (course stats or user stats columns). I.e: you can create a report showing the number of user logins to the site during a week or month.

== Reports repository ==

Configurable Reports is connected to two different repositories:

* https://github.com/jleyva/moodle-configurable_reports_repository A repository of any type of reports (users, courses, sql, etc...)
* https://github.com/jleyva/moodle-custom_sql_report_queries A repository of just SQL queries to be used in the SQL repor type

You can use your custom repository following this instructions:

* First, you need a github account (free)

* Fork any of the previous repositorys, using the GITHUB fork tool

* Using GIT, clone the repository to your computer in order to add your custom reports (some GIT knowledge is needed)

* Go to Administration / Plugins / Blocks / Configurable reports and change the settings for pointing to your repository (github account + / + repository name

* If you want to contribute to the official repository, use the Pull request Github feature (So I can easily add your reports)

== Developers documentation ==

It's very easy to create new report types, components and plugins.

'''Report''': A report plugin is a folder located at /report.
This folder contains a .class.php file with the child - class of the report_base.

You only need to modify a few methods to add a new report type.
Please, take a look at any of the current reports. The SQL report is an example of a non-typical report,
meanwhile the users and courses reports are standard reports.

The best way to create a report is to duplicate an existing one.

'''Component''': A component is part of a report, a component may be used by more than one report.
The main Component is the component Columns, that is used to add the columns of a report.

Others components are filters, permissions, plot, calculations..

The best way to create a component is to duplicate an existing one.

'''Plugin''': A plugin is a component module. The component column has a few of plugins (coursefield, userfield, etc.)
A plugin usually works for a unique report, but there are plugins that work for more than one report.
The best way to create a plugin is to duplicate an existing one.

== How to request a new feature ==

* Go to the Plugin Tracker http://tracker.moodle.org/browse/CONTRIB/component/10753
* Check in the open issues if your feature have been already requested http://tracker.moodle.org/secure/IssueNavigator.jspa?reset=true&jqlQuery=project+%3D+CONTRIB+AND+component+%3D+%22Block%3A+Configurable+report%22+AND+status+%3D+Open+ORDER+BY+priority+DESC&mode=hide
* If not, create a New issue (Component: Non-core contributed modules Issue type: New feature) (You have to register yourself in the tracker)
* Select the component Block: Configurable Reports and your Moodle version
* Explain in the Description field your needs
* If you have funding, you can contact me using the forum or the moodle internal messaging system, since I work for a Moodle Partner I can work on your request.
* Vote and Watch the issue you have created

== Credits ==

Juan Leyva [http://moodle.org/user/view.php?id=49568&course=1 Moodle profile]

[http://twitter.com/jleyvadelgado Follow me in Twitter]

== Screenshots ==

=== Users report ===
[[Image:block_custom_reports_sample_user_report.png|600px]]

=== SQL report ===
[[Image:block_custom_reports_sample_sql_report.png|600px]]

== See Also ==

* CONTRIB-2386
* [https://tracker.moodle.org/issues/?jql=project%20%3D%20CONTRIB%20AND%20component%20%3D%20%22Block%3A%20Configurable%20report%22 Block: Configurable reports] Tracker component
* [http://moodle.org/plugins/view.php?plugin=block_configurable_reports Modules & Plugins] database entry
* [http://moodle.org/mod/forum/discuss.php?d=159820 Help forum]
* [[ad-hoc_contributed_reports|contributed reports]] (in plain SQL)
* [https://github.com/jleyva/moodle-configurable_reports_repository Configurable Reports Repository on GitHub]
* [https://www.youtube.com/watch?v=lF6CuY2Qiw0 Configurable Reports as a Learning Analytics Tool] - iMoot 2015 presentation by Elizabeth Dalton
* [http://opensourceelearning.blogspot.co.za/2015/08/moodle-configurable-reports-plugin-all.html All Variables and Filters] - Lists the Variables and Filters you can use in a report

[[Category:Report]]
[[Category:Contributed_code]]

[[es:blocks/configurable_reports/]]

Configurable reports

2020-03-17T15:53:35Z

Libertymoodle: /* Filter issue */

{{Infobox plugin
|type = Block
|entry = https://moodle.org/plugins/view.php?plugin=block_configurable_reports
|tracker = http://tracker.moodle.org/browse/CONTRIB/component/10753
|discussion = https://moodle.org/mod/forum/view.php?id=7979
|maintainer = [[User:Juan Leyva|Juan Leyva]], [[User:Sara Arjona Téllez|Sara Arjona Téllez]]
|float = right
}}

== Installation ==

# Download the Configurable Reports installation file and unzip it to the '''\blocks''' directory in your Moodle folder.
# Be sure that the final name of the directory is: configurable_reports, the full path in your Moodle installation will be blocks/configurable_reports
# Login to Moodle as Administrator and click Notifications under Site Administration.

For more information see [[Installing contributed modules or plugins]]

== Overview ==

This block is a Moodle custom reports builder. It its also connected to a [https://github.com/jleyva/moodle-configurable_reports_repository public repository of sample reports] (only plugin version 2.3 and above)

It is designed in a modular way to allow developers to create new plugins in less than an hour.

'''Who can create custom reports?'''

Anyone with block, managereports or manageownreports permissions at SITE level or COURSE level.

'''What type of reports can I create?'''

- Courses reports, with information regarding courses.

- Categories reports, with information regarding categories. A courses report can be embedded in this type of report.

- Users reports, with information regarding users and their activity in a course.

- Timeline reports, this is a special type of report that displays a timeline. A course or user report can be embedded in this timeline showing data depending on the start and end time of the current row.

- Custom SQL Reports, custom SQL queries. This block can use the same SQL queries as [https://moodle.org/plugins/view.php?plugin=report_customsql Tim Hunt's Custom SQL queries] plugin.

Note for developers: You can create your own type of reports.

'''Who can view the reports?'''

When you create a report you can select which users can view it.

The reports are displayed in a block in the course or site frontpage.

== Creating a report ==

This is a very simple process.

If you are going to create a report for a course, you have to add the block in the course and click in the "Manage reports" link.

On the other hand, for site reports, add the block in the frontpage and click in the "Manage reports" link.

You must enter a name, an optional description, and you have to choose the type of report, pagination and exports formats.

Depending on the report choosen, there will be more or less tabs. These are the tabs for the courses and users report:

'''Columns''': Here you can choose the differents columns of your report depending on the type of report. (Course Name, User firstname, etc..)

'''Conditions''': Here you can define the conditions (i.e, only courses from this category, only users from Spain, etc.)

'''Ordering''': Here you can choose how to order the report using fields and directions.

'''Filters''': Here you can choose which filters will be displayed.

'''Template''': You can modify the report's layout by creating a template.

'''Permissions''': Here you can choose who can view a report.

'''Calculations''': Here you can add calculations for columns, i.e: average of number of users enrolled in courses

'''Plots''': Here you can add graphs to your report based on the report columns and values.

'''View report''': Self explanatory

== Tutorial ==

=== Creating a users' report ===

Requirements: ''Users from Spain, but not from Madrid, in this course. This report can be viewed only by users from Spain. A filter based on the user's city must be displayed. A pie plot showing the users' cities is required. A calculation table showing the total forum post views is required. The report must be ordered by users' lastname.''

Let's see how easy it is!

First of all, install the block.

Go to the course where the report will be created.

Add an instance of the Custom Reports block.

Click on "Manage reports"

Click on "Add report"

Enter a name, a description and choose "Users report" as Type of Report

The report will be saved and you will be redirected to the first Tab named "Columns".

'''Adding Columns'''

Here you can define the report table properties, width, align, cell padding, cell spacing, etc.

Add a Column called "User profile field"

Choose the field "firstname" and enter a name for the column in the text field. You can leave the rest of elements blank.

Repeat the process above for the lastname and city fields.

Add a Column called "User module actions".

Choose a module from the list, in this example, a forum.

'''Adding Conditions'''

Click on the Conditions Tab.

Add a Condition named "User field Condition".

Choose the column "Country", the Operator "=", and enter the value "ES" (this is the international code for Spain as Moodle stores it).

Add a Condition named "User field Condition".

Choose the column "city", the Operator "<>", and enter the value "Madrid".

Add a Condition named "Users in current report course".

These are the main conditions of the reports. Note that at the bottom there is a text box called condition, with this text:

"c2 and c1 and c3"

Here you can define a logic condition, in this case, we don't need to edit this condition but you can create complex expressions like:

(c1 and c2) or (c4 and c3)

'''Adding Ordering'''

Click on the Ordering Tab.

Add a ordering named "User field ordering".

Choose the column "Lastname" and the ordering "ASC" (Ascending).

'''Adding Filters'''

Click on the Filters Tab.

Add a filter named "User field filter".

Choose city.

'''Adding Permissions'''

Click on the Permissions Tab.

Choose "User field Value".

Choose the column "Country", and enter the value "ES".

Here you can add more permissions and a logic condition to be achieved.

'''Adding Calculations'''

Click on the Calculations tab.

Choose Sum.

Choose the column "User module actions".

'''Adding Plots'''

Click on the Plots tab.

Choose "Pie".

Choose the colum "City" as Name and Value.

Finally, add a few users in Moodle with the country Spain, and different cities, Madrid, Barcelona, Seville, etc. and test the report.

You can download the report in different formats (ods and xls), remember to check these options in the report page.

[[blocks/configurable_reports/#Users_report | See screenshot]]

=== Creating a SQL Report ===

You can find a lot of SQL Reports here: [[ad-hoc contributed reports]]

Since this block supports Tim Hunt's CustomSQL Queries Reports, you can use any query.

Remember to add a "Time filter" if you are going to use reports with time tokens.

First of all, install the block.

Go to the course where the report will be created.

Add an instance of the Custom Reports block.

Click on "Manage reports".

Click on "Add report

Enter a name, description, choose "SQL" as Type of Report

The report will be saved and you redirect to the first Tab named "Custom SQL"

Add this query (''Courses activity''):

<code sql>
SELECT COUNT(l.id) hits, l.course courseId, c.fullname coursename
FROM prefix_log l INNER JOIN prefix_course c ON l.course = c.id
GROUP BY courseId
ORDER BY hits DESC
</code>

==== Adding a calculation ====
# Go to Calculations Tab
# Add a Sum calculation, choose the hits column

==== Adding a Plot ====
# Go to Plot
# Add a Pie graph, choosing coursename as Name and hits as value

So, here you have a report with a Graph and calculations based on a SQL Query.

Note: Bar charts are currently not displaying on systems using PHP 7: https://github.com/jleyva/moodle-block_configurablereports/issues/101

==== Filters ====

Filters add a control to the report that allows the user to select a subset of data when the report runs. Filters require two steps:

# Select the filter you want to use on the "Filters" tab
# Add SQL code to make the filter affect the output.

These are the filters that can be used to constrain your report:

<code sql>
%%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:
</code>

'''Using Filters'''

When using a filter you need at least one static WHERE condition, followed by one or more filters. For example

<code sql>
WHERE 1
%%FILTER_COURSES:c.id%%
</code>

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 coded 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
<code sql>
%%FILTER_STARTTIME:l.TIME:>%% %%FILTER_ENDTIME:l.TIME:<%%
</code>

You can add a Course filter; it's very easy.
# Go to filters, choose Courses
# Edit the Custom SQL query:

<code sql>
SELECT COUNT(l.id) hits, l.course courseId, c.fullname coursename
FROM prefix_log l INNER JOIN prefix_course c ON l.course = c.id
%%FILTER_COURSES:l.course%%
GROUP BY courseId
ORDER BY hits DESC
</code>

Note that we are adding a token called: %%FILTER_COURSES:l.courseid%%

Go to View report, and you will see a Courses Filter, choose a Course and click on Add, here you have a report filtered.

You can also add a Starttime and endtime filter

# Go to filters, choose Start / End date filter
# Go to Custom SQL tab, this is the new query:

<code sql>
SELECT COUNT(l.id) hits, l.course courseId, c.fullname coursename
FROM prefix_log l INNER JOIN prefix_course c ON l.course = c.id
%%FILTER_COURSES:l.course%%
%%FILTER_STARTTIME:l.time:>%% %%FILTER_ENDTIME:l.time:<%%
GROUP BY courseId
ORDER BY hits DESC
</code>

If you want to filter text (for example, lastname)

# Go to filters, choose Search Text filter
# Go to Custom SQL tab and type your query. Here is an example for querying the user table:

<code sql>
SELECT u.firstname, u.lastname
FROM prefix_user u
WHERE 1=1
%%FILTER_SEARCHTEXT:u.lastname:~%%
ORDER BY u.lastname
</code>

Replace WHERE 1=1 with your WHERE criteria. If you do not have any where criteria and do not specify WHERE 1=1, you will receive a SQL error.

One more example (for filtering a group of courses by category)

<code sql>
SELECT COUNT(l.id) hits, c.fullname as Course,c.id as CourseID
,(SELECT Count( ra.userid ) AS Users FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
WHERE ra.roleid = 5 AND ctx.instanceid = c.id) AS Students
FROM prefix_log l INNER JOIN prefix_course c ON l.course = c.id
%%FILTER_CATEGORIES:c.category%%
GROUP BY l.course
ORDER BY hits DESC
</code>

Go to View report, now you can filter by time also.

'''Filter Issue'''

CONTRIB-4414 describes an issue where if you use the date filtering function and specify the end date as, for example, 6/11/13, Configurable Reports only searches for end dates up until 6/11/13 12:00 AM. The afternoon data for 6/11/13 is not included, so data for 6/11/13 2:30 PM will be excluded.

The workaround to include the entire end date for the full 24 hour period is to change:

<code>
%%FILTER_ENDTIME:table.field:<%%
</code>
to:
<code>
%%FILTER_ENDTIME:table.field-86399:<%%
</code>

==== SQL variables ====

If you place one of these strings in your SQL queries, it will be replaced by the appropriate value (current course id, current user id, Moodle www root (url), etc.)

<code sql>
%%CATEGORYID%%
%%COURSEID%%
%%CURRENTUSER%%
%%DEBUG%%
%%FILTER_VAR%%
%%STARTTIME%%','%%ENDTIME%%
%%USERID%%
%%WWWROOT%%
</code>

[[blocks/configurable_reports/#SQL_report | See screenshot]]

=== Creating a timeline report ===

''This report assumes that you have created at least one user or course report''

Timeline reports are a special type of reports. A timeline report displays a timeline in which a course report or user report can be embedded.

In this example we are going to create a report showing the user logins to the site during the last month (day per day).

Create a User report (see tutorial above) with three columns (firstname, lastname and user statistics)

Select the statistic (User logins)

Create a Timeline report, in the Timeline tab you can select the dates or days of the report (in this case, the last 30 days) and the interval of time for every row.

Add three "Other report column" columns, selecting all the previous user report columns.

And that's all, you can create a new type of plot (line graph). This graph is suitable for data depending on time.

== Advanced options ==

=== Export and import of reports ===

Embedded reports exporting is not working because the reports include references to another reports. A workaround is edit the imported report for changing the references in the "Other report field" column.

Reports that uses the user module outline column can't be exported either

=== Use the same report in different courses ===

(Available only in Configurable Report version 2.3 and above)

In order to use the same report in different courses you have to check the "Global report" option where creating a new report. This report will be then displayed in all the courses where the configurable report block is displayed and the block instance settings are set to "Display global reports".

If you don't want to display global reports in a certain block instance you can always edit the instance settings for selecting "No" in the "Display global reports" block setting.

Notice that these types of reports inherit the context of the course where is displayed, so any condition related to course inside the report is calculated using the course where the report is being viewed

=== Reports can run on a different DB then the current (production) DB ===

(Available only in Configurable Report version 2.3 and above)

This functionality is for using a copy of the same moodle database, not for queries to other database sources.

Go to Admin -> Plugins -> Blocks -> Configurable Report settings

=== DataTables for the report table ===

(Available only in Configurable Report version 2.3 and above)

Go to Admin -> Plugins -> Blocks -> Configurable Report settings to enable this functionality

=== CodeMirror.js for highlighting SQL query code ===

(Available only in Configurable Report version 2.3 and above)

Go to Admin -> Plugins -> Blocks -> Configurable Report settings to disable this functionality

=== Using GITHUB as a repository to distribute and manage sharable SQL queries ===

(Available only in Configurable Report version 2.3 and above)

Go to Admin -> Plugins -> Blocks -> Configurable Report settings to point to your own repository

=== Cron SQL queries ===

(Available only in Configurable Report version 2.3 and above)

=== Settings to control security of SQL Queries ===

(Available only in Configurable Report version 2.3 and above)

Go to Admin -> Plugins -> Blocks -> Configurable Report settings to change the security level

=== Templates ===

You can customize the report output using a template.

Just enable the Template option in the same name tab.

This is an example html code for displaying a list of users:

Header:

<code html4strict>
<p align="center"><b>##reportname##</b></p>
<table width="60%" align="center">
<tr>
<td>
</code>

Record:

<code html4strict>
<table width="100%">
<tr>
<td><img src="http://yourmoodle.com/user/pix.php/[[id]]/f1.jpg"></td>
<td><h2>[[Firstname]] [[Lastname]]</h2>
City: [[City]]
</td>
</tr>
</table>
<br>
</code>

Footer:

<code html4strict>
</td>
<td valign="top">
##graphs##
<br /><br />
##exportoptions##
</td>
</table>
</code>

=== Embedded reports ===

An embedded report consists in a report's set of columns that are embedded in another report.

You can embed a user report into a course report, in this case, the resulting rows will be expanded duplicating each row for each user.

{| class="wikitable"
|-
! Type of report
! Reports that can be embedded
|-
| Courses
| Users
|-
| Categories
| Courses
|-
| Timeline
| Users, courses
|}

Imagine you have a courses report, you can embed a user report, every row of the course report will be cloned for each user.

To embed a report just add a "Other report" column, a list of your reports will be showed.

Inside a course report you can embed a user report and the other way.

==== Timeline reports ====

Timeline reports are a special type of reports. A timeline report displays a timeline in which a courses report or users report can be embedded.

Timeline reports should be used when your user or course report includes statistics (course stats or user stats columns). I.e: you can create a report showing the number of user logins to the site during a week or month.

== Reports repository ==

Configurable Reports is connected to two different repositories:

* https://github.com/jleyva/moodle-configurable_reports_repository A repository of any type of reports (users, courses, sql, etc...)
* https://github.com/jleyva/moodle-custom_sql_report_queries A repository of just SQL queries to be used in the SQL repor type

You can use your custom repository following this instructions:

* First, you need a github account (free)

* Fork any of the previous repositorys, using the GITHUB fork tool

* Using GIT, clone the repository to your computer in order to add your custom reports (some GIT knowledge is needed)

* Go to Administration / Plugins / Blocks / Configurable reports and change the settings for pointing to your repository (github account + / + repository name

* If you want to contribute to the official repository, use the Pull request Github feature (So I can easily add your reports)

== Developers documentation ==

It's very easy to create new report types, components and plugins.

'''Report''': A report plugin is a folder located at /report.
This folder contains a .class.php file with the child - class of the report_base.

You only need to modify a few methods to add a new report type.
Please, take a look at any of the current reports. The SQL report is an example of a non-typical report,
meanwhile the users and courses reports are standard reports.

The best way to create a report is to duplicate an existing one.

'''Component''': A component is part of a report, a component may be used by more than one report.
The main Component is the component Columns, that is used to add the columns of a report.

Others components are filters, permissions, plot, calculations..

The best way to create a component is to duplicate an existing one.

'''Plugin''': A plugin is a component module. The component column has a few of plugins (coursefield, userfield, etc.)
A plugin usually works for a unique report, but there are plugins that work for more than one report.
The best way to create a plugin is to duplicate an existing one.

== How to request a new feature ==

* Go to the Plugin Tracker http://tracker.moodle.org/browse/CONTRIB/component/10753
* Check in the open issues if your feature have been already requested http://tracker.moodle.org/secure/IssueNavigator.jspa?reset=true&jqlQuery=project+%3D+CONTRIB+AND+component+%3D+%22Block%3A+Configurable+report%22+AND+status+%3D+Open+ORDER+BY+priority+DESC&mode=hide
* If not, create a New issue (Component: Non-core contributed modules Issue type: New feature) (You have to register yourself in the tracker)
* Select the component Block: Configurable Reports and your Moodle version
* Explain in the Description field your needs
* If you have funding, you can contact me using the forum or the moodle internal messaging system, since I work for a Moodle Partner I can work on your request.
* Vote and Watch the issue you have created

== Credits ==

Juan Leyva [http://moodle.org/user/view.php?id=49568&course=1 Moodle profile]

[http://twitter.com/jleyvadelgado Follow me in Twitter]

== Screenshots ==

=== Users report ===
[[Image:block_custom_reports_sample_user_report.png|600px]]

=== SQL report ===
[[Image:block_custom_reports_sample_sql_report.png|600px]]

== See Also ==

* CONTRIB-2386
* [https://tracker.moodle.org/issues/?jql=project%20%3D%20CONTRIB%20AND%20component%20%3D%20%22Block%3A%20Configurable%20report%22 Block: Configurable reports] Tracker component
* [http://moodle.org/plugins/view.php?plugin=block_configurable_reports Modules & Plugins] database entry
* [http://moodle.org/mod/forum/discuss.php?d=159820 Help forum]
* [[ad-hoc_contributed_reports|contributed reports]] (in plain SQL)
* [https://github.com/jleyva/moodle-configurable_reports_repository Configurable Reports Repository on GitHub]
* [https://www.youtube.com/watch?v=lF6CuY2Qiw0 Configurable Reports as a Learning Analytics Tool] - iMoot 2015 presentation by Elizabeth Dalton
* [http://opensourceelearning.blogspot.co.za/2015/08/moodle-configurable-reports-plugin-all.html All Variables and Filters] - Lists the Variables and Filters you can use in a report

[[Category:Report]]
[[Category:Contributed_code]]

[[es:blocks/configurable_reports/]]

Talk:Configurable reports

2020-03-17T15:34:48Z

Libertymoodle: /* Templates - variables */

=== Templates ===
The Templates section lists several "variables" such as:
* ##exportoptions##
* ##reportname##
* ##graphs##

Please document what these are. How can they be used in reports?

Please include a definitive list of these items.

Talk:Configurable reports

2020-03-17T15:34:27Z

Libertymoodle: /* Templates - variables */

=== Templates ===
The Templates section lists several "variables" such as
* ##exportoptions##
* ##reportname##
* ##graphs##

Please document what these are. How can they be used in reports?

Please include a definitive list of these items.

Course backup

2020-03-12T12:45:51Z

Libertymoodle: /* Example : clarify courseid param */

{{Backup}}
A course can be saved with some or all of its parts by using the course backup. Typically, the site administrator will set a schedule of [[Automated course backup|automated course backups]] for the whole site. A teacher can create a backup or download an existing backup for safe keeping, or for use on another Moodle site.

{{MediaPlayer | url = https://youtu.be/eNe6kRv2ndI| desc = Course backup: Moodle 3.7}}

==Backing up a course==

To backup a course

# Go into the course.
# Click the Backup link either in the gear menu or the Administration block (depending upon the theme).
# Initial settings - Select activities, blocks, filters and other items as required then click the Next button. Users with appropriate permissions, such as administrators and managers, can choose whether to [[Backup of user data|include users]], anonymize user information, or include user role assignments, groups, groupings, user files, comments, user completion details, course logs and grade history in the backup.
# Schema settings - Select/deselect specific items to include in backup, then click the Next button.
# If desired, select specific types of activity to be backed up by clicking the link 'Show type options'
# Confirmation and review - Check that everything is as required, using the Previous button if necessary, otherwise click the 'Perform backup' button
# Complete - Click the Continue button

{|
[[File:backupgroups.png|thumb|Backup settings]]
|
|[[File:26backuprestore1.png|thumb|Back up screen with option to select all or none]]
|
|[[File:26backuprestore2.png|thumb|Back up screen with option to select activity types]]
|}

A backup file (with distinctive .mbz extension to avoid confusion with .zip files) is then saved in the course backup area. Backup file names are of the form ''backup-moodle2-course-coursename-date-hour.mbz'', ending in ''-nu.mbz'' when backed up with no users and ''-an.mbz'' with anonymized names.

Tip: If you are satisfied with the default settings and don't wish to go through all the backup screens, you can simply click 'Jump to final step' to perform the backup.

==Anonymizing user information==

Anonymize user information is a backup feature which "protects user identities" by making each user anonymous. If this box is checked in the backup initial settings, Moodle will substitute aliases for real names, substituting @doesntexist.com email addresses and so forth. For example "Max Manager" might become "anonfirstname4 anonlastname4".

==Asynchronous course backups==

With large courses it is helpful to be able to continue working while the course is backing up in the background. This can be done if the administrator checks the box 'Enable asynchronous backups' from ''Site Administration / Advanced features''

==Backup via CLI for administrators==

Site administrators can backup selected courses using a CLI script.

===Options===
* --courseid=INTEGER (Course ID for backup.)
* --courseshortname=STRING (Course shortname for backup.)
* --destination=STRING (Path where to store backup file. If not set the backup will be stored within the course backup file area.)
* -h, --help (Print out this help.)

===Example===
<code php>
\$sudo -u www-data /usr/bin/php admin/cli/backup.php --courseid=2 --destination=/moodle/backup/
</code>

On Windows you will use cmd.exe to run the /admin/cli/backup.php script. If you have your Moodledata folder setup on a separate data server you can specify a UNC path to your backup folder on that data server. From the command line CD to the Moodle ''\admin\cli'' folder and run this command:
<code php>
php backup.php --courseid=25 --destination=\\moodledata\backup
</code>

where '--courseid' is the id of the course that you want to backup.

The .mbz backup file for courseid=25 will be stored in the ''backup'' subfolder in the ''Moodledata'' ($CFG->dataroot) folder.

==Tips and tricks==
* Lose content after a restore in Moodle 2.0 ? Do you see topic headings that say "Orphaned activities"? Solution: Go to course settings and increase the number of topic sections and things will return to normal.

==Creative uses==
The backup and restore processes can offer the teacher and administrators many creative solutions.
*Duplicating courses or specific activities in one course to another course (similar to Import)
*Updating a production Moodle site course, with material from a localhost site course
*Transferring a course to a new Moodle site.
*In earlier versions of Moodle, a way of rolling a course forward without past student activity
*Creating a blank activity, save just that activity and then restore it to the course or another course one or more times.

==General backup defaults==

Default settings for course backups can be set by a site administrator in 'General backup defaults' in the Site administration.

Selected settings may be locked, so that they cannot be changed when creating a course backup.

By selecting a time in the "Keep logs for.." dropdown, it is possible to specify how long backup logs information is kept before being deleted. As this information may be very large, it is recommended the length of time chosen be quite short.

==Course backup stops above 90%, not showing any errors==
This has been reported to be caused by:
* a [[Course_formats#Contributed_Course_Formats|non-standard course_format]]. Try replacing the course format.
* not enough server RAM. Adding more RAM to your server is usually the first [[Performance_recommendations|performance recomendation]].

==Course backup capabilities==

*[[Capabilities/moodle/backup:anonymise|Anonymise user data on backup]]
*[[Capabilities/moodle/backup:backupcourse|Backup courses]]
*[[Capabilities/moodle/backup:backupsection|Backup sections]]
*[[Capabilities/moodle/backup:backuptargetimport|Backup for import]]
*[[Capabilities/moodle/backup:configure|Configure backup options]]
*[[Capabilities/moodle/backup:downloadfile|Download files from backup areas]]
*[[Capabilities/moodle/backup:userinfo|Backup user data]]

==Error: Trying to restore user 'admin' from backup file will cause conflict ==
* Before proceeding, it would be advisable to have a second admin account ''just in case something goes wrong''.
* Check that the admin accounts on each server have '''different''' unique usernames and email addresses and then try again to backup up the course with user data and restore it.
** If you can not make a new backup and you must use an existing 'conflicting' backup file, you will have to change the new site's main admin account with extreme care to remember the new main admin's password and email.
* Note that the admin account from the imported file may loose the password and become unusable;
* You are advised to update/reset the 'imported' main 'admin's account's password before logging out, as this will most likely be the main 'admin' account for the site, and you would get into serious problems if this account stops working.
* If something goes terribly wrong, you can use the second admin account to fix the main admin account.

==See also==

*[[Course restore]]
*[[Backup of user data]]
*[[Activity backup]]
* Administrators can use [http://moosh-online.com/commands/#course-restore MOOSH] to bulk backup and restore courses from CLI

[[Category:Course]]

[[de:Kurssicherung]]
[[es:Respaldo del curso]]
[[eu:Ikastaroaren_Segurtasun-kopia]]
[[fr:Sauvegarde de cours]]
[[ja:コースバックアップ]]

Course backup

2020-03-12T12:32:49Z

Libertymoodle: /* Example : typo */

{{Backup}}
A course can be saved with some or all of its parts by using the course backup. Typically, the site administrator will set a schedule of [[Automated course backup|automated course backups]] for the whole site. A teacher can create a backup or download an existing backup for safe keeping, or for use on another Moodle site.

{{MediaPlayer | url = https://youtu.be/eNe6kRv2ndI| desc = Course backup: Moodle 3.7}}

==Backing up a course==

To backup a course

# Go into the course.
# Click the Backup link either in the gear menu or the Administration block (depending upon the theme).
# Initial settings - Select activities, blocks, filters and other items as required then click the Next button. Users with appropriate permissions, such as administrators and managers, can choose whether to [[Backup of user data|include users]], anonymize user information, or include user role assignments, groups, groupings, user files, comments, user completion details, course logs and grade history in the backup.
# Schema settings - Select/deselect specific items to include in backup, then click the Next button.
# If desired, select specific types of activity to be backed up by clicking the link 'Show type options'
# Confirmation and review - Check that everything is as required, using the Previous button if necessary, otherwise click the 'Perform backup' button
# Complete - Click the Continue button

{|
[[File:backupgroups.png|thumb|Backup settings]]
|
|[[File:26backuprestore1.png|thumb|Back up screen with option to select all or none]]
|
|[[File:26backuprestore2.png|thumb|Back up screen with option to select activity types]]
|}

A backup file (with distinctive .mbz extension to avoid confusion with .zip files) is then saved in the course backup area. Backup file names are of the form ''backup-moodle2-course-coursename-date-hour.mbz'', ending in ''-nu.mbz'' when backed up with no users and ''-an.mbz'' with anonymized names.

Tip: If you are satisfied with the default settings and don't wish to go through all the backup screens, you can simply click 'Jump to final step' to perform the backup.

==Anonymizing user information==

Anonymize user information is a backup feature which "protects user identities" by making each user anonymous. If this box is checked in the backup initial settings, Moodle will substitute aliases for real names, substituting @doesntexist.com email addresses and so forth. For example "Max Manager" might become "anonfirstname4 anonlastname4".

==Asynchronous course backups==

With large courses it is helpful to be able to continue working while the course is backing up in the background. This can be done if the administrator checks the box 'Enable asynchronous backups' from ''Site Administration / Advanced features''

==Backup via CLI for administrators==

Site administrators can backup selected courses using a CLI script.

===Options===
* --courseid=INTEGER (Course ID for backup.)
* --courseshortname=STRING (Course shortname for backup.)
* --destination=STRING (Path where to store backup file. If not set the backup will be stored within the course backup file area.)
* -h, --help (Print out this help.)

===Example===
<code php>
\$sudo -u www-data /usr/bin/php admin/cli/backup.php --courseid=2 --destination=/moodle/backup/
</code>

On Windows you will use cmd.exe to run the /admin/cli/backup.php script. If you have your Moodledata folder setup on a separate data server you can specify a UNC path to your backup folder on that data server. From the command line CD to the Moodle ''\admin\cli'' folder and run this command:
<code php>
php backup.php --courseid=25 --destination=\\moodledata\backup
</code>

The .mbz backup file for courseid=25 will be stored in the ''backup'' subfolder in the ''Moodledata'' ($CFG->dataroot) folder.

==Tips and tricks==
* Lose content after a restore in Moodle 2.0 ? Do you see topic headings that say "Orphaned activities"? Solution: Go to course settings and increase the number of topic sections and things will return to normal.

==Creative uses==
The backup and restore processes can offer the teacher and administrators many creative solutions.
*Duplicating courses or specific activities in one course to another course (similar to Import)
*Updating a production Moodle site course, with material from a localhost site course
*Transferring a course to a new Moodle site.
*In earlier versions of Moodle, a way of rolling a course forward without past student activity
*Creating a blank activity, save just that activity and then restore it to the course or another course one or more times.

==General backup defaults==

Default settings for course backups can be set by a site administrator in 'General backup defaults' in the Site administration.

Selected settings may be locked, so that they cannot be changed when creating a course backup.

By selecting a time in the "Keep logs for.." dropdown, it is possible to specify how long backup logs information is kept before being deleted. As this information may be very large, it is recommended the length of time chosen be quite short.

==Course backup stops above 90%, not showing any errors==
This has been reported to be caused by:
* a [[Course_formats#Contributed_Course_Formats|non-standard course_format]]. Try replacing the course format.
* not enough server RAM. Adding more RAM to your server is usually the first [[Performance_recommendations|performance recomendation]].

==Course backup capabilities==

*[[Capabilities/moodle/backup:anonymise|Anonymise user data on backup]]
*[[Capabilities/moodle/backup:backupcourse|Backup courses]]
*[[Capabilities/moodle/backup:backupsection|Backup sections]]
*[[Capabilities/moodle/backup:backuptargetimport|Backup for import]]
*[[Capabilities/moodle/backup:configure|Configure backup options]]
*[[Capabilities/moodle/backup:downloadfile|Download files from backup areas]]
*[[Capabilities/moodle/backup:userinfo|Backup user data]]

==Error: Trying to restore user 'admin' from backup file will cause conflict ==
* Before proceeding, it would be advisable to have a second admin account ''just in case something goes wrong''.
* Check that the admin accounts on each server have '''different''' unique usernames and email addresses and then try again to backup up the course with user data and restore it.
** If you can not make a new backup and you must use an existing 'conflicting' backup file, you will have to change the new site's main admin account with extreme care to remember the new main admin's password and email.
* Note that the admin account from the imported file may loose the password and become unusable;
* You are advised to update/reset the 'imported' main 'admin's account's password before logging out, as this will most likely be the main 'admin' account for the site, and you would get into serious problems if this account stops working.
* If something goes terribly wrong, you can use the second admin account to fix the main admin account.

==See also==

*[[Course restore]]
*[[Backup of user data]]
*[[Activity backup]]
* Administrators can use [http://moosh-online.com/commands/#course-restore MOOSH] to bulk backup and restore courses from CLI

[[Category:Course]]

[[de:Kurssicherung]]
[[es:Respaldo del curso]]
[[eu:Ikastaroaren_Segurtasun-kopia]]
[[fr:Sauvegarde de cours]]
[[ja:コースバックアップ]]

Course backup

2020-03-12T11:40:37Z

Libertymoodle: /* Example - typo */

{{Backup}}
A course can be saved with some or all of its parts by using the course backup. Typically, the site administrator will set a schedule of [[Automated course backup|automated course backups]] for the whole site. A teacher can create a backup or download an existing backup for safe keeping, or for use on another Moodle site.

{{MediaPlayer | url = https://youtu.be/eNe6kRv2ndI| desc = Course backup: Moodle 3.7}}

==Backing up a course==

To backup a course

# Go into the course.
# Click the Backup link either in the gear menu or the Administration block (depending upon the theme).
# Initial settings - Select activities, blocks, filters and other items as required then click the Next button. Users with appropriate permissions, such as administrators and managers, can choose whether to [[Backup of user data|include users]], anonymize user information, or include user role assignments, groups, groupings, user files, comments, user completion details, course logs and grade history in the backup.
# Schema settings - Select/deselect specific items to include in backup, then click the Next button.
# If desired, select specific types of activity to be backed up by clicking the link 'Show type options'
# Confirmation and review - Check that everything is as required, using the Previous button if necessary, otherwise click the 'Perform backup' button
# Complete - Click the Continue button

{|
[[File:backupgroups.png|thumb|Backup settings]]
|
|[[File:26backuprestore1.png|thumb|Back up screen with option to select all or none]]
|
|[[File:26backuprestore2.png|thumb|Back up screen with option to select activity types]]
|}

A backup file (with distinctive .mbz extension to avoid confusion with .zip files) is then saved in the course backup area. Backup file names are of the form ''backup-moodle2-course-coursename-date-hour.mbz'', ending in ''-nu.mbz'' when backed up with no users and ''-an.mbz'' with anonymized names.

Tip: If you are satisfied with the default settings and don't wish to go through all the backup screens, you can simply click 'Jump to final step' to perform the backup.

==Anonymizing user information==

Anonymize user information is a backup feature which "protects user identities" by making each user anonymous. If this box is checked in the backup initial settings, Moodle will substitute aliases for real names, substituting @doesntexist.com email addresses and so forth. For example "Max Manager" might become "anonfirstname4 anonlastname4".

==Asynchronous course backups==

With large courses it is helpful to be able to continue working while the course is backing up in the background. This can be done if the administrator checks the box 'Enable asynchronous backups' from ''Site Administration / Advanced features''

==Backup via CLI for administrators==

Site administrators can backup selected courses using a CLI script.

===Options===
* --courseid=INTEGER (Course ID for backup.)
* --courseshortname=STRING (Course shortname for backup.)
* --destination=STRING (Path where to store backup file. If not set the backup will be stored within the course backup file area.)
* -h, --help (Print out this help.)

===Example===
<code php>
\$sudo -u www-data /usr/bin/php admin/cli/backup.php --courseid=2 --destination=/moodle/backup/
</code>

On Windows you will use cmd.exe to run the /admin/cli/backup.php script. If you have your Moodledata folder setup on a separate data server you can specify a UNC path to your backup folder on that data server. CD to the Moodle ''\admin\cli'' folder and run this command:
<code php>
php backup.php --courseid=25 --destination=\\moodledata\backup
</code>

The .mbz backup file for courseid=25 will be stored in the ''backup'' subfolder in the ''Moodledata'' ($CFG->dataroot) folder.

==Tips and tricks==
* Lose content after a restore in Moodle 2.0 ? Do you see topic headings that say "Orphaned activities"? Solution: Go to course settings and increase the number of topic sections and things will return to normal.

==Creative uses==
The backup and restore processes can offer the teacher and administrators many creative solutions.
*Duplicating courses or specific activities in one course to another course (similar to Import)
*Updating a production Moodle site course, with material from a localhost site course
*Transferring a course to a new Moodle site.
*In earlier versions of Moodle, a way of rolling a course forward without past student activity
*Creating a blank activity, save just that activity and then restore it to the course or another course one or more times.

==General backup defaults==

Default settings for course backups can be set by a site administrator in 'General backup defaults' in the Site administration.

Selected settings may be locked, so that they cannot be changed when creating a course backup.

By selecting a time in the "Keep logs for.." dropdown, it is possible to specify how long backup logs information is kept before being deleted. As this information may be very large, it is recommended the length of time chosen be quite short.

==Course backup stops above 90%, not showing any errors==
This has been reported to be caused by:
* a [[Course_formats#Contributed_Course_Formats|non-standard course_format]]. Try replacing the course format.
* not enough server RAM. Adding more RAM to your server is usually the first [[Performance_recommendations|performance recomendation]].

==Course backup capabilities==

*[[Capabilities/moodle/backup:anonymise|Anonymise user data on backup]]
*[[Capabilities/moodle/backup:backupcourse|Backup courses]]
*[[Capabilities/moodle/backup:backupsection|Backup sections]]
*[[Capabilities/moodle/backup:backuptargetimport|Backup for import]]
*[[Capabilities/moodle/backup:configure|Configure backup options]]
*[[Capabilities/moodle/backup:downloadfile|Download files from backup areas]]
*[[Capabilities/moodle/backup:userinfo|Backup user data]]

==Error: Trying to restore user 'admin' from backup file will cause conflict ==
* Before proceeding, it would be advisable to have a second admin account ''just in case something goes wrong''.
* Check that the admin accounts on each server have '''different''' unique usernames and email addresses and then try again to backup up the course with user data and restore it.
** If you can not make a new backup and you must use an existing 'conflicting' backup file, you will have to change the new site's main admin account with extreme care to remember the new main admin's password and email.
* Note that the admin account from the imported file may loose the password and become unusable;
* You are advised to update/reset the 'imported' main 'admin's account's password before logging out, as this will most likely be the main 'admin' account for the site, and you would get into serious problems if this account stops working.
* If something goes terribly wrong, you can use the second admin account to fix the main admin account.

==See also==

*[[Course restore]]
*[[Backup of user data]]
*[[Activity backup]]
* Administrators can use [http://moosh-online.com/commands/#course-restore MOOSH] to bulk backup and restore courses from CLI

[[Category:Course]]

[[de:Kurssicherung]]
[[es:Respaldo del curso]]
[[eu:Ikastaroaren_Segurtasun-kopia]]
[[fr:Sauvegarde de cours]]
[[ja:コースバックアップ]]

Course backup

2020-03-12T11:38:30Z

Libertymoodle: /* Example pth fix*/

{{Backup}}
A course can be saved with some or all of its parts by using the course backup. Typically, the site administrator will set a schedule of [[Automated course backup|automated course backups]] for the whole site. A teacher can create a backup or download an existing backup for safe keeping, or for use on another Moodle site.

{{MediaPlayer | url = https://youtu.be/eNe6kRv2ndI| desc = Course backup: Moodle 3.7}}

==Backing up a course==

To backup a course

# Go into the course.
# Click the Backup link either in the gear menu or the Administration block (depending upon the theme).
# Initial settings - Select activities, blocks, filters and other items as required then click the Next button. Users with appropriate permissions, such as administrators and managers, can choose whether to [[Backup of user data|include users]], anonymize user information, or include user role assignments, groups, groupings, user files, comments, user completion details, course logs and grade history in the backup.
# Schema settings - Select/deselect specific items to include in backup, then click the Next button.
# If desired, select specific types of activity to be backed up by clicking the link 'Show type options'
# Confirmation and review - Check that everything is as required, using the Previous button if necessary, otherwise click the 'Perform backup' button
# Complete - Click the Continue button

{|
[[File:backupgroups.png|thumb|Backup settings]]
|
|[[File:26backuprestore1.png|thumb|Back up screen with option to select all or none]]
|
|[[File:26backuprestore2.png|thumb|Back up screen with option to select activity types]]
|}

A backup file (with distinctive .mbz extension to avoid confusion with .zip files) is then saved in the course backup area. Backup file names are of the form ''backup-moodle2-course-coursename-date-hour.mbz'', ending in ''-nu.mbz'' when backed up with no users and ''-an.mbz'' with anonymized names.

Tip: If you are satisfied with the default settings and don't wish to go through all the backup screens, you can simply click 'Jump to final step' to perform the backup.

==Anonymizing user information==

Anonymize user information is a backup feature which "protects user identities" by making each user anonymous. If this box is checked in the backup initial settings, Moodle will substitute aliases for real names, substituting @doesntexist.com email addresses and so forth. For example "Max Manager" might become "anonfirstname4 anonlastname4".

==Asynchronous course backups==

With large courses it is helpful to be able to continue working while the course is backing up in the background. This can be done if the administrator checks the box 'Enable asynchronous backups' from ''Site Administration / Advanced features''

==Backup via CLI for administrators==

Site administrators can backup selected courses using a CLI script.

===Options===
* --courseid=INTEGER (Course ID for backup.)
* --courseshortname=STRING (Course shortname for backup.)
* --destination=STRING (Path where to store backup file. If not set the backup will be stored within the course backup file area.)
* -h, --help (Print out this help.)

===Example===
<code php>
\$sudo -u www-data /usr/bin/php admin/cli/backup.php --courseid=2 --destination=/moodle/backup/
</code>

On Windows you will use cmd.exe to run the /admin/cli/backup.php script. If you have your Moodledata folder setup on a separate data server you can specify a UNC path to your backup folder on that data server:

CD to the Moodle ''\admin\cli'' folder and run this command:
<code php>
php backup.php --courseid=25 --destination=\\moodledata\backup
</code>

The .mbz backup file for courseid=25 will be stored in the ''backup'' subfolder in the ''Moodledata'' ($CFG->dataroot) folder.

==Tips and tricks==
* Lose content after a restore in Moodle 2.0 ? Do you see topic headings that say "Orphaned activities"? Solution: Go to course settings and increase the number of topic sections and things will return to normal.

==Creative uses==
The backup and restore processes can offer the teacher and administrators many creative solutions.
*Duplicating courses or specific activities in one course to another course (similar to Import)
*Updating a production Moodle site course, with material from a localhost site course
*Transferring a course to a new Moodle site.
*In earlier versions of Moodle, a way of rolling a course forward without past student activity
*Creating a blank activity, save just that activity and then restore it to the course or another course one or more times.

==General backup defaults==

Default settings for course backups can be set by a site administrator in 'General backup defaults' in the Site administration.

Selected settings may be locked, so that they cannot be changed when creating a course backup.

By selecting a time in the "Keep logs for.." dropdown, it is possible to specify how long backup logs information is kept before being deleted. As this information may be very large, it is recommended the length of time chosen be quite short.

==Course backup stops above 90%, not showing any errors==
This has been reported to be caused by:
* a [[Course_formats#Contributed_Course_Formats|non-standard course_format]]. Try replacing the course format.
* not enough server RAM. Adding more RAM to your server is usually the first [[Performance_recommendations|performance recomendation]].

==Course backup capabilities==

*[[Capabilities/moodle/backup:anonymise|Anonymise user data on backup]]
*[[Capabilities/moodle/backup:backupcourse|Backup courses]]
*[[Capabilities/moodle/backup:backupsection|Backup sections]]
*[[Capabilities/moodle/backup:backuptargetimport|Backup for import]]
*[[Capabilities/moodle/backup:configure|Configure backup options]]
*[[Capabilities/moodle/backup:downloadfile|Download files from backup areas]]
*[[Capabilities/moodle/backup:userinfo|Backup user data]]

==Error: Trying to restore user 'admin' from backup file will cause conflict ==
* Before proceeding, it would be advisable to have a second admin account ''just in case something goes wrong''.
* Check that the admin accounts on each server have '''different''' unique usernames and email addresses and then try again to backup up the course with user data and restore it.
** If you can not make a new backup and you must use an existing 'conflicting' backup file, you will have to change the new site's main admin account with extreme care to remember the new main admin's password and email.
* Note that the admin account from the imported file may loose the password and become unusable;
* You are advised to update/reset the 'imported' main 'admin's account's password before logging out, as this will most likely be the main 'admin' account for the site, and you would get into serious problems if this account stops working.
* If something goes terribly wrong, you can use the second admin account to fix the main admin account.

==See also==

*[[Course restore]]
*[[Backup of user data]]
*[[Activity backup]]
* Administrators can use [http://moosh-online.com/commands/#course-restore MOOSH] to bulk backup and restore courses from CLI

[[Category:Course]]

[[de:Kurssicherung]]
[[es:Respaldo del curso]]
[[eu:Ikastaroaren_Segurtasun-kopia]]
[[fr:Sauvegarde de cours]]
[[ja:コースバックアップ]]

Course backup

2020-03-12T11:34:42Z

Libertymoodle: /* Example formatting code */

{{Backup}}
A course can be saved with some or all of its parts by using the course backup. Typically, the site administrator will set a schedule of [[Automated course backup|automated course backups]] for the whole site. A teacher can create a backup or download an existing backup for safe keeping, or for use on another Moodle site.

{{MediaPlayer | url = https://youtu.be/eNe6kRv2ndI| desc = Course backup: Moodle 3.7}}

==Backing up a course==

To backup a course

# Go into the course.
# Click the Backup link either in the gear menu or the Administration block (depending upon the theme).
# Initial settings - Select activities, blocks, filters and other items as required then click the Next button. Users with appropriate permissions, such as administrators and managers, can choose whether to [[Backup of user data|include users]], anonymize user information, or include user role assignments, groups, groupings, user files, comments, user completion details, course logs and grade history in the backup.
# Schema settings - Select/deselect specific items to include in backup, then click the Next button.
# If desired, select specific types of activity to be backed up by clicking the link 'Show type options'
# Confirmation and review - Check that everything is as required, using the Previous button if necessary, otherwise click the 'Perform backup' button
# Complete - Click the Continue button

{|
[[File:backupgroups.png|thumb|Backup settings]]
|
|[[File:26backuprestore1.png|thumb|Back up screen with option to select all or none]]
|
|[[File:26backuprestore2.png|thumb|Back up screen with option to select activity types]]
|}

A backup file (with distinctive .mbz extension to avoid confusion with .zip files) is then saved in the course backup area. Backup file names are of the form ''backup-moodle2-course-coursename-date-hour.mbz'', ending in ''-nu.mbz'' when backed up with no users and ''-an.mbz'' with anonymized names.

Tip: If you are satisfied with the default settings and don't wish to go through all the backup screens, you can simply click 'Jump to final step' to perform the backup.

==Anonymizing user information==

Anonymize user information is a backup feature which "protects user identities" by making each user anonymous. If this box is checked in the backup initial settings, Moodle will substitute aliases for real names, substituting @doesntexist.com email addresses and so forth. For example "Max Manager" might become "anonfirstname4 anonlastname4".

==Asynchronous course backups==

With large courses it is helpful to be able to continue working while the course is backing up in the background. This can be done if the administrator checks the box 'Enable asynchronous backups' from ''Site Administration / Advanced features''

==Backup via CLI for administrators==

Site administrators can backup selected courses using a CLI script.

===Options===
* --courseid=INTEGER (Course ID for backup.)
* --courseshortname=STRING (Course shortname for backup.)
* --destination=STRING (Path where to store backup file. If not set the backup will be stored within the course backup file area.)
* -h, --help (Print out this help.)

===Example===
<code php>
\$sudo -u www-data /usr/bin/php admin/cli/backup.php --courseid=2 --destination=/moodle/backup/
</code>

On Windows you will use cmd.exe to run the /admin/cli/backup.php script. If you have your Moodledata folder setup on a separate data server you can specify a UNC path to your backup folder on that data server:

CD to the Moodle ''\admin\cli'' folder and run this command:
<code php>
php backup.php --courseid=25 --destination=\\moodledata\backup
</code>

The .mbz backup file for courseid=25 will be stored in the ''backup'' subfolder in the ''Moodledata'' folder.

==Tips and tricks==
* Lose content after a restore in Moodle 2.0 ? Do you see topic headings that say "Orphaned activities"? Solution: Go to course settings and increase the number of topic sections and things will return to normal.

==Creative uses==
The backup and restore processes can offer the teacher and administrators many creative solutions.
*Duplicating courses or specific activities in one course to another course (similar to Import)
*Updating a production Moodle site course, with material from a localhost site course
*Transferring a course to a new Moodle site.
*In earlier versions of Moodle, a way of rolling a course forward without past student activity
*Creating a blank activity, save just that activity and then restore it to the course or another course one or more times.

==General backup defaults==

Default settings for course backups can be set by a site administrator in 'General backup defaults' in the Site administration.

Selected settings may be locked, so that they cannot be changed when creating a course backup.

By selecting a time in the "Keep logs for.." dropdown, it is possible to specify how long backup logs information is kept before being deleted. As this information may be very large, it is recommended the length of time chosen be quite short.

==Course backup stops above 90%, not showing any errors==
This has been reported to be caused by:
* a [[Course_formats#Contributed_Course_Formats|non-standard course_format]]. Try replacing the course format.
* not enough server RAM. Adding more RAM to your server is usually the first [[Performance_recommendations|performance recomendation]].

==Course backup capabilities==

*[[Capabilities/moodle/backup:anonymise|Anonymise user data on backup]]
*[[Capabilities/moodle/backup:backupcourse|Backup courses]]
*[[Capabilities/moodle/backup:backupsection|Backup sections]]
*[[Capabilities/moodle/backup:backuptargetimport|Backup for import]]
*[[Capabilities/moodle/backup:configure|Configure backup options]]
*[[Capabilities/moodle/backup:downloadfile|Download files from backup areas]]
*[[Capabilities/moodle/backup:userinfo|Backup user data]]

==Error: Trying to restore user 'admin' from backup file will cause conflict ==
* Before proceeding, it would be advisable to have a second admin account ''just in case something goes wrong''.
* Check that the admin accounts on each server have '''different''' unique usernames and email addresses and then try again to backup up the course with user data and restore it.
** If you can not make a new backup and you must use an existing 'conflicting' backup file, you will have to change the new site's main admin account with extreme care to remember the new main admin's password and email.
* Note that the admin account from the imported file may loose the password and become unusable;
* You are advised to update/reset the 'imported' main 'admin's account's password before logging out, as this will most likely be the main 'admin' account for the site, and you would get into serious problems if this account stops working.
* If something goes terribly wrong, you can use the second admin account to fix the main admin account.

==See also==

*[[Course restore]]
*[[Backup of user data]]
*[[Activity backup]]
* Administrators can use [http://moosh-online.com/commands/#course-restore MOOSH] to bulk backup and restore courses from CLI

[[Category:Course]]

[[de:Kurssicherung]]
[[es:Respaldo del curso]]
[[eu:Ikastaroaren_Segurtasun-kopia]]
[[fr:Sauvegarde de cours]]
[[ja:コースバックアップ]]

Course backup

2020-03-12T11:33:29Z

Libertymoodle: /* Example: add Windows CLI info with DESTINATION being the Moodledata folder */

{{Backup}}
A course can be saved with some or all of its parts by using the course backup. Typically, the site administrator will set a schedule of [[Automated course backup|automated course backups]] for the whole site. A teacher can create a backup or download an existing backup for safe keeping, or for use on another Moodle site.

{{MediaPlayer | url = https://youtu.be/eNe6kRv2ndI| desc = Course backup: Moodle 3.7}}

==Backing up a course==

To backup a course

# Go into the course.
# Click the Backup link either in the gear menu or the Administration block (depending upon the theme).
# Initial settings - Select activities, blocks, filters and other items as required then click the Next button. Users with appropriate permissions, such as administrators and managers, can choose whether to [[Backup of user data|include users]], anonymize user information, or include user role assignments, groups, groupings, user files, comments, user completion details, course logs and grade history in the backup.
# Schema settings - Select/deselect specific items to include in backup, then click the Next button.
# If desired, select specific types of activity to be backed up by clicking the link 'Show type options'
# Confirmation and review - Check that everything is as required, using the Previous button if necessary, otherwise click the 'Perform backup' button
# Complete - Click the Continue button

{|
[[File:backupgroups.png|thumb|Backup settings]]
|
|[[File:26backuprestore1.png|thumb|Back up screen with option to select all or none]]
|
|[[File:26backuprestore2.png|thumb|Back up screen with option to select activity types]]
|}

A backup file (with distinctive .mbz extension to avoid confusion with .zip files) is then saved in the course backup area. Backup file names are of the form ''backup-moodle2-course-coursename-date-hour.mbz'', ending in ''-nu.mbz'' when backed up with no users and ''-an.mbz'' with anonymized names.

Tip: If you are satisfied with the default settings and don't wish to go through all the backup screens, you can simply click 'Jump to final step' to perform the backup.

==Anonymizing user information==

Anonymize user information is a backup feature which "protects user identities" by making each user anonymous. If this box is checked in the backup initial settings, Moodle will substitute aliases for real names, substituting @doesntexist.com email addresses and so forth. For example "Max Manager" might become "anonfirstname4 anonlastname4".

==Asynchronous course backups==

With large courses it is helpful to be able to continue working while the course is backing up in the background. This can be done if the administrator checks the box 'Enable asynchronous backups' from ''Site Administration / Advanced features''

==Backup via CLI for administrators==

Site administrators can backup selected courses using a CLI script.

===Options===
* --courseid=INTEGER (Course ID for backup.)
* --courseshortname=STRING (Course shortname for backup.)
* --destination=STRING (Path where to store backup file. If not set the backup will be stored within the course backup file area.)
* -h, --help (Print out this help.)

===Example===
\$sudo -u www-data /usr/bin/php admin/cli/backup.php --courseid=2 --destination=/moodle/backup/

On Windows you will use cmd.exe to run the /admin/cli/backup.php script. If you have your Moodledata folder setup on a separate data server you can specify a UNC path to your backup folder on that data server:

CD to the Moodle ''\admin\cli'' folder and run this command:
<code php>
php backup.php --courseid=25 --destination=\\moodledata\backup
</code>

The .mbz backup file for courseid=25 will be stored in the ''backup'' subfolder in the ''Moodledata'' folder.

==Tips and tricks==
* Lose content after a restore in Moodle 2.0 ? Do you see topic headings that say "Orphaned activities"? Solution: Go to course settings and increase the number of topic sections and things will return to normal.

==Creative uses==
The backup and restore processes can offer the teacher and administrators many creative solutions.
*Duplicating courses or specific activities in one course to another course (similar to Import)
*Updating a production Moodle site course, with material from a localhost site course
*Transferring a course to a new Moodle site.
*In earlier versions of Moodle, a way of rolling a course forward without past student activity
*Creating a blank activity, save just that activity and then restore it to the course or another course one or more times.

==General backup defaults==

Default settings for course backups can be set by a site administrator in 'General backup defaults' in the Site administration.

Selected settings may be locked, so that they cannot be changed when creating a course backup.

By selecting a time in the "Keep logs for.." dropdown, it is possible to specify how long backup logs information is kept before being deleted. As this information may be very large, it is recommended the length of time chosen be quite short.

==Course backup stops above 90%, not showing any errors==
This has been reported to be caused by:
* a [[Course_formats#Contributed_Course_Formats|non-standard course_format]]. Try replacing the course format.
* not enough server RAM. Adding more RAM to your server is usually the first [[Performance_recommendations|performance recomendation]].

==Course backup capabilities==

*[[Capabilities/moodle/backup:anonymise|Anonymise user data on backup]]
*[[Capabilities/moodle/backup:backupcourse|Backup courses]]
*[[Capabilities/moodle/backup:backupsection|Backup sections]]
*[[Capabilities/moodle/backup:backuptargetimport|Backup for import]]
*[[Capabilities/moodle/backup:configure|Configure backup options]]
*[[Capabilities/moodle/backup:downloadfile|Download files from backup areas]]
*[[Capabilities/moodle/backup:userinfo|Backup user data]]

==Error: Trying to restore user 'admin' from backup file will cause conflict ==
* Before proceeding, it would be advisable to have a second admin account ''just in case something goes wrong''.
* Check that the admin accounts on each server have '''different''' unique usernames and email addresses and then try again to backup up the course with user data and restore it.
** If you can not make a new backup and you must use an existing 'conflicting' backup file, you will have to change the new site's main admin account with extreme care to remember the new main admin's password and email.
* Note that the admin account from the imported file may loose the password and become unusable;
* You are advised to update/reset the 'imported' main 'admin's account's password before logging out, as this will most likely be the main 'admin' account for the site, and you would get into serious problems if this account stops working.
* If something goes terribly wrong, you can use the second admin account to fix the main admin account.

==See also==

*[[Course restore]]
*[[Backup of user data]]
*[[Activity backup]]
* Administrators can use [http://moosh-online.com/commands/#course-restore MOOSH] to bulk backup and restore courses from CLI

[[Category:Course]]

[[de:Kurssicherung]]
[[es:Respaldo del curso]]
[[eu:Ikastaroaren_Segurtasun-kopia]]
[[fr:Sauvegarde de cours]]
[[ja:コースバックアップ]]

Talk:Capabilities/mod/feedback:view

2019-11-21T17:09:02Z

Libertymoodle: /* Explanation required */

What does "allows a user to view a feedback activity" mean? Can a user with this capability just open a feedback form or can they see all the feedback responses submitted by students?
--[[User:Luis de Vasconcelos|Luis de Vasconcelos]] ([[User talk:Luis de Vasconcelos|talk]]) 17:08, 21 November 2019 (UTC)

ad-hoc contributed reports

2019-11-19T14:29:08Z

Libertymoodle: /* Quiz Module Reports - Questions which are tagged within a course/quiz */

{{Sitewide reports}}
==User and Role Report==

===Count number of distinct learners and teachers enrolled per category (including all its sub categories)===
<code sql>SELECT COUNT(DISTINCT lra.userid) AS learners, COUNT(DISTINCT tra.userid) as teachers
FROM prefix_course AS c #, mdl_course_categories AS cats
LEFT JOIN prefix_context AS ctx ON c.id = ctx.instanceid
JOIN prefix_role_assignments AS lra ON lra.contextid = ctx.id
JOIN prefix_role_assignments AS tra ON tra.contextid = ctx.id
JOIN prefix_course_categories AS cats ON c.category = cats.id
WHERE c.category = cats.id
AND (
cats.path LIKE '%/CATEGORYID/%' #Replace CATEGORYID with the category id you want to count (eg: 80)
OR cats.path LIKE '%/CATEGORYID'
)
AND lra.roleid=5
AND tra.roleid=3</code>

===Detailed ACTIONs for each ROLE (TEACHER, NON-EDITING TEACHER and STUDENT)===
<code sql>
SELECT r.name, l.action, COUNT( l.userid ) AS counter
FROM prefix_log AS l
JOIN prefix_context AS context ON context.instanceid = l.course AND context.contextlevel = 50
JOIN prefix_role_assignments AS ra ON l.userid = ra.userid AND ra.contextid = context.id
JOIN prefix_role AS r ON ra.roleid = r.id
WHERE ra.roleid IN ( 3, 4, 5 )
GROUP BY roleid, l.action
</code>

===Student (user) COUNT in each Course===
Including (optional) filter by: year (if included in course fullname).
<code sql>
SELECT CONCAT('<a target="_new" href="%%WWWROOT%%/course/view.php?id=',course.id,'">',course.fullname,'</a>') AS Course
,CONCAT('<a target="_new" href="%%WWWROOT%%/user/index.php?contextid=',context.id,'">Show users</a>') AS Users
, COUNT(course.id) AS Students
FROM prefix_role_assignments AS asg
JOIN prefix_context AS context ON asg.contextid = context.id AND context.contextlevel = 50
JOIN prefix_user AS user ON user.id = asg.userid
JOIN prefix_course AS course ON context.instanceid = course.id
WHERE asg.roleid = 5
# AND course.fullname LIKE '%2013%'
GROUP BY course.id
ORDER BY COUNT(course.id) DESC
</code>

=== Enrolment count in each Course ===

Shows the total number of enroled users of all roles in each course. Sorted by course name.

<code sql>
SELECT c.fullname, COUNT(ue.id) AS Enroled
FROM prefix_course AS c
JOIN prefix_enrol AS en ON en.courseid = c.id
JOIN prefix_user_enrolments AS ue ON ue.enrolid = en.id
GROUP BY c.id
ORDER BY c.fullname
</code>

===LIST of all site USERS by COURSE enrollment (Moodle 2.x)===

<code sql>
SELECT
user2.firstname AS Firstname,
user2.lastname AS Lastname,
user2.email AS Email,
user2.city AS City,
course.fullname AS Course
,(SELECT shortname FROM prefix_role WHERE id=en.roleid) as Role
,(SELECT name FROM prefix_role WHERE id=en.roleid) as RoleName

FROM prefix_course as course
JOIN prefix_enrol AS en ON en.courseid = course.id
JOIN prefix_user_enrolments AS ue ON ue.enrolid = en.id
JOIN prefix_user AS user2 ON ue.userid = user2.id
</code>

===Enrolled users,which did not login into the Course, even once (Moodle 2)===
Designed forMoodle 2 table structure and uses special plugin filter : %%FILTER_SEARCHTEXT:table.field%%

<code sql>
SELECT
user2.id as ID,
ul.timeaccess,
user2.firstname AS Firstname,
user2.lastname AS Lastname,
user2.email AS Email,
user2.city AS City,
user2.idnumber AS IDNumber,
user2.phone1 AS Phone,
user2.institution AS Institution,

IF (user2.lastaccess = 0,'never',
DATE_FORMAT(FROM_UNIXTIME(user2.lastaccess),'%Y-%m-%d')) AS dLastAccess

,(SELECT DATE_FORMAT(FROM_UNIXTIME(timeaccess),'%Y-%m-%d') FROM prefix_user_lastaccess WHERE userid=user2.id and courseid=c.id) as CourseLastAccess

,(SELECT r.name
FROM prefix_user_enrolments AS uenrol
JOIN prefix_enrol AS e ON e.id = uenrol.enrolid
JOIN prefix_role AS r ON e.id = r.id
WHERE uenrol.userid=user2.id and e.courseid = c.id) AS RoleName

FROM prefix_user_enrolments as ue
JOIN prefix_enrol as e on e.id = ue.enrolid
JOIN prefix_course as c ON c.id = e.courseid
JOIN prefix_user as user2 ON user2 .id = ue.userid
LEFT JOIN prefix_user_lastaccess as ul on ul.userid = user2.id
WHERE c.id=16 AND ul.timeaccess IS NULL
%%FILTER_SEARCHTEXT:user2.firstname%%
</code>

===Role assignments on categories===
<code sql>
SELECT
concat('<a target="_new" href="%%WWWROOT%%/course/category.php?id=',cc.id,'">',cc.id,'</a>') AS id,
concat('<a target="_new" href="%%WWWROOT%%/course/category.php?id=',cc.id,'">',cc.name,'</a>') AS category,
cc.depth, cc.path, r.name AS role,
concat('<a target="_new" href="%%WWWROOT%%/user/view.php?id=',usr.id,'">',usr.lastname,'</a>') AS name,
usr.firstname, usr.username, usr.email
FROM prefix_course_categories cc
INNER JOIN prefix_context cx ON cc.id = cx.instanceid
AND cx.contextlevel = '40'
INNER JOIN prefix_role_assignments ra ON cx.id = ra.contextid
INNER JOIN prefix_role r ON ra.roleid = r.id
INNER JOIN prefix_user usr ON ra.userid = usr.id
ORDER BY cc.depth, cc.path, usr.lastname, usr.firstname, r.name, cc.name
</code>

===Permissions Overides on Categories===
(By: [http://moodle.org/mod/forum/discuss.php?d=153059#p712834 Séverin Terrier] )
<code sql>
SELECT rc.id, ct.instanceid, ccat.name, rc.roleid, rc.capability, rc.permission,
DATE_FORMAT( FROM_UNIXTIME( rc.timemodified ) , '%Y-%m-%d' ) AS timemodified, rc.modifierid, ct.instanceid, ct.path, ct.depth
FROM `prefix_role_capabilities` AS rc
INNER JOIN `prefix_context` AS ct ON rc.contextid = ct.id
INNER JOIN `prefix_course_categories` AS ccat ON ccat.id = ct.instanceid
AND `contextlevel` =40
</code>

===Lists "Totally Opened Courses" (visible, opened to guests, with no password)===
(By: [http://moodle.org/mod/forum/discuss.php?d=153059#p712837 Séverin Terrier] )
<code sql>
SELECT
concat('<a target="_new" href="%%WWWROOT%%/course/view.php?id=',c.id,'">',c.id,'</a>') AS id,
concat('<a target="_new" href="%%WWWROOT%%/course/view.php?id=',c.id,'">',c.shortname,'</a>') AS 'Course',
concat('<a target="_new" href="%%WWWROOT%%/enrol/instances.php?id=',c.id,'">Méthodes inscription</a>') AS 'Enrollment plugins',
e.sortorder
FROM prefix_enrol AS e, prefix_course AS c
WHERE e.enrol='guest' AND e.status=0 AND e.password='' AND c.id=e.courseid AND c.visible=1
</code>

===Lists "loggedin users" from the last 120 days===
<code sql>
SELECT id,username,FROM_UNIXTIME(`lastlogin`) as days
FROM `prefix_user`
WHERE DATEDIFF( NOW(),FROM_UNIXTIME(`lastlogin`) ) < 120
</code>

''and user count for that same population:''
<code sql>
SELECT COUNT(id) as Users FROM `prefix_user`
WHERE DATEDIFF( NOW(),FROM_UNIXTIME(`lastlogin`) ) < 120
</code>

==== Users loggedin within the last 7 days ====
<code sql>
SELECT
l.* FROM mdl_logstore_standard_log l
WHERE
l.eventname = '\\core\\event\\user_loggedin'
AND FROM_UNIXTIME(l.timecreated, '%Y-%m-%d') >= DATE_SUB(NOW(), INTERVAL 7 DAY)

SELECT l.eventname FROM mdl_logstore_standard_log l
GROUP BY l.eventname
</code>

===Lists the users who have only logged into the site once===
<code sql>
SELECT id, username, firstname, lastname, idnumber
FROM prefix_user
WHERE prefix_user.deleted = 0
AND prefix_user.lastlogin = 0
AND prefix_user.lastaccess > 0
</code>

===Students in all courses of some institute===
What is the status (deleted or not) of all Students (roleid = 5) in all courses of some Institute
<code sql>
SELECT c.id, c.fullname, u.firstname, u.lastname, u.deleted
FROM prefix_course AS c
JOIN prefix_context AS ctx ON c.id = ctx.instanceid
JOIN prefix_role_assignments AS ra ON ra.contextid = ctx.id
JOIN prefix_user AS u ON u.id = ra.userid
WHERE ra.roleid =5
AND ctx.instanceid = c.id
AND u.institution = 'please enter school name here'
</code>

===Full User info (for deleted users)===
Including extra custom profile fields (from prefix_user_info_data)
<code sql>
SELECT *
FROM prefix_user as u
JOIN prefix_user_info_data as uid ON uid.userid = u.id
JOIN prefix_user_info_field as uif ON (uid.fieldid = uif.id AND uif.shortname = 'class')
WHERE `deleted` = "1" and `institution`="your school name" and `department` = "your department" and `data` = "class level and number"
</code>

===User's courses===
change "u.id = 2" with a new user id
<code sql>
SELECT u.firstname, u.lastname, c.id, c.fullname
FROM prefix_course AS c
JOIN prefix_context AS ctx ON c.id = ctx.instanceid
JOIN prefix_role_assignments AS ra ON ra.contextid = ctx.id
JOIN prefix_user AS u ON u.id = ra.userid
WHERE u.id = 2
</code>

===List Users with extra info (email) in current course===
blocks/configurable_reports replaces %%COURSEID%% with course id.
<code sql>
SELECT u.firstname, u.lastname, u.email
FROM prefix_role_assignments AS ra
JOIN prefix_context AS context ON context.id = ra.contextid AND context.contextlevel = 50
JOIN prefix_course AS c ON c.id = context.instanceid AND c.id = %%COURSEID%%
JOIN prefix_user AS u ON u.id = ra.userid
</code>

===List Students with enrollment and completion dates in current course===
This is meant to be a "global" report in Configurable Reports containing the following:
firstname, lastname, idnumber, institution, department, email, student enrolment date, student completion date
Note: for PGSQL, use to_timestamp() instead of FROM_UNIXTIME()
Contributed by Elizabeth Dalton, Moodle HQ

<code sql>
SELECT
u.firstname
, u.lastname
, u.idnumber
, u.institution
, u.department
, u.email
, FROM_UNIXTIME(cc.timeenrolled)
, FROM_UNIXTIME(cc.timecompleted)

FROM prefix_role_assignments AS ra
JOIN prefix_context AS context ON context.id = ra.contextid AND context.contextlevel = 50
JOIN prefix_course AS c ON c.id = context.instanceid AND c.id = %%COURSEID%%
JOIN prefix_user AS u ON u.id = ra.userid
JOIN prefix_course_completions AS cc ON cc.course = c.id AND cc.userid = u.id
</code>

===Special Roles===
<code sql>
SELECT ra.roleid,r.name
,concat('<a target="_new" href="%%WWWROOT%%/course/user.php?id=1&user=',ra.userid,'">',u.firstname ,' ',u.lastname,'</a>') AS Username
,concat('<a target="_new" href="%%WWWROOT%%/course/view.php?id=',c.id,'">',c.fullname,'</a>') AS Course
FROM prefix_role_assignments AS ra
JOIN prefix_role AS r ON r.id = ra.roleid
JOIN prefix_user AS u ON u.id = ra.userid
JOIN prefix_context AS ctx ON (ctx.id = ra.contextid AND ctx.contextlevel = 50)
JOIN prefix_course AS c ON ctx.instanceid = c.id
WHERE ra.roleid > 6
</code>

===Courses without Teachers===
Actually, shows the number of Teachers in a course.
<code sql>
SELECT concat('<a target="_new" href="%%WWWROOT%%/course/view.php?id=',c.id,'">',c.fullname,'</a>') as Course
,(SELECT Count( ra.userid ) AS Users FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
WHERE ra.roleid = 3 AND ctx.instanceid = c.id) AS Teachers
FROM prefix_course AS c
ORDER BY Teachers ASC
</code>

===List of users who have been enrolled for more than 4 weeks===
For Moodle 2.2 , by Isuru Madushanka Weerarathna
<code sql>
SELECT uenr.userid As User, IF(enr.courseid=uenr.courseid ,'Y','N') As Enrolled,
IF(DATEDIFF(NOW(), FROM_UNIXTIME(uenr.timecreated))>=28,'Y','N') As EnrolledMoreThan4Weeks
FROM prefix_enrol As enr, prefix_user_enrolments AS uenr
WHERE enr.id = uenr.enrolid AND enr.status = uenr.status
</code>

=== List of users with language===

Contributed by: [https://moodle.org/user/profile.php?id=88992 Randy Thornton]

An issue with systems that do not have their default language set up properly is the need to do a mass change for all users to a localization. A common case (in the U.S., Canada and the Americas) is changing the default English to United States English.

This will show you the language setting for all users:
<code sql>
SELECT username, lang from prefix_user
</code>

NOTE: UPDATE commands require the ability to alter the database directly via tools like Adminer or PHPMyAdmin or other db tools.

This code will change the setting from 'en' to 'en_us' for all users:

<code sql>
UPDATE prefix_user SET lang = 'en_us' WHERE lang = 'en'
</code>

To do this for only users who have a particular country set, use this as an example:
<code sql>
UPDATE prefix_user SET lang = 'en_us' WHERE country = 'US' AND lang = 'en'
</code>

=== List of users with Authentication ===

Contributed by: [https://moodle.org/user/profile.php?id=88992 Randy Thornton]

Sometimes you need to do mass changes of authentication methods. A common case is changing default manual to LDAP.

This will show you the Authentication setting for all users:
<code sql>
SELECT username, auth from prefix_user
</code>

NOTE: UPDATE commands require the ability to alter the database directly via tools like Adminer or PHPMyAdmin or other db tools.

This code will change the setting from 'manual' to 'ldap' for all users except for the first two accounts which are Guest and Admin. (WARNING: it is bad practice to change your admin account from manual to an external method as failure of that external method will lock you out of Moodle as admin.)

<code sql>
UPDATE prefix_user SET auth = 'ldap' WHERE auth = 'manual' AND id > 2
</code>

=== Compare role capability and permissions ===
<code sql>
SELECT DISTINCT mrc.capability
,(SELECT rc.permission FROM `mdl_role_capabilities` AS rc WHERE rc.capability = mrc.capability
AND rc.roleid = '1' AND rc.contextid = '1') AS Manager
,(SELECT rc.permission FROM `mdl_role_capabilities` AS rc WHERE rc.capability = mrc.capability
AND rc.roleid = '2' AND rc.contextid = '1') AS CourseCreator
,(SELECT rc.permission FROM `mdl_role_capabilities` AS rc WHERE rc.capability = mrc.capability
AND rc.roleid = '3' AND rc.contextid = '1') AS Teacher
,(SELECT rc.permission FROM `mdl_role_capabilities` AS rc WHERE rc.capability = mrc.capability
AND rc.roleid = '4' AND rc.contextid = '1') AS AssistantTeacher
,(SELECT rc.permission FROM `mdl_role_capabilities` AS rc WHERE rc.capability = mrc.capability
AND rc.roleid = '5' AND rc.contextid = '1') AS Student
,(SELECT rc.permission FROM `mdl_role_capabilities` AS rc WHERE rc.capability = mrc.capability
AND rc.roleid = '6' AND rc.contextid = '1') AS Guest

FROM `mdl_role_capabilities` AS mrc
</code>

=== User's accumulative time spent in course ===
A sum up of the time delta between logstore_standard_log user's records, considering the a 2 hour session limit.

Uses: current user's id %%USERID%% and current course's id %%COURSEID%%

And also using a date filter (which can be ignored)

The extra "User" field is used as a dummy field for the Line chart Series field, in which I use X=id, Series=Type, Y=delta.

<code sql>
SELECT
l.id,
l.timecreated,
DATE_FORMAT(FROM_UNIXTIME(l.timecreated),'%d-%m-%Y') AS dTime,
@prevtime := (SELECT max(timecreated) FROM mdl_logstore_standard_log
WHERE userid = %%USERID%% and id < l.id ORDER BY id ASC LIMIT 1) AS prev_time,
IF (l.timecreated - @prevtime < 7200, @delta := @delta + (l.timecreated-@prevtime),0) AS sumtime,
l.timecreated-@prevtime AS delta,
"User" as type

FROM prefix_logstore_standard_log as l,
(SELECT @delta := 0) AS s_init
# Change UserID
WHERE l.userid = %%USERID%% AND l.courseid = %%COURSEID%%
%%FILTER_STARTTIME:l.timecreated:>%% %%FILTER_ENDTIME:l.timecreated:<%%
</code>

=== Low-Participation Student Report ===
Contributed by Elizabeth Dalton, Granite State College / Moodle HQ

This report returns a list of students who are enrolled in courses filtered by a short-name text marker (in this case "OL-") in the specified category, but have very low participation in the course during the specified time period (fewer than 2 "Edits" to Activity Modules, indicating few active contributions to the course). The number of "Edits" is provided for each student for the time period specified.

An "Edit" is defined as course activity other than viewing content. Click the "Logs" link to review the student activity. The Logs offer the option to review "View" activity as well as "Edit" activity.

Only "visible" courses are included in this report. The report may be downloaded as an Excel spreadsheet.

Don't forget to set up Filters: "Start / End date filter" and "Filter categories" on the Filters tab in Configurable reports.

<code sql>
SELECT u.lastname AS Last, u.firstname AS First, u.idnumber AS IDnumber, u.email AS email, c.shortname AS CourseID, count(l.id) AS Edits, CONCAT('<a target="_new" href="https://learn.granite.edu/report/log/index.php',CHAR(63),'chooselog=1&showusers=1&showcourses=0&id=',c.id,'&user=',u.id,'&date=0&modid=&modaction=-view&logformat=showashtml','">','Logs','</a>') AS Link

FROM prefix_user AS u
JOIN prefix_role_assignments AS ra ON u.id = ra.userid
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
JOIN prefix_course AS c ON c.id = ctx.instanceid

LEFT JOIN prefix_log AS l ON l.userid = u.id AND l.course = c.id AND l.action NOT LIKE "view%" %%FILTER_STARTTIME:l.TIME:>%% %%FILTER_ENDTIME:l.TIME:<%%

WHERE ra.roleid =5
AND ctx.instanceid = c.id
AND c.visible=1
# This prefix filter allows the exclusion of non-online courses at the original institution. Alter this to fit your institution, or remove it.
AND c.shortname LIKE '%OL-%'
%%FILTER_CATEGORIES:c.category%%

GROUP BY u.idnumber

HAVING Edits < 2
</code>

=== Messages of All Users in a Specific Course ===

Contributed by: [https://moodle.org/user/profile.php?id=88992 Randy Thornton]

NOTE: This query will probably not work at all in 3.5 now due to the changes in the structure of the Messages database. - RT

This query shows the personal messages between users in a specific course, given the course id number. Properly speaking, personal messages pertain only to users and are not part of courses, but by filtering enrollments for roles in a course, you can show this.

This report as is shows only the messages between Teachers and Students, as the WHERE statement contains and AND ((...))) section that restrict this report to ONLY messages between Teachers (role id = 3) and Students (role id =5). Remove that part of the statement if you wish to see _all_ messages between all users, e.g. teachers to teachers, student to student.

Also, if you have created custom roles, you can replace the default id numbers with custom ones to further enhance the report.

<code sql>
SELECT
u.username AS 'From',
CONCAT(u.firstname ,' ',u.lastname) AS 'From Name',
u2.username AS 'To',
CONCAT(u2.firstname ,' ',u2.lastname) AS 'To Name',
DATE_FORMAT(FROM_UNIXTIME(me.timecreated), '%Y-%m-%d %H:%i') AS 'When',
me.subject AS 'Subject',
me.smallmessage AS 'Message'
FROM prefix_message me
JOIN prefix_role_assignments AS ra ON ra.userid = me.useridfrom AND ra.roleid IN (3,4,5)
JOIN prefix_role_assignments AS ra2 ON ra2.userid = me.useridto AND ra2.roleid IN (3,4,5)
JOIN prefix_context AS ctx ON ra.contextid = ctx.id AND ra2.contextid = ctx.id
JOIN prefix_course AS c ON c.id = ctx.instanceid
JOIN prefix_user u ON u.id = me.useridfrom
JOIN prefix_user u2 ON u2.id = me.useridto
WHERE c.id=##
AND ((ra.roleid = 3 AND ra2.roleid = 5) OR (ra.roleid = 5 AND ra2.roleid = 3))
ORDER BY me.useridfrom, me.useridto, me.timecreated
</code>

==Log Activity Reports==
===Count all Active Users by ROLE in a course category (including all of its sub-categories)===
<code sql>
SELECT COUNT(DISTINCT l.userid) as active
FROM mdl_course as c
JOIN mdl_context AS ctx ON ctx.instanceid=c.id
JOIN mdl_role_assignments AS ra ON ra.contextid = ctx.id
JOIN mdl_user_lastaccess as l ON ra.userid = l.userid
JOIN mdl_course_categories AS cats ON c.category = cats.id
WHERE c.category=cats.id AND (
cats.path LIKE '%/80/%'
OR cats.path LIKE '%/80'
)
AND ra.roleid=3 AND ctx.contextlevel=50 #ra.roleid= TEACHER 3, NON-EDITING TEACHER 4, STUDENT 5
AND l.timeaccess > (unix_timestamp() - ((60*60*24)*NO_OF_DAYS)) #NO_OF_DAYS change to number
</code>
===Detailed "VIEW" ACTION for each ROLE (TEACHER,NONE-EDITING TEACHER and STUDENT)===
<code sql>
SELECT l.action, count( l.userid ) as counter , r.name
FROM `prefix_log` as l
JOIN `prefix_role_assignments` AS ra on l.userid = ra.userid
JOIN `prefix_role` AS r ON ra.roleid = r.id
WHERE (ra.roleid IN (3,4,5)) AND (l.action LIKE '%view%' )
GROUP BY roleid,l.action
order by r.name,counter desc
</code>

===Total Activity of Roles:"Teacher" and "None-Editing Teacher" by Dates and by Hours===
The output columns of this report table can be used as base for a Pivot-Table
which will show the amount of '''activity''' per '''hour''' per '''days''' in 3D graph view.

<code sql>
SELECT DATE_FORMAT( FROM_UNIXTIME( l.time ) , '%Y-%m-%d' ) AS grptimed ,
DATE_FORMAT( FROM_UNIXTIME( l.time ) , '%k' ) AS grptimeh , count( l.userid ) AS counter
FROM `prefix_log` AS l
JOIN prefix_user AS u ON u.id = l.userid
JOIN prefix_role_assignments AS ra ON l.userid = ra.userid
JOIN prefix_role AS r ON r.id = ra.roleid
WHERE ra.roleid IN (3,4)
GROUP BY grptimed,grptimeh
ORDER BY grptimed,grptimeh
</code>

===How many LOGINs per user and user's Activity===
+ link username to a user activity graph report
<code sql>
SELECT concat('<a target="_new" href="%%WWWROOT%%/course/user.php?id=1&user=',u.id,'&mode=alllogs">',u.firstname ,' ',u.lastname,'</a>') as Username
,count(*) as logins
,(SELECT count(*) FROM prefix_log WHERE userid = l.userid GROUP BY userid) as Activity
FROM prefix_log as l JOIN prefix_user as u ON l.userid = u.id
WHERE `action` LIKE '%login%' group by userid
ORDER BY Activity DESC
</code>
===Distinct user logins per month===

Contributed by: [https://moodle.org/user/profile.php?id=88992 Randy Thornton]

The following will show you the months of the current calendar year with the total number of distinct, unique user logins per month. Change the year in the WHERE clause to the year you need.

<code sql>
SELECT
COUNT(DISTINCT l.userid) AS 'DistinctUserLogins',
DATE_FORMAT(FROM_UNIXTIME(l.timecreated), '%M') AS 'Month'
FROM prefix_logstore_standard_log l
WHERE l.action = 'loggedin' AND YEAR(FROM_UNIXTIME(l.timecreated)) = '2017'
GROUP BY MONTH(FROM_UNIXTIME(l.timecreated))
</code>

===Total activity per course, per unique user on the last 24h===
<code sql>
SELECT
COUNT(DISTINCT userid) AS countUsers
, COUNT(l.courseid) AS countVisits
, CONCAT('<a target="_new" href="%%WWWROOT%%/course/view.php?id=',c.id,'">', c.fullname, '</a>') AS Course

FROM mdl_logstore_standard_log AS l
JOIN mdl_course AS c ON c.id = l.courseid
WHERE l.courseid > 0
AND FROM_UNIXTIME(l.timecreated) >= DATE_SUB(NOW(), INTERVAL 1 DAY)
AND c.fullname LIKE '%תשעו%'
GROUP BY l.courseid
ORDER BY countVisits DESC
</code>

===Weekly Instructor Online Participation===
Contributed by Elizabeth Dalton, Granite State College

Displays participation of instructors in all courses per week of a term, including pre-term and post-term edits. An edit is defined as a change to the course, such as a discussion post, the grading of an assignment, or the uploading of file attachments, as well as alterations to course content.

* To specify a subject and/or course number, use % as a wildcard, e.g. ARTS% or ARTS501%
* To match part of a last name, use %, e.g. Smi% will match "Smith", "Smile", etc.

At our institution, we include filters on the course name or category to constrain by terms. These are very specific to how course names and categories are constructed at our institution, so I've removed those elements from this code. Also, our terms are 12 weeks long. You would want to insert additional "SUM" lines for longer terms, or remove lines for shorter terms.

'''Note''': This report can take a long time to run. While it can be run in Configurable Reports on demand, it may be more appropriate to implement it in the Ad Hoc Queries plugin as a scheduled report.

'''Note''': This version uses legacy (pre-2.7) logs. See below for post-2.7 Standard Logs version.

<code sql>
SELECT
c.shortname AS CourseID
, cc.name AS Category
, CONCAT(u.firstname ,' ',u.lastname) AS Instructor

, (SELECT COUNT( ra2.userid ) AS Users2 FROM prefix_role_assignments AS ra2
JOIN prefix_context AS ctx2 ON ra2.contextid = ctx2.id
WHERE ra2.roleid = 5 AND ctx2.instanceid = c.id) AS Students

, c.startdate AS Course_Start_Date

, c.visible AS Visible

, COUNT(l.id) AS Edits

, SUM(IF(WEEK(FROM_UNIXTIME(l.time)) - WEEK(FROM_UNIXTIME(c.startdate))<0,1,0)) AS BeforeTerm

, SUM(IF(WEEK(FROM_UNIXTIME(l.time))-WEEK(FROM_UNIXTIME(c.startdate))=0,1,0)) AS Week1
, SUM(IF(WEEK(FROM_UNIXTIME(l.time))-WEEK(FROM_UNIXTIME(c.startdate))=1,1,0)) AS Week2
, SUM(IF(WEEK(FROM_UNIXTIME(l.time))-WEEK(FROM_UNIXTIME(c.startdate))=2,1,0)) AS Week3
, SUM(IF(WEEK(FROM_UNIXTIME(l.time))-WEEK(FROM_UNIXTIME(c.startdate))=3,1,0)) AS Week4
, SUM(IF(WEEK(FROM_UNIXTIME(l.time))-WEEK(FROM_UNIXTIME(c.startdate))=4,1,0)) AS Week5
, SUM(IF(WEEK(FROM_UNIXTIME(l.time))-WEEK(FROM_UNIXTIME(c.startdate))=5,1,0)) AS Week6
, SUM(IF(WEEK(FROM_UNIXTIME(l.time))-WEEK(FROM_UNIXTIME(c.startdate))=6,1,0)) AS Week7
, SUM(IF(WEEK(FROM_UNIXTIME(l.time))-WEEK(FROM_UNIXTIME(c.startdate))=7,1,0)) AS Week8
, SUM(IF(WEEK(FROM_UNIXTIME(l.time))-WEEK(FROM_UNIXTIME(c.startdate))=8,1,0)) AS Week9
, SUM(IF(WEEK(FROM_UNIXTIME(l.time))-WEEK(FROM_UNIXTIME(c.startdate))=9,1,0)) AS Week10
, SUM(IF(WEEK(FROM_UNIXTIME(l.time))-WEEK(FROM_UNIXTIME(c.startdate))=10,1,0)) AS Week11
, SUM(IF(WEEK(FROM_UNIXTIME(l.time))-WEEK(FROM_UNIXTIME(c.startdate))=11,1,0)) AS Week12

, SUM(IF(WEEK(FROM_UNIXTIME(l.time))-WEEK(FROM_UNIXTIME(c.startdate))>=12,1,0)) AS AfterTerm

, CONCAT('<a target="_new" href="%%WWWROOT%%/report/log/index.php',CHAR(63),'chooselog=1&showusers=1&showcourses=0&id=',c.id,'&user=',u.id,'&date=0&modid=&modaction=&logformat=showashtml','">','Logs','</a>') AS Link

FROM prefix_user AS u
JOIN prefix_role_assignments AS ra ON u.id = ra.userid
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
JOIN prefix_course AS c ON c.id = ctx.instanceid
JOIN prefix_course_categories as cc ON c.category = cc.id

LEFT JOIN prefix_log AS l ON l.userid = u.id AND l.course = c.id AND l.action NOT LIKE "view%"

WHERE ra.roleid =3
AND ctx.instanceid = c.id
AND c.shortname LIKE :course
AND u.lastname LIKE :last_name

GROUP BY u.idnumber, c.id
HAVING students > 0
ORDER BY c.shortname
</code>

'''Note''': Post-2.7 log version:

<code sql>
SELECT
c.shortname AS CourseID
, cc.name AS Category
, CONCAT(u.firstname ,' ',u.lastname) AS Instructor

, (SELECT COUNT( ra2.userid ) AS Users2 FROM prefix_role_assignments AS ra2
JOIN prefix_context AS ctx2 ON ra2.contextid = ctx2.id
WHERE ra2.roleid = 5 AND ctx2.instanceid = c.id) AS Students

, FROM_UNIXTIME(c.startdate) AS Course_Start_Date

, c.visible AS Visible

, COUNT(DISTINCT l.id) AS Edits

, COUNT(DISTINCT IF((l.timecreated-c.startdate)<0,l.id,NULL)) AS 'Before Term'

, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=0,l.id,NULL)) AS 'Week 1'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=1,l.id,NULL)) AS 'Week 2'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=2,l.id,NULL)) AS 'Week 3'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=3,l.id,NULL)) AS 'Week 4'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=4,l.id,NULL)) AS 'Week 5'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=5,l.id,NULL)) AS 'Week 6'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=6,l.id,NULL)) AS 'Week 7'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=7,l.id,NULL)) AS 'Week 8'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=8,l.id,NULL)) AS 'Week 9'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=9,l.id,NULL)) AS 'Week 10'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=10,l.id,NULL)) AS 'Week 11'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=11,l.id,NULL)) AS 'Week 12'

, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))>=12,l.id,NULL)) AS 'After Term'

, CONCAT('<a target="_new" href="%%WWWROOT%%/report/log/index.php',CHAR(63),'chooselog=1&showusers=1&showcourses=0&id=',c.id,'&user=',u.id,'&date=0&modid=&modaction=&logformat=showashtml','">','Logs','</a>') AS Link

FROM prefix_user AS u
LEFT JOIN prefix_role_assignments AS ra ON u.id = ra.userid
LEFT JOIN prefix_context AS ctx ON ra.contextid = ctx.id
LEFT JOIN prefix_course AS c ON c.id = ctx.instanceid
LEFT JOIN prefix_course_categories as cc ON c.category = cc.id

LEFT JOIN prefix_logstore_standard_log AS l ON l.userid = u.id AND l.courseid = c.id AND l.crud IN ('c','u')

WHERE ra.roleid =3
AND ctx.instanceid = c.id
AND c.shortname LIKE '%OL-%'
AND cc.idnumber LIKE '%current%'

GROUP BY u.idnumber, c.id
#HAVING students > 0
ORDER BY RIGHT(c.shortname,2), c.shortname
</code>

===Weekly Student Online Participation===
Contributed by Elizabeth Dalton, Granite State College

Displays participation of students in the current course by week, including pre-term and post-term edits. An edit is defined as a change to the course, such as a discussion post, the submission of an assignment, or the completion of a quiz, as well as alterations to course content such as database entries (if permitted).

Links to three other reports are also provided:

* Logs: complete log entries for the student in the course, organized by date
* Activity Outline: the "Outline Report" from the User Activity Reports, summarizing the student's activity in the course, organized by course content
* Consolidated Activity Report: the "Complete Report" from the User Activity Reports, detailing the student's activity in the course, organized by course content (includes text of forum posts)

'''Note''': This should be defined as a "Global" report (visible from within all courses). At our institution, our terms are 12 weeks long. You would want to insert additional "SUM" lines for longer terms, or remove lines for shorter terms. We pull advisor names into student user profiles as part of our configuration. These lines are present in the code below, but are commented out, as they are very specific to your Moodle configuration.

'''Note''': This version of the report uses legacy (pre-2.7) logs. See below for a post-2.7 Standard Logs version.

<code sql>
SELECT
u.lastname AS 'Last Name'
, u.firstname AS 'First Name'
, COUNT(l.id) AS 'Edits'

, SUM(IF((l.time-c.startdate)/7<0,1,0)) AS 'Before Term'

, SUM(IF(FLOOR((l.time - c.startdate)/(60*60*24*7))=0,1,0)) AS 'Week 1'
, SUM(IF(FLOOR((l.time - c.startdate)/(60*60*24*7))=1,1,0)) AS 'Week 2'
, SUM(IF(FLOOR((l.time - c.startdate)/(60*60*24*7))=2,1,0)) AS 'Week 3'
, SUM(IF(FLOOR((l.time - c.startdate)/(60*60*24*7))=3,1,0)) AS 'Week 4'
, SUM(IF(FLOOR((l.time - c.startdate)/(60*60*24*7))=4,1,0)) AS 'Week 5'
, SUM(IF(FLOOR((l.time - c.startdate)/(60*60*24*7))=5,1,0)) AS 'Week 6'
, SUM(IF(FLOOR((l.time - c.startdate)/(60*60*24*7))=6,1,0)) AS 'Week 7'
, SUM(IF(FLOOR((l.time - c.startdate)/(60*60*24*7))=7,1,0)) AS 'Week 8'
, SUM(IF(FLOOR((l.time - c.startdate)/(60*60*24*7))=8,1,0)) AS 'Week 9'
, SUM(IF(FLOOR((l.time - c.startdate)/(60*60*24*7))=9,1,0)) AS 'Week 10'
, SUM(IF(FLOOR((l.time - c.startdate)/(60*60*24*7))=10,1,0)) AS 'Week 11'
, SUM(IF(FLOOR((l.time - c.startdate)/(60*60*24*7))=11,1,0)) AS 'Week 12'

, SUM(IF(FLOOR((l.time - c.startdate)/(60*60*24*7))>=15,1,0)) AS 'After Term'

, CONCAT('<a target="_blank" href="%%WWWROOT%%/report/log/index.php',CHAR(63),'chooselog=1&showusers=1&showcourses=0&id=',c.id,'&user=',u.id,'&date=0&modid=&modaction=&logformat=showashtml','">','Logs','</a>') AS 'Logs'

, CONCAT('<a target="_blank" href="%%WWWROOT%%/report/outline/user.php',CHAR(63),'id=',u.id,'&course=',c.id,'&mode=outline">','Outline','</a>') AS 'Activity Outline'

, CONCAT('<a target="_blank" href="%%WWWROOT%%/report/outline/user.php',CHAR(63),'id=',u.id,'&course=',c.id,'&mode=complete">','Activity','</a>') AS 'Consolidated Activity'

FROM prefix_user AS u
JOIN prefix_role_assignments AS ra ON u.id = ra.userid
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
JOIN prefix_course AS c ON c.id = ctx.instanceid
JOIN prefix_course_categories as cc ON c.category = cc.id

LEFT JOIN prefix_log AS l ON l.userid = u.id AND l.course = c.id AND l.action NOT LIKE "view%"

WHERE ra.roleid =5
AND ctx.instanceid = c.id

AND c.id = %%COURSEID%%

GROUP BY u.idnumber

ORDER BY u.lastname, u.firstname
</code>

'''Note''': Post-2.7 (Standard Logs) version

<code sql>
SELECT
u.lastname AS 'Last Name'
, u.firstname AS 'First Name'
, COUNT(l.id) AS 'Edits'

, COUNT(DISTINCT IF((l.timecreated-c.startdate)<0,l.id,NULL)) AS 'Before Term'

, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=0,l.id,NULL)) AS 'Week 1'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=1,l.id,NULL)) AS 'Week 2'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=2,l.id,NULL)) AS 'Week 3'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=3,l.id,NULL)) AS 'Week 4'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=4,l.id,NULL)) AS 'Week 5'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=5,l.id,NULL)) AS 'Week 6'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=6,l.id,NULL)) AS 'Week 7'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=7,l.id,NULL)) AS 'Week 8'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=8,l.id,NULL)) AS 'Week 9'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=9,l.id,NULL)) AS 'Week 10'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=10,l.id,NULL)) AS 'Week 11'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=11,l.id,NULL)) AS 'Week 12'

, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))>=12,l.id,NULL)) AS 'After Term'

# Our institution stores academic advisor names and emails in custom profile fields
#, CONCAT('<a href="mailto:',uce.data,'">',uid.data, '</a>') AS 'Academic Advisor'

, CONCAT('<a target="_blank" href="%%WWWROOT%%/report/log/index.php',CHAR(63),'chooselog=1&showusers=1&showcourses=0&id=',c.id,'&user=',u.id,'&date=0&modid=&modaction=&logformat=showashtml','">','Logs','</a>') AS 'Logs'

, CONCAT('<a target="_blank" href="%%WWWROOT%%/report/outline/user.php',CHAR(63),'id=',u.id,'&course=',c.id,'&mode=outline">','Outline','</a>') AS 'Activity Outline'

, CONCAT('<a target="_blank" href="%%WWWROOT%%/report/outline/user.php',CHAR(63),'id=',u.id,'&course=',c.id,'&mode=complete">','Activity','</a>') AS 'Consolidated Activity'

, CONCAT('<a target="_blank" href="%%WWWROOT%%/mod/forum/user.php',CHAR(63),'id=',u.id,'&course=',c.id,'">','Posts','</a>') AS 'Posts'

FROM prefix_user AS u
JOIN prefix_role_assignments AS ra ON u.id = ra.userid
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
JOIN prefix_course AS c ON c.id = ctx.instanceid
JOIN prefix_course_categories as cc ON c.category = cc.id

# student academic coach - you can include custom profile field data with these methods
# LEFT JOIN prefix_user_info_data as uid ON u.id = uid.userid AND uid.fieldid = '2'
# student academic coach email
# LEFT JOIN prefix_user_info_data as uce on u.id = uce.userid AND uce.fieldid = '6'

LEFT JOIN prefix_logstore_standard_log AS l ON l.userid = u.id AND l.courseid = c.id AND l.crud IN ('c','u')

WHERE ra.roleid =5
AND ctx.instanceid = c.id

AND c.id = %%COURSEID%%

GROUP BY u.idnumber

ORDER BY u.lastname, u.firstname
</code>

===My Weekly Online Participation===
Contributed by Elizabeth Dalton, Granite State College

Displays participation of the '''current user''' in the '''current course''' by week, including pre-term and post-term submissions/edits. A submission/edit is defined as a change to the course, such as a discussion post, the submission of an assignment, or the completion of a quiz, as well as alterations to course content such as database entries or new course activities or resources (if permitted).

This report uses Standard Logs (post 2.7).

<code sql>
SELECT

l.component AS 'activity'

, COUNT(DISTINCT IF((l.timecreated-c.startdate)<0,l.id,NULL)) AS 'Before Term'

, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=0,l.id,NULL)) AS 'Week 1'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=1,l.id,NULL)) AS 'Week 2'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=2,l.id,NULL)) AS 'Week 3'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=3,l.id,NULL)) AS 'Week 4'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=4,l.id,NULL)) AS 'Week 5'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=5,l.id,NULL)) AS 'Week 6'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=6,l.id,NULL)) AS 'Week 7'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=7,l.id,NULL)) AS 'Week 8'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=8,l.id,NULL)) AS 'Week 9'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=9,l.id,NULL)) AS 'Week 10'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=10,l.id,NULL)) AS 'Week 11'
, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))=11,l.id,NULL)) AS 'Week 12'

, COUNT(DISTINCT IF(FLOOR((l.timecreated - c.startdate)/(60*60*24*7))>=12,l.id,NULL)) AS 'After Term'

, COUNT(l.id) AS 'Total'

FROM prefix_user AS u
JOIN prefix_role_assignments AS ra ON u.id = ra.userid
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
JOIN prefix_course AS c ON c.id = ctx.instanceid
JOIN prefix_course_categories as cc ON c.category = cc.id

LEFT JOIN prefix_logstore_standard_log AS l ON l.userid = u.id AND l.courseid = c.id AND l.crud IN ('c','u')

WHERE 1
AND ctx.instanceid = c.id

AND c.id = %%COURSEID%%
AND u.id = %%USERID%%

GROUP BY l.component

ORDER BY l.component
</code>

===Faculty/Student Interactions===
Contributed by Elizabeth Dalton, Granite State College

Returns a count of instructor and other-student responses to student activity for the specified time period. This report can help indicate whether students' comments are being responded to, as well as summarizing post activity by students during the specified time.

'''Note''': This version of the report uses legacy (pre-2.7) logs. See below for the post-2.7 Standard Logs version.

'''Note''': This should be defined as a "Global" report (visible from within all courses).

'''Note''': This report can take a long time to run.

<code sql>
SELECT

# Identify student
CONCAT('<a target="_blank" href="%%WWWROOT%%/message/index.php?id=' , allstu.id , '">' , allstu.firstname , ' ' , allstu.lastname , '</a>' ) AS 'Student - click to send message'

, IF((COUNT(DISTINCT IF(fps.created > (UNIX_TIMESTAMP() - (7*24*60*60)),fps.id,NULL) )>0) OR (COUNT(DISTINCT IF(asb.timemodified > (UNIX_TIMESTAMP() - (7*24*60*60)),asb.id,NULL))>0) OR (SELECT COUNT(DISTINCT mfs.id) FROM prefix_message AS mfs WHERE mfs.useridfrom = allstu.id AND mfs.useridto = instr.id AND mfs.timecreated > (UNIX_TIMESTAMP() - (7*24*60*60))),'YES','NO') AS 'Student Participated This week'

, IF((COUNT(DISTINCT IF(fpi.created > (UNIX_TIMESTAMP() - (7*24*60*60)),fpi.id,NULL) )>0) OR (COUNT(DISTINCT IF(asg.timemodified > (UNIX_TIMESTAMP() - (7*24*60*60)),asg.id,NULL))>0) OR (SELECT COUNT(DISTINCT mts.id) FROM prefix_message AS mts WHERE mts.useridfrom = instr.id AND mts.useridto = allstu.id AND mts.timecreated > (UNIX_TIMESTAMP() - (7*24*60*60))),'YES','NO') AS 'Student Contacted This week'

## Only posts within last 7 days

# Count posts by student
, COUNT(DISTINCT IF(fps.created > (UNIX_TIMESTAMP() - (7*24*60*60)),fps.id,NULL)) AS 'Forum Stu Posts - 7 days'

# Count replies to student posts by instructors
, COUNT(DISTINCT IF(fpi.created > (UNIX_TIMESTAMP() - (7*24*60*60)),fpi.id,NULL) ) AS 'Forum Instr Replies - 7 days'

# using link back to student posts on replies, get unique student IDs responded
, COUNT(DISTINCT IF(fpsr.created > (UNIX_TIMESTAMP() - (7*24*60*60)),fpsr.id,NULL)) - COUNT(DISTINCT IF(fpi.created > (UNIX_TIMESTAMP() - (7*24*60*60)),fpi.id,NULL) ) AS 'Forum Stu Replies - 7 days'

# all replies
, COUNT(DISTINCT IF(fpsr.created > (UNIX_TIMESTAMP() - (7*24*60*60)),fpsr.id,NULL)) AS 'Forum All Replies - 7 days'

# add in count of graded assignments - 7 days
, COUNT(DISTINCT IF(asb.timemodified > (UNIX_TIMESTAMP() - (7*24*60*60)),asb.id,NULL)) AS 'Assign Submit - 7 days'
, COUNT(DISTINCT IF(asg.timemodified > (UNIX_TIMESTAMP() - (7*24*60*60)),asg.id,NULL)) AS 'Assign Grades - 7 days'

# Messages between students and instructors - 7 days
, (SELECT COUNT(DISTINCT mfs.id) FROM prefix_message AS mfs WHERE mfs.useridfrom = allstu.id AND mfs.useridto = instr.id AND mfs.timecreated > (UNIX_TIMESTAMP() - (7*24*60*60))) AS 'Msg Stu to Instr - 7 days'
, (SELECT COUNT(DISTINCT mts.id) FROM prefix_message AS mts WHERE mts.useridfrom = instr.id AND mts.useridto = allstu.id AND mts.timecreated > (UNIX_TIMESTAMP() - (7*24*60*60))) AS 'Msg Instr to Stu - 7 days'

## All posts in course so far
# Count posts by student
, COUNT(DISTINCT fps.id) AS 'Forum Stu Posts - to date'

# Count replies to student posts by instructors
, COUNT(DISTINCT fpi.id) AS 'Forum Instr Replies - to date'

# using link back to student posts on replies, get unique student IDs responded
, COUNT(DISTINCT fpsr.id) - COUNT(DISTINCT fpi.id) AS 'Forum Stu Replies - to date'

# all replies
, COUNT(DISTINCT fpsr.id) AS 'Forum All Replies - to date'

# add in count of graded assignments - whole course
, COUNT(DISTINCT asb.id) AS 'Assign Submit - to date'
, COUNT(DISTINCT asg.id) AS 'Assign Grades - to date'

# Messages between students and instructors - to date
, (SELECT COUNT(DISTINCT mfs.id) FROM prefix_message AS mfs WHERE mfs.useridfrom = allstu.id AND mfs.useridto = instr.id ) AS 'Msg Stu to Instr - to date'
, (SELECT COUNT(DISTINCT mts.id) FROM prefix_message AS mts WHERE mts.useridfrom = instr.id AND mts.useridto = allstu.id) AS 'Msg Instr to Stu - to date'

## JOINS

# Start by getting all the students in the course
FROM prefix_user AS allstu
JOIN prefix_role_assignments AS ras ON allstu.id = ras.userid AND ras.roleid = 5
JOIN prefix_context AS ctx ON ras.contextid = ctx.id
JOIN prefix_course AS c ON c.id = ctx.instanceid
JOIN prefix_course_categories as cc ON c.category = cc.id

# Now we get the forums and forum discussions from this course only
LEFT JOIN prefix_forum AS frm ON frm.course = c.id AND c.id = %%COURSEID%%
LEFT JOIN prefix_forum_discussions AS fd ON fd.course = %%COURSEID%% AND fd.forum = frm.id

# These are forum discussion posts just by students within specified time
LEFT JOIN prefix_forum_posts AS fps ON fps.userid = allstu.id AND fps.discussion = fd.id

# Separately, we connect the instructors of the courses
# We can use the context we have already gotten for the students
LEFT JOIN prefix_role_assignments AS rai ON rai.contextid = ctx.id
LEFT JOIN prefix_user AS instr ON instr.id = rai.userid AND rai.roleid =3

# Now we will connect to posts by instructors that are replies to student posts
# This is a left join, because we don't want to eliminate any students from the list
LEFT JOIN prefix_forum_posts AS fpi ON fpi.discussion = fd.id AND fpi.userid = instr.id AND fpi.parent = fps.id

# To get identities of only those students who were replied to:
# Connect from instr replies back up to parent posts by students again
# This has to be a LEFT JOIN, we know these posts exist but don't eliminate non-responded students
LEFT JOIN prefix_forum_posts AS fpir ON fpir.id = fpi.parent

# We also want to know if students are replying to one another
# These are posts that are replies to student posts
# Again, a left join
LEFT JOIN prefix_forum_posts AS fpsr ON fpsr.discussion = fd.id AND fpsr.parent = fps.id

# get the activity modules
LEFT JOIN prefix_course_modules AS cm ON c.id = cm.course

# get the assignments
LEFT JOIN prefix_assign AS a ON cm.instance = a.id
LEFT JOIN prefix_assign_submission AS asb ON a.id = asb.assignment AND asb.userid=allstu.id
LEFT JOIN prefix_assign_grades AS asg ON asg.assignment = a.id AND asg.userid = allstu.id AND asg.assignment = asb.assignment

# We care about messages that involve both the instructor and students of this course
# messages from instructor to students:
# LEFT JOIN prefix_message AS mts ON mts.useridfrom = instr.id AND mts.useridto = allstu.id
# LEFT JOIN prefix_message AS mfs ON mfs.useridfrom = instr.id AND mfs.useridto = allstu.id

WHERE
c.id = %%COURSEID%%

# GROUP BY c.shortname , allstu.id
GROUP BY allstu.id

ORDER BY allstu.lastname
</code>

'''Note''': Post-2.7 Standard Logs version

<code sql>
SELECT

# Identify student
CONCAT('<a target="_blank" href="%%WWWROOT%%/message/index.php?id=' , allstu.id , '">' , allstu.firstname , ' ' , allstu.lastname , '</a>' ) AS 'Student - click to send message'

, IF((COUNT(DISTINCT IF(fps.created > (UNIX_TIMESTAMP() - (7*24*60*60)),fps.id,NULL) )>0) OR (COUNT(DISTINCT IF(asb.timemodified > (UNIX_TIMESTAMP() - (7*24*60*60)),asb.id,NULL))>0) OR (SELECT COUNT(DISTINCT mfs.id) FROM prefix_message AS mfs WHERE mfs.useridfrom = allstu.id AND mfs.useridto = instr.id AND mfs.timecreated > (UNIX_TIMESTAMP() - (7*24*60*60))),'YES','NO') AS 'Student Participated This week'

, IF((COUNT(DISTINCT IF(fpi.created > (UNIX_TIMESTAMP() - (7*24*60*60)),fpi.id,NULL) )>0) OR (COUNT(DISTINCT IF(asg.timemodified > (UNIX_TIMESTAMP() - (7*24*60*60)),asg.id,NULL))>0) OR (SELECT COUNT(DISTINCT mts.id) FROM prefix_message AS mts WHERE mts.useridfrom = instr.id AND mts.useridto = allstu.id AND mts.timecreated > (UNIX_TIMESTAMP() - (7*24*60*60))),'YES','NO') AS 'Student Contacted This week'

## Only posts within last 7 days

# Count posts by student
, COUNT(DISTINCT IF(fps.created > (UNIX_TIMESTAMP() - (7*24*60*60)),fps.id,NULL)) AS 'Forum Stu Posts - 7 days'

# Count replies to student posts by instructors
, COUNT(DISTINCT IF(fpi.created > (UNIX_TIMESTAMP() - (7*24*60*60)),fpi.id,NULL) ) AS 'Forum Instr Replies - 7 days'

# using link back to student posts on replies, get unique student IDs responded
, COUNT(DISTINCT IF(fpsr.created > (UNIX_TIMESTAMP() - (7*24*60*60)),fpsr.id,NULL)) - COUNT(DISTINCT IF(fpi.created > (UNIX_TIMESTAMP() - (7*24*60*60)),fpi.id,NULL) ) AS 'Forum Stu Replies - 7 days'

# all replies
, COUNT(DISTINCT IF(fpsr.created > (UNIX_TIMESTAMP() - (7*24*60*60)),fpsr.id,NULL)) AS 'Forum All Replies - 7 days'

# add in count of graded assignments - 7 days
, COUNT(DISTINCT IF(asb.timemodified > (UNIX_TIMESTAMP() - (7*24*60*60)),asb.id,NULL)) AS 'Assign Submit - 7 days'
, COUNT(DISTINCT IF(asg.timemodified > (UNIX_TIMESTAMP() - (7*24*60*60)),asg.id,NULL)) AS 'Assign Grades - 7 days'

# Messages between students and instructors - 7 days
, (SELECT COUNT(DISTINCT mfs.id) FROM prefix_message AS mfs WHERE mfs.useridfrom = allstu.id AND mfs.useridto = instr.id AND mfs.timecreated > (UNIX_TIMESTAMP() - (7*24*60*60))) AS 'Msg Stu to Instr - 7 days'
, (SELECT COUNT(DISTINCT mts.id) FROM prefix_message AS mts WHERE mts.useridfrom = instr.id AND mts.useridto = allstu.id AND mts.timecreated > (UNIX_TIMESTAMP() - (7*24*60*60))) AS 'Msg Instr to Stu - 7 days'

## All posts in course so far
# Count posts by student
, COUNT(DISTINCT fps.id) AS 'Forum Stu Posts - to date'

# Count replies to student posts by instructors
, COUNT(DISTINCT fpi.id) AS 'Forum Instr Replies - to date'

# using link back to student posts on replies, get unique student IDs responded
, COUNT(DISTINCT fpsr.id) - COUNT(DISTINCT fpi.id) AS 'Forum Stu Replies - to date'

# all replies
, COUNT(DISTINCT fpsr.id) AS 'Forum All Replies - to date'

# add in count of graded assignments - whole course
, COUNT(DISTINCT asb.id) AS 'Assign Submit - to date'
, COUNT(DISTINCT asg.id) AS 'Assign Grades - to date'

# Messages between students and instructors - to date
, (SELECT COUNT(DISTINCT mfs.id) FROM prefix_message AS mfs WHERE mfs.useridfrom = allstu.id AND mfs.useridto = instr.id ) AS 'Msg Stu to Instr - to date'
, (SELECT COUNT(DISTINCT mts.id) FROM prefix_message AS mts WHERE mts.useridfrom = instr.id AND mts.useridto = allstu.id) AS 'Msg Instr to Stu - to date'

## JOINS

# Start by getting all the students in the course
FROM prefix_user AS allstu
JOIN prefix_role_assignments AS ras ON allstu.id = ras.userid AND ras.roleid = 5
JOIN prefix_context AS ctx ON ras.contextid = ctx.id
JOIN prefix_course AS c ON c.id = ctx.instanceid
JOIN prefix_course_categories as cc ON c.category = cc.id

# Now we get the forums and forum discussions from this course only
JOIN prefix_forum AS frm ON frm.course = c.id AND c.id = %%COURSEID%%
JOIN prefix_forum_discussions AS fd ON fd.course = %%COURSEID%% AND fd.forum = frm.id

# These are forum discussion posts just by students within specified time
LEFT JOIN prefix_forum_posts AS fps ON fps.userid = allstu.id AND fps.discussion = fd.id

# Separately, we connect the instructors of the courses
# We can use the context we have already gotten for the students
JOIN prefix_role_assignments AS rai ON rai.contextid = ctx.id
JOIN prefix_user AS instr ON instr.id = rai.userid AND rai.roleid =3

# Now we will connect to posts by instructors that are replies to student posts
# This is a left join, because we don't want to eliminate any students from the list
LEFT JOIN prefix_forum_posts AS fpi ON fpi.discussion = fd.id AND fpi.userid = instr.id AND fpi.parent = fps.id

# To get identities of only those students who were replied to:
# Connect from instr replies back up to parent posts by students again
# This has to be a LEFT JOIN, we know these posts exist but don't eliminate non-responded students
LEFT JOIN prefix_forum_posts AS fpir ON fpir.id = fpi.parent

# We also want to know if students are replying to one another
# These are posts that are replies to student posts
# Again, a left join
LEFT JOIN prefix_forum_posts AS fpsr ON fpsr.discussion = fd.id AND fpsr.parent = fps.id

# get the activity modules
JOIN prefix_course_modules AS cm ON c.id = cm.course

# get the assignments
JOIN prefix_assign AS a ON cm.instance = a.id
LEFT JOIN prefix_assign_submission AS asb ON a.id = asb.assignment AND asb.userid=allstu.id
LEFT JOIN prefix_assign_grades AS asg ON asg.assignment = a.id AND asg.userid = allstu.id AND asg.assignment = asb.assignment

WHERE
c.id = %%COURSEID%%

# GROUP BY c.shortname , allstu.id
GROUP BY allstu.id

ORDER BY allstu.lastname
</code>

===Student Resource Usage===
Contributed by Elizabeth Dalton, Granite State College

Displays usage by students of all activities and resources in the current course by activity. Only activities and sections which are visible in the course are included. This version requires the new "Standard Logs" from Moodle 2.7+.

'''Note''': This should be defined as a "Global" report (visible from within all courses).

<code sql>
SELECT
cs.section AS 'Week'
, cs.name AS 'Section Name'
, m.name AS 'item type'

, CONCAT(
COALESCE(a.name, ''),
COALESCE(b.name,''),
COALESCE(cert.name,''),
COALESCE(chat.name,''),
COALESCE(choice.name,''),
COALESCE(data.name,''),
COALESCE(feedback.name,''),
COALESCE(folder.name,''),
COALESCE(forum.name,''),
COALESCE(glossary.name,''),
COALESCE(imscp.name,''),
COALESCE(lesson.name,''),
COALESCE(p.name,''),
COALESCE(questionnaire.name,''),
COALESCE(quiz.name,''),
COALESCE(cr.name,''),
COALESCE(scorm.name,''),
COALESCE(survey.name,''),
COALESCE(url.name,''),
COALESCE(wiki.name,''),
COALESCE(workshop.name,''),
COALESCE(kalvidassign.name,''),
COALESCE(attendance.name,''),
COALESCE(checklist.name,''),
COALESCE(flashcard.name,''),
COALESCE(lti.name,''),
COALESCE(oublog.name,''),
COALESCE(ouwiki.name,''),
COALESCE(subpage.name,''),
COALESCE(journal.name,''),
COALESCE(lightboxgallery.name,''),
COALESCE(elluminate.name,''),
COALESCE(adaptivequiz.name,''),
COALESCE(hotpot.name,''),
COALESCE(wiziq.name,''),
COALESCE(turnitintooltwo.name,''),
COALESCE(kvr.name,'')
) AS 'item name'

, SUM(IF(l.crud IN ('r'),1,0)) AS 'total views'
, SUM(IF(l.crud IN ('c','u'),1,0)) AS 'total submissions'
, COUNT(DISTINCT IF(l.crud IN ('r'),u.id,NULL)) AS 'count of students who viewed'
, COUNT(DISTINCT IF(l.crud IN ('c','u'),u.id,NULL)) AS 'count of students who submitted'

FROM prefix_user AS u
JOIN prefix_role_assignments AS ra ON u.id = ra.userid
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
JOIN prefix_course AS c ON c.id = ctx.instanceid
JOIN prefix_course_categories as cc ON c.category = cc.id

JOIN prefix_course_sections AS cs ON cs.course = c.id AND cs.section <= 14 #AND cs.section > 0
LEFT JOIN prefix_course_modules AS cm ON cm.course = c.id AND cm.section = cs.id
JOIN prefix_modules AS m ON m.id = cm.module AND m.name NOT LIKE 'label'

LEFT JOIN prefix_assign AS a ON a.id = cm.instance AND m.name = 'assign'
LEFT JOIN prefix_book AS b ON b.id = cm.instance AND m.name = 'book'
LEFT JOIN prefix_certificate AS cert ON cert.id = cm.instance AND m.name = 'certificate'
LEFT JOIN prefix_chat AS chat ON chat.id = cm.instance AND m.name = 'chat'
LEFT JOIN prefix_choice AS choice ON choice.id = cm.instance AND m.name = 'choice'
LEFT JOIN prefix_data AS data ON data.id = cm.instance AND m.name = 'data'
LEFT JOIN prefix_feedback AS feedback ON feedback.id = cm.instance AND m.name = 'feedback'
LEFT JOIN prefix_folder AS folder ON folder.id = cm.instance AND m.name = 'folder'
LEFT JOIN prefix_forum AS forum ON forum.id = cm.instance AND m.name = 'forum'
LEFT JOIN prefix_glossary AS glossary ON glossary.id = cm.instance AND m.name = 'glossary'
LEFT JOIN prefix_imscp AS imscp ON imscp.id = cm.instance AND m.name = 'imscp'
LEFT JOIN prefix_lesson AS lesson ON lesson.id = cm.instance AND m.name = 'lesson'
LEFT JOIN prefix_page AS p ON p.id = cm.instance AND m.name = 'page'
LEFT JOIN prefix_questionnaire AS questionnaire ON questionnaire.id = cm.instance AND m.name = 'questionnaire'
LEFT JOIN prefix_quiz AS quiz ON quiz.id = cm.instance AND m.name = 'quiz'
LEFT JOIN prefix_resource AS cr ON cr.id = cm.instance AND m.name = 'resource'
LEFT JOIN prefix_scorm AS scorm ON scorm.id = cm.instance AND m.name = 'scorm'
LEFT JOIN prefix_survey AS survey ON survey.id = cm.instance AND m.name = 'survey'
LEFT JOIN prefix_url AS url ON url.id = cm.instance AND m.name = 'url'
LEFT JOIN prefix_wiki AS wiki ON wiki.id = cm.instance AND m.name = 'wiki'
LEFT JOIN prefix_workshop AS workshop ON workshop.id = cm.instance AND m.name = 'workshop'
LEFT JOIN prefix_kalvidassign AS kalvidassign ON kalvidassign.id = cm.instance AND m.name = 'kalvidassign'
LEFT JOIN prefix_kalvidres AS kvr ON kvr.id = cm.instance AND m.name = 'kalvidres'
LEFT JOIN prefix_attendance AS attendance ON attendance.id = cm.instance AND m.name = 'attendance'
LEFT JOIN prefix_checklist AS checklist ON checklist.id = cm.instance AND m.name = 'checklist'
LEFT JOIN prefix_flashcard AS flashcard ON flashcard.id = cm.instance AND m.name = 'flashcard'
LEFT JOIN prefix_lti AS lti ON lti.id = cm.instance AND m.name = 'lti'
LEFT JOIN prefix_oublog AS oublog ON oublog.id = cm.instance AND m.name = 'oublog'
LEFT JOIN prefix_ouwiki AS ouwiki ON ouwiki.id = cm.instance AND m.name = 'ouwiki'
LEFT JOIN prefix_subpage AS subpage ON subpage.id = cm.instance AND m.name = 'subpage'
LEFT JOIN prefix_journal AS journal ON journal.id = cm.instance AND m.name = 'journal'
LEFT JOIN prefix_lightboxgallery AS lightboxgallery ON lightboxgallery.id = cm.instance AND m.name = 'lightboxgallery'
LEFT JOIN prefix_elluminate AS elluminate ON elluminate.id = cm.instance AND m.name = 'elluminate'
LEFT JOIN prefix_adaptivequiz AS adaptivequiz ON adaptivequiz.id = cm.instance AND m.name = 'adaptivequiz'
LEFT JOIN prefix_hotpot AS hotpot ON hotpot.id = cm.instance AND m.name = 'hotpot'
LEFT JOIN prefix_wiziq AS wiziq ON wiziq.id = cm.instance AND m.name = 'wiziq'
LEFT JOIN prefix_turnitintooltwo AS turnitintooltwo ON turnitintooltwo.id = cm.instance AND m.name = 'turnitintooltwo'

LEFT JOIN prefix_logstore_standard_log AS l ON l.userid = u.id AND l.courseid = c.id

WHERE ra.roleid =5
AND ctx.instanceid = c.id
AND cs.visible = 1
AND cm.visible = 1

AND c.id = %%COURSEID%%

GROUP BY cm.id

ORDER BY cs.section
</code>

===Module activity (Hits) between dates===
<code sql>
SELECT module, COUNT( * )
FROM prefix_logstore_standard_log AS l
WHERE (FROM_UNIXTIME( l.`timecreated` ) BETWEEN '2018-10-01 00:00:00' AND '2019-09-31 00:00:00')
GROUP BY module
</code>

===Module activity (Instances and Hits) for each academic year===
<code sql>
SELECT name

,(SELECT COUNT(*)
FROM prefix_logstore_standard_log AS l
WHERE (FROM_UNIXTIME(l.`timecreated`) BETWEEN '2017-10-01 00:00:00' AND '2018-09-31 00:00:00')
AND l.module = m.name AND l.action = 'add'
) AS "Added 2017"

,(SELECT COUNT(*)
FROM prefix_logstore_standard_log AS l
WHERE (FROM_UNIXTIME(l.`timecreated`) BETWEEN '2017-10-01 00:00:00' AND '2018-09-31 00:00:00')
AND l.module = m.name
) AS "Used 2017"

,(SELECT COUNT(*)
FROM prefix_logstore_standard_log AS l
WHERE (FROM_UNIXTIME(l.`timecreated`) BETWEEN '2018-10-01 00:00:00' AND '2019-09-31 00:00:00')
AND l.module = m.name AND l.action = 'add'
) AS "Added 2018"

,(SELECT COUNT(*)
FROM prefix_logstore_standard_log AS l
WHERE (FROM_UNIXTIME(l.`timecreated`) BETWEEN '2018-10-01 00:00:00' AND '2019-09-31 00:00:00')
AND l.module = m.name
) AS "Used 2018"

,(SELECT COUNT(*)
FROM prefix_logstore_standard_log AS l
WHERE (FROM_UNIXTIME(l.`timecreated`) BETWEEN '2019-10-01 00:00:00' AND '2020-09-31 00:00:00')
AND l.module = m.name AND l.action = 'add'
) AS "Added 2019"

,(SELECT COUNT(*)
FROM prefix_logstore_standard_log AS l
WHERE (FROM_UNIXTIME(l.`timecreated`) BETWEEN '2019-10-01 00:00:00' AND '2020-09-31 00:00:00')
AND l.module = m.name
) AS "Used 2019"

FROM mdl_modules AS m
</code>

===Unique user sessions per day and month + graph===
The "graph" column is used when displaying a graph (which needs at least three columns to pick from)
<code sql>
SELECT COUNT(DISTINCT userid) AS "Unique User Logins"
,DATE_FORMAT(FROM_UNIXTIME(timecreated), "%y /%m / %d") AS "Year / Month / Day", "Graph"
FROM `mdl_logstore_standard_log`
WHERE action LIKE 'loggedin'
#AND timecreated > UNIX_TIMESTAMP('2015-01-01 00:00:00') # optional start date
#AND timecreated <= UNIX_TIMESTAMP('2015-01-31 23:59:00') # optional end date
GROUP BY MONTH(FROM_UNIXTIME(timecreated)), DAY(FROM_UNIXTIME(timecreated))
ORDER BY MONTH(FROM_UNIXTIME(timecreated)), DAY(FROM_UNIXTIME(timecreated))
</code>

And...

Counting user's global and unique hits per day + counting individual usage of specific activities and resources (on that day),

And since I am using phpMyAdmin's "Display Graph" feature (at the bottom of the query's output page), I have scaled down the "User Hits" by 10 to fit the graph. that's it.
<code sql>
SELECT DATE_FORMAT(FROM_UNIXTIME(timecreated), "%y-%m-%d") AS "Datez"
,COUNT(DISTINCT userid) AS "Unique Users"
,ROUND(COUNT(*)/10) "User Hits (K)"
,SUM(IF(component='mod_quiz',1,0)) "Quizzes"
,SUM(IF(component='mod_forum' or component='mod_forumng',1,0)) "Forums"
,SUM(IF(component='mod_assign',1,0)) "Assignments"
,SUM(IF(component='mod_oublog',1,0)) "Blogs"
,SUM(IF(component='mod_resource',1,0)) "Files (Resource)"
,SUM(IF(component='mod_url',1,0)) "Links (Resource)"
,SUM(IF(component='mod_page',1,0)) "Pages (Resource)"

FROM `mdl_logstore_standard_log`
WHERE 1=1
AND timecreated > UNIX_TIMESTAMP('2015-03-01 00:00:00') # optional START DATE
AND timecreated <= UNIX_TIMESTAMP('2015-05-31 23:59:00') # optional END DATE
GROUP BY MONTH(FROM_UNIXTIME(timecreated)), DAY(FROM_UNIXTIME(timecreated))
ORDER BY MONTH(FROM_UNIXTIME(timecreated)), DAY(FROM_UNIXTIME(timecreated))
</code>

===System wide, daily unique user hits for the last 7 days===
<code sql>
SELECT
DATE_FORMAT(FROM_UNIXTIME(l.timecreated), '%m%d') 'Day'
,COUNT(DISTINCT l.userid) AS 'Distinct Users Hits'
,COUNT( l.userid) AS 'Users Hits'

FROM prefix_logstore_standard_log AS l
WHERE l.courseid > 1
AND FROM_UNIXTIME(l.timecreated) >= DATE_SUB(NOW(), INTERVAL 7 DAY)
GROUP BY DAY(FROM_UNIXTIME(timecreated))
</code>

===User detailed activity in course modules===
Considering only several modules: url, resource, forum, quiz, questionnaire.

<code sql>
SELECT u.id, ra.roleid,
CONCAT(u.lastname, ' ', u.firstname) AS 'Student'
,COUNT(l.id) AS 'Actions'
,l.component "Module type"
,l.objectid "Module ID"
,CASE
WHEN l.component = 'mod_url' THEN (SELECT u.name FROM prefix_url AS u WHERE u.id = l.objectid )
WHEN l.component = 'mod_resource' THEN (SELECT r.name FROM prefix_resource AS r WHERE r.id = l.objectid )
WHEN l.component = 'mod_forum' THEN (SELECT f.name FROM prefix_forum AS f WHERE f.id = l.objectid )
WHEN l.component = 'mod_quiz' THEN (SELECT q.name FROM prefix_quiz AS q WHERE q.id = l.objectid )
WHEN l.component = 'mod_questionnaire' THEN (SELECT q.name FROM prefix_questionnaire AS q WHERE q.id = l.objectid )
END AS 'Module name'

,(SELECT GROUP_CONCAT(g.name) FROM prefix_groups AS g
JOIN prefix_groups_members AS m ON g.id = m.groupid WHERE g.courseid = l.courseid AND m.userid = u.id) "user_groups"

,(SELECT s.name
FROM prefix_course_modules AS cm
JOIN prefix_course_sections AS s ON s.course = cm.course AND s.id = cm.section
WHERE cm.id = l.contextinstanceid) AS "Section name"

FROM prefix_logstore_standard_log AS l
JOIN prefix_user AS u ON u.id = l.userid
JOIN prefix_role_assignments AS ra ON ra.userid = l.userid
AND ra.contextid = (SELECT id FROM prefix_context WHERE instanceid = l.courseid AND contextlevel = 50)
WHERE l.courseid = %%COURSEID%%
AND l.component IN ('mod_url', 'mod_resource', 'mod_forum', 'mod_quiz', 'mod_questionnaire')
%%FILTER_STARTTIME:l.timecreated:>%% %%FILTER_ENDTIME:l.timecreated:<%%

GROUP BY u.id, l.component
ORDER BY u.lastname, u.firstname
</code>

===What teachers and courses considered active?===
This report display several calculations and parameters that help the Online academic training team find teachers that might need more support getting their courses more supporting of online learning pedagogical methodologies.
<code sql>
SELECT concat('<a target="_new" href="%%WWWROOT%%/course/view.php?id=',
course.id,'">',course.fullname,'</a>') AS Course

#,course.shortname

,CASE
WHEN course.fullname LIKE '%2012%' THEN '2012'
WHEN course.fullname LIKE '%2013%' THEN '2013'
WHEN course.fullname LIKE '%2014%' THEN '2014'
WHEN course.fullname LIKE '%2015%' THEN '2015'
END AS Year

,CASE
WHEN course.fullname LIKE '%semester a%' THEN 'Spring semester'
WHEN course.fullname LIKE '%semester b%' THEN 'Fall semester'
WHEN course.fullname LIKE '%semester s%' THEN 'Summer semester'
END AS Semester

,IF(course.startdate>0, DATE_FORMAT(FROM_UNIXTIME(startdate), '%d-%m-%Y'), 'no date') AS "Course Start Date"

,(SELECT COUNT( ra.userid ) AS Users
FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
WHERE ra.roleid = 5 AND ctx.instanceid = course.id
) AS Students

,(SELECT COUNT( ra.userid ) AS Users
FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
WHERE ra.roleid = 4 AND ctx.instanceid = course.id
) AS "Assistant teacher"

,(SELECT COUNT( ra.userid ) AS Users
FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
WHERE ra.roleid = 3 AND ctx.instanceid = course.id
) AS Teachers

# Uncomment to use the new Moodle 2.8+ logstore
#,(SELECT COUNT(*) FROM mdl_logstore_standard_log AS l WHERE l.courseid = course.id) AS Hits

#,(SELECT COUNT(*)
#FROM mdl_logstore_standard_log AS l
#JOIN mdl_role_assignments AS ra ON ra.userid= l.userid AND ra.roleid = 5 AND ra.contextid = (SELECT id FROM mdl_context WHERE instanceid = l.courseid AND contextlevel = 50)
#WHERE l.courseid = course.id ) AS "Student HITs"

#,(SELECT COUNT(*)
#FROM mdl_logstore_standard_log AS l
#JOIN mdl_role_assignments AS ra ON ra.userid= l.userid AND ra.roleid = 3 AND ra.contextid = (SELECT id FROM mdl_context WHERE instanceid = l.courseid AND contextlevel = 50)
#WHERE l.courseid = course.id ) AS "Teacher HITs"

,(SELECT COUNT(*) FROM mdl_log AS l WHERE l.course = course.id) AS Hits

,(SELECT COUNT(*)
FROM mdl_log AS l
JOIN mdl_context AS con ON con.instanceid= l.course AND con.contextlevel=50
JOIN mdl_role_assignments AS ra ON ra.contextid= con.id AND ra.userid= l.userid AND ra.roleid = 5
WHERE l.course = course.id) AS "Students HITs"

,(SELECT COUNT(*)
FROM mdl_log AS l
JOIN mdl_context AS con ON con.instanceid= l.course AND con.contextlevel=50
JOIN mdl_role_assignments AS ra ON ra.contextid= con.id AND ra.userid= l.userid AND ra.roleid = 3
WHERE l.course = course.id) AS "Teachers HITs"

,(SELECT GROUP_CONCAT( CONCAT( u.firstname, " ", u.lastname ) )
FROM prefix_course c
JOIN prefix_context con ON con.instanceid = c.id
JOIN prefix_role_assignments ra ON con.id = ra.contextid AND con.contextlevel = 50
JOIN prefix_role r ON ra.roleid = r.id
JOIN prefix_user u ON u.id = ra.userid
WHERE r.id = 3 AND c.id = course.id
GROUP BY c.id
) AS Teachers

,(SELECT COUNT(*) FROM prefix_course_modules cm WHERE cm.course = course.id) Modules

,(SELECT COUNT(DISTINCT cm.module) FROM prefix_course_modules cm
WHERE cm.course = course.id) UniqueModules

,(SELECT GROUP_CONCAT(DISTINCT m.name)
FROM prefix_course_modules cm
JOIN mdl_modules as m ON m.id = cm.module
WHERE cm.course = course.id) UniqueModuleNames

,(SELECT COUNT(*) FROM mdl_course_modules cm JOIN mdl_modules as m ON m.id = cm.module
WHERE cm.course = course.id AND m.name IN ( 'ouwiki', 'wiki') ) "Num Wikis"

,(SELECT COUNT(*) FROM mdl_course_modules cm JOIN mdl_modules as m ON m.id = cm.module
WHERE cm.course = course.id AND m.name IN ( 'oublog') ) "Num Blogs"

,(SELECT COUNT(*) FROM mdl_course_modules cm JOIN mdl_modules as m ON m.id = cm.module
WHERE cm.course = course.id AND m.name IN ( 'forum', 'forumng') ) "Num Forums"

,(SELECT COUNT(*) FROM prefix_course_modules cm JOIN mdl_modules as m ON m.id = cm.module
WHERE cm.course = course.id AND m.name IN ('resource', 'folder', 'url', 'tab', 'file', 'book', 'page') ) Resources

,(SELECT COUNT(*) FROM prefix_course_modules cm JOIN mdl_modules as m ON m.id = cm.module
WHERE cm.course = course.id AND m.name IN ('forum', 'forumng', 'oublog', 'page', 'file', 'url', 'wiki' , 'ouwiki') ) "Basic Activities"

,(SELECT COUNT(*) FROM prefix_course_modules cm JOIN mdl_modules as m ON m.id = cm.module
WHERE cm.course = course.id AND m.name IN ('advmindmap', 'assign', 'attendance', 'book', 'choice', 'folder', 'tab', 'glossary', 'questionnaire', 'quiz', 'label' ) ) "Avarage Activities"

,(SELECT COUNT(*) FROM prefix_course_modules cm JOIN mdl_modules as m ON m.id = cm.module
WHERE cm.course = course.id AND m.name IN ('elluminate', 'game', 'workshop') ) "Advanced Activities"

FROM prefix_course AS course

#WHERE course.shortname LIKE '%2015%'
#WHERE 1=1
#%%FILTER_SEARCHTEXT:course.shortname:~%%

WHERE course.fullname LIKE '%2015%'

HAVING Modules > 2
ORDER BY UniqueModules DESC
</code>

===Weekly attendance report===
This report display weekly report in format HH:M:SS This MySQL query works together with AttendaceRegister module, and gather Log information from Attendanceregister_log table.
<code sql>
SELECT u.username, SEC_TO_TIME (SUM(arsess.duration)) AS weekly_online_attendance, FROM_UNIXTIME (arsess.logout) AS Last_Logout
FROM prefix_attendanceregister_session AS arsess
JOIN prefix_user AS u ON arsess.userid = u.id

WHERE (((arsess.logout) BETWEEN UNIX_TIMESTAMP(DATE_SUB(CURDATE(), INTERVAL 7 DAY)) AND UNIX_TIMESTAMP(CURDATE())))

GROUP BY arsess.userid
</code>

===How many distinct users connected to Moodle using the app by month===
https://moodle.org/mod/forum/discuss.php?d=336086#p1354194 by
Iñigo Zendegi Urzelai
<code sql>
SELECT
to_char(to_timestamp("timecreated"),'YYYY') as year,
to_char(to_timestamp("timecreated"),'MM') as month,
count(distinct userid) as distinct_users

FROM prefix_logstore_standard_log l
WHERE l.origin='ws'
GROUP BY to_char(to_timestamp("timecreated"),'YYYY'), to_char(to_timestamp("timecreated"),'MM')
ORDER BY to_char(to_timestamp("timecreated"),'YYYY'), to_char(to_timestamp("timecreated"),'MM');
</code>

==Course Reports==
===Most Active courses===
<code sql>
SELECT count(l.userid) AS Views
FROM `mdl_logstore_standard_log` l, `mdl_user` u, `mdl_role_assignments` r
WHERE l.courseid=35
AND l.userid = u.id
AND (l.timecreated > UNIX_TIMESTAMP('2015-01-01 00:00:00') AND l.timecreated <= UNIX_TIMESTAMP('2015-01-31 23:59:59'))AND r.contextid= (
SELECT id
FROM mdl_context
WHERE contextlevel=50 AND instanceid=l.courseid
)
AND r.roleid=5
AND r.userid = u.id
</code>

===Active courses, advanced===
Including: Teacher's name, link to the course, All types of log activities, special YEAR generated field, Activities and Resource count, enrolled Student count
<code sql>
SELECT COUNT(l.id) hits, concat('<a target="_new" href="%%WWWROOT%%/course/view.php?id=',c.id,'">',c.fullname,'</a>') AS Course

,(SELECT CONCAT(u.firstname,' ', u.lastname) AS Teacher
FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
JOIN prefix_user AS u ON u.id = ra.userid
WHERE ra.roleid = 3 AND ctx.instanceid = c.id LIMIT 1) AS Teacher

,CASE
WHEN c.fullname LIKE '%תשע' THEN 'תשע'
WHEN c.fullname LIKE '%תשעא' THEN 'תשעא'
WHEN c.fullname LIKE '%תשעב' THEN 'תשעב'
END AS Year

,(SELECT count(*) FROM prefix_course_modules cm WHERE cm.course = l.course) Modules

,(SELECT Count( ra.userid ) AS Users FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
WHERE ra.roleid = 5 AND ctx.instanceid = c.id) AS Students

FROM prefix_log l
INNER JOIN prefix_course c ON l.course = c.id
GROUP BY c.id
#The following line restricts the courses returned to those having more than 2 modules. Adjust based on your needs.
HAVING Modules > 2
ORDER BY Year DESC, hits DESC
</code>

=== Least active or probably empty courses===

Contributed by: [https://moodle.org/user/profile.php?id=88992 Randy Thornton]

It is difficult to know sometimes when a course is actually empty or was never really in use. Other than the simple case where the course was created and never touched again, in which case the course timecreated and timemodified will be the same, many courses created as shells for teachers or other users may be used once or a few times and have few or no test users enrollments in them. This query helps you see the range of such courses, showing you how many days if any it was used after initial creation, and how many user are enrolled. It denotes a course never ever modified by "-1" instead of "0" so you can sort those to the top. By default it limits this to courses used within 60 days of creation, and to courses with 3 or less enrollments (for example, teacher and assistant and test student account only.) You can easily adjust these numbers. The query includes a link to the course as well.

<code sql>
SELECT
c.fullname,
CONCAT('<a target="_blank" href="%%WWWROOT%%/course/view.php',CHAR(63),'id=',c.id,'">',c.shortname,'</a>') AS 'CourseLink',
DATE_FORMAT(FROM_UNIXTIME(c.timecreated), '%Y-%m-%d %H:%i') AS 'Timecreated',
DATE_FORMAT(FROM_UNIXTIME(c.timemodified), '%Y-%m-%d %H:%i') AS 'Timemodified',
CASE
WHEN c.timecreated = c.timemodified THEN '-1'
ELSE DATEDIFF(FROM_UNIXTIME(c.timemodified),FROM_UNIXTIME(c.timecreated))
END AS 'DateDifference',
COUNT(ue.id) AS Enroled
FROM prefix_course AS c
JOIN prefix_enrol AS en ON en.courseid = c.id
LEFT JOIN prefix_user_enrolments AS ue ON ue.enrolid = en.id
WHERE DATEDIFF(FROM_UNIXTIME(c.timemodified),FROM_UNIXTIME(c.timecreated) ) < 60
GROUP BY c.id
HAVING COUNT(ue.id) <= 3
ORDER BY c.fullname
</code>

===Count unique teachers with courses that use at least X module (Moodle19)===
You can remove the outer "SELECT COUNT(*) FROM (...) AS ActiveTeachers" SQL query and get the list of the Teachers and Courses.
<code sql>
SELECT COUNT(*)
FROM (SELECT c.id AS CourseID, c.fullname AS Course, ra.roleid AS RoleID, CONCAT(u.firstname, ' ', u.lastname) AS Teacher
,(SELECT COUNT(*) FROM prefix_course_modules cm WHERE cm.course = c.id) AS Modules
FROM prefix_course AS c
JOIN prefix_context AS ctx ON c.id = ctx.instanceid AND ctx.contextlevel = 50
JOIN prefix_role_assignments AS ra ON ra.contextid = ctx.id
JOIN prefix_user AS u ON u.id = ra.userid
JOIN prefix_course_categories AS cc ON cc.id = c.category
WHERE ra.roleid = 3
GROUP BY u.id
HAVING Modules > 5) AS ActiveTeachers
</code>

===RESOURCE count for each COURSE===
<code sql>
SELECT COUNT(l.id) count, l.course, c.fullname coursename
FROM prefix_resource l INNER JOIN prefix_course c on l.course = c.id
GROUP BY course
ORDER BY count DESC
</code>

===Common resource types count for each Category (Moodle19)===
Including sub-categories in total count.
<code sql>
SELECT mcc.id AS mccid, CONCAT( LPAD( '', mcc.depth, '.' ) , mcc.name ) AS Category
,(SELECT COUNT( * )
FROM prefix_resource AS r
JOIN prefix_course AS c ON c.id = r.course
JOIN prefix_course_categories AS cc ON cc.id = c.category
WHERE cc.path LIKE CONCAT( '%', mccid, '%' ) AND r.TYPE = 'file' AND r.reference LIKE 'http://%'
) AS Links

,(SELECT COUNT( * )
FROM prefix_resource AS r
JOIN prefix_course AS c ON c.id = r.course
JOIN prefix_course_categories AS cc ON cc.id = c.category
WHERE cc.path LIKE CONCAT( '%', mccid, '%' ) AND r.TYPE = 'file' AND r.reference NOT LIKE 'http://%'
) AS Files

,(SELECT COUNT( * )
FROM prefix_resource AS r
JOIN prefix_course AS c ON c.id = r.course
JOIN prefix_course_categories AS cc ON cc.id = c.category
WHERE cc.path LIKE CONCAT( '%', mccid, '%' ) AND r.TYPE = 'directory'
) AS Folders

,(SELECT COUNT( * )
FROM prefix_resource AS r
JOIN prefix_course AS c ON c.id = r.course
JOIN prefix_course_categories AS cc ON cc.id = c.category
WHERE cc.path LIKE CONCAT( '%', mccid, '%' ) AND r.TYPE = 'html'
) AS Pages

,(SELECT COUNT(*)
FROM stats_log_context_role_course
WHERE roleid = 5 AND module = 'resource' AND category = mcc.id
) AS Hits

FROM prefix_course_categories AS mcc
ORDER BY mcc.path
</code>
Where "stats_log_context_role_course" (in the above SQL query) is a VIEW generated by:
<code sql>
CREATE VIEW stats_log_context_role_course AS
SELECT l.course, c.category, cc.path, l.module, l.action, ra.userid, ra.roleid
FROM prefix_log AS l
JOIN prefix_context AS context ON context.instanceid = l.course AND context.contextlevel = 50
JOIN prefix_role_assignments AS ra ON ra.userid = l.userid AND ra.contextid = context.id
JOIN prefix_course AS c ON c.id = l.course
JOIN prefix_course_categories AS cc ON cc.id = c.category
</code>

Same query but for Moodle2+
<code sql>
SELECT mcc.id AS mccid, CONCAT( LPAD( '', mcc.depth, '.' ) , mcc.name ) AS Category,
mcc.path,

(SELECT COUNT(*)
FROM prefix_url AS u
JOIN prefix_course AS c ON c.id = u.course
JOIN prefix_course_categories AS cc ON cc.id = c.category
WHERE cc.path LIKE CONCAT( '%/', mccid, '%' )
) AS URLs,

(SELECT COUNT(*)
FROM prefix_folder AS f
JOIN prefix_course AS c ON c.id = f.course
JOIN prefix_course_categories AS cc ON cc.id = c.category
WHERE cc.path LIKE CONCAT( '%/', mccid, '%' )
) AS FOLDERs,

(SELECT COUNT(*)
FROM prefix_page AS p
JOIN prefix_course AS c ON c.id = p.course
JOIN prefix_course_categories AS cc ON cc.id = c.category
WHERE cc.path LIKE CONCAT( '%/', mccid, '%' )
) AS PAGEs,

(SELECT COUNT(*)
FROM prefix_book AS b
JOIN prefix_course AS c ON c.id = b.course
JOIN prefix_course_categories AS cc ON cc.id = c.category
WHERE cc.path LIKE CONCAT( '%/', mccid, '%' )
) AS BOOKs,

(SELECT COUNT(*)
FROM prefix_label AS l
JOIN prefix_course AS c ON c.id = l.course
JOIN prefix_course_categories AS cc ON cc.id = c.category
WHERE cc.path LIKE CONCAT( '%/', mccid, '%' )
) AS LABELs,

(SELECT COUNT(*)
FROM prefix_tab AS t
JOIN prefix_course AS c ON c.id = t.course
JOIN prefix_course_categories AS cc ON cc.id = c.category
WHERE cc.path LIKE CONCAT( '%/', mccid, '%' )
) AS TABs

FROM prefix_course_categories AS mcc
ORDER BY mcc.path
</code>

===Detailed Resource COUNT by Teacher in each course===

Including (optional) filter by: year, semester and course id.

<code sql>
SELECT concat('<a target="_new" href="%%WWWROOT%%/course/view.php?id=',c.id,'">',c.fullname,'</a>') AS CourseID
, c.id
,( SELECT DISTINCT CONCAT(u.firstname,' ',u.lastname)
FROM prefix_role_assignments AS ra
JOIN prefix_user AS u ON ra.userid = u.id
JOIN prefix_context AS ctx ON ctx.id = ra.contextid
WHERE ra.roleid = 3 AND ctx.instanceid = c.id AND ctx.contextlevel = 50 LIMIT 1) AS Teacher

, (CASE
WHEN c.fullname LIKE '%תשעב%' THEN '2012'
WHEN c.fullname LIKE '%תשעא%' THEN '2011'
END ) as Year
, (CASE
WHEN c.fullname LIKE '%סמסטר א%' THEN 'Semester A'
WHEN c.fullname LIKE '%סמסטר ב%' THEN 'Semester B'
WHEN c.fullname LIKE '%סמסטר ק%' THEN 'Semester C'
END ) as Semester
,COUNT(c.id) AS Total
,(SELECT count(*) FROM prefix_course_modules AS cm WHERE cm.course = c.id AND cm.module= 20) AS TABs
,(SELECT count(*) FROM prefix_course_modules AS cm WHERE cm.course = c.id AND cm.module= 33) AS BOOKs

FROM `prefix_resource` as r
JOIN `prefix_course` AS c on c.id = r.course
#WHERE type= 'file' and reference NOT LIKE 'http://%'

#WHERE 1=1
#%%FILTER_YEARS:c.fullname%%
#AND c.fullname LIKE '%2013%'

GROUP BY course
ORDER BY COUNT(c.id) DESC
</code>

===Courses that are defined as using GROUPs===
<code sql>
SELECT concat('<a target="_new" href="%%WWWROOT%%/group/index.php?id=',c.id,'">',c.fullname,'</a>') AS Course
,(SELECT count(*) FROM prefix_course_modules cm WHERE cm.course = c.id) Modules
,(SELECT count(*) FROM prefix_groups g WHERE g.courseid = c.id) Groups
FROM `prefix_course` AS c
WHERE groupmode > 0
</code>

===Courses with Groups===

Contributed by: [https://moodle.org/user/profile.php?id=88992 Randy Thornton]

List of all courses with Groups in them (groupmode > 0). You can also use groupmode=1 to list just Separate type groups or groupmode=2 to list Visible type groups.

<code sql>
SELECT c.shortname, g.name, c.groupmode
FROM prefix_course AS c
JOIN prefix_groups AS g ON c.id = g.courseid
WHERE c.groupmode > 0
</code>

===Users enrolled in a course with groups but not assigned a group ===

Displays by course all enrolled users that have not been assigned a group in courses that have groups. NOTE: This needs to be optimized.

<code sql>
SELECT DISTINCT
user2.firstname AS Firstname,
user2.lastname AS Lastname,
user2.email AS Email,
user2.city AS City,
course.fullname AS Course
,(SELECT shortname FROM prefix_role WHERE id=en.roleid) AS ROLE
,(SELECT name FROM prefix_role WHERE id=en.roleid) AS RoleName

FROM prefix_course AS course
JOIN prefix_enrol AS en ON en.courseid = course.id
JOIN prefix_user_enrolments AS ue ON ue.enrolid = en.id
JOIN prefix_user AS user2 ON ue.userid = user2.id
JOIN prefix_groups AS g ON g.courseid = course.id

WHERE ue.enrolid NOT IN (select userid from prefix_groups_members WHERE g.id=groupid)

ORDER BY Course, Lastname
</code>

===Groups in course with member list===

Contributed by: [https://moodle.org/user/profile.php?id=88992 Randy Thornton]

List the groups in a course (replace the # by the course id number) with the members of each group.

<code sql>
SELECT c.shortname, g.name AS Groupname, u.username
FROM prefix_course AS c
JOIN prefix_groups AS g ON g.courseid = c.id
JOIN prefix_groups_members AS m ON g.id = m.groupid
JOIN prefix_user AS u ON m.userid = u.id
WHERE c.id = #
</code>

Note: if you are using Configurable Reports block and want to perform this query on the current course you are in, then you can use a WHERE clause like this:
<code sql>
WHERE c.id = %%COURSEID%%
</code>

===Group Export===

Contributed by: [https://moodle.org/user/profile.php?id=88992 Randy Thornton]

There's a [[Import_groups|group import]] function, but no export. Use this to give you a report with the proper column order and headings to export to a csv file you can then import into another course to replicate the groups. This is a simple version with just the main fields: groupname, description, enrolment key.

<code sql>
SELECT g.name AS groupname, g.description, g.enrolmentkey
FROM prefix_groups AS g
JOIN prefix_course as c ON g.courseid = c.id
WHERE c.id = #
</code>
Note: if you are using Configurable Reports block and want to perform this query on the current course you are in, then you can use a WHERE clause like this:
<code sql>
WHERE c.id = %%COURSEID%%
</code>

===List all Courses in and below a certain category===
Use this SQL code to retrieve all courses that exist in or under a set category.

$s should be the id of the category you want to know about...
<code sql>
SELECT prefix_course. * , prefix_course_categories. *
FROM prefix_course, prefix_course_categories
WHERE prefix_course.category = prefix_course_categories.id
AND (
prefix_course_categories.path LIKE '%/$s/%'
OR prefix_course_categories.path LIKE '%/$s'
)
</code>

===List all Categories in one level below a certain category===
Use this PHP code to retrieve a list of all categories below a certain category.

$s should be the id of the top level category you are interested in.
<code php>
<?php

require_once('./config.php');

$parent_id = $s;

$categories= array();

$categories = get_categories($parent_id);

echo '<ol>';
foreach ($categories as $category)
{
echo '<li><a href="'.$CFG->wwwroot.'/course/category.php?id='.$category->id.'">'.$category->name.'</a></li>';
}
echo '</ol>';

?>
</code>

===Blog activity per Course (not including VIEW)===
Filter activity logging to some specific Course Categories!
+ link course name to actual course (for quick reference)
(you can change %blog% to %wiki% to filter down all wiki activity or any other module you wish)
<code sql>
SELECT concat('<a target="_new" href="%%WWWROOT%%/course/view.php?id=',cm.course,'">',c.fullname,'</a>') as CourseID
,m.name ,count(cm.id) as counter
,(SELECT Count( ra.userid ) AS Users
FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
WHERE ra.roleid = 5
AND ctx.instanceid = c.id
) AS Students
, ( SELECT count(id) FROM prefix_log WHERE `module` LIKE '%blog%' AND course = c.id AND action NOT LIKE '%view%' ) as BlogActivity
FROM `prefix_course_modules` as cm JOIN prefix_modules as m ON cm.module=m.id JOIN prefix_course as c ON cm.course = c.id
WHERE m.name LIKE '%blog%' AND c.category IN ( 8,13,15)
GROUP BY cm.course,cm.module order by counter desc
</code>

===Student's posts content in all course blogs (oublog)===
<code sql>
SELECT
b.name
,op.title
,op.message
,( SELECT CONCAT(u.firstname, ' ',u.lastname) FROM prefix_user AS u WHERE u.id = oi.userid) AS "Username"

FROM prefix_oublog_posts AS op
JOIN prefix_oublog_instances AS oi ON oi.id = op.oubloginstancesid
JOIN prefix_oublog as b ON b.id = oi.oublogid
JOIN prefix_course AS c ON b.course = c.id

WHERE c.id = %%COURSEID%%
</code>

===All Courses which uploaded a Syllabus file===
+ under specific Category
+ show first Teacher in that course
+ link Course's fullname to actual course
<code sql>
SELECT
concat('<a target="_new" href="%%WWWROOT%%/course/view.php?id=',c.id,'">',c.fullname,'</a>') as Course
,c.shortname,r.name
,(SELECT CONCAT(u.firstname,' ', u.lastname) as Teacher
FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
JOIN prefix_user as u ON u.id = ra.userid
WHERE ra.roleid = 3 AND ctx.instanceid = c.id LIMIT 1) as Teacher
FROM prefix_resource as r
JOIN prefix_course as c ON r.course = c.id
WHERE ( r.name LIKE '%סילבוס%' OR r.name LIKE '%סילאבוס%' OR r.name LIKE '%syllabus%' OR r.name LIKE '%תכנית הקורס%' )
AND c.category IN (10,18,26,13,28)
</code>

===Site-wide completed SCORM activities by Course name===
This report will list all completed attempts for all SCORM activities. It is ordered first by Course name, then student's last name, then student's first name, then attempt number. Please note: the FROM_UNIXTIME command is for MySQL.
<code sql>
SELECT u.firstname First,u.lastname Last,c.fullname Course, st.attempt Attempt,st.value Status,FROM_UNIXTIME(st.timemodified,"%m-%d-%Y") Date
FROM prefix_scorm_scoes_track AS st
JOIN prefix_user AS u ON st.userid=u.id
JOIN prefix_scorm AS sc ON sc.id=st.scormid
JOIN prefix_course AS c ON c.id=sc.course
WHERE st.value='completed'
ORDER BY c.fullname, u.lastname,u.firstname, st.attempt
</code>
===All users enrolled in a course without a role===
Identifies All users that are enrolled in a course but are not assigned a role.
<code sql>
SELECT
user.firstname AS Firstname,
user.lastname AS Lastname,
user.idnumber Employee_ID,
course.fullname AS Course

FROM prefix_course AS course
JOIN prefix_enrol AS en ON en.courseid = course.id
JOIN prefix_user_enrolments AS ue ON ue.enrolid = en.id
JOIN prefix_user as user ON user.id = ue.userid

WHERE user.id NOT IN (
SELECT u.id
FROM prefix_course AS c
JOIN prefix_context AS ctx ON c.id = ctx.instanceid
JOIN prefix_role_assignments AS ra ON ra.contextid = ctx.id
JOIN prefix_role AS r ON r.id = ra.roleid
JOIN prefix_user AS u ON u.id = ra.userid
WHERE c.id=course.id
)
ORDER BY Course, Lastname, Firstname

</code>

===List course resources accumulative file size and count===
This is the main (first) report, which has a link (alias) to a second report (the following on this page) which list each file in the course.
<code sql>
SELECT c.id "CourseID", context.id "ContextID"
,CONCAT('<a target="_new" href="%%WWWROOT%%/course/view.php?id=', c.id, '">', c.fullname ,'</a>') AS "Course Name"
, COUNT(*) "Course Files" , ROUND( SUM( f.filesize ) /1048576 ) AS file_size_MB
,CONCAT('<a target="_new" href="%%WWWROOT%%/blocks/configurable_reports/viewreport.php?alias=coursefiles&courseid=1&filter_courses=', c.id, '">List files</a>') AS "List Files"

FROM mdl_files AS f
JOIN mdl_context AS context ON context.id = f.contextid
JOIN mdl_course AS c ON c.id = (
SELECT instanceid
FROM mdl_context
WHERE id = SUBSTRING_INDEX( SUBSTRING_INDEX( context.path, '/' , -2 ) , '/', 1 ) )
WHERE filesize >0
GROUP BY c.id
</code>

With this report, you will have to define "alias" report property to "coursefiles" for it to be able to be called from the above report.
And also setup (add) a FILTER_COURSES filter.
<code sql>
SELECT
id ,CONCAT('<a target="_new" href="%%WWWROOT%%/pluginfile.php/', contextid, '/', component, '/', filearea, '/', itemid, '/', filename, '">', filename,'</a>') AS "File"
,filesize, mimetype ,author, license, timecreated, component, filearea, filepath

FROM mdl_files AS f
WHERE filesize >0
AND f.contextid
IN ( SELECT id
FROM mdl_context
WHERE path
LIKE ( SELECT CONCAT('%/',id,'/%')
AS contextquery
FROM mdl_context
WHERE 1=1
%%FILTER_COURSES:instanceid%%
AND contextlevel = 50
)
)
</code>

===Which courses has redundant topics===
This report list several "active topics" calculations, per course. which should give an administrator some indications for which topics/sections/weeks are filled with resources and activities and which ones are empty and not used (usually, at the end of the course).

The following, second SQL query, could be used to "trim" down those redundant course topics/sections/weeks by updating the course format's numsection (Number of sections) setting. (It's a per course format setting!)

<code sql>
SELECT id, format,
concat('<a target="_new" href="%%WWWROOT%%/course/view.php?id=',c.id,'">', c.fullname,'</a>') AS Course

,(SELECT value FROM `mdl_course_format_options` WHERE `courseid` = c.id AND `format` = c.format AND `name` = 'numsections' ) AS "numsections"
,(SELECT COUNT(*) FROM `mdl_course_sections` WHERE `course` = c.id AND `sequence` != '' ) AS "Non empty sections count"
,(SELECT COUNT(*) FROM `mdl_course_sections` WHERE `course` = c.id ) AS "Total section count"
,(SELECT COUNT(*) FROM `mdl_course_sections` WHERE `course` = c.id AND sequence IS NOT NULL) AS "Non NULL sections count"
,(SELECT COUNT(*) FROM `mdl_course_sections` WHERE `course` = c.id AND name != '') AS "Non empty section Name count"
,(SELECT COUNT(*) FROM mdl_course_modules cm WHERE cm.course = c.id) "Modules count"

FROM mdl_course AS c
</code>

The following SQL REPLACE query is used for "fixing" (updating) the "numsections" of a specific course format "onetopics" (you can always change it, or discard it to use this SQL REPLACE on all course formats)
<code sql>
REPLACE INTO `mdl_course_format_options` (`id`, `courseid`, `format`, `sectionid`, `name`, `value`)
SELECT NULL, c.id, 'onetopic', '0', 'numsections', (SELECT COUNT(*) FROM `mdl_course_sections` WHERE `course` = c.id AND name != '')
FROM `mdl_course` c where format = 'onetopic'
</code>

===Hidden Courses with Students Enrolled===
Contributed by Eric Strom

This query identifies courses with student enrollment that are currently hidden from students. Includes the defined course start date, count of students and instructors, and a clickable email link of instructor (first found record if more than one).

<code sql>
SELECT c.visible AS Visible,
DATE(FROM_UNIXTIME(c.startdate)) AS StartDate,
concat('<a target="_new" href="%%WWWROOT%%/course/view.php',CHAR(63),'id=',
c.id,'">',c.idnumber,'</a>') AS Course_ID,

(SELECT COUNT( ra.userid ) FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
WHERE ra.roleid = 5 AND ctx.instanceid = c.id) AS Students,

(SELECT COUNT( ra.userid ) FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
WHERE ra.roleid = 3 AND ctx.instanceid = c.id) AS Instructors,

(SELECT DISTINCT concat('<a href="mailto:',u.email,'">',u.email,'</a>')
FROM prefix_role_assignments AS ra
JOIN prefix_user AS u ON ra.userid = u.id
JOIN prefix_context AS ctx ON ctx.id = ra.contextid
WHERE ra.roleid = 3 AND ctx.instanceid = c.id AND ctx.contextlevel = 50 LIMIT 1) AS 'Instructor_Email',

now() AS Report_Timestamp

FROM prefix_course AS c
WHERE c.visible = 0 AND (SELECT COUNT( ra.userid ) FROM prefix_role_assignments AS ra JOIN prefix_context AS ctx ON ra.contextid = ctx.id WHERE ra.roleid = 5 AND ctx.instanceid = c.id) > 0
ORDER BY StartDate, Instructor_Email, Course_ID
</code>

==Course Design Reports==

These are reports which summarize course design aspects, such as activity and resource modules per section, types of activities used, etc.

===Course Content/Week===
Contributed by Elizabeth Dalton, Granite State College

This report assumes that the first 14 sections in a course, not including the "0" or "Welcome" section, correspond to weeks (with "Subsections" given numbers much higher in the sequence). Of those sections, each is checked to count the number of:

Forums
Graded Activities (may include Forums)
Resources (not including a Label)

Totals of each of these types of content elements per section are provided.

'''Note''': Only visible resources and activities are counted.
'''Note''': this is a "Global" report. Run it within a course to see a summary of the contents of that course.

<code sql>
SELECT

cs.section AS 'Week'
, cs.name AS 'Section Name'

, COUNT(DISTINCT IF((gi.id IS NULL) AND (m.name NOT LIKE 'label'),cm.id,NULL)) AS 'Ungraded Resources'

, COUNT(DISTINCT IF(m.name LIKE 'forum', cm.id, NULL)) AS 'Forums'

, COUNT(DISTINCT IF(gi.id, cm.id, NULL)) AS 'Graded Activities'

FROM prefix_course AS c
JOIN prefix_course_sections AS cs ON cs.course = c.id AND cs.section <= 14 AND cs.section > 0
LEFT JOIN prefix_course_modules AS cm ON cm.course = c.id AND cm.section = cs.id
JOIN prefix_modules AS m ON m.id = cm.module
LEFT JOIN prefix_grade_items AS gi ON gi.courseid = c.id AND gi.itemmodule = m.name AND gi.iteminstance = cm.instance

WHERE
cs.visible = 1
AND cm.visible = 1
AND c.id = %%COURSEID%%

GROUP BY cs.section
ORDER BY cs.section

</code>

===Assignments and Weights===
Contributed by Elizabeth Dalton, Granite State College

Returns a list of grade book categories for the current course, grade book weightings, the first type of assignment included in the category, a count of different assignment types for each category, and a count of assignments for each category.

Categories with weights of 0 are not included in this report.

Only visible activities are included in this report.

'''Note''': This is designed to be a "Global" report in Configurable Reports.
<code sql>
SELECT

IF(gc.parent IS NOT NULL, gc.fullname, 'None') AS 'Grade Book Category'
, IF(gc.parent IS NOT NULL, ROUND(gic.aggregationcoef, 2), ROUND(SUM(DISTINCT gi.aggregationcoef), 2)+ROUND(SUM(DISTINCT mgi.aggregationcoef), 2)) AS 'Category weight'

, CONCAT_WS(', ',GROUP_CONCAT(DISTINCT gi.itemmodule SEPARATOR ', '), IF(mgi.id, 'manual',NULL)) AS 'Activity Types'
, COUNT(DISTINCT gi.itemmodule) + IF(mgi.id,1,0) AS 'Different Activity Types'
, CONCAT_WS('<br>', GROUP_CONCAT(DISTINCT gi.itemname ORDER BY gi.itemname SEPARATOR '<br>'), GROUP_CONCAT(DISTINCT mgi.itemname ORDER BY mgi.itemname SEPARATOR '<br>')) AS 'Activity Names'
, COUNT(DISTINCT IF(gi.id, cm.id, NULL)) + COUNT(DISTINCT mgi.id) AS 'Activity Count'

FROM prefix_course AS c

#get grade categories
LEFT JOIN prefix_grade_categories AS gc ON gc.courseid = c.id
# back from categories to grade items to get aggregations and weights
JOIN prefix_grade_items AS gic ON gic.courseid = c.id AND gic.itemtype = 'category' AND gic.aggregationcoef != 0 AND (LOCATE(gic.iteminstance, gc.path) OR (gc.parent IS NULL))

# attach activities to course
JOIN prefix_course_modules AS cm ON cm.course = c.id
# attach grade items to activities
LEFT JOIN prefix_grade_items AS gi ON gi.courseid = c.id AND gi.iteminstance = cm.instance AND gi.itemtype = 'mod' AND gi.categoryid = gc.id AND gi.hidden != 1

# attach manual grade items to course-- they don't have modules
LEFT JOIN prefix_grade_items AS mgi ON mgi.courseid = c.id and mgi.itemtype = 'manual' AND mgi.categoryid = gc.id

WHERE
cm.visible = 1
AND c.id = %%COURSEID%%

GROUP BY gc.id
ORDER BY gc.id

</code>

===Pre-Term Course Review===
Contributed by Elizabeth Dalton, Granite State College

Provides an overview of the readiness of ONLINE, HYBRID, and BLENDED courses in the Staging category and all subcategories. Links to each course are provided. Other details:

# "Required blocks" include Instructor Block (mooprofile), Activities, and the Research block.
# "Instructor Details" block is not the "Instructor" block (mooprofile) automatically provided by the system. It is an optional block that can be edited by the instructor. If not edited to remove boilerplate text, it should be hidden.
# All courses should be in the "Collapsed Topics" format with the "Weeks" structure.
# "Weeks defined in course settings" is taken from our SIS when the course shells are created, but can be edited by faculty. "# of weeks named and visible" should usually match or exceed this value.
# We recommend that each week contain at least one forum, at least one graded activity, and at least one ungraded resource.
# "Syllabus updated" date is for the first attached file found with the text "syllabus" in the name. The "Days ago" calculation is included for convenience.

'''Note''': At our institution, we construct categories each term, and insert a text string "staging" in the Category ID for pre-term courses during the preparation or "staging" phase of course development. We remove this text string (and change it to "production") when courses go live at the start of the new term.

<code sql>
SELECT CONCAT('<a target="_blank" href="%%WWWROOT%%/course/view.php',CHAR(63),'id=',c.id,'">',c.shortname,'</a>') AS Course

#,RIGHT(c.idnumber,2) AS Type # Specific to GSC "Instructional Method" storage

#, substring_index(substr(c.shortname FROM locate('.',c.shortname)+1),'-',1) AS Section # Specific to GSC

,(SELECT CONCAT('<a target="_blank" href="%%WWWROOT%%/user/view.php',CHAR(63),'id=',u.id,'">',u.lastname,', ', u.firstname,'</a>')
FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
JOIN prefix_user AS u ON u.id = ra.userid
WHERE ra.roleid = 3 AND ctx.instanceid = c.id LIMIT 1) AS 'Instructor'

,(SELECT IF((u2.description IS NULL) OR (u2.description LIKE ''),'NO', 'YES')
FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
JOIN prefix_user AS u2 ON u2.id = ra.userid
WHERE ra.roleid = 3 AND ctx.instanceid = c.id LIMIT 1) AS 'Profile Has Bio'

,(SELECT IF(u3.picture > 0,'YES','NO')
FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
JOIN prefix_user AS u3 ON u3.id = ra.userid
WHERE ra.roleid = 3 AND ctx.instanceid = c.id LIMIT 1) AS 'Profile Has Picture'

, IF(((bpi.visible IS NULL) OR (bpi.visible !=0)) AND ((bpm.visible IS NULL) OR (bpm.visible !=0)) AND ((bpa.visible IS NULL) OR (bpa.visible !=0)) AND ((bpr.visible IS NULL) OR (bpr.visible !=0)),'YES','NO') AS 'Required blocks visible'
#, IF((bpm.visible IS NULL) OR (bpm.visible !=0),'YES','NO') AS 'Messages block visible'
#, IF((bpa.visible IS NULL) OR (bpa.visible !=0),'YES','NO') AS 'activities block visible'
#, IF((bpr.visible IS NULL) OR (bpr.visible !=0),'YES','NO') AS 'research block visible'

#, IF(SUM(IF(bi.configdata LIKE 'Tzo4OiJzdGRDbGFzcyI6Mzp7czo1OiJ0aXRsZSI7czoxODoiSW5zdHJ1Y3RvciBEZXRhaWxzI%',1,0)) AND (bip.visible !=0),'YES','') AS 'Instructor Details Block visible' # This is a hack based on UUencoded string data from the title of HTML "Instructor Details" block

#, IF(bi.configdata LIKE '%ZGl0IHRoaXMgYmxvY2s%','NO','') AS 'Instructor Details Block Updated' # HTML block has string 'dit this block'

#, IF(COUNT(bi.id) - SUM(IF(bi.configdata LIKE 'Tzo4OiJzdGRDbGFzcyI6Mzp7czo1OiJ0aXRsZSI7czoxODoiSW5zdHJ1Y3RvciBEZXRhaWxzI%',1,0)),'YES','') AS 'possible extra instructor blocks' #looking for any HTML block with "instructor" in the title

, IF(c.format='topcoll','YES', c.format) AS 'Collapsed Topics course format' # change this if you want to test for a different format
, IF(cfo.value = 2, 'YES','NO') AS 'weeks structure'

, cfw.value AS 'weeks defined in course settings'

, COUNT(DISTINCT IF(((cs.name IS NOT NULL) AND (cs.visible = 1) AND (cs.section != '0') AND (cs.sequence IS NOT NULL)),cs.id,NULL)) AS '# of weeks named & visible (includes orphans)'

, COUNT(DISTINCT IF(m.name LIKE 'forum', cm.id, NULL)) AS 'Forums'
, COUNT(DISTINCT IF(m.name LIKE 'forum' ,cs.id , NULL)) AS 'Weeks with Forum'

, COUNT(DISTINCT IF(gi.id, cm.id, NULL)) AS 'Activities'
, COUNT(DISTINCT IF(gi.id, cs.id, NULL)) AS 'Weeks with Activities'
, COUNT(DISTINCT mgi.id) AS 'Manual Grade Items'

, COUNT(DISTINCT IF((gi.id IS NULL) AND (m.name NOT IN ('forum','label')),cm.id,NULL)) AS 'Resources'
, COUNT(DISTINCT IF((gi.id IS NULL) AND (m.name NOT IN ('forum','label')), cs.id, NULL)) AS 'Weeks with Resources'

# Here are some other things you could check for per course
#,(SELECT count( m.name ) AS count FROM prefix_course_modules AS cm JOIN prefix_modules AS m ON cm.module = m.id WHERE cm.course = c.id AND m.name LIKE '%forum%') AS Forums

#,(SELECT count( m.name ) AS count FROM prefix_course_modules AS cm JOIN prefix_modules AS m ON cm.module = m.id WHERE cm.course = c.id AND m.name LIKE '%quiz%') AS Quizzes

#,(SELECT count( m.name ) AS count FROM prefix_course_modules AS cm JOIN prefix_modules AS m ON cm.module = m.id WHERE cm.course = c.id AND m.name LIKE '%assign%') AS Assignments

#,(SELECT COUNT(prefix_resource.id) FROM prefix_resource JOIN prefix_course ON prefix_course.id = prefix_resource.course WHERE c.id = prefix_resource.course) AS Files

#,(SELECT COUNT(prefix_url.id) FROM prefix_url JOIN prefix_course ON prefix_course.id = prefix_url.course WHERE c.id = prefix_url.course) AS Links

,(SELECT FROM_UNIXTIME(MAX(prefix_resource.timemodified))
FROM prefix_resource
JOIN prefix_course ON prefix_course.id = prefix_resource.course WHERE c.id = prefix_resource.course AND prefix_resource.name LIKE '%syllabus%') AS SyllabusDate

,(SELECT TO_DAYS(NOW())-TO_DAYS(FROM_UNIXTIME(MAX(prefix_resource.timemodified)))
FROM prefix_resource
JOIN prefix_course ON prefix_course.id = prefix_resource.course WHERE c.id = prefix_resource.course AND prefix_resource.name LIKE '%syllabus%') AS DaysAgo

, IF(COUNT(DISTINCT IF(f.type LIKE 'news', f.id,NULL)),'YES','NO' ) AS 'Announcement Forum Visible'

, IF(COUNT(DISTINCT IF(f.type LIKE 'news', fd.id,NULL)),'YES','NO' ) AS 'Announcement posted'

FROM prefix_course AS c
LEFT JOIN prefix_course_categories as cc ON c.category = cc.id
LEFT JOIN prefix_context AS ctxx ON c.id = ctxx.instanceid

LEFT JOIN prefix_block_positions AS bpi ON bpi.contextid = ctxx.id AND bpi.blockinstanceid = '43692' # mooprofile
LEFT JOIN prefix_block_positions AS bpm ON bpm.contextid = ctxx.id AND bpm.blockinstanceid = '43962' # messages
LEFT JOIN prefix_block_positions AS bpa ON bpa.contextid = ctxx.id AND bpa.blockinstanceid = '43963' # activities
LEFT JOIN prefix_block_positions AS bpr ON bpr.contextid = ctxx.id AND bpr.blockinstanceid = '38368' # html research help

LEFT JOIN prefix_course_sections AS cs ON cs.course = c.id AND cs.visible = 1 AND cs.sequence IS NOT NULL
LEFT JOIN prefix_course_modules AS cm ON cm.course = c.id AND cm.section = cs.id
LEFT JOIN prefix_modules AS m ON m.id = cm.module
LEFT JOIN prefix_grade_items AS gi ON gi.courseid = c.id AND gi.itemmodule = m.name AND gi.iteminstance = cm.instance

LEFT JOIN prefix_forum AS f ON f.course = c.id AND cm.instance = f.id AND cm.visible = 1
LEFT JOIN prefix_forum_discussions AS fd ON fd.forum = f.id

# attach manual grade items to course-- they don't have modules
LEFT JOIN prefix_grade_items AS mgi ON mgi.courseid = c.id and mgi.itemtype = 'manual'

LEFT JOIN prefix_course_format_options AS cfo ON cfo.courseid = c.id AND cfo.name = 'layoutstructure'
LEFT JOIN prefix_course_format_options AS cfw ON cfw.courseid = c.id AND cfw.name = 'numsections'

LEFT JOIN prefix_block_instances AS bi ON bi.parentcontextid = ctxx.id AND bi.blockname = 'html' AND (bi.configdata LIKE '%SW5zdHJ1Y3Rvc%' or bi.configdata LIKE '%bnN0cnVjdG9y%')
LEFT JOIN prefix_block_positions AS bip ON bip.blockinstanceid = bi.id

WHERE RIGHT(c.idnumber,2) IN ('OL', 'BL', 'HY')
# AND substring(cc.path,2,2) IN ('26') # Staging
#AND substring(cc.path,2,3) IN ('158') # UG
AND cc.idnumber LIKE '%staging%'
AND ctxx.contextlevel = 50

GROUP BY c.shortname
</code>

===Module instances + Module HITs by role teacher and student in course===
<code sql>
SELECT
m.name AS "Module name"
, COUNT(*) AS "Module count"

,(SELECT COUNT(*)
FROM prefix_log AS l
WHERE l.course = cm.course AND l.module = m.name ) AS "Hits"

,(SELECT COUNT(*)
FROM prefix_log AS l
JOIN prefix_context AS con ON con.instanceid= l.course AND con.contextlevel=50
JOIN prefix_role_assignments AS ra ON ra.contextid= con.id AND ra.userid= l.userid AND ra.roleid = 5
WHERE l.course = cm.course AND l.module = m.name) AS "Students HITs"

,(SELECT COUNT(*)
FROM prefix_log AS l
JOIN prefix_context AS con ON con.instanceid= l.course AND con.contextlevel=50
JOIN prefix_role_assignments AS ra ON ra.contextid= con.id AND ra.userid= l.userid AND ra.roleid = 3
WHERE l.course = cm.course AND l.module = m.name) AS "Teachers HITs"

FROM mdl_course_modules AS cm
JOIN mdl_modules AS m on m.id = cm.module
WHERE cm.course = '%%COURSEID%%'
GROUP BY cm.module
</code>

===Course Syllabus===
Contributed by Elizabeth Dalton, Granite State College / Moodle HQ

This report requires ELIS. It runs from within a course and constructs a course syllabus based on content in the course and in the ELIS entries related to the course (Class Instance, Course Description, and Program). It is a proof-of-concept of an automated syllabus production tool. Fields such as "Course Policies" and "Teaching Philosophy" are added to the Class Instance records, and instructors enter them there. The Instructor Bio is pulled from the User Profile of all users with the Teacher role in the course.

<code sql>
SELECT

c.fullname AS 'fullname'
, ec.idnumber AS 'elis-id'
, DATE_FORMAT(FROM_UNIXTIME(ec.startdate), '%b %e, %Y') AS 'start'
, DATE_FORMAT(FROM_UNIXTIME(ec.enddate), '%b %e, %Y') AS 'end'
, ecd.name AS 'longname'
, ecd.code AS 'coursecode'
, ecd.credits AS 'coursecredits'
, ecd.syllabus AS 'description'

, (SELECT eft.data
FROM prefix_local_eliscore_fld_data_text AS eft
JOIN prefix_local_eliscore_field AS ef ON ef.id = eft.fieldid AND ef.shortname = 'learning-outcomes'
WHERE ctxecd.id = eft.contextid) AS 'outcomes'

,(SELECT CONCAT('<a target="_blank" href="%%WWWROOT%%/user/view.php',CHAR(63),'id=',u.id,'">',u.firstname,' ', u.lastname,'</a> ', u.email)
FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
JOIN prefix_user AS u ON u.id = ra.userid
WHERE ra.roleid = 3 AND ctx.instanceid = c.id LIMIT 1) AS 'Instructor'

, (SELECT efc.data
FROM prefix_local_eliscore_fld_data_char AS efc
JOIN prefix_local_eliscore_field AS ef ON ef.id = efc.fieldid AND ef.shortname = 'term-code'
WHERE ctxci.id = efc.contextid) AS 'termcode'

, (SELECT eft.data
FROM prefix_local_eliscore_fld_data_text AS eft
JOIN prefix_local_eliscore_field AS ef ON ef.id = eft.fieldid AND ef.shortname = 'prerequisites'
WHERE ctxecd.id = eft.contextid) AS 'prerequisites'

, (SELECT eft.data
FROM prefix_local_eliscore_fld_data_text AS eft
JOIN prefix_local_eliscore_field AS ef ON ef.id = eft.fieldid AND ef.shortname = 'textbooks'
WHERE ctxci.id = eft.contextid) AS 'textbooks'

, (SELECT eft.data
FROM prefix_local_eliscore_fld_data_text AS eft
JOIN prefix_local_eliscore_field AS ef ON ef.id = eft.fieldid AND ef.shortname = 'other-class-materials'
WHERE ctxci.id = eft.contextid) AS 'other-class-materials'

, (SELECT eft.data
FROM prefix_local_eliscore_fld_data_text AS eft
JOIN prefix_local_eliscore_field AS ef ON ef.id = eft.fieldid AND ef.shortname = 'course-policies'
WHERE ctxci.id = eft.contextid) AS 'course-policies'

, (SELECT eft.data
FROM prefix_local_eliscore_fld_data_text AS eft
JOIN prefix_local_eliscore_field AS ef ON ef.id = eft.fieldid AND ef.shortname = 'teaching-philosophy'
WHERE ctxci.id = eft.contextid) AS 'teaching-philosophy'

, (SELECT eft.data
FROM prefix_local_eliscore_fld_data_text AS eft
JOIN prefix_local_eliscore_field AS ef ON ef.id = eft.fieldid AND ef.shortname = 'course-methods'
WHERE ctxci.id = eft.contextid) AS 'course-methods'

,(SELECT u2.description
FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
JOIN prefix_user AS u2 ON u2.id = ra.userid
WHERE ra.roleid = 3 AND ctx.instanceid = c.id LIMIT 1) AS 'Bio'

,(SELECT

GROUP_CONCAT(DISTINCT CONCAT(

'<tr><td style="border: solid #000 .5px">',IF(gc.parent IS NOT NULL, gc.fullname, 'None')
, ' </td><td style="border: solid #000 .5px"> '
,IF(gc.parent IS NOT NULL, ROUND(gic.aggregationcoef, 2), ROUND( gi.aggregationcoef, 2)+ROUND(mgi.aggregationcoef, 2))

) SEPARATOR '</td></tr>')
#get grade categories
FROM prefix_grade_categories AS gc
# back from categories to grade items to get aggregations and weights
LEFT JOIN prefix_grade_items AS gic ON gic.courseid = gc.courseid AND gic.itemtype = 'category' AND gic.aggregationcoef != 0 AND (LOCATE(gic.iteminstance, gc.path) OR (gc.parent IS NULL))
# attach grade items to activities
LEFT JOIN prefix_grade_items AS gi ON gi.courseid = gc.courseid AND gi.itemtype = 'mod' AND gi.categoryid = gc.id AND gi.hidden != 1
# attach manual grade items to course-- they don't have modules
LEFT JOIN prefix_grade_items AS mgi ON mgi.courseid = gc.courseid and mgi.itemtype = 'manual' AND mgi.categoryid = gc.id
WHERE gc.courseid = c.id ) AS 'grade categories'

, '<table width = "50%" >' AS 'table start'
, '<table width = "100%" >' AS 'table start 2'
, '</table>' AS 'table end'

, (SELECT eft.data
FROM prefix_local_eliscore_fld_data_text AS eft
JOIN prefix_local_eliscore_field AS ef ON ef.id = eft.fieldid AND ef.shortname = 'activities-schedule'
WHERE ctxci.id = eft.contextid) AS 'activities'

, (SELECT eft.data
FROM prefix_local_eliscore_fld_data_text AS eft
JOIN prefix_local_eliscore_field AS ef ON ef.id = eft.fieldid AND ef.shortname = 'schedule'
WHERE ctxci.id = eft.contextid) AS 'schedule'

, (SELECT eft.data
FROM prefix_local_eliscore_fld_data_text AS eft
JOIN prefix_local_eliscore_field AS ef ON ef.id = eft.fieldid AND ef.shortname = 'grading-scale'
WHERE ctxepm.id = eft.contextid) AS 'gradescale'

FROM
prefix_course AS c

# connect moodle course to ELIS class instance
LEFT JOIN prefix_local_elisprogram_cls_mdl AS ecm ON ecm.moodlecourseid = c.id
LEFT JOIN prefix_local_elisprogram_cls AS ec ON ec.id = ecm.classid
# class instance context
LEFT JOIN prefix_context AS ctxci ON ctxci.instanceid = ec.id AND ctxci.contextlevel = '14'

# connect ELIS class instance to ELIS course description
LEFT JOIN prefix_local_elisprogram_crs AS ecd ON ecd.id = ec.courseid
# course description context
LEFT JOIN prefix_context AS ctxecd ON ctxecd.instanceid = ecd.id AND ctxecd.contextlevel = '13'

#connect ELIS program to ELIS Course Description
LEFT JOIN prefix_local_elisprogram_pgm_crs AS epc ON epc.courseid = ecd.id
LEFT JOIN prefix_local_elisprogram_pgm AS epm ON epm.id = epc.curriculumid
# course program context
LEFT JOIN prefix_context AS ctxepm ON ctxepm.instanceid = epm.id AND ctxepm.contextlevel = '11'

WHERE

c.id = %%COURSEID%%
</code>

===Course Activities Helper===
Contributed by Elizabeth Dalton, Granite State College

This report provides a list of the graded activities in a course.
* '''Note''': Only graded activities are displayed.
* '''Note''': This is a "Global" report. Run it within a course to see a summary of the contents of that course.
* '''Note''': This report assumes that course sections each last one week.

<code sql>
# 303 Course Activities Helper

SELECT

gi.itemmodule AS 'activity type'
# cs.section AS 'section number'

# Calculation assumes each section lasts one week
, CONCAT(DATE_FORMAT(FROM_UNIXTIME(c.startdate + (7*24*60*60* (cs.section-1))), '%b %e, %Y'),' - <br>',DATE_FORMAT(FROM_UNIXTIME(c.startdate + (7*24*60*60* (cs.section))), '%b %e, %Y')) AS 'Date'

, gi.itemname AS 'activity name'

#, (SELECT asg.intro FROM prefix_assign AS asg WHERE asg.id = cm.instance) AS 'intro'

#, (SELECT f.intro FROM prefix_forum AS f WHERE f.id = cm.instance) AS 'f intro'

, CASE gi.itemmodule
WHEN 'assign' THEN (SELECT asg.intro FROM prefix_assign AS asg WHERE asg.id = gi.iteminstance)
WHEN 'forum' THEN (SELECT f.intro FROM prefix_forum AS f WHERE f.id = gi.iteminstance)
WHEN 'quiz' THEN (SELECT q.intro FROM prefix_quiz AS q WHERE q.id = gi.iteminstance)
END AS 'test case'

#, (SELECT GROUP_CONCAT(CONCAT(' - ',gi.itemname) SEPARATOR '<BR>') FROM prefix_grade_items AS gi JOIN prefix_course_modules AS cm ON gi.iteminstance = cm.instance WHERE gi.gradetype = 1 AND gi.hidden != 1 AND gi.courseid = c.id AND cm.course = c.id AND cm.section = cs.id ) AS 'activities'

FROM
prefix_course AS c

#get grade sections
LEFT JOIN prefix_course_sections AS cs ON cs.course = c.id AND cs.section > 0 AND cs.section <=14
LEFT JOIN prefix_course_modules AS cm ON cm.course = c.id AND cm.section = cs.id

#LEFT JOIN prefix_assign AS asg ON asg.id = cm.instance

JOIN prefix_grade_items AS gi ON gi.iteminstance = cm.instance AND gi.gradetype = 1 AND gi.hidden != 1 AND gi.courseid = c.id AND cm.course = c.id AND cm.section = cs.id

WHERE
c.id = %%COURSEID%%
AND cs.visible = 1

ORDER BY gi.itemmodule, cs.section
</code>

==Grade and Course Completion Reports==
===Site-Wide Grade Report with All Items===
Shows grades for all course items along with course totals for each student. Works with ad-hoc reports or Configurable Reports
<code sql>
SELECT u.firstname AS 'First' , u.lastname AS 'Last',
u.firstname + ' ' + u.lastname AS 'Display Name',
c.fullname AS 'Course',
cc.name AS 'Category',

CASE
WHEN gi.itemtype = 'course'
THEN c.fullname + ' Course Total'
ELSE gi.itemname
END AS 'Item Name',

ROUND(gg.finalgrade,2) AS Grade,
DATEADD(ss,gg.timemodified,'1970-01-01') AS Time

FROM prefix_course AS c
JOIN prefix_context AS ctx ON c.id = ctx.instanceid
JOIN prefix_role_assignments AS ra ON ra.contextid = ctx.id
JOIN prefix_user AS u ON u.id = ra.userid
JOIN prefix_grade_grades AS gg ON gg.userid = u.id
JOIN prefix_grade_items AS gi ON gi.id = gg.itemid
JOIN prefix_course_categories as cc ON cc.id = c.category

WHERE gi.courseid = c.id
ORDER BY lastname
</code>
For MySQL users, you'll need to use the MySQL DATE_ADD function instead of DATEADD. Replace the line:
<code>
DATEADD(ss,gg.timemodified,'1970-01-01') AS Time
</code>
with:
<code>
FROM_UNIXTIME(gg.timemodified) AS Time
</code>
And:
<code>
u.firstname + ' ' + u.lastname AS 'Display Name',
</code>
with:
<code>
CONCAT(u.firstname,' ',u.lastname) AS 'Display Name',
</code>

===Site-Wide Grade Report with Just Course Totals===
A second site-wide grade report for all students that just shows course totals. Works with ad-hoc reports or Configurable Reports
<code sql>
SELECT u.firstname AS 'First' , u.lastname AS 'Last', u.firstname + ' ' + u.lastname AS 'Display Name',
cc.name AS 'Category',
CASE
WHEN gi.itemtype = 'course'
THEN c.fullname + ' Course Total'
ELSE gi.itemname
END AS 'Item Name',

ROUND(gg.finalgrade,2) AS Grade,
DATEADD(ss,gg.timemodified,'1970-01-01') AS Time

FROM prefix_course AS c
JOIN prefix_context AS ctx ON c.id = ctx.instanceid
JOIN prefix_role_assignments AS ra ON ra.contextid = ctx.id
JOIN prefix_user AS u ON u.id = ra.userid
JOIN prefix_grade_grades AS gg ON gg.userid = u.id
JOIN prefix_grade_items AS gi ON gi.id = gg.itemid
JOIN prefix_course_categories as cc ON cc.id = c.category

WHERE gi.courseid = c.id AND gi.itemtype = 'course'

ORDER BY lastname
</code>

For MySQL users:
<code sql>
SELECT u.firstname AS 'First' , u.lastname AS 'Last', CONCAT(u.firstname , ' ' , u.lastname) AS 'Display Name',
c.fullname AS 'Course',
cc.name AS 'Category',
CASE
WHEN gi.itemtype = 'course'
THEN CONCAT(c.fullname, ' - Total')
ELSE gi.itemname
END AS 'Item Name',

ROUND(gg.finalgrade,2) AS Grade,
FROM_UNIXTIME(gg.timemodified) AS TIME

FROM prefix_course AS c
JOIN prefix_context AS ctx ON c.id = ctx.instanceid
JOIN prefix_role_assignments AS ra ON ra.contextid = ctx.id
JOIN prefix_user AS u ON u.id = ra.userid
JOIN prefix_grade_grades AS gg ON gg.userid = u.id
JOIN prefix_grade_items AS gi ON gi.id = gg.itemid
JOIN prefix_course_categories AS cc ON cc.id = c.category

WHERE gi.courseid = c.id AND gi.itemtype = 'course'
ORDER BY lastname
</code>

===Learner report by Learner with grades===
Which Learners in which course and what are the grades
<code sql>
SELECT u.firstname AS 'Name' , u.lastname AS 'Surname', c.fullname AS 'Course', cc.name AS 'Category',
CASE WHEN gi.itemtype = 'Course'
THEN c.fullname + ' Course Total'
ELSE gi.itemname
END AS 'Item Name', ROUND(gg.finalgrade,2) AS Score,ROUND(gg.rawgrademax,2) AS Max, ROUND(gg.finalgrade / gg.rawgrademax * 100 ,2) as Percentage,

if (ROUND(gg.finalgrade / gg.rawgrademax * 100 ,2) > 79,'Yes' , 'No') as Pass

FROM prefix_course AS c
JOIN prefix_context AS ctx ON c.id = ctx.instanceid
JOIN prefix_role_assignments AS ra ON ra.contextid = ctx.id
JOIN prefix_user AS u ON u.id = ra.userid
JOIN prefix_grade_grades AS gg ON gg.userid = u.id
JOIN prefix_grade_items AS gi ON gi.id = gg.itemid
JOIN prefix_course_categories AS cc ON cc.id = c.category
WHERE gi.courseid = c.id and gi.itemname != 'Attendance'
ORDER BY `Name` ASC
</code>

===User Course Completion===

Contributed by: [https://moodle.org/user/profile.php?id=88992 Randy Thornton]

A very simple report with a list of course completion status by username. Completions are noted by date, blank otherwise.

<code sql>
SELECT
u.username,
c.shortname,
DATE_FORMAT(FROM_UNIXTIME(p.timecompleted),'%Y-%m-%d') AS completed
FROM prefix_course_completions AS p
JOIN prefix_course AS c ON p.course = c.id
JOIN prefix_user AS u ON p.userid = u.id
WHERE c.enablecompletion = 1
ORDER BY u.username
</code>

===User Course Completion with Criteria===

Contributed by: [https://moodle.org/user/profile.php?id=88992 Randy Thornton]

A report with course completions by username, with Aggregation method, Criteria types, and Criteria detail where available.

<code sql>
SELECT u.username AS user,
c.shortname AS course,
DATE_FORMAT(FROM_UNIXTIME(t.timecompleted),'%Y-%m-%d') AS completed,
CASE
WHEN (SELECT a.method FROM prefix_course_completion_aggr_methd AS a WHERE (a.course = c.id AND a.criteriatype IS NULL) = 1) THEN "Any"
ELSE "All"
END AS aggregation,
CASE
WHEN p.criteriatype = 1 THEN "Self"
WHEN p.criteriatype = 2 THEN "By Date"
WHEN p.criteriatype = 3 THEN "Unenrol Status"
WHEN p.criteriatype = 4 THEN "Activity"
WHEN p.criteriatype = 5 THEN "Duration"
WHEN p.criteriatype = 6 THEN "Course Grade"
WHEN p.criteriatype = 7 THEN "Approve by Role"
WHEN p.criteriatype = 8 THEN "Previous Course"
END AS criteriatype,
CASE
WHEN p.criteriatype = 1 THEN "*"
WHEN p.criteriatype = 2 THEN DATE_FORMAT(FROM_UNIXTIME(p.timeend),'%Y-%m-%d')
WHEN p.criteriatype = 3 THEN t.unenroled
WHEN p.criteriatype = 4 THEN
CONCAT('<a target="_new" href="%%WWWROOT%%/mod/',p.module,'/view.php?id=',p.moduleinstance,'">',p.module,'</a>')
WHEN p.criteriatype = 5 THEN p.enrolperiod
WHEN p.criteriatype = 6 THEN CONCAT('Needed: ',ROUND(p.gradepass,2),' Achieved: ',ROUND(t.gradefinal,2))
WHEN p.criteriatype = 7 THEN p.role
WHEN p.criteriatype = 8 THEN (SELECT pc.shortname FROM prefix_course AS pc WHERE pc.id = p.courseinstance)
END AS criteriadetail
FROM prefix_course_completion_crit_compl AS t
JOIN prefix_user AS u ON t.userid = u.id
JOIN prefix_course AS c ON t.course = c.id
JOIN prefix_course_completion_criteria AS p ON t.criteriaid = p.id

</code>

===Courses with Completion Enabled and their settings===

Contributed by: [https://moodle.org/user/profile.php?id=88992 Randy Thornton]

List of all courses with completion enabled and their Aggregation setting, Criteria types, and Criteria details.

<code sql>

SELECT c.shortname AS Course,
CASE
WHEN (SELECT a.method FROM prefix_course_completion_aggr_methd AS a WHERE (a.course = t.course AND a.criteriatype IS NULL)) = 2 THEN "All"
ELSE "Any"
END AS Course_Aggregation,
CASE
WHEN t.criteriatype = 1 THEN "Self completion"
WHEN t.criteriatype = 2 THEN "Date done by"
WHEN t.criteriatype = 3 THEN "Unenrolement"
WHEN t.criteriatype = 4 THEN "Activity completion"
WHEN t.criteriatype = 5 THEN "Duration in days"
WHEN t.criteriatype = 6 THEN "Final grade"
WHEN t.criteriatype = 7 THEN "Approve by role"
WHEN t.criteriatype = 8 THEN "Previous course"
END AS Criteria_type,
CASE
WHEN t.criteriatype = 1 THEN "On"
WHEN t.criteriatype = 2 THEN DATE_FORMAT(FROM_UNIXTIME(t.timeend),'%Y-%m-%d')
WHEN t.criteriatype = 3 THEN "On"
WHEN t.criteriatype = 4 THEN
CONCAT('<a target="_new" href="%%WWWROOT%%/mod/',t.module,'/view.php?id=',t.moduleinstance,'">',t.module,'</a>')
WHEN t.criteriatype = 5 THEN ROUND(t.enrolperiod/86400)
WHEN t.criteriatype = 6 THEN ROUND(t.gradepass,2)
WHEN t.criteriatype = 7 THEN (SELECT r.shortname FROM prefix_role AS r WHERE r.id = t.role)
WHEN t.criteriatype = 8 THEN (SELECT pc.shortname FROM prefix_course AS pc WHERE pc.id = t.courseinstance)
END AS Criteria_detail
FROM prefix_course_completion_criteria as t
JOIN prefix_course AS c ON t.course = c.id
WHERE c.enablecompletion = 1
ORDER BY course
</code>

===Course Completion Report with custom dates===

List of users who completed multiple or single course/s from a start date to end date chosen by the user. The output gives username, name, course name, completion date and score

<code sql>

SELECT u.username AS 'User Name',
CONCAT(u.firstname , ' ' , u.lastname) AS 'Name',
c.shortname AS 'Course Name',
DATE_FORMAT(FROM_UNIXTIME(p.timecompleted),'%W %e %M, %Y') AS 'Completed Date',
ROUND(c4.gradefinal,2) AS 'Score'
FROM prefix_course_completions AS p
JOIN prefix_course AS c ON p.course = c.id
JOIN prefix_user AS u ON p.userid = u.id
JOIN prefix_course_completion_crit_compl AS c4 ON u.id = c4.userid
WHERE c.enablecompletion = 1 AND (p.timecompleted IS NOT NULL OR p.timecompleted !='')
AND (p.timecompleted>= :start_date AND p.timecompleted<=:end_date)
GROUP BY u.username
ORDER BY c.shortname

</code>

===Scales used in activities===
<code sql>
SELECT scale.name
,CONCAT('<a target="_new" href="%%WWWROOT%%/course/view.php?id=',c.id,'">',c.fullname,'</a>') AS Course
,CONCAT('<a target="_new" href="%%WWWROOT%%/mod/',gi.itemmodule,'/view.php?id=',cm.id,'">',gi.itemname,'</a>') AS "Module View"
,CONCAT('<a target="_new" href="%%WWWROOT%%/course/modedit.php?up','date=',cm.id,'">',gi.itemname,'</a>') AS "Module Settings"

FROM prefix_grade_items AS gi
JOIN prefix_course AS c ON c.id = gi.courseid
JOIN prefix_course_modules AS cm ON cm.course = gi.courseid AND cm.instance = gi.iteminstance
JOIN prefix_scale AS scale ON scale.id = gi.scaleid
WHERE gi.scaleid IS NOT NULL
</code>

===Extra Credit Items by Name Only===
Contributed by Eric Strom

This query identifies grade items in visible courses with student enrollment that have "extra credit" in the name of the item but set as extra credit in the grade settings. Includes the defined course start date, count of students and instructors, and a clickable email link of instructor (first found record if more than one).

<code sql>
SELECT DATE(FROM_UNIXTIME(c.startdate)) AS StartDate,
concat('<a target="_new" href="%%WWWROOT%%/grade/edit/tree/index.php',CHAR(63),'id=',
c.id,'">',c.idnumber,'</a>') AS Course_ID, gi.itemname AS Item_Name

,(SELECT COUNT( ra.userid ) FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
WHERE ra.roleid = 5 AND ctx.instanceid = c.id) AS Students

,(SELECT COUNT( ra.userid ) FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
WHERE ra.roleid = 3 AND ctx.instanceid = c.id) AS Instructors

,(SELECT DISTINCT concat('<a href="mailto:',u.email,'">',u.email,'</a>')
FROM prefix_role_assignments AS ra
JOIN prefix_user AS u ON ra.userid = u.id
JOIN prefix_context AS ctx ON ctx.id = ra.contextid
WHERE ra.roleid = 3 AND ctx.instanceid = c.id AND ctx.contextlevel = 50 LIMIT 1) AS 'Instructor_Email'

,now() AS Report_Timestamp

FROM prefix_grade_items AS gi
JOIN prefix_course AS c ON gi.courseid = c.id

WHERE gi.itemname LIKE '%extra credit%'
AND gi.gradetype = '1'
AND gi.hidden = '0'
AND gi.aggregationcoef = '0'
AND c.visible = 1
AND (SELECT COUNT( ra.userid ) FROM prefix_role_assignments AS ra JOIN prefix_context AS ctx ON ra.contextid = ctx.id WHERE ra.roleid = 5 AND ctx.instanceid = c.id) > 0

GROUP BY Course_ID, gi.id
ORDER BY StartDate, Course_ID

%%FILTER_SEARCHTEXT:Course_ID:~%%
</code>

===Site Wide Number of Courses Completed by User===
Contributed by Ken St. John

Simple report that shows the number of completed courses for all users site wide

<code sql>
SELECT u.lastname, u.firstname,
COUNT(p.timecompleted) AS TotalCompletions
FROM prefix_course_completions AS p
JOIN prefix_user AS u ON p.userid = u.id
GROUP BY p.userid
ORDER BY u.lastname
</code>

==Activity Module Reports==

=== User activity completions with dates===
Contributed by: [https://moodle.org/user/profile.php?id=88992 Randy Thornton]

This report shows the users completion status of activities across all courses. It is intended to be uses with Configurable Reports filters for user, start and end times, and also to be able to search the Module names.

Note: The CASE statement with module numbers may differ on different systems, depending on the number give to the module when the site was created or the module added to the site. These are common default numbers, but you should check your id numbers for them in the course_modules table and adjust as required. You can also add other, third-party plugins too if you wish.

<code sql>
SELECT
u.username As 'User',
c.shortname AS 'Course',
m.name AS Activitytype,
CASE
WHEN cm.module = 1 THEN (SELECT a1.name FROM prefix_assign a1 WHERE a1.id = cm.instance)
WHEN cm.module = 2 THEN (SELECT a2.name FROM prefix_assignment a2 WHERE a2.id = cm.instance)
WHEN cm.module = 3 THEN (SELECT a3.name FROM prefix_book a3 WHERE a3.id = cm.instance)
WHEN cm.module = 4 THEN (SELECT a4.name FROM prefix_chat a4 WHERE a4.id = cm.instance)
WHEN cm.module = 5 THEN (SELECT a5.name FROM prefix_choice a5 WHERE a5.id = cm.instance)
WHEN cm.module = 6 THEN (SELECT a6.name FROM prefix_data a6 WHERE a6.id = cm.instance)
WHEN cm.module = 7 THEN (SELECT a7.name FROM prefix_feedback a7 WHERE a7.id = cm.instance)
WHEN cm.module = 8 THEN (SELECT a8.name FROM prefix_folder a8 WHERE a8.id = cm.instance)
WHEN cm.module = 9 THEN (SELECT a9.name FROM prefix_forum a9 WHERE a9.id = cm.instance)
WHEN cm.module = 10 THEN (SELECT a10.name FROM prefix_glossary a10 WHERE a10.id = cm.instance)
WHEN cm.module = 11 THEN (SELECT a11.name FROM prefix_imscp a11 WHERE a11.id = cm.instance)
WHEN cm.module = 12 THEN (SELECT a12.name FROM prefix_label a12 WHERE a12.id = cm.instance)
WHEN cm.module = 13 THEN (SELECT a13.name FROM prefix_lesson a13 WHERE a13.id = cm.instance)
WHEN cm.module = 14 THEN (SELECT a14.name FROM prefix_lti a14 WHERE a14.id = cm.instance)
WHEN cm.module = 15 THEN (SELECT a15.name FROM prefix_page a15 WHERE a15.id = cm.instance)
WHEN cm.module = 16 THEN (SELECT a16.name FROM prefix_quiz a16 WHERE a16.id = cm.instance)
WHEN cm.module = 17 THEN (SELECT a17.name FROM prefix_resource a17 WHERE a17.id = cm.instance)
WHEN cm.module = 18 THEN (SELECT a18.name FROM prefix_scorm a18 WHERE a18.id = cm.instance)
WHEN cm.module = 19 THEN (SELECT a19.name FROM prefix_survey a19 WHERE a19.id = cm.instance)
WHEN cm.module = 20 THEN (SELECT a20.name FROM prefix_url a20 WHERE a20.id = cm.instance)
WHEN cm.module = 21 THEN (SELECT a21.name FROM prefix_wiki a21 WHERE a21.id = cm.instance)
WHEN cm.module = 22 THEN (SELECT a22.name FROM prefix_workshop a22 WHERE a22.id = cm.instance)
END AS Actvityname,
# cm.section AS Coursesection,
CASE
WHEN cm.completion = 0 THEN '0 None'
WHEN cm.completion = 1 THEN '1 Self'
WHEN cm.completion = 2 THEN '2 Auto'
END AS Activtycompletiontype,
CASE
WHEN cmc.completionstate = 0 THEN 'In Progress'
WHEN cmc.completionstate = 1 THEN 'Completed'
WHEN cmc.completionstate = 2 THEN 'Completed with Pass'
WHEN cmc.completionstate = 3 THEN 'Completed with Fail'
ELSE 'Unknown'
END AS 'Progress',
DATE_FORMAT(FROM_UNIXTIME(cmc.timemodified), '%Y-%m-%d %H:%i') AS 'When'
FROM prefix_course_modules_completion cmc
JOIN prefix_user u ON cmc.userid = u.id
JOIN prefix_course_modules cm ON cmc.coursemoduleid = cm.id
JOIN prefix_course c ON cm.course = c.id
JOIN prefix_modules m ON cm.module = m.id
# skip the predefined admin and guest user
WHERE u.id > 2
# config reports filters
%%FILTER_USERS:u.username%%
%%FILTER_SEARCHTEXT:m.name:~%%
%%FILTER_STARTTIME:cmc.timemodified:>%% %%FILTER_ENDTIME:cmc.timemodified:<%%

ORDER BY u.username

</code>

===How many SCORM activities are used in each Course===
<code sql>
SELECT cm.course,c.fullname ,m.name
,concat('<a target="_new" href="%%WWWROOT%%/mod/scorm/index.php?id=',c.id,'">',count(cm.id),'</a>') AS Counter

FROM `prefix_course_modules` as cm
JOIN prefix_modules as m ON cm.module=m.id
JOIN prefix_course as c ON cm.course = c.id
WHERE m.name LIKE '%scorm%'
GROUP BY cm.course,cm.module
ORDER BY count(cm.id) desc
</code>

===SCORM Usage by Course Start Date===
Contributed by Elizabeth Dalton, Granite State College

Report of number of inclusions of SCORM activities in courses, filtered by course start date.

<code sql>
SELECT

CONCAT('<a target="_blank" href="%%WWWROOT%%/course/view.php',CHAR(63),'id=',c.id,'">',c.shortname,'</a>') AS 'course'

, cc.name AS 'Category'
, scm.name AS 'Sample Activity Name'
, FROM_UNIXTIME(c.startdate) AS 'Course Start Date'
, COUNT(DISTINCT cm.id) AS 'Resources Used'
#, FROM_UNIXTIME(cm.added) AS 'resource added'

FROM prefix_course_modules AS cm
JOIN prefix_modules AS m ON cm.module = m.id AND m.name LIKE 'SCO%'

JOIN prefix_course AS c ON c.id = cm.course
JOIN prefix_course_categories AS cc ON cc.id = c.category
JOIN prefix_scorm AS scm ON scm.id = cm.instance

WHERE
1

%%FILTER_STARTTIME:c.startdate:>%%
%%FILTER_ENDTIME:c.startdate:<%%

GROUP BY c.shortname, m.name
ORDER BY c.startdate, c.shortname
</code>

=== LTI (External Tool) Usage by Course Start Date===
Contributed by Elizabeth Dalton, Granite State College

Report of number of inclusions of LTI (External Tool) Usage activities in courses, filtered by course start date.

<code sql>
SELECT

CONCAT('<a target="_blank" href="%%WWWROOT%%/course/view.php',CHAR(63),'id=',c.id,'">',c.shortname,'</a>') AS 'course'

, cc.name AS 'Category'
, lti.name AS 'Sample Activity Name'
, FROM_UNIXTIME(c.startdate) AS 'Course Start Date'
, COUNT(DISTINCT cm.id) AS 'Resources Used'
#, FROM_UNIXTIME(cm.added) AS 'resource added'

FROM prefix_course_modules AS cm
JOIN prefix_modules AS m ON cm.module = m.id AND m.name LIKE 'lti'

JOIN prefix_course AS c ON c.id = cm.course
JOIN prefix_course_categories AS cc ON cc.id = c.category
JOIN prefix_lti AS lti ON lti.id = cm.instance
WHERE
1

%%FILTER_STARTTIME:c.startdate:>%%
%%FILTER_ENDTIME:c.startdate:<%%

GROUP BY c.shortname, m.name
ORDER BY c.startdate, c.shortname
</code>

===Detailed ACTIONs for each MODULE===
<code sql>
SELECT module,action,count(id) as counter
FROM prefix_log
GROUP BY module,action
ORDER BY module,counter desc
</code>

===Most popular ACTIVITY===
<code sql>
SELECT COUNT(l.id) hits, module
FROM prefix_log l
WHERE module != 'login' AND module != 'course' AND module != 'role'
GROUP BY module
ORDER BY hits DESC
</code>

===System wide use of ACTIVITIES and RESOURCES===
<code sql>
SELECT count( cm.id ) AS counter, m.name
FROM `prefix_course_modules` AS cm
JOIN prefix_modules AS m ON cm.module = m.id
GROUP BY cm.module
ORDER BY counter DESC
</code>

===LOG file ACTIONS per MODULE per COURSE (IDs)===
<code sql>
select course,module,action,count(action) as summa from prefix_log
where action <> 'new'
group by course,action,module
order by course,module,action
</code>

===System Wide usage count of various course Activities===
(Tested and works fine in Moodle 2.x)
Like: Forum, Wiki, Blog, Assignment, Database,
#Within specific category
#Teacher name in course

<code sql>
SELECT concat('<a target="_new" href="%%WWWROOT%%/course/view.php?id=',c.id,'">',c.fullname,'</a>') as Course

,(SELECT CONCAT(u.firstname,' ', u.lastname) AS Teacher
FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
JOIN prefix_user AS u ON u.id = ra.userid
WHERE ra.roleid = 3 AND ctx.instanceid = c.id LIMIT 1) AS Teacher

,(SELECT count( m.name ) AS count FROM prefix_course_modules AS cm
JOIN prefix_modules AS m ON cm.module = m.id
WHERE cm.course = c.id AND m.name LIKE '%wiki%') AS Wikis
,(SELECT count( m.name ) AS count FROM prefix_course_modules AS cm
JOIN prefix_modules AS m ON cm.module = m.id
WHERE cm.course = c.id AND m.name LIKE '%blog%') AS Blogs

,(SELECT count( m.name ) AS count FROM
prefix_course_modules AS cm
JOIN prefix_modules AS m ON cm.module = m.id
WHERE cm.course = c.id AND m.name LIKE '%forum%') AS Forums

,(SELECT count( m.name ) AS count FROM prefix_course_modules AS cm
JOIN prefix_modules AS m ON cm.module = m.id
WHERE cm.course = c.id AND m.name LIKE '%data%') AS Databses

,(SELECT count( m.name ) AS count FROM prefix_course_modules AS cm
JOIN prefix_modules AS m ON cm.module = m.id
WHERE cm.course = c.id AND m.name LIKE '%assignment%') AS Assignments

,(SELECT Count( ra.userid ) AS Users FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
WHERE ra.roleid = 5 AND ctx.instanceid = c.id) AS Students

FROM prefix_course AS c
WHERE c.category IN ( 18)
ORDER BY Wikis DESC,Blogs DESC, Forums DESC
</code>

===Course wiki usage/activity over the last 6 semesters===
<code sql>
SELECT "Courses with Wikis"

,(SELECT count( m.name ) AS count FROM
prefix_course_modules AS cm
JOIN prefix_modules AS m ON cm.module = m.id
JOIN prefix_course AS c ON c.id = cm.course
WHERE cm.course = c.id AND m.name LIKE '%wiki%'
and c.fullname LIKE CONCAT('%','2010','%') and c.fullname LIKE '%Semester A%') AS '2010 <br/> Semester A'

,(SELECT count( m.name ) AS count FROM
prefix_course_modules AS cm
JOIN prefix_modules AS m ON cm.module = m.id
JOIN prefix_course AS c ON c.id = cm.course
WHERE cm.course = c.id AND m.name LIKE '%wiki%'
and c.fullname LIKE CONCAT('%','2010','%') and c.fullname LIKE '%Semester B%') AS '2010 <br/> Semester B'

,(SELECT count( m.name ) AS count FROM
prefix_course_modules AS cm
JOIN prefix_modules AS m ON cm.module = m.id
JOIN prefix_course AS c ON c.id = cm.course
WHERE cm.course = c.id AND m.name LIKE '%wiki%'
and c.fullname LIKE CONCAT('%','תשעא','%') and c.fullname LIKE '%סמסטר א%') AS 'תשעא <br/> סמסטר א'

,(SELECT count( m.name ) AS count FROM
prefix_course_modules AS cm
JOIN prefix_modules AS m ON cm.module = m.id
JOIN prefix_course AS c ON c.id = cm.course
WHERE cm.course = c.id AND m.name LIKE '%wiki%'
and c.fullname LIKE CONCAT('%','תשעא','%') and c.fullname LIKE '%סמסטר ב%') AS 'תשעא <br/> סמסטר ב'

,(SELECT count( m.name ) AS count FROM
prefix_course_modules AS cm
JOIN prefix_modules AS m ON cm.module = m.id
JOIN prefix_course AS c ON c.id = cm.course
WHERE cm.course = c.id AND m.name LIKE '%wiki%'
and c.fullname LIKE CONCAT('%','תשעב','%') and c.fullname LIKE '%סמסטר א%') AS 'תשעב <br/> סמסטר א'

,(SELECT count( m.name ) AS count FROM
prefix_course_modules AS cm
JOIN prefix_modules AS m ON cm.module = m.id
JOIN prefix_course AS c ON c.id = cm.course
WHERE cm.course = c.id AND m.name LIKE '%wiki%'
and c.fullname LIKE CONCAT('%','תשעב','%') and c.fullname LIKE '%סמסטר ב%') AS 'תשעב <br/> סמסטר ב'

,(SELECT count( m.name ) AS count FROM
prefix_course_modules AS cm
JOIN prefix_modules AS m ON cm.module = m.id
JOIN prefix_course AS c ON c.id = cm.course
WHERE cm.course = c.id AND m.name LIKE '%wiki%'
and c.fullname LIKE CONCAT('%','תשעג','%') and c.fullname LIKE '%סמסטר א%') AS 'תשעג <br/> סמסטר א'

,(SELECT count( m.name ) AS count FROM
prefix_course_modules AS cm
JOIN prefix_modules AS m ON cm.module = m.id
JOIN prefix_course AS c ON c.id = cm.course
WHERE cm.course = c.id AND m.name LIKE '%wiki%'
and c.fullname LIKE CONCAT('%','תשעג','%') and c.fullname LIKE '%סמסטר ב%') AS 'תשעג <br/> סמסטר ב'
</code>

===Detailed WIKI activity (per wiki per course)===
Including Number of Students in course (for reference)
<code sql>
SELECT concat('<a target="_new" href="%%WWWROOT%%/course/view.php?id=',cm.course,'">',c.fullname,'</a>') as CourseID
,(SELECT Count( ra.userid ) AS Users
FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
WHERE ra.roleid = 5 AND ctx.instanceid = c.id ) AS Students
,m.name
, ( SELECT count(id) FROM prefix_log WHERE cmid = cm.id AND action LIKE '%updat%' ) as 'UPDAT E'
, ( SELECT count(id) FROM prefix_log WHERE cmid = cm.id AND action LIKE '%annotate%' ) as ANNOTATE
, ( SELECT count(id) FROM prefix_log WHERE cmid = cm.id AND action LIKE '%comment%' ) as COMMENT
, ( SELECT count(id) FROM prefix_log WHERE cmid = cm.id AND action LIKE '%add%' ) as 'A DD'
, ( SELECT count(id) FROM prefix_log WHERE cmid = cm.id AND action LIKE '%edit%' ) as EDIT
, ( SELECT count(id) FROM prefix_log WHERE cmid = cm.id AND action NOT LIKE '%view%' ) as 'All (NO View)'
FROM `prefix_course_modules` as cm
JOIN prefix_modules as m ON cm.module=m.id
JOIN prefix_course as c ON cm.course = c.id
WHERE m.name LIKE '%wiki%'
GROUP BY cm.course,cm.module
ORDER BY 'All (NO View)' DESC
</code>

===Wiki usage, system wide===
(you can filter the output by selecting some specific course categories : "WHERE c.category IN ( 8,13,15)")

<code sql>
SELECT concat('<a target="_new" href="%%WWWROOT%%/course/view.php?id=',c.id,'">',c.fullname,'</a>') as Course

,(SELECT count( m.name ) AS count FROM prefix_course_modules AS cm
JOIN prefix_modules AS m ON cm.module = m.id
WHERE cm.course = c.id AND m.name LIKE '%wiki%') AS Wikis

,(SELECT count(*) FROM prefix_log as l WHERE l.course = c.id AND l.module LIKE '%wiki%') AS 'WikiActivity<br/>ALL'

,(SELECT count(*) FROM prefix_log as l WHERE l.course = c.id AND l.module LIKE '%wiki%' and l.action LIKE '%add%' ) AS 'WikiActivity<br/>ADD'

,(SELECT count(*) FROM prefix_log as l WHERE l.course = c.id AND l.module LIKE '%wiki%' and l.action LIKE '%edit%' ) AS 'WikiActivity<br/>EDIT'

,(SELECT count(*) FROM prefix_log as l WHERE l.course = c.id AND l.module LIKE '%wiki%' and l.action LIKE '%annotate%' ) AS 'WikiActivity<br/>ANNOTATE'

,(SELECT count(*) FROM prefix_log as l WHERE l.course = c.id AND l.module LIKE '%wiki%' and l.action LIKE '%comments%' ) AS 'WikiActivity<br/>Comments'

,(SELECT Count( ra.userid ) AS Users FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
WHERE ra.roleid = 5 AND ctx.instanceid = c.id) AS Students

,(SELECT count(*) FROM prefix_ouwiki_pages as ouwp
JOIN prefix_ouwiki as ouw ON ouw.id = ouwp.subwikiid
WHERE ouw.course = c.id GROUP BY ouw.course ) as OUWikiPages

,(SELECT count( DISTINCT nwp.pagename ) FROM prefix_wiki_pages AS nwp
JOIN prefix_wiki AS nw ON nw.id = nwp.dfwiki WHERE nw.course = c.id ) As NWikiPages

FROM prefix_course AS c
WHERE c.category IN ( 8,13,15)
HAVING Wikis > 0
ORDER BY 'WikiActivity<br/>ALL' DESC
</code>

===Aggregated Teacher activity by "WEB2" Modules===
(Tested and works fine in Moodle 2.x)
The NV column shows activity without VIEW log activity
<code sql>
SELECT ra.userid, u.firstname,u.lastname
,(SELECT count(*) FROM prefix_log as l WHERE l.userid = u.id AND l.module LIKE '%wiki%') AS Wiki
,(SELECT count(*) FROM prefix_log as l WHERE l.userid = u.id AND l.module LIKE '%wiki%' AND l.action NOT LIKE '%view%') AS Wiki_NV
,(SELECT count(*) FROM prefix_log as l WHERE l.userid = u.id AND l.module LIKE '%forum%') AS Forum
,(SELECT count(*) FROM prefix_log as l WHERE l.userid = u.id AND l.module LIKE '%forum%' AND l.action NOT LIKE '%view%') AS Forum_NV
,(SELECT count(*) FROM prefix_log as l WHERE l.userid = u.id AND l.module LIKE '%blog%') AS Blog
,(SELECT count(*) FROM prefix_log as l WHERE l.userid = u.id AND l.module LIKE '%blog%' AND l.action NOT LIKE '%view%') AS Blog_NV
,(SELECT count(*) FROM prefix_log as l WHERE l.userid = u.id AND l.module LIKE '%assignment%') AS Assignment
,(SELECT count(*) FROM prefix_log as l WHERE l.userid = u.id AND l.module LIKE '%assignment%' AND l.action NOT LIKE '%view%') AS Assignment_NV
FROM prefix_role_assignments AS ra
JOIN prefix_user AS u ON u.id = ra.userid
WHERE ra.roleid = 3
GROUP BY ra.userid
</code>

===List all the certificates issued, sort by variables in the custom profile fields===
Note: The SQL queries look intimidating at first, but isn't really that difficult to learn. I've seen in the forums that users wanted to do 'site-wide' groups in 1.9x. This is sort of the idea. It pulls all the certificates issued to all users sorted by the custom profile fields, which in my case is the Units or Depts (i.e. my site wide groups). Why certificates? I've explored with both grades and quizzes, the course admins are not really interested in the actual grades but whether the learner received a certificate (i.e. passed the course with x, y, z activities). It also saves me from creating groups and assigning them into the right groups. Even assigning in bulk is not efficient, since I have upward of 25 groups per course and constantly new learners enrolling in courses. The limitation is something to do with the server? as it only pull 5000 rows of data. If anyone figured out how to change this, please let me know. In the meantime, the work around is to pull only a few units/depts at a time to limit the number of rows. This is fine at the moment, since each course admin are only responsible for certain units/depts.

<code sql>
SELECT
DATE_FORMAT( FROM_UNIXTIME(prefix_certificate_issues.timecreated), '%Y-%m-%d' ) AS Date,
prefix_certificate_issues.classname AS Topic,
prefix_certificate.name AS Certificate,
prefix_certificate_issues.studentname as Name,
prefix_user_info_data.data AS Units

FROM
prefix_certificate_issues

INNER JOIN prefix_user_info_data
on prefix_certificate_issues.userid = prefix_user_info_data.userid

INNER JOIN prefix_certificate
on prefix_certificate_issues.certificateid = prefix_certificate.id

WHERE prefix_user_info_data.data='Unit 1'
OR prefix_user_info_data.data='Unit 2'
OR prefix_user_info_data.data='Unit 3'

ORDER BY Units, Name, Topic ASC
</code>

=== All Simple Certificates Earned in the Site===

Contributed by: [https://moodle.org/user/profile.php?id=88992 Randy Thornton]

Basic report of all certificates earned with the Simple Certificate plugin module in the whole site, sorted by most recent first. (Note: this uses the MySQL [http://www.mysqltutorial.org/mysql-date_format/ DATE_FORMAT] function.)

<code sql>
SELECT
CONCAT (u.firstname, ' ',u.lastname) As 'User',
c.fullname AS 'Course',
sc.name AS 'Certificate',
DATE_FORMAT( FROM_UNIXTIME(sci.timecreated), '%Y-%m-%d' ) As 'Date Awarded'
# sci.code 'CertificateId'
FROM prefix_simplecertificate_issues sci
JOIN prefix_user u ON sci.userid = u.id
JOIN prefix_simplecertificate sc ON sci.certificateid = sc.id
JOIN prefix_course AS c ON sc.course = c.id
ORDER BY sci.timecreated DESC
</code>

If you want to limit this to the most recent ones, you can add a condition to limit it to a certain number of days past. For example, adding this WHERE clause (above the ORDER BY) will show only those earned in the last 30 days:
<code sql>
WHERE DATEDIFF(NOW(),FROM_UNIXTIME(sci.timecreated) ) < 30
</code>

===Counter Blog usage in Courses,system wide===
What teachers in what courses, uses blogs and how many + student count in that course.
<code sql>

SELECT ( @counter := @counter+1) as counter,
concat('<a target="_new" href="%%WWWROOT%%/course/view.php?id=',c.id,'">',c.fullname,'</a>') as Course

,( SELECT DISTINCT CONCAT(u.firstname,' ',u.lastname)
FROM prefix_role_assignments AS ra
JOIN prefix_user AS u ON ra.userid = u.id
JOIN prefix_context AS ctx ON ctx.id = ra.contextid
WHERE ra.roleid = 3 AND ctx.instanceid = c.id AND ctx.contextlevel = 50 LIMIT 1) AS Teacher

,(SELECT count( m.name ) AS count FROM prefix_course_modules AS cm
JOIN prefix_modules AS m ON cm.module = m.id
WHERE cm.course = c.id AND m.name LIKE '%blog%') AS Blogs

,(SELECT Count( ra.userid ) AS Users FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
WHERE ra.roleid = 5 AND ctx.instanceid = c.id) AS Students

FROM prefix_course AS c, (SELECT @counter := 0) as s_init
WHERE c.category IN ( 8,13,15)
HAVING Blogs > 0
ORDER BY Blogs DESC
</code>

=== Elluminate (Blackboard Collaborate) - system wide usage===
<code sql>
SELECT e.name As Session ,er.recordingsize
,c.fullname As Course
,u.firstname,u.lastname
,DATE_FORMAT(FROM_UNIXTIME(e.timestart),'%d-%m-%Y') AS dTimeStart
,concat('<a target="_new" href="%%WWWROOT%%/moodle/mod/elluminate/loadrecording.php?id=',er.id,'">Show</a>') AS RecordedSession

FROM prefix_elluminate_recordings AS er
JOIN prefix_elluminate AS e ON e.meetingid = er.meetingid
JOIN prefix_course as c ON c.id = e.course
JOIN prefix_user AS u ON u.id = e.creator
ORDER BY er.recordingsize DESC
</code>

=== Choice ===

Contributed by: [https://moodle.org/user/profile.php?id=88992 Randy Thornton]

Results of the Choice activity. For all courses, shows course shortname, username, the Choice text, and the answer chosen by the user.

<code sql>
SELECT c.shortname AS course, u.username, h.name as question, o.text AS answer
FROM prefix_choice AS h
JOIN prefix_course AS c ON h.course = c.id
JOIN prefix_choice_answers AS a ON h.id = a.choiceid
JOIN prefix_user AS u ON a.userid = u.id
JOIN prefix_choice_options AS o ON a.optionid = o.id
</code>

=== Assignment type usage in courses ===
<code sql>
SELECT

CONCAT('<a target="_new" href="%%WWWROOT%%/mod/assign/index.php?id=',c.id,'">',c.fullname,'</a>') AS "List assignments"

,(SELECT COUNT(*) FROM prefix_assign WHERE c.id = course) AS Assignments

,(SELECT COUNT(*)
FROM prefix_assign_plugin_config AS apc
JOIN prefix_assign AS iassign ON iassign.id = apc.assignment
WHERE iassign.course = c.id AND apc.plugin = 'file' AND apc.subtype = 'assignsubmission' AND apc.name = 'enabled' AND apc.value = '1'
#GROUP BY apc.plugin
) AS "File Assignments"

,(SELECT COUNT(*)
FROM prefix_assign_plugin_config AS apc
JOIN prefix_assign AS iassign ON iassign.id = apc.assignment
WHERE iassign.course = c.id AND apc.plugin = 'onlinetext' AND apc.subtype = 'assignsubmission' AND apc.name = 'enabled' AND apc.value = '1'
) AS "Online Assignments"

,(SELECT COUNT(*)
FROM prefix_assign_plugin_config AS apc
JOIN prefix_assign AS iassign ON iassign.id = apc.assignment
WHERE iassign.course = c.id AND apc.plugin = 'pdf' AND apc.subtype = 'assignsubmission' AND apc.name = 'enabled' AND apc.value = '1'
) AS "PDF Assignments"

,(SELECT COUNT(*)
FROM prefix_assign_plugin_config AS apc
JOIN prefix_assign AS iassign ON iassign.id = apc.assignment
WHERE iassign.course = c.id AND apc.plugin = 'offline' AND apc.subtype = 'assignsubmission' AND apc.name = 'enabled' AND apc.value = '1'
) AS "Offline Assignments"

,(SELECT COUNT(*)
FROM prefix_assign_plugin_config AS apc
JOIN prefix_assign AS iassign ON iassign.id = apc.assignment
WHERE iassign.course = c.id AND apc.plugin = 'comments' AND apc.subtype = 'assignsubmission' AND apc.name = 'enabled' AND apc.value = '1'
) AS "Assignments Comments"

FROM prefix_assign AS assign
JOIN prefix_course AS c ON c.id = assign.course
GROUP BY c.id
</code>

==Assignment Module Reports==
===All Ungraded Assignments===

'''NOTE: This query is for the deprecated old Assignment module from Moodle 2.2, not the new Assignments module. Please update this query if you are the author or it will be removed as the 2.2 Assignment module is no longer supported since release 2.7.
''' See: [https://docs.moodle.org/dev/Moodle_2.7_release_notes#Assignment]

Returns all the submitted assignments that still need grading
<code sql>
select
u.firstname AS "First",
u.lastname AS "Last",
c.fullname AS "Course",
a.name AS "Assignment"

from prefix_assignment_submissions as asb
join prefix_assignment as a ON a.id = asb.assignment
join prefix_user as u ON u.id = asb.userid
join prefix_course as c ON c.id = a.course
join prefix_course_modules as cm ON c.id = cm.course

where asb.grade < 0 and cm.instance = a.id
and cm.module = 1

order by c.fullname, a.name, u.lastname
</code>

===All Ungraded Assignments w/ Link===

'''NOTE: This query is for the deprecated old Assignment module from Moodle 2.2, not the new Assignments module. Please update this query if you are the author or it will be removed as the 2.2 Assignment module is no longer supported since release 2.7.
''' See: [https://docs.moodle.org/dev/Moodle_2.7_release_notes#Assignment]

Returns all the submitted assignments that still need grading, along with a link that goes directly to the submission to grade it. The links work if you view the report within Moodle.
<code sql>
select
u.firstname AS "First",
u.lastname AS "Last",
c.fullname AS "Course",
a.name AS "Assignment",

'<a href="http://education.varonis.com/mod/assignment/submissions.php' + char(63) +
+ 'id=' + cast(cm.id as varchar) + '&userid=' + cast(u.id as varchar)
+ '&mode=single&filter=0&offset=2">' + a.name + '</a>'
AS "Assignmentlink"

from prefix_assignment_submissions as asb
join prefix_assignment as a ON a.id = asb.assignment
join prefix_user as u ON u.id = asb.userid
join prefix_course as c ON c.id = a.course
join prefix_course_modules as cm ON c.id = cm.course

where asb.grade < 0 and cm.instance = a.id and cm.module = 1

order by c.fullname, a.name, u.lastname
</code>

===Assignments (and Quizzes) waiting to be graded===

'''NOTE: This query is for the deprecated old Assignment module from Moodle 2.2, not the new Assignments module. Please update this query if you are the author or it will be removed as the 2.2 Assignment module is no longer supported since release 2.7.
''' See: [https://docs.moodle.org/dev/Moodle_2.7_release_notes#Assignment]

This report requires a YEAR filter to be added (Available when using the latest block/configurable_reports)

Which you can always remove, to make this query work on earlier versions.

The report includes:
*number of quizzes
*unFinished Quiz attempts
*Finished Quiz attempts
*number of students
*number of Assignments
*number of submitted answers by students
*number of unchecked assignments (waiting for the Teacher) in a Course.

<code sql>
SELECT concat('<a target="_new" href="%%WWWROOT%%/course/view.php?id=',c.id,'">',c.fullname,'</a>') AS Course

,(SELECT CONCAT(u.firstname,' ', u.lastname) AS Teacher
FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
JOIN prefix_user AS u ON u.id = ra.userid
WHERE ra.roleid = 3 AND ctx.instanceid = c.id LIMIT 1) AS Teacher

,concat('<a target="_new" href="%%WWWROOT%%/mod/assignment/index.php?id=',c.id,'">מטלות</a>') AS Assignments

,concat('<a target="_new" href="%%WWWROOT%%/mod/quiz/index.php?id=',c.id,'">בחנים</a>') AS 'Quizzes'

,(SELECT COUNT(*)
FROM prefix_course_modules cm
JOIN prefix_modules as m ON m.id = cm.module
WHERE m.name LIKE 'quiz' AND cm.course = c.id
GROUP BY cm.course
) AS 'nQuizzes'

,(SELECT COUNT(*)
FROM prefix_quiz_attempts AS qa
JOIN prefix_quiz AS q ON q.id = qa.quiz
WHERE q.course = c.id
AND qa.timefinish = 0
GROUP BY q.course) AS 'unFinished Quiz attempts'

,(SELECT COUNT(*)
FROM prefix_quiz_attempts AS qa
JOIN prefix_quiz AS q ON q.id = qa.quiz
WHERE q.course = c.id
AND qa.timefinish > 0
GROUP BY q.course) AS 'finished quiz attempts'

,(SELECT Count( ra.userid ) AS Users
FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
WHERE ra.roleid = 5
AND ctx.instanceid = c.id
) AS nStudents

,(
SELECT count(a.id)
FROM prefix_assignment AS a
JOIN prefix_course_modules AS cm ON a.course = cm.course
WHERE cm.instance = a.id AND cm.module = 1 AND a.course = c.id
) nAssignments

,(
SELECT count(*)
FROM prefix_assignment AS a
WHERE a.course = c.id AND FROM_UNIXTIME(a.timedue) > NOW()
GROUP BY a.course
) 'Open <br/>Assignments'

, CONCAT(ROUND( (100 / iAssignments ) * iOpenAssignments ) ,'%') 'unFinished <br/>Assignments <br/>(percent)'

,(
SELECT count(asb.id)
FROM prefix_assignment_submissions AS asb
JOIN prefix_assignment AS a ON a.id = asb.assignment
JOIN prefix_course_modules AS cm ON a.course = cm.course
WHERE asb.grade < 0 AND cm.instance = a.id AND cm.module = 1 AND a.course = c.id
) 'unChecked <br/>Submissions'

,(
SELECT count(asb.id)
FROM prefix_assignment_submissions AS asb
JOIN prefix_assignment AS a ON a.id = asb.assignment
JOIN prefix_course_modules AS cm ON a.course = cm.course
WHERE cm.instance = a.id AND cm.module = 1 AND a.course = c.id
) 'Submitted <br/>Assignments'

FROM prefix_course AS c
LEFT JOIN (
SELECT course, count(*) AS iAssignments
FROM prefix_assignment AS a
GROUP BY a.course
) AS tblAssignmentsCount ON tblAssignmentsCount.course = c.id

LEFT JOIN (
SELECT course, count(*) AS iOpenAssignments
FROM prefix_assignment AS a
WHERE FROM_UNIXTIME(a.timedue) > NOW()
GROUP BY a.course
) AS tblOpenAssignmentsCount ON tblOpenAssignmentsCount.course = c.id

WHERE 1=1
#AND c.fullname LIKE '%תשעג%'
%%FILTER_YEARS:c.fullname%%
## You can enable the SEMESTER filter as well,
## by uncommenting the following line:
## %%FILTER_SEMESTERS:c.fullname%%
ORDER BY 'Open <br/>Assignments' DESC
</code>

===Rubrics without zero values in criteria===
Contributed by Eric Strom

Rubric calculations in Moodle can fail to align with instructors expectations if they lack a zero value for each criterion used in the assessment. From documentation at https://docs.moodle.org/32/en/Rubrics#Grade_calculation:

"For example, when the teacher in the previous example chose both levels with 1 point, the plain sum would be 2 points. But that is actually the lowest possible score so it maps to the grade 0 in Moodle.
TIP: To avoid confusion from this sort of thing, we recommend including a level with 0 points in every rubric criterion."

This report identifies rubrics having criteria without a zero value level and the courses they live in. This also refines to only assignments with active rubrics that are visible to students in the course. Links to the each rubric id is the direct link to edit the rubric. Fix by adding a zero level for each criteria that is missing it. In general, the grading changes that result will be in the students' favor.

Includes search filter of course idnumber.

<code sql>
SELECT cat.name AS Department, concat('<a target="_new" href="%%WWWROOT%%/course/view.php',CHAR(63),'id=',
c.id,'">',c.idnumber,'</a>') AS Course_ID,
c.fullname AS Course_Name,
concat('<a target="_new" href="%%WWWROOT%%/grade/grading/form/rubric/edit.php',CHAR(63),'areaid=',gd.areaid,'">',gd.areaid,'</a>') AS Rubric
FROM prefix_course AS c
JOIN prefix_course_categories AS cat
ON cat.id = c.category
JOIN prefix_course_modules AS cm
ON c.id=cm.course
JOIN prefix_context AS ctx
ON cm.id = ctx.instanceid
JOIN prefix_grading_areas AS garea
ON ctx.id = garea.contextid
JOIN prefix_grading_definitions AS gd
ON garea.id = gd.areaid
JOIN prefix_gradingform_rubric_criteria AS crit
ON gd.id = crit.definitionid
JOIN prefix_gradingform_rubric_levels AS levels
ON levels.criterionid = crit.id
WHERE cm.visible='1' AND garea.activemethod = 'rubric' AND (crit.id NOT IN
(SELECT crit.id
FROM prefix_gradingform_rubric_criteria AS crit
JOIN prefix_gradingform_rubric_levels AS levels
ON levels.criterionid = crit.id WHERE levels.score = '0'))

GROUP BY Rubric
ORDER BY Course_ID, Rubric

%%FILTER_SEARCHTEXT:c.idnumber:~%%
</code>

===Who is using "Single File Upload" assignment===
<code sql>
SELECT
concat('<a target="_new" href="%%WWWROOT%%/course/view.php?id=',c.id,'">',c.fullname,'</a>') AS Course

,(SELECT CONCAT(u.firstname,' ', u.lastname) AS Teacher
FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
JOIN prefix_user AS u ON u.id = ra.userid
WHERE ra.roleid = 3 AND ctx.instanceid = c.id LIMIT 1) AS Teacher

,ass.name as "Assignment Name"

FROM
prefix_assignment as ass

JOIN
prefix_course as c ON c.id = ass.course

WHERE `assignmenttype` LIKE 'uploadsingle'
</code>

==Feedback Module Reports==
===List the answers to all the Feedback activities within the current course, submitted by the current user===
<code sql>
SELECT /* crs.fullname as "Course name", f.name AS "Journal name", CONCAT(u.firstname,' ',UPPER(u.lastname)) as "Participant", */ /* include these fields if you want to check the composition of the recordset */
DATE_FORMAT(FROM_UNIXTIME(c.timemodified),'%W %e %M, %Y') as "Answer Date",
CASE i.typ WHEN 'label' THEN i.presentation ELSE i.name END as "Topic", /* usually labels are used as section titles, so you'd want them present in the recordset */
v.value as "My Answer"

FROM prefix_feedback AS f
INNER JOIN prefix_course as crs on crs.id=f.course %%FILTER_COURSES:f.course%%
INNER JOIN prefix_feedback_item AS i ON f.id=i.feedback
INNER JOIN prefix_feedback_completed AS c on f.id=c.feedback %%FILTER_COURSEUSER:c.userid%%
LEFT JOIN prefix_feedback_value AS v on v.completed=c.id AND v.item=i.id
INNER JOIN prefix_user AS u on c.userid=u.id

WHERE c.id = %%COURSEID%% AND u.id = %%USERID%% AND c.anonymous_response = 1 /* This clause limits the recordset to the current course and the current user and includes/ excludes the anonymous responses as needed */

ORDER BY f.id, c.timemodified, i.id
</code>

===Show all Feedbacks from all courses for all users including showing names of anonymous users===

Contributed by: [https://moodle.org/user/profile.php?id=88992 Randy Thornton]

Shows all Feedbacks in all Courses with all multi-choice questions and answers of all users including showing the username of anonymous users. Also shows tryly anonymous users on the front page as 'Not-logged-in' users. This is a rough report, not a pretty report, and is limited to multiple-choice type questions, but is shows the answer number and the list of possible answers in raw form. I post it here as a basis for further reports, and also as away to get the identities of anonymous users if needed.

<code sql>
SELECT
c.shortname AS Course,
f.name AS Feedback,
# i.id AS Itemid,
i.name AS Itemname,
i.label AS Itemlabel,
CASE
WHEN f.anonymous = 1 AND u.id != 0 THEN CONCAT(u.username, ' :ANON')
WHEN fc.userid = 0 THEN 'Not-logged-in'
ELSE u.username
END AS 'User',
DATE_FORMAT(FROM_UNIXTIME(fc.timemodified),'%Y-%m-%d %H:%i') AS "Completed",
v.value AS "Choice",
CASE
WHEN i.typ = 'multichoice' THEN
IF ( SUBSTRING(i.presentation,1,6)='d>>>>>',
SUBSTRING(i.presentation,7),
i.presentation)
ELSE i.presentation
END AS "Answers",
i.typ,
i.dependitem,
i.dependvalue

FROM prefix_feedback f
JOIN prefix_course c ON c.id=f.course
JOIN prefix_feedback_item AS i ON f.id=i.feedback
JOIN prefix_feedback_completed fc ON f.id=fc.feedback
LEFT JOIN prefix_feedback_value v ON v.completed=fc.id AND v.item=i.id
LEFT JOIN prefix_user AS u ON fc.userid=u.id
WHERE i.typ != 'pagebreak'
</code>

==Resource Module Reports==
===List "Recently uploaded files"===
see what users are uploading
<code sql>
SELECT FROM_UNIXTIME(time,'%Y %M %D %h:%i:%s') as time ,ip,userid,url,info
FROM `prefix_log`
WHERE `action` LIKE 'upload'
ORDER BY `prefix_log`.`time` DESC
</code>

===List Courses that loaded a specific file: "X"===
Did the Teacher (probably) uploaded course's Syllabus ?
<code sql>
SELECT c.id, c.fullname FROM `prefix_log` as l
JOIN prefix_course as c ON c.id = l.course
WHERE `action` LIKE '%upload%' AND ( info LIKE '%Syllabus%' OR info LIKE '%Sylabus%' ) GROUP BY c.id
</code>

===All resources that link to some specific external website===
+ link to course
+ who's the teacher
+ link to external resource
<code sql>
SELECT
concat('<a target="_new" href="%%WWWROOT%%/course/view.php?id=',c.id,'">',c.fullname,'</a>') AS Course
,c.shortname,r.name
,(SELECT CONCAT(u.firstname,' ', u.lastname) AS Teacher
FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
JOIN prefix_user AS u ON u.id = ra.userid
WHERE ra.roleid = 3 AND ctx.instanceid = c.id LIMIT 1) AS Teacher
,concat('<a target="_new" href="%%WWWROOT%%/mod/resource/view.php?id=',r.id,'">',r.name,'</a>') AS Resource
FROM prefix_resource AS r
JOIN prefix_course AS c ON r.course = c.id
WHERE r.reference LIKE 'http://info.oranim.ac.il/home%'
</code>

==="Compose Web Page" RESOURCE count===
<code sql>
SELECT course,prefix_course.fullname, COUNT(*) AS Total
FROM `prefix_resource`
JOIN `prefix_course` ON prefix_course.id = prefix_resource.course
WHERE type='html'
GROUP BY course
</code>

===Resource count in courses===
+ (First)Teacher name
+ Where course is inside some specific Categories
<code sql>
SELECT
COUNT(*) AS count
,r.course
,c.shortname shortname
,c.fullname coursename
,( SELECT DISTINCT CONCAT(u.firstname,' ',u.lastname)
FROM prefix_role_assignments AS ra
JOIN prefix_user as u ON ra.userid = u.id
JOIN prefix_context AS ctx ON ctx.id = ra.contextid
WHERE ra.roleid = 3 AND ctx.instanceid = r.course AND ctx.contextlevel = 50 LIMIT 1) AS Teacher
FROM prefix_resource r
JOIN prefix_course c ON r.course = c.id
WHERE c.category IN (10,13,28,18,26)
GROUP BY r.course
ORDER BY COUNT(*) DESC
</code>

===Delete all the automated backup files===
Prepare bash cli script to delete all the automated backup files on the file system. (clean up some disk space)
<code sql>
SELECT CONCAT( 'rm -f /var/moodledatanew/filedir/', SUBSTRING( contenthash, 1, 2 ) , '/', SUBSTRING( contenthash, 3, 2 ) , '/', contenthash )
FROM `mdl_files`
WHERE `filename` LIKE '%mbz%'
AND filearea = 'automated'
</code>

Find out how much disk space is used by all automated backup files:
<code sql>
SELECT SUM(filesize)/(1024*1024*1024) FROM `mdl_files` WHERE `filename` LIKE '%mbz%' AND filearea = 'automated'
</code>

==Forum Module Reports==
===print all User's post in course Forums===
%%COURSEID%% is a variable the is replace by the current CourseID you are running the sql report from. if you are using the latest block/configurable_reports ! (You can always change it to a fixed course or remove it to display all courses.)
<code sql>
SELECT
concat('<a target="_new" href="%%WWWROOT%%/mod/forum/user.php?course=',c.id,'&id=',u.id,'&mode=posts">',CONCAT(u.firstname,' ', u.lastname),'</a>') As Fullname
,concat('<a target="_new" href="%%WWWROOT%%/mod/forum/view.php?f=',fd.forum,'">',f.name,'</a>') AS Forum
,count(*) as Posts
,(SELECT count(*) FROM prefix_forum_discussions AS ifd JOIN prefix_forum as iforum ON iforum.id = ifd.forum WHERE ifd.userid = fp.userid AND iforum.id = f.id) AS cAllDiscussion

FROM prefix_forum_posts AS fp
JOIN prefix_user as u ON u.id = fp.userid
JOIN prefix_forum_discussions AS fd ON fp.discussion = fd.id
JOIN prefix_forum AS f ON f.id = fd.forum
JOIN prefix_course as c ON c.id = fd.course
WHERE fd.course = %%COURSEID%%
GROUP BY f.id,u.id
ORDER BY u.id
</code>

===FORUM use Count per COURSE -- not including NEWS Forum!===
<code sql>
SELECT prefix_course.fullname, prefix_forum.course, count(*) as total FROM prefix_forum
INNER JOIN prefix_course
ON prefix_course.id = prefix_forum.course
WHERE NOT(prefix_forum.type = 'news')
GROUP BY prefix_forum.course
ORDER BY total desc
</code>

===FORUM use Count per COURSE by type -- not including NEWS Forum!===
<code sql>
SELECT prefix_course.fullname, prefix_forum.course, prefix_forum.type, count(*) as total FROM prefix_forum
INNER JOIN prefix_course
ON prefix_course.id = prefix_forum.course
WHERE NOT(prefix_forum.type = 'news')
GROUP BY prefix_forum.course,prefix_forum.type
ORDER BY total desc
</code>

===Forum activity - system wide===
<code sql>
SELECT concat('<a target="_new" href="%%WWWROOT%%/course/view.php?id=',c.id,'">',c.id,'</a>') AS CourseID
,( SELECT DISTINCT CONCAT(u.firstname,' ',u.lastname)
FROM prefix_role_assignments AS ra
JOIN prefix_user AS u ON ra.userid = u.id
JOIN prefix_context AS ctx ON ctx.id = ra.contextid
WHERE ra.roleid = 3 AND ctx.instanceid = c.id AND ctx.contextlevel = 50 LIMIT 1) AS Teacher
,c.fullname as Course
,f.type
,(SELECT Count( ra.userid ) AS Users FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
WHERE ra.roleid = 5 AND ctx.instanceid = c.id) AS Students
, fd.forum, f.name,count(*) AS cPostAndDisc
,(SELECT count(*) FROM prefix_forum_discussions AS ifd WHERE ifd.forum = f.id) AS cDiscussion
FROM prefix_forum_posts AS fp
JOIN prefix_forum_discussions AS fd ON fd.id = fp.discussion
JOIN prefix_forum AS f ON f.id = fd.forum
JOIN prefix_course AS c ON c.id = f.course
WHERE f.type != 'news' AND c.fullname LIKE '%2013%'
## WHERE 1=1
## %%FILTER_YEARS:c.fullname%%
## You can enable the SEMESTER filter as well,
## by uncommenting the following line:
## %%FILTER_SEMESTERS:c.fullname%%

GROUP BY fd.forum
ORDER BY count( * ) DESC
</code>

===Activity In Forums===
Trying to figure out how much real activity we have in Forums by aggregating:
Users in Course, Number of Posts, Number of Discussions, Unique student post, Unique student discussions, Number of Teachers , Number of Students, ratio between unique Student posts and the number of students in the Course...
<code sql>
SELECT c.fullname,f.name,f.type
,(SELECT count(id) FROM prefix_forum_discussions as fd WHERE f.id = fd.forum) as Discussions
,(SELECT count(distinct fd.userid) FROM prefix_forum_discussions as fd WHERE fd.forum = f.id) as UniqueUsersDiscussions
,(SELECT count(fp.id) FROM prefix_forum_discussions fd JOIN prefix_forum_posts as fp ON fd.id = fp.discussion WHERE f.id = fd.forum) as Posts
,(SELECT count(distinct fp.userid) FROM prefix_forum_discussions fd JOIN prefix_forum_posts as fp ON fd.id = fp.discussion WHERE f.id = fd.forum) as UniqueUsersPosts
,(SELECT Count( ra.userid ) AS Students
FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
WHERE ra.roleid =5
AND ctx.instanceid = c.id
) AS StudentsCount
,(SELECT Count( ra.userid ) AS Teachers
FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
WHERE ra.roleid =3
AND ctx.instanceid = c.id
) AS 'Teacher<br/>Count'
,(SELECT Count( ra.userid ) AS Users
FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
WHERE ra.roleid IN (3,5)
AND ctx.instanceid = c.id
) AS UserCount
, (SELECT (UniqueUsersDiscussions / StudentsCount )) as StudentDissUsage
, (SELECT (UniqueUsersPosts /StudentsCount)) as StudentPostUsage
FROM prefix_forum as f
JOIN prefix_course as c ON f.course = c.id
WHERE `type` != 'news'
ORDER BY StudentPostUsage DESC
</code>

===All Forum type:NEWS===
<code sql>
SELECT f.id, f.name
FROM prefix_course_modules AS cm
JOIN prefix_modules AS m ON cm.module = m.id
JOIN prefix_forum AS f ON cm.instance = f.id
WHERE m.name = 'forum'
AND f.type = 'news'
</code>

===All new forum NEWS items (discussions) from all my Courses===
change "userid = 26" and "id = 26" to a new user id
<code sql>
SELECT c.shortname,f.name,fd.name,FROM_UNIXTIME(fd.timemodified ,"%d %M %Y ") as Date
FROM prefix_forum_discussions as fd
JOIN prefix_forum as f ON f.id = fd.forum
JOIN prefix_course as c ON c.id = f.course
JOIN prefix_user_lastaccess as ul ON (c.id = ul.courseid AND ul.userid = 26)
WHERE fd.timemodified > ul.timeaccess
AND fd.forum IN (SELECT f.id
FROM prefix_course_modules AS cm
JOIN prefix_modules AS m ON cm.module = m.id
JOIN prefix_forum AS f ON cm.instance = f.id
WHERE m.name = 'forum'
AND f.type = 'news')
AND c.id IN (SELECT c.id
FROM prefix_course AS c
JOIN prefix_context AS ctx ON c.id = ctx.instanceid
JOIN prefix_role_assignments AS ra ON ra.contextid = ctx.id
JOIN prefix_user AS u ON u.id = ra.userid
WHERE u.id = 26) ORDER BY `fd`.`timemodified` DESC
</code>

===News Forum - Discussions COUNT===
Which is actually... How much instructions students get from their teachers
<code sql>
SELECT c.shortname ,
concat('<a target="_new" href="%%WWWROOT%%/course/view.php?id=',c.id,'">',c.fullname,'</a>') AS Course
,( SELECT DISTINCT CONCAT(u.firstname,' ',u.lastname)
FROM prefix_role_assignments AS ra
JOIN prefix_user AS u ON ra.userid = u.id
JOIN prefix_context AS ctx ON ctx.id = ra.contextid
WHERE ra.roleid = 3 AND ctx.instanceid = c.id AND ctx.contextlevel = 50 LIMIT 1) AS Teacher
,concat('<a target="_new" href="%%WWWROOT%%/mod/forum/view.php?f=',fd.forum,'">',count(fd.id),'</a>') AS DiscussionsSum
FROM prefix_forum_discussions AS fd
INNER JOIN prefix_forum AS f ON f.id = fd.forum
INNER JOIN prefix_course AS c ON c.id = f.course
WHERE f.type = 'news' AND c.category IN (10,13,28,18,26)
GROUP BY fd.forum
ORDER BY count(fd.id) DESC
</code>

===Cantidad de foros que han sido posteados por profesor===

(Number of forums that have been posted by teacher/Google translator)

Queriamos saber cuales son las acciones del profesor dentro de los foros de cada curso, por ello se hizo este informe.

(We wanted to know what the teacher's actions are in the forums of each course, so this report was made. /Google translator)
<code sql>
SELECT
concat('<a target="_new" href="%%WWWROOT%%/course/view.php?id=',c.id,'">',c.shortname,'</a>') AS curso,
CONCAT(u.firstname ,' ',u.lastname) AS Facilitador,

(SELECT COUNT( m.name ) AS COUNT FROM
prefix_course_modules AS cm
JOIN prefix_modules AS m ON cm.module = m.id
WHERE cm.course = c.id AND m.name LIKE '%forum%') AS foros,

COUNT(*) AS Posts

FROM prefix_forum_posts AS fp
JOIN prefix_forum_discussions AS fd ON fp.discussion = fd.id
JOIN prefix_forum AS f ON f.id = fd.forum
JOIN prefix_course AS c ON c.id = fd.course
JOIN prefix_user AS u ON u.id = fp.userid

WHERE fp.userid =
(
select distinct prefix_user.id
from prefix_user
join prefix_role_assignments as ra on ra.userid = prefix_user.id
where ra.roleid = 3
and userid = fp.userid
limit 1
)

and c.shortname like '%2014-2-1%'
GROUP BY c.id, u.id
</code>

===List all the Posts in all the Forums that got high rating===
We setup a scale that let teachers and students Rate forum post with "Important, interesting, valuable, not rated" scale
And then add a link to the following report at the begining of the course "Link to all interesting posts"
<code sql>
SELECT
CONCAT('<a target="_new" href="%%WWWROOT%%/mod/forum/view.php?f=',f.id,'">',f.name,'</a>') AS 'Forum name,
CONCAT('<a target="_new" href="%%WWWROOT%%/mod/forum/discuss.php?d=',fd.id,'#p',fp.id,'">',fp.subject,'</a>') AS 'Post link',
SUM(r.rating) AS 'Rating'
FROM mdl_rating AS r
JOIN mdl_forum_posts AS fp ON fp.id = r.itemid
JOIN mdl_forum_discussions AS fd ON fd.id = fp.discussion
JOIN mdl_forum AS f ON f.id = fd.forum
WHERE r.component = 'mod_forum' AND r.ratingarea = 'post' AND f.course = %%COURSEID%%
GROUP BY r.itemid
ORDER BY SUM(r.rating) DESC
</code>

===List all the Posts in all Discussions of a single Forum===
This report is used to help export all the student's posts and discussions of a single forum, by passing the context module id as a parameter to the report using "&filter_var=cmid"
<code sql>
SELECT
CONCAT('<a target="_new" href="%%WWWROOT%%/mod/forum/view.php?f=', f.id, '">', f.name, '</a>') AS 'Forum name',
fd.name AS 'Discussion',
CONCAT('<a target="_new" href="%%WWWROOT%%/mod/forum/discuss.php?d=', fd.id, '#p', fp.id, '">', fp.subject, '</a>') AS 'Post (link)',
fp.message

FROM mdl_forum_posts AS fp
JOIN mdl_forum_discussions AS fd ON fd.id = fp.discussion
JOIN mdl_forum AS f ON f.id = fd.forum
JOIN mdl_course_modules AS cm ON cm.module = 9 AND cm.instance = f.id
WHERE cm.id = %%FILTER_VAR%%
ORDER BY f.id, fd.id
</code>

==Quiz Module Reports==
===Generate a list of instructors and their email addresses for those courses that has "essay questions" in their quizzes===
<code sql>
SELECT qu.id AS quiz_id, qu.course AS course_id, qu.questions,
co.fullname AS course_fullname, co.shortname AS course_shortname,
qu.name AS quiz_name, FROM_UNIXTIME(qu.timeopen) AS quiz_timeopen, FROM_UNIXTIME(qu.timeclose) AS quiz_timeclose,
u.firstname, u.lastname, u.email,
FROM prefix_quiz qu, prefix_course co, prefix_role re, prefix_context ct, prefix_role_assignments ra, prefix_user u
WHERE FROM_UNIXTIME(timeopen) > '2008-05-14' AND
qu.course = co.id AND
co.id = ct.instanceid AND
ra.roleid = re.id AND
re.name = 'Teacher' AND
ra.contextid = ct.id AND
ra.userid = u.id

SELECT Count('x') As NumOfStudents
FROM prefix_role_assignments a
JOIN prefix_user u ON userid = u.id
WHERE roleid = 5 AND contextid = (SELECT id FROM prefix_context WHERE instanceid = 668 AND contextlevel = 50)
</code>

===Number of Quizes per Course===
<code sql>
SELECT count(*)
,concat('<a target="_new" href="%%WWWROOT%%/course/view.php?id=',c.id,'">',c.fullname,'</a>') AS Course
,concat('<a target="_new" href="%%WWWROOT%%/mod/quiz/index.php?id=',c.id,'">Link</a>') AS Quizes

FROM prefix_course_modules cm
JOIN prefix_course c ON c.id = cm.course
JOIN prefix_modules as m ON m.id = cm.module
WHERE m.name LIKE 'quiz'
GROUP BY c.id
</code>

===List all MultiAnswer (Cloze) Questions===
<code sql>
SELECT concat('<a target="_new" href="%%WWWROOT%%/mod/quiz/attempt.php?q=', quiz.id, '">', quiz.name, '</a>') AS Quiz
,question.id question_id, question.questiontext
FROM prefix_question question
JOIN prefix_quiz_question_instances qqi ON question.id = qqi.question
JOIN prefix_quiz quiz ON qqi.quiz = quiz.id
WHERE `qtype` LIKE 'multianswer'
</code>

===List courses with MANUAL grades===
Which is basically and indication to teachers using Moodle to hold offline grades inside Moodle's Gradebook,
So grades could be uploaded into an administrative SIS. Use with Configurable Reports.
<code sql>
SELECT COUNT( * )
,concat('<a target="_new" href="%%WWWROOT%%/grade/edit/tree/index.php?showadvanced=1&id=',c.id,'">',c.fullname,'</a>') AS Course
FROM prefix_grade_items AS gi
JOIN prefix_course as c ON c.id = gi.courseid
WHERE `itemtype` = 'manual'
GROUP BY courseid
</code>
===List the users that did not took the Quiz===
Do not forget to change "c.id = 14" and q.name LIKE '%quiz name goes here%'
<code sql>
SELECT
user2.id AS ID,
ul.timeaccess,
user2.firstname AS Firstname,
user2.lastname AS Lastname,
user2.email AS Email,
user2.username AS IDNumber,
user2.institution AS Institution,

IF (user2.lastaccess = 0,'never',
DATE_FORMAT(FROM_UNIXTIME(user2.lastaccess),'%Y-%m-%d')) AS dLastAccess

,(SELECT DATE_FORMAT(FROM_UNIXTIME(timeaccess),'%Y-%m-%d') FROM prefix_user_lastaccess WHERE userid=user2.id AND courseid=c.id) AS CourseLastAccess

,(SELECT r.name
FROM prefix_user_enrolments AS uenrol
JOIN prefix_enrol AS e ON e.id = uenrol.enrolid
JOIN prefix_role AS r ON e.id = r.id
WHERE uenrol.userid=user2.id AND e.courseid = c.id) AS RoleName

FROM prefix_user_enrolments AS ue
JOIN prefix_enrol AS e ON e.id = ue.enrolid
JOIN prefix_course AS c ON c.id = e.courseid
JOIN prefix_user AS user2 ON user2 .id = ue.userid
LEFT JOIN prefix_user_lastaccess AS ul ON ul.userid = user2.id
WHERE c.id=14 and ue.userid NOT IN (SELECT qa.userid FROM prefix_quiz_attempts AS qa
JOIN prefix_quiz AS q ON qa.quiz = q.id
JOIN prefix_course AS c ON q.course = c.id
WHERE c.id = 14 AND q.name LIKE '%quiz name goes here%')
</code>

===List Questions in each Quiz===

<code sql>
SELECT quiz.id,quiz.name, q.id, q.name
FROM mdl_quiz AS quiz
JOIN mdl_question AS q ON FIND_IN_SET(q.id, quiz.questions)
WHERE quiz.course = %%COURSEID%%
ORDER BY quiz.id ASC
</code>

Note: this query does not work in Moodle 2.8+. There is no mdl_quiz.questions field. It will need to be rewritten to use the usage/contextid organization.

Here is a version for Moodle 3.x

<code sql>
SELECT cm.id 'cmid', quiz.id 'quiz id'
,CONCAT('<a target="_new" href="%%WWWROOT%%/mod/quiz/edit.php?cmid=',
cm.id, '">', quiz.name, '</a>') AS 'edit quiz'
,q.id 'qid', q.name 'question name'
FROM mdl_quiz AS quiz
JOIN mdl_course_modules cm ON cm.instance = quiz.id AND cm.module = 33 # 33=quiz mdl_modules
JOIN mdl_quiz_slots qs ON qs.quizid = quiz.id
JOIN mdl_question AS q ON q.id = qs.questionid
WHERE quiz.course = %%COURSEID%%
ORDER BY quiz.id ASC
</code>

===Quiz activity research===
This report was made to extract student full activity in quizzes for an academic research about adapting instructional design teaching methods in online learning. The students do not use the Quiz module as a standard quiz but more as Study booklets or mini courses with embedded questions and hints to assist students evaluate their progress (Similar to what you expect to find in a SCORM activity)

<code sql>
SELECT
cm.course "course_id", cm.id "moduel_id", q.id "quiz_id", q.name "quiz_name",

CASE q.grademethod
WHEN 1 THEN "GRADEHIGHEST"
WHEN 2 THEN "GRADEAVERAGE"
WHEN 3 THEN "ATTEMPTFIRST"
WHEN 4 THEN "ATTEMPTLAST"
END "grade method"

, q.attempts "quiz_attempts_allowed", cm.groupmode "group_mode"
, qa.id "attempt_id", qa.state "attempt_state", qa.sumgrades "attempt_grade", qg.grade "user_final_grade", q.grade "quiz_max_grade"
,(SELECT GROUP_CONCAT(g.name) FROM mdl_groups AS g
JOIN mdl_groups_members AS m ON g.id = m.groupid WHERE g.courseid = q.course AND m.userid = u.id) "user_groups",
DATE_FORMAT(FROM_UNIXTIME(qa.timestart), '%d-%m-%Y %h:%k') "attempt_start",
DATE_FORMAT(FROM_UNIXTIME(qa.timefinish), '%d-%m-%Y %h:%k') "attempt_finish",
u.id "user_id", u.firstname, u.lastname,
question.id "question_id", question.name "question_name",
qas.state "question_step_state",qas.fraction "question_grade", qh.hint, question.qtype "question_type"

FROM mdl_quiz as q
JOIN mdl_course_modules as cm ON cm.instance = q.id and cm.module = 14
JOIN mdl_quiz_attempts qa ON q.id = qa.quiz
LEFT JOIN mdl_quiz_grades as qg ON qg.quiz = q.id and qg.userid = qa.userid
JOIN mdl_user as u ON u.id = qa.userid
JOIN mdl_question_usages as qu ON qu.id = qa.uniqueid
JOIN mdl_question_attempts as qatt ON qatt.questionusageid = qu.id
JOIN mdl_question as question ON question.id = qatt.questionid
JOIN mdl_question_attempt_steps as qas ON qas.questionattemptid = qatt.id
LEFT JOIN mdl_question_hints as qh ON qh.questionid = q.id
#WHERE q.id = "SOME QUIZ ID"
WHERE cm.course = "SOME COURSE ID"
</code>

===Quiz Usage in Courses by Date===
Contributed by Elizabeth Dalton, Granite State College

This report lists the courses containing quizzes with the course start date between the two values, and provides a summary of the types of questions in the quizzes in each course and whether question randomization and answer randomization functions were used.

"Multiple Choice" questions include true/false and matching question types.

"Short Answer" are questions that accept a single phrase.

"Other" questions include fixed numerical, calculated, essay, and various drag and drop types.

"Min Quiz Age" and "Max Quiz Age" provide data about the last modified date for the quizzes in the course, compared to the course start date. The values are expressed in units of days. A negative value indicates that a quiz was edited after the start of the course. A value greater than 90 days indicates that the quiz may have been used in an earlier term (cohort) without modification.

'''Note''': In Configurable Reports, the Date Filter is not applied until the "Apply" button is clicked.

<code sql>
SELECT

c.shortname AS 'Course'
#, u.lastname AS 'Instructor'
, COUNT(DISTINCT q.id) AS 'Quizzes'
, COUNT(DISTINCT qu.id) AS 'Questions'
, SUM(IF (qu.qtype = 'multichoice', 1, 0 )) + SUM(IF (qu.qtype = 'truefalse', 1, 0 )) + SUM(IF (qu.qtype = 'match', 1, 0 )) AS 'multichoice'

, SUM(IF (qu.qtype = 'shortanswer', 1, 0 )) AS 'shortanswer'

, COUNT( qu.id) - SUM(IF (qu.qtype = 'multichoice', 1, 0 )) - SUM(IF (qu.qtype = 'truefalse', 1, 0 )) - SUM(IF (qu.qtype = 'match', 1, 0 )) - SUM(IF (qu.qtype = 'shortanswer', 1, 0 )) AS 'Other'

, (SUM(IF (qu.qtype = 'multichoice', 1, 0 )) + SUM(IF (qu.qtype = 'truefalse', 1, 0 )) + SUM(IF (qu.qtype = 'match', 1, 0 )))/COUNT( qu.id) AS 'Percent MC'

#, SUM(IF (qu.qtype = 'numerical', 1, 0 )) AS 'numerical'
#, SUM(IF (qu.qtype LIKE 'calc%', 1, 0 )) AS 'calculated'
#, SUM(IF (qu.qtype = 'random', 1, 0 )) AS 'random'
#, SUM(IF (qu.qtype = 'shortanswer', 1, 0 )) AS 'shortanswer'
#, SUM(IF (qu.qtype = 'essay', 1, 0 )) AS 'essay'

, IF(q.shufflequestions > 0,'Yes','No') AS 'Randomized Questions'
, IF(q.shuffleanswers > 0,'Yes','No') AS 'Randomized Answers'

#, FROM_UNIXTIME(c.startdate) AS 'Course Start Date'
#, FROM_UNIXTIME(MIN(q.timemodified)) AS 'Last Modified'

#, DATEDIFF(FROM_UNIXTIME(c.startdate),FROM_UNIXTIME(MIN(q.timemodified))) AS 'Quiz age'

, MIN(DATEDIFF(FROM_UNIXTIME(c.startdate),FROM_UNIXTIME(q.timemodified))) AS 'Min Quiz Age'
, MAX(DATEDIFF(FROM_UNIXTIME(c.startdate),FROM_UNIXTIME(q.timemodified))) AS 'Max Quiz Age'

#, SUM(IF (DATEDIFF(FROM_UNIXTIME(c.startdate),FROM_UNIXTIME(q.timemodified)) < 90, 1,0)) AS 'new quizzes'

FROM prefix_quiz AS q
JOIN prefix_course AS c on c.id = q.course
JOIN prefix_quiz_question_instances AS qqi ON qqi.quiz = q.id
LEFT JOIN prefix_question AS qu ON qu.id = qqi.question

WHERE
1
%%FILTER_STARTTIME:c.startdate:>%% %%FILTER_ENDTIME:c.startdate:<%%

GROUP BY c.id

ORDER BY c.shortname
</code>

===Student responses (answers) to quiz questions===
(Contributed by Juan F with help from Tim hunt and fellow Moodlers on the forums)
A report that targets a specific quiz for all of our Biology courses, a summary of all questions and how many students get them right/wrong.
<code sql>
SELECT
concat( u.firstname, " ", u.lastname ) AS "Student Name",
u.id,
quiza.userid,
q.course,
q.name,
quiza.attempt,
qa.slot,
que.questiontext AS 'Question',
qa.rightanswer AS 'Correct Answer',
qa.responsesummary AS 'Student Answer'

FROM mdl_quiz_attempts quiza
JOIN mdl_quiz q ON q.id=quiza.quiz
JOIN mdl_question_usages qu ON qu.id = quiza.uniqueid
JOIN mdl_question_attempts qa ON qa.questionusageid = qu.id
JOIN mdl_question que ON que.id = qa.questionid
JOIN mdl_user u ON u.id = quiza.userid

WHERE q.name = "BIO 208 Post Test Assessment"
AND q.course = "17926"

ORDER BY quiza.userid, quiza.attempt, qa.slot
</code>

===Questions which are tagged within a course/quiz===
Calculates subgrades for tags in the each of the quizzes in a course.
Contributed by Daniel Thies in https://moodle.org/mod/forum/discuss.php?d=324314#p1346542

<code sql>
SELECT
quiz.name AS quiz,
t.rawname AS tag,
CONCAT('<a target="_new" href="%%WWWROOT%%/mod/quiz/review.php?attempt=',
MAX(quiza.id),'">',u.firstname,' ',u.lastname,'</a>') AS student,
CAST(SUM(qas.fraction) as decimal(12,1)) AS correct,
CAST(SUM(qa.maxmark) as decimal(12,1)) AS maximum,
CAST(SUM(qas.fraction)/SUM(qa.maxmark)*100 as decimal(4,2)) AS score
FROM prefix_quiz_attempts quiza
JOIN prefix_user u ON quiza.userid = u.id
JOIN prefix_question_usages qu ON qu.id = quiza.uniqueid
JOIN prefix_question_attempts qa ON qa.questionusageid = qu.id
JOIN prefix_quiz quiz ON quiz.id = quiza.quiz
JOIN prefix_tag_instance ti ON qa.questionid = ti.itemid
JOIN prefix_tag t ON t.id = ti.tagid
JOIN (SELECT MAX(fraction) AS fraction, questionattemptid
FROM prefix_question_attempt_steps
GROUP BY questionattemptid) qas ON qas.questionattemptid = qa.id
WHERE quiz.course = %%COURSEID%%
GROUP BY quiza.userid,
quiza.quiz,
quiz.name,
u.firstname,
u.lastname,
ti.tagid,
t.rawname
ORDER BY quiza.quiz, t.rawname, u.lastname, u.firstname, score
</code>

==SCORM Activity Reports==

===Lists All completed SCORM activites by Course name===
This report will list all completed attempts for all SCORM activities. It is ordered first by Course name, then student's last name, then student's first name, then attempt number. Please note: the FROM_UNIXTIME command is for MySQL.
<code sql>
SELECT u.firstname First,u.lastname Last,c.fullname Course, st.attempt Attempt,st.value Status,FROM_UNIXTIME(st.timemodified,"%m-%d-%Y") Date
FROM prefix_scorm_scoes_track AS st
JOIN prefix_user AS u ON st.userid=u.id
JOIN prefix_scorm AS sc ON sc.id=st.scormid
JOIN prefix_course AS c ON c.id=sc.course
WHERE st.value='completed'
ORDER BY c.fullname, u.lastname,u.firstname, st.attempt
</code>

===Lists SCORM status for all enrolled users by Course name===
This report will list the SCORM status for all users enrolled in the course. It is ordered first by Course name, then student's last name, then student's first name, then attempt number. This can be limited to individual courses by adding to the where clause the course id to report on.
<code sql>
SELECT
u.firstname AS First,
u.lastname AS Last,
u.idnumber AS Employee_ID,
u.city AS City,
uid.data AS State,
u.country AS Country,
g.name AS Group_name,
c.fullname AS Course,
st.attempt AS Attempt,
st.value AS Status,
FROM_UNIXTIME(st.timemodified,"%m-%d-%Y") AS Date

FROM prefix_scorm_scoes_track AS st
JOIN prefix_user AS u ON st.userid=u.id
JOIN prefix_user_info_data AS uid ON uid.userid = u.id
JOIN prefix_scorm AS sc ON sc.id=st.scormid
JOIN prefix_course AS c ON c.id=sc.course
JOIN prefix_groups AS g ON g.courseid = c.id
JOIN prefix_groups_members AS m ON g.id = m.groupid

WHERE st.element='cmi.core.lesson_status' AND m.userid=u.id

UNION

SELECT
user2.firstname AS First,
user2.lastname AS Last,
user2. idnumber AS Employee_ID,
user2.city AS City,
uid.data AS State,
user2.country AS Country,
g.name AS Group_name,
c.fullname AS Course,
"-" AS Attempt,
"not_started" AS Status,
"-" AS Date

FROM prefix_user_enrolments AS ue
JOIN prefix_enrol AS e ON e.id = ue.enrolid
JOIN prefix_course AS c ON c.id = e.courseid
JOIN prefix_user AS user2 ON user2 .id = ue.userid
JOIN prefix_user_info_data AS uid ON uid.userid = user2.id
JOIN prefix_groups AS g ON g.courseid = c.id
JOIN prefix_groups_members AS m ON g.id = m.groupid
JOIN prefix_scorm AS sc ON sc.course=c.id
Left Join prefix_scorm_scoes_track AS st on st.scormid=sc.id AND st.userid=user2.id

WHERE st.timemodified IS NULL AND m.userid=user2.id

ORDER BY Course, Last, First, Attempt

</code>

== Badges==

=== All badges issued, by User ===

Contributed by: [https://moodle.org/user/profile.php?id=88992 Randy Thornton]

This report will show you all the badges on a site that have been issued, both site and all courses, by the username of each user issued a badge. Includes the type of criteria passed (activity, course completion, manual), date issued, date expires, and a direct link to that issued badge page so you can see all the other details for that badge.

<code sql>
SELECT u.username, b.name AS badgename,
CASE
WHEN b.courseid IS NOT NULL THEN
(SELECT c.shortname
FROM prefix_course AS c
WHERE c.id = b.courseid)
WHEN b.courseid IS NULL THEN "*"
END AS Context,
CASE
WHEN t.criteriatype = 1 AND t.method = 1 THEN "Activity Completion (All)"
WHEN t.criteriatype = 1 AND t.method = 2 THEN "Activity Completion (Any)"
WHEN t.criteriatype = 2 AND t.method = 2 THEN "Manual Award"
WHEN t.criteriatype = 4 AND t.method = 1 THEN "Course Completion (All)"
WHEN t.criteriatype = 4 AND t.method = 2 THEN "Course Completion (Any)"
ELSE CONCAT ('Other: ', t.criteriatype)
END AS Criteriatype,
DATE_FORMAT( FROM_UNIXTIME( d.dateissued ) , '%Y-%m-%d' ) AS dateissued,
DATE_FORMAT( FROM_UNIXTIME( d.dateexpire ), '%Y-%m-%d' ) AS dateexpires,
CONCAT ('<a target="_new" href="%%WWWROOT%%/badges/badge.php?hash=',d.uniquehash,'">link</a>') AS Details
FROM prefix_badge_issued AS d
JOIN prefix_badge AS b ON d.badgeid = b.id
JOIN prefix_user AS u ON d.userid = u.id
JOIN prefix_badge_criteria AS t on b.id = t.badgeid
WHERE t.criteriatype <> 0
ORDER BY u.username
</code>

Please note: the FROM_UNIXTIME command is for MySQL.

=== All badges available in the system, with Earned count ===

Contributed by: [https://moodle.org/user/profile.php?id=88992 Randy Thornton]

Report of all badges in the system, with badge name and description, context, course shortname if a course badge, whether it is active and available, and a count of how many users have been issued that badge.

<code sql>
SELECT b.id, b.name, b.description,
CASE
WHEN b.type = 1 THEN "System"
WHEN b.type = 2 THEN "Course"
END AS Context,
CASE
WHEN b.courseid IS NOT NULL THEN
(SELECT c.shortname
FROM prefix_course AS c
WHERE c.id = b.courseid)
WHEN b.courseid IS NULL THEN "*"
END AS Course,
CASE
WHEN b.status = 0 OR b.status = 2 THEN "No"
WHEN b.status = 1 OR b.status = 3 THEN "Yes"
WHEN b.status = 4 THEN "x"
END AS Available,
CASE
WHEN b.status = 0 OR b.status = 1 THEN "0"
WHEN b.status = 2 OR b.status = 3 OR b.status = 4 THEN
(SELECT COUNT(*)
FROM prefix_badge_issued AS d
WHERE d.badgeid = b.id
)
END AS Earned
FROM prefix_badge AS b

</code>

=== Badges Leaderboard ===

Contributed by: [https://moodle.org/user/profile.php?id=88992 Randy Thornton]

A simple list of usernames and how many badges they have earned overall.

<code sql>
SELECT u.username, (SELECT COUNT(*) FROM prefix_badge_issued AS d WHERE d.userid = u.id) AS earned
FROM prefix_user AS u
ORDER BY earned DESC, u.username ASC
</code>

=== Manage badges (System & Course) ===

List system wide badges, course and system level badges + a link to relevant "manage badges" page.

<code sql>
SELECT b.id, b.name, b.description
,CASE
WHEN b.type = 1 THEN 'System'
WHEN b.type = 2 THEN 'Course'
END AS Level
,CONCAT('<a target="_new" href="%%WWWROOT%%/badges/index.php?type=', b.type, '&id=',
c.id, '">Manage badges in: ', c.fullname, '</a>') AS Manage
FROM prefix_badge AS b
JOIN prefix_course AS c ON c.id = b.courseid
</code>

==Administrator Reports==

===Config changes in Export friendly form===

Contributed by: [https://moodle.org/user/profile.php?id=88992 Randy Thornton]

The Administrative report Config changes is very useful but it would be nice to have it in a format that could be easily exported in one listing. Here is code to do that.

<code sql>
SELECT
DATE_FORMAT( FROM_UNIXTIME( g.timemodified ) , '%Y-%m-%d' ) AS date,
u.username AS user,
g.name AS setting,
CASE
WHEN g.plugin IS NULL THEN "core"
ELSE g.plugin
END AS plugin,
g.value AS new_value,
g.oldvalue AS original_value
FROM prefix_config_log AS g
JOIN prefix_user AS u ON g.userid = u.id
ORDER BY date DESC
</code>

===Cohorts by user===

Contributed by: [https://moodle.org/user/profile.php?id=88992 Randy Thornton]

How to get a list of all users and which cohorts they belong to.

<code sql>
SELECT u.firstname, u.lastname, h.idnumber, h.name
FROM prefix_cohort AS h
JOIN prefix_cohort_members AS hm ON h.id = hm.cohortid
JOIN prefix_user AS u ON hm.userid = u.id
ORDER BY u.firstname
</code>

===Cohorts with Courses===

Contributed by: [https://moodle.org/user/profile.php?id=88992 Randy Thornton]

List of all cohorts with name, id, visibility, and which courses they are enrolled in.

<code sql>
SELECT
# h.id,
# e.customint1,
h.name AS Cohort,
h.idnumber AS Cohortid,
CASE
WHEN h.visible = 1 THEN 'Yes'
ELSE '-'
END AS Cohortvisible,
CONCAT('<a target="_new" href="%%WWWROOT%%/course/view.php', CHAR(63),'id=',c.id,'">',c.fullname,'</a>') AS Course
FROM prefix_cohort h
JOIN prefix_enrol e ON h.id = e.customint1
JOIN prefix_course c ON c.id = e.courseid %%FILTER_COURSES:e.courseid%%
WHERE e.enrol = 'cohort' AND e.roleid = 5
</code>

===Courses created And Active courses by Year===
Active courses is counting course that have at least one Hit, And "Active_MoreThan100Hits" counts courses that have at least 100 Hits
<code sql>
SELECT

YEAR( FROM_UNIXTIME( `timecreated` ) ) AS YEAR, COUNT( * ) AS Counter

, (SELECT COUNT( DISTINCT course )
FROM prefix_log AS l
WHERE YEAR( FROM_UNIXTIME( l.`time` ) ) = YEAR( FROM_UNIXTIME( `timecreated` ) )
) AS "Active"

,(SELECT COUNT(*) FROM (
SELECT COUNT( * ),time
FROM prefix_log AS l
GROUP BY course
HAVING COUNT(*) > 100) AS courses_log
WHERE YEAR( FROM_UNIXTIME( courses_log.`time` ) ) = YEAR( FROM_UNIXTIME( `timecreated` ) )
) AS "Active_MoreThan100Hits"

FROM `prefix_course`
GROUP BY YEAR( FROM_UNIXTIME( `timecreated` ) )
</code>

===Users created And Active users by Year===
Active users is counting users that have at least one Hit, And "Active_MoreThan500Hits" counts users that have at least 500 Hits
<code sql>
SELECT

YEAR( FROM_UNIXTIME( `firstaccess` ) ) AS YEAR, COUNT( * ) AS Counter

, (SELECT COUNT( DISTINCT userid )
FROM prefix_log AS l
WHERE YEAR( FROM_UNIXTIME( l.`time` ) ) = YEAR( FROM_UNIXTIME( `firstaccess` ) )
) AS "Active"

,(SELECT COUNT(*) FROM (
SELECT COUNT( * ),time
FROM prefix_log AS l
GROUP BY userid
HAVING COUNT(*) > 500) AS users_log
WHERE YEAR( FROM_UNIXTIME( users_log.`time` ) ) = YEAR( FROM_UNIXTIME( `firstaccess` ) )
) AS "Active_MoreThan500Hits"

FROM `prefix_user`
GROUP BY YEAR( FROM_UNIXTIME( `timecreated` ) )
</code>

===Course Aggregation Report===
Contributed by Elizabeth Dalton, Granite State College

If you are considering upgrading from Moodle 2.6 to 2.8 or later, your grades may be changed. This report can help quantify and identify the courses at risk of changes.

In particular, be on the lookout for any courses with the following combinations of parameters, which are known to cause changes in calculations:

# mean of grades set with aggregate with subcategory.
# Simple weighted mean of grades with aggregate with sub category and drop the lowest
# Sum of grades drop the lowest

Also review:
https://tracker.moodle.org/browse/MDL-48618
https://tracker.moodle.org/browse/MDL-48634
https://tracker.moodle.org/browse/MDL-49257
https://tracker.moodle.org/browse/MDL-50089
https://tracker.moodle.org/browse/MDL-50062

<code sql>
SELECT

COUNT(c.shortname) AS 'Count of Courses'

# If you want to display all the courses for each aggregation type, uncomment the next line and change GROUP BY settings
#, c.shortname AS 'course name'

# If you need to display grade categories for each aggregation type, uncomment the next line and change GROUP BY settings
#, gc.fullname AS 'grade category name'

, gc.aggregation AS 'aggregation method'

#These aggregation text strings appear to be hard-coded. I couldn't find a table for them. If you have aggregation types I haven't included here, they'll be blank in your report results.
, CASE gc.aggregation
WHEN 0 THEN 'Mean of Grades'
WHEN 2 THEN 'Median of Grades'
WHEN 6 THEN 'Highest Grade'
WHEN 8 THEN 'Mode of Grades'
WHEN 10 THEN 'Weighted Mean of Grades'
WHEN 11 THEN 'Simple Weighted Mean of Grades'
WHEN 12 THEN 'Mean of Grades (with extra credits)'
WHEN 13 THEN 'Sum of Grades'
END AS 'aggregation name'

# Note that gc.aggregatesubcats column is eliminated in 2.8 and later per MDL-47503, so comment that line on updated systems or you'll get an error
, gc.keephigh AS 'keep high'
, gc.droplow AS 'dr0p low'
, gc.aggregateonlygraded AS 'Aggregate only graded'
, gc.aggregateoutcomes AS 'aggregate outcomes'
, gc.aggregatesubcats AS 'aggregate subcategories'

# If you are displaying data about individual courses, you may want to know how old they are
#, FROM_UNIXTIME(c.startdate) AS 'course start date'

# If you are trying to use this report to check to see if final grades have changed after an upgrade, you might want these data items, but calculations can still change later when the courses are actually viewed. Also, you'll need to uncomment the necessary JOINs below
#, gi.itemname AS 'grade item'
#, gg.finalgrade AS 'final grade'

FROM

prefix_course AS c
JOIN prefix_grade_categories AS gc ON gc.courseid = c.id
JOIN prefix_course_categories AS cc ON cc.id = c.category

#LEFT JOIN prefix_grade_items AS gi ON gi.courseid = c.id #AND gi.categoryid=gc.id
#LEFT JOIN prefix_grade_grades AS gg ON gg.itemid = gi.id AND gg.userid = u.id

WHERE
1
#AND gc.aggregation = 13 #only the dreaded Sum of Grades aggregations
#AND gc.depth = 1 # if for some reason you only want course aggregations, not subcategories

GROUP BY gc.aggregation, gc.keephigh, gc.droplow, gc.aggregateonlygraded, gc.aggregateoutcomes, gc.aggregatesubcats

</code>

=== Running Cron jobs (task_scheduled) ===
<code sql>
SELECT classname
,DATE_FORMAT(FROM_UNIXTIME(lastruntime), '%H:%i [%d]') AS 'last'
,DATE_FORMAT(now(), '%H:%i') AS 'now'
,DATE_FORMAT(FROM_UNIXTIME(nextruntime), '%H:%i [%d]') AS 'next'
,DATE_FORMAT(FROM_UNIXTIME(UNIX_TIMESTAMP()-nextruntime), '%i') AS 'next in min'
FROM mdl_task_scheduled
WHERE now() > FROM_UNIXTIME(nextruntime)
</code>

=== All Meta courses with Parent and Child course relationships ===

Contributed by: [https://moodle.org/user/profile.php?id=88992 Randy Thornton]

This shows the list of courses with Meta course link enrollments in them ('Parent course'), and the courses which are connected to them to provide enrollments ('Child courses').

<code sql>
SELECT
c.fullname AS 'Parent course name',
c.shortname AS 'Parent course shortname',
en.courseid AS 'Parent course id',
(SELECT fullname FROM prefix_course WHERE prefix_course.id = en.customint1) As 'Child course name',
(SELECT shortname FROM prefix_course WHERE prefix_course.id = en.customint1) As 'Child course shortname',
en.customint1 AS 'Child course id'
FROM prefix_enrol en
JOIN prefix_course c ON c.id = en.courseid
WHERE en.enrol = 'meta'
ORDER BY c.fullname
</code>

== Learning Analytics Reports ==
(Moodle v. 3.4 and later)

=== Learning Analytics Model Summary ===
This report provides a list of the learning analytics models on your site, whether enabled or not, and several details about them.

(Note: this report was created on a system using PostgreSQL. Some changes may be needed for other forms of SQL.)
Contributed by Elizabeth Dalton, Moodle HQ

<code sql>
SELECT
am.id AS "model id",
split_part(am.target,'\',5) AS "target",
CASE WHEN am.enabled=1 THEN 'YES' ELSE 'NO' END AS "enabled",
CASE WHEN am.trained=1 THEN 'YES' ELSE 'NO' END AS "trained",
am.name,
/* indicators,*/
char_length(am.indicators) - char_length(REPLACE(am.indicators,',',''))+1 AS "indicator count",
split_part(am.timesplitting,'\',5) AS "interval",
/*
to_timestamp(am.version) AS "version",
to_timestamp(am.timecreated) AS "time created",
to_timestamp(am.timemodified) AS "time modified",
*/
COUNT(DISTINCT ap.contextid) AS "contexts",
COUNT(ap.sampleid) AS "samples",
/* AVG(ap.prediction) AS "avg prediction", */
ROUND(ap.prediction,1) AS "prediction",
ROUND(AVG(aml.score),3) AS "model accuracy (avg)",
apa.actionname AS "action",
COUNT(apa.id) AS "number actions taken"

FROM prefix_analytics_models AS am
JOIN prefix_analytics_predictions AS ap ON am.id = ap.modelid
LEFT JOIN prefix_analytics_models_log AS aml ON aml.modelid = am.id
LEFT JOIN prefix_analytics_prediction_actions AS apa ON apa.predictionid = ap.id
GROUP BY am.id, ap.prediction, apa.actionname
</code>

=== Analytics Indicator Calculations ===
Pulls calculations from the "analytics_indicator_calc" table consisting of all calculations made for each indicator for each sample within each context for every model. In most cases you will want to limit this per context or sample, or at least group by context and sample.

<code sql>
SELECT
id,
to_timestamp(starttime) AS "start time",
to_timestamp(endtime) AS "end time",
contextid,
sampleorigin,
sampleid,
/*indicator, */
split_part(indicator,'\',2) AS "module",
split_part(indicator,'\',5) AS "indicator type",
value,
to_timestamp(timecreated) AS "time created"

FROM prefix_analytics_indicator_calc
WHERE id = 1
</code>

===Analytics Models ===
Pulls data from the "analytics_models" table consisting of one row per model. See the "Learning Analytics Model Summary" report, above, for an expanded report that JOINs model data from different tables to provide a more comprehensive view.
Contributed by Elizabeth Dalton, Moodle HQ

<code sql>
SELECT
id,
enabled,
trained,
name,
split_part(target,'\',5) AS "target",
/* indicators,*/
char_length(indicators) - char_length(REPLACE(indicators,',',''))+1 AS "indicator count",
split_part(timesplitting,'\',5) AS "interval",
predictionsprocessor,
to_timestamp(version) AS "version",
to_timestamp(timecreated) AS "time created",
to_timestamp(timemodified) AS "time modified",
usermodified

FROM prefix_analytics_models
</code>

=== Analytics Models Log ===
Pulls data from the "analytics_models_log" table consisting of evaluation calculations per model. If model evaluations have not been manually executed on the system from the command line, there will be no contents in this table.
Contributed by Elizabeth Dalton, Moodle HQ

<code sql>
SELECT
id,
modelid,
to_timestamp(version) AS "version",
evaluationmode,
split_part(target,'\',5) AS "target",
/* indicators,*/
char_length(indicators) - char_length(REPLACE(indicators,',',''))+1 AS "indicator count",
split_part(timesplitting,'\',5) AS "interval",
score,
info,
dir,
to_timestamp(timecreated) AS "time created",
usermodified

FROM prefix_analytics_models_log
</code>

=== Analytics Predictions ===
Pulls data from the "analytics_predictions" table consisting of one row per prediction per model. Counts the number of indicators calculated for each prediction, but does not list them. If a model has not yet been trained, the system cannot make predictions and this table will not include rows for that model ID. See the "Learning Analytics Model Summary" report, above, for an expanded report that JOINs model data from different tables to provide a more comprehensive view.
Contributed by Elizabeth Dalton, Moodle HQ

<code sql>
SELECT
id,
modelid,
contextid,
sampleid,
rangeindex,
prediction,
predictionscore,
char_length(calculations) - char_length(REPLACE(calculations,',',''))+1 AS "indicators calculated",
to_timestamp(timecreated) AS "time created",
to_timestamp(timestart) AS "time start",
to_timestamp(timeend) AS "time end"

from prefix_analytics_predictions
</code>

=== Analytics Prediction Actions ===
Pulls data from the "analytics_prediction_actions" table consisting of one row per action taken per prediction (e.g. a teacher viewing the outline report for a student at risk). If the model has not yet made predictions, there can be no prediction actions. See the "Learning Analytics Model Summary" report, above, for an expanded report that JOINs model data from different tables to provide a more comprehensive view.
Contributed by Elizabeth Dalton, Moodle HQ

<code sql>
SELECT
id,
predictionid,
userid,
actionname,
to_timestamp(timecreated) AS "time created"

FROM prefix_analytics_prediction_actions
</code>

=== Analytics Predictions with All Indicators ===
Pulls data from the "analytics_predictions" table consisting of one row per prediction per model. Lists the indicators calculated for each prediction. If a model has not yet been trained, the system cannot make predictions and this table will not include rows for that model ID.
Contributed by Elizabeth Dalton, Moodle HQ

<code sql>
SELECT
id AS "Prediction ID",
modelid AS "Model ID",
contextid AS "Context ID",
sampleid AS "Sample ID",
rangeindex AS "Analysis Interval",
prediction AS "Prediction value",
predictionscore,
calculations,
char_length(calculations) - char_length(REPLACE(calculations,',',''))+1 AS "indicators calculated",
to_timestamp(timecreated) AS "time created",
to_timestamp(timestart) AS "time start",
to_timestamp(timeend) AS "time end"

from prefix_analytics_predictions
</code>

=== Analytics Predict Samples ===
Pulls data from the "analytics_predict_samples" table consisting of one row per analysis interval per model, with a count of the samples used for each prediction. Sample details are not included here, but the report can be modified to list samples by IDs if needed by parsing the contents of the sampleids field. For example, this counts the number of student enrolments for which the system has generated predictions for a given model and analysis interval.
Contributed by Elizabeth Dalton, Moodle HQ

<code sql>
SELECT
id,
modelid,
analysableid,
split_part(timesplitting,'\',5) AS "interval",
rangeindex,
/* sampleids, */
char_length(sampleids) - char_length(REPLACE(sampleids,',',''))+1 AS "samples used",
to_timestamp(timecreated) AS "time created",
to_timestamp(timemodified) AS "time modified"

FROM prefix_analytics_predict_samples
</code>

=== Analytics Train Samples ===
Pulls data from the "analytics_train_samples" table consisting of one row per analysis interval per model, with a count of the samples used for each training calculation.
Contributed by Elizabeth Dalton, Moodle HQ

<code sql>
SELECT
id,
modelid,
analysableid,
split_part(timesplitting,'\',5) AS "interval",
/* sampleids, */
char_length(sampleids) - char_length(REPLACE(sampleids,',',''))+1 AS "samples used",
to_timestamp(timecreated) AS "time created"

FROM prefix_analytics_train_samples
</code>

=== Analytics Used Analysables ===
Pulls data from the "analytics_used_analysables" table consisting of one row per context per model, noting whether the analysable was used to train the model or to make a prediction. This data is used to control the training and prediction processes.
Contributed by Elizabeth Dalton, Moodle HQ

<code sql>
SELECT
id,
modelid,
action,
analysableid,
to_timestamp(firstanalysis) AS "first analysis",
to_timestamp(timeanalysed) AS "time analysed"

FROM prefix_analytics_used_analysables
</code>

=== Analytics Used Files ===
Pulls data from the "analytics_used_files" table consisting of one row per file per model, noting whether the file was used to train the model or to make a prediction. This data is used to control the training and prediction processes.
Contributed by Elizabeth Dalton, Moodle HQ

<code sql>
SELECT

id,
modelid,
fileid,
action,
TO_TIMESTAMP(time) AS Time

FROM prefix_analytics_used_files
</code>

===Average Cognitive Depth and Social Breadth===

Here is a simple SQL snippet to calculate average cognitive depth and social breadth indicators for all students in the system. This one ignores indicator values of 0, as they are nulls as defined in this model.
Contributed by Elizabeth Dalton, Moodle HQ

<code sql>
SELECT

i.contextid,
i.sampleid,

TRUNC(AVG(CASE
WHEN i.indicator LIKE '%cognitive%' THEN i.value
ELSE '0'
END),2) AS "Average Cognitive Depth",

TRUNC(AVG(CASE
WHEN i.indicator LIKE '%social%' THEN i.value
ELSE '0'
END),2) AS "Average Social Breadth"

FROM prefix_analytics_indicator_calc as i
WHERE
i.value != 0
GROUP BY i.contextid, i.sampleid
</code>

== Useful sub queries ==

IN this section please put any short one purpose sub queries that show how common procedures often useful as part of larger queries.

=== All teachers in the course ===

This snippet shows how to get teachers from a course. The contextevel for course objects is 50. And the default Teacher role is role id 3.

<code sql>
,(SELECT GROUP_CONCAT( CONCAT( u.firstname, " ", u.lastname ) )
FROM prefix_course ic
JOIN prefix_context con ON con.instanceid = ic.id
JOIN prefix_role_assignments ra ON con.id = ra.contextid AND con.contextlevel = 50
JOIN prefix_role r ON ra.roleid = r.id
JOIN prefix_user u ON u.id = ra.userid
WHERE r.id = 3 AND ic.id = c.id
GROUP BY ic.id
) AS TeacherNames
</code>

=== Get custom User profile fields for a user ===

Contributed by: [https://moodle.org/user/profile.php?id=88992 Randy Thornton]

This snippet of code shows how to connect a user with their custom profile field data. This will list all users with all custom profile fields and data. Custom profile fields have two tables, one for the definition of the profile field (user_info_field) and its settings, and a separate table to hold the data entered by users (user_info_data).

<code sql>
SELECT u.username, uif.name, uid.data
FROM prefix_user AS u
JOIN prefix_user_info_data AS uid ON uid.userid = u.id
JOIN prefix_user_info_field AS uif ON uid.fieldid = uif.id
</code>

If you want to limit it to one of those fields, you can restrict it by shortname of the custom profile field, so:

<code sql>
SELECT u.username, uif.name, uid.data
FROM prefix_user AS u
JOIN prefix_user_info_data AS uid ON uid.userid = u.id
JOIN prefix_user_info_field AS uif ON (uid.fieldid = uif.id AND uif.shortname = 'shortname1')
</code>

will show you only the data from the custom profile field with the shortname 'shortname1'.

If you want to do this with two or more custom profile fields, you will need to have a JOIN and table alias for each with a restriction for each profile field shortname. Example:

<code sql>
SELECT u.username, d1.data AS 'Profile One', d2.data As 'Profile Two'
FROM prefix_user u
JOIN prefix_user_info_data d1 ON d1.userid = u.id
JOIN prefix_user_info_field f1 ON d1.fieldid = f1.id AND f1.shortname = 'shortname1'
JOIN prefix_user_info_data d2 ON d2.userid = u.id
JOIN prefix_user_info_field f2 ON d2.fieldid = f2.id AND f2.shortname = 'shortname2'
</code>

==== NOTE: Alternate Method ====

If you have more than a couple of fields you need to use, then this query may time out or not return data due to too many joins. The limit seems to be around 10 custom profile fields.

Instead you should use an alternate method which uses Subselects for each of the profile fields. Details and sample code are in this forum discussion: https://moodle.org/mod/forum/discuss.php?d=355502#p1434854. A sample of the style is:

<code sql>
SELECT u.username

,(SELECT d1.data FROM prefix_user_info_data d1
JOIN prefix_user_info_field f1 ON d1.fieldid = f1.id AND f1.shortname = 'shortname1'
WHERE d1.userid = u.id
) AS thefirstfield

,(SELECT d1.data FROM prefix_user_info_data d1
JOIN prefix_user_info_field f1 ON d1.fieldid = f1.id AND f1.shortname = 'shortname2'
WHERE d1.userid = u.id
) AS thesecondfield

FROM prefix_user u
</code>

=== How to use Configurable Reports Date Time Filters===

Contributed by: [https://moodle.org/user/profile.php?id=88992 Randy Thornton]

In the Configurable Reports block, you can set the Time and Date filter to allow you to pick your report Start date/time and End date/time interactively. This will work on any column in a table that is a timestamp.

Here is a simple example:

<code sql>
SELECT u.username,
DATE_FORMAT(FROM_UNIXTIME(u.firstaccess),'%Y-%m-%d %H:%i') AS 'FirstAccess',
DATE_FORMAT(FROM_UNIXTIME(u.lastaccess),'%Y-%m-%d %H:%i') AS 'LastAccess'
FROM prefix_user u

WHERE 1=1
%%FILTER_STARTTIME:u.firstaccess:>%%
%%FILTER_ENDTIME:u.lastaccess:<%%
</code>

1) You will need to replace name of the table and column for the filter to use the time and date column you need for your query. In the example above, it filters on the firstaccess and lastaccess columns in the user table. If you were doing a report on course completion, you might put the timecompleted column, and so forth.

2) You MUST then add the Start / End date filter on the Filters tab of the Report. If you don't, the report will still run, probably, but the filter will be ignored.

Note: the WHERE 1=1 statement is a peculiarity of the filters in Config reports: if you don't have a WHERE statement in your query already, then you must add this dummy WHERE to keep the statement valid. If you already have a WHERE statement in your code, simply add the %%FILTER%% placeholders after it (and before any GROUP or ORDER BY statements.)

==See also==
* [https://github.com/jleyva/moodle-configurable_reports_repository Configurable Reports Repository on GitHub]
* [https://moodleschema.zoola.io/index.html Moodle DB schema explorer] - searching and filtering tables, fields and external key connections between tables.

[[Category:Contributed code]]

[[es:Reportes específicos hechos por usuarios]]

Configurable reports

2019-08-07T07:35:30Z

Libertymoodle: /* Maintainer list */

{{Infobox plugin
|type = Block
|entry = https://moodle.org/plugins/view.php?plugin=block_configurable_reports
|tracker = http://tracker.moodle.org/browse/CONTRIB/component/10753
|discussion = https://moodle.org/mod/forum/view.php?id=7979
|maintainer = [[User:Juan Leyva|Juan Leyva]], [[User:Sara Arjona Téllez|Sara Arjona Téllez]]
|float = right
}}

== Installation ==

# Download the Configurable Reports installation file and unzip it to the '''\blocks''' directory in your Moodle folder.
# Be sure that the final name of the directory is: configurable_reports, the full path in your Moodle installation will be blocks/configurable_reports
# Login to Moodle as Administrator and click Notifications under Site Administration.

For more information see [[Installing contributed modules or plugins]]

== Overview ==

This block is a Moodle custom reports builder. It its also connected to a [https://github.com/jleyva/moodle-configurable_reports_repository public repository of sample reports] (only plugin version 2.3 and above)

It is designed in a modular way to allow developers to create new plugins in less than an hour.

'''Who can create custom reports?'''

Anyone with block, managereports or manageownreports permissions at SITE level or COURSE level.

'''What type of reports can I create?'''

- Courses reports, with information regarding courses.

- Categories reports, with information regarding categories. A courses report can be embedded in this type of report.

- Users reports, with information regarding users and their activity in a course.

- Timeline reports, this is a special type of report that displays a timeline. A course or user report can be embedded in this timeline showing data depending on the start and end time of the current row.

- Custom SQL Reports, custom SQL queries. This block can use the same SQL queries as [https://moodle.org/plugins/view.php?plugin=report_customsql Tim Hunt's Custom SQL queries] plugin.

Note for developers: You can create your own type of reports.

'''Who can view the reports?'''

When you create a report you can select which users can view it.

The reports are displayed in a block in the course or site frontpage.

== Creating a report ==

This is a very simple process.

If you are going to create a report for a course, you have to add the block in the course and click in the "Manage reports" link.

On the other hand, for site reports, add the block in the frontpage and click in the "Manage reports" link.

You must enter a name, an optional description, and you have to choose the type of report, pagination and exports formats.

Depending on the report choosen, there will be more or less tabs. These are the tabs for the courses and users report:

'''Columns''': Here you can choose the differents columns of your report depending on the type of report. (Course Name, User firstname, etc..)

'''Conditions''': Here you can define the conditions (i.e, only courses from this category, only users from Spain, etc.)

'''Ordering''': Here you can choose how to order the report using fields and directions.

'''Filters''': Here you can choose which filters will be displayed.

'''Template''': You can modify the report's layout by creating a template.

'''Permissions''': Here you can choose who can view a report.

'''Calculations''': Here you can add calculations for columns, i.e: average of number of users enrolled in courses

'''Plots''': Here you can add graphs to your report based on the report columns and values.

'''View report''': Self explanatory

== Tutorial ==

=== Creating a users' report ===

Requirements: ''Users from Spain, but not from Madrid, in this course. This report can be viewed only by users from Spain. A filter based on the user's city must be displayed. A pie plot showing the users' cities is required. A calculation table showing the total forum post views is required. The report must be ordered by users' lastname.''

Let's see how easy it is!

First of all, install the block.

Go to the course where the report will be created.

Add an instance of the Custom Reports block.

Click on "Manage reports"

Click on "Add report"

Enter a name, a description and choose "Users report" as Type of Report

The report will be saved and you will be redirected to the first Tab named "Columns".

'''Adding Columns'''

Here you can define the report table properties, width, align, cell padding, cell spacing, etc.

Add a Column called "User profile field"

Choose the field "firstname" and enter a name for the column in the text field. You can leave the rest of elements blank.

Repeat the process above for the lastname and city fields.

Add a Column called "User module actions".

Choose a module from the list, in this example, a forum.

'''Adding Conditions'''

Click on the Conditions Tab.

Add a Condition named "User field Condition".

Choose the column "Country", the Operator "=", and enter the value "ES" (this is the international code for Spain as Moodle stores it).

Add a Condition named "User field Condition".

Choose the column "city", the Operator "<>", and enter the value "Madrid".

Add a Condition named "Users in current report course".

These are the main conditions of the reports. Note that at the bottom there is a text box called condition, with this text:

"c2 and c1 and c3"

Here you can define a logic condition, in this case, we don't need to edit this condition but you can create complex expressions like:

(c1 and c2) or (c4 and c3)

'''Adding Ordering'''

Click on the Ordering Tab.

Add a ordering named "User field ordering".

Choose the column "Lastname" and the ordering "ASC" (Ascending).

'''Adding Filters'''

Click on the Filters Tab.

Add a filter named "User field filter".

Choose city.

'''Adding Permissions'''

Click on the Permissions Tab.

Choose "User field Value".

Choose the column "Country", and enter the value "ES".

Here you can add more permissions and a logic condition to be achieved.

'''Adding Calculations'''

Click on the Calculations tab.

Choose Sum.

Choose the column "User module actions".

'''Adding Plots'''

Click on the Plots tab.

Choose "Pie".

Choose the colum "City" as Name and Value.

Finally, add a few users in Moodle with the country Spain, and different cities, Madrid, Barcelona, Seville, etc. and test the report.

You can download the report in different formats (ods and xls), remember to check these options in the report page.

[[blocks/configurable_reports/#Users_report | See screenshot]]

=== Creating a SQL Report ===

You can find a lot of SQL Reports here: [[ad-hoc contributed reports]]

Since this block supports Tim Hunt's CustomSQL Queries Reports, you can use any query.

Remember to add a "Time filter" if you are going to use reports with time tokens.

First of all, install the block.

Go to the course where the report will be created.

Add an instance of the Custom Reports block.

Click on "Manage reports".

Click on "Add report

Enter a name, description, choose "SQL" as Type of Report

The report will be saved and you redirect to the first Tab named "Custom SQL"

Add this query (''Courses activity''):

<code sql>
SELECT COUNT(l.id) hits, l.course courseId, c.fullname coursename
FROM prefix_log l INNER JOIN prefix_course c ON l.course = c.id
GROUP BY courseId
ORDER BY hits DESC
</code>

==== Adding a calculation ====
# Go to Calculations Tab
# Add a Sum calculation, choose the hits column

==== Adding a Plot ====
# Go to Plot
# Add a Pie graph, choosing coursename as Name and hits as value

So, here you have a report with a Graph and calculations based on a SQL Query.

Note: Bar charts are currently not displaying on systems using PHP 7: https://github.com/jleyva/moodle-block_configurablereports/issues/101

==== Filters ====

Filters add a control to the report that allows the user to select a subset of data when the report runs. Filters require two steps:

# Select the filter you want to use on the "Filters" tab
# Add SQL code to make the filter affect the output.

These are the filters that can be used to constrain your report:

<code sql>
%%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:
</code>

'''Using Filters'''

When using a filter you need at least one static WHERE condition, followed by one or more filters. For example

<code sql>
WHERE 1
%%FILTER_COURSES:c.id%%
</code>

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 coded 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
<code sql>
%%FILTER_STARTTIME:l.TIME:>%% %%FILTER_ENDTIME:l.TIME:<%%
</code>

You can add a Course filter; it's very easy.
# Go to filters, choose Courses
# Edit the Custom SQL query:

<code sql>
SELECT COUNT(l.id) hits, l.course courseId, c.fullname coursename
FROM prefix_log l INNER JOIN prefix_course c ON l.course = c.id
%%FILTER_COURSES:l.course%%
GROUP BY courseId
ORDER BY hits DESC
</code>

Note that we are adding a token called: %%FILTER_COURSES:l.courseid%%

Go to View report, and you will see a Courses Filter, choose a Course and click on Add, here you have a report filtered.

You can also add a Starttime and endtime filter

# Go to filters, choose Start / End date filter
# Go to Custom SQL tab, this is the new query:

<code sql>
SELECT COUNT(l.id) hits, l.course courseId, c.fullname coursename
FROM prefix_log l INNER JOIN prefix_course c ON l.course = c.id
%%FILTER_COURSES:l.course%%
%%FILTER_STARTTIME:l.time:>%% %%FILTER_ENDTIME:l.time:<%%
GROUP BY courseId
ORDER BY hits DESC
</code>

If you want to filter text (for example, lastname)

# Go to filters, choose Search Text filter
# Go to Custom SQL tab and type your query. Here is an example for querying the user table:

<code sql>
SELECT u.firstname, u.lastname
FROM prefix_user u
WHERE 1=1
%%FILTER_SEARCHTEXT:u.lastname:~%%
ORDER BY u.lastname
</code>

Replace WHERE 1=1 with your WHERE criteria. If you do not have any where criteria and do not specify WHERE 1=1, you will receive a SQL error.

One more example (for filtering a group of courses by category)

<code sql>
SELECT COUNT(l.id) hits, c.fullname as Course,c.id as CourseID
,(SELECT Count( ra.userid ) AS Users FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
WHERE ra.roleid = 5 AND ctx.instanceid = c.id) AS Students
FROM prefix_log l INNER JOIN prefix_course c ON l.course = c.id
%%FILTER_CATEGORIES:c.category%%
GROUP BY l.course
ORDER BY hits DESC
</code>

Go to View report, now you can filter by time also

==== SQL variables ====

If you place one of these strings in your SQL queries, it will be replaced by the appropriate value (current course id, current user id, Moodle www root (url), etc.)

<code sql>
%%CATEGORYID%%
%%COURSEID%%
%%CURRENTUSER%%
%%DEBUG%%
%%FILTER_VAR%%
%%STARTTIME%%','%%ENDTIME%%
%%USERID%%
%%WWWROOT%%
</code>

[[blocks/configurable_reports/#SQL_report | See screenshot]]

=== Creating a timeline report ===

''This report assumes that you have created at least one user or course report''

Timeline reports are a special type of reports. A timeline report displays a timeline in which a course report or user report can be embedded.

In this example we are going to create a report showing the user logins to the site during the last month (day per day).

Create a User report (see tutorial above) with three columns (firstname, lastname and user statistics)

Select the statistic (User logins)

Create a Timeline report, in the Timeline tab you can select the dates or days of the report (in this case, the last 30 days) and the interval of time for every row.

Add three "Other report column" columns, selecting all the previous user report columns.

And that's all, you can create a new type of plot (line graph). This graph is suitable for data depending on time.

== Advanced options ==

=== Export and import of reports ===

Embedded reports exporting is not working because the reports include references to another reports. A workaround is edit the imported report for changing the references in the "Other report field" column.

Reports that uses the user module outline column can't be exported either

=== Use the same report in different courses ===

(Available only in Configurable Report version 2.3 and above)

In order to use the same report in different courses you have to check the "Global report" option where creating a new report. This report will be then displayed in all the courses where the configurable report block is displayed and the block instance settings are set to "Display global reports".

If you don't want to display global reports in a certain block instance you can always edit the instance settings for selecting "No" in the "Display global reports" block setting.

Notice that these types of reports inherit the context of the course where is displayed, so any condition related to course inside the report is calculated using the course where the report is being viewed

=== Reports can run on a different DB then the current (production) DB ===

(Available only in Configurable Report version 2.3 and above)

This functionality is for using a copy of the same moodle database, not for queries to other database sources.

Go to Admin -> Plugins -> Blocks -> Configurable Report settings

=== DataTables for the report table ===

(Available only in Configurable Report version 2.3 and above)

Go to Admin -> Plugins -> Blocks -> Configurable Report settings to enable this functionality

=== CodeMirror.js for highlighting SQL query code ===

(Available only in Configurable Report version 2.3 and above)

Go to Admin -> Plugins -> Blocks -> Configurable Report settings to disable this functionality

=== Using GITHUB as a repository to distribute and manage sharable SQL queries ===

(Available only in Configurable Report version 2.3 and above)

Go to Admin -> Plugins -> Blocks -> Configurable Report settings to point to your own repository

=== Cron SQL queries ===

(Available only in Configurable Report version 2.3 and above)

=== Settings to control security of SQL Queries ===

(Available only in Configurable Report version 2.3 and above)

Go to Admin -> Plugins -> Blocks -> Configurable Report settings to change the security level

=== Templates ===

You can customize the report output using a template.

Just enable the Template option in the same name tab.

This is an example html code for displaying a list of users:

Header:

<code html4strict>
<p align="center"><b>##reportname##</b></p>
<table width="60%" align="center">
<tr>
<td>
</code>

Record:

<code html4strict>
<table width="100%">
<tr>
<td><img src="http://yourmoodle.com/user/pix.php/[[id]]/f1.jpg"></td>
<td><h2>[[Firstname]] [[Lastname]]</h2>
City: [[City]]
</td>
</tr>
</table>
<br>
</code>

Footer:

<code html4strict>
</td>
<td valign="top">
##graphs##
<br /><br />
##exportoptions##
</td>
</table>
</code>

=== Embedded reports ===

An embedded report consists in a report's set of columns that are embedded in another report.

You can embed a user report into a course report, in this case, the resulting rows will be expanded duplicating each row for each user.

{| class="wikitable"
|-
! Type of report
! Reports that can be embedded
|-
| Courses
| Users
|-
| Categories
| Courses
|-
| Timeline
| Users, courses
|}

Imagine you have a courses report, you can embed a user report, every row of the course report will be cloned for each user.

To embed a report just add a "Other report" column, a list of your reports will be showed.

Inside a course report you can embed a user report and the other way.

==== Timeline reports ====

Timeline reports are a special type of reports. A timeline report displays a timeline in which a courses report or users report can be embedded.

Timeline reports should be used when your user or course report includes statistics (course stats or user stats columns). I.e: you can create a report showing the number of user logins to the site during a week or month.

== Reports repository ==

Configurable Reports is connected to two different repositories:

* https://github.com/jleyva/moodle-configurable_reports_repository A repository of any type of reports (users, courses, sql, etc...)
* https://github.com/jleyva/moodle-custom_sql_report_queries A repository of just SQL queries to be used in the SQL repor type

You can use your custom repository following this instructions:

* First, you need a github account (free)

* Fork any of the previous repositorys, using the GITHUB fork tool

* Using GIT, clone the repository to your computer in order to add your custom reports (some GIT knowledge is needed)

* Go to Administration / Plugins / Blocks / Configurable reports and change the settings for pointing to your repository (github account + / + repository name

* If you want to contribute to the official repository, use the Pull request Github feature (So I can easily add your reports)

== Developers documentation ==

It's very easy to create new report types, components and plugins.

'''Report''': A report plugin is a folder located at /report.
This folder contains a .class.php file with the child - class of the report_base.

You only need to modify a few methods to add a new report type.
Please, take a look at any of the current reports. The SQL report is an example of a non-typical report,
meanwhile the users and courses reports are standard reports.

The best way to create a report is to duplicate an existing one.

'''Component''': A component is part of a report, a component may be used by more than one report.
The main Component is the component Columns, that is used to add the columns of a report.

Others components are filters, permissions, plot, calculations..

The best way to create a component is to duplicate an existing one.

'''Plugin''': A plugin is a component module. The component column has a few of plugins (coursefield, userfield, etc.)
A plugin usually works for a unique report, but there are plugins that work for more than one report.
The best way to create a plugin is to duplicate an existing one.

== How to request a new feature ==

* Go to the Plugin Tracker http://tracker.moodle.org/browse/CONTRIB/component/10753
* Check in the open issues if your feature have been already requested http://tracker.moodle.org/secure/IssueNavigator.jspa?reset=true&jqlQuery=project+%3D+CONTRIB+AND+component+%3D+%22Block%3A+Configurable+report%22+AND+status+%3D+Open+ORDER+BY+priority+DESC&mode=hide
* If not, create a New issue (Component: Non-core contributed modules Issue type: New feature) (You have to register yourself in the tracker)
* Select the component Block: Configurable Reports and your Moodle version
* Explain in the Description field your needs
* If you have funding, you can contact me using the forum or the moodle internal messaging system, since I work for a Moodle Partner I can work on your request.
* Vote and Watch the issue you have created

== Credits ==

Juan Leyva [http://moodle.org/user/view.php?id=49568&course=1 Moodle profile]

[http://twitter.com/jleyvadelgado Follow me in Twitter]

== Screenshots ==

=== Users report ===
[[Image:block_custom_reports_sample_user_report.png|600px]]

=== SQL report ===
[[Image:block_custom_reports_sample_sql_report.png|600px]]

== See Also ==

* CONTRIB-2386
* [https://tracker.moodle.org/issues/?jql=project%20%3D%20CONTRIB%20AND%20component%20%3D%20%22Block%3A%20Configurable%20report%22 Block: Configurable reports] Tracker component
* [http://moodle.org/plugins/view.php?plugin=block_configurable_reports Modules & Plugins] database entry
* [http://moodle.org/mod/forum/discuss.php?d=159820 Help forum]
* [[ad-hoc_contributed_reports|contributed reports]] (in plain SQL)
* [https://github.com/jleyva/moodle-configurable_reports_repository Configurable Reports Repository on GitHub]
* [https://www.youtube.com/watch?v=lF6CuY2Qiw0 Configurable Reports as a Learning Analytics Tool] - iMoot 2015 presentation by Elizabeth Dalton
* [http://opensourceelearning.blogspot.co.za/2015/08/moodle-configurable-reports-plugin-all.html All Variables and Filters] - Lists the Variables and Filters you can use in a report

[[Category:Report]]
[[Category:Contributed_code]]

[[es:blocks/configurable_reports/]]

Redis cache store

2019-05-22T09:26:04Z

Libertymoodle: /* See also */

{{Performance}}
The Redis cache store is one of the best options to handle session and application cache as it supports: data guarantee, locking, key awareness. (and also can be used for [[Session_handling#Redis_session_driver|user's sessions caching]] in the config.php file)

Before Redis is available as a cache store, you will need to install [[Redis]] service (daemon) on your Moodle server, locally in case of a single Moodle app node architecture or externally if you are using a cluster of Moodle nodes. only then, you can configure Redis as an application or session level cache store.

If you are configuring a cluster of Moodle servers/nodes, the [[Redis]] service (daemon) should be installed on an external server and all Moodle nodes (servers/instances) should point to that external Redis. so all user's data is available when the user is using (connected to) any of the Moodle nodes, in case the user's connection is not persistent (sticky) to a specific node for the entire Moodle session. An external Redis (NoSQL) service can be installed on the main SQL server alongside the MySQL/MariaDB service, just make sure you have enough memory allocated on that server for both services.

A good practice is to give the [[Redis]] cache store prefix a proper short name and not leave it empty, as later on, it might conflict with user's session Redis cache you might choose to use, or other Moodle instances that will be installed on the same server. for example "my-school-name_cs_", where you replace "my-school-name" with your short school name. (and if you are also using a user's session store on the config.php file, you might like to prefix it with "my-school-name_us_")

When using a cluster setup with several Moodle instances on each node that belong to different Schools/Institutes/clients, make sure that you use the same Prefix for all Moodle instances that are on different nodes and are of the same School/Institute/Client.

==Installing Redis server==
* [https://www.linode.com/docs/databases/redis/install-and-configure-redis-on-centos-7 install and configure redis on centos 7]
* [https://www.digitalocean.com/community/tutorials/how-to-install-and-secure-redis-on-ubuntu-18-04 install and configure redis on Ubuntu 18.04]
* [[Session_handling#Redis_session_driver]] and [https://www.digitalocean.com/community/tutorials/how-to-set-up-a-redis-server-as-a-session-handler-for-php-on-ubuntu-14-04 How to Set Up a Redis Server as a Session Handler for PHP]
==Installing Redis php driver==
* For CentOS, you can use either [https://rpms.remirepo.net/ Remi] or [https://ius.io/ IUS] repositories, and install the [https://dl.iuscommunity.org/pub/ius/stable/CentOS/7/x86_64/repoview/php71u-pecl-redis.html php71u-pecl-redis] driver.
* [https://gist.github.com/hollodotme/418e9b7c6ebc358e7fda Redis php-fpm 7 driver on Ubuntu 14.04]

==See also==
* [https://gist.github.com/kabel/10023961 Monitor Redis stats (a php one page app)]
* MDL-48468 : Add a Redis cache store to Moodle core

[[de:Redis Cache]]

Talk:Caching

2019-05-21T16:18:03Z

Libertymoodle: /* Retire Memcache / Memcached */

When editing cache mappings most of a Primary store and a Final store setting. These setting really need to be defined as to their purpose.

=== Redis Cache Store Instance ===
The '''Section 6 Adding cache store instances''' section of this doc has these four options:

6.1 File cache
6.2 Memcache
6.3 Memcached
6.4 MongoDB

What about Redis? Can a "Redis cache store instance" be used here too? If so, please expand the article to explain this.

=== Memcache / Memcached ===
As of May 2019 various documents indicate that Memcache and Memcached are old technologies that aren't fully compatible with PHP 7 anymore. Examples:
* MDL-55602 says "memcache is not PHP7 compatible".
* [https://moodle.org/mod/forum/discuss.php?d=355932#p1435923 Re: memcached problem]
* [https://moodle.org/mod/forum/discuss.php?d=371013#p1496352 Re: Memcahed and moodle 3.5]
* [https://moodle.org/mod/forum/discuss.php?d=366556 Upgrading 3.1.5 to 3.4.1]

Should this Memcache / Memcached section be removed from this documentation, or at least updated to indicate the modern alternatives that should be used instead?

Linked Tracker issue: MDL-65542

--[[User:Luis de Vasconcelos|Luis de Vasconcelos]] ([[User talk:Luis de Vasconcelos|talk]]) 11:23, 21 May 2019 (UTC)

Talk:Caching

2019-04-23T14:33:04Z

Libertymoodle: Addd a Redis Cache Store Instance

Talk:Caching

2019-04-23T14:32:01Z

Libertymoodle: Addd a Redis Cache Store Instance

No login

2019-03-15T06:56:18Z

Libertymoodle: /* See also - https link */

{{Authentication}}
An administrator may "turn off" or suspend a user's account by selecting "No Login" in the "Choose an authentication method setting" in the user's profile, or by ticking the 'Suspended account' checkbox.

[[File:newnologin.png]]

Different users have to have unique email addresses in their profile, even when email is not enabled. When the "No Login" setting is used, the account email may not be re-used to create another account. This essentially is a way to bar a particular user account from using Moodle for the duration that the account is assigned to this authentication type.

==See also==

Using Moodle forum discussions:
* [https://moodle.org/mod/forum/discuss.php?d=173432 What is the difference between suspending and soft-deleting a user?]
* [https://moodle.org/mod/forum/discuss.php?d=341147 Suspended vs Authentication: No login?]

[[fr:Pas de connexion]]
[[de:Kein_Login]]
[[es:Sin ingreso]]

No login

2019-03-15T06:55:27Z

Libertymoodle: /* See also links */

{{Authentication}}
An administrator may "turn off" or suspend a user's account by selecting "No Login" in the "Choose an authentication method setting" in the user's profile, or by ticking the 'Suspended account' checkbox.

[[File:newnologin.png]]

Different users have to have unique email addresses in their profile, even when email is not enabled. When the "No Login" setting is used, the account email may not be re-used to create another account. This essentially is a way to bar a particular user account from using Moodle for the duration that the account is assigned to this authentication type.

==See also==

Using Moodle forum discussions:
* [http://moodle.org/mod/forum/discuss.php?d=173432 What is the difference between suspending and soft-deleting a user?]
* [https://moodle.org/mod/forum/discuss.php?d=341147 Suspended vs Authentication: No login?]

[[fr:Pas de connexion]]
[[de:Kein_Login]]
[[es:Sin ingreso]]

Installing plugins

2019-03-11T15:05:12Z

Libertymoodle: Undo revision 133325 by Libertymoodle (talk)

{{Installing Moodle}}
==Why install additional plugins?==

Plugins enable you to add additional features and functionality to Moodle, such as new activities, new quiz question types, new reports, integrations with other systems and many more.

Note: Certain hosting solutions, such as [https://moodle.com/cloud/ MoodleCloud], prevent plugins being installed from within Moodle.

==Choosing the best plugins for your site==

Note: It is recommended that you proceed with caution and always try installing these plugins in a local experimental server before installing them in a production server.

* Moodle has a [https://moodle.org/plugins/report/index.php?report=favourites&p=0&l=50&s=favourited&d=DESC list of the most favourite plugins], which might be worth considering for adding to your site :)
* You can find the plugins with the largest number of downloads in the last three months at [https://moodle.org/plugins/stats.php https://moodle.org/plugins/stats.php]. These are the plugins most likely to be most useful for most sites. It would probably be a good idea to consider them first.
* You can test and try more than 50 of the most popular Moodle plugins at [http://plugins.moodlebites.com plugins.moodlebites.com]
* See the [https://moodle.org/mod/forum/discuss.php?d=325804 list of (year 2015) favorite plugins] by Gavin Henrick
* Moodle has a list of plugins that have received the [https://moodle.org/plugins/browse.php?list=award&id=1 Reviewers' choice award]. These are given by the plugins guardians and reviewers for particularly useful, well coded or otherwise interesting plugins.
* If your Moodle site needs assessment beyond the sixteen [https://docs.moodle.org/38/en/Question_types#Standard_question_types standard question types included in Moodle core], see the many (49 in 2017) available [https://docs.moodle.org/38/en/Third-party_question_types third party question types].
* Special cases:
** All plugins with ''mobile'' in their name, are related to [https://docs.moodle.org/38/en/Moodle_Mobile mobile devices].

===Elementary school teaching===
You might consider some plugins for [[Gamification|gamification]], such as the [https://moodle.org/plugins/mod_quizgame Quizventure].

===Plugins for K-12 teaching===
For [https://en.wikipedia.org/wiki/K%E2%80%9312 K-12] teaching and learning environments, please consider installing the plugins that are included in the [https://moodle.com/cloud/school/?utm_source=Sendy&utm_medium=Email&utm_campaign=Newsletter_July2016 Moodle for School at MoodleCloud]:
* [https://moodle.org/plugins/mod_attendance Attendance]
* [http://bigbluebutton.org/ BigBlueButton]
* [https://moodle.org/plugins/mod_checklist Checklist]
* [https://moodle.org/plugins/atto_chemistry Chemistry editor]
* [https://moodle.org/plugins/mod_choicegroup Group choice]
* [https://moodle.org/plugins/block_xp Level up!]
* [https://moodle.org/plugins/mod_quizgame Quizventure]
* [https://moodle.org/plugins/tinymce_wordcount Word count]

===Plugins for University teaching===
For universities, there is a [https://docs.moodle.org/38/en/Tertiary_education#Moodle_plugins_by.2Ffor_Universities list of plugins by/for Universities], and a [https://docs.moodle.org/38/en/Tertiary_education#Discipline-specific_plugins link to discipline-specific plugins], which might be worth considering.

== Considerations for production sites (skip if you're just moodling) ==

'''VERY IMPORTANT''' Warning: Please be aware that some plugins have not been reviewed, and the quality and/or suitability for your Moodle site has not been checked. Please be careful. It may not do what you expect, it may have serious security issues or it may even not work at all. This is however improving over time with the evolving new plugins directory system.

* If you have a large site for production purposes consider if you '''really''' need the plugin? More functionality means more things to support, more things to (potentially) go wrong and more things to worry about at upgrade time.
* Is the plugin supported and maintained? If something goes wrong can you get support? Will bugs be fixed?
* If the plugin does not work in a future version of Moodle, what will you do about it?
* Beware of ''patches'' ([https://moodle.org/plugins/browse.php?list=category&id=38 Moodle Plugins Directory Other category]) ! If a plugin modifies or replaces core files then be very careful. It can only be guaranteed to work with the exact build (version) of Moodle it was created for and is highly unlikely to survive a Moodle upgrade.
* Look at [https://moodle.org/mod/forum/discuss.php?d=340821#p1373707 this] and [https://moodle.org/mod/forum/discuss.php?d=346296 also this] forum threads of users worried about installing a plugin.

==Installing a plugin==

To install a plugin, its source code must be put (deployed) into the appropriate location inside the Moodle installation directory and the main administration page ''Administration > Site administration > Notifications'' must be visited. There are three ways how the plugin code can be deployed into Moodle.

Plugin code may be deployed from within Moodle, either directly from the Moodle plugins directory or by uploading a ZIP file. The web server process has to have write access to the plugin type folder where the new plugin is to be installed in order to use either of these methods.

Alternatively, a plugin may be deployed manually at the server.

===Installing directly from the Moodle plugins directory===

# Login as an admin and go to ''Site administration > Plugins > Install plugins''. (If you can't find this location, then plugin installation is prevented on your site.)
# Click the button 'Install plugins from Moodle plugins directory'.
# Search for a plugin with an Install button, click the Install button then click Continue.
# Confirm the installation request
# Check the plugin validation report

===Installing via uploaded ZIP file===

# Go to the [https://moodle.org/plugins Moodle plugins directory], select your current Moodle version, then choose a plugin with a Download button and download the ZIP file.
# Login to your Moodle site as an admin and go to ''Administration > Site administration > Plugins > Install plugins''.
# Upload the ZIP file. You should only be prompted to add extra details (in the Show more section) if your plugin is not automatically detected.
# If your target directory is not writeable, you will see a warning message.
# Check the plugin validation report

{|
| [[File:plugin1.png|thumb|Install plugins]]
| [[File:add-on package validation.png|thumb|Plugin package validation]]
|}

===Installing manually at the server===

If you can't deploy the plugin code via the administration web interface, you have to copy it to the server file system manually (e.g. if the web server process does not have write access to the Moodle installation tree to do this for you).

First, establish the correct place in the Moodle code tree for the plugin type. Common locations are:

* /path/to/moodle/theme/ - themes
* /path/to/moodle/mod/ - activity modules and resources
* /path/to/moodle/blocks/ - sidebar blocks
* /path/to/moodle/question/type/ - question types
* /path/to/moodle/course/format/ - course formats
* /path/to/moodle/admin/report/ - admin reports

See [[:dev:Plugins]] for the full list of all plugin types and their locations within the Moodle tree.

# Go to the [https://moodle.org/plugins Moodle plugins directory]; select your current Moodle version, then choose a plugin with a Download button and download the ZIP file.
# Upload or copy it to your Moodle server.
# Unzip it in the right place for the plugin type (or follow the plugin instructions).
# In your Moodle site (as admin) go to ''Site administration > Notifications'' (you should, for most plugin types, get a message saying the plugin is installed).

Note: The plugin may contain language files. They'll be found by your Moodle automatically. These language strings can be customized using the standard ''Site administration > Language'' editing interface. If you get a "Database error" when you try to edit your language files, there is a strong chance that the language files included within the downloaded ZIP file of this plugin have a coding problem. If you delete the ''plugin_name/lang/other_language_different_to_English/'' folder with the new language strings and the database error disappears, this is indeed the case. Please notify the plugin maintainer, so that it can be fixed in future releases.

==Troubleshooting==

===Errors===

If you obtain an error, please [[Debugging|turn debugging on]] to obtain additional information about the cause of the error.

;Database error while doing a language customization : May not be related to the [[Language_customisation#Database_error|Language customization]], but rather a problem with a recently installed plugin.

;tool_installaddon/err_curl_exec - cURL error 60 : This suggests problems with the validation of the SSL certificate of the remote (moodle.org) site. This is also a known problem in Moodle Windows 7 servers running the Moodle package for Windows. See [[SSL certificate for moodle.org]] for more info and possible solutions.

===A file permissions error has occurred===

On certain 3.0.x versions, when installing plugins via the administration interface, the Moodle uses the configuration settings <tt>$CFG->directorypermissions</tt> and <tt>$CFG->filepermissions</tt>. If these are not defined explicitly in your config.php, the default value is set automatically to 777 (rwxrwxrwx) for directories and 666 (rw-rw-rw-) for files (see lib/setup.php).

If this default behaviour does not fit your needs and hosting environment, you may wish to specify more strict setting such as

$CFG->directorypermissions = 02750;

A common error after installing plugins is that when you create an instance of the module and then save and display it, it reports the error, "A file permissions error has occurred. Please check the permissions on the script and the directory it is in and try again." If you get this, the file permissions of the package are mostl likely set to 711 preventing them from running correctly. With your preferred FTP client or via your web hosts control panel, set the file permissions of all the files and directories in the installed module, e.g. /moodle/mod/[myplugin]/ to 755 and then see if you can successfully view the module instance.

===Default exception handler: Error writing to database Debug: Duplicate entry 'en_us-...===
* These errors are usually caused by a third party plugin.
* To find the involved plugin, go to [http://lang.moodle.org http://lang.moodle.org] and use the AMOS tool to find all the strings with the given string identifier.
* Remove the suspected plugin and check if the error has disappeared. If so, please contact the plugin maintainer and report this issue.
* Please see [https://moodle.org/mod/forum/discuss.php?d=219504 this forum thread] for known causes and fixes.

===When installing manually===

* Check the file permissions. The web server needs to be able to read the plugin files. If the the rest of Moodle works then try to make the plugin permissions and ownership match.
* Did you '''definitely''' unzip or install the plugin in the correct place?
* Because Moodle scans plugin folders for new plugins you cannot have any other files or folders there. Make sure you deleted the zip file and don't try to rename (for example) an old version of the plugin to some other name - it will break.
* Make sure the directory name for the plugin is correct. All the names '''have''' to match. If you change the name, then it won't work.

===Obtaining help===

Ask in a forum in [http://moodle.org/course/view.php?id=5 Moodle in English]. Make sure you describe your system (including versions of MySQL, PHP etc.), what you tried and what happened. Copy and paste error messages exactly. Provide the link to the version of the plugin you downloaded (some have very similar names).

==Uninstalling a plugin==

To uninstall a plugin
# Go to ''Administration> Site Administration > Plugins > Plugins overview'' and click the Uninstall link opposite the plugin you wish to remove
# Use a file manager to remove/delete the actual plugin directory as instructed, otherwise Moodle will reinstall it next time you access the site administration

==Plugins overview==

[[File:plugins overview.png|thumb|center|400px|Plugins overview highlighting available check button]]

The Plugins overview page in ''Administration > Site Administration > Plugins > Plugins overview'' lists all installed plugins, together with the version number,release, availability (enabled or disabled) and settings link (if applicable).

A 'Check for available updates' button enables admins to quickly check for any updates available for plugins installed on the site (from the [http://moodle.org/plugins plugins directory]). Any updates available are highlighted, with further information and a download link in the notes column opposite the plugin.

===Plugin updating from within Moodle===

An administrator can enable updates deployment in ''Administration > Site Administration > Server > Update notifications''. Then when updates are available, 'Install this update' buttons are shown on the Plugins overview page. See [[Automatic updates deployment]] for more details.

==Preventing installing plugins from within Moodle==

If required, installing and updating from within Moodle can be prevented by copying the following lines of code from config-dist.php and pasting them in config.php.

<code php>
// Use the following flag to completely disable the installation of plugins
// (new plugins, available updates and missing dependencies) and related
// features (such as cancelling the plugin installation or upgrade) via the
// server administration web interface.
$CFG->disableupdateautodeploy = true;
</code>

==See also==
* [https://moodle.org/mod/forum/discuss.php?d=325804 list of (year 2015) favorite plugins] by Gavin Henrick
* [[Notifications]] for further details of update notifications
* [[Plugin Review Criteria]]
* [[Plugins FAQ]]
* Moodle in English [http://moodle.org/mod/forum/view.php?id=44 General plugins forum]
* [[Installing Moodle from Git repository#Installing a contributed extension from its Git repository|Installing a contributed extension from its Git repository]]

For developers:

*[[:dev:Category:Plugins|Plugins developer documentation]]
*[[:dev:Plugin validation]]
*[[:dev:On-click add-on installation]]

[[Category:Contributed code]]

[[de:Plugins installieren]]
[[es:Instalar complementos]]
[[fr:Installation de plugins]]
[[it:Installare plugin]]

Installing plugins

2019-03-11T15:03:51Z

Libertymoodle: /* Installing directly from the Moodle plugins directory - disable instructions */

{{Installing Moodle}}
==Why install additional plugins?==

Plugins enable you to add additional features and functionality to Moodle, such as new activities, new quiz question types, new reports, integrations with other systems and many more.

Note: Certain hosting solutions, such as [https://moodle.com/cloud/ MoodleCloud], prevent plugins being installed from within Moodle.

==Choosing the best plugins for your site==

Note: It is recommended that you proceed with caution and always try installing these plugins in a local experimental server before installing them in a production server.

* Moodle has a [https://moodle.org/plugins/report/index.php?report=favourites&p=0&l=50&s=favourited&d=DESC list of the most favourite plugins], which might be worth considering for adding to your site :)
* You can find the plugins with the largest number of downloads in the last three months at [https://moodle.org/plugins/stats.php https://moodle.org/plugins/stats.php]. These are the plugins most likely to be most useful for most sites. It would probably be a good idea to consider them first.
* You can test and try more than 50 of the most popular Moodle plugins at [http://plugins.moodlebites.com plugins.moodlebites.com]
* See the [https://moodle.org/mod/forum/discuss.php?d=325804 list of (year 2015) favorite plugins] by Gavin Henrick
* Moodle has a list of plugins that have received the [https://moodle.org/plugins/browse.php?list=award&id=1 Reviewers' choice award]. These are given by the plugins guardians and reviewers for particularly useful, well coded or otherwise interesting plugins.
* If your Moodle site needs assessment beyond the sixteen [https://docs.moodle.org/38/en/Question_types#Standard_question_types standard question types included in Moodle core], see the many (49 in 2017) available [https://docs.moodle.org/38/en/Third-party_question_types third party question types].
* Special cases:
** All plugins with ''mobile'' in their name, are related to [https://docs.moodle.org/38/en/Moodle_Mobile mobile devices].

===Elementary school teaching===
You might consider some plugins for [[Gamification|gamification]], such as the [https://moodle.org/plugins/mod_quizgame Quizventure].

===Plugins for K-12 teaching===
For [https://en.wikipedia.org/wiki/K%E2%80%9312 K-12] teaching and learning environments, please consider installing the plugins that are included in the [https://moodle.com/cloud/school/?utm_source=Sendy&utm_medium=Email&utm_campaign=Newsletter_July2016 Moodle for School at MoodleCloud]:
* [https://moodle.org/plugins/mod_attendance Attendance]
* [http://bigbluebutton.org/ BigBlueButton]
* [https://moodle.org/plugins/mod_checklist Checklist]
* [https://moodle.org/plugins/atto_chemistry Chemistry editor]
* [https://moodle.org/plugins/mod_choicegroup Group choice]
* [https://moodle.org/plugins/block_xp Level up!]
* [https://moodle.org/plugins/mod_quizgame Quizventure]
* [https://moodle.org/plugins/tinymce_wordcount Word count]

===Plugins for University teaching===
For universities, there is a [https://docs.moodle.org/38/en/Tertiary_education#Moodle_plugins_by.2Ffor_Universities list of plugins by/for Universities], and a [https://docs.moodle.org/38/en/Tertiary_education#Discipline-specific_plugins link to discipline-specific plugins], which might be worth considering.

== Considerations for production sites (skip if you're just moodling) ==

'''VERY IMPORTANT''' Warning: Please be aware that some plugins have not been reviewed, and the quality and/or suitability for your Moodle site has not been checked. Please be careful. It may not do what you expect, it may have serious security issues or it may even not work at all. This is however improving over time with the evolving new plugins directory system.

* If you have a large site for production purposes consider if you '''really''' need the plugin? More functionality means more things to support, more things to (potentially) go wrong and more things to worry about at upgrade time.
* Is the plugin supported and maintained? If something goes wrong can you get support? Will bugs be fixed?
* If the plugin does not work in a future version of Moodle, what will you do about it?
* Beware of ''patches'' ([https://moodle.org/plugins/browse.php?list=category&id=38 Moodle Plugins Directory Other category]) ! If a plugin modifies or replaces core files then be very careful. It can only be guaranteed to work with the exact build (version) of Moodle it was created for and is highly unlikely to survive a Moodle upgrade.
* Look at [https://moodle.org/mod/forum/discuss.php?d=340821#p1373707 this] and [https://moodle.org/mod/forum/discuss.php?d=346296 also this] forum threads of users worried about installing a plugin.

==Installing a plugin==

To install a plugin, its source code must be put (deployed) into the appropriate location inside the Moodle installation directory and the main administration page ''Administration > Site administration > Notifications'' must be visited. There are three ways how the plugin code can be deployed into Moodle.

Plugin code may be deployed from within Moodle, either directly from the Moodle plugins directory or by uploading a ZIP file. The web server process has to have write access to the plugin type folder where the new plugin is to be installed in order to use either of these methods.

Alternatively, a plugin may be deployed manually at the server.

===Installing directly from the Moodle plugins directory===

# Login as an admin and go to ''Site administration > Plugins > Install plugins''. (If you can't find this location, then plugin installation is prevented on your site. Refer to [https://docs.moodle.org/38/en/Automatic_updates_deployment#Disabling_updates_deployment Disabling_updates_deployment] for details on how to enable it.)
# Click the button 'Install plugins from Moodle plugins directory'.
# Search for a plugin with an Install button, click the Install button then click Continue.
# Confirm the installation request
# Check the plugin validation report

===Installing via uploaded ZIP file===

# Go to the [https://moodle.org/plugins Moodle plugins directory], select your current Moodle version, then choose a plugin with a Download button and download the ZIP file.
# Login to your Moodle site as an admin and go to ''Administration > Site administration > Plugins > Install plugins''.
# Upload the ZIP file. You should only be prompted to add extra details (in the Show more section) if your plugin is not automatically detected.
# If your target directory is not writeable, you will see a warning message.
# Check the plugin validation report

{|
| [[File:plugin1.png|thumb|Install plugins]]
| [[File:add-on package validation.png|thumb|Plugin package validation]]
|}

===Installing manually at the server===

If you can't deploy the plugin code via the administration web interface, you have to copy it to the server file system manually (e.g. if the web server process does not have write access to the Moodle installation tree to do this for you).

First, establish the correct place in the Moodle code tree for the plugin type. Common locations are:

* /path/to/moodle/theme/ - themes
* /path/to/moodle/mod/ - activity modules and resources
* /path/to/moodle/blocks/ - sidebar blocks
* /path/to/moodle/question/type/ - question types
* /path/to/moodle/course/format/ - course formats
* /path/to/moodle/admin/report/ - admin reports

See [[:dev:Plugins]] for the full list of all plugin types and their locations within the Moodle tree.

# Go to the [https://moodle.org/plugins Moodle plugins directory]; select your current Moodle version, then choose a plugin with a Download button and download the ZIP file.
# Upload or copy it to your Moodle server.
# Unzip it in the right place for the plugin type (or follow the plugin instructions).
# In your Moodle site (as admin) go to ''Site administration > Notifications'' (you should, for most plugin types, get a message saying the plugin is installed).

Note: The plugin may contain language files. They'll be found by your Moodle automatically. These language strings can be customized using the standard ''Site administration > Language'' editing interface. If you get a "Database error" when you try to edit your language files, there is a strong chance that the language files included within the downloaded ZIP file of this plugin have a coding problem. If you delete the ''plugin_name/lang/other_language_different_to_English/'' folder with the new language strings and the database error disappears, this is indeed the case. Please notify the plugin maintainer, so that it can be fixed in future releases.

==Troubleshooting==

===Errors===

If you obtain an error, please [[Debugging|turn debugging on]] to obtain additional information about the cause of the error.

;Database error while doing a language customization : May not be related to the [[Language_customisation#Database_error|Language customization]], but rather a problem with a recently installed plugin.

;tool_installaddon/err_curl_exec - cURL error 60 : This suggests problems with the validation of the SSL certificate of the remote (moodle.org) site. This is also a known problem in Moodle Windows 7 servers running the Moodle package for Windows. See [[SSL certificate for moodle.org]] for more info and possible solutions.

===A file permissions error has occurred===

On certain 3.0.x versions, when installing plugins via the administration interface, the Moodle uses the configuration settings <tt>$CFG->directorypermissions</tt> and <tt>$CFG->filepermissions</tt>. If these are not defined explicitly in your config.php, the default value is set automatically to 777 (rwxrwxrwx) for directories and 666 (rw-rw-rw-) for files (see lib/setup.php).

If this default behaviour does not fit your needs and hosting environment, you may wish to specify more strict setting such as

$CFG->directorypermissions = 02750;

A common error after installing plugins is that when you create an instance of the module and then save and display it, it reports the error, "A file permissions error has occurred. Please check the permissions on the script and the directory it is in and try again." If you get this, the file permissions of the package are mostl likely set to 711 preventing them from running correctly. With your preferred FTP client or via your web hosts control panel, set the file permissions of all the files and directories in the installed module, e.g. /moodle/mod/[myplugin]/ to 755 and then see if you can successfully view the module instance.

===Default exception handler: Error writing to database Debug: Duplicate entry 'en_us-...===
* These errors are usually caused by a third party plugin.
* To find the involved plugin, go to [http://lang.moodle.org http://lang.moodle.org] and use the AMOS tool to find all the strings with the given string identifier.
* Remove the suspected plugin and check if the error has disappeared. If so, please contact the plugin maintainer and report this issue.
* Please see [https://moodle.org/mod/forum/discuss.php?d=219504 this forum thread] for known causes and fixes.

===When installing manually===

* Check the file permissions. The web server needs to be able to read the plugin files. If the the rest of Moodle works then try to make the plugin permissions and ownership match.
* Did you '''definitely''' unzip or install the plugin in the correct place?
* Because Moodle scans plugin folders for new plugins you cannot have any other files or folders there. Make sure you deleted the zip file and don't try to rename (for example) an old version of the plugin to some other name - it will break.
* Make sure the directory name for the plugin is correct. All the names '''have''' to match. If you change the name, then it won't work.

===Obtaining help===

Ask in a forum in [http://moodle.org/course/view.php?id=5 Moodle in English]. Make sure you describe your system (including versions of MySQL, PHP etc.), what you tried and what happened. Copy and paste error messages exactly. Provide the link to the version of the plugin you downloaded (some have very similar names).

==Uninstalling a plugin==

To uninstall a plugin
# Go to ''Administration> Site Administration > Plugins > Plugins overview'' and click the Uninstall link opposite the plugin you wish to remove
# Use a file manager to remove/delete the actual plugin directory as instructed, otherwise Moodle will reinstall it next time you access the site administration

==Plugins overview==

[[File:plugins overview.png|thumb|center|400px|Plugins overview highlighting available check button]]

The Plugins overview page in ''Administration > Site Administration > Plugins > Plugins overview'' lists all installed plugins, together with the version number,release, availability (enabled or disabled) and settings link (if applicable).

A 'Check for available updates' button enables admins to quickly check for any updates available for plugins installed on the site (from the [http://moodle.org/plugins plugins directory]). Any updates available are highlighted, with further information and a download link in the notes column opposite the plugin.

===Plugin updating from within Moodle===

An administrator can enable updates deployment in ''Administration > Site Administration > Server > Update notifications''. Then when updates are available, 'Install this update' buttons are shown on the Plugins overview page. See [[Automatic updates deployment]] for more details.

==Preventing installing plugins from within Moodle==

If required, installing and updating from within Moodle can be prevented by copying the following lines of code from config-dist.php and pasting them in config.php.

<code php>
// Use the following flag to completely disable the installation of plugins
// (new plugins, available updates and missing dependencies) and related
// features (such as cancelling the plugin installation or upgrade) via the
// server administration web interface.
$CFG->disableupdateautodeploy = true;
</code>

==See also==
* [https://moodle.org/mod/forum/discuss.php?d=325804 list of (year 2015) favorite plugins] by Gavin Henrick
* [[Notifications]] for further details of update notifications
* [[Plugin Review Criteria]]
* [[Plugins FAQ]]
* Moodle in English [http://moodle.org/mod/forum/view.php?id=44 General plugins forum]
* [[Installing Moodle from Git repository#Installing a contributed extension from its Git repository|Installing a contributed extension from its Git repository]]

For developers:

*[[:dev:Category:Plugins|Plugins developer documentation]]
*[[:dev:Plugin validation]]
*[[:dev:On-click add-on installation]]

[[Category:Contributed code]]

[[de:Plugins installieren]]
[[es:Instalar complementos]]
[[fr:Installation de plugins]]
[[it:Installare plugin]]

Talk:Capabilities/mod/quiz:manage

2019-03-11T11:17:25Z

Libertymoodle: /* Request for clarity */

The one line explanation on this page says: "This allows a user to manage quizzes".

What does that mean? When managing quizzes what can you do and what can't you do?

Can someone expand this doc to answer that and clarify the meaning of "This allows a user to manage quizzes". I'm not sure what that means.
--[[User:Luis de Vasconcelos|Luis de Vasconcelos]] ([[User talk:Luis de Vasconcelos|talk]]) 11:16, 11 March 2019 (UTC)

Moodle migration

2018-12-19T09:56:06Z

Libertymoodle: /* Formatting */

{{Installing Moodle}}
There may be times when you need to move your Moodle site from one server to another. For example, moving a Moodle site from shared hosting service's server to a dedicated server.

==Recommended method==

This involves moving a whole site from one server to another. If you are changing the domain/IP address to the new server you need to do these steps:

===Turn on maintenance mode===

Place your current Moodle site into [[Maintenance mode]] via ''Site Administration > Server > Maintenance Mode'' to prevent any further additions to the Moodle database. Don't let administrators login during the migration as they are not affected by the maintenance mode setting.

===Backup the Moodle database on the old sever===

The right way to back up your database depends on which database system you are using. The instructions below are one way to back up a MySQL database. Another option would be to use a tool like phpMyAdmin to manually make a backup. The documentation for your database will give more options. There are many ways to do such backups. Here is an outline of a little script you can run from command line on Unix to backup the database:

<pre>
cd /my/backup/directory
mv moodle-database.sql.gz moodle-database-old.sql.gz
mysqldump -h example.com -u myusername -p'mypassword' -C -Q -e --create-options mydatabasename > moodle-database.sql
</pre>
If you only write "-p" without your password, you will be prompted for it.

=== Restore the database backup to the new server ===

Copy the database back up files to the new server and restore into the new database server.

Once you have created the new database on the new server:

<pre>mysql -p new_database < moodle-database.sql</pre>

For other databases, follow their instructions for restoring a backup.

===Copy moodledata from the old server to the new server===

Copy the contents of your data directory (check for the value in <code>$CFG->dataroot</code>) to the new server. This can be a lot of data, so consider using a good data copying tool like [https://rsync.samba.org/ rsync]. If using an FTP client, the transfer of the <code>filedir</code> folder must be in '''BINARY''' mode or the files will get corrupted in the process.

NB: It is not necessary to copy the contents of these directories:
* /moodledata/cache
* /moodledata/localcache
* /moodledata/sessions
* /moodledata/temp
* /moodledata/trashdir
Omitting these files will reduce transfer time substantially.

Check the file permissions of the copied files. The web server needs read and write access.

===Copy the Moodle code from the old server to the new server===

You will need to copy the Moodle code itself to the new server (this is the Moodle folder found in your webroot folder e.g. /var/www or public_html).

Check the file permissions of the copied files. The web server needs read access.

===Update config.php with the URL of the new server===

If the migration will move Moodle to a new URL, then update $CFG->wwwroot in config.php to point to the new location.

Also check the other properties there. Is the path $CFG->moodledata still correct? Do the database connection settings need to be changed?

===Test the copied site===

You should now be able to log into the new site as admin, and verify that most things are working.

===Update links containing wwwroot in the database===

The one thing we have not fixed is any internal links stored in the database. To fix these use the [[Search and replace tool]] by going to {wwwroot}/admin/tool/replace/index.php.

Enter the url for your old server (<nowiki>http://oldserver.com/</nowiki>) and new server (<nowiki>http://newserver.com/</nowiki>) and it will fix any links stored in the database.

===Take the site out of maintenance mode===

Test the migration some more, then when you are satisfied, remember to take the site out of maintenance mode.

==Quick and hacky method==

If you have shell access on both servers, here is a quick command-line based method.

*Set up a new empty database on the '''new''' server.
*Place your existing Moodle site into maintenance mode.
*Login to shell on the '''old''' existing server.
*Use rsync to copy '''moodledata''' and '''public_html''' or '''moodle''' folders (or whatever directory your Moodle install is in) to the new server - execute (replacing caps with your details; SOURCE = the directory you want to copy) for each directory:
::<code>rsync -av -e ssh SOURCE/ USERNAME@NEW_SERVER.COM:/PATH/TO/DESTINATION/</code>
*Dump existing database and move and import into database on new server by executing:
::<code>mysqldump --allow-keywords --opt -uMySQL_USERNAME -pPASSWORD DATABASE | ssh USER@DOMAIN "mysql -uMySQL_USERNAME -pPASSWORD DATABASE"</code>
*Replace any links in the database that contin the full site URL:
::<code>#sed -e 's/oldserver.com/newserver.com/g' oldmysqldump.sql > newmysqldump.sql</code>
*On the '''new server''', update '''config.php''' with relevant details where applicable (e.g. database name and user details, the wwwroot and the dataroot).
*Check ownership and permissions are correct on both moodle code and moodledata directories.
*Make sure everything is working.

Takes about 15 minutes for a small site. However, transferring several Gigabytes of data for a larger site can take hours depending on your network connection and hard drive read/write speed.

When you are happy all has gone well, set up redirects/make DNS changes if required, take new site out of maintenance mode and "switch off" old site.

*If you are switching the ip address from the old server to the new one, you will need to turn off the old server before firing up the new one to avoid ip addressing conflicts and confusion!

==Other considerations==

===Upgrade Moodle at the same time?===

While doing the work of migrating Moodle, you might want to [[Upgrading | upgrade Moodle]] to the latest version at the same time. On the other hand, if you do that, and something breaks, you won't be sure which change caused the problem, so the more cautious approach is to change one thing at a time, and test in between to verify that all is well.

===DNS & masquerading changes===

You may have had to change the DNS entries for the new Moodle site. If you have done so, it will take some time for the changes to replicate, so be patient. If your server is located behind a firewall, you may also have to change your firewall rules to allow access to the new server. See the [[Masquerading | masquerading docs]].

===Internal and external access===

If you have a set up where your Moodle site can be accessed via a network and via the internet, ensure you check that the new site can be accessed internally and externally.

===reCAPTCHA===
If you migrate to a new domain and have setup [[Email-based_self-registration]], you need to create new API-Keys at google. You will find the explanation and links to google in [[Email-based_self-registration]].

==See also==

* [[Site backup]]
* [[Site restore]]
* [[Backup and restore FAQ]]

==Any questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=28 Installing and upgrading help forum] on moodle.org

[[es:Migración de Moodle]]
[[fr:Migration de Moodle]]
[[ja:Moodle移行]]
[[de:Moodle-Migration]]

Moodle migration

2018-12-19T09:50:06Z

Libertymoodle: /* Formatting */

{{Installing Moodle}}
There may be times when you need to move your Moodle site from one server to another. For example, moving a Moodle site from shared hosting service's server to a dedicated server.

==Recommended method==

This involves moving a whole site from one server to another. If you are changing the domain/IP address to the new server you need to do these steps:

===Turn on maintenance mode===

Place your current Moodle site into [[Maintenance mode]] via ''Site Administration > Server > Maintenance Mode'' to prevent any further additions to the Moodle database. Don't let administrators login during the migration as they are not affected by the maintenance mode setting.

===Backup the Moodle database on the old sever===

The right way to back up your database depends on which database system you are using. The instructions below are one way to back up a MySQL database. Another option would be to use a tool like phpMyAdmin to manually make a backup. The documentation for your database will give more options. There are many ways to do such backups. Here is an outline of a little script you can run from command line on Unix to backup the database:

<pre>
cd /my/backup/directory
mv moodle-database.sql.gz moodle-database-old.sql.gz
mysqldump -h example.com -u myusername -p'mypassword' -C -Q -e --create-options mydatabasename > moodle-database.sql
</pre>
If you only write "-p" without your password, you will be prompted for it.

=== Restore the database backup to the new server ===

Copy the database back up files to the new server and restore into the new database server.

Once you have created the new database on the new server:

<pre>mysql -p new_database < moodle-database.sql</pre>

For other databases, follow their instructions for restoring a backup.

===Copy moodledata from the old server to the new server===

Copy the contents of your data directory (check for the value in <code>$CFG->dataroot</code>) to the new server. This can be a lot of data, so consider using a good data copying tool like [https://rsync.samba.org/ rsync]. If using an FTP client, the transfer of the <code>filedir</code> folder must be in '''BINARY''' mode or the files will get corrupted in the process.

NB: It is not necessary to copy the contents of these directories:
* /moodledata/cache,
* /moodledata/localcache,
* /moodledata/sessions,
* /moodledata/temp, or
* /moodledata/trashdir
Omitting these files will reduce transfer time substantially.

Check the file permissions of the copied files. The web server needs read and write access.

===Copy the Moodle code from the old server to the new server===

You will need to copy the Moodle code itself to the new server (this is the Moodle folder found in your webroot folder e.g. /var/www or public_html).

Check the file permissions of the copied files. The web server needs read access.

===Update config.php with the URL of the new server===

If the migration will move Moodle to a new URL, then update $CFG->wwwroot in config.php to point to the new location.

Also check the other properties there. Is the path $CFG->moodledata still correct? Do the database connection settings need to be changed?

===Test the copied site===

You should now be able to log into the new site as admin, and verify that most things are working.

===Update links containing wwwroot in the database===

The one thing we have not fixed is any internal links stored in the database. To fix these use the [[Search and replace tool]] by going to {wwwroot}/admin/tool/replace/index.php.

Enter the url for your old server (<nowiki>http://oldserver.com/</nowiki>) and new server (<nowiki>http://newserver.com/</nowiki>) and it will fix any links stored in the database.

===Take the site out of maintenance mode===

Test the migration some more, then when you are satisfied, remember to take the site out of maintenance mode.

==Quick and hacky method==

If you have shell access on both servers, here is a quick command-line based method.

*Set up a new empty database on the '''new''' server.
*Place your existing Moodle site into maintenance mode.
*Login to shell on the '''old''' existing server.
*Use rsync to copy '''moodledata''' and '''public_html''' or '''moodle''' folders (or whatever directory your Moodle install is in) to the new server - execute (replacing caps with your details; SOURCE = the directory you want to copy) for each directory:
::<code>rsync -av -e ssh SOURCE/ USERNAME@NEW_SERVER.COM:/PATH/TO/DESTINATION/</code>
*Dump existing database and move and import into database on new server by executing:
::<code>mysqldump --allow-keywords --opt -uMySQL_USERNAME -pPASSWORD DATABASE | ssh USER@DOMAIN "mysql -uMySQL_USERNAME -pPASSWORD DATABASE"</code>
*Replace any links in the database that contin the full site URL:
::<code>#sed -e 's/oldserver.com/newserver.com/g' oldmysqldump.sql > newmysqldump.sql</code>
*On the '''new server''', update '''config.php''' with relevant details where applicable (e.g. database name and user details, the wwwroot and the dataroot).
*Check ownership and permissions are correct on both moodle code and moodledata directories.
*Make sure everything is working.

Takes about 15 minutes for a small site. However, transferring several Gigabytes of data for a larger site can take hours depending on your network connection and hard drive read/write speed.

When you are happy all has gone well, set up redirects/make DNS changes if required, take new site out of maintenance mode and "switch off" old site.

*If you are switching the ip address from the old server to the new one, you will need to turn off the old server before firing up the new one to avoid ip addressing conflicts and confusion!

==Other considerations==

===Upgrade Moodle at the same time?===

While doing the work of migrating Moodle, you might want to [[Upgrading | upgrade Moodle]] to the latest version at the same time. On the other hand, if you do that, and something breaks, you won't be sure which change caused the problem, so the more cautious approach is to change one thing at a time, and test in between to verify that all is well.

===DNS & masquerading changes===

You may have had to change the DNS entries for the new Moodle site. If you have done so, it will take some time for the changes to replicate, so be patient. If your server is located behind a firewall, you may also have to change your firewall rules to allow access to the new server. See the [[Masquerading | masquerading docs]].

===Internal and external access===

If you have a set up where your Moodle site can be accessed via a network and via the internet, ensure you check that the new site can be accessed internally and externally.

===reCAPTCHA===
If you migrate to a new domain and have setup [[Email-based_self-registration]], you need to create new API-Keys at google. You will find the explanation and links to google in [[Email-based_self-registration]].

==See also==

* [[Site backup]]
* [[Site restore]]
* [[Backup and restore FAQ]]

==Any questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=28 Installing and upgrading help forum] on moodle.org

[[es:Migración de Moodle]]
[[fr:Migration de Moodle]]
[[ja:Moodle移行]]
[[de:Moodle-Migration]]

Search and replace tool

2018-11-01T13:16:31Z

Libertymoodle: /* Update warning */

{{Admin tools}}
Admins can search and replace text e.g. URLs in their Moodle database using the search and replace tool at <nowiki>http://yourmoodlesite.org/admin/tool/replace/index.php</nowiki> (replacing yourmoodlesite.org with the address of your Moodle site). This is useful when a [[Moodle migration|Moodle site is moved from one server to another]] or when the URL changes.

Alternatively, a command line script can be used to search and replace text. See [[Administration via command line]] for details.

{{Warning|A database and site backup should be created before performing a search and replace.}}

==See also==

* Tracker issue MDL-35099 Convert hidden search/replace script into a proper core admin tool

[[es:Herramienta para buscar y remplazar]]
[[fr: Recherche et remplacement]]
[[de:Datenbank-Suche]]

Talk:Search and replace tool

2018-10-31T11:50:55Z

Libertymoodle: /* Need to improve "Shorten result if necessary" */

In recent versions of Moodle this Search and Replace tool has an additional checkbox called "Shorten result if necessary", so this screenshot is out of date.

What is this "Shorten result if necessary" checkbox? What does "Shorten result if necessary" mean?

And what are "the risks of this operation"? Those risks should be listed here. Not everybody is able to read PHP code to try and work out the risks themselves.
--[[User:Luis de Vasconcelos|Luis de Vasconcelos]] ([[User talk:Luis de Vasconcelos|talk]]) 13:01, 16 September 2014 (WST)

:Thanks Luis, I have removed the out-of-date screenshot. --[[User:Helen Foster|Helen Foster]] ([[User talk:Helen Foster|talk]]) 16:14, 25 August 2015 (AWST)

:: What does "Shorten result if necessary" do? Can somebody add an explanation to this topic? --[[User:Luis de Vasconcelos|Luis de Vasconcelos]] ([[User talk:Luis de Vasconcelos|talk]]) 11:50, 31 October 2018 (UTC)

HTTPS conversion tool

2018-10-29T10:19:27Z

Libertymoodle: /* Add Help argument */

{{Security}}
[[File:HTTPStool.png|thumb|left|HTTPS conversion tool]]The HTTPS conversion tool in Moodle 3.4 onwards will convert any embedded HTTP content (not links) on your site to HTTPS in order for it to display correctly on your HTTPS site. It is accessed from the HTTP security screen of Site administration, or by typing directly ''YOURMOODLESITE.com''/admin/tool/httpsreplace/index.php (where YOURMOODLESITE.com is the name of your site).

Before performing the conversion, content will be scanned to find any URLs which may not work after conversion i.e. any domains which do not appear to support HTTPS content. After switching to HTTPS, the content included from these sites will no longer display within Moodle for users with secure modern browsers. These problematic domains will be converted, but obviously won't work once the conversion is complete, hence they are reported for audit prior to the conversion process.

There is also a CLI conversion tool. To list domains that need conversion:

php admin/tool/httpsreplace/cli/url_replace.php -l

To perform the conversion:

php admin/tool/httpsreplace/cli/url_replace.php -r --confirm

To view Help:

php admin/tool/httpsreplace/cli/url_replace.php -h

==See also==

* MDL-46269

[[es:Herramienta para conversión a HTTPS]]
[[de:HTTPS Konvertierung]]

Custom SQL queries report

2017-03-09T09:31:32Z

Libertymoodle: /* typo fix */

{{Sitewide reports}}
Created by The Open University

This admin report plugin allows Administrators to set up arbitrary database queries to act as ad-hoc reports. Reports can be of two types: either run on demand, or scheduled to run automatically. Other users with the right capability can go in and see a list of queries that they have access to. Results can be viewed on-screen or downloaded as CSV.

==Installing this report==

Follow the generic [[Installing plugins]] documentation.

==Screen shots==

Here are two example screen shots, showing the two main screens.

[[Image:Custom_report_list.png|thumb|none|600px|The list of available reports]]
[[Image:Custom_report.png|thumb|none|600px|The results of running one of the reports]]

(Note, these screen shots are in the OU theme, not the standard Moodle theme, and iCMA is OU-jargon for quiz.)

==Interface for normal users==

===List of available queries===

Users with the report/customsql:view capability can access the list of reports in the admin block. Each query is accessible only to a certain people. There are three levels of access:
* Available to any one who can access the report at all (those with report/customsql:view).
* Available to people who are able to see other system reports (those with moodle/site:viewreports)
* Available to administrators only (those with moodle/site:config)

When you go to the list, it will only show the queries you have access to. There is a note beside each query saying when it was last run, and how long it took to generate.

The list shows on-demand and scheduled queries separately.

===Running an on-demand query===

To run an on-demand query, click on its name in the list of queries.

The query will be run, and the results will be displayed as a table. Any URLs in the table will automatically be made into hyperlinks.

A description of the query may appear above the table.

The summary of when the query was run and how long it took is shown at the bottom, along with a link to download the CSV file (for example to get the data into Excel) and a link back to the list of all available queries.

===Viewing the results of scheduled queries===

Scheduled queries can work in one of two ways. Either each run of the report generates and entire table of reasults, or each run just creates one line of results, and the report builds up a row at a time.

When you click the name in the list of queries, you get taken to a display of the latest results, just like in the on-demand case.

However, if each scheduled run generates a complete report, then at the bottom of a page there will be a list of all the previous runs of the report, so that you can go and see how the report changed over time.

==Interface for administrators==

Administrators (that is, users with report/customsql:definequeries) see everything that other users see, but with some additions.

===Additional controls in the staff interface===

Administrators get shown who each report in the list is available to.

They also get an edit and a delete icon next to each query.

There is an '''Add new query button''' at the end of the list of queries.

When viewing a particular query, Administrators get an edit and a delete link underneath the table of results.

===Adding or editing a query===

When you click the '''Add new query button''', you get taken to an editing form that lets you define the query.

You must give the query a name.

You can optionally enter a description that is displayed above the results table. You should use this to explain what the results of the query mean.

You must enter the SQL to generate the results you want displayed. This must be an SQL select statement. You must use the prefix prefix_ for table names. It should not be possible to enter any SQL that would alter the contents of the database.

You choose who you want the query to be accessible to.

You choose whether the query should be run on-demand or scheduled weekly or monthly. If the report is scheduled, you can say whether the each run returns one row to be added to a single table, or whether each run generates a separate table.

When you save the new query, the SQL is checked to make sure that it will execute without errors. If you have said that the report will only return a single row, this is also checked.
After saving the query, if this was a manual query, you are taken to the query results page, so you can see what the results look like. If it was an automatic query or if you cancel the form, you are taken to the list of available queries.

Editing an existing query uses the same form as for adding a new query, but to change the properties of an existing query.

Note that at the OU, weeks start on Saturday. If you don't like that, there is a fairly obvious constant to hack at the top of locallib.php.

===Deleting a query===

When you click the delete icon or link for a query, you are taken to a confirmation page that shows you SQL of the query you are about to delete. The query is only deleted if you click Yes on the confirmation page.

After deleting a query, you are taken back to the list of queries.

==Share your interesting queries here==

If you come up with any interesting SQL to custom reports, you can share it here.

===Quiz attempts in the last week/month===

Set this up as a scheduled report:

<code sql>
SELECT COUNT(*)
FROM prefix_quiz_attempts
WHERE timefinish > %%STARTTIME%%
AND timefinish <= %%ENDTIME%%
AND preview = 0
</code>

This '''must''' be set up as a '''Scheduled, on the first day of each week''' or '''Scheduled, on the first day of each month''' report, or it will not work.

===Usage summary===

This report shows roughly the same usage statistics that are sent to moodle.org when you register your site. The ones that are aggregated at http://moodle.org/stats/. (The only difference is that the registration form does not do AND confirmed = 1 for some reason.

<code sql>
SELECT
(SELECT COUNT(id) FROM prefix_course) - 1 AS courses,
(SELECT COUNT(id) FROM prefix_user WHERE deleted = 0 AND confirmed = 1) AS users,
(SELECT COUNT(DISTINCT ra.userid)
FROM prefix_role_capabilities rc
JOIN prefix_role_assignments ra ON ra.roleid = rc.roleid
WHERE rc.capability IN ('moodle/course:upd' || 'ate', 'moodle/site:doanything')) AS teachers,
(SELECT COUNT(id) FROM prefix_role_assignments) AS enrolments,
(SELECT COUNT(id) FROM prefix_forum_posts) AS forum_posts,
(SELECT COUNT(id) FROM prefix_resource) AS resources,
(SELECT COUNT(id) FROM prefix_question) AS questions
</code>

There are two interesting queries in this blog post [http://tjhunt.blogspot.com/2010/03/when-do-students-submit-their-online.html When do students submit their online tests?].

===Monthly Usage by Role===

This report shows a distinct count of users by their role, accessing your site. Each instance of user and role is counted once per month, no matter how many courses they access. We use this to show the total number of students and teachers accessing our site.

<code sql>
SELECT
month(from_unixtime(`prefix_stats_user_monthly`.`timeend`)) AS calendar_month,
year(from_unixtime(`prefix_stats_user_monthly`.`timeend`)) AS calendar_year,
prefix_role.name as user_role,
COUNT(DISTINCT prefix_stats_user_monthly.userid) AS total_users
FROM
prefix_stats_user_monthly
Inner Join prefix_role_assignments ON prefix_stats_user_monthly.userid = prefix_role_assignments.userid
Inner Join prefix_context ON prefix_role_assignments.contextid = prefix_context.id
Inner Join prefix_role ON prefix_role_assignments.roleid = prefix_role.id
WHERE prefix_context.contextlevel = 50
AND `prefix_stats_user_monthly`.`stattype` = 'activity'
AND prefix_stats_user_monthly.courseid <>1
GROUP BY month(from_unixtime(`prefix_stats_user_monthly`.`timeend`)),
year(from_unixtime(`prefix_stats_user_monthly`.`timeend`)),
prefix_stats_user_monthly.stattype,
prefix_role.name
ORDER BY
year(from_unixtime(`prefix_stats_user_monthly`.`timeend`)), month(from_unixtime(`prefix_stats_user_monthly`.`timeend`)),
prefix_role.name
</code>

You must have Statistics turned on to be able to generate any data with this report.

PostgreSQL version of the Monthly Usage by Role query:

<code sql>
SELECT
extract(month from to_timestamp(prefix_stats_user_monthly.timeend)) AS calendar_month,
extract(year from to_timestamp(prefix_stats_user_monthly.timeend)) AS calendar_year,
prefix_role.name AS user_role,
COUNT(DISTINCT prefix_stats_user_monthly.userid) AS total_users
FROM
prefix_stats_user_monthly
INNER JOIN prefix_role_assignments ON prefix_stats_user_monthly.userid = prefix_role_assignments.userid
INNER JOIN prefix_context ON prefix_role_assignments.contextid = prefix_context.id
INNER JOIN prefix_role ON prefix_role_assignments.roleid = prefix_role.id
WHERE prefix_context.contextlevel = 50
AND prefix_stats_user_monthly.stattype = 'activity'
AND prefix_stats_user_monthly.courseid <>1
GROUP BY extract(month from to_timestamp(prefix_stats_user_monthly.timeend)),
extract(year from to_timestamp(prefix_stats_user_monthly.timeend)),
prefix_stats_user_monthly.stattype,
prefix_role.name
ORDER BY
extract(year from to_timestamp(prefix_stats_user_monthly.timeend)), extract(month from to_timestamp(prefix_stats_user_monthly.timeend)),
prefix_role.name
</code>

===Show all Quiz results across a site===
I'm sure someone will be able to improve upon this, but this is a query that will show Quiz results across a site. --[[User:Stuart Mealor|Stuart Mealor]] 22:07, 9 April 2010 (UTC)

<code sql>
SELECT
prefix_grade_items.itemname,
prefix_grade_items.grademax,
ROUND(prefix_grade_grades.finalgrade, 0) AS finalgrade,
prefix_user.firstname,
prefix_user.lastname,
prefix_user.username
FROM
prefix_grade_grades
INNER JOIN prefix_user ON prefix_grade_grades.userid = prefix_user.id
INNER JOIN prefix_grade_items ON prefix_grade_grades.itemid = prefix_grade_items.id
WHERE (prefix_grade_items.itemname IS NOT NULL)
AND (prefix_grade_items.itemtype = 'mod' OR prefix_grade_items.itemtype = 'manual')
AND (prefix_grade_items.itemmodule = 'quiz' OR prefix_grade_items.itemmodule IS NULL)
AND (prefix_grade_grades.timemodified IS NOT NULL)
AND (prefix_grade_grades.finalgrade > 0)
AND (prefix_user.deleted = 0)
</code>

==See also==

* [http://moodle.org/mod/forum/discuss.php?d=136484 Custom SQL queries report] forum announcement
* list of [[ad-hoc contributed reports]]
* [http://moodle.org/mod/forum/discuss.php?d=153059 Forum post] with some more useful queries.
* [http://moodle.org/mod/data/view.php?d=13&rid=2884 Modules and plugins database entry]
* [[Configurable_reports|Configurable reports]] block

[[Category:Contributed_code]]

[[es:Reportes de consultas personalizadas SQL]]
[[fr:admin/report/customsql/index]]

Talk:Moodle migration

2016-04-25T09:51:36Z

Libertymoodle: /* Add info for load balanced Moodle sites */

== Moodle on Multiple Servers ==
This article is written with the assumption that Moodle will be hosted on a single server. But what about large Moodle installations that are hosted on multiple "load balanced" servers? These sites may share the Moodledata folder using e.g. NAS storage. The database may also be hosted on a different database server. Is the migration process any different for these multi-server sites? If so, what needs to be done differently when migrating these sites? Example: how should caching be configured on these multi-server environments?
--[[User:Luis de Vasconcelos|Luis de Vasconcelos]] ([[User talk:Luis de Vasconcelos|talk]]) 17:51, 25 April 2016 (AWST)

Configurable reports

2016-04-14T10:46:05Z

Libertymoodle: /* See Also */

{{Infobox plugin
|type = Block
|entry = https://moodle.org/plugins/view.php?plugin=block_configurable_reports
|tracker = http://tracker.moodle.org/browse/CONTRIB/component/10753
|discussion = https://moodle.org/mod/forum/view.php?id=7979
|maintainer = [[User:Juan Leyva|Juan Leyva]]
|float = right
}}

== Installation ==

# Download the Configurable Reports installation file and unzip it to the '''\blocks''' directory in your Moodle folder.
# Be sure that the final name of the directory is: configurable_reports, the full path in your Moodle installation will be blocks/configurable_reports
# Login to Moodle as Administrator and click Notifications under Site Administration.

For more information see [[Installing contributed modules or plugins]]

== Overview ==

This block is a Moodle custom reports builder. It its also connected to a [https://github.com/jleyva/moodle-configurable_reports_repository public repository of sample reports] (only plugin version 2.3 and above)

It is designed in a modular way to allow developers to create new plugins in less than an hour.

'''Who can create custom reports?'''

Anyone with block, managereports or manageownreports permissions at SITE level or COURSE level.

'''What type of reports can I create?'''

- Courses reports, with information regarding courses.

- Categories reports, with information regarding categories. A courses report can be embedded in this type of report.

- Users reports, with information regarding users and their activity in a course.

- Timeline reports, this is a special type of report that displays a timeline. A course or user report can be embedded in this timeline showing data depending on the start and end time of the current row.

- Custom SQL Reports, custom SQL queries. This block can use the same SQL queries as [https://moodle.org/plugins/view.php?plugin=report_customsql Tim Hunt's Custom SQL queries] plugin.

Note for developers: You can create your own type of reports.

'''Who can view the reports?'''

When you create a report you can select which users can view it.

The reports are displayed in a block in the course or site frontpage.

== Creating a report ==

This is a very simple process.

If you are going to create a report for a course, you have to add the block in the course and click in the "Manage reports" link.

On the other hand, for site reports, add the block in the frontpage and click in the "Manage reports" link.

You must enter a name, an optional description, and you have to choose the type of report, pagination and exports formats.

Depending on the report choosen, there will be more or less tabs. These are the tabs for the courses and users report:

'''Columns''': Here you can choose the differents columns of your report depending on the type of report. (Course Name, User firstname, etc..)

'''Conditions''': Here you can define the conditions (i.e, only courses from this category, only users from Spain, etc.)

'''Ordering''': Here you can choose how to order the report using fields and directions.

'''Filters''': Here you can choose which filters will be displayed.

'''Template''': You can modify the report's layout by creating a template.

'''Permissions''': Here you can choose who can view a report.

'''Calculations''': Here you can add calculations for columns, i.e: average of number of users enrolled in courses

'''Plots''': Here you can add graphs to your report based on the report columns and values.

'''View report''': Self explanatory

== Tutorial ==

=== Creating a users' report ===

Requirements: ''Users from Spain, but not from Madrid, in this course. This report can be viewed only by users from Spain. A filter based on the user's city must be displayed. A pie plot showing the users' cities is required. A calculation table showing the total forum post views is required. The report must be ordered by users' lastname.''

Let's see how easy it is!

First of all, install the block.

Go to the course where the report will be created.

Add an instance of the Custom Reports block.

Click on "Manage reports"

Click on "Add report"

Enter a name, a description and choose "Users report" as Type of Report

The report will be saved and you will be redirected to the first Tab named "Columns".

'''Adding Columns'''

Here you can define the report table properties, width, align, cell padding, cell spacing, etc.

Add a Column called "User profile field"

Choose the field "firstname" and enter a name for the column in the text field. You can leave the rest of elements blank.

Repeat the process above for the lastname and city fields.

Add a Column called "User module actions".

Choose a module from the list, in this example, a forum.

'''Adding Conditions'''

Click on the Conditions Tab.

Add a Condition named "User field Condition".

Choose the column "Country", the Operator "=", and enter the value "ES" (this is the international code for Spain as Moodle stores it).

Add a Condition named "User field Condition".

Choose the column "city", the Operator "<>", and enter the value "Madrid".

Add a Condition named "Users in current report course".

These are the main conditions of the reports. Note that at the bottom there is a text box called condition, with this text:

"c2 and c1 and c3"

Here you can define a logic condition, in this case, we don't need to edit this condition but you can create complex expressions like:

(c1 and c2) or (c4 and c3)

'''Adding Ordering'''

Click on the Ordering Tab.

Add a ordering named "User field ordering".

Choose the column "Lastname" and the ordering "ASC" (Ascending).

'''Adding Filters'''

Click on the Filters Tab.

Add a filter named "User field filter".

Choose city.

'''Adding Permissions'''

Click on the Permissions Tab.

Choose "User field Value".

Choose the column "Country", and enter the value "ES".

Here you can add more permissions and a logic condition to be achieved.

'''Adding Calculations'''

Click on the Calculations tab.

Choose Sum.

Choose the column "User module actions".

'''Adding Plots'''

Click on the Plots tab.

Choose "Pie".

Choose the colum "City" as Name and Value.

Finally, add a few users in Moodle with the country Spain, and different cities, Madrid, Barcelona, Seville, etc. and test the report.

You can download the report in different formats (ods and xls), remember to check these options in the report page.

[[blocks/configurable_reports/#Users_report | See screenshot]]

=== Creating a SQL Report ===

You can find a lot of SQL Reports here: [[ad-hoc contributed reports]]

Since this block supports Tim Hunt's CustomSQL Queries Reports, you can use any query.

Remember to add a "Time filter" if you are going to use reports with time tokens.

First of all, install the block.

Go to the course where the report will be created.

Add an instance of the Custom Reports block.

Click on "Manage reports".

Click on "Add report

Enter a name, description, choose "SQL" as Type of Report

The report will be saved and you redirect to the first Tab named "Custom SQL"

Add this query (''Courses activity''):

<code sql>
SELECT COUNT(l.id) hits, l.course courseId, c.fullname coursename
FROM prefix_log l INNER JOIN prefix_course c ON l.course = c.id
GROUP BY courseId
ORDER BY hits DESC
</code>

Go to Calculations Tab

Add a Sum calculation, choose the hits column

Go to Plot

Add a Pie graph, choosing coursename as Name and hits as value

So, here you have a report with a Graph and calculations based on a SQL Query.

You can add a Course filter, it's very easy:

Go to filters, choose Courses

Edit the Custom SQL query:

<code sql>
SELECT COUNT(l.id) hits, l.course courseId, c.fullname coursename
FROM prefix_log l INNER JOIN prefix_course c ON l.course = c.id
%%FILTER_COURSES:l.course%%
GROUP BY courseId
ORDER BY hits DESC
</code>

Note that we are adding a token called: %%FILTER_COURSES:l.courseid%%

Go to View report, and you will see a Courses Filter, choose a Course and click on Add, here you have a report filtered.

You can also add a Starttime and endtime filter

Go to filters, choose Start / End date filter

Go to Custom SQL tab, this is the new query:

<code sql>
SELECT COUNT(l.id) hits, l.course courseId, c.fullname coursename
FROM prefix_log l INNER JOIN prefix_course c ON l.course = c.id
%%FILTER_COURSES:l.course%%
%%FILTER_STARTTIME:l.time:>%% %%FILTER_ENDTIME:l.time:<%%
GROUP BY courseId
ORDER BY hits DESC
</code>

If you want to filter text (for example, lastname)

Go to filters, choose Search Text filter

Go to Custom SQL tab and type your query. Here is an example for querying the user table:

<code sql>
SELECT u.firstname, u.lastname
FROM prefix_user u
WHERE 1=1
%%FILTER_SEARCHTEXT:u.lastname:~%%
ORDER BY u.lastname
</code>

Replace WHERE 1=1 with your WHERE criteria. If you do not have any where criteria and do not specify WHERE 1=1, you will receive a SQL error.

One more example (for filtering a group of courses by category)
<code sql>
SELECT COUNT(l.id) hits, c.fullname as Course,c.id as CourseID
,(SELECT Count( ra.userid ) AS Users FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
WHERE ra.roleid = 5 AND ctx.instanceid = c.id) AS Students
FROM prefix_log l INNER JOIN prefix_course c ON l.course = c.id
%%FILTER_CATEGORIES:c.category%%
GROUP BY l.course
ORDER BY hits DESC
</code>
Go to View report, now you can filter by time also

'''SQL variables'''
If you place this strings in your SQL queries, it will be replaced by the appropriate value (current course id, current user id, Moodle www root (url))

* %%COURSEID%%
* %%USERID%%
* %%WWWROOT%%

[[blocks/configurable_reports/#SQL_report | See screenshot]]

=== Creating a timeline report ===

''This report assumes that you have created at least one user or course report''

Timeline reports are a special type of reports. A timeline report displays a timeline in which a course report or user report can be embedded.

In this example we are going to create a report showing the user logins to the site during the last month (day per day).

Create a User report (see tutorial above) with three columns (firstname, lastname and user statistics)

Select the statistic (User logins)

Create a Timeline report, in the Timeline tab you can select the dates or days of the report (in this case, the last 30 days) and the interval of time for every row.

Add three "Other report column" columns, selecting all the previous user report columns.

And that's all, you can create a new type of plot (line graph). This graph is suitable for data depending on time.

== Advanced options ==

=== Export and import of reports ===

Embedded reports exporting is not working because the reports include references to another reports. A workaround is edit the imported report for changing the references in the "Other report field" column.

Reports that uses the user module outline column can't be exported either

=== Use the same report in different courses ===

(Available only in Configurable Report version 2.3 and above)

In order to use the same report in different courses you have to check the "Global report" option where creating a new report. This report will be then displayed in all the courses where the configurable report block is displayed and the block instance settings are set to "Display global reports".

If you don't want to display global reports in a certain block instance you can always edit the instance settings for selecting "No" in the "Display global reports" block setting.

Notice that these types of reports inherit the context of the course where is displayed, so any condition related to course inside the report is calculated using the course where the report is being viewed

=== Reports can run on a different DB then the current (production) DB ===

(Available only in Configurable Report version 2.3 and above)

Go to Admin -> Plugins -> Blocks -> Configurable Report settings

=== DataTables for the report table ===

(Available only in Configurable Report version 2.3 and above)

Go to Admin -> Plugins -> Blocks -> Configurable Report settings to enable this functionality

=== CodeMirror.js for highlighting SQL query code ===

(Available only in Configurable Report version 2.3 and above)

Go to Admin -> Plugins -> Blocks -> Configurable Report settings to disable this functionality

=== Using GITHUB as a repository to distribute and manage sharable SQL queries ===

(Available only in Configurable Report version 2.3 and above)

Go to Admin -> Plugins -> Blocks -> Configurable Report settings to point to your own repository

=== Cron SQL queries ===

(Available only in Configurable Report version 2.3 and above)

=== Settings to control security of SQL Queries ===

(Available only in Configurable Report version 2.3 and above)

Go to Admin -> Plugins -> Blocks -> Configurable Report settings to change the security level

=== Templates ===

You can customize the report output using a template.

Just enable the Template option in the same name tab.

This is an example html code for displaying a list of users:

Header:

<code html4strict>
<p align="center"><b>##reportname##</b></p>
<table width="60%" align="center">
<tr>
<td>
</code>

Record:

<code html4strict>
<table width="100%">
<tr>
<td><img src="http://yourmoodle.com/user/pix.php/[[id]]/f1.jpg"></td>
<td><h2>[[Firstname]] [[Lastname]]</h2>
City: [[City]]
</td>
</tr>
</table>
<br>
</code>

Footer:

<code html4strict>
</td>
<td valign="top">
##graphs##
<br /><br />
##exportoptions##
</td>
</table>
</code>

=== Embedded reports ===

An embedded report consists in a report's set of columns that are embedded in another report.

You can embed a user report into a course report, in this case, the resulting rows will be expanded duplicating each row for each user.

{| class="wikitable"
|-
! Type of report
! Reports that can be embedded
|-
| Courses
| Users
|-
| Categories
| Courses
|-
| Timeline
| Users, courses
|}

Imagine you have a courses report, you can embed a user report, every row of the course report will be cloned for each user.

To embed a report just add a "Other report" column, a list of your reports will be showed.

Inside a course report you can embed a user report and the other way.

==== Timeline reports ====

Timeline reports are a special type of reports. A timeline report displays a timeline in which a courses report or users report can be embedded.

Timeline reports should be used when your user or course report includes statistics (course stats or user stats columns). I.e: you can create a report showing the number of user logins to the site during a week or month.

== Reports repository ==

Configurable Reports is connected to two different repositories:

* https://github.com/jleyva/moodle-configurable_reports_repository A repository of any type of reports (users, courses, sql, etc...)
* https://github.com/jleyva/moodle-custom_sql_report_queries A repository of just SQL queries to be used in the SQL repor type

You can use your custom repository following this instructions:

* First, you need a github account (free)

* Fork any of the previous repositorys, using the GITHUB fork tool

* Using GIT, clone the repository to your computer in order to add your custom reports (some GIT knowledge is needed)

* Go to Administration / Plugins / Blocks / Configurable reports and change the settings for pointing to your repository (github account + / + repository name

* If you want to contribute to the official repository, use the Pull request Github feature (So I can easily add your reports)

== Developers documentation ==

It's very easy to create new report types, components and plugins.

'''Report''': A report plugin is a folder located at /report.
This folder contains a .class.php file with the child - class of the report_base.

You only need to modify a few methods to add a new report type.
Please, take a look at any of the current reports. The SQL report is an example of a non-typical report,
meanwhile the users and courses reports are standard reports.

The best way to create a report is to duplicate an existing one.

'''Component''': A component is part of a report, a component may be used by more than one report.
The main Component is the component Columns, that is used to add the columns of a report.

Others components are filters, permissions, plot, calculations..

The best way to create a component is to duplicate an existing one.

'''Plugin''': A plugin is a component module. The component column has a few of plugins (coursefield, userfield, etc.)
A plugin usually works for a unique report, but there are plugins that work for more than one report.
The best way to create a plugin is to duplicate an existing one.

== How to request a new feature ==

* Go to the Plugin Tracker http://tracker.moodle.org/browse/CONTRIB/component/10753
* Check in the open issues if your feature have been already requested http://tracker.moodle.org/secure/IssueNavigator.jspa?reset=true&jqlQuery=project+%3D+CONTRIB+AND+component+%3D+%22Block%3A+Configurable+report%22+AND+status+%3D+Open+ORDER+BY+priority+DESC&mode=hide
* If not, create a New issue (Component: Non-core contributed modules Issue type: New feature) (You have to register yourself in the tracker)
* Select the component Block: Configurable Reports and your Moodle version
* Explain in the Description field your needs
* If you have funding, you can contact me using the forum or the moodle internal messaging system, since I work for a Moodle Partner I can work on your request.
* Vote and Watch the issue you have created

== Credits ==

Juan Leyva [http://moodle.org/user/view.php?id=49568&course=1 Moodle profile]

[http://twitter.com/jleyvadelgado Follow me in Twitter]

== Screenshots ==

=== Users report ===
[[Image:block_custom_reports_sample_user_report.png|600px]]

=== SQL report ===
[[Image:block_custom_reports_sample_sql_report.png|600px]]

== See Also ==

CONTRIB-2386

[http://tracker.moodle.org/browse/CONTRIB/component/10753 Block: Configurable reports] Tracker component

[http://moodle.org/plugins/view.php?plugin=block_configurable_reports Modules & Plugins] database entry

[http://moodle.org/mod/forum/discuss.php?d=159820 Help forum]

[[ad-hoc_contributed_reports|contributed reports]] (in plain SQL)

[https://github.com/jleyva/moodle-configurable_reports_repository Configurable Reports Repository on GitHub]

[https://www.youtube.com/watch?v=lF6CuY2Qiw0 Configurable Reports as a Learning Analytics Tool] - iMoot 2015 presentation by Elizabeth Dalton

[http://opensourceelearning.blogspot.co.za/2015/08/moodle-configurable-reports-plugin-all.html All Variables and Filters] - Lists the Variables and Filters you can use in a report

[[es:blocks/configurable_reports/]]

Configurable reports

2016-04-14T10:27:46Z

Libertymoodle: /* Added See Also link */

{{Infobox plugin
|type = Block
|entry = https://moodle.org/plugins/view.php?plugin=block_configurable_reports
|tracker = http://tracker.moodle.org/browse/CONTRIB/component/10753
|discussion = https://moodle.org/mod/forum/view.php?id=7979
|maintainer = [[User:Juan Leyva|Juan Leyva]]
|float = right
}}

== Installation ==

# Download the Configurable Reports installation file and unzip it to the '''\blocks''' directory in your Moodle folder.
# Be sure that the final name of the directory is: configurable_reports, the full path in your Moodle installation will be blocks/configurable_reports
# Login to Moodle as Administrator and click Notifications under Site Administration.

For more information see [[Installing contributed modules or plugins]]

== Overview ==

This block is a Moodle custom reports builder. It its also connected to a [https://github.com/jleyva/moodle-configurable_reports_repository public repository of sample reports] (only plugin version 2.3 and above)

It is designed in a modular way to allow developers to create new plugins in less than an hour.

'''Who can create custom reports?'''

Anyone with block, managereports or manageownreports permissions at SITE level or COURSE level.

'''What type of reports can I create?'''

- Courses reports, with information regarding courses.

- Categories reports, with information regarding categories. A courses report can be embedded in this type of report.

- Users reports, with information regarding users and their activity in a course.

- Timeline reports, this is a special type of report that displays a timeline. A course or user report can be embedded in this timeline showing data depending on the start and end time of the current row.

- Custom SQL Reports, custom SQL queries. This block can use the same SQL queries as [https://moodle.org/plugins/view.php?plugin=report_customsql Tim Hunt's Custom SQL queries] plugin.

Note for developers: You can create your own type of reports.

'''Who can view the reports?'''

When you create a report you can select which users can view it.

The reports are displayed in a block in the course or site frontpage.

== Creating a report ==

This is a very simple process.

If you are going to create a report for a course, you have to add the block in the course and click in the "Manage reports" link.

On the other hand, for site reports, add the block in the frontpage and click in the "Manage reports" link.

You must enter a name, an optional description, and you have to choose the type of report, pagination and exports formats.

Depending on the report choosen, there will be more or less tabs. These are the tabs for the courses and users report:

'''Columns''': Here you can choose the differents columns of your report depending on the type of report. (Course Name, User firstname, etc..)

'''Conditions''': Here you can define the conditions (i.e, only courses from this category, only users from Spain, etc.)

'''Ordering''': Here you can choose how to order the report using fields and directions.

'''Filters''': Here you can choose which filters will be displayed.

'''Template''': You can modify the report's layout by creating a template.

'''Permissions''': Here you can choose who can view a report.

'''Calculations''': Here you can add calculations for columns, i.e: average of number of users enrolled in courses

'''Plots''': Here you can add graphs to your report based on the report columns and values.

'''View report''': Self explanatory

== Tutorial ==

=== Creating a users' report ===

Requirements: ''Users from Spain, but not from Madrid, in this course. This report can be viewed only by users from Spain. A filter based on the user's city must be displayed. A pie plot showing the users' cities is required. A calculation table showing the total forum post views is required. The report must be ordered by users' lastname.''

Let's see how easy it is!

First of all, install the block.

Go to the course where the report will be created.

Add an instance of the Custom Reports block.

Click on "Manage reports"

Click on "Add report"

Enter a name, a description and choose "Users report" as Type of Report

The report will be saved and you will be redirected to the first Tab named "Columns".

'''Adding Columns'''

Here you can define the report table properties, width, align, cell padding, cell spacing, etc.

Add a Column called "User profile field"

Choose the field "firstname" and enter a name for the column in the text field. You can leave the rest of elements blank.

Repeat the process above for the lastname and city fields.

Add a Column called "User module actions".

Choose a module from the list, in this example, a forum.

'''Adding Conditions'''

Click on the Conditions Tab.

Add a Condition named "User field Condition".

Choose the column "Country", the Operator "=", and enter the value "ES" (this is the international code for Spain as Moodle stores it).

Add a Condition named "User field Condition".

Choose the column "city", the Operator "<>", and enter the value "Madrid".

Add a Condition named "Users in current report course".

These are the main conditions of the reports. Note that at the bottom there is a text box called condition, with this text:

"c2 and c1 and c3"

Here you can define a logic condition, in this case, we don't need to edit this condition but you can create complex expressions like:

(c1 and c2) or (c4 and c3)

'''Adding Ordering'''

Click on the Ordering Tab.

Add a ordering named "User field ordering".

Choose the column "Lastname" and the ordering "ASC" (Ascending).

'''Adding Filters'''

Click on the Filters Tab.

Add a filter named "User field filter".

Choose city.

'''Adding Permissions'''

Click on the Permissions Tab.

Choose "User field Value".

Choose the column "Country", and enter the value "ES".

Here you can add more permissions and a logic condition to be achieved.

'''Adding Calculations'''

Click on the Calculations tab.

Choose Sum.

Choose the column "User module actions".

'''Adding Plots'''

Click on the Plots tab.

Choose "Pie".

Choose the colum "City" as Name and Value.

Finally, add a few users in Moodle with the country Spain, and different cities, Madrid, Barcelona, Seville, etc. and test the report.

You can download the report in different formats (ods and xls), remember to check these options in the report page.

[[blocks/configurable_reports/#Users_report | See screenshot]]

=== Creating a SQL Report ===

You can find a lot of SQL Reports here: [[ad-hoc contributed reports]]

Since this block supports Tim Hunt's CustomSQL Queries Reports, you can use any query.

Remember to add a "Time filter" if you are going to use reports with time tokens.

First of all, install the block.

Go to the course where the report will be created.

Add an instance of the Custom Reports block.

Click on "Manage reports".

Click on "Add report

Enter a name, description, choose "SQL" as Type of Report

The report will be saved and you redirect to the first Tab named "Custom SQL"

Add this query (''Courses activity''):

<code sql>
SELECT COUNT(l.id) hits, l.course courseId, c.fullname coursename
FROM prefix_log l INNER JOIN prefix_course c ON l.course = c.id
GROUP BY courseId
ORDER BY hits DESC
</code>

Go to Calculations Tab

Add a Sum calculation, choose the hits column

Go to Plot

Add a Pie graph, choosing coursename as Name and hits as value

So, here you have a report with a Graph and calculations based on a SQL Query.

You can add a Course filter, it's very easy:

Go to filters, choose Courses

Edit the Custom SQL query:

<code sql>
SELECT COUNT(l.id) hits, l.course courseId, c.fullname coursename
FROM prefix_log l INNER JOIN prefix_course c ON l.course = c.id
%%FILTER_COURSES:l.course%%
GROUP BY courseId
ORDER BY hits DESC
</code>

Note that we are adding a token called: %%FILTER_COURSES:l.courseid%%

Go to View report, and you will see a Courses Filter, choose a Course and click on Add, here you have a report filtered.

You can also add a Starttime and endtime filter

Go to filters, choose Start / End date filter

Go to Custom SQL tab, this is the new query:

<code sql>
SELECT COUNT(l.id) hits, l.course courseId, c.fullname coursename
FROM prefix_log l INNER JOIN prefix_course c ON l.course = c.id
%%FILTER_COURSES:l.course%%
%%FILTER_STARTTIME:l.time:>%% %%FILTER_ENDTIME:l.time:<%%
GROUP BY courseId
ORDER BY hits DESC
</code>

If you want to filter text (for example, lastname)

Go to filters, choose Search Text filter

Go to Custom SQL tab and type your query. Here is an example for querying the user table:

<code sql>
SELECT u.firstname, u.lastname
FROM prefix_user u
WHERE 1=1
%%FILTER_SEARCHTEXT:u.lastname:~%%
ORDER BY u.lastname
</code>

Replace WHERE 1=1 with your WHERE criteria. If you do not have any where criteria and do not specify WHERE 1=1, you will receive a SQL error.

One more example (for filtering a group of courses by category)
<code sql>
SELECT COUNT(l.id) hits, c.fullname as Course,c.id as CourseID
,(SELECT Count( ra.userid ) AS Users FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
WHERE ra.roleid = 5 AND ctx.instanceid = c.id) AS Students
FROM prefix_log l INNER JOIN prefix_course c ON l.course = c.id
%%FILTER_CATEGORIES:c.category%%
GROUP BY l.course
ORDER BY hits DESC
</code>
Go to View report, now you can filter by time also

'''SQL variables'''
If you place this strings in your SQL queries, it will be replaced by the appropriate value (current course id, current user id, Moodle www root (url))

* %%COURSEID%%
* %%USERID%%
* %%WWWROOT%%

[[blocks/configurable_reports/#SQL_report | See screenshot]]

=== Creating a timeline report ===

''This report assumes that you have created at least one user or course report''

Timeline reports are a special type of reports. A timeline report displays a timeline in which a course report or user report can be embedded.

In this example we are going to create a report showing the user logins to the site during the last month (day per day).

Create a User report (see tutorial above) with three columns (firstname, lastname and user statistics)

Select the statistic (User logins)

Create a Timeline report, in the Timeline tab you can select the dates or days of the report (in this case, the last 30 days) and the interval of time for every row.

Add three "Other report column" columns, selecting all the previous user report columns.

And that's all, you can create a new type of plot (line graph). This graph is suitable for data depending on time.

== Advanced options ==

=== Export and import of reports ===

Embedded reports exporting is not working because the reports include references to another reports. A workaround is edit the imported report for changing the references in the "Other report field" column.

Reports that uses the user module outline column can't be exported either

=== Use the same report in different courses ===

(Available only in Configurable Report version 2.3 and above)

In order to use the same report in different courses you have to check the "Global report" option where creating a new report. This report will be then displayed in all the courses where the configurable report block is displayed and the block instance settings are set to "Display global reports".

If you don't want to display global reports in a certain block instance you can always edit the instance settings for selecting "No" in the "Display global reports" block setting.

Notice that these types of reports inherit the context of the course where is displayed, so any condition related to course inside the report is calculated using the course where the report is being viewed

=== Reports can run on a different DB then the current (production) DB ===

(Available only in Configurable Report version 2.3 and above)

Go to Admin -> Plugins -> Blocks -> Configurable Report settings

=== DataTables for the report table ===

(Available only in Configurable Report version 2.3 and above)

Go to Admin -> Plugins -> Blocks -> Configurable Report settings to enable this functionality

=== CodeMirror.js for highlighting SQL query code ===

(Available only in Configurable Report version 2.3 and above)

Go to Admin -> Plugins -> Blocks -> Configurable Report settings to disable this functionality

=== Using GITHUB as a repository to distribute and manage sharable SQL queries ===

(Available only in Configurable Report version 2.3 and above)

Go to Admin -> Plugins -> Blocks -> Configurable Report settings to point to your own repository

=== Cron SQL queries ===

(Available only in Configurable Report version 2.3 and above)

=== Settings to control security of SQL Queries ===

(Available only in Configurable Report version 2.3 and above)

Go to Admin -> Plugins -> Blocks -> Configurable Report settings to change the security level

=== Templates ===

You can customize the report output using a template.

Just enable the Template option in the same name tab.

This is an example html code for displaying a list of users:

Header:

<code html4strict>
<p align="center"><b>##reportname##</b></p>
<table width="60%" align="center">
<tr>
<td>
</code>

Record:

<code html4strict>
<table width="100%">
<tr>
<td><img src="http://yourmoodle.com/user/pix.php/[[id]]/f1.jpg"></td>
<td><h2>[[Firstname]] [[Lastname]]</h2>
City: [[City]]
</td>
</tr>
</table>
<br>
</code>

Footer:

<code html4strict>
</td>
<td valign="top">
##graphs##
<br /><br />
##exportoptions##
</td>
</table>
</code>

=== Embedded reports ===

An embedded report consists in a report's set of columns that are embedded in another report.

You can embed a user report into a course report, in this case, the resulting rows will be expanded duplicating each row for each user.

{| class="wikitable"
|-
! Type of report
! Reports that can be embedded
|-
| Courses
| Users
|-
| Categories
| Courses
|-
| Timeline
| Users, courses
|}

Imagine you have a courses report, you can embed a user report, every row of the course report will be cloned for each user.

To embed a report just add a "Other report" column, a list of your reports will be showed.

Inside a course report you can embed a user report and the other way.

==== Timeline reports ====

Timeline reports are a special type of reports. A timeline report displays a timeline in which a courses report or users report can be embedded.

Timeline reports should be used when your user or course report includes statistics (course stats or user stats columns). I.e: you can create a report showing the number of user logins to the site during a week or month.

== Reports repository ==

Configurable Reports is connected to two different repositories:

* https://github.com/jleyva/moodle-configurable_reports_repository A repository of any type of reports (users, courses, sql, etc...)
* https://github.com/jleyva/moodle-custom_sql_report_queries A repository of just SQL queries to be used in the SQL repor type

You can use your custom repository following this instructions:

* First, you need a github account (free)

* Fork any of the previous repositorys, using the GITHUB fork tool

* Using GIT, clone the repository to your computer in order to add your custom reports (some GIT knowledge is needed)

* Go to Administration / Plugins / Blocks / Configurable reports and change the settings for pointing to your repository (github account + / + repository name

* If you want to contribute to the official repository, use the Pull request Github feature (So I can easily add your reports)

== Developers documentation ==

It's very easy to create new report types, components and plugins.

'''Report''': A report plugin is a folder located at /report.
This folder contains a .class.php file with the child - class of the report_base.

You only need to modify a few methods to add a new report type.
Please, take a look at any of the current reports. The SQL report is an example of a non-typical report,
meanwhile the users and courses reports are standard reports.

The best way to create a report is to duplicate an existing one.

'''Component''': A component is part of a report, a component may be used by more than one report.
The main Component is the component Columns, that is used to add the columns of a report.

Others components are filters, permissions, plot, calculations..

The best way to create a component is to duplicate an existing one.

'''Plugin''': A plugin is a component module. The component column has a few of plugins (coursefield, userfield, etc.)
A plugin usually works for a unique report, but there are plugins that work for more than one report.
The best way to create a plugin is to duplicate an existing one.

== How to request a new feature ==

* Go to the Plugin Tracker http://tracker.moodle.org/browse/CONTRIB/component/10753
* Check in the open issues if your feature have been already requested http://tracker.moodle.org/secure/IssueNavigator.jspa?reset=true&jqlQuery=project+%3D+CONTRIB+AND+component+%3D+%22Block%3A+Configurable+report%22+AND+status+%3D+Open+ORDER+BY+priority+DESC&mode=hide
* If not, create a New issue (Component: Non-core contributed modules Issue type: New feature) (You have to register yourself in the tracker)
* Select the component Block: Configurable Reports and your Moodle version
* Explain in the Description field your needs
* If you have funding, you can contact me using the forum or the moodle internal messaging system, since I work for a Moodle Partner I can work on your request.
* Vote and Watch the issue you have created

== Credits ==

Juan Leyva [http://moodle.org/user/view.php?id=49568&course=1 Moodle profile]

[http://twitter.com/jleyvadelgado Follow me in Twitter]

== Screenshots ==

=== Users report ===
[[Image:block_custom_reports_sample_user_report.png|600px]]

=== SQL report ===
[[Image:block_custom_reports_sample_sql_report.png|600px]]

== See Also ==

CONTRIB-2386

[http://tracker.moodle.org/browse/CONTRIB/component/10753 Block: Configurable reports] Tracker component

[http://moodle.org/plugins/view.php?plugin=block_configurable_reports Modules & Plugins] database entry

[http://moodle.org/mod/forum/discuss.php?d=159820 Help forum]

[[ad-hoc_contributed_reports|contributed reports]] (in plain SQL)

[https://github.com/jleyva/moodle-configurable_reports_repository Configurable Reports Repository on GitHub]

[https://www.youtube.com/watch?v=lF6CuY2Qiw0 Configurable Reports as a Learning Analytics Tool] - iMoot 2015 presentation by Elizabeth Dalton

[[es:blocks/configurable_reports/]]

Configurable reports

2015-07-08T10:52:21Z

Libertymoodle: /* See Also */

{{Infobox plugin
|type = Block
|entry = https://moodle.org/plugins/view.php?plugin=block_configurable_reports
|tracker = http://tracker.moodle.org/browse/CONTRIB/component/10753
|discussion = https://moodle.org/mod/forum/view.php?id=7979
|maintainer = [[User:Juan Leyva|Juan Leyva]]
|float = right
}}

== Installation ==

# Download the Configurable Reports installation file and unzip it to the '''\blocks''' directory in your Moodle folder.
# Be sure that the final name of the directory is: configurable_reports, the full path in your Moodle installation will be blocks/configurable_reports
# Login to Moodle as Administrator and click Notifications under Site Administration.

For more information see [[Installing contributed modules or plugins]]

== Overview ==

This block is a Moodle custom reports builder. It its also connected to a [https://github.com/jleyva/moodle-configurable_reports_repository public repository of sample reports] (only plugin version 2.3 and above)

It is designed in a modular way to allow developers to create new plugins in less than an hour.

'''Who can create custom reports?'''

Anyone with block, managereports or manageownreports permissions at SITE level or COURSE level.

'''What type of reports can I create?'''

- Courses reports, with information regarding courses.

- Categories reports, with information regarding categories. A courses report can be embedded in this type of report.

- Users reports, with information regarding users and their activity in a course.

- Timeline reports, this is a special type of report that displays a timeline. A course or user report can be embedded in this timeline showing data depending on the start and end time of the current row.

- Custom SQL Reports, custom SQL queries. This block can use the same SQL queries as [https://moodle.org/plugins/view.php?plugin=report_customsql Tim Hunt's Custom SQL queries] plugin.

Note for developers: You can create your own type of reports.

'''Who can view the reports?'''

When you create a report you can select which users can view it.

The reports are displayed in a block in the course or site frontpage.

== Creating a report ==

This is a very simple process.

If you are going to create a report for a course, you have to add the block in the course and click in the "Manage reports" link.

On the other hand, for site reports, add the block in the frontpage and click in the "Manage reports" link.

You must enter a name, an optional description, and you have to choose the type of report, pagination and exports formats.

Depending on the report choosen, there will be more or less tabs. These are the tabs for the courses and users report:

'''Columns''': Here you can choose the differents columns of your report depending on the type of report. (Course Name, User firstname, etc..)

'''Conditions''': Here you can define the conditions (i.e, only courses from this category, only users from Spain, etc.)

'''Ordering''': Here you can choose how to order the report using fields and directions.

'''Filters''': Here you can choose which filters will be displayed.

'''Template''': You can modify the report's layout by creating a template.

'''Permissions''': Here you can choose who can view a report.

'''Calculations''': Here you can add calculations for columns, i.e: average of number of users enrolled in courses

'''Plots''': Here you can add graphs to your report based on the report columns and values.

'''View report''': Self explanatory

== Tutorial ==

=== Creating a users' report ===

Requirements: ''Users from Spain, but not from Madrid, in this course. This report can be viewed only by users from Spain. A filter based on the user's city must be displayed. A pie plot showing the users' cities is required. A calculation table showing the total forum post views is required. The report must be ordered by users' lastname.''

Let's see how easy it is!

First of all, install the block.

Go to the course where the report will be created.

Add an instance of the Custom Reports block.

Click on "Manage reports"

Click on "Add report"

Enter a name, a description and choose "Users report" as Type of Report

The report will be saved and you will be redirected to the first Tab named "Columns".

'''Adding Columns'''

Here you can define the report table properties, width, align, cell padding, cell spacing, etc.

Add a Column called "User profile field"

Choose the field "firstname" and enter a name for the column in the text field. You can leave the rest of elements blank.

Repeat the process above for the lastname and city fields.

Add a Column called "User module actions".

Choose a module from the list, in this example, a forum.

'''Adding Conditions'''

Click on the Conditions Tab.

Add a Condition named "User field Condition".

Choose the column "Country", the Operator "=", and enter the value "ES" (this is the international code for Spain as Moodle stores it).

Add a Condition named "User field Condition".

Choose the column "city", the Operator "<>", and enter the value "Madrid".

Add a Condition named "Users in current report course".

These are the main conditions of the reports. Note that at the bottom there is a text box called condition, with this text:

"c2 and c1 and c3"

Here you can define a logic condition, in this case, we don't need to edit this condition but you can create complex expressions like:

(c1 and c2) or (c4 and c3)

'''Adding Ordering'''

Click on the Ordering Tab.

Add a ordering named "User field ordering".

Choose the column "Lastname" and the ordering "ASC" (Ascending).

'''Adding Filters'''

Click on the Filters Tab.

Add a filter named "User field filter".

Choose city.

'''Adding Permissions'''

Click on the Permissions Tab.

Choose "User field Value".

Choose the column "Country", and enter the value "ES".

Here you can add more permissions and a logic condition to be achieved.

'''Adding Calculations'''

Click on the Calculations tab.

Choose Sum.

Choose the column "User module actions".

'''Adding Plots'''

Click on the Plots tab.

Choose "Pie".

Choose the colum "City" as Name and Value.

Finally, add a few users in Moodle with the country Spain, and different cities, Madrid, Barcelona, Seville, etc. and test the report.

You can download the report in different formats (ods and xls), remember to check these options in the report page.

[[blocks/configurable_reports/#Users_report | See screenshot]]

=== Creating a SQL Report ===

You can find a lot of SQL Reports here: [[ad-hoc contributed reports]]

Since this block supports Tim Hunt's CustomSQL Queries Reports, you can use any query.

Remember to add a "Time filter" if you are going to use reports with time tokens.

First of all, install the block.

Go to the course where the report will be created.

Add an instance of the Custom Reports block.

Click on "Manage reports".

Click on "Add report

Enter a name, description, choose "SQL" as Type of Report

The report will be saved and you redirect to the first Tab named "Custom SQL"

Add this query (''Courses activity''):

<code sql>
SELECT COUNT(l.id) hits, l.course courseId, c.fullname coursename
FROM prefix_log l INNER JOIN prefix_course c ON l.course = c.id
GROUP BY courseId
ORDER BY hits DESC
</code>

Go to Calculations Tab

Add a Sum calculation, choose the hits column

Go to Plot

Add a Pie graph, choosing coursename as Name and hits as value

So, here you have a report with a Graph and calculations based on a SQL Query.

You can add a Course filter, it's very easy:

Go to filters, choose Courses

Edit the Custom SQL query:

<code sql>
SELECT COUNT(l.id) hits, l.course courseId, c.fullname coursename
FROM prefix_log l INNER JOIN prefix_course c ON l.course = c.id
%%FILTER_COURSES:l.course%%
GROUP BY courseId
ORDER BY hits DESC
</code>

Note that we are adding a token called: %%FILTER_COURSES:l.courseid%%

Go to View report, and you will see a Courses Filter, choose a Course and click on Add, here you have a report filtered.

You can also add a Starttime and endtime filter

Go to filters, choose Start / End date filter

Go to Custom SQL tab, this is the new query:

<code sql>
SELECT COUNT(l.id) hits, l.course courseId, c.fullname coursename
FROM prefix_log l INNER JOIN prefix_course c ON l.course = c.id
%%FILTER_COURSES:l.course%%
%%FILTER_STARTTIME:l.time:>%% %%FILTER_ENDTIME:l.time:<%%
GROUP BY courseId
ORDER BY hits DESC
</code>

If you want to filter text (for example, lastname)

Go to filters, choose Search Text filter

Go to Custom SQL tab and type your query. Here is an example for querying the user table:

<code sql>
SELECT u.firstname, u.lastname
FROM prefix_user u
WHERE 1=1
%%FILTER_SEARCHTEXT:u.lastname:~%%
ORDER BY u.lastname
</code>

Replace WHERE 1=1 with your WHERE criteria. If you do not have any where criteria and do not specify WHERE 1=1, you will receive a SQL error.

One more example (for filtering a group of courses by category)
<code sql>
SELECT COUNT(l.id) hits, c.fullname as Course,c.id as CourseID
,(SELECT Count( ra.userid ) AS Users FROM prefix_role_assignments AS ra
JOIN prefix_context AS ctx ON ra.contextid = ctx.id
WHERE ra.roleid = 5 AND ctx.instanceid = c.id) AS Students
FROM prefix_log l INNER JOIN prefix_course c ON l.course = c.id
%%FILTER_CATEGORIES:c.category%%
GROUP BY l.course
ORDER BY hits DESC
</code>
Go to View report, now you can filter by time also

'''SQL variables'''
If you place this strings in your SQL queries, it will be replaced by the appropriate value (current course id, current user id, Moodle www root (url))

* %%COURSEID%%
* %%USERID%%
* %%WWWROOT%%

[[blocks/configurable_reports/#SQL_report | See screenshot]]

=== Creating a timeline report ===

''This report assumes that you have created at least one user or course report''

Timeline reports are a special type of reports. A timeline report displays a timeline in which a course report or user report can be embedded.

In this example we are going to create a report showing the user logins to the site during the last month (day per day).

Create a User report (see tutorial above) with three columns (firstname, lastname and user statistics)

Select the statistic (User logins)

Create a Timeline report, in the Timeline tab you can select the dates or days of the report (in this case, the last 30 days) and the interval of time for every row.

Add three "Other report column" columns, selecting all the previous user report columns.

And that's all, you can create a new type of plot (line graph). This graph is suitable for data depending on time.

== Advanced options ==

=== Export and import of reports ===

Embedded reports exporting is not working because the reports include references to another reports. A workaround is edit the imported report for changing the references in the "Other report field" column.

Reports that uses the user module outline column can't be exported either

=== Use the same report in different courses ===

(Available only in Configurable Report version 2.3 and above)

In order to use the same report in different courses you have to check the "Global report" option where creating a new report. This report will be then displayed in all the courses where the configurable report block is displayed and the block instance settings are set to "Display global reports".

If you don't want to display global reports in a certain block instance you can always edit the instance settings for selecting "No" in the "Display global reports" block setting.

Notice that these types of reports inherit the context of the course where is displayed, so any condition related to course inside the report is calculated using the course where the report is being viewed

=== Reports can run on a different DB then the current (production) DB ===

(Available only in Configurable Report version 2.3 and above)

Go to Admin -> Plugins -> Blocks -> Configurable Report settings

=== DataTables for the report table ===

(Available only in Configurable Report version 2.3 and above)

Go to Admin -> Plugins -> Blocks -> Configurable Report settings to enable this functionality

=== CodeMirror.js for highlighting SQL query code ===

(Available only in Configurable Report version 2.3 and above)

Go to Admin -> Plugins -> Blocks -> Configurable Report settings to disable this functionality

=== Using GITHUB as a repository to distribute and manage sharable SQL queries ===

(Available only in Configurable Report version 2.3 and above)

Go to Admin -> Plugins -> Blocks -> Configurable Report settings to point to your own repository

=== Cron SQL queries ===

(Available only in Configurable Report version 2.3 and above)

=== Settings to control security of SQL Queries ===

(Available only in Configurable Report version 2.3 and above)

Go to Admin -> Plugins -> Blocks -> Configurable Report settings to change the security level

=== Templates ===

You can customize the report output using a template.

Just enable the Template option in the same name tab.

This is an example html code for displaying a list of users:

Header:

<code html4strict>
<p align="center"><b>##reportname##</b></p>
<table width="60%" align="center">
<tr>
<td>
</code>

Record:

<code html4strict>
<table width="100%">
<tr>
<td><img src="http://yourmoodle.com/user/pix.php/[[id]]/f1.jpg"></td>
<td><h2>[[Firstname]] [[Lastname]]</h2>
City: [[City]]
</td>
</tr>
</table>
<br>
</code>

Footer:

<code html4strict>
</td>
<td valign="top">
##graphs##
<br /><br />
##exportoptions##
</td>
</table>
</code>

=== Embedded reports ===

An embedded report consists in a report's set of columns that are embedded in another report.

You can embed a user report into a course report, in this case, the resulting rows will be expanded duplicating each row for each user.

{| class="wikitable"
|-
! Type of report
! Reports that can be embedded
|-
| Courses
| Users
|-
| Categories
| Courses
|-
| Timeline
| Users, courses
|}

Imagine you have a courses report, you can embed a user report, every row of the course report will be cloned for each user.

To embed a report just add a "Other report" column, a list of your reports will be showed.

Inside a course report you can embed a user report and the other way.

==== Timeline reports ====

Timeline reports are a special type of reports. A timeline report displays a timeline in which a courses report or users report can be embedded.

Timeline reports should be used when your user or course report includes statistics (course stats or user stats columns). I.e: you can create a report showing the number of user logins to the site during a week or month.

== Reports repository ==

Configurable Reports is connected to two different repositories:

* https://github.com/jleyva/moodle-configurable_reports_repository A repository of any type of reports (users, courses, sql, etc...)
* https://github.com/jleyva/moodle-custom_sql_report_queries A repository of just SQL queries to be used in the SQL repor type

You can use your custom repository following this instructions:

* First, you need a github account (free)

* Fork any of the previous repositorys, using the GITHUB fork tool

* Using GIT, clone the repository to your computer in order to add your custom reports (some GIT knowledge is needed)

* Go to Administration / Plugins / Blocks / Configurable reports and change the settings for pointing to your repository (github account + / + repository name

* If you want to contribute to the official repository, use the Pull request Github feature (So I can easily add your reports)

== Developers documentation ==

It's very easy to create new report types, components and plugins.

'''Report''': A report plugin is a folder located at /report.
This folder contains a .class.php file with the child - class of the report_base.

You only need to modify a few methods to add a new report type.
Please, take a look at any of the current reports. The SQL report is an example of a non-typical report,
meanwhile the users and courses reports are standard reports.

The best way to create a report is to duplicate an existing one.

'''Component''': A component is part of a report, a component may be used by more than one report.
The main Component is the component Columns, that is used to add the columns of a report.

Others components are filters, permissions, plot, calculations..

The best way to create a component is to duplicate an existing one.

'''Plugin''': A plugin is a component module. The component column has a few of plugins (coursefield, userfield, etc.)
A plugin usually works for a unique report, but there are plugins that work for more than one report.
The best way to create a plugin is to duplicate an existing one.

== How to request a new feature ==

* Go to the Plugin Tracker http://tracker.moodle.org/browse/CONTRIB/component/10753
* Check in the open issues if your feature have been already requested http://tracker.moodle.org/secure/IssueNavigator.jspa?reset=true&jqlQuery=project+%3D+CONTRIB+AND+component+%3D+%22Block%3A+Configurable+report%22+AND+status+%3D+Open+ORDER+BY+priority+DESC&mode=hide
* If not, create a New issue (Component: Non-core contributed modules Issue type: New feature) (You have to register yourself in the tracker)
* Select the component Block: Configurable Reports and your Moodle version
* Explain in the Description field your needs
* If you have funding, you can contact me using the forum or the moodle internal messaging system, since I work for a Moodle Partner I can work on your request.
* Vote and Watch the issue you have created

== Credits ==

Juan Leyva [http://moodle.org/user/view.php?id=49568&course=1 Moodle profile]

[http://twitter.com/jleyvadelgado Follow me in Twitter]

== Screenshots ==

=== Users report ===
[[Image:block_custom_reports_sample_user_report.png|600px]]

=== SQL report ===
[[Image:block_custom_reports_sample_sql_report.png|600px]]

== See Also ==

CONTRIB-2386

[http://tracker.moodle.org/browse/CONTRIB/component/10753 Block: Configurable reports] Tracker component

[http://moodle.org/plugins/view.php?plugin=block_configurable_reports Modules & Plugins] database entry

[http://moodle.org/mod/forum/discuss.php?d=159820 Help forum]

[[ad-hoc_contributed_reports|contributed reports]] (in plain SQL)

[https://github.com/jleyva/moodle-configurable_reports_repository Configurable Reports Repository on GitHub]

[[es:blocks/configurable_reports/]]

ad-hoc contributed reports

2015-07-08T10:18:33Z

Libertymoodle: See also

Talk:Logging

2015-05-21T12:20:59Z

Libertymoodle: Legacy logging

This article says: "A new Moodle site will have Standard logging enabled and Legacy logging disabled. A site which has been upgraded will have both enabled."
But is it ok to disable the legacy log on a site which has been upgraded and only use the new standard log? Does Moodle store anything in the legacy log that is not stored in the standard log - especially on a site which has been upgraded? An explanation of this would be useful, especially if disabling the legacy logs will cause some information that is/was logged to the legacy logs to no longer be logged.
--[[User:Luis de Vasconcelos|Luis de Vasconcelos]] ([[User talk:Luis de Vasconcelos|talk]]) 15:52, 20 May 2015 (AWST)

: For what i know, you can disable legacy logs. But if you do so : you won't be able to look/show/display (existing) legacy logs, and no new legacy logs will be generated. It can be a problem for non standard plugins not well upgraded, still generating legacy logs, but not standard logs. With time, more plugins are upgraded...
:--[[User:Séverin Terrier|Séverin Terrier]] ([[User talk:Séverin Terrier|talk]]) 19:58, 20 May 2015 (AWST)

Thanks Séverin - I have added your comments to the page. --[[User:Mary Cooch|Mary Cooch]] ([[User talk:Mary Cooch|talk]]) 22:25, 20 May 2015 (AWST)

:: Do current versions of Moodle core still write any data to the legacy log?
:: --[[User:Luis de Vasconcelos|Luis de Vasconcelos]] ([[User talk:Luis de Vasconcelos|talk]]) 20:20, 21 May 2015 (AWST)

: You can disable legacy store plugin completely OR you can only disable writing to legacy log inside the plugin settings. In the second case you will be able to read from the log but no new entries will be added. This is also what will be set automatically during upgrade. [https://docs.moodle.org/27/en/Upgrading#Possible_issues_that_may_affect_you_in_Moodle_2.7 More details]
: --[[User:Marina Glancy|Marina Glancy]] ([[User talk:Marina Glancy|talk]]) 08:15, 21 May 2015 (AWST)

:: Thanks Marina for your detailed information. If i remember well (but i can be wrong), when i upgraded to 2.7(.1 ?), legacy log where automatically disabled, so not visible. Suppose it has been improved since then.
::--[[User:Séverin Terrier|Séverin Terrier]] ([[User talk:Séverin Terrier|talk]]) 16:11, 21 May 2015 (AWST)

:: Thanks Marina. If you disable writing to the legacy log will the data that would have been written to the legacy log if it were still enabled be written to the standard log instead? Or will that "legacy log data" not be written to any log at all?
:: --[[User:Luis de Vasconcelos|Luis de Vasconcelos]] ([[User talk:Luis de Vasconcelos|talk]]) 17:37, 21 May 2015 (AWST)

Can you migrate the data in the legacy logs to the new standard log? If so, is there a documented migration process?
--[[User:Luis de Vasconcelos|Luis de Vasconcelos]] ([[User talk:Luis de Vasconcelos|talk]]) 19:05, 21 May 2015 (AWST)

If you have a need to keep all your logging data indefinately, or for a very long time, does it make better to use an external database for logging? If so, is there any documentation describing how to do this log data migration from the Moodle database to the external logging database?
--[[User:Luis de Vasconcelos|Luis de Vasconcelos]] ([[User talk:Luis de Vasconcelos|talk]]) 19:05, 21 May 2015 (AWST)

Talk:Logging

2015-05-21T12:16:14Z

Libertymoodle: More logging questions

This article says: "A new Moodle site will have Standard logging enabled and Legacy logging disabled. A site which has been upgraded will have both enabled."
But is it ok to disable the legacy log on a site which has been upgraded and only use the new standard log? Does Moodle store anything in the legacy log that is not stored in the standard log - especially on a site which has been upgraded? An explanation of this would be useful, especially if disabling the legacy logs will cause some information that is/was logged to the legacy logs to no longer be logged.
--[[User:Luis de Vasconcelos|Luis de Vasconcelos]] ([[User talk:Luis de Vasconcelos|talk]]) 15:52, 20 May 2015 (AWST)

: For what i know, you can disable legacy logs. But if you do so : you won't be able to look/show/display (existing) legacy logs, and no new legacy logs will be generated. It can be a problem for non standard plugins not well upgraded, still generating legacy logs, but not standard logs. With time, more plugins are upgraded...
:--[[User:Séverin Terrier|Séverin Terrier]] ([[User talk:Séverin Terrier|talk]]) 19:58, 20 May 2015 (AWST)

Thanks Séverin - I have added your comments to the page. --[[User:Mary Cooch|Mary Cooch]] ([[User talk:Mary Cooch|talk]]) 22:25, 20 May 2015 (AWST)

: You can disable legacy store plugin completely OR you can only disable writing to legacy log inside the plugin settings. In the second case you will be able to read from the log but no new entries will be added. This is also what will be set automatically during upgrade. [https://docs.moodle.org/27/en/Upgrading#Possible_issues_that_may_affect_you_in_Moodle_2.7 More details]
: --[[User:Marina Glancy|Marina Glancy]] ([[User talk:Marina Glancy|talk]]) 08:15, 21 May 2015 (AWST)

:: Thanks Marina for your detailed information. If i remember well (but i can be wrong), when i upgraded to 2.7(.1 ?), legacy log where automatically disabled, so not visible. Suppose it has been improved since then.
::--[[User:Séverin Terrier|Séverin Terrier]] ([[User talk:Séverin Terrier|talk]]) 16:11, 21 May 2015 (AWST)

:: Thanks Marina. If you disable writing to the legacy log will the data that would have been written to the legacy log if it were still enabled be written to the standard log instead? Or will that "legacy log data" not be written to any log at all?
:: --[[User:Luis de Vasconcelos|Luis de Vasconcelos]] ([[User talk:Luis de Vasconcelos|talk]]) 17:37, 21 May 2015 (AWST)

:: Do current versions of Moodle core still write any data to the legacy log?
:: --[[User:Luis de Vasconcelos|Luis de Vasconcelos]] ([[User talk:Luis de Vasconcelos|talk]]) 20:16, 21 May 2015 (AWST)

Can you migrate the data in the legacy logs to the new standard log? If so, is there a documented migration process?
--[[User:Luis de Vasconcelos|Luis de Vasconcelos]] ([[User talk:Luis de Vasconcelos|talk]]) 19:05, 21 May 2015 (AWST)

If you have a need to keep all your logging data indefinately, or for a very long time, does it make better to use an external database for logging? If so, is there any documentation describing how to do this log data migration from the Moodle database to the external logging database?
--[[User:Luis de Vasconcelos|Luis de Vasconcelos]] ([[User talk:Luis de Vasconcelos|talk]]) 19:05, 21 May 2015 (AWST)

Talk:Logging

2015-05-21T11:05:21Z

Libertymoodle: /* Logging FAQs */

This article says: "A new Moodle site will have Standard logging enabled and Legacy logging disabled. A site which has been upgraded will have both enabled."
But is it ok to disable the legacy log on a site which has been upgraded and only use the new standard log? Does Moodle store anything in the legacy log that is not stored in the standard log - especially on a site which has been upgraded? An explanation of this would be useful, especially if disabling the legacy logs will cause some information that is/was logged to the legacy logs to no longer be logged.
--[[User:Luis de Vasconcelos|Luis de Vasconcelos]] ([[User talk:Luis de Vasconcelos|talk]]) 15:52, 20 May 2015 (AWST)

: For what i know, you can disable legacy logs. But if you do so : you won't be able to look/show/display (existing) legacy logs, and no new legacy logs will be generated. It can be a problem for non standard plugins not well upgraded, still generating legacy logs, but not standard logs. With time, more plugins are upgraded...
:--[[User:Séverin Terrier|Séverin Terrier]] ([[User talk:Séverin Terrier|talk]]) 19:58, 20 May 2015 (AWST)

Thanks Séverin - I have added your comments to the page. --[[User:Mary Cooch|Mary Cooch]] ([[User talk:Mary Cooch|talk]]) 22:25, 20 May 2015 (AWST)

: You can disable legacy store plugin completely OR you can only disable writing to legacy log inside the plugin settings. In the second case you will be able to read from the log but no new entries will be added. This is also what will be set automatically during upgrade. [https://docs.moodle.org/27/en/Upgrading#Possible_issues_that_may_affect_you_in_Moodle_2.7 More details]
: --[[User:Marina Glancy|Marina Glancy]] ([[User talk:Marina Glancy|talk]]) 08:15, 21 May 2015 (AWST)

:: Thanks Marina for your detailed information. If i remember well (but i can be wrong), when i upgraded to 2.7(.1 ?), legacy log where automatically disabled, so not visible. Suppose it has been improved since then.
::--[[User:Séverin Terrier|Séverin Terrier]] ([[User talk:Séverin Terrier|talk]]) 16:11, 21 May 2015 (AWST)

:: Thanks Marina. If you disable writing to the legacy log will the data that would have been written to the legacy log if it were still enabled be written to the standard log instead? Or will that "legacy log data" not be written to any log at all?
:: --[[User:Luis de Vasconcelos|Luis de Vasconcelos]] ([[User talk:Luis de Vasconcelos|talk]]) 17:37, 21 May 2015 (AWST)

Can you migrate the data in the legacy logs to the new standard log? If so, is there a documented migration process?
--[[User:Luis de Vasconcelos|Luis de Vasconcelos]] ([[User talk:Luis de Vasconcelos|talk]]) 19:05, 21 May 2015 (AWST)

If you have a need to keep all your logging data indefinately, or for a very long time, does it make better to use an external database for logging? If so, is there any documentation describing how to do this log data migration from the Moodle database to the external logging database?
--[[User:Luis de Vasconcelos|Luis de Vasconcelos]] ([[User talk:Luis de Vasconcelos|talk]]) 19:05, 21 May 2015 (AWST)

Talk:Logging

2015-05-21T09:37:26Z

Libertymoodle: /* Legacy logging */

This article says: "A new Moodle site will have Standard logging enabled and Legacy logging disabled. A site which has been upgraded will have both enabled."
But is it ok to disable the legacy log on a site which has been upgraded and only use the new standard log? Does Moodle store anything in the legacy log that is not stored in the standard log - especially on a site which has been upgraded? An explanation of this would be useful, especially if disabling the legacy logs will cause some information that is/was logged to the legacy logs to no longer be logged.
--[[User:Luis de Vasconcelos|Luis de Vasconcelos]] ([[User talk:Luis de Vasconcelos|talk]]) 15:52, 20 May 2015 (AWST)

: For what i know, you can disable legacy logs. But if you do so : you won't be able to look/show/display (existing) legacy logs, and no new legacy logs will be generated. It can be a problem for non standard plugins not well upgraded, still generating legacy logs, but not standard logs. With time, more plugins are upgraded...
:--[[User:Séverin Terrier|Séverin Terrier]] ([[User talk:Séverin Terrier|talk]]) 19:58, 20 May 2015 (AWST)

Thanks Séverin - I have added your comments to the page. --[[User:Mary Cooch|Mary Cooch]] ([[User talk:Mary Cooch|talk]]) 22:25, 20 May 2015 (AWST)

: You can disable legacy store plugin completely OR you can only disable writing to legacy log inside the plugin settings. In the second case you will be able to read from the log but no new entries will be added. This is also what will be set automatically during upgrade. [https://docs.moodle.org/27/en/Upgrading#Possible_issues_that_may_affect_you_in_Moodle_2.7 More details]
: --[[User:Marina Glancy|Marina Glancy]] ([[User talk:Marina Glancy|talk]]) 08:15, 21 May 2015 (AWST)

:: Thanks Marina for your detailed information. If i remember well (but i can be wrong), when i upgraded to 2.7(.1 ?), legacy log where automatically disabled, so not visible. Suppose it has been improved since then.
::--[[User:Séverin Terrier|Séverin Terrier]] ([[User talk:Séverin Terrier|talk]]) 16:11, 21 May 2015 (AWST)

:: Thanks Marina. If you disable writing to the legacy log will the data that would have been written to the legacy log if it were still enabled be written to the standard log instead? Or will that "legacy log data" not be written to any log at all?
:: --[[User:Luis de Vasconcelos|Luis de Vasconcelos]] ([[User talk:Luis de Vasconcelos|talk]]) 17:37, 21 May 2015 (AWST)

Talk:Logging

2015-05-20T07:52:25Z

Libertymoodle: /* Legacy logging */

Talk:Logging

2015-05-20T07:50:01Z

Libertymoodle: /* Need clarity on Standard logging and Legacy logging */

Using slash arguments

2015-03-25T11:28:47Z

Libertymoodle: SCORM FAQ link

{{Environment}}
It is recommended that the use of slash arguments is enabled. In future it will be required.

For further information, see

* [[Internet Information Services#Slasharguments|IIS server configuration]]
* [[Apache#Slasharguments|Apache slasharguments configuration]]
* [[Nginx#Slasharguments|Nginx slasharguments configuration]]
* [[SCORM_FAQ#slash_arguments_warning_when_I_add.2Fupdate_SCORM_objects_in_my_course|SCORM FAQ: slash arguments warning when I add/update SCORM objects in my course]]

Using slash arguments

2015-03-25T11:27:07Z

Libertymoodle: Added SCORM_FAQ slash_arguments link

{{Environment}}
It is recommended that the use of slash arguments is enabled. In future it will be required.

For further information, see

* [[Internet Information Services#Slasharguments|IIS server configuration]]
* [[Apache#Slasharguments|Apache slasharguments configuration]]
* [[Nginx#Slasharguments|Nginx slasharguments configuration]]
* [[SCORM_FAQ#slash_arguments_warning_when_I_add.2Fupdate_SCORM_objects_in_my_course|SCORM FAQ slash arguments warning when I add/update SCORM objects in my course]]

Internet Information Services

2015-03-03T13:36:20Z

Libertymoodle: /* Debugging problems */

{{Installing Moodle}}[[Internet Information Services]] ('''IIS''') is the web server software bundled with Windows Server, as well as certain client versions of Windows. Please note Apache web server has much better community support and there are usually fewer problems when running Moodle on Apache. Windows OS is not suitable for large installations because PHP is limited to 32bit even in 64bit Windows, please consider using Linux or other unix-like operating systems instead.

==IIS installation steps (Windows 7)==

# Go to Control panel, click on Programs and Turn Windows features on or off
# Tick "Internet Information Services" and "Internet Information Services / Application Development Features / CGI"
# Install [http://www.microsoft.com/web/downloads/platform.aspx Microsoft Web Platform Installer]

==PHP installation steps==

It is strongly recommended to use only the official MS Platform installer, it automatically installs all necessary components and facilitates easy configuration with PHP manager. Manual installation attempts often fail or may not allow Moodle to function properly. Unfortunately MS does not usually distribute up-to-date version of PHP, you may need to download them manually.

# Install [http://www.microsoft.com/web/downloads/platform.aspx Miscrosoft Web Platform Installer]
# Install latest PHP 5.5.x using Web Platform Installer
# Install URL Rewrite 2.0 using Web Platform Installer

Optionally you may install the required components manually:
# Download [http://phpmanager.codeplex.com PHP manager for IIS] and install it
# Download latest PHP 5.5.x VC11 x86 Non Thread Safe from [http://windows.php.net/download/ http://windows.php.net/download/]
# Extract the Zip file to a directory such as C:\PHP\
# Install the Visual C++ Redistributable for Visual Studio 2012 [http://www.microsoft.com/en-us/download/details.aspx?id=30679] - on 64bit Windows install both x86 and x64
# Open the Internet Information Service (IIS) Manager - right click on This computer and select Manage
# Click on PHP Manager icon
# Register new PHP version - select C:\PHP\php-cgi.exe

'''Warning: PHP needs to be configured via FastCGI in IIS, older CGI interface is known to have problems with some file names.'''

==PHP configuration steps==

# Set PHP configuration to values recommended by PHP Manager
# Enable required extensions in the PHP manager: php_intl.dll, php_pgsql.dll
# Enable [[OPcache]] extension
# Set your timezone in PHP.ini
# Set appropriate memory limits in PHP.ini

==IIS configuration steps==

# Setup URL rewriting described below
# Configure IIS to show detailed error pages.
# Set very long CGI timeout - 1 hour or better more.
# In IIS Manager add Moodle dirroot directory as a new virtual directory or set it as site directory

===Slasharguments===

IIS 7 should support relative path arguments by default, if it does not work try enabling following in your php.ini

cgi.fix_pathinfo = 1

===URL rewriting===
If you can not modify registry as described below you may try manual configuration of rewrite rules, the PHP installation via ''Microsoft Web Platform Installer'' installs necessary ''URL Rewrite 2.0'' module.

[[File:Rewrite_rule_-_Internet_Information_Services_(IIS)_Manager.png|thumb]]

Add following rewrite rule to enable support for unicode file names in Moodle and to work around internal file length limitation breaking YUI file serving:

* Matches the Pattern - Regular Expressions - <code>^([^\?]+?\.php)(\/.+)$</code>
* Action - Rewrite - <code>{R:1}\?file={R:2}</code>
* Append query string - enabled
* Stop processing of subsequent rules - enabled

===Optional UTF-8 file name fix===

By default IIS is unable to handle unicode characters in files uploaded into Moodle. This may result in not working Javascript on Moodle site (impossible to expand navigation, etc.) or broken CSS styles.

See [http://www.iis.net/learn/application-frameworks/install-and-configure-php-on-iis/configuring-the-fastcgi-extension-for-iis-60#utf8servervars Using UTF-8 Encoding for Server Variables] and [http://support.microsoft.com/kb/2277918/ How to get UTF-8 Encoding support in IIS 7.5 in Windows 7 and Windows Server 2008 R2 with the KB 2277918 hotfix].

Execute:
<code>
reg add HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\w3svc\Parameters /v FastCGIUtf8ServerVariables /t REG_MULTI_SZ /d REQUEST_URI\0PATH_INFO
</code>

===CGI timeouts===

By default IIS is configured to stop execution of any PHP script after 5 minutes of activity, this interferes with long running Moodle scripts such as upgrade or cron. The timeout should be increased to at least one hour.

==Directory permissions==

The default IIS account is ''IIS_IUSRS'', make sure it has appropriate access right to Moodle dirroot (read only) and dataroot (read/write) directories.

==Debugging problems==

By default, IIS uses custom error pages that intentionally hide error details on production sites:
[[Image:scratch1_77F5DD11.jpg|frame|center|IIS default error message]]

But when you're diagnosing problems in Moodle that's not very useful. You can temporarily disable these default error messages in IIS so that you see a specific Moodle error message. To achieve that set the "existingResponse" setting for Custom Error Pages in IIS to “PassThrough” for your Moodle site. The result will be that Moodle displays a more specific message about the error when a problem occurs:
[[Image:scratch2_243263F6.jpg|frame|center|Useful error message]]
The generic IIS "404" error message which normally does not reveal any details about the problem will no longer be displayed.

The debugging option in ''Settings>Site administration>Development>Debugging'' should also be enabled so that you see the debug messages.

== See also ==

* [[Installing MSSQL for PHP]]
* [http://www.iis.net The Official Microsoft IIS Site]
* [http://en.wikipedia.org/wiki/Internet_Information_Services Wikipedia article on IIS]
* [http://php.iis.net/ PHP installer for IIS]
* [http://blogs.iis.net/kehand/archive/2009/08/09/php-and-custom-error-pages.aspx Kern Handa's blog post about IIS error messages]

[[ja:IIS]]

Internet Information Services

2015-03-03T13:34:44Z

Libertymoodle: /* See also */

{{Installing Moodle}}[[Internet Information Services]] ('''IIS''') is the web server software bundled with Windows Server, as well as certain client versions of Windows. Please note Apache web server has much better community support and there are usually fewer problems when running Moodle on Apache. Windows OS is not suitable for large installations because PHP is limited to 32bit even in 64bit Windows, please consider using Linux or other unix-like operating systems instead.

==IIS installation steps (Windows 7)==

# Go to Control panel, click on Programs and Turn Windows features on or off
# Tick "Internet Information Services" and "Internet Information Services / Application Development Features / CGI"
# Install [http://www.microsoft.com/web/downloads/platform.aspx Microsoft Web Platform Installer]

==PHP installation steps==

It is strongly recommended to use only the official MS Platform installer, it automatically installs all necessary components and facilitates easy configuration with PHP manager. Manual installation attempts often fail or may not allow Moodle to function properly. Unfortunately MS does not usually distribute up-to-date version of PHP, you may need to download them manually.

# Install [http://www.microsoft.com/web/downloads/platform.aspx Miscrosoft Web Platform Installer]
# Install latest PHP 5.5.x using Web Platform Installer
# Install URL Rewrite 2.0 using Web Platform Installer

Optionally you may install the required components manually:
# Download [http://phpmanager.codeplex.com PHP manager for IIS] and install it
# Download latest PHP 5.5.x VC11 x86 Non Thread Safe from [http://windows.php.net/download/ http://windows.php.net/download/]
# Extract the Zip file to a directory such as C:\PHP\
# Install the Visual C++ Redistributable for Visual Studio 2012 [http://www.microsoft.com/en-us/download/details.aspx?id=30679] - on 64bit Windows install both x86 and x64
# Open the Internet Information Service (IIS) Manager - right click on This computer and select Manage
# Click on PHP Manager icon
# Register new PHP version - select C:\PHP\php-cgi.exe

'''Warning: PHP needs to be configured via FastCGI in IIS, older CGI interface is known to have problems with some file names.'''

==PHP configuration steps==

# Set PHP configuration to values recommended by PHP Manager
# Enable required extensions in the PHP manager: php_intl.dll, php_pgsql.dll
# Enable [[OPcache]] extension
# Set your timezone in PHP.ini
# Set appropriate memory limits in PHP.ini

==IIS configuration steps==

# Setup URL rewriting described below
# Configure IIS to show detailed error pages.
# Set very long CGI timeout - 1 hour or better more.
# In IIS Manager add Moodle dirroot directory as a new virtual directory or set it as site directory

===Slasharguments===

IIS 7 should support relative path arguments by default, if it does not work try enabling following in your php.ini

cgi.fix_pathinfo = 1

===URL rewriting===
If you can not modify registry as described below you may try manual configuration of rewrite rules, the PHP installation via ''Microsoft Web Platform Installer'' installs necessary ''URL Rewrite 2.0'' module.

[[File:Rewrite_rule_-_Internet_Information_Services_(IIS)_Manager.png|thumb]]

Add following rewrite rule to enable support for unicode file names in Moodle and to work around internal file length limitation breaking YUI file serving:

* Matches the Pattern - Regular Expressions - <code>^([^\?]+?\.php)(\/.+)$</code>
* Action - Rewrite - <code>{R:1}\?file={R:2}</code>
* Append query string - enabled
* Stop processing of subsequent rules - enabled

===Optional UTF-8 file name fix===

By default IIS is unable to handle unicode characters in files uploaded into Moodle. This may result in not working Javascript on Moodle site (impossible to expand navigation, etc.) or broken CSS styles.

See [http://www.iis.net/learn/application-frameworks/install-and-configure-php-on-iis/configuring-the-fastcgi-extension-for-iis-60#utf8servervars Using UTF-8 Encoding for Server Variables] and [http://support.microsoft.com/kb/2277918/ How to get UTF-8 Encoding support in IIS 7.5 in Windows 7 and Windows Server 2008 R2 with the KB 2277918 hotfix].

Execute:
<code>
reg add HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\w3svc\Parameters /v FastCGIUtf8ServerVariables /t REG_MULTI_SZ /d REQUEST_URI\0PATH_INFO
</code>

===CGI timeouts===

By default IIS is configured to stop execution of any PHP script after 5 minutes of activity, this interferes with long running Moodle scripts such as upgrade or cron. The timeout should be increased to at least one hour.

==Directory permissions==

The default IIS account is ''IIS_IUSRS'', make sure it has appropriate access right to Moodle dirroot (read only) and dataroot (read/write) directories.

==Debugging problems==

By default, IIS uses custom error pages that intentionally hide error details on production sites:
[[Image:scratch1_77F5DD11.jpg|frame|center|IIS default error message]]

When diagnosing problems in Moodle that's not very useful, so you can temporarily disable these default error messages in IIS so that you see a specific Moodle error message. To achieve that set the "existingResponse" setting for Custom Error Pages in IIS to “PassThrough” for your Moodle site. The result will be that Moodle displays a more specific message about the error when a problem occurs:
[[Image:scratch2_243263F6.jpg|frame|center|Useful error message]]
The generic IIS "404" error message which normally does not reveal any details about the problem will no longer be displayed.

The debugging option in ''Settings>Site administration>Development>Debugging'' should also be enabled so that you see the debug messages.

== See also ==

* [[Installing MSSQL for PHP]]
* [http://www.iis.net The Official Microsoft IIS Site]
* [http://en.wikipedia.org/wiki/Internet_Information_Services Wikipedia article on IIS]
* [http://php.iis.net/ PHP installer for IIS]
* [http://blogs.iis.net/kehand/archive/2009/08/09/php-and-custom-error-pages.aspx Kern Handa's blog post about IIS error messages]

[[ja:IIS]]

Internet Information Services

2015-03-03T13:33:10Z

Libertymoodle: IIS debugging setup

{{Installing Moodle}}[[Internet Information Services]] ('''IIS''') is the web server software bundled with Windows Server, as well as certain client versions of Windows. Please note Apache web server has much better community support and there are usually fewer problems when running Moodle on Apache. Windows OS is not suitable for large installations because PHP is limited to 32bit even in 64bit Windows, please consider using Linux or other unix-like operating systems instead.

==IIS installation steps (Windows 7)==

# Go to Control panel, click on Programs and Turn Windows features on or off
# Tick "Internet Information Services" and "Internet Information Services / Application Development Features / CGI"
# Install [http://www.microsoft.com/web/downloads/platform.aspx Microsoft Web Platform Installer]

==PHP installation steps==

It is strongly recommended to use only the official MS Platform installer, it automatically installs all necessary components and facilitates easy configuration with PHP manager. Manual installation attempts often fail or may not allow Moodle to function properly. Unfortunately MS does not usually distribute up-to-date version of PHP, you may need to download them manually.

# Install [http://www.microsoft.com/web/downloads/platform.aspx Miscrosoft Web Platform Installer]
# Install latest PHP 5.5.x using Web Platform Installer
# Install URL Rewrite 2.0 using Web Platform Installer

Optionally you may install the required components manually:
# Download [http://phpmanager.codeplex.com PHP manager for IIS] and install it
# Download latest PHP 5.5.x VC11 x86 Non Thread Safe from [http://windows.php.net/download/ http://windows.php.net/download/]
# Extract the Zip file to a directory such as C:\PHP\
# Install the Visual C++ Redistributable for Visual Studio 2012 [http://www.microsoft.com/en-us/download/details.aspx?id=30679] - on 64bit Windows install both x86 and x64
# Open the Internet Information Service (IIS) Manager - right click on This computer and select Manage
# Click on PHP Manager icon
# Register new PHP version - select C:\PHP\php-cgi.exe

'''Warning: PHP needs to be configured via FastCGI in IIS, older CGI interface is known to have problems with some file names.'''

==PHP configuration steps==

# Set PHP configuration to values recommended by PHP Manager
# Enable required extensions in the PHP manager: php_intl.dll, php_pgsql.dll
# Enable [[OPcache]] extension
# Set your timezone in PHP.ini
# Set appropriate memory limits in PHP.ini

==IIS configuration steps==

# Setup URL rewriting described below
# Configure IIS to show detailed error pages.
# Set very long CGI timeout - 1 hour or better more.
# In IIS Manager add Moodle dirroot directory as a new virtual directory or set it as site directory

===Slasharguments===

IIS 7 should support relative path arguments by default, if it does not work try enabling following in your php.ini

cgi.fix_pathinfo = 1

===URL rewriting===
If you can not modify registry as described below you may try manual configuration of rewrite rules, the PHP installation via ''Microsoft Web Platform Installer'' installs necessary ''URL Rewrite 2.0'' module.

[[File:Rewrite_rule_-_Internet_Information_Services_(IIS)_Manager.png|thumb]]

Add following rewrite rule to enable support for unicode file names in Moodle and to work around internal file length limitation breaking YUI file serving:

* Matches the Pattern - Regular Expressions - <code>^([^\?]+?\.php)(\/.+)$</code>
* Action - Rewrite - <code>{R:1}\?file={R:2}</code>
* Append query string - enabled
* Stop processing of subsequent rules - enabled

===Optional UTF-8 file name fix===

By default IIS is unable to handle unicode characters in files uploaded into Moodle. This may result in not working Javascript on Moodle site (impossible to expand navigation, etc.) or broken CSS styles.

See [http://www.iis.net/learn/application-frameworks/install-and-configure-php-on-iis/configuring-the-fastcgi-extension-for-iis-60#utf8servervars Using UTF-8 Encoding for Server Variables] and [http://support.microsoft.com/kb/2277918/ How to get UTF-8 Encoding support in IIS 7.5 in Windows 7 and Windows Server 2008 R2 with the KB 2277918 hotfix].

Execute:
<code>
reg add HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\w3svc\Parameters /v FastCGIUtf8ServerVariables /t REG_MULTI_SZ /d REQUEST_URI\0PATH_INFO
</code>

===CGI timeouts===

By default IIS is configured to stop execution of any PHP script after 5 minutes of activity, this interferes with long running Moodle scripts such as upgrade or cron. The timeout should be increased to at least one hour.

==Directory permissions==

The default IIS account is ''IIS_IUSRS'', make sure it has appropriate access right to Moodle dirroot (read only) and dataroot (read/write) directories.

==Debugging problems==

By default, IIS uses custom error pages that intentionally hide error details on production sites:
[[Image:scratch1_77F5DD11.jpg|frame|center|IIS default error message]]

When diagnosing problems in Moodle that's not very useful, so you can temporarily disable these default error messages in IIS so that you see a specific Moodle error message. To achieve that set the "existingResponse" setting for Custom Error Pages in IIS to “PassThrough” for your Moodle site. The result will be that Moodle displays a more specific message about the error when a problem occurs:
[[Image:scratch2_243263F6.jpg|frame|center|Useful error message]]
The generic IIS "404" error message which normally does not reveal any details about the problem will no longer be displayed.

The debugging option in ''Settings>Site administration>Development>Debugging'' should also be enabled so that you see the debug messages.

== See also ==

* [[Installing MSSQL for PHP]]
* [http://www.iis.net The Official Microsoft IIS Site]
* [http://en.wikipedia.org/wiki/Internet_Information_Services Wikipedia article on IIS]
* [http://php.iis.net/ PHP installer for IIS]
* [http://blogs.iis.net/kehand/archive/2009/08/09/php-and-custom-error-pages.aspx blog post about IIS error messages]

[[ja:IIS]]

File:scratch1 77F5DD11.jpg

2015-03-03T13:26:08Z

Libertymoodle: Default IIS 404 error message, without and specific details of the problem.

Default IIS 404 error message, without and specific details of the problem.

File:scratch2 243263F6.jpg

2015-03-03T13:24:39Z

Libertymoodle: Useful Moodle error message

Useful Moodle error message

Talk:Question bank

2014-10-17T09:08:15Z

Libertymoodle: /* =Clarify functionality */

===Clarify functionality===
What is the purpose of the "Also show old questions" checkbox on the Question Bank page (/question/edit.php?cmid=...)?

What is an "old question"?
--[[User:Luis de Vasconcelos|Luis de Vasconcelos]] ([[User talk:Luis de Vasconcelos|talk]]) 17:06, 17 October 2014 (WST)

Talk:Question bank

2014-10-17T09:06:52Z

Libertymoodle: What is "Also show old questions" checkbox?

===Clarify functionality==
What is the purpose of the "Also show old questions" checkbox on the Question Bank page (/question/edit.php?cmid=...)?

What is an "old question"?
--[[User:Luis de Vasconcelos|Luis de Vasconcelos]] ([[User talk:Luis de Vasconcelos|talk]]) 17:06, 17 October 2014 (WST)