Worked Examples
Catalyst Data: End-to-End Sample Workflow
Complete an all-feature retrofit demonstration in Catalyst Data.
Catalyst Data · How-to Guide
Governed entities, indicators, sources, evidence, questions, instruments, datasets, observations, quality, review, query, export, API, access, connectors, and refresh.
Purpose
This end-to-end workflow demonstrates every documented Catalyst Data capability through one fictional resilient-community-retrofit case. The objective is not to prove a real-world conclusion; it is to verify the complete product workflow with controlled data.
Prerequisites
- The current product release
- A new synthetic workspace
- The all-feature CSV and JSON
- No production or private information
- Time to review every checkpoint
Sample data
This article uses a fictional Resilient Community Retrofit Program. The files contain one demonstration row for every documented feature, so each capability can be tested without private or production data.
Download CSV feature examples · Download JSON workspace example
Preview
| # | Feature | Sample action | Expected result | Classification |
|---|---|---|---|---|
| 1 | Entities | create the Community Center entity | a stable entity ID | synthetic-demo |
| 2 | Indicators | define monthly electricity use with unit, method, and direction | a reusable indicator definition | synthetic-demo |
| 3 | Sources | register utility data with publisher, URL, license, retrieval, and citation | a provenance source record | synthetic-demo |
| 4 | Evidence Ledger | attach a bill and meter export to observations | an evidence chain | synthetic-demo |
| 5 | Questions | state whether use fell after weather normalization | a bounded analytical question | synthetic-demo |
The downloadable files include all 20 feature rows.
Procedure
Scenario
A community center is assessing energy, comfort, financing, implementation, evidence, and monitoring needs. Use only the supplied fictional records.
- 1. Entities: create the Community Center entity. Confirm a stable entity ID.
- 2. Indicators: define monthly electricity use with unit, method, and direction. Confirm a reusable indicator definition.
- 3. Sources: register utility data with publisher, URL, license, retrieval, and citation. Confirm a provenance source record.
- 4. Evidence Ledger: attach a bill and meter export to observations. Confirm an evidence chain.
- 5. Questions: state whether use fell after weather normalization. Confirm a bounded analytical question.
- 6. Instruments: define a meter-reading or import instrument. Confirm a versioned collection instrument.
- 7. Datasets: create a monthly-energy dataset. Confirm a registered dataset.
- 8. Observations: enter January through March kWh with time, source, and status. Confirm traceable observations.
- 9. Units and Methods: define kWh and the normalization method. Confirm explicit unit and method records.
- 10. Quality Rules: flag negative, duplicate, missing, or out-of-range values. Confirm quality findings.
- 11. Review and Revision: correct a duplicate while preserving history. Confirm a revision record.
- 12. Persistent Workspaces: save datasets, views, queries, and notes. Confirm a reusable workspace.
- 13. Saved Queries: save a query for reviewed monthly observations. Confirm a versioned query.
- 14. Comparison Studio: compare baseline and retrofit months. Confirm a normalized comparison.
- 15. Export Studio: freeze the reviewed comparison into CSV, JSON, brief, and manifest. Confirm an integrity-protected export.
- 16. Public API: return approved energy observations. Confirm scoped structured data.
- 17. Embeds: embed an approved energy trend table. Confirm a controlled visualization.
- 18. Institutional Access: give reviewers access without publication rights. Confirm role-aware permissions.
- 19. Connectors: retrieve a public utility or indicator feed. Confirm a logged connector run.
- 20. Refresh Operations: refresh tariff data and reconcile exceptions. Confirm a refresh record and exception queue.
Save and review
- Save the final workspace under the sample workspace ID.
- Close and reopen it in a clean session.
- Compare every feature result with the sample expected_result field.
- Document unresolved differences and do not hide warnings.
- Export one complete artifact bundle.
- Send one supported handoff to an integration and verify its receipt.
Supported integrations
- Catalyst Analytics R
- Research Lab
- Decision Studio
- Site Intelligence
- Knowledge Library
- Platform Core
Expected output
- a stable entity ID
- a reusable indicator definition
- a provenance source record
- an evidence chain
- a bounded analytical question
- a versioned collection instrument
- a registered dataset
- traceable observations
- explicit unit and method records
- quality findings
- a revision record
- a reusable workspace
- a versioned query
- a normalized comparison
- an integrity-protected export
- scoped structured data
- a controlled visualization
- role-aware permissions
- a logged connector run
- a refresh record and exception queue
- A complete saved workspace
- A portable export
- A validated cross-product handoff receipt
Verification
- Every CSV feature row has a corresponding saved result.
- The JSON workspace ID and product version are preserved.
- The export can be inspected without temporary browser state.
- The receiving product identifies source, destination, schema, artifact, and review state.
- A human reviewer can reproduce or audit the demonstration.
Responsible use
Governed data is not automatically true or fit for every purpose; preserve source rights, privacy, definitions, uncertainty, and review.
Replace synthetic data only with information you are authorized to use, after reassessing licensing, privacy, uncertainty, and review obligations.