1-888-257-2278 Go to YuJa
  1. YuJa Help Center
  2. Panorama LMS Accessibility Platform
  3. Moodle Integration
  4. Administrator

Integrating YuJa Panorama Digital Accessibility into Moodle 4.0 Using LTI 1.3

Avatar
YuJa Product Support
  • Updated

This document provides instructions on integrating the Panorama platform into your Moodle 4.0 Learning Management System (LMS). Before proceeding with the steps below, please ensure that you have full access to your Moodle instance as an admin. If you have questions regarding any steps in this process, please contact your dedicated Customer Success Manager.

Obtaining Moodle Web Service Token

The YuJa Panorama - LMS Connector requires an Access Token to be generated in order to access the API provided by Moodle. To obtain the Access Token, follow the instructions below.

  1. Log in to Moodle as an admin and select Site administration from the top row.
  2. Select the Server tab.
  3. Scroll down to Web Services and select Overview.
    Server page in Site administration. Overview is highlighted.
  4. Ensure the Status for Enable web services is set to Yes, and Enable protocols is set to rest.
    Overview page showing Enable Web services set to Yes and Enable protocols set to rest.
  5. Navigate back to Web Services and select External services.
    Side administration page. External Services is highlighted.
  6. Click Add.
    The Add button is highlighted.
  7. Enter the Name, Panorama, and ensure the Enabled checkbox is checked.
  8. Click Show more.
    External service page to add Panorama. The enabled option is checked and Show More is highlighted.
  9. Ensure Can download files and Can upload files are checked.
  10. Under the Required capability drop-down menu, search for and add repository/url:view.
  11. Click Add service.
    Can download files and can upload files are checked. Required capability is added and the Add Service button is highlighted.
  12. You'll be redirected to a page to add functions to the service. Click Add functions.
  13. In the search bar, add the following functions, and click Add functions.
    Multiple functions have been added. The Add function button is highlighted.

    • core_enrol_get_enrolled_users_with_capability

    • core_enrol_get_enrolled_users

    • core_course_get_courses

    • core_files_get_files

    • mod_page_get_pages_by_courses

    • mod_assign_get_assignments

    • core_course_get_categories

    • core_course_get_contents

    • mod_forum_get_forums_by_courses

    • mod_glossary_get_glossaries_by_courses

    • mod_data_get_databases_by_courses

    • mod_folder_get_folders_by_courses

    • mod_lesson_get_lessons_by_courses

    • mod_quiz_get_quizzes_by_courses

    • mod_survey_get_surveys_by_courses

    • mod_workshop_get_workshops_by_courses

    • mod_book_get_books_by_courses

  14. Navigate back to Web Services, and select Manage tokens.
    Server tab is selected. Manage tokens is highlighted.
  15. Click Create token.
    Manage tokens page. Create token is highlighted.
  16. Under the User drop-down menu, select a user with administrative permissions. 
  17. For Service, select the Panorama service created earlier, and click Save changes.
    Create token page. User and service is selected. Save changes is highlighted.
  18. After saving the token, you will be redirected to the Manage tokens page. Under the Token column, send the generated token to your Customer Success Manager.
    • Note: Move to the next section of the guide only once you have received all the required information from your Customer Success Manager.
    Manage tokens page showcasing the newly created token.

Installing the Panorama Plugin 

Installing the Panorama plugin requires you to have received the local_panorama.zip and filter_panorama.zip files from your Customer Success Manager.

  1. Select Site administration from the top row.
  2. Select the Plugins tab.
  3. Click Install plugins.
    Plugins tab in Site administration. Install plugin is highlighted.
  4. Click Choose a file.
    the choose a file button is highlighted.
  5. Select the Upload a file tab from the left-side menu, and click Choose File.
  6. Select the local_panorama.zip file provided to you by your Customer Success Manager, and click Upload this file.
    modal to select a file. Choose file is highlighted. the upload this file button is highlighted.
  7. Click Install plugin from the ZIP file.
    Confirmation message to upload file. Continue is highlighted.
  8. Click Continue to install the plugin.
  9. Repeat the above steps to install the filter_panorama.zip file provided to you by your Customer Success Manager.
    the Plugins tab in Site administration.

Configure Settings for Panorama 

After installing the plugins, you will need to configure your settings for Panorama.

  1. Select Site administration from the top row.
  2. Select the Plugins tab.
    The plugins tab in Site administration.
  3. Scroll down to Panorama, and select Panorama for Moodle Settings.
    Panorama for Moodle settings is selected.
  4. Fill in your Primary Identify Key, Secondary Identify Key, LTI Consumer Key, and LTI Key provided to you by your Customer Success Manager.
  5. Click Save changes.
    Panorama for Moodle Settings keys are highlighted and filled out.

Enable the Panorama Filter

Enabling the Panorama filter allows Panorama to be displayed within Moodle.

  1. Select Site administration from the top row.
  2. Select the Plugins tab.
    The plugins tab in Site administration.
  3. Scroll down to Filters, and select Manage filters. 
    Manage filters is selected from the Filters section.
  4. Locate and enable the Panorama for Moodle filter by selecting On in the drop-down menu. The Panorama filter will now be enabled for Moodle Versions above 3.5.
    List of all manged filters. Panorama for Moodle is set to On.

Panorama Configuration Application for Moodle LTI 1.3

  1. Select Site administration from the top row.
  2. Select the Plugins tab.
  3. Click Manage tools.
    Plugins tab in Site administration. Manage tools is selected.
  4. Click configure a tool manually.
    Manage tools page. Configure a tool manually is highlighted.
  5. For External tool configuration, certain fields for Tool settings will require your Zone URL to be entered. Refer to the following URLs for your zone.
    • US Zone: https://panorama-api.yuja.com 
    • CA Zone: https://panorama-api-cz.yuja.com
    • EU Zone: https://panorama-api-ez.yuja.com
  6. Fill out the following information as follows, and then scroll down and click Save changes.
    Settings are filled for Tool settings.
    • Tool name: Panorama LTI 1.3
    • Tool URL: https://<YOUR_ZONE_URL>/lti/lti-app-1.3-entry
    • Tool description: Panorama LTI 1.3 App
    • LTI version: LTI 1.3
    • Public key type: Keyset URL
    • Public Keyset: https://<YOUR_ZONE_URL>/lti/lti-app-1.3-jkw
    • Initiate login URL: https://<YOUR_ZONE_URL>/lti/lti-app-1.3-oidc-initiation 
    • Redirection URL(s): https://<YOUR_ZONE_URL>/lti/lti-app-1.3-entry
  7. Once the Panorama tool has been added, you will be redirected to the Manage tools page. Locate the newly created tool, and click the View Configuration Details icon.
  8. Important: Send the Tool configuration details to your Customer Success Manager to complete the Panorama and Moodle LTI 1.3 configuration. You may send the details by clicking the Email button.
  9. Once your Customer Success Manager has confirmed the integration process, you may continue to the next section of this guide. 
    Tool configuration details.

Once the Panorama Moodle application is configured, admins can enable Panorama within courses. 

  1. Log in to Moodle as an admin and navigate to the course you would like to add Panorama to.
  2. Enable Edit Mode from the top-right corner of the page.
    The edit mode toggle is enabled in a course.
  3. Create or navigate to any section, and then click Add an activity or resource.
    add an activity or resource is highlighted.
  4. Select External Tool.
    External tool is highlighted.
  5. In the Activity name field, enter Panorama or any identifiable name you wish to use. 
  6. For the Preconfigured tool drop-down menu, select the Panorama LTI 1.3 created earlier. 
  7. Click Save and return to course. The Panorama LTI link will now be available within your chosen course.
    Adding a new External tool page. Activity name and preconfigured tool are filled out. the Save and return to course button is highlighted.

Related articles