---
title: "Test Plans in the Testing Board"
canonical: "https://docs.getxray.app/space/XRAYCLOUD/44565285/Test%20Plans%20in%20the%20Testing%20Board"
format: markdown
---
> Macro (ui-expand)
>
> > Macro (toc)
# Introduction
Test Plans can be viewed and managed from the Testing Board.
The Testing Board is a Test Plan-level feature that allows you to organize tests hierarchically within folders. Each Test Plan has an associated Test Plan Board, and a Test can only belong to one folder within the Board.
This page will help you understand the Test Plan Board screen and the operations available within it, such as easily creating [Test Executions](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565117) from a folder or selected tests.
# Access
> Macro (ui-steps)
>
> > Macro (legacy-content)
>
> > Macro (legacy-content)
>
> > Macro (legacy-content)
>
> > Macro (legacy-content)
# Test Plans Board Landing Screen Overview
- Figure 4 - 1: filter Test Plans by text.
- Figure 4 - 2: toggle to filter Test Plans assigned to the logged-in user or not.
- Figure 4 - 3: custom filters to filter the Test Plans in the project.
- Figure 4 - 4: select a field to sort Test Plans by.
- Figure 4 - 5: select ascending or descending order to sort the Test Plans.
- Figure 4 - 6: create a new Test Plan.
- Figure 4 - 7: export the Test Plan listed either as a CSV file or through the Document Generator.
- Figure 4 - 8: set the scope of the status for the progress bar.
- Figure 4 - 5: Test Plan ID/link to the respective Test Plan Issue.
- Figure 4 - 9: Test Plan progress bar.
# Test Plan Board
## Overview
To see a Test Plan from the Test Plans Board, click the Test Plan ID/link (Figure 5 - 5).
Figure 5 depicts the main areas of the Test Plan Board screen, which include the Test Plan Board itself, along with its sub-folders.
- Test fields section (Figure 5 - 3)
- Figure 5 - 1: breadcrumb links for the Testing Board.
- Figure 5 - 2: Test Plan summary (can be edited if the Issue is editable).
- Figure 5 - 4: add Tests to the Test Plan.
- Figure 5 - 5: edit by opening the Jira Issue dialog.
- Figure 5 - 6: scope of the status of the Tests.
- Figure 5 - 7: menu icon that allows the configuration of the Test Plan and/or creation of a report through the Document Generator.
- Figure 5 - 3: Test Plan fields (can be edited inline if the Issue is editable).
- Figure 5 - 8: overall progress.
- Figure 5 - 9: create a Test Execution in the Test Plan.
- Figure 5 - 10: link to the Test Executions associated with the Test Plan.
- Folders section (Figure 4 - 11)
- Figure 5 - 13: context actions for the currently selected folder; these actions are also accessible by right-clicking a folder.
- Figure 5 - 12: a given folder; CRUD actions for the selected folder (e.g., create, rename, delete, etc.) can be accessed by right-clicking the folder.
- Figure 5 - 13: number of Tests within the current folder and the total Tests, including sub-folders.
- Tests section (Figure 5 - 14)
- Figure 5 - 14: search bar to find Issues.
- Figure 5 - 15: listed Issues.
- Figure 5 - 16: toggle to find *Only My Issues*.
- Figure 5 - 17: filters to refine the Issue search.
- Figure 5 - 18: switch from hierarchical to flat view.
- Figure 5 - 19: folder progress.
- Figure 5 - 20: button to open a modal with the Test Runs of the given Test in the context of the Test Plan.
- Figure 5 - 21: status of the Test.
- Figure 5 - 22: button to open the dataset defined for the respective Test.
## View Mode: Flat or Hierarchical
You can choose between the traditional, hierarchical/folders view or a flattened view.
If you choose *Folders View*, in the *Tests *section (Figure 5 - 25), you will see only the Tests that are direct subfolders of the folder selected on the left side, within the Folders section (Figure 5 - 11). 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; Figure 5 - 15) 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 execute an operation on them.
Click the *View* button (Figure 5 - 25) to switch between views.
## Operations
### Going from an Issue to the Test Plan Board
Go to the Test Plan Issue (Figure 6) and click the *View on board* option (Figure 6 - 1). You will be immediately taken to the Test Plan Board (Figure 5).
### Test Fields Section
The Test Fields section (Figure 7 - 1) presents some information regarding the Test Plan, namely its description, its assignee (Figure 7 - 2), and its fix versions (Figure 7 - 3). This section can be collapsed or expanded (Figure 7 - 4).
If the Test Plan is editable, the fields can be edited inline. Otherwise, the fields will be displayed in read-only mode. To edit a field, click it and it will enter edit mode. The changes will be saved automatically when exiting the field by clicking outside of it.
#### Tracking Progress
The Board presents the consolidated results for the Tests that are part of the Test Plan (Figure 7 - 5). In other words, you're able to see the latest status for each Test that is being tracked on the Test Plan, regardless of the number of runs you make for it. If you schedule and run multiple Test cycles (i.e., Test Executions), the Board will group the results from those executions and will show you the calculated status for each Test.
You can then see the overall execution status of the Test Plan, globally taking into account 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 (Figure 7 - 6).
##### Overall Progress
Use the top progress bar (Figure 7 - 5) to track the overall progress of the Test Plan.
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 PASSED 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 (Figure 7 - 7), 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 *(Figure 7 - 8).
The values shown for each folder only consider the immediate sub-Tests (i.e., the Tests that are within that folder). Thus, this bar shows the totals for the Tests that are seen underneath it.
On the right side of each Test (Figure 8 - 6), 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, considering the selected Test Environment.
##### Progress Analysis
Tests can be analyzed by [Test Environment](https://getxraydocs.atlassian.net/wiki/display/XRAYCLOUD/Working+with+Test+Environments) (i.e., considering the results for some given Test Environment) using the proper action (Figure 7 - 8), to see the current testing status for that environment.
This way, you can analyze on a per Test Environment basis or see the overall status if you choose *All Environments*.
#### Test Executions
##### Creating a Test Execution
To create a Test Execution with all the Tests in the Test Plan:
> Macro (ui-steps)
>
> > Macro (legacy-content)
>
> > Macro (legacy-content)
To create a Test Execution with Tests filtered by status:
> Macro (ui-steps)
>
> > Macro (legacy-content)
>
> > Macro (legacy-content)
>
> > Macro (legacy-content)
##### Viewing Associated Test Execution
The Text Execution(s) link (Figure 12 - 3) allows you to see how many Test Executions are associated with the Test Plan.
Click that link (Figure 12 - 3) to view those Test Executions in the [Test Executions board](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44579147) (Figure 13).
### Folders Section
A folder can be selected by clicking it (Figure 14 - 2). Once selected, you can perform context actions by right-clicking the folder (Figure 14 - 1), or by using the three-dotted icon at the top of the folder's section (Figure 14 - 3).
> ℹ️ It is not possible to select multiple folders.
#### Creating a Folder
> Macro (ui-steps)
>
> > Macro (legacy-content)
>
> > Macro (legacy-content)
>
> > Macro (legacy-content)
#### Renaming a Folder
> Macro (ui-steps)
>
> > Macro (legacy-content)
>
> > Macro (legacy-content)
#### Expanding/Collapsing Folders
Folders can be expanded or collapsed easily just by clicking the arrow icon next to the folder (Figure 19 - 1).
You can also use the *Collapse All* button (Figure 19 - 2) to collapse all the folders from that Test Plan repository.
#### Removing Folders
You can remove an existing folder and its descendant folders.
> Macro (ui-steps)
>
> > Macro (legacy-content)
>
> > Macro (legacy-content)
>
> > ℹ️ Tests that were in one of the removed folders will not be deleted. Tests will be removed from the Test Plan Board but will appear in the Board folder, so they can be organized in the Test Repository again if needed.
#### Viewing Issues
You can view the Test Issues, from the selected folder and its sub-folders, in the Issue search screen. This option is only available if there are Issues in the selected folder.
> Macro (ui-steps)
>
> > Macro (legacy-content)
>
> > Macro (legacy-content)
#### Moving from One Folder to Another
A folder, including its descendants, can be moved to another folder just by dragging and dropping it into the destination folder.
> Macro (ui-steps)
>
> > Macro (legacy-content)
>
> > Macro (legacy-content)
>
> > ℹ️ Dragging the folder directly on top of some existing folder will append it to the list of current child folders.
#### Ordering / Ranking Folders
You can also move directly to a given position/rank by dragging and dropping the folder in the new desired position, by using the interim space between two existing folders (Figure 24).
> ℹ️ If you wish to rank the folder as the last one (i.e. move it to the last position) within some parent folder, drag it to the parent folder.
#### Creating a Test
You can create a Test that will be automatically associated with the selected folder.
> Macro (ui-steps)
>
> > Macro (legacy-content)
>
> > Macro (legacy-content)
>
> > Macro (legacy-content)
>
> > ℹ️ The process is the same for creating Test Sets with Test/s and Test Executions with Test/s. Just select the corresponding options in Step 2.
> > ℹ️
> > ℹ️ The ranking of the **Tests within the Test Set** will respect the ranking they already have in the **Test Repository folder**.
> > ℹ️
> > ℹ️ The ranking of the **Tests within the Test Execution** will respect the ranking they already have in the **Board folder.**
#### Adding Tests to a Folder
You can add Tests to an existing folder based on filters or JQL.
This action corresponds to moving them from any folder they may already be (including the **Board **folder) to the destination folder. Thus, if you add a Test that is currently in some folder within the Test Repository to some destination folder, then it will be moved from the source folder to the destination folder.
> Macro (ui-steps)
>
> > Macro (legacy-content)
>
> > Macro (legacy-content)
>
> > Macro (legacy-content)
>
> > Macro (legacy-content)
>
> > ℹ️ The process is the same for adding Test/s to Test Set and adding Tests to Test Execution.
> > ℹ️
> > ℹ️ The ranking of the **Tests within the Test Set** will respect the ranking they already have in the **Test Repository** folder. If Tests already exist in the destination Test Set, then their ranking in the Test Set is not changed.
> > ℹ️
> > ℹ️ The ranking of the **Tests within the Test Execution** will respect the ranking they already have in the **Board folder.**
##### Document Generator
> ℹ️ You have to enable the Document Generator option on the [Xray global settings](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44566331), to use it.
> Macro (ui-steps)
>
> > Macro (legacy-content)
>
> > Macro (legacy-content)
>
> > Macro (legacy-content)
### Tests Section
Tests can be selected by clicking them. Multiple Test selections are possible by pressing the *Ctrl* key (on Windows) or the *Cmd* key (on Mac OS X). If you want to select more than one Test and the Tests are listed consecutively, press the *Shift* key to quickly select an entire group. 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 item, the last item, and all items in between.
After selecting one or more Tests, context actions can then be executed on them, such as creating a Test Set, Test Execution, etc. (Figure 32 - 5).
#### Filtering Visible Tests
The list of visible Tests can be filtered, so you can easily see and obtain the relevant Tests you need. The filter is applied when you change to another folder.
Filtering Tests is quite useful, for example, when creating the structure of the Test Repository based on a subset of Tests from the **Board **folder.
You can search (Figure 32 - 1) and/or filter the list of visible Tests to make it easier to pick the Tests you need (Figure 32 - 2; 3). To remove this filter, delete the keyword/s you entered.
##### Showing Issues Assigned to You Only
Click the *Only My Issues* button (Figure 32 - 2).
To remove the filter, click the *Only My Issues* button (Figure 32 - 2) again.
##### Filtering by Custom Filters
1. Click *Filters* (Figure 33 - 1).
2. Select *Basic* (Figure 33 - 2).
3. If you select *Basic*, you will have a series of dropdown menus, so that you can pick the options most useful to your search (Figure 33 - 3).
4. Click *Apply* (Figure 33 - 5).
> ℹ️ If you select *Advanced *(Figure 33 - 2), you will be able to make a JQL search.
> ℹ️
> ℹ️ To remove the filter/s, click the *Clear* button (Figure 33 - 4) and then *Apply* (Figure 33 - 5).
#### Moving Tests to Another Folder
Tests can be moved to another folder by selecting, dragging, and dropping them to the destination folder.
You can also use this operation for moving Tests (i.e., adding Tests) from folder to folder within the Test Repository.
#### Ordering / Ranking
Tests can be ranked within a folder by using drag-and-drop.
> ℹ️ When creating a Test Set, Test Execution, or Test Plan, or adding Tests to an existing one, Xray will respect the order of the Tests, taking into account the ranking they have in the Test Repository.
> ℹ️
> ℹ️ The algorithm starts by adding the Tests of the folder, respecting their rank in the folder, and then iterates through the sub-folders. Each sub-folder is processed the same way.
> ℹ️
> ℹ️ If a Test already exists in the destination entity (e.g., Test Set/Plan/Execution), then it is not added again, and the current ranking is maintained.
#### Creating a Test Set with Tests
> Macro (ui-steps)
>
> > Macro (legacy-content)
>
> > Macro (legacy-content)
>
> > Macro (legacy-content)
>
> > ℹ️ This process is the same if you wish to *Create a Test Execution with Test(s)*. Just select the corresponding option in Step 2.
#### Adding Tests to Test Set(s)
> Macro (ui-steps)
>
> > Macro (legacy-content)
>
> > Macro (legacy-content)
>
> > Macro (legacy-content)
>
> > Macro (legacy-content)
>
> > ℹ️ The process is the same for adding *Tests to Test Execution*. Just select the corresponding option in Step 2.
#### Moving Tests to Root
You can move Tests to the Boaes (root) folder; this is equivalent to removing them from the Test Repository.
There are two different ways to move Tests to the *Test Repository* folder:
1. Select the Tests you want to move.
2. Drag the Tests and drop them on the *Board*** **folder, or right-click the Test/s and, from the box of options, select the *Move to Root* option (Figure 38 - 1).
#### Viewing Issues
You can use the context action View Issues to view the selected Tests on the Search Issues screen.
> Macro (ui-steps)
>
> > Macro (legacy-content)
>
> > Macro (legacy-content)
#### Document Generator
> Macro (ui-steps)
>
> > Macro (legacy-content)
>
> > Macro (legacy-content)
>
> > Macro (legacy-content)
>
> > Macro (legacy-content)
#### Removing Tests
> Macro (ui-steps)
>
> > Macro (legacy-content)
>
> > Macro (legacy-content)
>
> > Macro (legacy-content)
Support/Troubleshooting
If you have questions or technical issues, please [contact the Support team via the Customer Portal (Jira service management)](https://jira.getxray.app/servicedesk/customer/portal/2/user/login?destination=portal%2F2%2Fcreate%2F28) or [send us a message using the in-app chat](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44577312).