Skip to content

Commit

Permalink
fix: wrong variable name to enable PII (#283)
Browse files Browse the repository at this point in the history
* fix: no USER in ASPECTS_ENABLE_PII

* chore: command instructions to enable PII added
  • Loading branch information
CodeWithEmad authored Oct 15, 2024
1 parent 3f16f14 commit 94bcdfa
Showing 1 changed file with 7 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,12 @@ Personally Identifiable Identification

By default Aspects does not store information that can directly link the xAPI learning traces to an individual's name, email address, username, etc. Storing this information has potential legal consequences and should be undertaken with careful consideration.

Setting ``ASPECTS_ENABLE_USER_PII`` to ``True``, then running Tutor init for the Aspects plugin, turns on the ability to send user data to ClickHouse. When turned on this populates the ``event_sink.external_id`` and ``event_sink.user_profile`` tables as new users are created.
Setting ``ASPECTS_ENABLE_PII`` to ``True``, then running Tutor init for the Aspects plugin, turns on the ability to send user data to ClickHouse. When turned on this populates the ``event_sink.external_id`` and ``event_sink.user_profile`` tables as new users are created.

.. code-block:: bash
tutor config save -s ASPECTS_ENABLE_PII=true
tutor dev|local|k8s do init -l aspects
However it does not copy over existing users, see :ref:`Backfilling Existing Data` below for more information on how to do that.

Expand Down Expand Up @@ -256,7 +261,7 @@ There is a management command to populate course data for one, all, or a subset
tutor local run lms ./manage.py lms dump_data_to_clickhouse --object course_overviews
If you are running with ``ASPECTS_ENABLE_USER_PII`` set to ``True`` you will need to populate the user PII data with these commands:
If you are running with ``ASPECTS_ENABLE_PII`` set to ``True`` you will need to populate the user PII data with these commands:

.. code-block::
Expand Down

0 comments on commit 94bcdfa

Please sign in to comment.