TFS SCT

You can use Microsoft Visual Studio Team Foundation Server (TFS) as an artifact source for a component. TFS is the collaboration platform at the core of Microsoft's application lifecycle management (ALM) solution.

In this topic:

Prerequisites

Before you can use the TFS source configuration type (SCT), ensure that the following prerequisites are met:

• An executable named tftoolxxxx.exe (where xxxx is the version of TFS, and can be 2008, 2010, 2012, 2013, 2015, or 2017) must be installed on the Deployment Automation server.

  The Deployment Automation server installer automatically installs the supported tftool executables. These are placed in the Deployment Automation server tools\tfs directory in folders that match each exe name. For example, the tftool2013.exe is installed here by default:

  <da-install-directory> \tools\tfs\tftool2013\tftool2013.exe

• The Deployment Automation server and the TFS software must be installed on the same machine, because there are certain TFS DLL files required by the tftool executable.

• The installation folder is specified in the tfsToolLocation property in the server installation's conf\server\installed.properties file, so there is no need to include this in the Path variable.

  If the tftool executable is not found in the in designated folder, an error message similar to the following is displayed:

  "You must provide a valid TFS tool; <da-install-directory>\tools\tfs\tftool2013\tftool2013.exe was not found."

• If you upgraded or reinstalled, and during installation you selected the Use Existing Settings option in the General Program Settings panel, the tfsToolLocation property may not be set in the server installation's conf\server\installed.properties file. In that case, you need to add the property to the file manually and set it to the directory path where your tftool executables reside, for example:

  tfsToolLocation=<da-install-directory>\tools\tfs

Back to top

TFS SCT settings

Select TFS from the Source Config Type list and define the type-specific properties. For details about creating components, see Create components.

Field	Description
TFS URL	Specify the TFS server URL. For example: http://tfs2013:8080/tfs/mycollection
TFS Version	Select the version of the TFS libraries that you want to use. These are listed from those installed on the Deployment Automation server. For details, see Prerequisites. Note: Use 2015 or 2017 with the TFS source configuration type only if you are using XAML builds. Otherwise, see TFS vNext SCT.
TFS Username	Specify a username if you need to use different credentials than the ones used for the Deployment Automation process.
TFS Password	Specify a password if you specified a username.
TFS Team Project	The name of the TFS team project where the build definition resides.
Build Definition	The name of the build definition to monitor for new builds.
Build Status	Limit builds to a given status.
Build Quality	Limit builds to a given build quality.
Directory Offset	Directory offset within the root of the build artifacts.
File Includes	Specify a new-line-separated list of files to include. Leave empty or use **/* to include all.
File Excludes	Specify a new-line-separated list of files to exclude.

Back to top

See also:

• Use source configuration types
• Plugins overview