Internal Tools Overview
Purpose
The purpose of this page is to be a guide to the internal tools that are used within edX to examine or manipulate product-related data, in support of our customers, partners, and internal stakeholders. By nature, this list of tools will be constantly changing along with the needs of our business. So if you know of any tools that should be added or removed from this page, please go ahead and do so, or contact Alan Zarembok (Deactivated) if you are not sure how to proceed.
Internally Developed Tools
The following tools are used in resolving issues in dealing with learner and course issues.
Tool Name | Description | How to Access | Code Repo | Notes |
---|---|---|---|---|
Ecommerce admin tool | Admin tool for viewing courses, coupons, offers | ecommerce.edx.org/courses | ecommerce | UI for each tab currently retrieves all data, should improve this (e.g. search for one partner, etc.). |
This tool includes several tabs: | ||||
Courses | https://ecommerce.edx.org/courses/ | Allows you to edit course type, seats, price, verification deadline. | ||
Coupons | https://ecommerce.edx.org/coupons/ | view/edit coupon info, download report (CSV) on coupon usage | ||
Enterprise Coupons | https://ecommerce.edx.org/enterprise/coupons/ | same as above, for enterprise coupons | ||
Program Offers | https://ecommerce.edx.org/programs/offers/ | view/edit program offers, including start/end dates, discount percentage | ||
Enterprise Offers | https://ecommerce.edx.org/enterprise/offers/ | similar to above, but for enterprise offers | ||
Journal Bundle Offers | https://ecommerce.edx.org/journals/offers/ | Currently has no data--obsolete? | ||
Student support page | Support tool for managing student info (certificates, enrollments, entitlements, etc.) | courses.edx.org/support | edx-platform | django app named support. Should explore the individual tools on this page further. |
This tool includes several tabs: | ||||
Certificates | https://courses.edx.org/support/certificates | View/regenerate certificates | ||
Manual Refund | https://courses.edx.org/support/refund | Issue manual refunds | ||
Enrollment | https://courses.edx.org/support/enrollment | View/update enrollments for given student. | ||
Manage User | https://courses.edx.org/support/manage_user | Enable/disable login for user account. | ||
Entitlements | https://courses.edx.org/support/course_entitlement | View/edit/reissue learner entitlements. | ||
Feature Based Enrollment | https://courses.edx.org/support/feature_based_enrollments | |||
Financial aid suite | View miscellaneous info related to financial aid. | There is a python script that populates a SQL database that lives on Allyson Pyers' laptop. The script takes financial aid requests from zendesk, applies some criteria to approve or disapprove them, and adds them to the database. The financial aid is provided via coupons that Allyson requests from marketing in blocks. | https://github.com/edx/partner-support | |
Video heal tool (in development) | Allow support staff to run heal tool on videos without engineering assistance. | https://github.com/edx/edx-video-pipeline/pull/123/files | Need to investigate what changes would be needed to make this work. Also should consider developing as a micro-frontend. |
Other Tools (e.g. Django admin pages or 3rd party software)
Tool Name | Description | How to Access | Code Repo | Notes |
---|---|---|---|---|
LMS Admin | Misc stuff–videos, proctoring, credit... | courses-internal.edx.org/admin | ||
Discovery Admin | View discovery data–courses, runs, seats, etc. | discovery.edx.org/admin | ||
Credentials Admin | Management of credentials | credentials.edx.org/admin | ||
Proctoring Review Dashboard | Review status of proctored exams | courses-internal.edx.org/admin/edx_proctoring/proctoredexamsoftwaresecurereview | ||
Coursegraph | View course structure in graphical format | coursegraph.edx.org/browser | outdated and broken (ticket?) | |
Instructor tab | For particular course, manage users, enrollment, certificates, etc. | view course from staff acct | not really internal, course instructors can use this | |
Ecommerce dashboard (Oscar) | View information related to ecommerce transactions, e.g. orders, refunds, customers, etc. | ecommerce.edx.org/dashboard | ecommerce | django generated page |
Veda admin tool | monitor processing status, health of pipeline | veda.edx.org/admin | edx-video-pipeline | Login via firefox only |
Flower | Check flow of celery tasks | veda.edx.org:5555 | edx-video-pipeline |
Ideas for Tools to be Built
- List from Jennifer Akana:
- Idea from Corey Miller: slack channel similar to #release-events that would provide information on deployments of all services.
- Idea from Allyson Pyers: entitlements tool should be able to delete entitlements (currently they can be reissued but not deleted)