Package Version Control Options

When you have set up a package for version control, you gain access to a range of version control operations that can be performed on that package, such as:

Open the dialog for working with baselines of the package
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
 

Access     Project Browser | right-click version-controlled package | Package Control

Options

Option

Action

Shortcut

See also

Configure

Apply or remove version control for the selected package (specify version control settings) or specify a file for use in XMI package control.

 

Ctrl+Alt+P

Configure Controlled Package

Package Baselines

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

 

Ctrl+Alt+B

Manage Baselines

Check In Branch

Check-in packages contained in the currently selected model branch (that is, the selected package and all of its child packages).

The Select Packages to Check In dialog lists 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 is, the selected package and all of its child packages) that are version controlled and checked-in.

 

 

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 you have checked-out yourself.

 

 

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 you have checked-out yourself.

 

 

 

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 to the Latest Revision of 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, the system 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, the system 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 to the Latest Revision of All Packages

The System Output Window

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, the system 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  Branches

Export as Model Branch

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

 

 

Export Controlled Model Branch

Import a Model Branch

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

 

 

Importing Controlled Model Branch

Get Package

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

 

 

Include Other Users' Packages

Re-synch Status With VC Provider

Update the version control status value recorded for the selected package in the 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 project is out of synchrony with the version control status reported by your version control provider.

 

 

Resynchronize the Status of Version Controlled Packages

Version Control Settings

Display the Version Control Settings dialog.

 

Version Control Settings

 

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.

 

 

Update Package Status

Notes

You set up Version Control using options from the project Version Control submenu
If the selected package is not under version control, a different set of options is available
If a version control configuration has not been defined for the model, no options for using version control are available, only the options for configuring version control

Learn more