Updated SmallPART (markdown)

Ralf Becker 2021-08-28 13:34:32 +02:00
parent 436d20337a
commit 165f7d02bb

@ -8,26 +8,28 @@ SmallPART courses can be embedded into a LMS (Learning Management System) like M
* [Moodle external tool documentation](https://docs.moodle.org/310/en/External_tool)
* recommended is to use LTI 1.3 which allows to create SmallPART as external tool for the whole Moodle installation
* for Moodle < 3.10 you have to use the [manual registration](https://github.com/EGroupware/egroupware/wiki/smallPART-old-Moodle-LTI)
* SmallPART does not yet support the automatic configuration, so you have to configure it manually
![](https://raw.githubusercontent.com/wiki/EGroupware/egroupware/pics/MoodleManageTools.png)
* Moodle 3.10+ support automatic registration using the following URL: ```https://example.org/egroupware/smallpart/```
![](https://raw.githubusercontent.com/wiki/EGroupware/egroupware/pics/MoodleLTIautoRegistration.png)
* you need to replace ```boulder.egroupware.org``` with your own EGroupware Domain and for EGroupware Cloud hosting use ```egw``` instead of ```egroupware``` for the path
* you need to replace ```example.org``` with your own EGroupware Domain and for EGroupware Cloud hosting use ```egw``` instead of ```egroupware``` for the path, then click on [Add LTI Advantage]
![](https://raw.githubusercontent.com/wiki/EGroupware/egroupware/pics/MoodleLTIautoRegistration-done.png)
* then you need to activate the automatic registration in Moodle by clicking on [Activate]:
![](https://raw.githubusercontent.com/wiki/EGroupware/egroupware/pics/MoodleLTIactivateRegistration.png)
* and in EGroupware (Admin > Applications > smallPART > LTI configuration) by unchecking **Disabled** and [Save]:
![](https://raw.githubusercontent.com/wiki/EGroupware/egroupware/pics/EGroupwareLTIactivateRegistration.png)
* then you can check the configuration details in Moodle
![](https://raw.githubusercontent.com/wiki/EGroupware/egroupware/pics/MoodleLTItool.png)
> For the public key Moodle unfortunately does not support a JWK URL (JSON Web Key), so you have to get it from your server under /var/lib/egroupware/default/files/openid/public.key. If you have no access to the server you can use the JWK URL (https://boulder.egroupware.org/egroupware/openid/endpoint.php/jwks) to fetch the key and [use a service to convert it](https://8gwifi.org/jwkconvertfunctions.jsp) (use only the key object ``` {"alg": "RS256", "kty": "RSA", ...}```, not the whole array!)
* then display the configuration details in Moodle
![](https://raw.githubusercontent.com/wiki/EGroupware/egroupware/pics/MoodleLTIdetails.png)
* and add them in EGroupware under Administration > Application > SmallPART > LTI Configuration
![](https://raw.githubusercontent.com/wiki/EGroupware/egroupware/pics/EGroupwareLTIconfig.png)
> Please note: LTI creates accounts in EGroupware, unless your [Moodle authenticates via OpenID Connect against EGroupware](https://github.com/EGroupware/egroupware/wiki/Moodle). Use ```Global Unique Identifier (lis_person_sourceid)``` in that case. If your Moodle has it's own users, use ```Moodle Username``` for the same username in EGroupware as in Moodle. All new users are added to EGroupware's ```Default``` Group and LTI staff and admins to the ```Teachers``` group.
* now you're ready to add a SmallPART course and/or video to a Moodle course
![](https://raw.githubusercontent.com/wiki/EGroupware/egroupware/pics/MoodleAddActivity.png)
![](https://raw.githubusercontent.com/wiki/EGroupware/egroupware/pics/MoodleAddExtTool.png)
> full icon URL: https://boulder.egroupware.org/egroupware/smallpart/templates/default/images/navbar.svg
* now you're ready to add a smallPART course and/or video to a Moodle course
![](https://raw.githubusercontent.com/wiki/EGroupware/egroupware/pics/MoodleLTIaddActivity.png)
![](https://raw.githubusercontent.com/wiki/EGroupware/egroupware/pics/MoodleLTIaddExtTool.png)
* [Select content] allows to interactive select a course and video
![](https://raw.githubusercontent.com/wiki/EGroupware/egroupware/pics/MoodleLTIcontentSelection.png)
* SmallPART video in Moodle (screenshot is from a teacher with rights to edit courses!)
![](https://raw.githubusercontent.com/wiki/EGroupware/egroupware/pics/SmallPARTinMoodle.png)