Add enrollment date and custom fields to students profile information CSV

[igobranco]

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.

Other information

None.

[openedx-webhooks]

Thanks for the pull request, @igobranco!

What's next?

Please work through the following steps to get your changes ready for engineering review:

:radio_button: Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

• If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
  • This process (including the steps you'll need to take) is documented here.
• If it doesn't, simply proceed with the next step.

:radio_button: Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

• Dependencies

  This PR must be merged before / after / at the same time as ...

• Blockers

  This PR is waiting for OEP-1234 to be accepted.

• Timeline information

  This PR must be merged by XX date because ...

• Partner information

  This is for a course on edx.org.

• Supporting documentation
• Relevant Open edX discussion forum threads

:radio_button: Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

:radio_button: Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/wg-maintenance-edx-platform. Tag them in a comment and let them know that your changes are ready for review.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

• The size and impact of the changes that it introduces
• The need for product review
• Maintenance status of the parent repository

:bulb: As a result it may take up to several weeks or months to complete a review and merge your PR.

[e0d]

@jmakowski1123 and @ProductRyan do you feel like there should be a product review for this? If not, which team owns instructor reports?

[mphilbrick211]

@jmakowski1123 and @ProductRyan do you feel like there should be a product review for this? If not, which team owns instructor reports?

Hi @jmakowski1123 and @ProductRyan - flagging Ed's question for you. Thanks!

[mphilbrick211]

@jmakowski1123 and @ProductRyan do you feel like there should be a product review for this? If not, which team owns instructor reports?

Hi @jmakowski1123 and @ProductRyan - flagging Ed's question for you. Thanks!

Friendly follow-up on this @jmakowski1123 and @ProductRyan

[jmakowski1123]

Product Feature Review ticket created and assigned to Spencer, I believe he owns the instructor reports. https://github.com/openedx/platform-roadmap/issues/281

[mphilbrick211]

Hi @igobranco! Please see Spencer's questions here.

[mphilbrick211]

Hi @igobranco! Do you plan to pursue this pull request? If so, it looks like some new checks need to be run. Thanks!