Skip to main content

LTI 1.3 Tool Configuration for D2L/Brightspace

Anna G.
Updated

The following is intended for D2L/Brightspace LMS administrators. Use the configuration guide on this page to create the RedShelf LTI 1.3 Tool in the D2L environment for your independent campus. This guide is also available to download in pdf format at the bottom of this page. 

NOTE: If your institution uses Pearson Partner Integration in any courses, please continue to use your existing LTI 1.0/1.1 Tool link for these courses only.

  • If you are unsure if your institution uses Partner Integration, contact your RedShelf support team.
  • If you currently have the RedShelf LTI 1.3 tool installed in D2L, but you'd like to begin using Pearson Partner Integration, you will need to install the 1.0/1.1 version of RedShelf's LTI tool. RedShelf's 1.3 LTI tool does not support Pearson Partner Integration at this time. Instructions for installing LTI 1.0/1.1 can be found farther down on this page under RedShelf LTI 1.0/1.1 Tool Configuration for D2L.

 

Step 1. Select the gear icon in the top right of your D2L environment, then select Manage Extensibility.

 

 

Step 2. Select LTI Advantage, then select Register Tool and enter the following information:

Step 3. Select Register. A RedShelf LTI 1.3 Tool is now created in your D2L environment.

Step 4. Record the client id. You will provide the client id to RedShelf to complete enablement of your RedShelf LTI 1.3 Tool.


Step 5. Select View Deployments.

 

 

 

Step 6. Select New Deployment, then enter the following information:

  • Enabled: [Enable this setting]
  • Tool: RedShelf Digital Learning Materials
  • Name: RedShelf Digital Learning Materials
  • Description: RedShelf LTI 1.3 Tool
  • Extensions: [Check these boxes]
    • Assignment and Grade Services
    • Deep Linking
    • Names and Role Provisioning Services
  • Security Settings: [Check all boxes except “Anonymous”]
    • Org Unit Information
    • User Information
    • Link Information
    • Classlist including users not known to this deployment
    • Open as External Resource
  • Make tool available to: [Add all applicable org units]

Step 7. Select Create Deployment. A RedShelf LTI 1.3 Tool Deployment is now created in your D2L environment.

 

Step 8. Record the deployment id. You will provide the deployment id to RedShelf to complete enablement of your RedShelf LTI 1.3 Tool Deployment. Select View Links.

 

Step 9. Select New Link, then enter the following information:

  • Enabled: [Enable this setting]
  • Name: RedShelf Deep Link
  • URL: https://redshelf.com/lti1p3/dl
  • Description: RedShelf LTI 1.3 Deep Link Tool
  • Type: Deep Linking Quicklink
  • Width: 1300
  • Height: 812

Step 10. Select Save and Close. A RedShelf LTI 1.3 Deep Link Tool Link is now created in your D2L environment.

 

Step 11. Select New Link, then enter the following information:

Step 12. Select Save and Close. A RedShelf LTI 1.3 Tool Link is now created in your D2L environment.





Step 13. Navigate to a module in one of your courses into which you want to place a RedShelf LTI 1.3 Tool Link. Select Existing Activities, then select External Learning Tools.

 

Step 14. Select the RedShelf Digital Learning Materials Tool Link from the list of tools. This places a link to RedShelf into a course module in your LMS course.


Step 15. Provide the client id and deployment id to your RedShelf account representative. They will enable your RedShelf LTI 1.3 Tool Link.

NOTE: If you are enabling any of the additional RedShelf integrations (Automated Roster Transfer, Automated Course Data Transfer, or Automated Tool Placement), please wait to provide your client id and deployment id until after you enable those integrations, as there is additional information required by RedShelf.

 

Once your RedShelf account representative confirms that LTI 1.3 is enabled…

Step 16. Click the RedShelf Digital Learning Materials link to ensure your LTI 1.3 Tool has been configured correctly.

NOTE: You may see the red message in the screenshot below. This is expected behavior, and does not mean your LTI Tool is misconfigured.

 

 

 

 

RedShelf LTI 1.0/1.1 Tool Configuration for D2L

The following guide is intended for D2L LMS administrators. The 1.0/1.1 version of RedShelf's LTI tool should only be used to support Pearson Partner Integration courses. We recommend all other courses use LTI 1.3.

If installing the RedShelf LTI 1.0/1.1 Tool, your RedShelf representative will share the following information with you: 

  • Consumer Key
  • Shared Secret
  • Launch URL

The Consumer Key and Shared Secret are used as a means of authorizing the  connection to the LMS and RedShelf. The Launch URL is added to the LMS and specifies the location where a user will  go in RedShelf when clicking on the LTI tool in the LMS. 

 

How to Create the RedShelf LTI Tool Provider (LMS Admin)

Once the Key, Secret, and Launch URL have been obtained from your RedShelf representative, the LTI tool can be built. The tool needs to be built in two parts. First, RedShelf needs to be added as an External Tool Provider. Next, the LTI Tool Link can be built.

 

Step 1. Navigate to your External Learning Tools.

Step 2. Select Manage Tool Providers.

Step 3. Select New Tool Provider.

Step 4. Configure the following parameters for the Tool Provider Settings:

  • Launch Point: https://whitelabel.redshelf.com/lti/basic_launch/
    • Replace whitelabel.redshelf.com with the Launch URL provided to you by RedShelf.
  • Secret: [Provided to you by RedShelf]
  • Tool Consumer Information: Check the box for "Use Custom Tool Consumer Information instead of Default"
  • Key: [Provided to you by RedShelf]
  • Name: This is the name of the tool. You may name this anything you wish, but we suggest RedShelf Course Materials.
  • Description: This is the tool description. You may enter anything here or leave it blank.
  • Contact Email: You can leave this blank.
  • Visibility: Check the box for "Allow users to use this tool provider"
  • Security Settings: Please check all of the security settings. This ensures that RedShelf knows which user is coming from which course.
  • Make Tool Provider Available To: Make this tool available to all applicable org units.

When you are finished, be sure to select Save and Close 

 

 

How to Create the RedShelf LTI Tool Link (LMS Admin)

Now that the tool provider has been created, the next step is to create the tool configuration.

Step 1. From the External Learning Tools menu, select Manage External Learning Tool Links.

Step 2. Select New Link.

Step 3. On the New Link page, fill out the following information:

  • Title: This is the name of the tool. You may name this anything you wish, but we suggest RedShelf Course Materials.
  • URL:  https://whitelabel.redshelf.com/lti/basic_launch/
  • Visibility: Check the box for "Allow users to use this tool provider"
  • Signature:
    • Select the checkbox for Sign Messages With Key/Secret.
    • Select the radio button for Tool Consumer Key/Secret.
  • Security Settings: Select the radio button for Use Tool Provider Security Settings.
  • Make Tool Provider Available To: Make this tool available to all applicable org units.

Select Save and Close when you're finished. This completes the LTI tool configuration. The tool is now ready to be adopted into courses by professors.

 

How to Place the LTI Tool within a Course (LMS Administrator or Professor)

Step 1. Sign in to Brightspace/D2L and select your course.

Step 2. Navigate to your course content.

Step 3. Create a Module or select the existing Module where the eBook should be tied, and select Add an Existing Activity.

Step 4. Select External Learning Tools.

 

Step 5. Select the Redshelf tool.

Note: If the RedShelf tool is not present, the faculty member should contact the Admin to ensure it is assigned to that course.

How to Test the RedShelf LTI Tool (Administrator) 

To test that the LTI tool is functioning properly, please do the following:

Step 1. Create a test student with a test email account.

The student must have an email address, as this is what RedShelf uses as the student's identifier. We also have the option to match student rosters based on the user's SIS ID. 

Step 2. Add the LTI Tool to a test course or a real course.

Step 3. Enroll the student into the course.

Step 4: Provide the course ID (org unit ID) to your RedShelf representative.

  • The Org Unit ID can be found in the URL on the Course Details page. Select a course and view the ID in the URL.
  • To retrieve org unit IDs for multiple courses in bulk...
    • If RedShelf's API integration is configured in D2L, you have the option of letting RedShelf retrieve org unit IDs from D2L without needing your help. If you are interested in this option, ask your RedShelf representative about facilitating automated course data transfer. 
    • You can run a report in D2L and provide it to RedShelf. To run the report, follow these steps:
      • Click on the Admin Tools menu
      • Choose Reporting
      • Choose New Report
      • Choose Org Units
      • Choose Table
      • Export the report as a .csv file and send it to your RedShelf representative.
  • RedShelf will "launch" a course on our end and pair it with the test course using the org unit ID.

 

Step 5. Once RedShelf notifies you that we are ready to test the LTI, log in as the student and click the LTI tool link you placed in the test course. You should be launched to RedShelf where you will see the digital course materials RedShelf placed in the course. 

 

Additional Notes

Making Sure the Tool Opens In a New Window (Optional) 

If you'd like the LTI tool to launch in a new window, you can configure this at the course level by doing the following:

Step 1. Select the course: 

Step 2: Scroll down the page to the Content Browser, click the down arrow, and Go to Course Builder:

Step 3. In the Course Materials section, find the RedShelf external LTI, click the down arrow, and select Edit Properties In-place.

Step 4. You will see a flag for Open as External Resource. Check this flag.

The setting  should save automatically, and now the RedShelf platform will open in a new tab or window,  allowing for a consistent single sign-on experience.

 

User Roles

RedShelf's LTI tool supports the following user roles:

  • Student
  • Learner
  • Professor     
  • Teaching Assistant (TA)

While you are in the admin role (even if impersonating a student or professor) you will get an error when launching the LTI tool, as RedShelf does not recognize the admin role.

Students and Learners are charged for the course materials if they do not opt out. Professors and TAs are not charged for materials.

As for the user experience, professors, TAs, and students have virtually the same experience when accessing RedShelf through D2L. The only difference is that students will see the option to opt out. 

 
 

Related articles