Skip to content

Commit 6199684

Browse files
feat: document how to share pii to lti components (#1368)
* feat: document how to share pii to lti components The setting to share user emails and usernames with LTI components is behind a flag that can be set from the Django admin. Add documentation for how to set this flag. Private-ref: https://tasks.opencraft.com/browse/BB-6337 * fixup! feat: document how to share pii to lti components Add links and chart in response to review
1 parent 2a0b6dc commit 6199684

5 files changed

Lines changed: 46 additions & 6 deletions

File tree

12.7 KB
Loading
5.46 KB
Loading
37 KB
Loading
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
.. _Allow sharing PII to LTI Components:
2+
3+
Allow sharing PII to LTI Components
4+
###################################
5+
6+
.. tags:: site operator, how-to
7+
8+
The LTI component block has settings to share the user's email or username with the LTI application.
9+
By default, these settings are disabled for privacy reasons.
10+
The settings may be enabled per-course by an administrator, using the Django admin console:
11+
12+
#. With a system administrator account, navigate to the django admin console, and find the "Course allow pii sharing in lti flags" item.
13+
Click the text on the left for the item to navigate to the page with the list of these flags.
14+
From this page, you can add, modify, or delete flags.
15+
16+
.. image:: /_images/site_ops_how_tos/lti_pii_sharing_admin_1.png
17+
:alt: A screenshot of the Django admin console showing the "Course allow pii sharing in lti flags" menu item.
18+
19+
#. Click the button to add a new flag:
20+
21+
.. image:: /_images/site_ops_how_tos/lti_pii_sharing_admin_2.png
22+
:alt: A screenshot of the Django admin console showing the button to "add course allow pii sharing in lti flag".
23+
24+
#. In the new flag form, enter the ID for the course you wish to enable this for, and ensure the "Enabled" field is checked.
25+
26+
.. image:: /_images/site_ops_how_tos/lti_pii_sharing_admin_3.png
27+
:alt: A screenshot of the Django admin console showing the form to add an enabled flag for a particular course id.
28+
29+
#. Finally, save the form.
30+
31+
.. seealso::
32+
33+
:ref:`LTI Component settings` (reference)
34+
35+
**Maintenance chart**
36+
37+
+--------------+-------------------------------+----------------+--------------------------------+
38+
| Review Date | Working Group Reviewer | Release |Test situation |
39+
+--------------+-------------------------------+----------------+--------------------------------+
40+
| | | | |
41+
+--------------+-------------------------------+----------------+--------------------------------+

source/educators/references/course_development/exercise_tools/lti_component_settings.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -171,10 +171,9 @@ LTI Component Settings
171171
launches, the learners are warned that if they continue, their email
172172
address will be shared with the LTI provider.
173173

174-
175174
By default, this setting is not available in Studio.
176-
To make this setting available, a system administrator must enable the
177-
setting in the Django administration console.
175+
See :ref:`Allow sharing PII to LTI Components` for how to enable
176+
(requires system administrator privileges).
178177

179178
* - Request user's username
180179
- Sends the learner's username to the remote LTI tool. This is the
@@ -186,9 +185,8 @@ LTI Component Settings
186185
will be shared with the LTI provider.
187186

188187
By default, this setting is not available in Studio.
189-
190-
To make this setting available in Studio, a system administrator must
191-
enable the setting in the Django administration console.
188+
See :ref:`Allow sharing PII to LTI Components` for how to enable
189+
(requires system administrator privileges).
192190

193191
.. seealso::
194192

@@ -202,6 +200,7 @@ LTI Component Settings
202200

203201
:ref:`Enabling and using LTI Advantage features` (how-to)
204202

203+
:ref:`Allow sharing PII to LTI Components` (how-to)
205204

206205
**Maintenance chart**
207206

0 commit comments

Comments
 (0)