From 518dd6a908080288ac992da2a9499b560630ab42 Mon Sep 17 00:00:00 2001 From: Brian Mesick Date: Mon, 16 Dec 2024 16:16:17 -0500 Subject: [PATCH 1/2] docs: Update student profile report columns --- .../data/student_profile_report.rst | 69 +++++++++++++------ 1 file changed, 47 insertions(+), 22 deletions(-) diff --git a/source/educators/references/data/student_profile_report.rst b/source/educators/references/data/student_profile_report.rst index ba1520e1e..3015c9347 100644 --- a/source/educators/references/data/student_profile_report.rst +++ b/source/educators/references/data/student_profile_report.rst @@ -17,54 +17,74 @@ team member and the following columns. .. list-table:: - :widths: 30 70 + :widths: 25 10 65 :header-rows: 1 * - Column + - Required? - Description * - id + - Yes - The user account ID number that the system assigns to each registrant. * - username - - The public username entered by the learner. Usernames are required and - cannot be changed. + - Yes + - The public username entered by the learner. Usernames cannot be changed + except by requesting account deletion. * - name - - The full name entered by the learner. A name is required. Learners can - update this value on the **Account Settings** page. + - Yes + - The full name entered by the learner. Learners can update this value on + the **Account Settings** page. * - email - - The email address entered by the learner. An email address is required. - Learners can update this value on the **Account Settings** page. + - Yes + - The email address entered by the learner. Learners can update this + value on the **Account Settings** page. * - language + - No - This column is included for backward compatibility only. This data is no longer collected during account creation. The selection that a learner makes for language on the **Account Settings** page is not included in this report. * - location + - No - This column is included for backward compatibility only. The selection that a learner makes for **Country** during registration or for **Country or Region** on the **Account Settings** page is displayed in the "country" column of this report. * - year_of_birth - - This value is optional and can be updated on the **Account Settings** - page. + - No + - This column is included for backward compatibility only. The selection + that a learner makes for **Year of birth** on the **Account Settings** + page is explicitly excluded from this report now. * - gender - - This value is optional and can be updated on the **Account Settings** - page. + - No + - This value can be updated on the **Account Settings** page. * - level_of_education - - This value is optional and can be updated on the **Account Settings** - page. For a list of the possible values, see the description of the - `auth_userprofile`_ table's level_of_education column in the - *EdX Research Guide*. + - No + - This value can be updated on the **Account Settings** page. For a list + of the possible values, see the description of the `auth_userprofile`_ + table's level_of_education column in the *EdX Research Guide*. * - mailing_address - - No longer collected during registration. Previously, this value was + - No + - This column is included for backward compatibility only. It is no + longer collected during registration. Previously, this value was optional and was supplied only at registration. * - goals - - This value is optional and is supplied only at registration. + - No + - This column is included for backward compatibility only. It is no + longer collected during registration. Previously, this value was + optional and was supplied only at registration. This is not related + to the course goals feature. * - enrollment_mode + - Yes - Indicates the enrollment track that the learner is enrolled in, such as "audit" or "verified". * - verification_status + - No + - This column is only included if the ID verification feature is enabled + and ``verification_status`` is included in the site's + ``student_profile_download_fields`` setting. - - Indicates whether learners who are enrolled in course tracks that require + Indicates whether learners who are enrolled in course tracks that require ID verification have successfully verified their identities to edX by submitting an official photo ID via webcam. The value in this column is "N/A" for learners enrolled in course tracks that do not require ID @@ -80,19 +100,25 @@ team member and the following columns. current and valid. * - cohort + - No - This column is included only if the course has cohorts enabled. For courses that include learner cohorts, shows the name of the cohort group that is assigned to the learner. If a learner is not assigned to a cohort, the value is ``[unassigned]``. * - team + - No - This column is included only if the course has teams enabled. For courses that include teams, shows the name of the team that the learner belongs to. If a learner has not joined a team, the value is ``[unavailable]``. * - city - - Data for this column is not currently collected on edx.org. + - No + - This column is included for backward compatibility only. Data for this + column is not currently collected. * - country - - Learners are required to specify **Country** during registration, and can - update this value on the **Account Settings** page. + - No + - On some sites, such as edx.org, learners are required to specify + **Country** during registration. By default this is not required. This + value can be updated or set on the **Account Settings** page. .. seealso:: :class: dropdown @@ -102,4 +128,3 @@ team member and the following columns. :ref:`View and download student data` (how-to) :ref:`Access Anonymized Learner IDs ` (how-to) - From 20f7e672ca83a0627be7004c2507ec0a53226cf3 Mon Sep 17 00:00:00 2001 From: Brian Mesick Date: Wed, 8 Jan 2025 16:04:43 -0500 Subject: [PATCH 2/2] docs: Clarify how columns are defined for the report --- .../references/data/student_profile_report.rst | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/source/educators/references/data/student_profile_report.rst b/source/educators/references/data/student_profile_report.rst index 3015c9347..f98ef23f8 100644 --- a/source/educators/references/data/student_profile_report.rst +++ b/source/educators/references/data/student_profile_report.rst @@ -7,13 +7,9 @@ Columns in the Student Profile Report .. tags:: educator, reference The student profile report includes a row for each enrolled learner or course -team member and the following columns. - -.. only:: Open_edX - - The descriptions of columns in the following table apply to edx.org. Required - or optional fields shown to learners during registration and available for - editing in **Account Settings** might vary for Open edX sites. +team member and the following columns. The fields fields that are available for +students to fill out in **Account Settings** (and therefore will be populated +in this report) are configurable in the Open edX site configuration. .. list-table::