Creating a Workflow

Overview

A Workflow is a sequence of connected test scripts that execute in a defined order. It's the core execution unit in Test Orchestration where you visually chain test scripts together without writing code.

🔄 Visual Automation

Instead of coding test sequences, you drag test scripts onto a canvas and draw lines to connect them. Simple, visual, and powerful!

---

Why Create Workflows?

Workflows let you:

Benefit	Example
Chain Tests	API test → Web test → Mobile test
Share Data	First test creates user, second test uses that user
Save Time	Run 10 tests with one click instead of manually running each
Automate Validation	Complex scenarios run unattended
Organize Tests	Group related tests logically

---

Workflow Building Steps

What is a Node/Step?

A node is a single test script or action in your workflow.

Examples of Nodes:

• 🌐 Web test script

• 📱 Mobile app test script

• 🔌 API test script

• ⏱️ Wait action (pause for X seconds)

• 🔄 Retry action (retry a failed test)

• 📧 Email action (send notification)

How Workflows Work

┌─────────────────────────────────────────┐
│         Workflow Execution               │
├─────────────────────────────────────────┤
│                                         │
│  [Login API] ──→ [Web Login] ──→ [Mobile App]
│       ✅             ✅              ✅
│   (user created) (login success)  (app loaded)
│                                         │
│  All tests passed ✅                    │
│  Total time: 45 seconds                 │
│                                         │
└─────────────────────────────────────────┘

---

Step-by-Step: Creating Your First Workflow

Step 1: Open Your Project

1. Go to Projects section

2. Find the project you created earlier

3. Click on the project name

4. You'll see the Project Dashboard

Dashboard View:

┌─ E-Commerce Testing ────────────────────┐
│                                         │
│  [+ Workflow]  [Settings]  [Reports]   │
│                                         │
│  Workflows:                             │
│  ├─ [No workflows yet]                  │
│  └─ [+ Create New Workflow]             │
│                                         │
└─────────────────────────────────────────┘

---

Step 2: Create New Workflow

Click the "+ Workflow" or "Create Workflow" button

Result:

• A workflow creation dialog appears

• You're ready to configure the workflow

---

Step 3: Configure Workflow Details

Fill in the workflow information:

Field 1: Workflow Name (Required)

What to enter: Descriptive name for this workflow

Examples:

✅ Good Names:
   - User Registration with Email Verification
   - Complete Checkout Flow
   - Login and Dashboard Validation
   - API Data Creation and Verification

❌ Avoid:
   - Workflow 1, Test 1
   - WF Test
   - Flow

Tips:

• Be specific about what the workflow tests

• Include key steps if helpful

• Avoid generic names

• Keep it concise (30-50 characters)

Example: Type Complete Checkout Flow

---

Field 2: Description (Optional)

What to enter: Explain what this workflow does

Examples:

✅ Good Descriptions:
   - Validates complete checkout: API order creation, Web purchase, email confirmation
   - Tests mobile app login with Web portal verification
   - Comprehensive API sequence for payment processing

❌ Avoid:
   - Test workflow
   - Testing flow

Example: Type Validates complete checkout flow: API order creation, Web UI purchase, email confirmation

---

Field 3: Tags (Optional)

What to enter: Keywords for categorizing and filtering

Examples:

Common Tags:
├─ By Type: api, web, mobile, desktop, integration
├─ By Scope: smoke, regression, sanity, e2e
├─ By Team: backend, frontend, qa, platform
├─ By Component: payment, login, search, checkout
└─ By Status: active, beta, deprecated

How to Add Tags:

1. Type a tag name (e.g., checkout)

2. Press Enter or Tab

3. Tag appears as a label

4. Repeat for more tags

Example: Type checkout, press Enter, type payment, press Enter

---

Step 4: Create and Enter Canvas

1. Click "Create" or "Save"

2. Workflow is created

3. You're taken to the Workflow Canvas

Canvas Layout:

┌─────────────────────────────────────────────────────┐
│ Complete Checkout Flow  [Edit] [Run] [Settings]    │
├─────────────────────────────────────────────────────┤
│                                                     │
│  ┌──────────────────────────────────────────────┐   │
│  │                                              │   │
│  │  [Empty Canvas - Ready for Nodes]            │   │
│  │                                              │   │
│  │  ← Add nodes from sidebar →                  │   │
│  │                                              │   │
│  └──────────────────────────────────────────────┘   │
│                                                     │
└─────────────────────────────────────────────────────┘

---

Step 5: Select Service Type

The sidebar shows different service types for filtering scripts.

Service Types:

Icon	Service	Scripts Available
🌐	Web	Web UI test scripts
📱	Mobile	iOS and Android scripts
🔌	API	REST/GraphQL API scripts
🖥️	Desktop	Windows/Mac app scripts

How to Select:

1. Look at the left sidebar

2. Find service type buttons

3. Click the service type (e.g., API)

4. List below shows available scripts for that type

Sidebar View:

┌─ Service Types ─────────┐
│ [🌐 Web]                │
│ [📱 Mobile]             │
│ [🔌 API]  ← Selected    │
│ [🖥️ Desktop]            │
├─ Available Scripts ─────┤
│ ✓ Create User API       │
│ ✓ Login API             │
│ ✓ Get Profile API       │
│ ✓ Update Account API    │
└─────────────────────────┘

---

Step 6: Add Scripts to Canvas

Add your test scripts by dragging them onto the canvas.

Method 1: Drag and Drop (Recommended)

1. Find script in the sidebar (e.g., "Create User API")

2. Click and hold on the script name

3. Drag the script onto the canvas

4. Release to drop it

Result: Script appears as a step on the canvas

Sidebar                          Canvas
┌──────────────┐                ┌──────────────────┐
│ Create User  │  ──(drag)──>   │ [Create User]    │
│ Login API    │                │                  │
│ Get Profile  │                └──────────────────┘
└──────────────┘

Method 2: Double-Click (if available)

1. Find script in sidebar

2. Double-click the script name

3. Script automatically appears on canvas

---

Step 7: Add Multiple Scripts

Repeat Step 6 to add more test scripts.

Example Building:

1. Select API service type

2. Drag "Create User API" to canvas

3. Switch to Web service type

4. Drag "Web Login" to canvas

5. Drag "Dashboard Validation" to canvas

6. Switch to Mobile service type

7. Drag "Mobile Profile Check" to canvas

Canvas Now Shows:

┌─────────────────────────────────────┐
│                                     │
│  [Create User API]                  │
│                                     │
│  [Web Login]                        │
│                                     │
│  [Dashboard Validation]             │
│                                     │
│  [Mobile Profile Check]             │
│                                     │
└─────────────────────────────────────┘

---

Step 8: Connect the Steps

Create execution flow by connecting steps together.

Understanding Connections

Connections define the order tests execute:

• Line goes from first test to next

• Tests execute in connected order

• Data flows through connections

How to Connect

1. Hover over first step (e.g., "Create User API")

2. Look for connection point - small circle/dot on right edge

3. Click and drag from the connection point

4. Drag line to target step (e.g., "Web Login")

5. Release when hovering over target

6. Connection created! ✅

Visual Example:

Step 1: Hover on first step
        [Create User API]  ●  ← connection point

Step 2: Drag to second step
        [Create User API] ──────> [Web Login]

Step 3: Connection complete
        [Create User API] ──────→ [Web Login]

Create Full Flow

Repeat connecting process:

[Create User API]
        ↓
[Web Login]
        ↓
[Dashboard Validation]
        ↓
[Mobile Profile Check]

---

Step 9: Understand Node Execution Order

Execution follows the connections:

Execution Timeline:
1️⃣  Create User API (30 seconds)
     ↓ (user created)
2️⃣  Web Login (20 seconds)
     ↓ (logged in successfully)
3️⃣  Dashboard Validation (15 seconds)
     ↓ (validated)
4️⃣  Mobile Profile Check (25 seconds)
     ↓
✅  All tests passed (90 seconds total)

---

Step 10: Configure Run Settings (Mandatory)

Before executing, configure execution parameters:

💡 Run Configuration

This determines where and how your tests run. Set this before first execution.

1. Look for "Run Configuration" or "Settings" button

2. Configure:

Environment:

• Select: Development, Staging, or Production

• Affects URLs, credentials used

Browsers (for Web tests):

• Chrome, Firefox, Safari, Edge

• Can select multiple browsers

Devices (for Mobile tests):

• iOS: iPhone 14, iPad Pro, etc.

• Android: Pixel 7, Samsung Galaxy, etc.

Other Options:

• Screen resolution

• Network speed

• Headless mode (no UI display)

1. Click "Save Configuration"

---

Workflow Execution States

When nodes execute, they show different statuses:

Status Indicators

Status	Icon	Color	Meaning
Pending	⏳	Gray	Waiting to execute
Running	🔄	Yellow	Currently executing
Passed	✅	Green	Completed successfully
Failed	❌	Red	Execution failed
Skipped	⊘	Light Gray	Skipped by condition
Stopped	⏹️	Black	Manually stopped
Retrying	🔁	Orange	Retrying after failure

Example Execution View

During Execution:
┌──────────────────────┐
│ ⏳ Create User       │ (Pending)
│ 🔄 Web Login         │ (Running) ← Current
│ ⏳ Dashboard Validate │ (Pending)
│ ⏳ Mobile Profile     │ (Pending)
└──────────────────────┘

After Completion:
┌──────────────────────┐
│ ✅ Create User       │ (30 sec)
│ ✅ Web Login         │ (20 sec)
│ ✅ Dashboard Validate│ (15 sec)
│ ✅ Mobile Profile    │ (25 sec)
└──────────────────────┘
Total: 90 seconds ✅

---

Common Workflow Patterns

Pattern 1: Sequential Flow

Execute tests one after another in order.

[Setup API] → [Web UI] → [Verification] → [Cleanup]

Use When:

• Tests depend on each other

• Data flows from one to next

• Order is critical

Pattern 2: Branching (If Supported)

Execute different paths based on conditions.

        ┌─ Path A
[Decision] 
        └─ Path B

Use When:

• Different test paths for different scenarios

• Conditional execution needed

Pattern 3: Conditional Logic

Run multiple tests simultaneously.

            ┌─ iOS Tests
[Setup] ────┤
            └─ Android Tests

Use When:

• Tests are independent

• Need faster execution

• Testing multiple platforms

Pattern 4: With Actions

Include Wait, Retry, Email actions.

[API Call] → [Retry if fails] → [Wait 5 sec] → [Verify] → [Email if failed]

Use When:

• Need delays between steps

• Handling flaky tests

• Sending notifications

---

Best Practices for New Workflows

✅ DO:

1. Start Simple

   • Begin with 2-3 steps

   • Add complexity gradually

   • Test after each addition

2. Use Descriptive Names

   • Workflow: "Complete Checkout Flow"

   • Not: "Test 1", "Workflow A"

3. Add Descriptions

   • Helps team understand purpose

   • Useful for future reference

4. Connect Logically

   • Follow natural flow

   • Don't create confusing paths

5. Verify Connections

   • Ensure all nodes are connected

   • Check execution order

6. Test Incrementally

   • Execute after adding 2-3 steps

   • Verify data flows correctly

   • Check for errors early

❌ DON'T:

1. Create Overly Complex Workflows

   • Don't add 20 steps on first try

   • Keep initial workflows simple

2. Forget Descriptions

   • Without description, team won't understand

   • Future you won't remember purpose

3. Ignore Errors

   • Fix failures immediately

   • Review logs to understand issues

4. Create Unconnected Nodes

   • Isolated nodes won't execute

   • Ensure all nodes have connections

5. Mix Unrelated Tests

   • One workflow = one logical test scenario

   • Don't combine unrelated tests

6. Skip Run Configuration

   • Always set environment

   • Select appropriate browsers/devices

---

Troubleshooting: Creating Workflows

Issue: Can't Create Workflow

Solution:

• Ensure you're inside a project first

• Project must be active (not archived)

• Check permissions with admin

Issue: Scripts Don't Appear in Sidebar

Solution:

• Verify scripts exist in the system

• Check script service type is selected

• Some scripts may not be available in your project

Issue: Can't Drag Scripts to Canvas

Solution:

• Try double-clicking instead

• Refresh the page

• Check browser compatibility

• Zoom to 100% and try again

Issue: Can't Connect Steps

Solution:

• Hover over right edge of step to find connection point

• Drag from connection point to target step

• Make sure steps are close enough

• Try zooming in for precision

Issue: Workflow Won't Save

Solution:

• Ensure workflow name is filled in

• Check for special characters in names

• Try refreshing page and saving again

---

What's Inside a Workflow

Workflow Contains:

Workflow: "Checkout Validation"
├─ Nodes (Test Scripts)
│  ├─ Create Order API
│  ├─ Web Payment Page
│  ├─ Payment Processing
│  └─ Order Confirmation Mobile
│
├─ Connections
│  ├─ Create Order → Web Payment
│  ├─ Web Payment → Payment Processing
│  └─ Payment Processing → Confirmation
│
├─ Configuration
│  ├─ Environment: Staging
│  ├─ Browsers: Chrome, Firefox
│  └─ Devices: iPhone 14, Pixel 7
│
└─ Settings
   ├─ Timeout: 5 minutes
   ├─ Retry: 2 attempts
   └─ On Failure: Send Email

---

Next Steps After Creating

You Can Now:

✅ Execute the workflow - Run tests and see results ✅ Schedule it - Set up automatic runs ✅ Share with team - Give others access ✅ Add more workflows - Create variations ✅ View reports - Analyze execution data

Continue Learning:

🎯 Execute Your Workflow

Executing Workflows →

Learn how to run your workflow and view results!

After executing:

• Workflow Concepts - Deepen your understanding

• Nodes and Steps - Understand node types

• Data Propagation - Pass data between steps

• Scheduler - Automate execution

---

Summary Checklist

Before executing your workflow, verify:

• Workflow name is descriptive

• At least 2 nodes added to canvas

• All nodes are connected in sequence

• No unconnected/isolated nodes

• Run configuration is set

• Environment is correct

• Browsers/devices are selected

---

Questions? Check FAQ or Troubleshooting