Canvas LTI 1.3 Integration - Administrator Setup

  1. From the administrator account for your Student Learning & Licensure (SL&L) organization, click on Settings, click Configuration Settings, and then click LMS Integrations: A Configuration Settings page showing the LMS integrations tab with options for two LMS connections and a Canvas timeline integration, each marked inactive and displayed with an edit button.
  2. Click the Edit button (pencil icon) to the right of LMS 1 or LMS 2.
  3. From the LMS dropdown, select Canvas.
  4. In the LMS URL box, enter the URL for your institution's Canvas environment. Ex: canvas.livetext.com, canvas.jsu.edu, etc. The LMS Integration settings in SL&L with 'Canvas' selected as the LMS and a field for 'LMS URL'.
  5. Enter the following URLs into the corresponding fields:
    • Public keyset URL: https://Enter Your LMS URL Here/api/lti/security/jwks
    • Access token URL: https://Enter Your LMS URL Here/login/oauth2/token
    • Authentication request URL: https://Enter Your LMS URL Here/api/lti/authorize_redirect
  6. In a new tab or window, log into your Canvas administrator account and go to the Site Admin page. An Admin menu page showing links for Site Admin, Watermark, and All Accounts within the left navigation panel.
  7. Go to the Developer Keys menu.
  8. Click + Developer Key, then click + LTI Key. The Canvas Developer Keys page with '+ Developer Key' and '+ LTI Key' options highlighted.
  9. Choose Manual Entry as the Method, then enter the following information to configure the tool:

    • Enter a Key Name.
    • Enter a Title.
    • Enter a Description.
    • Enter the Target Link URI: https://sll.watermarkinsights.com/via/lti/v1p3/launch
    • Copy the Initiate login URL from SL&L and paste it into the OpenID Connect
      Initiation Url in Canvas.
    • Copy the Redirection URL and paste it into the Redirect URIs field in Canvas.
    • In Canvas, select the Public JWK URL for the JWK Method.
    • Copy the Public keyset URL from SL&L and paste it into the Public JWK URL field in Canvas.

    The Canvas Developer Key setup, showing various LTI configuration fields including JWK Method and Public JWK URL.

  10. Expand the LTI Advantage Services section and enable the following features:

    • 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.

    The Canvas LTI Advantage Services section with several toggles enabled, pertaining to gradebook, submission, and user data access.

  11. Expand the Additional Settings section, enter the following queries in the Custom Fields box:

    • user_id=$Canvas.user.id
    • user_login_id=$Canvas.user.loginId

      Note: For clients to be able to use the ability to authenticate users accessing SL&L from Canvas based on the SIS ID value in Canvas, they would need to include the following custom parameter in the LTI 1.3 administrative set up for SL&L in Canvas (please refer screen-shot):

    • sis_id=$Person.sourcedId

    The 'Custom Fields' section within Canvas Developer Key settings, with 'sis_id=$Person.sourcedId' entered.

    The mentioned custom parameter value can be added by the Canvas administrator from Developer Keys > Locate the set up for SL&L and click the edit icon > Expand the Additional Settings section > Custom Fields box.

  12. Under Privacy Level, select Public.
    The Canvas Developer Key settings showing 'Privacy Level' set to 'Public'.
  13. In the Placements section, deselect the default options (Account Navigation, Link Selection) and select Assignment Selection.
    The Placements input field with 'Assignment Selection' selected.
  14. Enable Deep Linking by following these steps:
    1. In the Placements section, you can set up an access point to SL&L’s Deep Linking workflow in 3 different ways, using three different options: The Canvas Developer Keys page with the Placements section expanded, showing options like Course Assignments Menu, Module Index Menu Modal, and Module Menu Modal.
    2. By selecting the Course Assignments Menu option: Selecting this option enables an access point to SL&L’s Deep Linking workflow from the ellipses displayed next to the assignment creation button in the Assignments area of your Canvas course.

      Note: The title of the access point would be what you provide for the Text field referred in point #4.4 below. The Canvas Assignments page, with the ellipses button highlighted next to the '+Assignment' button.

    3. By selecting the Module Index Menu Modal option: Selecting this option enables an access point to SL&L’s Deep Linking workflow from the ellipses displayed next to the module creation button in the Home area and Modules area of your Canvas course.

      Note: The title of the access point would be what you provide for the Text field referred in point #4.d below. The Canvas Modules page, showing the ellipses button next to the '+Module' button.The Canvas Home page, with the ellipses button next to the '+Module' button.

    4. By selecting the Module Menu Modal option: Selecting this option enables an access point to SL&L’s Deep Linking workflow from the ellipses displayed for each module listed in the Home area and Modules area of your Canvas course.

      Note: The title of the access point would be what you provide for the Text field referred in point #4.4 below.

      The Canvas Modules page, with the ellipses button next to an individual module highlighted.The Canvas Home page, showing the ellipses button next to an individual module.

      Note: The set up details for each of the three options listed above are similar and have been shared below.

    5. For each of the three options mentioned in point #3 and its sub-points, the following details will need to be provided: The Placement settings in Canvas, with fields for Target Link URL, Message Type, Icon URL, Text, Selection Height, and Selection Width.
      • Target Link URL: For this field, enter: https://sll.watermarkinsights.com/via/lti/v1p3/deeplink
      • Select Message Type: Select the option LtiDeepLinkingRequest for this field.
      • Icon URL: You can enter URL of your choice here.
      • Text: Enter the title that you would like for the Deep Linking access point. (Note: It would be good to provide a title that indicates that the option corresponds to Deep Linking or that indicates that this option enables bulk creation and linking of Canvas assignments with SL&L activities.)
      • Selection Height: These are the dimensions of the dialog in which the Deep Linking workflow gets rendered in Canvas. The ideal value that ensures that the dialog displays correctly on different screen-sizes are: Height = 700
      • Selection Width: These are the dimensions of the dialog in which the Deep Linking workflow gets rendered in Canvas. The ideal value that ensures that the dialog displays correctly on different screen-sizes are: Width = 1540
    6. Click Save.
  15. Click Save to register the LTI 1.3 tool.
  16. Toggle the newly created LTI 1.3 Developer Key to On.
  17. Copy the Client ID under the Details column for the newly created LTI 1.3 Developer Key, and paste it into the Client ID field in SL&L.
  18. In Canvas, navigate to Admin > Site Admin > Settings > Apps. An External Apps page showing a list of available integrations in Canvas, with tabs to filter apps and buttons to manage the app list or view app configurations.
  19. Site Admin Settings Apps." width="auto" height="auto"
  20. Click View App Configurations.
  21. Click + App. The External Apps page with '+ App' and 'View App Center' buttons.
  22. Select By Client ID for the Configuration Type.
  23. Paste the Client ID from step 16 and click Submit. The Add App dialog with 'Configuration Type' set to 'By Client ID' and a field to paste the Client ID, and Save and Cancel buttons.
  24. Click Install. The newly added app will now appear in the list of Apps.
  25. Click the gear icon to the right of your app, and click Deployment ID. The External Apps list page showing the settings gear menu next to an app, revealing a dropdown menu with 'Deployment ID', highlighted.
  26. Copy the Deployment ID and paste it into the Deployment ID field in SL&L.
  27. Enter the following URL in the Issuer field in SL&L: https://canvas.instructure.com

    *If you are configuring this integration in the Canvas testing environment, enter: https://canvas.test.instructure.com

    *If you are configuring this integration in the Canvas beta environment, enter: https://canvas.beta.instructure.com

    *Please make sure there are no trailing spaces or other characters (such as a "/") at the end of the URL

  28. Click SAVE in SL&L.

Using Deep Linking to Bulk Create and Link Canvas Assignments to SL&L Activities

Once you have enabled Deep Linking for your LTI 1.3 integration between Canvas and SL&L, your Canvas Course Admins and Canvas Course Instructors can begin to use it to bulk create and link Canvas assignments based on SL&L activities.

  1. Based on the Deep Linking option that has been enabled by your Canvas Admin (you can reach out to your Canvas Administrator to know about the enabled option and its title), the Canvas Course Admins and Canvas Course Instructors can access the Deep Linking workflow from their Canvas Course as follows:
    1. From the ellipses displayed next to the +Module button in the Home area and Modules area. The Canvas Modules page, showing the ellipses button next to the '+Module' button.The Canvas Home page, with the ellipses button next to the '+Module' button. Note: The title of the Deep Linking option would be set by your Canvas Administrator.
    2. From the ellipses displayed for each module listed in the Home area and Modules area.

      The Canvas Modules page, with the ellipses button next to an individual module highlighted.The Canvas Home page, showing the ellipses button next to an individual module.

      Note: The title of the Deep Linking option would be set by your Canvas Administrator.

    3. From the ellipses displayed next to the +Assignment button in the Assignments area.

      The Canvas Assignments page, with the ellipses button highlighted next to the '+Assignment' button.

      Note: The title of the Deep Linking option would be set by your Canvas Administrator.

  2. Once you access the Deep Linking workflow option, a pop up will be displayed where in you will be able to view a paginated list of activities (20 activities per page) from the course sections that you have access to in SL&L.

    The Deep Linking workflow pop-up in Canvas, showing a paginated list of SL&L activities with columns for Activity Title, Course Code, and Section Name.

    1. If you are an administrator in SL&L, you will see a list of activities from open course sections that belong to the hierarchy nodes to which you have access.
    2. If you are an instructor in SL&L, you will see a list of activities from the open course sections for which you are the instructor.
    3. The list only includes activities that have been published, but are not linked to any LMS assignment.
  3. You can filter the list of activities in the following ways:
    1. By searching based on Activity Title, Course Code, and Section Name.
    2. Using the View drop-down: This drop-down enables you to filter the list of activities based on three options. The 'View' drop-down menu in the Deep Linking workflow, showing three options: 'Activities from all sections', 'Activities from matched sections', and 'Selected Activities'.
      1. Activities from all sections: Selecting this option displays a list of published, but unlinked activities from all open course sections that you have access to in SL&L.

        The Deep Linking workflow showing a list of activities from all sections after applying the filter.

        Note: If you do not have access to any open course sections as an SL&L Administrator or an SL&L Course Instructor OR if no published activities have been created in the open course sections that you have access to as an SL&L Administrator or an SL&L Course Instructor OR if all activities from the open course that you have access to as an SL&L Administrator or an SL&L Course are already linked to an LMS assignment, an empty state message will be displayed. An empty state message in the Deep Linking workflow, indicating that no activities were found for 'Activities from all sections'.

      2. Activities from matched sections: Selecting this option displays a list of published, but unlinked activities from course sections that you have access to in SL&L, which match the Canvas Course (through which you have accessed the Deep Linking workflow page) based on Section ID or Section Name.

        The Deep Linking workflow showing a list of activities filtered to only include those from matched sections.

        Note: From among the open course sections to which you have access as an SL&L Administrator or an SL&L Course Instructor, if there are no course sections that match the Canvas course (through which you have accessed the Deep Linking workflow page) based on Section ID or Section Name OR if no published activities have been created in the course sections that match the Canvas course (through which you have accessed the Deep Linking workflow page) based on Section ID or Section Name OR if all published activities from the course sections that match the Canvas course (through which you have accessed the Deep Linking workflow page) based on Section ID or Section Name are already linked to an LMS assignment, an empty state message will be displayed if you select the Activities from matched sections option.

        An empty state message in the Deep Linking workflow, indicating that no activities were found for 'Activities from matched sections'.

      3. Selected Activities: Selecting this option displays a list of activities that you have selected after accessing the Deep Linking workflow page.

        The Deep Linking workflow showing a list of activities that the user has selected.

        Note: If you have not made any selections on the Deep Linking workflow page, an empty state message will be displayed if you select the Selected Activities option.

        An empty state message in the Deep Linking workflow, indicating that no activities have been selected yet.

        When you access the Deep Linking workflow page, if there is an SL&L Course Section or Course Sections that match the Canvas Course (through which you have accessed the Deep Linking workflow page) based on Section ID or Section Name, the list will display activities from the matched Course Section or Course Sections by default i.e. the View drop-down on the page will default to the option Activities from matched sections.

      4. Search and select the activities that you would like to create and link as Canvas Assignments.
      5. Click the Add Activities button.

Note: The selected SL&L activities will be created as assignments in the Canvas Course and the created Canvas assignments would also be linked to the corresponding SL&L activities.

Additional Information of Note

  1. The assignments that get created in Canvas would not be published by default i.e. the assignments would not be straight away visible to students from the Canvas Course.
  2. The created assignments can be bulk published either using the Publish all modules and items option available in the Home and Modules areas of the Canvas course OR using the Publish all modules and items option available for each module in the Home and Modules areas of the Canvas course.

    The Canvas Modules page, with the 'Publish all modules and items' button highlighted.

    The Canvas Home page, showing the 'Publish all modules and items' button for an individual module.

    Note: The ability to bulk publish would only be available for Canvas Assignments created using the Deep Linking workflow access point from the ellipses displayed next to the +Module button in the Home area and Modules area OR the Deep Linking workflow access point from the ellipses displayed for each module listed in the Home area and Modules area.

  3. There is presently no way in Canvas to bulk publish the assignments created using the Deep Linking workflow access point from the ellipses displayed next to the +Assignment button in the Assignments area of the Canvas course. The assignments created from the Assignments area would need to be published one by one.
  4. An SL&L activity that is linked to a Canvas assignment using Deep Linking would display the value Connected for the LMS Connection: field ONLY AFTER the SL&L activity is accessed through the linked Canvas assignment at least once.
  5. To completely unlink an SL&L activity from its linked Canvas assignment:
    • First use the Disconnect LMS Link option for the SL&L activity.

    • Then, delete the Canvas assignment that was linked to the SL&L activity.

Was this article helpful?
9 out of 10 found this helpful

Articles in this section

How to Contact Support
There are many ways to reach out! Click the icon above for our support options.
Watermark Academy
Click the icon above to access the Watermark Academy for consultation, training, and implementation companion courses.
Customer Community
Can’t find the answer? Ask fellow users how they’re making the most of Watermark in our Community!