Menus

Main Window

The following menus and menu items appear in Vault Professional’s Main Window.

File

Connect to Server

The Connect to Server command allows you to connect to the Vault Professional server. This command is also available on the Toolbar and will display when Vault Professional is started. You can choose to automatically connect on startup with a profile.

Disconnect from Server

The Disconnect from Server command allows you to disconnect from the current server.

Choose Repository

The Choose Repository command allows you to select the repository from the connected server. You can choose to automatically open a repository when connecting to Vault Professional by using a profile.

Add Files/Folders

The Add Files/Folders command allows you to add new files or folders to the open repository by selecting files or folders accessible on the local machine. The Add Files command can also be found on the Toolbar.

Detect New Files to Add

The Detect New Files command allows you to see which files exist in your local working folder that do not exist in Vault Professional, therefore allowing you to easily add newly created files to the repository.

Create Folder

The Create Folder command allows you to create a new empty folder within the open repository. The Create Folder command can also be found on the Toolbar.

Delete

The Delete command allows you to delete files or folders from the repository. The Delete command can also be found on the Toolbar.

Note

The Delete command is non-destructive. The items still exists in the history of the repository and can be recovered by clicking the Undelete command found in the Folder Properties.

Rename

The Rename command allows the names of the selected files or folders to be changed.

Move

The Move command allows you to move the selected files or folders from one folder to another.

Properties

The Properties command allows you to view and modify the properties of the selected file (File Properties) or folder (Folder Properties).

Set Working Folder

The Set Working Folder command allows you to set a directory on the client machine to store files retrieved from the server. The Set Working Folder command can also be found on the Toolbar.

A working folder must be set in order to Get Latest, Check Out or Edit.

Explore Working Folder

The Explore Working Folder command allows you to open a Windows Explorer window on the corresponding working folder. If there is no working folder set or the working folder does not exist, the command will not be available.

Exit

The Exit command closes the Vault Professional client application.

Edit

View File

The View File command allows you to view the repository’s latest version of a selected file without checking out or replacing the local copy of the file. The View File command can also be found on the Toolbar.

Edit File

The Edit File command allows you to check out and edit a selected file in a single operation. The Edit File command can also be found on the Toolbar.

Select All

The Select All command allows you to select all of the files in the file list.

Invert Selection

The Invert Selection command allows you to invert the already selected files. For each file in the file list, if it is selected, it will be unselected and, if it is unselected, it will be selected.

View

Refresh

The Refresh command refreshes the file list and folder tree by retrieving the latest information from the server. This command is merely used to update the display of status information, it does not modify the working folders in any way.

See Automatic Refresh in General Options to set the refresh option.

Show Differences

The Show Differences command opens the Diff dialog box to examine the differences between versions of a file. The Diff command can also be found on the Toolbar.

Show Blame

The Show Blame command opens Blame in the Vault Web Client. Blame is a line by line file history which shows the last user to modify any given line in a file.

Show Labels

The Show Labels command opens the Show Labels dialog to examine labels that have been applied to the currently selected file or folder, or labels that have been created recursively below that file or folder.

Show History

The Show History command opens the History Explorer to examine past versions to a tree or repository. The History command can also be found on the Toolbar.

History Favorites->Edit Favorites

The History Favorites->Edit Favorites command opens the Edit History Favorites dialog that allows you to manage saved queries.

History Favorites->(Saved Query)

The History Favorites->(Saved Query) command invokes a specific named query and displays it in the History Explorer dialog.

Show Line History

The Show Line History command opens the Show Line History wizard to search through the history of a file to find all modifications to a line, or a group of lines.

View Shelved Changes

The View Shelved Changes command opens the View Shelved Changes to list the shelvesets that have been uploaded to the Vault Professional server.

Dockable Panels

The panel commands at the bottom of the View menu provide options for displaying dockable panels in the Vault Professional GUI Client. Click the panel command in the View menu to open the panel. Click the X in the upper corner of the panel to close the panel. To move a panel, click on the title bar and move to one of the docking points which appears in the client.

Repository Explorer

The Repository Explorercommand opens a panel that contains the Folder Tree and File List for the current repository. By default, the panel is always displayed.

Browse Work Items

The Browse Work Items command opens the Vault ProfessionalItem Tracking Panel to browse and edit work items.

Pending Change Set

The Pending Change Set command opens a panel that contains the Pending Change set for the current repository.

Messages

The Messages command opens a panel that displays status messages from the Vault Professional server.

Search

The Search command opens a panel with file name and file status search options.

Notifications

The Notifications command opens a panel that displays real-time source control and event notifications.

Find in Files

The Find in Files command opens a panel to search file contents within the Vault Professional repository.

Source

Get Latest Version

The Get Latest Version command retrieves a copy of the file from the Vault Professional server and places it in your working folder. If there is no current working directory, the Set Working Folder dialog box is displayed first since a working directory must exist before files are retrieved. The Get Latest Version command can also be found on the Toolbar.

Check Out

The Check Out command allows you to check out the latest version of a file or folder to modify the item. The Check Out command can also be found on the Toolbar.

Check In/Commit

The Check In/Commit command allows you to commit changes made to local files back into the repository. The Check In command can also be found on the Toolbar.

Undo Check Out

The Undo Check Out command allows you to undo a checkout and not modify contents of the file in the repository or change the version number. The Undo Check Out command can also be found on the Toolbar.

Show Merge

The Show Merge command allows you to resolve merges for files of status Needs Merge and also to examine how Vault Professional automatically resolved the conflicts between two files.

Resolve Merge Status

The Resolve Merge Status command resets the status of a file from Needs Merge to Edited Status, which allows you to check in the file.   Vault Professional will only prompt to Resolve Merge Status if you are using SourceGear’s DiffMerge tool.

Note: The best practice is to first view the Show Merge results, as there may be file conflicts that must be manually resolved. If there are unresolved merge conflicts, Resolve Merge Status will revert any conflicting changes back to the lines in the common ancestor of the two files being merged. This may cause modifications to be lost.

Label

The Label command allows you to tag a version of a file or folder with a text string. The Label command can also be found on the Toolbar.

Share

The Share command allows you to make files or folders appear in two distinct places in the repository. The Share command can also be found on the Toolbar.

Branch

The Branch command allows you to either Share Branch or Copy Branch. A Share Branch allows you to break a link for a shared file; creating a separate file at the location it was shared. A Copy Branch allows you to branch any file or folder, whether it is shared or not. The Branch command can also be found on the Toolbar.

Snapshot

The Snapshot command allows you apply snapshots to a folder. This command has been deprecated in favor of Branch or Label.

Pin/Unpin

The Pin command allows you to pin a file or pin a folder to its current version, disallowing any changes to the file or folder until it is unpinned.

Cloak/Uncloak

The Cloak command allows you to specify that a folder should be ignored during recursive operations. For example, Get Latest Version operation will not get files from a cloaked folder unless the cloaked folder is specifically selected.

Tools

Find In Files

The Find in Files command allows you search for files containing a given text string.

Merge Branches

The Merge Branches command allows you to merge changes from any folder to any other folder.

Options

The Options command allows you to set global options by opening the Options dialog box.

Change Password

The Change Password option allows you to change passwords.

Abort Current Operation

The Abort command cancels any current server operation. It is only available during attempts to contact the Vault Professional server. The Abort command can also be found on the Toolbar.

Help

Contents

The Contents command will bring up the Help files. The Contents command can also be found on the Toolbar.

Search

The Search command will bring up the Search page for the Help files.

Technical Support

The Technical Support command will provide you with support contact information and links to the FAQ lists. It will also list your system and version information that will be relevant for tech support issues.

About Vault Professional

The About SourceGear Vault Professional dialog will show you the version number and the current locale.

Folder Tree Context Menu

Create Folder

The Create Folder command is used to create a new empty folder within the open repository. The Create Folder command can also be found on the Toolbar..

Add Files/Folders

The Add Files/Folders command allows you to add new files or folders to the open repository by selecting files or folders accessible on the local machine. The Add Files command can also be found on the Toolbar.

Detect New Files to Add

The Detect New Files command allows you to see which files exist in your local working folder that do not exist in Vault Professional, therefore allowing you to easily add newly created files to the repository.

Set Working Folder

The Set Working Folder command allows you to set a folder on the client machine in which to retrieve repository files. The Set Working Folder command can also be found on the Toolbar.

A working folder must be set in order to Get Latest, Check Out or Edit.

Explore Working Folder

The Explore Working Folder command allows you to open a Windows Explorer window on the corresponding working folder. If there is no working folder set or the working folder does not exist, the command will not be available.

Get Latest Version

The Get Latest Version command allows you to retrieve all the latest files within the folder from the Vault Professional server and place them in the working folder. If there is no current working folder, the Set Working Folder dialog box is displayed first since a working directory must exist before files are retrieved. The Get Latest Version command can also be found on the Toolbar.

Check Out

The Check Out command allows you to check out the latest version of a files in the selected folder. You can then modify the files. The Check Out command can also be found on the Toolbar.

Check In/Commit

The Check In/Commit command allows you commit changes made to local files found in the selected folder or one of its sub-folders back into the repository. The Check In command can also be found on the Toolbar.

Undo Check Out

The Undo Check Out command allows you to undo the check out and not modify the contents of the file found in the selected folder or its subfolders in the repository or change the version number. The Undo Check Out command can also be found on the Toolbar.

Show Differences

The Show Differences command opens the Diff dialog box to examine the differences between versions of a folder. The Show Differences command can also be found on the Toolbar.

Show History

The Show History command opens the History Explorer to examine past versions to a tree or repository. The Show History command can also be found on the Toolbar.

History Favorites->Edit Favorites

The History Favorites->Edit Favorites command opens the Edit History Favorites dialog that allows you to manage saved queries.

History Favorites->(Saved Query)

The History Favorites->(Saved Query) command invokes a specific named query and displays it in the History Explorer dialog..

Show Labels

The Show Labels command opens the Show Labels dialog to examine labels that have been applied to the currently selected folder, labels that have been created recursively below that folder or labels inherited by that folder.

Share

The Share command allows you to make the selected folder appear in two distinct places in the repository. The Share command can also be found on the Toolbar.

Branch

The Branch command allows you to either Share Branch or Copy Branch. A Share Branch allows you to break a link for a shared item; creating a separate item at the location it was shared. A Copy Branch allows you to branch any item, whether it is shared or not. The Branch command can also be found on the Toolbar.

Label

The Label command allows you to tag a version of a file or folder with a text string. The Label command can also be found on the Toolbar.

Pin/Unpin

The Pin command allows you pin a folder to its current version, disallowing any changes to the folder until it is unpinned.

Cloak/Uncloak

The Cloak command allows you to specify that a folder should be ignored during recursive operations. For example, Get Latest Version operation will not get files from a cloaked folder unless the cloaked folder is specifically selected.

Delete

The Delete command allows you to delete the selected folder from the repository. The Delete command can also be found on the Toolbar.

Note

The Delete command is non-destructive. The items still exists in the history of the repository and can be recovered by clicking the Undelete command found in the Folder Properties.

Rename

The Rename command allows the name of the selected folder to be changed. The item will be immediately renamed unless Auto-Commit has been turned off in the Check In Options.

Move

The Move command allows the location of the selected folder to be changed. The item will be immediately moved unless Auto-Commit has been turned off in the Check In Options.

Properties

The Properties command allows you to view and modify the properties of the selected folder (Folder Properties).

File List Context Menu

View File

The View File command allows you to view the latest version of a selected file without checking out or replacing the local copy of the file. The View File command can also be found on the Toolbar.

Edit File

The Edit File command allows you to check out and edit a selected file in a single operation. The Edit File command can also be found on the Toolbar.

Get Latest Version

The Get Latest Version command allows you to retrieve a copy of the file from the Vault Professional server and place it in your working folder. If there is no current working folder, the Set Working Folder dialog box is displayed first since a working directory must exist before files are retrieved. The Get Latest Version command can also be found on the Toolbar.

Check Out

The Check Out command allows you to check out the latest version of the selected file. You can then modify the file or folder. The Check Out command can also be found on the Toolbar.

Check In/Commit

The Check In/Commit command allows you to commit changes made to local files back into the repository. The Check In/Commit command can also be found on the Toolbar.

Undo Check Out

The Undo Check Out command allows you to check in a file and not modify the contents of the file in the repository or change the version number. The Undo Check Out command can also be found on the Toolbar.

Show Differences

The Show Differences command opens the Diff dialog box to examine the differences between versions of a file. The Show Differences command can also be found on the Toolbar.

Show Labels

The Show Labels command opens the Show Labels dialog to examine labels that have been applied to the currently selected file.

Show History

The Show History command opens the History Explorer to examine past versions to a tree or repository. The Show History command can also be found on the Toolbar.

History Favorites->Edit Favorites

The History Favorites->Edit Favorites command opens the Edit History Favorites dialog that allows you to manage saved queries.

History Favorites->(Saved Query)

The History Favorites->(Saved Query) command invokes a specific named query and displays it in the History Explorer dialog..

Show Merge

The Show Merge command allows you to examine how Vault Professional automatically resolved the conflicts between two files, and to manually merge a file if it still needs merged.

Resolve Merge Status

The Resolve Merge Status command resets the status of a file from Needs Merge to Edited, which allows you to check in the file. If there are conflicts between the repository version and the working folder version, the merge will revert to the common ancestor of the lines which are in conflict. Use this command with caution.

Share

The Share command allows you to make files appear in two distinct places in the repository. The Share command can also be found on the Toolbar.

Branch

The Branch command allows you to either Share Branch or Copy Branch. A Share Branch allows you to break a link for a shared file; creating a separate file at the location it was shared. A Copy Branch allows you to branch any file, whether it is shared or not. The Branch command can also be found on the Toolbar.

Label

The Label command allows you to tag a version of a file with a text string. The Label command can also be found on the Toolbar.

Pin/Unpin

The Pin command allows you pin a file to its current version, disallowing any changes to the file until it is unpinned.

Delete

The Delete command allows you to delete the selected files from the repository. If multiple files are selected, they will all be deleted at the same time. The Delete command can also be found on the Toolbar.

Note

The Delete command is non-destructive. The file or folder still exists in the history of the repository and can be recovered by clicking the Undelete command found in the Folder Properties.

Rename

The Rename command allows the names of the selected file(s) to be changed.

Properties

The Properties command allows you to view and modify the properties of the selected file (File Properties).

Pending Change Set Context Menu

Select All

Allows you to select all the entries in the Pending Change Set.

Copy

Copies all the currently selected entries in the Pending Change Set to the clipboard in a text format.

Edit Item Comment

The Edit Item Comment allows you to add or edit the comment associated with this item (not the overall changeset comment).

Commit

The Check In/Commit command allows you to bring up the Check In/Commit dialog box containing the selected items in the pending list and then commit them to the repository.

Undo

The Undo command allows you to check in a file and not modify the contents of the file in the repository or change the version number. The Undo command can also be found on the Toolbar.

Shelve Selected Operations

The Shelve Selected Operations command allows you to create a Shelve Set and store it in the Vault databases without first needing to check in your changes. The Shelve Set can later be unshelved so you can work on it further. The Shelve All command can be found on the Pending Change Set Toolbar.

Show Differences

The Show Differences command opens the Diff dialog box to examine the differences between versions of a file. The Show Differences command can also be found on the Toolbar.

Show Merge

The Show Merge command allows you to examine how Vault Professional automatically resolved the conflicts between two files.

Resolve Merge Status

The Resolve Merge Status command resets the status of a file from Needs Merge to Edited, which allows you to check in the file.

Status Search Context Menu

The Status Search context menu is available on an item by right clicking the mouse over an item. Not all search result items have a context menu and the set of commands in each menu is not the same for each search type. The following tables list each status search type and its context menu commands, if any.

Status

Menu

Old

Get Latest Version, Check Out, Show Differences, Delete, Pin

Missing

Get Latest Version, Check Out, Delete, Pin

Checked out by

Get Latest Version, Check In, Undo Check Out, Show Differences, Delete, Pin

Merged

Get Latest Version, Check In, Undo Check Out, Show Differences, Show Merge, Delete

Edited

Get Latest Version, Check In, Undo Check Out, Show Differences, Delete, Pin

Renegade

Get Latest Version, Check Out, Show Differences, Delete, Pin

Unknown

Get Latest Version, Check Out, Show Differences, Delete

Needs Merged

Get Latest Version, Check Out, Show Differences, Show Merge, Delete

More Recent

Get Latest Version, Check Out, Show Differences, Delete, Unpin

Show Label Menus

The following menus and menu items appear in the Show Labels dialog.

Label

Delete

The Delete command allows you to delete a selected label. You will be prompted to confirm the label deletion. Once confirmed, the label is removed from the repository.

This command is only available on labels that were created at the same file or folder the Show Labels command was invoked on.

Rename

The Rename command allows you to rename a label. The “rename” must maintain label “uniqueness” for all items in the label

This command is only available on labels that were created at the same file or folder the Show Labels command was invoked on.

Promotion

The Promotion command brings up the Label Promotion dialog, which allows you to add or delete files to or from the label, and also allows you to change the version numbers of files associated with the label.

This command is only available on labels that were created at the same file or folder the Show Labels command was invoked on.

Close

Closes the dialog

View

Refresh

The Refresh command allows you to re-query the label to get updated results.

Action

Diff

Invokes the diff command on the item listed in the menu item that is associated with the selected label.

View

Views the item listed in the menu item that is associated with the selected label. For a folder, this invokes a window that allows you to see the tree structure of the folder at the time it was labeled.

Get

Gets the item listed in the menu item that is associated with the selected label.

A working folder is required to Get a label to the local disk. The Get dialog is displayed when getting the item, and you can choose to get the item to a different folder from that dialog.

If the folder the label is retrieved to is a working folder, it will update the state files to reflect the versions of the label, and will honor the Get options that apply to history Gets, for issues like overwriting existing files, timestamps, etc.

Share

Shares the item listed in the menu item that is associated with the selected label at the version associated with label. This works same way as if it were shared from history, in that it shares the item, then pins it to the version it was shared from.

You can only share an item that is part of a label that has not been promoted.

Branch

Branches the item listed in the menu item that is associated with the selected label. This works same way as if it were branched from history at the version associated with the label.

You can only branch an item that is part of a label that has not been promoted.

Pin/Unpin

Pinning / Unpinning an item associated with the selected label will operate as if the main object is pinned or unpinned using the label’s version.

You can only pin or unpin an item that is part of a label that has not been promoted

Edit Comment

Invokes a dialog that allows you to change the text of the comment is associated with the selected label.  You can only edit label comments if you are the creator of the label or the “admin” user.

Label Promotion Menus

The following menus and menu items appear in the Label Promotion dialog.

File

Delete

The Delete command marks the currently selected file or folder to be deleted from the label. Once deleted, the file or folder is not retrieved as part of the label. The deletion actually happens when the Save command is invoked.

This command is not available on the label root.

Add

The Add command allows you to add files or folders to the label. Only files or folders that currently exist at the selected folder in the repository can be added to the label. You can select any folder in the label to add files or folders to. If there are no new files or folders to be added, a dialog will be displayed telling you so.

The add of the files or folder actually happens when the Save command is invoked.

This command is not available when a file is the current selection.

Change Version

The Change Version command allows you to change the version of a file associated with the label. When invoked, a dialog is displayed showing all the versions of the selected file, and you can choose which new version you want to associate with the label.

The version number change actually happens when the Save command is invoked

This command is not available when a file is the current selection.

Save

The Save command saves the label’s edited contents. The changes to be saved are listed in the bottom pane of the window

Close

The Close command will close the Label Promotion window, offering to save any unsaved changes first.

View

Refresh

The Refresh command gets the latest version of the label from the server, and updates the tree view and file list.

History Menus

The following menus and menu items appear in the History Explorer dialog.

View

Refresh

The Refresh command allows you to re-query the server with the same filter/sort criteria, showing you changes in history made since the history window was first invoked.

Act Recursively

The Act Recursively command is a toggle that shows whether the current query is a recursive query, and allows you to change the value, and re-query with the value toggled from how it is currently set.

Action

Diff

The History Diff command allows you to compare a version with a previous version or the working folder. If two versions have been selected, the command retrieves both versions and compares them against each other using the default Diff Program. If only one version is selected, the History Diff dialog will be displayed to allow you to choose which version you want to diff against.

View

If a file is selected, the History View command allows you to retrieve the selected version and display its contents by launching the appropriate editor.

View is not supported for an entire folder.

Get

The History Get command gets the version that corresponds to the current selection. For example, if the current selection is a file check in, it retrieves the version associated with that check in. If the current selection is a folder, it retrieves the files (and their versions) that existed at the time of that folder version. Files are retrieved to their working folders by default.

Details

The Details command allows you to see the details for the entire check in, including the other files included in that file version’s check in, of the selected file by displaying the Version Details dialog box.

Pin

The Pin command allows you to pin the selected item.

Unpin

The Unpin command allows you to unpin the selected item.

Share

History Share works similarly to the regular Share command except that it works on a historical version of a file or folder instead of sharing the most recent version.

In the case of a file, it will share the file to a new location, and then pin it to the version you have selected in the list. For folders, it will share the folder to a new location and pin the folder to the version that was selected.

A History Share will always pin the file or folder being shared even if it is the most recent version. If the file or folder being shared is already shared, it will merely add the new file or folder as another link in the shared file.

Branch

The Branch command allows you to branch on the selected file or folder at the version that is selected. You cannot branch a deleted file or folder.

Note

A branch on a previous version of an item is always a Copy Branch. A branch on the current version follows the normal rules of branch. See Branch Items for more information.

Label

The Label command allows you to label the selected file or folder at the version that is selected. You cannot label a deleted file or folder.

Rollback

The History Rollback command is a non-destructive way to make a previous version the current version. It checks out the file at the version selected and checks in that file as the latest version. A rollback does not break a share.

Rollback is not available when the file is pinned.

Check Out

The History Check Out command is used to check out a file while simultaneously retrieving the selected version. This only allows a single checkout at a time.

Help

Contents

The Contents command will bring up the Help files opened to the History Explorer.

About Vault Professional

The About SourceGear Vault Professional command will show you the version number and the current locale.