Setting up an LTI Advantage integration with Canvas (instructions for administrators)

 Permission

A Canvas Administrator at your district must complete the following actions before teachers can link their assignments and use grade passback in the applicable Imagine Learning programs.

 Note

This article applies to Dragonfly, StudySync, Traverse, and Twig Science. 

With the programs listed above, you can establish an LTI (Learning Tools Interoperability) integration with Canvas so teachers can link assignments* and enable grade passback between Canvas and the program. This eliminates the need for teachers to enter students' grades manually in Canvas—instead, they can grade assignments in the Imagine Learning program and then send the grades electronically to Canvas. Students will also be able to complete and submit their Imagine Learning coursework and then view their grades directly in Canvas**.

*The assignment linking feature is not yet available for Twig Science. Teachers using Twig Science will be redirected to the Product Portal to navigate to and then grade the assignment. The grade will then be reflected in Canvas.

**Dragonfly assignments that are only reviewed for completion but do not have a percentage grade will not be captured in the Canvas gradebook.

To set up and configure the LTI integration between Imagine Learning and Canvas:

  1. Sign in to Canvas.
  2. Click Admin in the left navigation bar, then choose your account.
    canvas-click admin_ select account.jpg
  3. Scroll down and select Developer Keys in the left navigation sidebar, then click the + Developer Key button. Choose + LTI Key from the drop-down button.
    developer Keys_add new key _Canvas.jpg
  4. Fill out the top of the form with the following information, including copying and pasting the URLs from the table below. 
    top of canvas form for admins.jpg

    (If the field is not specified in the table, it is up to you how you fill it out.)

    Field Name What to Enter
    Redirect URIs:

    Enter each of these on a separate line: 

    https://lti.launch.imaginelearning.com/api/launch https://lti.launch.imaginelearning.com/api/launch/sso https://lti.launch.imaginelearning.com/api/launch/ags - add this one if your integration should also support assignment linking and grade passback (rather than SSO-only)

    Method: Manual entry
    Title: Use the same or similar value as the Key Name
    Target Link URI https://lti.launch.imaginelearning.com/api/launch
    OpenID Connect Initiation URL https://lti.launch.imaginelearning.com/api/OidcLogin
    JWK Method: Public JWK URL
    Public JWK URL https://lti.launch.imaginelearning.com/api/jwks
  5. If your integration should include assignment linking and grade passback (rather than SSO-only): Click on the caret to open the LTI Advantage Services section, and enable the following services:

    • Can create and view assignment data in the gradebook associated with the tool.
    • Can create and update submission results for assignments associated with the tool.
    • Can view the content of a page the tool is launched from. 

    canvas_LTI Advantage Services.jpg

  6. Click the caret to open the Additional Settings section. 

    • In the Custom Fields box, copy and paste the following on 2 separate lines:
      username=$Canvas.user.loginId 
      studentView=$com.instructure.User.student_view
    • Change the Privacy Level to Public.

    canvas_additional settings section.jpg

  7. In the Placements section, use the caret to open the drop-down menu and add Course Navigation. Then open the Course Navigation section and fill in the following fields:

    • Target Link URI: https://lti.launch.imaginelearning.com/api/launch/sso
    • Text: Use the name you want to appear in your left-hand menu; for example, Imagine Learning Portal SSO

    placements and course navigation_canvas.jpg
     

  8. At the bottom of the page, click Save to finish adding the Developer Key.
    canvas save dev key.jpg
  9. You'll receive a confirmation at the top of the screen, and your new Developer Key appears in the list of keys. Copy the Client ID from the Details column. You'll need to paste it elsewhere later in this process.
    canvas-client ID.jpg
  10. Click View in Canvas Apps and then click Unlock app
    View in Canvas apps_unlock.jpg
  11. Click Unlock.
    unlock app_canvas.jpg
    You will receive a confirmation message at the top of your screen that you successfully unlocked the app.
  12. Go to Courses from the left navigation bar, create a new course if needed, and then click on the new or previously-existing course's settings (gear icon). 
    canvas_settings by course name.jpg
  13. Go to the Apps tab and then click View App Configurations.
    Apps_view app configurations_canvas.jpg
  14. Click the + App button.
    + App button_canvas.jpg
  15. In the window that opens, choose By Client ID in the Configuration Type drop-down menu.
    add app-by client ID_canvas.jpg
     
  16. Paste in the Client ID you previously copied and then click Submit.
    canvas add app by client ID click Submit.jpg
  17. Confirm the intended action by clicking Install.
    canvas-add app confirm install.jpg

    You'll see a message at the top of your screen that the app was added.

  18. Go to Modules from the left navigation bar, then click the + Module button to make the app visible within the course.
    module_add module _canvas.jpg
  19. Name your module and then click Add Module
    add module 2_canvas.jpg
    You'll receive a confirmation at the top of the page.
  20. Once you've created your module, click the + button on the far right side.
    click + button by module.jpg
  21. In the window that opens, select External Tool from the Add drop-down menu. 
    Then, select your app from the list and click Add Item
    add item to module_canvas.jpg
  22. Publish the course and add the students and educators to the course.

     Caution

    Publish the course, but do not publish the module. Publishing the module would make it available for students, who would then get an error message if they click on it.

  23. Provide the Client ID to your Imagine Learning onboarding agent so they can complete the setup in Imagine Learning's internal system.
  24. Once your Imagine Learning onboarding agent informs you that they've completed their part of the configuration, notify your teachers that they can begin linking assignments and grades.