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

EchoVideo: Creating an LTI 1.3 Integration with Blackboard

Amanda Leibovich
  • Updated

The following information details how an Admin, within both EchoVideo and Blackboard access, can set up a new LTI 1.3 integration for Deep Linking capabilities between Blackboard and EchoVideo.

  1. Create an Application in the Blackboard Developer Site
  2. Create an Initial EchoVideo LTI 1.3 Configuration
  3. Create the Blackboard LTI 1.3 Configuration
  4. Manage Placements for the Blackboard Application
  5. Register the LTI 1.3 Tool in Blackboard and Create a Deployment
  6. 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 Blackboard LMS environments.

The Process

Part 1: Create an Application in the Blackboard Developer Site

The first part involves creating your Blackboard Developer account and Application in the Anthology portal.

  1. Go to https://developer.anthology.com/ and create an account.
  2. After completing the account registration, create a Group. You can give the group any name you want.
    Create a new group screen in the Blackboard Developer site
  3. Once your Group has been created, you must create a new Application for this integration.
    1. Click on My Applications.
    2. On the My Applications page, click on Register a REST or LTI application.
      My Applications page and Register a REST or LTI application button identified as described
    3. If you already have existing Applications, click the plus icon in the table header on the Register a New Application page to start the process.
    4. If you do not have an existing Application, on the new application page fill out the Application Name and Description fields.
    5. Your application requires two domains dependent on your region. There are four regions with two domains each.
      • United States 
        echo360integrate.org
        api.echo360integrate.org
      • Canada 
        echo360integrate.ca
        api.echo360integrate.ca
      • Europe / Middle East / Africa 
        echo360integrate.org.uk
        api.echo360integrate.org.uk
      • Asia / Pacific 
        echo360integrate.net.au
        api.echo360integrate.net.au
    6. Lastly, enable My Integration supports LTI 1.3 to enable the feature in the application.
      Register a new application screen with My Integration supports LTI 1.3 toggle enabled identified as described

Keep this page open as we must populate it with data from the EchoVideo side next.

Part 2: 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 populated in the Blackboard Developer Application (Part 3).

  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
  7. In the newly created LTI 1.3 configuration, ensure that the Use Alternate Domain Name option is toggled on. It is off by default.
    Configuration details in EchoVideo with Use Alternate Domain Name toggle enabled and identified as described

     

The generated details from this step will be used to configure Blackboard in Part 3.

Part 3: Create the Blackboard LTI 1.3 Configuration

This part creates the Blackboard LTI 1.3 configuration and specifies the placements. You will need to be logged into the Blackboard Developer site and enter data from the Echo side (from Part 2 above)

  1. Log into Blackboard Developer OR navigate to the browser tab from Part 1 above.
  2. Log into EchoVideo as an Admin OR navigate to the browser tab from Part 2 above.
  3. From the LTI 1.3 Configuration in EchoVideo, copy the OIDC Initiation URL and paste it into the Login Initiation URL in Blackboard Developer > Register a New Application page.
  4. From the LTI 1.3 Configuration in EchoVideo, copy the Redirect URI and paste it into the Tool Redirect URL(s) field in Blackboard Developer > Register a New Application page.
  5. From the LTI 1.3 Configuration in EchoVideo, copy the Public Keyset URL and paste it into the Tool JWKS URL in Blackboard Developer > Register a New Application page.
    Configuration details in EchoVideo with OIDC Initiation URL, Public Keyset URL, and Redirect URI identified as described
  6. Click Register Application.
    Register Application button identified as described
  7. After registering the application, you will be taken to the Key page.

    The Secret shown on this page is only shown once. If you close this page without copying the secret to a safe and secure location, it cannot be recovered.

    LTI 1.3 Key information in Blackboard as described
  8. Enter the LTI 1.3 configuration details from the page above into your EchoVideo LTI 1.3 Configuration LMS Details as follows,
    1. Copy and paste the Issuer into the EchoVideo LMS Details > Issuer field.
    2. Copy and paste the Public Keyset URL into the EchoVideo LMS Details > Public Keyset URL field.
    3. Copy and paste the Access token endpoint into the EchoVideo LMS Details > Access Token URL field.
    4. Copy and paste the OIDC auth request endpoint into the EchoVideo LMS Details > Authentication Request URL field.
    5. Copy and paste the Application ID into the EchoVideo LMS Details > Client ID field.
    6. Click Save.
      LMS details in EchoVideo with LMS details populated and identified as described

Now that we have Saved the configuration in EchoVideo, we need to Manage the Placements in the Blackboard Developer site for this new Application. (Part 4)

Part 4: Manage Placements for the Blackboard Application

Now, we must create the placements for our Application on the Blackboard Developer site.

  1. From the My Applications page, click on the three horizontal dots next to your Application in the list to reveal a menu and select Manage Placements.
    My Applications in Blackboard with Manage Placements from Group dropdown identified as described
  2. This will bring you to the Register a new placement page where we will create two placements for this integration.
  3. First, we will create an Analytics tool.
  4. Name the placement and add an (optional) description.
  5. For Type select Course tool.

    There are multiple types of placements in Blackboard. Different types will appear in different parts of the platform. Consult your support documentation for more information on placements.

  6. The Target link URI should be set to 
    https://api.echo360integrate.org/lti/analytics
  7. The Target link URI of your placement depends on the region you are in. There are four regions. 
    https://api.echo360integrate.org/lti/analytics
    https://api.echo360integrate.ca/lti/analytics
    https://api.echo360integrate.org.uk/lti/analytics
    https://api.echo360integrate.net.au/lti/analytics
  8. Optionally, populate the Icon URL.
    https://echo360.org/assets/images/0a11772a218c58bd62b8c46ab5bf90dc-favicon.png
  9. Click Register Placement.
    Register a new placement in Blackboard fields as described
  10. To create a Deep Linking Tool placement, click the plus sign at the top right of the Manage Placements page.
  11. Name the placement and add an (optional) description.
  12. For Type select Deep Linking content tool.
  13. The Target link URI of your placement depends on the region you are in. There are four regions: 
    https://api.echo360integrate.org/lti
    https://api.echo360integrate.ca/lti
    https://api.echo360integrate.org.uk/lti
    https://api.echo360integrate.net.au/lti
  14. Optionally, populate the Icon URL.
    https://echo360.org/assets/images/0a11772a218c58bd62b8c46ab5bf90dc-favicon.png
  15. Click Register Placement.
    Register placement button identified as described

Now we have two placements associated with the LTI 1.3 application.
LTI 1.3 Blackboard Manage Placements screen as described

Part 5: Register the LTI 1.3 Tool in Blackboard and Create a Deployment

In this part, you will need the application ID from the application you created in the Blackboard Developer site.

  1. From My Applications in the Blackboard Developer site, copy the Application ID for your app.
    My Application in Blackboard with Application ID identified as described
  2. Log in to Blackboard as an Admin.
  3. Go to the Administrator Tools page.
  4. Click LTI Tool Providers.
  5. On the LTI Tool Providers page, click Register LTI 1.3 / Advantage Tool.
  6. Paste the Application ID from your Blackboard Developer Application into the Client ID field in Blackboard and click Submit.
    Administrator Tools in Blackboard with Client ID and Submit button identified as described

    This will take you to a page to verify the settings and approve the tool status.

  7. For your Blackboard tool, enter the following:

    • Domains: Enter your domain names. They depend on the region you are in.
      • United States 
        echo360integrate.org
        api.echo360integrate.org
      • Canada 
        echo360integrate.ca
        api.echo360integrate.ca
      • Europe / Middle East / Africa 
        echo360integrate.org.uk
        api.echo360integrate.org.uk
      • Asia / Pacific 
        echo360integrate.net.au
        api.echo360integrate.net.au
    • Tool Status: Choose Approved.
    • Tool Provider Custom Parameters: Enter the following: 
      lms_course_id=@X@course.id@X@

      Blackboard Admin Tools screen with Tool Provider Custom Parameters set as described
  8. Copy the Deployment ID field to a safe place. You will need it to create the deployment in EchoVideo.
  9. Scroll down this page and ensure the Role in Course, Name, and Email Address are selected, and click Submit.
    Institution Policies in Blackboard with items selected as described

Part 6: 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 Blackboard Deployment ID from Part 5 above.

  1. For the relevant LTI 1.3 configuration, choose the Deployment tab and click Add Deployment.
    LTI 1.3 Deployment tab with Add Deployment button identified as described
  2. Add the deployment registration details.
    • Deployment Name - Enter a deployment name
    • Deployment ID - Add the Blackboard Deployment ID saved from Part 5 above.
  3. Click Save to complete the EchoVideo LTI 1.3 Configuration's Deployment registration.

If placements or the tool icon do not sync between the two systems, click Synchronize LTI 1.3 Tools in Blackboard, as shown in the figure below. Sync Button as described

 

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

Related to