CA Agile Central Plugin for Microsoft Visual Studio / TFS 2008/2010 Installation & User Guide
The CA Agile Central Plugin for Visual Studio/TFS (Team Foundation Server) provides a simple method for .NET developers and testers to link CA Agile Central artifacts to VS/TFS Version Control checkins to provide traceability between CA Agile Central artifacts and code checkins.
Supported Versions: Visual Studio 2008 or 2010 with Team Foundation Server 2010 or 2012
This plugin can operate at two different levels:
- If you have only VS (Visual Studio) installed, this plugin will cause updates to VS Defects or Tasks to be pushed to CA Agile Central.
- If you also have TFS (Team Foundation Server) installed as well, this plugin will also display a "CheckIn" box on the plugin screen in VS.
For developers and testers who use Microsoft Visual Studio for application development and use Team Foundation Server source control, the Visual Studio plugin provides instant access to tasks and defects from within the Visual Studio context. The tasks and defects can be viewed or updated, providing an easy way to cross-populate information in CA Agile Central without having to leave the IDE. The Team Foundation Server plugin extends on this by providing a simple method to link CA Agile Central artifacts to Team Foundation Version Control check-ins to provide traceability between CA Agile Central artifacts and code check-ins.
2.0 Software and hardware requirements
Click on the Contact Support link at the bottom of any page in CA Agile Central to open a support case to obtain the CA Agile Central plugin for Team Foundation Server. Once you've received a response and obtained the installation package, proceed with the following tasks.
The following are the hardware and software requirements to install and run the CA Agile Central Team Foundation Server plugin.
- Visual Studio 2008 or 2010;
- Team Foundation Server 2010 or 2012 with Source Control
*Tested on 32-bit Windows XP and 64-bit Windows 7
Install the CA Agile Central Team Foundation Server plugin on each Visual Studio client that you plan to run the plugin. Installing multiple versions (one for Visual Studio 2008 and one for Visual Studio 2010) of the plugin is not supported.
3.1 New installation
- Double-click the RallyforVisualStudio20xx_1.x.x.msi file.
- Click Next when the welcome screen displays.
- Accept the license agreement to proceed.
- Click Next to confirm the installation.
The installer copies the files and configures the file system.
Administrator Installation: If the your are an administrator, the installer shows a dialog to confirm the version of Visual Studio for which the plugin is being installed and whether the plugin will be available to only the logged in user or everyone. Check the Make this installation available to Everyone box to make the CA Agile Central plugin available to any user that logs in to that machine.
If you are not an administrator, the installer installs the plugin only for the logged-in user.
3.2 Upgrade existing installation
The plugin removes the previous versions installed on you machine. However, if you attempt to install the same version, the setup displays a message with options to repair or remove the current installation. To resolve this:
- Go to Start → Control Panel → Add/Remove Programs and select Rally for Visual Studio, and click Remove. Alternatively, double-click the RallyforVisualStudio20xx_1.x.x.msi file.and select Remove Rally for Visual Studio.
- Follow the steps listed under 3.1 New installation.
4. Troubleshooting the plugin
4.1 Installation troubleshooting
If the CA Agile Central entry point icon does not display in the Tools menu, then follow these steps to manually initiate the plugin:
WARNING: THE ACCURACY / VALIDITY OF THE 3 STEPS BELOW HAVE BEEN CALLED INTO QUESTION. IT WILL BE CORRECTED AS SOON AS WE HAVE NEW DATA>
- Go to Start → All Programs → Microsoft Visual Studio 2010/2013 → Visual Studio Tools → Visual Studio 2008/2010 Command Prompt.
- Type devenv.exe /resetaddin RallyPlugin.Connect.
A new Visual Studio instance starts.
- The CA Agile Central plugin menu displays in the Tools menu.
4.2 Check-in button troubleshooting
If the check-in button does not display, verify these items:
- Ensure you have a Project/Solution open in Solution Explorer.
- Ensure the files in the open Project/Solution have been added to TFS source control.
4.3 Plugin hangs on Getting workspace users
If after you login in to the CA Agile Central plugin, the messages displayed in the bottom-right corner of the Visual Studio window stop and hang at: "Getting workspace users...", then it is probably because this user (in CA Agile Central) has a "Default Workspace / Project:" as follows:
- the user is the only user having access to this workspace/project.
- the user has this default setting defined as "<<No Entry>>" (for example, no workspace/project).
4.4 Unable to load data for Iterations filter drop-down
You may encounter the following error when running version 1.6.3 or lower of the plugin, or, after upgrading to 1.6.4 or higher without a clean un-install:
"Unable to load data for Iterations filter drop-down due to a recent error. Please click 'Refresh List' to reload list."
This may occur when the plugin tries to refresh the Iterations list: A) after successfully logging in or B) when clicking Refresh List button. This is a known issue which has been resolved for version >= 1.6.4 of the plugin. If you were running a previous version of the add-in you may need to do a clean reinstall (after uninstalling your present instance) in order to overcome this error. A clean reinstall is the key: before you re-install, please follow these steps to uninstall your current instance:
- Close Visual Studio
- Uninstall the current Visual Studio plugin (Control Panel >> Programs and Features)
- In a Windows Explorer window, navigate to (example from Windows 7):
- "C:\Users\username\Documents\" (or the equivalent folder for your version of Windows)
- Delete the folder named "RallyPlugin" from the "Documents" folder.
- Re-install the plugin from the install MSI.
4.5 General troubleshooting
The activity log tracks all errors that the plugin encounters. If you have any issues using the plugin, please review the log file located in:
- Windows XP: %UserProfile%\My Documents\RallyPlugin\ForVS2010\RallyLog\<year><month><day>ActivityLog.log
- Windows 7: %UserProfile%\Documents\RallyPlugin\ForVS2010\RallyLog\<year><month><day>ActivityLog.log
For example, log for November 3rd, 2010 will be named 20101103ActivityLog.log and will be stored in this directory.
5. Using the CA Agile Central Team Foundation Server plugin
5.1 Display Team Foundation Server plugin from Visual Studio
- Open Visual Studio.
- From the menu bar, click Tools, then select CA Agile Central.
- Click Login and enter user credentials on the Setup Page.
- Enter proxy server information if applicable (speak to your local system administrator for the server information).
- Click OK.
5.2 Retrieve workspaces, defects, and tasks
Once successfully logged in to CA Agile Central from the plugin, the Tasks and Defects lists are displayed for the CA Agile Central user's default workspace in CA Agile Central. To determine if a user has a default workspace, go to Setup → Profile → Edit Profile from CA Agile Central.
- If you do not have a default workspace,the first open workspace sorted alphabetically will display that you have permission to view.
- Only Tasks and Defects that the Visual Studio user owns and are not-closed (not- completed) are displayed.
- All open workspaces that the user has permission to view are displayed in the workspace drop-down.
- By default, the Task tab is selected and the Task list is shown. You can click the Defects tab to see the Defect list.
- Selecting another workspace from the Workspace chooser will automatically refresh the current Task and Defect list with information from the selected Workspace.
5.3 Update tasks and defects
Click the row for the defect or task you want to edit.
The Save and Cancel icons are located at the top-right to accept and cancel modifications. These icons are identical to the Save and Cancel icons in CA Agile Central when inline editing an artifact.
5.4 Check in code from Team Foundation Server Source Control
- Open a Solution/Project from File → Open in Visual Studio. Ensure this Solution/Project has been added to Source Control.
- Go to Tools → CA Agile Central (if the CA Agile Central window is not currently open). A check in button should display on the far-right of the defect or task row.
- Once a file is modified in Visual Studio and ready to be checked in, click Check In from the appropriate row for the CA Agile Central artifact that relates to the modified files.
- On the Check In dialog select the applicable files to check in and enter comments regarding the changeset.
- Click Check In to finalize.
- Once this completes, right-click on the modified file in Visual Studio and select Show History to see the last changeset and a reference to the CA Agile Central artifact in the history.
- For the CA Agile Central artifact, click the formatted ID (such as DE1, TA23) link to go directory to the artifact (it may prompt you to login to CA Agile Central).
- When viewing the CA Agile Central artifact from CA Agile Central, notice the fields are updated in CA Agile Central based on modifications from Visual Studio (for example, you updated the Defect state and now the same state is set in CA Agile Central).
- The CA Agile Central artifact will also have a new Discussion entry that shows information on the changeset, comments, owner of change, and a list of modified files in a nicely formatted table view.