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 Brightspace LMS and EchoVideo:
- Create an Initial EchoVideo LTI 1.3 Configuration
- Create the Brightspace LTI 1.3 Configuration
- Update the EchoVideo LTI 1.3 Configuration
- Create One or More Deployments in Brightspace
- Register a Deployment to the EchoVideo LTI 1.3 Configuration
- Create placements (Links) in Brightspace
In order to complete these steps, you must have an Administrator role within both EchoVideo and the Brightspace 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 Brightspace (Part 2).
- Log into EchoVideo as an administrator.
- Click the Settings icon in the upper-right corner of the screen.
- From the Settings menu, select Institution Settings.
General settings appears and Basic Info is selected by default.
- Click Integration.
- Select LMS/VLE and then LTI 1.3.
- Click Add Deployment, enter 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 Brightspace in Part 2.
Part 2: Create the Brightspace LTI 1.3 Configuration
This part will create the Brightspace LTI 1.3 configuration. You need to be within Brightspace as an Admin, plus have access to the EchoVideo configuration variables from Part 1 above.
- In Brightspace, click the Settings icon in the upper-right corner.
- In the menu that opens, choose Manage Extensibility then select LTI Advantage.
- Click on the Register Tool button and select Standard registration.
Enter the LTI 1.3 configuration details as follows:
- Name: Enter a name.
- Description: Optionally, enter a description.
-
Domain: Enter the domain portion only of the Target Link URL from the EchoVideo LTI 1.3 Configuration. Do not include the
/lti
that is at the end of the URL. - Redirect URLs: Enter the Redirect URI from the EchoVideo LTI 1.3 Configuration.
- OpenID Connect Login URL: Paste the OIDC Initiation URL from the EchoVideo LTI 1.3 Configuration.
- Target Link URI: Paste the Target Link URL from the EchoVideo LTI 1.3 Configuration.
- Keyset URL: Paste the Public Keyset URL from the EchoVideo LTI 1.3 Configuration.
- Extensions: Select Deep Linking.
- Roles: Select Send Institution Role.
- Substitution Parameters: Leave this as is.
-
Custom Parameters: Paste the following text into the Custom parameters text area:
lms_user_id=$User.id
lms_course_id=$CourseOffering.sourcedId
- Click the Register button.
At the bottom of the screen, you should now see a Brightspace Registration Details section. The details included here will be needed to complete and update the EchoVideo LTI 1.3 configuration in Part 3 below.
- Client ID
- Brightspace Keyset URL
- Brightspace OAuth2 Access Token URL
- OpenID Connect Authentication Endpoint
- Brightspace OAuth2 Audience
- Issuer
- Click the Save and Close button.
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 Brightspace configuration variables from Part 2 above.
- Click the arrow to expand EchoVideo LMS Details as shown below.
- Update the EchoVideo LTI 1.3 Configuration with the details that were generated in the Brightspace LMS for Part 2 above.
- Issuer: Paste the Issuer from the Brightspace LTI 1.3 Configuration.
- Client Id: Paste the Client ID from the Brightspace LTI 1.3 Configuration.
- Public Keyset URL: Paste the Brightspace Keyset URL from the Brightspace LTI 1.3 Configuration.
- Access Token URL: Paste the Brightspace OAuth2 Access Token URL from the Brightspace LTI 1.3 Configuration.
- Authentication Request URL: Paste the OpenID Connect Authentication Endpoint from the Brightspace LTI 1.3 Configuration.
- Click the Save button to complete the EchoVideo LTI 1.3 Configuration update.
Part 4. Create one or more Deployments in Brightspace
This part (which occurs within the Brightspace LMS) creates the LTI 1.3 deployment now that configuration is complete.
- In Brightspace, click the Settings icon, choose Manage Extensibility then select LTI Advantage.
- Click on the Configuration item we created in Part 2 above.
- Under the Brightspace Registration Details click View Deployments.
- From the top of the page, click on the New Deployment button.
- Enter the following information:
- Tool: Select your recently created configuration.
- Name: Enter a name for this deployment.
- Description: Enter a description for this deployment.
- Extensions: Select the Deep Linking option.
-
Security Settings: Select the following checkboxes:
-
- Org Unit Information
- User Information
- Name
- First Name
- Middle Name
- Last Name
- User ID
- Username
- Org Defined ID
-
-
Make tool available to: Select the Org units this tool shall be available within.
The deployment screen shall be completed similar to below.
- Click Create Deployment.
- The Brightspace Deployment Detail will be shown. The Deployment ID is required for the next part to be completed in EchoVideo.
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 Brightspace 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.
- Name: Enter a deployment name.
-
ID: Add the Brightspace Deployment ID saved from Part 4 above.
- Click Save to complete the EchoVideo LTI 1.3 Configuration's Deployment registration.
Part 6. Create Placements in Brightspace
This is the final configuration part and occurs within the Brightspace LMS, in order to complete this part you must be on the Brightspace Deployment detail section from Part 4 above. In this part, you can create new links for the deployment that are used within your Brightspace courses. These links can be a Basic Launch type (used for access to EchoVideo course analytics), Deep Linking Insert Stuff type (which is used to embed EchoVideo media into Brightspace pages using the Insert stuff workflow) or Deep Linking Quicklink type (which is used to create a Deep Link using the Quicklink workflow).
- Click the All button, as shown in the figure below.
- Click the Deployment Name.
- Scroll to the bottom and click View Links.
- Click the New Link button.
- To create a Deep Linking embed placement tool for Insert Stuff feature, enter the following:
- Name: Choose a name appropriate for embed tool in your LMS.
- URL: Enter the Target Link URL from the EchoVideo LTI 1.3 configuration.
- Description: Enter a description.
- Type: Select Deep Linking Insert Stuff.
- Click the Save button, and click New Link again (if you have more placements to create).
- To create a Basic Launch tool to be used for Course Analytics, enter the following:
- Name: Choose a name appropriate for EchoVideo Course Analytics in your LMS.
- URL: Enter the Target Link URL, with /analytics appended, from the EchoVideo LTI 1.3 configuration.
- Description: Enter a description.
- Type: Select Basic Launch.
- Click the Save button, and click New Link again (if you have more placements to create).
- To create a Deep Linking placement tool for the Quicklink feature, enter the following:
- Name: Choose a name appropriate for Deep Linking via QuickLinks in your LMS.
- URL: Enter the Target Link URL from the EchoVideo LTI 1.3 configuration.
- Description: Enter a description.
- Type: Select Deep Linking Quicklink.
- Click the Save button.
If you have additional placements to create, click New Link.
- To create a Deep Linking embed placement tool for Insert Stuff feature, enter the following:
This completes the configuration of LTI 1.3 between Brightspace LMS and EchoVideo.