This document provides instructions on integrating the Panorama Platform into Canvas LTI 1.3. If you have any questions regarding any steps in this process, please contact your dedicated Customer Success Manager.
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.
- Log in to Canvas as an Admin. On the sidebar, click on Account, then choose Settings from the left side menu.
- From the Settings page, scroll down to Approved Integrations, and click on + New Access Token.
- Under Purpose, type in YuJa Panorama and leave Expires date blank. Click on Generate Token.
- After generating the Access Token, copy down the information under the Token field.
- Send the Access Token key to your YuJa Customer Success Manager. Move to the next section once you receive the JavaScript file for the LMS Viewer from your Customer Success Manager.
Installing the YuJa Panorama - LMS Viewer
This step will require your Canvas instance to have the Custom CSS/JavaScript Overrides feature enable. If this is not enabled, please contact your Canvas Account Manager.
- 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.
- Select Settings from the left-hand navigation bar, and ensure that the settings tab is selected from the top row.
- Next, click on Themes from the left-hand navigation bar, then choose the + Theme button. Select any theme template from the drop-down.
- In the theme editor, go to the Upload tab, and select the Canvas Visualizer file that is sent to you by your Customer Success Manager. Important: The Upload tab is only available once your Canvas Account Manager enables it.
- Next, click on Preview Your Changes, and then choose Apply Theme. When asked to give your theme a name, type in Panorama Theme.
- Follow the next section to configure Panorama for Canvas.
Panorama Configuration Application for Canvas LTI 1.3
This step will allow organizations to enable Panorama for all the courses within Canvas LTI 1.3.
- Log in to Canvas as an Administrator. From the left sidebar, click on Admin, and select the Canvas account for your Organization.
- From the left-hand navigation bar, select Developer Keys.
- click +Developer Key, and then click +LTI Key.
- From the Method drop-down menu, select Paste JSON.
- Paste the JSON string provided to you by your Customer Success Manager.
- Provide a Key Name of your choosing, and click Save.
- 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.
- Next, select Settings from the navigation bar.
- Select Apps from the top row, and then select View App Configurations.
- Select +App from the top-right of the screen.
- Under Configuration Type, select By Client ID.
- Paste the Client ID copied earlier.
- Click Submit.
- To complete the process, please contact your Customer Success Manager with your Deployment ID and Client ID to finalize the configuration for Panorama.
- To view your Deployment ID, select the Gear icon next to the newly created app.
- From the drop-down menu, select Deployment ID.
- A small window will open and display the Deployment ID.
- Your Client ID can be located in the Developer Keys menu.
Accessing the Panorama Platform in Canvas
Once Panorama has been configured and added to the desired courses, the tool will be available for use in the course navigation menu.
- To access the Panorama Configuration, navigate to any courses as an Admin and click on the Panorama LTI. Select the Gear icon on the top-right corner.
- Once Panorama is configured, the YuJa Panorama - LMS Viewer will be available in the enabled courses.
- To access the Course Accessibility report, click on the Panorama LTI from the course navigation menu, and then select the Course Reporting option.
- To access the Institution Accessibility report, click on the Panorama LTI from the course navigation menu, and then select the Institution Reporting option.
Uninstalling Panorama from a Canvas Instance
To remove Panorama from a Canvas instance, the Admin will need to remove the LTI app, Developer Key, and the LMS Viewer.
- Log in to Canvas as an Admin. From the left sidebar, click on Admin, and select the Canvas account for your Organization.
- Select Settings from the left-hand navigation bar.
- Select the App tab from the top row, and then click View App Configuration.
- Select the Gear icon for the LTI Panorama app, and click Delete.
- Select Delete to confirm your removal of the tool and disable the Panorama integration for LTI 1.3.
- Next, Admins will need to remove the Developer Key.
- From the left-hand navigation bar, select Developer Keys.
- Under the Actions column, select the Trash Can icon to remove the developer key.
- Select OK to confirm the removal of the key.
- Finally, as an Admin, the LMS Viewer will need to be removed by clicking Themes from the navigation menu.
- Next, select the theme for Panorama, and click Open in Theme Editor.
- From the left-hand Panel, click Upload.
- Under JavaScript file, Click the X to remove the Panorama script.
- Click Save theme to complete the removal of the LMS Viewer.
- Panorama has now successfully been uninstalled from the Canvas instance.