1-888-257-2278 Go to YuJa
  1. YuJa Help Center
  2. Panorama Accessibility Platform
  3. Canvas Integration
  4. Administrators

Integrating Panorama Digital Accessibility into Canvas Using LTI 1.1

Avatar
YuJa Product Support
  • 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 Client Success 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 Client Success 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. From the Select Integration drop-down menu, 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.

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 on Admin, and select the Canvas account for your institution.
  2. Click on Settings, navigate to the Apps tab, then select View Apps Configurations. 
  3. Click Add App, fill in the following information, and then click Submit to complete the Panorama configuration for Canvas.
    • Configuration Type: Paste XML
    • Name: Panorama Configuration
    • Consumer Key: Obtained in the previous section of this guide.
    • Secret Key: The LTI Secret obtained in the previous section of this guide.
    • XML Configuration: Open the XML file downloaded in the previous section of this guide. Copy the content within it in a text editor such as Notepad and paste it here.

Generating Canvas Access Token for the YuJa Panorama - LMS Connector

The YuJa Panorama - LMS Connector requires an Access Token to be generated in order to access the API provided by Canvas. To obtain the Access Token, follow the instructions below.

  1. Log in to Canvas as an Admin. On the sidebar, click on Account, then choose Settings from the left side menu.
  2. From the Settings page, scroll down to Approved Integrations, and click on + New Access Token.
  3. Under Purpose, type in YuJa Panorama and leave Expires date blank. Click on Generate Token.
  4. After generating the Access Token, copy down the information under the Token field, as it will be required in the next section of this guide.

Integrating Canvas With Panorama

After noting down your access token from the previous section, you need 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 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 Canvas instance. 

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 from the left-side menu, and then select Integration Settings.
  3. From the Select Integration drop-down menu, select LMS Visualizer and click 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 Canvas Account Manager enables it.

  9. Next, click on Preview Your Changes, and 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 to complete the removal of the LMS Viewer.
  11. Panorama has now successfully been uninstalled from the Canvas instance.

Related articles