Admins can integrate Engage into their Canvas learning management system (LMS). The integration allows polls to be created, published, and graded directly to Canvas courses and viewed by admins, instructors, and students. If you have any questions regarding the steps in this process, please contact your dedicated Account Manager.
Integrating Engage into Canvas
The integration process will add Engage to all courses in Canvas. Before beginning the integration process, make sure you have received the Redirect URl, Target link URl, OpenID Connection Initiation Url, and the Public JWK from your Account Manager.
- Log in to Canvas as an admin.
- In the side navbar, select Admin, and then select your institution.
- In the side navbar, select Developer Keys.
- Click + Developer Key > + LTI Key.
- In the Key Settings section, enter the information as shown below.
- Key Name: Any name you choose that helps identify the key.
- Redirect URLs: The redirect URLs provided by your Account Manager.
- Method: Select Manual Entry.
- Title: Any name you choose that helps identify the key.
- Description: A description of the key.
- Target Link URl: The Target Link URI provided by your Account Manager.
- OpenID Connect Initiation URL: The OpenID Connect Initiation URLs provided by your Account Manager.
- JWK Method: Select Public JWK URL.
- Public JWK URL: The Public JWK URL provided by your Account Manager.
- In the LTI Advantage Services section, turn on the toggles below.
- Can create and view assignment data in the gradebook associated with the tool.
- Can view assignment data in the gradebook associated with the tool.
- Can view submission data for assignments associated with the tool.
- Can create and update submission results for assignments associated with the tool.
- Can retrieve user data associated with the context the tool is installed in.
-
In the Additional Settings section, enter the information as shown below in Custom Fields:
- canvas_user_id=$Canvas.user.id
- canvas_course_id=$Canvas.course.id
- person_sourcedid=$Person.email.primary
-
In the Privacy Level section, select Public.
-
In the Placements drop-down menu, select Course Navigation and Assignment Selection.
-
In the Assignment Selection section, enter the information as shown below, and then click Save.
- 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.
- Locate the newly created developer key.
- In the Details column for the developer key, take note of the Client ID. It will be required for multiple steps.
- Turn on the State toggle.
- In the side navbar, select Settings.
- Select the Apps tab > + Apps.
- In the Configuration Type drop-down menu, select By Client ID.
- In the Client ID field, paste the Client ID copied from step 12, and then click Submit.
- Locate the YuJa Engage external app.
- Click the Gear button > Deployment Id.
- Copy the Deployment Id. It will be required for Configuring the Engage API.
Configuring the Engage API
Once you have added Engage to Canvas, you will be required to configure the Engage API to allow for data transfer between Canvas and Engage.
- Log in to Canvas and select your course.
- Navigate to Engage.
Note: If you cannot locate Engage, your institution may have set the link under another name. Please reach out to your admin or instructor for more information. - In the side navbar, select Integrations.
- In the Select Integration Type drop-down menu, select LMS LTI 1.3.
- In the Select LMS drop-down menu, select Canvas.
- In the API Configuration section, use the Tool configuration details noted in the Integrating Engage into Canvas section to enter the information as shown below.
- ISS: https://canvas.instructure.com
- Client Id: The Client Id copied in Integrating Engage into Canvas.
- 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: The Deployment Id copied in Integrating Engage into Canvas.
- In the User Configuration and Course Configuration sections, turn on the toggles.
-
Click Save Changes.
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 to Canvas. Please follow the Canvas guide to learn how to manage API access tokens in my user account.
- Log in to Engage as an admin.
- In the side navbar, select Integrations.
- In the Choose Integration Type drop-down menu, select LMS - API.
- In the Choose LMS drop-down menu, select Canvas.
-
In the API Access section, enter the information as shown below.
-
LMS API Link: https://<YOUR_CANVAS_DOMAIN>/api/v1
- Example: https://evergreen.canvas.com/api/v1
- Access Token: Click Override to enter the token copied in Configuring the Engage API.
-
LMS API Link: https://<YOUR_CANVAS_DOMAIN>/api/v1
-
Adjust any additional Linkage Settings as shown below.
- Canvas Course: Select Canvas Course ID.
- Canvas Users: Select Canvas User ID or Primary Email.
- Use Email as Backup Field: Turn on the Use Email as Backup Field toggle.
- Click Save Changes.