Go to YuJa
  1. YuJa Help Center
  2. Panorama LMS Accessibility Platform
  3. Canvas Integration
  4. Administrators

Integrating Panorama into Canvas Using LTI 1.3

Avatar
YuJa Doc Team
  • Updated

This document provides admins with instructions on integrating the Panorama Platform into Canvas using LTI 1.3. Before proceeding with the steps below, please ensure you have full access to your Canvas instance as an admin. If you have questions about the process, please contact your dedicated Client Success Manager.

Obtaining Your Panorama JSON String

Before adding Panorama to your Canvas instance, you will need to obtain your JSON string. To access your JSON string, 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. Then select Integration Settings.
    alt
  3. From the Select Integration drop-down menu, choose LTI 1.3.
  4. In the LTI App Placement section, select the placement for the Panorama LTI app within your LMS.
  5. Click Download LTI 1.3 JSON to obtain your Panorama JSON String. Then proceed to the next section of this guide.
    alt

Adding Panorama to Canvas

Once you've obtained your JSON string, you can add Panorama to your Canvas instance. 

  1. Log in to Canvas as an admin. From the left sidebar, click on Admin, and select the Canvas account for your institution.
  2. From the left-side navigation bar, select Developer Keys.
  3. Click +Developer Key, and then click +LTI Key.
  4. From the Method drop-down menu, select Paste JSON.
  5. Open the JSON file downloaded in the previous section in any text editor, such as Notepad, and copy its content.
  6. Next, paste the copied content into the LTI 1.3 Configuration field.
  7. Provide a Key Name of your choice, and click Save.
    Note: If you want the LTI tool to be disabled on the course navigation bar by default, add the following parameter in the section for the course navigation - "default": "disabled",
    The parameter to set the Panorama LTI link is inserted in the code.
  8. Copy the Client ID that is provided under Details, and make sure the newly created developer key is set to ON under the State column.
  9. Next, select Settings from the navigation bar.  
  10. Select Apps from the top row, and then select View App Configurations.
  11. Select +App from the top-right of the screen.
  12. Under Configuration Type, select By Client ID.
  13. Paste the Client ID copied earlier. Please keep a note of it as it will still be required.
  14. Click Submit to create the app.
  15. Select the Gear icon next to the newly created app.
  16. From the drop-down menu, select Deployment ID and copy the ID. It will be required in step 20 of this section.
  17. Next, log in to your Panorama account.
  18. Click Configurations from the left-side menu, and then select Integration Settings.
  19. From the Select Integration drop-down menu, select LTI 1.3.
  20. Fill out the information below based on your Panorama environment (Account Type). 
    • Production Environment: 
      • Client ID: The Client ID that was copied in step 8. 
      • Deployment ID: The deployment ID that was copied in step 16. 
      • ISS: https://canvas.instructure.com
      • OIDC Endpoint: https://canvas.instructure.com/api/lti/authorize_redirect
      • JWKS Endpoint: https://canvas.instructure.com/api/lti/security/jwks
    • Test Environment:
      • Client ID: The Client ID that was copied in step 8. 
      • Deployment ID: The deployment ID that was copied in step 16. 
      • ISS: https://canvas.test.instructure.com
      • OIDC Endpoint: https://canvas.test.instructure.com/api/lti/authorize_redirect
      • JWKS Endpoint: https://canvas.test.instructure.com/api/lti/security/jwks
    • Beta Environment:
      • Client ID: The Client ID that was copied in step 8. 
      • Deployment ID: The deployment ID that was copied in step 16. 
      • ISS: https://canvas.beta.instructure.com
      • OIDC Endpoint: https://canvas.beta.instructure.com/api/lti/authorize_redirect
      • JWKS Endpoint: https://canvas.beta.instructure.com/api/lti/security/jwks
  21. Click Save Changes to add Panorama to your Canvas instance and then proceed to the next section of this guide.

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. Important: If you would like more control over which APIs Panorama has access to, please visit our guide on Generating a Client ID and Secret for the Panorama Canvas Connector. After completing the steps in the linked guide, please proceed to the section titled Installing the LMS Visualizer.

  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 the Expires date blank.
  4. Click Generate Token.
  5. 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. 
    Note: If your token contains a tilde (~), please only copy the characters after the tilde as your token.

Integrating Canvas With Panorama

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

  1. Log in to Panorama, click Configurations, and then select Integration Settings. 
  2. Under the Select Integration drop-down menu, choose LMS API.
  3. Click Add Access Key.
  4. Under Access Token, paste the token obtained in the previous section of this guide. 
    Note: If your token contains a tilde (~), please only copy the characters after the tilde as your token. 
  5. Click Add Access Key.
  6. Click Save Changes. Panorama will now be able to retrieve information from your Canvas instance. You can choose which courses or accounts Panorama can access by managing your scope settings. 

Installing the LMS Visualizer 

Installing the LMS visualizer will allow Panorama's icons to appear within courses. 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.

  1. Log in to Panorama.
  2. Click Configurations from the left-side menu, and then select Integration Settings.
  3. From the Select Integration drop-down menu, choose 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. Next, click on Themes from the left-hand navigation bar, then click the + Theme button. Select any theme template from the drop-down.
  7. In the theme editor, go to the Upload tab, and select the Visualizer file that was downloaded. Important: The Upload tab is only available once your Canvas Account Manager enables it.
  8. Next, click Preview Your Changes, and then choose Apply Theme. When asked to give your theme a name, type in Panorama Theme.

Related articles