@@ -12,20 +12,15 @@ LTI Component Settings
1212 * - Setting
1313 - Description
1414
15- * - Display Name
16- - Specifies the name of the component. This name appears as a heading
17- above the problem. Unique, descriptive display names help you
18- identify problems quickly and accurately for analysis.
19-
20- * - LTI Application Information
15+ * - Data Sharing Notice
2116 - The description of the remote LTI application. If the application
2217 requires a username or email address, use this field to inform learners
2318 that their information will be forwarded to the external application.
2419
2520 * - LTI Version
2621 - Used to select the LTI version used for the current LTI component.
2722
28- * - LTI ID (LTI 1.1 only)
23+ * - LTI Passport ID (LTI 1.1 only)
2924 - Specifies the LTI ID for the remote LTI tool provider. This value must
3025 match the LTI ID that you entered as part of the LTI passport string for
3126 the LTI tool. For more information about LTI passports, see
@@ -34,30 +29,29 @@ LTI Component Settings
3429 * - LTI URL (LTI 1.1 only)
3530 - Specifies the URL of the remote LTI tool that this component launches.
3631
37- * - LTI 1.3 Tool Launch URL (LTI 1.3 only)
32+ * - Launch URL (LTI 1.3 only)
3833 - Specifies the URL of the remote LTI tool that this component launches.
3934 This is sometimes called *Redirect URL * in some tools.
4035
41- * - LTI 1.3 OIDC URL (LTI 1.3 only)
36+ * - Tool Initiate Login URL (OIDC) (LTI 1.3 only)
4237 - Specifies the URL of the login URL for the remote LTI tool for the
4338 authentication flow. This can also be called *Login URL * on some tools.
4439
45- * - LTI 1.3 Tool Public Key (LTI 1.3 only)
46- - The LTI 1.3 tool's public key. This is a string that starts with
47- '-----BEGIN PUBLIC KEY-----' and is required so that the LMS can check if
48- the messages and launch requests received have the signature from the tool.
49- This is not required when doing LTI 1.3 Launches without LTI Advantage.
40+ * - Registred Redirect URL (LTI 1.3 only)
41+ - Enter the redirect URIs this tool is allowed to use during login
42+ e.g. ["https://tool.com", "https://tool_deeplink.com"]. Leave this blank to
43+ use the launch URL and deep linking URL by default.
5044
5145 * - Deep linking (LTI 1.3 only)
52- - Toggle to enable or disable LTI Advantage Deep Linking. Select **True ** if
46+ - Toggle to enable or disable LTI Advantage Deep Linking. Select **Enabled ** if
5347 the tool supports this feature and you want to use it in this component.
5448
55- * - LTI Advantage Deep Linking Launch URL (LTI 1.3 only)
49+ * - Deep Linking Launch URL (LTI 1.3 only)
5650 - Specifies the URL of the remote LTI tool that this component uses to perform
5751 deep linking launches. If not specified by the tool, use the same URL as
5852 in **LTI 1.3 Tool Launch URL **.
5953
60- * - LTI Assignment and Grades Service (LTI 1.3 only)
54+ * - Assignment and Grades (LTI 1.3 only)
6155 - Toggle to enable LTI Advantage Assignment and Grades services and set the
6256 grading model.
6357
@@ -66,14 +60,45 @@ LTI Component Settings
6660 * **Disabled ** - LTI AGS service will be disabled. Use this for tools that
6761 don't send any grades back to the platform.
6862
69- * **Allow tools to submit grades only (declarative) (Default) ** - the platform
70- will enable LTI AGS and prepare a single grade container for problems to
71- send grades back to. Use this for simple LTI problems.
63+ * **Declarative (Default) ** - the platform will enable LTI AGS and prepare
64+ a single grade container for problems to send grades back to. Use this
65+ for simple LTI problems.
66+
67+ * **Programmatic ** - The tool will have full control over the grading process,
68+ enabling it to create and edit one or more grade containers and manage the
69+ learner scores that will be reported to the LMS.
70+
71+ * - Names & Roles (NRPS) (LTI 1.3 only)
72+ - Enable this to allow the tool to access the names and roles of enrolled learners,
73+ if the tool supports NRPS.
74+
75+ * - Tool Publick Key Mode (LTI 1.3 only)
76+ - Choose how Open edX will get the tool’s public key for validating signed messages.
77+
78+ Options are:
79+
80+ * **Public Key ** - The tool will send the public key to the LMS.
81+
82+ * **Keyset URL ** - The tool will send the keyset URL to the LMS.
7283
73- * **Allow tools to manage and submit grade (programmatic) ** - The tool will have
74- full control over the grading process, enabling it to create and edit one or
75- more grade containers and manage the learner scores that will be reported
76- to the LMS.
84+ * - LTI 1.3 Tool Public Key (LTI 1.3 only)
85+ - The LTI 1.3 tool's public key. This is a string that starts with
86+ '-----BEGIN PUBLIC KEY-----' and is required so that the LMS can check if
87+ the messages and launch requests received have the signature from the tool.
88+ This is not required when doing LTI 1.3 Launches without LTI Advantage.
89+
90+ This is only required if **Tool Publick Key Mode ** is set to **Public Key **.
91+
92+ * - Tool Keyset URL (LTI 1.3 only)
93+ - The URL of the tool’s JWK keyset. Open edX uses this URL to retrieve the public
94+ keys needed to validate signed messages.
95+
96+ This is only required if **Tool Publick Key Mode ** is set to **Keyset URL **.
97+
98+ * - Display Name
99+ - Specifies the name of the component. This name appears as a heading
100+ above the problem. Unique, descriptive display names help you
101+ identify problems quickly and accurately for analysis.
77102
78103 * - Custom Parameters
79104 - Sends additional parameters that are required by the remote LTI tool.
@@ -93,59 +118,63 @@ LTI Component Settings
93118
94119 ["page=144"]
95120
96- * - LTI Launch Target
97- - Controls the way that the course page will open and display the remote
98- LTI tool.
99-
100- Options are:
121+ * - This activity is graded
122+ - Indicates whether the LTI component receives a numerical score from the
123+ remote LTI tool provider. By default, this value is set to **Ungraded **.
101124
102- * **Inline ** - the LTI tool will appear directly in the course page.
125+ * - Grade Weight
126+ - Specifies the number of points possible for a problem. By default, if a
127+ remote LTI tool provider grades the problem, the problem is worth one
128+ point, and a learner's score can be any value between zero and one.
103129
104- * **Modal ** - the LTI tool will appear in a separate display window in
105- front of the course page. The modal display window prevents learners
106- from interacting with the course page until they dismiss the LTI tool.
130+ This setting is only applied if **This activity is graded ** is set to **Graded **.
107131
108- * **New Window ** - the LTI tool will appear in a new web browser window.
109- Depending on the configuration of the web browser, it may appear in a
110- new tab or in a separate browser window. Learners can interact with
111- both the course page and the LTI tool.
132+ For more information about problem weights and computing point scores,
133+ see :ref: `Problem Weight `.
112134
113- * - Button Text
114- - Enter a custom label for the button that opens the external LTI tool.
135+ * - Accept grades after due date
136+ - Specifies whether third-party systems are allowed to post grades after
137+ the deadline. By default, this value is set to **Enabled **.
115138
116- * - Inline Height
117- - Specifies the on-screen height of the LTI tool in pixels.
139+ This setting is only applied if **This activity is graded ** is set to **Graded **.
118140
119- This setting is only applied if the ** LTI Launch Target ** is set to
120- ** Inline ** .
141+ * - Share Email
142+ - Sends the learner's email address to the remote LTI tool .
121143
122- * - Modal Height
123- - Specifies the on-screen height of the LTI content window as a percentage
124- of the visible web browser window height. Enter the percentage in whole numbers.
144+ An LTI component will only send learners' email addresses if the **Open
145+ Tool in ** control is set to **New Window **. When the new window
146+ launches, the learners are warned that if they continue, their email
147+ address will be shared with the LTI provider.
125148
126- This setting is only applied if the **LTI Launch Target ** control is set
127- to **Modal **.
149+ By default, this setting is not available in Studio.
150+ See :ref: `Allow sharing PII to LTI Components ` for how to enable
151+ (requires system administrator privileges).
128152
129- * - Modal Width
130- - Specifies the on-screen width of the LTI content window as a percentage
131- of the web browser window width. Enter the percentage in whole numbers .
153+ * - Share Username
154+ - Sends the learner's username to the remote LTI tool. This is the
155+ username that the learner used to register for the course .
132156
133- This setting is only applied if the **LTI Launch Target ** control is set
134- to **Modal **.
157+ An LTI component will only send learners' usernames if the **Open
158+ Tool in ** control is set to **New Window **. When the new window
159+ launches, the learners are warned that if they continue, their username
160+ will be shared with the LTI provider.
135161
136- * - Scored
137- - Indicates whether the LTI component receives a numerical score from the
138- remote LTI tool provider. By default, this value is set to ** False ** .
162+ By default, this setting is not available in Studio.
163+ See :ref: ` Allow sharing PII to LTI Components ` for how to enable
164+ (requires system administrator privileges) .
139165
140- * - Weight
141- - Specifies the number of points possible for a problem. By default, if a
142- remote LTI tool provider grades the problem, the problem is worth one
143- point, and a learner's score can be any value between zero and one.
166+ * - Share Full name
167+ - Sends the learner's full name to the remote LTI tool. This is the
168+ full name that the learner used to register for the course.
144169
145- This setting is only applied if **Scored ** is set to **True **.
170+ An LTI component will only send learners' full names if the **Open
171+ Tool in ** control is set to **New Window **. When the new window
172+ launches, the learners are warned that if they continue, their full
173+ name will be shared with the LTI provider.
146174
147- For more information about problem weights and computing point scores,
148- see :ref: `Problem Weight `.
175+ By default, this setting is not available in Studio.
176+ See :ref: `Allow sharing PII to LTI Components ` for how to enable
177+ (requires system administrator privileges).
149178
150179 * - Hide External Tool
151180 - Controls whether the LTI component will display the remote LTI tool on
@@ -159,34 +188,48 @@ LTI Component Settings
159188 Set the value to **False ** to display the remote LTI tool and allow
160189 learners to interact with it.
161190
162- * - Accept grades past deadline
163- - Specifies whether third-party systems are allowed to post grades after
164- the deadline. By default, this value is set to ** True ** .
191+ * - Open Tool in
192+ - Controls the way that the course page will open and display the remote
193+ LTI tool .
165194
166- * - Request user's email
167- - Sends the learner's email address to the remote LTI tool.
195+ Options are:
168196
169- An LTI component will only send learners' email addresses if the **LTI
170- Launch Target ** control is set to **New Window **. When the new window
171- launches, the learners are warned that if they continue, their email
172- address will be shared with the LTI provider.
197+ * **Inline ** - the LTI tool will appear directly in the course page.
173198
174- By default, this setting is not available in Studio.
175- See :ref: ` Allow sharing PII to LTI Components ` for how to enable
176- (requires system administrator privileges) .
199+ * ** Modal ** - the LTI tool will appear in a separate display window in
200+ front of the course page. The modal display window prevents learners
201+ from interacting with the course page until they dismiss the LTI tool .
177202
178- * - Request user's username
179- - Sends the learner's username to the remote LTI tool. This is the
180- username that the learner used to register for the course.
203+ * **New Window ** - the LTI tool will appear in a new web browser window.
204+ Depending on the configuration of the web browser, it may appear in a
205+ new tab or in a separate browser window. Learners can interact with
206+ both the course page and the LTI tool.
181207
182- An LTI component will only send learners' usernames if the **LTI Launch
183- Target ** control is set to **New Window **. When the new window
184- launches, the learners are warned that if they continue, their username
185- will be shared with the LTI provider.
208+ * - Inline Height (px)
209+ - Specifies the on-screen height of the LTI tool in pixels.
186210
187- By default, this setting is not available in Studio.
188- See :ref: `Allow sharing PII to LTI Components ` for how to enable
189- (requires system administrator privileges).
211+ This setting is only applied if the **Open Tool in ** is set to
212+ **Inline **.
213+
214+ * - Modal Height (%)
215+ - Specifies the on-screen height of the LTI content window as a percentage
216+ of the visible web browser window height. Enter the percentage in whole numbers.
217+
218+ This setting is only applied if the **Open Tool in ** control is set
219+ to **Modal **.
220+
221+ * - Modal Width (%)
222+ - Specifies the on-screen width of the LTI content window as a percentage
223+ of the web browser window width. Enter the percentage in whole numbers.
224+
225+ This setting is only applied if the **Open Tool in ** control is set
226+ to **Modal **.
227+
228+ * - Launch Button Text
229+ - Enter a custom label for the button that opens the external LTI tool.
230+
231+ - The button text is only displayed if the **Open Tool in ** control is set
232+ to **Modal ** or **New Window **.
190233
191234.. seealso ::
192235
0 commit comments