Contents

Test Definition - User interface

The test definition view can be reached by selecting a test project from the Tests section in the main navigation bar.
The view consists of three parts:

Definition Tree

The definition tree is located on the left side of the view and is always visible.
It's used to organize the tests needed in the selected test project.
To edit the definition of a test it has to be part of a definition tree.
Tests that are part of a definition tree can also be added to test plans more easily later.

The definition tree contains folders and tests below a root folder named after the corresponding project.
This allows you to organize and structure the tests of your test projects.

Every test can occur one time in the definition tree.
From there it can be added to multiple test plans.

Selecting a test in the definition tree opens the issue detail view for this test on the right side.
Selecting a folder in the definition tree opens the reading view for this folder on the right side.

Reading View

The reading view provides an alternative perspective on the content of a tree folder.
It's located on the right side of the definition view and is only visible if a folder (including the root folder) is selected in the definition tree.

The reading view displays the folder selected in the definition tree and visible subfolders as list.
For every displayed folder the contained tests are also displayed.

Issue Detail View

The issue detail view displays all important information about a test and provides interfaces to edit the definition of a test.
It's located on the right side of the definition view and is only visible if a test is selected in the definition tree.

As described in the Tests - Concept Guide test are JIRA issues extended by the possibility to attach test steps and test parameters.
The issue detail view displays all information about the test / issue similar to the standard JIRA issue view.
It also displays issue links for the test and provides methods to create, edit and delete issue links.
It also displays test specific information for the selected test such as

test steps
parameters
test plans that contain the selected test
the definition tree path for the selected test

Reading View - Operations

Click on the issue key of a test to select the corresponding test item in the definition tree.
Click on a folder to expand/collapse its content.
Right click on a folder and select
- Expand all to expand all folders displayed in the reading view.
- Collapse all to collapse all folders displayed in the reading view.

Issue Detail View - Operations

The issue detail view provides interfaces for

editing the test itself
managing issue links
organizing test steps
working with test parameters

All of the above-mentioned concepts are documented on separate pages in this documentation.
Except for editing issues and managing issue links which is documented in the JIRA documentation.

Definition Tree - Context menu operations

The definition tree can contain items of three different types.
These are tree folders, test items and a root folder.
Each of these item types has its own set of context menu entries, whereby some menu entries are present in more than one set.
For each of the following context menu operations the item types providing this operation are indicated.

Folder related operations

	Available for:	tree folder	root folder	test item
Create folder	Opens the create folder dialog. Within the dialog you can enter a name and a description for the new folder. Note that the names of folders with the same parent folder have to be unique. Click Create to create the new folder below the selected one.
Edit	Opens the edit folder dialog. The dialog allows you to change the name and the description of a folder.
Delete	Opens the delete folder dialog. Deleting a folder will also delete all subfolders and remove all contained tests from the definition tree. The tests won't be deleted and can be added again later.
Expand all	Expands the selected tree folder and all subsequent folders.
Collapse all	Collapses the selected tree folder and all subsequent folders.
Refresh folder	Refresh the folders content and fetch new data from server.
Show in issue navigator	Opens the JIRA issue navigator in a new browser tab / window. Applies a search query using the testDefinitionPath JQL extension to display all issues contained in the selected folder and its subsequent folders in the issue navigator.
Cut	Stage a folder or test for cutting.
Paste	Paste staged content into the selected folder. Note that the staged content will be moved to the new folder not copied. Cutting and pasting can be used only within the same plan tree. A staged test can be pasted to every folder of the same plan tree. A staged folder can be pasted to the root folder of the same plan tree. Moving a folder to another tree folder can be done via drag and drop.

Test related operations

	Available for:	tree folder	root folder	test item
Create issue	Opens the JIRA Create Issue dialog. More information to creating issues can be found in the JIRA documentation. Click Create to create the new issue / test and add it to the selected folder or the parent folder if a test item was selected.
Add existing issues	Opens the add existing issues dialog. Select Add all ... to add all issues created on the selected test project that aren't already part of the tree. Select Search for issues to search for recently viewed issues to add them to the selected folder. Select From filter to add all issues matching the provided filter or JQL query. Note that when selected Search for issues or From filter the selected issues do not necessarily come from the same project the definition tree belongs to. Also issues that are already part of this definition tree won't be added.
Edit issue	Opens the JIRA Edit Issue dialog. More information to editing issues can be found in the JIRA documentation.
Add link	Opens the add link dialog. This allows you to add a JIRA issue link between the test selected in the definition tree and one or more tests selected from the dialog.
Test execution	Opens the add execution dialog for this particular test. This allows you to create and run a single test execution right out the definition tree. For further information take a look at the Test Execution - Reference.
Remove	Opens the remove test dialog. The test will only be removed from the definition tree. It won't be deleted and can be added again later.

Definition Tree - Drag and drop operations

The definition tree supports the following drag and drop operations:

Change folder positions
Change the folder hierarchy
Change the position of tests
Move tests between folders

Definition Tree - Filter

Click on the Filter button to open the filter input.

Similar to the JIRA issue search the filter input provides a basic and an advanced mode.
In basic mode you can select a saved filter to apply. The advanced mode allows you to enter a JQL filter query.
You can switch between the two modes by clicking the Advanced / Basic button.

Once a filter is applied only tests matching the filter query are displayed.
An orange warning symbol located in the top right corner of the definition tree indicates that a filter is applied.

Click on the Clear button to remove a filter in advanced mode.
To remove a filter in basic mode click on the next to the selected filter.

Definition Tree - Export

Click on the Export button to open the export menu.
Select an export format from the list to export the definition tree content to.
The exported content depends on the type of the item currently selected.
An applied filter also affects the exported content.

The following tables describe the export content in each format depending on issue type and applied filter.

Since the XML export provides information that can be used to integrate another application with T4J via its REST API a complete example export file is provided.
The example file is the result of an export with the root folder of the definition tree selected and no filter applied. It covers the structure of the root item, a folder item and a test item.
Note that there's no example export for Excel and Word since those export formats are mostly used for internal documentation purposes. Therefore a textual description of the content should be sufficient.

Plan Tree - Export formats

XML

Type of the selected tree item	Content	Filter applied
Test item	Detailed information about the selected test item including item ids that can be used for REST API calls.
	Contains the same information stated above.
Tree folder	Contains no information except for the following items: <trees><tree/></trees>
	Detailed information about the selected tree folder and all subsequent folders and contained test items.
Root folder or nothing selected	Detailed information of the root folder.
	The content is equivalent to the content when selecting a tree folder just with the root folder as top level element.

Example response

<?xml version="1.0" encoding="UTF-8"?>
    <trees>
        <tree>
            <folders>
                <name>PROJECT</name>
                <description/>
                <id>-1</id>
                <nameDisplay>PROJECT</nameDisplay>
                <parent>-2</parent>
                <folders>
                    <name>Example Folder</name>
                    <description>An example folder</description>
                    <id>658</id>
                    <nameDisplay>Example Folder</nameDisplay>
                    <parent>-1</parent>
                    <folders>
                        <name>Subfolder</name>
                        <description>A subfolder of the example folder.</description>
                        <id>668</id>
                        <nameDisplay>Subfolder</nameDisplay>
                        <parent>658</parent>
                        <issues>
                            <id>1000</id>
                            <issueId>12300</issueId>
                            <key>PRJ-20</key>
                            <url>http://host:port/jira/browse/PRJ-20</url>
                            <summary>ExampleTest</summary>
                            <description>test description</description>
                            <descriptionHTML>&lt;p&gt;test description&lt;/p&gt;</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 - Hidden Job Switch</name>
                                    <value>false</value>
                                </attribute>
                            </attributes>
                            <links>
                                <link>
                                <linkName>is blocked by</linkName>
                                <issueKey>PRJ-17</issueKey>
                                <issueSummary>Linked Issue</issueSummary>
                                <issueUrl>http://host:port/jira/browse/PRJ-17</issueUrl>
                                <priority>Major</priority>
                                <status>To Do</status>
                                </link>
                            </links>
                            <teststeps>
                                <teststep>
                                    <id>53</id>
                                    <name>Example Test Step</name>
                                    <description>An example test step using parameter p1: ##p1##</description>
                                    <result>The expected result.</result>
                                </teststep>
                            </teststeps>
                            <parameters>
                                <parameter>
                                    <key>p1</key>
                                    <value>parameter value</value>
                                </parameter>
                            </parameters>
                            <path>Example Folder</path>
                            <path>Subfolder</path>
                            <combinedPath>\PRJ\Example Folder\Subfolder</combinedPath>
                        </issues>
                        <position>1</position>
                    </folders>
                    <position>1</position>
                </folders>
                <position>0</position>
            </folders>
        </tree>
    </trees>

Excel

Type of the selected tree item	Content	Filter applied
Test item	Contains basic information about the selected issue. Also contains information about issue links, test steps, parameters and custom JIRA issue fields.
	Contains the same information stated above.
Tree folder	Contains no information.
	Contains the name of the selected folder. Contains the folder path for all issues contained in the selected folder and subsequent folders. Also contains basic informations for those issues and information about the test steps.
Root folder or nothing selected	Contains the name of the project.
	The content is equivalent to the content when selecting a tree folder just with the root folder as top level element.

Word

Type of the selected tree item	Content	Filter applied
Test item	Contains basic information about the selected test item. Also contains information about issue links, test steps, parameters and custom JIRA issue fields.
	Contains the same information stated above.
Tree folder	Contains no information.
	Contains the name of the selected folder and all subsequent folders and basic information about the contained issues.
Root folder or nothing selected	Contains the name of the project.
	The content is equivalent to the content when selecting a tree folder just with the root folder as top level element.

Searching for tests

Advanced search integration

The advanced search functionality of JIRA allows to use structured queries to search for issues. These queries are written in Atlassian's JIRA Query Language (JQL). The result set is displayed as a list of issues in the issue navigator. It is also possible to save advanced search queries for private or public use.

Test for JIRA enhances the advanced search of JIRA with new functions to search for issues in T4J specific entities such as test plans or definition trees.

Saved JQL queries can be further used for filtering or adding issues matching the query to a definition tree.

How to search for tests

Select Issues > Search for Issues from the main navigation bar
Switch to advanced searching by clicking the Advanced link from the filter bar
Enter a query in the search text box
Click on the Search button or hit enter to execute the query

The query should be of the following structure: field operator function()

You can look up the supported fields and operators for the new Requirements for JIRA functions in the function reference below.

Function Reference

Test Definition Folder

Click here to expand...

Returns the issues/tests that are contained in a specific folder in the definition tree of a project.

Syntax

testDefinitionFolder(path)

Where path represents a part of the hierarchical structure of the definition tree.

Path should be of the following form: "project name/parentFolder/.../childFolder"

Supported Fields

Issue

Supported Operators

=

!=

~

!~

>

>=

<

<=

IS

IS NOT

IN

NOT IN

WAS

WAS IN

WAS NOT

WAS NOT IN

CHANGED

Examples

Find all issues that are contained in the folder "Webtests" within the definition tree of the project "OnlineHotelReservation:

issue in testDefinitionFolder("OnlineHotelReservation/Webtests")

Test Definition Path

Click here to expand...

Returns the issues/tests that are contained in a specific folder in the definition tree of a project.
Also returns the issues/tests of subsequent folders.

Syntax

testDefinitionPath(path)

Where path represents a part of the hierarchical structure of the definition tree.

Path should be of the following form: "project name/parentFolder/.../childFolder"

Supported Fields

Issue

Supported Operators

=

!=

~

!~

>

>=

<

<=

IS

IS NOT

IN

NOT IN

WAS

WAS IN

WAS NOT

WAS NOT IN

CHANGED

Examples

Find all issues that are contained in the folder "Webtests" or one of its subfolders within the project "OnlineHotelReservation:

issue in testDefinitionPath("OnlineHotelReservation/Webtests")

Test Plan

Click here to expand...

Returns all issues/tests that are part of a specific test plan.

Syntax

testPlan(project,plan)

Where project is the name of the project that contains the desired test plan and plan is the name of the test plan.

Supported Fields

Issue

Supported Operators

=

!=

~

!~

>

>=

<

<=

IS

IS NOT

IN

NOT IN

WAS

WAS IN

WAS NOT

WAS NOT IN

CHANGED

Examples

Find all issues/tests that are part of the test plan "Example Plan" created on the project "OnlineHotelReservation":

issue in testPlan("OnlineHotelReservation","Example Plan")

Failed in Execution

Click here to expand...

Returns all issues/tests that are marked as failed in a specific execution of a given test plan.

Syntax

failedInExecution(project,plan,execution)

Where project is the name of the project that contains the desired test plan.
Plan is the name of the test plan.
Execution is the name of a specific execution of the given test plan.

Supported Fields

Issue

Supported Operators

=

!=

~

!~

>

>=

<

<=

IS

IS NOT

IN

NOT IN

WAS

WAS IN

WAS NOT

WAS NOT IN

CHANGED

Examples

Find all issues/tests that are part of the test plan "Example Plan" created on the project "OnlineHotelReservation", which were marked as failed during "Test Execution":

issue in failedInExecution("OnlineHotelReservation","Example Plan","Test Execution")

Test Definition - Reference

Test Definition - User interface

Reading View - Operations

Issue Detail View - Operations

Definition Tree - Context menu operations

Folder related operations

Test related operations

Definition Tree - Drag and drop operations

Definition Tree - Filter

Definition Tree - Export

Plan Tree - Export formats

Searching for tests

Advanced search integration

How to search for tests

Function Reference

Test Definition Folder

Syntax

Supported Fields

Supported Operators

Test Definition Path

Syntax

Supported Fields

Supported Operators

Examples

Test Plan

Syntax

Supported Fields

Supported Operators

Examples

Failed in Execution

Syntax

Supported Fields

Supported Operators

Examples