Status: Product definition

Overview

In order to have the information necessary to constantly improve Open edX, the "Survey Report" project was created. This project allows administrators to send anonymized information about their initiatives. This information is received by axim and among other uses it feeds the annual report.

The report contains:

• Total number of active unique courses.

• Total number of recently active users with login in the last 4 weeks.

• Total number of users ever registered in the platform.

• Total number of active enrollments in the platform.

• Total number of generated certificates.

• Extra information that admins can configure to send along (the current version in master contains no info here and there have been discussions about adding the release version or the site name. No decision has been reached)

Generating a report is currently done in the admin panel under /admin/survey_report/surveyreport/. It is available since the Palm release

Problem

We need data about the usage of instances of Open edX to be able to make decisions. This means we would like instance admins to ideally send the survey report twice a year.

Sending the report today is done by clicking a button in the admin panel and is performed by an async task so as to not block any processes during the count operations. However the feature is new and relatively unknown.

Key Use Cases

• As an administrator I want to send the survey report of my initiative that uses Open edX.

• As an administrator I do not want to send the survey report of my initiative that uses Open edX.

• As an operator I don’t want to be asked ever about sending the survey report.

Solution

We propose the implementation of announcement functionality that work similarly to the Wikipedia fundraising banner. Two times a year the administrators with the is_superuser flag will be presented with a banner explaining what the report is, who it is sent to, what do we do with it and asking that they create one. A call to action will let them create the report immediately and also a button will allow them to close the banner.

The banner would have the following message:

The Open edX Project relies on the collective strength of its community to be a thriving platform for online education.

Open edX is a dynamic ecosystem and it is used in diverse learning environments. By sharing anonymized reports of aggregated data, you can contribute to the collective knowledge of the community. This data can help us all understand the reach of our project, make better decisions and ultimately support innovation in lifelong learning and advance next generation learning experience platforms.

We invite you to join the Open edX Data Sharing Initiative by sharing an anonymized reports of aggregated data from your institution's usage of the platform. The report data will be sent to Axim Collaborative, the non-profit behind the Open edX project.

If you agree and want to send a report you can click the button below. You can always send reports and see the status of reports you have sent in the past at /admin/survey_report/surveyreport/.

[Send report button]
[I don’t want to send the Survey. Don’t show me this]

This banner would be shown to users when the following conditions are met:

1. there is no report generated in the last 6 Months.

2. the user has both the is_staff and is_superuser flags set as true.

3. the user is navigating any page in the /admin/* path.

4. there is no record of the message being dismissed in the last 6 Months
   

Access to this functionality by roles in the LMS or Studio admin panels