Set up your Moodle integration

This guide provides all you need to know about configuring and testing your Moodle LTI integration with Perlego.

Included: Ultimate
Add-on required: Essential, Enhanced
Read more about plans and add-ons.

Table of contents

  1. About the Moodle integration
  2. Configure your Moodle integration
    1. Install the Perlego LTI tool into Moodle
    2. Send Perlego your ClientID, LMS URL and default access link
  3. Testing
    1. Basic LTI launch and deep linking launch
  4. Troubleshooting

About the Moodle integration

The integration allows Moodle admins and instructors to deep-link titles from Perlego to a module within a course.

When a student clicks on a Perlego link they are automatically directed to create their account and once registered they will be automatically logged in, creating a seamless experience for your students.

Configure your Moodle integration

Before you start the configuration make sure:

    • Your organisation is on the Ultimate plan OR you have purchased the LMS integration as an add-on
    • You have System Admin access to your Moodle instance.
    • You have a test course within Moodle.
  • You have created an access link for new registrations to be sent to.

    1. Install the Perlego LTI tool into Moodle

    1. In the Moodle Admin menu, navigate to the Site Administration page, click on Plugins, click on External Tool option and then click on the Manage Tools link.

    2. Enter https://perlego.ltiaas.com/register in the Tool URL field.

      Untitled (6)

    3. Click on the Add LTI Advantage button. Alternatively, you can select to configure a tool manually and skip to step 7.
    4. Perlego will now appear in the Tools section, it should be pending. Untitled (7)
    5. Click on the Edit icon. Screenshot 2023-09-14 at 12.19.38

    6. You should see the Tool settings page below. Untitled (8)

    7. Ensure that the tool settings match our API settings. They should be populated automatically.

      • Tool URL: https://perlego.ltiaas.com/lti/launch
      • Public key type: Keyset URL
      • Public Keyset URL: https://perlego.ltiaas.com/lti/keys
      • Initiate Login URL: https://perlego.ltiaas.com/lti/login
      • Redirection URI(s): We have 3 URIs for redirection. Ensure all three are inputted into the field each on a new line.
      <https://perlego.ltiaas.com/lti/launch>
      <https://perlego.ltiaas.com>
      <https://perlego.ltiaas.com/>
    8. Copy the Client ID and make a note of it - you’ll need it later.

    9. Scroll down to the Tool configuration usage section in the form and select Show in activity chooser and as a preconfigured tool in the drop-down.Screenshot 2023-09-14 at 12.28.48

    10. In the Default launch container section of the form select New Window in the drop-down.

      Screenshot 2023-09-14 at 12.29.05

    11. Under Privacy, ensure that Share launcher’s email with tool is set to Always .

    12. Save the changes.

    13. You will be redirected to Plugins → Manage tools → Add tool. Screenshot 2023-09-14 at 12.30.40

    14. Click on the Activate button.

    Here's a quick video walkthrough of the installation steps.

    2. Send Perlego your ClientID, LMS URL and default access link

    Send us the ClientID you’ve generated and your Moodle URL by completing our LMS set up form, so we can complete the registration.

    You’ll also need to tell us which access link your LMS users should be directed to when signing up to Perlego. If you don’t have an access link yet, you’ll need to create one in Perlego. This requires a Perlego admin login.

    If you set up the tool manually, you will have to email all your Tool configuration details to integrations@perlego.com.

    Untitled (9)

    Testing

    Basic LTI launch and deep linking launch

    These steps are to test Basic LTI and deep linking launch in Moodle.

    1. Toggle the Edit Mode on the right top navigation bar in Moodle. To activate Edit Mode, it should change from grey to blue as shown in the image below.Screenshot 2023-09-14 at 15.31.02

    2. Click on the Home menu and then Add an activity or resource. Screenshot 2023-09-14 at 15.35.59

    3. On the pop-up modal search for Perlego.Screenshot 2023-09-14 at 15.36.49
    4. Select Perlego. Then you should see the Adding a new External tool page. Screenshot 2023-09-14 at 15.37.53
    5. Click on Select content. Screenshot 2023-09-14 at 15.38.24

    6. The Perlego content selector should display. Screenshot 2023-09-14 at 15.39.45

    7. Search the content you want to add, or scroll down and select the content. Screenshot 2023-09-14 at 15.42.33
    8. Click on Submit and you should see the image below. Screenshot 2023-09-14 at 15.44.25

    9. Click on Save and Return to course or Save and display button. You should see the content here. Screenshot 2023-09-14 at 15.51.28

    10. Click on the external tool link. You should be redirected to your Perlego access code or get logged into Perlego if you have an existing account.

    Troubleshooting

    Screenshot 2023-09-14 at 15.55.48

    If you get the Something went wrong error, follow these steps:

    1. First re-check all of the tool settings.
    2. If they are correct, then check if the Moodle user you are logged in with is enrolled as a participant on your test course. If they are not, enrol them and test again.
    3. If that doesn’t work, try creating a student user and testing with it. For more details follow the Moodle documentation.
      1. To Create a new user, go to Site administrationUsers → Accounts and click Add a new user . Screenshot 2023-09-14 at 16.08.00
      2. Fill out the form and create the user. Go to Site administrationUsers → Add a new user
      3. Add the user as a participant in a course. Go to HomeAvailable courses → Add a new course. Screenshot 2023-09-14 at 16.16.31
      4. Click on My First Course , then click on Enrol Users, select the user and click on the Enrol Users button. Screenshot 2023-09-16 at 10.27.24

      5. Go back to My first course, click on the course tab then click on Add an activity or resource. Screenshot 2023-09-16 at 10.34.56

      6. Search Perlego. Screenshot 2023-09-16 at 10.35.32
      7. Follow the steps on how to add Perlego content in step 4 above.
      8. Log in as the newly created user.
      9. Click on Available coursesMy first course
      10. Click on the Perlego content that was added to the course. Screenshot 2023-09-16 at 10.40.14
      11. The user will be redirected to Perlego to create an account.

    If you are still hitting the error contact integrations@perlego.com.