Skip to content

Moodle - Manual Registration

Summary

Manual registration is available in version 3.9 or higher of Moodle.

To set up LTIAAS with Moodle you need to:

  1. Create a new tool in the Moodle installation
  2. Register the Moodle installation inside LTIAAS
  3. Do a test launch

1) Create a new 'External Tool' in your Moodle installation

  1. Login to your Moodle installation as an administrator.
  2. Navigate to 'Site administration' -> 'Plugins' -> 'Activity modules' -> 'External tool' -> 'Manage tools'
  3. Click the 'configure a tool manually' link
  4. In the resulting form. configure the tool with the following information:
    • Tool name: Your Tool Name
    • Tool URL: https://your.ltiaas.com
    • Tool description: Your Tool Description
    • LTI version: LTI 1.3
    • Public key type: Keyset URL
    • Public keyset: https://your.ltiaas.com/keys
    • Initiate login URL: https://your.ltiaas.com/login
    • Redirection URI(s): https://your.ltiaas.com
    • Tool configuration usage: Show in activity chooser as a preconfigured tool
    • Default launch container: (your choice)
    • Supports Deep Linking (Content-Item Message): CHECKED <- This is needed if the LTIAAS deep linking service is going to be used.Otherwise leave it unchecked.
    • Content Selection URL: (left blank)

      NOTE: When using LTIAAS, the Content Selection URL should be left blank. This URL is configured within the LTIAAS setup.

    • Icon URL: https://your-webiste.com/<icon.png>
    • Secure icon URL: https://your-website.com/<icon.png>
    • IMS LTI Assignment and Grade Services:Use this service for grade sync and column management <- This is needed if the LTIAAS assignments and grades service is going to be used.
    • IMS LTI Names and Role Provisioning: Use this service to retrieve members' information as per privacy settings <- This is needed if the LTIAAS names and roles service is going to be used.
    • Tool Settings: Use this service
    • Share launcher's name with tool: Delegate to teacher (recommended)
    • Share launcher's email with tool: Delegate to teacher (recommended)
    • Accept grades from the tool: Delegate to teacher (recommended)
    • Force SSL: CHECKED
  5. Click the 'Save changes' button at the bottom when the form is filled. You can always go back and change this form later if you need to.
  6. After saving, find the tool on the list of tools and click the button that has 4 horizontal lines.
  7. A dialog should pop up that shows the information hat you need to provide to LTIAAS. Save this for the next step.

2) Register The Moodle Installation Inside LTIAAS

Follow the steps on the Registering Your First Platform page. Use the table below to help translate the information provided by the LMS to values needed in the LTIAAS registration process.

LTIAAS Registration API Name Moodle Provided Name
name Any name you would like that helps you identify your LSM
clientId Client ID
url Platform ID
authConfig.method JWK_SET
authConfig.key Public Keyset URL
accesstokenEndpoint Access Token URL
authenticationEndpoint Authentication Request URL

3) Do A Test Launch

  1. In the Moodle installation, go to a course and turn editing on.
  2. Press the "Add and activity or resource" link in one of the section of the course.
  3. Select the newly created tool.
  4. Give the Activity a name, set any other options to your liking, and click 'Save and display'
  5. If the setup was successful, you should see the new tool launch successfully.