Overview
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:
- Create an Initial EchoVideo LTI 1.3 Configuration
- Create the Canvas LTI 1.3 Configuration
- Update the EchoVideo LTI 1.3 Configuration
- Create a Deployment in Canvas
- Register a Deployment to the EchoVideo LTI 1.3 Configuration
In order 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).
- Log into your EchoVideo Admin account.
- Click the Settings icon.
- Select Institution Settings.
- Click the Integration icon.
- Select LMS/VLE and then LTI 1.3.
- Click Add Configuration, provide a name for the configuration, and click Save.
The initial EchoVideo LTI 1.3 Configuration is now complete. The generated details from this step will be used for the configuration of Canvas in Part 2.
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, plus have access to the EchoVideo configuration variables from Part 1 above.
- In your Canvas LMS, Click on Admin and then choose Developer Keys.
- Click on the + Developer Key button and select the + LTI Key option.
- 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: Select the following checkboxes:
- 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_user_id=$User.id
lms_course_id=$CourseOffering.sourcedId
- 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 the following appended:
/analytics
-
Text: Enter
EchoVideo Course Analytics
-
Target Link URI: Enter the Target Link URL, from the EchoVideo LTI 1.3 configuration, with the following appended:
- 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://echo360qa.dev/assets/images/0a11772a218c58bd62b8c46ab5bf90dc-favicon.png
Selection Height: 800
Selection Width: 800
- Click the Save button.
The Developer Keys page is shown and the recent entry is displayed.
- Make sure you toggle the state of the key you just created to ON as shown below.
- Copy the Client ID (listed above the Show Key button) as it 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.
- Click the arrow to expand EchoVideo Details as shown below.
- Update the EchoVideo LTI 1.3 Configuration with the details that were 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
-
Issuer: Enter
- Click the Save button to complete the EchoVideo LTI 1.3 Configuration update.
Part 4: Create a Deployment in Canvas
This part (which occurs within the Canvas LMS) creates the LTI 1.3 deployment now that configuration is complete.
- In the Canvas LMS, Go to Admin -> Settings -> Apps page.
- Click on the View App Configurations button and then click the + App button.
- On the page shown above, enter the following information:
- Configuration Type: Select the By Client ID option
- Client ID: Enter the Client ID that was generated previously as part of Part 2 in Canvas
- Click the Submit button. An Add App window appears as shown below.
- Click Install.
- A resulting row entry is displayed on the page. Click its corresponding gear icon and select Deployment ID.
- Record the Deployment ID for the next (and final) part of this documentation.
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) plus have access to the Canvas Deployment ID from Part 4 above.
- For the relevant LTI 1.3 configuration, click on Deployment and then click the Add Configuration button.
- Add the deployment registration details.
- Deployment Name: Enter a deployment name.
-
Deployment ID: Add the Canvas Deployment ID saved from Part 4 above.
- Click Save to complete the EchoVideo LTI 1.3 Configuration's Deployment registration.
The LTI 1.3 configuration for Canvas and EchoVideo is now complete and ready for use.