Workflow Automation

ℹ️ Note: AI-powered workflow automation is a core feature of Allinix. This guide covers the key concepts and implementation details of our workflow system.

Architecture Overview

Frontend Structure

graph TD
  A[Workflow] --> B[Node 1]
  A --> C[Node 2]
  B --> D[Node 3]
  C --> D
  B --Edge--> C

Key Components

1. Workflow

   • Represents the entire graph structure

   • Contains all nodes and their connections

2. Node

   • Individual element within a workflow

   • Has position and visual properties

   • Maps to a backend Block

3. Edge

   • Connects two nodes

   • Defines workflow execution path

Backend Structure

Block System

interface Block {
  type: string;
  description: string;
  inputs: Record<string, any>;
  outputs: Record<string, any>;
  run(): Promise<void>;
}

• Each frontend Node maps to a Block

• Blocks contain actual execution logic

• Example: SlackMessageBlock handles Slack message sending

Adding New Blocks

Frontend Configuration

export const blockDefinitions = {
  // Add your block definition here
  MyNewBlock: {
    type: 'MyNewBlock',
    inputs: {
      // Define input fields
    },
    outputs: {
      // Define output fields
    }
  }
};

ℹ️ Note: Block definitions will soon be served from the backend, eliminating the need for frontend updates.

Backend Implementation

1. Create Block Definition

   class MyBlockInput:
       field1: str
       field2: int
   
   class MyBlockOutput:
       result: str
   
   class MyBlock:
       type = "MyBlock"
       description = "Performs specific action"
       image_url = "block-icon.png"
       input = MyBlockInput
       
       async def run(self) -> MyBlockOutput:
           # Implementation
           pass

2. Install Dependencies

   poetry add required-package

3. Register Block

   from .my_block import MyBlock
   
   def get_block_runner(block_type: str):
       if block_type == "MyBlock":
           return MyBlock()

4. Rebuild Services

   docker compose down
   docker compose up --build

Node Categories

Triggers

• Entry points that initiate workflow execution

• Schedule-based triggers

• Event-based triggers

• Manual triggers

Actions

• Perform specific tasks within the workflow

• Data processing

• External service integration

• Custom business logic

⚠️ Warning: Always test new blocks thoroughly in a development environment before deploying to production.