UiPath Studio Guide

Connecting your Project to a Source Control System

Source control systems prove very handy when developing larger projects that require smooth collaboration between multiple users. Studio offers the tools to connect automation projects to version control systems through the Team page in the backstage view.

Alternatively, the Show Team Page image alt text button in the Project panel opens the same Team page. When connected to either a TFS or SVN repository, the icon changes to image alt text and displays repository and user details if you hover over it.

Note:

You cannot connect to both TFS and SVN at the same time.

The supported versions of Team Foundation Server are:

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

TFS Version Control

Setting up TFS in Studio

  1. In the Team page, click Open from TFS or Add to TFS. The Connect to Team Foundation Server window is displayed.
  1. Click Servers. The Add/Remove Team Foundation Server window is displayed.
  1. Click the Add button. The Add Team Foundation Server window is displayed.
  1. Fill in the details of your TFS repository and click OK. Your team’s collections and projects are available in the Connect to Team Foundation Server window.

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

If the TFS server is online (e.g. https://<account>.visualstudio.com) 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 page, click Open from TFS. The Connect to Team Foundation Server window is displayed.

Note:

The Connect to Team Foundation Server window has the option to switch between users when connecting to the TFS repository.

  1. Open the drop-down menu under the Select a Team Foundation 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 Check out from TFS project window opens.
  1. To check out a particular folder, add a relative path to the Remote subfolder or use the image alt text button to open the repository browser. Expand or collapse folders in the repository, look inside folders, copy the Selected Path or select a file to open. Click OK.
  1. Pick a Check out directory. The project name is added in the checkout directory by default. Click Open. The project.json, .xaml and other files stored in the repository project folder are mapped locally.
  2. 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 allows you to check out a project from a TFS repository that was previously checked out by a different 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.

Note:

If you check out only the .xaml file of a library project from the TFS repository, the .screenshots 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 on the Show Team Page button in the Project panel. This opens the Team page.
  2. Click on the Add to TFS button to open the Connect to Team Foundation Server window. Pick the server you want to access, a team project collection and a team project. Once the selection is made, click Connect. The Add to TFS project window opens.
  1. To add the project to a particular folder, provide a relative path to the Remote subfolder box or use the image alt text 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.
  2. 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.

SVN Version Control

Opening a Project from SVN

  1. In the Team page, select Open from SVN. The Open from SVN Repository window opens.
  1. Type in the Repository URL or use the image alt text button to open the repository browser. Expand or collapse folders in the repository, look inside folders, copy the Selected Path or select a file to open. Click OK.
  1. Pick an empty Check out directory. Select the Use credentials box and fill in your Username and Password. Click Open. The project is now available in the check out directory.
  2. 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 allows you to check out a project from a SVN repository that was previously checked out by a different 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.

Adding a Project to SVN

Note:

Some SVN operations are not directly manageable through Studio. For this, and to ensure optimal compatibility, use a recent version of a SVN client. For TortoiseSVN, versions up to 1.9.7 are supported.

  1. Create or open a project in Studio from the Start tab in the Backstage view.
  2. Click on the Show Team Page button in the Project panel. This opens the Team page.
  3. Click on the Add to SVN button to open the Add to SVN window.
  4. Type in the Repository URL or use the image alt text button to open the repository browser. Select a file to open. Click OK. Provide a path to the Check out directory. The check out directory must be empty. If applicable, check the Use credentials check box, and type in the User and Password. Click Add to upload the project to the SVN repository.
  5. In the Check In Changes window, select the files that you would like to add to the repository and write a Commit Message.
  1. Click Check In. The files are now available in the repository, together with the Commit message. The project.json file returns to read-only mode in Studio.

Editing and Adding a New Project Version in TFS or SVN

  1. Connect the project to your TFS or SVN repository.
  2. Right-click the .xaml file, and select Check Out for Edit. The latest version of the .xaml file on the repository is added to the Project panel, and it becomes locked for editing, until it’s checked in.

Note:

Once a file is checked out from the TFS or SVN repository, it is no longer available for check out by other users with access permissions.

  1. Changes can be made to the .xaml file, as if it were on the local machine.
  2. To upload the newest version, right-click the .xaml file and select Check In. The Check In Changes window is displayed.
  3. 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.
  1. 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.
  2. Click on the Show Team Page button in the Project panel, and then Disconnect to disconnect the current project from source control.

Context Menu Options

Important!

This information applies to both SVN and TFS.

Once your project is connected to either TFS or SVN, right-clicking any file or folder in the Project panel opens a context menu that contains the following options:

Option
Description

Open

Opens the selected .xaml file in the Designer panel, in read-only mode if it was not checked out for edit from the TFS/SVN repository.

Rename

Enables you to rename the selected file or folder, and opens the Rename Item window. When checking in the renamed .xaml file, the previously modified version must also be checked in.

Delete

Deletes the selected item only from your local machine. The latest checked in version of the file is still available in the TFS/SVN repository.

Finish Editing

Checks in the project.json file in the respository, together with changes and a commit message.

Add

Uploads the selected item to the TFS/SVN server. This option is not available, if the item was previously uploaded to the server.

Get Latest Version

Downloads the latest version of the selected item from the TFS/SVN repository.

Check Out Latest For Edit

Marks the selected file or folder as locked for editing. Checking out a file locks it on the server so that no one else can edit it.

Check In

Displays the Check In Changes window and enables you to upload the selected item to the server as the newest version. The .xaml file must be saved before uploading it. After it’s checked in, the file becomes read-only in Studio.

Undo

Displays the Undo Pending Changes window and enables you to Revert the changes done to the project, either revert modified files to previous or unversioned states, or retrieve files which were deleted from the local machine.

Changes cannot be reverted after the file was checked in.

Run

Runs the selected workflow, even if it's not checked out or added to the repository.

Set as Main

Sets the selected .xaml file as Main in the project. The first created .xaml is set as Main by default.



Connecting your Project to a Source Control System


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.