The term two-way integration or bi-directional integration here relates to the use of issue managers to perform test case management operations on Test Collab without requiring you to login to Test Collab application. 

Supported operations that can be performed from within the issue manager, include :

  • Operations possible when you use a TestCollab administrator's API keyLinking existing TestCollab project with current issue manager's ProjectCreating new TestCollab project being in issue manager to link it with current projectLinking Existing test cases defined in TestCollab to an issue defined in issue manager

  • Operations available for all Test Collab users, provided their respective roles permit them to do so:Adding a new test case and get it automatically linked with the current issue defined in issue managerEditing an already linked test caseViewing a test case detailsUnlinking a linked test case from the current issueDeleting a linked test caseAssign test cases to users who have permissions to execute test cases in TestCollab

Please note that two-way integration is supported only on Test Collab version 1.3.4 and higher.

Add-on Installation

If you have a running instance of JIRA on your server, you can easily add Test Collab add-on to it. 

To download the compressed Test Collab add-on files for JIRA goto Downloads page. 

Once you have the add-on's .jar archive, you can get it installed in JIRA. 

  • When logged into JIRA as an administrator, select "Administration" option

  • Use "Add-ons" option under the "Administration" menu

  • Select "Manage Add-ons". You may be asked to reenter your password before moving ahead

  • On "Manage Add-ons" page, you will get a link to "Upload add-on".


  • Select the downloaded Test Collab add-on's archive and click "Upload"

  • This should also start installation once file is uploaded


  • Once installation is done you will be shown a confirmation message

  • Installed add-on can then be configured

  • For "Test Collab URL", you simply require to enter the URL that is to be used to access Test Collab application for bidirectional integration from JIRA


Setting up Test Collab API key


To set up key to make calls to Test Collab API, one needs to follow these steps:

  • Select "Administration" option

  • Click on "User Management" on top menu to see a drop down having related options 

  • Select "Users", to see the list of users that have been added into JIRA

  • Hover over username, on popped up box, click on "More"

  • Select "Administer User"

  • Select "Edit Properties"

  • In "Add User Property" section provide a new key with the name "TCKEY" and the value that would be same as your Test Collab's API key, you may like to refer "How to know Test Collab user's API Key" for details.



How to know Test Collab user's API Key

Being logged into Test Collab, navigate to your profile. On profile page, you will find your API key, that can be used to access Test Collab.



Performing Test Case Management tasks

After setting up Test Collab plug-in and API key, you can start performing test case management related tasks.

If you are logged in as an administrator of JIRA application and also you have provided the API key for a Test Collab user who can act as an administrator, then you can either add a new JIRA project or use an existing project to "Enable" Test Collab for it, for this switch to "Components" option on project administration page.


Adding a Project in Test Collab

As an administrator, you also have an option to introduce a new project in Test Collab, that will have the same name as that of the JIRA Project. For this you can select "Create New" from the drop down next to "Linked Project".

Non Administrative Tasks


Please note that all the tasks that have been described below can be performed on the basis of role that has been assigned to the user whose API key is used, for the Test Collab project linked with the current JIRA project.

Once Test Collab is enabled for a JIRA project, you will be able to perform all other test case management tasks. For this you can either use an existing JIRA issue or create a new one.

Once an issue is created or selected, you will see a new section at the bottom that will allow you to manage the linked Test Collab test cases, this section gives you option to either add new test case in Test Collab and link it automatically to JIRA issue, or link existing test cases.

If you are a Test Collab user who is assigned a role that permits to edit test cases in a project, then you can link existing testcases under that Test Collab project.

When you click on "Link Existing", a popup would come up and that will list all test suites that are present in linked Test Collab project.

You can expand individual test suite to select specific test cases


If you have selected the entire suite(s), all their related test cases will automatically get linked with JIRA issue.Otherwise individually selected test cases will be linked.

If you opt to add a new test case then you will get a popup to enter the details of new test case, the interface would be similar to the add page you see in Test Collab.

After saving, the new test case will be introduced in Test Collab application and will be automatically linked with the JIRA issue.

When one or more cases are linked with the JIRA issue, for each linked case you will get options like edit, unlink and delete.

Opting to edit will popup the related form.

Unlink will remove the test case from the list of linked test cases.

Deleting apart from unlinking from JIRA, will delete the test case from Test Collab as well.

Assigning Test Cases to Testers for Execution

Opting to "Execute Selected Tests", after selecting one or more linked test cases, will popup a window to first let you create a new Test Collab test execution and then assign the execution to the users who have the role in Test Collab project that allows them to execute a test.

Creating a New Test Execution 




Did this answer your question?