MoodleDocs - User contributions [en]

MediaWiki:Sitenotice

2021-10-20T11:52:06Z

Tsala: improved wording

''Note: This documentation is for Moodle 2.7. For up-to-date documentation see '''[[:en:{{NAMESPACE}}:{{PAGENAME}}|{{PAGENAME}}]].'''''

MediaWiki:MoodleDocsVersionLinks

2017-05-14T08:41:01Z

Tsala: 3.3 link

2.7 docs: /27/en/{{FULLPAGENAMEE}}
3.3 docs: /33/en/{{FULLPAGENAMEE}}
3.2 docs: /32/en/{{FULLPAGENAMEE}}
3.1 docs: /31/en/{{FULLPAGENAMEE}}

Workshop FAQ

2017-02-10T08:48:12Z

Tsala: How can I obtain more grading levels for each rubric criterion? - Q & A copied from https://moodle.org/mod/forum/discuss.php?d=347205

{{Workshop}}
==How the heck are these grades calculated?==

Make sure you read carefully pages explaining [[Using_Workshop#Workshop_grading|workshop grading]] and [[Workshop grading strategies|grading strategies]].

==How can I get the workshop to switch phase automatically?==

In ''Administration > Workshop Administration > Edit settings'' tick the box 'Switch to the next phase after the submissions deadline' in the access control section. The workshop will then automatically switch to the assessment phase - after the next time cron is run on your Moodle. (Depending on your Moodle administration, you might be able to run it manually by typing into your browser ''YOURMOODLE.com/admin/cron.php'' (where YOURMOODLE.com is the name of your Moodle site).

==How can I make reviewing anonymous?==

If you do not want your students to know whose work they are reviewing and who is reviewing their work, go to ''Administration>Workshop administration>Permissions'' and click the X next to student to prevent "view author names" ''mod/workshop:viewauthornames'' and "view reviewer names" ''mod/workshop:viewreviewernames''

==Can I use Workshop for students to peer assess an offline activity?==
You can, although they will have to submit something, even though that might be a blank document. See this forum post for more information: https://moodle.org/mod/forum/discuss.php?d=220054#p958145

==How can I publish workshop submissions?==
When in the Grading evaluation phase, it is possible to publish (ie make visible to all participants) selected submissions you might consider are helpful examples. To do this, as the teacher, choose a particular submission and click its title.Scroll down and below the submission text you will find a form allowing you to mark the submission as published. Save the form. When the workshop is closed, any such published submissions become visible.
{|
| [[File:publishedsubmissions.png|thumb|Published submissions (click to enlarge)]]
|}

==How can I edit or delete an example submission?==
Example submissions can only be managed (added, edited or deleted) during the setup phase. In the list of example submissions, click on the title of the submission you'd like to delete. Below the submission content, there are buttons to edit, delete and assess the example submission.

==How can I obtain more grading levels for each rubric criterion?==

Each time you save the form, then continue editing it, a new empty level is displayed. If you don't need it, simply leave it empty.

==See also==

*Using Moodle [http://moodle.org/mod/forum/view.php?id=740 Workshop forum]

[[Category:FAQ]]

[[de:Workshop FAQ]]
[[es:Taller FAQ]]

Upgrading FAQ

2017-01-25T11:31:03Z

Tsala: download link for Moodle 2.2

{{Installing Moodle}}
==How do I upgrade from 1.9.x to 2.7?==

1.x -> 1.9.19 -> 2.2.11 -> 2.7

(It is better to upgrade to latest current stable before going to next branch, the same for plugins; upgrading from early stable branches usually works but there is no guarantee.)

Moodle 2.2.11 may be downloaded from https://download.moodle.org/stable22/.

==How do I upgrade Moodle? Do I just overwrite the files?==

Do NOT overwrite files, as it may cause strange errors. Read the [[Upgrading]] documentation before proceeding.

==I obtain the message "Upgrade already running in this session, please wait!"==

Most likely you refreshed the page before the completion message. If you are absolutely sure that there are no upgrade processes active (php and/or mysql), you can click on "!!!" and restart the upgrade.

:''Note'': If you click on "'!!!" or try to restart the upgrade from another browser, there is a chance that your data in the database could be corrupted. If this happens, you will need to restore the database from sql dump and then restart the upgrade and wait - the process can take several hours on large sites.

==Can I upgrade more than one version at a time?==

You can only upgrade to Moodle 2.7 from Moodle 2.2.

You can only upgrade to Moodle 2.2 from Moodle 1.9 or later.

For information on upgrading from versions of Moodle prior to 1.9, see the section 'Upgrading more than one version' in the Moodle 2.2 documentation [https://docs.moodle.org/22/en/Upgrading Upgrading].

==I have custom code in my site. How do I upgrade?==
Please see this forum post on [https://moodle.org/mod/forum/discuss.php?d=263355#p1141326 upgrading with custom code] for some suggestions.

==See also==

* [[Installation FAQ]]
* Using Moodle [https://moodle.org/mod/forum/discuss.php?d=224561 Notes on upgrading Moodle from 1.9.x to 2.4.1 on a shared server] forum discussion

[[Category:FAQ]]

[[ja:アップグレードFAQ]]
[[es:Actualización FAQ]]

Installation FAQ

2017-01-09T15:35:58Z

Tsala: /* Downloading previous releases of Moodle */ simplifying text

{{Installing Moodle}}
== System information needed for Installation problems forum ==
When posting questions to the [http://moodle.org/mod/forum/view.php?id=28 Installation problems forum], try to provide as much background information as possible about your Moodle system. Consider providing some or all of the following:
* Server Operating System name (version also if possible):
* PHP version (e.g. PHP 5.4.4)
* Database server type and version (e.g. MySQL 5.5.18)
* Browser and version (e.g. Firefox, IE8):
* Moodle version (e.g. 2.7):
* Moodle install type? (New/Upgrade):
* Moodle config.php attached (please remove passwords):
* Phpinfo attached?:

Make sure you provide a sensible description (never HELP! or URGENT!) and a full description of what you did and what happened. Copy and paste any error messages accurately in full. 'Nothing' is not a symptom, even a blank page is something!

[[#top|Top]]

==PHP - is it installed and what version do I have?==

Make a new file on your web site called ''info.php'', containing the following text, and call it from your browser:

<code php>
<?PHP phpinfo() ?>
</code>

If nothing happens then you don't have PHP installed or your webserver is not configured to handle .php files properly. See the installation docs for some information about where to download it for your computer. See the [[phpinfo]] page for details about the content of this page.

[[#top|Top]]

==I am being told that I need the '''intl php plugin''' to continue to install Moodle 2.x==
The intl.dll from Zend is part of the PHP 5.2.8 release and later. It is aimed at improving the internationalization of php pages and Moodle 2.x uses it as part of this process. If your install is on a local machine or network, then you can download the latest version of PHP and update your PHP. You then have to uncomment all the required dynamic extensions you need, including the php_intl.dll extension. The problem is then solved. If the install is on a host server, then you need to contact your host and ask them to do the same, As an alternative, you can unzip/untar the download file, copy and paste the intl.dll file to your php/ext folder and include the line:
extension=php_intl.dll
in the Dynamic Extensions section of your php.ini file.

You can also set the error level using:
intl.error_level = E_WARNING
but this is not essential

If you are using a Linux install, use your system package manager or specify compilation flag.
* Debian 5.0 (& Ubuntu) use: apt-get install php-intl or apt-get install php5-intl
* CentOS 5.5 (& RedHat) you should (probably) be using php 5.3 from remi and then use: yum install php-intl

This technique can be applied to any updated dynamic extension from Zend. You may want to use later dll files in your php/ext folder, you can do so by doing the same as above, but be careful, your version may not be able to take full advantage of the extension, or some very new extensions may cause an unexpected instability. The best option is still to update on a regular basis, perhaps once a year or so for the PHP.

[[#top|Top]]

===What Dynamic Extensions do I really need uncommented in my php.ini file? What else do I need to change?===
This assumes you have complete control over the installation and running of your server, if your Moodle is hosted, you need to do something different, which is also discussed below. In the php.ini you need to delete the semi-colon, the ;, from the start of any line to uncomment it. For Moodle, you really should only need to change some values, and make sure the extensions you require are available. These are:

Resource Limits
memory_limit = 128M //This is the maximum it requires and on a shared server you may get much less.

Data Handling
post_max_size = 512M //This allows postings of up to 512MB, but set it to suit yourself and your circumstances

Paths and Directories
doc_root ="driveletter:\path\to\server\active\web\directory" (e.g. d:\Apache\htdocs or e:\iis\wwwroot )
and
extension_dir = "driveletter:\path\to\php\ext" (e.g. d:\php\ext or e:\iis\php\ext)

File Uploads
upload_max_filesize = 512M (This is different from the post_max_size this is for file uploads.)

Dynamic Extensions ('''Windows Only''')
{| class="nicetable"
|-
! PHP 5.3.x
|-
|
extension=php_curl.dll
extension=php_gd2.dll
extension=php_gettext.dll
extension=php_intl.dll
extension=php_imap.dll
extension=php_ldap.dll
extension=php_mbstring.dll
extension=php_exif.dll ; Must be after mbstring as it depends on it
extension=php_mysql.dll
extension=php_mysqli.dll
extension=php_openssl.dll
extension=php_pdo_mssql.dll
extension=php_pdo_mysql.dll
extension=php_soap.dll
extension=php_sockets.dll
extension=php_sqlite.dll
extension=php_xmlrpc.dll
extension=php_zip.dll
|}

These edits and Dynamic extensions cover a range of options here, there are a number of other possibilities, but these listed are the most common ones. Unless you have a specific need, there may not be any reason to deviate from these settings, but if you do, make sure you know what is going to happen. These extensions will also allow you to successfully install and run many other PHP applications.

One example is the Oracle extensions are not shown here, but Oracle can be used for the Moodle database. Another area people often get themselves into trouble is using "Magic quotes". Magic quotes really should be set to off, they were only introduced early in the use of PHP to allow for some inexperienced scripting practices, (read poor, shoddy or dodgy here). If someone is still writing poor scripts, then they deserve to draw attention to themselves and their scripts deleted.

[[#top|Top]]

==What & where are Moodle's configuration settings stored?==
Configuration settings are stored in the config.php file stored in your moodle folder. This file is created during the installation process. If there is a problem and the installation cannot create the file, you can try creating it manually from the [[Configuration file]] docs.
[[#top|Top]]

==Downloading previous releases of Moodle==

Previous versions of Moodle that are not found on [http://download.moodle.org Moodle downloads] may be downloaded from <nowiki>http://download.moodle.org/stable[version_number]/</nowiki> where [version_number] is the number without a point. For example http://download.moodle.org/stable20/ or http://download.moodle.org/stable27/

You'll see a directory tree with the files displayed. Click on the one you want and download as normal. If you require the latest update of the version, scroll to the end of the list and download the "moodle-latest" file.

* '''Windows Packages''': To download other releases not found in [http://download.moodle.org/windows/ Moodle packages for Windows], use this URL:
:<nowiki>http://download.moodle.org/windows/MoodleWindowsInstaller-latest-[version_number].zip</nowiki>
* '''Mac Packages''': To download other releases not found in [http://download.moodle.org/macosx/ Mac packages], use either of these URLs (depending on whether you need the Intel or PPC package):
:<nowiki>http://download.moodle.org/macosx/Moodle4Mac-Intel-[version_number].dmg</nowiki>
:<nowiki>http://download.moodle.org/macosx/Moodle4Mac-PPC-[version_number}.dmg</nowiki>

[[#top|Top]]

== How to enable and check PHP error logs==
PHP can be set up to log errors in a variety of different ways: two of these involve the use of the php.ini file and the ini_set command. See [[PHP error logs]].

== "Could not find a top level course" ==
If this appears immediately after you have attempted to install Moodle it almost certainly means that the installation did not complete. A complete installation will ask you for the administrator profile and to name the site just before it completes. Check your logs for errors. Then drop the database and start again. If you used the web-based installer try the command line one. Does your computer definitely have sufficient resource to run Moodle?

==Email copies are not being sent from my forums==

You ''must'' set up cron properly if you want Moodle to send out automatic email from forums, assignments etc. This same process also performs a number of clean-up tasks such as deleting old unconfirmed users, unenrolling old students and so on. Please refer to the [[Cron|cron instructions]].

Tips:
* Try the default settings in ''Settings > Site administration > Plugins > Message outputs > Email''. This generally works. Except...
* On a Windows server you *must* supply the address of an SMTP server (Windows, unlike Unix, does not have a build in mail server) in the above settings page
* Make sure that ''allowuseremailcharset'' in ''Settings > Site administration > Plugins > Message outputs > Email'' is set to No unless you really know what you are doing. Setting this to Yes can cause a problem in some versions of Moodle.
* Check your firewall or ask your network administrator. Many mail servers are heavily locked down and you may need permission to send mail through them.

[[#top|Top]]

==I can't log in - I just stay stuck on the login screen==

This may also apply if you are seeing “Your session has timed out. Please login again” or "A server error that affects your login session was detected. Please login again or restart your browser" and cannot log in.

The following are possible causes and actions you can take (in no particular order):

* Check first that your main admin account (which will be a manual account) is also a problem. If your users are using an external authentication method (e.g. LDAP) that could be the problem. Isolate the fault and make sure it really is Moodle before going any further.
* Check that your hard disk is not full or if your server is on shared hosting check that you have not reached your disk space quota. This will prevent new sessions being created and nobody will be able to log in.
* Carefully check the permissions in your 'moodledata' area. The web server needs to be able to write to the 'sessions' subdirectory.
* Your own computer (not your Moodle server) may have a firewall that is stripping referrer information from the browser. Here are some instructions for fixing [http://service1.symantec.com/SUPPORT/nip.nsf/46f26a2d6dafb0a788256bc7005c3fa3/b9b47ad7eddd343b88256c6b006a85a8?OpenDocument&src=bar_sch_nam Norton firewall products].
* Try deleting the ''sessions'' folder in your moodledata directory (anybody currently logged in will be thrown out)
* Try deleting cookies on your computer and/or try another browser or another client computer
* In ''Settings > Site administration > Server > Session Handling'', try setting a value for 'Cookie prefix'. You can also do this by setting <code>$CFG->sessioncookie='something';</code> in config.php. This is especially true if you are using multiple Moodles on the same browser.
* Make sure you have not removed or changed the [[Password salting|Password Salt]] value(s) in config.php. If passwords were created using a salt the correct salt must be in config.php for those passwords to continue to work. This is easily done if you recreate config.php while performing an upgrade and forget to transfer the salt values.
* Do you have a .htaccess file in your Moodle folder (or its parent directories). If so, is there anything in there that might be causing trouble (strange redirects, access restrictions etc.)?
* Check the value of '''mnet_localhost_id''' in the mdl_config database table. It's normally 1 but must match the '''mnet_hostid''' field in your user records in the mdl_user table for the user to be recognised. It can sometimes get changed spuriously during upgrades or site migrations.
* Check config.php - it should NOT have any spaces/new lines at the end of code.
* You are using the correct username and password, yes?

If you are still having problems, read the [[Can_not_log_in | Cannot log in]] page. You '''could''' also try changing the admin password. Proceed as if you have lost it - see [[Administration FAQ]].

[[#top|Top]]

==I log in but the login link doesn't change. I am logged in and can navigate freely.==

Make sure the URL in your <code>$CFG->wwwroot</code> setting is exactly the same as the one you are actually using to access the site.

[[#top|Top]]
==Uploaded files give "File not found"==

For example: Not Found: The requested URL /moodle/file.php/2/myfile.jpg was not found on this server.

This indicates that slash arguments are not enabled on your web server. Please see [[Using slash arguments]] for details.

[[#top|Top]]

==Why are all my pages blank?==

Check the dirroot variable in ''config.php''. You must use complete, absolute pathnames (e.g.)

<code php>
$CFG->dirroot = "/var/www/moodle";
</code>

Another reason might be that PHP has not been configured to support MySQL (or whatever other database you are using). This is common on RedHat and OpenBSD installations. In this case, an error is generated, but since error displays are often disabled by default, all that is seen on the browser is a blank screen. To enable PHP error displays see [[Installation_FAQ#How_to_enable_and_check_PHP_error_logs | How to enable and check PHP error logs]].

To determine if database support is your problem, insert this as the second line in your ''config.php'' file

<code php>
phpinfo();
</code>

then reload the web page. Examine the output closely to see if you chosen database is supported. If not, look for a package you are missing.

[[#top|Top]]

== Why is a particular page blank or incomplete? ==

*'''Check your web server log files!!'''
:If a particular page is blank or incomplete (it doesn't display the footer), before you do anything else switch on [[Debugging]] and [[Installation_FAQ#How_to_enable_and_check_PHP_error_logs | check your PHP error logs]]. Having established that PHP error logging is working, reproduce the error. Immediately check the error log file right at the end. Hopefully you will see a PHP error message at or very near the end of the file. This may solve your problem directly or makes it a lot easier to diagnose the problem in the Moodle forums.

*If you are '''upgrading to a new version of Moodle''', check that you do not have an old version of a non-standard block or module installed. Remove any such blocks or modules installed using the admin settings page and start the install process again. However, do also make sure that you have included all optional plugins that were required by your courses. This is particularly common with "editing on".

*If you '''do not see any blocks listed''', turn editing on and remove any blocks that you have added to that page and try reloading.

*You may get this error immediately after '''selecting a language'''. At this stage of the installation process your Moodle computer may need to connect to the Internet and download a language pack, so check that the computer can access the Internet by using a browser. Check also that your PHP settings are as given in the Moodle [[Installing_Moodle#Requirements | Moodle Requirements]] page.

'''See also''':
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=97734 PHP configuration error] forum discussion

==Installation hangs when setting-up database tables==
Sometimes the installation will hang when setting up tables, where only half the page displayed in the browser and/or other outputs are removed. You may see truncated MySQL statements, or the “Scroll to continue” link is displayed but no “Continue” button is there.

See [[Unexpected installation halts]] for more about solutions that involve:
*Checking for MySQL limits
*Checking the .htaccess files
*Code customizations issues
*Checking memory limit
*Upgrade incrementally
*Fix fopen function

[[#top|Top]]

==Why can't I upload a new image into my profile?==

If you don't see anything on your user profile pages to let you upload user images then it's usually one of the following:
*The permissions associated with the role you are using are preventing you from changing your profile picture.
* GD is not installed, or is not enabled on your server. Make sure '''GD has been included in your PHP installation'''. You can check this by going to ''Site Administration > Server > PHP info'' and looking for the gdversion setting. This setting is chosen automatically every time you visit that page. If it shows GD version 1 or version 2 then everything should be fine. Save that configuration page and go back to your user profile.
* GD is installed, but is in some way corrupt. For instance, [http://moodle.org/mod/forum/discuss.php?d=44271#p386194 see this discussion on empty lines or white spaces in config files.]
GD is a library that allows image processing. For example, when all is well with your system, and you upload a new profile image, GD compresses the image and produces two thumbnails, one is 100x100 pixels, and the other is 35x35 pixels.

If Moodle thinks GD is not installed, then you will need to '''install the GD library'''.
*On Unix you may need to re-compile PHP with arguments something like this:

./configure --with-apxs=/usr/local/apache/bin/apxs --with-xml --with-gd
--with-jpeg-dir=/usr/local --with-png-dir=/usr --with-ttf --enable-gd-native-ttf
--enable-magic-quotes --with-mysql --enable-sockets --enable-track-vars
--enable-versioning --with-zlib

* On Windows this is usually a matter of "turning on" the extension in PHP by editing your php.ini file. To do this remove the semicolon for the php_gd2.dll extension - check that this file is actually present in your php extensions folder first (search your php.ini for extension_dir to determine where this points to on your hard disk). You should then have a line that looks like this:
extension=php_gd2.dll

:Windows users should see the [[Installing AMP|installation instructions]] for further help.

3. Remember to '''restart your webserver''' (if possible) and re-visit the Moodle configuration page after making any changes to PHP so it can pick up the correct version of GD.

'''See also''': Using Moodle forum discussion [http://moodle.org/mod/forum/discuss.php?d=44271 Profile pictures] for additional information.

== Why doesn't my Moodle site display the time and date correctly? ==

Each language requires a specific language code (called a '''locale''' code) to allow dates to be displayed correctly. The language packs contain default standard codes, but sometimes these don't work on Windows servers.

You can find the correct locale codes for Windows on these two pages: [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/vclib/html/_crt_language_strings.asp Language codes] and [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/vclib/html/_crt_country_strings.asp Country/region] codes (e.g. "esp_esp" for spanish)

These new locale codes can be entered on the Administration >> Configuration >> [[admin/config|Variables]] page, where they override the ones in the currently chosen language pack.
[[#top|Top]]
== How do I uninstall Moodle?==

'''Webhost/manual installation''': If you have installed Moodle manually or have installed onto a webhost, follow these steps:
*Delete the moodle database using this mysql command (or delete using your mysql client, e.g. PHPMyAdmin):
<pre>sql>DROP DATABASE moodle;</pre>
:In the above example replace 'moodle' with the name of the moodle database you created when installing.
*Delete the moodledata directory. If you, or your users, have uploaded materials into this directory take a copy of these before deleting this directory.
*Delete the moodle directory itself. This will delete all of the moodle PHP script files.

'''XAMPP windows installation''': If you have installed Moodle on windows through the XAMPP package, follow these steps:
*Open cmd.exe and navigate to this directory within your installation directory:
<pre>server/mysql/bin</pre>
*Run this command, replacing USERNAME with your database username (the default is "root") and DATABASE with your database name (the default is "moodle"):
<pre>mysqladmin.exe -u USERNAME -p drop DATABASE</pre>
*Enter your database password at the prompt (the default is "" [blank]).
*Enter "y" to confirm the database drop.
*Delete the moodledata directory. If you, or your users, have uploaded materials into this directory take a copy of these before deleting this directory.
*Delete the moodle directory itself. This will delete all of the moodle PHP script files.

==Migrating Moodle to a new site or server==
Migrating Moodle means that you have to move the current installation to a new server, and so may have to change IP addresses or DNS entries. To do this you will need to change the $CFG->wwwroot value in the config.php on the new server. You will also have to change any absolute links stored in the database backup file (before restoring the file on the new server) either using the admin/replace.php script, your text editor or another "search and replace" tool, e.g. sed. For more details see the [[Moodle_migration | Moodle Migration]] page.

[[#top|Top]]
==Why does my new installation display correctly on the server, but when I view it from a different machine, styles and images are missing?==
In the installation instructions, one of the suggested settings for 'webroot' is 'localhost'. This is fine if all you want to do is some local testing of your new Moodle installation. If, however, you want to view your new installation from another machine on the same local area network, or view your site on the internet, you will have to change this setting:
*For local testing, 'localhost' is fine for the webroot ($CFG->wwwroot in config.php).
*If you want to test your site from other machines on the same local area network (LAN), then you will have to use the private ip address of the serving machine, (e.g. 192.168.1.2/moodle) or the network name of the serving computer (e.g. network_name_of_serving_machine/moodle) as the web root. Depending on your LAN setup, it may be better to use the network name of the computer rather than its (private) ip address, because the ip address can and will change from time to time. If you don't want to use the network name, then you will have to speak to your network administrator and have them assign a permanent ip address to the serving machine.
*Finally, if you want to test your new installation across the internet, you will have to use either a domain name or a permanent (public) ip address/moodle as your web root. To handle both types of access, see [https://docs.moodle.org/en/masquerading masquerading].

[[#top|Top]]
==Maximum upload file size - how to change it?==
There are several places to change the maximum file upload size. The first place to check is the Administration block. Security -> Site Policies -> and look for "Maximum Uploaded File Size". This is the "maxbyte" variable found in older versions of Moodle (under Admin > Variables). Teachers may also set the maximum file size by the [[Course_settings#Maximum_upload_size|course administration block]].

If the above does not provide a large enough figure you will need to make changes in your server settings. The usual place is in your php.ini file (go to Site administration > Server > PHPinfo and check a few lines down for its location). Look for settings '''upload_max_filesize''' and '''post_max_size''', setting them both to your desired new value (e.g. '64MB'). You will need to restart the web server for these changes to take effect - e.g. on Linux, '''/etc/init.d/apache2 force-reload'''. Check your documentation or just reboot the server.

For more help see:
*[[Administration_FAQ#How_do_the_limits_on_uploaded_files_work.3F]]
*[[Installing_Moodle#Recheck_PHP_settings]]
*[[Installing_Moodle#Using_a_.htaccess_file_for_webserver_and_PHP_settings]]
*[[Site_policies#Maximum_uploaded_file_size]]
*These forum posts: http://moodle.org/mod/forum/discuss.php?d=63840#287960 and http://moodle.org/mod/forum/discuss.php?d=93882#p414650

[[#top|Top]]

==Moodle claims PHP float handling is not compatible==

The symptom is that when you try to install or upgrade your Moodle, you get a message "Detected unexpected problem in handling of PHP float numbers".

[http://moodle.org/mod/forum/discuss.php?d=114945 This forum thread] and MDL-18253 have more information. In short, this problem should not happen, you can help us by telling posting information about exactly which version of PHP, and OS you are using. That may let us find a way to work around this problem.

You may be able to solve this issue by installing a more recent PHP versions. If you compile PHP yourself from source, changing the compilation options may help. However, since we don't understand the cause, we don't really know. If you do find a solution that works for you, please do tell us about it.

Update: we have a guess that the problem may be the [http://au2.php.net/manual/en/ini.core.php#ini.precision 'precision' setting in your php.ini file]. In a default PHP install this is set of 14. On at least one server that exhibited this problem it had been changed to a smaller value. So, if you see this problem, please try adding
ini_set('precision', 14);
to your config.php file, and report your success in MDL-18253.

==When upgrading Moodle claims my MySQL database is not UTF8 when I'm sure it is==

The UTF-8 detection for MySQL databases was finally fixed in Moodle 2.5, some incorrectly configured databases were previously reported as compatible.

Please note it is not enough to alter the charset and collation of the database, you must fix each text column in each database table!

Before going any further make sure you understand the difference between character encoding (how text is stored) and collations (the rules for comparing text strings). Collation problems will never cause this error but have a bunch of problems of their own.

See [[Converting your MySQL database to UTF8]]

[[#top|Top]]

== How do I run multiple instances of Moodle without duplicating base code? ==

See [http://moodle.org/mod/forum/discuss.php?d=13211 this thread] for a detailed explanation by [[User:Martin_Langhoff| Martin Langhoff]].

== What is FreeTDS and how can I use it in my installation? ==
[[Installing MSSQL for PHP|FreeTDS]] is an open source implementation of the Tabular Data Stream protocol used by Microsoft SQL Server and Sybase for their databases. Unfortunately, Microsoft servers don't usually accept TDS 5.0 connections. FreeTDS allows your Unix/Linux applications to talk to these other database products and import and export data between different systems successfully.

== How do I install a plugin? ==

Please see [[Installing plugins]].

==I can't enable a plugin on the Plugins overview page because the icon is not clickable==
The open and closed eye icon on the Plugins overview page is simply there to show whether or not a plugin is enabled. You can't edit plugins from this screen. If you wish to enable a plugin, to to the appropriate page for managing the type of plugin you need, for instance ''Settings>Site administration>Plugins>Repositories>Manage repositories'' or ''Settings>Site administration>Plugins>Activity modules>Manage activities.''

== See also ==

* [[Errors FAQ]]
* Using Moodle [http://moodle.org/mod/forum/view.php?id=28 Installation problems forum]
* [[Beginning_Moodle_2.0_Administration|Beginning Moodle 2.0 Administration FAQ]]

Installing Moodle in a shared web hosting environment:
* [[Finding_and_Selecting_A_Web_Host|Finding and Selecting a web host]]
* [[Installing_Moodle_on_SmarterASP.NET|Installing Moodle on SmarterASP.NET web hosting]]

[[Category:FAQ]]

[[es:FAQ Instalación]]
[[fr:FAQ d'installation]]
[[ja:インストールFAQ]]
[[de:Installation FAQ]]

MediaWiki:Noarticletext

2016-12-05T09:12:25Z

Tsala: rewording

{{Main page}}
This page does not exist. You can [[:en:{{NAMESPACE}}:{{PAGENAME}}|check whether it exists in the documentation for the latest stable version of Moodle]] or [[Special:Search/{{PAGENAME}}|search for this page title]] in other pages.

You are also welcome to [{{SERVER}}{{localurl:{{NAMESPACE}}:{{PAGENAME}}|action=edit}} create it] yourself :-)

==See also==

*[[MoodleDocs:Guidelines for contributors]]

MediaWiki:MoodleDocsVersionLinks

2016-12-05T07:26:47Z

Tsala: 3.2 link

2.7 docs: /27/en/{{FULLPAGENAMEE}}
3.2 docs: /32/en/{{FULLPAGENAMEE}}
3.1 docs: /31/en/{{FULLPAGENAMEE}}
3.0 docs: /30/en/{{FULLPAGENAMEE}}

Capabilities/message/airnotifier:managedevice

2016-11-25T16:30:00Z

Tsala: removing link

{{Capabilities}}
*This allows a user to manage their registered mobile device for mobile app notifications
*This capability is allowed for the default role of authenticated user

[[Category:Capabilities|Messaging]]
[[Category:Messaging]]

Capabilities/message/airnotifier:managedevice

2016-11-25T16:26:16Z

Tsala: capabilities template, description, categories

{{Capabilities}}
*This allows a user to manage their registered mobile device for [[Mobile app notifications]]
*This capability is allowed for the default role of authenticated user

[[Category:Capabilities|Messaging]]
[[Category:Messaging]]

Security recommendations

2016-11-07T14:14:09Z

Tsala: /* Basic recommendations */ Use https to secure all pages - copied from 29 docs

{{Security}}All web application software is highly complex, and every application has security issues that are found from time to time, usually involving some combination of input that the programmers did not anticipate. The Moodle project takes security seriously, and is continuously improving Moodle to close such holes as we find them.

==Introduction==
*This page contains important security measures for your Moodle installation.
*You should report security problems to the [http://tracker.moodle.org/secure/CreateIssue!default.jspa Moodle tracker] (and mark it as a security issue!) so that developers can see it and inform registered Moodle sites about fixes as soon as possible.
*You should not post actual exploits in the forums or elsewhere on the web (to protect Moodle admins who have not upgraded yet).

==Simple security measures==
*The best security strategy is a good backup! But you don't have a good backup unless you are able to restore it. Test your restoration procedures!
*Load only software or services you will use
*Perform regular updates
*Model your security after the layers of clothing you wear on a cold winter day

==Basic recommendations==

;Update Moodle regularly on each release
:Published security holes draw crackers attention after release. The older the version, the more vulnerabilities it is likely to contain.
; Use https to secure all pages (not just the login page)
:Protect all traffic from your Moodle instance and your users by making all pages accessible via https only. This not only protects passwords on login but also ensures the privacy of your users so that all user data cannot be intercepted or manipulated ("ad injections") from third parties like WLAN providers for example. Free https certificates are available from https://letsencrypt.org/. In addition, set httpslogin=yes in your moodle config to add an extra layer of protection for submitting login credentials.
;Register globals '''MUST''' be disabled - see [[admin/environment/custom check/php check register globals]]
:This will help prevent against possible XSS problems in third-party scripts.
;Use strong passwords for admin and teachers
:Choosing "difficult" passwords is a basic security practice to protect against "brute force" cracking of accounts.
;Only give teacher accounts to trusted users. Avoid creating public sandboxes with free teacher accounts on production servers.
:Teacher accounts have much freer permissions and it is easier to create situations where data can be abused or stolen.
;Separate your systems as much as possible
:Another basic security technique is to use different passwords on different systems, use different machines for different services and so on. This will prevent damage being widespread even if one account or one server is compromised.

==Run regular updates==
*Use auto update systems
*Windows Update
*Linux: up2date, yum, apt-get
:Consider automating updates with a script scheduled via cron
*Mac OSX update system
*Stay current with php, apache, and moodle

==Use mailing lists to stay updated==
*CERT - http://www.us-cert.gov/cas/signup.html
*PHP - http://www.php.net/mailing-lists.php - sign up for Announcements list
*MySQL - http://lists.mysql.com - sign up for MySQL Announcements

==Firewalls==
*Security experts recommend a dual firewall
:Differing hardware/software combinations
*Disabling unused services is often as effective as a firewall
:Use netstat -a to review open network ports
*Not a guarantee of protection
*Allow ports
:80, 443(ssl), and 9111 (for chat),
:Remote admin: ssh 22, or rdp 3389

==Password policy==

A password policy may be set up in ''Settings > Site administration > Security > [[Site policies]]''.

There is a check box to determine if password complexity should be enforced or not, the option to set the minimum length of the password, the minimum number of digits, the minimum number of lowercase characters, the minimum number of uppercase characters and the minimum number of non alphanumeric characters.

If a user enters a password that does not meet those requirements, they are given an error message indicating the nature of the problem with the entered password.

Enforcing password complexity along with requiring users to change their initial password go a long way in helping ensure that users choose and are in fact using "good passwords".

However, making the check too onerous just results in them writing it down so be realistic.

==Be prepared for the worst==
*Have backups ready
*Practice recovery procedures ahead of time
*Use a rootkit detector on a regular basis
**Linux/MacOSX - http://www.chkrootkit.org/
**Windows - http://technet.microsoft.com/en-en/sysinternals/bb897445.aspx and http://technet.microsoft.com/de-de/sysinternals/bb897445.aspx

==Moodle security alerts==
*Register your site with Moodle.org
:Registered users receive email alerts
*Security alerts also posted online
*Web - http://moodle.org/security
*RSS feed - http://moodle.org/rss/file.php/1/1/forum/996/rss.xml

==Miscellaneous considerations==
These are all things you might consider that impact your overall security:
*Use the secure forms setting
*Always set a mysql root user password
*Turn off mysql network access
*Use SSL, httpslogins=yes
*Use good passwords - set up a password policy in ''Settings > Site administration > Security > [[Site policies]]''
*Do not enable the ''opentogoogle'' setting (in ''Settings > Site administration > Security > [[Site policies]]'')
*Disable guest access
*Place enrollment keys on all courses or set Course Enrollable = No for all courses
*Ensure the enrolment key hint is disabled (which it is by default) in ''Administration > Site administration > Plugins > Enrolment > Self enrolment.''

==Most secure/paranoid file permissions==

'''Note''': The following information applies to Linux/Unix based installations only, as MS Windows permission system is quite different.

Depending on your server set-up there are two different scenarios:
# You are running Moodle on your own dedicated server.
# You are running Moodle on a shared hosting environment.

In the sections below, you are required to use the web service user account and group to set the permissions, so you need to know them. This can vary quite a bit from server to server but if this feature has not been disabled in your server, you can go to http://your.moodle.site/admin/phpinfo.php (logging in as admin), and then search for the line that reads 'User/Group', inside the 'apache' table. For example, I get 'www-data' for the user account and 'www-data' for the group too.

=== Running Moodle on a dedicated server ===
Assuming you are running Moodle on a sealed server (i.e. no user logins allowed on the machine) and that root takes care of the modifications to both moodle code and moodle config (config.php), then this are the most tight permissions I can think of:

1. moodledata directory and all of its contents (and subdirectories, includes sessions):
owner: apache user (apache, httpd, www-data, whatever; see above)
group: apache group (apache, httpd, www-data, whatever; see above)
permissions: 700 on directories, 600 on files

2. moodle directory and all of its contents and subdirectories (including config.php):
owner: root
group: root
permissions: 755 on directories, 644 on files.

If you allow local logins for regular users, then 2. should be:
owner: root
group: apache group (apache, httpd, www-data, whatever; see above)
permissions: 750 on directories, 640 on files.

Think of these permissions as the most paranoid ones. You can be secure enough with less tighter permissions, both in moodledata and moodle directories (and subdirectories).

=== Running Moodle on a shared hosting environment ===
If you are running Moodle on a shared hosting environment, then above permissions are probably wrong. If you set 700 as the permission for directories (and 600 for files), you are probably denying the web service user account access to your directories and files.

If you want to tighten your permissions as much as possible, you will need to know:

# the user account and the group the web service is running under (see above).
# the owner of the directories/files of both moodledata and the moodle directory (this should normally be your client user account), and the group of the directories/files. You can usually get this information from the file manager of your hosting control panel. Go to the moodle folder and pick any directory or file and try to view/change the permissions, owner and group of that file. That would normally show the current permissions, owner and group. Do the same for the moodledata directory.

Then, depending on the following scenarios you should use a different set of permissions (listed from more secure to less secure) for your moodledata directory:

# if the web service account and the owner of the directories/files is the same, you should use 700 for directories and 600 for files.
# if the web service group and the group of the directories/files is the same, you should use 770 for directories and 660 for the files.
# if none of the above, you will need to use 777 for directories and 666 for files, which is less secure but it is your only option. 707 and 606 would be more secure, but it might or might not work, depending on your particular setup.

In fact, you just need to set moodledata the permissions specified above, as all the directories and files inside are created by the web service itself, and will have the right permissions.

Regarding the moodle directory, as long as the web service user account can read the files plus read and execute the directories, that should be enough. There is no need to grant write permission to the web service account/group on any of the files or subdirectories. The only drawback is that you will need to create the config.php by hand during the installation process, as Moodle will not be able to create it. But that should not be a big problem.

==See also==

*[[Security FAQ]]
Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=39404 Guide to Securing your Moodle Server]
*[http://moodle.org/mod/forum/discuss.php?d=93561 How to secure Moodle website from hacking] including recommendations on emergency recovery

[[es:Recomendaciones de Seguridad]]
[[fr:Sécurité]]

Security recommendations

2016-11-04T10:15:43Z

Tsala: copying changes from 29 docs

{{Security}}All web application software is highly complex, and every application has security issues that are found from time to time, usually involving some combination of input that the programmers did not anticipate. The Moodle project takes security seriously, and is continuously improving Moodle to close such holes as we find them.

==Introduction==
*This page contains important security measures for your Moodle installation.
*You should report security problems to the [http://tracker.moodle.org/secure/CreateIssue!default.jspa Moodle tracker] (and mark it as a security issue!) so that developers can see it and inform registered Moodle sites about fixes as soon as possible.
*You should not post actual exploits in the forums or elsewhere on the web (to protect Moodle admins who have not upgraded yet).

==Simple security measures==
*The best security strategy is a good backup! But you don't have a good backup unless you are able to restore it. Test your restoration procedures!
*Load only software or services you will use
*Perform regular updates
*Model your security after the layers of clothing you wear on a cold winter day

==Basic recommendations==
*Update Moodle regularly on each release
:Published security holes draw crackers attention after release. The older the version, the more vulnerabilities it is likely to contain.
*[[admin/environment/custom check/php check register globals|Register globals '''MUST''' be disabled]]
:This will help prevent against possible XSS problems in third-party scripts.
*Use strong passwords for admin and teachers
:Choosing "difficult" passwords is a basic security practice to protect against "brute force" cracking of accounts.
*Only give teacher accounts to trusted users. Avoid creating public sandboxes with free teacher accounts on production servers.
:Teacher accounts have much freer permissions and it is easier to create situations where data can be abused or stolen.
*Separate your systems as much as possible
:Another basic security technique is to use different passwords on different systems, use different machines for different services and so on. This will prevent damage being widespread even if one account or one server is compromised.

==Run regular updates==
*Use auto update systems
*Windows Update
*Linux: up2date, yum, apt-get
:Consider automating updates with a script scheduled via cron
*Mac OSX update system
*Stay current with php, apache, and moodle

==Use mailing lists to stay updated==
*CERT - http://www.us-cert.gov/cas/signup.html
*PHP - http://www.php.net/mailing-lists.php - sign up for Announcements list
*MySQL - http://lists.mysql.com - sign up for MySQL Announcements

==Firewalls==
*Security experts recommend a dual firewall
:Differing hardware/software combinations
*Disabling unused services is often as effective as a firewall
:Use netstat -a to review open network ports
*Not a guarantee of protection
*Allow ports
:80, 443(ssl), and 9111 (for chat),
:Remote admin: ssh 22, or rdp 3389

==Password policy==

A password policy may be set up in ''Settings > Site administration > Security > [[Site policies]]''.

There is a check box to determine if password complexity should be enforced or not, the option to set the minimum length of the password, the minimum number of digits, the minimum number of lowercase characters, the minimum number of uppercase characters and the minimum number of non alphanumeric characters.

If a user enters a password that does not meet those requirements, they are given an error message indicating the nature of the problem with the entered password.

Enforcing password complexity along with requiring users to change their initial password go a long way in helping ensure that users choose and are in fact using "good passwords".

However, making the check too onerous just results in them writing it down so be realistic.

==Be prepared for the worst==
*Have backups ready
*Practice recovery procedures ahead of time
*Use a rootkit detector on a regular basis
**Linux/MacOSX - http://www.chkrootkit.org/
**Windows - http://technet.microsoft.com/en-en/sysinternals/bb897445.aspx and http://technet.microsoft.com/de-de/sysinternals/bb897445.aspx

==Moodle security alerts==
*Register your site with Moodle.org
:Registered users receive email alerts
*Security alerts also posted online
*Web - http://moodle.org/security
*RSS feed - http://moodle.org/rss/file.php/1/1/forum/996/rss.xml

==Miscellaneous considerations==
These are all things you might consider that impact your overall security:
*Use the secure forms setting
*Always set a mysql root user password
*Turn off mysql network access
*Use SSL, httpslogins=yes
*Use good passwords - set up a password policy in ''Settings > Site administration > Security > [[Site policies]]''
*Do not enable the ''opentogoogle'' setting (in ''Settings > Site administration > Security > [[Site policies]]'')
*Disable guest access
*Place enrollment keys on all courses or set Course Enrollable = No for all courses
*Ensure the enrolment key hint is disabled (which it is by default) in ''Administration > Site administration > Plugins > Enrolment > Self enrolment.''

==Most secure/paranoid file permissions==

'''Note''': The following information applies to Linux/Unix based installations only, as MS Windows permission system is quite different.

Depending on your server set-up there are two different scenarios:
# You are running Moodle on your own dedicated server.
# You are running Moodle on a shared hosting environment.

In the sections below, you are required to use the web service user account and group to set the permissions, so you need to know them. This can vary quite a bit from server to server but if this feature has not been disabled in your server, you can go to http://your.moodle.site/admin/phpinfo.php (logging in as admin), and then search for the line that reads 'User/Group', inside the 'apache' table. For example, I get 'www-data' for the user account and 'www-data' for the group too.

=== Running Moodle on a dedicated server ===
Assuming you are running Moodle on a sealed server (i.e. no user logins allowed on the machine) and that root takes care of the modifications to both moodle code and moodle config (config.php), then this are the most tight permissions I can think of:

1. moodledata directory and all of its contents (and subdirectories, includes sessions):
owner: apache user (apache, httpd, www-data, whatever; see above)
group: apache group (apache, httpd, www-data, whatever; see above)
permissions: 700 on directories, 600 on files

2. moodle directory and all of its contents and subdirectories (including config.php):
owner: root
group: root
permissions: 755 on directories, 644 on files.

If you allow local logins for regular users, then 2. should be:
owner: root
group: apache group (apache, httpd, www-data, whatever; see above)
permissions: 750 on directories, 640 on files.

Think of these permissions as the most paranoid ones. You can be secure enough with less tighter permissions, both in moodledata and moodle directories (and subdirectories).

=== Running Moodle on a shared hosting environment ===
If you are running Moodle on a shared hosting environment, then above permissions are probably wrong. If you set 700 as the permission for directories (and 600 for files), you are probably denying the web service user account access to your directories and files.

If you want to tighten your permissions as much as possible, you will need to know:

# the user account and the group the web service is running under (see above).
# the owner of the directories/files of both moodledata and the moodle directory (this should normally be your client user account), and the group of the directories/files. You can usually get this information from the file manager of your hosting control panel. Go to the moodle folder and pick any directory or file and try to view/change the permissions, owner and group of that file. That would normally show the current permissions, owner and group. Do the same for the moodledata directory.

Then, depending on the following scenarios you should use a different set of permissions (listed from more secure to less secure) for your moodledata directory:

# if the web service account and the owner of the directories/files is the same, you should use 700 for directories and 600 for files.
# if the web service group and the group of the directories/files is the same, you should use 770 for directories and 660 for the files.
# if none of the above, you will need to use 777 for directories and 666 for files, which is less secure but it is your only option. 707 and 606 would be more secure, but it might or might not work, depending on your particular setup.

In fact, you just need to set moodledata the permissions specified above, as all the directories and files inside are created by the web service itself, and will have the right permissions.

Regarding the moodle directory, as long as the web service user account can read the files plus read and execute the directories, that should be enough. There is no need to grant write permission to the web service account/group on any of the files or subdirectories. The only drawback is that you will need to create the config.php by hand during the installation process, as Moodle will not be able to create it. But that should not be a big problem.

==See also==

*[[Security FAQ]]
Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=39404 Guide to Securing your Moodle Server]
*[http://moodle.org/mod/forum/discuss.php?d=93561 How to secure Moodle website from hacking] including recommendations on emergency recovery

[[es:Recomendaciones de Seguridad]]
[[fr:Sécurité]]

Moodle Mobile

2016-10-14T09:40:54Z

Tsala: removing mention of Windows Phone Store

{{Mobile}}
== Features ==

Moodle Mobile is the Moodle official mobile application for Android and iOS. It's available in Google Play and Apple Market.

* Responsive design for phone and tablets
* Upload a picture into your private file area
* Record an audio file and upload it into your private file area
* Record a video and upload it into your private file area
* Send a private message to a course participant (can be done offline)
* Take a personal note about a course participant (can be done offline)
* Add a course participant to your phone contact
* Call a course participant touching the phone number
* Locate a course participant address on Google map
* Download and view some course resources
* Quick access to your course contents
* View calendar events
* Mobile Push notifications
* Remote layout/style customization (see below)
* Upload any type of file from your device to your Moodle private files area
* * Support for sites using CAS or Shibboleth as auth methods
* * View all your past private messages and notifications
* * View your activity and course total grades in a course
* * Browse and download your private and course files
* * View forum discussions

Note: All features indicated (*) require the [[Moodle Mobile additional features]] plugin to be installed.

Notice that Moodle Mobile is not a replacement of the MyMobile or Bootstrap/Simple theme. Moodle Mobile offers offline contents, camera & audio features and Push notifications connected to the user messaging preferences.
You can use Moodle Mobile app in combination with a Mobile theme.

=== Screenshots ===

'''Phone''' (portrait view)

{|
| [[File:LoggedInList.png|thumb|Initial view]]
| [[File:CourseView.png|thumb|Course contents view]]
| [[File:CameraUpload.png|thumb|Photo uploading]]
|}
{|
|[[File:ParticipantView.png|thumb|Single participant view]]
| [[File:ListParticipants.png|thumb|Participant list view]]
|[[File:moodleinstantmessage.png|thumb|Notifications]]
|}

'''Tablet''' (landscape view)
{|
|[[File:tabletparticipants.png|thumb|600px|Participant view]]
|}
{|
|[[File:tabletlandscape.png|thumb|600px|Course content view]]
|}

=== Style customization ===

The app can also retrieve your custom styles from your Moodle site. Since the app is a HTML5 app, you can apply safely any CSS, CSS2 and CSS3 style.

In your Moodle installation go to Plugins / Web services / Mobile and enter in the mobilecssurl field a valid URL pointing to a CSS file containing your custom styles.

The CSS should be placed inside your Moodle installation (in your custom theme or inside a local plugin)

Once the user is logged in the app, there is a periodical process that retrieves your remote CSS files for applying your custom styles.

Notice that on the first time a user opens the app, he will see the default "orange" style. Your custom styles will be applied once the user has added a site in the app.

See https://docs.moodle.org/dev/Moodle_Mobile_Themes for documentation.

=== Notifications ===

The app can receive notifications from your Moodle site, but you have to configure it. See [[Mobile app Push Notifications]]

=== Languages ===

Languages currently supported:

* Arabic
* Basque
* Catalan
* Chinese
* Czech
* Dutch
* English
* French
* German
* Hebrew
* Hungarian
* Italian
* Japanese
* Mexican spanish
* Portuguese
* Russian
* Spanish
* Swedish

==Moodle sites must be enabled for the app to access them==

Moodle 2.4 or above is mandatory.

The administrator of your Moodle site must enable mobile access as follows:

* In ''Administration > Site administration > Plugins > Web services > Mobile'' tick the 'Enable web services for mobile devices' checkbox, then click the button to save changes.

If your site uses a SSL certificate it must be a trusted certificate. For security reasons the app doesn't work with self-signed certificates.

==Installing the Moodle Mobile app==

The Moodle Mobile app is available in Google Play, Apple Store, and the Windows Phone Store. See [https://download.moodle.org/mobile/ Moodle Mobile] for links.

You can also install the app directly from your mobile device by searching for "Moodle Mobile" with author/owner "Moodle Pty Ltd".

==Testing the app on a demo site==

In the login screen, type "teacher" or "student" in the Username field and click the Add button. You will be logged automatically to the Mount Orange Moodle School demo site You can use the Moodle School demo site - http://school.demo.moodle.net/ for testing the app.

== Cache ==
If you connect to your Moodle site and update/create/delete anything, and then go to your mobile app, the content will not be displayed. You will have to wait a couple of minutes. The cache time for the app is currently 5 minutes.

You can refresh the contents of the Mobile app using the refresh button (top right in the left orange menu)

There are developer options for purging the cache at any time (Settings -> Development)

==How to report a bug==

# Log in to the Moodle Mobile tracker [https://tracker.moodle.org/browse/MOBILE https://tracker.moodle.org/browse/MOBILE] (you'll need to [http://tracker.moodle.org/secure/Signup%21default.jspa create a tracker account] if you've not done so previously)
# ''Check whether the issue has already been reported by [https://tracker.moodle.org/issues/?jql=project%20%3D%20MOBILE searching all the issues]''
# If not, report the bug by clicking the 'Create Issue' link at the top right of the page, selecting 'Moodle Mobile' as the project
# Add a detailed description then click the Create button
# Attach the following files to the issue by selecting 'Attach Files' in the 'More actions' dropdown menu:
#* 'Device information' - this can be found in the app (Settings -> Development -> Device info, you can send yourself this information by email using the e-mail button at the bottom)
#* App Log (''Settings -> Development -> Show Log'', again you can send yourself this information by email)

=== Report a bug by email ===

You can send us the same report by email using ''Settings -> Report a bug''. As the report is sent by email to mobile@moodle.com, the report will take more time to be filed in the tracker.

== See also ==

* [[:dev:Moodle Mobile|Moodle Mobile developer docs]]
* [[Mobile web services]]

[[ja:モバイルアプリ]]
[[de:Mobile App]]
[[es:App para móvil]]

Course creator role

2016-10-14T07:02:04Z

Tsala: forum discussion links

{{Standard roles}}
A user assigned the role of course creator can (as the name suggests!) create a course. If the setting "Creators' role in new courses" is left as default (teacher), then the course creator is enrolled as a teacher in the course they have just created and can then edit the course settings and enrol other users.

A course creator can also view hidden courses.

The role of course creator could typically be assigned to a master teacher, department head or program coordinator.

==Creating a course==

The "Add a new course" button can be found at the bottom of the page listing all courses.

When a course creator creates a course, they are automatically enrolled in the course as a teacher, or whatever role is set in ''Administration > Site administration > Users > Permissions > User policies''.

'''Note (1):''' If a user is assigned the role of course creator in the course category context, the "Add a new course" button only appears when the course category contains at least one course.

'''Note (2):''' Course creators are not automatically assigned the role of teacher in a course they have not created, even if it is in a category where they have course creator rights.

==Deleting a course==

There is no user interface for course creators to delete courses they have created, however they can do so by editing the URL of the course from <nowiki>http://yourmoodlesite.net/course/view.php?id=N</nowiki> to <nowiki>http://yourmoodlesite.net/course/delete.php?id=N</nowiki> (replacing 'view' with 'delete').

==Role assignment==

A user may be assigned the role of course creator as a system role (in ''Administration > Site administration > Users > Permissions > Assign system roles'') or in the course category context.

==Role permissions==

If you require a course creator to have additional permissions, it is recommended that the [[Manager role]] is used, rather than changing the course creator role permissions. Otherwise, allowing additional capabilities for the course creator role may result in course creators having access to courses which they have not created.

The role of course creator is ONLY intended for enabling users to create courses; it is not intended for enabling users to edit existing courses!

==See also==

* [https://moodle.org/mod/forum/discuss.php?d=182576 Cannot remove users from system-wide Course Creator] forum discussion

[[fr:Créateur de cours]]
[[ja:コース作成者]]
[[de:Kursersteller-Rolle]]
[[es:Rol de creador de curso]]

Language customization

2016-10-12T15:00:00Z

Tsala: changes copied from 31 docs

{{Language}}
==Changing words or phrases==

Words or phrases (in any language) used on the site may be easily changed by an administrator using the language customisation feature. For example, you may want to change the word "Course" to "Unit".

# Go to ''Site administration > Language > Language customisation'' and choose the language you wish to customise.
# Click the "Open language pack for editing" button. (This may take some time to process.)
# Once the language pack has loaded, click the "Continue" button.
# Find the string you wish to customise using the filter settings, then clicking "Show strings". See below for details of how to find the component and string identifier.
# Make your changes in the "Local customisation" box.
# Click "Apply changes and continue editing" if you want to use another filter or edit other file(s), otherwise click "Save changes to the language pack" to save all of the changes you have made.

==Finding the component and string identifier==
[[File:Show origin of lang strings.png|thumb|Lang string origins]]
# Go to ''Site administration > Development > Debugging''.
# Tick the 'Show origin of languages strings' tickbox then save changes.
# Go to the page containing the string you want to customise and in the address bar, append the following to the URL: either <pre>?strings=1</pre> or <pre>&strings=1</pre> (depending whether there is already a parameter).
# Reload the page.

The page will then be displayed with component and string identifies in curly brackets after each string, for example "{rememberusername/admin}". The first part, before the /, is the string identifier. The last part is the component e.g admin.php. If there is nothing after the / then the string is in moodle.php.

==Filter settings==

[[Image:Language_string_M2_filter.png|thumb|Language filter]]

* ''Show strings of these components'' - Click or Ctrl+click to select one or more files.
* ''Customised only'' - tick the box to display only those strings that are already present in your xx_local pack.
* ''Help only''' - tick the box to display only help strings, that is the texts used when clicking the yellow question mark icon.
* ''Modified only'' - tick the box to display only the strings that are modified since the last checked in string into the language pack.
* ''Only strings containing'' - insert a phrase that must appear in the string. For example, if you put a word 'student' here, you will get only those strings that contain this word.
* ''String identifier'' - see above.

==Local customisation highlighting==

* Customised strings (already saved in a file) are highlighted in green.
* Modified strings (not saved in a file yet) are highlighted in blue.
* Customised strings for deletion are highlighted in red.

== More about language packs ==

Moodle is translated into many languages - see [https://download.moodle.org/langpack/3.1/ Language packs for Moodle 3.1] for their list and the translation completion status. The translations are distributed as language packages (or just lang packs) that are maintained by kind volunteers, community contributors and Moodle Partners.

Moodle site administrators can customise any language pack to fit their individual needs. Editing the language pack files directly is not recommended, since any changes would be silently overwritten during the next upgrade. Instead, you should use the language customisation feature, which automatically creates a local language pack that holds all your changes from the official pack.

Local language packs have the same structure as official ones. They are saved in your Moodle data directory in moodledata/lang/xx_local/ folder where 'xx' is the code of the language. You have to have the official language pack installed before you can customise it. A local language pack should contain just strings you have customised - there is no need to create a copy of a whole official language pack.

When displaying a string, Moodle first looks whether a local customisation exists in moodledata/lang/xx_local/component_file.php. If so, it is used. If not, the string from the official language pack is used. (If the string has not been translated yet, the original English version is displayed). Please note that the strings are cached for better performance so if you modify a file directly in your xx_local pack then you will have to purge Moodle caches afterwards. Caches are purged automatically when using the language customisation feature.

[[image:customlang-process.png|800px|thumb|left|Workflow of the language customisation (click to enlarge)]]
 

==How to backup and restore a customised language pack==

This is handy when you have made customisations of your language pack and you want to install these changes on another server.

If you customised a language pack xx, the only folder you need to back up is $CFG->dataroot/lang/xx_local. All others without the _local suffix are standard packages that can be installed and uninstalled via the admin tool.

Once the folder is restored on another server, you will have to manually purge caches from the admin interface to allow the in-built string manager to re-read the *_local folders and start using them.

==Sharing a language customisation==

* If you have made a language customisation for a specific need, which is shared by other people (e.g. a kids version of your national language, intended for your school, but also useful for other schools), please consider sharing it as a child language in AMOS.
* If your country uses a language that is not exactly the same as an existing language pack listed in the [http://lang.moodle.org/local/amos/credits.php translation credits], and you have made a customisation that better suits the needs of your fellow country Moodle users, you might want to consider starting a child language pack in AMOS (e.g. Canadian French, which has over 1000 changes from the French parent language).

In either case, contact the parent language pack maintainer listed in the [http://lang.moodle.org/local/amos/credits.php translation credits] and/or our translation coordinator, Koen, [mailto:translation@moodle.org translation@moodle.org].

==Troubleshooting==

===Database error===

[[File:Database error while language customization.png|400px]]
If you encounter a database error when you try to customise a language pack, then it may be due to a recent plugin that corrupted the database. You are advised to check all plugins recently added to your site, and check whether removing a plugin prevents this error. If that is the case, please contact the maintainer for the involved plugin and [https://moodle.org/mod/forum/discuss.php?d=222815 report the error]. Most cases seen in 2013 were fixed by the maintainers of those plugins. [https://moodle.org/mod/forum/discuss.php?d=254464#unread One case seen in 2014] was related to the Essential (additional) theme and language packs other than English; it was caused by a a bug with the notification language handling, and was fixed with a plugin update.

Or, you can [https://moodle.org/mod/forum/discuss.php?d=208012 execute a database query] on your server in order to track down the plugin causing the problem.

==See also==

* [https://moodle.org/mod/forum/discuss.php?d=219504 Duplicate entry 'en-373-AM'] forum discussion about error when attempting to edit a lang pack
* [https://moodle.org/mod/forum/discuss.php?d=272950 Changing one word across the whole site] forum discussion
*[http://youtu.be/0v72GKn2Wuk Moodle 2 Language Administration settings] MoodleBites video on YouTube

==Any questions?==

Please post in the [https://moodle.org/mod/forum/view.php?id=43 Languages forum] on moodle.org.

[[de:Sprachanpassung]]
[[es:Personalización del idioma]]

Cloze question type

2016-10-11T05:44:50Z

Tsala: redirect

#redirect [[Embedded Answers (Cloze) question type]]

About Moodle FAQ

2016-10-10T06:45:54Z

Tsala: improvements copied from 31 page

{{About Moodle}}
Below is a list of general questions many educators ask about Moodle. There are also [[:Category:FAQ|Frequently Asked Question page]]s for many specific Moodle tools.

==Starting with Moodle==

===What is Moodle?===
Moodle is a free online learning management system, or LMS (also known as VLE.) You can read more about Moodle [http://moodle.org/about/ here] or you might find it useful to watch the [https://www.youtube.com/watch?v=wop3FMhoLGs video: What is Moodle?] . It is suitable for all ages and all sectors. Anywhere learning takes place, Moodle can be used. It is usually used online but may also be used on an 'intranet' within your organisation.

===Where is the funny name from?===
The word Moodle is an acronym for Modular Object-Oriented Dynamic Learning Environment, which is mostly useful to programmers and education theorists. It's also a verb (in the bigger English dictionaries) that describes the process of lazily meandering through something, doing things as it occurs to you to do them, an enjoyable tinkering that often leads to insight and creativity. A sort of cross between "muse" and "doodle". As such it applies both to the way Moodle was originally developed, and to the way a student or teacher might approach studying or teaching an online course in an ongoing, iterative way. Anyone who uses Moodle is a Moodler.

===How do I start using Moodle?===

=== I just want to try it out===

* You can try Moodle's standard features on the [http://demo.moodle.net Moodle Sandbox demo site], an empty out-of-the-box site.
* To explore Moodle in action on a site populated with courses, activities and users, visit the [http://school.demo.moodle.net Mount Orange School demo site].
* You can obtain your own Moodle site on MoodleCloud - [https://moodle.com/cloud/free/ Moodle for Free].
* A further way to try Moodle out is to [http://download.moodle.org download] your own copy and install it "locally", ie, on your own computer.

(Please note that moodle.org is not the place for setting up your courses, but for finding out information and asking questions.)

=== I want to use Moodle as an individual or set it up for my organisation===

* You are welcome to use [https://moodle.com/cloud/free/ Moodle for Free] for up to 50 users.
* Otherwise, our MoodleCloud solution, [https://moodle.com/cloud/school/ Moodle for School] is perfect for multiple classes in K-12 teaching and learning environments.
* If you have the technical knowledge, you can [http://download.moodle.org download Moodle] and install it on a server online.
* A further possibility is to ask one of our [http://moodle.com/partners/ Moodle Partners] to host a site for you.

===Do I have to be really good with technology to use Moodle?===
To use Moodle, you only need the basic web browsing skills. To install it you need a little more knowledge, but guidance is provided.

==Cost==

===How much does it cost to download and use Moodle?===
By way of its [[Dev:License|GNU General Public License]], Moodle is and will remain free to download and use in any way you like. Consider it free like a 'free puppy' that needs care and attention to grow, not free like a 'free beer'.

===How much does it cost to run Moodle?===
Nothing to install, use and change. Of course, there are costs if you have your Moodle hosted with someone, and costs associated with maintenance and training in an organisation (like any other software). But no royalties, fees or user charges.

===How much does it cost to have Moodle hosted?===
There are many options for hosting. Cost is usually related to services provided and capacity (eg. a university site with 10 000 users will naturally cost more to host and maintain than a small community school). Ask your local [https://moodle.com/partners/ Moodle Partner] and keep Moodle going that way too!

==Technical queries==

===Do I need my own server to run Moodle?===
Only if you are going to host it yourself. (See the section on 'Starting with Moodle' above.)

===Can I customise a theme to make it relevant to our school?===
Yes, see [[Themes]]. You can customise themes down to a single course. There are many ways to make Moodle looks great too.

===Can you use Moodle from anywhere and on any device??===
*Moodle works well in all standard, modern browsers and different operating systems. If you plan to run a Moodle site, you should be aware of your audience, their typical bandwidth and web browsers.
*Yes, if it is on a web server attached to the internet and you have a computer, mobile device or tablet. Or if it is on a web server attached to the same intranet (internal network) as a computers or tablets which need to work it. There is an official [[Moodle Mobile| Moodle mobile app.]]

===Can access to Moodle be restricted to just our organisation?===
Yes, several ways to do this. For example, it can be installed on your school's internal network, or limit the IPs to those assigned by your school, or only manually enroll your students are just a few ways.

===I've come from a school that used a different VLE/LMS. Can I transfer my stuff over to Moodle?===
Some VLE/LMS-specific activities may (not) be compatible, but you can zip your content files and unzip them in Moodle.

==Help and support with Moodle==
=== How do I use Moodle?===
The [[Main page| Moodle documentation]] is a good place to start. Then if you get stuck, come and ask on the [https://moodle.org/course/ Moodle Community forums.]

===I don't understand the terms===
Moodle uses jargon words that you may be familiar with from other, non-Moodle contexts. Within Moodle, These words have specific (and potentially different) meanings, which you can read about on the page [[Moodle key terms]]

===Is there an official support desk for Moodle?===
* [https://moodle.org/course/ Moodle.org Community forums] serve as an excellent support desk. Ask your question any time, in any language.
* [https://moodle.com/partners/ Moodle Partners] offer paid-for support as part of their service.

===Are there any good Moodle tutorials?===
* Get some help at Moodle.org in the [http://moodle.org/course Community forums] or search the [[Main_Page|Moodle documentation]] There are also many [http://moodle.org/mod/data/view.php?id=7246 books and manuals] available for purchase.
* The [https://www.youtube.com/user/moodlehq Moodle HQ Youtube channel] offers basic tutorials for teachers and walk-throughs of the latest features.

===Where can I get Moodle training?===
*For teachers beginning with Moodle, Moodle HQ offers a free MOOC [https://learn.moodle.net Learn Moodle] which is run twice yearly.
*A number of organisations offer training for Moodle administrators or course creators. Look for a [https://moodle.com/partners/ Moodle Partner] in your area for officially accredited training. You can also think of doing the [http://moodle.org/course/view.php?id=48 Moodle Course Creator Certificate] to improve your skills.

===What about people with disabilities?===
Moodle supports many assistive technologies such as screen-readers, screen-magnifiers, alternative mouse and key use, disabling of AJAX and JavaScript, and more. See the developer documentation [[:dev:Accessibility | Accessibility]] for further details.

===Are there any comparisons of Moodle with other Learning Management Systems?===
See the [http://moodle.org/mod/forum/view.php?id=2784 Comparisons and Advocacy forum] and also [http://moodle.org/mod/data/view.php?d=19 Moodle buzz].

==Security==

===How secure is Moodle?===
Moodle is designed to be very secure. However, a lot depends upon the webserver, the way Moodle is setup and regular updates of the package by the Moodle Administrator.

===Can Moodle get hacked into and student data stolen?===
This is highly unlikely if your Moodle site has up-to-date security and the site administrator has not given away the keys. Anything is possible on any website, but Moodle makes it difficult for nasty people to cause havoc.

===What if I did something wrong and accidentally broke it - could it be easily fixed?===
Moodle can be backed-up at any point. If a backup was made 5 minutes before you broke it, chances are it can be fixed easily.

===Is my student data safe on a cheap or free webhost?===
While you do have some control of the security of a Moodle site on a free or cheap web host, the question is: How much do you trust your web host?

===Can I track and search what people do and post in Moodle?===
Assuming you are a teacher and it is your course, yes. Moodle Admin can do that for the entire site.

===Can I backup Moodle so I don't lose things?===
Yes, you can backup a Moodle site or as a teacher you can back up your course and download it (if your role permits it). With appropriate permissions, you can restore your course and/or import parts of courses elsewhere on your site or beyond.

==Teaching and Learning==

===What is the best way to use Moodle?===
The best way to use Moodle is the way which helps your students learn most efficiently. Moodle was designed on the principles of Social constructionism - see the page on [[Pedagogy]] for more information - but you do not have to use Moodle in that way if it is not appropriate to your needs.

===Can Moodle be used for..... ?===

The short answer is yes. Below is a list of just a few ways Moodle may be used. A dedicated forum [https://moodle.org/mod/forum/view.php?id=41 Teaching with Moodle] exists to discuss different ways of using the many [[Activities]] and [[Resources]] of Moodle to enhance your teaching.

*Peer assessment: see [[Workshop]]
*Discussion and debate: see [[Forum]]
*Sharing files and media: see [[Working with files]]
*Collaboration: see [[Glossary]] and [[Database]]
*Independent and personalised learning: see [[Lesson]]
*Submitting work online: see [[Assignments]]
*Assessment, summative and formative: see [[Quiz]]
*Gamification: see [[Using_restrict_access#Gamification|Gamification]]

===Are there any good examples of Moodle use I can see?===
Try the [http://school.demo.moodle.net Mount Orange School demo], a working demonstration site full of examples for you to see and play with.

===How do I share ideas and content with other Moodlers?===
*By participating in many ways, either through events, [http://moodle.org/forums/ Moodle Community Forums] on Moodle.org and networks elsewhere.
*You can find and share courses and activities on our [http://moodle.net/ Moodle Community hub.] You can download courses to use in your own site and publish course content to share with others.
*Within your own Moodle site, you can share courses with colleagues by using the [[Reusing activities| Course import or Restore features]].

===Can Moodle be used in different subjects?===

Yes. Moodle is used in [[:Category:Discipline-specific_Moodling| a variety of fields]]. Users in some subject areas may benefit further from standard or compatible third-party modules and plugins:

* In [[:Category:Mathematics|maths]], [[TeX filter|TeX notation filter]] (standard) or [[DragMath equation editor|DragMath equation editor]] (third-party plugin)), and more than 10 third party question types. You can also use [[PhET simulations]]
* For [[:Category:Language teaching| language teachers]], the contributed [https://moodle.org/plugins/view.php?plugin=mod_hotpot Hotpot] and [https://moodle.org/plugins/search.php?s=Poodll&search=Search+plugins Poodll] plugins are very popular.
* For [[:Category:Chemistry| chemistry]] there are many plugins for displaying molecular structures and making questions about them. You can also use [[PhET simulations]]
* For [[:Category:Music| music]] there are question type plugins for [[Key signature question type| key signature]], [[Music theory question type| music theory]], [[Music interval question type| music interval]] and [[Musical scale question type|musical scale]].
* For [[:Category:Programming| computer programming]] there in an [[iAssign| interactive assignment package]] and several question types.

==See also==

* [[About Moodle]]
* [[Decision FAQ]]
* [https://docs.moodle.org/dev/Contributing_to_Moodle Contribuiting to Moodle]

[[Category:FAQ]]

[[de:Was ist Moodle FAQ]]
[[es:FAQ acerca de Moodle]]
[[fr:FAQ sur Moodle]]

Multi-language content filter

2016-09-28T12:59:32Z

Tsala: /* How to use in a course */ order of span tags (MDL-55197)

{{Filters}}
The Multi-language content filter enables resources to be created in multiple languages. When turned on, it looks for <nowiki></nowiki> tags which indicate that a text contains multiple languages. Then it selects and outputs the best language for the current user. The language of the resource will change when the user changes their selected Moodle language.

== How to use in a course ==

To use this feature first create your contents in multiple languages (in the same resource). Then enclose each language block (aka multilang block) in the following tags:

<nowiki>your_content_here
your_content_in_other_language_here</nowiki>

It is essential to be in '''the code editing mode''' (press <nowiki>[<>]</nowiki> in the HTML editor), when you enter these tags for them to work. Only spaces, tabs and enters can be used between the individual languages in the multilang block.

Note: If your site uses a child language pack (see [[Language packs]] for the list), then the first span tag must be the parent language. Otherwise, when a user using the child language views the text, it will not be in the correct language for them (as reported in MDL-55197). For example, if your site uses en_us then the en span tag (as parent language) must be first i.e.

<nowiki>your_content_in English
your_content_in_German_here</nowiki>

==How to use for assignment submission agreements==
#Since Moodle 2.7.4 it's possible to have assignment submission statements in different languages.
#With the filter enabled, go to Site administration>Plugins>Activity modules>Assignment>Assignment settings.
#In the submission statement, add (for example)

<nowiki>This assignment is my own work, except where I have acknowledged the use of the works of other people.
Ce devoir est le fruit de mon travail personnel, sauf aux endroits où l'utilisation d'oeuvre d'autres auteurs est clairement indiquée. </nowiki>

== How it works internally ==

# Filter first looks for ''multilang blocks'' in the text
# For each multilang block:
#* If there are texts in the currently active language, print them
#* Else, if there exists texts in the current parent language, print them
#* Else, print the first language found in the text
# Text outside of multilang blocks will be shown always

== Common problems ==

* The multilang filter is not enabled. It can be enabled by a site administrator in ''Settings > Site administration > Plugins > Filters > Manage filters''.
* Extra characters between language span tags - editor might add <nowiki> </nowiki> or other tags, please review the html in source view
* If the course setting is "force" some language, you won't be able to change the displayed language.
* Extra spaces in language span tag
* Can not easily access language choice dropdown! Unfortunately you must go to the site homepage or your own profile to change the displayed language. It is possible to manually quickly change displayed lang by editing the URL in the browsers address bar. See Tips and tricks below!
* The multilang filter does not work with the course short name! A course's short name is meant as a unique course identifier, so it does not use the multilang filter

==Tips and tricks==

===Changing language displayed without going to front page===
It is possible to change the displayed language by manually changing the link.
*Here is the default language page at id=2306. This link is in English, the default language:
:http://moodle.org/mod/resource/view.php?id=2306
*The link to change the page display to Spanish is
:http://moodle.org/mod/resource/view.php?id=2306&lang=es ,
*When the default language is an other language, to change the page to an English version, the link would be:
:http://moodle.org/mod/resource/view.php?id=2306&lang=en

Thus, with a bit of editing, you can manually change the displayed language by adding "&lang=xx" to the URL in the location bar of the browser. Where xx is the abbreviation for the language you want.

==The 'Restriction by language' additional plugin==
Language filters are great, but sometimes they can make your resources and activities very complex.

The 'Restriction by language' availability condition is an additional plugin for Moodle 2.7, available in the [https://moodle.org/plugins/view.php?plugin=availability_language Moodle plugins database], that makes it easy to show an English resource only to English users and an activity in French only to French speaking students.

[[File:Restriction by language.png]]

==See also==

*[[Language]]
*Custom menu items in [[Theme settings]]
*[https://moodle.org/mod/forum/discuss.php?d=320980 this forum thread] about translating a MOOC

[[Category:Language]]

[[de:Mehrsprachiger Inhalt]]
[[es:Contenido multilingüe]]
[[fr:Contenu multilingue]]
[[ja:多言語シンタックス]]

error/moodle/dmlwriteexception

2016-09-22T15:29:55Z

Tsala: MySQL dmlwriteexception error when using calculated questions in a quiz (MDL-29332)

This indicates that a general error occurred when Moodle tried to write to the database. If you turn on [[Debugging]] you will get more detailed information about what the problem is.

==MySQL==

If you're using a MySQL database for your Moodle installation, this error can be caused by the server's <code>max_allowed_packet</code> size being configured incorrectly. [https://moodle.org/mod/forum/discuss.php?d=230681#p1001751 Increasing this value may resolve the issue.]

==dmlwriteexception error when restoring a course==

If you obtain a dmlwriteexception error when restoring a course, it is recommended that InnoDB tables are converted to the Barracuda file format. See the section 'Converting InnoDB tables to Barracuda' in [[Administration via command line]] for details of why this is recommended plus information on a tool for converting tables.

==dmlwriteexception error when using calculated questions in a quiz==

If you're using MySQL or SQL*Server and you have a problem with duplicated keys with the question_attempt_step_data table when using calculated questions in a quiz (from entering a formula which uses variables with the same characters in different cases), it is recommended that you upgrade to Moodle 3.0.x or higher ASAP. Alternatively, the problematic unique index can be dropped or the collation of the columns changed to be case-sensitive, however this is not considered a complete fix. See MDL-29332 for more information.

==See also==

* [[Development:DML exceptions]]

[[Category:Error|Dmlwriteexception]]

[[es:error/moodle/dmlwriteexception]]

Calculated question type

2016-09-22T15:22:24Z

Tsala: MySQL dmlwriteexception error when using calculated questions in a quiz (MDL-29332)

{{Questions}}
Calculated questions offer a way to create individual numerical questions by the use of wildcards (i.e you can use common variables names as '''x''' , '''y''' enclosed in curly braces to create the wildcards '''{x}''' and '''{y}''') that are substituted with random values when the quiz is taken.

For example, if you want to create a large number of '''"Calculate the area of a rectangle"''' problems to drill your students, you could create a question with two wildcards (i.e. '''{base}''', '''{height}''' created from the common '''base''', '''height''' variable names) and put in the "'''Correct Answer Formula='''" input field '''{base}''' * '''{height}''' ( * being the multiplication sign ).

'''Correct Answer Formula=''' {base}*{height}

When a student takes the test, Moodle will randomly select values for '''{base}''' and '''{height}''' and grade the response using the result of the '''Correct Answer Formula'''.

The test will very rarely appear the same way twice.

== Is this really the question type for you? ==
The main purpose of the calculated question is to create multiple versions of a question with different numerical values. This means you must have '''at least one''' wildcard in one of the answers.

If you don't need a random element, use the [[Numerical question type]] instead.
== Simple calculated question type ==

The [[Simple calculated question type|simple calculated]] question offers the most used features of the calculated question with a much simpler creation interface.

==Wildcards and datasets==

When Moodle delivers a Calculated question to the student, the wildcards are replaced with randomly-selected values. However, these values are not completely random - rather, they are randomly selected from a pre-defined ''dataset'' of possible values. This allows you some control over the possible values chosen - for example, in order to make sure the numbers are realistic.

These datasets can be ''private'' or ''shared'' - private datasets are used by one wildcard within one calculated question; shared datasets are used by one wildcard within all calculated questions that use it.

==Question set-up==
To create (or modify) a calculated question there are three pages to work through. The instructions below take you through the pages, step by step:

===Page 1. Editing a Calculated question ===

#Select the question '''category'''
#Any shared wildcards for this category are listed beneath. If you change category, you'll need to click the "Update the category" button to refresh this list. There may not be any shared wildcards yet - if not, you can create them later if you wish.
#Give the question a descriptive '''name''' - this allows you to identify it in the question bank.
#Enter the '''question text'''. This should be the question you want the student to answer, and it must include all the information they need to calculate an answer. Therefore it must contain at least one wildcard, inside curly braces. For example, if you wanted the student to sum numbers A and B, the question text might read: "What is {A} + {B}?" You may also include quantities computed from wildcards using the syntax "{=...}: for example, the question "What is {={A}+{B}} - {A}?" with wildcard values A=4 and B=3 would display as "What is 7 - 4?"
#Select an image to display if you want to add a picture to the question. For the student, it appears immediately after the question text and before the choices. If you want more control over how the image appears, include it in the question text above, using the HTML editor.
#Set the '''default question grade''' (i.e. the maximum number of marks for this question).
#Set the '''Penalty factor''' (see [[Calculated_question_type#Penalty_factor|Penalty factor]] below).
#''Moodle 1.7+:'' If you wish, add general feedback. This is text that appears to the student after he/she has answered the question.
#Next add the '''formula for the answer'''. This formula must contain at least the wildcards that appear in the question text. See [[Calculated_question_type#Correct_answer_formula_syntax|Correct answer formula syntax]] for further details.
# Choose the '''grade''' that the student will get for this question if they give this answer. This should be a percentage of the total marks available. For example, you could give 100% for a correct answer, and 50% for an answer that is nearly right. '''One of the answers must have a 100% grade'''.
#Determine the '''tolerance''' for error that you will accept in the answer. The tolerance and tolerance type settings combine to give a range of acceptable scores. So, if tolerance = t, correct answer = x and the difference between the user's answer and the correct answer is dx, then the tolerance types are as follows:
##Nominal - mark correct if dx <= t
##Relative - mark correct if dx / x <= t
##Geometric - mark correct if dx² / x² <= t²
# The next 2 settings, "Correct answer shows" or "Answer display" and "Format" illustrate the '''precision''' of the answer. Use these to select the number of decimal places or significant figures that reflect the tolerance settings. Notice that the student response grading will be done using the tolerance values without any check of its '''Correct answer Format'''.
# Add some '''feedback''' which the student will see if they enter this answer.
# You can specify as many answer formulae as you like - click "Add another answer blank" to add more.
# You can also specify units for the answers. For example, if you enter a unit of 'cm' here, and the accepted answer is 15, then the answers '15cm' and '15' are both accepted as correct. If you add more than one unit, you can also specify a multiplier. So, if your main answer was 5500 with unit W, you can also add the unit kW with a multiplier of 0.001. This means that the answers '5500', '5500W' or '5.5kW' would all be marked correct. Note that the accepted error is also multiplied, so an allowed error of 100W would become an error of 0.1kW.
# Finally (!) you can click "Next page" to save what you've done and move on. If you are editing an existing question, you can click "Next page (new question)" to create a completely new question based on an existing one.

==== Penalty factor ====

The 'penalty factor' only applies when the question is used in a quiz using adaptive mode - i.e. where the student is allowed multiple attempts at a question even within the same attempt at the quiz. If the penalty factor is more than 0, then the student will lose that proportion of the '''maximum''' grade upon each successive attempt. For example, if the default question grade is 10, and the penalty factor is 0.2, then each successive attempt after the first one will incur a penalty of 0.2 x 10 = 2 points.

===Tolerance===

As for numerical questions it is possible to allow a margin within which all responses are accepted as correct. The "Tolerance" field is used for this. However, there are three different types of tolerances. These are Relative, Nominal and Geometric. If we say that the correct answer at quiz time is calculated to 200 and the tolerance is set to 0.5 then the different tolerance types work like this:

Relative: A tolerance interval is calculated by multiplying the correct answer with 0.5, ie in this case we get 100 so for this tolerance the correct response must be between 100 and 300. (200 ± 100)
This is useful if the magnitude of the correct answer can differ greatly between different wildcard values.

Nominal: This is the simplest tolerance type but not very powerful. The correct response must be between 199.5 and 200.5 (200 ± 0.5)
This tolerance type can be useful if the differences between different correct answers are small.

Geometric: The upper limit of the tolerance interval is calculated as 200 + 0.5*200 and is the same as for the relative case. The lower limit is calculated as 200/(1 + 0.5). The correct response must then be between 133.33 and 300.
This is useful for complex calculation that must have great tolerances where relative tolerances of 1 or more would be used for the upper limit but clearly not acceptable for the lower limit as it would make zero a correct answer for all cases.

The field Significant Figures does only relate to how the correct answer should be presented in the review or the reports. Examples: If it is set to 3 then the correct answer 13.333 would be presented as 13.3; 1236 would be presented as 1240; 23 would be presented as 23.0 etc.

===Page 2. Choose dataset properties ===

Each wildcard that you specify in the answer formula must have an associated set of possible values - this is its ''dataset''. Each of the wildcards is listed on this page along with a choice of dataset:
*'''private''' i.e. only used by this question
*'''shared''' i.e shared with other calculated questions in the same category

Using a shared dataset can save time when you are creating a lot of similar calculated questions.

Note that even when creating a question for the first time, this page may say that your wildcard "will use the same existing private dataset as before." This just means that Moodle has already tentatively created a private data set for that wildcard: if a private dataset is what you want, leave this choice selected.

If there is anything in the question text that looks like a wildcard, but does not appear in any of the answer formulae, you can specify whether or not this is meant to be a wildcard. If it is, you can choose whether it should use a private or shared dataset.

To continue, simply choose your preferred dataset for each wildcard, then click "Next Page".

===Page 3. Edit the datasets ===

Now we need to create the set of possible values that each wildcard can take. ''Warning'' - this page is a bit confusing!

There are two ways of creating values - you can type them in yourself and add them to the list, or you can have Moodle generate them for you.

==== Adding/deleting your own values ====

Adding individual values to the list is easy:

# In the 'Param' field for each wildcard, enter the value you want
# Scroll down to the 'Add' section and click the Add button (leaving the number of items set to 1)
# Repeat the above steps as many times as necessary (the maximum number of items is 100)

To delete values from the list:

# In the 'Delete' section, select the number of items to delete
# Click the Delete button

==== Letting Moodle create values ====

# Start with the "Range of Values" fields, and enter the lower and upper limits for the values you would accept
# Choose a number of decimal places for the value
# Choose the distribution of values between the limits - 'uniform' means any value between the limits is equally likely to be generated; 'loguniform' means that values towards the lower limit are more likely.
# Now move down to the 'Add' section and click on "force regeneration"
# In the menu next to the Add button, choose the number of sets of random values (items) you wish to add to the list. (Note that the maximum total number of items in your list is 100.)
# Finally, click Add to append the new values to the list
# '''Note:''' If you want more control over the items that Moodle adds, you can do them one at a time and preview the values before you add them. Click the "Get New Item to Add" button to make Moodle generate new values in the "Item to Add" section at the top. If you like them, click "Add" for 1 item; if not, click "Get New Item to Add" again to get new values.

==== Finishing off ====

Once your list of items (values) is complete, you are finished. It's up to you how many values you add - the more values you add, the more a question can be used by the students without them seeing the same values repeatedly.

Note that if you delete values from the list, you can put them back again. Change the "Next Item to Add" option to "reuse previous value if available", then the next time you add items, Moodle will restore your previously-deleted items from the dataset.

Once your list of values is complete, you can click 'Save changes' to finish.

==== What does the 'Update the datasets parameters' button do? ====

Warning: This button can affect several questions, so be careful before using it.
Assume you have selected dataset parameter for {a} to be any value between 1-10 and generated a question. In the second question also you decide to use a SHARED wildcard called {a}. Inherently, it will show a value between 1-10. However, your need here changes and you want to make it 11-100 instead. Then, you change them in the range and click this button. Voila! the values change and you can add new items here using the 'Get New item to add'. However, if you go back to your previous question, you will see that values would change there too, because it is a shared dataset. If you do not update parameters, then this may not happen and will generate a new set of values and displays them in the "Item to Add" section.

==Correct answer formula syntax==

=== DO NOT PUT THE = sign in the formula. ===

* In the recent versions of the calculated question type, you could have more than one answer formula and applied a specific grading value to each of them as long as there is at least one 100% correct answer formula.
If more than one correct answer formula input field are displayed when editing,
your site has the multiple answer feature.

* As a general rule, write these formulas like you would in a calculator e.g. <code>3 + 5 * sin(3/{x})</code> A notable exception is exponentiation, where x3 cannot be entered as <code>{x}^3</code>, but instead should be entered as <code>pow({x}, 3)</code>.
* Each function's placeholders and other arguments should be in parentheses (brackets). For example, if you want students to calculate the sine of one angle and cosine of two times another angle, you would enter <code>sin({a}) + cos({b}*2)</code> or <code>sin({a}) + cos(2*{b})</code>.
* It's usually better to have too many parentheses (brackets) than too few. The server won't care, and the more specific you are about what you mean, the more likely it will like your complex formulas.
* There is no implicit multiplication. To you, the human editor, "5(23)" or "5x" may seem perfectly obvious. To the server doing the math, it's crazy talk and won't be understood. Always use the "*" for multiplication.
* Any special mathematical function must have parentheses around its values. Take the sine function in the first bullet point for instance. Notice that the ''3 / x'' is wrapped in parentheses (brackets)--this is so the server can understand it properly. Without those parentheses, the server won't know if you mean "(sin 3) / x" or "sin (3 / x)" and will reject the entire formula accordingly.

==Available functions==

Calculated questions can use more than simple arithmetic operators. The following functions are allowed in versions 1.5 and newer.

{| width="97%" border="1px"
!Function
!Explanation
|-
|abs
|Absolute value
|-
|acos
|Arc cosine -- output in radians.
|-
|acosh
|Inverse hyperbolic cosine -- output in radians.
|-
|asin
|Arc sine -- output in radians.
|-
|asinh
|Inverse hyperbolic sine.-- output in radians.
|-
|atan2
|Arc tangent of two variables -- pass in two values like (y, x), and you'll get the atan(y/x), adjusted to the proper quadrant. (Note: The variables are in the reverse order to atan2(x,y) in Excel) Output is radians.
|-
|atan
|Arc tangent -- output in radians.
|-
|atanh
|Inverse hyperbolic tangent-- output in radians.
|-
|bindec
|Binary to decimal
|-
|ceil
|Round fractions up
|-
|cos
|Cosine -- in radians!!! Convert your degree measurement to radians before you take the cos of it.
|-
|cosh
|Hyperbolic cosine -- in radians!!! Convert your degree measurement to radians before you take the cosh of it.
|-
|decbin
|Decimal to binary
|-
|decoct
|Decimal to octal
|-
|deg2rad
|Converts the number in degrees to the radian equivalent
|-
|exp
|Calculates the exponent of e
|-
|expm1
|Returns exp(number) - 1, computed in a way that is accurate even when the value of number is close to zero
|-
|floor
|Round fractions down
|-
|fmod
|Returns the floating-point modulus of two numbers - i.e. the remainder when the first is divided by the second.
|-
|is_finite
|Finds whether a value is a legal finite number
|-
|is_infinite
|Finds whether a value is infinite
|-
|is_nan
|Finds whether a value is not a number
|-
|log10
|Base-10 logarithm
|-
|log1p
|Returns log(1 + number), computed in a way that is accurate even when the value of number is close to zero
|-
|log
|Natural logarithm (''ln'')
|-
|max
|Find highest value
|-
|min
|Find lowest value
|-
|octdec
|Octal to decimal
|-
|pi()
|Get value of pi - the function does not take an argument, like in Excel.
|-
|pow (numberToRaise, NumberRaisedTo)
|Exponential expression
|-
|rad2deg
|Converts the radian number to the equivalent number in degrees
|-
|rand
|Generate a random integer
|-
|round
|Rounds a float
|-
|sin
|Sine -- in radians!!! Convert your degree measurement to radians before you take the sin of it.
|-
|sinh
|Hyperbolic sine -- in radians!!! Convert your degree measurement to radians before you take the sinh of it.
|-
|sqrt
|Square root
|-
|tan
|Tangent -- in radians!!! Convert your degree measurement to radians before you take the tan of it.
|-
|tanh
|Hyperbolic tangent -- in radians!!! Convert your degree measurement to radians before you take the tanh of it.
|}

==Predefined constants==
Actually there is NO Predefined constant that is allowed other than pi() as a function without parameter.

==Synchronization==

You could use shared wild cards to get the same values across questions in a quiz.

A simple example will be to use the same radius in a first question asking for the perimeter of a circle of {radius}cm and a second question asking for the surface of a circle of {radius}cm.

When the quiz will be shown to the student the two questions will shown the same {radius} value.

However the synchronization will work '''ONLY''' if the questions are kept in the '''SAME''' category and have the '''SAME NUMBER OF DATASETS''' .

If you need to move the synchronized questions to another category, you need to do it by editing the questions.

(This restriction should be released by sept. 2010).

==MySQL dmlwriteexception error when using calculated questions in a quiz==

If you're using MySQL or SQL*Server and you have a problem with duplicated keys with the question_attempt_step_data table when using calculated questions in a quiz (from entering a formula which uses variables with the same characters in different cases), it is recommended that you upgrade to Moodle 3.0.x or higher ASAP. Alternatively, the problematic unique index can be dropped or the collation of the columns changed to be case-sensitive, however this is not considered a complete fix. See MDL-29332 for more information.

==See also==

Using Moodle forum discussions:

* [http://moodle.org/mod/forum/discuss.php?d=150923 couple questions about "edit datasets page" in calculated questions]
* [https://moodle.org/mod/forum/discuss.php?d=230558 Capital vs lower case letters with units]

[[Category:Mathematics]]

[[de:Berechnungsfragen]]
[[es:question/type/calculated]]
[[fr:Question calculée]]
[[zh:計算題]]
[[ja:計算問題タイプ]]

Upgrading

2016-09-22T09:35:24Z

Tsala: /* Possible issues that may affect you in Moodle 2.7 */ MySQL dmlwriteexception error when using calculated questions in a quiz (MDL-29332)

{{Installing Moodle}}
''This page explains in detail how to upgrade Moodle. For a summary of the process, see [[Upgrade overview]].''

==Check the requirements==

Check that your server meets all requirements for 2.7 in ''Administration > Site administration > Server > [[Environment]]''.

Note: You can only upgrade to Moodle 2.7 from Moodle 2.2 or later. If upgrading from earlier versions, you must [https://docs.moodle.org/22/en/Upgrading_to_Moodle_2.2 upgrade to 2.2] as a first step.

==Before upgrading==

'''We advise that you test the upgrade first on a COPY of your production site, to make sure it works as you expect.'''

===Themes===

All standard themes present in Moodle 2.6 (and earlier), except the Clean theme, have been removed from Moodle 2.7 (see MDL-43784). Custom themes and themes from the Plugins Directory are not affected, unless they use one of the removed themes as a parent theme. If a theme that was in use has been removed, the theme will revert to the new default theme called Clean.

For sites wishing to continue using any of the removed standard themes (or themes relying on a standard theme as a parent theme), other than Clean, we recommend you use the following process.

# Download the 2.7 version of Moodle, but do not run the upgrade yet.
# Download the 2.7 version of your theme from the [https://moodle.org/plugins/browse.php?list=category&id=3 Themes section of the Moodle plugins directory] (or from the links below) into moodle/theme/.
# Proceed with the upgrade.

It is possible to copy missing themes into Moodle after the upgrade, but this should happen before users touch the system, otherwise theme-related settings may be lost.

The affected themes (with download links) are...

{|-
| Afterburner
| [https://moodle.org/plugins/view.php?plugin=theme_afterburner plugins db]
| [https://github.com/moodlehq/moodle-theme_afterburner github]
|-
| Anomaly
| [https://moodle.org/plugins/view.php?plugin=theme_anomaly plugins db]
| [https://github.com/moodlehq/moodle-theme_anomaly github]
|-
| Arialist
| [https://moodle.org/plugins/view.php?plugin=theme_arialist plugins db]
| [https://github.com/moodlehq/moodle-theme_arialist github]
|-
| Binarius
| [https://moodle.org/plugins/view.php?plugin=theme_binarius plugins db]
| [https://github.com/moodlehq/moodle-theme_binarius github]
|-
| Boxxie
| [https://moodle.org/plugins/view.php?plugin=theme_boxxie plugins db]
| [https://github.com/moodlehq/moodle-theme_boxxie github]
|-
| Brick
| [https://moodle.org/plugins/view.php?plugin=theme_brick plugins db]
| [https://github.com/moodlehq/moodle-theme_brick github]
|-
| Formal White
| [https://moodle.org/plugins/view.php?plugin=theme_formal_white plugins db]
| [https://github.com/andreabix/moodle-theme_formal_white github]
|-
| Form Factor
| [https://moodle.org/plugins/view.php?plugin=theme_formfactor plugins db]
| [https://github.com/moodlehq/moodle-theme_formfactor github]
|-
| Fusion
| [https://moodle.org/plugins/view.php?plugin=theme_fusion plugins db]
| [https://github.com/moodlehq/moodle-theme_fusion github]
|-
| Leatherbound
| [https://moodle.org/plugins/view.php?plugin=theme_leatherbound plugins db]
| [https://github.com/moodlehq/moodle-theme_leatherbound github]
|-
| Magazine
| [https://moodle.org/plugins/view.php?plugin=theme_magazine plugins db]
| [https://github.com/moodlehq/moodle-theme_magazine github]
|-
| Nimble
| [https://moodle.org/plugins/view.php?plugin=theme_nimble plugins db]
| [https://github.com/moodlehq/moodle-theme_nimble github]
|-
| Nonzero
| [https://moodle.org/plugins/view.php?plugin=theme_nonzero plugins db]
| [https://github.com/moodlehq/moodle-theme_nonzero github]
|-
| Overlay
| [https://moodle.org/plugins/view.php?plugin=theme_overlay plugins db]
| [https://github.com/moodlehq/moodle-theme_overlay github]
|-
| Serenity
| [https://moodle.org/plugins/view.php?plugin=theme_serenity plugins db]
| [https://github.com/moodlehq/moodle-theme_serenity github]
|-
| Sky High
| [https://moodle.org/plugins/view.php?plugin=theme_sky_high plugins db]
| [https://github.com/moodlehq/moodle-theme_sky_high github]
|-
| Splash
| [https://moodle.org/plugins/view.php?plugin=theme_splash plugins db]
| [https://github.com/moodlehq/moodle-theme_splash github]
|-
| Standard
| [https://moodle.org/plugins/view.php?plugin=theme_standard plugins db]
| [https://github.com/moodlehq/moodle-theme_standard github]
|-
| Standard old
| [https://moodle.org/plugins/view.php?plugin=theme_standardold plugins db]
| [https://github.com/moodlehq/moodle-theme_standardold github]
|}

Note: Only installed additional themes are updated automatically during the upgrade, NOT standard themes. Because standard themes have been removed from Moodle 2.7, they have to be re-added.

===Questions engine upgrade===

In Moodle 2.1, there was a major overhaul of the Question engine. As explained in [https://docs.moodle.org/21/en/Upgrading_to_Moodle_2.1#Planning_the_question_engine_upgrade the upgrade documentation for that version], it was possible to delay parts of the database upgrade to be run later. Before you upgrade to Moodle 2.7, this upgrade must be completed.

This will affect you if...
* your site started off on a version of Moodle 2.0.x and
* when you upgraded to Moodle 2.1 or 2.2, you made use of the complex facility to delay part of the question engine upgrade (as explained in [https://docs.moodle.org/21/en/Upgrading_to_Moodle_2.1#Planning_the_question_engine_upgrade the upgrade documentation for that version]) and
* you still have not completing that upgrade
...then you must complete it before upgrading to Moodle 2.7.

You can check by looking at the bottom of the [[:en:Environment|Environment]] page in your site, providing you are running a version later than 2.4.9, 2.5.5 or 2.6.2. If you have a problem, it will tell you there. If there is no mention of questions there, you can forget about this.

This is unlikely to affect most users.

== Backup important data ==

There are three areas that should be backed up before any upgrade:
#Moodle software (For example, everything in server/htdocs/moodle)
#Moodle uploaded files (For example, server/moodledata)
#Moodle database (For example, your Postgres or MySQL database dump)

See [[Site backup]] for more specific information.

==Put your site into maintenance mode==
Before you begin upgrading your site, you should put it into [[Maintenance_mode | maintenance mode]] to stop any non-admin users from logging in.

== Check for plugin updates ==

If you have [[Automatic updates deployment]] enabled, you will be able to update installed plugins automatically during the upgrade. Just make sure you check for available updates (via the button for it) at the Plugins check screen.

If you are updating plugins manually, it is a good moment now to check in the [http://moodle.org/plugins Moodle Plugins directory] whether there is a 2.7 version available for any plugins (including themes) that you have previously installed on your site. If so, download the plugin package. In the next step, you will copy it to the appropriate location in your Moodle code (see [[Installing plugins]]).

The upgrade of the plugin will then happen as part of the Moodle upgrade process.

If an out-of-date plugin causes your upgrade to fail, you can usually delete the plugin code rather than uninstalling it from within Moodle so that the data associated with it is not deleted.

== Install the new Moodle software ==

=== Standard install package ===

# Move your old Moodle software program files to another location. ''Do NOT copy new files over the old files.''
# Unzip or unpack the upgrade file so that all the new Moodle software program files are in the location the old files used to be in on the server. Moodle will adjust SQL and moodledata if it needs to in the upgrade.
# Copy your old [[Configuration file|config.php file]] back to the new Moodle directory.
# As mentioned above, if you had installed any plugins on your site you should add them to the new code tree now. It is important to check that you get the correct version for your new version of Moodle. Be particularly careful that you do not overwrite any code in the new version of Moodle.
# Dont forget to also copy over your moodledata folder / directory. If you don't you will get a "fatal error $cfg- dataroot is not configured properly".

====Linux====
mv moodle moodle.backup
tar xvzf moodle-2.7.tgz

Next, copy across your config.php, any custom plugins, and your .htaccess file if you created one ('''check that custom plugins are the correct version for your new Moodle first'''):

cp moodle.backup/config.php moodle
cp -pr moodle.backup/theme/mytheme moodle/theme/mytheme
cp -pr moodle.backup/mod/mymod moodle/mod/mymod

Don't forget to make moodle/config.php (and the rest of the source code) readable by your www server. Ideally the files should not be writeable by your server.

If you use cron, take care that cron.php is executeable and uses the correct php command:
chmod 740 admin/cli/cron.php (some configurations need chmod 750 or chmod 755)
copy the first line from cron.php (if it looks like '#!/usr/local/bin/php' or '#!/usr/local/bin/php5.3', no need to copy '<?php')

if necessary.

=== Using Git ===

You can use Git for updating or upgrading your Moodle. See [[Git for Administrators]] for details.

===Command line upgrade===

On Linux servers, Moodle 2.7 supports running the [[CLI|upgrade from the command line]], rather than through a web browser. This is likely to be more reliable, particularly for large sites.

== Finishing the upgrade ==

The last step is to trigger the upgrade processes within Moodle.

To do this just go to ''Administration > Site administration > Notifications''.

Moodle will automatically detect the new version and perform all the SQL database or file system upgrades that are necessary. If there is anything it can't do itself (very rare) then you will see messages telling you what you need to do.

Assuming all goes well (no error messages) then you can start using your new version of Moodle and enjoy the new features!

Note: If you are running multiple servers then you should purge all caches manually (via ''Administration > Site administration > Development > Purge all caches'') after completing the upgrade on all servers.

===Fatal error: Maximum execution time of 30 seconds exceeded...===

If your server uses a main language other than English, you may encounter a 'Fatal error: Maximum execution time of 30 seconds exceeded' when you try to upgrade it. You can increase max_execution_time = 160 on php.ini to allow the scripts enough time to process the language update. Otherwise, you can switch to English as the default language before doing the upgrade and back to your original language after a succcessful upgrade. See the forum discussion at https://moodle.org/mod/forum/discuss.php?d=119598.

==After upgrading==

The config.php file from your installation should work fine but if you take a look at config-dist.php that came with Moodle 2.7 there are more/different options available (e.g. database drivers and settings). It's a good idea to map your old config.php settings to a new one based on the 2.7 config-dist.php.

===Cron===

Cron has received a major update (MDL-25499) and now has support for both scheduled and adhoc tasks.

The benefits of these changes are:
* The schedule for every task can be configured by the admin
* Tasks can run in parallel
* Cron processes use locking to prevent the same task running at the same time by different processes
* Clusters with multiple identical application nodes are supported, you can run cron on all of them

A result of this is that cron can be run much more often, which means (for example) forum posts can be sent out sooner. To take advantage of the new cron system it is now strongly recommended that administrators increase the frequency that cron is run to at least ''once per minute''.

You also may need to modify any automated scripts you have that are parsing the output from cron. It is no longer possible to simply monitor the output of cron for the string "Cron script completed correctly" (if that is what you were doing). An alternative is to monitor the output for the string "task failed:". If you detect that a task is failing, [[Cron#Debugging_Scheduled_Tasks|here]] are some tips for debugging the failure.

Before the upgrade to 2.7, there may have been a cron task that was failing, which was preventing the rest of cron from being executed. A failure in any single task will no longer prevent the rest of the Moodle cron tasks from executing, so you may uncover previously masked bugs. It is a good idea to closely monitor the output from cron after the upgrade to 2.7.

===Assignments===

The old assignment (2.2) module has been removed from core and has been replaced by a stub to support transparently remapping URLs and restoring course backups from the old module to the new one.

If you are still using the old assignment (2.2) module, after upgrading to Moodle 2.7 all assignment (2.2) activities will be hidden. You need to run the [[Assignment upgrade tool]] to un-hide the activities.

If you really, really need to keep using the old assignment (2.2) module, you should update the code to Moodle 2.7, and then replace the "mod/assignment" folder with the one from https://github.com/moodlehq/moodle-mod_assignment/releases before completing the upgrade.

===Maths filters===

Moodle 2.7 comes with a new maths filter based on [http://mathjax.org MathJax]. It is an alternative to the existing Tex filter. The MathJax filter is enabled by default for new sites and also upgrades. You may wish to disable the Tex filter and enable the MathJax filter. In 2.7 sites, if both are enabled the TeX filter wins regardless of filter order because the TeX filter removes all TeX notation before the javascript is executed. This may mask the fact MathJaxloader is enabled on old installations. In 2.8 both filters may be run together with both being used to display the mathematics. See MDL-44780. There are some compatibility settings and other options that can be changed for the [[MathJax filter]].

==Possible issues that may affect you in Moodle 2.7==

===Custom log-based reports===

Moodle 2.7 has moved to the new Logging API that allows more detailed and more flexible log storage. By default after the upgrade Moodle no longer stores data in table 'log'. All standard reports and plugins that used to access this table are converted to support both new API and legacy 'log' table. It is understandable that there might be custom 3rd party plugins that can not be changed immediately and either write significant information to the 'log' table or require access to it. In this case admin needs to enable writing to the legacy log:
Site Administration > Plugins > Logging > Legacy log : Select "Log legacy data". You might also want to disable "Standard log" so your system doesn't have double logging.

=== MySQL dmlwriteexception error when restoring a course===

If you obtain a dmlwriteexception error when restoring a course, it is recommended that InnoDB tables are converted to the Barracuda file format. See the section 'Converting InnoDB tables to Barracuda' in [[Administration via command line]] for details of why this is recommended plus information on a tool for converting tables.

===MySQL dmlwriteexception error when using calculated questions in a quiz===

If you're using MySQL or SQL*Server and you have a problem with duplicated keys with the question_attempt_step_data table when using calculated questions in a quiz (from entering a formula which uses variables with the same characters in different cases), it is recommended that you upgrade to Moodle 3.0.x or higher ASAP. Alternatively, the problematic unique index can be dropped or the collation of the columns changed to be case-sensitive, however this is not considered a complete fix. See MDL-29332 for more information.

=== Moodle 2.3, 2.4, 2.5 and 2.6 improvements ===

Depending on which version you are upgrading from, please see the section 'Possible issues that may affect you' in the documentation

* [https://docs.moodle.org/23/en/Upgrading Upgrading to Moodle 2.3]
* [https://docs.moodle.org/24/en/Upgrading Upgrading to Moodle 2.4]
* [https://docs.moodle.org/25/en/Upgrading Upgrading to Moodle 2.5]
* [https://docs.moodle.org/26/en/Upgrading Upgrading to Moodle 2.6]

==See also==

* [[Installation]]
* Using Moodle [http://moodle.org/mod/forum/view.php?id=28 Installation problems forum]
* [[dev:Moodle 2.7 release notes|Moodle 2.7 release notes]]
* [[dev:Upgrade API|Upgrade API]]

[[es:Actualización de moodle]]
[[fr:Mise à jour]]
[[ja:Moodleをアップグレードする]]
[[de:Aktualisierung von Moodle]]

Badges FAQ

2016-09-19T09:08:04Z

Tsala: /* Can I award a badge based on a specific grade? */ removing assignment

{{Badges}}
==How can teachers award site badges?==
By default, teachers can only award course badges. Only users with capabilities to manage badges in the system are able to do this, so if you wish teachers to award site badges you need to create a new, global role.
#Go to ''Administration > Site administration > Users > Permissions > Define roles'' and add a new role called for example "Site badge awarder"
#Add it to the "System" context
#Set the following capabilities to "allow": moodle/badges:awardbadge, moodle/badges:viewbadges, moodle/badges:configurecriteria
#Assign this role to the teachers you wish to award site badges.

The teacher with the role "Site badge awarder" will see a link to Badges in the Administration block.

==Can more than one teacher in a course award the same badge?==
''(copied from MDL-39189'') It's not the user who issues the badge, but a role. Users with multiple roles will have an option to use both of them to issue badges. If the badge is awarded twice by different roles, both roles are displayed and criteria (ALL/ANY) is given. In some cases it will be required for a badge to be awarded by several different roles. When there are, let's say, three teachers in the course and they go to award a badge as a teacher, each of them will see the list of users who already got the badge from a teacher, so they won't need to award the badge again.
==What's the difference between a backpack and a collection?==
When you upload a badge to the [http://backpack.openbadges.org/ Openbadges site] you are adding it to your backpack, which is the general area you put your badges in. (Like a backpack!) You then organise them into collections (like separate little bags in your backpack) and you choose which to display on your Moodle profile. So a badge may be in your backpack and not in a collection, but it must be in your backpack before it can be in a collection. (Note the 'public' box must be ticked too.) Collections allow you to control which badges you share with people.
{|
|[[File:mozillabackpack.png|thumb|A users's online backpack]]
|[[File:collections.png|thumb|Drag badges into a new collection to display on Moodle]]
|}
==What size is a badge?==

A badge is displayed with dimensions 100 X 100 pixels. However, a larger image may be uploaded, which will then be cropped to be a square, and then resized.

See also [https://moodle.org/mod/forum/discuss.php?d=230591 Badge image size] discussion.

==Can I award a badge based on a specific grade?==

There are two ways of awarding a badge based on a specific grade.

Method 1:

Set a passing grade for the quiz in the gradebook, as explained in section 1.3 of [[Activity completion settings]].

Method 2:

# Create a page resource and set the restrict access conditions so that it only appears if the user obtains a certain grade in the quiz or assignment
# Set the activity completion for the page as "view"
# Set the badge criteria such that the page has to be completed (i.e. viewed)

==Do I have to use my Moodle email for my backpack?==
No, but you have to log in via your Persona account to authenticate via your backpack, in order to ensure you are only displaying badges belonging to you.

==Which roles can see which badges?==
See this [https://moodle.org/mod/forum/discuss.php?d=234155&parent=1017187#p1017363 forum post on viewing badges]

==Can I change a badge images once awarded?==
The short answer is 'no', but see this forum post on [https://moodle.org/mod/forum/discuss.php?d=228553 changing badge images] for more information.

==Can I revoke a badge once it has been awarded?==
See the section on deleting badges in [[Managing badges]]

==How can I get badges with participants' profiles like on Moodle.org?==
[[File:profilebadges.png|thumb|500px|center]]

These are not badges. These are group avatars/pictures. When you create a group in your course - see the documentation on [[Groups]] - you can add a picture to represent that group. In places such as forums this picture is then displayed for each participant. If they are a member of several groups then several pictures will be displayed.

==See also==

* Moodle in English [https://moodle.org/mod/forum/view.php?id=8085 Badges forum]
* [http://www.somerandomthoughts.com/blog/2013/05/06/open-badges-and-moodle/ Open Badges and Moodle] blog post from Gavin Henrick
* [http://badg.us/en-US/ badg.us] - a service for creating and issuing badges
* [https://p2pu.org/en/groups/how-do-i-make-a-badge/ P2PU Badge Maker] - a step by step guide on how to make a badge
* [https://www.openbadges.me/ OpenBadges.me] - An open-access image creator from MyKnowledgeMap to support all of your Open Badge building needs.
* [http://moodlebadges.com/ Badges For Your Moodle] - CC-licensed badges available for free download

Forum discussions:
* [https://moodle.org/mod/forum/discuss.php?d=252377 Badges Backup Requires "Include Enrolled Users"?]

[[Category:FAQ]]

[[es:Insignias FAQ]]
[[ja:バッジFAQ]]

Activity completion FAQ

2016-09-19T09:02:04Z

Tsala: removing duplicate heading

{{Activity completion}}
==What happens when completion conditions are unlocked?==

Once you unlock options and then click 'Save changes', all completion information for the activity will be deleted and, if possible, regenerated according to the new settings. See the section 'What happens when you unlock' in [[Activity completion settings]] for further details.

==Activity completion status does not change==
Has [[Cron]] been run on the server side? Activity completion default is to be trigger by a cron event at a regular interval. The default is 10 minutes.

:Why so long a gap? My students want instant gratification and positive reinforcement they have taken another step! The update on a site can take time and resources of the server because it looks at every course, every activity, every user.

==How do I change the default time to refresh course completion reports==
Want to change the default time? This will require a code tweak at line 126 or so in the /lib/completionlib.php file. Make sure the server is sending a cron message to Moodle every 10 minutes or more often. If the server is sending a cron trigger to Moodle every 60 minutes, that will be the length of time which will pass before the change will appear.

==Can I move the activity completion checkboxes to the left instead of the right?==

[[File:checkboxleft.png]]

Please see MDL-34729 and MDL-31603

This is a not-fully tested solution, based on adapting Christian Herman's tip from Moodle 2.0 to 2.5 and discussion in https://moodle.org/mod/forum/discuss.php?d=263661
If you are using Clean or More theme, add the following to the Custom CSS box in ''Appearance>Themes>Clean' (or More)

/* Completion Checkbox Left of Activity Icon and Align Checkboxes Full Left */
.section .activity .actions { position: relative; }

.path-course-view li.activity span.autocompletion, .path-course-view li.activity form.togglecompletion
{ float: left; margin-left: -15px;}

/* Small Space Between Checkbox & Icon */
.path-course-view .section .activity img.activityicon
{ padding-left: 1em; }

[[Category:FAQ]]

[[de:Aktivitätsabschluss FAQ]]
[[es:Finalización de actividad FAQ]]

Enrolment methods

2016-09-13T04:43:40Z

Tsala: /* Managing enrolment methods */ up/down arrows applying to self enrolment

{{Course enrolment}}
==Enrolment methods==
Depending upon which enrolment methods are enabled for the site (by an administrator in ''Administration > Site administration > Plugins > Enrolments > [[Enrolment plugins|Manage enrol plugins]]''), some or all of the following are available within a course:

===Manual enrolment===
*This enables users to be enrolled manually in ''Administration > Course administration > Users > Enrolled users''.
*It allows the teacher of the course to manage individual or collective enrolment to their course themselves - for example: if a new student arrives to class unexpectedly with just a login to the site, they may be enrolled by the teacher into their course without any input from an administrator.
*See [[Manual_enrolment|Manual enrolment]] for full details of how this can work in your course.

===Self enrolment===
*This allows users to enrol themselves into a course, either directly or via an enrolment key ("course password") The teacher does not then have to manually add students.
*More than one instance of the self enrolment method can be used so that when users enrol themselves they are assigned different roles e.g. certain users can be assigned the role of student and other users can be assigned the role of non-editing teacher
*The self-enrolment method also allows for users to enrol themselves into groups by using a group enrolment key.
*See [[Self_enrolment|Self enrolment]] for full details of how this can work in your course.

===Guest access===
*This allows those with the guest role to view the contents of a course.
*Users with the "guest role" may be visitors who do not have an account on your Moodle, or users who do have an account ("authenticated users") but who would just like to explore your course.
*It is possible to add an enrolment key so that only those guest users you wish to grant access can enter the course
*Entering a course with guest access doesn't allow a user to participate in any activities; they can only view information.
*See [[Guest_access|Guest access]] for full details of how this can work in your course.

===Cohort sync===
*A cohort is a set of users which has been added either to the site as a whole or to a particular category and which can then be made available in a course through the cohort-sync enrolment plugin.
*Only an administrator or a manager can use this plugin.
*See [[Cohort_sync|Cohort sync]] for full details of how this can work in your course.

===Course meta link===
*This allows users who are in another course to be automatically enrolled into your course as well. An example might be if a Moodle site has a course for "Staff Only" and a course for "Moodle Help". If the "Staff Only" course is added to the "Moodle Help" course with the course meta link plugin, then every time a new member of staff joins the "Staff Only" course, they will automatically be enrolled in the "Moodle Help" course as well.
*Teachers can only select from courses in which they are teachers when using this method.
*See [[Course_meta_link|Course meta link]] for full details of how this can work in your course.

===PayPal===
*This allows users to pay for a course. The PayPal enrolment plugin needs to be enabled sitewide by the administrator and the plugin needs to be added to a course by the administrator or a manager.
*The course teacher can select a cost(and currency for their course) along with other course-specific requirements.
*See [[Paypal_enrolment|PayPal enrolment]] for full details of how this can work in your course.

==Managing enrolment methods==
[[Image:Enrolment methods1.png]]

Managers and teachers (and any other users with the capability [[Capabilities/moodle/course:enrolconfig|moodle/course:enrolconfig]]) can manage enrolment methods in ''Course administration > Users > Enrolment methods''.

* To add a new method, select it from the dropdown menu.
* To remove any unused enrolment method, click the delete icon (X) opposite it.
* To temporarily disable an enrolment method, click the show/hide icon (an eye) opposite it. (This ensures that the settings are remembered if the enrolment method is later re-enabled.)
* If several self-enrolment methods are enabled, the order in which they are listed for users wanting to enrol can be changed with the up/down arrows.

==See also==

* [[Enrolment plugins]]

[[de:Einschreibemethoden]]

Enrolment methods

2016-09-12T09:05:08Z

Tsala: /* Managing enrolment methods */ changing order (see MDL-55903)

{{Course enrolment}}
==Enrolment methods==
Depending upon which enrolment methods are enabled for the site (by an administrator in ''Administration > Site administration > Plugins > Enrolments > [[Enrolment plugins|Manage enrol plugins]]''), some or all of the following are available within a course:

===Manual enrolment===
*This enables users to be enrolled manually in ''Administration > Course administration > Users > Enrolled users''.
*It allows the teacher of the course to manage individual or collective enrolment to their course themselves - for example: if a new student arrives to class unexpectedly with just a login to the site, they may be enrolled by the teacher into their course without any input from an administrator.
*See [[Manual_enrolment|Manual enrolment]] for full details of how this can work in your course.

===Self enrolment===
*This allows users to enrol themselves into a course, either directly or via an enrolment key ("course password") The teacher does not then have to manually add students.
*More than one instance of the self enrolment method can be used so that when users enrol themselves they are assigned different roles e.g. certain users can be assigned the role of student and other users can be assigned the role of non-editing teacher
*The self-enrolment method also allows for users to enrol themselves into groups by using a group enrolment key.
*See [[Self_enrolment|Self enrolment]] for full details of how this can work in your course.

===Guest access===
*This allows those with the guest role to view the contents of a course.
*Users with the "guest role" may be visitors who do not have an account on your Moodle, or users who do have an account ("authenticated users") but who would just like to explore your course.
*It is possible to add an enrolment key so that only those guest users you wish to grant access can enter the course
*Entering a course with guest access doesn't allow a user to participate in any activities; they can only view information.
*See [[Guest_access|Guest access]] for full details of how this can work in your course.

===Cohort sync===
*A cohort is a set of users which has been added either to the site as a whole or to a particular category and which can then be made available in a course through the cohort-sync enrolment plugin.
*Only an administrator or a manager can use this plugin.
*See [[Cohort_sync|Cohort sync]] for full details of how this can work in your course.

===Course meta link===
*This allows users who are in another course to be automatically enrolled into your course as well. An example might be if a Moodle site has a course for "Staff Only" and a course for "Moodle Help". If the "Staff Only" course is added to the "Moodle Help" course with the course meta link plugin, then every time a new member of staff joins the "Staff Only" course, they will automatically be enrolled in the "Moodle Help" course as well.
*Teachers can only select from courses in which they are teachers when using this method.
*See [[Course_meta_link|Course meta link]] for full details of how this can work in your course.

===PayPal===
*This allows users to pay for a course. The PayPal enrolment plugin needs to be enabled sitewide by the administrator and the plugin needs to be added to a course by the administrator or a manager.
*The course teacher can select a cost(and currency for their course) along with other course-specific requirements.
*See [[Paypal_enrolment|PayPal enrolment]] for full details of how this can work in your course.

==Managing enrolment methods==
[[Image:Enrolment methods1.png]]

Managers and teachers (and any other users with the capability [[Capabilities/moodle/course:enrolconfig|moodle/course:enrolconfig]]) can manage enrolment methods in ''Course administration > Users > Enrolment methods''.

* To add a new method, select it from the dropdown menu.
* To remove any unused enrolment method, click the delete icon (X) opposite it.
* To temporarily disable an enrolment method, click the show/hide icon (an eye) opposite it. (This ensures that the settings are remembered if the enrolment method is later re-enabled.)
* To change the order in which the enrolment methods are listed, use the up/down arrows.

==See also==

* [[Enrolment plugins]]

[[de:Einschreibemethoden]]

Installing plugins

2016-06-17T07:47:32Z

Tsala: note about certain hosting solutions preventing plugins installation

{{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.}}
== 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.

==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 ''Administration > Site administration > Plugins > Install plugins''.
# Click the button 'Install plugins from Moodle plugins directory'.
# Search for a plugin with an Install button, click the Install button then click Continue.
# Check that you obtain a 'Validation passed!' message, then click the button 'Install plugin'.

===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, select the appropriate plugin type, tick the acknowledgement checkbox, then click the button 'Install plugin from the ZIP file'.
# Check that you obtain a 'Validation passed!' message, then click the button 'Install plugin'.

{|
| [[File:install add-ons.png|thumb|Install plugins]]
| [[File:add-on package validation.png|thumb|Plugin package validation]]
|}

For both of the above methods, after clicking the button 'Install plugin', you will then be automatically redirected to ''Settings > Site administration > Notifications'' and the installation process (i.e. creating required database tables etc) will happen.

===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 ''Settings > 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 ''Settings > 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.

;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===

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 the appropriate forum in [http://moodle.org/course/view.php?id=5 Using Moodle]. 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 ''(new in 2.7)'', 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.

// Use the following flag to completely disable the On-click plugin installation
// feature and hide it from the server administration UI.
//
// $CFG->disableonclickaddoninstall = true;

==See also==

* [[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]]
* [http://www.somerandomthoughts.com/blog/2013/05/07/managing-add-ons-in-moodle-2-5/ Managing add-ons in Moodle 2.5] blog post by Gavin Henrick
*[http://youtu.be/RxlmVzIllVk Moodle 2 Plugins Administration] MoodleBites video on YouTube
* [http://youtu.be/K3MYE8am7M4 Install a New Theme] MoodleBites video on YouTube

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]]

MediaWiki:MoodleDocsVersionLinks

2016-05-23T08:18:26Z

Tsala: 3.1 link

2.7 docs: /27/en/{{FULLPAGENAMEE}}
3.1 docs: /31/en/{{FULLPAGENAMEE}}
3.0 docs: /30/en/{{FULLPAGENAMEE}}
2.9 docs: /29/en/{{FULLPAGENAMEE}}

error/data/invalidrecord

2016-04-27T06:50:14Z

Tsala: description, categories

The error 'Incorrect record' is displayed when attempting to view a database activity entry which has been deleted.

[[Category:Error|Database activity module]]
[[Category:Database activity module|Error]]

MediaWiki:MoodleDocsVersionLinks

2016-01-07T14:30:28Z

Tsala: 3.0 link

2.7 docs: /27/en/{{FULLPAGENAMEE}}
3.0 docs: /30/en/{{FULLPAGENAMEE}}
2.9 docs: /29/en/{{FULLPAGENAMEE}}

Guest access

2015-12-14T08:24:27Z

Tsala: removing mention of self enrolment - thanks to Elena Ivanova for testing

{{Enrolment}}
The Guest access plugin allows users with the [[Guest_role |Guest role]] to view the contents of a course. This might be used, for example, if a Moodle site serves as a website where certain courses contain publicly available information, or else with a commercial Moodle site where courses with guest access can offers a "taster" of the kind of courses which may be purchased. (Note that the guest cannot participate in any activities; they can only view content.)

==Course settings for guest access==
*In ''Administration > Course administration > Users > Enrolment methods'', first ensure that you have added "guest access" as an enrollment method, and that it has its eye open.
*In ''Administration > Course administration > Edit settings'', scroll to "Guest access"
*Set the drop down to "Yes"
*If you wish guests to use a password to access the course then add it here.
[[File:Guestaccesscoursesettings.png]]

==Admin settings for guest access==
*In ''Administration > Site administration > Plugins > Enrolments > Manage enrol plugins'',ensure Guest access is enabled (has its eye open.) This enables Guest access.
* In ''Administration > Site administration > Plugins > Manage authentication'' set the Guest login button to Show if you want the button on the Frontpage.
* Also Guest accounts can be logged - check the ''Administration> Site administration > Server > Cleanup > Log guest access'' setting

===Default settings for guest access===
*Clicking on ''Administration > Site administration > Plugins > Enrolments > Guest access'' brings up the screen where admin can set defaults for guest access in courses.
**Clicking the 'Advanced' button next to 'Allow guest access' will hide this setting in a course and will instead display a 'Show more' link to click on to access the setting.
** Guest access can be turned on by default in all new courses and you can also:
**require each course with guest access to have a password for guests. (Note: this can confuse teachers who are not aware of the requirement.)
**use or ignore your Moodle's standard password policy for guest access passwords
**offer if needed the first letter of the password as a hint.

===Auto-login guests===
*In ''Administration > Site administration > Users > Permissions > User policies'', you can tick the box so that visitors are automatically logged in as guests when accessing a course with guest access (i.e. they don't have to click the "login as guest button".
*In ''Administration > Site administration > Plugins > Authentication > Manage Authentication'', you must have "Guest login button" set to "Show".
*In ''Administration > Site administration > Security > Site policies'' you can check "Open to Google" setting so that the Google search robot will be allowed to enter your site as a Guest. In addition, people coming in to your site via a Google search will automatically be logged in as a Guest.

==See also==

* [[Guest role]]

[[de:Gastzugang zum Kurs]]

[[es:Acceso de invitados]]

Cleanup

2015-11-25T11:04:34Z

Tsala: /* Keep logs for */ setting move

{{Server settings}}
An administrator can limit the size of certain tables in the database by setting appropriate options in ''Administration > Site administration > Server > Cleanup''.

==Delete unconfirmed users after==

If you're using [[Email-based self-registration]] users must confirm their account (complete the email registration process) within a certain time-frame. Once the time set here has passed, any account that hasn't been confirmed will be deleted. The default is 7 days.

==Delete incomplete users after==

Once users have confirmed their account, they must complete their profile within the time interval set here.

A ''complete profile'' is one where the following fields have been filled in (are not empty):
*First name
*Last name
*Email address
Just as a reference, given that the firstname, lastname and email are required fields of the [[Upload users]] module, any account created this way is automatically a complete account.

==Keep logs for==

Moodle keeps extensive logs of user activity. Eventually, however, the logs will become so large that they begin to clog your server. Limiting the length of time logs are kept for will reduce database table size. Generally, a year is enough time to keep logs for.

Note: In Moodle 2.7 onwards, this setting has been moved to the legacy log store settings in ''Site administration > Plugins > Logging > Manage log stores''.

==Disable grade history==

History tracking of changes in grades-related tables may be disabled by checking the ''disablegradehistory'' box.

==Grade history lifetime==

The length of time that the history of changes in grade-related tables is kept may be set (from 30 days to never).

Note: For users who have upgraded to Moodle 2 from 1.9, the setting 'Unsubscribe users from courses after' in Cleanup has been replaced by 'Unenrol inactive after' in [[Self enrolment]]. i.e. the setting now applies ONLY to users who self-enrolled.

==See also==

*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=87795 How do I prune mdl_log table?] forum discussion

[[eu:Garbiketa]]
[[fr:Nettoyage]]
[[ja:クリーンアップ]]
[[de:Aufräumarbeiten]]
[[es:Limpieza]]

MediaWiki:Noarticletext

2015-11-19T13:13:25Z

Tsala: version update

{{Main page}}
This page does not exist in the Moodle 2.7 documentation. You can [[:en:{{NAMESPACE}}:{{PAGENAME}}|check whether it exists in the Moodle 3.0 documentation]] or [[Special:Search/{{PAGENAME}}|search for this page title]] in other pages.

You are also welcome to [{{SERVER}}{{localurl:{{NAMESPACE}}:{{PAGENAME}}|action=edit}} create it] yourself :-)

==See also==

*[[MoodleDocs:Guidelines for contributors]]

MediaWiki:MoodleDocsVersionLinks

2015-09-28T20:21:09Z

Tsala: removing links of no longer maintained versions

2.7 docs: /27/en/{{FULLPAGENAMEE}}
2.9 docs: /29/en/{{FULLPAGENAMEE}}
2.8 docs: /28/en/{{FULLPAGENAMEE}}

Moodle migration

2015-09-15T13:27:03Z

Tsala: copying updates from 29 docs

{{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]] 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 --password=mypassword -C -Q -e --create-options mydatabasename > moodle-database.sql
</pre>

=== 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 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.

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 databse===

The one thing we have not fixed is any internal links stored in the database. To fix these use the [[Search and replace tool]] buy 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.

==See also==

* [[Site backup]]
* [[Site restore]]
* [[Backup and restore FAQ]]

Using Moodle forum discussions:
* [http://moodle.org/mod/forum/discuss.php?d=62959 Changing Moodle URL]
* [http://moodle.org/mod/forum/discuss.php?d=57477 Changing site address]
* [http://moodle.org/mod/forum/discuss.php?d=76704 Upgrading whilst migrating]
* [http://moodle.org/mod/forum/discuss.php?d=65450 Internal and external access]
* [http://moodle.org/mod/forum/discuss.php?d=111807 Migrated Moodle to New Server But Can't Login]
* [http://moodle.org/mod/forum/discuss.php?d=228436 Replace script returns "Service Unavailable"]
* [http://moodle.org/mod/forum/discuss.php?d=85812 migrating Moodle's data directory on a Windows system]

[[es:Migración de Moodle]]
[[fr:Migration de Moodle]]
[[ja:Moodle移行]]
[[de:Moodle-Migration]]

Course completion FAQ

2015-07-03T13:24:57Z

Tsala: /* Students have completed things but the report does not show it */ updated answer

{{Course completion}}
==Students have completed things but the report does not show it==

Check in ''Administration > Site administration > Server > Scheduled tasks'' that the task 'Calculate completion data' is running frequently enough, such as every minute.

==I have set up course prerequisites but my students can still access the second course before they have finished the first==
Sorry - the course prerequisites feature does NOT prevent students from accessing courses. It merely prevents the course from being marked as "complete" until they have completed another course.

==How can I prevent my students accessing course 2 before they have completed course 1?==
This is currently not possible using completion settings- see MDL-22648 .The usual workaround is to add a final activity at the end of course 1 - such as a quiz - inside which you give the enrolment key to the next course (in the quiz feedback for example) Thus, only those who have completed course 1 can get access to course 2. That doesn't stop them sharing the key however, but you could see any cheaters in the logs.

==I made a mistake and had to erase my student data. Do my students have to redo the activities?==
No. For example, if you set the course completion for All aggregation methods and wanted to reset it to "Any", Moodle will warn you that you are deleting compiled student data. It will delete the student data only for the course completion information. When cron.php runs it will recompile the course completion information.

==My student got an error message when they click on more information in the course completion block==
Moodle is confused by your course completion settings. This may happen at the start of the course when the student has not completed an activity and/or you have selected an aggreation method of All and have not checked off that they have completed the activity.

==Where do my students tell me they have finished the course?==
Did you install the [[Self completion block]]? When they click on the link in that block, that will indicate they think they are done. You will have to wait for [[Cron]] to run before seeing the results in your course completion report.

==How can I set my course completion to be longer than 30 days after enrolment?==
Currently the dropdown menu only allows you to choose from up to 30 days after enrolment. There is a tracker entry about this here MDL-34678. However, if you are happy editing the database then you can manually change the value. (Thanks to Aaron Barnes for the following instructions)

You'll need to look in the mdl_course_completion_criteria table. The Duration After Enrolment criteria will have the "criteriatype" value of 5 and the number of days is recorded in the column "enrolperiod" in seconds (so #days x 86400). You should be able to adjust the enrolperiod value and after the next cron run everything will use the new value.
==See also==

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=184602 Confused how Completion.... err.... completes]
*[http://moodle.org/mod/forum/discuss.php?d=194747 How to set course completion requirements to include a minimum quiz grade?]

[[Category:FAQ]]

[[de:Kursabschluss FAQ]]
[[es:Finalización del curso FAQ]]

error/moodle/dmlwriteexception

2015-07-01T06:35:09Z

Tsala: MySQL dmlwriteexception error when restoring a course

Backup and restore FAQ

2015-07-01T06:32:04Z

Tsala: MySQL dmlwriteexception error when restoring a course

{{Backup}}
==How do I backup a course?==

See [[Course backup]] and [[Automated backup setup]].

==How do I restore a course?==

See [[Course restore]].

==How do I backup my site?==

See [[Site backup]].

==What are the pros and cons of course versus site backups?==

[[Site backup|Site backups]] are recommended in order to have all data saved with the best confidence and the shortest recovery time.

For a site administrator, [[Automated course backup|automated course backups]] are more expensive in terms of time, CPU usage and storage. The recovery time to have a site running again takes longer than a site backup. However, teachers and site administrators might find a course backups as a way to create a "fresh" copy of a course that can be re-used (in older versions of Moodle, in newer versions see [[Import course data]]) or as a method to distribute a course(s) to other Moodle sites.

==Why is my automated course backup much smaller in size than my manual course backup?==

This is an intentional design decision. Because of the way files are stored in Moodle 2.x, there is no need to include the files in the backup if you are planning to restore them to the same Moodle site. Leaving them out saves huge amounts of disk space and makes the backup procedure much faster.

==What data is not contained in course backups?==

By selecting all the options when setting up the backup you can include almost all the data in the course. However you should be aware of the fact that some things are not backed up:
* Quiz questions are only backed up if at least one question from their category has been added to a quiz.
* Scales are only backed up if they are used by at least one activity.
* Users' passwords are not backed up when the "Include enrolled users" option is selected.

==The process ends with: "Error: An error occurred deleting old backup data". What should I do?==

This part of the backup (or restore) procedure tries to delete old info, used in previous executions, performing the following tasks:

# Delete old records from "backup_ids" table: Check the table exists, repair it and try again.
# Delete old records from "backup_files" table: Check the table exists, repair it and try again.
# Delete old files from "moodledata/temp/backup": Delete the dir completely and try again.

[[Image:BackupProblem.gif|thumb|Backup error message]]For points 1 & 2, there are various ways of repairing tables, including using MySQL Admin.
For point 3 see below:

The error message states that the "directory not empty" and gives the path to that directory. If you go there with an FTP program you can see what is there and clean up. It could be just some empty subfolders that were leftover. Deleting these has been able to help. One can also delete the dir "moodledata/temp/backup" completely. That can take a bit longer but may solve several problems at once.

==The process ends with: "XML error: not well-formed (invalid token) at line YYYY". What can I do?==

This problem can appear at any point in the restore process. It's caused when the XML parser detects something incorrect in the backup file that prevent correct operation. Usually, it's caused by some "illegal" characters added in the original course due to some copy/paste of text containing them (control characters, or invalid sequences...).

The best method to handle this issue is:

* Unzip the problematic backup file under one empty folder.

* Open the moodle.xml with Firefox. It will show you where (exact char) the problem is happening.

* Edit the moodle.xml file with some UTF8-compatible editor and delete such characters. Save changes.

* Test the moodle.xml file again with Firefox until no error was displayed.

* Zip everything again (all the folder contents but not the folder itself!).

* Restore the course. It should work now.

* Restore still not working? See the next question.

Also, if possible, it's highly recommended to solve those problems in the original course too from Moodle itself. Once "repaired" there, problems will be out if you create new backup files in the future.

==The process ends with: "moodle xml not found at root level of zip file". What can I do?==
If you are restoring from a zip file backup make sure the moodle.xml file is at the root level. To ensure this:
#Unzip the backup file of the course (example: mycourse.zip)
#Once the file is unzipped, open the folder (example: mycourse).
#Select the folders within the mycourse folder AND the moodle.xml file and create a zip of those item (example: mycourse_new.zip)
#Upload the new zip file (example: mycourse_new.zip) and restore from that.

If the backup file is guaranteed to be correct, check paths to external files (zip, unzip). Incorrect settings also lead to this error message (see the Using Moodle forum discussion [http://moodle.org/mod/forum/discuss.php?d=140355 moodle.xml not found in root...] and MDL-14812).

==The process ends with: "An error occurred while copying the zip file..."==

This problem is most likely caused by a permissions issue in the destination directory. Backup files are copied to "XXX/backupdata" under your dataroot directory (where XXX is the id of the course being backed up).

The problem could also be caused by a disk being full, though this is far less likely.

To obtain precise information about what's happening, you can enable debug messages in ''Administration > Server > [[Debugging]]'' (select the maximum level - DEVELOPER) and/or check the web server error logs.

==I Still get an XML error. How can I clean the borked XML file?==

In some cases XML backup files may contain characters causing the restore process to abort, even after the steps described in the previous question. In such cases you may want to try the following:

* Download the [http://repository.atlassian.com/atlassian-xml-cleaner/jars/atlassian-xml-cleaner-0.1.jar Atlassian XML Cleaner Utility] from the [http://confluence.atlassian.com/display/JIRA/Removing+invalid+characters+from+XML+backups JIRA Atlassian site].

* Unzip the problematic Moodle backup file under one empty folder. Moodle will create the course file folders as long as the unclean moodle.xml file. Please unzip using the Moodle unzip feature.

* Rename the unclean moodle.xml file to moodle-unclean.xml.

* If you don't have access to your Moodle server's command prompt, using the Moodle zip feature, zip the moodle-unclean.xml file only, download the zip file locally and unzip it. It is very important to download the xml file in zipped format to avoid unwanted character encoding when transferring from an operating system to another.

* Move the downloaded Atlassian XML Cleaner Utility in the same folder where is your moodle-unclean.xml file.

* Issue the following command from the command prompt:

java -jar atlassian-xml-cleaner-0.1.jar moodle-unclean.xml > moodle.xml

* If you launched the utility on your local computer, zip the just created (and hopefully cleaned) moodle.xml file and upload it in the same place from where you downloaded the moodle-unclean.xml file. Once uploaded, unzip it using the Moodle unzip feature.

* Zip everything again (all the folder contents but the folder itself!).

* Restore the course. It should work now.

==What does "Some of your courses weren't saved!!" mean?==

There are three possible causes of this problem:
# Error - this happens when the backup procedure has found an error and so hasn't finished the backup of a particular course. These are "controlled" errors and the scheduled backup continues with the next course.
# Unfinished - this happens when the backup procedure dies without knowing why. When the cron is next executed it detects that the last execution went wrong, and continues skipping the problematic course. A possible solution would be to raise the PHP/Apache limit in your installation (memory, time of execution...). By taking a look to your log tables you should be able to see if the "crash" is happening at exact time intervals (usually a problem with the max_execution_time php's variable), or if there is some exact point were all the courses are breaking.
# Skipped - this happens when a course is unavailable to students and has not been changed in the last month (31 days). This isn't an error situation - it's a feature, especially useful for sites with many unavailable old courses, saving process time.

==Why are some courses being skipped?==

[[Image:autobackup_skip_settings.png|thumb|AutoBackup '''skip''' settings]]Moodle's ''Course backups'' routines are instructed to automatically skip courses based on three settings in ''Administration > Site administration > Courses > Backups > Automated backup setup.'' The Moodle administrator(s) use those settings to specify whether to ''Skip hidden courses'' (set by default to 'Yes'), ''Skip courses not modified since'' (set by default to '30 days'), and ''Skip courses not modified since previous backup'' (set by default to 'No'). A course which meets any of the enabled criteria will be skipped during the next run of ''Course backups''.

==Why does restore stop, rather than completing?==

Attempting to restore a course to an older version of Moodle than the one the course was backed up on can result in the restore process failing to complete. To ensure a successful restore, make sure that the version of Moodle you are restoring the course to is the same, or newer, than the one the course was backed up on.

If it stop unexpectedly with no errors shown try again with [[Debugging]] switched on. Any errors you now see can help experts in the support forums diagnose your problem. You can also check the discussion links in the See also section below for further advice.

==Restore stops with the message "Trying to restore user xxxx from backup file will cause conflict"==

[[Image:Moodle 2.0 Restore breaks.png|thumb|Error message in Moodle 2.0]]

This message is displayed when:

# The target site has a user xxxx (xxxx being the username)
# The backup archive being restored also contains a user xxxx (same username)
# After various comparisons, Moodle has determined that the target site user xxxx and the backup user xxxx aren't the same person.

If 1, 2 and 3 are all true, the restore process stops in order to prevent the backup user xxxx's activities (forum posts, quiz attempts, assignment uploads, etc) from being associated with the target site user xxxx.

These checks and behaviour were introduced in Moodle 1.9.x and continue being valid under 2.0. It's common for the user in question to be the "admin" user (which exists in practically all Moodle installations).

There are two possible methods to make the xxxx users match (and avoid the conflict):

a) Modify the backup archive '''users.xml''' file and make the ''email'' or ''firstaccess'' fields match the ones in target site. 
b) Modify the '''target site''' and set the user ''email'' or ''firstaccess'' fields to match the ones in backup archive users.xml file.

Method a) is recommended so the restore process will match both xxxx users and all activities in the backup file belonging to xxxx will be associated to the already existing target site user xxxx user.

'''NOTE:''' When using method a) be aware that the ''moodle-filename-backup.'''mbz''''' is a zip file and can be renamed to ''moodle-filename-backup.'''zip''''' and unzipped.
When editing is complete, rezip and then rename using the original file name with the "*.mbz" extention.

==Why are certain course links broken in a restored course?==

Inter-activity links must be absolute (full) URLs e.g. <code><nowiki>http://site.com/mod/resource/view.php?id=xxx</nowiki></code> in order to be processed properly during backup and restore.

Any relative URLs e.g. <code>/mod/resource/view.php?id=xxx</code>, <code>../resource/view.php?id=xxx</code> or <code>view.php?id=xxx</code> will result in broken links when the course is restored.

==Restoring a course results in broken HTML tags. What can I do?==
This has been known to be caused by older versions of libxml2 and PHP - try updating them to the latest versions.

==I have a very large course, over 2GB, and the backup process stops.==

Courses over 4GB cannot be backed up without turning on an experimental option. See 'New backup format' below.

Below that size, large courses can be restored in Moodle, but sometimes it needs a bit of tweaking to get it right. Moodle backup files are *.mbz fies and can be renamed to zip files. They can be unzipped, then edited, rezipped and restored. It does not matter if you are using a Linux or Windows or Mac server, a local host or anything else, the technique is the same.

The editing comes in two different ways, one is the resources, activities, quizzes, images. video files and so on are listed, written and referred to in the moodle.xml file. You can find the starting point and the end point of each resouce that you can delete out of the xml file.

The xml might look something like this:
<file id="111"> <contenthash>b11ac9bc0cebee17acfd28d13b548331f76645bc</contenthash>
<contextid>21</contextid>
<component>mod_resource</component>
<filearea>content</filearea>
<itemid>0</itemid>
<filepath>/</filepath>
<filename>howtomakeatimemachine.flv</filename>
<userid>4</userid>
<filesize>1092320586557</filesize>
<mimetype>video/flv</mimetype>
<status>0</status>
<timecreated>12345432123</timecreated>
<timemodified>12345432123</timemodified>
<source>howtomakeatimemachine.flv</source>
<author>Fred Nurks</author>
<license>allrightsreserved</license>
<sortorder>0</sortorder>
<repositorytype>$@NULL@$</repositorytype>
<repositoryid>$@NULL@$</repositoryid>
<reference>$@NULL@$</reference>
</file>

When editing, make sure all this is deleted, everything between the <file></file> tags.

The second part of editing is locating the actual resouce if it is an image, a separate file or video then deleting it. Really large mbz files tend to have a lot of videos, often flv files, or uncompressed images, like tiffs. They can be found, and deleted easily, in the directory tree of the backup.

You can then rezip the edited file, rename it to an mbz and, if you have edited it right, it should restore. You can use the original file to break down really large backups over and over into four or five smaller mbz files, as many as you like.

It is recommended that you test the technique first on a smaller file, it is easier to follow and gets you used to xml structuring and so on. Say one course with a couple of pages, a number of different image types, a couple of videos will help you immensely.

You do not have to worry about permissions in Windows or Xos servers, or concern yourself with editing rights usually. However, you may be required to ensure you are the owner fo the files being edited.

'''NOTE:''' Before re-zipping, check to make sure you have removed all references to the pages/files/resources you have deleted in the moodle-backup.xml file as well. here msay be none, but check anyway.

== Using the new backup format (experimental) ==

If you have large courses you may find it useful to turn on an experimental option introduced in Moodle 2.6, 'Enable new backup format' (on the admin menu under Development/Experimental/Experimental settings).

This option selects a different internal backup format. Without this option, you cannot back up courses larger than 4GB.

You can change this option at any time. Whatever the option is set to, restore works for both the old and new format. The option only affects newly-created backups.

When you use this option, backup files still have the .mbz extension and work the same way, but there are some differences:

* There is no limit on total backup size. (We have tested with courses up to about 10GB.)
* Files may be slightly smaller.
* If you need to edit this type of backup file manually, you will need to rename the .mbz file to .tar.gz, instead of .zip. You may need to use different software to extract and recompress this type of file. We have tested using GNU tar on Windows and Linux.

The new backup format is experimental, but is being used in some large sites and may be enabled as default in a future Moodle version. If you find problems with it, please report them in the Moodle tracker.

==How can I extract original files from a Moodle backup file?==
If you really want to get original files from the backup file (an ".mbz" file) you downloaded (using the backup and restore feature), you can do so in much the same way as is suggested above.

The backup file can actually be opened with any zip/unzip program you can download. Once you open the file, you need to extract:

The files.xml file.
The files directory (folder).

Next step would be to open the "files.xml" file in a text editor, and:

Search for the name of each file you want to get.
Take note of the value of the corresponding contenthash tag.
In the "files" folder you extracted, locate the file whose name is the same as the value of the contenthash and which will always be located in a folder whose name corresponds to the two first characters of the file name.

For example, let's assume there is a "backup_courses-120730.mbz" file of which the "files.xml" file and the "files" folder have been extracted. There is a PDF file named "Leadership.pdf" that is required for another purpose.

Open the files.xml file and:

1. Search for the string "Leadership.pdf", which in this case is found under the following <file id...> group tag:

<file id="12345">
<contenthash>fb6cf43a9b2d432403c70a2cb4c340dbb6225631</contenthash>
:
<filename>Leadership.pdf</filename>
:
<license>allrightsreserved</license>
<sortorder>1</sortorder>
</file>

2. Take note of the corresponding contenthash value: fb6cf43a9b2d432403c70a2cb4c340dbb6225631.

3. As the first two characters of the contenthash are "fb", open the "fb" folder inside the "files" directory (which was previously extracted), and there is a file named "fb6cf43a9b...". Rename that file as "Leadership.pdf", and then move it to another location. Repeat this for all the files required, using the correct contenthash value of course.

==What happens if I restore a backup containing an assignment from Moodle 2.2 and older?==

The assignment activity module was completely rewritten in Moodle 2.3. Thus, assignments from Moodle 2.2 and older (e.g. from Moodle 1.9) need to be upgraded in order to continue being usable. See the section 'Restoring course backups from Moodle 2.2 and older' in [[Assignment upgrade tool]] for details of what to do.

==MySQL dmlwriteexception error when restoring a course==

If you obtain a dmlwriteexception error when restoring a course, it is recommended that InnoDB tables are converted to the Barracuda file format. See the section 'Converting InnoDB tables to Barracuda' in [[Administration via command line]] for details of why this is recommended plus information on a tool for converting tables.

== See also ==

*Using Moodle [http://moodle.org/mod/forum/view.php?f=128 Backup and Restore forum]
*[http://www.databasejournal.com/features/mysql/article.php/10897_3300511_2 databasejournal.com article on repairing database corruption in MySQL]
* [[Site backup]]
* [[Moodle migration]]
* [[Beginning Moodle 2.0 Administration]]

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=142720 Trying to restore user 'admin' from backup file will cause conflict]
*[http://moodle.org/mod/forum/discuss.php?d=167471 Where is the Moodle 2.0 "Course Backup Filearea"?]

[[Category:FAQ]]

[[es:Respaldo y restauración FAQ]]
[[pl:Backup FAQ]]
[[fr:FAQ de sauvegarde]]
[[ja:バックアップFAQ]]
[[pt:FAQ sobre cópias de segurança]]
[[de:Sicherung und Wiederherstellung FAQ]]

Administration via command line

2015-07-01T06:30:49Z

Tsala: /* Converting InnoDB tables to Barracuda */ copying changes from 28 docs

{{Installing Moodle}}
==Running CLI scripts==
If you have shell access to your web server, you may find various CLI (command line interface) scripts useful during Moodle administration. Core admin CLI tools are located in the <code>admin/cli/*</code> folder. Other plugins provide their CLI functionality via scripts in their own cli folder. For example, the enrol_db sync script is located in <code>enrol/db/cli/</code>.

To avoid problems with access control, you should run them as the owner of the web server process. It is especially important for CLI installation and upgrade as they create new files in moodledata directory and the web server has to have write access to them. In Linux distributions, the user that runs the web server is usually apache or wwrun or httpd or something similar. As a root, you will probably want to execute Moodle CLI scripts like this:

$ cd /path/to/your/moodle/dir
$ sudo -u apache /usr/bin/php admin/cli/somescript.php --params

Most of the scripts accept common --help (or -h) parameter to display the full usage information, for example:

$ sudo -u apache /usr/bin/php admin/cli/install.php --help

== Upgrading ==

Moodle can be upgraded from the command line. As with the installation script, there is either interactive or non-interactive mode of the upgrade. The script itself does not put the site into the maintenance mode, you have to do it on your own. Also, the script does not backup any data (if you read this page, you probably have some own scripts to backup your moodledata and the database, right?)

$ sudo -u apache /usr/bin/php admin/cli/upgrade.php

Upgrading via command line is a very comfortable way of Moodle upgrade if you use Git checkout of the Moodle source code (see [[Git for Administrators]]). See the following procedure how to upgrade your site within several seconds to the most recent version while preserving your eventual local customizations tracked in git repository:

$ cd /var/www/sites/moodle/htdocs/
$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --enable
$ git pull
$ sudo -u apache /usr/bin/php admin/cli/upgrade.php
$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --disable

== Installation ==

There are two modes of installing Moodle from the command line. In interactive mode, the install script asks you for all data needed to properly set up new Moodle site. In non-interactive mode, you must provide all required data as the script parameters and then the new site is installed silently. The parameters can be passed in the interactive mode, too. The provided values are then used as the default values during the interactive session.

$ sudo -u apache /usr/bin/php admin/cli/install.php --lang=cs

== Maintenance mode ==

To switch your site into the maintenance mode via CLI, you can use

$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --enable

To turn maintenance mode off, just execute the same script with --disable parameter.

== Offline mode ==

In some situations, you may want to switch your Moodle site into offline mode so that it is not accessible via the web but you can not stop the web server completely (typically because there are other web pages and applications running there). If a file called <code>climaintenance.html</code> exists in the root folder of moodledata directory, Moodle will automatically display the contents of that file instead of any other page.

$ cd /var/www/sites/moodle/moodledata/
$ echo '<h1>Sorry, maintenance in progress</h1>' > climaintenance.html

You can prepare a nice formatted HTML page to inform your users about the server being down and keep in the moodledata directory under a name like <code>climaintenance.off</code> and rename it to the <code>climaintenance.html</code> if needed.

== Custom site defaults ==

During the install and upgrade via CLI, Moodle sets the administration variables to the default values. You can use different defaults. See MDL-17850 for details. Shortly, all you need to do is to add a file <code>local/defaults.php</code> into your Moodle installation. The format of the file is like

<code php>
<?php
$defaults['pluginname']['settingname'] = 'settingvalue'; // for plugins
$defaults['moodle']['settingname'] = 'settingvalue'; // for core settings
</code>

These defaults are used during install, upgrade and are also displayed as defaults on Site administration pages.

== Reset user password ==

If you happen to forget your admin password (or you want to set a password for any other user on the site), you can use reset_password.php script. The script sets the correctly salted password for the given user.

$ sudo -u apache /usr/bin/php admin/cli/reset_password.php

== MySQL storage engine conversion ==

If you run your Moodle site with MySQL database backend and use the default MyISAM as the storage engine for your tables, you may want to convert them to use some more reliable engine like InnoDB (actually, you should want to switch to PostgreSQL ;-) anyway).

$ sudo -u apache /usr/bin/php admin/cli/mysql_engine.php --engine=InnoDB

==Converting InnoDB tables to Barracuda==

Sites using MySQL with database tables using Antelope as the file format are recommended to convert the tables to the Barracuda file format.

This is because tables using Antelope as the file format cannot handle more than 10 text columns. This file formats only supports ''compact'' and ''redundant'' row formats for backward compatibility reasons. This may cause a problem on larger sites when restoring a course, in which case the following error will be displayed:

Row size too large (>8126). Changing some columns to TEXT or BLOB or using ROW_FORMAT=DYNAMIC or ROW_FORMAT=COMPRESSED may help.

Barracuda is the newest innoDB file format. In addition to supporting ''compact'' and ''redundant'' row formats, Barracuda also supports ''compressed'' and ''dynamic'' row formats.

However, converting tables to Barracuda is only recommended, and not required, since not all MySQL users are affected. (It may only be a problem for larger sites.)

===Tool for converting tables===

A command line tool is included in Moodle for converting tables to Barracuda.

To view tables requiring conversion, use the list option:

$ php admin/cli/mysql_compressed_rows.php --list

Here is an example output:

mdl_data Compact (needs fixing)
mdl_data_fields Compact (needs fixing)
mdl_enrol_paypal Compact (needs fixing)

To proceed with the conversion, run the command using the fix option:

$ php admin/cli/mysql_compressed_rows.php --fix

Successful table conversion will be reported in the output, for example:

mdl_data ... Compressed
mdl_data_fields ... Compressed
mdl_enrol_paypal ... Compressed

Please note that the commands must be executed on your moodle directory. Once tables are fixed, the warning message will no longer be displayed.

For further information on InnoDB file formats see the [http://dev.mysql.com/doc/innodb/1.1/en/glossary.html#glos_antelope MySQL InnoDB glossary - Antelope] and the [http://dev.mysql.com/doc/innodb/1.1/en/glossary.html#glos_barracuda MySQL InnoDB glossary - Barracuda].

== Running cron via command line ==

In versions 1.x, you could execute admin/cron.php either from command line or via the web. Since Moodle 2.0, only admin/cli/cron.php script can be run via command line.

== Scheduled tasks ==

Scheduled tasks are automatically run by the cron script, but the specific tasks which run on each cron iteration are determined by the scheduled tasks configuration. It is possible to override the scheduled tasks configuration and run a single scheduled task immediately using the admin/tool/task/cli/schedule_task.php script.

This script accepts the following arguments:

--list - list all the known scheduled tasks. The tasks are listed by the class name used to run the task. This class name is required as the argument to the next option in order to run a specific task immediately.

--execute=<task> - Runs a single scheduled task immediately - regardless of scheduling settings. This will even run disabled tasks. Tasks will still use locking to prevent concurrent execution of the same task - even on clusters. The format of the <task> argument must be the same as returned by the --list option above.

'''Note:''' You must escape the "\" with an extra \ when using the --execute command. Take the following for example:

<pre>php schedule_task.php --list</pre>

will return something like:

<pre>
== List of scheduled tasks (http://yourserver.com/moodle) ==
\enrol_imsenterprise\task\cron_task 10 * * * * * ASAP
\logstore_legacy\task\cleanup_task * 5 * * * * ASAP
\logstore_standard\task\cleanup_task * 4 * * * * Wednesday, November 12, 2014, 4:35 AM
\mod_forum\task\cron_task * * * * * * ASAP
\core\task\automated_backup_task 50 * * * * * ASAP

...
</pre>

To run the first task in that list, you would execute

<pre>php schedule_task.php --execute=\\enrol_imsenterprise\\task\\cron_task</pre>

==Database transfer==

A command line script for [[Database transfer]] may be found in ''admin/tool/dbtransfer/cli/migrate.php''.

==Purge caches==

You can purge caches using this script:

php admin/cli/purge_caches.php

==Fix course / module sequences==

In rare cases (such as after upgrading from a very old version of Moodle), the course / section / module sequence data can be out of sync. This can cause various problems for affected courses, such as sections not appearing, backups failing, pages not displaying etc. There is a specific check to check for errors caused by this problem, and to fix the data in the database if they are found. To run this script please use the command below:

php admin/cli/fix_course_sequence.php -c=* --fix

This will check every course in Moodle and report which ones had errors and were fixed.

==See also==

* MDL-35736 - Manage plugins via command line
* MDL-36237 - Resort course list via CLI

[[fr:Administration en ligne de commande]]
[[de:Administration über Kommandozeile]]
[[ja:コマンドライン経由の管理]]
[[es:Administración por línea de comando]]

Upgrading

2015-07-01T06:28:31Z

Tsala: /* Possible issues that may affect you in Moodle 2.7 */ MySQL dmlwriteexception error when restoring a course

{{Installing Moodle}}
''This page explains in detail how to upgrade Moodle. For a summary of the process, see [[Upgrade overview]].''

==Check the requirements==

Check that your server meets all requirements for 2.7 in ''Administration > Site administration > Server > [[Environment]]''.

Note: You can only upgrade to Moodle 2.7 from Moodle 2.2 or later. If upgrading from earlier versions, you must [https://docs.moodle.org/22/en/Upgrading_to_Moodle_2.2 upgrade to 2.2] as a first step.

==Before upgrading==

'''We advise that you test the upgrade first on a COPY of your production site, to make sure it works as you expect.'''

===Themes===

All standard themes present in Moodle 2.6 (and earlier), except the Clean theme, have been removed from Moodle 2.7 (see MDL-43784). Custom themes and themes from the Plugins Directory are not affected, unless they use one of the removed themes as a parent theme. If a theme that was in use has been removed, the theme will revert to the new default theme called Clean.

For sites wishing to continue using any of the removed standard themes (or themes relying on a standard theme as a parent theme), other than Clean, we recommend you use the following process.

# Download the 2.7 version of Moodle, but do not run the upgrade yet.
# Download the 2.7 version of your theme from the [https://moodle.org/plugins/browse.php?list=category&id=3 Themes section of the Moodle plugins directory] (or from the links below) into moodle/theme/.
# Proceed with the upgrade.

It is possible to copy missing themes into Moodle after the upgrade, but this should happen before users touch the system, otherwise theme-related settings may be lost.

The affected themes (with download links) are...

{|-
| Afterburner
| [https://moodle.org/plugins/view.php?plugin=theme_afterburner plugins db]
| [https://github.com/moodlehq/moodle-theme_afterburner github]
|-
| Anomaly
| [https://moodle.org/plugins/view.php?plugin=theme_anomaly plugins db]
| [https://github.com/moodlehq/moodle-theme_anomaly github]
|-
| Arialist
| [https://moodle.org/plugins/view.php?plugin=theme_arialist plugins db]
| [https://github.com/moodlehq/moodle-theme_arialist github]
|-
| Binarius
| [https://moodle.org/plugins/view.php?plugin=theme_binarius plugins db]
| [https://github.com/moodlehq/moodle-theme_binarius github]
|-
| Boxxie
| [https://moodle.org/plugins/view.php?plugin=theme_boxxie plugins db]
| [https://github.com/moodlehq/moodle-theme_boxxie github]
|-
| Brick
| [https://moodle.org/plugins/view.php?plugin=theme_brick plugins db]
| [https://github.com/moodlehq/moodle-theme_brick github]
|-
| Formal White
| [https://moodle.org/plugins/view.php?plugin=theme_formal_white plugins db]
| [https://github.com/andreabix/moodle-theme_formal_white github]
|-
| Form Factor
| [https://moodle.org/plugins/view.php?plugin=theme_formfactor plugins db]
| [https://github.com/moodlehq/moodle-theme_formfactor github]
|-
| Fusion
| [https://moodle.org/plugins/view.php?plugin=theme_fusion plugins db]
| [https://github.com/moodlehq/moodle-theme_fusion github]
|-
| Leatherbound
| [https://moodle.org/plugins/view.php?plugin=theme_leatherbound plugins db]
| [https://github.com/moodlehq/moodle-theme_leatherbound github]
|-
| Magazine
| [https://moodle.org/plugins/view.php?plugin=theme_magazine plugins db]
| [https://github.com/moodlehq/moodle-theme_magazine github]
|-
| Nimble
| [https://moodle.org/plugins/view.php?plugin=theme_nimble plugins db]
| [https://github.com/moodlehq/moodle-theme_nimble github]
|-
| Nonzero
| [https://moodle.org/plugins/view.php?plugin=theme_nonzero plugins db]
| [https://github.com/moodlehq/moodle-theme_nonzero github]
|-
| Overlay
| [https://moodle.org/plugins/view.php?plugin=theme_overlay plugins db]
| [https://github.com/moodlehq/moodle-theme_overlay github]
|-
| Serenity
| [https://moodle.org/plugins/view.php?plugin=theme_serenity plugins db]
| [https://github.com/moodlehq/moodle-theme_serenity github]
|-
| Sky High
| [https://moodle.org/plugins/view.php?plugin=theme_sky_high plugins db]
| [https://github.com/moodlehq/moodle-theme_sky_high github]
|-
| Splash
| [https://moodle.org/plugins/view.php?plugin=theme_splash plugins db]
| [https://github.com/moodlehq/moodle-theme_splash github]
|-
| Standard
| [https://moodle.org/plugins/view.php?plugin=theme_standard plugins db]
| [https://github.com/moodlehq/moodle-theme_standard github]
|-
| Standard old
| [https://moodle.org/plugins/view.php?plugin=theme_standardold plugins db]
| [https://github.com/moodlehq/moodle-theme_standardold github]
|}

Note: Only installed additional themes are updated automatically during the upgrade, NOT standard themes. Because standard themes have been removed from Moodle 2.7, they have to be re-added.

===Questions engine upgrade===

In Moodle 2.1, there was a major overhaul of the Question engine. As explained in [https://docs.moodle.org/21/en/Upgrading_to_Moodle_2.1#Planning_the_question_engine_upgrade the upgrade documentation for that version], it was possible to delay parts of the database upgrade to be run later. Before you upgrade to Moodle 2.7, this upgrade must be completed.

This will affect you if...
* your site started off on a version of Moodle 2.0.x and
* when you upgraded to Moodle 2.1 or 2.2, you made use of the complex facility to delay part of the question engine upgrade (as explained in [https://docs.moodle.org/21/en/Upgrading_to_Moodle_2.1#Planning_the_question_engine_upgrade the upgrade documentation for that version]) and
* you still have not completing that upgrade
...then you must complete it before upgrading to Moodle 2.7.

You can check by looking at the bottom of the [[:en:Environment|Environment]] page in your site, providing you are running a version later than 2.4.9, 2.5.5 or 2.6.2. If you have a problem, it will tell you there. If there is no mention of questions there, you can forget about this.

This is unlikely to affect most users.

== Backup important data ==

There are three areas that should be backed up before any upgrade:
#Moodle software (For example, everything in server/htdocs/moodle)
#Moodle uploaded files (For example, server/moodledata)
#Moodle database (For example, your Postgres or MySQL database dump)

See [[Site backup]] for more specific information.

==Put your site into maintenance mode==
Before you begin upgrading your site, you should put it into [[Maintenance_mode | maintenance mode]] to stop any non-admin users from logging in.

== Check for plugin updates ==

If you have [[Automatic updates deployment]] enabled, you will be able to update installed plugins automatically during the upgrade. Just make sure you check for available updates (via the button for it) at the Plugins check screen.

If you are updating plugins manually, it is a good moment now to check in the [http://moodle.org/plugins Moodle Plugins directory] whether there is a 2.7 version available for any plugins (including themes) that you have previously installed on your site. If so, download the plugin package. In the next step, you will copy it to the appropriate location in your Moodle code (see [[Installing plugins]]).

The upgrade of the plugin will then happen as part of the Moodle upgrade process.

If an out-of-date plugin causes your upgrade to fail, you can usually delete the plugin code rather than uninstalling it from within Moodle so that the data associated with it is not deleted.

== Install the new Moodle software ==

=== Standard install package ===

# Move your old Moodle software program files to another location. ''Do NOT copy new files over the old files.''
# Unzip or unpack the upgrade file so that all the new Moodle software program files are in the location the old files used to be in on the server. Moodle will adjust SQL and moodledata if it needs to in the upgrade.
# Copy your old [[Configuration file|config.php file]] back to the new Moodle directory.
# As mentioned above, if you had installed any plugins on your site you should add them to the new code tree now. It is important to check that you get the correct version for your new version of Moodle. Be particularly careful that you do not overwrite any code in the new version of Moodle.
# Dont forget to also copy over your moodledata folder / directory. If you don't you will get a "fatal error $cfg- dataroot is not configured properly".

====Linux====
mv moodle moodle.backup
tar xvzf moodle-2.7.tgz

Next, copy across your config.php, any custom plugins, and your .htaccess file if you created one ('''check that custom plugins are the correct version for your new Moodle first'''):

cp moodle.backup/config.php moodle
cp -pr moodle.backup/theme/mytheme moodle/theme/mytheme
cp -pr moodle.backup/mod/mymod moodle/mod/mymod

Don't forget to make moodle/config.php (and the rest of the source code) readable by your www server. Ideally the files should not be writeable by your server.

If you use cron, take care that cron.php is executeable and uses the correct php command:
chmod 740 admin/cli/cron.php (some configurations need chmod 750 or chmod 755)
copy the first line from cron.php (if it looks like '#!/usr/local/bin/php' or '#!/usr/local/bin/php5.3', no need to copy '<?php')

if necessary.

=== Using Git ===

You can use Git for updating or upgrading your Moodle. See [[Git for Administrators]] for details.

===Command line upgrade===

On Linux servers, Moodle 2.7 supports running the [[CLI|upgrade from the command line]], rather than through a web browser. This is likely to be more reliable, particularly for large sites.

== Finishing the upgrade ==

The last step is to trigger the upgrade processes within Moodle.

To do this just go to ''Administration > Site administration > Notifications''.

Moodle will automatically detect the new version and perform all the SQL database or file system upgrades that are necessary. If there is anything it can't do itself (very rare) then you will see messages telling you what you need to do.

Assuming all goes well (no error messages) then you can start using your new version of Moodle and enjoy the new features!

Note: If you are running multiple servers then you should purge all caches manually (via ''Administration > Site administration > Development > Purge all caches'') after completing the upgrade on all servers.

===Fatal error: Maximum execution time of 30 seconds exceeded...===

If your server uses a main language other than English, you may encounter a 'Fatal error: Maximum execution time of 30 seconds exceeded' when you try to upgrade it. You can increase max_execution_time = 160 on php.ini to allow the scripts enough time to process the language update. Otherwise, you can switch to English as the default language before doing the upgrade and back to your original language after a succcessful upgrade. See the forum discussion at https://moodle.org/mod/forum/discuss.php?d=119598.

==After upgrading==

The config.php file from your installation should work fine but if you take a look at config-dist.php that came with Moodle 2.7 there are more/different options available (e.g. database drivers and settings). It's a good idea to map your old config.php settings to a new one based on the 2.7 config-dist.php.

===Cron===

Cron has received a major update (MDL-25499) and now has support for both scheduled and adhoc tasks.

The benefits of these changes are:
* The schedule for every task can be configured by the admin
* Tasks can run in parallel
* Cron processes use locking to prevent the same task running at the same time by different processes
* Clusters with multiple identical application nodes are supported, you can run cron on all of them

A result of this is that cron can be run much more often, which means (for example) forum posts can be sent out sooner. To take advantage of the new cron system it is now strongly recommended that administrators increase the frequency that cron is run to at least ''once per minute''.

You also may need to modify any automated scripts you have that are parsing the output from cron. It is no longer possible to simply monitor the output of cron for the string "Cron script completed correctly" (if that is what you were doing). An alternative is to monitor the output for the string "task failed:". If you detect that a task is failing, [[Cron#Debugging_Scheduled_Tasks|here]] are some tips for debugging the failure.

Before the upgrade to 2.7, there may have been a cron task that was failing, which was preventing the rest of cron from being executed. A failure in any single task will no longer prevent the rest of the Moodle cron tasks from executing, so you may uncover previously masked bugs. It is a good idea to closely monitor the output from cron after the upgrade to 2.7.

===Assignments===

The old assignment (2.2) module has been removed from core and has been replaced by a stub to support transparently remapping URLs and restoring course backups from the old module to the new one.

If you are still using the old assignment (2.2) module, after upgrading to Moodle 2.7 all assignment (2.2) activities will be hidden. You need to run the [[Assignment upgrade tool]] to un-hide the activities.

If you really, really need to keep using the old assignment (2.2) module, you should update the code to Moodle 2.7, and then replace the "mod/assignment" folder with the one from https://github.com/moodlehq/moodle-mod_assignment/releases before completing the upgrade.

===Maths filters===

Moodle 2.7 comes with a new maths filter based on [http://mathjax.org MathJax]. It is an alternative to the existing Tex filter. The MathJax filter is enabled by default for new sites and also upgrades. You may wish to disable the Tex filter and enable the MathJax filter. In 2.7 sites, if both are enabled the TeX filter wins regardless of filter order because the TeX filter removes all TeX notation before the javascript is executed. This may mask the fact MathJaxloader is enabled on old installations. In 2.8 both filters may be run together with both being used to display the mathematics. See MDL-44780. There are some compatibility settings and other options that can be changed for the [[MathJax filter]].

==Possible issues that may affect you in Moodle 2.7==

===Custom log-based reports===

Moodle 2.7 has moved to the new Logging API that allows more detailed and more flexible log storage. By default after the upgrade Moodle no longer stores data in table 'log'. All standard reports and plugins that used to access this table are converted to support both new API and legacy 'log' table. It is understandable that there might be custom 3rd party plugins that can not be changed immediately and either write significant information to the 'log' table or require access to it. In this case admin needs to enable writing to the legacy log:
Site Administration > Plugins > Logging > Legacy log : Select "Log legacy data". You might also want to disable "Standard log" so your system doesn't have double logging.

=== MySQL dmlwriteexception error when restoring a course===

If you obtain a dmlwriteexception error when restoring a course, it is recommended that InnoDB tables are converted to the Barracuda file format. See the section 'Converting InnoDB tables to Barracuda' in [[Administration via command line]] for details of why this is recommended plus information on a tool for converting tables.

=== Moodle 2.3, 2.4, 2.5 and 2.6 improvements ===

Depending on which version you are upgrading from, please see the section 'Possible issues that may affect you' in the documentation

* [https://docs.moodle.org/23/en/Upgrading Upgrading to Moodle 2.3]
* [https://docs.moodle.org/24/en/Upgrading Upgrading to Moodle 2.4]
* [https://docs.moodle.org/25/en/Upgrading Upgrading to Moodle 2.5]
* [https://docs.moodle.org/26/en/Upgrading Upgrading to Moodle 2.6]

==See also==

* [[Installation]]
* Using Moodle [http://moodle.org/mod/forum/view.php?id=28 Installation problems forum]
* [[dev:Moodle 2.7 release notes|Moodle 2.7 release notes]]
* [[dev:Upgrade API|Upgrade API]]

[[es:Actualización de moodle]]
[[fr:Mise à jour]]
[[ja:Moodleをアップグレードする]]
[[de:Aktualisierung von Moodle]]

admin/environment/custom check/unsupported db table row format

2015-07-01T06:27:08Z

Tsala: copying updates from 28 docs

{{Environment}}
Sites using MySQL with database tables using Antelope as the file format are recommended to convert the tables to the Barracuda file format. See the section 'Converting InnoDB tables to Barracuda' in [[Administration via command line]] for details of why this is recommended plus information on a tool for converting tables.

==See also==

Forum discussions:
* [https://moodle.org/mod/forum/discuss.php?d=312863 Converting InnoDB tables to Barracuda]
* [https://moodle.org/mod/forum/discuss.php?d=312955 Error Converting InnoDB tables to Barracuda - Moodle 2.8.5 - 2.8.5+ (Build: 20150501)]
* [https://moodle.org/mod/forum/discuss.php?d=315719 Antelope to barracuda on WIndows]

[[Category:Environment|Database]]

[[es:admin/environment/custom check/unsupported db table row format]]

admin/environment/custom check/unsupported db storage engine

2015-06-26T10:44:33Z

Tsala: redirect

#redirect [[Migration from MyISAM to InnoDB]]

admin/environment/custom check/unsupported db table row format

2015-06-26T07:47:50Z

Tsala: removing redirect for additional info to be added before directing people to Administration via command line

{{Environment}}
If your database has tables using Antelope as the file format, you are recommended to convert the tables to the Barracuda file format using a special tool as described in [[Administration via command line]].

==See also==

Forum discussions:
* [https://moodle.org/mod/forum/discuss.php?d=312863 Converting InnoDB tables to Barracuda]
* [https://moodle.org/mod/forum/discuss.php?d=312955 Error Converting InnoDB tables to Barracuda - Moodle 2.8.5 - 2.8.5+ (Build: 20150501)]
* [https://moodle.org/mod/forum/discuss.php?d=315719 Antelope to barracuda on WIndows]

{{stub}}

[[Category:Environment|Database]]

[[es:admin/environment/custom check/unsupported db table row format]]

admin/environment/database/mysql

2015-06-26T07:35:18Z

Tsala: removing out-of-date info

{{Environment}}
{{stub}}

[[Category:Environment|Database]]

[[fr:admin/environment/database/mysql]]
[[es:admin/environment/database/mysql]]

Using Database

2015-06-16T15:14:19Z

Tsala: Enabling an RSS feed of recently added entries

{{Database}}
==Views==

===View list===

The list view shows multiple entries, possibly in a more abbreviated form to ensure all the information fits. You may use the controls at the bottom of the screen to search and sort the contents.

* ''View single'': one item at a time
* ''View list'' : several items at a time (number is user defined)
* ''Add entry'' : add an item to the database
* ''Search'' : search the entries

[[Image:26databaseview.png]]

=== View single ===

Alternatively, you may view only one entry at a time. This might allow you to view more detailed information than the list view.

=== Add comment ===

If comments have been enabled, you may add a comment.

=== Rate entries ===

If ratings have been enabled, and made viewable, by the database editor, you may [[Grades|grade]] other database entries, and view these ratings.

==Adding an entry==

Go to the "Add entry" tab and fill in the form.
===Deleting multiple entries===

In List view, a checkbox will appear next to each entry. Select the entries you wish to delete and click the 'Delete selected' button. Alternatively, click the 'Select all' and the 'Delete all' buttons to delete all entries. A warning message will appear asking you to verify what you wish to delete.

==Automatically linking database entries==

If the [[Database auto-linking filter]] is enabled, any entries in a database will be automatically linked to where the concept words and/or phrases appear within the same course. This includes forum postings, internal resources, week summaries etc.

Note: If you do not want particular text to be linked (in a forum posting, say) then you should add <nolink> and </nolink> tags around the text. Alternatively the filter can be disabled for a particular activity.
==Approving and undoing approval of entries==

If, during database set up, 'Approval required' was set to 'Yes' then a teacher can approve an entry by clicking on the tick/checkmark icon.

Once an entry has been approved, it is possible to undo the approval by clicking the circle with a line through it icon.

{|
|[[File:26databaseapprove.png|thumb|Entry approved]]
|[[File:26databaseunapprove.png|thumb|Approval undone]]
|}

==Importing many entries==
You can import entries via a CSV file if you click the "Import entries" link under 'Database activity administration' in the Administration block of your course. CSV means Comma-Separated-Values and is a common format for text interchange.

[[image:Databaseupload.png]]

The easiest way to determine the format of the text file is to manually add an entry to the database and then export it. The resulting export text file may then be edited and used for importing entries. Here's a sample of what a very simple file will look like.

[[Image:Upload_csv_sample.png]]

The expected file format is a plain text file with a list of field names as the first record. The data then follows, one record per line.

The field delimiter defaults to a comma character and the field enclosure is not set by default (field enclosures are characters that surround each field in each record).

Records should be delimited by new lines (usually generated by pressing RETURN or ENTER in your text editor). Tabs can be specified using \t and newlines by \n.

Sample file:

name,height,weight
Kai,180cm,80kg
Kim,170cm,60kg
Koo,190cm,20kg

Note: Certain field types may not be supported.

Do not put spaces after your commas or upload will fail!

After upload page import.php comes back blank if it failed.
If successful you'll read a message like, "1 entries saved".

==Exporting entries==

You can export entries either in CSV (comma separated values) or ODS (OpenOffice Calc) formats by clicking the tab at the top or by clicking the "Export entries" link under 'Database activity administration' in the Administration block in your course. (Both CSV and ODS formats can be opened with MS Excel.)

[[File:Databasexport.png]]

When using the CSV format, the user can select either the comma, semicolon, or tab to separate the fields. The selection of the proper character is important. If users select to use a comma to separate the fields and some of the fields contain data with commas then the number of columns is going to be misaligned and likely cause confusion.

Users can select which fields from the database they wish to have exported. By default, all fields are checked to be included. Choose the fields that you wish to have included in the export.

Once the export type and the fields to be exported have been selected, clicking on the Export entries pushbutton will generate the file. The user will usually have the option of either opening or saving the file.

For information on converting the date export (and import) format, see the discussion [https://moodle.org/mod/forum/discuss.php?d=220505 Standard Database Module - Dates].

==Exporting to an external portfolio==

If an external [[Portfolios|portfolio]] such as [[Mahara_portfolio|Mahara]] has been enabled by the administrator then users have the option to export individual entries to that portfolio. They will see at the bottom of a database entry an "export" icon to click on and select the portfolio to export to:

[[File:Exportdatabasentry.png]]

==Enabling an RSS feed of recently added entries==

To enable an RSS feed from a database activity, an administrator must first enable RSS feeds for database activities across the whole site as described in [[RSS feeds settings]]. A section called 'RSS' will then appear on the edit settings page of the database activity.

# Edit the database activity settings and set the number of entries in the RSS feed e.g. 5.
# Check that the RSS template includes the required fields.
# Log out and then access the database activity as a guest.
# Copy the 'RSS feed for this activity' link in the administration block.

The RSS feed may then be displayed in an [[Remote RSS feeds block]] or elsewhere.

== Example databases ==

Moodle.org has two good examples of the database module in action:

* [http://moodle.org/mod/data/view.php?id=6140 Moodle Buzz], a database of the titles, authors and web links to news articles mentioning Moodle
* [http://moodle.org/mod/data/view.php?d=26 Themes], a database with screenshots, download links and user comments about Moodle [[Themes|themes]]

== Creative uses ==

You could use the database module to:

* allow collaboration on building a collection of web links/books/journal references related to a particular subject
* display student created photos/posters/websites/poems for peer comment and review
* gather comments and votes on a shortlist of potential logos/mascot names/project ideas
* provide a [http://moodle.org/mod/forum/discuss.php?d=52699 student file storage area]
* maintain a log of what was done in a face-to-face class each day, so that absent students can get caught up themselves. [http://moodle.org/mod/forum/discuss.php?d=115047 Example]

== See also ==

*[http://school.demo.moodle.net/course/view.php?id=57&section=3 Examples of databases in the School demo site] (available for download)
* [[Dataform module]], which is a major enhancement of the Database module with improved browsing, editing, searching and other features.
* [[Glossary module]], which performs a similar though more specialised, text-based role
* [[Using Moodle book]] Chapter 12: Databases
* Using Moodle [http://moodle.org/mod/forum/view.php?id=3505 Database activity module forum]
* [http://moodle.org/mod/data/view.php?rid=2424 Tracking Students' Reading with the Moodle Database Module] presentation
Using Moodle forum discussions:
* [http://moodle.org/mod/forum/discuss.php?d=72260 Database Module: Each learner Private DB?]
* [http://moodle.org/mod/forum/discuss.php?d=84487 Database for Dummies please!]
* [http://moodle.org/mod/forum/discuss.php?d=89117 Restricting access to database content by user?]
* [http://moodle.org/mod/forum/discuss.php?d=139137 How to use the database activity module?]

[[de:Datenbank nutzen]]
[[es:Usando BasedeDatos]]

Capabilities/webservice/xmlrpc:use

2015-06-10T09:16:06Z

Tsala: link update

{{Capabilities}}
*This allows a user to use the XML-RPC protocol for [[Web services]].
*This capability is not set for any of the default roles.

On moodle.org this capability is allowed for the default role of authenticated user to enable people using the [[Moodle Mobile]] app to access the site.

[[Category:Capabilities|Webservice]]
[[Category:Web Services]]

[[eu:Capabilities/webservice/xmlrpc:use]]
[[es:Capabilities/webservice/xmlrpc:use]]

MediaWiki:Sitenotice

2015-05-11T13:16:12Z

Tsala: note and link to up-to-date docs

''Note: You are currently viewing documentation for Moodle 2.7. Up-to-date documentation for the latest stable version of Moodle may be available here: '''[[:en:{{NAMESPACE}}:{{PAGENAME}}|{{PAGENAME}}]].'''''

MediaWiki:MoodleDocsVersionLinks

2015-05-11T06:18:36Z

Tsala: 2.9 link

2.7 docs: /27/en/{{FULLPAGENAMEE}}
2.9 docs: /29/en/{{FULLPAGENAMEE}}
2.8 docs: /28/en/{{FULLPAGENAMEE}}
2.6 docs: /26/en/{{FULLPAGENAMEE}}
2.5 docs: /25/en/{{FULLPAGENAMEE}}
2.4 docs: /24/en/{{FULLPAGENAMEE}}
2.3 docs: /23/en/{{FULLPAGENAMEE}}
2.2 docs: /22/en/{{FULLPAGENAMEE}}
2.1 docs: /21/en/{{FULLPAGENAMEE}}
2.0 docs: /20/en/{{FULLPAGENAMEE}}
1.9 docs: /19/en/{{FULLPAGENAMEE}}

admin/environment/custom check/unsupported db table row format

2015-04-27T07:31:15Z

Tsala: redirect copied from 28 docs

#REDIRECT [[Administration via command line#Converting_InnoDB_tables_to_Barracuda]]

Administration via command line

2015-04-27T07:29:57Z

Tsala: copying text from 2.8 wiki

{{Installing Moodle}}
==Running CLI scripts==
If you have shell access to your web server, you may find various CLI (command line interface) scripts useful during Moodle administration. Core admin CLI tools are located in the <code>admin/cli/*</code> folder. Other plugins provide their CLI functionality via scripts in their own cli folder. For example, the enrol_db sync script is located in <code>enrol/db/cli/</code>.

To avoid problems with access control, you should run them as the owner of the web server process. It is especially important for CLI installation and upgrade as they create new files in moodledata directory and the web server has to have write access to them. In Linux distributions, the user that runs the web server is usually apache or wwrun or httpd or something similar. As a root, you will probably want to execute Moodle CLI scripts like this:

$ cd /path/to/your/moodle/dir
$ sudo -u apache /usr/bin/php admin/cli/somescript.php --params

Most of the scripts accept common --help (or -h) parameter to display the full usage information, for example:

$ sudo -u apache /usr/bin/php admin/cli/install.php --help

== Upgrading ==

Moodle can be upgraded from the command line. As with the installation script, there is either interactive or non-interactive mode of the upgrade. The script itself does not put the site into the maintenance mode, you have to do it on your own. Also, the script does not backup any data (if you read this page, you probably have some own scripts to backup your moodledata and the database, right?)

$ sudo -u apache /usr/bin/php admin/cli/upgrade.php

Upgrading via command line is a very comfortable way of Moodle upgrade if you use Git checkout of the Moodle source code (see [[Git for Administrators]]). See the following procedure how to upgrade your site within several seconds to the most recent version while preserving your eventual local customizations tracked in git repository:

$ cd /var/www/sites/moodle/htdocs/
$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --enable
$ git pull
$ sudo -u apache /usr/bin/php admin/cli/upgrade.php
$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --disable

== Installation ==

There are two modes of installing Moodle from the command line. In interactive mode, the install script asks you for all data needed to properly set up new Moodle site. In non-interactive mode, you must provide all required data as the script parameters and then the new site is installed silently. The parameters can be passed in the interactive mode, too. The provided values are then used as the default values during the interactive session.

$ sudo -u apache /usr/bin/php admin/cli/install.php --lang=cs

== Maintenance mode ==

To switch your site into the maintenance mode via CLI, you can use

$ sudo -u apache /usr/bin/php admin/cli/maintenance.php --enable

To turn maintenance mode off, just execute the same script with --disable parameter.

== Offline mode ==

In some situations, you may want to switch your Moodle site into offline mode so that it is not accessible via the web but you can not stop the web server completely (typically because there are other web pages and applications running there). If a file called <code>climaintenance.html</code> exists in the root folder of moodledata directory, Moodle will automatically display the contents of that file instead of any other page.

$ cd /var/www/sites/moodle/moodledata/
$ echo '<h1>Sorry, maintenance in progress</h1>' > climaintenance.html

You can prepare a nice formatted HTML page to inform your users about the server being down and keep in the moodledata directory under a name like <code>climaintenance.off</code> and rename it to the <code>climaintenance.html</code> if needed.

== Custom site defaults ==

During the install and upgrade via CLI, Moodle sets the administration variables to the default values. You can use different defaults. See MDL-17850 for details. Shortly, all you need to do is to add a file <code>local/defaults.php</code> into your Moodle installation. The format of the file is like

<code php>
<?php
$defaults['pluginname']['settingname'] = 'settingvalue'; // for plugins
$defaults['moodle']['settingname'] = 'settingvalue'; // for core settings
</code>

These defaults are used during install, upgrade and are also displayed as defaults on Site administration pages.

== Reset user password ==

If you happen to forget your admin password (or you want to set a password for any other user on the site), you can use reset_password.php script. The script sets the correctly salted password for the given user.

$ sudo -u apache /usr/bin/php admin/cli/reset_password.php

== MySQL storage engine conversion ==

If you run your Moodle site with MySQL database backend and use the default MyISAM as the storage engine for your tables, you may want to convert them to use some more reliable engine like InnoDB (actually, you should want to switch to PostgreSQL ;-) anyway).

$ sudo -u apache /usr/bin/php admin/cli/mysql_engine.php --engine=InnoDB

==Converting InnoDB tables to Barracuda==

Some users are getting the following MySQL error during course restore:

Row size too large (>8126). Changing some columns to TEXT or BLOB or using ROW_FORMAT=DYNAMIC or ROW_FORMAT=COMPRESSED may help.

The error is due to the fact that the MySQL default InnoDB file format (Antelope) cannot handle more than 10 text columns. Thus you are recommended to change the InnoDB file format to Barracuda using the following command:

php admin/cli/mysql_compressed_rows.php

For further information on InnoDB file formats see:

* http://dev.mysql.com/doc/innodb/1.1/en/glossary.html#glos_antelope
* http://dev.mysql.com/doc/innodb/1.1/en/glossary.html#glos_barracuda

== Running cron via command line ==

In versions 1.x, you could execute admin/cron.php either from command line or via the web. Since Moodle 2.0, only admin/cli/cron.php script can be run via command line.

== Scheduled tasks ==

Scheduled tasks are automatically run by the cron script, but the specific tasks which run on each cron iteration are determined by the scheduled tasks configuration. It is possible to override the scheduled tasks configuration and run a single scheduled task immediately using the admin/tool/task/cli/schedule_task.php script.

This script accepts the following arguments:

--list - list all the known scheduled tasks. The tasks are listed by the class name used to run the task. This class name is required as the argument to the next option in order to run a specific task immediately.

--execute=<task> - Runs a single scheduled task immediately - regardless of scheduling settings. This will even run disabled tasks. Tasks will still use locking to prevent concurrent execution of the same task - even on clusters. The format of the <task> argument must be the same as returned by the --list option above.

'''Note:''' You must escape the "\" with an extra \ when using the --execute command. Take the following for example:

<pre>php schedule_task.php --list</pre>

will return something like:

<pre>
== List of scheduled tasks (http://yourserver.com/moodle) ==
\enrol_imsenterprise\task\cron_task 10 * * * * * ASAP
\logstore_legacy\task\cleanup_task * 5 * * * * ASAP
\logstore_standard\task\cleanup_task * 4 * * * * Wednesday, November 12, 2014, 4:35 AM
\mod_forum\task\cron_task * * * * * * ASAP
\core\task\automated_backup_task 50 * * * * * ASAP

...
</pre>

To run the first task in that list, you would execute

<pre>php schedule_task.php --execute=\\enrol_imsenterprise\\task\\cron_task</pre>

==Database transfer==

A command line script for [[Database transfer]] may be found in ''admin/tool/dbtransfer/cli/migrate.php''.

==Purge caches==

You can purge caches using this script:

php admin/cli/purge_caches.php

==Fix course / module sequences==

In rare cases (such as after upgrading from a very old version of Moodle), the course / section / module sequence data can be out of sync. This can cause various problems for affected courses, such as sections not appearing, backups failing, pages not displaying etc. There is a specific check to check for errors caused by this problem, and to fix the data in the database if they are found. To run this script please use the command below:

php admin/cli/fix_course_sequence.php -c=* --fix

This will check every course in Moodle and report which ones had errors and were fixed.

==See also==

* MDL-35736 - Manage plugins via command line
* MDL-36237 - Resort course list via CLI

[[fr:Administration en ligne de commande]]
[[de:Administration über Kommandozeile]]
[[ja:コマンドライン経由の管理]]
[[es:Administración por línea de comando]]

Capabilities/mod/wiki:overridelock

2015-04-03T07:00:32Z

Tsala: capabilities template

{{Capabilities}}
*This allows a user to override locked [[Wiki module|wiki pages]]
*This capability is allowed for the default roles of manager, teacher and non-editing teacher

[[Category:Capabilities|Wiki]]
[[Category:Wiki]]

[[fr:Capabilities/mod/wiki:overridelock]]
[[ja:ケイパビリティ/mod/wiki:overridelock]]

Capabilities/mod/wiki:managewiki

2015-04-03T06:57:57Z

Tsala: capabilities template, categories

{{Capabilities}}
*This allows a user to edit [[Wiki module|wiki]] settings
*This capability is allowed for the default roles of manager, teacher and non-editing teacher

[[Category:Capabilities|Wiki]]
[[Category:Wiki]]

[[es:Capabilities/mod/wiki:managewiki]]