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

Check In and Check Out Packages

To work on a version controlled package you must have the package checked out. When a package is checked out to a specific user, a write lock is set on the package and other users cannot make changes to it until it has been checked in again.

Note:

In the Corporate, Business and Software Engineering, System Engineering and Ultimate editions of Enterprise Architect, if security is enabled you must have Use Version Control permission to check files in and out using version control.

Check In/Check Out

  1. In the Project Browser, right-click on the package icon.
  2. Select the Package Control | Check In, Check Out or Undo Checkout context menu options, as appropriate.
  3. If required, enter a comment when prompted to do so.

If you are working in a private model and you select the Check Out menu option, the Import Package dialog displays (in shared models, this dialog only has default values and therefore does not display).

ImportPackage

Option

Use to

Force reload from XMI

Reload the package content from the XMI file in the central repository, even though the package and XMI file are synchronized. This ensures that links and dependencies that might not have been refreshed are updated as well.

Accept current package

(The default.) Leave the package content in its current state.

Refresh model view

Refresh the model view to show any changes from other checked out packages.

Always apply above settings

Apply the settings in the above three fields every time you check out a package that is found to be up to date, and therefore do not display this dialog again.

Note:

To display the dialog if, for example, you want to change the settings, press [Ctrl] while you select the Package Control | Check Out menu option.

The package icon in the Project Browser should change. When you check out a package this is represented by a figure 8 to the left of the package icon. When you check in a package the package icon is overlaid with a colored rectangle and key. In the example below, the upper package is checked out whilst the lower package is checked in.

CheckInOut

Notes:
  • If you check out a version controlled package whilst offline, the package icon has a red figure 8 in front of it. See Offline Version Control.
  • 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.

Check In Branch

  1. In the Project Browser, right-click on the package icon at the root of the model branch that is to be checked in and select the Package Control | Check In Branch context menu option. The Select Packages to Check-in dialog displays, listing all version controlled packages within the branch that you have checked out.
     
    CheckInBranchDlg
     
  2. Click on the package to check in, or use:
  • [Ctrl]+click to add or remove several individual packages
  • [Shift]+click to select a range of packages
  • All to select all packages listed
  • None to clear all selected packages.
  1. Click on the OK button to check-in the selected packages.
  2. If required, enter a comment when prompted to do so. (This comment applies to all packages that you have checked in.)
  3. Each package icon changes to indicate that the packages have been checked-in.

Check Out Branch

  1. In the Project Browser, right-click on the name of the root package of the model branch to be checked out and select the Package Control | Check Out Branch context menu option. The selected package and all of its contained sub-packages are recursively checked out.
  2. Any packages that cannot be checked-out are listed in a message box, with a brief description of the problem. For example: The package is already checked out by user 'Fred'.
  3. When Project Security is enabled in Lock to Edit mode, Enterprise Architect prompts you to apply a User Lock throughout the selected model branch before proceeding.