Add enrollment date and custom fields to students profile information CSV

[jmakowski1123]

Abstract

For Contributing Author:

This is the Primary Product Ticket for the following community contribution: Add enrollment date and custom fields to students' profile information

Checklist prior to undergoing Product Review:

The following information is required in order for Product Managers to be able to review your pull request:

• Explanation of the problem being solved
• Description of how users will be impacted, and which users will be impacted
• Screenshots or video showing the functionality or fix, before and after
• Reproduction steps and/or testing steps

Only if necessary:

• If necessary, links to corresponding configuration changes
• If necessary, links to corresponding enablement changes, particularly waffle/toggle status details

Related PRs

• Add enrollment date and custom fields to students profile information CSV edx-platform#32216

For Product Manager doing the review:

What criteria should be analyzed from Product to approve a PR?

• The problem being solved by the feature or fix is clear.
• There is clarity on how the change or fix will impact the end user.
• It is clear that the change will not negatively impact users or other areas of the platform.
• The change is implemented comprehensively.
• Any changes to UI use the current, standard Paragon Design System: https://paragon-openedx.netlify.app/

[github-actions]

Thanks for your submission, @openedx/open-edx-project-managers will review shortly.

[jmakowski1123]

Description
This pull request refactors the query of the students profile information CSV so it retrieves the CourseEnrollment object and adds by default the enrollment date on the CSV.
This change as direct impact to "Course Author" that have the "Data Researcher" role because they can better understand when its students have been enrolled in the course.

Additionally, another improvement has been implemented on the same use case. That allows site operators to include on the export custom fields if the platform has an extending User model. This can be used if you have an extended model that include for example an university student number and Site Operator want to export the student number on the student profile information CSV.

The pull request has impact on the use case: LMS > Course > Instructor > Data download > Download profile information as a CSV

Supporting information
None.

Testing instructions
LMS > Course > Instructor > Data download > Download profile information as a CSV

Open a course on the LMS, open the Instructor tab, select Data download and then click on the button Download profile information as a CSV. If you are running on the Devstack the exported file should be on the /tmp/edx-s3 folder inside the LMS container.

Example:

make dev.shell.lms
cat /tmp/edx-s3/grades/bb6d638a296059742509a0d319ddf8456b6dbf9a/edX_DemoX_Demo_Course_student_profile_info_2023-05-09-1149.csv
Deadline
None
I think this features can be easily backported to Palm and Olive.

[mphilbrick211]

Hi @spencertiberi! Just seeing if you've had a chance to take a look at this?

[spencertiberi]

Hi! So for clarity sake, this doesn't change permissions in anyway, no? Are there any added PII concerns? And how are the custom fields configured?

[igobranco]

Hi! So for clarity sake, this doesn't change permissions in anyway, no? Are there any added PII concerns? And how are the custom fields configured?

@spencertiberi No it doesn't change the permissions in anyway. By default it will add the enrollment_date of the student to the students profile information CSV. Given the fact that the CSV already has more sensive PPI in it, I think the enrollment date is irrelevant.

To add more custom fields to the CSV, you need to change your site configuration settings:

• student_profile_download_fields
• student_profile_download_fields_custom_student_attributes

And add that attribute to the User.

Please view this comment on the PR that explains on how to do this:
openedx/edx-platform@f9bfde2#diff-e74a04be02f2ed67823d2690541749f076e667da6160430d741d05be75ac2243R89-R131

[jmakowski1123]

@spencertiberi This looks ok to me. The profile already contains other timestamp related information such as last login, and I think enrollment date would fall under the same umbrella. If we don't hear back from you by Dec 20, we'll assume this is approved.

[ali-hugo]

@jmakowski1123 I see this is tagged as "needs product review" - should it perhaps be moved to "product review done"?

---

EDIT:
I updated the status. Please move it back if necessary. 🙂