April 8, 2009

SQL Server Reporting Services

Surround SCM

Works with TestTrack 2009 and later Works with Surround SCM 2010 and later

Will not work with TestTrack 2008 and earlier Will not work with Surround SCM 2009 and earlier

The reporting plug-in architecture in TestTrack and Surround SCM enables some pretty exciting reporting and dashboard integration possibilities. You'll find a complete SQL Server Reporting Services (SSRS) plug-in on this page, which allows you to view reports created in SSRS from the TestTrack and Surround SCM clients.
[toc]

Installing the Plug-in

Download the SSRS plug-in zip file.
  • SSRSPluginCore.dll — C# library that supports the SSRS web service.
  • serverreportsSSRSPlugin.dll — C++ library used to wrap SSRSPluginCore.dll.
  • serverreportsttplugin.conf — Configuration file used by SSRSPluginCore.dll, which stores the computer name SSRS is running on and the web service virtual directory name.
  • clientreportsSSRSClientPlugin.dll — C# library that communicates with SSRS to open Report Builder.
The following installation instructions work for both TestTrack and Surround, <appdir> is the application installation path. For example, the default for TestTrack is C:Program FilesSeapineTestTrack. The default for Surround SCM is C:Program FilesSeapineSurround SCM.

Server Plug-in

Note: Microsoft .Net Framework must be installed on your server for this plug-in to function properly.
  1. Copy the following files to the <appdir>serverrports directory on the server:
    • SSRSPlugin.dll
    • ttplugin.conf
  2. Update the following parameters in ttplugin.conf.
    • Change the serverlocation parameter to the computer that SSRS is installed on. For example, if SSRS is installed on a computer named WYSICORPDEV, use serverlocation=WYSICORPDEV.
    • Change the reportserver_virtualdir parameter to the report server virtual directory name. For example if the virtual directory is named SQLReportServer, use reportserver_virtualdir=SQLReportServer.
    Tip If you do not know the virtual directory name, look it up in the SSRS Configuration Manager. On SQL Server 2005, the virtual directory is displayed in the Report Server Virtual Directory Category. On SQL Server 2008, the virtual directory is displayed in the Web Service URL category.
  3. Copy SSRSPluginCore.dll to the <appdir> directory on the server.
  4. Run regasm SSRSPluginCore.dll at a command prompt to register the C# library to use .NET classes. If the regasm command line utility is not available, install the .NET Framework and try registering the library again.
    For example: regasm "C:Program FilesSeapineTestTrackSSRSPluginCore.dll

Client Plug-in

Note: This is optional, and will allow you to create and edit SSRS reports directly from your TestTrack or Surround SCM client. Additionally, there are sample SQL Server data models for TestTrack, to make report creation easier.
  1. Copy SSRSClientPlugin.dll to the <appdir>clientreports directory on the client computer.
  2. Restart the TestTrack or Surround SCM client.

Using the Plug-in

The following instructions work similarly in both TestTrack and Surround SCM. TestTrack screenshots have been used, but the functionality is the same across both applications.

Application Security

To add external reports to TestTrack or Surround SCM, the following security commands must be enabled for the security group:
  • Add Reports and Add External Reports in TestTrack.
  • Add/Edit Private Reports and Add External Reports in Surround SCM.

SSRS Security

You must configure the following SSRS security to provide external report access in TestTrack:
  • Add Windows users or groups who will access SSRS reports. If the TestTrack Server is installed as a service, add the server computer as a user or group.
  • Assign the Browser role to users or groups who need access to reports in the TestTrack report models.
  • You can also assign other roles as needed.
    Note: SSRS security overrides TestTrack security settings.

Samples

TestTrack Native Samples

If you have a small installation of TestTrack, it might be possible to run Reporting Services against that project without converting to a RDBMS.
Native Database Dashboard

TestTrack MySQL Samples

It's recommended that you move to a RDBMS database if you're going to use 3rd party reporting solutions against the TestTrack data. Here we've created sample reports against a TestTrack project hosted from a SQL Server database.
MySQL Database Dashboard

TestTrack SQL Server Samples

It's recommended that you move to a RDBMS database if you're going to use 3rd party reporting solutions against the TestTrack data. Here we've created sample reports against a TestTrack project hosted from a SQL Server database. SQL Server Reporting Samples.zip - contains SQL Server Reporting Services 2008 rdl files for the samples shown below.

User List by Project & Role

Here's a report showing all of your users and customers broken down by project and role. A great way to gain insight into security and roles across your entire installation.

Project Automation Rules

This report lists all of the automation rules setup in your project broken down by type. The query and more details can be found here.

Project Gantt Chart

This report shows a gantt chart for individual product releases, by task (bug #). Very rudimentary at this point, and highly dependent on how you've setup your TTP project but it's a solid start for those looking at scheduling within TestTrack.

Surround SCM SQL Server Samples

This dashboard shows check out activity by user and by branch. The first chart shows the number of files checked out by user. The second chart shows the number of files checked out by branch, and then by user. It also contains a report with detailed information on the check outs. This is very generic, so it should work under any branch model.

The .rdl files can be downloaded from here. There are two rdl files, Dashboard.rdl is the main dashboard you see in the screenshot above. The Check out Details Table is a sub report, which points to the Check Out Details Table.rdl file.