MoodleDocs - Användarbidrag [sv]

Year-end procedures

2020-07-02T02:24:17Z

Deraadt: Adding link to our process

{{Backup}}

Where Moodle is used in an academic environment, such as a school or university, it is useful to have procedures in place for removing students and teachers who have left and moving current students "up" a year while ensuring all essential work is preserved. While we talk about "year end procedures",the approach of preparing for the next intake of students for one or more courses may have nothing to do with a year-end. Some organisations might run two-week online courses every month; others might complete a qualification each term/semester, while yet others might have a self-paced, rolling programme with enrolment at any time.

Below are some suggested procedures and aspects to be taken into consideration. (Thanks to Gavin Henrick whose [http://www.somerandomthoughts.com/blog/2012/09/14/end-of-year-rollover/ End of Year rollover] blog post provided much of the content below.)

==First thoughts==

*When will this be done? At the end of the term(semester)? During the break? Many establishments find it easier to perform admin tasks during the holidays when fewer students and teachers are accessing Moodle. It might be advisable to put the site into [[Maintenance mode]] while this is being done.
*Will students who have left at the end of the current year be removed permanently or will their details need to be retained for a period of time? This will depend on the policies of on your own establishment or education authority.
*Teachers and other staff members who have left will also need removing from the site.

==Which strategy to use?==
There are a number of rolling over strategies used by schools, colleges and other organisations. Which strategy is used is dependent on a number of different criteria including:
*who creates the course structure/content
*the type of courses which are in place
*the volume of courses that is live
*whether all courses stop/start at the same time.

Here are some standard mechanisms for a course rollover:

==Backing up (archiving) courses==
Courses may be made copied for archiving by using the [[Course backup]] feature and including user details (ie, assignment submissions, forum posts etc) (Note that this would be done by the administrator, as a regular course teacher is not allowed, for security reasons, to back up courses with user details.)
The courses can then be stored either externally on a disc or within Moodle in a category named, for instance, "Archives" which can be hidden from regular users. The original course may then be "reset" for a new intake of students.

'''Pros:'''
*Students and teachers have live access to the prior instance of the module.
*The initial content and activities are already built for the incoming class
*The effort can be outsourced from central administration to each teacher if they have sufficient permissions in their own category
'''Cons:'''
*There is more than one copy of the course in the Moodle site
*If carried out by a teacher they now need course creation rights in a category.
*This is effort that is needed for every course and is a linear cost in time based on the number of courses that need resetting.

An alternative is to create empty courses for teachers, give them editing rights in the course and allow them to import the resources and activities from their old course into the new course. See [[Import course data]]

==Resetting the courses==
Once a course has been backed up for safekeeping, it can be [[Reset course|reset]] by clicking the link in ''Settings>Course administration>Reset'' This removes all user data from a course but keeps the activities themselves ready to start afresh with students who will then be enrolled for the new academic year.

This can be done manually by teachers for their own courses and as such, they have control over what aspects are reset. They may for example choose to not reset certain activities that they want to keep the user content from (a forum, or a glossary or database for example). See [[Reset course]]

'''Pros:'''
*There is only one course in the instance
*Permissions for teachers do not change
*The initial content and activities are already built for the incoming class
*The effort can be outsourced to each teacher

'''Cons:'''
*This is effort that is needed for every course and is a linear cost in time based on the number of courses that need resetting.
*Students and teachers do not have live access to the prior instance of the module which may be desirable for a number of reasons.

==Creating a new course==
A third option is where an empty course is created each year and the teacher is assigned to it. However, this requires the teacher to build it again each year with the new resources and activities. They can import if they wish but this is often done where the content has potentially changed so new versions of resources need to be added rather than last year’s re-used.

'''Pros:'''
*Students and teachers have live access to the prior instance of the module.
*The content is potentially different in each instance of the course
*Some of the effort is outsourced to the teacher

'''Cons:'''
*The effort cannot all be outsourced to each teacher as someone has to create the course and assign the teacher rights.
*There is more than one copy of the course in the Moodle site
*This is effort that is needed for every course and is a linear cost in time based on the number of courses that need resetting.
*The initial content and activities are not already built for the incoming class

==Make a new Moodle==
Another approach is to isolate each year by creating a new instance of Moodle for the upcoming student intake. Then only the needed courses, users, and resources/activities are added to this, so that it is kept as lean and as high performance as possible.
If you still want your students and teachers to have access to the old course you can keep it on an archive URL so that they can still log in and use it, but it is now isolated from the new content and users.

'''Pros:'''
*The old courses are still live to be accessed by students/teachers
*The live site only has the data that is needed in it.
*The live site does not necessarily have to be the same version as the old one.

'''Cons:'''
*There is now another Moodle instance to maintain/patch/upgrade
*If a teacher wants something from the old instance they need to back up the content and the upload to the new site before restoring, adding two extra steps of downloading/uploading.

==Other considerations==
*Who creates the content? Who does the actual work of uploading to a course? Depending on the institution, it might be a single teacher, an admin, a learning technologist or an IT assistant. Understanding where the burden of work will fall and having buy-in for this to happen, is of primary importance.
*How does the type of course impact the approach to roll over? If the course has predefined content and activities which will not change for the next iteration of the course then forcing a full rebuild is a huge cost which could be avoided. However if the resources are digital copies of the latest lecture notes and recorded lecture, then it potentially changes every instance of the course and is built over time.
*How large is your Moodle? If your Moodle has 10 courses managing a rollover is a different prospect compared to if your Moodle site has 2,000 courses. Doing backups of 2,000 courses and restoring them in a few days, or short period will add significant load to your Moodle site which needs to be taken into account when planning.

==Accessing the courses next year==
*How will new students and new teachers access their courses? They will need both accounts creating and enrolment into their courses. Which methods of [[Authentication]] and [[Enrolment]] will best suit your needs?
*Likewise, how will existing teachers and students access their new courses?

==See also==
* [https://youtu.be/Wyu3UA7U5rA End of year course rollover YouTube tutorial] by Lewis Carr and accompanying [http://www.slideshare.net/LewisCarr2/end-of-year-moodle-course-rollovers Slideshare presentation on course rollovers.]
* [http://www.somerandomthoughts.com/blog/2012/09/14/end-of-year-rollover/ End of Year rollover] blog post by Gavin Henrick from which much of this documentation was taken.
* [https://salvetore.wordpress.com/2020/07/02/our-course-roll-over-process/ A Roll-over process] by Michael de Raadt.

==Useful tools==
* [https://moodle.org/plugins/local_remote_backup_provider Remote backup provider]
* [https://moodle.org/plugins/tool_my_external_backup_restore_courses_admin Restore courses from remote Moodle]
* Administrators can use [http://moosh-online.com/commands/#course-restore MOOSH] to bulk backup and restore courses from CLI
* [https://moodle.org/plugins/block_remote_courses My remote courses] (block)
* [https://moodle.org/plugins/local_course_template Use template on course creation]
* [https://moodle.org/plugins/block_eledia_course_archiving Course archiving] & [https://moodle.org/plugins/tool_coursearchiver Course archiver]
* [https://moodle.org/plugins/tool_sync CSV based sync] to different Moodle instances
* [https://moodle.org/plugins/block_admin_presets Admin presets] (export/import)

[[es:Procedimientos de fin-de-año]]
[[de:Jahresabschluss einer Moodle-Site]]
[[fr:Procédures de fin d'année]]

Global search

2020-02-12T02:53:51Z

Deraadt: Recommending a higher maxBooleanClauses value

{{More features}}
==What is Global search?==
*Global search lets you search everywhere on the Moodle site that you have access to. A student can search their courses for particular lecture notes, for example, or a teacher could search for subject-related activities.
*The feature needs to be enabled by the administrator in Advanced features and then, from the Manage Global search page, the search engine must be selected.

When Global search is enabled, search box is then available next to the user menu.

[[File:NFGlobalsearchbox.png|thumb|center|480px|Searching the site (when global search is enabled)]]

*A [[Global search block]] may also be added to course pages.

==What can I search for?==
You can search for your courses, activities information and some activities contents like forum posts, book chapters, glossary entries or collaborative wikis pages.

HTML block content may be searched and, if the administrator sets the setting "Searchable courses" to ''Search within all courses the user can access'' then courses which are visible to users but which they are not enrolled in may also be searched. (These courses are courses with guest access or if the user has the capability to view all courses.)

==How does it work?==
*Click the search icon by the user menu and type a search term into the box that appears, or type into the box in the [[Global search block]] if enabled.
*On the next screen, you can simply click the search button to search everywhere, or expand the Filter to search in specific areas:

[[File:NFFilteringGlobalSearch2.png|thumb|center|600px|Filtering the search]]

*You will then see results displayed from all areas of Moodle you have access to:

[[File:31GSResults2a.png|thumb|center|600px|Search results]]

===Solr-specific features===
''These features are only available if you use '''Solr''' as your search engine.''

====Search query features====
You can improve your search using any of the following search query features:

* Specifying the field to be searched by prefixing the search query with 'title:', 'content:', 'name:', or 'intro:' e.g.'title:news' returns results with the word 'news' in the title
* Boolean operators ('AND', 'OR', 'NOT') to combine or exclude keywords
* Wildcard characters ('*' or '?' ) to represent characters in the search query
* Proximity searches ('~') e.g. mood~2 returns "moodle" (2 letters away from "mood"), Moodle Australia~3 returns results containing "Moodle HQ in Perth, Australia" (the queried terms were within 3 words of each other)
* Boosting terms ('^') to boost certain words or phrases e.g. "Perth Australia"^5 "Australia" will return results with the phrase "Perth Australia" as more relevant.

====File contents indexing====
Solr has the ability to index the contents of files, such as File resources and attachments to Forum posts.

====Extra filters====
'''New in 3.5''' : New fields now facilitate filtering by user ID and searching by group.

==How is it set up?==

Note: Global search needs a search engine. It's recommended you set everything up first, index the site contents ''and only then'' enable Global search.

Moodle core includes two search engines: Simple Global search and Solr. See the [https://docs.moodle.org/dev/Search_engines Developer docs on Search engine plugins] if you wish to write your own.

===Setting up Simple search===

Simple Global search provides global search features without the need to install an external search engine.

{{MediaPlayer | url = https://youtu.be/4JJhOd2XAiY | desc = Simple global search}}

===Setting up Solr===

* The latest Solr 5 available version is the recommended one.
* Moodle supports Solr server from 4.0 onwards, although you can only use the Solr schema setup script that we provide with Moodle from Solr 5. The latest Solr 5 available version is the recommended one; the same will apply to Solr 6 once it is released.

====General Setup====

# Set the feature up in ''Site administration > Plugins > Search > Manage global search'' by selecting Solr as the search engine and ticking search area checkboxes as required
# In ''Site administration > Plugins > Search > Solr'', set '''Host name''' to localhost, '''Port''' to 8983 and '''Index name''' to 'moodle' (the name of the index in Solr)
# If you are using Solr with SSL encryption and basic authentication (see below if you want to use client certificates instead), you will need to configure this.This is important if solr is not installed in the web server server.
## Go to ''Site administration > Plugins > Search > Solr''
## Set '''Secure mode''' to Yes
## Set port number if required (sometimes SSL installations use port 443).
## Type in the username and password.
# If you are using Solr with SSL encryption via client certificates, you will need to configure Moodle as such. This is important if solr is not installed in the web server server.
## You will need a separate key file and cacert file, both in pem format, located on your server Moodle, and readable by the PHP process.
## Go to ''Site administration > Plugins > Search > Solr''
## Set '''Secure mode''' to Yes
## '''SSL certificate''' to /path/to/certs/solr-ssl.cacert.pem
## '''SSL key''' to /path/to/certs/solr-ssl.key.pem
## '''SSL key Password''' to The password used to lock the SSL Key
## '''SSL CA certificates name''' to /path/to/certs/solr-ssl.cacert.pem
# You now need to populate the created Solr index with your site's data. You can do it via the web interface by going to ''Site administration > Reports > Global search info'' or from the CLI by running the <tt>search/cli/indexer.php</tt> script. The CLI script is the recommended option for big sites. <code># sudo -u www-run php search/cli/indexer.php --force</code>
# Enable Global search in ''Site administration > Advanced features''

====File Indexing====

Solr has the ability to index the contents of files, such as File resources and attachments to Forum posts. This uses the [https://tika.apache.org/ Tika] engine which comes bundled with Solr. To enable this feature:
# In ''Site administration > Plugins > Search > Solr'' enable the checkbox '''Enable file indexing'''
# Set '''Maximum file size to index (kB)''' to some value - the default is '''2097152''' (2GB)
#* Files larger than this limit will not be sent for Solr for indexing, but the file name will still be indexed.

'''New in 34:''' File indexing now works retroactively -ie, if you set up Global search without file indexing enabled and a later date you enable file indexing, files associated with existing objects will be included.

====How to install Solr====

You need PHP Solr extension installed. You can download the official latest versions from [http://pecl.php.net/package/solr PECL: Package: solr]. The minimum required version is PECL Solr 2.1 for PHP 5 branch and PECL Solr 2.4 for PHP 7 branch.

Basic installation steps (using apache web server):

===== Linux (Debian/Ubuntu) =====
Using APT:
sudo apt install php-solr
sudo service apache2 restart

If you can't install the SOLR PHP module via APT, try the following:

With PHP5.x
sudo apt-get install libpcre3-dev libxml2-dev libcurl4-openssl-dev
sudo apt-get install php5-dev
sudo apt-get install php-pear
sudo pecl install solr
sudo sh -c "echo 'extension=solr.so' > /etc/php5/apache2/conf.d/solr.ini"
sudo sh -c "echo 'extension=solr.so' > /etc/php5/cli/conf.d/solr.ini"
sudo service apache2 restart

With PHP 7
sudo apt-get install libpcre3-dev libxml2-dev libcurl4-openssl-dev
sudo apt-get install php7.0-dev
sudo apt-get install php-pear
sudo pecl install solr
sudo sh -c "echo 'extension=solr.so' > /etc/php/7.0/apache2/conf.d/solr.ini"
sudo sh -c "echo 'extension=solr.so' > /etc/php/7.0/cli/conf.d/solr.ini"
sudo service apache2 restart

===== Linux (Redhat/Centos 6 & 7) =====

====== Using built in php5 packages ======
yum install php-pecl-solr2
service httpd restart

====== Using 3rd party php7 packages (webtactic) ======
yum install libxml2-devel pcre-devel libcurl-devel php70w-devel php70w-pear
pecl install solr
echo "extension=solr.so" > /etc/php.d/solr.ini
service httpd restart

===== OSX using macports =====

sudo port install apache-solr4
sudo port install php54-solr

===== OSX using homebrew =====

brew install homebrew/php/php56-solr

===== Windows =====

* Check your PHP version (see Site admin > Server > PHP Info) for PHP version, compiler (eg VC15), architecture (eg x64), and thread safety.
* Get the matching PHP extension DLL from [https://pecl.php.net/package/solr PECL] (or [https://www.apachelounge.com/viewtopic.php?t=6359 this page] if not available on PECL).
* Add the DLL to you php\ext folder.
* Add the directive "extension=php_solr.dll" to your php.ini file.
* Restart your web server.
* Install the [https://www.java.com/en/download/manual.jsp Java Runtime Environment]
* Download Solr from the [https://archive.apache.org/dist/lucene/solr/ Solr Downloads page], eg solr-5.5.5.zip.
* Extract to an accessible place, eg: c:\solr-5.5.5
* From command line (as admin), in C:\solr-5.5.5, run...
** bin\solr start
** bin\solr status
** bin\solr create -c moodle
** bin\solr stop -all
* (As admin) Edit C:\solr-5.5.5\server\solr\moodle\conf\solrconfig.xml and change line...
<maxBooleanClauses>1024</maxBooleanClauses>
...to...
<maxBooleanClauses>524288</maxBooleanClauses>
* Create Scheduled task to start Solr
** General
*** Run whether user is logged on or not
*** Run at highest privileges
*** Configure for Windows Server 2016
** Triggers
*** Run daily (start any time)
*** Repeat every hour, indefinitely
** Actions
*** Start program
*** Script: C:\solr-5.5.5\bin\solr.cmd
*** Add arguments: start -m 2g
** Conditions
*** Uncheck: Start the task only when the computer is on AC power
** Settings
*** Uncheck: Stop the task if it runs longer than: ...
*** If the task is already running, then the following rule applies: Do not start a new instance
* Run the scheduled task manually (for now)
* At the command line, in c:\solr-5.5.5, run ''bin\solr status'' to check it is running
* Configure the Solr server in Moodle as below.
* Visit Site admin > Plugins > Search > Manage global search. It may prompt you to set up the seach schema.
* Run the scheduled task to build the search index from the command line. It may initially need to run a few times as it will time out after 10min and you may have a lot of files.
php admin\tool\task\cli\schedule_task.php --execute=\core\task\search_index_task
* Keep an eye on the amount of memory used with ''solr status'' and the Task Manager (see the Java process).

===== The Solr server =====

Note that for medium/large sites you may need to increase maxBooleanClauses setting. In [https://tracker.moodle.org/browse/MDL-54992 MDL-54992] we are working on an alternative way to query the server.

Please note that there is a security issue that affects some Solr versions. The patched versions are 5.5.5, 6.6.2, 7.1, 7.2 and all new versions are patched. If your Solr server version is lower but you can't upgrade to one of the patched versions it is recommended to disable the XML Query Parser.

The following example snippet (feel free to copy & paste into a .sh script with execution permissions) will download Solr 5.5.5 (replace it with latest 5.x) in the current directory, start the solr server and create an index in it named '''moodle''' to add moodle data to it. If wget gives an error, check http://www-us.apache.org/dist/lucene/solr and update SOLRVERSION

#!/bin/bash
set -e
SOLRVERSION=5.5.5
SOLRNAME=solr-$SOLRVERSION
SOLRTAR=$SOLRNAME'.tgz'
INDEXNAME=moodle
if [ -d $SOLRNAME ]; then
echo "Error: Directory $SOLRNAME already exists, remove it before starting the setup again."
exit 1
fi
if [ ! -f $SOLRTAR ]; then
wget http://www-us.apache.org/dist/lucene/solr/$SOLRVERSION/$SOLRTAR
fi
tar -xvzf $SOLRTAR
cd $SOLRNAME
bin/solr start
bin/solr create -c $INDEXNAME
# After setting it up and creating the index use:
# - "/yourdirectory/solrdir/bin/solr start" from CLI to start the server
# - "/yourdirectory/solrdir/bin/solr stop" from CLI to stop the server.

======Solr 5/6 schema setup======

Moodle will use Solr's managed schema interface to install the required fields. You will be directed on what to do from the Manage global search page.

For very large or busy sites, it is recommended that you manually remove the '''_text_''' field, and associated copy directive from, the default Solr schema. This field is not used by Moodle, and will significantly slow indexing, and increase the size of the resulting Solr core.

======Solr 4 schema setup======

You cannot use the schema setup script when using a Solr 4 server. If you really want to use the Solr 4x branch, here are the field types descriptions:

Extracted from search/classes/document.php

{| class="nicetable"
|-
! Field name
! Field type
! Stored
! Indexed
! Query field
|-
| id
| org.apache.solr.schema.StrField
| true
| false
| false
|-
| itemid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| title
| org.apache.solr.schema.TextField
| true
| true
| true
|-
| content
| org.apache.solr.schema.TextField
| true
| true
| true
|-
| contextid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| areaid
| org.apache.solr.schema.StrField
| true
| true
| false
|-
| type
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| courseid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| owneruserid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| modified
| org.apache.solr.schema.TrieDateField
| true
| true
| false
|-
| userid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| description1
| org.apache.solr.schema.TextField
| true
| true
| true
|-
| description2
| org.apache.solr.schema.TextField
| true
| true
| true
|-
| solr_filegroupingid
| org.apache.solr.schema.StrField
| true
| true
| false
|-
| solr_fileid
| org.apache.solr.schema.StrField
| true
| true
| false
|-
| solr_filecontenthash
| org.apache.solr.schema.StrField
| true
| true
| false
|-
| solr_fileindexstatus
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| solr_filecontent
| org.apache.solr.schema.TextField
| false
| true
| true
|}

======Memory and File indexing considerations======

For large sites, and particularly if you are using the File indexing feature, it's a good idea to give Solr plenty of memory, eg aound 10-20GB. To start Solr with more than its default 512MB of RAM, use the ''-m'' option:
solr start -m 12g

See the documents for your version of Solr on how to increases memory when Solr is started automatically.

======Too many boolean clauses error======

Because of the way Moodle handles permissions for searches, if you have non-admin users with access to a large number of activities (>1000), they may an error similar to the following:

The query you provided could not be parsed by the search engine: org.apache.solr.search.SyntaxError: Cannot parse
...
too many boolean clauses

To correct this, you need to increase the ''maxBooleanClauses'' setting in your Solr core. The setting is located in ''corename/conf/solrconfig.xml''.

This important note is included in the config file:
** WARNING **

This option actually modifies a global Lucene property that
will affect all SolrCores. If multiple solrconfig.xml files
disagree on this property, the value at any given moment will
be based on the last SolrCore to be initialized.

This means that for consistent behavior you should update this value for all cores in the Solr server.

=====Commannd for installing Solr Server on Centos 7=====
First of all install java (openjdk)
yum install java-1.8.0-openjdk
Add user for solr
adduser solr
Download solr server, find latest here : http://lucene.apache.org/solr/mirrors-solr-latest-redir.html, from the list there download latest solr-[version].tgz

Here is the list of needed commands (note that latest solr is suggested, change command to appropriate version)
cd /opt
wget http://www-eu.apache.org/dist/lucene/solr/6.6.0/solr-6.6.0.tgz
tar zxvf solr-6.6.0.tgz
cp solr-6.6.0/bin/install_solr_service.sh .
rm -rf solr-6.6.0
./install_solr_service.sh solr-6.6.0.tgz
chkconfig solr on
Create the index
su - solr -c "/opt/solr/bin/solr create_core -c moodle"
Then go to your Moodle and set index name as created (moodle)

==See also==

Forum discussions:
* [https://moodle.org/mod/forum/discuss.php?d=334938 Global search doesn't index plugins?]
* [https://moodle.org/mod/forum/discuss.php?d=339819 Global Search on Moodle 3.1]
* [https://moodle.org/mod/forum/discuss.php?d=384884 Global Search index repair]

'''MySQL Database Connection error with Simple Search:''' This SQL query should solve the issue

''ALTER TABLE mdl_search_simpledb_index ADD FULLTEXT(title, content, description1, description2)''

A quick introduction to Moodle global search, followed by a description of the new features and fixes in Moodle 3.4 (and some of those in Moodle 3.5).
*[https://www.slideshare.net/sammarshall_ou/moodle-global-search-nows-the-time-to-jump-in Presentation by Sam Marshall from the Open University]

[[es:Búsqueda global]]
[[de:Globale Suche]]
[[fr:Recherche globale]]

Messaging settings

2019-11-28T00:53:48Z

Deraadt:

{{Messaging}}
==Messaging settings for all users==

*Users can decide how they want to be notified of new messages and event notifications by editing their messaging preferences page, which they can access either from the Preferences link in the user menu or from the gear icon in the messaging/notifications menus. See [[Messaging]] and [[Notifications]] for more information.
*Which options they see there depend on what has been enabled by the administrator. For example, the mobile option is only available if the site is enabled for the mobile app.

==Enabling / disabling messaging site wide==

The personal messaging system in Moodle is enabled by default. It may be disabled by a site administrator from Site administration > Messaging > Messaging settings.

From 'Messaging settings', the administrator can "Allow site-wide messaging" (disabled by default). If this setting is enabled, users on the site can view all other users when selecting someone to message and can choose to accept messages from anyone on the site.

==Notification settings ==

Messaging system default settings are set in 'Notification settings' in Site administration / Messaging

There are four default types of notification plugins: web, Jabber, email and mobile.

By default web and email are both enabled, though email will only work of course if the site has been properly configured to deliver email. Jabber and Mobile notifications are off by default and need to be configured first.

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

==== Jabber ====
Jabber is the original name of the Extensible Messaging and Presence Protocol ([https://en.wikipedia.org/wiki/XMPP XMPP]), an open standard instant messaging protocol.
The Jabber service on the Moodle server must be configured before use. To configure Jabber, an XMPP account should be created that is specific to the Moodle server, either on a locally hosted XMPP server or on one of many [https://xmpp.net/directory.php public servers]. The information for this account is entered in Site administration / Plugins / Message outputs / Jabber:

*Host - The server to connect to to send jabber message notifications - this is entered as the full hostname (e.g. jabber.org) with no protocol (i.e. no "https://")
*Server - XMPP host ID (can be left empty if the same as Jabber host)
*Username - The user name to use when connecting to the Jabber server as the Moodle site, without domain name
*Password - The password to use when connecting to the Jabber server as the Moodle site.
*Port - defaults to 5222

[[File:Jabber_configuration.png]]

After the Jabber service has been configured, it must also be enabled:

[[File:jabber_enable.png]]

Each Moodle user wishing to receive instant message notifications through Jabber must create an account on a Jabber server and must configure their Moodle account to include those details:

[[File:jabber_user_account.png]]

The user must also choose which notifications to receive using Jabber:

[[File:Jabber_notification_preferences.png]]

Users may also choose to receive Moodle messages via Jabber:

[[File:Jabber_messages_on.png]]

====Mobile notifications====

[[File:mobilenotifications.png]]

The administrator can configure the site to push messages to mobile devices. Moodle pushes messages to a messaging server, which then pushes it to Apple or Google depending on the platform the target device is using (iOS or Android).

[[Site registration|Registered sites]] can make use of the default messaging server https://messages.moodle.net/ which is maintained by moodle.com. To connect to this, click 'Request access key' and then add it to the Airnotifier access key field.

Alternatively, you may install your own private Airnotifier server and use that instead. See https://github.com/dongsheng/airnotifier for details.

===Default message outputs===

You can specify the default outputs for each type of message that Moodle can send in 'Default message outputs' in Site administration.

You can also set to what degree each type of message is enabled, and whether users are able to change these default settings in their profiles:

* ''Disallowed'' - This particular type of message is not allowed at all and users will not see any settings related to them. Message of the chosen type will never be delivered.

* ''Permitted'' - Users are permitted or allowed to change the settings. When the user account is created, the new user will inherit the settings the administrator sets here, but will be allowed to change them afterward in their Messaging settings. Messages will be delivered as the user sets them on their own Messaging settings page.

* ''Locked'' - Users are not permitted or allowed to change these settings. When the user account is created, the new user will inherit the settings the administrator sets here and will never be allowed to change them. Messages will be delivered for all users as you set them on this page.

====Logged in/Offline====

You can set whether each of these will be sent when the user is online through the messaging system interface available to users in their profiles, and/or whether each output is sent via email.

====Ordering of messaging settings====

Because users might have many different messaging options, they are ordered into different components - for example, activities, system, enrolments etc.

[[File:ExampleStudentNotification.png|thumb|600px|center|Example notifications preferences screen - student view]]

==== List of message types====

Except for '''Personal messages between users''', which refers to the interaction messaging tool on a user profile, the other messages are generated by events in Moodle. These are set in the system by the Administrator in ''Site administration > Plugins > Message outputs > Default message outputs''.

{| class="wikitable"
|-
! Output Name !! Description !! Recipients
|-
| Assignment notifications || Student has submitted an [[Assignment activity|assignment]]|| Teacher
|-
| Warning when your quiz attempt becomes overdue || See [[Quiz settings]] || Student
|-
| Available update notifications || Notice of new releases of Moodle code || Site administrators
|-
| Backup notifications || Automated backup schedule run completed || Site administrators
|-
| Badge creator notifications || Notify creator of a badge when it is awarded to someone || Any badge creator (typically Teacher or Manager role)
|-
| Badge recipient notifications || Notify recipient of a badge when it is awarded to them || Any badge recipient (typically Student role)
|-
| Comment posted on a learning plan || ? || ?
|-
| Comment posted on a competency || ? || ?
|-
| Confirmation of your own quiz submissions || Notice your quiz was successfully submitted || Student
|-
| Course creation request approval notification || Notice a requested course has been approved || Defined in ''Site admin > Courses > Course request > Course request notification''
|-
| Course creation request notification || Notice a course has been requested - See [[Course request]] || Defined in ''Site admin > Courses > Course request > Course request notification''
|-
| Course creation request rejection notification || Notice a requested course has been rejected || Defined in ''Site admin > Courses > Course request > Course request notification''
|-
| Subscribed forum digests || Sets default for this for user profiles || Authenticated users
|-
| Important errors with the site || Important errors - See also [[Debugging]] || Site administrators
|-
| Manual enrolment expiry notifications || Notice if [[Manual enrolment]] about to expire || Manual enrolees
|-
| Self enrolment expiry notifications || Notify users when their enrolment expires || Enroller only, or Enroller & Enrolled user
|-
| Lesson essay graded notification || Notify students a teacher has graded a Lesson essay question || Student
|-
| Personal messages between users || Using the Messaging interface tool || Authenticated Users
|-
| Message to confirm that an inbound message came from you || See [[Incoming mail configuration]] || Authenticated Users
|-
| Feedback reminder || [[Feedback activity|Feedback]] non-respondent reminder message || Student feedback activity non-responders
|-
| Warning when an inbound message could not be processed || See [[Incoming mail configuration]] || Authenticated Users
|-
| Confirmation that a message was successfully processed || See [[Incoming mail configuration]] || Authenticated Users
|-
| Notices about minor problems || || Site administrators
|-
| Notification of rule subscriptions || Notifications from [[Event monitoring]] rules || Event rule subscribers
|-
| Subscribed forum posts || Default for forum subscription handling || Anyone subscribed to a forum
|-
| Feedback notifications || Notices from setting Enable notification of submissions || Teacher, Feedback administrator
|-
| Notification of quiz submissions || Message that student has submitted a quiz || Teacher
|}

==Roles and Messaging capabilities==

The following capabilities can be applied as permissions to make custom changes to roles affecting messaging.

* [[Capabilities/moodle/course:bulkmessaging|course:bulkmessaging - Send a message to many people]]
* [[Capabilities/moodle/site:readallmessages|site:readallmessages - Read all messages on site]]
* [[Capabilities/moodle/site:sendmessage|site:sendmessage - Send messages to any user]]
* [[Capabilities/moodle/user:editownmessageprofile|user:editownmessageprofile - Edit own user messaging profile]]
* [[Capabilities/moodle/user:editmessageprofile|user:editmessageprofile - Edit user messaging profile]]

===Email===
All email messages and notifications go to the email address set in a user's profile. The administrator can optionally allow users to choose to have notifications sent to a different email address. This is off by default and can be enabled in ''Site administration > Advanced features > Notification email override''.

Users can then enter their alternative email address under Preferences/User account/Notification preferences: Click on the gear icon next to "Email" in the table header and enter the alternative email.

Note: The 'messagingallowemailoverride' setting does not affect failed log in notifications as they do not go through the messaging system, and will therefore still go to the original email specified.

[[fr:Paramètres de messagerie]]
[[de:Einstellungen für Mitteilungen]]
[[es:Configuraciones de mensajería]]

Global search

2019-11-19T18:53:41Z

Deraadt:

{{More features}}
==What is Global search?==
*Global search lets you search everywhere on the Moodle site that you have access to. A student can search their courses for particular lecture notes, for example, or a teacher could search for subject-related activities.
*The feature needs to be enabled by the administrator in Advanced features and then, from the Manage Global search page, the search engine must be selected.

When Global search is enabled, search box is then available next to the user menu.

[[File:NFGlobalsearchbox.png|thumb|center|480px|Searching the site (when global search is enabled)]]

*A [[Global search block]] may also be added to course pages.

==What can I search for?==
You can search for your courses, activities information and some activities contents like forum posts, book chapters, glossary entries or collaborative wikis pages.

HTML block content may be searched and, if the administrator sets the setting "Searchable courses" to ''Search within all courses the user can access'' then courses which are visible to users but which they are not enrolled in may also be searched. (These courses are courses with guest access or if the user has the capability to view all courses.)

==How does it work?==
*Click the search icon by the user menu and type a search term into the box that appears, or type into the box in the [[Global search block]] if enabled.
*On the next screen, you can simply click the search button to search everywhere, or expand the Filter to search in specific areas:

[[File:NFFilteringGlobalSearch2.png|thumb|center|600px|Filtering the search]]

*You will then see results displayed from all areas of Moodle you have access to:

[[File:31GSResults2a.png|thumb|center|600px|Search results]]

===Solr-specific features===
''These features are only available if you use '''Solr''' as your search engine.''

====Search query features====
You can improve your search using any of the following search query features:

* Specifying the field to be searched by prefixing the search query with 'title:', 'content:', 'name:', or 'intro:' e.g.'title:news' returns results with the word 'news' in the title
* Boolean operators ('AND', 'OR', 'NOT') to combine or exclude keywords
* Wildcard characters ('*' or '?' ) to represent characters in the search query
* Proximity searches ('~') e.g. mood~2 returns "moodle" (2 letters away from "mood"), Moodle Australia~3 returns results containing "Moodle HQ in Perth, Australia" (the queried terms were within 3 words of each other)
* Boosting terms ('^') to boost certain words or phrases e.g. "Perth Australia"^5 "Australia" will return results with the phrase "Perth Australia" as more relevant.

====File contents indexing====
Solr has the ability to index the contents of files, such as File resources and attachments to Forum posts.

====Extra filters====
'''New in 3.5''' : New fields now facilitate filtering by user ID and searching by group.

==How is it set up?==

Note: Global search needs a search engine. It's recommended you set everything up first, index the site contents ''and only then'' enable Global search.

Moodle core includes two search engines: Simple Global search and Solr. See the [https://docs.moodle.org/dev/Search_engines Developer docs on Search engine plugins] if you wish to write your own.

===Setting up Simple search===

Simple Global search provides global search features without the need to install an external search engine.

{{MediaPlayer | url = https://youtu.be/4JJhOd2XAiY | desc = Simple global search}}

===Setting up Solr===

* The latest Solr 5 available version is the recommended one.
* Moodle supports Solr server from 4.0 onwards, although you can only use the Solr schema setup script that we provide with Moodle from Solr 5. The latest Solr 5 available version is the recommended one; the same will apply to Solr 6 once it is released.

====General Setup====

# Set the feature up in ''Site administration > Plugins > Search > Manage global search'' by selecting Solr as the search engine and ticking search area checkboxes as required
# In ''Site administration > Plugins > Search > Solr'', set '''Host name''' to localhost, '''Port''' to 8983 and '''Index name''' to 'moodle' (the name of the index in Solr)
# If you are using Solr with SSL encryption and basic authentication (see below if you want to use client certificates instead), you will need to configure this.This is important if solr is not installed in the web server server.
## Go to ''Site administration > Plugins > Search > Solr''
## Set '''Secure mode''' to Yes
## Set port number if required (sometimes SSL installations use port 443).
## Type in the username and password.
# If you are using Solr with SSL encryption via client certificates, you will need to configure Moodle as such. This is important if solr is not installed in the web server server.
## You will need a separate key file and cacert file, both in pem format, located on your server Moodle, and readable by the PHP process.
## Go to ''Site administration > Plugins > Search > Solr''
## Set '''Secure mode''' to Yes
## '''SSL certificate''' to /path/to/certs/solr-ssl.cacert.pem
## '''SSL key''' to /path/to/certs/solr-ssl.key.pem
## '''SSL key Password''' to The password used to lock the SSL Key
## '''SSL CA certificates name''' to /path/to/certs/solr-ssl.cacert.pem
# You now need to populate the created Solr index with your site's data. You can do it via the web interface by going to ''Site administration > Reports > Global search info'' or from the CLI by running the <tt>search/cli/indexer.php</tt> script. The CLI script is the recommended option for big sites. <code># sudo -u www-run php search/cli/indexer.php --force</code>
# Enable Global search in ''Site administration > Advanced features''

====File Indexing====

Solr has the ability to index the contents of files, such as File resources and attachments to Forum posts. This uses the [https://tika.apache.org/ Tika] engine which comes bundled with Solr. To enable this feature:
# In ''Site administration > Plugins > Search > Solr'' enable the checkbox '''Enable file indexing'''
# Set '''Maximum file size to index (kB)''' to some value - the default is '''2097152''' (2GB)
#* Files larger than this limit will not be sent for Solr for indexing, but the file name will still be indexed.

'''New in 34:''' File indexing now works retroactively -ie, if you set up Global search without file indexing enabled and a later date you enable file indexing, files associated with existing objects will be included.

====How to install Solr====

You need PHP Solr extension installed. You can download the official latest versions from [http://pecl.php.net/package/solr PECL: Package: solr]. The minimum required version is PECL Solr 2.1 for PHP 5 branch and PECL Solr 2.4 for PHP 7 branch.

Basic installation steps (using apache web server):

===== Linux (Debian/Ubuntu) =====
Using APT:
sudo apt install php-solr
sudo service apache2 restart

If you can't install the SOLR PHP module via APT, try the following:

With PHP5.x
sudo apt-get install libpcre3-dev libxml2-dev libcurl4-openssl-dev
sudo apt-get install php5-dev
sudo apt-get install php-pear
sudo pecl install solr
sudo sh -c "echo 'extension=solr.so' > /etc/php5/apache2/conf.d/solr.ini"
sudo sh -c "echo 'extension=solr.so' > /etc/php5/cli/conf.d/solr.ini"
sudo service apache2 restart

With PHP 7
sudo apt-get install libpcre3-dev libxml2-dev libcurl4-openssl-dev
sudo apt-get install php7.0-dev
sudo apt-get install php-pear
sudo pecl install solr
sudo sh -c "echo 'extension=solr.so' > /etc/php/7.0/apache2/conf.d/solr.ini"
sudo sh -c "echo 'extension=solr.so' > /etc/php/7.0/cli/conf.d/solr.ini"
sudo service apache2 restart

===== Linux (Redhat/Centos 6 & 7) =====

====== Using built in php5 packages ======
yum install php-pecl-solr2
service httpd restart

====== Using 3rd party php7 packages (webtactic) ======
yum install libxml2-devel pcre-devel libcurl-devel php70w-devel php70w-pear
pecl install solr
echo "extension=solr.so" > /etc/php.d/solr.ini
service httpd restart

===== OSX using macports =====

sudo port install apache-solr4
sudo port install php54-solr

===== OSX using homebrew =====

brew install homebrew/php/php56-solr

===== Windows =====

* Check your PHP version (see Site admin > Server > PHP Info) for PHP version, compiler (eg VC15), architecture (eg x64), and thread safety.
* Get the matching PHP extension DLL from [https://pecl.php.net/package/solr PECL] (or [https://www.apachelounge.com/viewtopic.php?t=6359 this page] if not available on PECL).
* Add the DLL to you php\ext folder.
* Add the directive "extension=php_solr.dll" to your php.ini file.
* Restart your web server.
* Install the [https://www.java.com/en/download/manual.jsp Java Runtime Environment]
* Download Solr from the [https://archive.apache.org/dist/lucene/solr/ Solr Downloads page], eg solr-5.5.5.zip.
* Extract to an accessible place, eg: c:\solr-5.5.5
* From command line (as admin), in C:\solr-5.5.5, run...
** bin\solr start
** bin\solr status
** bin\solr create -c moodle
** bin\solr stop -all
* (As admin) Edit C:\solr-5.5.5\server\solr\moodle\conf\solrconfig.xml and change line...
<maxBooleanClauses>1024</maxBooleanClauses>
...to...
<maxBooleanClauses>32768</maxBooleanClauses>
* Create Scheduled task to start Solr
** General
*** Run whether user is logged on or not
*** Run at highest privileges
*** Configure for Windows Server 2016
** Triggers
*** Run daily (start any time)
*** Repeat every hour, indefinitely
** Actions
*** Start program
*** Script: C:\solr-5.5.5\bin\solr.cmd
*** Add arguments: start -m 2g
** Conditions
*** Uncheck: Start the task only when the computer is on AC power
** Settings
*** Uncheck: Stop the task if it runs longer than: ...
*** If the task is already running, then the following rule applies: Do not start a new instance
* Run the scheduled task manually (for now)
* At the command line, in c:\solr-5.5.5, run ''bin\solr status'' to check it is running
* Configure the Solr server in Moodle as below.
* Visit Site admin > Plugins > Search > Manage global search. It may prompt you to set up the seach schema.
* Run the scheduled task to build the search index from the command line. It may initially need to run a few times as it will time out after 10min and you may have a lot of files.
php admin\tool\task\cli\schedule_task.php --execute=\core\task\search_index_task
* Keep an eye on the amount of memory used with ''solr status'' and the Task Manager (see the Java process).

===== The Solr server =====

Note that for medium/large sites you may need to increase maxBooleanClauses setting. In [https://tracker.moodle.org/browse/MDL-54992 MDL-54992] we are working on an alternative way to query the server.

Please note that there is a security issue that affects some Solr versions. The patched versions are 5.5.5, 6.6.2, 7.1, 7.2 and all new versions are patched. If your Solr server version is lower but you can't upgrade to one of the patched versions it is recommended to disable the XML Query Parser.

The following example snippet (feel free to copy & paste into a .sh script with execution permissions) will download Solr 5.5.5 (replace it with latest 5.x) in the current directory, start the solr server and create an index in it named '''moodle''' to add moodle data to it. If wget gives an error, check http://www-us.apache.org/dist/lucene/solr and update SOLRVERSION

#!/bin/bash
set -e
SOLRVERSION=5.5.5
SOLRNAME=solr-$SOLRVERSION
SOLRTAR=$SOLRNAME'.tgz'
INDEXNAME=moodle
if [ -d $SOLRNAME ]; then
echo "Error: Directory $SOLRNAME already exists, remove it before starting the setup again."
exit 1
fi
if [ ! -f $SOLRTAR ]; then
wget http://www-us.apache.org/dist/lucene/solr/$SOLRVERSION/$SOLRTAR
fi
tar -xvzf $SOLRTAR
cd $SOLRNAME
bin/solr start
bin/solr create -c $INDEXNAME
# After setting it up and creating the index use:
# - "/yourdirectory/solrdir/bin/solr start" from CLI to start the server
# - "/yourdirectory/solrdir/bin/solr stop" from CLI to stop the server.

======Solr 5/6 schema setup======

Moodle will use Solr's managed schema interface to install the required fields. You will be directed on what to do from the Manage global search page.

For very large or busy sites, it is recommended that you manually remove the '''_text_''' field, and associated copy directive from, the default Solr schema. This field is not used by Moodle, and will significantly slow indexing, and increase the size of the resulting Solr core.

======Solr 4 schema setup======

You cannot use the schema setup script when using a Solr 4 server. If you really want to use the Solr 4x branch, here are the field types descriptions:

Extracted from search/classes/document.php

{| class="nicetable"
|-
! Field name
! Field type
! Stored
! Indexed
! Query field
|-
| id
| org.apache.solr.schema.StrField
| true
| false
| false
|-
| itemid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| title
| org.apache.solr.schema.TextField
| true
| true
| true
|-
| content
| org.apache.solr.schema.TextField
| true
| true
| true
|-
| contextid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| areaid
| org.apache.solr.schema.StrField
| true
| true
| false
|-
| type
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| courseid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| owneruserid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| modified
| org.apache.solr.schema.TrieDateField
| true
| true
| false
|-
| userid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| description1
| org.apache.solr.schema.TextField
| true
| true
| true
|-
| description2
| org.apache.solr.schema.TextField
| true
| true
| true
|-
| solr_filegroupingid
| org.apache.solr.schema.StrField
| true
| true
| false
|-
| solr_fileid
| org.apache.solr.schema.StrField
| true
| true
| false
|-
| solr_filecontenthash
| org.apache.solr.schema.StrField
| true
| true
| false
|-
| solr_fileindexstatus
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| solr_filecontent
| org.apache.solr.schema.TextField
| false
| true
| true
|}

======Memory and File indexing considerations======

For large sites, and particularly if you are using the File indexing feature, it's a good idea to give Solr plenty of memory, eg aound 10-20GB. To start Solr with more than its default 512MB of RAM, use the ''-m'' option:
solr start -m 12g

See the documents for your version of Solr on how to increases memory when Solr is started automatically.

======Too many boolean clauses error======

Because of the way Moodle handles permissions for searches, if you have non-admin users with access to a large number of activities (>1000), they may an error similar to the following:

The query you provided could not be parsed by the search engine: org.apache.solr.search.SyntaxError: Cannot parse
...
too many boolean clauses

To correct this, you need to increase the ''maxBooleanClauses'' setting in your Solr core. The setting is located in ''corename/conf/solrconfig.xml''.

This important note is included in the config file:
** WARNING **

This option actually modifies a global Lucene property that
will affect all SolrCores. If multiple solrconfig.xml files
disagree on this property, the value at any given moment will
be based on the last SolrCore to be initialized.

This means that for consistent behavior you should update this value for all cores in the Solr server.

=====Commannd for installing Solr Server on Centos 7=====
First of all install java (openjdk)
yum install java-1.8.0-openjdk
Add user for solr
adduser solr
Download solr server, find latest here : http://lucene.apache.org/solr/mirrors-solr-latest-redir.html, from the list there download latest solr-[version].tgz

Here is the list of needed commands (note that latest solr is suggested, change command to appropriate version)
cd /opt
wget http://www-eu.apache.org/dist/lucene/solr/6.6.0/solr-6.6.0.tgz
tar zxvf solr-6.6.0.tgz
cp solr-6.6.0/bin/install_solr_service.sh .
rm -rf solr-6.6.0
./install_solr_service.sh solr-6.6.0.tgz
chkconfig solr on
Create the index
su - solr -c "/opt/solr/bin/solr create_core -c moodle"
Then go to your Moodle and set index name as created (moodle)

==See also==

Forum discussions:
* [https://moodle.org/mod/forum/discuss.php?d=334938 Global search doesn't index plugins?]
* [https://moodle.org/mod/forum/discuss.php?d=339819 Global Search on Moodle 3.1]
* [https://moodle.org/mod/forum/discuss.php?d=384884 Global Search index repair]

'''MySQL Database Connection error with Simple Search:''' This SQL query should solve the issue

''ALTER TABLE mdl_search_simpledb_index ADD FULLTEXT(title, content, description1, description2)''

A quick introduction to Moodle global search, followed by a description of the new features and fixes in Moodle 3.4 (and some of those in Moodle 3.5).
*[https://www.slideshare.net/sammarshall_ou/moodle-global-search-nows-the-time-to-jump-in Presentation by Sam Marshall from the Open University]

[[es:Búsqueda global]]
[[de:Globale Suche]]
[[fr:Recherche globale]]

Global search

2019-11-19T00:57:35Z

Deraadt:

{{More features}}
==What is Global search?==
*Global search lets you search everywhere on the Moodle site that you have access to. A student can search their courses for particular lecture notes, for example, or a teacher could search for subject-related activities.
*The feature needs to be enabled by the administrator in Advanced features and then, from the Manage Global search page, the search engine must be selected.

When Global search is enabled, search box is then available next to the user menu.

[[File:NFGlobalsearchbox.png|thumb|center|480px|Searching the site (when global search is enabled)]]

*A [[Global search block]] may also be added to course pages.

==What can I search for?==
You can search for your courses, activities information and some activities contents like forum posts, book chapters, glossary entries or collaborative wikis pages.

HTML block content may be searched and, if the administrator sets the setting "Searchable courses" to ''Search within all courses the user can access'' then courses which are visible to users but which they are not enrolled in may also be searched. (These courses are courses with guest access or if the user has the capability to view all courses.)

==How does it work?==
*Click the search icon by the user menu and type a search term into the box that appears, or type into the box in the [[Global search block]] if enabled.
*On the next screen, you can simply click the search button to search everywhere, or expand the Filter to search in specific areas:

[[File:NFFilteringGlobalSearch2.png|thumb|center|600px|Filtering the search]]

*You will then see results displayed from all areas of Moodle you have access to:

[[File:31GSResults2a.png|thumb|center|600px|Search results]]

===Solr-specific features===
''These features are only available if you use '''Solr''' as your search engine.''

====Search query features====
You can improve your search using any of the following search query features:

* Specifying the field to be searched by prefixing the search query with 'title:', 'content:', 'name:', or 'intro:' e.g.'title:news' returns results with the word 'news' in the title
* Boolean operators ('AND', 'OR', 'NOT') to combine or exclude keywords
* Wildcard characters ('*' or '?' ) to represent characters in the search query
* Proximity searches ('~') e.g. mood~2 returns "moodle" (2 letters away from "mood"), Moodle Australia~3 returns results containing "Moodle HQ in Perth, Australia" (the queried terms were within 3 words of each other)
* Boosting terms ('^') to boost certain words or phrases e.g. "Perth Australia"^5 "Australia" will return results with the phrase "Perth Australia" as more relevant.

====File contents indexing====
Solr has the ability to index the contents of files, such as File resources and attachments to Forum posts.

====Extra filters====
'''New in 3.5''' : New fields now facilitate filtering by user ID and searching by group.

==How is it set up?==

Note: Global search needs a search engine. It's recommended you set everything up first, index the site contents ''and only then'' enable Global search.

Moodle core includes two search engines: Simple Global search and Solr. See the [https://docs.moodle.org/dev/Search_engines Developer docs on Search engine plugins] if you wish to write your own.

===Setting up Simple search===

Simple Global search provides global search features without the need to install an external search engine.

{{MediaPlayer | url = https://youtu.be/4JJhOd2XAiY | desc = Simple global search}}

===Setting up Solr===

* The latest Solr 5 available version is the recommended one.
* Moodle supports Solr server from 4.0 onwards, although you can only use the Solr schema setup script that we provide with Moodle from Solr 5. The latest Solr 5 available version is the recommended one; the same will apply to Solr 6 once it is released.

====General Setup====

# Set the feature up in ''Site administration > Plugins > Search > Manage global search'' by selecting Solr as the search engine and ticking search area checkboxes as required
# In ''Site administration > Plugins > Search > Solr'', set '''Host name''' to localhost, '''Port''' to 8983 and '''Index name''' to 'moodle' (the name of the index in Solr)
# If you are using Solr with SSL encryption and basic authentication (see below if you want to use client certificates instead), you will need to configure this.This is important if solr is not installed in the web server server.
## Go to ''Site administration > Plugins > Search > Solr''
## Set '''Secure mode''' to Yes
## Set port number if required (sometimes SSL installations use port 443).
## Type in the username and password.
# If you are using Solr with SSL encryption via client certificates, you will need to configure Moodle as such. This is important if solr is not installed in the web server server.
## You will need a separate key file and cacert file, both in pem format, located on your server Moodle, and readable by the PHP process.
## Go to ''Site administration > Plugins > Search > Solr''
## Set '''Secure mode''' to Yes
## '''SSL certificate''' to /path/to/certs/solr-ssl.cacert.pem
## '''SSL key''' to /path/to/certs/solr-ssl.key.pem
## '''SSL key Password''' to The password used to lock the SSL Key
## '''SSL CA certificates name''' to /path/to/certs/solr-ssl.cacert.pem
# You now need to populate the created Solr index with your site's data. You can do it via the web interface by going to ''Site administration > Reports > Global search info'' or from the CLI by running the <tt>search/cli/indexer.php</tt> script. The CLI script is the recommended option for big sites. <code># sudo -u www-run php search/cli/indexer.php --force</code>
# Enable Global search in ''Site administration > Advanced features''

====File Indexing====

Solr has the ability to index the contents of files, such as File resources and attachments to Forum posts. This uses the [https://tika.apache.org/ Tika] engine which comes bundled with Solr. To enable this feature:
# In ''Site administration > Plugins > Search > Solr'' enable the checkbox '''Enable file indexing'''
# Set '''Maximum file size to index (kB)''' to some value - the default is '''2097152''' (2GB)
#* Files larger than this limit will not be sent for Solr for indexing, but the file name will still be indexed.

'''New in 34:''' File indexing now works retroactively -ie, if you set up Global search without file indexing enabled and a later date you enable file indexing, files associated with existing objects will be included.

====How to install Solr====

You need PHP Solr extension installed. You can download the official latest versions from [http://pecl.php.net/package/solr PECL: Package: solr]. The minimum required version is PECL Solr 2.1 for PHP 5 branch and PECL Solr 2.4 for PHP 7 branch.

Basic installation steps (using apache web server):

===== Linux (Debian/Ubuntu) =====
Using APT:
sudo apt install php-solr
sudo service apache2 restart

If you can't install the SOLR PHP module via APT, try the following:

With PHP5.x
sudo apt-get install libpcre3-dev libxml2-dev libcurl4-openssl-dev
sudo apt-get install php5-dev
sudo apt-get install php-pear
sudo pecl install solr
sudo sh -c "echo 'extension=solr.so' > /etc/php5/apache2/conf.d/solr.ini"
sudo sh -c "echo 'extension=solr.so' > /etc/php5/cli/conf.d/solr.ini"
sudo service apache2 restart

With PHP 7
sudo apt-get install libpcre3-dev libxml2-dev libcurl4-openssl-dev
sudo apt-get install php7.0-dev
sudo apt-get install php-pear
sudo pecl install solr
sudo sh -c "echo 'extension=solr.so' > /etc/php/7.0/apache2/conf.d/solr.ini"
sudo sh -c "echo 'extension=solr.so' > /etc/php/7.0/cli/conf.d/solr.ini"
sudo service apache2 restart

===== Linux (Redhat/Centos 6 & 7) =====

====== Using built in php5 packages ======
yum install php-pecl-solr2
service httpd restart

====== Using 3rd party php7 packages (webtactic) ======
yum install libxml2-devel pcre-devel libcurl-devel php70w-devel php70w-pear
pecl install solr
echo "extension=solr.so" > /etc/php.d/solr.ini
service httpd restart

===== OSX using macports =====

sudo port install apache-solr4
sudo port install php54-solr

===== OSX using homebrew =====

brew install homebrew/php/php56-solr

===== Windows =====

* Check your PHP version (see Site admin > Server > PHP Info) for PHP version, compiler (eg VC15), architecture (eg x64), and thread safety.
* Get the matching PHP extension DLL from [https://pecl.php.net/package/solr PECL] (or [https://www.apachelounge.com/viewtopic.php?t=6359 this page] if not available on PECL).
* Add the DLL to you php\ext folder.
* Add the directive "extension=php_solr.dll" to your php.ini file.
* Restart your web server.
* Install the [https://www.java.com/en/download/manual.jsp Java Runtime Environment]
* Download Solr from the [https://archive.apache.org/dist/lucene/solr/ Solr Downloads page], eg solr-5.5.5.zip.
* Extract to an accessible place, eg: c:\solr-5.5.5
* From command line (as admin), in C:\solr-5.5.5, run...
** bin\solr start
** bin\solr status
** bin\solr create -c moodle
** bin\solr stop -all
* (As admin) Edit C:\solr-5.5.5\server\solr\moodle\conf\managed-schema, comment out lines...

* (As admin) Edit C:\solr-5.5.5\server\solr\moodle\conf\solrconfig.xml and change line...
<maxBooleanClauses>1024</maxBooleanClauses>
...to...
<maxBooleanClauses>32768</maxBooleanClauses>
* Create Scheduled task to start Solr
** General
*** Run whether user is logged on or not
*** Run at highest privileges
*** Configure for Windows Server 2016
** Triggers
*** At startup
*** Repeat every hour, indefinitely
** Actions
*** Start program
*** Script: C:\solr-5.5.5\bin\solr.cmd
*** Add arguments: start -m 2g
** Conditions
*** Uncheck: Start the task only when the computer is on AC power
** Settings
*** Uncheck: Stop the task if it runs longer than: ...
*** If the task is already running, then the following rule applies: Do not start a new instance
* Run the scheduled task manually (for now)
* At the command line, in c:\solr-5.5.5, run ''bin\solr status'' to check it is running
* Configure the Solr server in Moodle as below.
* Visit Site admin > Plugins > Search > Manage global search. It may prompt you to set up the seach schema.
* Run the scheduled task to build the search index from the command line. It may need to run a few times as it will time out after 10min.
php admin\tool\task\cli\schedule_task.php --execute=\core\task\search_index_task
* Keep an eye on the amount of memory used with ''solr status'' and the Task Manager (see the Java process).

===== The Solr server =====

Note that for medium/large sites you may need to increase maxBooleanClauses setting. In [https://tracker.moodle.org/browse/MDL-54992 MDL-54992] we are working on an alternative way to query the server.

Please note that there is a security issue that affects some Solr versions. The patched versions are 5.5.5, 6.6.2, 7.1, 7.2 and all new versions are patched. If your Solr server version is lower but you can't upgrade to one of the patched versions it is recommended to disable the XML Query Parser.

The following example snippet (feel free to copy & paste into a .sh script with execution permissions) will download Solr 5.5.5 (replace it with latest 5.x) in the current directory, start the solr server and create an index in it named '''moodle''' to add moodle data to it. If wget gives an error, check http://www-us.apache.org/dist/lucene/solr and update SOLRVERSION

#!/bin/bash
set -e
SOLRVERSION=5.5.5
SOLRNAME=solr-$SOLRVERSION
SOLRTAR=$SOLRNAME'.tgz'
INDEXNAME=moodle
if [ -d $SOLRNAME ]; then
echo "Error: Directory $SOLRNAME already exists, remove it before starting the setup again."
exit 1
fi
if [ ! -f $SOLRTAR ]; then
wget http://www-us.apache.org/dist/lucene/solr/$SOLRVERSION/$SOLRTAR
fi
tar -xvzf $SOLRTAR
cd $SOLRNAME
bin/solr start
bin/solr create -c $INDEXNAME
# After setting it up and creating the index use:
# - "/yourdirectory/solrdir/bin/solr start" from CLI to start the server
# - "/yourdirectory/solrdir/bin/solr stop" from CLI to stop the server.

======Solr 5/6 schema setup======

Moodle will use Solr's managed schema interface to install the required fields. You will be directed on what to do from the Manage global search page.

For very large or busy sites, it is recommended that you manually remove the '''_text_''' field, and associated copy directive from, the default Solr schema. This field is not used by Moodle, and will significantly slow indexing, and increase the size of the resulting Solr core.

======Solr 4 schema setup======

You cannot use the schema setup script when using a Solr 4 server. If you really want to use the Solr 4x branch, here are the field types descriptions:

Extracted from search/classes/document.php

{| class="nicetable"
|-
! Field name
! Field type
! Stored
! Indexed
! Query field
|-
| id
| org.apache.solr.schema.StrField
| true
| false
| false
|-
| itemid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| title
| org.apache.solr.schema.TextField
| true
| true
| true
|-
| content
| org.apache.solr.schema.TextField
| true
| true
| true
|-
| contextid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| areaid
| org.apache.solr.schema.StrField
| true
| true
| false
|-
| type
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| courseid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| owneruserid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| modified
| org.apache.solr.schema.TrieDateField
| true
| true
| false
|-
| userid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| description1
| org.apache.solr.schema.TextField
| true
| true
| true
|-
| description2
| org.apache.solr.schema.TextField
| true
| true
| true
|-
| solr_filegroupingid
| org.apache.solr.schema.StrField
| true
| true
| false
|-
| solr_fileid
| org.apache.solr.schema.StrField
| true
| true
| false
|-
| solr_filecontenthash
| org.apache.solr.schema.StrField
| true
| true
| false
|-
| solr_fileindexstatus
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| solr_filecontent
| org.apache.solr.schema.TextField
| false
| true
| true
|}

======Memory and File indexing considerations======

For large sites, and particularly if you are using the File indexing feature, it's a good idea to give Solr plenty of memory, eg aound 10-20GB. To start Solr with more than its default 512MB of RAM, use the ''-m'' option:
solr start -m 12g

See the documents for your version of Solr on how to increases memory when Solr is started automatically.

======Too many boolean clauses error======

Because of the way Moodle handles permissions for searches, if you have non-admin users with access to a large number of activities (>1000), they may an error similar to the following:

The query you provided could not be parsed by the search engine: org.apache.solr.search.SyntaxError: Cannot parse
...
too many boolean clauses

To correct this, you need to increase the ''maxBooleanClauses'' setting in your Solr core. The setting is located in ''corename/conf/solrconfig.xml''.

This important note is included in the config file:
** WARNING **

This option actually modifies a global Lucene property that
will affect all SolrCores. If multiple solrconfig.xml files
disagree on this property, the value at any given moment will
be based on the last SolrCore to be initialized.

This means that for consistent behavior you should update this value for all cores in the Solr server.

=====Commannd for installing Solr Server on Centos 7=====
First of all install java (openjdk)
yum install java-1.8.0-openjdk
Add user for solr
adduser solr
Download solr server, find latest here : http://lucene.apache.org/solr/mirrors-solr-latest-redir.html, from the list there download latest solr-[version].tgz

Here is the list of needed commands (note that latest solr is suggested, change command to appropriate version)
cd /opt
wget http://www-eu.apache.org/dist/lucene/solr/6.6.0/solr-6.6.0.tgz
tar zxvf solr-6.6.0.tgz
cp solr-6.6.0/bin/install_solr_service.sh .
rm -rf solr-6.6.0
./install_solr_service.sh solr-6.6.0.tgz
chkconfig solr on
Create the index
su - solr -c "/opt/solr/bin/solr create_core -c moodle"
Then go to your Moodle and set index name as created (moodle)

==See also==

Forum discussions:
* [https://moodle.org/mod/forum/discuss.php?d=334938 Global search doesn't index plugins?]
* [https://moodle.org/mod/forum/discuss.php?d=339819 Global Search on Moodle 3.1]
* [https://moodle.org/mod/forum/discuss.php?d=384884 Global Search index repair]

'''MySQL Database Connection error with Simple Search:''' This SQL query should solve the issue

''ALTER TABLE mdl_search_simpledb_index ADD FULLTEXT(title, content, description1, description2)''

A quick introduction to Moodle global search, followed by a description of the new features and fixes in Moodle 3.4 (and some of those in Moodle 3.5).
*[https://www.slideshare.net/sammarshall_ou/moodle-global-search-nows-the-time-to-jump-in Presentation by Sam Marshall from the Open University]

[[es:Búsqueda global]]
[[de:Globale Suche]]
[[fr:Recherche globale]]

Global search

2019-11-18T22:55:40Z

Deraadt: Adding windows setup and configuration instructions

{{More features}}
==What is Global search?==
*Global search lets you search everywhere on the Moodle site that you have access to. A student can search their courses for particular lecture notes, for example, or a teacher could search for subject-related activities.
*The feature needs to be enabled by the administrator in Advanced features and then, from the Manage Global search page, the search engine must be selected.

When Global search is enabled, search box is then available next to the user menu.

[[File:NFGlobalsearchbox.png|thumb|center|480px|Searching the site (when global search is enabled)]]

*A [[Global search block]] may also be added to course pages.

==What can I search for?==
You can search for your courses, activities information and some activities contents like forum posts, book chapters, glossary entries or collaborative wikis pages.

HTML block content may be searched and, if the administrator sets the setting "Searchable courses" to ''Search within all courses the user can access'' then courses which are visible to users but which they are not enrolled in may also be searched. (These courses are courses with guest access or if the user has the capability to view all courses.)

==How does it work?==
*Click the search icon by the user menu and type a search term into the box that appears, or type into the box in the [[Global search block]] if enabled.
*On the next screen, you can simply click the search button to search everywhere, or expand the Filter to search in specific areas:

[[File:NFFilteringGlobalSearch2.png|thumb|center|600px|Filtering the search]]

*You will then see results displayed from all areas of Moodle you have access to:

[[File:31GSResults2a.png|thumb|center|600px|Search results]]

===Solr-specific features===
''These features are only available if you use '''Solr''' as your search engine.''

====Search query features====
You can improve your search using any of the following search query features:

* Specifying the field to be searched by prefixing the search query with 'title:', 'content:', 'name:', or 'intro:' e.g.'title:news' returns results with the word 'news' in the title
* Boolean operators ('AND', 'OR', 'NOT') to combine or exclude keywords
* Wildcard characters ('*' or '?' ) to represent characters in the search query
* Proximity searches ('~') e.g. mood~2 returns "moodle" (2 letters away from "mood"), Moodle Australia~3 returns results containing "Moodle HQ in Perth, Australia" (the queried terms were within 3 words of each other)
* Boosting terms ('^') to boost certain words or phrases e.g. "Perth Australia"^5 "Australia" will return results with the phrase "Perth Australia" as more relevant.

====File contents indexing====
Solr has the ability to index the contents of files, such as File resources and attachments to Forum posts.

====Extra filters====
'''New in 3.5''' : New fields now facilitate filtering by user ID and searching by group.

==How is it set up?==

Note: Global search needs a search engine. It's recommended you set everything up first, index the site contents ''and only then'' enable Global search.

Moodle core includes two search engines: Simple Global search and Solr. See the [https://docs.moodle.org/dev/Search_engines Developer docs on Search engine plugins] if you wish to write your own.

===Setting up Simple search===

Simple Global search provides global search features without the need to install an external search engine.

{{MediaPlayer | url = https://youtu.be/4JJhOd2XAiY | desc = Simple global search}}

===Setting up Solr===

* The latest Solr 5 available version is the recommended one.
* Moodle supports Solr server from 4.0 onwards, although you can only use the Solr schema setup script that we provide with Moodle from Solr 5. The latest Solr 5 available version is the recommended one; the same will apply to Solr 6 once it is released.

====General Setup====

# Set the feature up in ''Site administration > Plugins > Search > Manage global search'' by selecting Solr as the search engine and ticking search area checkboxes as required
# In ''Site administration > Plugins > Search > Solr'', set '''Host name''' to localhost, '''Port''' to 8983 and '''Index name''' to 'moodle' (the name of the index in Solr)
# If you are using Solr with SSL encryption and basic authentication (see below if you want to use client certificates instead), you will need to configure this.This is important if solr is not installed in the web server server.
## Go to ''Site administration > Plugins > Search > Solr''
## Set '''Secure mode''' to Yes
## Set port number if required (sometimes SSL installations use port 443).
## Type in the username and password.
# If you are using Solr with SSL encryption via client certificates, you will need to configure Moodle as such. This is important if solr is not installed in the web server server.
## You will need a separate key file and cacert file, both in pem format, located on your server Moodle, and readable by the PHP process.
## Go to ''Site administration > Plugins > Search > Solr''
## Set '''Secure mode''' to Yes
## '''SSL certificate''' to /path/to/certs/solr-ssl.cacert.pem
## '''SSL key''' to /path/to/certs/solr-ssl.key.pem
## '''SSL key Password''' to The password used to lock the SSL Key
## '''SSL CA certificates name''' to /path/to/certs/solr-ssl.cacert.pem
# You now need to populate the created Solr index with your site's data. You can do it via the web interface by going to ''Site administration > Reports > Global search info'' or from the CLI by running the <tt>search/cli/indexer.php</tt> script. The CLI script is the recommended option for big sites. <code># sudo -u www-run php search/cli/indexer.php --force</code>
# Enable Global search in ''Site administration > Advanced features''

====File Indexing====

Solr has the ability to index the contents of files, such as File resources and attachments to Forum posts. This uses the [https://tika.apache.org/ Tika] engine which comes bundled with Solr. To enable this feature:
# In ''Site administration > Plugins > Search > Solr'' enable the checkbox '''Enable file indexing'''
# Set '''Maximum file size to index (kB)''' to some value - the default is '''2097152''' (2GB)
#* Files larger than this limit will not be sent for Solr for indexing, but the file name will still be indexed.

'''New in 34:''' File indexing now works retroactively -ie, if you set up Global search without file indexing enabled and a later date you enable file indexing, files associated with existing objects will be included.

====How to install Solr====

You need PHP Solr extension installed. You can download the official latest versions from [http://pecl.php.net/package/solr PECL: Package: solr]. The minimum required version is PECL Solr 2.1 for PHP 5 branch and PECL Solr 2.4 for PHP 7 branch.

Basic installation steps (using apache web server):

===== Linux (Debian/Ubuntu) =====
Using APT:
sudo apt install php-solr
sudo service apache2 restart

If you can't install the SOLR PHP module via APT, try the following:

With PHP5.x
sudo apt-get install libpcre3-dev libxml2-dev libcurl4-openssl-dev
sudo apt-get install php5-dev
sudo apt-get install php-pear
sudo pecl install solr
sudo sh -c "echo 'extension=solr.so' > /etc/php5/apache2/conf.d/solr.ini"
sudo sh -c "echo 'extension=solr.so' > /etc/php5/cli/conf.d/solr.ini"
sudo service apache2 restart

With PHP 7
sudo apt-get install libpcre3-dev libxml2-dev libcurl4-openssl-dev
sudo apt-get install php7.0-dev
sudo apt-get install php-pear
sudo pecl install solr
sudo sh -c "echo 'extension=solr.so' > /etc/php/7.0/apache2/conf.d/solr.ini"
sudo sh -c "echo 'extension=solr.so' > /etc/php/7.0/cli/conf.d/solr.ini"
sudo service apache2 restart

===== Linux (Redhat/Centos 6 & 7) =====

====== Using built in php5 packages ======
yum install php-pecl-solr2
service httpd restart

====== Using 3rd party php7 packages (webtactic) ======
yum install libxml2-devel pcre-devel libcurl-devel php70w-devel php70w-pear
pecl install solr
echo "extension=solr.so" > /etc/php.d/solr.ini
service httpd restart

===== OSX using macports =====

sudo port install apache-solr4
sudo port install php54-solr

===== OSX using homebrew =====

brew install homebrew/php/php56-solr

===== Windows =====

* Check your PHP version (see Site admin > Server > PHP Info) for PHP version, compiler (eg VC15), architecture (eg x64), and thread safety.
* Get the matching PHP extension DLL from [https://pecl.php.net/package/solr PECL] (or [https://www.apachelounge.com/viewtopic.php?t=6359 this page] if not available on PECL).
* Add the DLL to you php\ext folder.
* Add the directive "extension=php_solr.dll" to your php.ini file.
* Restart your web server.
* Install the [https://www.java.com/en/download/manual.jsp Java Runtime Environment]
* Download Solr from the [https://archive.apache.org/dist/lucene/solr/ Solr Downloads page], eg solr-5.5.5.zip.
* Extract to an accessible place, eg: c:\solr-5.5.5
* From command line (as admin), in C:\solr-5.5.5, run...
** bin\solr start
** bin\solr status
** bin\solr create -c moodle
** bin\solr stop -all
* (As admin) Edit C:\solr-5.5.5\server\solr\moodle\conf\managed-schema, comment out lines...

* (As admin) Edit C:\solr-5.5.5\server\solr\moodle\conf\solrconfig.xml and change line...
<maxBooleanClauses>1024</maxBooleanClauses>
...to...
<maxBooleanClauses>32768</maxBooleanClauses>
* Create Scheduled task to start Solr
** General
*** Run whether user is logged on or not
*** Run at highest privileges
*** Configure for Windows Server 2016
** Triggers
*** At startup
*** Repeat every hour, indefinitely
** Actions
*** Start program
*** Script: C:\solr-5.5.5\bin\solr.cmd
*** Add arguments: start -m 2g
** Conditions
*** Uncheck: Start the task only when the computer is on AC power
** Settings
*** Uncheck: Stop the task if it runs longer than: ...
*** If the task is already running, then the following rule applies: Do not start a new instance
* Run the scheduled task manually (for now)
* At the command line, in c:\solr-5.5.5, run ''bin\solr status'' to check it is running
* Configure the Solr server in Moodle as below.
* Keep an eye on the amount of memory used with ''solr status'' and the Task Manager (see the Java process).

===== The Solr server =====

Note that for medium/large sites you may need to increase maxBooleanClauses setting. In [https://tracker.moodle.org/browse/MDL-54992 MDL-54992] we are working on an alternative way to query the server.

Please note that there is a security issue that affects some Solr versions. The patched versions are 5.5.5, 6.6.2, 7.1, 7.2 and all new versions are patched. If your Solr server version is lower but you can't upgrade to one of the patched versions it is recommended to disable the XML Query Parser.

The following example snippet (feel free to copy & paste into a .sh script with execution permissions) will download Solr 5.5.5 (replace it with latest 5.x) in the current directory, start the solr server and create an index in it named '''moodle''' to add moodle data to it. If wget gives an error, check http://www-us.apache.org/dist/lucene/solr and update SOLRVERSION

#!/bin/bash
set -e
SOLRVERSION=5.5.5
SOLRNAME=solr-$SOLRVERSION
SOLRTAR=$SOLRNAME'.tgz'
INDEXNAME=moodle
if [ -d $SOLRNAME ]; then
echo "Error: Directory $SOLRNAME already exists, remove it before starting the setup again."
exit 1
fi
if [ ! -f $SOLRTAR ]; then
wget http://www-us.apache.org/dist/lucene/solr/$SOLRVERSION/$SOLRTAR
fi
tar -xvzf $SOLRTAR
cd $SOLRNAME
bin/solr start
bin/solr create -c $INDEXNAME
# After setting it up and creating the index use:
# - "/yourdirectory/solrdir/bin/solr start" from CLI to start the server
# - "/yourdirectory/solrdir/bin/solr stop" from CLI to stop the server.

======Solr 5/6 schema setup======

Moodle will use Solr's managed schema interface to install the required fields. You will be directed on what to do from the Manage global search page.

For very large or busy sites, it is recommended that you manually remove the '''_text_''' field, and associated copy directive from, the default Solr schema. This field is not used by Moodle, and will significantly slow indexing, and increase the size of the resulting Solr core.

======Solr 4 schema setup======

You cannot use the schema setup script when using a Solr 4 server. If you really want to use the Solr 4x branch, here are the field types descriptions:

Extracted from search/classes/document.php

{| class="nicetable"
|-
! Field name
! Field type
! Stored
! Indexed
! Query field
|-
| id
| org.apache.solr.schema.StrField
| true
| false
| false
|-
| itemid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| title
| org.apache.solr.schema.TextField
| true
| true
| true
|-
| content
| org.apache.solr.schema.TextField
| true
| true
| true
|-
| contextid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| areaid
| org.apache.solr.schema.StrField
| true
| true
| false
|-
| type
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| courseid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| owneruserid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| modified
| org.apache.solr.schema.TrieDateField
| true
| true
| false
|-
| userid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| description1
| org.apache.solr.schema.TextField
| true
| true
| true
|-
| description2
| org.apache.solr.schema.TextField
| true
| true
| true
|-
| solr_filegroupingid
| org.apache.solr.schema.StrField
| true
| true
| false
|-
| solr_fileid
| org.apache.solr.schema.StrField
| true
| true
| false
|-
| solr_filecontenthash
| org.apache.solr.schema.StrField
| true
| true
| false
|-
| solr_fileindexstatus
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| solr_filecontent
| org.apache.solr.schema.TextField
| false
| true
| true
|}

======Memory and File indexing considerations======

For large sites, and particularly if you are using the File indexing feature, it's a good idea to give Solr plenty of memory, eg aound 10-20GB. To start Solr with more than its default 512MB of RAM, use the ''-m'' option:
solr start -m 12g

See the documents for your version of Solr on how to increases memory when Solr is started automatically.

======Too many boolean clauses error======

Because of the way Moodle handles permissions for searches, if you have non-admin users with access to a large number of activities (>1000), they may an error similar to the following:

The query you provided could not be parsed by the search engine: org.apache.solr.search.SyntaxError: Cannot parse
...
too many boolean clauses

To correct this, you need to increase the ''maxBooleanClauses'' setting in your Solr core. The setting is located in ''corename/conf/solrconfig.xml''.

This important note is included in the config file:
** WARNING **

This option actually modifies a global Lucene property that
will affect all SolrCores. If multiple solrconfig.xml files
disagree on this property, the value at any given moment will
be based on the last SolrCore to be initialized.

This means that for consistent behavior you should update this value for all cores in the Solr server.

=====Commannd for installing Solr Server on Centos 7=====
First of all install java (openjdk)
yum install java-1.8.0-openjdk
Add user for solr
adduser solr
Download solr server, find latest here : http://lucene.apache.org/solr/mirrors-solr-latest-redir.html, from the list there download latest solr-[version].tgz

Here is the list of needed commands (note that latest solr is suggested, change command to appropriate version)
cd /opt
wget http://www-eu.apache.org/dist/lucene/solr/6.6.0/solr-6.6.0.tgz
tar zxvf solr-6.6.0.tgz
cp solr-6.6.0/bin/install_solr_service.sh .
rm -rf solr-6.6.0
./install_solr_service.sh solr-6.6.0.tgz
chkconfig solr on
Create the index
su - solr -c "/opt/solr/bin/solr create_core -c moodle"
Then go to your Moodle and set index name as created (moodle)

==See also==

Forum discussions:
* [https://moodle.org/mod/forum/discuss.php?d=334938 Global search doesn't index plugins?]
* [https://moodle.org/mod/forum/discuss.php?d=339819 Global Search on Moodle 3.1]
* [https://moodle.org/mod/forum/discuss.php?d=384884 Global Search index repair]

'''MySQL Database Connection error with Simple Search:''' This SQL query should solve the issue

''ALTER TABLE mdl_search_simpledb_index ADD FULLTEXT(title, content, description1, description2)''

A quick introduction to Moodle global search, followed by a description of the new features and fixes in Moodle 3.4 (and some of those in Moodle 3.5).
*[https://www.slideshare.net/sammarshall_ou/moodle-global-search-nows-the-time-to-jump-in Presentation by Sam Marshall from the Open University]

[[es:Búsqueda global]]
[[de:Globale Suche]]
[[fr:Recherche globale]]

Redis cache store

2019-11-16T19:15:54Z

Deraadt:

{{Performance}}
The Redis cache store is one of the best options to handle session and application cache as it supports: data guarantee, locking, key awareness. (and also can be used for [[Session_handling#Redis_session_driver|user's sessions caching]] in the config.php file)

Before Redis is available as a cache store, you will need to install [[Redis]] service (daemon) on your Moodle server, locally in case of a single Moodle app node architecture or externally if you are using a cluster of Moodle nodes. only then, you can configure Redis as an application or session level cache store.

If you are configuring a cluster of Moodle servers/nodes, the [[Redis]] service (daemon) should be installed on an external server and all Moodle nodes (servers/instances) should point to that external Redis. So all user's data is available when the user is using (connected to) any of the Moodle nodes. An external Redis (NoSQL) service can be installed on the main SQL server alongside the MySQL/MariaDB service, just make sure you have enough memory allocated on that server for both services.

A good practice is to give the [[Redis]] cache store prefix a proper short name and not leave it empty, as later on, it might conflict with user's session Redis cache you might choose to use, or other Moodle instances that will be installed on the same server. for example "my-school-name_cs_", where you replace "my-school-name" with your short school name. (and if you are also using a user's session store on the config.php file, you might like to prefix it with "my-school-name_us_")

When using a cluster setup with several Moodle instances on each node that belong to different Schools/Institutes/clients, make sure that you use the same Prefix for all Moodle instances that are on different nodes and are of the same School/Institute/Client.

==Installing Redis server==
* [https://www.linode.com/docs/databases/redis/install-and-configure-redis-on-centos-7 install and configure redis on centos 7]
* [https://www.digitalocean.com/community/tutorials/how-to-install-and-secure-redis-on-ubuntu-18-04 install and configure redis on Ubuntu 18.04]
* [[Session_handling#Redis_session_driver]] and [https://www.digitalocean.com/community/tutorials/how-to-set-up-a-redis-server-as-a-session-handler-for-php-on-ubuntu-14-04 How to Set Up a Redis Server as a Session Handler for PHP]
* Install [https://dl.iuscommunity.org/pub/ius/stable/CentOS/7/x86_64/repoview/redis5.html Redis 5] via IUS CentOS 7 repository.
* [https://github.com/microsoftarchive/redis/releases Windows port] (the MSI file installs a service)

==Installing Redis php driver==
* For CentOS, you can use either [https://rpms.remirepo.net/ Remi] or [https://ius.io/ IUS] repositories, and install the [https://dl.iuscommunity.org/pub/ius/stable/CentOS/7/x86_64/repoview/php71u-pecl-redis.html php71u-pecl-redis] driver.
* [https://gist.github.com/hollodotme/418e9b7c6ebc358e7fda Redis php-fpm 7 driver on Ubuntu 14.04]
* [https://pecl.php.net/package/redis Windows PHP extensions] including DLLs for Windows. Check your PHP version, CPU (64bit or x86) and thread-safe value (see Site Admin > Server > PHP Info) to get the right version; add DLL file to ext directory, add 'extension=php_redis.dll' entry to php.ini and restart your web server.

==Configuring Redis in Moodle==
* Navigate to Site admin > Plugins > Caching > Configuration.
* When installed, you should see a tick next to "Redis" under "Installed cache stores" and a link to add an instance.
[[File:Redis_cache_ready.png]]
* Click "Add instance".
** Give your Redis instance a name, like "Redis1" and set the IP:port for the Redis server. If it is on the same machine, the default would be 127.0.0.1:6379.
** The new instance should appear under "Configured store instances" with a "Ready" tick.
* Under "Stores used when no mapping is present" click '''Edit mappings". Set "Redis1" (or the name used earlier) for the "Application" and "Session" caches.
[[File:Set_Redis_as_default_Application_and_Session_cache.png]]
* After saving this, you should see Redis as the cache for most cache stores.

==See also==
* [https://gist.github.com/kabel/10023961 Monitor Redis stats (a php one page app)]
* MDL-48468 : Add a Redis cache store to Moodle core

[[de:Redis Cache]]

Fil:Set Redis as default Application and Session cache.png

2019-11-16T19:09:28Z

Deraadt:

Fil:Redis cache ready.png

2019-11-16T19:08:39Z

Deraadt:

Completion Progress block

2016-08-19T22:16:56Z

Deraadt: /* Installation */

{{Infobox plugin
|type = Block, Completion Progress
|entry = https://moodle.org/plugins/view.php?plugin=block_completion_progress
|tracker = https://tracker.moodle.org/issues/?jql=project%20%3D%20CONTRIB%20AND%20component%20%3D%20%22Block%3A%20Completion%20Progress%22
|discussion = https://moodle.org/plugins/view.php?plugin=block_completion_progress
|maintainer = [[User:Michael de Raadt|Michael de Raadt]]
|float = right
}}
[[Blocks|Back to Blocks page]]

== Features ==

[[Image:Completion_Progress_bar_in_block_-_with_details.png|A progress bar for a student]]

* The Completion Progress is a time-management tool for students.
* It visually shows what activities/resources a student is supposed to interact with in a course.
* It is colour-coded so students can quickly see what they have and have not completed/viewed.
* The block relies on completion settings of activities/resources in the course and when they should be completed by.
* Ordering can be based on expected completion times or on the ordering of activities in the course.
* There is an Overview page allowing teachers to see the progress of all students in a class, which is helpful for finding students at risk.
* Adding the Completion Progress block to the [[Dashboard]] shows users a combined view of their progress from all courses they are enrolled in (where the block is set up).

[[Image:Completion_Progress_Overview_of_students_with_messaging.png|right|thumb|The overview page]]

== Installation ==

* Download the latest version of the block from [https://moodle.org/plugins/block_completion_progress its entry on the Plugins directory] or using its [https://github.com/deraadt/moodle-block_completion_progress Git repository].
* The Completion Progress block is added like other blocks ([[Installing_contributed_modules_or_plugins|How to install a block]]).
* In Moodle versions prior to 3.1, [[Activity completion]] needs to be enabled.

== Global settings ==

The Completion Progress block has a number of global settings that will be seen on installation and can be accessed later at Site administration > Plugins > Blocks > Completion Progress.
[[Image:Completion_Progress_Global_settings.png|thumb|Global settings]]
* ''When wrapping, limit rows to...'' The progress bar shown in the block can be wrapped. This setting allows some control of how long the bar should be before wrapping. The default is 16.
* ''Default presentation for long bars'' The bar can be displayed by squeezing all segments, wrapping segments over multiple lines or allowing the bar to scroll. The default is to Squeeze.
* ''Course name to show on Dashboard'' The block can be added to the dashboard and combines visible Completion Progress block content from the courses a user is enrolled in. By default, the course name shown for each relevant course, is the short course name, but some institutions/organisations may not think this is appropriate in relation to their course naming scheme, so a long course name can be selected.
* ''Colours'' By default, the colours used in the block are red, blue and green. In certain cultures these colours may not have the same meaning. Also, institutions/organisations may wish to use colours that match their theme.
* ''Show inactive students in Overview'' In most cases, inactive students are not wanted in course lists, such as the Overview page associated with the block. However, in some cases, such as ongoing courses, inactive students might need to be visible on the Overview page.

== Capabilities (Controlling who sees parts of the block) ==

The block uses a number of capabilities that are added when the block is installed.

[[Image:Completion_Progress_Capabilities.png|thumb|Capabilities]]

* ''Add a Completion Progress block to My home'' (block/completion_progress:myaddinstance) Controls whether the Completion Progress block can be added by a user to the Dashboard (formerly My home) page. By default, this is allowed for all authenticated users.
* ''Add a new Completion Progress block'' (block/completion_progress:addinstance) Controls whether the Completion Progress block can be added to a course page. By default, this is allowed for the following archetypal roles.
** Teacher (editingteacher)
** Manager (manager)
** Course creator (coursecreator)
** (and Admins)
* ''View course overview of Completion Progress for all students'' (block/completion_progress:overview) Controls whether the Overview page and the button on the Completion Progress block used to access the Overview page can be viewed by a user. By default, this is allowed for the following archetypal roles.
** Non-editing teacher (teacher)
** Teacher (editingteacher)
** Manager (manager)
** Course creator (coursecreator)
** (and Admins)
* ''Show the bar in the Completion Progress block'' (block/completion_progress:showbar) Controls whether the bar in the Completion Progress block is shown to a user. The reason for not showing this to certain users is that this might not be relevant and possibly annoying. By default, this is shown to the following archetypal roles.
** Non-editing teacher (teacher)
** Teacher (editingteacher)
** Student (student)
** (and Admins)

== Setting up a Completion Progress block in a course ==

In Moodle versions prior to 3.1, [[Activity completion]] needs to be enabled.

Once the block is installed on your site, you can use it in a course as follows.
# Turn editing on
# Create your activities/resources as normal
# Set completion settings for each activity you want to appear in the bar, including an expected by date
# Add the Completion Progress block to your page ([[Blocks|How to add a block]])
# Move your block into a prominent position (click and drag the block title)
# Choose to:
#(Optional) Configure how the block should appear

Hidden items will not appear in the Completion Progress block until they are unhidden. This is useful for a scheduled release of activities.

== Links ==

* [http://moodle.org/plugins/view.php?plugin=block_completion_progress Block in Plugins Directory]
* [https://tracker.moodle.org/issues/?jql=project%20%3D%20CONTRIB%20AND%20component%20%3D%20%22Block%3A%20Completion%20Progress%22 Bug Tracker Page] (Please report bugs here.)
* [https://github.com/deraadt/moodle-block_completion_progress Git repository]

[[Category:Contributed code]]
[[Category:Block]]

[[es:Bloque de Progreso de Finalización]]

Completion Progress block

2016-08-19T22:16:12Z

Deraadt: Add links in install instructions

{{Infobox plugin
|type = Block, Completion Progress
|entry = https://moodle.org/plugins/view.php?plugin=block_completion_progress
|tracker = https://tracker.moodle.org/issues/?jql=project%20%3D%20CONTRIB%20AND%20component%20%3D%20%22Block%3A%20Completion%20Progress%22
|discussion = https://moodle.org/plugins/view.php?plugin=block_completion_progress
|maintainer = [[User:Michael de Raadt|Michael de Raadt]]
|float = right
}}
[[Blocks|Back to Blocks page]]

== Features ==

[[Image:Completion_Progress_bar_in_block_-_with_details.png|A progress bar for a student]]

* The Completion Progress is a time-management tool for students.
* It visually shows what activities/resources a student is supposed to interact with in a course.
* It is colour-coded so students can quickly see what they have and have not completed/viewed.
* The block relies on completion settings of activities/resources in the course and when they should be completed by.
* Ordering can be based on expected completion times or on the ordering of activities in the course.
* There is an Overview page allowing teachers to see the progress of all students in a class, which is helpful for finding students at risk.
* Adding the Completion Progress block to the [[Dashboard]] shows users a combined view of their progress from all courses they are enrolled in (where the block is set up).

[[Image:Completion_Progress_Overview_of_students_with_messaging.png|right|thumb|The overview page]]

== Installation ==

* Grab the latest version of the block from [https://moodle.org/plugins/block_completion_progress its entry on the Plugins directory] or using its [https://github.com/deraadt/moodle-block_completion_progress Git repository].
* The Completion Progress block is added like other blocks ([[Installing_contributed_modules_or_plugins|How to install a block]]).
* In Moodle versions prior to 3.1, [[Activity completion]] needs to be enabled.

== Global settings ==

The Completion Progress block has a number of global settings that will be seen on installation and can be accessed later at Site administration > Plugins > Blocks > Completion Progress.
[[Image:Completion_Progress_Global_settings.png|thumb|Global settings]]
* ''When wrapping, limit rows to...'' The progress bar shown in the block can be wrapped. This setting allows some control of how long the bar should be before wrapping. The default is 16.
* ''Default presentation for long bars'' The bar can be displayed by squeezing all segments, wrapping segments over multiple lines or allowing the bar to scroll. The default is to Squeeze.
* ''Course name to show on Dashboard'' The block can be added to the dashboard and combines visible Completion Progress block content from the courses a user is enrolled in. By default, the course name shown for each relevant course, is the short course name, but some institutions/organisations may not think this is appropriate in relation to their course naming scheme, so a long course name can be selected.
* ''Colours'' By default, the colours used in the block are red, blue and green. In certain cultures these colours may not have the same meaning. Also, institutions/organisations may wish to use colours that match their theme.
* ''Show inactive students in Overview'' In most cases, inactive students are not wanted in course lists, such as the Overview page associated with the block. However, in some cases, such as ongoing courses, inactive students might need to be visible on the Overview page.

== Capabilities (Controlling who sees parts of the block) ==

The block uses a number of capabilities that are added when the block is installed.

[[Image:Completion_Progress_Capabilities.png|thumb|Capabilities]]

* ''Add a Completion Progress block to My home'' (block/completion_progress:myaddinstance) Controls whether the Completion Progress block can be added by a user to the Dashboard (formerly My home) page. By default, this is allowed for all authenticated users.
* ''Add a new Completion Progress block'' (block/completion_progress:addinstance) Controls whether the Completion Progress block can be added to a course page. By default, this is allowed for the following archetypal roles.
** Teacher (editingteacher)
** Manager (manager)
** Course creator (coursecreator)
** (and Admins)
* ''View course overview of Completion Progress for all students'' (block/completion_progress:overview) Controls whether the Overview page and the button on the Completion Progress block used to access the Overview page can be viewed by a user. By default, this is allowed for the following archetypal roles.
** Non-editing teacher (teacher)
** Teacher (editingteacher)
** Manager (manager)
** Course creator (coursecreator)
** (and Admins)
* ''Show the bar in the Completion Progress block'' (block/completion_progress:showbar) Controls whether the bar in the Completion Progress block is shown to a user. The reason for not showing this to certain users is that this might not be relevant and possibly annoying. By default, this is shown to the following archetypal roles.
** Non-editing teacher (teacher)
** Teacher (editingteacher)
** Student (student)
** (and Admins)

== Setting up a Completion Progress block in a course ==

In Moodle versions prior to 3.1, [[Activity completion]] needs to be enabled.

Once the block is installed on your site, you can use it in a course as follows.
# Turn editing on
# Create your activities/resources as normal
# Set completion settings for each activity you want to appear in the bar, including an expected by date
# Add the Completion Progress block to your page ([[Blocks|How to add a block]])
# Move your block into a prominent position (click and drag the block title)
# Choose to:
#(Optional) Configure how the block should appear

Hidden items will not appear in the Completion Progress block until they are unhidden. This is useful for a scheduled release of activities.

== Links ==

* [http://moodle.org/plugins/view.php?plugin=block_completion_progress Block in Plugins Directory]
* [https://tracker.moodle.org/issues/?jql=project%20%3D%20CONTRIB%20AND%20component%20%3D%20%22Block%3A%20Completion%20Progress%22 Bug Tracker Page] (Please report bugs here.)
* [https://github.com/deraadt/moodle-block_completion_progress Git repository]

[[Category:Contributed code]]
[[Category:Block]]

[[es:Bloque de Progreso de Finalización]]

Completion Progress block

2016-08-18T11:34:06Z

Deraadt:

{{Infobox plugin
|type = Block, Completion Progress
|entry = https://moodle.org/plugins/view.php?plugin=block_completion_progress
|tracker = https://tracker.moodle.org/issues/?jql=project%20%3D%20CONTRIB%20AND%20component%20%3D%20%22Block%3A%20Completion%20Progress%22
|discussion = https://moodle.org/plugins/view.php?plugin=block_completion_progress
|maintainer = [[User:Michael de Raadt|Michael de Raadt]]
|float = right
}}
[[Blocks|Back to Blocks page]]

== Features ==

[[Image:Completion_Progress_bar_in_block_-_with_details.png|A progress bar for a student]]

* The Completion Progress is a time-management tool for students.
* It visually shows what activities/resources a student is supposed to interact with in a course.
* It is colour-coded so students can quickly see what they have and have not completed/viewed.
* The block relies on completion settings of activities/resources in the course and when they should be completed by.
* Ordering can be based on expected completion times or on the ordering of activities in the course.
* There is an Overview page allowing teachers to see the progress of all students in a class, which is helpful for finding students at risk.
* Adding the Completion Progress block to the [[Dashboard]] shows users a combined view of their progress from all courses they are enrolled in (where the block is set up).

[[Image:Completion_Progress_Overview_of_students_with_messaging.png|right|thumb|The overview page]]

== Installation ==

* The Completion Progress block is added like other blocks ([[Installing_contributed_modules_or_plugins|How to install a block]]).
* In Moodle versions prior to 3.1, [[Activity completion]] needs to be enabled.

== Global settings ==

The Completion Progress block has a number of global settings that will be seen on installation and can be accessed later at Site administration > Plugins > Blocks > Completion Progress.
[[Image:Completion_Progress_Global_settings.png|thumb|Global settings]]
* ''When wrapping, limit rows to...'' The progress bar shown in the block can be wrapped. This setting allows some control of how long the bar should be before wrapping. The default is 16.
* ''Default presentation for long bars'' The bar can be displayed by squeezing all segments, wrapping segments over multiple lines or allowing the bar to scroll. The default is to Squeeze.
* ''Course name to show on Dashboard'' The block can be added to the dashboard and combines visible Completion Progress block content from the courses a user is enrolled in. By default, the course name shown for each relevant course, is the short course name, but some institutions/organisations may not think this is appropriate in relation to their course naming scheme, so a long course name can be selected.
* ''Colours'' By default, the colours used in the block are red, blue and green. In certain cultures these colours may not have the same meaning. Also, institutions/organisations may wish to use colours that match their theme.
* ''Show inactive students in Overview'' In most cases, inactive students are not wanted in course lists, such as the Overview page associated with the block. However, in some cases, such as ongoing courses, inactive students might need to be visible on the Overview page.

== Capabilities (Controlling who sees parts of the block) ==

The block uses a number of capabilities that are added when the block is installed.

[[Image:Completion_Progress_Capabilities.png|thumb|Capabilities]]

* ''Add a Completion Progress block to My home'' (block/completion_progress:myaddinstance) Controls whether the Completion Progress block can be added by a user to the Dashboard (formerly My home) page. By default, this is allowed for all authenticated users.
* ''Add a new Completion Progress block'' (block/completion_progress:addinstance) Controls whether the Completion Progress block can be added to a course page. By default, this is allowed for the following archetypal roles.
** Teacher (editingteacher)
** Manager (manager)
** Course creator (coursecreator)
** (and Admins)
* ''View course overview of Completion Progress for all students'' (block/completion_progress:overview) Controls whether the Overview page and the button on the Completion Progress block used to access the Overview page can be viewed by a user. By default, this is allowed for the following archetypal roles.
** Non-editing teacher (teacher)
** Teacher (editingteacher)
** Manager (manager)
** Course creator (coursecreator)
** (and Admins)
* ''Show the bar in the Completion Progress block'' (block/completion_progress:showbar) Controls whether the bar in the Completion Progress block is shown to a user. The reason for not showing this to certain users is that this might not be relevant and possibly annoying. By default, this is shown to the following archetypal roles.
** Non-editing teacher (teacher)
** Teacher (editingteacher)
** Student (student)
** (and Admins)

== Setting up a Completion Progress block in a course ==

In Moodle versions prior to 3.1, [[Activity completion]] needs to be enabled.

Once the block is installed on your site, you can use it in a course as follows.
# Turn editing on
# Create your activities/resources as normal
# Set completion settings for each activity you want to appear in the bar, including an expected by date
# Add the Completion Progress block to your page ([[Blocks|How to add a block]])
# Move your block into a prominent position (click and drag the block title)
# Choose to:
#(Optional) Configure how the block should appear

Hidden items will not appear in the Completion Progress block until they are unhidden. This is useful for a scheduled release of activities.

== Links ==

* [http://moodle.org/plugins/view.php?plugin=block_completion_progress Block in Plugins Directory]
* [https://tracker.moodle.org/issues/?jql=project%20%3D%20CONTRIB%20AND%20component%20%3D%20%22Block%3A%20Completion%20Progress%22 Bug Tracker Page] (Please report bugs here.)
* [https://github.com/deraadt/moodle-block_completion_progress Git repository]

[[Category:Contributed code]]
[[Category:Block]]

[[es:Bloque de Progreso de Finalización]]

Completion Progress block

2016-08-18T11:33:07Z

Deraadt: Fixing tracker link

{{Infobox plugin
|type = Block, Completion Progress
|entry = https://moodle.org/plugins/view.php?plugin=block_completion_progress
|tracker = https://tracker.moodle.org/browse/CONTRIB/component/XXX/?selectedTab=com.atlassian.jira.jira-projects-plugin:component-summary-panel
|discussion = https://moodle.org/plugins/view.php?plugin=block_completion_progress
|maintainer = [[User:Michael de Raadt|Michael de Raadt]]
|float = right
}}
[[Blocks|Back to Blocks page]]

== Features ==

[[Image:Completion_Progress_bar_in_block_-_with_details.png|A progress bar for a student]]

* The Completion Progress is a time-management tool for students.
* It visually shows what activities/resources a student is supposed to interact with in a course.
* It is colour-coded so students can quickly see what they have and have not completed/viewed.
* The block relies on completion settings of activities/resources in the course and when they should be completed by.
* Ordering can be based on expected completion times or on the ordering of activities in the course.
* There is an Overview page allowing teachers to see the progress of all students in a class, which is helpful for finding students at risk.
* Adding the Completion Progress block to the [[Dashboard]] shows users a combined view of their progress from all courses they are enrolled in (where the block is set up).

[[Image:Completion_Progress_Overview_of_students_with_messaging.png|right|thumb|The overview page]]

== Installation ==

* The Completion Progress block is added like other blocks ([[Installing_contributed_modules_or_plugins|How to install a block]]).
* In Moodle versions prior to 3.1, [[Activity completion]] needs to be enabled.

== Global settings ==

The Completion Progress block has a number of global settings that will be seen on installation and can be accessed later at Site administration > Plugins > Blocks > Completion Progress.
[[Image:Completion_Progress_Global_settings.png|thumb|Global settings]]
* ''When wrapping, limit rows to...'' The progress bar shown in the block can be wrapped. This setting allows some control of how long the bar should be before wrapping. The default is 16.
* ''Default presentation for long bars'' The bar can be displayed by squeezing all segments, wrapping segments over multiple lines or allowing the bar to scroll. The default is to Squeeze.
* ''Course name to show on Dashboard'' The block can be added to the dashboard and combines visible Completion Progress block content from the courses a user is enrolled in. By default, the course name shown for each relevant course, is the short course name, but some institutions/organisations may not think this is appropriate in relation to their course naming scheme, so a long course name can be selected.
* ''Colours'' By default, the colours used in the block are red, blue and green. In certain cultures these colours may not have the same meaning. Also, institutions/organisations may wish to use colours that match their theme.
* ''Show inactive students in Overview'' In most cases, inactive students are not wanted in course lists, such as the Overview page associated with the block. However, in some cases, such as ongoing courses, inactive students might need to be visible on the Overview page.

== Capabilities (Controlling who sees parts of the block) ==

The block uses a number of capabilities that are added when the block is installed.

[[Image:Completion_Progress_Capabilities.png|thumb|Capabilities]]

* ''Add a Completion Progress block to My home'' (block/completion_progress:myaddinstance) Controls whether the Completion Progress block can be added by a user to the Dashboard (formerly My home) page. By default, this is allowed for all authenticated users.
* ''Add a new Completion Progress block'' (block/completion_progress:addinstance) Controls whether the Completion Progress block can be added to a course page. By default, this is allowed for the following archetypal roles.
** Teacher (editingteacher)
** Manager (manager)
** Course creator (coursecreator)
** (and Admins)
* ''View course overview of Completion Progress for all students'' (block/completion_progress:overview) Controls whether the Overview page and the button on the Completion Progress block used to access the Overview page can be viewed by a user. By default, this is allowed for the following archetypal roles.
** Non-editing teacher (teacher)
** Teacher (editingteacher)
** Manager (manager)
** Course creator (coursecreator)
** (and Admins)
* ''Show the bar in the Completion Progress block'' (block/completion_progress:showbar) Controls whether the bar in the Completion Progress block is shown to a user. The reason for not showing this to certain users is that this might not be relevant and possibly annoying. By default, this is shown to the following archetypal roles.
** Non-editing teacher (teacher)
** Teacher (editingteacher)
** Student (student)
** (and Admins)

== Setting up a Completion Progress block in a course ==

In Moodle versions prior to 3.1, [[Activity completion]] needs to be enabled.

Once the block is installed on your site, you can use it in a course as follows.
# Turn editing on
# Create your activities/resources as normal
# Set completion settings for each activity you want to appear in the bar, including an expected by date
# Add the Completion Progress block to your page ([[Blocks|How to add a block]])
# Move your block into a prominent position (click and drag the block title)
# Choose to:
#(Optional) Configure how the block should appear

Hidden items will not appear in the Completion Progress block until they are unhidden. This is useful for a scheduled release of activities.

== Links ==

* [http://moodle.org/plugins/view.php?plugin=block_completion_progress Block in Plugins Directory]
* [https://tracker.moodle.org/issues/?jql=project%20%3D%20CONTRIB%20AND%20component%20%3D%20%22Block%3A%20Completion%20Progress%22 Bug Tracker Page] (Please report bugs here.)
* [https://github.com/deraadt/moodle-block_completion_progress Git repository]

[[Category:Contributed code]]
[[Category:Block]]

[[es:Bloque de Progreso de Finalización]]

Completion Progress block

2016-08-18T11:30:19Z

Deraadt: /* Capabilities (Controlling who sees parts of the block) */

{{Infobox plugin
|type = Block, Completion Progress
|entry = https://moodle.org/plugins/view.php?plugin=block_completion_progress
|tracker = https://tracker.moodle.org/browse/CONTRIB/component/XXX/?selectedTab=com.atlassian.jira.jira-projects-plugin:component-summary-panel
|discussion = https://moodle.org/plugins/view.php?plugin=block_completion_progress
|maintainer = [[User:Michael de Raadt|Michael de Raadt]]
|float = right
}}
[[Blocks|Back to Blocks page]]

== Features ==

[[Image:Completion_Progress_bar_in_block_-_with_details.png|right|A progress bar for a student]]

* The Completion Progress is a time-management tool for students.
* It visually shows what activities/resources a student is supposed to interact with in a course.
* It is colour-coded so students can quickly see what they have and have not completed/viewed.
* The block relies on completion settings of activities/resources in the course and when they should be completed by.
* Ordering can be based on expected completion times or on the ordering of activities in the course.
* There is an Overview page allowing teachers to see the progress of all students in a class, which is helpful for finding students at risk.
* Adding the Completion Progress block to the [[Dashboard]] shows users a combined view of their progress from all courses they are enrolled in (where the block is set up).

[[Image:Completion_Progress_Overview_of_students_with_messaging.png|right|thumb|The overview page]]

== Installation ==

* The Completion Progress block is added like other blocks ([[Installing_contributed_modules_or_plugins|How to install a block]]).
* In Moodle versions prior to 3.1, [[Activity completion]] needs to be enabled.

== Global settings ==

The Completion Progress block has a number of global settings that will be seen on installation and can be accessed later at Site administration > Plugins > Blocks > Completion Progress.
[[Image:Completion_Progress_Global_settings.png|thumb|Global settings]]
* ''When wrapping, limit rows to...'' The progress bar shown in the block can be wrapped. This setting allows some control of how long the bar should be before wrapping. The default is 16.
* ''Default presentation for long bars'' The bar can be displayed by squeezing all segments, wrapping segments over multiple lines or allowing the bar to scroll. The default is to Squeeze.
* ''Course name to show on Dashboard'' The block can be added to the dashboard and combines visible Completion Progress block content from the courses a user is enrolled in. By default, the course name shown for each relevant course, is the short course name, but some institutions/organisations may not think this is appropriate in relation to their course naming scheme, so a long course name can be selected.
* ''Colours'' By default, the colours used in the block are red, blue and green. In certain cultures these colours may not have the same meaning. Also, institutions/organisations may wish to use colours that match their theme.
* ''Show inactive students in Overview'' In most cases, inactive students are not wanted in course lists, such as the Overview page associated with the block. However, in some cases, such as ongoing courses, inactive students might need to be visible on the Overview page.

== Capabilities (Controlling who sees parts of the block) ==

The block uses a number of capabilities that are added when the block is installed.

[[Image:Completion_Progress_Capabilities.png|thumb|Capabilities]]

* ''Add a Completion Progress block to My home'' (block/completion_progress:myaddinstance) Controls whether the Completion Progress block can be added by a user to the Dashboard (formerly My home) page. By default, this is allowed for all authenticated users.
* ''Add a new Completion Progress block'' (block/completion_progress:addinstance) Controls whether the Completion Progress block can be added to a course page. By default, this is allowed for the following archetypal roles.
** Teacher (editingteacher)
** Manager (manager)
** Course creator (coursecreator)
** (and Admins)
* ''View course overview of Completion Progress for all students'' (block/completion_progress:overview) Controls whether the Overview page and the button on the Completion Progress block used to access the Overview page can be viewed by a user. By default, this is allowed for the following archetypal roles.
** Non-editing teacher (teacher)
** Teacher (editingteacher)
** Manager (manager)
** Course creator (coursecreator)
** (and Admins)
* ''Show the bar in the Completion Progress block'' (block/completion_progress:showbar) Controls whether the bar in the Completion Progress block is shown to a user. The reason for not showing this to certain users is that this might not be relevant and possibly annoying. By default, this is shown to the following archetypal roles.
** Non-editing teacher (teacher)
** Teacher (editingteacher)
** Student (student)
** (and Admins)

== Setting up a Completion Progress block in a course ==

In Moodle versions prior to 3.1, [[Activity completion]] needs to be enabled.

Once the block is installed on your site, you can use it in a course as follows.
# Turn editing on
# Create your activities/resources as normal
# Set completion settings for each activity you want to appear in the bar, including an expected by date
# Add the Completion Progress block to your page ([[Blocks|How to add a block]])
# Move your block into a prominent position (click and drag the block title)
# Choose to:
#(Optional) Configure how the block should appear

Hidden items will not appear in the Completion Progress block until they are unhidden. This is useful for a scheduled release of activities.

== Links ==

* [http://moodle.org/plugins/view.php?plugin=block_completion_progress Block in Plugins repository]
* [http://tracker.moodle.org/browse/CONTRIB/component/XXX Bug Tracker Page] (Please report bugs here.)
* [https://github.com/deraadt/moodle-block_completion_progress Git repository]

[[Category:Contributed code]]
[[Category:Block]]

[[es:Bloque de Progreso de Finalización]]

Completion Progress block

2016-08-18T11:29:53Z

Deraadt: Fixing image label

{{Infobox plugin
|type = Block, Completion Progress
|entry = https://moodle.org/plugins/view.php?plugin=block_completion_progress
|tracker = https://tracker.moodle.org/browse/CONTRIB/component/XXX/?selectedTab=com.atlassian.jira.jira-projects-plugin:component-summary-panel
|discussion = https://moodle.org/plugins/view.php?plugin=block_completion_progress
|maintainer = [[User:Michael de Raadt|Michael de Raadt]]
|float = right
}}
[[Blocks|Back to Blocks page]]

== Features ==

[[Image:Completion_Progress_bar_in_block_-_with_details.png|right|A progress bar for a student]]

* The Completion Progress is a time-management tool for students.
* It visually shows what activities/resources a student is supposed to interact with in a course.
* It is colour-coded so students can quickly see what they have and have not completed/viewed.
* The block relies on completion settings of activities/resources in the course and when they should be completed by.
* Ordering can be based on expected completion times or on the ordering of activities in the course.
* There is an Overview page allowing teachers to see the progress of all students in a class, which is helpful for finding students at risk.
* Adding the Completion Progress block to the [[Dashboard]] shows users a combined view of their progress from all courses they are enrolled in (where the block is set up).

[[Image:Completion_Progress_Overview_of_students_with_messaging.png|right|thumb|The overview page]]

== Installation ==

* The Completion Progress block is added like other blocks ([[Installing_contributed_modules_or_plugins|How to install a block]]).
* In Moodle versions prior to 3.1, [[Activity completion]] needs to be enabled.

== Global settings ==

The Completion Progress block has a number of global settings that will be seen on installation and can be accessed later at Site administration > Plugins > Blocks > Completion Progress.
[[Image:Completion_Progress_Global_settings.png|thumb|Global settings]]
* ''When wrapping, limit rows to...'' The progress bar shown in the block can be wrapped. This setting allows some control of how long the bar should be before wrapping. The default is 16.
* ''Default presentation for long bars'' The bar can be displayed by squeezing all segments, wrapping segments over multiple lines or allowing the bar to scroll. The default is to Squeeze.
* ''Course name to show on Dashboard'' The block can be added to the dashboard and combines visible Completion Progress block content from the courses a user is enrolled in. By default, the course name shown for each relevant course, is the short course name, but some institutions/organisations may not think this is appropriate in relation to their course naming scheme, so a long course name can be selected.
* ''Colours'' By default, the colours used in the block are red, blue and green. In certain cultures these colours may not have the same meaning. Also, institutions/organisations may wish to use colours that match their theme.
* ''Show inactive students in Overview'' In most cases, inactive students are not wanted in course lists, such as the Overview page associated with the block. However, in some cases, such as ongoing courses, inactive students might need to be visible on the Overview page.

== Capabilities (Controlling who sees parts of the block) ==

The block uses a number of capabilities that are added when the block is installed.

[[Image:Completion_Progress_Capabilities.png|thumb|Capabilities]

* ''Add a Completion Progress block to My home'' (block/completion_progress:myaddinstance) Controls whether the Completion Progress block can be added by a user to the Dashboard (formerly My home) page. By default, this is allowed for all authenticated users.
* ''Add a new Completion Progress block'' (block/completion_progress:addinstance) Controls whether the Completion Progress block can be added to a course page. By default, this is allowed for the following archetypal roles.
** Teacher (editingteacher)
** Manager (manager)
** Course creator (coursecreator)
** (and Admins)
* ''View course overview of Completion Progress for all students'' (block/completion_progress:overview) Controls whether the Overview page and the button on the Completion Progress block used to access the Overview page can be viewed by a user. By default, this is allowed for the following archetypal roles.
** Non-editing teacher (teacher)
** Teacher (editingteacher)
** Manager (manager)
** Course creator (coursecreator)
** (and Admins)
* ''Show the bar in the Completion Progress block'' (block/completion_progress:showbar) Controls whether the bar in the Completion Progress block is shown to a user. The reason for not showing this to certain users is that this might not be relevant and possibly annoying. By default, this is shown to the following archetypal roles.
** Non-editing teacher (teacher)
** Teacher (editingteacher)
** Student (student)
** (and Admins)

== Setting up a Completion Progress block in a course ==

In Moodle versions prior to 3.1, [[Activity completion]] needs to be enabled.

Once the block is installed on your site, you can use it in a course as follows.
# Turn editing on
# Create your activities/resources as normal
# Set completion settings for each activity you want to appear in the bar, including an expected by date
# Add the Completion Progress block to your page ([[Blocks|How to add a block]])
# Move your block into a prominent position (click and drag the block title)
# Choose to:
#(Optional) Configure how the block should appear

Hidden items will not appear in the Completion Progress block until they are unhidden. This is useful for a scheduled release of activities.

== Links ==

* [http://moodle.org/plugins/view.php?plugin=block_completion_progress Block in Plugins repository]
* [http://tracker.moodle.org/browse/CONTRIB/component/XXX Bug Tracker Page] (Please report bugs here.)
* [https://github.com/deraadt/moodle-block_completion_progress Git repository]

[[Category:Contributed code]]
[[Category:Block]]

[[es:Bloque de Progreso de Finalización]]

Completion Progress block

2016-08-18T11:29:03Z

Deraadt: Fixing images

{{Infobox plugin
|type = Block, Completion Progress
|entry = https://moodle.org/plugins/view.php?plugin=block_completion_progress
|tracker = https://tracker.moodle.org/browse/CONTRIB/component/XXX/?selectedTab=com.atlassian.jira.jira-projects-plugin:component-summary-panel
|discussion = https://moodle.org/plugins/view.php?plugin=block_completion_progress
|maintainer = [[User:Michael de Raadt|Michael de Raadt]]
|float = right
}}
[[Blocks|Back to Blocks page]]

== Features ==

[[Image:Completion_Progress_bar_in_block_-_with_details.png|right|A progress bar for a student]]

* The Completion Progress is a time-management tool for students.
* It visually shows what activities/resources a student is supposed to interact with in a course.
* It is colour-coded so students can quickly see what they have and have not completed/viewed.
* The block relies on completion settings of activities/resources in the course and when they should be completed by.
* Ordering can be based on expected completion times or on the ordering of activities in the course.
* There is an Overview page allowing teachers to see the progress of all students in a class, which is helpful for finding students at risk.
* Adding the Completion Progress block to the [[Dashboard]] shows users a combined view of their progress from all courses they are enrolled in (where the block is set up).

[[Image:Completion_Progress_Overview_of_students_with_messaging.png|right|thumb|The overview page]]

== Installation ==

* The Completion Progress block is added like other blocks ([[Installing_contributed_modules_or_plugins|How to install a block]]).
* In Moodle versions prior to 3.1, [[Activity completion]] needs to be enabled.

== Global settings ==

The Completion Progress block has a number of global settings that will be seen on installation and can be accessed later at Site administration > Plugins > Blocks > Completion Progress.
[[Image:Completion_Progress_Global_settings.png|thumb|Global settings]]
* ''When wrapping, limit rows to...'' The progress bar shown in the block can be wrapped. This setting allows some control of how long the bar should be before wrapping. The default is 16.
* ''Default presentation for long bars'' The bar can be displayed by squeezing all segments, wrapping segments over multiple lines or allowing the bar to scroll. The default is to Squeeze.
* ''Course name to show on Dashboard'' The block can be added to the dashboard and combines visible Completion Progress block content from the courses a user is enrolled in. By default, the course name shown for each relevant course, is the short course name, but some institutions/organisations may not think this is appropriate in relation to their course naming scheme, so a long course name can be selected.
* ''Colours'' By default, the colours used in the block are red, blue and green. In certain cultures these colours may not have the same meaning. Also, institutions/organisations may wish to use colours that match their theme.
* ''Show inactive students in Overview'' In most cases, inactive students are not wanted in course lists, such as the Overview page associated with the block. However, in some cases, such as ongoing courses, inactive students might need to be visible on the Overview page.

== Capabilities (Controlling who sees parts of the block) ==

The block uses a number of capabilities that are added when the block is installed.
[[Image:Completion_Progress_Capabilities.png|thumb|Global settings]]
* ''Add a Completion Progress block to My home'' (block/completion_progress:myaddinstance) Controls whether the Completion Progress block can be added by a user to the Dashboard (formerly My home) page. By default, this is allowed for all authenticated users.
* ''Add a new Completion Progress block'' (block/completion_progress:addinstance) Controls whether the Completion Progress block can be added to a course page. By default, this is allowed for the following archetypal roles.
** Teacher (editingteacher)
** Manager (manager)
** Course creator (coursecreator)
** (and Admins)
* ''View course overview of Completion Progress for all students'' (block/completion_progress:overview) Controls whether the Overview page and the button on the Completion Progress block used to access the Overview page can be viewed by a user. By default, this is allowed for the following archetypal roles.
** Non-editing teacher (teacher)
** Teacher (editingteacher)
** Manager (manager)
** Course creator (coursecreator)
** (and Admins)
* ''Show the bar in the Completion Progress block'' (block/completion_progress:showbar) Controls whether the bar in the Completion Progress block is shown to a user. The reason for not showing this to certain users is that this might not be relevant and possibly annoying. By default, this is shown to the following archetypal roles.
** Non-editing teacher (teacher)
** Teacher (editingteacher)
** Student (student)
** (and Admins)

== Setting up a Completion Progress block in a course ==

In Moodle versions prior to 3.1, [[Activity completion]] needs to be enabled.

Once the block is installed on your site, you can use it in a course as follows.
# Turn editing on
# Create your activities/resources as normal
# Set completion settings for each activity you want to appear in the bar, including an expected by date
# Add the Completion Progress block to your page ([[Blocks|How to add a block]])
# Move your block into a prominent position (click and drag the block title)
# Choose to:
#(Optional) Configure how the block should appear

Hidden items will not appear in the Completion Progress block until they are unhidden. This is useful for a scheduled release of activities.

== Links ==

* [http://moodle.org/plugins/view.php?plugin=block_completion_progress Block in Plugins repository]
* [http://tracker.moodle.org/browse/CONTRIB/component/XXX Bug Tracker Page] (Please report bugs here.)
* [https://github.com/deraadt/moodle-block_completion_progress Git repository]

[[Category:Contributed code]]
[[Category:Block]]

[[es:Bloque de Progreso de Finalización]]

Completion Progress block

2016-08-18T11:27:08Z

Deraadt: Note about activity completion.

{{Infobox plugin
|type = Block, Completion Progress
|entry = https://moodle.org/plugins/view.php?plugin=block_completion_progress
|tracker = https://tracker.moodle.org/browse/CONTRIB/component/XXX/?selectedTab=com.atlassian.jira.jira-projects-plugin:component-summary-panel
|discussion = https://moodle.org/plugins/view.php?plugin=block_completion_progress
|maintainer = [[User:Michael de Raadt|Michael de Raadt]]
|float = right
}}
[[Blocks|Back to Blocks page]]

== Features ==

[[Image:Completion_Progress_bar_in_block_-_with_details.png|right|A progress bar for a student]]
* The Completion Progress is a time-management tool for students.
* It visually shows what activities/resources a student is supposed to interact with in a course.
* It is colour-coded so students can quickly see what they have and have not completed/viewed.
* The block relies on completion settings of activities/resources in the course and when they should be completed by.
* Ordering can be based on expected completion times or on the ordering of activities in the course.
* There is an Overview page allowing teachers to see the progress of all students in a class, which is helpful for finding students at risk.
* Adding the Completion Progress block to the [[Dashboard]] shows users a combined view of their progress from all courses they are enrolled in (where the block is set up).
[[Image:Completion_Progress_Overview_of_students_with_messaging.png|The overview page]]

== Installation ==

* The Completion Progress block is added like other blocks ([[Installing_contributed_modules_or_plugins|How to install a block]]).
* In Moodle versions prior to 3.1, [[Activity completion]] needs to be enabled.

== Global settings ==

The Completion Progress block has a number of global settings that will be seen on installation and can be accessed later at Site administration > Plugins > Blocks > Completion Progress.
[[Image:Completion_Progress_Global_settings.png|thumb|Global settings]]
* ''When wrapping, limit rows to...'' The progress bar shown in the block can be wrapped. This setting allows some control of how long the bar should be before wrapping. The default is 16.
* ''Default presentation for long bars'' The bar can be displayed by squeezing all segments, wrapping segments over multiple lines or allowing the bar to scroll. The default is to Squeeze.
* ''Course name to show on Dashboard'' The block can be added to the dashboard and combines visible Completion Progress block content from the courses a user is enrolled in. By default, the course name shown for each relevant course, is the short course name, but some institutions/organisations may not think this is appropriate in relation to their course naming scheme, so a long course name can be selected.
* ''Colours'' By default, the colours used in the block are red, blue and green. In certain cultures these colours may not have the same meaning. Also, institutions/organisations may wish to use colours that match their theme.
* ''Show inactive students in Overview'' In most cases, inactive students are not wanted in course lists, such as the Overview page associated with the block. However, in some cases, such as ongoing courses, inactive students might need to be visible on the Overview page.

== Capabilities (Controlling who sees parts of the block) ==

The block uses a number of capabilities that are added when the block is installed.
[[Image:Completion_Progress_Capabilities.png|thumb|Global settings]]
* ''Add a Completion Progress block to My home'' (block/completion_progress:myaddinstance) Controls whether the Completion Progress block can be added by a user to the Dashboard (formerly My home) page. By default, this is allowed for all authenticated users.
* ''Add a new Completion Progress block'' (block/completion_progress:addinstance) Controls whether the Completion Progress block can be added to a course page. By default, this is allowed for the following archetypal roles.
** Teacher (editingteacher)
** Manager (manager)
** Course creator (coursecreator)
** (and Admins)
* ''View course overview of Completion Progress for all students'' (block/completion_progress:overview) Controls whether the Overview page and the button on the Completion Progress block used to access the Overview page can be viewed by a user. By default, this is allowed for the following archetypal roles.
** Non-editing teacher (teacher)
** Teacher (editingteacher)
** Manager (manager)
** Course creator (coursecreator)
** (and Admins)
* ''Show the bar in the Completion Progress block'' (block/completion_progress:showbar) Controls whether the bar in the Completion Progress block is shown to a user. The reason for not showing this to certain users is that this might not be relevant and possibly annoying. By default, this is shown to the following archetypal roles.
** Non-editing teacher (teacher)
** Teacher (editingteacher)
** Student (student)
** (and Admins)

== Setting up a Completion Progress block in a course ==

In Moodle versions prior to 3.1, [[Activity completion]] needs to be enabled.

Once the block is installed on your site, you can use it in a course as follows.
# Turn editing on
# Create your activities/resources as normal
# Set completion settings for each activity you want to appear in the bar, including an expected by date
# Add the Completion Progress block to your page ([[Blocks|How to add a block]])
# Move your block into a prominent position (click and drag the block title)
# Choose to:
#(Optional) Configure how the block should appear

Hidden items will not appear in the Completion Progress block until they are unhidden. This is useful for a scheduled release of activities.

== Links ==

* [http://moodle.org/plugins/view.php?plugin=block_completion_progress Block in Plugins repository]
* [http://tracker.moodle.org/browse/CONTRIB/component/XXX Bug Tracker Page] (Please report bugs here.)
* [https://github.com/deraadt/moodle-block_completion_progress Git repository]

[[Category:Contributed code]]
[[Category:Block]]

[[es:Bloque de Progreso de Finalización]]

Completion Progress block

2016-08-18T11:25:57Z

Deraadt: Adding note about activity completion for earlier versions

{{Infobox plugin
|type = Block, Completion Progress
|entry = https://moodle.org/plugins/view.php?plugin=block_completion_progress
|tracker = https://tracker.moodle.org/browse/CONTRIB/component/XXX/?selectedTab=com.atlassian.jira.jira-projects-plugin:component-summary-panel
|discussion = https://moodle.org/plugins/view.php?plugin=block_completion_progress
|maintainer = [[User:Michael de Raadt|Michael de Raadt]]
|float = right
}}
[[Blocks|Back to Blocks page]]

== Features ==

[[Image:Completion_Progress_bar_in_block_-_with_details.png|right|A progress bar for a student]]
* The Completion Progress is a time-management tool for students.
* It visually shows what activities/resources a student is supposed to interact with in a course.
* It is colour-coded so students can quickly see what they have and have not completed/viewed.
* The block relies on completion settings of activities/resources in the course and when they should be completed by.
* Ordering can be based on expected completion times or on the ordering of activities in the course.
* There is an Overview page allowing teachers to see the progress of all students in a class, which is helpful for finding students at risk.
* Adding the Completion Progress block to the [[Dashboard]] shows users a combined view of their progress from all courses they are enrolled in (where the block is set up).
[[Image:Completion_Progress_Overview_of_students_with_messaging.png|The overview page]]

== Installation ==

* The Completion Progress block is added like other blocks ([[Installing_contributed_modules_or_plugins|How to install a block]]).
* In Moodle versions prior to 3.1, [[Activity completion]] needs to be enabled.

== Global settings ==

The Completion Progress block has a number of global settings that will be seen on installation and can be accessed later at Site administration > Plugins > Blocks > Completion Progress.
[[Image:Completion_Progress_Global_settings.png|thumb|Global settings]]
* ''When wrapping, limit rows to...'' The progress bar shown in the block can be wrapped. This setting allows some control of how long the bar should be before wrapping. The default is 16.
* ''Default presentation for long bars'' The bar can be displayed by squeezing all segments, wrapping segments over multiple lines or allowing the bar to scroll. The default is to Squeeze.
* ''Course name to show on Dashboard'' The block can be added to the dashboard and combines visible Completion Progress block content from the courses a user is enrolled in. By default, the course name shown for each relevant course, is the short course name, but some institutions/organisations may not think this is appropriate in relation to their course naming scheme, so a long course name can be selected.
* ''Colours'' By default, the colours used in the block are red, blue and green. In certain cultures these colours may not have the same meaning. Also, institutions/organisations may wish to use colours that match their theme.
* ''Show inactive students in Overview'' In most cases, inactive students are not wanted in course lists, such as the Overview page associated with the block. However, in some cases, such as ongoing courses, inactive students might need to be visible on the Overview page.

== Capabilities (Controlling who sees parts of the block) ==

The block uses a number of capabilities that are added when the block is installed.
[[Image:Completion_Progress_Capabilities.png|thumb|Global settings]]
* ''Add a Completion Progress block to My home'' (block/completion_progress:myaddinstance) Controls whether the Completion Progress block can be added by a user to the Dashboard (formerly My home) page. By default, this is allowed for all authenticated users.
* ''Add a new Completion Progress block'' (block/completion_progress:addinstance) Controls whether the Completion Progress block can be added to a course page. By default, this is allowed for the following archetypal roles.
** Teacher (editingteacher)
** Manager (manager)
** Course creator (coursecreator)
** (and Admins)
* ''View course overview of Completion Progress for all students'' (block/completion_progress:overview) Controls whether the Overview page and the button on the Completion Progress block used to access the Overview page can be viewed by a user. By default, this is allowed for the following archetypal roles.
** Non-editing teacher (teacher)
** Teacher (editingteacher)
** Manager (manager)
** Course creator (coursecreator)
** (and Admins)
* ''Show the bar in the Completion Progress block'' (block/completion_progress:showbar) Controls whether the bar in the Completion Progress block is shown to a user. The reason for not showing this to certain users is that this might not be relevant and possibly annoying. By default, this is shown to the following archetypal roles.
** Non-editing teacher (teacher)
** Teacher (editingteacher)
** Student (student)
** (and Admins)

== Setting up a Completion Progress block in a course ==

Once the block is installed on your site, you can use it in a course as follows.
# Turn editing on
# Create your activities/resources as normal
# Set completion settings for each activity you want to appear in the bar, including an expected by date
# Add the Completion Progress block to your page ([[Blocks|How to add a block]])
# Move your block into a prominent position (click and drag the block title)
# Choose to:
#(Optional) Configure how the block should appear

Hidden items will not appear in the Completion Progress block until they are unhidden. This is useful for a scheduled release of activities.

== Links ==

* [http://moodle.org/plugins/view.php?plugin=block_completion_progress Block in Plugins repository]
* [http://tracker.moodle.org/browse/CONTRIB/component/XXX Bug Tracker Page] (Please report bugs here.)
* [https://github.com/deraadt/moodle-block_completion_progress Git repository]

[[Category:Contributed code]]
[[Category:Block]]

[[es:Bloque de Progreso de Finalización]]

Completion Progress block

2016-06-18T10:19:51Z

Deraadt: Created page with "{{Infobox plugin |type = Block, Completion Progress |entry = https://moodle.org/plugins/view.php?plugin=block_completion_progress |tracker = https://tracker.moodle.org/browse/..."

{{Infobox plugin
|type = Block, Completion Progress
|entry = https://moodle.org/plugins/view.php?plugin=block_completion_progress
|tracker = https://tracker.moodle.org/browse/CONTRIB/component/XXX/?selectedTab=com.atlassian.jira.jira-projects-plugin:component-summary-panel
|discussion = https://moodle.org/plugins/view.php?plugin=block_completion_progress
|maintainer = [[User:Michael de Raadt|Michael de Raadt]]
|float = right
}}
[[Blocks|Back to Blocks page]]

== Features ==

[[Image:Completion_Progress_bar_in_block_-_with_details.png|right|A progress bar for a student]]
* The Completion Progress is a time-management tool for students.
* It visually shows what activities/resources a student is supposed to interact with in a course.
* It is colour-coded so students can quickly see what they have and have not completed/viewed.
* The block relies on completion settings of activities/resources in the course and when they should be completed by.
* Ordering can be based on expected completion times or on the ordering of activities in the course.
* There is an Overview page allowing teachers to see the progress of all students in a class, which is helpful for finding students at risk.
* Adding the Completion Progress block to the [[Dashboard]] shows users a combined view of their progress from all courses they are enrolled in (where the block is set up).
[[Image:Completion_Progress_Overview_of_students_with_messaging.png|The overview page]]

== Installation ==

The Completion Progress block is added like other blocks ([[Installing_contributed_modules_or_plugins|How to install a block]]).

== Global settings ==

The Completion Progress block has a number of global settings that will be seen on installation and can be accessed later at Site administration > Plugins > Blocks > Completion Progress.
[[Image:Completion_Progress_Global_settings.png|thumb|Global settings]]
* ''When wrapping, limit rows to...'' The progress bar shown in the block can be wrapped. This setting allows some control of how long the bar should be before wrapping. The default is 16.
* ''Default presentation for long bars'' The bar can be displayed by squeezing all segments, wrapping segments over multiple lines or allowing the bar to scroll. The default is to Squeeze.
* ''Course name to show on Dashboard'' The block can be added to the dashboard and combines visible Completion Progress block content from the courses a user is enrolled in. By default, the course name shown for each relevant course, is the short course name, but some institutions/organisations may not think this is appropriate in relation to their course naming scheme, so a long course name can be selected.
* ''Colours'' By default, the colours used in the block are red, blue and green. In certain cultures these colours may not have the same meaning. Also, institutions/organisations may wish to use colours that match their theme.
* ''Show inactive students in Overview'' In most cases, inactive students are not wanted in course lists, such as the Overview page associated with the block. However, in some cases, such as ongoing courses, inactive students might need to be visible on the Overview page.

== Capabilities (Controlling who sees parts of the block) ==

The block uses a number of capabilities that are added when the block is installed.
[[Image:Completion_Progress_Capabilities.png|thumb|Global settings]]
* ''Add a Completion Progress block to My home'' (block/completion_progress:myaddinstance) Controls whether the Completion Progress block can be added by a user to the Dashboard (formerly My home) page. By default, this is allowed for all authenticated users.
* ''Add a new Completion Progress block'' (block/completion_progress:addinstance) Controls whether the Completion Progress block can be added to a course page. By default, this is allowed for the following archetypal roles.
** Teacher (editingteacher)
** Manager (manager)
** Course creator (coursecreator)
** (and Admins)
* ''View course overview of Completion Progress for all students'' (block/completion_progress:overview) Controls whether the Overview page and the button on the Completion Progress block used to access the Overview page can be viewed by a user. By default, this is allowed for the following archetypal roles.
** Non-editing teacher (teacher)
** Teacher (editingteacher)
** Manager (manager)
** Course creator (coursecreator)
** (and Admins)
* ''Show the bar in the Completion Progress block'' (block/completion_progress:showbar) Controls whether the bar in the Completion Progress block is shown to a user. The reason for not showing this to certain users is that this might not be relevant and possibly annoying. By default, this is shown to the following archetypal roles.
** Non-editing teacher (teacher)
** Teacher (editingteacher)
** Student (student)
** (and Admins)

== Setting up a Completion Progress block in a course ==

Once the block is installed on your site, you can use it in a course as follows.
# Turn editing on
# Create your activities/resources as normal
# Set completion settings for each activity you want to appear in the bar, including an expected by date
# Add the Completion Progress block to your page ([[Blocks|How to add a block]])
# Move your block into a prominent position (click and drag the block title)
# Choose to:
#(Optional) Configure how the block should appear

Hidden items will not appear in the Completion Progress block until they are unhidden. This is useful for a scheduled release of activities.

== Links ==

* [http://moodle.org/plugins/view.php?plugin=block_completion_progress Block in Plugins repository]
* [http://tracker.moodle.org/browse/CONTRIB/component/XXX Bug Tracker Page] (Please report bugs here.)
* [https://github.com/deraadt/moodle-block_completion_progress Git repository]

[[Category:Contributed code]]
[[Category:Block]]

Fil:Completion Progress Capabilities.png

2016-06-18T10:19:39Z

Deraadt:

Fil:Completion Progress Global settings.png

2016-06-18T10:19:02Z

Deraadt:

Fil:Completion Progress bar in block - with details.png

2016-06-18T10:18:08Z

Deraadt:

Fil:Completion Progress Overview of students with messaging.png

2016-06-18T10:16:01Z

Deraadt:

Analytics plugins

2016-04-06T07:32:51Z

Deraadt: /* Moodle Plugins */

Learning Analytics are any piece of information that can help an LMS user improve learning outcomes. Users include students, teachers, administrators and decision-makers.

== Moodle Plugins ==

There are a number of reports, blocks and other plugins for Moodle that provide learning analytics.

{| class="nicetable"
|-
! Plugin
! Plugin type
! Standard / Additional
! Useful for
! Description
! Reported usage*
|-
| [[:en:Logs|Logs]]
| Report
| Standard
| Teachers, Admins, Decision-makers
| Filterable log of events
| style="text-align:center;" | 71.4%
|-
| [[:en:Activity_report|Activity]]
| Report
| Standard
| Teachers
| View count of activities in course
| style="text-align:center;" | 69.1%
|-
| [[:en:Using_Activity_completion|Activity completion]], see also [[:en:Using_Course_completion|Course completion]]
| Report
| Standard
| Teachers
| Completion matrix of students and activities
| style="text-align:center;" | 66.3%
|-
| [[:en:Logs|Live logs]]
| Report
| Standard
| Teachers, Admins
| Automatically refreshing log of events
| style="text-align:center;" | 55.2%
|-
| [[:en:Feedback_activity|Feedback]]
| Activity
| Standard
| Teachers, Researchers
| Configurable survey tool
| style="text-align:center;" | 59.5%
|-
| [[:en:Quiz_statistics_report|(Quiz) Statistics]]
| Report
| Standard
| Teachers
| Student quiz performance report
| style="text-align:center;" | 53.0%
|-
| [[:en:Participation_report|(Course) Participation]]
| Report
| Standard
| Teachers
| Single student's participation in course
| style="text-align:center;" | 49.9%
|-
| [[:en:Survey_module|Survey]]
| Activity
| Standard
| Teachers, Researchers
| Set of standardised educational surveys
| style="text-align:center;" | 45.6%
|-
| [http://moodle.org/plugins/view.php?plugin=mod_questionnaire Questionnaire]
| Activity
| Additional
| Teachers, Researchers
| Configurable survey tool
| style="text-align:center;" | 45.3%
|-
| [[:en:Course_overview_report|Course overview]]
| Report
| Standard
| Admins, Decision-makers
| Comparison of participation across multiple courses
| style="text-align:center;" | 45.0%
|-
| [[:en:Course_completion_status_block|Course completion status]]
| Block
| Standard
| Students
| View of student's own completion of activities
| style="text-align:center;" | 41.4%
|-
| [http://moodle.org/plugins/view.php?plugin=block_progress Progress Bar]
| Block
| Additional
| Students, Teachers
| Time management tool for students with overview for teachers
| style="text-align:center;" | 32.0%
|-
| [[:en:Events_list_report|Events list]]
| Report
| Standard
| Teachers, Admins
| Events that can be monitored/searched in logs
| style="text-align:center;" | 28.6%
|-
| [[:en:Activity_results_block|Activity results block]]
| Block
| Standard
| Students
| Leader-board of results in single activity
| style="text-align:center;" | 26.1%
|-
| [http://moodle.org/plugins/view.php?id=82 Configurable Reports]
([https://docs.moodle.org/29/en/ad-hoc_contributed_reports A list of contributed reports])
| Block ([https://github.com/nadavkav/moodle-report_configurablereports Report] [https://github.com/nadavkav/moodle-filter_crgraph Graphs filter])
| Additional
| Teachers, Admins, Decision-makers
| Report generation and viewing
| style="text-align:center;" | 22.7%
|-
| [[Overview_report|(Gradebook) Overview]]
| Report
| Standard
| Teachers, Students
| View of student grades across activites
| style="text-align:center;" | N/A
|-
| [[Statistics]]
| Report
| Standard
| Admins, Decision-makers
| Daily activity across site
| style="text-align:center;" | N/A
|-
| [[:en:Event_monitoring|Event monitor]]
| Report
| Standard
| Teachers, Admins, Decision-makers
| Proactive, focussed monitor tool
| style="text-align:center;" | N/A
|-
| [http://moodle.org/plugins/view/report_customsql Ad-hoc database queries]
| Report
| Additional
| Teachers, Admins, Decision-makers
| SQL-based report generation and viewing
| style="text-align:center;" | N/A
|-
| [http://moodle.org/plugins/browse.php?list=set&id=20 Engagement Analytics]
| Block, Report, Activity module
| Additional
| Teachers
| Configurable engagement measurement report and block
| style="text-align:center;" | N/A
|-
| [http://moodle.org/plugins/view/block_dedication Course Dedication]
| Block
| Additional
| Students, Teachers
| Estimated time online for students
| style="text-align:center;" | N/A
|-
| [http://moodle.org/plugins/view.php?plugin=block_graph_stats Graph Stats]
| Block
| Additional
| Teachers, Admins
| Daily visits to site or course
| style="text-align:center;" | N/A
|-
| [http://moodle.org/plugins/view/block_gismo GISMO]
| Block
| Additional
| Teachers
| Numerous charts of student activity participation
| style="text-align:center;" | N/A
|-
| [http://moodle.org/plugins/view/block_xp Level Up!]
| Block
| Additional
| Students, Teachers
| Incentive-drive participation meter
| style="text-align:center;" | N/A
|-
| [http://moodle.org/plugins/report_forumgraph Forum Graph]
| Report
| Additional
| Teachers
| Graph of forum interactions
| style="text-align:center;" | N/A
|-
| [https://moodle.org/plugins/block_analytics_graphs Analytics Graphs]
| Block
| Additional
| Teachers
| Visualisation of student participation
| style="text-align:center;" | N/A
|-
| [https://moodle.org/plugins/block_heatmap Heatmap]
| Block
| Additional
| Teachers
| Colour-coded indication of activity views on course page
| style="text-align:center;" | N/A
|-
| [https://moodle.org/plugins/local_analytics Analytics]
| Local
| Additional
| Admins, Decision-makers
| Enriched feed to Google Analytics and Pywick
| style="text-align:center;" | N/A
|-
| [https://moodle.org/plugins/logstore_xapi Logstore xAPI]
| Logstore
| Additional
| Admins, Decision-makers, Researchers
| xAPI event stream output
| style="text-align:center;" | N/A
|}

<nowiki>*</nowiki> Reported usage is drawn from the [http://research.moodle.net/71/1/Plugins%20Usage%20Survey%202015%20Report.pdf Plugins Usage Survey from 2015].

== Integrations with Moodle ==

A number of systems integrate with Moodle to provide learning analytics information externally.

* [http://damos.world/2013/08/30/the-moodle-activity-viewer-mav-heatmaps-of-student-activity/ Moodle Activity Viewer] (MAV) ([https://github.com/damoclark/mav-enterprise Git]), consider [https://moodle.org/plugins/block_heatmap Heatmap] as an alternative
* [http://www.intelliboard.net/ Intelliboard]
* [http://www.lambdasolutions.net/products/lmsreporting/ Analytika]
* [https://learninglocker.net/ Learning Locker], can be used with [https://moodle.org/plugins/logstore_xapi Logstore xAPI]
* [http://klassdata.com/smartklass-learning-analytics-plugin/learning-analytics-moodle-smartklass/ SmartKlass]

== Dimensions of Analytics ==

Learning analytics are a concept that has been emerging under a number of different names through the past decades. Its origins lie in research in data mining and intelligent tutoring systems. LA tools can be categorised in a number of ways. The diagram below describes such tools by how deeply they are integrated with other systems ([http://www.netdimensions.com/downloads-2015/others/lms-evolution-or-extinction.pdf?mkt_tok=3RkMMJWWfF9wsRokuKjMZKXonjHpfsX56OQtW6CwlMI%2F0ER3fOvrPUfGjI4DTsdlI%2BSLDwEYGJlv6SgFS7fAMaFl3bgIWBY%3D source]).

[[File:Learning-analytics.png]]

== See also... ==
* [https://moodle.org/mod/forum/view.php?id=8044 Analytics and reporting forum]
* [https://moodle.org/mod/forum/view.php?id=8205 Moodle Research forum]
* [[:dev:Moodle_research|Moodle research page]]
* [[Logging]]
* [[:en:Events_list_report|Events list]]
* [[:dev:Learning_Analytics_Specification|Learning Analytics API specification]]
* [[:dev:Working_Groups#Assessment_Analytics|Assessment Analytics working group details and issues]]
* [[:dev:Event_2|Events specification]]
* [[:dev:Logging_2|Logging specification]]
* [[:dev:reportbuilder/API|Report Builder API specification]]

[[Category:Report]]

[[es:Análisis del aprendizaje]]

Analytics plugins

2016-04-06T07:31:24Z

Deraadt: Adding descriptions to plugins

Learning Analytics are any piece of information that can help an LMS user improve learning outcomes. Users include students, teachers, administrators and decision-makers.

== Moodle Plugins ==

There are a number of reports, blocks and other plugins for Moodle that provide learning analytics.

{| class="nicetable"
|-
! Plugin
! Plugin type
! Standard / Additional
! Useful for
! Description
! Reported usage*
|-
| [[:en:Logs|Logs]]
| Report
| Standard
| Teachers, Admins, Decision-makers
| Filterable log of events
| style="text-align:center;" | 71.4%
|-
| [[:en:Activity_report|Activity]]
| Report
| Standard
| Teachers
| View count of activities in course
| style="text-align:center;" | 69.1%
|-
| [[:en:Using_Activity_completion|Activity completion]], see also [[:en:Using_Course_completion|Course completion]]
| Report
| Standard
| Teachers
| Completion matrix of students and activities
| style="text-align:center;" | 66.3%
|-
| [[:en:Logs|Live logs]]
| Report
| Standard
| Teachers, Admins
| Automatically refreshing log of events
| style="text-align:center;" | 55.2%
|-
| [[:en:Feedback_activity|Feedback]]
| Activity
| Standard
| Teachers, Researchers
| Configurable survey tool
| style="text-align:center;" | 59.5%
|-
| [[:en:Quiz_statistics_report|(Quiz) Statistics]]
| Report
| Standard
| Teachers
| Student quiz performance report
| style="text-align:center;" | 53.0%
|-
| [[:en:Participation_report|(Course) Participation]]
| Report
| Standard
| Teachers
| Single student's participation in course
| style="text-align:center;" | 49.9%
|-
| [[:en:Survey_module|Survey]]
| Activity
| Standard
| Teachers, Researchers
| Set of standardised educational surveys
| style="text-align:center;" | 45.6%
|-
| [http://moodle.org/plugins/view.php?plugin=mod_questionnaire Questionnaire]
| Activity
| Additional
| Teachers, Researchers
| Configurable survey tool
| style="text-align:center;" | 45.3%
|-
| [[:en:Course_overview_report|Course overview]]
| Report
| Standard
| Admins, Decision-makers
| Comparison of participation across multiple courses
| style="text-align:center;" | 45.0%
|-
| [[:en:Course_completion_status_block|Course completion status]]
| Block
| Standard
| Students
| View of student's own completion of activities
| style="text-align:center;" | 41.4%
|-
| [http://moodle.org/plugins/view.php?plugin=block_progress Progress Bar]
| Block
| Additional
| Students, Teachers
| Time management tool for students with overview for teachers
| style="text-align:center;" | 32.0%
|-
| [[:en:Events_list_report|Events list]]
| Report
| Standard
| Teachers, Admins
| Events that can be monitored/searched in logs
| style="text-align:center;" | 28.6%
|-
| [[:en:Activity_results_block|Activity results block]]
| Block
| Standard
| Students
| Leader-board of results in single activity
| style="text-align:center;" | 26.1%
|-
| [http://moodle.org/plugins/view.php?id=82 Configurable Reports]
([https://docs.moodle.org/29/en/ad-hoc_contributed_reports A list of contributed reports])
| Block ([https://github.com/nadavkav/moodle-report_configurablereports Report] [https://github.com/nadavkav/moodle-filter_crgraph Graphs filter])
| Additional
| Teachers, Admins, Decision-makers
| Report generation and viewing
| style="text-align:center;" | 22.7%
|-
| [[Overview_report|(Gradebook) Overview]]
| Report
| Standard
| Teachers, Students
| View of student grades across activites
| style="text-align:center;" | N/A
|-
| [[Statistics]]
| Report
| Standard
| Admins, Decision-makers
| Daily activity across site
| style="text-align:center;" | N/A
|-
| [[:en:Event_monitoring|Event monitor]]
| Report
| Standard
| Teachers, Admins, Decision-makers
| Proactive, focussed monitor tool
| style="text-align:center;" | N/A
|-
| [http://moodle.org/plugins/view/report_customsql Ad-hoc database queries]
| Report
| Additional
| Teachers, Admins, Decision-makers
| SQL-based report generation and viewing
| style="text-align:center;" | N/A
|-
| [http://moodle.org/plugins/browse.php?list=set&id=20 Engagement Analytics]
| Block, Report, Activity module
| Additional
| Teachers
| Configurable engagement measurement report and block
| style="text-align:center;" | N/A
|-
| [http://moodle.org/plugins/view/block_dedication Course Dedication]
| Block
| Additional
| Students, Teachers
| Estimated time online for students
| style="text-align:center;" | N/A
|-
| [http://moodle.org/plugins/view.php?plugin=block_graph_stats Graph Stats]
| Block
| Additional
| Teachers, Admins
| Daily visits to site or course
| style="text-align:center;" | N/A
|-
| [http://moodle.org/plugins/view/block_gismo GISMO]
| Block
| Additional
| Teachers
| Numerous charts of student activity participation
| style="text-align:center;" | N/A
|-
| [http://moodle.org/plugins/view/block_xp Level Up!]
| Block
| Additional
| Students, Teachers
| Incentive-drive participation meter
| style="text-align:center;" | N/A
|-
| [http://moodle.org/plugins/report_forumgraph Forum Graph]
| Report
| Additional
| Teachers
| Graph of forum interactions
| style="text-align:center;" | N/A
|-
| [https://moodle.org/plugins/block_analytics_graphs Analytics Graphs]
| Block
| Additional
| Teachers
| Visualisation of student participation
| style="text-align:center;" | N/A
|-
| [https://moodle.org/plugins/block_heatmap Heatmap]
| Block
| Additional
| Teachers
| Colour-coded indication of activity views on course page
| style="text-align:center;" | N/A
|-
| [https://moodle.org/plugins/local_analytics|Analytics]
| Local
| Additional
| Admins, Decision-makers
| Enriched feed to Google Analytics and Pywick
| style="text-align:center;" | N/A
|-
| [https://moodle.org/plugins/logstore_xapi Logstore xAPI]
| Logstore
| Additional
| Admins, Decision-makers, Researchers
| xAPI event stream output
| style="text-align:center;" | N/A
|}

<nowiki>*</nowiki> Reported usage is drawn from the [http://research.moodle.net/71/1/Plugins%20Usage%20Survey%202015%20Report.pdf Plugins Usage Survey from 2015].

== Integrations with Moodle ==

A number of systems integrate with Moodle to provide learning analytics information externally.

* [http://damos.world/2013/08/30/the-moodle-activity-viewer-mav-heatmaps-of-student-activity/ Moodle Activity Viewer] (MAV) ([https://github.com/damoclark/mav-enterprise Git]), consider [https://moodle.org/plugins/block_heatmap Heatmap] as an alternative
* [http://www.intelliboard.net/ Intelliboard]
* [http://www.lambdasolutions.net/products/lmsreporting/ Analytika]
* [https://learninglocker.net/ Learning Locker], can be used with [https://moodle.org/plugins/logstore_xapi Logstore xAPI]
* [http://klassdata.com/smartklass-learning-analytics-plugin/learning-analytics-moodle-smartklass/ SmartKlass]

== Dimensions of Analytics ==

Learning analytics are a concept that has been emerging under a number of different names through the past decades. Its origins lie in research in data mining and intelligent tutoring systems. LA tools can be categorised in a number of ways. The diagram below describes such tools by how deeply they are integrated with other systems ([http://www.netdimensions.com/downloads-2015/others/lms-evolution-or-extinction.pdf?mkt_tok=3RkMMJWWfF9wsRokuKjMZKXonjHpfsX56OQtW6CwlMI%2F0ER3fOvrPUfGjI4DTsdlI%2BSLDwEYGJlv6SgFS7fAMaFl3bgIWBY%3D source]).

[[File:Learning-analytics.png]]

== See also... ==
* [https://moodle.org/mod/forum/view.php?id=8044 Analytics and reporting forum]
* [https://moodle.org/mod/forum/view.php?id=8205 Moodle Research forum]
* [[:dev:Moodle_research|Moodle research page]]
* [[Logging]]
* [[:en:Events_list_report|Events list]]
* [[:dev:Learning_Analytics_Specification|Learning Analytics API specification]]
* [[:dev:Working_Groups#Assessment_Analytics|Assessment Analytics working group details and issues]]
* [[:dev:Event_2|Events specification]]
* [[:dev:Logging_2|Logging specification]]
* [[:dev:reportbuilder/API|Report Builder API specification]]

[[Category:Report]]

[[es:Análisis del aprendizaje]]

Analytics plugins

2016-04-06T06:43:23Z

Deraadt: Adding Events list

Learning Analytics are any piece of information that can help an LMS user improve learning outcomes. Users include students, teachers, administrators and decision-makers.

== Moodle Plugins ==

There are a number of reports, blocks and other plugins for Moodle that provide learning analytics.

{| class="nicetable"
|-
! Plugin
! Plugin type
! Standard / Additional
! Useful for
! Reported usage*
|-
| [[:en:Logs|Logs]]
| Report
| Standard
| Teachers, Admins, Decision-makers
| style="text-align:center;" | 71.4%
|-
| [[:en:Activity_report|Activity]]
| Report
| Standard
| Teachers
| style="text-align:center;" | 69.1%
|-
| [[:en:Using_Activity_completion|Activity completion]], see also [[:en:Using_Course_completion|Course completion]]
| Report
| Standard
| Teachers
| style="text-align:center;" | 66.3%
|-
| [[:en:Logs|Live logs]]
| Report
| Standard
| Teachers, Admins
| style="text-align:center;" | 55.2%
|-
| [[:en:Feedback_activity|Feedback]]
| Activity
| Standard
| Teachers, Researchers
| style="text-align:center;" | 59.5%
|-
| [[:en:Quiz_statistics_report|(Quiz) Statistics]]
| Report
| Standard
| Teachers
| style="text-align:center;" | 53.0%
|-
| [[:en:Participation_report|(Course) Participation]]
| Report
| Standard
| Teachers
| style="text-align:center;" | 49.9%
|-
| [[:en:Survey_module|Survey]]
| Activity
| Standard
| Teachers, Researchers
| style="text-align:center;" | 45.6%
|-
| [http://moodle.org/plugins/view.php?plugin=mod_questionnaire Questionnaire]
| Activity
| Additional
| Teachers, Researchers
| style="text-align:center;" | 45.3%
|-
| [[:en:Course_overview_report|Course overview]]
| Report
| Standard
| Admins, Decision-makers
| style="text-align:center;" | 45.0%
|-
| [[:en:Course_completion_status_block|Course completion status]]
| Block
| Standard
| Students
| style="text-align:center;" | 41.4%
|-
| [http://moodle.org/plugins/view.php?plugin=block_progress Progress Bar]
| Block
| Additional
| Students, Teachers
| style="text-align:center;" | 32.0%
|-
| [[:en:Events_list_report|Events list]]
| Report
| Standard
| Teachers, Admins
| style="text-align:center;" | 28.6%
|-
| [[:en:Activity_results_block|Activity results block]]
| Block
| Standard
| Students
| style="text-align:center;" | 26.1%
|-
| [http://moodle.org/plugins/view.php?id=82 Configurable Reports]
([https://docs.moodle.org/29/en/ad-hoc_contributed_reports A list of contributed reports])
| Block ([https://github.com/nadavkav/moodle-report_configurablereports Report] [https://github.com/nadavkav/moodle-filter_crgraph Graphs filter])
| Additional
| Teachers, Admins, Decision-makers
| style="text-align:center;" | 22.7%
|-
| [[Overview_report|(Gradebook) Overview]]
| Report
| Standard
| Teachers, Students
| style="text-align:center;" | N/A
|-
| [[Statistics]]
| Report
| Standard
| Admins, Decision-makers
| style="text-align:center;" | N/A
|-
| [http://moodle.org/plugins/view/report_customsql Ad-hoc database queries]
| Report
| Additional
| Teachers, Admins, Decision-makers
| style="text-align:center;" | N/A
|-
| [http://moodle.org/plugins/browse.php?list=set&id=20 Engagement Analytics]
| Block, Report, Activity module
| Additional
| Teachers
| style="text-align:center;" | N/A
|-
| [http://moodle.org/plugins/view/block_dedication Course Dedication]
| Block
| Additional
| Students, Teachers
| style="text-align:center;" | N/A
|-
| [http://moodle.org/plugins/view.php?plugin=block_graph_stats Graph Stats]
| Block
| Additional
| Teachers, Admins
| style="text-align:center;" | N/A
|-
| [http://moodle.org/plugins/view/block_gismo GISMO]
| Block
| Additional
| Teachers
| style="text-align:center;" | N/A
|-
| [http://moodle.org/plugins/view/block_xp Level Up!]
| Block
| Additional
| Students, Teachers
| style="text-align:center;" | N/A
|-
| [http://moodle.org/plugins/report_forumgraph Forum Graph]
| Report
| Additional
| Teachers
| style="text-align:center;" | N/A
|-
| [https://moodle.org/plugins/block_analytics_graphs Analytics Graphs]
| Block
| Additional
| Teachers
| style="text-align:center;" | N/A
|-
| [https://moodle.org/plugins/block_heatmap Heatmap]
| Block
| Additional
| Teachers
| style="text-align:center;" | N/A
|}

<nowiki>*</nowiki> Reported usage is drawn from the [http://research.moodle.net/71/1/Plugins%20Usage%20Survey%202015%20Report.pdf Plugins Usage Survey from 2015].

== Integrations with Moodle ==

A number of systems integrate with Moodle to provide learning analytics information.

* [http://damos.world/2013/08/30/the-moodle-activity-viewer-mav-heatmaps-of-student-activity/ Moodle Activity Viewer] (MAV) ([https://github.com/damoclark/mav-enterprise Git])
* [http://www.intelliboard.net/ Intelliboard]

== Dimensions of Analytics ==

Learning analytics are a concept that has been emerging under a number of different names through the past decades. Its origins lie in research in data mining and intelligent tutoring systems. LA tools can be categorised in a number of ways. The diagram below describes such tools by how deeply they are integrated with other systems ([http://www.netdimensions.com/downloads-2015/others/lms-evolution-or-extinction.pdf?mkt_tok=3RkMMJWWfF9wsRokuKjMZKXonjHpfsX56OQtW6CwlMI%2F0ER3fOvrPUfGjI4DTsdlI%2BSLDwEYGJlv6SgFS7fAMaFl3bgIWBY%3D source]).

[[File:Learning-analytics.png]]

== See also... ==
* [https://moodle.org/mod/forum/view.php?id=8044 Analytics and reporting forum]
* [https://moodle.org/mod/forum/view.php?id=8205 Moodle Research forum]
* [[:dev:Moodle_research|Moodle research page]]
* [[Logging]]
* [[:en:Events_list_report|Events list]]
* [[:dev:Learning_Analytics_Specification|Learning Analytics API specification]]
* [[:dev:Working_Groups#Assessment_Analytics|Assessment Analytics working group details and issues]]
* [[:dev:Event_2|Events specification]]
* [[:dev:Logging_2|Logging specification]]
* [[:dev:reportbuilder/API|Report Builder API specification]]

[[Category:Report]]

[[es:Análisis del aprendizaje]]

Analytics plugins

2016-04-06T06:42:29Z

Deraadt: Adding more learning analytics plugins

Learning Analytics are any piece of information that can help an LMS user improve learning outcomes. Users include students, teachers, administrators and decision-makers.

== Moodle Plugins ==

There are a number of reports, blocks and other plugins for Moodle that provide learning analytics.

{| class="nicetable"
|-
! Plugin
! Plugin type
! Standard / Additional
! Useful for
! Reported usage*
|-
| [[:en:Logs|Logs]]
| Report
| Standard
| Teachers, Admins, Decision-makers
| style="text-align:center;" | 71.4%
|-
| [[:en:Activity_report|Activity]]
| Report
| Standard
| Teachers
| style="text-align:center;" | 69.1%
|-
| [[:en:Using_Activity_completion|Activity completion]], see also [[:en:Using_Course_completion|Course completion]]
| Report
| Standard
| Teachers
| style="text-align:center;" | 66.3%
|-
| [[:en:Logs|Live logs]]
| Report
| Standard
| Teachers, Admins
| style="text-align:center;" | 55.2%
|-
| [[:en:Feedback_activity|Feedback]]
| Activity
| Standard
| Teachers, Researchers
| style="text-align:center;" | 59.5%
|-
| [[:en:Quiz_statistics_report|(Quiz) Statistics]]
| Report
| Standard
| Teachers
| style="text-align:center;" | 53.0%
|-
| [[:en:Participation_report|(Course) Participation]]
| Report
| Standard
| Teachers
| style="text-align:center;" | 49.9%
|-
| [[:en:Survey_module|Survey]]
| Activity
| Standard
| Teachers, Researchers
| style="text-align:center;" | 45.6%
|-
| [http://moodle.org/plugins/view.php?plugin=mod_questionnaire Questionnaire]
| Activity
| Additional
| Teachers, Researchers
| style="text-align:center;" | 45.3%
|-
| [[:en:Course_overview_report|Course overview]]
| Report
| Standard
| Admins, Decision-makers
| style="text-align:center;" | 45.0%
|-
| [[:en:Course_completion_status_block|Course completion status]]
| Block
| Standard
| Students
| style="text-align:center;" | 41.4%
|-
| [http://moodle.org/plugins/view.php?plugin=block_progress Progress Bar]
| Block
| Additional
| Students, Teachers
| style="text-align:center;" | 32.0%
|-
| [[:en:Events_list_report|Events list]]
| Report
| Standard
| Teachers, Admins
| style="text-align:center;" | 28.6%
|-
| [[:en:Activity_results_block|Activity results block]]
| Block
| Standard
| Students
| style="text-align:center;" | 26.1%
|-
| [http://moodle.org/plugins/view.php?id=82 Configurable Reports]
([https://docs.moodle.org/29/en/ad-hoc_contributed_reports A list of contributed reports])
| Block ([https://github.com/nadavkav/moodle-report_configurablereports Report] [https://github.com/nadavkav/moodle-filter_crgraph Graphs filter])
| Additional
| Teachers, Admins, Decision-makers
| style="text-align:center;" | 22.7%
|-
| [[Overview_report|(Gradebook) Overview]]
| Report
| Standard
| Teachers, Students
| style="text-align:center;" | N/A
|-
| [[Statistics]]
| Report
| Standard
| Admins, Decision-makers
| style="text-align:center;" | N/A
|-
| [http://moodle.org/plugins/view/report_customsql Ad-hoc database queries]
| Report
| Additional
| Teachers, Admins, Decision-makers
| style="text-align:center;" | N/A
|-
| [http://moodle.org/plugins/browse.php?list=set&id=20 Engagement Analytics]
| Block, Report, Activity module
| Additional
| Teachers
| style="text-align:center;" | N/A
|-
| [http://moodle.org/plugins/view/block_dedication Course Dedication]
| Block
| Additional
| Students, Teachers
| style="text-align:center;" | N/A
|-
| [http://moodle.org/plugins/view.php?plugin=block_graph_stats Graph Stats]
| Block
| Additional
| Teachers, Admins
| style="text-align:center;" | N/A
|-
| [http://moodle.org/plugins/view/block_gismo GISMO]
| Block
| Additional
| Teachers
| style="text-align:center;" | N/A
|-
| [http://moodle.org/plugins/view/block_xp Level Up!]
| Block
| Additional
| Students, Teachers
| style="text-align:center;" | N/A
|-
| [http://moodle.org/plugins/report_forumgraph Forum Graph]
| Report
| Additional
| Teachers
| style="text-align:center;" | N/A
|-
| [https://moodle.org/plugins/block_analytics_graphs Analytics Graphs]
| Block
| Additional
| Teachers
| style="text-align:center;" | N/A
|-
| [https://moodle.org/plugins/block_heatmap Heatmap]
| Block
| Additional
| Teachers
| style="text-align:center;" | N/A
|}

<nowiki>*</nowiki> Reported usage is drawn from the [http://research.moodle.net/71/1/Plugins%20Usage%20Survey%202015%20Report.pdf Plugins Usage Survey from 2015].

== Integrations with Moodle ==

A number of systems integrate with Moodle to provide learning analytics information.

* [http://damos.world/2013/08/30/the-moodle-activity-viewer-mav-heatmaps-of-student-activity/ Moodle Activity Viewer] (MAV) ([https://github.com/damoclark/mav-enterprise Git])
* [http://www.intelliboard.net/ Intelliboard]

== Dimensions of Analytics ==

Learning analytics are a concept that has been emerging under a number of different names through the past decades. Its origins lie in research in data mining and intelligent tutoring systems. LA tools can be categorised in a number of ways. The diagram below describes such tools by how deeply they are integrated with other systems ([http://www.netdimensions.com/downloads-2015/others/lms-evolution-or-extinction.pdf?mkt_tok=3RkMMJWWfF9wsRokuKjMZKXonjHpfsX56OQtW6CwlMI%2F0ER3fOvrPUfGjI4DTsdlI%2BSLDwEYGJlv6SgFS7fAMaFl3bgIWBY%3D source]).

[[File:Learning-analytics.png]]

== See also... ==
* [https://moodle.org/mod/forum/view.php?id=8044 Analytics and reporting forum]
* [https://moodle.org/mod/forum/view.php?id=8205 Moodle Research forum]
* [[:dev:Moodle_research|Moodle research page]]
* [[Logging]]
* [[:dev:Learning_Analytics_Specification|Learning Analytics API specification]]
* [[:dev:Working_Groups#Assessment_Analytics|Assessment Analytics working group details and issues]]
* [[:dev:Event_2|Events specification]]
* [[:dev:Logging_2|Logging specification]]
* [[:dev:reportbuilder/API|Report Builder API specification]]

[[Category:Report]]

[[es:Análisis del aprendizaje]]

Heatmap block

2016-03-18T04:50:30Z

Deraadt: /* Capabilities (Controlling who sees parts of the block) */

{{Infobox plugin
|type = Block
|entry = https://moodle.org/plugins/view.php?plugin=block_heatmap
|tracker = https://tracker.moodle.org/browse/CONTRIB/component/15738
|discussion = https://moodle.org/mod/forum/discuss.php?d=329136
|maintainer = [[User:Michael de Raadt|Michael de Raadt]]
|float = right
}}
[[Blocks|Back to Blocks page]]

== Features ==

[[Image:Heatmap_in_course.png|thumb|right|A heatmap applied to a course]]
* The Heatmap block overlays a heatmap onto a course to highlight activities with more or less activity.
* Counts of visits and unique users to each activity is also shown.
* The Heatmap can be toggled off when it is not needed.

== Installation ==

The Heatmap block is added like other blocks ([[Installing_contributed_modules_or_plugins|How to install a block]]).

== Global settings ==

The Heatmap block has a number of global settings that will be seen on installation and can be accessed later at Site administration > Plugins > Blocks > Heatmap.
[[Image:Heatmap_global_settings.png|thumb|Global settings]]
* ''Cache lifespan'' A cache is used to retain results and reduce impact on the log table. The lifespan of the cache can be controlled. A longer-lived cache means the burden of querying the log table is reduced. A shorter-lived cache will show more recent results.
* ''Check for activity'' You can limit the timespan that is covered by the log entries queried by the block can be controlled. You can choose to search back to the start of the course (default) or to the beginning of the log. This option can be changed if courses are re-run and teachers want to see beyond the start of the current instance. Searching further back in the log may cause additional load.
* ''What to show on course page'' Two things can be added to course pages: a background colour for activities with visits and icons showing the count of visits and count of unique users. You can select to show both (default) or one or the other.

'''Note: Changes to cache-related settings may not appear immediately in the user interface unless you also purge caches after saving these settings.'''

== Capabilities (Controlling who sees parts of the block) ==

The block uses a number of capabilities that are added when the block is installed.
[[Image:Heatmap_capabilities.png|thumb|Capabilities]]
* ''Add a new Heatmap block'' (block/heatmap:addinstance) Controls whether the Heatmap block can be added to a course page. By default, this is allowed for the following archetypal roles.
** Teacher (editingteacher)
** Manager (manager)
** (and Admins)
* ''View the Heatmap'' (block/heatmap:view) Controls who can see the Heatmap block and subsequently the overlay of the heatmap on the course. This is something that will usually be relevant to Teachers, so it is hidden from students.
** Teacher (editingteacher)
** Manager (manager)
** (and Admins)

== Setting up a Heatmap in a course ==

Once the Heatmap block is installed, you can use it in a course as follows.
# Turn editing on
# Add the Heatmap block to your page ([[Blocks|How to add a block]])
# Toggle the Heatmap off and on as needed

== Links ==

* [http://moodle.org/plugins/view.php?plugin=block_heatmap Entry in Plugins repository]
* [https://tracker.moodle.org/browse/CONTRIB/component/15738 Bug Tracker Page] (Please report bugs here.)
* [https://github.com/deraadt/moodle-block_heatmap Git repository]

===Videos===

<mediaplayer>https://www.youtube.com/watch?v=jqZP0T0rR4U</mediaplayer>

[[Category:Contributed code]]
[[Category:Block]]

[[es:Bloque Heatmap]]

Fil:Heatmap capabilities.png

2016-03-18T04:45:35Z

Deraadt: Deraadt uploaded a new version of File:Heatmap capabilities.png

Heatmap block

2016-03-18T04:45:00Z

Deraadt: Removing capability for the Dashboard as it was removed from the block

{{Infobox plugin
|type = Block
|entry = https://moodle.org/plugins/view.php?plugin=block_heatmap
|tracker = https://tracker.moodle.org/browse/CONTRIB/component/15738
|discussion = https://moodle.org/mod/forum/discuss.php?d=329136
|maintainer = [[User:Michael de Raadt|Michael de Raadt]]
|float = right
}}
[[Blocks|Back to Blocks page]]

== Features ==

[[Image:Heatmap_in_course.png|thumb|right|A heatmap applied to a course]]
* The Heatmap block overlays a heatmap onto a course to highlight activities with more or less activity.
* Counts of visits and unique users to each activity is also shown.
* The Heatmap can be toggled off when it is not needed.

== Installation ==

The Heatmap block is added like other blocks ([[Installing_contributed_modules_or_plugins|How to install a block]]).

== Global settings ==

The Heatmap block has a number of global settings that will be seen on installation and can be accessed later at Site administration > Plugins > Blocks > Heatmap.
[[Image:Heatmap_global_settings.png|thumb|Global settings]]
* ''Cache lifespan'' A cache is used to retain results and reduce impact on the log table. The lifespan of the cache can be controlled. A longer-lived cache means the burden of querying the log table is reduced. A shorter-lived cache will show more recent results.
* ''Check for activity'' You can limit the timespan that is covered by the log entries queried by the block can be controlled. You can choose to search back to the start of the course (default) or to the beginning of the log. This option can be changed if courses are re-run and teachers want to see beyond the start of the current instance. Searching further back in the log may cause additional load.
* ''What to show on course page'' Two things can be added to course pages: a background colour for activities with visits and icons showing the count of visits and count of unique users. You can select to show both (default) or one or the other.

'''Note: Changes to cache-related settings may not appear immediately in the user interface unless you also purge caches after saving these settings.'''

== Capabilities (Controlling who sees parts of the block) ==

The block uses a number of capabilities that are added when the block is installed.
[[Image:Heatmap_capabilities.png|thumb|Global settings]]
* ''Add a new Heatmap block'' (block/heatmap:addinstance) Controls whether the Heatmap block can be added to a course page. By default, this is allowed for the following archetypal roles.
** Teacher (editingteacher)
** Manager (manager)
** (and Admins)
* ''View the Heatmap'' (block/heatmap:view) Controls who can see the Heatmap block and subsequently the overlay of the heatmap on the course. This is something that will usually be relevant to Teachers, so it is hidden from students.
** Teacher (editingteacher)
** Manager (manager)
** (and Admins)

== Setting up a Heatmap in a course ==

Once the Heatmap block is installed, you can use it in a course as follows.
# Turn editing on
# Add the Heatmap block to your page ([[Blocks|How to add a block]])
# Toggle the Heatmap off and on as needed

== Links ==

* [http://moodle.org/plugins/view.php?plugin=block_heatmap Entry in Plugins repository]
* [https://tracker.moodle.org/browse/CONTRIB/component/15738 Bug Tracker Page] (Please report bugs here.)
* [https://github.com/deraadt/moodle-block_heatmap Git repository]

===Videos===

<mediaplayer>https://www.youtube.com/watch?v=jqZP0T0rR4U</mediaplayer>

[[Category:Contributed code]]
[[Category:Block]]

[[es:Bloque Heatmap]]

admin/setting/blocksettingheatmap

2016-03-08T02:13:15Z

Deraadt: Redirected page to Heatmap block#Global settings

#REDIRECT [[Heatmap_block#Global_settings]]

Heatmap block

2016-03-08T02:12:04Z

Deraadt: Created page with "{{Infobox plugin |type = Block |entry = https://moodle.org/plugins/view.php?plugin=block_heatmap |tracker = https://tracker.moodle.org/browse/CONTRIB/component/15738 |discussi..."

{{Infobox plugin
|type = Block
|entry = https://moodle.org/plugins/view.php?plugin=block_heatmap
|tracker = https://tracker.moodle.org/browse/CONTRIB/component/15738
|discussion = https://moodle.org/mod/forum/discuss.php?d=329136
|maintainer = [[User:Michael de Raadt|Michael de Raadt]]
|float = right
}}
[[Blocks|Back to Blocks page]]

== Features ==

[[Image:Heatmap_in_course.png|thumb|right|A heatmap applied to a course]]
* The Heatmap block overlays a heatmap onto a course to highlight activities with more or less activity.
* Counts of visits and unique users to each activity is also shown.
* The Heatmap can be toggled off when it is not needed.

== Installation ==

The Heatmap block is added like other blocks ([[Installing_contributed_modules_or_plugins|How to install a block]]).

== Global settings ==

The Heatmap block has a number of global settings that will be seen on installation and can be accessed later at Site administration > Plugins > Blocks > Heatmap.
[[Image:Heatmap_global_settings.png|thumb|Global settings]]
* ''Cache lifespan'' A cache is used to retain results and reduce impact on the log table. The lifespan of the cache can be controlled. A longer-lived cache means the burden of querying the log table is reduced. A shorter-lived cache will show more recent results.
* ''Check for activity'' You can limit the timespan that is covered by the log entries queried by the block can be controlled. You can choose to search back to the start of the course (default) or to the beginning of the log. This option can be changed if courses are re-run and teachers want to see beyond the start of the current instance. Searching further back in the log may cause additional load.
* ''What to show on course page'' Two things can be added to course pages: a background colour for activities with visits and icons showing the count of visits and count of unique users. You can select to show both (default) or one or the other.

'''Note: Changes to cache-related settings may not appear immediately in the user interface unless you also purge caches after saving these settings.'''

== Capabilities (Controlling who sees parts of the block) ==

The block uses a number of capabilities that are added when the block is installed.
[[Image:Heatmap_capabilities.png|thumb|Global settings]]
* ''Add a Heatmap block to the Dashboard'' (block/heatmap:myaddinstance) Leave this off for all users. The block won't work on the Dashboard.
* ''Add a new Heatmap block'' (block/heatmap:addinstance) Controls whether the Heatmap block can be added to a course page. By default, this is allowed for the following archetypal roles.
** Teacher (editingteacher)
** Manager (manager)
** (and Admins)
* ''View the Heatmap'' (block/heatmap:view) Controls who can see the Heatmap block and subsequently the overlay of the heatmap on the course. This is something that will usually be relevant to Teachers, so it is hidden from students.
** Teacher (editingteacher)
** Manager (manager)
** (and Admins)

== Setting up a Heatmap in a course ==

Once the Heatmap block is installed, you can use it in a course as follows.
# Turn editing on
# Add the Heatmap block to your page ([[Blocks|How to add a block]])
# Toggle the Heatmap off and on as needed

== Links ==

* [http://moodle.org/plugins/view.php?plugin=block_heatmap Entry in Plugins repository]
* [https://tracker.moodle.org/browse/CONTRIB/component/15738 Bug Tracker Page] (Please report bugs here.)
* [https://github.com/deraadt/moodle-block_heatmap Git repository]

===Videos===

<mediaplayer>https://www.youtube.com/watch?v=jqZP0T0rR4U</mediaplayer>

[[Category:Contributed code]]
[[Category:Block]]

Fil:Heatmap capabilities.png

2016-03-08T01:44:41Z

Deraadt:

Fil:Heatmap global settings.png

2016-03-08T01:25:45Z

Deraadt:

Fil:Heatmap in course.png

2016-03-08T01:23:30Z

Deraadt:

Analytics plugins

2016-02-26T03:17:34Z

Deraadt: Adding Level Up!

Progress Bar block

2016-02-25T21:44:00Z

Deraadt: Changing repo link to Github

{{Infobox plugin
|type = Block, Progress bar
|entry = https://moodle.org/plugins/view.php?plugin=block_progress
|tracker = https://tracker.moodle.org/browse/CONTRIB/component/10489/?selectedTab=com.atlassian.jira.jira-projects-plugin:component-summary-panel
|discussion = https://moodle.org/plugins/view.php?plugin=block_progress
|maintainer = [[User:Michael de Raadt|Michael de Raadt]]
|float = right
}}
[[Blocks|Back to Blocks page]]

== Features ==

[[Image:Bar_in_block_-_with_details.png|right|A progress bar for a student]]
* The Progress Bar is a time-management tool for students.
* It visually shows what activities/resources a student is supposed to interact with in a course.
* It is colour coded so students can quickly see what they have and have not completed/viewed.
* The teacher selects which pre-existing activities/resources are to be included in the Progress Bar and when they should be completed/viewed.
* Ordering can be done by times/deadlines or by the ordering of activities in the course.
* There is an overview page allowing teachers to see the progress of all students in a class, which is helpful for finding students at risk.
* Adding the Progress Bar block to the [[Dashboard]] shows users a combined view of their progress on all courses (where the block is set up).
[[Image:Overview_of_students.png|The overview page]]

== Installation ==

The Progress Bar block is added like other blocks ([[Installing_contributed_modules_or_plugins|How to install a block]]).

== Global settings ==

The Progress Bar block has a number of global settings that will be seen on installation and can be accessed later at Site administration > Plugins > Blocks > Progress Bar.
[[Image:Progress_Bar_Global_settings.png|thumb|Global settings]]
* ''Course name to show on Dashboard'' The block can be added to the dashboard and combines visible Progress Bar block content from the courses a user is enrolled in. By default, the course name shown for each relevant course, is the short course name, but some institutions/organisations may not think this is appropriate in relation to their course naming scheme, so a long course name can be selected.
* ''Colours'' By default, the colours used in the block are red, blue and green. In certain cultures these colours may not have the same meaning. Also, institutions/organisations may wish to use colours that match their theme.
* ''Show inactive students in Overview'' In most cases, inactive students are not wanted in course lists, such as the Overview page associated with the Progress Bar. However, in some cases, such as ongoing courses, inactive students might need to be visible on the Overview page.

== Capabilities (Controlling who sees parts of the block) ==

The block uses a number of capabilities that are added when the block is installed.
[[Image:Progress_Bar_Capabilities.png|thumb|Global settings]]
* ''Add a Progress Bar block to My home'' (block/progress:myaddinstance) Controls whether the Progress Bar can be added by a user to the Dashboard (formerly My home) page. By default, this is allowed for all authenticated users.
* ''Add a new Progress Bar block'' (block/progress:addinstance) Controls whether the Progress Bar block can be added to a course page. By default, this is allowed for the following archetypal roles.
** Teacher (editingteacher)
** Manager (manager)
** Course creator (coursecreator)
** (and Admins)
* ''View course overview of Progress bars for all students'' (block/progress:overview) Controls whether the Overview page and the button on the Progress Bar block used to access the Overview page can be viewed by a user. By default, this is allowed for the following archetypal roles.
** Non-editing teacher (teacher)
** Teacher (editingteacher)
** Manager (manager)
** Course creator (coursecreator)
** (and Admins)
* ''Show the bar in the Progress Bar block'' (block/progress:showbar) Controls whether the bar in the Progress Bar block is shown to a user. The reason for not showing this to certain users is that this might not be relevant and possibly annoying. By default, this is shown to the following archetypal roles.
** Non-editing teacher (teacher)
** Teacher (editingteacher)
** Student (student)
** (and Admins)

== Setting up a Progress Bar in a course ==

Once the progress bar is installed, you can use it in a course as follows.
# Turn editing on
# Create your activities/resources as normal
# Add the Progress Bar block to your page ([[Blocks|How to add a block]])
# Move your Progress Bar block into a prominent position (click and drag the block title)
# Choose to:
#* Monitor all activities (pre-fills configuration page)
#* Select which activities to monitor (start from scratch)
# Set the activities/resources you want shown in the block to "Yes" and those you don't to "No".
# Set the date and time when the activity/resource is expected to be completed/viewed by (some activities have deadlines set, if so, that deadline can be used or another can be set in the Progress Bar block configuration).
# Save changes.

Hidden items will not appear in the Progress Bar until they are unhidden. This is useful for a scheduled release of activities.

== Links ==

* [http://moodle.org/plugins/view.php?plugin=block_progress Block code in Plugins repository]
* [http://tracker.moodle.org/browse/CONTRIB/component/10489 Bug Tracker Page] (Please report bugs here.)
* [https://github.com/deraadt/moodle-block_progress Git repository]

==Available translations==
This plugin has been (partly or completely) [https://docs.moodle.org/dev/Translation translated] in [http://lang.moodle.org/ AMOS] to these 24 languages by February 2016:
* Basque (eu)
* Catalan (ca)
* Chinese (Traditional/Big5) (zh_tw)
* Croatian (hr)
* Czech (cs)
* Dansk (da)
* Dutch (nl)
* Finnish (fi)
* French (fr)
* German (de)
* Hebrew (he)
* Japanese (ja)
* Lietuvių (lt)
* Macedonian (mk)
* Mongolian (mn)
* Norwegian (no)
* Polish (pl)
* Portuguese (Brazil) (pt_br)
* Romanian (ro)
* Russian (ru)
* Serbian (Cyrillic) (sr_cr)
* Serbian (Latin) (sr_lt)
* Spanish (International) (es)
* Spanish - Mexico (es_mx)

The documentation (this page that you are reading now) is available in spanish at [https://docs.moodle.org/all/es/Bloque_de_barra_de_progreso Bloque de barra de progreso].

== Acknowledgements ==

* Thanks to:
** Toshimi Hatanaka for contributing a Japanese translation
** Yvonne Schneider and Joachim Vogelgesang for contributing a German translation
** Maria João Spilker for contributing a Portuguese-Brazilian translation
** Pieter Wolters for contributing a Dutch translation
** Fernando Sánchez for contributing a Spanish translation
** Fabien Sartoretti for contributing a French translation
** Adam Levy for contributing queries and strings for Hot Potatoes support
** Petras Virzintas for contributing queries for Turnitin support
** Willian Mano for helping with the modern look CSS
** Matthieu Rolland for contributing queries for the Questionnaire module
** Johan Reinalda for contributing global config changes for block colours
** German Valero for Spanish - Mexico translation of the block and this page.

===Videos===

<mediaplayer>http://www.youtube.com/watch?v=06LA5Cv9Fhw</mediaplayer>

<mediaplayer>http://www.youtube.com/watch?v=ekH8IfCyGzM</mediaplayer>

[[Category:Contributed code]]
[[Category:Block]]

[[es:Bloque de barra de progreso]]

Analytics plugins

2016-02-24T23:45:16Z

Deraadt: Adding Feedback and Questionnaire activities

Progress Bar block

2016-02-24T00:11:10Z

Deraadt: Adding global settings and capabilities

{{Infobox plugin
|type = Block, Progress bar
|entry = https://moodle.org/plugins/view.php?plugin=block_progress
|tracker = https://tracker.moodle.org/browse/CONTRIB/component/10489/?selectedTab=com.atlassian.jira.jira-projects-plugin:component-summary-panel
|discussion = https://moodle.org/plugins/view.php?plugin=block_progress
|maintainer = [[User:Michael de Raadt|Michael de Raadt]]
|float = right
}}
[[Blocks|Back to Blocks page]]

== Features ==

[[Image:Bar_in_block_-_with_details.png|right|A progress bar for a student]]
* The Progress Bar is a time-management tool for students.
* It visually shows what activities/resources a student is supposed to interact with in a course.
* It is colour coded so students can quickly see what they have and have not completed/viewed.
* The teacher selects which pre-existing activities/resources are to be included in the Progress Bar and when they should be completed/viewed.
* Ordering can be done by times/deadlines or by the ordering of activities in the course.
* There is an overview page allowing teachers to see the progress of all students in a class, which is helpful for finding students at risk.
* Adding the Progress Bar block to the [[Dashboard]] shows users a combined view of their progress on all courses (where the block is set up).
[[Image:Overview_of_students.png|The overview page]]

== Installation ==

The Progress Bar block is added like other blocks ([[Installing_contributed_modules_or_plugins|How to install a block]]).

== Global settings ==

The Progress Bar block has a number of global settings that will be seen on installation and can be accessed later at Site administration > Plugins > Blocks > Progress Bar.
[[Image:Progress_Bar_Global_settings.png|thumb|Global settings]]
* ''Course name to show on Dashboard'' The block can be added to the dashboard and combines visible Progress Bar block content from the courses a user is enrolled in. By default, the course name shown for each relevant course, is the short course name, but some institutions/organisations may not think this is appropriate in relation to their course naming scheme, so a long course name can be selected.
* ''Colours'' By default, the colours used in the block are red, blue and green. In certain cultures these colours may not have the same meaning. Also, institutions/organisations may wish to use colours that match their theme.
* ''Show inactive students in Overview'' In most cases, inactive students are not wanted in course lists, such as the Overview page associated with the Progress Bar. However, in some cases, such as ongoing courses, inactive students might need to be visible on the Overview page.

== Capabilities (Controlling who sees parts of the block) ==

The block uses a number of capabilities that are added when the block is installed.
[[Image:Progress_Bar_Capabilities.png|thumb|Global settings]]
* ''Add a Progress Bar block to My home'' (block/progress:myaddinstance) Controls whether the Progress Bar can be added by a user to the Dashboard (formerly My home) page. By default, this is allowed for all authenticated users.
* ''Add a new Progress Bar block'' (block/progress:addinstance) Controls whether the Progress Bar block can be added to a course page. By default, this is allowed for the following archetypal roles.
** Teacher (editingteacher)
** Manager (manager)
** Course creator (coursecreator)
** (and Admins)
* ''View course overview of Progress bars for all students'' (block/progress:overview) Controls whether the Overview page and the button on the Progress Bar block used to access the Overview page can be viewed by a user. By default, this is allowed for the following archetypal roles.
** Non-editing teacher (teacher)
** Teacher (editingteacher)
** Manager (manager)
** Course creator (coursecreator)
** (and Admins)
* ''Show the bar in the Progress Bar block'' (block/progress:showbar) Controls whether the bar in the Progress Bar block is shown to a user. The reason for not showing this to certain users is that this might not be relevant and possibly annoying. By default, this is shown to the following archetypal roles.
** Non-editing teacher (teacher)
** Teacher (editingteacher)
** Student (student)
** (and Admins)

== Setting up a Progress Bar in a course ==

Once the progress bar is installed, you can use it in a course as follows.
# Turn editing on
# Create your activities/resources as normal
# Add the Progress Bar block to your page ([[Blocks|How to add a block]])
# Move your Progress Bar block into a prominent position (click and drag the block title)
# Choose to:
#* Monitor all activities (pre-fills configuration page)
#* Select which activities to monitor (start from scratch)
# Set the activities/resources you want shown in the block to "Yes" and those you don't to "No".
# Set the date and time when the activity/resource is expected to be completed/viewed by (some activities have deadlines set, if so, that deadline can be used or another can be set in the Progress Bar block configuration).
# Save changes.

Hidden items will not appear in the Progress Bar until they are unhidden. This is useful for a scheduled release of activities.

== Links ==

* [http://moodle.org/plugins/view.php?plugin=block_progress Block code in Plugins repository]
* [http://tracker.moodle.org/browse/CONTRIB/component/10489 Bug Tracker Page] (Please report bugs here)
* [http://cvs.moodle.org/contrib/plugins/blocks/progress/ CVS Repository]

==Available translations==
This plugin has been (partly or completely) [https://docs.moodle.org/dev/Translation translated] in [http://lang.moodle.org/ AMOS] to these 14 languages by Sept 2014:
* Basque (eu)
* Chinese (Traditional/Big5) (zh_tw)
* Dutch (nl)
* Finnish (fi)
* French (fr)
* German (de)
* Hebrew (he)
* Japanese (ja)
* Macedonian (mk)
* Norwegian (no)
* Portuguese (Brazil) (pt_br)
* Russian (ru)
* Spanish (International) (es)
* Spanish - Mexico (es_mx)

The documentation (this page that you are reading now) is available in spanish at [https://docs.moodle.org/all/es/Bloque_de_barra_de_progreso Bloque de barra de progreso].

== Acknowledgements ==

* Thanks to:
** Toshimi Hatanaka for contributing a Japanese translation
** Yvonne Schneider and Joachim Vogelgesang for contributing a German translation
** Maria João Spilker for contributing a Portuguese-Brazilian translation
** Pieter Wolters for contributing a Dutch translation
** Fernando Sánchez for contributing a Spanish translation
** Fabien Sartoretti for contributing a French translation
** Adam Levy for contributing queries and strings for Hot Potatoes support
** Petras Virzintas for contributing queries for Turnitin support
** Willian Mano for helping with the modern look CSS
** Matthieu Rolland for contributing queries for the Questionnaire module
** Johan Reinalda for contributing global config changes for block colours
** German Valero for Spanish - Mexico translation of the block and this page.

===Videos===

<mediaplayer>http://www.youtube.com/watch?v=06LA5Cv9Fhw</mediaplayer>

<mediaplayer>http://www.youtube.com/watch?v=ekH8IfCyGzM</mediaplayer>

[[Category:Contributed code]]
[[Category:Block]]

[[es:Bloque de barra de progreso]]

Capabilities/block/progress:addinstance

2016-02-24T00:07:48Z

Deraadt: Created page with "This capability controls whether the Progress Bar block can be added to a course page. By default, this is allowed for the following archetypal roles. * Teacher (editingteac..."

This capability controls whether the Progress Bar block can be added to a course page.

By default, this is allowed for the following archetypal roles.
* Teacher (editingteacher)
* Manager (manager)
* Course creator (coursecreator)
* (and Admins)

Capabilities/block/progress:overview

2016-02-24T00:07:45Z

Deraadt: Created page with "This capability controls whether the Overview page and the button on the Progress Bar block used to access the Overview page can be viewed by a user. By default, this is allo..."

This capability controls whether the Overview page and the button on the Progress Bar block used to access the Overview page can be viewed by a user.

By default, this is allowed for the following archetypal roles.
* Non-editing teacher (teacher)
* Teacher (editingteacher)
* Manager (manager)
* Course creator (coursecreator)
* (and Admins)

Capabilities/block/progress:showbar

2016-02-24T00:07:42Z

Deraadt: Created page with "This capability controls whether the bar in the Progress Bar block is shown to a user. The reason for not showing this to certain users is that this might not be relevant and..."

This capability controls whether the bar in the Progress Bar block is shown to a user.

The reason for not showing this to certain users is that this might not be relevant and possibly annoying.

By default, this is shown to the following archetypal roles.
* Non-editing teacher (teacher)
* Teacher (editingteacher)
* Student (student)
* (and Admins)

Capabilities/block/progress:myaddinstance

2016-02-24T00:05:38Z

Deraadt: Created page with "This capability controls whether the Progress Bar can be added by a user to the Dashboard (formerly My home) page. By default, this is allowed for all authenticated users."

This capability controls whether the Progress Bar can be added by a user to the Dashboard (formerly My home) page. By default, this is allowed for all authenticated users.

Fil:Progress Bar Capabilities.png

2016-02-23T23:53:14Z

Deraadt:

Fil:Progress Bar Global settings.png

2016-02-23T23:36:48Z

Deraadt:

Moodle research

2016-02-01T04:35:23Z

Deraadt: Redirecting to new Moodle research page on Dev docs. Papers listed have been copied to Moodle Research Library

#REDIRECT [[:dev:Moodle_research]]

Analytics plugins

2016-02-01T04:22:46Z

Deraadt: Correcting Event 2 link

Analytics plugins

2016-02-01T04:15:14Z

Deraadt: Adding some links

Analytics plugins

2016-01-13T04:34:20Z

Deraadt: Adding link to assessment analytics work

Analytics plugins

2016-01-12T00:02:54Z

Deraadt: Adding learning analytics dimensions image