From 5bdf143918026a7c68e679808d898cb870755886 Mon Sep 17 00:00:00 2001 From: Emad Rad Date: Sun, 13 Oct 2024 15:54:09 +0330 Subject: [PATCH 1/2] fix: no USER in ASPECTS_ENABLE_PII --- .../how-tos/production_configuration.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/technical_documentation/how-tos/production_configuration.rst b/docs/technical_documentation/how-tos/production_configuration.rst index 4f79538..6c2ee9e 100644 --- a/docs/technical_documentation/how-tos/production_configuration.rst +++ b/docs/technical_documentation/how-tos/production_configuration.rst @@ -166,7 +166,7 @@ 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. However it does not copy over existing users, see :ref:`Backfilling Existing Data` below for more information on how to do that. @@ -256,7 +256,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:: From 5d2f4d140296516da02291f247a7625de3324d7e Mon Sep 17 00:00:00 2001 From: Emad Rad Date: Sun, 13 Oct 2024 15:59:27 +0330 Subject: [PATCH 2/2] chore: command instructions to enable PII added --- .../how-tos/production_configuration.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/technical_documentation/how-tos/production_configuration.rst b/docs/technical_documentation/how-tos/production_configuration.rst index 6c2ee9e..5425961 100644 --- a/docs/technical_documentation/how-tos/production_configuration.rst +++ b/docs/technical_documentation/how-tos/production_configuration.rst @@ -168,6 +168,11 @@ By default Aspects does not store information that can directly link the xAPI le 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. XAPI User Id Type