--- title: "Test Plan" canonical: "https://docs.getxray.app/space/XRAYCLOUD/44565153/Test%20Plan" format: markdown --- > Macro (ui-expand) > > > Macro (toc) # Introduction The purpose of a Test Plan is to give you better visibility and management over your Tests. It provides a table of all the Tests included in the Test Plan and their respective [Test Executions](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565117). A Test Plan can be defined as: - **Static**: add Tests explicitly to the Test Plan using the Xray Issue picker. - **Dynamic (****[Xray Enterprise](https://marketplace.atlassian.com/apps/1229688/xray-enterprise?hosting=cloud&tab=overview&showOnlyPublic=true)**** only):** define a Saved Filter as the source of Tests for the Test Plan. This way, all Tests on the filter will be added automatically to the Test Plan by Xray. For example, you can define a Test Plan with a filter containing the Tests associated with Stories from a Sprint. Your Test Plan will collect all relevant Tests for that Sprint automatically. If a Test Plan is configured with a Saved Filter, you can't add or remove Tests explicitly from the Test Plan. > ℹ️ ### Dynamic Test Plan is an Xray Enterprise Feature > ℹ️ > ℹ️ ![Banner-Xray-Documentation-Enterprise.png](media://8da93d32-a160-4f12-b91e-e7d9a6dfa7ca) > ℹ️ > ℹ️ Dynamic Test Plans is a feature of **[Xray Enterprise](https://marketplace.atlassian.com/apps/1229688/xray-enterprise?hosting=cloud&tab=overview&showOnlyPublic=true)**. If you do not have Xray Enterprise installed, the **Dynamic Test Plans are not available **in the Test Plan Issue, and it is impossible to configure dynamic test lists. When installing Xray Enterprise for the first time, please make sure to re-enable Xray to load all properties from Xray Enterprise. More below. # Managing Test Plans and Executions When tracking a particular version, the Test Plan displays the latest status for each test, regardless of the number of testing iterations (i.e., Test Executions) performed. You can group Test Executions and easily provide feedback on the current status of the tests involved. From the Test Plan, it’s possible to create one or more Test Executions for all or a subset of the tests within the Test Plan (e.g., only those tests that are still failing). You can assign one or more Test Plans to a release and track the progress of those tests within each Test Plan. [Coverage Analysis](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565185) can also be performed, focusing on the tests in a given Test Plan and its related Test Executions. # Operations ## Creating a Test Plan > Macro (ui-steps) > > > Macro (legacy-content) > > > Macro (legacy-content) > > > ℹ️ You can also select the option to create another Issue (Figure 1 - 4). If checked, a new *Create Issue* modal appears. This Issue is automatically pre-populated with your previous Test Plan details but with the *Summary* field blank (Figure 1 - 3). > > ℹ️ > > ℹ️ If you're working with versions, then you should also select an option from the *Fix Version* dropdown menu to indicate that you're tracking the results of the Tests for that version. This will be used to automatically fill out the Fix Version of the planned Test Executions (i.e., the ones linked to/created from this Test Plan). > > > Macro (legacy-content) > > > Macro (legacy-content) ## Adding Tests to a Test Plan  Aside from adding Tests to the Test Plan using the Create Issue screen (Figure 1), you can also do it on the Test Issue screen (Figure 3). > Macro (ui-steps) > > > Macro (legacy-content) > > > Macro (legacy-content) > > > Macro (legacy-content) > > > Macro (legacy-content) > > > Macro (legacy-content) > > > Macro (legacy-content) > > > Macro (legacy-content) ## Reordering Tests You can change the order of the Tests, directly in the Test Plan Issue screen. Changing the order of Tests in a Test Plan is useful for prioritizing critical Tests, aligning with the logical flow of testing, optimizing resource allocation, and improving reporting. It ensures that testing efforts are focused and efficient, helping to validate key functionality and meet project goals. There are two ways of changing the order of Tests within a Test Plan: ### Drag-and-Drop > Macro (ui-steps) > > > Macro (legacy-content) > > > Macro (legacy-content) > > > Macro (legacy-content) ### Changing Rank Action > Macro (ui-steps) > > > Macro (legacy-content) > > > Macro (legacy-content) > > > Macro (legacy-content) ## Associating Test Executions with the Test Plan Since the table only shows Test Runs for Tests that are in the Test Plan and for Test Executions that are associated with the Test Plan, it's necessary to associate Test Executions with the Test Plan. You can add existing Test Execution Issues directly to a Test Plan. ### Option 1 > Macro (ui-steps) > > > Macro (legacy-content) > > > Macro (legacy-content) > > > Macro (legacy-content) > > > Macro (legacy-content) ### Option 2 > Macro (ui-steps) > > > Macro (legacy-content) > > > Macro (legacy-content) > > > Macro (legacy-content) > > > Macro (legacy-content) ## Test Plan Table The Test Plan Tests section (Figure 15 - 2), in the Test Plan Issue screen (Figure 15), provides a table where you can see all the Tests (Figure 15 - 1) that were added to the Test Plan and their Test Executions (if they are associated with the Test Plan).  ![Figure 15 - Table.png](media://24a2ccfd-f068-4bef-8360-34d0be17200e) ### Operations  - Select/see the Tests (Figure 15 - 1). - Create a planned Test Execution (see more below), so its results will be reflected in the current Test Plan (Figure 15 - 4). - Add Tests and Test Sets (Figure 15 - 12). - Check the Test Plan Progress Bar (Figure 15 - 6). - Apply filters (see the Filter section below; Figure 15 - 5). - Select a Test Environment to calculate the status of Test Issues for that environment (Figure 15 - 7). It opens a modal with a table that displays information about the Test Runs of a particular Test (Figure 15 - 10). This modal's table is similar to the Test Run table because it allows for inline execution and for operations like assigning a Test run and deleting an execution. This table's columns are configurable. Similar to the Tests table in the Test Plans Issue view screen, it is possible to use a Test Environment to calculate the status of Test runs for that environment. - Change rank, open the dataset and/or remove a Test Issue (Figure 15 - 11). - View the execution results on the Testing Board (Figure 15 - 8) for better Test organization. - Performe Issue actions (cloning, moving, using the Xray Document Generator; Figure 15 - 13). More below. #### Creating Test Executions from the Test Plan You can create Test Executions directly in the Test Plan Issue screen (Figure 15). > ℹ️ To create a Test Execution from the Test Plan, you (as a user) must have permission to edit the current Test Plan because the results of the Test Execution will affect the consolidated information shown in the Test Plan. A user will only be able to create Test Executions in certain projects. If the user does not have permission to create Test Executions for a selected project, an error message will be displayed. > Macro (ui-steps) > > > Macro (legacy-content) > > > Macro (legacy-content) > > > Macro (legacy-content) **All tests...** This option, shown via a modal (Figure 18), lets you create a Test Execution with all the Tests that are associated with the Test Plan. ![Figure 18 - Modal.jpeg](media://84ddb171-9dae-47ec-a7ca-c764d8ac5894) > ℹ️ If the *Revision* field is not configured in the Create Issue screen of the Test Execution for the selected project, that field will not appear in the modal. If there are some mandatory fields, the standard Create Issue screen will be shown. Fill in the fields and (Figure 18 - 1), once you're finished, click the *Create* button (Figure 18 - 2). **With status...** This option, shown via a modal, lets you choose the Tests based on their consolidated status by clicking them (Figure 19 - 1). A Test Execution will be created using those Tests. ![Figure 19 - Modal](media://96d7277a-3513-4978-857f-51fa5f746388) Once you're finished, click the *Create* button (Figure 19 - 2). #### Filters > Macro (ui-steps) > > > Macro (legacy-content) > > > Macro (legacy-content) #### Bulk Actions > Macro (ui-steps) > > > Macro (legacy-content) > > > Macro (legacy-content) #### Cloning/Moving a Test Plan > Macro (ui-steps) > > > Macro (legacy-content) > > > Macro (legacy-content) **Cloning** A modal will open (Figure 23) for you to type the Issue's summary Figure 23 - 1) and confirm the cloning. Click *Clone *(Figure 23 - 2). ![Figure 23 - Cloning](media://6cf8a342-4cbe-4890-9773-9033cf1e8a81) > ℹ️ The Test Plan along with its Test Issue associations will be cloned. After the Issue is created, its screen will be opened. > ℹ️ > ℹ️ On some occasions, the cloned Issue screen may open before the Xray information is cloned and, as a result, the new Test Plan will appear empty. When this happens, you will see a modal with a message (Figure 24). > ℹ️ > ℹ️ ![Figure 24 - Modal](media://58c07c32-f8d4-405e-ac48-e6bc134cc2bc)  **Moving** > Macro (rw-ui-steps-macro) > > > Macro (rw-step) > > A modal will open for you to select the destination project and Issue type (Figure 25 - 1). > > ![Figure 25 - Modal](media://afcf4d98-6b89-47fa-951e-8dde753dd9ba) > > > Macro (rw-step) > > Click *Next* (Figure 25 - 2) to move on to the next steps and, at the end, confirm the changes. Your Test Plan will be moved. #### Document Generator > ℹ️ You have to enable the Document Generator option, in the [Xray Global Settings](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44566331), to use the Document Generator You can export the Test Plan using the Xray Document Generator. > Macro (ui-steps) > > > Macro (legacy-content) > > > Macro (legacy-content) > > > Macro (legacy-content) > > > Macro (legacy-content) ### Xray History Any changes made to the Test Plan data are recorded in the Xray History section (Figure 29 - 1). These include linking the Test Plan with other entities (Test and Test Execution). ![Figure 29 - History](media://9d9a0646-30c9-4faf-8031-9aabb4a309bc) ## Configuring a Test Plan with a Saved Filter (**Xray Enterprise Only**) > ℹ️ ![image](media://e45117fa-8d8a-4dbb-a5bd-bce01fb39e09) > ℹ️ > ℹ️ Configure Test Plan with a Saved Filter is a feature of **[Xray Enterprise](https://www.getxray.app/xray-enterprise)**. If you do not have Xray Enterprise installed, this option **is not available **in the Test Plan and it is not possible to configure Dynamic Test lists. When installing Xray Enterprise for the first time, make sure to [reconfigure Xray](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565797) to load all properties from Xray Enterprise. > ℹ️ > ℹ️ [Saved Filters](https://support.atlassian.com/jira-work-management/docs/save-your-search-as-a-filter/) are one of the most powerful Jira features, that can be used to help you find the information you need, but can also be used in gadgets, reports, or even subscriptions. As Xray is seamlessly integrated with Jira, you can take advantage of this feature to create your Dynamic Test Plans. Using Saved Filters to create Dynamic Test Plans will prevent users from deleting or adding Tests from your Test Plan, as well as from changing the ranking. If you need to make changes to your Dynamic Test Plan list, you need to update the [filter settings](https://support.atlassian.com/jira-work-management/docs/save-your-search-as-a-filter/). In addition to being able to explicitly add Tests to the Test Plan, you can use a filter and you can define a custom JQL depending on your needs so that Tests will appear automatically on the Test Plan, as follows. > Macro (ui-steps) > > > Macro (legacy-content) > > > 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).