Using Shared Steps in Test Cases Guide

Using Shared Steps in Test Cases

To insert a shared step into a test case:

  1. Open the test case editor (create or edit mode).

  2. In the steps section, click “Insert Shared Step” or use the shared step insertion feature.

  3. A modal will appear showing all available shared steps.

  4. Select the shared step you want to insert.

  5. The shared step’s steps will be inserted into your test case.

  6. You can edit the inserted steps if needed (depending on configuration).

Shared Step Usage:

  • Consistency: All test cases using a shared step will have the same steps
  • Updates: When you update a shared step, all test cases using it are automatically updated
  • Parameters: Shared steps can use parameters, which are resolved when the test case is executed
  • Files: Files attached to shared steps are included when the shared step is inserted

Best Practices

When creating and managing shared steps:

  1. Clear Naming: Use descriptive names that indicate what the shared step does
  2. Comprehensive Descriptions: Add descriptions to help others understand when to use the shared step
  3. Modular Steps: Create shared steps for common, reusable procedures
  4. Parameter Usage: Use parameters to make shared steps flexible and reusable
  5. Regular Updates: Keep shared steps up to date as procedures change
  6. Usage Review: Periodically review which test cases use each shared step
  7. Documentation: Document complex shared steps with detailed descriptions
  8. Scope Management: Use project scope appropriately (all vs selected projects)

Use Cases

Common Test Procedures

  • Create shared steps for frequently used procedures (login, logout, navigation)
  • Reuse across multiple test cases
  • Update once to update all test cases

Standardized Testing

  • Enforce standard testing procedures across teams
  • Ensure consistency in test execution
  • Maintain quality standards

Complex Workflows

  • Break down complex workflows into reusable shared steps
  • Combine multiple shared steps in test cases
  • Maintain complex procedures in one place

Environment-Specific Steps

  • Use parameters to make shared steps work across environments
  • Reference environment-specific values (URLs, credentials)
  • Update parameters without modifying shared steps

Next Steps

  • Learn about Parameters to make shared steps more flexible
  • Explore Custom Fields to extend data capture in test cases
  • Read about Test Execution to understand how shared steps are used during test runs

Was this page helpful?