Get Started with Ingestion in Sprinto
Edit Workflows Using YAML Editor
Learn how to edit ingestion workflows in Sprinto using YAML Editor, including importing YAML, exporting workflow configuration, validation, and advanced workflow editing.
Sprinto’s YAML Editor allows advanced users to directly edit ingestion workflow configuration.
YAML Editor provides full visibility into the workflow structure and is useful when you need:
- Advanced workflow customisation
- Direct configuration editing
- Manual workflow control
- Workflow import and export
- Version-controlled configuration management
Most users can build workflows using the AI Editor or Visual Editor. YAML Editor is recommended for advanced workflow management.
Note
YAML Editor is only available for from-scratch plans. Template-based plans support Visual Editor only.
Before You Begin
Ensure that:
- A from-scratch ingestion plan already exists
- You have access to the Ingestion module
- You understand the workflow structure before editing YAML directly
Open YAML Editor
To open YAML Editor:
- Log in to the Sprinto dashboard.
- Go to Ingestion.
- Open the Plans tab.
- Locate the required from-scratch plan.
- Open the three-dot menu.
- Click Edit.
- Open the YAML Editor tab.
Sprinto opens the YAML configuration workspace.
Understand the YAML Editor Layout
The YAML Editor includes:
- YAML editing workspace
- Validation feedback
- Import option
- Copy option
- Download option
- Save Changes button
The editor displays the complete ingestion workflow configuration.
Review Workflow Configuration
The YAML workspace contains the ingestion workflow definition.
Depending on the workflow, the configuration may include:
- Plan details
- Parameters
- Providers
- Credentials
- Workflow steps
- Outputs
- Processing logic
The configuration updates dynamically when changes are saved.
Edit Workflow Configuration
You can directly modify workflow behaviour inside the YAML editor.
Examples include:
- Updating workflow steps
- Changing parameters
- Modifying conditions
- Editing mappings
- Adjusting outputs
- Reordering processing logic
Changes affect future workflow executions after saving.
Import a YAML File
Importing allows you to load an existing workflow configuration into Sprinto.
Import YAML
- Open the YAML Editor.
- Click Import.
- Select the YAML file.
- Review the imported configuration.
- Click Save.
Imported YAML replaces the existing workflow configuration.
Copy YAML Configuration
You can copy the workflow configuration directly from the editor.
Copy YAML
- Open the YAML Editor.
- Click Copy.
Sprinto copies the YAML configuration to the clipboard.
This is useful for:
- Sharing workflow logic
- Comparing configurations
- Reviewing changes externally
Download YAML Configuration
Downloading allows you to export the ingestion workflow locally.
Download YAML
- Open the YAML Editor.
- Click Download.
Sprinto downloads the YAML file.
Downloaded YAML can be used for:
- Backups
- Workflow migration
- External review
- Version tracking
Validate YAML Configuration
Sprinto validates YAML before saving changes.
Validation helps identify:
- Invalid formatting
- Missing required configuration
- Unsupported schema structure
- Workflow inconsistencies
Validation messages appear directly inside the editor.
You must resolve validation errors before saving.
Save Workflow Changes
After editing the workflow:
- Review the YAML configuration.
- Click Save Changes.
Sprinto validates and stores the updated workflow.
Use YAML Editor with Other Editors
YAML Editor works alongside:
- AI Editor
- Visual Editor
Changes made in one editor affect the shared workflow configuration.
For example:
- AI-generated workflows appear in YAML
- Visual Editor changes update the YAML structure
- Saved YAML changes affect workflow execution
When to Use YAML Editor
YAML Editor is recommended when:
- Advanced workflow customisation is required
- Direct configuration editing is preferred
- Teams manage workflows using version control
- AI-generated workflows require manual refinement
- Workflow logic is too complex for Visual Editor
For most workflows, Sprinto recommends starting with AI Editor first.
Best Practices
Use the following recommendations when editing YAML workflows:
- Start with AI Editor before using YAML directly
- Review workflow structure before editing
- Validate YAML before saving
- Export backups before major changes
- Keep workflow logic readable
- Test workflows after updating YAML
- Use Run History and Troubleshoot after major edits