Ranorex Help Center

How can we help you?

Team Foundation Version Control (TFVC)

Using Team Foundation Version Control (TFVC) for Source Control

About Team Foundation Version Control (TFVC) and Ranorex Studio

 Team Foundation Version Control (TFVC) is a centralized version control system by Microsoft included in Team Foundation Server.

In order to work with TFVC in Ranorex Studio either Microsoft Visual Studio or Team Explorer for Microsoft Visual Studio have to be installed on the same machine. These programs come with the required 'Team Foundation Server MSSCCI Provider'.

Ranorex Studio will assist you with this dialog in case the required prerequisite is not present on the machine:

Dialog in case the required prerequisite is not present on the machine

The MSSCCI interface supports single byte character sets (SBCS) only. Here you can find a description on how to change the code page. This means there is no MBCS support.

 

Add a Ranorex Solution to TFVC

Please make sure your Team Foundation Server infrastructure is set up and working.

For adding an existing Ranorex Solution to TFVC open the context menu of the solution. Go to 'Source Control' and click on 'Add Solution to Source Control'.

Adding an existing solution to TFVC

To add a new Ranorex Solution right from the beginning to TFVC check the option 'Add to Source Control' in the 'New Project' dialog.

Adding a new solution to TFVC

The 'Source Control Wizard' will be opened.

Please follow these instructions:

  1. Choose 'Microsoft Team Foundation Server' as Source Control provider.
    Choose 'TFVC' as Source Control provider
     
  2. Select your Team Foundation Server.
    Select your Team Foundation Server.
     
  3. Choose the folder you want to add your solution to.
    Choose the folder you want to add your solution to.
     
  4. Select the files you want to have under source control and deselect the files you don't want to have under source control respectively and perform a check in.
    Select the files you want to have under source control

After performing these steps, your solution is under source control and your local copy is up to date.

Your solution is now under source control and your local copy is up to date

 

Check out a Ranorex Solution from TFVC

 Please make sure your Team Foundation Server infrastructure is set up and working.
  1. Open 'Tools' menu, move to 'Source Control' and click on 'Checkout…'.

     
  2. Choose 'Microsoft Team Foundation Server' as Source Control provider in Source Control Wizard.
    Choose 'Microsoft Team Foundation Server' as Source Control provider in Source Control Wizard.
     
  3. Specify the local check out Directory
    Specify the local check out Directory
     
  4. Select your Team Foundation Server.
    Select your Team Foundation Server.
     
  5. Choose the folder in the repository you want to check out from server.
     Choose the folder in the repository you want to check out from server.
     
  6. The chosen solution will be checked out.
 

Icon overlays in Projects View

 

Overlay icons are added to the items in the Projects view in Ranorex Studio as the solution is under source control.

Icon overlays  

Checked In

Checked In File under source control, not checked out for editing.

Checked out

Checked out File under source control, checked out, not dirty.

Checked out Modified

Checked out Modified File under source control, checked out, dirty.

Added

Added File added to project, not checked in.
 

Options

In Ranorex Studio Options you can find options related to TFVC.

Open main menu item 'Tools' and choose 'Options…'. In the following dialog select folder 'Tools' and sub-item 'TFS Options'. By default, all checkboxes are checked.

If you are working with TFVC and running into performance problems with big solutions, uncheck 'Enable file state 'Modified' check'.

TFS options