Skip to main content

 

 
Go Search
Home
Getting Started
Knowledge Base
Training
Discussions
Downloads
Platform SDK
  

 
 
VersionOne Community > Downloads > Integration Documentation > VisualStudio

 
VersionOne Visual Studio Add-In User Guide

VersionOne Visual Studio Add-In User Guide


Description

The VersionOne Visual Studio Add-in (VSAddin) provides direct interaction with VersionOne developer tasks from within Visual Studio. This enables Microsoft platform developers to update VersionOne task status, estimates, remaining effort, etc., without needing to leave the comfortable confines of the Visual Studio IDE. VSAddin was created using the Visual Studio.NET 2003 VSIP SDK & Extras and has been released as a working reference implementation..

System Requirements

VersionOne: 6.3 or above

Client Workstation:

  • Operating System—Windows XP, Windows 2000, or Windows Server 2003

  • IDE—Visual Studio .Net 2003 or Visual Studio 2005

Downloads

The latest version of VSAddin is available at V1: Integration Downloads.

Installation

1. Run the MSI

Run the VSAddin setup msi and follow the steps in the installation wizard.

2. Configure

Select Options… from the Tools menu, and navigate to the VersionOne settings as show in Figure 1, “Configuration Options Screen”.

Figure 1. Configuration Options Screen

Configuration Options Screen


Enter the configuration parameters as specified in the table below and click Test Connection to ensure that the add-in can both access VersionOne’s API and authenticate using the supplied username and password. If the add-in is not configured correctly, or if VersionOne is unavailable (e.g. you are off-network), both the Projects and Tasks windows will inform you of the appropriate error, and provide an option to modify the add-in configuration.

Table 1. VSAddin Configuration Parameters

ParameterDescription
Application URLVersionOne installation URL
UsernameUser that will access VersionOne. If authenticationType is WindowsIntegrated this can either be left blank to use the currently logged on user, or a different windows domain account can be specified (it must be in the form 'user@FullyQualifiedDomainName').
PasswordPassword for the username above. If the authenticationType is WindowsIntegrated this should be left blank if the username is blank (to use the currently logged on user account).
Effort TrackingFlag for Effort Tracking. If VersionOne has effort tracking enabled, check this box to add the Effort and Done columns


Usage

The add-in consists of two dockable windows, VersionOne Projects and VersionOne Tasks, accessible via the View menu’s Other Windows sub-menu. Additionally, the built-in Visual Studio properties grid is populated with relevant properties dependent on the user’s context and focus within either window.

Selecting Projects

As shown in Figure 2, “Projects Window”, the VersionOne Projects dockable window displays a project tree populated with your current projects. To access this window, go to the View menu, select the Other Windows sub-menu, and select VersionOne Projects. To choose a specific project to work on, simply navigate the tree and select it.

Note that your project selection is maintained between uses of Visual Studio (per user, via Documents And Settings), so after you select the project you may close this window to preserve real estate within the IDE. The Task Window (discussed next) displays the current project name in its’ window title for project context.

Figure 2. Projects Window

Projects Window

Updating Tasks

Like the VersionOne Projects window, the Tasks window is accessible by selecting VersionOne Tasks via the View menu’s Other Windows sub-menu. Once you’ve selected a project you’re working on, the Tasks window will display a grid listing all tasks that belong to you. To update a task, either modify the attribute directly in the tasks grid (for the most common properties) or, after selecting the row, use the Visual Studio properties grid to edit the extended set of task properties. Once you’re finished updating a Task, click the Save button to update the task in VersionOne.

Figure 3. Tasks Window

Tasks Window

Copyright © 2007, VersionOne, Inc. All rights reserved. This document was generated 2007-05-08 18:39:21.