Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_images/site_ops_how_tos/external_lti_configuration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ Each LTI passport includes three component text strings that are separated by
colon characters. The component strings are: the LTI ID, the client key, and
the client secret.

- The **LTI ID** is a value that you create to refer to the remote LTI tool
- The **LTI Passport ID** is a value that you create to refer to the remote LTI tool
provider. You should create an LTI ID that you can remember easily.

The LTI ID can contain uppercase and lowercase alphanumeric characters, as
well as underscore characters (_). It can be any length. For example, you
can create an LTI ID that is as simple as ``test_lti_id``, or your LTI ID
can create an LTI Passport ID that is as simple as ``test_lti_id``, or your LTI Passport ID
can be a string of numbers and letters such as ``id_21441`` or
``book_lti_provider_from_new_york``.

Expand All @@ -50,10 +50,10 @@ the client secret.
something as simple as ``secret``, or it might be a string of numbers and
letters such as ``23746387264`` or ``yt4984yr8``.

To create an LTI passport, combine the LTI ID, client key,
To create an LTI passport, combine the LTI Passport ID, client key,
and client secret in the following format (be sure to include the colons).

``{your_lti_id}:{client_key}:{client_secret}``
``{your_lti_passport_id}:{client_key}:{client_secret}``

The following example LTI passports show the format of the
passport string.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ To add an LTI 1.3 component to a course unit, follow these steps.
#. Enter the LTI 1.3 settings provided from your tool. For basic LTI 1.3
tools, without LTI Advantage, you need to set the following settings:

* **LTI 1.3 Tool Launch URL** (can also be called redirect url)
* **LTI 1.3 OIDC URL** (can also be called login url)
* **Launch URL** (can also be called redirect url)
* **Tool Initiate Login URL (OIDC)** (can also be called login url)

To enable *LTI Advantage* features, such as grades pass back and Deep
Linking, you also need to set **LTI 1.3 Tool Public Key** with a key
Linking, you also need to set **Tool Public Key** with a key
provided by the LTI tool. The key will look similar to this example:

.. code-block:: bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,16 +44,16 @@ Configure the LTI Consumer to use the reusable configuration
************************************************************

#. Open the component’s settings (Edit).
#. Set **Configuration type** to *Reusable configuration*.
#. Set **LTI version** to *LTI 1.3*.
#. Set **Reusable configuration ID**:
#. Set **Configuration Type** to *Existing*.
#. Set **LTI Version** to *LTI 1.3*.
#. Set **LTI Reusability ID**:

* Enter the filter key for the reusable configuration, typically the slug value prefixed as shown in your instance (for example, ``lti_store:reference_tool``).

#. (Optional) Update the **Display name** and any course-facing settings as needed.
#. Save.

.. image:: /_images/educator_how_tos/edit_lti_component.png
.. image:: /_images/educator_how_tos/external_lti_configuration.png
:alt: LTI component in editing mode, displaying the fields to be edited

Publish and test
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ To set up LTI-AGS services on a component, follow these steps.

#. Select **Edit** in the component that appears.

#. Locate the **LTI Assignment and Grades Service** setting.
#. Locate the **Assignment and Grades** setting.

#. Select the operation mode of the Assignments and Grades services. You can
disable the LTI-AGS service by selecting **Disabled** or pick one of the
Expand Down Expand Up @@ -58,13 +58,12 @@ To set up LTI-DL services on a component, follow these steps.

#. Select **Edit** in the component that appears.

#. Locate the **Deep linking** setting and set it to **True** (enabled).
#. Locate the **Deep linking** setting and set it to **Enabled**.

#. Locate the **LTI Advantage Deep Linking Launch URL** setting.
#. Locate the **Deep Linking Launch URL** setting.

#. Retrieve the Deep Linking Launch url from the tool you're integrating with.
If it's not provided, try using the same value as in the **LTI 1.3 Tool
Launch URL**.
If it's not provided, try using the same value as in the **Launch URL**.

#. Select **Save**. The Studio page will refresh and show the updated details
page.
Expand Down Expand Up @@ -108,7 +107,7 @@ To set up LTI-NRPS services on a component, follow these steps.

#. Select **Edit** in the component that appears.

#. Locate the **Enable LTI NRPS** setting and set it to **True** (enabled).
#. Locate the **Names & Roles (NRPS)** setting and set it to **Enabled**.

#. Select **Save**. The LTI-NRPS will be enabled for all subsequent launches.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,15 @@ LTI Component Settings
* - Setting
- Description

* - Display Name
- Specifies the name of the component. This name appears as a heading
above the problem. Unique, descriptive display names help you
identify problems quickly and accurately for analysis.

* - LTI Application Information
* - Data Sharing Notice
- The description of the remote LTI application. If the application
requires a username or email address, use this field to inform learners
that their information will be forwarded to the external application.

* - LTI Version
- Used to select the LTI version used for the current LTI component.

* - LTI ID (LTI 1.1 only)
* - LTI Passport ID (LTI 1.1 only)
- Specifies the LTI ID for the remote LTI tool provider. This value must
match the LTI ID that you entered as part of the LTI passport string for
the LTI tool. For more information about LTI passports, see
Expand All @@ -34,30 +29,29 @@ LTI Component Settings
* - LTI URL (LTI 1.1 only)
- Specifies the URL of the remote LTI tool that this component launches.

* - LTI 1.3 Tool Launch URL (LTI 1.3 only)
* - Launch URL (LTI 1.3 only)
- Specifies the URL of the remote LTI tool that this component launches.
This is sometimes called *Redirect URL* in some tools.

* - LTI 1.3 OIDC URL (LTI 1.3 only)
* - Tool Initiate Login URL (OIDC) (LTI 1.3 only)
- Specifies the URL of the login URL for the remote LTI tool for the
authentication flow. This can also be called *Login URL* on some tools.

* - LTI 1.3 Tool Public Key (LTI 1.3 only)
- The LTI 1.3 tool's public key. This is a string that starts with
'-----BEGIN PUBLIC KEY-----' and is required so that the LMS can check if
the messages and launch requests received have the signature from the tool.
This is not required when doing LTI 1.3 Launches without LTI Advantage.
* - Registered Redirect URL (LTI 1.3 only)
- Enter the redirect URIs this tool is allowed to use during login
e.g. ``["https://tool.com", "https://tool_deeplink.com"]``. Leave this blank to
use the launch URL and deep linking URL by default.

* - Deep linking (LTI 1.3 only)
- Toggle to enable or disable LTI Advantage Deep Linking. Select **True** if
- Toggle to enable or disable LTI Advantage Deep Linking. Select **Enabled** if
the tool supports this feature and you want to use it in this component.

* - LTI Advantage Deep Linking Launch URL (LTI 1.3 only)
* - Deep Linking Launch URL (LTI 1.3 only)
- Specifies the URL of the remote LTI tool that this component uses to perform
deep linking launches. If not specified by the tool, use the same URL as
in **LTI 1.3 Tool Launch URL**.

* - LTI Assignment and Grades Service (LTI 1.3 only)
* - Assignment and Grades (LTI 1.3 only)
- Toggle to enable LTI Advantage Assignment and Grades services and set the
grading model.

Expand All @@ -66,14 +60,45 @@ LTI Component Settings
* **Disabled** - LTI AGS service will be disabled. Use this for tools that
don't send any grades back to the platform.

* **Allow tools to submit grades only (declarative) (Default)** - the platform
will enable LTI AGS and prepare a single grade container for problems to
send grades back to. Use this for simple LTI problems.
* **Declarative (Default)** - the platform will enable LTI AGS and prepare
a single grade container for problems to send grades back to. Use this
for simple LTI problems.

* **Allow tools to manage and submit grade (programmatic)** - The tool will have
full control over the grading process, enabling it to create and edit one or
more grade containers and manage the learner scores that will be reported
to the LMS.
* **Programmatic** - The tool will have full control over the grading process,
enabling it to create and edit one or more grade containers and manage the
learner scores that will be reported to the LMS.

* - Names & Roles (NRPS) (LTI 1.3 only)
- Enable this to allow the tool to access the names and roles of enrolled learners,
if the tool supports NRPS.

* - Tool Public Key Mode (LTI 1.3 only)
- Choose how Open edX will get the tool’s public key for validating signed messages.

Options are:

* **Public Key** - The tool will send the public key to the LMS.

* **Keyset URL** - The tool will send the keyset URL to the LMS.

* - Tool Public Key (LTI 1.3 only)
- The LTI 1.3 tool's public key. This is a string that starts with
``-----BEGIN PUBLIC KEY-----`` and is required so that the LMS can check if
the messages and launch requests received have the signature from the tool.
This is not required when doing LTI 1.3 Launches without LTI Advantage.

This is only required if **Tool Public Key Mode** is set to **Public Key**.

* - Tool Keyset URL (LTI 1.3 only)
- The URL of the tool’s JWK keyset. Open edX uses this URL to retrieve the public
keys needed to validate signed messages.

This is only required if **Tool Public Key Mode** is set to **Keyset URL**.

* - Display Name
- Specifies the name of the component. This name appears as a heading
above the problem. Unique, descriptive display names help you
identify problems quickly and accurately for analysis.

* - Custom Parameters
- Sends additional parameters that are required by the remote LTI tool.
Expand All @@ -93,59 +118,63 @@ LTI Component Settings

["page=144"]

* - LTI Launch Target
- Controls the way that the course page will open and display the remote
LTI tool.

Options are:
* - This activity is graded
- Indicates whether the LTI component receives a numerical score from the
remote LTI tool provider. By default, this value is set to **Ungraded**.

* **Inline** - the LTI tool will appear directly in the course page.
* - Grade Weight
- Specifies the number of points possible for a problem. By default, if a
remote LTI tool provider grades the problem, the problem is worth one
point, and a learner's score can be any value between zero and one.

* **Modal** - the LTI tool will appear in a separate display window in
front of the course page. The modal display window prevents learners
from interacting with the course page until they dismiss the LTI tool.
This setting is only applied if **This activity is graded** is set to **Graded**.

* **New Window** - the LTI tool will appear in a new web browser window.
Depending on the configuration of the web browser, it may appear in a
new tab or in a separate browser window. Learners can interact with
both the course page and the LTI tool.
For more information about problem weights and computing point scores,
see :ref:`Problem Weight`.

* - Button Text
- Enter a custom label for the button that opens the external LTI tool.
* - Accept grades after due date
- Specifies whether third-party systems are allowed to post grades after
the deadline. By default, this value is set to **Enabled**.

* - Inline Height
- Specifies the on-screen height of the LTI tool in pixels.
This setting is only applied if **This activity is graded** is set to **Graded**.

This setting is only applied if the **LTI Launch Target** is set to
**Inline**.
* - Share Email
- Sends the learner's email address to the remote LTI tool.

* - Modal Height
- Specifies the on-screen height of the LTI content window as a percentage
of the visible web browser window height. Enter the percentage in whole numbers.
An LTI component will only send learners' email addresses if the **Open
Tool in** control is set to **New Window**. When the new window
launches, the learners are warned that if they continue, their email
address will be shared with the LTI provider.

This setting is only applied if the **LTI Launch Target** control is set
to **Modal**.
By default, this setting is not available in Studio.
See :ref:`Allow sharing PII to LTI Components` for how to enable
(requires system administrator privileges).

* - Modal Width
- Specifies the on-screen width of the LTI content window as a percentage
of the web browser window width. Enter the percentage in whole numbers.
* - Share Username
- Sends the learner's username to the remote LTI tool. This is the
username that the learner used to register for the course.

This setting is only applied if the **LTI Launch Target** control is set
to **Modal**.
An LTI component will only send learners' usernames if the **Open
Tool in** control is set to **New Window**. When the new window
launches, the learners are warned that if they continue, their username
will be shared with the LTI provider.

* - Scored
- Indicates whether the LTI component receives a numerical score from the
remote LTI tool provider. By default, this value is set to **False**.
By default, this setting is not available in Studio.
See :ref:`Allow sharing PII to LTI Components` for how to enable
(requires system administrator privileges).

* - Weight
- Specifies the number of points possible for a problem. By default, if a
remote LTI tool provider grades the problem, the problem is worth one
point, and a learner's score can be any value between zero and one.
* - Share Full Name
- Sends the learner's full name to the remote LTI tool. This is the
full name that the learner used to register for the course.

This setting is only applied if **Scored** is set to **True**.
An LTI component will only send learners' full names if the **Open
Tool in** control is set to **New Window**. When the new window
launches, the learners are warned that if they continue, their full
name will be shared with the LTI provider.

For more information about problem weights and computing point scores,
see :ref:`Problem Weight`.
By default, this setting is not available in Studio.
See :ref:`Allow sharing PII to LTI Components` for how to enable
(requires system administrator privileges).

* - Hide External Tool
- Controls whether the LTI component will display the remote LTI tool on
Expand All @@ -159,34 +188,48 @@ LTI Component Settings
Set the value to **False** to display the remote LTI tool and allow
learners to interact with it.

* - Accept grades past deadline
- Specifies whether third-party systems are allowed to post grades after
the deadline. By default, this value is set to **True**.
* - Open Tool in
- Controls the way that the course page will open and display the remote
LTI tool.

* - Request user's email
- Sends the learner's email address to the remote LTI tool.
Options are:

An LTI component will only send learners' email addresses if the **LTI
Launch Target** control is set to **New Window**. When the new window
launches, the learners are warned that if they continue, their email
address will be shared with the LTI provider.
* **Inline** - the LTI tool will appear directly in the course page.

By default, this setting is not available in Studio.
See :ref:`Allow sharing PII to LTI Components` for how to enable
(requires system administrator privileges).
* **Modal** - the LTI tool will appear in a separate display window in
front of the course page. The modal display window prevents learners
from interacting with the course page until they dismiss the LTI tool.

* - Request user's username
- Sends the learner's username to the remote LTI tool. This is the
username that the learner used to register for the course.
* **New Window** - the LTI tool will appear in a new web browser window.
Depending on the configuration of the web browser, it may appear in a
new tab or in a separate browser window. Learners can interact with
both the course page and the LTI tool.

An LTI component will only send learners' usernames if the **LTI Launch
Target** control is set to **New Window**. When the new window
launches, the learners are warned that if they continue, their username
will be shared with the LTI provider.
* - Inline Height (px)
- Specifies the on-screen height of the LTI tool in pixels.

By default, this setting is not available in Studio.
See :ref:`Allow sharing PII to LTI Components` for how to enable
(requires system administrator privileges).
This setting is only applied if the **Open Tool in** is set to
**Inline**.

* - Modal Height (%)
- Specifies the on-screen height of the LTI content window as a percentage
of the visible web browser window height. Enter the percentage in whole numbers.

This setting is only applied if the **Open Tool in** control is set
to **Modal**.

* - Modal Width (%)
- Specifies the on-screen width of the LTI content window as a percentage
of the web browser window width. Enter the percentage in whole numbers.

This setting is only applied if the **Open Tool in** control is set
to **Modal**.

* - Launch Button Text
- Enter a custom label for the button that opens the external LTI tool.

The button text is only displayed if the **Open Tool in** control is set
to **Modal** or **New Window**.

.. seealso::

Expand Down