I need reports emailed to me. How do I set that up?

This article describes the steps needed to acquire learner reports via email.

The edX Admin Portal allows you to configure your own catalog metadata, and learner progress reports for receipt on a cadence of your choosing, delivered as a password-protected compressed (ZIP) file in JSON or CSV format via email (SMTP) or secure file transport (SFTP).

To configure these reports, follow the instructions below:

1. Login to the edX Admin Portal: https://portal.edx.org/ using your admin account 
2. Using the Left toolbar, navigate to Reporting Configurations (contact your edX Account Management representative if you need help obtaining access to this feature). 
3. Select "Add a reporting configuration"

4. Complete the fields required for the configuration, as follows:

   • • • Active:  Checking this box will ensure the report is sent. This can be unchecked at later time if you do not wish to receive the report anymore

       • Data Type:  The type of report you want to receive.

         • • Catalog: This will send a catalog metadata report, including all of the courses available to your organization in your edX Curated Catalog 

           • Progress:  This will send a learner progress report with information about the courses learners at your organization are enrolled in.

       • Delivery Method:  The transmission mechanism to use for delivery of the report, which can be either Email or SFTP.  Regardless of the selection, the report file will be delivered as a password-protected compressed (ZIP) file.

       • Report Type:  The representation format to use, which can be either CSV or JSON

       • Frequency:  The interval for which to deliver the report, which can be either daily, weekly, or monthly.

         • • Day of Month:  The day of the month to send the report (Required and only valid when the frequency is monthly)

           • Day of Week:  The day of the week to send the report (Required and only valid when the frequency is weekly)

           • Hour of Day: The hour of the day to send the report, in Eastern Time (24-hour format). This field is required for all frequency settings

5. If your chosen Delivery Method is email, you will also need to complete the following fields
   • • • Email(s):  The email addresses where the report should be sent. Please include one address per line
       • Password:  This password will be used to secure the compressed (ZIP) file. Please specify the password in clear-text format.  It will be encrypted by the edX system when stored in the database.  If lost, you will need to submit a new password.
6. If your chosen Delivery Method is SFTP, you will also need to complete the following fields
   • • • SFTP Host Name:  The host name of the SFTP service to deliver the report.  Please provision a unique SFTP service account specifically for edX’s use.
       • SFTP Port Number: The connection port made available by the SFTP service.  The standard port number for SFTP services is 22.
       • SFTP Username: The service username used to securely access the SFTP service. Please provision a unique SFTP service account specifically for edX’s use.
       • Decrypted SFTP Password:  The service password used to security access the SFTP service. Specify the password in clear-text format. If lost, you will need to submit a new password.
       • SFTP File Path: The path (directory) on the SFTP service to store the report file. 
7. If your chosen Data Type is catalog, you will also need to complete the following fields
   • • • Enterprise Customer Catalogs: Select which catalogs should be included in your report. If left blank, all catalogs will be included. 
8. Submit and wait for your report! 

For more information or assistance with Report Configuration, submit a support ticket to enterprise-support@edx.org, or reach out to your account manager (where applicable)