Chat with us, powered by LiveChat Skip to main content
Echo360 Status: 

EchoVideo: Creating an LTI 1.3 Configuration with Canvas

Echo360
  • Updated

The following information details how an Administrator can set up a new LTI 1.3 configuration to be used for Deep Linking capabilities between the Canvas LMS and EchoVideo:

  1. Create an Initial EchoVideo LTI 1.3 Configuration
  2. Create the Canvas LTI 1.3 Configuration
  3. Update the EchoVideo LTI 1.3 Configuration
  4. Create a Deployment in Canvas
  5. Register a Deployment to the EchoVideo LTI 1.3 Configuration

To complete these steps, you must have an Administrator role within both EchoVideo and the Canvas LMS environments.

Process

Part 1: Create an Initial EchoVideo LTI 1.3 Configuration

This part creates the initial EchoVideo LTI 1.3 configuration. The resulting information in EchoVideo will be used in Canvas (Part 2).

  1. Log into EchoVideo as an administrator.
  2. Click the Settings icon in the upper-right corner of the screen.
  3. From the Settings menu, select Institution Settings.

    General settings appear and Basic Info is selected by default.

  4. Click Integration.
  5. Select LMS / VLE and then LTI 1.3.
    Steps to navigate to LTI 1.3 configuration identified
  6. Click Add Configuration, provide a name for the configuration, and click Save.
    LTI 1.3 configuration named

    The initial EchoVideo LTI 1.3 Configuration is now complete. The generated details from this step will be used to configure Canvas in Part 2.

    EchoVideo Details with Target Link URL, Public Keyset URL, OIDC Initiation URL, and Redirect URI populated

Part 2: Create the Canvas LTI 1.3 Configuration

This part will create the Canvas LTI 1.3 configuration and specify the placements. You will need to be within the Canvas LMS with Administrator privileges and access to the EchoVideo configuration variables from Part 1 above.

  1. In your Canvas LMS, Click on Admin and then choose Developer Keys.
  2. Click + Developer Key and select the + LTI Key option.
  3. Enter the LTI 1.3 configuration details as follows:
    • Key Name: Enter a name.
    • Redirect URIs: Paste the Redirect URL from the EchoVideo LTI 1.3 Configuration.
    • Method: Select the Manual Entry option.
    • Title: Enter a title.
    • Description: Enter a description.
    • Target Link URI: Paste the Target Link URL from the EchoVideo LTI 1.3 Configuration.
    • OpenID Connect Initiation Url: Paste the OIDC Initiation URL from the EchoVideo LTI 1.3 Configuration.
    • JWK Method: Select the Public JWK URL option.
    • Public JWK URL: Paste the Public Keyset URL from the EchoVideo LTI 1.3 Configuration.
    • LTI Advantage Services: Enable the following:
      • 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 in which the tool is installed.
      • Can update public jwk for LTI services.
      • Can look up Account information.
    • Additional Settings:
      • Domain: Paste the base domain of the Target Link URL from the EchoVideo LTI 1.3 Configuration.
      • Privacy Level: Select the PUBLIC toggle.
      • Custom Fields: Paste the following text into the Custom Fields text area:
        lms_course_id=$Canvas.course.id
    • Placements:
      • Add Course Navigation, Link Selection, and Editor Button.
    • Course Navigation:
      • Target Link URI: Enter the Target Link URL, from the EchoVideo LTI 1.3 configuration, with /analytics appended.
      • Text: Enter 
        EchoVideo Course Analytics
    • Link Selection:
      • Target Link URI: Enter the Target Link URL from the EchoVideo LTI 1.3 configuration.
      • Text: Enter 
        EchoVideo Deep Link
      • Message Type: Select the LtiDeepLinkingRequest option.
    • Editor Button:
      • Target Link URI: Enter the Target Link URL from the EchoVideo LTI 1.3 configuration.
      • Text: Enter EchoVideo Deep Link Embeds
      • Message Type: Select the LtiDeepLinkingRequest option.
      • Icon URL: Enter 
        https://echo360.org/assets/images/0a11772a218c58bd62b8c46ab5bf90dc-favicon.png
        Selection Height: 800
        Selection Width: 800
    Create Canvas LTI 1.3 Configuration information as described
  4. Click Save.

    The Developer Keys page is shown, and the recent entry is displayed.

  5. Make sure you toggle the state of the key you just created to ON, as shown below.
    Saved LTI Key shown in Canvas turned ON as described
  6. Copy the Client ID (listed above Show Key), which will be used in the next part in EchoVideo.

Part 3: Update the EchoVideo LTI 1.3 Configuration

This set of instructions requires you to be in EchoVideo on the LTI 1.3 Configurations page (check Part 1 for information on how to get there if required), plus have access to the Canvas Client ID variable from Part 2 above.

  1. Click the arrow to expand LMS Details, as shown below.
    EchoVideo LMS Configuration Details Expanded as described
  2. Update the EchoVideo LTI 1.3 Configuration with the details generated in the Canvas LMS for Part 2 above.
    • Issuer: Enter 
      https://canvas.instructure.com
    • Client Id: Paste the Client ID from the Canvas LTI 1.3 Configuration.
    • Public Keyset URL: Enter 
      https://sso.canvaslms.com/api/lti/security/jwks
    • Access Token URL: Enter 
      https://sso.canvaslms.com/login/oauth2/token
    • Authentication Request URL: Enter 
      https://sso.canvaslms.com/api/lti/authorize_redirect
  3. Click Save to complete the EchoVideo LTI 1.3 Configuration update.

If you deploy this tool to your Canvas test instance, update the LMS Details in EchoVideo with the test URLs for the Issuer, Public Keyset URL, Access Token URL, and Authentication Request URL.

Part 4: Create a Deployment in Canvas

This part (within the Canvas LMS) creates the LTI 1.3 deployment now that configuration is complete.

  1. In Canvas, navigate to Admin > Settings > Apps.
  2. Click View App Configurations and then + App.
    Add App modal in Canvas that appears once step 2 is performed
  3. On the page shown above, enter the following information:
    • Configuration Type: Select the By Client ID option.
    • Client ID: Enter the Client ID generated previously as part of Part 2 in Canvas.
  4. Click Submit. An Add App window appears as shown below. Add App Client ID displayed as described
  5. Click Install.
  6. A resulting row entry is displayed on the page. Click its corresponding gear icon and select Deployment ID.
    Canvas Deployment ID displayed as described
  7. Record the Deployment ID for this documentation's next (and final) part.

Part 5: Register a Deployment to the EchoVideo LTI 1.3 Configuration

This set of instructions requires you to be in EchoVideo on the LTI 1.3 Configurations page (check Part 1 for information on how to get there if required) and have access to the Canvas Deployment ID from Part 4 above.

  1. For the relevant LTI 1.3 configuration, click on Deployment and then click Add Configuration.
    Add Configuration for relevant LTI 1.3 steps as described
  2. Add the deployment registration details.
    • Deployment Name: Enter a deployment name.
    • Deployment ID: Add the Canvas Deployment ID saved from Part 4 above.
      Add LTI 1.3 Configuration Deployment for Canvas as described
  3. Click Save to complete the EchoVideo LTI 1.3 Configuration's Deployment registration.
    Canvas LTI 1.3 Configuration Deployment Registration complete as described

The LTI 1.3 configuration for Canvas and EchoVideo is now complete and ready for use.

Related to