@loopstack/dynamic-routing-example-workflow

@loopstack/dynamic-routing-example-workflow

A module for the Loopstack AI automation framework.

This module provides an example workflow demonstrating how to implement conditional routing based on runtime values.

Overview

The Dynamic Routing Example Workflow shows how to create branching logic in workflows using the if condition on transitions. It demonstrates how to route execution through different paths based on input values.

By using this workflow as a reference, you'll learn how to:

• Define conditional transitions using the if property with expression syntax
• Build multi-level branching structures
• Implement fallback routes when conditions aren't met
• Use @Input for workflow arguments with UI form configuration

This example is useful for developers building workflows that require decision trees, validation flows, or any logic that branches based on data.

Installation

You can add this module using the loopstack cli or via npm.

a) Add Sources via loopstack add (recommended)

loopstack add @loopstack/dynamic-routing-example-workflow

This command copies the source files into your src directory.

• It is a great way to explore the code to learn new concepts or add own customizations
• It will set up the module for you, so you do not need to manually update your application

b) Install via npm install

npm install --save @loopstack/dynamic-routing-example-workflow

Use npm install if you want to use and maintain the module as node dependency.

• Use this, if you do not need to make changes to the code or want to review the source code.

Setup

1. Manual setup (optional)

This step is automatically done for you when using the loopstack add command.

• Add DynamicRoutingExampleModule to the imports of default.module.ts or any other custom module.
• Inject the DynamicRoutingExampleWorkflow workflow to your workspace class using the @InjectWorkflow() decorator.

See here for more information about working with Modules and Workspaces

How It Works

Workflow Class

The workflow class declares input arguments using @Input:

@Workflow({
  configFile: __dirname + '/dynamic-routing-example.workflow.yaml',
})
export class DynamicRoutingExampleWorkflow {
  @InjectTool() private createChatMessage: CreateChatMessage;

  @Input({
    schema: z
      .object({
        value: z.number().default(150),
      })
      .strict(),
  })
  args: {
    value: number;
  };
}

Key Concepts

1. Conditional Transitions

Use the if property with expression syntax (${{ }}) to define conditions for transitions. The first matching transition from a given state is taken:

- id: route-to-place-A
  from: prepared
  to: placeA
  if: ${{ args.value > 100 }}

- id: route-to-place-B
  from: prepared
  to: placeB
  # No condition = fallback route

The expression syntax ${{ }} supports JavaScript-like comparison operators (>, <, >=, <=, ==, etc.) directly, without needing helper functions.

2. Multi-Level Branching

Chain conditional transitions to create decision trees:

# First level: value > 100?
- id: route-to-place-A
  from: prepared
  to: placeA
  if: ${{ args.value > 100 }}

- id: route-to-place-B
  from: prepared
  to: placeB
  # Fallback: value <= 100

# Second level: value > 200?
- id: route-to-place-C
  from: placeA
  to: placeC
  if: ${{ args.value > 200 }}

- id: route-to-place-D
  from: placeA
  to: placeD
  # Fallback: 100 < value <= 200

3. UI Form Configuration

Configure the input form in YAML:

ui:
  form:
    properties:
      value:
        title: 'A number between 0 and 300'

4. Complete Routing Flow

The workflow routes through different states based on the input value:

• value <= 100 -> placeB -> "Value is less or equal 100"
• 100 < value <= 200 -> placeA -> placeD -> "Value is less or equal 200, but greater than 100"
• value > 200 -> placeA -> placeC -> "Value is greater than 200"

Dependencies

This workflow uses the following Loopstack modules:

• @loopstack/core - Core framework functionality
• @loopstack/create-chat-message-tool - Provides CreateChatMessage tool

About

Author: Jakob Klippel

License: Apache-2.0

Additional Resources

• Loopstack Documentation
• Getting Started with Loopstack
• Find more Loopstack examples in the Loopstack Registry