1. Home
  2. Opkey Help
  3. 22. External Tool Integration with Opkey Web
  4. 22.32 Working with TFS Cloud Server

22.32 Working with TFS Cloud Server


TFS (Team Foundation Server) is a tool which delivers source control, work item tracking, Team Foundation Build, reporting, and project management capabilities. Team Foundation Server also includes a data warehouse where data from work item tracking, source control, builds, and testing tools are stored.

Team Foundation Server has now been integrated with OpKey 5.33. By using this feature, you can map your project artifacts to log new bugs, update status of logged bugs etc.

TFS Cloud Server is the cloud version of TFS Local server. You first need to host your project on www.visualstudio.com domain for using TFS with OpKey. Navigate to the https://www.visualstudio.com/ and host your project.

Enter your Hostname here at https://app.vsaex.visualstudio.com/profile/account?

Working With TFS Cloud Server

Select Team Foundation Version Control and click on Continue.


Here, you can view that your given hostname is being registered.


Once your hostname has been registered, you need to install OpKey TFS Extension. Navigate to the Manage extensions, as shown below. Click on Manage extensions.


Click on Browse Marketplace to search and install OpKey TFS Extension.


Type OpKey TFS Extension in the search bar.


Once it is uploaded, let it install. Click on Install to begin installation.

9 Install Extension.jpg

Once, your extension gets installed successfully, you need to confirm for the permissions to be granted. Click on Confirm.

10 confirm installation.jpg

Now the OpKey TFS Extension has been installed under DefaultCollection and ready to use.

11 Extension installed.jpg

Important Points:

  • You don’t need to run OpKey TFS utility for showing OpKey Execution Stats on TFS Cloud Server.

  • There is only one Collection named as DefaultCollection. You can create new project(s) to this DefaultCollection.

Let us map projects with TFS Cloud Server by using following steps:

Open OpKey Auth. Click on External Tool Integration under Tools menu.

External Tool Integration page opens as follows:

Check Use For Test Management checkbox and click on Configure icon.

TFS Settings page opens. Enter TFS Cloud Server URL in TFS URL field. Enter User ID as TFS Cloud Login ID and Password as Alternate Authentication Credentials. Click on Refresh button of Project Collection. Project Collection and Project fields are checked for successful mapping.

Make sure that Automatically Bug Logging checkbox is selected, it automatically log a bug in selected project in TFS for the failed test case or scenarios. If bug is already logged then it updates that bug.

Creating Alternate Authentication Credentials:

Let us see how to create an Alternate Authentication Credentials.

Click on Security under the project menu.

Check Enable alternate authentication credentials checkbox.


Fill required fields and click on Save.


Once, your Alternate Authentication Credentials has created successfully, you can easily map your projects with the TFS Cloud Server.

Logging bug on TFS Cloud:

Let us see how bugs are automatically logged on TFS Cloud when a Test Script is failed.

Create a Test Case in OpKey. Make sure that it should get failed during execution.

Example: Here, we have created a Test Case having few test steps. Data input argument are not given so that it can get failed.

Click on Run Now to execute it. Run Now Wizard opens. Fill all required fields and check Show Advanced Settings. Click on Next.

Check Update Mapped Test management Artifact checkbox and click on Next.

Click on Next for other execution steps until Execution process gets started.

Here, you can view that the execution process gets completed and execution get failed.

Within Execution Logs, you can view that it is connected with Team Foundation Server (TFS) and logged a new bug in TFS cloud.

Now, on TFS Cloud you can view the logged bug. Go to the OpKey Execution Stats tab to view details about the executed Test Case and Test Steps. OpKey Execution Stats contains detailed information about the executed Test Script and its Test Steps.


Updating & Logging bug on TFS Cloud:

Let us see how you can update a logged bug by mapping a Test Case with TFS. Here, you can map logged bugs (work item) in TFS Local Server.

Right click on the Test Case and click on TFS Mapping.

TFS Mapping Details page opens. Check work item checkbox and click on Map to TFS.

Apply TFS Query Filter and click on Search. You can apply Basic TFS Query Filter.

Here you can view list of bugs (work items) with details. Check work item checkboxes and click on Apply Mapping Changes.

Once all mapping successfully saved, a popup message appears that “All Mapping Successfully Saved“.

Now, the mapped work items in TFS Cloud will be updated when the associated Test Script will be executed.

Let us execute the Test Case again. Click on Run Now (F5) to begin the execution process and click on Next until the execution process gets started.

Once the execution process gets completed, you can view the execution logs that the mapped bug has been updated and new ids corresponding to that bug has also been logged.

Have a look at the updated and newly logged bug for the mapped bug ids.


Was this article helpful to you? Yes No