Dashboards and BI
Superset dashboards on your tenant data, opened inside Beetl.
Dashboards in Beetl are Apache Superset dashboards that read your tenant's datasets and open inside the app. They are the place for charts you want to keep and share. A chart drawn on a query result is not saved (see Result charts), while a dashboard stays available to everyone in the tenant. You build dashboards in Superset (see the Superset user docs), and Beetl lists and displays them.
Setting up dashboards
Dashboards are an optional add-on for each tenant. Until they are set up, the Dashboards item in the sidebar is greyed out, and hovering over it shows "Dashboards is not configured — set it up in Settings." A direct link to a dashboard page leads to a page-not-found screen.
A TenantAdmin sets them up under Settings → Tenant → Dashboards:
Ask Beetl for the URL and an API key of the Superset instance prepared for your tenant. Dashboards work with a Superset that Beetl has set up to read from your tenant.
Enter the URL and API key, then choose Register.
Wait for the status badge to show Active. Beetl adds a database for your tenant's data to that Superset, and the Dashboards item in the sidebar becomes available.
| Control | What it does |
|---|---|
| Register / Replace | Saves the URL and API key. The key is write-only. To keep the current key when you replace the configuration, leave the field empty; a new URL needs the key again. |
| Status badge | Pending while the connection is not ready, Active once dashboards can be used. |
| Retry provisioning | Shown while the status is not Active. Runs the setup again, for example after Superset was unreachable. |
| Remove | Turns dashboards off for the tenant. The dashboards themselves stay in Superset. |
Making a dashboard appear in Beetl
You author dashboards in Superset. A dashboard shows up in Beetl only when all of these are true in Superset:
- It is published, not a draft.
- Every chart on it uses datasets from your tenant's Beetl database. A single chart from any other database keeps the whole dashboard out of Beetl.
- Embedding is turned on for it.
The last condition is the one most often missed: a published dashboard without embedding does not appear. Superset embedding walks through publishing and embedding. Beetl asks Superset for the list each time you open Dashboards, so a change shows up on your next visit.
Browsing and opening dashboards
Choose Dashboards in the sidebar to see a card for each dashboard, by title. If none qualify, the page shows "No embedded dashboards" with a reminder to publish a dashboard and enable embedding for it.
Opening a card shows the dashboard at full height, with its title in the header and a back arrow to the list. Superset's filter bar is available and starts collapsed. If a dashboard stops qualifying, for example because it went back to draft, its page shows "Dashboard not found".
Who sees which dashboards
Every user in the tenant, TenantAdmin or TenantUser, sees every dashboard that meets the conditions above. Beetl has no per-dashboard permissions, so publish and embed a dashboard only when the whole tenant may see it. Viewing a dashboard in Beetl does not need a Superset account. Only a TenantAdmin can change the dashboard settings; see Tenants and roles.
What Superset can read
Superset sees the same datasets you can query in Query, including external datasets. It reads only your tenant's data and cannot change it. Charts read the datasets themselves, so they are not cut to the 1,000 rows a saved query result keeps. To show a reshaped or aggregated table, write it to a dataset with a pipeline and chart that dataset.
In this section
| Page | What it covers |
|---|---|
| Superset embedding | Connecting Superset, enabling embedding, and authoring dashboards that appear in Beetl. |
Related
Last updated on