The Test Plan Board is a Test Plan-level test organization feature that allows you to organize Tests hierarchically in folders. Always remember that each Test Plan has an associated (Test Plan) Board and that a Test can only belong to one folder within the Board. 

This page will help you understand the Test Plan Board screen and the available operations within it, such as the ability to easily create Test Executions from a given folder or from selected Tests.

Dynamic Test Plan on the Test Plan Board (Xray Enterprise Feature)

In the Test Plan Board context, you can have a Test Plan configured with a Saved Filter. In this situation, there are some restrictions on the operations available:

1. The "Add Tests" button is unavailable on the Test Plan Board.
2. The Remove Tests action is not provided on the test cards on the Test Plan Board.
3. It is not possible to create new Tests on the Test Plan board. 

Settings

Overview of the Test Plan Board UI

The Test Plan Board screen can be accessed from the project left sidebar by choosing the Test Plan Board icon.

The following picture depicts several key areas of the Test Plan Board screen, including the Board itself and other auxiliary folders.

T: Title section

• • T1: Test Plan's issue key
  • T2: Test Plan's issue summary (with the possibility of switching to another issue)
  • T3: Test Plan's Overall Execution Status
    
    

A: Folders section

• • A1: "All" and "Orphans" meta-folders
  • A2: the Test Repository itself, composed of folders and sub-folders with Tests organized within them
  • A3: CRUD actions for the currently selected folder (e.g., create, rename, delete)
  • A4: information about the number of Tests within the current folder and the total Tests, including sub-folders
    
    

B: Tests section

• • B1: the path of the folder
  • B2: overall execution status for this folder (takes into account the Test Environment selected) 
  • B3: Test Environment to consider for the computation of the overall execution status
  • B4: Test filters 
  • B5: displayed Tests vs the actual total number of Tests within the current folder 
  • B6: ranked list of Tests within the current folder (only direct children)
  • B7: calculated status for each Test, based on runs from related Test Executions in the selected Test Environment

C: Switch between "flat view" and "folders view" 

Clicking on T1 will redirect you to the standard Test Plan issue screen.

How to access it

To reach the Test Plan Board UI, you can use the proper project icon at the top "Tests" menu. 

It is also accessible right from the Test Plan issue screen.

                             

Switching between Test Plans

After entering the Test Plan Board UI, you can switch between different Test Plans to manage their respective Boards. 

To switch between Test Plans:

Step 1: Click on the Test Plan summary.

       

Step 2: Search/select the issue key or summary of the desired Test Plan.

        

      

Tracking progress

The Board presents the consolidated results for the Tests that are part of the Test Plan; in other words, you can see the latest status for each Test that is being tracked on the Test Plan, regardless of the number of runs you have made for it. If you schedule and run multiple test cycles (i.e., Test Executions), the Board will group the results from those executions and show you the calculated status for each Test.

You can then see the overall execution status of the Test Plan globally, considering all the planned Test Executions you create in the different environments.

If you need to drill-down and see the current status for a subset of Tests, you can do it at the folder level.

Overall progress

To track the overall progress of the Test Plan, use the top progress bar (T3).

Moving the cursor over the bar elements will give information on the number of Tests (absolute and percentage) that are currently in that status.

The overall execution status considers the joint results for all the Test Environments in which you have run your Tests (i.e., a Test will appear as PASS only if it passed in all the Test Environments for which you scheduled Test Executions).  

Folder progress

By allowing you to see the progress per folder (B2), you can analyze the status of a subset of Tests that are part of the Test Plan.

The analysis per folder considers the selected Test Environment; by default, it shows the calculated status for "All Environments."

The values shown for each folder only consider the immediate child Tests (i.e., the Tests within that folder). Thus, this bar shows the totals for the Tests that are seen "underneath" it.

On the right side of each Test (B7), you can see the current calculated status for that Test in the context of the Test Plan and the selected Test Environment. The status that is shown corresponds to the last run made for that Test in the scope of the related Test Executions, taking into account the selected Test Environment.

Analysis by Test Environment 

Tests can be analyzed by Test Environment (i.e., taking into account the results for some given Test Environment) using the proper action (B3) to see the current testing status for that environment.

Thus, you can analyze on a per Test Environment basis or see the overall status if you choose "All Environments." For more information on using Test Environments and calculating the status for a given environment, please see Working with Test Environments.

The analysis by Test Environment is only applicable to the folder progress bar (B2) and the individual test statuses (B7).

View Actions

You can choose between the traditional hierarchical/folders view or the flattened one.

If you choose "Folders View," then in the Tests section (B), you will see just the Tests that are direct children of the folder selected on the left side within the Folders section (A). In this case, you can only select Tests directly within the currently selected folder.

On the other hand, if you prefer, you can switch to a "Flat View";  if so, you'll see on the right side (Tests section) all the Tests that belong to that folder and related sub-folders, grouped by folder. Then you can apply a filter if you want, select some of the Tests (no matter in which sub-folder they're in) and do an operation for them.

Folder Actions

A folder can be selected by clicking on it. 

Once selected, you can do some context actions or use the icons available at the bottom of the folders section.

Note: Currently, it is not possible to select multiple folders.

Create

To create a new folder:

Step 1: Click on the parent folder.

Step 2: Click on the proper add icon at the bottom of the folders section.

Step 3: Type the name of the folder.

Step 4: Press Enter or click outside of the selected folder.

Rename

To rename an existing folder:

Step 1: Either double-click on the folder or select the folder and then click the proper edit icon at the bottom of the folders section.

Step 2: Type the new name for the folder.     

Step 3: Press Enter or click outside of the selected folder 

Remove

You can easily remove an existing folder and its descendant folders.

Tests that were in one of the removed folders will not be erased; Tests will be removed from the Test Repository to the Orphans meta-folder, so they can be organized in the Test Repository again if needed.

To remove a folder:

Step 1: Click on the parent folder.

Step 2: Click on the proper remove icon at the bottom of the folders section.

Step 3: Confirm removal of the folder.

Expand/Collapse

Folders can be expanded or collapsed easily by clicking the folder.          

           

Expand/Collapse All

Expand all and collapse all actions are available as contextual actions. These actions alow 

To expand all or collapse all the subfolders of a folder:

Step 1: Click on the parent folder.

Step 2: Use the context action Expand All or Collapse All.

   

View Issues

You can view the Test issues, from the selected folder and its subfolders, in the issue search screen.

To view the Test issues:

Step 1: Click on the folder.

Step 2: Use the context action View Issues.

You will be redirected to the search issues page

Moving to another folder

A folder, including its descendants, can be moved to another folder just by dragging and dropping to the destination folder.

    

Dragging the folder directly on top of an existing folder will append it to the list of current child folders.

You can also move directly to a given position/rank by choosing the interim space between the existent folders.

    

Ordering / Ranking

A folder can be ranked within its parent folder by using drag-and-drop.

Note: If you wish to rank it as the last one (i.e., move it to the last position) within a parent folder, you need to drag it to the parent folder.

     

Create Test here

You can create a Test and associate it automatically with the selected Test Plan Board folder.

To create a Test in a folder,

Step 1: Click on the folder.

Step 2: Use the context action Create Test here.

Step 3: Fill out the Test fields and click Create. You have created a brand-new Test and associated it with the selected folder.

    

Move into

Users can "add" Tests that are already part of the Test Plan to an existing folder based on some filters or JQL.

This action corresponds to "moving" them from any folder they may already be in (including the Orphans) to the destination folder. Thus, if you "add" a Test currently in some folder within the Board to a destination folder, it will essentially be moved from the source folder to the destination folder. Note that the Test must already be part of the Test Plan.

If you want to add Tests to the Test Plan, you need to go to the Test Plan issue screen and use the Add Tests button.

To "add" Tests to a folder:

Step 1: Right-click on the folder.

Step 2: Use the context action Move into.

Step 3: Choose the Tests you want using the provided filters, a previously saved filter, or by JQL.

Note: An error message will be displayed if you try to add non-Test issues or Tests that are not part of the Test Plan (e.g., by using a saved filter).

Create Test Set

Users can easily create a Test Set with all the Tests in a given folder and its descendant folders.

The ranking of the Tests within the Test Set will respect their ranking in the Test Repository folder.

To create a Test Set with all the Tests of a given folder, including its descendants:

Step 1: Click on the folder.

Step 2: Use the context action Create Test Set.

Step 3: Fill out the Test Set fields and click Create. Your brand-new Test Set is created with all the Tests in the proper order.

     

Add to Test Set(s)

Users can add Tests to an existing Test Set with all the Tests in a given folder and its descendant folders.

The ranking of the Tests within the Test Set will respect their ranking in the Test Repository folder. If Tests already exist in the destination Test Set, their ranking in the Test Set is not changed.

To add Tests from a folder, including its descendants, to an existing Test Set(s):

Step 1: Click on the folder.

Step 2: Use the context action Add to Test Set.

Step 3: Choose the Test Set(s) key(s) and select Add selected. The Test Set(s) will now be updated.

    

Create Test Execution

You can easily create a Test Execution with all the Tests in a given folder and its descendant folders. This Test Execution will automatically be linked to the Test Plan.

The ranking of the Tests within the Test Execution will respect their ranking in the Board folder.

To create a Test Execution with all the Tests of a given folder, including its descendants:

Step 1: Click on the folder.

Step 2: Use the context action Create Test Execution.

Step 3: Choose the Tests based on their consolidated status in a specific Test Environment. You can choose all Tests using the top left-side option; the Test Environment can be chosen in the top right-side option. You can see the number of Tests currently in that consolidated status for all shown statuses. You may choose one or more statuses. In the example below, we will include just the (1) Test currently failing.  

       

Step 4: Fill out the Test Execution fields and click Create. Your brand-new Test Execution is created with all the Tests, considering the previous selection, in the proper order.

    

Add to Test Execution(s)

You can add Tests to an existing Test Execution with all the Tests in a given folder and its descendant folders.

Note that the destination Test Execution will not be automatically linked to the Test Plan. If you want to link it, you must do it manually.

The ranking of the Tests within the Test Execution will respect their ranking in the Test Repository folder. If Tests already exist in the destination Test Execution, their ranking in the Test Execution is not changed.

To add Tests from a folder, including its descendants, to an existing Test Execution(s):

Step 1: Click on the folder.

Step 2: Use the context action Add to Test Execution.

Step 3: Choose the Test Execution(s) key(s) and select Add selected. The Test Execution(s) will now be updated.

    

Tests Actions

Tests can be selected by clicking on them. Multiple selections are possible by using the "Ctrl" key (on Windows) or the "Cmd" key (on OS X). If you want to select more than one Test and the Tests are listed consecutively, use the "Shift" key to select an entire group quickly. Click the first Test in the list you want to select, hold down the "Shift" key, scroll down to the last Test you want, and click it. This selects the first, last, and all items in between.

You can also filter the list of visible Tests to make it easier to pick the Tests you need.

After selecting one or more Tests, context actions can be done on them, such as creating a Test Set, Test Execution, etc.

Filtering visible Tests

The list of visible Tests can be filtered, so you can easily see and obtain the relevant Tests you need. Note that the filter is applied if you change to another folder.

Filtering Tests is quite useful, for example, when creating the structure of the Board based on a subset of Tests from the All or Orphans meta-folders.

     

Moving to another folder

You can move Tests to another folder by using drag-and-drop to the destination folder.

You can also use this operation for "adding" Tests (i.e., moving Tests) from the meta-folders (i.e., All, Orphans) to folders within the Test Repository.

Ordering / Ranking

Tests can be ranked within a folder by using drag-and-drop. 

Create Test Set

Use the context action Create Test Set to create a new Test Set containing the selected Tests. 

Add to Test Set(s)

Use the context action Add to Test Set to add selected Tests to an existing Test Set. 

Create Test Execution

Use the context action Create Test Execution to create a new Test Execution containing the selected Tests.

Note that when creating a Test Execution from a folder or selecting Tests, this Test Execution will be linked to the Test Plan.

Add to Test Execution(s)

Use the context action Add to Test Execution to add selected Tests to an existing Test Execution. 

Note that the destination Test Execution will not be automatically linked to the Test Plan. If you want to link it, you must do it manually.

Move to Orphans

You can move Tests to the Orphans folder, which is equivalent to removing them from the Board.

In order to move Tests to the Orphans meta-folder:

Step 1: Select the Tests you want.

Step 2: Use the context action Move to Orphans

Step 3: Confirm by clicking on Move to Orphans.

View Issues

You can use the context action View Issues to view the selected Tests on the search issues page.

Step 1: Select the Tests you want.

Step 2: Use the context action View Issues.

How ranking works when creating or adding Tests to Test Sets, Test Executions, or Test Plans

Whenever creating a Test Set, Test Execution, or Test Plan or adding Tests to an existing one, Xray will respect the order that the Tests have in the Board.

The algorithm starts by adding the Tests of the folder, respecting their rank in the folder, and then iterates through the child folders. Each child folder is processed the same way.

If a Test already exists in the destination entity (e.g., Test Set/Execution), it is not added again, and the current ranking is maintained.