Friday, 13 April 2007

How to install Caliber for VSTS

This document is a basically a simplified version of the official installation instructions coming with the product download (Caliber VSTS). It should give you a good idea of the work needed. However if you are familiar with Caliber and at ease with installing software, it will get you there much faster, perfect for a quick evaluation or look around. If you are not too confident or are implementing this on a production system, I suggest reading the full notes (see Caliber VSTS installation guide, run the installer select "Documentation / Installation Guide").

Prerequisites:
This post assumes that you have already installed Caliber (client and server). You need at least version 2005 R2 SP1. It will NOT work with a previous version of Caliber (for instance Caliber 2005 R2 or Caliber 2005 will not work this software) as there is a hard dependency on this specific version. Of course you need Visual Studio and note that it does not work with the Express version.
There is 2 main parts in the Caliber VSTS integration:
  • One goes on the server side on the same machine as the VSTS server (this is a requirement).
  • Then there is 2 other pieces on the "client" side.
    • One - the real client side piece - add inside Visual Studio Team Explorer a Caliber folder where your requirements will appear,
    • The other one add a new type of trace (*) to VSTS Work and Test items.


Installation:

  • Install the server part of the Caliber for VSTS (you will find it in the Caliber VSTS installer under "Server components / Server"), you must install it where the TFS application is installed (not where the database is). It cannot be installed anywhere else (if not it won't work),
  • then on each client machines where Visual Studio is running install the Visual Studio integration (under "Client components / Client"),
  • now install on each client machine where the Caliber client is running the traceability add-in (under "Client components / Traceability Add-in"),
  • finally setup the traceability add-in, follow the setup instructions below.

Traceability add-in setup:
This add-in enables the creation of traces (*) from requirements to Work and Test items in VSTS. It must be installed by the Caliber administrator. Note that the add-in is installed automatically with the CaliberRM Client for Visual Studio Team System (so you don't need to do it wherever Visual Studio is setup with the Caliber VSTS integration). Now go in the Framework administrator and follows these steps:
To trace requirements to Visual Studio Team System work items, you must enable the add-in as follows:
  1. In the Framework Administrator, select the project in which you want to enable the integration.
  2. Select the External Traceability tab.
  3. Click the New button.
  4. In the New Integration dialog box, enter a Vendor Name. This name will appear as a tab in the Traceability Modification window. "VSTS Work Items", for example.
  5. In the Library Name box, enter VSTS (exact match required).
  6. Click the Change Icon... button and select the icon you would like to associate with the integration.
  7. Click OK.
  8. In the Disabled section, select the new integration and click the Move Left button (<).
  9. Click the Save button to save the project.

To trace requirements to Visual Studio Team System tests, you must enable the add-in as follows:

  1. In the Framework Administrator, select the project in which you want to enable the integration.
  2. Select the External Traceability tab.
  3. Click the New button.
  4. In the New Integration dialog box, enter a Vendor Name. This name will appear as a tab in the Traceability Modification window. "VSTS Tests", for example.
  5. In the Library Name box, enter VSTSTests (exact match required) .
  6. Click the Change Icon... button and select the icon you would like to associate with the integration.
  7. Click OK.
  8. In the Disabled section, select the new integration and click the Move Left button (<).
  9. Click the Save button to save the project.
Troubleshooting:
  • If you see an error message containing the text "Requested registry access is not allowed" when expanding the Caliber node in Visual Studio Team Explorer you are good to follow the steps documented in this page.
  • Following this if you see an error message containing the text "Database 'Caliber' already exists", you are good to follow the steps documented in the page.
(*) these are links between requirements or to external artifacts.
Good luck!

No comments: