Check Out

The Check Out dialog box allows you to check out a file from the Vault repository. Checking out a file marks your intention to edit it and ensures it has write permission locally. Proceeding with a Check Out retrieves the latest version of the file. For more information, please see the section for checking out Files or Folders.

The Check Out dialog box can be opened:

•      From the Source menu, select Check Out

•      Right-click on selected folder to bring up the Folder Tree Context Menu, select Check Out

•      Right-click on file to bring up the File List Context Menu, select Check Out

•      Select Check Out on the Toolbar

•      Ctrl+O

You must have a working folder defined to check out a file. If a working folder is not set for the selected file or folder, the Set Working Folder dialog box will appear first. Select a working folder and continue with the Check Out command. Click Cancel on the Set Working Folder dialog box to abort the operation.

File Options

Set File Time

The Set file time list allows you to select the timestamp to give the local file after it is retrieved from the repository. Select one of the following options.

•      Current – the current client time the file is download from the server.

•      Modification – the time the file was last modified on the client before it was checked in. This time depends on the clock of the client machine where it was checked in.

•      Check In – the server time the file was checked in on the server.

Modified Local Copy

This option tells Vault how to handle files that have been modified locally since they were retrieved or exist but have a status of Unknown. This option doesn’t apply to local files that are known versions in the repository. Select one of the following options:

•      Overwrite Working Copy – This overwrites the local file. If the file has a status of Unknown, it will be backed up in the _sgbak directory before being overwritten

•      Do Not Overwrite/Merge Later – This will not overwrite an existing file if it has been changed locally. Vault will still download a new repository version into the hidden state folder if one exists, allowing you to manually merge the file later (in which case the file’s status becomes Needs Merge).

•      Attempt Automatic Merge – Vault will attempt to merge the changes from the server copy into the working copy. If it can do so without irresolvable conflicts, then it will do so. All three files will be archived so you can examine precisely what was done in the automatic merge step. However, if the file cannot be merged automatically, the behavior is identical to that of the Do Not Overwrite setting above. The working copy is untouched, and you must resolve the conflict later before Check In is allowed. A message is written in red in the Messages pane for each file that could not be merged.

The default for this option is Attempt Automatic Merge.

Request Exclusive Lock

The Request Exclusive Lock checkbox is checked or unchecked as per your setting in the General Options dialog.

An exclusive lock on a file means that no one else can check the file in or out while the current user has it checked out.

This option is disabled and checked for non-mergeable files which must be checked out exclusively since they cannot be merged.

Recursive

Check the Recursive checkbox to check out all files and subfolders of the selected folder.

Only Show this Dialog When the Shift Key is Down

If you select this option, the dialog box will be disabled and will not appear unless the shift-key is being held down. The default selections will apply to any item checked out. See Command Dialogs Options to change the default selections.

Comment

Enter a comment in the Comment box. This comment will be the default check in comment for the file that was checked out (or all files if this was a recursive operation). This is optional.

OK

Click OK to check out the selected items and close the Check Out dialog box.

Cancel

Click Cancel to close the Check Out dialog box. Nothing will be checked out.