1-888-257-2278 Go to YuJa
  1. YuJa Help Center
  2. YuJa Engage
  3. Canvas
  4. Administrator

Integrating the YuJa Engage Platform for Canvas LTI 1.3

Avatar
YuJa Product Support
  • Updated

Admins can integrate the YuJa Engage Platform into their Canvas Learning Management System (LMS). The integration will allow polls to be created and published directly to desired courses and viewed by admins, instructors, and students. If you have any questions regarding the steps in this process, please contact your dedicated Customer Success Manager.

Integrating YuJa Engage for LTI 1.3

The integration process will add YuJa Engage to all courses within your institution's LMS. Before beginning the integration process, please ensure you have received the Redirect URl, Target link URl, OpenID Connect Url, and the Public JWK URL from your Customer Success Manager.

  1. Log in to Canvas as an admin. Click Admin from the left-hand main menu, and select your institution. 
  2. From the navigation menu, click Developer Keys.
    The developer key page for Canvas. The Admin tab and Developer Keys tab are both highlighted.
  3. Click + Developer Key, and then select + LTI Key from the drop-down menu.
    The + Developer Key button is slected and LTI Key is highlighted from the drop-down menu.
  4. Enter the following information for your Key Settings:
    Key settings are filled out.
    • Key Name: A name of your choosing (e.g. YuJa Engage).
    • Redirect URLs: Obtained from your Customer Success Manager.
    • Method: Manual Entry.
    • Title: A title of your choosing (e.g. YuJa Engage).
    • Description: A description of your choosing (e.g. YuJa Engage LTI 1.3)
    • Target Link: Obtained from your Customer Success Manager.
    • OpenID Connect Initiation URL: Obtained from your Customer Success Manager.
    • JWK Method: Public JWK URL.
    • Public JWK URL: Obtained from your Customer Success Manager.
  5. Next, click on LTI Advantage Services and enable the following services:
    LTI Advantage services with the first six option selected.
      • Can create and view assignment data in the gradebook associated with the tool.
  6. Select the Additional Settings and enter the Custom Fields below:
      • canvas_user_id=$Canvas.user.id
      • canvas_course_id=$Canvas.course.id
      • person_sourcedid=$Person.email.primary
  7. Set the Privacy Level to Public.
    Privacy level set to public in additional settings.
  8. From the Placements drop-down menu, select Course Navigation and Assignment Selection.
    Course Navigation set for placements.
  9. Next, under Assignment Selection fill out the information as follows.
      • Target Link URL: Same as the Redirect URL entered above.
      • Select Message Type: LtiDeepLinkingRequest
      • Selection Height: We recommend entering the value 600.
      • Selection Width: We recommend entering the value 800.
  10. For the newly created developer key, copy the Client ID located under the Details column. It will be required for multiple steps. 
  11. Ensure the developer key is set to ON under the State column.
    The developer keys page with client ID and Status both highlighted for the newly created key.
  12. From the left-hand navigation menu, click Settings.
  13. Click on the Apps tab in the top row, then click View App Configurations.
    The settings page with the App tab and View App configuration button highlighted.
  14. Click + App.
    External Apps page with the +App button highlighted.
  15. From the Configuration Type drop-down menu, select By Client ID.
  16. Paste the Client ID copied earlier into the Client ID field, and click Submit.
    Add App page with configuration type, client ID, and the Submit button highlighted.
  17. Next, locate the YuJa Engage external app, click the Gear icon, and select Deployment Id from the drop-down menu.
    External apps page has the gear icon highlighted for the new app created and deployment ID highlighted.
  18. Copy the Deployment Id. It will be required for the next section of this guide.
    The deployment ID.

Configuring the API for YuJa Engage

Once the integration process is complete, you will be required to configure the YuJa Engage API to allow for data transfer.

  1. Log in to YuJa Engage as an admin.
  2. From the left-hand navigation menu, select Integration.
  3. From the Choose Integration Type drop-down menu, click LMS LTI 1.3.
  4. Select Canvas.
    LMS -LTI 1.3 and Canvas are selected from the drop-down menu and are highlighted.
  5. Within the API Configuration, enter the following information:
    The API Configuration fields are filled.
    • ISS: https://canvas.instructure.com
    • Client Id: Enter the Client Id copied earlier.
    • OIDC Endpoint: https://canvas.instructure.com/api/lti/authorize_redirect
    • JWKS Endpoint: https://canvas.instructure.com/api/lti/security/jwks
    • OAuth2 Token Endpoint: https://canvas.instructure.com/login/oauth2/token
    • Deployment Id: Enter the Deployment Id copied earlier.
  6. Click Save Changes to complete the integration process and add YuJa Engage to all courses within your institution.
    The Save button is highlighted for the integration settings.

Integrating Course Roster Sync

Once the integration is complete, you can enable course roster sync to automatically update the Engage roster with a list of students within a specified course. Before proceeding with the steps below, you will need to add an access token on Canvas. Please follow the Canvas guide to learn how to add an access token: Add Access Token.

  1. Log in to YuJa Engage.
  2. From the left-side navigation menu, select Integration.
  3. From the Choose Integration Type drop-down menu, click LMS - API.
  4. Select Canvas.
    The Engage Integration page for Canvas.
  5. Enter the following API Access information:
    • Domain: Your Canvas domain URL
      • Example: evergreen.canvas.com
    • LMS API Link: https://<YOUR_CANVAS_DOMAIN>/api/v1
      • Example: https://evergreen.canvas.com/api/v1
    • Access Token: Copy and paste the access token you added to your Canvas account. 
    The Engage Integration page for Canvas. The API Access fields are entered.
  6. Adjust any additional Linkage Settings.
    • Canvas Course: The primary linkage attribute will be based on the Canvas Course ID.
    • Canvas Users: The primary linkage attribute can be the user's Canvas User ID or their Primary Email.
    • It is recommended that you check: Use user email and user's name as backup fields if no Canvas User ID is found.
    The Engage Integration page for Canvas. The Linkage settings are adjusted.
  7. Click Save Changes.
    The Engage Integration page for Canvas. The Save button is highlighted.

Related articles