Creating a Project

Overview

A Project is the top-level container in Test Orchestration where you organize your workflows. Each project can contain multiple workflows, environments, and configurations specific to your testing needs.

💡 Think of Projects as Testing Suites

One project per application or major feature. Example: "E-Commerce Web", "Mobile Banking App", "Backend APIs".

---

Why Projects Matter

Projects help you:

Benefit	Example
Organize Work	Group all e-commerce tests in one project
Manage Permissions	Control who can access different projects
Isolate Configurations	Different environments per project
Track Execution	See all runs for one app in one place
Team Collaboration	Multiple team members working on same project

---

Step-by-Step: Creating Your First Project

Step 1: Navigate to Projects Section

1. Log into Test Orchestration

2. Look at the left sidebar

3. Click on "Projects"

4. You'll see the Projects page with existing projects (if any)

Screen Layout:

┌─ Projects ──────────────────────┐
│  ┌─ [+ Create Project]  Search  │
│  │                              │
│  ├─ Existing Project 1  • •     │
│  ├─ Existing Project 2  • •     │
│  └─ [No projects yet?]          │
└──────────────────────────────────┘

---

Step 2: Start Project Creation

1. Click the "+ Create Project" button (top-right corner)

2. A project creation dialog/form will appear

What You'll See:

┌─ New Project ─────────────────┐
│                               │
│ Project Name *                │
│ [________________________]     │
│                               │
│ Project Key *                 │
│ [____________]                │
│                               │
│ Description                   │
│ [_____________________]        │
│                               │
│  [Cancel]  [Create Project]   │
└───────────────────────────────┘

---

Step 3: Fill in Project Details

Field 1: Project Name (Required)

What to enter: A descriptive, human-readable name

📝 Naming Guide

Good project names tell you what the project tests at a glance.

Examples:

✅ Good Names:
   - E-Commerce Testing Suite
   - Mobile Banking App Tests
   - API Integration Tests
   - Regression Test Suite

❌ Avoid:
   - Project 1, Test 1, Project X
   - Random names with no meaning

Tips:

• Use clear, descriptive names

• Include app or feature name

• Be specific about test type if needed

• Aim for 30 characters or less

Example: Type E-Commerce Testing Suite

---

Field 2: Project Key (Required)

What to enter: A unique, short identifier (3-5 characters, uppercase)

🔑 Project Key Tips

The project key is used in URLs and system identifiers. Make it short and memorable.

Purpose: Used internally for quick identification, URLs, and filtering

Examples:

Project Name              →  Project Key
E-Commerce Testing       →  ECOM
Mobile Banking App       →  MOBBA
API Integration Tests    →  APIIT
Regression Suite         →  RGSN
Quality Assurance Setup  →  QASU

Rules:

• Must be unique (no two projects with same key)

• Use UPPERCASE letters

• Can include numbers

• No special characters (-, _, etc.)

• 3-5 characters ideal

Tips:

• Use first letters of each word: "ECOM" for "E-Commerce"

• Keep it short and memorable

• Makes URLs cleaner

Example: Type ECOM

---

Field 3: Description (Optional)

What to enter: Brief explanation of the project's purpose

Purpose: Helps team members understand what this project tests

Examples:

✅ Good Descriptions:
   - Testing end-to-end checkout flow including Web, Mobile, and API
   - Comprehensive regression testing for mobile banking features
   - API integration tests for payment processing system
   - Daily smoke tests for critical user paths

❌ Avoid:
   - Test project
   - Project for testing
   - Random text

Tips:

• Be concise but informative

• Include key scope (Web/Mobile/API)

• Mention main focus area

• 1-2 sentences is enough

Example: Type End-to-end testing for e-commerce checkout flow including Web, Mobile, and API validations

---

Step 4: Review and Create

1. Review all entries:

   • Project Name is descriptive

   • Project Key is unique and uppercase

   • Description explains the purpose

2. Click "Create Project" button

3. Wait for confirmation:

   • Page reloads

   • Project appears in Projects list

   • You're ready to add workflows

✅ Project Created Successfully!

Your project is now ready. Next step: Create your first workflow!

---

What Happens After Creation?

Automatic Setup

When you create a project, Test Orchestration automatically:

✅ Creates default environments:
   - Development
   - Staging
   - Production

✅ Sets up project structure:
   - Workflows container
   - Schedules container
   - Reports container

✅ Configures permissions:
   - You as project owner
   - Default access levels
   - Team member invitation capability

Project States

Your project can be in different states:

State	Meaning	Actions
Active	Ready to use	Create workflows, execute tests
Archived	Not in active use	View only, can be restored
Inactive	Temporarily disabled	No execution allowed

---

After Creating Your Project

You Can Now:

✅ Create Workflows - Add test sequences inside the project ✅ Invite Team Members - Share project access with colleagues ✅ Configure Environments - Set up Dev, Staging, Prod ✅ Schedule Runs - Automate test execution ✅ View Reports - Track execution history

Next Steps:

🚀 Continue Building

Now that you have a project, let's create your first workflow inside it!

Creating a Workflow →

Then explore:

• Workflows Concepts - Learn how workflows work

• Projects in Depth - Advanced project features

• Run Configuration - Customize execution

---

Project Management Overview

Finding Your Project

Once created, find your project:

1. Go to Projects section

2. Look for your project name in the list

3. Projects show:

   • Name and key

   • Number of workflows

   • Last modified date

   • Quick action buttons

Opening a Project

To open a project:

1. Click on project name in the list

2. OR click the project card

3. You'll see the project dashboard

Project Dashboard

Shows:

┌─ Project Dashboard ─────────────┐
│ Project: E-Commerce Testing     │
│                                 │
│ [Create Workflow +] [Settings]  │
│                                 │
│ Workflows:                      │
│ ├─ Checkout Flow                │
│ ├─ Search & Filter              │
│ └─ [+ Create New]               │
│                                 │
│ Recent Executions:              │
│ ├─ Checkout Flow (PASSED)       │
│ └─ Search & Filter (FAILED)     │
└─────────────────────────────────┘

---

Best Practices for Projects

✅ DO:

1. Create One Project Per Application

   • Project: "E-Commerce Web App"

   • Project: "Mobile Banking"

   • Project: "Backend APIs"

2. Use Clear, Descriptive Names

   • ✅ "User Registration Testing Suite"

   • ❌ "Project 1"

3. Fill in Descriptions

   • Helps team members understand purpose

   • Useful for onboarding new people

4. Organize by Feature or Team

   • Projects by feature: "Payment Module", "User Profile"

   • Projects by team: "Backend Team", "Mobile Team"

5. Document Project Purpose

   • Add description with context

   • Include main test areas

❌ DON'T:

1. Create Too Many Projects

   • Avoid one project per test

   • Group related tests in one project

2. Use Generic Names

   • ❌ "Test Project", "Project X", "Testing"

   • ✅ "E-Commerce Regression Suite"

3. Mix Unrelated Tests

   • ❌ Web tests and API tests in one project (if separate apps)

   • ✅ All web tests for same app in one project

4. Leave Descriptions Empty

   • Future team members won't understand purpose

   • Difficult to maintain

---

Common Scenarios

Scenario 1: New Feature Testing

Project: "Payment Gateway v2 Testing"
Key: PGWV2
Description: "Testing new payment gateway integration with Web, Mobile, and API"

Workflows:
├─ Credit Card Processing
├─ Digital Wallet Integration
├─ Refund Processing
└─ Security Validation

Scenario 2: Multi-Platform Testing

Project: "Mobile App Quality Assurance"
Key: MAPP
Description: "Cross-platform testing for iOS and Android apps"

Workflows:
├─ iOS E-E Flow
├─ Android E-E Flow
├─ Cross-Platform Validation
└─ Performance Testing

Scenario 3: Daily Smoke Tests

Project: "Production Smoke Tests"
Key: PRODSM
Description: "Daily smoke tests for critical production paths"

Workflows:
├─ Login Flow
├─ Dashboard Load
├─ Key Feature Check
└─ Logout

---

Troubleshooting: Can't Create Project?

Issue: Button Not Appearing

Solution:

• Check sidebar for "Projects" option

• Refresh the page

• Check user permissions with admin

Issue: Project Key Already Exists

Solution:

• Project keys must be unique

• Choose a different key

• Try: "ECOM2", "ECOM_V2", etc.

Issue: Form Won't Submit

Solution:

• Ensure all required fields filled (name, key)

• Project Name cannot be empty

• Project Key must be uppercase

• Check for special characters

Issue: Project Not Appearing After Creation

Solution:

• Refresh the page

• Check Projects list

• May need to log out and back in

• Contact admin if still not visible

---

Summary

Step	Action	Time
1	Navigate to Projects	30 sec
2	Click Create Project	10 sec
3	Enter project name	1 min
4	Enter project key	1 min
5	Add description	1 min
6	Click Create	30 sec
Total	Create First Project	~4 minutes

---

What's Next?

✅ Project Created! Now let's build workflows inside it.

🎯 Next: Create Your First Workflow

Creating a Workflow →

You'll learn how to add test scripts and connect them visually.

---

Questions? Check FAQ or Troubleshooting