English Español Français
Go to YuJa
  1. YuJa Help Center
  2. Panorama LMS Accessibility Platform
  3. Canvas Integration
  4. Administrators

Integrating Panorama into Canvas Using LTI 1.1

Avatar
YuJa
  • Updated

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

 

Obtaining Your Consumer Key, LTI Secret, and XML File for Your Integration 

Before proceeding with the steps below, you will need to have received an email from your Account Manager asking you to sign up for your Panorama account. Sign up for your account, and then proceed with the steps below. 

  1. Log in to your Panorama Account.
  2. Click Configurations from the left-side menu, and then select Integration Settings.

  3. Select LTI 1.1.

  4. Click Download LTI 1.1 XML, and then copy your Consumer Key and LTI Secret. They will be required in the next section of this guide.

Generating a Client Key and Secret

  1. Click + Developer Key > API Key.
    1.png

  2. Enter the following information:

    • Key Name: Panorama API Integration
    • Redirect URls: https://<zoneURL>/canvas-auth
      • US Zone: https://panorama-api.yuja.com/canvas-auth
      • CAN Zone: https://panorama-api-cz.yuja.com/canvas-auth
      • EU Zone: https://panorama-api-ez.yuja.com/canvas-auth
      • AUS Zone: https://panorama-api-az.yuja.com/canvas-auth

    2.png

  3. (Optional) Enable Enforce Scopes.
    Note: We do not recommend enforcing scopes. It will require you to reintegrate Panorama with the Canvas API whenever Panorama adds new functionality that uses the API. If you do not want to proceed with this, please ensure that Enforce Scopes is disabled, then proceed to step 5. 
  4. Check Allow Include Parameters and then check the following parameters:
    3.png
    • Accounts
      • url:GET|/api/v1/accounts
      • url:GET|/api/v1/accounts/:id
      • url:GET|/api/v1/accounts/:account_id/courses
      • url:GET|/api/v1/accounts/:account_id/sub_accounts
    • Admins
      • url:GET|/api/v1/accounts/:account_id/admins
    • Assignments
      • url:GET|/api/v1/courses/:course_id/assignments
      • url:GET|/api/v1/courses/:course_id/assignments/:id
      • url:PUT|/api/v1/courses/:course_id/assignments/:id
    • Courses
      • url:GET|/api/v1/courses
      • url:GET|/api/v1/courses/:id
      • url:GET|/api/v1/courses/:course_id/users
      • url:GET|/api/v1/courses/:course_id/users/:id
      • url:PUT|/api/v1/courses/:id
      • url:POST|/api/v1/courses/:course_id/files
    • Discussion Topics
      • url:GET|/api/v1/courses/:course_id/discussion_topics
      • url:GET|/api/v1/courses/:course_id/discussion_topics/:topic_id
      • url:PUT|/api/v1/courses/:course_id/discussion_topics/:topic_id
      • url:PUT|/api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:id
    • Enrollments
      • url:GET|/api/v1/users/:user_id/enrollments
      • url:GET|/api/v1/courses/:course_id/enrollments 
    • Enrollment Terms
      • url:GET|/api/v1/accounts/:account_id/terms
      • url:GET|/api/v1/accounts/:account_id/terms/:id
    • Files
      • url:GET|/api/v1/courses/:course_id/files
      • url:GET|/api/v1/files/:id
      • url:POST|/api/v1/files/:id
      • url:PUT|/api/v1/files/:id
    • Pages
      • url:GET|/api/v1/courses/:course_id/pages
      • url:GET|/api/v1/courses/:course_id/pages/:url_or_id
      • url:PUT|/api/v1/courses/:course_id/pages/:url_or_id
      • url:POST|/api/v1/courses/:course_id/pages
    • Quizzes
      • url:GET|/api/v1/courses/:course_id/quizzes
      • url:GET|/api/v1/courses/:course_id/quizzes/:id
      • url:GET|/api/quiz/v1/courses/:course_id/quizzes/:assignment_id
      • url:GET|/api/quiz/v1/courses/:course_id/quizzes
      • url:PUT|/api/v1/courses/:course_id/quizzes/:id
      • url:PATCH|/api/quiz/v1/courses/:course_id/quizzes/:assignment_id
    •  Roles
      • url:GET|/api/v1/accounts/:account_id/roles
      • url:GET|/api/v1/accounts/:account_id/roles/:id
    • Rubrics
      • url:GET|/api/v1/courses/:course_id/rubrics
      • url:GET|/api/v1/courses/:course_id/rubrics/:id
    • LTI Resource Links
      • url:GET|/api/v1/courses/:course_id/lti_resource_links
      • url:GET|/api/v1/courses/:course_id/lti_resource_links/:id
  5. Click Save.
    4.png
  6. Locate the newly created Panorama API Integration developer key and copy the Client ID under Details.
  7. Click Show Key and copy the Client Secret.
  8. Log in to Panorama, then from the left-side menu, click Configuration > Integration Settings.
    7.png
  9. From the Select Integration drop-down menu, select LMS API.
  10. Click Add Access Key.
    9.png
  11. For the Canvas Authentication Method, choose Client ID.
  12. In the Client ID field, enter the ID from step 8.
  13. In the Client Secret field, enter the client secret from step 9.
  14. If you used enforced scopes, enable Use Enforced Scopes. Otherwise, skip this step.
  15. Click Authenticate With Canvas.
    Note: Please ensure you are logged in to Canvas as an admin with full privileges.
  16. Click Authorize.
    13.png
  17. Copy the authentication response and go back to Panorama. Paste the response in the Canvas Authentication Response field.
  18. Click Add Access Key.
  19. Click Save Changes to complete the setup.
    15.png

Adding Panorama to Canvas

Once you've obtained your Consumer Key, Secret Key, and XML Configuration, you can add Panorama to your Canvas instance.

  1. Log in to Canvas as an Administrator. From the left sidebar, click Admin, and select the Canvas account for your institution.
  2. Click on Settings > Apps > View App Configurations.
  3. Click + App, fill in the following information, then click Submit to complete the Panorama configuration for Canvas.
     
    • Configuration Type: Paste XML
    • Name: Panorama Configuration
    • Consumer Key: Obtained in the first section of this guide.
    • Secret Key: The LTI Secret obtained in the first section of this guide.
    • XML Configuration: Open the XML file downloaded in the first section of this guide. Copy the content within it in a text editor such as Notepad and paste it here.

Installing the LMS Visualizer

This step requires your Canvas instance to have the Custom CSS/JavaScript Overrides feature enabled. If it is not enabled, please contact your Canvas Account Manager. The LMS Visualizer will allow Panorama's accessibility icons to be displayed. 

  1. Log in to your Panorama Account.
  2. Click Configurations > Integration Settings.
  3. Select LMS Visualizer > Download Visualizer.
  4. Next, log in to Canvas as an Admin. From the left sidebar, click on Admin and select the Account to apply the YuJa Panorama - LMS Viewer.
  5. Select Settings from the left-hand navigation bar, and ensure that the Settings tab is selected from the top row.
     
  6. Scroll down to the Features section.
    • If the option for Custom CSS/JavaScript overrides is available, ensure that it is checked. Then, scroll down and click Update Settings.
    • If the option for Custom CSS/JavaScript overrides is not available, please contact your Canvas Account Manager to enable Custom CSS/JavaScript overrides in the Theme Editor.
  7. Next, click on Themes from the left-hand navigation bar, then choose the + Theme button. Select any theme template from the drop down.
  8. In the Canvas Theme Editor, go to the Upload tab, and select the Canvas Visualizer file you downloaded in step 3 of this section. Important: The Upload tab is only available once your Account Manager enables it.
  9. Next, click Preview Your Changes, then choose Apply Theme. When asked to give your theme a name, type in Panorama Theme.

Uninstalling Panorama from a Canvas Instance

To remove Panorama from a Canvas instance, the Admin will need to remove the LTI app and the LMS Viewer. To learn how to remove these features, please follow the steps below. 

  1. Log in to Canvas as an Administrator. From the left sidebar, click on Admin, and select the Canvas account for your Organization.
  2. Select Settings from the left-hand navigation bar.
  3. Select the App tab from the top row, and then click View App Configuration.
  4. Select the Gear icon for the LTI Panorama app, and click Delete.
  5. Select Delete to confirm the removal of the tool and disable Panorama integration for LTI 1.1. 
  6. Finally, as an Admin, you will need to remove the LMS Viewer by clicking Themes from the navigation menu.
  7. Next, select the theme for Panorama, and click Open in Theme Editor.
  8. From the left-hand panel, click Upload.
  9. Under JavaScript file, Click the X to remove the Panorama script.
  10. Click Save theme. Panorama has now successfully been uninstalled from the Canvas instance.

Related articles

Contact Support