|
|
|
|
@@ -3,3 +3,186 @@ title: Execution
|
|
|
|
|
description: The execution of a workflow.
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
import { Card, Cards } from 'fumadocs-ui/components/card'
|
|
|
|
|
import { Files, Folder, File } from 'fumadocs-ui/components/files'
|
|
|
|
|
import { Step, Steps } from 'fumadocs-ui/components/steps'
|
|
|
|
|
import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'
|
|
|
|
|
import { Tab, Tabs } from 'fumadocs-ui/components/tabs'
|
|
|
|
|
import { AgentIcon, ApiIcon, ConditionalIcon, CodeIcon, ChartBarIcon, ConnectIcon, GmailIcon, PerplexityIcon, NotionIcon, ExaAIIcon, FirecrawlIcon, SlackIcon } from '@/components/icons'
|
|
|
|
|
|
|
|
|
|
# Workflow Execution
|
|
|
|
|
|
|
|
|
|
Sim Studio provides a powerful execution engine that brings your workflows to life. Understanding how execution works will help you design more effective workflows and troubleshoot any issues that arise.
|
|
|
|
|
|
|
|
|
|
## Execution Flow
|
|
|
|
|
|
|
|
|
|
When you execute a workflow in Sim Studio, the system follows a predictable pattern:
|
|
|
|
|
|
|
|
|
|
<Steps>
|
|
|
|
|
<Step>
|
|
|
|
|
### Validation
|
|
|
|
|
The workflow is validated to ensure it has an enabled starter block and proper connections. This includes checking that:
|
|
|
|
|
- The starter block has no incoming connections
|
|
|
|
|
- All required blocks are present and properly connected
|
|
|
|
|
- Loop configurations are valid with appropriate iteration limits
|
|
|
|
|
</Step>
|
|
|
|
|
|
|
|
|
|
<Step>
|
|
|
|
|
### Initialization
|
|
|
|
|
The execution context is created with environment variables and input values. This context maintains the state of the workflow throughout execution, including:
|
|
|
|
|
- Block outputs and states
|
|
|
|
|
- Execution path tracking
|
|
|
|
|
- Routing decisions
|
|
|
|
|
- Loop iteration counters
|
|
|
|
|
</Step>
|
|
|
|
|
|
|
|
|
|
<Step>
|
|
|
|
|
### Block Execution
|
|
|
|
|
Blocks are executed in topological order, with each block's outputs feeding into subsequent blocks. The executor:
|
|
|
|
|
- Determines the next layer of blocks to execute based on dependencies
|
|
|
|
|
- Resolves inputs for each block from previous outputs
|
|
|
|
|
- Dispatches execution to specialized handlers for each block type
|
|
|
|
|
</Step>
|
|
|
|
|
|
|
|
|
|
<Step>
|
|
|
|
|
### Path Determination
|
|
|
|
|
Router and conditional blocks make routing decisions that determine which execution paths to follow. The path tracker:
|
|
|
|
|
- Updates the active execution path based on these decisions
|
|
|
|
|
- Ensures that only blocks on active paths are executed
|
|
|
|
|
- Handles complex branching logic in your workflow
|
|
|
|
|
</Step>
|
|
|
|
|
|
|
|
|
|
<Step>
|
|
|
|
|
### Result Collection
|
|
|
|
|
The final output and execution logs are collected and presented in the UI. You'll see:
|
|
|
|
|
- Complete execution logs for each block
|
|
|
|
|
- Performance metrics and timing information
|
|
|
|
|
- Any errors that occurred during execution
|
|
|
|
|
- The final workflow output
|
|
|
|
|
</Step>
|
|
|
|
|
</Steps>
|
|
|
|
|
|
|
|
|
|
## Block Types
|
|
|
|
|
|
|
|
|
|
Sim Studio has two main categories of blocks in workflows:
|
|
|
|
|
|
|
|
|
|
<Tabs items={['Orchestration Blocks', 'Output Blocks']}>
|
|
|
|
|
<Tab value="Orchestration Blocks">
|
|
|
|
|
<Card>
|
|
|
|
|
Orchestration blocks control the flow of execution through your workflow.
|
|
|
|
|
|
|
|
|
|
<Files>
|
|
|
|
|
<File name="Router Blocks" icon={<ConnectIcon className="w-4 h-4" />} annotation="Direct the workflow along specific paths based on dynamic decisions. The router evaluates inputs and selects one of multiple possible paths." />
|
|
|
|
|
<File name="Conditional Blocks" icon={<ConditionalIcon className="w-4 h-4" />} annotation="Execute different paths based on conditional logic. Conditions are evaluated to true or false, determining which path to follow." />
|
|
|
|
|
</Files>
|
|
|
|
|
</Card>
|
|
|
|
|
</Tab>
|
|
|
|
|
|
|
|
|
|
<Tab value="Output Blocks">
|
|
|
|
|
<Card>
|
|
|
|
|
Output blocks perform operations and generate results that can be used by downstream blocks.
|
|
|
|
|
|
|
|
|
|
<Files>
|
|
|
|
|
<File name="Agent Block" icon={<AgentIcon className="w-4 h-4" />} annotation="Interact with AI models to generate content. Supports various LLM providers with optional tool calling capabilities." />
|
|
|
|
|
<File name="Function Blocks" icon={<CodeIcon className="w-4 h-4" />} annotation="Execute custom JavaScript/TypeScript code to process data. Runs in a secure sandbox environment with appropriate timeout limits." />
|
|
|
|
|
<File name="API Blocks" icon={<ApiIcon className="w-4 h-4" />} annotation="Make HTTP requests to external services. Configure headers, body, and authentication for REST API interactions."/>
|
|
|
|
|
<File name="Evaluator Blocks" icon={<ChartBarIcon className="w-4 h-4" />} annotation="Assess outputs against defined criteria with customizable scoring logic."/>
|
|
|
|
|
</Files>
|
|
|
|
|
</Card>
|
|
|
|
|
</Tab>
|
|
|
|
|
</Tabs>
|
|
|
|
|
|
|
|
|
|
## Real-Time Monitoring
|
|
|
|
|
|
|
|
|
|
As your workflow executes, Sim Studio provides powerful real-time monitoring capabilities:
|
|
|
|
|
|
|
|
|
|
<Accordions>
|
|
|
|
|
<Accordion title="Active Block Indicator">
|
|
|
|
|
The currently executing block is highlighted in the workflow editor, making it easy to follow the execution flow in real-time. This visual indicator helps you understand exactly where in your workflow the execution is currently happening.
|
|
|
|
|
</Accordion>
|
|
|
|
|
|
|
|
|
|
<Accordion title="Live Logs Panel">
|
|
|
|
|
Execution logs appear in real-time in the logs panel on the right side. These logs include detailed information about each block's execution, including inputs, outputs, execution time, and any errors that occur. You can use these logs to debug your workflow and understand how data flows between blocks.
|
|
|
|
|
</Accordion>
|
|
|
|
|
|
|
|
|
|
<Accordion title="Block States">
|
|
|
|
|
Each block's state (pending, executing, completed, or error) is visually indicated in the workflow editor. This helps you quickly identify which blocks have executed successfully and which may have encountered issues.
|
|
|
|
|
</Accordion>
|
|
|
|
|
|
|
|
|
|
<Accordion title="Performance Metrics">
|
|
|
|
|
Detailed timing information shows how long each block takes to execute, helping you identify performance bottlenecks in your workflow. The execution engine tracks start time, end time, and total duration for both individual blocks and the entire workflow.
|
|
|
|
|
</Accordion>
|
|
|
|
|
</Accordions>
|
|
|
|
|
|
|
|
|
|
## Execution Methods
|
|
|
|
|
|
|
|
|
|
Sim Studio offers multiple ways to trigger workflow execution:
|
|
|
|
|
|
|
|
|
|
<Cards>
|
|
|
|
|
<Card title="Manual Execution" href="#">
|
|
|
|
|
Run workflows on-demand through the Sim Studio interface. This is perfect for testing and development, allowing you to iteratively refine your workflow with immediate feedback.
|
|
|
|
|
</Card>
|
|
|
|
|
|
|
|
|
|
<Card title="Scheduled Execution" href="#">
|
|
|
|
|
Configure workflows to run automatically on a specified schedule using cron expressions. Ideal for regular data processing, reporting tasks, or any workflow that needs to run periodically without manual intervention.
|
|
|
|
|
</Card>
|
|
|
|
|
|
|
|
|
|
<Card title="API Endpoints" href="#">
|
|
|
|
|
Each workflow can be exposed as an API endpoint with authentication, allowing external systems to trigger execution with custom inputs. This enables seamless integration with your existing applications and services.
|
|
|
|
|
</Card>
|
|
|
|
|
|
|
|
|
|
<Card title="Webhooks" href="#">
|
|
|
|
|
Configure workflows to execute in response to external events via webhook triggers. This allows your workflows to react to events from third-party services like GitHub, Stripe, or any platform that supports webhooks.
|
|
|
|
|
</Card>
|
|
|
|
|
</Cards>
|
|
|
|
|
|
|
|
|
|
## Advanced Execution Features
|
|
|
|
|
|
|
|
|
|
### Loops
|
|
|
|
|
|
|
|
|
|
Sim Studio supports sophisticated loop constructs, allowing parts of your workflow to execute repeatedly:
|
|
|
|
|
|
|
|
|
|
- **Iteration Limits** - Configure maximum iterations (default: 5) to prevent infinite loops and minimum iterations to ensure the loop executes a certain number of times.
|
|
|
|
|
- **Conditional Looping** - Continue looping until specific conditions are met, with the loop manager tracking iteration counts.
|
|
|
|
|
- **Loop Reset** - Automatically resets block states between iterations, allowing blocks to be re-executed with updated inputs.
|
|
|
|
|
- **Feedback Paths** - Create feedback loops where outputs from later blocks feed back into earlier blocks in the workflow.
|
|
|
|
|
|
|
|
|
|
### Error Handling
|
|
|
|
|
|
|
|
|
|
The execution engine includes built-in error handling mechanisms:
|
|
|
|
|
|
|
|
|
|
- **Block-Level Errors** - Errors in one block don't necessarily stop the entire workflow execution.
|
|
|
|
|
- **Detailed Error Logs** - Comprehensive error information is captured in the execution logs, including error messages, stack traces, and relevant context.
|
|
|
|
|
- **Fallback Mechanisms** - For function execution, the system tries WebContainer execution first, then falls back to VM execution if needed.
|
|
|
|
|
- **Recovery Options** - Configure blocks to retry on failure or implement custom error handling logic.
|
|
|
|
|
|
|
|
|
|
### Environment Variables
|
|
|
|
|
|
|
|
|
|
Use environment variables to securely store and access sensitive information:
|
|
|
|
|
|
|
|
|
|
- **API Keys** - Store API credentials securely without hardcoding them in your workflow.
|
|
|
|
|
- **Configuration Values** - Manage environment-specific configuration values.
|
|
|
|
|
- **Runtime Availability** - All environment variables are available to blocks during execution.
|
|
|
|
|
- **Secure Storage** - Values are encrypted at rest and only decrypted during execution.
|
|
|
|
|
|
|
|
|
|
## Execution Context
|
|
|
|
|
|
|
|
|
|
Each workflow execution maintains a detailed context that includes:
|
|
|
|
|
|
|
|
|
|
- **Block States** - Outputs and execution status of each block, indexed by block ID.
|
|
|
|
|
- **Execution Path** - The active path through the workflow based on routing decisions.
|
|
|
|
|
- **Routing Decisions** - Records which paths were selected by router and conditional blocks.
|
|
|
|
|
- **Loop Iterations** - Tracks current iteration count for each loop in the workflow.
|
|
|
|
|
- **Environment Variables** - Configuration values available to all blocks during execution.
|
|
|
|
|
- **Execution Logs** - A chronological record of block executions with timing information.
|
|
|
|
|
|
|
|
|
|
## Performance Considerations
|
|
|
|
|
|
|
|
|
|
- **Block Complexity** - Complex blocks with heavy computation may take longer to execute. Consider breaking complex operations into multiple blocks.
|
|
|
|
|
- **External Dependencies** - Blocks that rely on external services may be affected by network latency or service availability.
|
|
|
|
|
- **Execution Layers** - The executor processes blocks in layers based on dependencies, which can affect overall execution time.
|
|
|
|
|
- **Code Optimization** - For function blocks, optimize your code to reduce execution time and resource usage.
|
|
|
|
|
- **Timeout Limits** - Function blocks have configurable timeout limits to prevent long-running operations from blocking execution.
|
|
|
|
|
|
|
|
|
|
By understanding these execution principles, you can design more efficient and effective workflows in Sim Studio.
|
|
|
|
|
|
|
|
|
|
|
Waleed Latif