Package Version Control Menu

The Package Control menu, when invoked from a version controlled package, provides access to all of the version control operations that are performed on packages.

Access:     Right-click on a version controlled package node | Package Control

Use to:

  • Open the dialog for working with baselines
  • Apply version control to a single package or a selected hierarchy of packages
  • Check-in and check-out single packages or a selected hierarchy of packages
  • Update packages to the latest revision from the version control repository
  • Inspect the revision history or properties of the XMI file associated with a package
  • Revert a package to a previous revision
  • Compare the current model content of a package, against the latest revision of the package in version control
  • Import and export hierarchies of packages (model branches) to and from the model, through the version control system
  • Synchronize the status of a package, with the version control system

Reference:

Action

Usage

Shortcut

See also

Configure

Display the Package Control Options dialog for the currently selected package

Use to apply or remove version control for a package (specify version control settings) or to specify a file for use in XMI package control

Ctrl + Alt + P

Package Control Options Dialog

Manage Baselines

Create a Baseline of the current package, or compare the current package with a previous Baseline

Ctrl + Alt + B

Create a Baseline

Check In Branch

Check-in packages contained in the currently selected model branch

For the selected branch of the model, (that is, the selected package and all of its child packages) display the Select Packages to Check In dialog, listing all version controlled packages within that branch that are checked out to you; you can then select packages in the displayed list, to be submitted for check-in

You can also choose to keep the packages checked-out after committing a new revision to version control

 

Check In a Model Branch

Check Out Branch

Recursively check out all packages contained within the currently selected model branch, that are version controlled and checked-in (that is, the selected package and all of its child packages)

 

Check Out a Model Branch

Check In

Commit a new revision of the currently selected package to the version control repository and lock the package against further editing

Only available for packages that are checked-out by the current user

 

Check In a Package

Check Out

Synchronize the currently selected package with the latest revision from the version control repository and unlock the package to allow editing

Only available for packages that are not already checked-out (and whose associated package file is not checked-out)

 

Check Out a Package

Undo Check Out

Restore the selected package to the latest revision in the version control repository and lock the package against further editing

 

Undo Check Out of a Package

Put Latest

Commit a new revision of the currently selected package to the version control system, while keeping the package checked-out

This is equivalent to checking a package in and immediately checking it back out again

Only available for packages that are checked-out by the current user

 

 

Get Latest

Synchronize the currently selected package with the latest revision from the version control repository

Available only for packages that are checked in

 

Update Selected Package

Get All Latest

Update all of the version controlled packages in the project, to the latest revision retrieved from version control

Only updates packages that are currently checked in

Once the latest revisions are retrieved, Enterprise Architect scans all the controlled packages and fixes any missing cross-references by comparing the package with its XMI 1.1 file

If the cross-reference information in the XMI does not match the model, Enterprise Architect updates the model with the information from the XMI and records this update in the Output window

You can roll back such updates by selecting the entry in the Output Window and using the context menu option Rollback Update (or Rollback Selected Updates if multiple entries are selected)

  • Closing the model clears the entries in the Output window
  • An entry in the Output window is also cleared as and when you roll-back the update for it

 

Update All Packages

Output Windows

Scan XMI and Reconcile Model

Scan the package XMI files associated with each of the project's controlled packages and restore any diagram objects or cross-references that are detected as missing from the project

This function is useful in team environments where each user maintains their own private copy of the model database (i.e. multiple private EAP files) and model updates are propagated through the use of controlled packages; it provides no benefit when the model is hosted in a single shared database that is accessed by all team members

Each controlled package is compared with its associated XMI file and, if the cross-reference information in the model does not match the XMI, Enterprise Architect updates the model with the information from the XMI and records the update in the Output window

You can roll back such updates by right-clicking on the entry in the Output window and selecting the context menu option Rollback Update (or Rollback Selected Updates if multiple entries are selected)

Closing the model clears the entries in the Output window; an entry in the Output window is also cleared as and when you roll-back the update for it

This functionality is invoked automatically as part of the Get All Latest operation

When working in an environment that uses a Private Model deployment and your model contains a significant number of cross-package references, it is recommended that you invoke Scan XMI  and Reconcile Model from time to time, following the re-importation of controlled packages - for example, after using Get Latest to update a number of packages - or after performing a number of package check-outs

  • As a general rule, avoid running Scan XMI  and Reconcile Model while you have uncommitted changes in your model
  • Generally, you should:
  • Check-out a number of packages
  • Invoke Scan XMI  and Reconcile Model
  • Make your modifications
  • Commit any outstanding changes before you check-out more packages and run Scan XMI  and Reconcile Model again

 

Version Control Best Practices  white paper
http://sparxsystems.com/WhitePapers/Version_Control.pdf

File Properties

Display version control properties pertaining to the XMI export file associated with the currently selected package; this also identifies who has checked out the package

 

 

File History

Display change history information for the currently selected package

Revert to or check-out a prior revision of the package

 

Review Package History

Compare with controlled version

Compare the currently selected package with the latest revision of its associated XMI file retrieved from version control

 

 

Add Branch to Version Control

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 Model Branches

Export as Model Branch

Export a newly created model branch from your own private copy of a model

 

Exporting VC branches

Import a Model Branch

Retrieve a model branch and import it into either the source model or another model

 

Importing VC branches

Get Package

Access packages in the version control repository that are not currently available in your model

 

Including Other User's Packages

Re-synch Status With VC Provider

Update the version control status value recorded for the selected package in the Enterprise Architect project to match the value reported by the version control provider, without performing an XMI import or export

Use this function when the package's version control status recorded in your Enterprise Architect project is out of synchrony with the version control status reported by your version control provider

 

Match the value reported by the version control provider

Version Control Settings

Display the Version Control Settings dialog

 

Version Control Settings dialog

Update Package Status

Provide a bulk update on the status of a package, including status options such as Proposed, Validate and Mandatory

This command is not specific to version controlled packages

 

 

Notes:

  • If the selected package is not under version control, this menu displays a number of different options

Learn More: