@@ -96,19 +96,13 @@ information, see :ref:`Enable Additional Exercises and Tools`.
96
96
``lti `` module is no longer present in the **Advanced Module List **.
97
97
98
98
99
- .. _Setting up a LTI 1.1 component
99
+ .. _Setting up a LTI 1.1 component :
100
100
101
101
*******************************
102
102
Setting up an LTI 1.1 component
103
103
*******************************
104
104
105
- .. _LTI Information :
106
-
107
- ==============================
108
- LTI Authentication Information
109
- ==============================
110
-
111
- Some LTI tools require users to provide authentication credentials. If the LTI
105
+ Some LTI 1.1 tools require users to provide authentication credentials. If the LTI
112
106
tool you are including in your course requires authentication, you must add an
113
107
LTI passport for that tool to your course configuration.
114
108
@@ -186,7 +180,7 @@ To add an LTI passport for an LTI tool to the configuration for your course, fol
186
180
187
181
``"test_lti_id:b289378-f88d-2929-ctools.umich.edu:secret" ``
188
182
189
- For more information about creating your key, see :ref: `LTI Information `.
183
+ For more information about creating your key, see :ref: `Setting up a LTI 1.1 component `.
190
184
191
185
#. If you use more than one LTI provider in your course, separate each LTI
192
186
passport string with commas. Make sure to surround each entry with quotation
@@ -215,7 +209,8 @@ To add an LTI component to a course unit, follow these steps.
215
209
216
210
#. If the LTI tool requires authentication, register the key and shared secret
217
211
for the LTI tool in the configuration for your course. For more information
218
- about registering authentication credentials, see :ref: `LTI Information `.
212
+ about registering authentication credentials, see
213
+ :ref: `Setting up a LTI 1.1 component `.
219
214
220
215
#. Edit the unit in which you want to add the remote LTI tool and select
221
216
**Advanced ** from the **Add New Component ** section. Select **LTI
@@ -226,6 +221,8 @@ To add an LTI component to a course unit, follow these steps.
226
221
227
222
#. Select **Edit ** in the component that appears.
228
223
224
+ #. In the **LTI Version ** field, select **LTI 1.1/1.2 **.
225
+
229
226
#. Configure the LTI component in the component editor. For more information
230
227
about each setting, see :ref: `LTI Component settings `.
231
228
@@ -234,14 +231,46 @@ To add an LTI component to a course unit, follow these steps.
234
231
To test an LTI component, use the **Preview ** feature or view the live version
235
232
in the LMS. For more information, see :ref: `Testing Your Course Content `.
236
233
237
- .. _Setting up a LTI 1.3 component
234
+ .. _Setting up a LTI 1.3 component :
238
235
239
236
*******************************
240
237
Setting up an LTI 1.3 component
241
238
*******************************
242
239
243
240
244
241
242
+ .. _Enabling and using LTI Advantage features :
243
+
244
+ *****************************************
245
+ Enabling and using LTI Advantage features
246
+ *****************************************
247
+
248
+ LTI Advantage is an extension of the LTI 1.3 specification that enables additional
249
+ features in LTI components. See `LTI Advantage `_ for more imformation.
250
+
251
+ Currently, Open edX supports the following LTI Advantage extensions:
252
+
253
+ * `Assignments and Grades services `_
254
+ * `Deep Linking `_
255
+
256
+
257
+ .. _Enabling LTI Assignments and Grades services :
258
+
259
+ ============================================
260
+ Enabling LTI Assignments and Grades services
261
+ ============================================
262
+
263
+ TBD LTI AGS setup and usage
264
+
265
+
266
+ .. _Enabling and using LTI Deep Linking :
267
+
268
+ ===================================
269
+ Enabling and using LTI Deep Linking
270
+ ===================================
271
+
272
+ TBD LTI DL setup and usage
273
+
245
274
.. _LTI Component settings :
246
275
247
276
**********************
@@ -265,15 +294,59 @@ LTI Component Settings
265
294
requires a username or email address, use this field to inform learners
266
295
that their information will be forwarded to the external application.
267
296
268
- * - LTI ID
297
+ * - LTI Version
298
+ - Used to select the LTI version used in for the current LTI component.
299
+
300
+ * - LTI ID (LTI 1.1 only)
269
301
- Specifies the LTI ID for the remote LTI tool provider. This value must
270
302
match the LTI ID that you entered as part of the LTI passport string for
271
303
the LTI tool. For more information about LTI passports, see :ref: `LTI
272
304
Information`.
273
305
274
- * - LTI URL
306
+ * - LTI URL (LTI 1.1 only)
275
307
- Specifies the URL of the remote LTI tool that this component launches.
276
308
309
+ * - LTI 1.3 Tool Launch URL (LTI 1.3 only)
310
+ - Specifies the URL of the remote LTI tool that this component launches.
311
+ This is sometimes called *redirect * url in some tools.
312
+
313
+ * - LTI 1.3 OIDC URL (LTI 1.3 only)
314
+ - Specifies the URL of the login URL for the remote LTI tool for the
315
+ authentication flow. This can also be called *Login URL * on some tools.
316
+
317
+ * - LTI 1.3 Tool Public Key (LTI 1.3 only)
318
+ - The LTI 1.3 Tool's public key. This is a string that starts with
319
+ '-----BEGIN PUBLIC KEY-----' and is required so that the LMS can check if
320
+ the messages and launch requests received have the signature from the tool.
321
+ This is not required when doing LTI 1.3 Launches without LTI Advantage.
322
+
323
+ * - Deep linking (LTI 1.3 only)
324
+ - Toggle to enable or disable LTI Advantage Deep Linking. Select **True ** if
325
+ the tool supports this feature and you want to use it in this component.
326
+
327
+ * - LTI Advantage Deep Linking Launch URL (LTI 1.3 only)
328
+ - Specifies the URL of the remote LTI tool that this component uses to perform
329
+ deep linking launches. If not specified by the tool, use the same URL as
330
+ in **LTI 1.3 Tool Launch URL **.
331
+
332
+ * - LTI Assignment and Grades Service (LTI 1.3 only)
333
+ - Toggle to enable LTI Advantage Assignment and Grades services and set the
334
+ grading model.
335
+
336
+ Options are:
337
+
338
+ * **Disabled ** - LTI AGS service will be disabled. Use this for tools that
339
+ don't send any grades back to the platform.
340
+
341
+ * **Allow tools to submit grades only (declarative) (Default) ** - the platform
342
+ will enable LTI AGS and prepare a single grade container for problems to
343
+ send grades back to. Use this for simple LTI problems.
344
+
345
+ * **Allow tools to manage and submit grade (programmatic) ** - LTI AGS is enabled
346
+ and the tool will have full control over the grading process, enabling it to
347
+ create and edit one or more grade containers and manage the learner scores that
348
+ will be linked to the LMS.
349
+
277
350
* - Custom Parameters
278
351
- Sends additional parameters that are required by the remote LTI tool.
279
352
The parameters that you send depend on the specific LTI tool you are
0 commit comments