Skip to main content

How to set up the Engageli LTI External Tool in Canvas LMS

  • Updated

This article will walk you through the process of setting up Engageli as an LTI tool within Canvas LMS.

Developer Key/External Tool Setup

The first step to the integration process is to set up the Engageli tool. This will allow Engageli to be used throughout your Canvas instance.

  1. As a Canvas Admin, navigate to the "Admin" > "Developer Keys" area of the platform, as shown below.
  2. Select the "+ Developer Key" button, then select "+ LTI Key" from the corresponding dropdown, as shown below.

  3. In the new page that opens, configure the fields at the top-half of the page as follows:
    • Key Name - Name this as you wish, we recommend including "Engageli" in the name for easy lookup if you need to edit this later on.
    • Redirect URIs - Engageli will provide these.
    • Method - Ensure this is set to "Manual Entry"
    • Title - Name this as you wish, preferably something that references Engageli.
    • Description - Use any description you wish.
    • Target Link URI - Engageli will provide this.
    • OpenID Connect Initiation Url - Engageli will provide this.
    • JWK Method - Set this to "Public JWK URL".
    • Public JWK URL - Engageli will provide this.
  4. In the LTI Advantage Services section, we recommend enabling every option. Engageli might not support every option at this time, but enabling all options now will save you from having to revisit this area in the event that we make enhancements. Screenshot below for reference.

  5. In the Additional Settings section, populate the "Custom Fields" box. Below is a list of all entries to add to this box:
     
    term_name=$Canvas.term.name
    course_roles=$Canvas.membership.roles
    course_end_date=$Canvas.course.endAt
    course_start_date=$Canvas.course.startAt
    Below is a screenshot of how this should appear within Canvas:

    For context, these are key-value pairs containing Canvas variables that will be passed to Engageli. Depending on your use case, Engageli may have you add additional variables in this area.
  6. In the Additional Settings section, ensure the Privacy Level flag is set to "PUBLIC"
  7. For the Placements field, select all the areas you wish for the Engageli tool links to be made available for inserting.
    In our example, we're going to add "Link Selection" as a placement, as shown below:

    Some fields related to the Link Selection placement will appear. They are all optional; below is our recommendation for certain fields:
      • Selection Height - We recommend setting this to 750.
      • Selection Width - We recommend setting this to 600.
  8. When done with placements, click the "Save" button at the bottom of the page.
  9. Back on the Developer Keys page, where all your keys are listed, look for the key you've just created and ensure it is enabled, by toggling the switch under the "State" column.

  10. Locate the Client ID value for your new tool by looking under the "Details" column, as shown below. You'll need to provide this value to the Engageli team.

You are now done with the setup. You will need to fill out the form below and send it to your Engageli representative, so that they can complete their end of the setup. We've pre-populated the form with helpful placeholder values.

  • Client ID - (can be obtained from the Developer Keys page you visited earlier)
  • URL/Issuer - https://canvas.instructure.com (leave this as-is, no change needed)
  • Authentication Endpoint - https://PARTNER.instructure.com/api/lti/authorize_redirect (replace PARTNER with your Canvas subdomain).
  • Access Token Endpoint - https://PARTNER.instructure.com/login/oauth2/token (replace PARTNER with your Canvas subdomain)
  • Authentication Configuration - JWK_SET hosted at https://PARTNER.instructure.com/api/lti/security/jwks (replace PARTNER with your Canvas subdomain)

Making Developer Key/External Tool Available Globally

If you decide that you'd like to make the Engageli tool available to all courses, please continue with the below steps.

  1. Navigate to Admin > Settings > App, then click the "View App Configurations" button, as shown below.

  2. You should see a new "+ App" button. Go ahead and click that. Screenshot below for reference:

  3. In the pop-up window, set the "Configuration Type" dropdown to "By Client ID", then type or paste in the Client ID value for your tool in the "Client ID" field, as shown below. Once you are ready click the "Submit" button to apply the configuration.

 

Any questions? Please contact Support or your existing Engageli contact.

 

 

 Need more help? Contact Support.

Related articles