As an admin, you can integrate YuJa Lumina into your 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 Account 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 an LTI 1.3 connection.
Generating Canvas developer keys
Before integrating YuJa Lumina into Canvas, you must create a new Developer Key to generate a Deployment ID for the LTI 1.3 connection in Canvas.
- Log in to Canvas as an admin.
- In the sidebar, select Admin > Developer Keys.
-
Click + Developer Key > + LTI Key.
- In the Key Name field, enter YuJa Lumina.
-
In the Method drop-down menu, select Enter URL.
- Paste your institution's JSON URL under JSON URL. Your institution's JSON URL is as follows: 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
-
The Redirect URIs field will automatically be filled.
-
Click Save.
-
Ensure that the Developer Key State is toggled on.
-
Click on the pencil icon.
-
Scroll down to the Additional Settings button to expand the field.
-
Add the following parameters (including quotations) to the Custom Fields section. For more information on each parameter, please reach out to your dedicated Account Manager.
"lti_login_id”:”$Canvas.user.loginId",
“canvas_course_id=$Canvas.course.id”
-
Click Save in the bottom right corner. The Key Settings modal will close automatically.
-
Click View in Canvas Apps. A new Canvas window will open.
-
Click Unlock app.
-
In the pop-up, click Unlock.
-
Next, click the pencil icon.
-
Change the status to Available, then click Save.
-
Upon clicking Save, click Copy Client ID, as it will be required in the next sections.
Adding YuJa Lumina to all courses
Once the LTI Developer Key is set up, you can add YuJa Lumina to all your courses in Canvas.
- Log in to Canvas as an Admin.
- In the side navbar, select Admin.
- Select Settings.
-
Select the Apps tab > View App Configurations.
-
Ensure that the toggle is enabled for the app for YuJa Lumina.
-
Click on the Gear button and select Deployment Id.
-
Take note of the Deployment Id for later use.
Adding YuJa Lumina to a single course
Once the LTI Developer Key is set up, you can add YuJa Lumina to the courses you choose.
- Log in to 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 Client ID copied in step 19 of Generating Canvas Developer Keys, and then click Submit.
-
Click Install.
-
Click on the Gear button and select Deployment Id.
-
Take note of the Deployment Id for use in the next section.
Integrating Canvas into YuJa Lumina
Once the LTI Developer Key is set up, you can integrate Canvas into YuJa Lumina.
- Log in to the YuJa Lumina as an admin.
- Click the Main Menu button and then select Admin Panel.
-
In the sidebar, click Integrations.
-
From the Integrations menu, select Canvas.
-
In the Choose Connection Method drop-down menu, select LTI 1.3.
- In the LTI Configuration section, enter the information as shown below.
-
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 step 18 of Generating Canvas Developer Keys.
- 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 7 in Adding YuJa Lumina to all courses or step 9 in Adding YuJa Lumina to a single course. 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:
-
To complete the process, scroll up to click Save changes in the top right corner.
- Log in to your Canvas domain. Go to any courses with YuJa Lumina installed and click on the YuJa LTI link to log in to YuJa Lumina.
Note: When filling out the API Configuration fields, please ensure that there are no spelling mistakes, extra symbols, or spaces.