Connect an Enterprise Architect Model to Version Control using TFS

Having set up TFS and created or otherwise opened your model, you can configure the model for version control under TFS.

To configure the model for version control, follow the steps below:

  1. Open or create the Enterprise Architect model to place under version control.
  2. Select the Project | Version Control | Version Control Settings menu option. The Version Control Settings dialog displays.
  3. Click on the New button, in the Unique ID field enter a suitable name, then select the TFS radio button.
  4. Click on the Select Path... button to the right of the Working Copy path field, and select the local folder in which to keep local working copies of the XML files to be stored in the Version Control repository.


Enterprise Architect queries TFS to retrieve the Server and Workspace names associated with this folder, when attempting to save the configuration data.

  1. In the User Name and Password fields, type values that enable access to the TFS workspace associated with the Working Copy path specified above.


Users who automatically log in to TFS through means external to Enterprise Architect (for example, through MS Integrated Security) can leave the User Name and Password fields blank. If the Password field is blank, Enterprise Architect retrieves the current user's Windows username and uses that value when determining whether a package is checked out to them or to some other user.

  1. The TFS Exe Path field displays the default installation path; for example:
           C:\Program Files\Microsoft Visual Studio 8\Common7\IDE\tf.exe.
    Click on the Select Path... button if it is necessary to modify this field.
  2. Click on the Save button to save the configuration you have defined.
  3. The new configuration is added to the list in the Defined Configurations panel.


A new entry is also created in the Local Paths list, with the same ID as the new version control configuration. The Local Path entry records the Local Project path, for use in subsequent path substitutions.

  1. When you have finished defining your version control configurations, click on the Close button.

Additional Information on the Dialog Fields


Use to

This model is private

Specify whether all users connect to a single shared copy of the model (such as a DBMS) or each user connects to their own private copy of the model.

When unselected (for shared models), the option disables the File History - Retrieve functionality when the selected package is checked out by another user. This prevents modifications that might have been made by the other user from being discarded through importing a prior revision from version control.

Save nested version controlled packages to stubs only

Set nested version controlled packages to stubs or fully expanded trees. Defaults to selected.

For a full explanation of this option, see Use Nested Version Control Packages.

Unique ID

Specify a configuration name that readily distinguishes it from other configurations.

The Unique ID is added to the list of Version Control configurations a package can connect to. In addition it is possible to select a previous version control configuration from this drop-down menu providing the configuration is not in the current model.

Working Copy Path

Specify the folder where the XML files representing the packages are stored. This folder should already exist before it is specified.

Every PC using TFS version control should have its own TFS Local Folder in which to store working copies of the XMI package files - this should not be a shared network folder. Particularly bear this in mind if you are creating a .EAP file which is to be shared (for example, a SQL database).

Server Name

Specify the name of the Team Foundation Server to connect to.

Workspace Name

Specify the name of a pre-defined TFS workspace that you are using.

User Name

Specify the user name that you use to connect to the Team Foundation Server. The user name that you specify should give you read/write permissions in the specified workspace.


Specify the password associated with the user name you specify. Enterprise Architect stores this password, in encrypted form, as part of the version control configuration data.

TFS Exe Path

Browse to and select the full path name of the TFS command line client's executable file.


  • Sparx Systems strongly urge you not to manipulate version controlled package files outside of Enterprise Architect. It is possible to leave the package files in a state that Enterprise Architect cannot recognize.
  • Visual Studio Integration (MDG Integration for Visual Studio 2005 or 2008) enhances TFS support by providing access to, for example, work items and bugs within both Enterprise Architect and the MDG Integration product.