HyperPBIBuild analytics onceGitHub

Dashboard examples

HyperPBI includes eight complete, deterministic dashboards that run through the same schema, data, and rendering pipeline in the unified website, the Playground, and Power BI. Browse live previews at /examples; the source-of-truth manifest is examples/dashboards/manifest.json.

Included dashboards

Use caseFolderProfileDesign focus
Recruiting and workforce analyticstalent-acquisitionCoreApplication flow, candidate mix, open roles, and applicant detail
Construction and capital-program controlcapital-project-controlsCoreProject identity, earned value, progress gauges, and cost composition
Retail, ecommerce, and cash-flow monitoringretail-sales-operationsCoreRevenue trends, product categories, recent orders, and settlements
Urban mobility operationsurban-mobility-command-centerMapsFleet locations, status, demand, battery health, and busy routes
Patient-care operationspatient-care-operationsCoreEncounters, alerts, response time, department load, and patient detail
Consumer bankingdigital-banking-overviewCoreBalances, debit and credit activity, expense mix, and transactions
Digital media and website analyticsmedia-web-performanceCoreConversions, sessions, engagement, channels, and live locations
Industrial network monitoringindustrial-network-telemetryCoreThroughput, latency, uptime, alerts, site ranking, and telemetry

Each folder is self-contained:

  • specification.json is a strict HyperPBI dashboard schema 2.0 document.
  • runtime.json is Runtime Configuration protocol 1.0.
  • data.csv is deterministic synthetic data with portable lowercase field names.
  • project.hyperpbi contains the complete offline Playground project, including normalized data and stable row keys.
  • README.md explains expected behavior, limitations, source fields, and host-specific loading.

Use an example in the Playground

  1. Open /examples in the unified website.
  2. Choose a dashboard to see its live shared-runtime preview and portability notes.
  3. Select Load in Playground to import a new local copy and open its project workspace.
  4. Edit, validate, preview, and export the project normally.

Alternatively, open /playground and import the folder's project.hyperpbi file. The import creates a new browser-local project ID; it does not change the checked-in example. A .hyperpbi project bundle is a Playground artifact and is not imported by Power BI.

Use an example in Power BI

  1. Build or obtain the package profile declared by the example:
    • Run npm run package:core for every example except Urban Mobility.
    • Run npm run package:maps for Urban Mobility. Its OpenStreetMap basemap needs the package's declared WebAccess hosts and network access.
  2. In Power BI Desktop, import the appropriate .pbiviz package and add HyperPBI to the report canvas.
  3. Import the example's data.csv as one table.
  4. Add every CSV column to HyperPBI's single Values field well. Keep the simple lowercase headers unchanged.
  5. Paste runtime.json into Runtime Configuration.
  6. Paste specification.json into Advanced JSON, validate and preview it, then save.

Every logical dataset in these examples starts from the host-neutral powerbi alias, so the same specification resolves the uploaded CSV in the Playground and the visual data view in Power BI. Each CSV remains below the visual's 50-field mapping limit and 30,000-row data window. Power BI still controls the received query grain, relationships, field summarization, and identity selection.

The Core profile has no external-provider WebAccess. The Maps profile is required only where a dashboard uses approved basemap, geocoding, ArcGIS, GeoJSON, or XYZ network access. Do not put credentials or private service tokens in example JSON.

Regenerate and verify

From the repository root:

npm run examples:generate
npm run examples:check

Generation is deterministic. The check verifies the manifest and required files, strict schema preparation, CSV field and row limits, direct Power BI portability, project-bundle import, and byte-equivalent regeneration from the host-neutral template helper.

When adding an example, create one use-case-named folder, keep all field references portable to the single Power BI data view, declare the correct package profile, and add the entry to the manifest. Implement generally useful behavior in the shared runtime rather than hiding an example-specific workaround in its specification.