How to set up integration with Team Foundation Server
Team Foundation Server (TFS) plugin can be used to update entities in TargetProcess. You can update entity states and time spent/remaining as you enter comments when doing a commit to Microsoft Visual Studio.
To set up TFS integration, go to Settings → System Settings → Plugins, and add a new TFS Integration profile:
There are two ways to specify a working repository:
- The URI includes a reference to a TFS Project collection. In this case, revisions for all the Project Teams in this collection will be processed
- The URI includes a reference to just one TFS Project Team. Only the revisions from the specified Project Team will be processed.
By default, users in TFS and TargetProcess are mapped automatically if one of the following is true:
- TFS User Domain Name is like: “Domain\UserName” = TP Active Directory User name
- TFS User Name w/o domain prefix = TP Login
Otherwise, you need to map users:
As soon as the profile is created, TargetProcess will import TFS revisions starting from the revision number you’ve specified. This can take several minutes. You can track the import status in the log:
Now, as you do a commit to Microsoft Visual Studio, just add a comment in any of these formats:
|Change entity states||#ID (or id:ID) state:fixed|
|Add comments to defect||#ID comment: text of your comment here comment: this is a second multi-line comment row1 row2|
|Add spent time||#ID time:1|
|Add spent and remaining time||#ID time:4:8|
|Update several entities at a time||#ID, #ID comment: will not be fixed state: invalid time:0.5|
|All possible actions||#456, #887 state:done time:3:0 comment:whoa! Everything is completed!|
In this example, as soon as the commit is done, the status of the entity with ID=128 will be changed to Done, and the comment “Should be included to the current release,” spent time = 1 hour and remaining time = 2 hours will be added to the entity.
You can see all the updates from TFS in the Source tab:
Make sure you enter comments in the correct format as shown above. Neither comments, nor time entries, nor the states will update if the format is incorrect.
You can convert the old TFS plugin profiles to the new ones (recommended). The “Convert to new profile” option is available for all the old plugins:
As soon as the conversion is done, the old profile is disabled. The new profile will resume syncing from the last processed revision number.