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

Integrating Panorama 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). 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 the steps in this process, please contact your dedicated Client Success Manager.

Obtaining Your Consumer Key and LTI Secret 

Before proceeding with the steps below, you will need to have received an email from your Client Success Manager asking you to sign up for your Panorama admin account.

  1. Log in to your Panorama Account.
  2. Click Configurations from the left-side menu, and then select Integration Settings.
  3. From the Select Integration drop-down menu, select LTI 1.1.
  4. Please note your Consumer Key and LTI Secret. They are required for the next section of this guide.

Adding the Panorama Application to Moodle

Once you've obtained your consumer key and LTI secret, you will be able to add Panorama to your 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 Manage tools.
  3. Click configure a tool manually.
     
  4. Fill out the following information as shown below, and then scroll down, click Save changes, and continue to the next section of this guide.  
    • 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
      • AUS Zone: https://panorama-api-az.yuja.com/lti/lti-app
    • Tool description: Panorama LTI 1.1 APP
    • LTI version: LTI 1.0/1.1
    • Consumer key: Obtained from the previous section of this guide.
    • Shared secret: The LTI Secret that was obtained from the previous section of this guide. 

Enabling the Panorama LTI Link within a Moodle Course

Once you have added the Panorama Moodle application, you can enable Panorama within a course of your choosing. 

  1. Log in to Moodle, and from the side panel, click on the course you would like to 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. Please continue to the next section of this guide.

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

    • 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

    • mod_label_get_labels_by_courses
  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. Keep note of the token as it will be required, and then continue to the next section of this guide. 

Integrating Moodle With Panorama

After noting down your access token from the previous section, you will need to establish a connection between your Moodle instance and Panorama so that Panorama can retrieve data. 

  1. Access the Panorama Platform, click Configurations, and then select Integration Settings. 
  2. Under the Select Integration drop-down menu, select LMS API.
  3. Click Add Access Key.
  4. Under Access Token, paste the access token obtained in the previous section of this guide. 
  5. Click Add Access Key.
  6. Click Save Changes. Panorama will now be able to retrieve information from your Moodle instance. 

Installing the Panorama Visualizer Plugin  

The Panorama Visualizer plugin will allow you to see Panorama icons in courses.

  1. Log in to your Panorama Account.
  2. Click Configurations from the left-side menu, and then select Integration Settings.
  3. From the Select Integration drop-down menu, select LMS Visualizer and click Download Plugins.
  4. Locate the downloaded ZIP file on your device, and extract it. You should see two ZIP files that will need to be uploaded to Moodle later in this guide: filter_panorama and local_panorama
  5. To upload the files, log in to Moodle as an admin, click Site administration from the left-side panel, and then click Plugins from the top row.
  6. Click Install plugins.
  7.  Click Choose a file.
  8. Select the Upload a file tab from the left-side menu, and click Choose File.
  9. Select the local_panorama.zip file, and click Upload this file.
  10. Click Install plugin from the ZIP file.
  11. Click Continue to install the plugin.
  12. Repeat the steps 6-11 to install the filter_panorama.zip file. Once completed, continue to the next section of this guide.
     

Configure Settings for Panorama 

After installing the plugins, you will need to configure your Panorama settings. This requires obtaining information from your Panorama account. 

  1. Log in to your Panorama Account.
  2. Click Configurations from the left-side menu, and then select Institution Information.
  3. Copy down your Primary Identifier Key and Secondary Identifier Key.
  4. Next, log in to Moodle and from the left-hand navigation menu, click Site administration, and then click the Plugins tab from the top row. 
  5. Scroll down to Panorama, and select Panorama for Moodle Settings.
  6. Enter the information shown below and click Save Changes. Once done, continue to the next section of this guide. 
    • Primary Identify Key: Obtained in step 3 of this section.
    • Secondary Identify Key: Obtained in step 3 of this section.
    • LTI Consumer Key: The Consumer Key that was obtained in the first section of this guide. 
    • LTI Key: The LTI Secret that was obtained in the first section of this guide. 

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>

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