SDCStudio User Workflow Guide

Overview

SDCStudio provides multiple pathways for creating Semantic Data Charter (SDC4) data models. This guide outlines the different workflows available to users, from simple data uploads to complex AI-powered model generation.

The Modern Automated Workflow

With the new architecture, the primary workflow is a streamlined, two-phase automated process.

  1. Phase 1: Parsing. You upload a file, and the system quickly analyzes its structure.
  2. Phase 2: Agent Processing. A team of AI agents automatically builds your data model from the parsed structure.

This automated process handles the creation of components, clusters, and the final data model, which you can then review and refine.

Workflow Diagram

graph TD
    A["User Uploads File<br/>(e.g., CSV or Markdown)"] --> B{"Status: Parsing"}
    B --> C{"Status: Parsed"}
    C --> D["Agent Processing Starts"]
    D --> E{"Status: Agent Processing"}
    E --> F{"Success?"}
    F -->|Yes| G["Status: Completed"]
    F -->|No| H["Status: Agent Error"]

    G --> I["Review & Refine<br/>Data Model"]
    I --> J["Publish Model"]
    J --> K["Download XSD/JSON"]

    H --> L["Click 'Retry' Button"]
    L --> D

    %% Styling
    classDef process fill:#e0f2f1,stroke:#004d40,stroke-width:2px,color:#004d40
    classDef success fill:#e8f5e8,stroke:#1b5e20,stroke-width:2px,color:#1b5e20
    classDef error fill:#fce4ec,stroke:#880e4f,stroke-width:2px,color:#880e4f
    classDef action fill:#e1f5fe,stroke:#01579b,stroke-width:2px,color:#01579b

    class B,C,E process
    class G,I,J,K success
    class H error
    class A,D,L action

Workflow Details

1. File Upload

  • Action: Upload a CSV or a structured Markdown file.
  • Result: The system immediately queues your file for processing, and the status changes to Parsing.

2. Parsing Phase

  • Status: Parsing -> Parsed
  • What's Happening: The system reads the file to understand its structure. This is a quick, technical step.
  • Result: A ParsedData object is created and cached. The status changes to Parsed, and the agent processing phase is automatically triggered.

3. Agent Processing Phase

  • Status: Agent Processing
  • What's Happening: This is where the AI does its work. A team of software agents collaborates to:
    • Create an SDC4 component for each column in your file.
    • Group these components into a logical Cluster.
    • Create the final Data Model that contains the cluster.
  • Result: This phase can end in one of two states.

4. Completion or Error

  • If Successful (Status: Completed):

    • A new Data Model, a Cluster, and all the necessary column-based components have been created in the database.
    • You can now navigate to the "Data Models" page to find, review, and refine your new model.

  • If Unsuccessful (Status: Agent Error):

    • The initial file parsing was successful, but an error occurred during the automated model building.
    • This is a retryable state. A "Retry" button will appear next to the file in the Data Sources list. Clicking it will re-run only the failed "Agent Processing" step.

5. Review, Publish, and Export

  • Once your model is Completed, you can:
    • Review and Edit: Examine the components, add more detailed descriptions, or adjust constraints.
    • Publish: Finalize the model.
    • Download: Export the model as a standard XSD or JSON schema for use in other systems.