MoodleDocs - User contributions [en]

Moodle XML format

2020-01-21T08:33:38Z

Jwelshoff:

{{Export questions}}
The XML Format is a Moodle-specific format for importing and exporting questions to be used with the [[Quiz module]]. The format has been developed within the Moodle Community but other software may support it to a greater or lesser degree.

==A word about validity (and CDATA)==

The XML parser assumes that the XML file is well formed and does not detect or report errors. If it is not you are very likely to get unexpected errors. If you are hand-coding the XML file it is strongly recommended that you pass it through some sort of XML verifier before importing into Moodle. A simple way to do this is to open the XML file using Firefox or Internet Explorer.

Note particularly that embedded HTML fragments should be within [http://en.wikipedia.org/wiki/CDATA CDATA sections]. CDATA example:

<code xml>
<questiontext format="html">
<text><![CDATA[
Now I can include any HTML that I 
wish. Without the CDATA, the HTML tags would break
the XML!!
]]>
</text>
</questiontext>
</code>

==Overall structure of XML file==

The file is enclosed by tags as follows. It is '''important''' to make sure the xml tag only is really the first line of the file. A blank first line, or additional tags on the first line will confuse the Moodle XML parser.

<code xml>
<?xml version="1.0" ?>
<quiz>
.
.
.
</quiz>
</code>

Within the <quiz> tags are any number of <question> tags. One of these <question> tags can be a dummy question with a ''category'' type to specify a category for the import/export.

<code xml>
<question type="category">
<category>
<text>$course$/XXXX</text>
</category>
</question>
</code>

Where XXXX is the new category name. If the category exists, the question(s) will be added to the existing course; otherwise a new category will be created. This only works if you have "Get category from file" checked.

Multiple categories can be specified in the same file. Just add another dummy 'category' question each time you would like to establish a new category and the questions that follow it will be placed there.

The file must be encoded in [[UTF8]]

Moodle XML import and export are balanced in functionality, so if you need to understand the format you can simply create some questions and export them to see what it looks like.

==Tags common to all question types==

A question is written as follows.

<code xml>
<question type="multichoice|truefalse|shortanswer|matching|cloze|essay|numerical|description">
<name>
<text>Name of question</text>
</name>
<questiontext format="html">
<text>What is the answer to this question?</text>
</questiontext>
.
.
.
</question>
</code>

Each question requires a <name> tag and <question-text> tag for the XML file to import into Moodle properly.

"Format" selects the [[Formatting options]] for the question text. The options are '''html''' (the default), '''moodle_auto_format''', '''plain_text''' and '''markdown'''. The choice effects the way in which the text will be displayed.

Further tags, which usually include at least one <answer> tag, follow in the space marked with dots as child nodes to the <question> tag. The response-related tags are listed further down on this page. Various (optional?) tags are possible.

* tags (non-hierarchical keywords)
* penalty
* generalfeedback
* defaultgrade
* hidden

Even though question tags (non-hierarchical keyowords) are not fully supported in the question engine, they can be imported and exported via XML.

<code xml>
<question ...>
...
<tags>
<tag>
<text>keyword1</text>
</tag>
<tag>
<text>keyword2</text>
</tag>
...
</tags>
...
</question>
</code>

The <image> tag contains the url of any included image. Nested within the <image> tag may be an <image_base64> tag which contains the actual image data encoded in base64 [http://www.php.net/manual/en/function.base64-encode.php].

{{Note|If you export questions from a Moodle 1.9 server, the exported file might contain only the relative URL to the image hosted in the 1.9 server, while exported questions from Moodle 2.x and 3.x servers might contain the actual image encoded in base 64. This explains why some question bank import-export operations include all the images and some others don't.}}
'''In the following question type examples the common parts of the question are not shown to improve clarity. It's a good idea to export some examples yourself to see a full example.'''

==Multiple choice==

MC questions have one <answer> tag for each choice. Each choice can carry feedback and score weighting (by using the fraction attribute). In addition, an MC question has the following tags:

* single ''(values: true/false)''
* shuffleanswers ''(values: 1/0)''
* correctfeedback
* partiallycorrectfeedback
* incorrectfeedback
* answernumbering (allowed values: 'none', 'abc', 'ABCD' or '123')

The <single> tag is used to distinguish single response (radio button) and multiple response (checkbox) variants.

<code xml>
<question type="multichoice">
<answer fraction="100">
<text>The correct answer</text>
<feedback><text>Correct!</text></feedback>
</answer>
<answer fraction="0">
<text>A distractor</text>
<feedback><text>Ooops!</text></feedback>
</answer>
<answer fraction="0">
<text>Another distractor</text>
<feedback><text>Ooops!</text></feedback>
</answer>
<shuffleanswers>1</shuffleanswers>
<single>true</single>
<answernumbering>abc</answernumbering>
</question>
</code>

== True/false ==

Two answer tags are given, one which is true, and one which is false. The fraction attribute of the answer tag identifies which option is correct (100) and which is false (0). Feedback is supported. The following example shows the format when true is the correct answer and false is wrong.

<code xml>
<question type="truefalse">
<answer fraction="100">
<text>true</text>
<feedback><text>Correct!</text></feedback>
</answer>
<answer fraction="0">
<text>false</text>
<feedback><text>Ooops!</text></feedback>
</answer>
</question>
</code>

== Short answer ==

The short answer question type supports alternative correct responses, each with its own weighting and feedback. The Moodle XML format uses one <answer> tag for each of the alternative correct answers.

The <usecase> tag toggles case-sensitivity with the values 1/0.

<code xml>
<question type="shortanswer">
<answer fraction="100">
<text>The correct answer</text>
<feedback><text>Correct!</text></feedback>
</answer>

<question type="shortanswer">
<answer fraction="100">
<text>The correct answer</text>
<feedback><text>Correct!</text></feedback>
</answer>
<answer fraction="100">
<text>An alternative answer</text>
<feedback><text>Correct!</text></feedback>
</answer>
</question>
</code>

== Numerical response ==

The following is a simplified version of the Moodle XML format for numerical responses.

<code xml>
<question type="numerical">
<answer fraction="100">
<text>23</text>
<feedback><text>Feedback</text></feedback>
</answer>
</question>
</code>

Moodle also supports a <tolerance> tag (how accurate must the number be?) and one or more <unit> tags. Unit tags have names and multipliers. E.g. if the main answer is in kilometres, an additional answer could be the equivalent in metres with a multiplier of 1000.

'''Note:''' prior to 1.7.2 the fraction was expressed as a value between 0 and 1 in a <fraction> element and the answer value was '''not''' enclosed in <text> tags. This format of the numerical question type is deprecated but will still be correctly imported if found (for now).

== Matching ==

Pair matching responses use the <shuffleanswers> tag to determine whether the order of the items should be randomized.
Each pair is contained inside a <subquestion> tag. The first item of each pair is contained with a <text> tag, while the second has an <answer> tag around it as well. Feedback and score weighting is not supported by Moodle for this response type.

<code xml>
<question type="matching">
<subquestion>
<text>This is the 1st item in the 1st pair.</text>
<answer>
<text>This is the 2nd item in the 1st pair.</text>
</answer>
</subquestion>
<subquestion>
<text>This is the 1st item in the 2nd pair.</text>
<answer>
<text>This is the 2nd item in the 2nd pair.</text>
</answer>
</subquestion>
<shuffleanswers>true</shuffleanswers>
</question>
</code>

== Essay ==

An example of the essay type question...

<code xml>
<question type="essay">
<answer fraction="0">
<text></text>
</answer>
</question>
</code>

There isn't an answer and there isn't a grade in this case.

'''Note:''' prior to 1.7.2 the fraction was expressed as a value between 0 and 1 in a <fraction> element and the answer value was '''not''' enclosed in <text> tags. This format of the essay question type is deprecated but will still be correctly imported if found (for now).

== Other question types ==

=== Cloze ===

It is supported, and depends on a special format for the <questiontext> tag.

=== Description response type===

This response type has no further tags other than those contained in the question header (such as <questiontext>).

=== Random matching ===

Moodle has a question type which consists of taking short answer questions in the same quiz and displaying them as a pair matching exercise. However Moodle is neither able to export nor import this question type.

==Text formats==

Moodle XML files should explicity specify the text format ('''html''', '''moodle_auto_format''', '''plain_text''' and '''markdown''' - these correspond to the constants , FORMAT_HTML, FORMAT_MOODLE, etc used in the Moodle code) for each piece of content. Note that, by default, the format should be specified on the parent of the <text> element. This is slightly odd, but a remnant of history.

If the format is not specified for the questiontext, then '''html''' is the default. If the format is not specified on any other part of the question, then the format of the questiontext is the default.

(This default changed around November 2011. Before that, the default was '''moodle_auto_format''' whenever the format was not specified.)

==Useful utilities==
*[https://moodle.org/plugins/qformat_crossxml Cross XML format] This input format plugin is a handy utility that converts question from one question type to another.
*[http://vletools.com Online Moodle XML converter] Convert from existing text files glossaries and quizzes to Moodle XML format. Also can convert from Moodle XMl to text.
*[http://www.learningseekers.com/products MoXMLE - A Java based application] MoXMLE is a Java based application that converts a Simple TXT file into a Moodle XML format.

== See also ==
* [http://www.qedoc.org/index.php?title=Moodle_XML_format Quedoc's Moodle XML documentation]
* [[User:Frank Ralf/Moodle XML1]] (work in progress)
*[[Aiken format]]
*[[XML FAQ]]
*[[Import and export FAQ]]

[[ja:Moodle XMLフォーマット]]
[[de: Moodle XML-Format]]
[[fr:Format XML Moodle]]
[[es:Formato Moodle XML]]

Installing Moodle

2019-10-25T08:43:15Z

Jwelshoff: /* Settings within Moodle */

{{Template:Installing Moodle}}
''This page explains how to install Moodle. If you are an expert and/or in a hurry try [[Installation Quickstart]].''

If you just want to try Moodle on a standalone machine there are 'one-click' installers for Windows (see [[Complete install packages for Windows]]) and for OSX (see [[Complete Install Packages for Mac OS X]]) or [[ install on OS X]]. These are unsuitable for production servers.

== Requirements ==

Moodle is primarily developed in Linux using [[Apache]], [[PostgreSQL]]/[[MySQL]]/[[MariaDB]] and [[PHP]] (sometimes known as the LAMP platform). Typically this is also how Moodle is run, although there are other options as long as the software requirements of the [{{Release notes}} release] are met.

If you are installing Moodle in a Windows server, note that from php5.5 onwards, you will also need to have the Visual C++ Redistributable for Visual Studio 2012 installed from:
http://www.microsoft.com/en-us/download/details.aspx?id=30679 Visual C++] ( x86 or x64)

The basic requirements for Moodle are as follows:

=== Hardware ===
* Disk space: 200MB for the Moodle code, plus as much as you need to store content. 5GB is probably a realistic minimum.
* Processor: 1GHz (min), 2GHz dual core or more recommended.
* Memory: 512MB (min), 1GB or more is recommended. 8GB plus is likely on a large production server
* Consider separate servers for the web "front ends" and the database. It is much easier to "tune"

All the above requirements will vary depending on specific hardware and software combinations as well as the type of use and load; busy sites may well require additional resources. Further guidance can be found under [[Performance_recommendations|performance recommendations]]. Moodle scales easily by increasing hardware.

For very large sites, you are much better starting with a small pilot and gaining some experience and insight. A "what hardware do I need for 50,000 user?" style post in the forums is highly unlikely to get a useful answer.

=== Software ===

See the [{{Release notes}} release notes] in the dev docs for software requirements.

== Set up your server ==

Depending the use case a Moodle server may be anything from a Desktop PC (e.g. for testing and evaluating) to a rackmounted or [[Server cluster|clustered]] solution. As mentioned above there are lots of possibilities for installing the basic server software, some links and pointers are at [[Installing AMP]], [[Internet_Information_Services|IIS]], [[Nginx]].

It will help hugely, regardless of your deployment choices, if time is taken to understand how to configure the different parts of your software stack (HTTP daemon, database, PHP etc). Do not expect the standard server configuration to be optimal for Moodle. For example, the web server and database servers will almost certainly require tuning to get the best out of Moodle.

If a hosting provider is being used ensure that all Moodle [{{Release notes}}#Server_requirements requirements] (such as PHP version) are met by the hosting platform before attempting the installation. It will help to become familiar with changing settings within the hosting provider's platform (e.g. PHP file upload maximums) as the options and tools provided vary.

== Download and copy files into place ==

'''IMPORTANT: While there are now a number of places you can get the Moodle code (including host provided Moodle installers), you are strongly advised to only obtain Moodle from moodle.org. If you run into problems it will be a great deal easier to support you.'''

You have two options:
* Download your required version from http://moodle.org/downloads and unzip/unpack...
* '''OR''' Pull the code from the Git repository (recommended for developers and also makes upgrading very simple):
<pre>
$ git clone -b MOODLE_{{Version3}}_STABLE git://git.moodle.org/moodle.git
</pre>

Other options you might consider:

* ''--depth=1'' for shallow cloning (only) latest revision (be advised! If you are a developer, you will not be able to easily make git updates and modification later on when this feature is used)

* ''--single-branch'' to limit cloning to a single branch, this fetches the Moodle {{Version}} Stable branch (latest weekly build). For a fuller discussion see [[Git for Administrators]].

Either of the above should result in a directory called '''moodle''', containing a number of files and folders.

You can typically place the whole folder in your web server documents directory, in which case the site will be located at '''<nowiki>http://yourwebserver.com/moodle</nowiki>''', or you can copy all the contents straight into the main web server documents directory, in which case the site will be simply '''<nowiki>http://yourwebserver.com</nowiki>'''. See the documentation for your system and/or web server if you are unsure.

:''Tip:'' If you are downloading Moodle to your local computer and then uploading it to your hosted web site, if possible upload the compressed file and decompress at the remote end (check your 'file manager'). Failing that, watch FTP progress carefully for errors or missed files.

* '''Secure the Moodle files:''' It is vital that the files are not writeable by the web server user. For example, on Unix/Linux (as root):
<pre>
# chown -R root /path/to/moodle
# chmod -R 0755 /path/to/moodle
# find /path/to/moodle -type f -exec chmod 0644 {} \;
</pre>
(files are owned by the administrator/superuser and are only writeable by them - readable by everyone else)

The third command finds all the regular files and executes the chmod command 0644 on them.

If you want to use the built-in plugin installer you need to make the directory writable by web server user. It is strongly recommended to use ACL when your server supports it, for example if your Apache server uses account www-data:

<pre>
# chmod -R +a "www-data allow read,delete,write,append,file_inherit,directory_inherit" /path/to/moodle
</pre>

The effect of the previous command is to allow the Apache user account (www-data in this case) to access and change files within the moodle site. Many people would consider this a brave move for a new site admin to implement. In a new moodle you can safely leave this out. A default Ubuntu install does not have the +a option for the chmod command anyway. The +a attribute is an ACL (Access Control List) facility which allows you to set per user access for individual files. For example, OSX has this by default.

== Create an empty database ==

Next create a new, empty database for your installation. You need to find and make a note of following information for use during the final installation stage:
* '''dbhost''' - the database server hostname. Probably ''localhost'' if the database and web server are the same machine, otherwise the name of the database server
* '''dbname''' - the database name. Whatever you called it, e.g. ''moodle''
* '''dbuser''' - the username for the database. Whatever you assigned, e.g. ''moodleuser'' - do not use the root/superuser account. Create a proper account with the minimum permissions needed.
* '''dbpass''' - the password for the above user

If your site is hosted you should find a web-based administration page for databases as part of the control panel (or ask your administrator). For everyone else or for detailed instructions, see the page for your chosen database server:
* [[PostgreSQL]] (recommended)
* [[MariaDB]] (recommended)
* [[MySQL]]
* [[MSSQL]]
* [[Oracle]] (not recommended)

== Create the (''moodledata'') data directory ==

Moodle requires a directory to store all of its files (all your site's uploaded files, temporary data, cache, session data etc.). The web server needs to be able to write to this directory. On larger systems consider how much free space you are going to use when allocating this directory.

Due to the default way Moodle caches data you may have serious performance issues if you use relatively slow storage (e.g. NFS) for this directory. Read the [[Performance_recommendations]] carefully and consider using (e.g.) redis or memcached for [[Caching]].

'''IMPORTANT:''' This directory must '''NOT''' be accessible directly via the web. This would be a serious security hole. Do not try to place it inside your web root or inside your Moodle program files directory. Moodle will not install. It can go anywhere else convenient.

Here is an example (Unix/Linux) of creating the directory and setting the permissions for '''anyone''' on the server to write here. This is only appropriate for Moodle servers that are not shared. Discuss this with your server administrator for better permissions that just allow the web server user to access these files.

<pre>
# mkdir /path/to/moodledata
# chmod 0777 /path/to/moodledata
</pre>

If your server supports ACL it is recommended to set following permissions, for example if your Apache server uses account www-data:
<pre>
# chmod -R +a "www-data allow read,delete,write,append,file_inherit,directory_inherit" /path/to/moodledata
</pre>
If you are planning to execute PHP scripts from the command line you should set the same permissions for the current user:
<pre>
$ sudo chmod -R +a "`whoami` allow read,delete,write,append,file_inherit,directory_inherit" /path/to/moodledata
</pre>

==== Securing moodledata in a web directory ====

If you are using a hosted site and you have no option but to place 'moodledata' in a web accessible directory. You may be able to secure it by creating an .htaccess file in the 'moodledata' directory. This does not work on all systems - see your host/administrator. Create a file called .htaccess containing only the following lines:
<pre>
order deny,allow
deny from all
</pre>

== Start Moodle install ==
It's now time to run the installer to create the database tables and configure your new site. The recommended method is to use the command line installer. If you cannot do this for any reason (e.g. on a Windows server) the web-based installer is still available.

=== Command line installer ===

It's best to run the command line as your system's web user. You need to know what that is - see your system's documentation (e.g. Ubuntu/Debian is 'www-data', Centos is 'apache')

* Example of using the command-line (as root - substitute 'www-data' for your web user):
<pre>
# chown www-data /path/to/moodle
# cd /path/to/moodle/admin/cli
# sudo -u www-data /usr/bin/php install.php
# chown -R root /path/to/moodle
</pre>
The chowns allow the script to write a new config.php file. More information about the options can be found using
<pre>
# php install.php --help
</pre>

You will be asked for other settings that have not been discussed on this page - if unsure just accept the defaults. For a full discussion see [[Administration via command line]]

=== Web based installer ===

For ease of use you can install Moodle via the web. We recommend configuring your web server so that the page is not publicly accessible until the installation is complete.

To run the web installer script, just go to your Moodle's main URL using a web browser.

The installation process will take you through a number of pages. You should be asked to confirm the copyright, see the database tables being created, supply administrator account details and supply the site details. The database creation can take some time - please be patient. You should eventually end up at the Moodle front page with an invitation to create a new course.

It is very likely that you will be asked to download the new config.php file and upload it to your Moodle installation - just follow the on-screen instructions.

==Final configuration==

=== Settings within Moodle ===
There are a number of options within the Moodle Site Administration screens (accessible from the 'Site administration' tab in the 'Administration' block (Classic theme) or the Site administration button in the navigation bar (Boost). Here are a few of the more important ones that you will probably want to check:
* ''Administration > Site administration > Server > Email > Outgoing mail configuration'': Set your smtp server and authentication if required (so your Moodle site can send emails). You can also set a norepy email on this page.
* ''Administration > Site administration > Server > Server > Support contact''. Set your support contact email.
* ''Administration > Site administration > Server > System paths'': Set the paths to du, dot and aspell binaries.
* ''Administration > Site administration > Server > HTTP'': If you are behind a firewall you may need to set your proxy credentials in the 'Web proxy' section.
* ''Administration > Site administration > Location > Update timezones'': Run this to make sure your timezone information is up to date. (more info [[Location]])
** [http://php.net/manual/en/timezones.php Set server's local timezone] inside <tt>php.ini</tt> (should probably be inside <tt>/etc/php.ini</tt> or <tt>/etc/php.d/date.ini</tt>, depending on the underlying OS):
<code php>
[Date]
; Defines the default timezone used by the date functions
date.timezone = "YOUR LOCAL TIMEZONE"
</code>

=== Remaining tasks ===

* '''Configure Cron''': Moodle's background tasks (e.g. sending out forum emails and performing course backups) are performed by a script which you can set to execute at specific times of the day. This is known as a cron script. Please refer to the [[Cron|Cron instructions]].
* '''Set up backups''': See [[Site backup]] and [[Automated course backup]].
* '''Secure your Moodle site''': Read the [[Security recommendations]].
*'''Increasing the maximum upload size''' See [[Installation FAQ]] Maximum upload file size - how to change it?
* '''Check mail works''' (New in 3.7): From Site administration > Server > Test outgoing mail configuration, use the link to send yourself a test email. Don't be tempted to skip this step.

=== Installation is complete :) ===

* Create a new course: You can now access Moodle through your web browser (using the same URL as you set during the install process), log in as your admin user and creatse a new course. See [[Adding a new course|create a new course]].

=== If something goes wrong... ===

Here are some things you should try...

* Check the [[Installation FAQ]]
* Check your file permissions carefully. Can your web server read (but not write) the Moodle program files? Can your web server read and write your Moodle data directory? If you don't fully understand how file ownership and permissions work on your operating system it would be time very well spent to find out.
* Check your database permissions. Have you set up your database user with the correct rights and permissions for your configuration (especially if the web server and database server are different machines)?
* Create your [[Configuration file]] (config.php) by hand. Copy config-dist.php (in the root of the Moodle program directory) to config.php, edit it and set your database/site options there. Installation will continue from the right place.
* Once you have a config.php (see previous tip) you can edit it to turn on debugging (in section 8). This may give you extra information to help track down a problem. If you have access, check your web server error log(s).
* Re-check your php.ini / .htaccess settings. Are they appropriate (e.g. memory_limit), did you edit the correct php.ini / .htaccess file and (if required) did you re-start the web server after making changes?
* Did you include any non-core (optional) plugins, themes or other code before starting the installation script? If so, remove it and try again (it may be broken or incompatible).
* Explain your problem in the [http://moodle.org/mod/forum/view.php?id=28 Installation problems forum]. '''PLEASE''' list your software versions; explain what you did, what happened and what error messages you saw (if any); explain what you tried. There is no such thing as 'nothing', even a blank page is something!

== Platform specific instructions ==

'''Note:''' Much of this information is provided by the community. It may not have been checked and may be out of date. Please read in conjunction with the above installation instructions.

* [[Windows installation]]
** [[Installing Moodle on SmarterASP.NET]]
* [[Unix or Linux Installation]]
* [[Mac Installation]]
* [[Amazon EC2 Cloud Services Installation]]

== See also ==
* [http://www.slideshare.net/gb2048/my-own-moodle Slideshare presentation by Gareth Barnard on installing a local installation of Moodle] and accompanying [https://drive.google.com/folderview?id=0B17B0rYH2zERU21sQnVweUZCUFk&usp=sharing help guides]
* [http://moodle.org/mod/forum/discuss.php?d=182086 New Video Tutorial- How to Install Moodle on Shared Hosting via cPanel (Not Fantastico)]
* [http://moodle.org/mod/forum/discuss.php?d=199542 Video Tutorial - Install Moodle on a Virtual Box from scratch]

[[es:Instalaci%C3%B3n_de_moodle]]
[[de:Installation von Moodle]]
[[fr:Installation de Moodle]]
[[ja:Moodleのインストール]]

Talk:Standards

2019-10-22T12:56:31Z

Jwelshoff: Created page with "This page is in need of an update, as it does not mention LTI Advantage certification, LTI 2.0 (declared deprecated when 1.3 / Advantage was released). Also, more clarity on..."

This page is in need of an update, as it does not mention LTI Advantage certification, LTI 2.0 (declared deprecated when 1.3 / Advantage was released).

Also, more clarity on the nature of the supported open standards is welcome.

Talk:Upload a file repository

2019-08-19T09:50:35Z

Jwelshoff: Created page with "When this repository is disabled or set to Enabled, but hidden, the drag-and-drop file in course page (or other associated file areas) is completely disabled as well. This m..."

When this repository is disabled or set to Enabled, but hidden, the drag-and-drop file in course page (or other associated file areas) is completely disabled as well.

This may be seen as a serious issue when debugging issues where users can't upload files to their courses (in editing mode).

Talk:Glossary settings

2019-04-18T09:00:47Z

Jwelshoff: Created page with "In Glossary Appearance, screenshot images of the various options should be made available, so users can make a better decision on which glossary format to use. Now it is uncle..."

In Glossary Appearance, screenshot images of the various options should be made available, so users can make a better decision on which glossary format to use. Now it is unclear how the format differ from each other.

Also, please clarify the description and differences between 'Simple, dictionary format' and the 'Continuous' format, as these are very subtly different.

Add a new user

2017-06-27T13:20:16Z

Jwelshoff: /* Generate password and notify user */

{{Accounts}}
==Adding new users==
An administrator or manager (or any other user with the capability [[Capabilities/moodle/user:create|moodle/user:create]]) can create new user accounts in Site administration > Users > Accounts > Add a new user''. (To add users in bulk, see [[Upload users]].)

[[File:26manualreg.png]]

==General==

===Username===
The user will use this username to log in to the Moodle instance. It needs to be unique. This may be changed. A user's name can only contain alphabetical letters in lowercase, numbers, hyphen '-', underscore '_', period '.', or an at character '@' - unless you enable 'Allow extended characters in usernames' ( ''Site Administration > Security > Site Policies'')

===Authentication method===
The setting specifies how Moodle will check whether the user's specified password is correct.

Accounts created by an administrator use the '''Manual Accounts''' method, and accounts created by the user themselves using the email sign-up method use the E-mail based self-registration method.

===Suspended account===

Suspended user accounts cannot log in or use web services, and any outgoing messages are discarded.

===Generate password and notify user===
Moodle will generate a temporary password and email the user with instructions on how to log in and change it. The email message (as in the screenshot below) may be changed in ''Site administration > Language > Language customisation''. Select 'moodle.php' and the string identifier ''newusernewpasswordtext''
{|
|[[File:26emailpassword.png|thumb|new user email]]
|
|[[File:26changepasswordmessage.png|thumb|How to change the default message]]
|}

===Password===
This is the user's password. It is subject to the password policy in [[Site policies]]. A user can change their password via ''User menu > Preferences''.

===First Name===
The user's first name. It is displayed along with the last name in messages, forum posts, participants list, reports and anywhere where something about the user is shows on the page.

===Surname===
The user's surname. It is displayed along with the first name in messages, forum posts, participants list, reports and anywhere where something about the user is shows on the page.

===Email address===
Password reset notices, forum digests and other messages are sent to this email address from the Moodle site.

'''New in 3.0:''' Duplicate email addresses may be allowed if the setting 'Allow accounts with the same email' is enabled in ''Site administration > Plugins >Authentication >Manage authentication.''

===Email display===
This setting controls who can see the user's email address.

===Email format===
This setting can be used such that Moodle will send text-only emails to the user.

===Email digest type===
This setting set whether the user will receive an email for each new forum post in subscribed forums, or if new posts should be sent once per day in a digest, and which type of digest.
* No digest (one receives individual emails),
* Complete (a single digest daily) or
* Subjects (a single digest daily with only the post topics included).

===Forum auto-subscribe===
If a user subscribes to a forum, new posts will be sent in the digest as specified. This setting sets whether a user is automatically subscribed to forums or if a manual click on the subscription button in each forum is required.

===Forum tracking===
THis setting specifies whether new posts written since the user's last visit should be highlighted as such.

===When editing text===
This setting specifies whether the user prefers to see the WYSIWYG text editor or just a plain text box.

===Screen Reader===
Enabling this setting will improve the display of Moodle to make it more compatible with screen readers.

===City/town===
The user's city or town

===Country===
The user's country

Note: City and country defaults may be set in ''Administration > Site administration > Location > Location settings''.

===Timezone===
This setting is used to adjust the times of messages and assignment/quiz due dates to match the user's local time

===Description===
Information about the user that other users can see.

==User Picture==
The user's picture can be displayed next to the user's name next to any content he/she has posted in Moodle activities such as the forum. See [[User pictures]] for details.

==Interests==
The list of interests can be used as a way of connecting users with similar interests. [[Tags]] must be enabled on the site.

==Optional==
There are several optional fields that come with an standard install. These include:
Web Page, ICA number, Skype ID, AIM ID, Yahoo ID, MSN ID, ID number, Institution, Department, Phone, Mobile Phone, Address.

The site administrator may [[User profile fields|add more custom fields]] and/or turn off any of these "optional" fields.

[[de:Nutzer/in neu anlegen]]
[[es:Añadir un nuevo usuario]]

Add a new user

2017-06-27T13:19:56Z

Jwelshoff: /* Generate password and notify user */

{{Accounts}}
==Adding new users==
An administrator or manager (or any other user with the capability [[Capabilities/moodle/user:create|moodle/user:create]]) can create new user accounts in Site administration > Users > Accounts > Add a new user''. (To add users in bulk, see [[Upload users]].)

[[File:26manualreg.png]]

==General==

===Username===
The user will use this username to log in to the Moodle instance. It needs to be unique. This may be changed. A user's name can only contain alphabetical letters in lowercase, numbers, hyphen '-', underscore '_', period '.', or an at character '@' - unless you enable 'Allow extended characters in usernames' ( ''Site Administration > Security > Site Policies'')

===Authentication method===
The setting specifies how Moodle will check whether the user's specified password is correct.

Accounts created by an administrator use the '''Manual Accounts''' method, and accounts created by the user themselves using the email sign-up method use the E-mail based self-registration method.

===Suspended account===

Suspended user accounts cannot log in or use web services, and any outgoing messages are discarded.

===Generate password and notify user===
Moodle will generate a temporary password and email the user with instructions on how to log in and change it. The email message (as in the screenshot below)may be changed in ''Site administration > Language > Language customisation''. Select 'moodle.php' and the string identifier ''newusernewpasswordtext''
{|
|[[File:26emailpassword.png|thumb|new user email]]
|
|[[File:26changepasswordmessage.png|thumb|How to change the default message]]
|}

===Password===
This is the user's password. It is subject to the password policy in [[Site policies]]. A user can change their password via ''User menu > Preferences''.

===First Name===
The user's first name. It is displayed along with the last name in messages, forum posts, participants list, reports and anywhere where something about the user is shows on the page.

===Surname===
The user's surname. It is displayed along with the first name in messages, forum posts, participants list, reports and anywhere where something about the user is shows on the page.

===Email address===
Password reset notices, forum digests and other messages are sent to this email address from the Moodle site.

'''New in 3.0:''' Duplicate email addresses may be allowed if the setting 'Allow accounts with the same email' is enabled in ''Site administration > Plugins >Authentication >Manage authentication.''

===Email display===
This setting controls who can see the user's email address.

===Email format===
This setting can be used such that Moodle will send text-only emails to the user.

===Email digest type===
This setting set whether the user will receive an email for each new forum post in subscribed forums, or if new posts should be sent once per day in a digest, and which type of digest.
* No digest (one receives individual emails),
* Complete (a single digest daily) or
* Subjects (a single digest daily with only the post topics included).

===Forum auto-subscribe===
If a user subscribes to a forum, new posts will be sent in the digest as specified. This setting sets whether a user is automatically subscribed to forums or if a manual click on the subscription button in each forum is required.

===Forum tracking===
THis setting specifies whether new posts written since the user's last visit should be highlighted as such.

===When editing text===
This setting specifies whether the user prefers to see the WYSIWYG text editor or just a plain text box.

===Screen Reader===
Enabling this setting will improve the display of Moodle to make it more compatible with screen readers.

===City/town===
The user's city or town

===Country===
The user's country

Note: City and country defaults may be set in ''Administration > Site administration > Location > Location settings''.

===Timezone===
This setting is used to adjust the times of messages and assignment/quiz due dates to match the user's local time

===Description===
Information about the user that other users can see.

==User Picture==
The user's picture can be displayed next to the user's name next to any content he/she has posted in Moodle activities such as the forum. See [[User pictures]] for details.

==Interests==
The list of interests can be used as a way of connecting users with similar interests. [[Tags]] must be enabled on the site.

==Optional==
There are several optional fields that come with an standard install. These include:
Web Page, ICA number, Skype ID, AIM ID, Yahoo ID, MSN ID, ID number, Institution, Department, Phone, Mobile Phone, Address.

The site administrator may [[User profile fields|add more custom fields]] and/or turn off any of these "optional" fields.

[[de:Nutzer/in neu anlegen]]
[[es:Añadir un nuevo usuario]]

Add a new user

2017-06-27T13:19:36Z

Jwelshoff: /* Generate password and notify user */

{{Accounts}}
==Adding new users==
An administrator or manager (or any other user with the capability [[Capabilities/moodle/user:create|moodle/user:create]]) can create new user accounts in Site administration > Users > Accounts > Add a new user''. (To add users in bulk, see [[Upload users]].)

[[File:26manualreg.png]]

==General==

===Username===
The user will use this username to log in to the Moodle instance. It needs to be unique. This may be changed. A user's name can only contain alphabetical letters in lowercase, numbers, hyphen '-', underscore '_', period '.', or an at character '@' - unless you enable 'Allow extended characters in usernames' ( ''Site Administration > Security > Site Policies'')

===Authentication method===
The setting specifies how Moodle will check whether the user's specified password is correct.

Accounts created by an administrator use the '''Manual Accounts''' method, and accounts created by the user themselves using the email sign-up method use the E-mail based self-registration method.

===Suspended account===

Suspended user accounts cannot log in or use web services, and any outgoing messages are discarded.

===Generate password and notify user===
Moodle will generate a temporary password and email the user with instructions on how to log in and change it. The email message (as in the screenshot below)may be changed in ''Site administration > Language > Language customisation'' Select 'moodle.php' and the string identifier ''newusernewpasswordtext''
{|
|[[File:26emailpassword.png|thumb|new user email]]
|
|[[File:26changepasswordmessage.png|thumb|How to change the default message]]
|}

===Password===
This is the user's password. It is subject to the password policy in [[Site policies]]. A user can change their password via ''User menu > Preferences''.

===First Name===
The user's first name. It is displayed along with the last name in messages, forum posts, participants list, reports and anywhere where something about the user is shows on the page.

===Surname===
The user's surname. It is displayed along with the first name in messages, forum posts, participants list, reports and anywhere where something about the user is shows on the page.

===Email address===
Password reset notices, forum digests and other messages are sent to this email address from the Moodle site.

'''New in 3.0:''' Duplicate email addresses may be allowed if the setting 'Allow accounts with the same email' is enabled in ''Site administration > Plugins >Authentication >Manage authentication.''

===Email display===
This setting controls who can see the user's email address.

===Email format===
This setting can be used such that Moodle will send text-only emails to the user.

===Email digest type===
This setting set whether the user will receive an email for each new forum post in subscribed forums, or if new posts should be sent once per day in a digest, and which type of digest.
* No digest (one receives individual emails),
* Complete (a single digest daily) or
* Subjects (a single digest daily with only the post topics included).

===Forum auto-subscribe===
If a user subscribes to a forum, new posts will be sent in the digest as specified. This setting sets whether a user is automatically subscribed to forums or if a manual click on the subscription button in each forum is required.

===Forum tracking===
THis setting specifies whether new posts written since the user's last visit should be highlighted as such.

===When editing text===
This setting specifies whether the user prefers to see the WYSIWYG text editor or just a plain text box.

===Screen Reader===
Enabling this setting will improve the display of Moodle to make it more compatible with screen readers.

===City/town===
The user's city or town

===Country===
The user's country

Note: City and country defaults may be set in ''Administration > Site administration > Location > Location settings''.

===Timezone===
This setting is used to adjust the times of messages and assignment/quiz due dates to match the user's local time

===Description===
Information about the user that other users can see.

==User Picture==
The user's picture can be displayed next to the user's name next to any content he/she has posted in Moodle activities such as the forum. See [[User pictures]] for details.

==Interests==
The list of interests can be used as a way of connecting users with similar interests. [[Tags]] must be enabled on the site.

==Optional==
There are several optional fields that come with an standard install. These include:
Web Page, ICA number, Skype ID, AIM ID, Yahoo ID, MSN ID, ID number, Institution, Department, Phone, Mobile Phone, Address.

The site administrator may [[User profile fields|add more custom fields]] and/or turn off any of these "optional" fields.

[[de:Nutzer/in neu anlegen]]
[[es:Añadir un nuevo usuario]]

Add a new user

2017-06-27T13:19:22Z

Jwelshoff: /* Generate password and notify user */

{{Accounts}}
==Adding new users==
An administrator or manager (or any other user with the capability [[Capabilities/moodle/user:create|moodle/user:create]]) can create new user accounts in Site administration > Users > Accounts > Add a new user''. (To add users in bulk, see [[Upload users]].)

[[File:26manualreg.png]]

==General==

===Username===
The user will use this username to log in to the Moodle instance. It needs to be unique. This may be changed. A user's name can only contain alphabetical letters in lowercase, numbers, hyphen '-', underscore '_', period '.', or an at character '@' - unless you enable 'Allow extended characters in usernames' ( ''Site Administration > Security > Site Policies'')

===Authentication method===
The setting specifies how Moodle will check whether the user's specified password is correct.

Accounts created by an administrator use the '''Manual Accounts''' method, and accounts created by the user themselves using the email sign-up method use the E-mail based self-registration method.

===Suspended account===

Suspended user accounts cannot log in or use web services, and any outgoing messages are discarded.

===Generate password and notify user===
Moodle will generate a temporary password and email the user with instructions on how to log in and change it. The email message (as in the screenshot below)may be changed in ''Site administration >Language > Language customisation'' Select 'moodle.php' and the string identifier ''newusernewpasswordtext''
{|
|[[File:26emailpassword.png|thumb|new user email]]
|
|[[File:26changepasswordmessage.png|thumb|How to change the default message]]
|}

===Password===
This is the user's password. It is subject to the password policy in [[Site policies]]. A user can change their password via ''User menu > Preferences''.

===First Name===
The user's first name. It is displayed along with the last name in messages, forum posts, participants list, reports and anywhere where something about the user is shows on the page.

===Surname===
The user's surname. It is displayed along with the first name in messages, forum posts, participants list, reports and anywhere where something about the user is shows on the page.

===Email address===
Password reset notices, forum digests and other messages are sent to this email address from the Moodle site.

'''New in 3.0:''' Duplicate email addresses may be allowed if the setting 'Allow accounts with the same email' is enabled in ''Site administration > Plugins >Authentication >Manage authentication.''

===Email display===
This setting controls who can see the user's email address.

===Email format===
This setting can be used such that Moodle will send text-only emails to the user.

===Email digest type===
This setting set whether the user will receive an email for each new forum post in subscribed forums, or if new posts should be sent once per day in a digest, and which type of digest.
* No digest (one receives individual emails),
* Complete (a single digest daily) or
* Subjects (a single digest daily with only the post topics included).

===Forum auto-subscribe===
If a user subscribes to a forum, new posts will be sent in the digest as specified. This setting sets whether a user is automatically subscribed to forums or if a manual click on the subscription button in each forum is required.

===Forum tracking===
THis setting specifies whether new posts written since the user's last visit should be highlighted as such.

===When editing text===
This setting specifies whether the user prefers to see the WYSIWYG text editor or just a plain text box.

===Screen Reader===
Enabling this setting will improve the display of Moodle to make it more compatible with screen readers.

===City/town===
The user's city or town

===Country===
The user's country

Note: City and country defaults may be set in ''Administration > Site administration > Location > Location settings''.

===Timezone===
This setting is used to adjust the times of messages and assignment/quiz due dates to match the user's local time

===Description===
Information about the user that other users can see.

==User Picture==
The user's picture can be displayed next to the user's name next to any content he/she has posted in Moodle activities such as the forum. See [[User pictures]] for details.

==Interests==
The list of interests can be used as a way of connecting users with similar interests. [[Tags]] must be enabled on the site.

==Optional==
There are several optional fields that come with an standard install. These include:
Web Page, ICA number, Skype ID, AIM ID, Yahoo ID, MSN ID, ID number, Institution, Department, Phone, Mobile Phone, Address.

The site administrator may [[User profile fields|add more custom fields]] and/or turn off any of these "optional" fields.

[[de:Nutzer/in neu anlegen]]
[[es:Añadir un nuevo usuario]]

Add a new user

2017-06-27T13:19:06Z

Jwelshoff: /* Generate password and notify user */

{{Accounts}}
==Adding new users==
An administrator or manager (or any other user with the capability [[Capabilities/moodle/user:create|moodle/user:create]]) can create new user accounts in Site administration > Users > Accounts > Add a new user''. (To add users in bulk, see [[Upload users]].)

[[File:26manualreg.png]]

==General==

===Username===
The user will use this username to log in to the Moodle instance. It needs to be unique. This may be changed. A user's name can only contain alphabetical letters in lowercase, numbers, hyphen '-', underscore '_', period '.', or an at character '@' - unless you enable 'Allow extended characters in usernames' ( ''Site Administration > Security > Site Policies'')

===Authentication method===
The setting specifies how Moodle will check whether the user's specified password is correct.

Accounts created by an administrator use the '''Manual Accounts''' method, and accounts created by the user themselves using the email sign-up method use the E-mail based self-registration method.

===Suspended account===

Suspended user accounts cannot log in or use web services, and any outgoing messages are discarded.

===Generate password and notify user===
Moodle will generate a temporary password and email the user with instructions on how to log in and change it. The email message (as in the screenshot below)may be changed in ''Site administration >Language >Language customisation'' Select 'moodle.php' and the string identifier ''newusernewpasswordtext''
{|
|[[File:26emailpassword.png|thumb|new user email]]
|
|[[File:26changepasswordmessage.png|thumb|How to change the default message]]
|}

===Password===
This is the user's password. It is subject to the password policy in [[Site policies]]. A user can change their password via ''User menu > Preferences''.

===First Name===
The user's first name. It is displayed along with the last name in messages, forum posts, participants list, reports and anywhere where something about the user is shows on the page.

===Surname===
The user's surname. It is displayed along with the first name in messages, forum posts, participants list, reports and anywhere where something about the user is shows on the page.

===Email address===
Password reset notices, forum digests and other messages are sent to this email address from the Moodle site.

'''New in 3.0:''' Duplicate email addresses may be allowed if the setting 'Allow accounts with the same email' is enabled in ''Site administration > Plugins >Authentication >Manage authentication.''

===Email display===
This setting controls who can see the user's email address.

===Email format===
This setting can be used such that Moodle will send text-only emails to the user.

===Email digest type===
This setting set whether the user will receive an email for each new forum post in subscribed forums, or if new posts should be sent once per day in a digest, and which type of digest.
* No digest (one receives individual emails),
* Complete (a single digest daily) or
* Subjects (a single digest daily with only the post topics included).

===Forum auto-subscribe===
If a user subscribes to a forum, new posts will be sent in the digest as specified. This setting sets whether a user is automatically subscribed to forums or if a manual click on the subscription button in each forum is required.

===Forum tracking===
THis setting specifies whether new posts written since the user's last visit should be highlighted as such.

===When editing text===
This setting specifies whether the user prefers to see the WYSIWYG text editor or just a plain text box.

===Screen Reader===
Enabling this setting will improve the display of Moodle to make it more compatible with screen readers.

===City/town===
The user's city or town

===Country===
The user's country

Note: City and country defaults may be set in ''Administration > Site administration > Location > Location settings''.

===Timezone===
This setting is used to adjust the times of messages and assignment/quiz due dates to match the user's local time

===Description===
Information about the user that other users can see.

==User Picture==
The user's picture can be displayed next to the user's name next to any content he/she has posted in Moodle activities such as the forum. See [[User pictures]] for details.

==Interests==
The list of interests can be used as a way of connecting users with similar interests. [[Tags]] must be enabled on the site.

==Optional==
There are several optional fields that come with an standard install. These include:
Web Page, ICA number, Skype ID, AIM ID, Yahoo ID, MSN ID, ID number, Institution, Department, Phone, Mobile Phone, Address.

The site administrator may [[User profile fields|add more custom fields]] and/or turn off any of these "optional" fields.

[[de:Nutzer/in neu anlegen]]
[[es:Añadir un nuevo usuario]]

Learning plan supervisor

2017-05-23T11:03:18Z

Jwelshoff: /* Assign your teacher the new role */

{{Competencies}}Course teachers cannot by default create, manage or view student [[Learning plans|learning plans]], since competencies and learning plans exist outside of a course context, whereas the role of teacher is assigned in the course context. To allow course teachers to create, manage and view learning plans ''for the students they are responsible for only'', follow these steps:

==Create two custom roles==

====Learning plan supervisor (system)====

#From Site administration, access the Define Roles screen and click the button to Add a new role.
#Click the Continue button.
#Give your role the name ''Learning plan supervisor (system)''
#Tick 'System' as the context type where the role may be assigned.
#Scroll down and set the capabilities moodle/site:configview, moodle/competency:templatemanage, moodle/competency:templateview and block/lp:view all to Allow.
#Save the new role.

====Learning plan supervisor (user)====

#From Site administration, access the Define Roles screen and click the button to Add a new role.
#Click the Continue button.
#Give your role the name ''Learning plan supervisor (user)''
#Tick 'User' as the context type where the role may be assigned.
#Scroll down and set the capabilities moodle/competency:planmanage, moodle/competency:planreview, moodle/competency:plancomment all to Allow.
#Save the new role.

==Create a cohort of the teacher's students==
In order to ensure the new learning plan supervisor can only deal with his/her own students, we need to create a cohort.

#From Site administration, access the Cohorts screen and add a new cohort.
#Add the students of the teacher you wish to make a learning plan supervisor.

==Match the cohort to their teacher==
#From Site administration, access the Cohorts screen and create a cohort with the relevant students in it.
#Then from the Users tab, click the link Assign user roles to cohort.
#From the top dropdown, choose your teacher.
#In the middle ('Select role') dropdown, choose 'Learning plan supervisor (user)'. (Note that only roles with 'User' ticked as the context type where they may be assigned will be visible here.)
#From the bottom ('Select cohorts') dropdown, choose the cohort with the teacher's students.
# Click the Assign button.

==Assign your teacher the new role==
#From Site administration, access the Users screen, and then from Permissions, click Assign system roles.
#Assign your chosen teacher the role of Learning plan supervisor (system).

==What the teacher sees==
''Note: The role will not take effect immediately; only once the scheduled task has run.''

The course teacher will see a Site administration link and be able to access learning plan templates:

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

He/she will be able to add a new learning template.

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

Once the template is created, clicking the Edit link will allow them to create new learning plans ''only for the students in the cohort'' created by the admin.

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

The course teacher and learning plan supervisor will be able to see the learning plans from their students' profiles.

==See also==
*The [[Learning plan viewer]] role allows course teachers to view (but not create or edit) the learning plans of their students.
*The [[Competency reviewer]] role allows course teachers to view evidence uploaded by students and review their competencies.

[[Category:Roles]]

[[es:Supervisor de plan de aprendizaje]]

Competencies

2017-04-10T14:02:35Z

Jwelshoff: /* Course competencies */

{{Tracking progress}}
== What are competencies?==

Competencies describe the level of understanding or proficiency of a learner in certain subject-related skills. Competency-based education (CBE), also known as Competency-based learning or Skills-based learning, refers to systems of assessment and grading where students demonstrate these competencies. In Moodle 3.1 it is possible to create and apply frameworks for evaluating students against competencies in Moodle.
*Video: [https://www.youtube.com/watch?v=6zzVgFcQToU| CBE for admins]
*Video: [https://www.youtube.com/watch?v=mxBaPnP0j1g| CBE for teachers]
*Video: [https://www.youtube.com/watch?v=QF7Bb3mN9tA| CBE for students]

==How is it set up?==

*Competencies may be enabled by an administrator in ''Site administration > Competencies''.
*Administrators can then set up competency frameworks and add competencies to them. See [[Competency frameworks]] for more information.
*They can then create learning plan templates, add competencies to them and assign learning plans to individual selected students or to whole cohorts. See [[Learning plans]] for more information.
*Teachers can add competencies to courses and course activities. They can view a [[Competency breakdown report |competency breakdown report]] from the Administration block and rate competencies.
*Staff with the relevant capabilities can review student learning plans and view any evidence of prior learning students submit. For more details see [[Competencies FAQ]].
*Students can view their learning plans, upload evidence of prior learning and request reviews. For more details see [[Competencies FAQ]].
*For those with the relevant capabilities, a new [[Learning plans block]] is available to be added to the dashboard (for example).

== Course competencies ==

*A course teacher can list which of the competencies they will be teaching in their course from ''Navigation > My courses > 'Course name' > Competencies.'' A teacher can add or remove competencies from a course here, and see which competencies have been linked to which activities. Clicking on the competency name will take the teacher to a grading page for that competency.
*A student can also see (but not change) the competencies linked to a course from ''Navigation > My courses > 'Course name' > Competencies'' and will also see their current rating for each competency.

===Manually rating course competencies===

A course teacher can rate the students against each of the course competencies from ''Course administration > Reports > Competency breakdown.'' Select a student from the menu ''(1)'' and then click on the desired competency ''(2)'':

[[File:compbreakdownreport2.png|thumb|600px|center]]

The page for that student will display and you can then change their rating from the dropdown ''(3)'':
[[File:cbrating.png|thumb|centre|600px]]

For more information, see [[Competencies FAQ]].

== Activity competencies ==

Competencies can be linked to activities. This means you can make sure that you have activities or resources for every competency in the course, by looking at the course competencies page and finding un-mapped competencies.

It is possible to map more than one competency to an activity, by selecting more than once from the competency drop down when setting up the activity.

It is possible to use activity completion to automatically complete - or add evidence to course competencies.

To add a competency to an activity

# Edit the settings for the activity
# In the competencies section, select one or more competencies from the list of course competencies
# If desired, set what to do upon activity completion - attach evidence, send for review or complete the competency

[[File:activity competencies.png|frame|center|Adding competencies to an activity]]

The activity will then be shown under the competency on the course competencies page

[[File:course competencies.png|frame|center|Course competency with linked activity]]

====Example of Activity completion with Activity competencies====
A student must demonstrate a skill four times before they achieve a competency:

*Create four activities (such as four assignments) with activity completion set to receiving a grade.
* Set a pass grade from the assignment setting screen.
*For assignments 2, 3 and 4, restrict access until the previous assignments have been completed.
*In the assignment settings for the final assignment, expand 'Course competencies', select the required competency and set 'Upon activity completion' to 'Complete the competency'.
* The student submits work as normal. The teacher grades work as normal. If all four assignments obtain a pass grade, the competency is automatically achieved.
[[File:studentviewcomp.png|frame|center|Student view of competency achieved.]]

==Backing up and restoring competencies==
Courses with competencies may be backed up to include the competencies. ''However, these will only be restored to a new site if the competencies already exist with the same ID numbers on the new site.''

== Statistics ==

Statistics are built into the various pages.

Student - view competencies in a course:

[[File:course-student.png|thumb|600px|center|Course competency progress for a student]]

Student - view their own learning plan:
[[File:plan-student.png|thumb|600px|center|Learning plans progress for a student]]

Teacher - view competencies in a course:
[[File:course-teacher.png|thumb|600px|center|Course competency statistics for a teacher]]

Manager - view progress for all plans in a template:
[[File:template-manager.png|thumb|600px|center|Learning Plan Template statistics for a manager]]

==See also==

* [[Competencies FAQ]]
* [[Competency reviewer|Competency reviewer role]] - for enabling teachers to review the competencies of students in their class

[[Category:Competencies]]

[[es:Competencias]]

[[fr:Compétences]]
[[de:Kompetenzen]]

Competency frameworks

2017-04-07T13:03:15Z

Jwelshoff: /* Setting a competency rule */

{{Competencies}}Site administrators and users with the [[Capabilities/moodle/competency:competencymanage|capability to manage competency frameworks]] at site or category level can create, import and export a competency framework and define associated competencies. See the video [https://www.youtube.com/watch?v=6zzVgFcQToU| CBE for admins] for more information on manually setting up competency frameworks and the video [https://youtu.be/N65LZ6MZ04c Competency frameworks] for information on importing a framework.

==Adding competency frameworks manually==

*Go to 'Competency frameworks' in Site administration to create competencies in the system, or access the same link from Category administration to add them from a category.
*Any existing frameworks are displayed here; you can click a button to create a new one or look in the [https://moodle.net/mod/data/view.php?id=27 Competency frameworks repository] .

[[File:NewCompFrameworks.png|thumb|600px|center|Click the button to add a new framework or choose from repository]]

*The '''ID number''' should be very specific, especially if it is likely that you will have multiple versions of a competency framework on the site at the same time (e.g. when revising the framework each year).
*The '''Scale''' is the default scale used when rating a competency. An individual competency in a framework can have a different scale to the framework.
*Clicking '''Configure scales''' displays extra information about the scale for ratings. There should be a default value, which is assigned when the competency is completed by an automated rule - and the list of values that are deemed "proficient" need to be listed so that the student can see at a glance, which competencies have been achieved and which have not. For more information see [[Competencies FAQ]].
*From the '''Taxonomies''' drop downs, you can define the words used to describe competencies in the framework, depending on their depth in the tree.

Once you have created a competency framework, it will appear in the list of frameworks and you can add competencies to it.

==Importing competency frameworks==
{{New features}}
*Existing frameworks in CSV format may be imported from 'Import competency framework' in Site administration. See the video [https://youtu.be/N65LZ6MZ04c Competency frameworks] for a demo.
*Moodle.net has a [https://moodle.net/mod/data/view.php?id=27 Competency frameworks repository] for sharing files. It can be accessed directly from 'Competency frameworks' in Site administration.
*If you are unsure how to set up your CSV file, download an existing framework to use as a model. Here is a basic explanation:

#"Parent ID number" - competencies are arranged in a tree. This field indicates which competency is the parent of the current row.
#"ID number" - a string that uniquely identifies this competency in this framework
#"Short name" - a short name for the competency
#"Description" - a longer description for the competency
#"Description format" - a number representing the format of the text in the description. Valid options are: 0 = Moodle format, 1 = HTML, 2 = Plain text, 3 = Wiki format, 4 = Markdown
#"Scale values" - only required on the framework row. Defines a comma separated list of options used to grade the competencies
#"Scale configuration" - a json encoded object used to define the scale configuration. is a valid default
#"Related ID numbers" - a comma separated list of id numbers belonging to competencies related to the current row
#"Is framework" - must be 1 for a single row in the framework which defines the name and description of the entire framework
#"Taxonomy" - defined for the framework row, defines the lang string keys used to describe competencies at each level of the framework

Plugins are available for importing in other formats. [https://moodle.org/plugins/search.php?s=competency+framework&search=Search+plugins Search the Moodle plugins directory for competency framework] to find out what else is available.

===Adding competencies to a framework===

To add competencies to a framework, click on the framework name to go to the page where you can manage the competencies for this framework.

[[File:managing competencies.png|frame|center|Managing competencies for the Mathematics framework]]

This page lets you build the tree of competencies that defines your competency framework. To start adding competencies, first click on a node in the tree (the topmost node in the tree will be the framework itself), then click on the "Add competency" button. (If you have changed the name in Taxonomies, the button will be named differently, such as "Add skill".)

*The '''ID number''' - this is required and must be unique within this competency framework. It is used to map competencies in backup and restore, as well as when migrating to a newer version of a competency framework.
*The '''Scale''' and items in "Configure scales" will default to the scale configured for the competency framework, but can be changed for an individual competency if required.
*Clicking Edit next to a competency once it has been created and selected displays other options, for example marking it as "related" to other competencies or creating an automatic completion rule. An automatic completion rule allows one competency to be completed automatically when all sub-competencies are complete.
[[File:relatedcompetency.png|thumb|600px|center|More options with selected competencies]]

===Setting a competency rule===
Competency rules can be added to any competency in a framework, as long as it has children. A competency rule can be used to automatically mark as complete a parent competency when all children of it are complete. Linking the child competencies to course activities combined with the competency rule 'Mark as complete when all children are complete' will award the parent competency to a student when he has successfully completed the course activities.

*A competency may be marked complete when other competencies are complete or have a certain number of points.
*To do this, click Edit next to the competency and choose ''Competency rule''
*Click in the box next to Outcome (''1'' below) and choose "Mark as complete" ''(2'' below.)

{|
| [[File:competencyrulea.png|thumb|400px|Click the arrow]]
| [[File:competencyruleb.png|thumb|400px|'Mark as complete' reveals a 'When' field]]
|}
*From the new 'When' field, you can choose 'All children are complete' or 'Points required are met'. For 'Points required' you can then set the points and whether or not a competency is required:
[[File:competencyrulec.png|center]]

==Exporting competency frameworks==
{{New features}}
Competency frameworks may be exported in CSV format from 'Export competency framework' in Site administration.

[[File:exportcompframework.png|center]]

[[es:Estructuras de competencia]]
[[fr:Référentiels de compétences]]

[[de:Kompetenzrahmen]]