Banner background image
Studio User Guide
Last updated Dec 20, 2023

Managing Projects With TFS

The supported versions of Team Foundation Server are:

  • 2012
  • 2013
  • 2015
  • Express 2012
  • Express 2013
  • Express 2015

    Note: Studio only works with Server workspaces. You cannot open projects from TFS if the workspace created by Studio is changed to a Local workspace from outside of Studio.

Setting up TFS in Studio

  1. In the Team tab, click Open from TFS or Add to TFS. The Connect to Azure DevOps Server window is displayed.

  2. Click Servers. The Add/Remove Azure DevOps Server window is displayed.

  3. Click the Add button. The Add Azure DevOps Server window is displayed.

  4. Fill in the details of your TFS repository and click OK. Your team’s collections and projects are available in the Connect to Azure DevOps Server window.

The Manage TFS Online button connects you to the web management interface.

If the TFS server is online (e.g. https://<account> UiPath Studio requests authentication with a Microsoft account.
Note: By default, on all Windows Server machines, this window is not displayed, as it requires JavaScript to run. This can be enabled from the Internet Explorer settings (Security tab > Custom Level > Enable Scripting).

Opening a Project from TFS

  1. In the Team tab, click Open from TFS. The Connect to Azure DevOps Server window is displayed.

    Note: The Connect to Azure DevOps Server window has the option to switch between users when connecting to the TFS repository.
  2. Open the drop-down menu under the Select an Azure DevOps Server and pick the server you want to access. Pick a team project collection and a team project. Once the selection is made, click Connect. The Repository Browser opens.

  3. Expand or collapse folders in the repository, look inside folders, copy the Selected Path or select a file to open. Click OK. The Check out from TFS project window is displayed.

    To change the file and open the repository browser, use the button.

  4. Pick a Check out directory. The project name is added to the checkout directory by default. Click Open. The project.json, .xaml and other files stored in the repository project folder are mapped locally.
  5. A Question dialog box is opened, with two options for pulling the Main.xaml file from the repository:
    • Check out latest and edit - opens the latest version of the Main.xaml file from the repository, in edit mode. The Break Lock option indicates that the file is already checkout by another user. By using this option, the lock is removed without notifying the user.
    • Open local as read only - opens the local version of the Main.xaml file in read-only mode. The Package Manager can be opened even if the files are in read-only mode, but in order to perform changes and install dependencies, the project.json file needs to be checked out.
Selecting the checkbox for Always do this and don't show me this again, and then the Check out latest and edit option propagates your choice for future occurrences. Regardless of your choice, the project.json file still needs to be checked out separately for certain changes to take effect.

Note: If you check out only the <code>.xaml</code> file of a library project from the TFS repository, the <code>.screenshots</code> folder does not update. Use Get Latest Version on the folder to get the files.

Adding a Project to TFS

  1. Create or open a project in Studio. Click Start > Team > Add to TFS button, or Add to Source Control > Add to TFS shortcut in the status bar. The Connect to Azure DevOps Server window is displayed.
  2. Pick the server you want to access, a team project collection, and a team project. Once the selection is made, click Connect. The Please select the folder to add under window is displayed, which allows you to select the location to add your project to. Click OK.

  3. The Add to TFS project window is displayed.

    To add the project to a particular folder, provide a relative path to the Remote subfolder box or use the docs image button to open the repository browser. Select a .xaml file to open. Click OK. Pick a Check out directory, and then click Add. The Check in Changes window opens.
  4. Select the files you want to check in and write a Commit Message. Click Check In. The project files are added to the TFS repository, and checked out locally, except for the project.json file.

When a project is added to TFS, the context menu in the Project panel includes TFS-specific options. For more information, see Context Menu Options for SVN and TFS.

Editing and Checking in Changes to TFS

  1. Connect one of your projects to your TFS repository.
  2. Right-click the .xaml file and select Check Out for Edit. The latest version of the .xaml file is mapped locally and opened in the Project panel. It becomes locked for editing until it’s checked in. Perform any sort of changes to the files.
    Note: Once a file is checked out from the TFS repository, it is no longer available for check out by other users with access permissions.
  3. Right-click the .xaml file or project node, and select Check In, or click the docs image icon in the Status bar, which also counts the number of uncommitted changes. The Check In Changes window is displayed.
  4. Review the changes and check the Show Unversioned Files box to add imported files to the repository. Write a Commit Message to describe the changes.

  5. Click Check In. The latest version is now available in the repository, together with the Commit message. In Studio, the project.json file returns to the read-only mode.
  6. Click Start > Team > Disconnect to disconnect the current project from source control.

    Note: If you edit a file from a project added to source control in an external editor, the change is visible in the Project panel and the status bar only after you click Refresh docs image in the Project panel.

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.