VersionOne Effort Reporting Tool

Table of Contents

1. Determine Install Location
2. Install
3. Configure

Description

The VersionOne Effort Reporting Tool allows you to export effort records from V1 into a flat SQL server table and report on effort rolled up across many different attributes, including task, test, story, story type, defect, theme, epic, project, iteration, and team. The tool is an exe that can be run as a scheduled task to retrieve effort records at the interval of your choice.

Configure the effort reporting exe with the url of your VersionOne instance and the username and password of a single VersionOne user account. Note that the user account you configure the application to use must have at least Observer access to the projects you wish to retrieve effort for. Create a new database and run the Effort.sql script to create the table that will hold the effort data. You can now create a scheduled task to run the effort reporting exe at the interval of your choice.

System Requirements

VersionOne Release 8.0.1197 and above

Integration Server:

Operating System—Windows 2000, 2003
Framework—Microsoft .Net 2.0
Database—SQL Server 2000 or later

Downloads

The latest version of The Effort Reporting Tool is available at V1: Integration Downloads.

Installation

Configuration varies slightly depending on whether you are using VersionOne native authentication or Windows Integrated authentication. Tip: all hosted VersionOne instances use VersionOne native authentication. Local installations can be either.

1. Determine Install Location

The effort reporting tool can be installed on any server that has internet access to your VersionOne instance. Exact placement should be determined by your internal software management requirements. The integation server must meet the System Requirements stated above.

2. Install

Download the effort reporting binary zip from the link above.
Extract the contents to a location on your server.
Create a new database in a SQL Server instance.
Run the Effort.sql script to create the Effort table.

3. Configure

Open the file VersionOne.EffortReporting.Console.exe.config in a text editor, change the configuration parameters listed below, and save your changes.

Table 1. Effort Reporting Tool Configuration Parameters

Parameter	Description
authenticationType	VersionOne security setting. Valid values are "V1" and "WindowsIntegrated".
v1Url	VersionOne installation URL.
username	User that will access VersionOne. If authenticationType is "WindowsIntegrated", you must specify the windows domain account in the form "User@FullyQualifiedDomainName". If you are unsure what the fully qualified domain name is, see the Domain name shown on the 'Computer Name' tab in the My Computer...Properties dialog. If using "WindowsIntegrated", you may also leave the username and password blank, and simply run the exe in a process that uses a valid windows account that can access your VersionOne instance.
password	Password for the username above (see note above about leaving it blank in case of "WindowsIntegrated" security).
connectionString	Valid connection string for the database you created during installation. Ensure the credentials used have write and truncate access to the Effort table.

3. Test the Application

Open a command prompt and navigate to the location of the VersionOne.EffortReporting.Console.exe
Type "VersionOne.EffortReporting.Console.exe" to run the exe. You should receive a message that the report data has been refreshed.
Open your Effort table in SQL Server and ensure it is populated with the effort records you expect from VersionOne.

4. Schedule

Create a scheduled task to run the exe at the interval of your choice. If using "WindowsIntegrated" authentication with a blank username and password, run the scheduled task using a valid windows account that can access your VersionOne instance.

Example Queries

Get the total effort expended per day by each person on every Story and Defect in the system:

SELECT     memberFullName, storyOrDefectName, dateLogged, SUM(effortLogged) AS totalEffort
	FROM         Effort
	GROUP BY memberFullName, storyOrDefectName, dateLogged

Get the total effort expended on a particular theme (also called feature group in some methodologies) during a particular time period:

SELECT     themeName, SUM(effortLogged) AS totalEffort
	FROM         Effort
	WHERE     (dateLogged BETWEEN '20080201' AND '20080331')
	GROUP BY themeName

Get the total effort for each team spent on a particular project:

SELECT     teamName, teamId, projectName, projectId, SUM(effortLogged) AS totalEffort
	FROM         Effort
	GROUP BY teamName, projectName, teamId, projectId