Applying Version Control in a Team Environment

The process of setting up a version control environment and applying version control to a project to be accessed by a number of users is summarized here.

Version Control - Process Overview



See also


Install your version control product.

Version Control Product Setup


Create a version control repository.


Create a version control project to be used with your Enterprise Architect project.


Check-out a working copy of the version control project (a module, project or folder within the version control system) into a local folder.

You must do this for every team member that is accessing the version controlled Packages, whether you are using a single shared model or each team member stores his own private copy of the model.

Create a Local Working Copy Prepare a CVS Local Workspace


Within Enterprise Architect, define a version control configuration to provide access to the working copy files.

The name of the version control configuration must be the same across all machines throughout a team. That is, all version control access to a given Package must be through version control configurations with the same name, across all models and all users.

The easiest way to perform this step, (throughout the team), is to have one user set up version control on the model and then share that model with the rest of the team.

  • In Shared Model deployment, all users connect to a single instance of the model database, so the model is shared automatically
  • In Private Model deployment, it is easiest to distribute copies of the original model (after version control has been set up) to all other members of the team

Whenever you open a model (Private or Shared) that uses a version control configuration that is not yet defined on your workstation, a prompt displays to complete the definition for that configuration. This typically means specifying the local working copy directory and maybe choosing the version control project associated with this Enterprise Architect project.

Once this has been done, the version controlled Packages that already exist in the model are ready for use.

Version Control Setup


Configure Packages within the Enterprise Architect model for version control. That is, apply version control to individual Packages.

Configure Controlled Package


Check-out and check-in Packages as required.

Check In a Package Check Out a Package


  • It is possible to use multiple version control configurations within the same model; different Packages can still use different version control configurations within the model, as long as any given Package is always accessed via the same version control configuration

Learn more

Team deployment and the use of version control is discussed in two Sparx Systems white papers, available as on-line resources on the Sparx Systems web site: