This document provides instructions on integrating the YuJa Enterprise Video Platform into your Canvas Learning Management System (LMS). If you have any questions regarding any steps in this process, please contact your dedicated Customer Success Manager.
Overview
The below steps will add the YuJa Enterprise Video Platform as an LTI tool that can be accessed within one or more of your Canvas courses.
* Note: If your organization is running a 2018 or earlier version of Canvas, please update your Canvas to the latest version in order to use YuJa Enterprise Connector for LTI 1.3.
Generating Canvas Developer Keys
The instructions below will allow users to create a new Developer Key that can be used to generate a Deployment ID for the YuJa Enterprise Connector for LTI 1.3 in Canvas.
- Log in to Canvas as an admin.
- Navigate to the Admin tab and choose Developer Keys. Click the + Developer Keys button and select + LTI Key.
- From the Method drop-down menu, select Paste JSON.
- Under Key Name, enter YuJa.
-
Access your institution's JSON string by entering the following URL into a new browser window: https://<INST_URL>/P/LTI/Canvas/CanvasLTI3Config.json
- Replace <INST_URL> with your zone URL.
- Example: https://lakewood.yuja.com/P/LTI/Canvas/CanvasLTI3Config.json
- Copy the text in between the outer braces, and paste it under LTI 1.3 Configuration. The Redirect URls field will automatically be filled.
-
The following parameters are highly recommended. For more information on each parameter, please reach out to your dedicated Customer Success Manager. Otherwise, please add the following parameters (including quotations) to the Custom Fields section in the JSON string.
- "lti_login_id”:”$Canvas.user.loginId",
- “canvas_course_id=$Canvas.course.id”
-
Note: After adding the parameter above, Custom Fields should be displayed as the following:
- "custom_fields": {
"canvas_course_previous_context_ids": "$Canvas.course.previousContextIds",
"lti_login_id": "$Canvas.user.loginId",
"canvas_course_id": "$Canvas.course.id"
}
- "custom_fields": {
- Click Save to add the LTI Key.
- Update State from Off to On and copy down the Developer Key for later use.
Adding the YuJa Enterprise Video Platform to All Courses
With the LTI Developer Key set up, the Admin can now go ahead and add the YuJa Enterprise Video Platform to all courses in Canvas. If you wish to enable the YuJa Enterprise Video Platform per course basis, please go to the next section.
- Log into Canvas as an Admin.
- Navigate to the Admin tab and choose Settings. From the navigation menu, choose Apps and click on View App Configurations.
- Click on + App, then under Configuration Type, choose By Client ID.
-
Enter the Client ID obtained from step 9 in the Generating Canvas Developer Keys section, and then click Submit.
- If everything is set up correctly, it will say YuJa is detected. Next, click Install.
- Once YuJa is installed, click on the Gear icon and choose Deployment Id. Copy down the whole thing for later use.
Adding the YuJa Enterprise Video Platform on a Per Course Basis
With the LTI Developer Key set up, the Admin can now go ahead and add the YuJa Enterprise Video Platform to certain desired courses. The following steps should be repeated for each desired course. If you wish to enable the YuJa Enterprise Video Platform for all courses, please go to the previous section.
- Log into Canvas as an Admin.
- Navigate to the desired course and choose Settings. From the navigation menu, choose Apps and click on View App Configurations.
- Click on + App, then under Configuration Type, choose By Client ID.
- Type in the Developer Key obtained in Generating Canvas Developer Keys step 7 then click Submit.
- If everything is set up correctly, it will say YuJa is detected. Next, click Install.
- Once YuJa is installed, click on the Gear icon and choose Deployment Id. Copy down the whole thing for later use.
Integrating Canvas into the YuJa Enterprise Video Platform
With the YuJa Enterprise Video Platform set up in Canvas, the next step is to integrate Canvas into the YuJa Enterprise Video Platform.
- Log into the YuJa Enterprise Video Platform as an admin, and select the Admin Panel from the Main Menu icon.
- From the left-hand navigation menu, click on Integrations.
- From the Select Integration drop-down menu, choose LMS via LTI 1.3.
- For Choose an LMS, select Canvas.
- Under API Configuration, follow the instructions below to fill out the fields and click Save once you're done.
-
ISS:
- For Production instances: https://canvas.instructure.com
- For Test instances: https://canvas.test.instructure.com or https://canvas.beta.instructure.com
- Client ID: Click Add and enter the client ID obtained in Generating Canvas Developer Keys step 5.
- OIDC Endpoint: https://<YOUR_CANVAS_DOMAIN>/api/lti/authorize_redirect
- JWKS Endpoint: https://<YOUR_CANVAS_DOMAIN>/api/lti/security/jwks
- Outh2 Token Endpoint: https://<YOUR_CANVAS_DOMAIN>/login/oauth2/token
- Deployment ID: Click Add and enter the deployment ID obtained in step 6 in the section above. If entering multiple Deployment IDs, separate each by a single comma.
- Register LMS Vanity URLs: If your institution has a vanity URL, enter it here. If entering multiple URLs, separate each by a single comma.
-
ISS:
- Log into your Canvas domain. Go to any courses with YuJa installed and click on the YuJa LTI link to log into the YuJa Enterprise Video Platform.
Note: When filling out the API Configuration fields, please ensure that there are no spelling mistakes, extra symbols, or spaces.
Using the YuJa Media Chooser
With the YuJa Enterprise Video Platform set up, users will be able to use the YuJa Media Chooser to embed their videos in Canvas.
- Open the text editor in Canvas and click the Apps icon. Select YuJa Media from the pop-up menu.
- Once the YuJa Media Chooser opens, click the Upload Media tab. Users will be able to embed any video from their Media Library to embed in Canvas after selecting a video and clicking Insert Content.
Gradebook Integration with Canvas
This section provides the instruction for the optional integration of the YuJa Enterprise Video Platform Gradebook into your Canvas Gradebook. This section assumes you already followed the previous sections and completed the setup.
Creating Video Quizzes in Canvas Assignments
The instructions below will allow users to create a new video quiz by using the Assignments option in Canvas.
- Navigate to the Assignments tab in your Canvas course and select + Assignments.
- Enter the name for the quiz and assign a grade. Scroll down to the Submission Type to select External Tools, then press Find.
- Select YuJa from the list, then choose the video quiz under the Quizzes tab that you would like to embed.
- Once done, click Select to choose the video quiz then click Save and Publish.
- Students will be able to take the quiz when they go to their Assignments tab in Canvas.
Viewing the Gradebook
Once students submit their answers to the quiz, instructors will be able to check their grades by going to the Grades tab in Canvas.