The following is intended for Moodle LMS administrators. Use the configuration guide on this page to create the RedShelf LTI 1.3 Tool in the Moodle 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 those courses only. All courses not using Pearson Partner Integration should use the LTI 1.3 tool.
- If you are unsure if your institution uses Partner Integration, contact your RedShelf support team.
- If you already have the RedShelf LTI 1.3 tool installed in Moodle, 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 in Moodle does not support Pearson Partner Integration at this time. Instructions for installing LTI 1.0/1.1 can be found on this page under RedShelf LTI 1.0/1.1 Tool Configuration for Moodle.
Step 1. Select Site administration in the top left of your Moodle environment, then select Plugins along the top navigation bar, followed by Manage tools.
Step 2. Select configure a tool manually, then enter the following information:
- Tool name: RedShelf Deep Link
- Tool URL: https://redshelf.com/lti1p3/dl
- Tool description: RedShelf LTI 1.3 Deep Linking Tool
- LTI version: LTI 1.3
- Public key type: Keyset Url [your Moodle environment may not have this option]
- Public key: If your Moodle environment has the Keyset Url option, then:
https://redshelf.com/lti1p3/jwks - Public key: If your Moodle environment does not have the Keyset Url option, then copy the full text below:
- -----BEGIN PUBLIC KEY-----MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAnzyis1ZjfNB0bBgKFMSvv kTtwlvBsaJq7S5wA+kzeVOVpVWwkWdVha4s38XM/pa/yr47av7+z3VTmvDRyAHca T92whREFpLv9cj5lTeJSibyr/Mrm/YtjCZVWgaOYIhwrXwKLqPr/11inWsAkfIytvHWTx ZYEcXLgAXFuUuaS3uF9gEiNQwzGTU1v0FqkqTBr4B8nW3HCN47XUu0t8Y0e+lf4s4 OxQawWD79J9/5d3Ry0vbV3Am1FtGJiJvOwRsIfVChDpYStTcHTCMqtvWbV6L11BW kpzGXSW4Hv43qa+GSYOD2QU68Mb59oSk2OB+BtOLpJofmbGEGgvmwyCI9MwI DAQAB
-----END PUBLIC KEY-----
- -----BEGIN PUBLIC KEY-----MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAnzyis1ZjfNB0bBgKFMSvv kTtwlvBsaJq7S5wA+kzeVOVpVWwkWdVha4s38XM/pa/yr47av7+z3VTmvDRyAHca T92whREFpLv9cj5lTeJSibyr/Mrm/YtjCZVWgaOYIhwrXwKLqPr/11inWsAkfIytvHWTx ZYEcXLgAXFuUuaS3uF9gEiNQwzGTU1v0FqkqTBr4B8nW3HCN47XUu0t8Y0e+lf4s4 OxQawWD79J9/5d3Ry0vbV3Am1FtGJiJvOwRsIfVChDpYStTcHTCMqtvWbV6L11BW kpzGXSW4Hv43qa+GSYOD2QU68Mb59oSk2OB+BtOLpJofmbGEGgvmwyCI9MwI DAQAB
- Initiate login URL: https://redshelf.com/lti1p3/oidclogin
- Redirection URI(s):
- Custom parameters: [leave this field blank]
- Tool configuration usage: Show in activity chooser and as a preconfigured tool
- Default launch container: New window
- Content-Item Message: [check this box]
- Content Selection URL: https://redshelf.com/lti1p3/dl
- Services:
- IMS LTI Assignment and Grade Services: Use this service for grade sync and column management
- IMS LTI Names and Role Provisioning: Use this service to retrieve member’s information as per privacy settings
- Tool Settings: Use this service
- Privacy:
- Share launcher’s name with tool: Always
- Share launcher’s email with tool: Always
- Accept grades from the tool: As specified in Deep Linking definition or Delegate to teacher
- Force SSL: [check this box]
Step 3. Select Save changes. A RedShelf LTI 1.3 Tool is now created in your Moodle environment.
Step 4. Select the View configuration details icon on the RedShelf Deep Link Tool, then record the Client ID and Deployment ID fields.
You will provide the Client ID and Deployment ID to RedShelf to complete enablement of your RedShelf LTI 1.3 Tool.
Step 5. Provide the Client ID and Deployment ID to your RedShelf 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), 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 representative confirms that LTI 1.3 is enabled…
Step 6. Navigate to a course into which you want to place a RedShelf LTI 1.3 Tool link.
Step 7. Select the gear icon in the top right, then select Turn editing on.
Step 8. Select Add an activity or resource, followed by RedShelf Deep Link.
Step 9. Click Select Content.
Step 10. Select RedShelf “My Courses”, followed by Create Link. This brings you back to your Moodle window to finish configuration of your LTI 1.3 Tool.
NOTE: You may see the red message in the screenshot below. This is expected behavior and does not mean your LTI Tool is misconfigured. Please proceed with these steps.
Step 11. Select Save and return to course.
Step 12. Click the RedShelf Digital Materials link to ensure your LTI 1.3 Tool has been configured correctly.
NOTE: You may see an error like 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 Moodle
The following guide is intended for Moodle 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.
Prior to 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 (Moodle Admin)
The recommended way to create and add the RedShelf LTI tool to a course is to first create the tool side-wide, and then add it to the necessary courses. However, you can also create the tool at the course level first, and then add the course-level tool to other courses if you wish.
The steps below cover how to create the tool site-wide. The steps for creating the tool at the course level are similar, but the order of the steps differs slightly.
For more information about creating and adding external tools, see the following Moodle documentation:
- Adding a tool site wide:
https://docs.moodle.org/33/en/External_tool_settings#Adding_a_tool_site-wide - Adding a tool to a course: https://docs.moodle.org/33/en/External_tool_settings#Adding_a_new_external_tool_to_a_course
Step 1. Navigate to Site Administration and select Plugins.
Step 2. Under Activity Modules, and under External Tools, select Manage External Tools.
Step 3. On the Manage Tools page, select Configure a tool manually.
Step 4. On the External Tools Configuration page, fill out the following fields:
- Tool Name: This is the name of the tool, which instructors or other LMS admins will see when adding the tool to a course.
- Tool URL: The tool URL should be https://whitelabel.redshelf.com/lti/basic_launch/
- Replace whitelabel.redshelf.com with the Launch URL provided to you by RedShelf.
- Tool Description: This field contains the description of the tool. It can be left blank if you wish.
- Consumer Key: Enter the consumer key provided to you by RedShelf.
- Shared Secret: Enter the shared secret provided to you by RedShelf.
- Custom Parameters: Leave blank.
- Tool Configuration Usage: Select "Show as preconfigured tool when adding an external tool." This will allow the tool to be seen on any course admin page so that it can be added to a course.
- Default launch container: Set this to "New Window". Opening the tool in a new window ensures that SSO works across all platforms.
- Under Privacy:
- Share launcher's name with tool: Always
- Share launcher's email with tool: Always
At the bottom of the page, select "Save changes" to save the tool.
How to Add the RedShelf LTI Tool to a Course (Professor or Moodle Admin)
Step 1. Go to the desired course and select Turn Editing On in the upper right-hand corner.
Step 2. Click +Add an activity or resource link in the topic you wish to adopt the tool.
Step 3. Select External Tool and click Add.
Step 4. Fill out the following fields:
- Activity Name: This is the name of the tool which the students will see in the course.
- Preconfigured Tool: This is where you will select the RedShelf tool created in the previous step.
Once the tool has been selected, all of the other relevant fields will be filled out automatically and editing of them will be locked. This ensures that each implementation of the tool in each individual course is consistent.
Step 5. At the bottom of the page, select Save and return to course.
How to Test the LTI Tool (Moodle Admin)
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 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 in the course.
Step 4. Notify your RedShelf representative that you are ready to test the LTI tool and share the test course ID with them.
RedShelf will "launch" a course on our end with sample materials and pair it with the Moodle test course. To do this, they will need to know the Moodle course ID associated with the test course. Every Moodle course shell has a unique identifier called a Moodle Course Shell ID. This ID is usually a string of numbers at the end of the URL on the course's main page. This is the key identifier RedShelf needs for SSO.
Additional Notes
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.