Welcome to the TFS Integration Platform!

NOTICE 
Please do not create issues or discussions using the Issue Tracker for this project, but instead use the MSDN forum which is monitored by the team.


The TFS Integration Platform is a project developed by the Team Foundation Server (TFS) product group and the Visual Studio ALM Rangers to facilitate the development of tools that integrate TFS with other systems. Currently, the scope of this project is to enable TFS to integrate with other version control and work-item/bug tracking systems, but the eventual goal of this project is to enable integration with a broader range of tools/systems (i.e. build). This platform enables the development of two major classifications of tools: tools that move data unidirectionally into TFS, and tools that synchronize data bidirectionally.

Prior to this project, we had a similar effort called the TFS Migration and Synchronization Toolkit. This platform is designed to replace that project. You can find the archived wiki content for that project on the Archive page, and the releases are still available on the Downloads tab.

Should you be here or on Visual Studio Code Gallery?

The Microsoft Visual Studio TFS Integration Tools is a suite of tools, built on top of the TFS Integration Platform, that facilitate integration between external systems and Team Foundation Server. For more information visit this page or review the latest data sheet.

This product is also released through the Visual Studio Code Gallery.  To decide whether you should be consuming that release or a build from this Codeplex site you can review the following three questions:

  1. Are you looking for a fully supported product, that you can install and run, then you should be looking at the Team Foundation Server Integration Tool here.
  2. Are you looking for the bleeding-edge (BETA & work in progress) binary, source and documentation bits, then this Codeplex site is the correct location
  3. Are you a custom adapter developer looking for the TFS Integration Platform, then this Codeplex site is the correct location
  4. Interested in contributing? Visit the page on Contributing for more information. Check out these Community developed migration/integration projects.

Have a question or comment? Please use the forum rather than the Issue Tracker on this site. We monitor the forum closely and infrequently look at items in the Issue Tracker.

Migration Guidance

If you’re thinking about migrating to TFS, but don’t know where to start, then check out the recommended download (Migration Guidance Document) for the TFS Integration Platform release. This document outlines many of the common scenarios for migrating data into TFS, and it provides recommended options for each scenario.

If you’re looking for migration tools or partner services, please also see the TFS Migration and Integration Solutions page on MSDN.

Upgrade vs. Migration

One common area of confusion is around the definition of "migration", especially as to how it compares with the term "upgrade". Below is an explanation of how these concepts differ (also see the aforementioned Migration Guidance Document).

  • Migration - For this project, and for TFS in general, we use the term "migration" to refer to moving data between two TFS server instances. Migration is done through the APIs of TFS by using external tools, and is a lossy data transfer.
  • Upgrade - We would define "upgrade" as the fully supported, in-the-box process of changing to the next version of TFS (e.g. upgrading from TFS 2005 to TFS 2008). Upgrades are done at the database level, and are full fidelity, meaning there is no data loss.

Scope

TFS is currently comprised of several major feature areas, including, version control, work item tracking, build automation, reporting, and SharePoint. At this point in time, the TFS Integration Platform is scoped to only support a the following TFS features:

  • Version Control - This includes the migration of all files and folders, and support for preserving changeset contents. The following changetypes are currently supported: add, edit, rename, delete, branch, merge, and type.
  • Work Item Tracking - This includes the migration of all work item revisions, fields, in-use areas and iterations, and links (including links to changesets).

Vision

The TFS Integration Platform is a development platform for partners and customers who are interested in building bridges from other systems to TFS. One goal of the project is to make it simple to write a simple adapter for connecting such systems. We intend to continue to invest in raising the level of abstraction for those interested in building solutions by providing a common host UI and eventually wiring in features like offline and more natural cross-domain support into the platform.

Through the development of solutions built on top of this platform by our team, and by our partners, we plan to drive features back into the platform. Feedback from end users of those solutions will also be critical to prioritizing the right areas of investment, so please help us by sharing your experiences and feedback in our forum.

Limitations

Please also be aware of the Limitations that exist for this platform, as outlined on the Visual Studio Gallery and in the Migration Guidance document. Not all scenarios are currently able to be supported due to limitations of TFS, and not all features of TFS are in scope for this project.

Getting Started

If you're a developer and you are looking to get started building an adapter, the best resource for you is the Custom Adapter POC Documentation which you can find in the TFS Integration Tools Documentation, built by the Rangers. This release contains a document that walks through the setup of a development environment for the TFS Integration Platform, and contains a guided tour of a proof of concept (POC) adapter. The document was written with the purpose of helping adapter developers understand the key concepts for building adapters on the platform. Accompanying this document is the actual POC adapter source code, which is in the downloads page.

If you're looking to learn more details about the platform, the core architecture, and the included TFS adapters, check out the TFS Integration Tools Documentation.

Developers looking to start building adapters will also need the installable from the Visual Studio Gallery. This release contains the binaries for the platform as well as the TFS adapters.

For those developers that want to see the latest source code for this project, please go to the Source Code tab.

Visual Studio ALM Rangers

The Visual Studio ALM Rangers are delivering guidance to this initiative with support from Microsoft software engineers, Microsoft Most Valued Professionals (MVPs) and technical specialists from technology communities around the globe, giving you a real-world view from the field, where the technology has been tested and used.

Links

Last edited Jan 22, 2013 at 7:58 PM by wschaub, version 71