This article provides a step-by-step guide how to configure and install CirQlive MEETS as an LTI tool in your Moodle LMS.
Note, this manual was written for Moodle versions 3 and up. If your institution uses Moodle 2.x please see our Moodle (2.x) LTI Installation Manual.
MEETS offers the option to set up MEETS using LTI 1.0/1.1 as well as LTI 1.3. Choose the option
Table of contents:
- 1. LTI installation in Moodle's Site administration
- 2. Adding activities to course pages
1a Accessing Manage tools in Moodle
On the "ADMINISTRATION" block, go to Site Administration>Plugins>Activity Modules>External Tool. Press "Manage Tools" and then after that page loads, press "configure a tool manually".
Note: for the purpose of this guide, we will use "MEETS" as the name of the LTI tool. You can, however, substitute this name with the name of your choice in the following steps.
1b Setting up LTI 1.0/1.1
For the following section, you will need the Tool Base URL, Consumer Key, and Shared Secret found in your MEETS Administration for this MEETS platform connection. To retrieve these details, please see: Creating a MEETS platform connection for your LMS. Choose LTI version 1.0/1.1
On the "External tool configuration" page in Moodle:
- In the "Tool Settings" section:
- Enter "MEETS" as the "Tool Name".
- Enter the "Tool Base URL" which you received from the MEETS Administration into the Tool URL field
- Choose LTI version 1.0/1.1
- Enter the "Consumer Key" and "Shared Secret" which you received from the MEETS Administration into their corresponding fields.
- In the field of "Show when creating activities, we recommend choosing "Show in activity chooser and as preconfigured tool".
- Set the "Default launch container" to your preferred choice. Most prefer "Embed, without blocks", however if MEETS is displayed in too small of an iframe or your users encounter compatibility issues, select "New window".
- You can check "Supports Deep Linking (Content-Item Message)" if you wish to enable this feature. (See Deep Linking manual).
- You can optionally add a URL of an icon you want to use to differentiate MEETS from other tools you're using.
- In the "Services" section, set the "LMS LTI Assignments and Grade Services", and "Tool Settings" to "Do not use this service". Set "LMS LTI Names and Role Provisioning" to "Use this service to retrieve members' information as per privacy settings"
- In the "Privacy" section:
- Set Share launcher's name, launcher's email to "Always" and Accept grades to "Never".
- After entering the above information, click "Save changes".
1c Setting up LTI 1.3
When setting up LTI 1.3, you will need to transfer information between Moodle and MEETS Administration. Open MEETS Administration platform connection settings as well as Moodle's External tool configuration.
In MEETS Administration open the platform connection settings. Please see: Creating a MEETS integration instance for your LMS. Choose LTI version 1.3
Choose the encryption settings supported by your Moodle and approved by your security team. Moodle 3.9 and upwards are known to support an "Encryption Type" of "Rivest-Shamir-Adleman (RSA)" and "Signing Algorithm" of "RS256". Choose your desired "Key Size", "3072-Bit" is the default, and the option recommended by the US National Security Agency in 2016. After choosing your preferred options, press "Generate".
After clicking Generate, you will get the Public Key to enter into Moodle. You will get the key as both a Public Keyset URL as well as in PEM format (copy and pastable text). You will also have other URLs that you will need to copy and enter into Moodle.
Go to Moodle's External tool configuration.
- Give the Tool a name. We suggest MEETS.
- Enter the Tool URL found in MEETS Administration.
- Choose LTI version 1.3
- In the Public Key Type, choose if you wish to enter the Key as a URL (Keyset URL), or paste the key text (RSA key). Moodle will accordingly give you the appropriate field to enter the data.
- Enter the Initiate Login URL and Redirection URI found in MEETS Administration.
- In the field of "Show when creating activities, we recommend choosing "Show in activity chooser and as preconfigured tool"
- Set the "Default launch container" to your preferred choice. Most prefer "Embed, without blocks", however if MEETS is displayed in too small of an iframe or your users encounter compatibility issues, select "New window".
- You can check "Supports Deep Linking (Content-Item Message)" if you wish to enable this feature (Deep linking manual).
- Enter an icon if you wish. If you don't the standard LTI Moodle icon will show.
- In the "Services" section, set the "LMS LTI Assignments and Grade Services", and "Tool Settings" to "Do not use this service". Set "LMS LTI Names and Role Provisioning" to "Use this service to retrieve member's information as per privacy settings"
- In the "Privacy" section set Share launcher's name, launcher's email to "Always", and Accept grades to "Never".
- After entering the above information, click "Save changes".
After you saved the changed, go to the Moodle LTI "Manage Tools" section, click on the icon to "view configuration details"
It will look like this:
Enter that data into the platform connection settings in the MEETS Administration
Press Save or Save and close
Stage 2. Adding activities to course pages
Go to a course page where you wish to add the MEETS External tool you created and turn editing on.
Press "Add an activity or resource" in the section of your choice.
MEETS should appear in the list of resources and activities after completing Stage 1 of this installation manual. If you have chosen a different Tool Name in Stage 1, the tool will appear with that name in this list.
Select MEETS and press “Show more” in the "General" section.
Uncheck “Display Activity Name”. (Enabling this option will steal a large portion of the screen, negatively affecting the user experience)
If you wish to use a deep link, you can do so on this page as explained in the Deep linking manual.
Important note: Ensure the Consumer Key and Shared Secret fields are left empty (some browsers may erroneously enter your private data).
Save your settings. MEETS will now appear in your course page, giving your users direct, one-click access to the MEETS platform.
Adding MEETS to additional courses
To add MEETS to additional courses, simply repeat Stage 2 for each course. (Stage 1 only needs to be done once per site and instance)