Reference Materials

Detailed specifications and reference documentation for SDCStudio.

Available References

Markdown Template Format

Authoritative reference for the Markdown template format consumed by the md2pd parser: - YAML front matter and the eight named-tree sections - Column format and the keyword allowlist - Type system (explicit SDC4 types and user-friendly types) - Type-inference rules (enumeration shape, name patterns, numeric context) - Constraints, enumeration, and component reuse syntax - Validation behavior and optional LLM enrichment

SDC4 Type Reference

One generated page, read from the reference model and the component models on every change: - The hierarchy and what every component carries - The twelve value types, the eight list types, the structural and contextual types - Reference ranges and intervals, the data model - The sixteen exceptional values - For each type: what a record carries and what you set in SDCStudio

Assembly: the request, the estimate and the job resource

The assemble/ request, and the two endpoints around it an agent uses: the estimate before any money moves (what is reused, what is minted, the cost, the key's limit, an estimate_id to hand back) and the job resource that every long operation reports to.

Generated Application API

The HTTP API of a generated Lightweight or Enterprise application: the X-API-Key header, the upload and validation routes, their answers and errors, and what differs between the two profiles.

BFO Alignment

How the SDC4 ontologies align with the Basic Formal Ontology 2020 (ISO/IEC 21838-2) through a separate mapping file, and how to load it into a generated application's triplestore.

Glossary

The Governed Data Record, the Semantic Data Charter and the Settlement Receipt, defined once.

Workflow Diagram

Visual workflow guides: - Processing pipeline diagrams - Agent interaction flows - Data flow illustrations - Mermaid diagrams

How to Use This Section

Quick Lookup: - Use ⌘F (Ctrl+F) to search within documents - Check table of contents at top of each reference - Follow cross-references to related topics

Learning: - Start with Template Format if you are authoring Markdown templates - Read the SDC4 Type Reference for every type, what a record carries and what you set - Reference Workflow Diagram for visual understanding

Development: - Use as specification when creating components - Reference during code generation - Validate against documented constraints

← Back to Documentation Home