Current LTI on edX: UX
Adding an LTI Tool to an edX Course
10.20. LTI Component — Building and Running an edX Course documentation
Enabling a Course to Use LTI Components
In edX Studio, locate your course, click on the Settings tab and select Advanced Settings from the dropdown.
In the Advanced Module List field, add “lti_consumer” between the brackets if it is not already there.
This allows LTI components to be used in the course.
Enabling an Added LTI in a edX Course (1.1 LTI Specific)
These steps do NOT need to occur for a 1.3 LTI integration.
edX Course Author experience: https://support.yellowdig.co/hc/en-us/articles/14092253325716-Open-edX-Course-Setup-Guide-FOR-INSTRUCTORS-
These screenshots are taken from the above help article for Yellowdig, however the process is the similar for other LTIs.
Obtain the LMS key and secret from your organization administrator.
Navigate to your edX Studio course.
Click on Settings then select Advanced Settings from the dropdown.
Locate the LTI Passports field.
Enter "yellowdig:[network key]:[network secret]" between the brackets.
Replace [network key] and [network secret] with the corresponding key and secret from step 1.
Include the quotation marks and the colons.
If you have multiple LTI Passports, separate them with commas.
At the bottom of your screen, click the Save button (in the black bar that pops up).
Creating a LTI Tool Graded Assignment Type
Note: These directions and some screenshots come from this support article for the Yellowdig implementation. However, the steps to create a new graded assignment type in edX are similar for other LTI tools. https://support.yellowdig.co/hc/en-us/articles/14092253325716-Open-edX-Course-Setup-Guide-FOR-INSTRUCTORS-
In your edX course, navigate to Settings and select Grading from the dropdown menu.
Scroll to the bottom of the page and click on + New Assignment Type.
Fill out the fields according to your course needs. Here’s an example from Yellowdig:
Click on Save Changes in the black bar at the bottom of your screen.
Creating an edX LTI Assignment
Creating a 1.1 LTI Assignment
Note: These directions and some screenshots come from this support article for the Yellowdig implementation. However, the steps to create a new graded assignment type in edX are similar for other LTI tools. https://support.yellowdig.co/hc/en-us/articles/14092253325716-Open-edX-Course-Setup-Guide-FOR-INSTRUCTORS-
edX Course Author Experience:
In your edX Studio course, navigate to your course outline (Select Content then choose Outline from the dropdown menu). You can also click on the course name in the upper left instead.
Click on + New Section.
Name your new section.
Click on + New Subsection and name the subsection accordingly.
Click on + New Unit.
Name your new unit.
Select Advanced.
Click on LTI Consumer.
Click on Edit.
Fill in the fields.
Here’s an example from Yellowdig’s documentation:
Fill in the fields as follows, keeping in mind that you must set LTI Launch Target to "New Window" and that you must enable "Request user's email" to achieve successful LTI launches.Display Name: Yellowdig
LTI Application Information: [insert custom description tailored to your students]
LTI ID: yellowdig
NOTE: For LTI version, you should indicate LTI 1.1/1.2.
LTI URL: https://api.yellowdig.app/launch
Custom Parameters: [leave blank]
LTI Launch Target: New Window. [To accommodate iOS and Safari 13+ users, for whom opening Yellowdig in an iFrame may be impossible, we strongly recommend "New Window".]
Button Text: Yellowdig
Scored: True [if using grade passback]
Weight: [to reduce rounding errors, we recommend allocating at least 100 points to Yellowdig]
Hide External Tool: False
Accept Grades Past Deadline: [choose in accordance with your preferences]
Request User's Username: [choose in accordance with your preferences]
Request User's Email: True
Request User's Full Name: True
Note: For Request User’s Username, Email, and Full Name - these fields may not be available depending on your edX setup. In our instance, we set Send extra parameters as “true” in order to make sure the LTI works.
Click on Save.
Creating a 1.3 LTI Assignment
Note: These directions and some screenshots come from this support article for the Yellowdig implementation. However, the steps to create a new graded assignment type in edX are similar for other LTI tools. https://support.yellowdig.co/hc/en-us/articles/14092253325716-Open-edX-Course-Setup-Guide-FOR-INSTRUCTORS-
edX Course Author Experience:
In your edX Studio course, navigate to your course outline (Select Content then choose Outline from the dropdown menu). You can also click on the course name in the upper left instead.
Click on + New Section.
Name your new section.
Click on + New Subsection and name the subsection accordingly.
Click on + New Unit.
Name your new unit.
Select Advanced.
Click on LTI Consumer.
Click on Edit.
Fill in the fields.
Here’s an example from Yellowdig’s documentation:
Fill in the fields as follows, keeping in mind that you must set LTI Launch Target to "New Window" and that you must enable "Request user's email" to achieve successful LTI launches.Display Name: Yellowdig
LTI Application Information: [insert custom description tailored to your students]
LTI ID: yellowdig
NOTE: For LTI version, you should indicate LTI 1.3.
LTI URL: https://api.yellowdig.app/launch
Custom Parameters: [leave blank]
LTI Launch Target: New Window. [To accommodate iOS and Safari 13+ users, for whom opening Yellowdig in an iFrame may be impossible, we strongly recommend "New Window".]
Button Text: Yellowdig
Scored: True [if using grade passback]
Weight: [to reduce rounding errors, we recommend allocating at least 100 points to Yellowdig]
Hide External Tool: False
Accept Grades Past Deadline: [choose in accordance with your preferences]
Request User's Username: [choose in accordance with your preferences]
Request User's Email: True
Request User's Full Name: True
Note: For Request User’s Username, Email, and Full Name - these fields may not be available depending on your edX setup. In our instance, we set Send extra parameters as “true” in order to make sure the LTI works.
Click on Save.
Note About 1.3 Authentication
Once you have completed the above steps, you will see a screen that looks something like this:
From this point, this info can be sent to the vendor so that they can authenticate the LTI integration on their end and you can use the tool in edX.
However, if you are trying to use the tool in multiple places in the same course, all above steps INCLUDING the authentication needs to be replicated. This results in the previous authentication being deactivated, while the new authentication is authorized. This is an issue specific to 1.3.