Zephyr Squad With Team-Managed Projects

Applies to Zephyr Squad Cloud, last modified on September 21, 2023

To use Zephyr Squad in team-managed projects (formerly known as next-gen projects), you must enable Zephyr Squad for individual projects and set up a Test issue type. This is important as the Test issue type is used throughout Zephyr Squad. You won't be able to interact with the Zephyr Squad menu until the Test issue type is created and enabled.

You can change the issue type used by Zephyr Squad later if needed.

Create an issue type for Zephyr Squad

  1. Navigate to the project settings for your team-managed project.

    The settings of the team-managed project

    Click the image to enlarge it.

  2. Click Issue types on the sidebar.

    The Issue Types page of the team-managed project

    Click the image to enlarge it.

  3. Click Add issue type.

    Creating a new issue

    Click the image to enlarge it.

  4. Click Create issue type.

    Creating a new issue type

    Click the image to enlarge it.

  5. Enter the name for the issue type, for example, Test. You can also add a description and change the issue icon if you want.

    Note: We recommend using the Zephyr Squad icon as it allows you to easily distinguish a test.
    The Zephyr icon

    Click the image to enlarge it.

  6. Click Create.

Enable Zephyr Squad in a project

  1. Click Zephyr Squad in the project sidebar.

  2. Select the issue type that you want to use for Zephyr tests. If you have not created one yet, follow the steps above to create it.

    Selecting the Jira type

    Click the image to enlarge it.

  3. Click Enable.

    A Created Zephyr Test Issue

    Click the image to enlarge it.

Now you can create and use Zephyr Squad tests in your project.

Change the issue type used by Zephyr Squad

If needed, you can change the issue type used for Zephyr Squad tests (for example, from Test to Task or similar).

  1. Go to Project settings > Apps > Zephyr Squad.

  2. Click Change.

    Changing the issue type

    Click the image to enlarge it.

  3. Select another issue type to use for Zephyr Squad tests. To create a new one, follow the steps above.

    Changing the issue type

    Click the image to enlarge it.

  4. Important: Choose whether to migrate existing Zephyr Squad data from the old to the new issue type.

    • To migrate the data, select the Migrate the Zephyr Squad data in <IssueType> to the new Zephyr Squad Test issue type check box.

    • If you do not migrate the data, all pre-existing data for the original issue type will be deleted forever.

  5. Click Change.

Disable Zephyr Squad in a project

  1. Go to Project settings > Apps > Zephyr Squad.

  2. Click Disable Zephyr Squad in Project XXX.

    Disabling Zephyr Squad

    Click the image to enlarge it.

  3. Choose whether you want to delete or keep Zephyr Squad data:

    • If you choose to delete the data forever, it will be completely removed and cannot be recovered.

    • If you choose to keep the data, the next time you enable Zephyr Squad, the pre-existing data will be associated with the Test issue type mapped.

  4. Click Disable.

    The Disable button

    Click the image to enlarge it.

See Also

UI Overview
Terms and Concepts

Highlight search results