10. Epic - Tab Content: Reports

[edschema]

Description

• Reports tab is only visible if Aspects is enabled on the instance.
• Aspects installs a platform plugin.
• Filter that renders the iFrame within the dashboard here

Spec

• The tab has a header that says "Reports"
  • this tab is only visible if Aspects is enabled on the instance
• There is a button in-line to view the reports dashboard in Superset: "View Dashboards in Superset"
• The content renders within an iFrame in the main content area

[bmtcril]

Please note that this tab is currently injected by an openedx filter on the platform side and rendered with a mako template. I assume that will all need to be changed to MFE plugin slots for the tab and content. I don't know what the scope of the conversion project is, but we can work with you to make sure the new slots are testable with Aspects if this task becomes just adding the necessary slots.

The filter to inject the tab is here:
https://github.com/openedx/platform-plugin-aspects/blob/main/platform_plugin_aspects/extensions/filters.py

The template to render the "View dashboards in Superset" link and embed the report iframe is here:
https://github.com/openedx/platform-plugin-aspects/blob/main/platform_plugin_aspects/templates/instructor_dashboard/aspects.html

[bmtcril]

Are there any updates on this one? Do we still think this will make Willow?

[sarina]

Following this issue, would love an update ASAP. Now that inst dash is on-by-default we need a plan here. If the plan is "for Aspects reports in inst dash, you need to set LEGACY_INSTRUCTOR_DASHBOARD to True" we need this notated in the operator docs.

[holaontiveros]

Hi @sarina I just started working this, the plan for now it's to have a filter like thing so anyone can add tabs to the endpoint consumed by the new instructor dashboad that would allow to configure the details for the tab (name, url, etc...) so they can point to a specific URL and then either use a full frontendbase app or a slot to display the thing they need to display

[holaontiveros]

@bmtcril in case you want tot take a look for aspects the new filter is already created, and during the day I'll have the code for edx-platform ready

but basically you'll have to use the new filter to config a new tab for the v2 API and configure a widget for the tab slots which will match the url :tabid and handle whatever you need in there