Prev Next

Controlled Package Menu

If you are working on a Package that is not itself under version control (but that might contain child Packages that are under version control), you select your Package control options from the 'Controlled Package' menu.  

(For a Package that is directly under version control, you use the 'Package Version Control' menu.)

Access

Context Menu

Project Browser > Right-click on Package > Package Control

Package Control Options

Option

Action

See also

Lock Package

Select this option to apply a lock on the selected Package.  

(This option is only displayed when user security is enabled in User/Group locking mode)

Lock Package

Apply/Release User Lock

Select this option to apply or release a user lock on the selected Package.  

(This option is only displayed when user security is enabled in 'Require User Lock to Edit' locking mode)

Apply a User Lock

Configure (various settings for the Package)

Select this option to display the 'Package Control Options' dialog, and specify whether this Package (and its child Packages) is controlled and the file it is controlled through.

Shortcut: Ctrl+Alt+P

Configure Packages

Package Baselines  

Select this option to create a Baseline of the current Package, or compare the current Package with a previous Baseline.

Shortcut: Ctrl+Alt+B

Managing Baselines

Check In Branch

Select this option for the selected branch of the model (that is, the selected Package and all of its child Packages), to 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.

Check in a Model Branch

Check Out Branch

Select this option for the selected Package, to check out the Package and recursively check out all of its contained sub-Packages.

The system retrieves the latest version of the Packages from the central repository, overwriting the current Packages.

After check out, the Packages are available for editing.

Check Out a Model Branch

Save Package to File  

Select this option to save a Controlled Package to an XMI file.

Shortcut: Ctrl+Alt+S

Save a Package

Load Package from File

Select this option to load a previously-saved XMI file.

Shortcut: Ctrl+Alt+L

Load a Package

View Package XMI  

Select this option to display the Package XMI after the Package has been exported to XMI.

Shortcut: Ctrl+Alt+X

Compare Package with XMI file

Select this option to compare the current Package with a previously-saved XMI file of the Package.

The Compare Utility (Diff)

Set Visibility Level

This menu item is only available in a model that has been set up for Visibility Levels, and when it is being accessed via a Pro Cloud server connection. It is primarily used by System Administrators to manage user access to Packages within the model.

You use this option to set a Visibility Level on a Package, which applies to the Package and its child structures. The Visibility Level has a matching user access level set in user security. A user with a given access level can only see, access and update Packages with the equivalent Visibility level or lower.

Select from the list of values, which start at 0 (no restriction on access) and can go up to 5 (for Packages requiring high security of access). You will only be able to set Visibility Levels at or below the access level to which you have been assigned.

To remove a visibility level from a Package (and all its children), simply set the Visibility Level back to zero. Any user can then view and update the Package (within the limitations of any user security controls on their access to functions).

Add Branch to Version Control

Select this option to apply version control to all Packages within the selected model branch, in a single operation.

Apply Version Control to Branches

Export as Model Branch

Select this option to export a newly created model branch from your own private copy of a model.

Export Controlled Model Branch

Import a Model Branch

Select this option to retrieve a model branch and import it into either the source model or another model.

Import Controlled Model Branch

Get Package (for version control)

Select this option to gain access from Packages in the version-controlled repository that is currently available in your model.

Version Control

Get All Latest (for version control)

Select this option to retrieve the latest version of the Package from the repository. The option is available only for Packages that are checked in.

The alternative option 'Get Latest' - if displayed - is not intended for sharing project files and should only be used when users have their own individual databases.

Version Control

Scan XMI and Reconcile Model

Select this option to 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 (that is, multiple private project 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 System Output window.

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

Closing the model clears the entries in the System Output window; an entry in the 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.

Note: As a general rule, avoid running 'Scan XMI and Reconcile Model' while you have uncommitted changes in your model. Generally, you:

  1. Check-out a number of Packages.
  2. Invoke 'Scan XMI and Reconcile Model'.
  3. Make your modifications.
  4. Commit any outstanding changes before you check-out more Packages and run 'Scan XMI and Reconcile Model' again.
http://sparxsystems.com/WhitePapers/Version_Control.pdf

Re-synch Status With VC Provider

(Version controlled Package.)

Select this option to 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.

Version Control Settings

Select this option to display the 'Version Control Settings' dialog.

Version Control Settings

Learn more