Skip to content

Workflow Settings

This guide explains the various settings available for configuring workflows in Raikoo. Understanding these settings will help you optimize workflow execution, manage resources efficiently, and create more robust AI solutions.

Workflow Configuration Overview

Each workflow in Raikoo has a set of configurable settings that control its behavior during execution. These settings are organized into several categories:

  • General workflow properties
  • Execution settings
  • Parameter configuration
  • Error handling
  • Monitoring and logging
  • Security and access control

Properly configuring these settings ensures that your workflows run efficiently and reliably.

General Workflow Properties

Workflow Name and Description

Every workflow should have a clear name and description:

  • Name: A concise, descriptive identifier for the workflow
  • Description: A detailed explanation of the workflow's purpose and function

Best practices for naming: - Use clear, action-oriented names (e.g., "Customer Support Email Generator") - Include the primary function in the name - Use consistent naming conventions across your projects

Workflow Tags

Tags help organize and filter workflows within your projects:

  • Add relevant tags that categorize the workflow's purpose
  • Use consistent tagging schemes across your organization
  • Common tag categories include:
    • Department (Marketing, HR, Engineering)
    • Function (Document Processing, Content Generation)
    • Status (Production, Testing, Development)

Default Persona

You can set a default persona for all AI operations in a workflow:

  • Select a persona that aligns with the workflow's overall purpose
  • Individual operations can override this default as needed
  • Consider creating specialized personas for specific workflow types

Execution Settings

Execution Mode

Raikoo workflows can run in different execution modes:

  • Serial: Operations execute in sequence based on dependencies

    • Ensures predictable order of execution
    • Preferred when operations depend on previous results
    • More conservative resource usage

  • Parallel: Independent operations can execute simultaneously

    • Reduces overall execution time
    • Better for workflows with many independent operations
    • Uses more resources during execution

To set the execution mode: 1. Select the workflow in the Workflow Builder 2. Open the Properties panel 3. Navigate to the Execution Settings section 4. Choose Serial or Parallel mode

Timeout Settings

Configure timeouts to prevent workflows from running indefinitely:

  • Workflow Timeout: Maximum duration for the entire workflow execution
  • Operation Timeout: Default maximum duration for individual operations
    • Can be overridden at the operation level

Recommended timeout practices: - Set reasonable timeouts based on expected execution time - Add buffer time for variations in processing speed - Consider longer timeouts for operations that process large amounts of data

Retry Configuration

Set up retry behavior for failed operations:

  • Max Retries: Number of times to retry a failed operation
  • Retry Delay: Wait time between retry attempts
  • Retry Strategy: Options include:
    • Fixed interval retry
    • Exponential backoff
    • Custom retry logic

Parameter Configuration

Defining Workflow Parameters

Workflow parameters allow for flexible execution with varying inputs:

  1. In the Workflow Builder, select the workflow itself
  2. Navigate to the Parameters section in the Properties panel
  3. Click "Add Parameter"
  4. Configure each parameter with:
    • Name: Unique identifier (e.g., inputText)
    • Type: Data type (String, Number, Boolean, etc.)
    • Default Value: Optional fallback value
    • Description: Explanation of the parameter's purpose
    • Required: Whether the parameter must be provided

Parameter Types

Raikoo supports various parameter types:

  • String: Text values
  • Number: Numeric values
  • Boolean: True/false values
  • Object: JSON objects
  • Array: Lists of values
  • File Reference: Path to a file in the workspace

Using Parameters in Operations

Reference workflow parameters within operations using the variable syntax:

{{WorkflowParameters.parameterName}}

This allows operations to adapt their behavior based on the workflow's input parameters.

Parameter Validation

Set validation rules for parameters to ensure quality inputs:

  • String validation: Minimum/maximum length, pattern matching
  • Number validation: Minimum/maximum values, step size
  • Custom validation: JavaScript-based validation logic

Error Handling

Error Modes

Configure how the workflow responds to errors:

  • Fail Fast: Stop the entire workflow on first error
  • Continue on Error: Attempt to continue execution despite errors
  • Custom Error Handling: Define specific behaviors for different error types

Error Handlers

Add specialized error handling operations:

  1. Add an error handler operation to the workflow
  2. Connect it to operations that might fail
  3. Configure the error handler to:
    • Log detailed error information
    • Execute fallback logic
    • Clean up resources
    • Send notifications

Fallback Operations

Create alternative execution paths for error situations:

  • Define what happens when primary operations fail
  • Implement simplified but reliable fallback operations
  • Ensure critical functionality continues even with partial failures

Workspace Configuration

Workspace Initialization

Configure how the workspace is set up at the start of workflow execution:

  • Initial Files: Files to include in the workspace at startup
  • Directory Structure: Predefined folder structure for outputs
  • Template Files: Template files to copy into the workspace

Workspace Cleanup

Control how workspace resources are managed after execution:

  • Retention Policy: How long to keep workspace files
  • Archive Settings: Whether to archive the workspace on completion
  • Cleanup Actions: What files to remove automatically

Monitoring and Logging

Logging Level

Set the detail level for workflow execution logs:

  • Basic: Essential information only
  • Standard: Operation outcomes and timing
  • Verbose: Detailed execution information
  • Debug: Complete diagnostic information

Notifications

Configure alerts and notifications for workflow events:

  • Completion Notifications: Alerts when workflows finish
  • Error Notifications: Alerts when workflows encounter problems
  • Threshold Alerts: Notifications when workflows exceed time/resource limits

Progress Tracking

Enable detailed progress tracking:

  • Operation Status Updates: Real-time status of each operation
  • Progress Metrics: Percentage complete, time remaining
  • Execution Timeline: Visual representation of operation execution

Security and Access Controls

Access Permissions

Define who can view, edit, or execute the workflow:

  • View Permission: Who can see the workflow
  • Edit Permission: Who can modify the workflow
  • Execute Permission: Who can run the workflow

Credential Management

Configure how the workflow accesses external services:

  • Credential References: Secure references to authentication details
  • Token Management: How access tokens are obtained and refreshed
  • Scope Limitations: Restricting permissions to minimum necessary

Version Control

Version History

Each workflow maintains a version history:

  • Access previous versions through the version selector
  • Add descriptive comments to each version
  • Compare changes between versions

Version Tagging

Use tags to mark important workflow versions:

  • Production: Currently deployed version
  • Release Candidate: Version pending final review
  • Development: Work-in-progress versions

Best Practices for Workflow Settings

Documentation

  • Document the purpose and configuration of each workflow
  • Include examples of expected inputs and outputs
  • Explain any complex or unusual settings

Performance Optimization

  • Use parallel execution for independent operations
  • Configure appropriate timeouts for long-running operations
  • Implement resource limits for expensive operations

Security

  • Follow the principle of least privilege for permissions
  • Regularly review and update security settings
  • Use secure methods for handling sensitive information

Maintenance

  • Regularly review and update workflow settings
  • Clean up unused workflows and resources
  • Implement monitoring to identify performance issues

Conclusion

Properly configuring workflow settings is essential for creating efficient, reliable, and secure AI workflows in Raikoo. By understanding and optimizing these settings, you can ensure that your workflows meet your requirements while making the best use of available resources.

For more information on specific settings, refer to related guides on Working with Workflows and Best Practices.