Skip to Content

Wiki source code of LTI 1.3

Last modified by Moritz Baumgarten on 16.02.2024
Show last authors
1 {{layout}}
2 {{layout-section ac:type="single"}}
3 {{layout-cell}}
4 If you want to create a new configuration for a tool with LTI version 1.1, open the selection list **LTI Version** and select **LTI 1.3**. Under **Tool**, select **Custom Tool**.
5 {{/layout-cell}}
6 {{/layout-section}}
7
8 {{layout-section ac:type="two_equal"}}
9 {{layout-cell}}
10 [[image:Kurseditor-LTI -1-3-Tool Konfig tool wählen_en.png||alt="Kurseditor - LTI 1.3_de.png" data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
11 {{/layout-cell}}
12
13 {{layout-cell}}
14
15 {{/layout-cell}}
16 {{/layout-section}}
17
18 {{layout-section ac:type="single"}}
19 {{layout-cell}}
20 This opens the following configuration settings you can make:
21
22 (% class="relative-table" style="width:100.0%" %)
23 |=(((
24 Login URL des Tools
25 )))|Enter the address of the external learning application.
26 |=(% colspan="1" %)(% colspan="1" %)
27 (((
28 Launch URL des Tools
29 )))|(% colspan="1" %)Enter the start URL of the external learning application.
30 |=(% colspan="1" %)(% colspan="1" %)
31 (((
32 Schlüsseltyp
33 )))|(% colspan="1" %)(((
34 Select if the key of the tool shall be retrieved via **Keyset URL** or if you wish to enter the **RSA Key** directly.
35
36 The advantage of the Keyset URL is that once the key expires and is recreated, no new course element adjustments are necessary if the URL remains the same.
37 )))
38 |=(% colspan="1" %)(% colspan="1" %)
39 (((
40 Keyset URL des Tools
41 )))|(% colspan="1" %)This option only appears if your selected key type is Keyset URL. Enter the URL with which the public key of the tool can be retrieved in this field.
42 |=(% colspan="1" %)(% colspan="1" %)
43 (((
44 RSA Key des Tools
45 )))|(% colspan="1" %)This option only appears if your selected key type is RSA Key. Enter the complete and latest public key of the tool in this field.
46 |=(% colspan="1" %)(% colspan="1" %)
47 (((
48 ClientID des Tools
49 )))|(% colspan="1" %)Enter the tool ID. Your Client ID is a unique ID to ensure the identity of both sides and has to be configured in OPAL and the Tool. You can freely choose the Client ID but it should not be given to unauthorised third parties.
50 |=(((
51 Passwort
52 )))|Enter the corresponding password for the key. The password can also be obtained from the provider of the external learning application.
53 |=(% colspan="1" %)(% colspan="1" %)
54 (((
55 Datenschutz
56 )))|(% colspan="1" %)(% colspan="1" %)
57 (((
58 Define the parameters that you want to be transmitted to the tool:
59
60 * **First and last name: **If you activate this checkbox, the first and last name of the user will be forwarded to the external learning application.
61 * **Send email: **If you activate this checkbox, the email address of the user will be sent to the external learning application.
62
63
64 )))
65 |=(((
66 Zusätzliche Parameter
67 )))|In this field, you can enter additional parameters which shall be transmitted to the learning platform. This way, the learning application can be informed from which learning platform the request is given. The external learning application must be able to process the shared information, which is why a consultation with the provider is necessary. The important thing is that the parameters are always given with name and value (key=value). Multiple parameters must always be specified line by line.
68 |=(% colspan="1" %)(% colspan="1" %)
69 (((
70 Anzeige
71 )))|(% colspan="1" %)Select whether the tool should be opened directly in the course view or in a new browser window.
72
73 (% class="auto-cursor-target" %)
74
75 {{/layout-cell}}
76 {{/layout-section}}
77
78 {{layout-section ac:type="two_equal"}}
79 {{layout-cell}}
80 [[image:Kurseditor-LTI-1-3-Tool Konfig Eigenes Tool_en.png||alt="Kurseditor - LTI 1.3 Optionen_de.png" data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
81 {{/layout-cell}}
82
83 {{layout-cell}}
84
85 {{/layout-cell}}
86 {{/layout-section}}
87
88 {{layout-section ac:type="single"}}
89 {{layout-cell}}
90 Save your entries. You will then be shown the necessary information about the OPAL interface, which you have to configure in the selected LTI tool.
91 {{/layout-cell}}
92 {{/layout-section}}
93
94 {{layout-section ac:type="single"}}
95 {{layout-cell}}
96 === OPAL configurations for the external tool ===
97
98 LTI 1.3 requires a coordinated configuration of the LMS and the tool. The configuration is based on the specific interface URLs, as well as the client ID used as a key. To configure OPAL at the external tool you therefore also need the OPAL interface data.
99
100 Once you have saved the details of the tool to be connected, the required URLs are displayed. This is how it works in general:
101
102
103 * **Issuer ID (ISS): **The Issuer ID identifies the learning platform OPAL. For example, you can use the OPAL URL [[https:~~/~~/bildungsportal.sachsen.de/opal>>url:https://bildungsportal.sachsen.de/opal]] as a unique identifier.
104 * **Client ID**: The Client ID is a unique ID to ensure the identity of both sides. It has to be configured in OPAL and the Tool.
105 * **OIDC Auth URL**: OPAL URL with addition /ltiauth,  e.g.  [[https:~~/~~/bildungsportal.sachsen.de/opal/ltiauth/>>url:https://bildungsportal.sachsen.de/opal/ltiauth/]]
106 * **OAuth2 Access Token URL**: OPAL URL with addition /restapi/lti/token, e.g. [[https:~~/~~/bildungsportal.sachsen.de/opal/restapi/lti/token>>url:https://bildungsportal.sachsen.de/opal/restapi/lti/token]]
107 * **Keyset URL**: OPAL URL with addition /restapi/lti/keys , e.g. [[https:~~/~~/bildungsportal.sachsen.de/opal/restapi/lti/keys>>url:https://bildungsportal.sachsen.de/opal/restapi/lti/keys]]
108 * **Deployment-ID**: The Deployment ID enables the differentiation of multiple tool instances. If just one tool instance is provided, the deployment ID has the value "1".
109 {{/layout-cell}}
110 {{/layout-section}}
111 {{/layout}}