Skip to main content
All CollectionsDefects management and integrationsJIRA
TestCollab's bi-directional integration app for JIRA
TestCollab's bi-directional integration app for JIRA

Perform all your test case management activities within JIRA without needing to log into TestCollab

Vishal Vaswani avatar
Written by Vishal Vaswani
Updated over a week ago

ℹ️ This plugin is only available for companies subscribed to a paid plan.

There is no need to switch between two different tools to manage your test cases.

If you are a JIRA user, you can take advantage of TestCollab's bi-directional app to manage all your test cases within JIRA by linking your test cases from TestCollab with issues in JIRA.


Things you can do with our Jira app are:

  • Link existing test cases of TestCollab with Jira issues

  • Add new test cases from Jira to TestCollab

  • Edit linked test cases

  • Delete test cases

  • Unlink test cases

  • Create new test plan from Jira in TestCollab

Installing the app

TestCollab's bi-directional app is available on Atlassian marketplace with the name "TestCollab - Test management for Jira". Installation is simple and straight forward, click on Get App to let the installation begin

Accessing test cases from TestCollab in Jira

You would be shown the application's basic information along with options to review app's terms of use and privacy policy. Click on Get it now to agree with these and install the app.

Installing TestCollab's bi-directional integration app for Jira - Step 2

Installing TestCollab's bi-directional integration app for Jira - Step 3

Clicking on configure on installation success message brings up API token entry form.

Configuring the application

Providing Administrator's API Token

Adding TestCollab API token

You can use the link provided above the API token entry box to get an API token generated.

Remember at the time of configuring the app you can either use API token of either super administrator or of an administrator from your company registered with TestCollab, using API token of a non admin is not allowed to configure the app.

Adding TestCollab API token in Jira

Select Company

Once API token is verified, you would be asked to select the company / account name.

Selecting TestCollab account to be used in Jira

API Token Entry for All Users

There is one more place where you would enter your TestCollab API token, this is the page where your API token is used to link your TestCollab profile. The option is available under Apps menu, you simply have to select the app name i.e. TestCollab

API token for other users on TestCollab account

Note: If you revoke your API token in TestCollab then you need to reconfigure the TestCollab bi-directional integration app in JIRA, failing to this would cause the app to not to work in JIRA.

By this time when you navigate to your JIRA project you would see new link for "TestCollab" on left navigation bar

New link for TestCollab in Jira project

But before we can use it, we have to configure project specific settings in JIRA for TestCollab app

Project settings for TestCollab app

Configuring project specific settings for TestCollab app in Jira

You select a TestCollab project whose test cases you would like to get managed and linked with issues in current JIRA project.

One more important part of this setting is selection of issue types you want the feature of test cases management to work for.

All the processes discussed above are performed by a user who has provided the API token of a TestCollab super administrator or administrator.

From this point onward the features are common for administrators and non-administrators but in case of non-administrators the availability would depend on the role assigned to user in TestCollab.

Having done the project specific setting the link for "TestCollab" on project's main menu should be usable.

Note: you may be asked to enable third part cookies on your browser

Enable third party cookies to use TestCollab app in Jira

With this you are all set to use the app. Start by exploring the TestCollab project's details

Filtering test cases from TestCollab to link them with Jira issue

Accessing test cases from TestCollab data in Jira

Note: Based on the permissions you have in the selected TestCollab project, you would be able to perform various operations on entities like test suites, test cases and test plans using this interface.

Test cases management through JIRA issues

For the JIRA issue types selected while configuring project specific settings for TestCollab you would get options to perform various operations.

Test Cases tab on issue page

Notice the section titled Test Cases under Activity, this is the place from where you would be linking and managing test cases of TestCollab.

Linking test cases

Clicking on Link test case opens a list of test cases in the TestCollab project, which you can filter and shortlist to link with a JIRA issue.

Linking test cases from TestCollab with Jira issue

Once the test cases are shortlisted click on checkbox on title row of grid to select them all (or you can also select individual test cases) and use Link now button.

Linking test cases from TestCollab with Jira issue

The linked test cases should now be listed on Test Cases section and ready for various operations to be performed.

Linked test cases from TestCollab with Jira issue

Adding a test case

If your TestCollab role in project allows then you can add new test cases and get those new test cases automatically linked with current JIRA issue.

Adding new test cases in TestCollab from Jira

More details on how to add test case are available here.

Editing a test case

Just like adding, editing of test cases is simple, you have to use the actions menu shown next to the individual test case.

Editing test cases from TestCollab in Jira

Once Edit option is selected, it opens up the edit test case form.

Editing test cases from TestCollab in Jira

Unlink a test case

If a test case is no longer needed to be linked with JIRA issue, it can be unlinked, again the Unlink option is available on actions menu.

Unlinking test cases from Jira issue

Deleting a test case

If a test case is no more required then use delete action.

Please note this action will not only unlink the test case from JIRA issue but it would also DELETE the test case from your TestCollab instance and this action cannot be reverted, so one needs to be very careful while performing this action.

Adding new test cases in TestCollab from Jira

Creating a test plan

With the linked test cases you can also get a test plan created and assigned to testers.

Creating a new test plan in TestCollab from Jira

The process is identical to the one performed in TestCollab.

Automatic linking of failed test cases with defects reported

The defects reported from TestCollab as a result of test case failure will automatically link the test cases with issue thus reported in JIRA, provided the correct project settings for the app are done in JIRA.

Maintaining the same session for a TestCollab user in a different tab

Sometimes we need to maintain the same TestCollab user's session as in the bi-directional integration app in Jira, for this please follow the steps mentioned below:

  • Log-in to the Jira instance that has TestCollab's bi-directional integration app installed and configured using the credentials of the user who also has an account in TestCollab

  • Switch to the project that has been configured to link its issues with test cases in TestCollab

  • Either use TestCollab link on the left menu or go to an issue and access "Test Cases" tab under "Activities" section, and perform an action that opens TestCollab application interface

  • In both the above cases, use "Go to TestCollab" link

Maintaining a parallel user session in Jira and TestCollab

Making the linked test cases' list available for all users added to Jira project

If you are using TestCollab's bi-directional integration app before the release of this feature then these steps need to be followed :

  • The TestCollab API token that was previously being used for authetication of TestCollab's bi-directional integration app on Jira needs to be revoked from TestCollab

  • Confirm that the app on Jira no longer has authentication by using the "Configure" option for TestCollab on the "Manage Apps" page

  • Then the super administrator on TestCollab account has to use a separate API token (generated using his/her account) to re-authenticate the application on Jira, this is again done by using the "Configure" option in Jira

  • Once authenticated with a separate API token, the list of test cases that are linked with an issue will be available for all users added to the Jira project associated with a TestCollab project, whether or not they have an account on TestCollab.

Did this answer your question?