English Español Français
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
  • Updated

As an admin, you can connect the Panorama Platform with your Moodle Learning Management System (LMS) to make Panorama available inside Moodle for processing documents and WYSIWYG pages.

Adding Panorama to Your Moodle LMS

Panorama must be added to Moodle as an external tool. Once added, you can then enable it for your desired courses. 

Adding Panorama as an External Tool

  1. Log in to Moodle as an admin.
  2. Select Site administration from the sidebar, and then select the Plugins tab from the topbar.
  3. Under Activity modules, click Manage tools.
    Site administration within Moodle

  4. Click configure a tool manually.
    Note: Certain fields for Tool settings will require your Zone URL to be entered. Refer to one of these URLs according to 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

    Configure a tool manually.

  5. Expand the Tool settings section, and enter the information required:
    Important: After saving, please click the Gear icon on the Panorama tool to ensure that your information has been saved.

    •  
      • 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.

    External tool configuration

  6. Expand the Privacy section, and select the required options:
    • Share launcher's name with tool: Always
    • Share launcher's email with tool: Always
  7. Click Save changes. You will be redirected to the Manage tools page.Privacy section in the Manage tools page.
  8. Locate the newly created tool, and click the View Configuration Details icon.
  9. Copy of the tool configuration details. You will need to enter it in Panorama.
    Tool configuration details
  10. Log in to your Panorama account, select Configurations > Integration Settings from the sidebar.Integration Settings within Configuration in Panorama.
     
  11. From the Select Integration drop-down menu, select LTI 1.3.
  12. Enter the required information:
    • Client ID: The client ID that was copied in step 9. 
    • Deployment ID: The deployment ID that was copied in step 9.
    • ISS: The Platform ID that was copied in step 9.
    • OIDC Endpoint: The Authentication request URL that was copied in step 9.
    • JWKS Endpoint: The Public Keyset URL that was copied in step 9. 
  13. Click Save changes.
    Save changes

Adding the Panorama LTI Link to a Moodle Course

  1. From the sidebar in Moodle, select a course that you would like to add Panorama to.
    Selecting a course in moodle sidebar.
  2. Under the Settings icon, click Turn editing on.
    Turn editing on
  3. Click Add an activity or resource.
    Add an activity or resource.
  4. Select External tool.
    External Tool.
  5. In the Activity name field, enter Panorama, or any identifiable name you wish to use. 
  6. From 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.
    Click Save and return to course.
     

Allow Panorama to Open Inside Moodle

Follow the steps below to make sure Panorama opens within Moodle instead of opening in a new tab.

  1. Log in to Moodle as an admin. 
  2. Select Site administration from the sidebar, and then select the Plugins tab from the topbar.Selecting plugin tab.
  3. Under Filters, click Manage Filters.
    24__1_.png
  4. Locate the Panorama for Moodle filter, and select On from the drop-down menu.
    25__1_.png

Installing the Panorama Visualizer Plugin

Installing the Panorama Visualizer will allow Panorama's accessibility icons to be displayed within your Moodle courses. 

  1. Go to Panorama and hover over the sidebar.
  2. Select Configurations > Integration Settings.
  3. Under the Select Integration drop-down menu, select LMS Visualizer.
  4. Click Download Plugins.
  5. Locate the downloaded ZIP file on your device, and extract it. You should see three ZIP files that will need to be uploaded to Moodle later in this guide:
    •  
      • filter_panorama.zip
      • local_panorama.zip
      • local_replacementapipanorama.zip
  6. Log in to Moodle as an admin, select Site administration from the sidebar, and then select the Plugins tab from the topbar.
  7. Click Install plugins.
    15.png
  8.  Click Choose a file...
    16.png
  9. Select the Upload a file tab from the sidebar, and click Choose File.
  10. Select the local_panorama.zip file, and click Upload this file.
    18.png
  11. Click Install plugin from the ZIP file.
    19.png
  12. Click Continue to install the plugin.
  13. Repeat steps 6-12 to install the filter_panorama.zip file.
  14. Repeat steps 6-12 to install the local_replacementapipanorama.zip file.
  15. After installing all three plugins, click Continue.
    20.png
  16. Log in to Panorama.
  17. In the sidebar, select Configurations > Institution Information.
  18. Locate the Primary Identifier Key and Secondary Identifier Key, and copy both keys.
    identifier key
  19. In the Select Integration drop-down field, select LTI 1.1.
  20. In the Consumer Key and LTI Secret fields, copy the text.
    Panorama integration settings with select integrations, consumer key, and LTI secret fields circled
  21. Go back to Moodle.
  22. In the sidebar, select Site administration, and then select the Plugins tab from the topbar.
    21.png
  23. Locate Panorama, and click Panorama for Moodle Settings.
    22.png
  24. In the Primary Identify Key and Secondary Identify Key field, enter the text copied in step 18.
  25. In the LTI Consumer Key field, enter the Consumer Key copied in step 20.
  26. In the LTI Key field, enter the LTI Secret copied in step 20.
    Moodle panorama for moodle settings with identify keys, consumer key and LTI key fields circled
     
  27. Click Save changes.
    Moodle panorama for moodle settings with save changes button circled

Connecting Your Moodle Account to Panorama

After adding Panorama to your Moodle LMS, you have to connect your Moodle account to Panorama through an API integration to start using Panorama.

Generating an access token in Moodle 

Before connecting your institution's Moodle account with Panorama, you have to generate an access token in Moodle, which will be used during the API integration in Panorama later.

  1. Log in to Moodle as an admin.
  2. Select Site administration from the sidebar, and then select the Plugins tab from the topbar.
    1__1_.png
  3. Under Web Services, 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. Go back to the Site administration > Plugins > Web Services.
  6. Under Web Services, select External services.
    1__1_.png
  7. Under Custom Services, click Add.
    5.png
  8. In the Name field, enter Panorama.
  9. Select the Enabled checkbox.
  10. Click Show more...
    6.png
  11. Select the Can download files and Can upload files checkboxes.
  12. From the Required capability drop-down menu, search for repository/url:view and add it.
  13. Click Add service.
    7.png
  14. After being redirected to the External Services page, locate Panorama and click Functions.
    8.png
  15. Under all the existing functions, click Add functions.
    9.png

  16. In the search bar, add all the required 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

    • mod_forum_get_forum_discussions

    • mod_wiki_get_wikis_by_courses

    • mod_resource_get_resources_by_courses

    • local_replacementapipanorama_update_file

    • local_replacementapipanorama_update_attachment

    • local_replacementapipanorama_update_html

    FireShot_Capture_551_-__-_us-east-2-panorama-staging-s3-1.s3.us-east-2.amazonaws.com.png

  17. Click Add functions.
  18. Go back to the Site administration > Plugins > Web Services.
  19. Click Manage tokens.
  20. Click Add.
    12.png
  21. From the User drop-down menu, select a user with admin permissions. 
  22. From the Service drop-down menu, select the Panorama service created earlier.
    13.png
  23. Click Save changes. You will be redirected to the Manage tokens page.
  24. Copy and jot down the token, as it will be required in the next section of this guide.
    111.png

Adding Moodle API to Your Panorama Account

After getting the access token in Moodle, you will need to establish a connection between Moodle and Panorama.

  1. Go to Panorama and hover over the sidebar.
  2. Select Configurations > Integration Settings.
    configuration
  3. Under the Select Integration drop-down menu, select LMS API.
  4. Click Add Access Key.
    Add Access Key
     
  5. In the Access Token field, paste the access token obtained in the previous section of this guide. 
  6. Click Add Access Key.
    add acess key window.
     
  7. Click Save Changes. 
    save change.

Uninstalling Panorama from Your Moodle Instance

  1. Log in to Moodle as an admin.
  2. Select Site administration from the sidebar, and then select the Plugins tab from the topbar.
  3. Under Plugins, click Plugins overview.
    38.png
  4. Locate the filter_panorama plugin, and click Uninstall.
    39.png
  5. Click Confirm to uninstall the plugin.
    40.png
  6. After being redirected to the Plugins overview page, locate and uninstall the local_panorama and local_replacementapipanorama plugin as well.
    41.png
  7. To remove the Panorama external tools located within your courses, select a course that contains the Panorama external tool. 
    31.png
  8. Click Turn editing on.
    1__3_.png
  9. Click Edit next to the Panorama tool.
    2__1_.png
  10. Click Delete.
    3__1_.png
  11. Click Yes to remove the Panorama external tool from the course. Repeat steps 7-10 for any additional courses that contain the Panorama external tool.
    4__1_.png

Related articles

Contact Support