Option to Specify Which Tab of a Dashboard to Send in Apache Superset Reports

[aprendizlaura]

Hello,

I have a question about the behavior of reports in Apache Superset when dealing with dashboards that have multiple tabs.

Does anyone know if it is possible to specify which tab of a multi-tab dashboard is included when sending reports? Currently, it seems that only the first tab (which is the default one that opens) is sent in the report.

I have tried adding the following feature flag "ALERT_REPORT_TABS": True, but it still only sends the first tab.

Thank you!

[dosubot[bot]]

Yes, it is possible to specify which tab of a multi-tab dashboard is included when sending reports in Apache Superset. This is done through the extra field in the report schedule configuration, where you can specify the dashboard_state including activeTabs and anchor.

Here is the relevant code snippet:

def _validate_report_extra(self, exceptions: list[ValidationError]) -> None:
    extra: Optional[ReportScheduleExtra] = self._properties.get("extra")
    dashboard = self._properties.get("dashboard")
    if extra is None or dashboard is None:
        return

    dashboard_state = extra.get("dashboard")
    if not dashboard_state:
        return

    position_data = json.loads(dashboard.position_json or "{}")
    active_tabs = dashboard_state.get("activeTabs") or []
    anchor = dashboard_state.get("anchor")
    invalid_tab_ids = set(active_tabs) - set(position_data.keys())
    if anchor and anchor not in position_data:
        invalid_tab_ids.add(anchor)
    if invalid_tab_ids:
        exceptions.append(
            ValidationError(
                _("Invalid tab ids: %s(tab_ids)", tab_ids=str(invalid_tab_ids)),
                "extra",
            )
        )

This code validates the extra field to ensure that the specified activeTabs and anchor are valid tab IDs within the dashboard's position_data ^[1].

For more detailed examples, you can refer to the integration tests for dashboard reports with tabs, which demonstrate how to create a report schedule with specific active tabs and validate the generated permalink and email notifications ^[2][3].

To continue talking to Dosu, mention @dosu.

[aprendizlaura]

@dosu How should I proceed if I want all the tabs of my dashboard to be included when sending a report via email? I have tried setting the feature flag "ALERT_REPORT_TABS": True, but it still only sends the first tab. Are there additional configurations needed, or is there a specific way to set up the report schedule to achieve this?

[dosubot[bot]]

To include all tabs of your dashboard when sending a report via email, you need to configure the extra field in the report schedule to specify all the tabs. Here’s how you can do it:

1. Enable the Required Feature Flags:
   Ensure that both ALERT_REPORTS and ALERT_REPORT_TABS feature flags are enabled in your superset_config.py:

   FEATURE_FLAGS = {
       "ALERT_REPORTS": True,
       "ALERT_REPORT_TABS": True,
   }

2. Modify the extra Field:
   Update the extra field in the report schedule configuration to include all the tabs. Here’s an example of how to structure it:

   extra = {
       "dashboard": {
           "activeTabs": ["tab1", "tab2", "tab3"],  # List all tab IDs here
           "anchor": "tab1"  # Optionally, specify the anchor tab
       }
   }
   
   # Assuming `self._properties` is the dictionary containing the report schedule configuration
   self._properties["extra"] = extra

3. Create or Update the Report Schedule:
   When creating or updating the report schedule, ensure the extra field is set correctly. Here’s an example within the CreateReportScheduleCommand class:

   class CreateReportScheduleCommand(CreateMixin, BaseReportScheduleCommand):
       def __init__(self, data: dict[str, Any]):
           self._properties = data.copy()
           self._properties["extra"] = {
               "dashboard": {
                   "activeTabs": ["tab1", "tab2", "tab3"],  # List all tab IDs here
                   "anchor": "tab1"  # Optionally, specify the anchor tab
               }
           }
   
       @transaction(on_error=partial(on_error, reraise=ReportScheduleCreateFailedError))
       def run(self) -> ReportSchedule:
           self.validate()
           return ReportScheduleDAO.create(attributes=self._properties)

By following these steps, you can ensure that all tabs of your dashboard are included when sending a report via email ^[1].

To continue talking to Dosu, mention @dosu.