Contents

Test Plans - Reference pages

Global Test Plans Reference

Test Plan - Properties


Plan Name	The name identifies the test plan. It's required and has to be set during creation of the test plan. It can be edited later. The names for test plans of the same project have to be unique. The name is also used to select a test plan in the execution view.
Description	An optional description for further explanation of the test plan. The description can be set during creation of the test plan and can be edited later.
Configuration	An optional configuration to add additional meta data to the test plan. Configurations are project specific and can be managed by the JIRA administrator. They provide information in form of simple key-value pairs. The configuration can be set during creation of the test plan and can be edited later.
Tests	A test plan contains one or more tests which are added during structuring specific test plans. The amount of tests and test steps contained in a test plan is calculated automatically and will be displayed in the plan view.

Test Plan - Views

Plan View

The Plan View is one of the four main views in Test for JIRA.
After selecting a project in the plugin section you can navigate to the Plan View by clicking the Plan button in the top right corner.
The Plan View displays all test plans for the selected project.

Displayed properties for each test plan:

Plan Name
Description
Configuration
Amount of tests and test steps contained

Plan Tree View

The Plan Tree of a test plan displays the contained tests hierarchically structured.
It can be reached by clicking on the name of a test plan in plan view.
The plan name is the name of the root folder of the tree structure.
A more detailed description of the displayed content of the plan tree is given in the second part of this reference.

Execution View

The Execution View is another one of the four main views in Test for JIRA.
After selecting a project in the plugin section you can navigate to the Execution View by clicking the Execution button in the top right corner.
The execution view displays the name of every test plan of the selected project and the corresponding executions.
A more detailed description of the Execution View can be found in the test execution reference.

Test Plan - Operations

All operations can be accessed from the Plan View of a test project.

Create test plans

Click on the New Plan button to open the new plan dialog.

Within the dialog you can enter the initial property values.
Click Create to create the new test plan.

Edit test plans

Click on the to open the edit test plan dialog.

The dialog allows you to edit the following properties:

Name
Description
Configuration

Delete test plans

Click on the to open the delete test plan dialog.

Note that deleting a test plan won't delete previous executions of this plan.
The plan will be displayed as disabled in the Execution View. Its execution can be accessed as usual.

Copy test plans

Click on the to copy the corresponding test plan.

The new test plan will be inserted right below the original test plan.
The property values are copied from the original test plan except for the name which is the original name with a "(copy)" appended.
Also is the complete test plan structure copied from the original test plan. This includes all folders and tests that are part of the test plan.
Executions of the original test plan won't be copied.

Filter test plans

Click on the Filter button to open the filter input.

Enter a filter query and click on Filter to apply the filter to the test plan table.
Click on Clear to remove the current filter and close the input.
Click on Cancel to close the input without changing the current filter settings.

Once a filter is applied only test plans containing the filter query in their names will be displayed in the test plans table.
Properties other than the Plan Name are not evaluated against the filter query.
An orange warning symbol located in the top left corner indicates that a filter is applied.

Test Plan - Export

Click on the Export button to open the export menu.
Select an export format from the list to export the test plans for the selected project.
Note that the exported files always contain all test plans although a filter might be applied.

Test Plan - Export formats

XML

Exports the test plans for the selected project as XML file.

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<testplans>
	<testplan>
		<prjKey>PRJ</prjKey>
		<project>10100</project>
		<description>An example test plan</description>
		<configuration>1</configuration>
		<id>12</id>
		<name>Example Test Plan</name>
		<copying>false</copying>
		<copyFailed>false</copyFailed>
		<testCount>1</testCount>
		<stepCount>1</stepCount>
	</testplan>
	<projectName>PROJECT</projectName>
</testplans>

XML with details

Exports the test plans and their tree structures for the selected project as XML file.

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<trees>
	<tree>
		<folders>
			<name>Example Test Plan</name>
			<description/>
			<id>123</id>
			<nameDisplay>Example Test Plan</nameDisplay>
			<parent>-152</parent>
			<folders>
				<name>Subfolder</name>
				<description>A subfolder of the root folder.</description>
				<id>345</id>
				<nameDisplay>Subfolder</nameDisplay>
				<parent>123</parent>
				<issues>
					<id>1000</id>
					<issueId>12300</issueId>
					<key>PRJ-20</key>
					<url>http://host:port/jira/browse/PRJ-20</url>
					<summary>Example Test</summary>
					<descriptionHTML/>
					<iconUrl>http://host:port/jira/images/icons/issuetypes/newfeature.png</iconUrl>
					<issueType>New Feature</issueType>
					<position>1</position>
					<status>To Do</status>
					<statusUrl>http://host:port/jira/images/icons/statuses/open.png</statusUrl>
					<priority>Major</priority>
					<priorityUrl>http://host:port/jira/images/icons/priorities/major.png</priorityUrl>
					<attributes>
						<attribute>
							<name>Custom - Job Checkbox</name>
							<value>false</value>
						</attribute>
					</attributes>
					<teststeps>
						<teststep>
							<id>53</id>
							<name>Example Test Step</name>
							<description>An example test step using parameter p1: ##p1##</description>
							<result>-</result>
						</teststep>
					</teststeps>
					<parameters>
						<parameter>
							<key>p1</key>
							<value>value</value>
						</parameter>
					</parameters>
					<path>Subfolder</path>
					<combinedPath>\PRJ\Subfolder</combinedPath>
				</issues>
				<position>1</position>
			</folders>
			<position>0</position>
		</folders>
	</tree>
</trees>

Excel

Exports the test plans for the selected project as Excel file.

Example Response

Test Plans PROJECT

Plan	Description	Tests	Test Steps
Example Test Plan	An example test plan	1	1

Excel with details

Exports the test plans and their tree structures for the selected project as Excel file.

Example Response

Example Plan

Path	Issue Key	Status	Issue Type	Summary	Description	Test Step	Description	Expected Result
/Subfolder	PRJ-20	To Do	New Feature	Example Test	An example test.
						Example Test Step	An example test step using parameter p1: ##p1##	-