February 10, 2010

TestTrack Excel Add-in Toolbar

Helix ALM

Developed against TestTrack Pro 2010 and Excel 2007

This tools allows the user to view the defect list from within Excel. Selected records in the list window can be imported into a new worksheet in the Excel workbook.

[toc]

How it works

The TestTrack Excel Add-in Toolbar is a way to access TestTrack Pro from Excel. After installting the Add-in toolbar, a TestTrack toolbar will become available in Excel.

The Toolbar

The toolbar consists of three buttons

Defect List Button

Use this button to retrieve the list of defects in TestTrack Pro. This button will not be enabled unless you have already connected to TestTrack Pro.

Connect to TestTrack Button

Use this button to bring up a login window. Enter the appropriate information to log in to TestTrack. This button will be disabled when you are connected.

Disconnect from TestTrack Button

Use this button to terminate your TestTrack session. This button will be disabled if you are disconnected from TestTrack.

Login Window

Use the Login Window to connect to TestTrack and establish a connection.

Following are the fields in this window: SOAP URL: Enter the path to the TestTrack SOAP CGI exectuable. It should be something like http://serveraddress/scripts/ttsoapcgi.exe or http://serveraddress/cgi-bin/ttsoapcgi.exe. User Name: TestTrack User Name to use to connect. This user must have the ability to log in to TestTrack via the SOAP SDK. This is set in the user's security group. Password: Password for the above user. Projects: List of projects available to the user. Will not populate if any of the above three fields have incorrect information. Save Connection Information: Saves the SOAP URL, Username and project selection. It does not save the password. Save Password (Clear Text): Saves the password in the configuration file in plain text.

Defect List Window

The defect list window displays defects returned by the selected filter.

Use the import button to import the selected items to a new Excel sheet.

Column Configuration

The defect list window will contain three columns by default:
  • Number
  • Summary
  • Status
If any of the above columns are renamed, the tool will not work The display of these columns can not be changed. However, additional columns for display can be configured. Column names can be added to the configuration file. Enclose the column name with <column> tags. Note that not all columns may be displayed. If you specify a column, but you do not have permission to see the field, the column will not be displayed.

Configuration File

When the connection information on the login window is saved, it is saved to a configuration file called "TTConfig.xml". This file gets saved to the "current directory", which by default is the directory where the Excel executable is located. The file may also contain information about columns to display in the defect list window. Following is a sample config file that is saving all connection information (including password) and also has three extra columns configured.
<?xml version="1.0"?>
<ROOT>
  <ServerAddress>http://localhost/scripts/ttsoapcgi.exe</ServerAddress>
  <Project>TestTrack ALM</Project>
  <TTUserName>Administrator</TTUserName>
  <TTPassword>password</TTPassword>
  <SaveConnection>True</SaveConnection>
  <SavePassword>True</SavePassword>
  <Column>Currently Assigned To</Column>
  <Column>Product</Column>
  <Column>Component</Column>
</ROOT>

Import Process

The tool imports the selected record on the defect list window into a new Excel sheet in the open active workbook. The import will start at cell "A1", and the first row will be the column headings. The filter used in the defect list window becomes the sheet name. If the sheet name is already in use, the generic Sheet# name is used. This behavior is hard coded and can not be altered at this time. Eacn click of the "Import" button will result in a new sheet being created.

Download

Download the installer from here

Tutorial

Installation

To install the addin, download the installer from the downloads section. If you have a previous version of the Addin, uninstall it first by going through Add/Remove programs in Windows. Follow the prompts to complete the installation.

Using the addin

To use the Addin, open Excel. Depending on your version, you might have an "Addin" toolbar visible, or you may have to go to "View" > "Toolbars" and enable it from there. The first step is to connect to TestTrack, so click on the connect button. Enter all applicable information and click on "Connect". If successful, the "connect" button on the toolbar should be disabled. You are now ready to import some defects! Click on the Bug icon on the toolbar to luanch the defect list window. The window will not display any defects until a filter is selected. Choose a filter to display items, if not sure, use the "Not Filtered" option. Note that this may result in a large number of defects being retrieved and could take several minutes to populate. Select the items you want to import and click on the "Import" button.

Support/Issues

Keep in mind that this tool was developed by me and is provided "as is". Seapine software does not support this tool. If you have any questions or issues, feel free to shoot me an email.