BI Catalog Management

Overview

The BI Dashboard Catalog in the Admin Panel manages which dashboards are available for users to view. This guide covers the Admin Panel configuration for BI dashboards. Full dashboard creation and chart building is performed in Apache Superset.

Navigation: Settings → Catalogs → BI Dashboards

Data Architecture

timveroOS uses a Data Warehouse (DWH) architecture for BI:

  1. timveroOS stores operational data in the primary database

  2. ETL Process transforms and loads data into the DWH (customized per project)

  3. DWH provides optimized data for reporting

  4. Superset reads directly from the DWH

  5. Admin Panel embeds dashboards from Superset

Note: The data model exposed to Superset is customized via standard ETL tools during implementation. Tables and views available depend on your project's ETL configuration.

Admin Panel Permissions

The Admin Panel provides limited BI-related permissions:

Permission
Description

View BI Menu

Access to embedded dashboards in Admin Panel

View Dashboard Catalog

Browse available dashboards

Edit Dashboard Catalog

Modify dashboard catalog entries

Note: Full Superset configuration (chart creation, dashboard building, SQL queries) is performed in the Superset admin portal, not the Admin Panel.

Dashboard Catalog Management

Understanding the Catalog

The Dashboard Catalog connects Superset dashboards to the Admin Panel interface. Each catalog entry defines:

  • Dashboard name (displayed in Admin Panel menu)

  • Superset dashboard URL/ID

  • Access permissions

  • Display order

Adding a Dashboard to the Catalog

  1. Navigate to SettingsCatalogsBI Dashboards

  2. Click Add

  3. Configure:

    • Name: Display name for the dashboard

    • Dashboard ID/URL: Reference to Superset dashboard

    • Status: Active/Inactive

    • Order: Display position in menu

  4. Click Save

Editing Catalog Entries

  1. Navigate to SettingsCatalogsBI Dashboards

  2. Select the dashboard entry

  3. Modify fields as needed

  4. Click Save

Deactivating Dashboards

To hide a dashboard from users without deleting:

  1. Select the dashboard entry

  2. Set Status to Inactive

  3. Save

Dashboard will no longer appear in the BI menu but configuration is preserved.

Apache Superset Integration

Superset Portal Access

The Superset admin portal runs on a separate custom URL (configured by DevOps). Access Superset for:

  • Creating and editing charts

  • Building dashboards

  • Writing SQL queries

  • Configuring data sources

  • Setting dashboard permissions

  • Scheduling reports

Superset Documentation

All standard Superset features are available as documented at: Apache Superset Documentationarrow-up-right

Available Features in Superset

Chart Creation:

  • Various visualization types

  • Custom SQL queries

  • Calculated metrics

  • Custom aggregations

Dashboard Building:

  • Drag-and-drop layout

  • Interactive filters

  • Dashboard tabs

  • Markdown annotations

Data Sources:

  • Direct database connections

  • SQL query support

  • Virtual datasets

  • Cached queries

Integration Points

The BI Dashboard integrates with:

  • Data Warehouse: Source data repository

  • ETL Process: Data transformation

  • User Management: Access control via catalog

  • Admin Panel: Dashboard embedding

Admin Panel vs Superset Responsibilities

Capability
Admin Panel
Superset

View embedded dashboards

Manage dashboard catalog

Create charts

Build dashboards

Write SQL queries

Configure data sources

Set dashboard permissions

Schedule reports

Best Practices

Catalog Organization

  • Use clear, descriptive dashboard names

  • Group related dashboards logically

  • Set appropriate display order

  • Deactivate rather than delete unused dashboards

Naming Conventions

  • Include dashboard purpose in name

  • Use consistent naming patterns

  • Indicate audience (e.g., "Executive - Portfolio Overview")

Troubleshooting

Dashboard Not Appearing in Admin Panel

Possible Causes:

  • Catalog entry not created

  • Status set to Inactive

  • User lacks View BI Menu permission

  • Incorrect Dashboard ID/URL

Resolution: Verify catalog entry exists and is active, check user permissions.

Dashboard Shows Error

Possible Causes:

  • Superset dashboard deleted or renamed

  • Data source connection issue

  • Dashboard ID mismatch

Resolution: Verify dashboard exists in Superset, check Dashboard ID in catalog entry.

Once configured, see how dashboards are used:

Next Steps

With BI catalog configured, explore:


For advanced Apache Superset features and customization options, refer to the official documentation at https://superset.apache.org/docs/intro/

Last updated

Was this helpful?