The information, documentation, and step-by-step instructions for integrating RedShelf into your Moodle system!
LTI Tool Integration
Your RedShelf representative will send you a document detailing how to complete the LTI tool integration.
To start the process outlined in the document you get from your RedShelf representative, your representative will send you the following information:
- LAUNCH URL:
** make sure there are no spaces before and after each of these credentials **
Moodle Administrator Creates RedShelf LTI Tool
The easiest way to create and add the RedShelf LTI tool to a course is to first create the tool side-wide, 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. This document will cover how to create the tool site-wide. The steps for creating the tool at the course level however are similar, just the order of the steps is a little different.
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
Create the tool site wide:
- In the Site Administration, select "Plugins."
- Under "Activity Modules", and under "External Tools", select "Manage External Tools."
- On the Manage Tools page, select the button for "Configure a tool manually."
- 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/, where whitelabel is replaced by the name of your white label on RedShelf.
- Tool Description: This field contains the description of the tool. It can be left blank if you wish.
- Consumer Key: This field contains the consumer key, which should have been provided to you by your RedShelf account representative.
- Shared Secret: This field contains the consumer secret, which should have been provided to you by your RedShelf account representative.
- 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 the tool 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.
Add the RedShelf tool to a course:
- Select the desired course and select Turn Editing On in the upper right-hand corner.
- Click the "+Add an activity or resource link" in the topic you wish to adopt the tool.
- Select External Tool and click Add.
- Fill out the following fields:
- Activity Name: This is the name of the tool which the students will see on 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 on each individual course is consistent.
- At the bottom of the page, select "Save and return to course."
Test the LTI Tool
- Create a test student with a test email account. The student must have an email address. This is what RedShelf uses as the student's identifier.
- Add the LTI Tool to a test course or a real course.
- Enroll the student in the course.
- You’ll likely receive an error message at first, but RedShelf will add a book to this test email account to confirm the integration is working.
RedShelf's LTI tool supports the following roles:
- Teaching Assistant (TA)