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

Integrating Panorama into Moodle Using LTI 1.3

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

Adding the Panorama Application to 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, and then click Manage tools.
    28.png
  3. Click configure a tool manually.
    00.png
  4. 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
    • AUS Zone: https://panorama-api-az.yuja.com
  5. Fill out the following information, and then scroll down and click Save changes. Important: A known bug in Moodle may remove the information you've entered. After saving, please click the Gear icon on the Panorama tool to ensure your information was saved.
     35.png
    • 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-jwk
    • 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
    • Tool configuration usage for Moodle version 4.5 and later: Show in activity chooser and as a preconfigured tool
      • Note: For Moodle versions lower than 4.5, choose your preferred Tool configuration usage. 
    • Default Launch Container: We recommend selecting New Window.
  6. 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.
  7. Copy of the information provided. You will be required to enter it in Panorama.
    36__1___1_.png
  8. Log in to your Panorama account, click Configurations, and then select Integration Settings.  
  9. From the Select Integration drop-down menu, select LTI 1.3.
  10. Enter the information as shown below:
    • Client ID: The client ID that was copied in step 7. 
    • Deployment ID: The deployment ID that was copied in step 7.
    • ISS: The Platform ID that was copied in step 7
    • OIDC Endpoint: The Authentication request URL that was copied in step 7.
    • JWKS Endpoint: The Public Keyset URL that was copied in step 7. 
  11. Click Save changes and continue to the next section of this guide. 
    9.png

Enabling the Panorama LTI Link within a Moodle Course

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

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

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.
    1__1_.png
  3. Scroll down to Web Services and select Overview.
    2.png
  4. Ensure the Status for Enable web services is set to Yes, and Enable protocols is set to rest.
    3.png
  5. Navigate back to Web Services and select External services.
    1__1_.png
  6. Under Custom Services click Add.
    5.png
  7. Enter the Name, Panorama, and ensure the Enabled checkbox is checked.
  8. Click Show more.
    6.png
  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.
    7.png
  12. After being redirected to the External Services page, find the newly added External service, and select Functions.
    8.png
  13. Scroll down, and click Add functions.
    9.png
  14. In the search bar, add the following functions, and click Add functions.
    FireShot_Capture_551_-__-_us-east-2-panorama-staging-s3-1.s3.us-east-2.amazonaws.com.png

    • 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

    • local_replacementapipanorama

  15. Navigate back to Web Services, and select Manage tokens.
  16. Click on Add.
    12.png
  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.
    13.png
  19. After saving the token, you will be redirected to the Manage tokens page. Keep note of the token, it will be required in the next section of this guide.
    111.png

Integrating Moodle With Panorama

After noting down your access token from the previous section, the final process is to establish a connection between your Canvas 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 Visualizer will allow Panorama's accessibility icons to be displayed within Moodle 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.
    15.png
  7.  Click Choose a file. 
    16.png
  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.
    18.png
  10. Click Install plugin from the ZIP file.
    19.png
  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.
    20.png

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, from the left-side menu, under Configuration, select Integration Settings. 
  5. Under Select Integration, choose LTI 1.1. 
  6. Copy down the Consumer Key and LTI Secret. Your LTI 1.3 Consumer Key and LTI Secret are the same as the LTI 1.1 integration. 
  7. Next, log in to your Moodle account. Click Site administration, and then click the Plugins tab from the top row.
    21.png
  8. Scroll down to Panorama, and select Panorama for Moodle Settings.
    22.png
  9. 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.
      23.png

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.
    1__3_.png
  3. Scroll down to Filters, and select Manage Filters.
     24__1_.png
  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.
    25__1_.png

Uninstalling Panorama from 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 Plugins overview.
    38.png
  3. Locate the filter_panorama plugin, and click uninstall.
    39.png
  4. Click Confirm to uninstall the plugin.
    40.png
  5. After being redirected to the Plugins overview page, locate and uninstall the local_panorama plugin as well.
    41.png
  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. 
    31.png
  7. Click Turn editing on in the top-right corner.
    1__3_.png
  8. Click Edit next to the Panorama LTI tool.
    2__1_.png
  9. Click Delete.
    3__1_.png
  10. Click Yes to remove the Panorama external tool from the course. Repeat steps 6-9 for any additional courses which contain the Panorama external tool in order to complete the uninstallation process of Panorama from Moodle.
    4__1_.png

Related articles