As an admin, you can integrate Lumina into their Canvas Learning Management System (LMS). Before integrating Lumina, please ensure that you have full access to Canvas as an admin. If you have any questions about the steps in this guide, please contact your dedicated Client Success Manager.
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
Before integrating Lumina into Canvas, you must create a new Developer Key to generate a Deployment ID for the YuJa Enterprise Connector using LTI 1.3 in Canvas.
- Log in to Canvas as an admin.
- In the sidebar, select Admin > Developer Keys.
- Click Developer Keys > + LTI Key.
- In the Key Name field, enter YuJa Lumina.
- In the Method drop-down menu, select Paste JSON.
- Access your institution's JSON string by entering the 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.
- In the LTI 1.3 Configuration field, paste the text. The Redirect URls field will automatically be filled.
- Add the following parameters. For more information on each parameter, please reach out to your dedicated Client 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”
- 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.
- Enable the Developer Key State toggle.
- Click View in Canvas Apps. A new Canvas window will be opened.
- Click the pencil icon.
- Change the status to Available, then click Save.
Adding Lumina to All Courses
Once the LTI Developer Key is set up, you can add Lumina to all your courses in Canvas.
- Log into Canvas as an Admin.
- In the side navbar, select Admin.
- Select Settings.
-
Select the Apps tab > View App Configurations.
- Click + App.
- In the Configuration Type drop-down field, select By Client ID.
-
In the Client ID field, enter the the Developer Key obtained in step 9 of Generating Canvas Developer Keys, and then click Submit.
-
Click Install.
-
Click on the Gear button and select Deployment Id. Take note of the Id for later use.
Adding Lumina to a Course
Once the LTI Developer Key is set up, you can add Lumina to the courses you choose.
- Log into Canvas as an Admin and select your course.
- Select Settings.
- Select the Apps tab > View App Configurations.
- Click + App.
- In the Configuration Type drop-down field, select By Client ID.
- In the Client ID field, enter the the Developer Key obtained in step 7 of Generating Canvas Developer Keys, and then click Submit.
- Click Install.
- Click on the Gear button and select Deployment Id. Take note of the Id for later use.
Integrating Canvas into Lumina
Once the LTI Developer Key is set up, you can integrate Canvas into Lumina.
- Log into the Lumina as an admin.
- Click the Main Menu button and then select Admin Panel.
-
In the sidebar, click Integrations.
- In the Select Integration drop-down menu, select LMS via LTI 1.3.
- In the Choose an LMS drop-down menu, select Canvas.
- In the LTI Configuration section, enter the information as shown below and then click Save changes on the top of the screen.
-
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 in to Lumina.
Note: When filling out the API Configuration fields, please ensure that there are no spelling mistakes, extra symbols, or spaces.
Using Lumina in Canvas
Once Lumina is set up in Canvas, users will be able to use Lumina to embed their videos in Canvas.
- Log in to Canvas as an admin.
- Click Assignments and select the assignment you want.
- Click Edit.
- Click the Apps button > YuJa Media.
- Select the media you want and then click Upload and Insert Content.
- Click Save.