Workflows

Overview

A Workflow is a sequence of connected test scripts and actions that execute in a defined order. It's the core execution unit in Test Orchestration where you orchestrate multiple test steps, define conditional logic, and manage data flow between tests.

🔄 Workflow vs Script

Think of a workflow as an automated test script—but instead of writing code, you visually connect test nodes together. No coding experience required!

---

What is a Workflow?

A Workflow in Test Orchestration is:

• A visual automation sequence - Connect test scripts using a node-based interface

• An executable unit - Can be run on-demand or scheduled

• A reusable component - Can be used as sub-workflows in other workflows

• A container for logic - Includes conditional execution, retries, and error handling

• A data conduit - Passes data from one test to the next

Workflow Anatomy

Workflow: "E-Commerce User Journey"
├── Start Node
├── Node 1: API - Create User Account
├── Node 2: Web - User Login
├── Node 3: Web - Browse Products (Conditional)
├── Node 4: Mobile - Add to Cart
├── Node 5: API - Process Payment
├── Node 6: Wait - 5 seconds
├── Node 7: API - Verify Order Status
└── End Node

---

Workflow States

A workflow can exist in different states:

State	Description	Actions Available
Draft	Under development, not ready for execution	Edit, Delete, Publish
Active	Published and ready to execute	Run, Schedule, Edit, Archive
Archived	No longer in active use but retained	Restore, View, Delete
In Progress	Currently executing	View Progress, View Logs
Completed	Finished execution	View Results, Rerun

---

Creating a Workflow

Step-by-Step Guide

1. Start New Workflow

1. Open your Project

2. Click Create Workflow (or + New Workflow)

3. Choose creation method:

   • From Scratch - Build from blank canvas

   • From Template - Use pre-built patterns

   • From Existing Workflow - Duplicate and modify

2. Configure Basic Details

• Workflow Name - Descriptive name (e.g., "Complete Purchase Flow")

• Description - What this workflow tests

• Tags - For organization and filtering (optional)

  • Example: payment, smoke, regression

3. Set Workflow Parameters

• Timeout - Maximum execution time before auto-stop

• On Failure - What happens if a step fails:

  • Stop Workflow

  • Continue to Next Step

  • Skip to Error Handler

• Retry Logic - Automatic retry settings

4. Add the First Node

1. Click Add Node or + button on canvas

2. Select node type:

   • Test Script (Web, Mobile, API, Desktop)

   • Action (Wait, Retry, Stop, Send Email, etc.)

3. Configure the node

4. Click Add

5. Connect Additional Nodes

1. Click + Add Node again

2. Select the next node

3. Configure it

4. The connection is created automatically

5. Repeat for all steps

6. Review and Publish

1. Click Review

2. Check:

   • All nodes are connected

   • Parameters are correct

   • No orphaned nodes

3. Click Publish

4. Workflow is now active and ready to run

---

Workflow Components

Node Types

Test Nodes (Execute Test Scripts)

• Web Test Scripts

• Mobile Test Scripts

• API Test Scripts

• Desktop Test Scripts

Action Nodes (Workflow Control)

• Wait - Pause execution for a specified duration

• Retry - Retry a failed node

• Stop - End workflow execution

• Send Email - Send notification emails

• Data Hub - Access and manipulate shared data

• Comment - Add documentation

Conditional Nodes

• If-Then - Conditional branching

• Switch - Multiple conditional paths

Node Configuration

Each node contains:

1. Input Parameters

   • Test data required by the node

   • Can be static values or dynamic variables

2. Execution Settings

   • Timeout for this node

   • Skip conditions

   • Error handling

3. Output Mapping

   • What data to capture from node results

   • Available to downstream nodes

---

Data Flow in Workflows

Understanding Data Propagation

Data flows through your workflow from node to node:

Node 1 (Create User)
└─ Outputs: user_id, user_email
   ↓
Node 2 (Login with Email)
└─ Inputs: user_email (from Node 1)
   ↓
Node 3 (Update Profile)
└─ Inputs: user_id (from Node 1)

Using Output Variables

1. Node Output Variables

   • Referenced as: ${NODE_1.OUTPUT_FIELD}

   • Example: ${NODE_1.user_id}

2. Project Variables

   • Referenced as: ${PROJECT.VARIABLE_NAME}

   • Example: ${PROJECT.BASE_URL}

3. Workflow Variables

   • Custom variables defined within the workflow

   • Referenced as: ${WORKFLOW.VARIABLE_NAME}

4. Environment Variables

   • Environment-specific values

   • Referenced as: ${ENV.VARIABLE_NAME}

---

Workflow Execution

Running a Workflow

On-Demand Execution

1. Open the workflow

2. Click Run or Execute

3. Optional: Override parameters

4. Click Start Execution

5. Monitor progress in real-time

Scheduled Execution

See Scheduler documentation for detailed scheduling setup.

Quick start:

1. Open workflow

2. Click Schedule

3. Set frequency (One-time, Daily, Weekly, Monthly)

4. Set time and days

5. Click Save Schedule

Monitoring Execution

During workflow execution:

• Real-time Progress - Watch nodes execute

• Node Status - Green (passed), Red (failed), Yellow (running), Gray (skipped)

• Execution Timeline - See timing for each node

• Live Logs - View detailed execution logs

• Stop Execution - Click stop to end workflow

Execution Results

After execution completes:

1. Summary - Overall status, pass/fail, execution time

2. Node Details - Status and results for each node

3. Data Captured - Output values from each node

4. Logs - Detailed execution logs

5. Screenshots - Visual outputs if applicable

6. Performance Metrics - Timing and resource usage

---

Workflow Management

Editing a Workflow

1. Open the workflow

2. Click Edit

3. Make changes:

   • Add/remove nodes

   • Modify connections

   • Update parameters

   • Adjust logic

4. Click Save Draft to save without publishing

5. Click Update to publish changes

📝 Draft vs Published

Save as draft to work on changes without affecting existing executions. Publish when ready to make changes live.

Duplicating a Workflow

To create a copy of an existing workflow:

1. Open the workflow

2. Click Options (three dots)

3. Select Duplicate

4. Enter new workflow name

5. Click Create

The duplicate is created as a draft and can be modified independently.

Archiving a Workflow

To remove a workflow from active use:

1. Open the workflow

2. Click Options

3. Select Archive

4. Confirm archival

Archived workflows:

• Don't appear in active workflow list

• Cannot be executed

• Can be restored later

• Retain full history

Deleting a Workflow

To permanently delete a workflow:

1. Open workflow

2. Click Options

3. Select Delete

4. Confirm deletion

⚠️ Warning: Irreversible Deletion

Deletion is irreversible and all execution history is lost. Consider archiving instead if you might need this workflow later.

---

Workflow Best Practices

Design Principles

1. Single Responsibility

   • Each workflow should test one primary feature or scenario

   • Create separate workflows for different test scenarios

2. Reusability

   • Design workflows to be reusable across test suites

   • Use variables instead of hardcoded values

3. Clear Naming

   • Use descriptive workflow names

   • Include what is being tested

   • Example: "User Registration with Email Verification"

4. Error Handling

   • Always define what happens on failure

   • Use try-catch patterns with error handlers

   • Log errors for debugging

5. Documentation

   • Add descriptions to complex workflows

   • Use comments in nodes to explain logic

   • Document expected inputs and outputs

Performance Optimization

1. Minimize Wait Times

   • Use only necessary wait steps

   • Optimize timeouts

2. Sequential Execution

   • Use sequential nodes for clarity

   • Speeds up overall execution

3. Resource Efficiency

   • Don't run unnecessary steps

   • Use conditional logic to skip unneeded tests

4. Limit Workflow Scope

   • Don't create overly complex workflows

   • Break into smaller workflows if needed

---

Advanced Workflow Features

Conditional Execution

Execute different paths based on conditions:

Node 1: Get User Status
├─ If status = "Active"
│  └─ Node 2: Run Full Test Suite
└─ If status = "Inactive"
   └─ Node 3: Run Basic Checks

See Conditional Execution for details.

Independent Paths

Run multiple nodes in optimized sequence:

Node 1: Create Test Data
├─ Node 2A: Web Test
├─ Node 2B: Mobile Test
└─ Node 2C: API Test
   ↓
Node 3: Verify Results

See Conditional Execution for details.

Sub-Workflows

Nest workflows within workflows for reusability:

Main Workflow
├─ Setup Sub-Workflow
├─ Test Sub-Workflow
└─ Cleanup Sub-Workflow

Error Handling

Define what happens when nodes fail:

• Continue - Continue to next node despite failure

• Retry - Automatically retry the node

• Skip To - Jump to specific node

• Stop - End workflow execution

• Alert - Send notification

See Error Handling for details.

---

Workflow Versioning

Automatic Versioning

Test Orchestration automatically versions workflows:

• Each publish creates a new version

• Previous versions are retained

• Can view execution history per version

Accessing Version History

1. Open workflow

2. Click Versions (or History)

3. See list of all versions with:

   • Version number

   • Publication date

   • Author

   • Description

4. Click version to view or restore

---

Summary

• Workflows are the core execution unit in Test Orchestration

• Nodes are connected to create execution sequences

• Data flows from node to node through output variables

• Workflows can be scheduled for automated execution

• Advanced features support conditional logic and error handling

---

Related Topics

• Creating Workflows - Getting started guide

• Nodes and Steps - Understand workflow components

• Execution Flow - How workflows execute

• Data Propagation - Pass data between steps

• Scheduler - Automate workflow execution

• Advanced Topics - Conditional logic and error handling

Next: Learn about the building blocks of workflows in Nodes and Steps.