CVS with Local Repositories

Before you can set up Enterprise Architect, you must have a working directory that points to a local repository; that is, one that is installed on your local machine. See your version control software help files for more information.

To set up CVS version control follow the steps below:

  1. Launch Enterprise Architect and open or create the Enterprise Architect model for which packages are to be placed 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.
  4. In the Unique ID field, type a suitable name for the configuration.
  5. Against the Type field, click on the CVS radio button.
  6. Click on the Select Path... button to the right of the Working Copy path field and browse for and select the local folder in which to keep local working copies of the XML files to be stored in the Version Control repository.
  7. If necessary, click on the Select Path... button to the right of the CVS Exe Path field and browse to the file path for the file cvs.exe, the CVS executable.
  8. Click on the Save button to save the configuration you have defined.
  9. 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.

For further information on the fields in the Version Control Settings dialog, see the following table.


Use to

This model is Private

Specify whether all users connect to a single shared copy of the model (e.g. 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 Version Control Nested Packages.

Unique ID

Specify a name that readily distinguishes the configuration from other configurations. The Unique ID is displayed as a selection in the list of Version Control configurations a package can connect to. In addition it is possible to select a previous version control configuration from the drop-down menu providing the configuration is not in use in the current model.

Working Copy path

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

Every version control configuration you define in Enterprise Architect, should have its own local Working Copy 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 an Enterprise Architect project that is to be shared (for example, a SQL database).

Current User

The CVS user name associated with all CVS commands that are issued. This name is used by Enterprise Architect, to determine who has a package 'checked-out'.


The full path name of the CVS 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.