Skip to main content
The FlexDeploy TFVC plugin makes it easy to interact with source code stored in Microsoft Team Foundation Version Control SCM. There is no need to install TFS or a TFVC client. The plugin uses a Java based API to interact with Team Foundation Version Control. FlexDeploy allows users to configure TFVC repository connection details to be shared by various projects and other configurations at the project level. This allows for easy get and label operations during a build workflow execution. 
  • Create SCM Instance for TFVC and define the URL, User and Password information. You can also validate the connection when creating an SCM Instance for TFVC.
  • At the project level, the user will select TFVC as the SCM Type and provide details like Get Folder, Branch, Label etc. which are defined as Groovy scripts.

​
Supported Versions

  • 2013+
  • On-Prem
  • Hosted

​
Key Features

  • No installation necessary
  • Executes commands using embedded Java API.

​
Integration Instance Properties

FlexDeploy supports creation of SCM instances and the following properties must be configured for each TFVC Instance. These properties are available to all operations.

Property Name

Property Code

Required

Description

TFVC URL

FDTFVC_URL

Yes

Team Foundation Server collection URL.

TFVC User

FDTFVC_USER

Yes

The user name for connecting to TFS/TFVC. User name does not need to be domain qualified.

TFVC Password

FDTFVC_PASSWORD

Yes

The password for the TFVC User.

TFVC File Content URL

FDTFVC_FILE_CONTENT_URL

No

TFVC repository file URL. Able to use the following variables {FILE_PATH}{PROJECT_NAME}{PATH}

Configure this property if URLs automatically generated by FlexDeploy does not meet your needs.

Available variable(s):

  • {PATH} - This will be either Main Path Script or Branch Path Script e.g.: /main/HumanResources/Project1

  • {FILEPATH} - Path of the file as discovered from SCM, e.g. /sql/EmployeeData.sql

  • {PROJECT_NAME} - Name of the Project, for example, if the Project Name starts with TFSRepo−theProjectNamewillbeTFSRepo</p></li></ul><plocal−id="02c2bafb922f">e.g.<code>https://repo.mydomain.com/{PROJECTNAME}/{PATH}/{FILEPATH}</code></p><plocal−id="a5f40c1b6c7b">Availablesince<strong>9.0.0.7</strong>.</p></td></tr><trdata−local−id="d930f3a5d25d"><tddata−local−id="c01f351bec36"class="confluenceTd"><plocal−id="99984aeae19a">TFVCFileContentCommitURL</p></td><tddata−local−id="a3e1d373c171"class="confluenceTd"><plocal−id="a07c943a8d55"><code>FDTFVCFILECONTENTCOMMITURL</code></p></td><tddata−local−id="daa4776aaa3a"class="confluenceTd"><plocal−id="42f37f81ece8">No</p></td><tddata−local−id="0b45cd3c5012"class="confluenceTd"><plocal−id="65590ce34e37">TFVCrepositoryfilecontentcommitURL.Abletousethefollowingvariables{FILEPATH}{PROJECTNAME}{PATH}{COMMIT}</p><plocal−id="74593f2849b5">ConfigurethispropertyifURLsautomaticallygeneratedbyFlexDeploydoesnotmeetyourneeds.</p><plocal−id="6736803687ed">Availablevariable(s):</p><ullocal−id="a57724d731a3"><lilocal−id="9c14c95e7c05"><plocal−id="e052b52d0441">{COMMIT}−Teamsfoundationrevisionnumberlike10,15,etc.</p></li><lilocal−id="e0f7fdb92c3f"><plocal−id="302a39121586">{PATH}−ThiswillbeeitherMainPathScriptorBranchPathScripte.g.:<code>/main/HumanResources/Project1</code></p></li><lilocal−id="c8f30e479eb2"><plocal−id="e2095b11300b">{FILEPATH}−PathofthefileasdiscoveredfromSCM,e.g.<code>/sql/EmployeeData.sql</code></p></li><lilocal−id="157abc243a50"><plocal−id="ad8d9d2913ea">{PROJECTNAME}−NameoftheProject,forexample,iftheProjectNamestartswithTFSRepo - the Project Name will be TFSRepo</p></li></ul><p local-id="02c2bafb922f">e.g. <code>https://repo.mydomain.com/\{PROJECT_NAME\}/\{PATH\}/\{FILEPATH\}</code></p><p local-id="a5f40c1b6c7b">Available since <strong>9.0.0.7</strong>.</p></td></tr><tr data-local-id="d930f3a5d25d"><td data-local-id="c01f351bec36" class="confluenceTd"><p local-id="99984aeae19a">TFVC File Content Commit URL</p></td><td data-local-id="a3e1d373c171" class="confluenceTd"><p local-id="a07c943a8d55"><code>FDTFVC_FILE_CONTENT_COMMIT_URL</code></p></td><td data-local-id="daa4776aaa3a" class="confluenceTd"><p local-id="42f37f81ece8">No</p></td><td data-local-id="0b45cd3c5012" class="confluenceTd"><p local-id="65590ce34e37">TFVC repository file content commit URL. Able to use the following variables \{FILE_PATH\}\{PROJECT_NAME\}\{PATH\}\{COMMIT\}</p><p local-id="74593f2849b5">Configure this property if URLs automatically generated by FlexDeploy does not meet your needs.</p><p local-id="6736803687ed">Available variable(s):</p><ul local-id="a57724d731a3"><li local-id="9c14c95e7c05"><p local-id="e052b52d0441">\{COMMIT\} - Teams foundation revision number like 10, 15, etc.</p></li><li local-id="e0f7fdb92c3f"><p local-id="302a39121586">\{PATH\} - This will be either Main Path Script or Branch Path Script e.g.: <code>/main/HumanResources/Project1</code></p></li><li local-id="c8f30e479eb2"><p local-id="e2095b11300b">\{FILEPATH\} - Path of the file as discovered from SCM, e.g. <code>/sql/EmployeeData.sql</code></p></li><li local-id="157abc243a50"><p local-id="ad8d9d2913ea">\{PROJECT_NAME\} - Name of the Project, for example, if the Project Name starts with TFSRepo - the Project Name will be TFSRepo

e.g. https://repo.mydomain.com/\{PROJECT_NAME\}/\{PATH\}/\{FILEPATH\}/commit/\{COMMIT\}

Available since 9.0.0.7.

TFVC Commit URL

FDTFVC_COMMIT_URL

No

TFVC Commit URL. Able to use the following variables {COMMIT}

Configure this property if URLs automatically generated by FlexDeploy does not meet your needs.

Available variable(s):

  • {COMMIT} - Teams foundation revision number like 10, 15, etc.

e.g. https://repo.mydomain.com/MyOrg/FD-REPO/commit/\{COMMIT\}

Available since 9.0.0.7.

​
Special Considerations

If you are connecting to a Visual Studio Online repository, you will be required to use a personal access token instead of a password to connect your account to FlexDeploy. To create a personal access token, follow these simple steps.
  1. Sign into your visual studio online account by going to https://[your-account-name].visualstudio.com. 
  2. Click on your profile in the upper right corner.
  3. From that menu, choose ‘Security’, and the first page you see should be called ‘Personal access tokens’. 
  4. Click add to create a new token.
  5. Give your token a name and choose the account(s) that should be accessed using that token.
  6. Copy the token displayed on the page, and paste it in place of the password when creating a TFVC instance in FlexDeploy.
NOTE - We can also have a TFS/TFVC repository in Azure DevOps, and FlexDeploy supports this integration. For the Azure DevOps configuration, the required details are: You can create a PAT from: https://dev.azure.com/{Organisation}/_usersSettings/tokens

​
Plugin Operations