Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

...

https://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/exercises_tools/lti_component.html#lti-component

...

Enabling a Course to Use LTI Components

Expand
  1. In edX Studio, locate your course, click on the Settings tab and select Advanced Settings from the dropdown.

    Image Modified
  2. In the Advanced Module List field, add “lti_consumer” between the brackets if it is not already there.

    Image Modified
  3. This allows LTI components to be used in the course.

...

Enabling an Added LTI in a edX Course (1.1 LTI Specific)

Expand

These steps do NOT need to occur for a 1.3 LTI integration.

Info

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.

  1. Obtain the LMS key and secret from your organization administrator.

  2. Navigate to your edX Studio course.

  3. Click on Settings then select Advanced Settings from the dropdown.

    Image Modified
  4. Locate the LTI Passports field.

  5. Enter "yellowdig:[network key]:[network secret]" between the brackets.

    1. Replace [network key] and [network secret] with the corresponding key and secret from step 1.

    2. Include the quotation marks and the colons.

    3. If you have multiple LTI Passports, separate them with commas.

Image Modified
  1. At the bottom of your screen, click the Save button (in the black bar that pops up).

    Image Modified

...

Creating a LTI Tool Graded Assignment Type

Expand
Info

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-

  1. In your edX course, navigate to Settings and select Grading from the dropdown menu.

  2. Scroll to the bottom of the page and click on + New Assignment Type.

    Image Modified
  3. Fill out the fields according to your course needs. Here’s an example from Yellowdig:

    Image Modified
  4. Click on Save Changes in the black bar at the bottom of your screen.

    Image Modified

...

Creating an edX LTI Assignment

Creating a 1.1 LTI Assignment

Expand
Info

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:

  1. 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.

    Image Modified
  2. Click on + New Section.

    Image Modified
  3. Name your new section.

    Image Modified
  4. Click on + New Subsection and name the subsection accordingly.

    Image Modified
  5. Click on + New Unit.

    Image Modified
  6. Name your new unit.

    Image Modified
  7. Select Advanced.

    Image Modified
  8. Click on LTI Consumer.

    Image Modified
  9. Click on Edit.

    Image Modified
  10. Fill in the fields.

    Image Modified

    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.

      Image Added
    • 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.

      Image Added

  1. Click on Save.

    Image Added

Creating a 1.3 LTI Assignment

Expand
Info

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:

  1. 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.

    Image Added
  2. Click on + New Section.

    Image Added
  3. Name your new section.

    Image Added
  4. Click on + New Subsection and name the subsection accordingly.

    Image Added
  5. Click on + New Unit.

    Image Added
  6. Name your new unit.

    Image Added
  7. Select Advanced.

    Image Added
  8. Click on LTI Consumer.

    Image Added
  9. Click on Edit.

    Image Added
  10. Fill in the fields.

    Image Added

    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.

      Image Modified
    • 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.

      Image Modified

  11. Click on Save.

    Image Modified

Note About 1.3 Authentication

Expand

Once you have completed the above steps, you will see a screen that looks something like this:

Image Added

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.