Please note : This help page is not for the latest version of Enterprise Architect. The latest help can be found here.

Use Version Control

Once your version control product is installed and a suitable environment has been created, Enterprise Architect can then utilize that environment to control your project's packages.

The following topics describe use of the version control features of Enterprise Architect, accessed through the Package Version Control Menu.

Guide:

Topic

Detail

See also

Version Control Settings

Version Control Configurations are used by Enterprise Architect to communicate with your version control system.

You must define a Version Control Configuration in your project and then use that configuration to control the packages in your project.

Version Control Setup

Configure a Package

To put a package under version control, you must mark the package as a controlled package, specify the version control configuration to control it and associate an XMI file with the package.

Configure Controlled Package

Check In a Model Branch

The Check In a Model Branch command allows you to check-in all packages involved in a particular unit of work, as a single operation.

Check In a Model Branch

Check Out a Model Branch

The Check Out a Model Branch command allows you to check-out all packages within a selected model branch, as a single operation.

Check Out a Model Branch

Check In a Package

The Check In command allows you to check-in the package currently selected in the Project Browser.

Check In a Package

Check Out a Package

To work on a version controlled package you must have the package checked out.

The Check Out command allows you to check-out the package currently selected in the Project Browser.

Check Out a Package

Undo Check Out of a Package

The Undo Check Out command allows you to undo the check-out of a package, discarding any modifications that have been made by restoring the package content to the latest revision held in version control.

Undo Check Out of a Package

Import a Package From Version Control

You can retrieve packages from version control that have been created by other users, or by you in another model, and import them into your current model.

Include Other Users Packages

Apply Version Control to a Model Branch

Enterprise Architect enables you to apply version control to all packages within a selected model branch, in a single operation.  In this context, a model branch is a package that is currently selected in the Project Browser, and all of the packages contained within it.

Apply Version Control to Branches

Export a Version Controlled Model Branch

The Export a Model Branch command exports version control information about the root package of a model branch, that is used to simplify the process of exporting and importing a hierarchy of packages from one model to another.

Export Controlled Model Branch

Import a Model Branch From Version Control

Model branch files can simplify the process of exporting and importing a hierarchy of packages from one model to another.

The Import a Model Branch command uses Enterprise Architect's Model Branch Files, of which there are few, to retrieve information about the root package file and import the model branch.

Import Controlled Model Branch

View Package Revision History

The File History command allows you to review the change history of version controlled packages.

It also enables you to check out a prior revision of the package for editing, effectively allowing you to roll-back to a prior revision of the package.

Review Package History

Validate Package Configurations

You can test the validity of the version control settings associated with each version controlled package within your current model.

Validate Package Configurations

Resynchronize the Status of Version Controlled Packages

Enterprise Architect enables you to re-synchronize the version control status of version controlled packages within your project with the status reported by your version control provider.

Resynchronize Package Status

Notes:

  • Database replication should not be combined with version controlled packages
  • If the packages under version control contain any alternative images and those images are subject to frequent change, you can set the Export alternate images option on the Options dialog to export the images to the version control repository when you check in the packages. If the images are not subject to frequent change, do not select this option and instead use Export / Import Reference Data to manage alternative images