This document provides instructions on integrating a YuJa Media Chooser Extension into your Moodle Learning Management System (LMS) using LTI. This extension, called the Moodle Media Chooser, can be installed into your Moodle LMS and is designed to work with Moodle 2.4+.
Integrating the YuJa Media Chooser into Moodle
If you have any questions regarding any steps in this process, please contact your Account Manager. The plugin architecture of the Moodle LMS Extension is provided below.
Local | (local/yuja) | Allows for LTI configuration and provides LTI integration for the other plugins. |
Atto | (lib/editor/atto/plugins/yuja) | Allows you to insert YuJa-hosted media using the Atto editor. |
TinyMce | (lib/editor/tinymce/plugins/yuja) | Allows you to insert YuJa-hosted media using the TinyMCE editor (Legacy). |
Tiny | (lib/editor/tiny/plugins/yuja) | Allows you to insert YuJa-hosted media using the TinyMCE editor for Moodle 4.2 and above. |
Installation
- You will be provided with one zip titled “YuJa Enterprise Video Platform - LMS Media Extension - Moodle Media Chooser”.zip. Unzip this file.
- For each plugin folder, you’ll see an accompanying zip file. The zip files contained are titled “atto_yuja.zip”, “local_yuja.zip”, “tinymce_yuja.zip”, "tiny_yuja.zip"
- Log in to Moodle as an admin, and click Site Administration.
- Select the Plugins tab and then click Install Plugins. provide the zip file and, in turn, click Install Plugin From the ZIP File. Start with the “local_yuja.zip” file first, then install the other two.
- Alternatively, instead of using the Install plugin from the ZIP file option, if you have one zip for all the plugins or wish to perform the installation manually, you can do so by copying the “yuja” folder from each of the below locations into the corresponding folders on your Moodle server:
- Moodle 2.4+: From “tinymce_yuja” copy the “yuja” folder to (path/to/your/moodle/lib/editor/tinymce/plugins/)
- Moodle 2.7+: From “atto_yuja” copy the “yuja” folder to (path/to/your/moodle/lib/editor/atto/plugins/)
- From “yuja_local” copy the “yuja” folder to (path/to/your/moodle/local/)
- For the next copy step, please choose the correct one for your Moodle version:
- To finalize the installation, you will need to log in as an admin to your Moodle instance and navigate to Site Administration/Notifications. You should see the modified plugins listed. If not, click Check for Available Updates.
- Once you see the modified plugins listed, click Upgrade Moodle Database now to complete the installation.
- If this is your first time installing the local_yuja plugin, you will be asked to enter your configuration information. The configuration details will match those used to configure the YuJa Enterprise Video Platform in Section 1.
- If this is your first time installing the Atto plugin, please note that it requires some additional configuration, as noted below.
- Lastly, there is a setting in Moodle that prevents the user from inserting iframes by default, so make sure the Enable Trusted Content in Site Administration/Security/Site Policies is checked to enable iframes. It is possible to navigate to the settings page directly by going to https://<moodle_url>/admin/settings.php?section=sitepolicies.
Additional Configurations
Below are the additional steps to configure the YuJa Media Chooser plugins.
-
Local Plugin:
- The Settings dialog for the Local Plugin will be shown immediately after installing it. If not, or to access it later, navigate to Site Administration/Plugins/Local plugins/YuJa Package Config.
- You will be asked to enter the LTI version and the Tool URL. The LTI version is LTI 1.3 and the Tool URL would have been provided to you by your YuJa Client Success Manager and other details you use to configure an external LTI tool to access the YuJa Enterprise Video Platform.
-
Atto Rich Text Editor Plugin:
- Once installed, the Atto plugin requires a little bit of additional configuration.
- Go to http://your.moodle/admin/settings.php?section=editorsettingsatto and add a new line in the Toolbar config text area containing yuja = yuja where you want the button to appear. See http://docs.moodle.org/27/en/Text_editor#Toolbar_settings on how to fine-tune Atto's toolbar to your liking.
-
TinyMCE Rich Text Editor (Legacy) Plugin:
- Once the plugin has been installed (see above), the configuration is automatic, and no further action should be taken.
-
TinyMCE Rich Text Editor (Moodle 4.2+) Plugin:
- Once the plugin has been installed (see above), the configuration is automatic, and no further action should be taken.
Optional - Installing the Media Chooser with Grade Book Sync for Moodle
Overview
Content Item Message is a protocol that enables LTI-based tools to pass back authentication information for, among other things, embedded videos. Within Moodle, CIM can be used to embed content using a specified Moodle-defined CIM workflow.
Videos posted to Moodle using the Moodle CIM workflow will be able to track analytics (i.e. the YuJa user watching the video will be known as opposed to the viewer being marked as “Anonymous”).
Note: Currently Moodle does not support CIM-based embedding via text editors; however, the Moodle Development Community has an open ticket to support LTI Content Item through Text Editors in the future (see https://tracker.moodle.org/browse/MDL-56229 and https://moodle.org/mod/forum/discuss.php?d=354590).
Installing the Media Chooser with Grade Book Sync for Moodle
The CIM Tool must be installed through the Moodle LMS.
- Navigate to Site Administrator/Plugins/Activity Modules/External Tools/Manage Tools.
- Click configure a tool manually. Enter the following fields:
- Tool Name: YuJa
- Tool URL: https://<YourInstitutionURL>.yuja.com/LTI3Entry.jsp
- LTI version: LTI 1.3
- Public key type: Keyset URL
-
Public keyset: https://<YourInstitutionURL>.yuja.com/P/Data/LTI3JwksJSONS
-
Initiate login URL: https://<YourInstitutionURL>.yuja.com/LTI3LoginInit.jsp
-
Redirection URI(s): https://<YourInstitutionURL>.yuja.com/LTI3Entry.jsp
-
Custom parameters:
-
moodle_course_previous_context_ids=$Context.id.history
-
lti_login_id=$User.username
-
-
Tool configuration usage: Show in activity chooser and as a preconfigured tool
-
Default launch container: Embed, without blocks.
-
Content-Item Message: Check.
-
Icon URL (Optional: add a custom logo to the YuJa Media Chooser icon):
https://<YourInstitutionZone>/Dashboard/icons/yuja-media-chooser.png
- Expand the Privacy tab and make the following selections. Important: The settings below are required to ensure proper gradebook integration and tracking. It's highly recommended to set all three settings to Always.
-
Share launcher's name with tool: Always.
- Share launcher's email with tool: Always.
- Accept grades from the tool: Always.
-
- Click Save Changes.