Technical Reference
Catalyst Data: Technical Reference and Integrations
Review the technical, data, lifecycle, validation, and integration contract for Catalyst Data.
Catalyst Data · Technical Reference
Governed entities, indicators, sources, evidence, questions, instruments, datasets, observations, quality, review, query, export, API, access, connectors, and refresh.
Purpose
This reference summarizes the functional contract, record expectations, lifecycle, validation, export, compatibility, integration, privacy, and release-review requirements for Catalyst Data.
Prerequisites
- Current release notes and repository documentation
- A test environment
- A backup and rollback plan
- Access to product health or package checks
- The synthetic all-feature sample
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.
Technical contract
Canonical identity
| Field | Value |
|---|---|
| Product slug | catalyst-data |
| Product name | Catalyst Data |
| Verified version | 1.11.0 |
| Content pack | 1.0.0 |
| Default article state | draft |
| Human review | required |
Functional surface
| Capability | Sample operation | Expected artifact |
|---|---|---|
| Entities | create the Community Center entity | a stable entity ID |
| Indicators | define monthly electricity use with unit, method, and direction | a reusable indicator definition |
| Sources | register utility data with publisher, URL, license, retrieval, and citation | a provenance source record |
| Evidence Ledger | attach a bill and meter export to observations | an evidence chain |
| Questions | state whether use fell after weather normalization | a bounded analytical question |
| Instruments | define a meter-reading or import instrument | a versioned collection instrument |
| Datasets | create a monthly-energy dataset | a registered dataset |
| Observations | enter January through March kWh with time, source, and status | traceable observations |
| Units and Methods | define kWh and the normalization method | explicit unit and method records |
| Quality Rules | flag negative, duplicate, missing, or out-of-range values | quality findings |
| Review and Revision | correct a duplicate while preserving history | a revision record |
| Persistent Workspaces | save datasets, views, queries, and notes | a reusable workspace |
| Saved Queries | save a query for reviewed monthly observations | a versioned query |
| Comparison Studio | compare baseline and retrofit months | a normalized comparison |
| Export Studio | freeze the reviewed comparison into CSV, JSON, brief, and manifest | an integrity-protected export |
| Public API | return approved energy observations | scoped structured data |
| Embeds | embed an approved energy trend table | a controlled visualization |
| Institutional Access | give reviewers access without publication rights | role-aware permissions |
| Connectors | retrieve a public utility or indicator feed | a logged connector run |
| Refresh Operations | refresh tariff data and reconcile exceptions | a refresh record and exception queue |
Core record fields
- Stable record or artifact ID
- Product and schema version
- Created and updated time
- Owner or responsible role
- Lifecycle or review state
- Source and provenance
- Units, period, geography, classification, or audience where applicable
- Validation findings and uncertainty
- Privacy and publication boundary
- Export or handoff integrity metadata
Lifecycle
Use a human-controlled lifecycle such as draft → review → approved/published, with revise, superseded, archived, withdrawn, failed, and recovered states where appropriate. Automated analysis may recommend; it must not silently approve, publish, or create private cases.
Validation
- Required-field and type checks
- Identifier and relationship checks
- Unit, period, geography, method, and classification compatibility
- Product and schema compatibility
- Source, evidence, and provenance completeness
- Permission, privacy, and publication-boundary checks
- Deterministic checksum or fingerprint validation for portable artifacts
Integrations
- Catalyst Analytics R
- Research Lab
- Decision Studio
- Site Intelligence
- Knowledge Library
- Platform Core
Send the minimum required fields through a typed contract. Preserve source product, destination, schema, artifact ID, review state, provenance, consent or privacy boundary, and receipt. Private Contact and Engagement records never belong in public support or research artifacts.
Release review
- Confirm interface, service, manifest, package, and schema versions.
- Validate the all-feature sample.
- Run product tests and integrity checks.
- Test one export and each supported handoff category.
- Document breaking changes and migration path.
- Update Last Verified Version before publishing this article.
Expected output
- A complete feature contract
- A validated synthetic export
- A compatibility decision
- A documented integration receipt
- A release-integrity report
Verification
- Product slug, version, schema, and IDs agree.
- Every documented feature maps to an actual interface, command, route, or record.
- The sample files produce the stated artifacts.
- Integrations preserve provenance and privacy.
- Migration, rollback, support, and release documentation are current.
Responsible use
Governed data is not automatically true or fit for every purpose; preserve source rights, privacy, definitions, uncertainty, and review.