English Español Français
1-888-257-2278 Go to YuJa
  1. YuJa Help Center
  2. Panorama Accessibility Platform
  3. Moodle Integration
  4. Administrator

Integrating YuJa Panorama for Digital Accessibility into Moodle Using LTI 1.1

Avatar
YuJa Product Support
  • Updated

This document provides instructions on integrating the Panorama Platform into your Moodle Learning Management System (LMS). If you have any 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. In the side panel, click on Site administration.
  2. Select the Plugins tab from the top row.
  3. Scroll down to Web Service, and select Overview
  4. Ensure the Status for Enable web services is set to Yes, and Enable protocols is set to rest.
  5. Navigate back to Web Services, and select External services.
  6. Under Custom Services click Add.
  7. Enter the Name, Panorama, and ensure the Enabled checkbox is checked.
  8. Click Show more.
  9. Ensure 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.
  12. After being redirected to the External Services page, find the newly added External service, and select Functions.
  13. Scroll down, and click Add functions.
  14. In the search bar, add the following functions, and click Add functions.

    • 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

  15. Navigate back to Web Services, and select Manage tokens.
  16. Click on Add.
  17. Under the User drop-down menu, select a user with administrative permissions. 
  18. For Service, select the Panorama service created earlier, and click Save changes.
  19. After saving the token, you will be redirected to the Manage Tokens page. Send the generated token to your Customer Success Manager.    
  20. Move to the next section of the guide only once you have received all the required information from your Customer Success Manager.

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. Click Site administration from the left side panel, and then click Plugins from the top row.
  2. Click Install plugins
  3.  Click Choose a file. 
  4. Select the Upload a file tab from the left-hand menu, and click Choose File.
  5. Select the local_panorama.zip file provided to you by your Customer Success Manager, and click Upload this file.
  6. Click Install plugin from the ZIP file.
  7. Click Continue to install the plugin.
  8. Repeat the above steps to install the filter_panorama.zip file provided to you by your Customer Success Manager.

Configure Settings for Panorama 

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

  1. From the left-hand navigation menu, click Site administration, and then click the Plugins tab from the top row. 
  2. Scroll down to Panorama, and select Panorama for Moodle Settings.
  3. Fill in your Primary Identify Key, Secondary Identify Key, LTI Consumer Key, LTI Key provided to you by your Customer Success Manager, and then click Save changes.

Enable the Panorama Filter

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

  1. Log in to Moodle as an Admin. In the side panel, click on Site administration.

  2. Select the Plugins tab from the top row. 
  3. Scroll down to Filters, and select Manage Filters.
  4. Locate and enable the Panorama for Moodle filter by selecting On from the drop-down menu. The Panorama filter will now be enabled for Moodle Versions above 3.5.
  5. The next step must only be completed for Moodle versions 3.5 and below. 
  6. Click Site administration from the left side panel, and then click the Appearance tab from the top row.
  7. Click Additional HTML.  
  8. In the space provided, add the following script to the Within Head section, and then scroll down and click Save changes to enable the Panorama filter on versions 3.5 and below.

    • <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js"></script>

Panorama Configuration Application for Moodle LTI 1.1

  1. Log in to Moodle as an Admin. In the side panel, click on Site administration.
  2. Select the Plugins tab from the top row, and then click Manage tools.
  3. Click configure a tool manually. 
  4. Fill out the following information as follows, and then scroll down and click Save changes. 
    • Tool name: Panorama LTI 1.1
    • Tool URL: Copy and paste the URL based on your zone.
      • US Zone: https://panorama-api.yuja.com/lti.lti-app 
      • CA Zone: https://panorama-api-cz.yuja.com/lti/lti-app 
      • EU Zone: https://panorama-api-ez.yuja.com/lti/lti-app
    • Tool description: Panorama LTI 1.1 APP
    • LTI version: LTI 1.0/1.1
    • Consumer key: Obtained from your Customer Success Manager
    • Shared secret: Obtained from your Customer Success Manager

Enabling the Panorama LTI Link within a Moodle Course

Once the Admin has configured the Panorama Moodle application, Instructors can enable Panorama within a course of their choosing. 

  1. Log in to Moodle as an Instructor. In the side panel, click on the course you would like add Panorama to.
  2. Click Turn editing on in the top-right corner.
  3. Click Add an activity or resource.
  4. Click External tool.
  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.1 created earlier. 
  7. Click Save and return to course. 
  8. The Panorama LTI link will now be available within your chosen course. 

Uninstalling Panorama from Moodle Instance

  1. Log in to Moodle as an Admin. In the side panel, click on Site administration.
  2. Select the Plugins tab from the top row, and then click Plugins overview. 
  3. Locate the filter_panorama plugin, and click uninstall.
  4. Click Confirm to uninstall the plugin.
  5. After being redirected to the Plugins overview page, locate and uninstall the local_panorama plugin as well.  
  6. Finally, remove the Panorama external tools located within your courses. In the side panel, click on the course that contains a Panorama external tool. 
  7. Click Turn editing on in the top-right corner.
  8. Click Edit next to the Panorama LTI tool. 
  9. Click Delete.
  10. Click Yes to remove the Panorama external tool from the course. Repeat the steps for any additional courses which contain the Panorama external tool in order to complete the uninstallation process of Panorama from Moodle. 

Related articles