Dialog Boxes

Add Files/Folders

The Add Files/Folders dialog box allows you to add new files or folders to the repository by selecting files that are accessible to the local machine.

The Add Files/Folders dialog box can be opened:

  • From the File menu, select Add Files/Folders

  • Right-click on selected folder to bring up the Folder Tree Context Menu, select Add Files/Folders

  • Select Add Files/Folders on the Toolbar

  • Ctrl+N

Tree View of Local File System

The top pane contains a tree control and a file list of the local file system. If a working folder exists at the node this command was invoked on, the tree control will have that working folder selected. Selecting a node in the tree will fill the file list with the files in that local folder.

Checking a folder will automatically check all the folders and files under that folder that meet the exclusion rules, and add that folder to the File/Folder to be Added list. If not all files/folders underneath a folder are checked, the folder’s checkbox will be partially checked.

Checking a partially checked folder will fully check all files and folders under that folder. Checking a fully checked folder will uncheck all files and folders, and remove the entry from the Files/Folder to be Added list.

Files/Folders to be Added

The Files/Folders to be Added is the list of pending folders or files that are to be added from the local directory. Following are the columns in this list.

  • Items – The local path of the file or folder to be added.

  • Properties – For files, the size of the file being added. For folders, the total size, and the number of folders and files included in the folder being added.

  • Repository Path – The path in the repository the items will be added.

Exclude

Click Exclude to display a dialog that allows you to view/edit the list of files and folders to exclude when checking a folder. This list is defined in the Admin Web Client and making changes to it here does not update the default list.

Changing this list does not go back and re-apply the exclusion rules to already checked folders, since it is possible you could have already made changes to the file list that cause it to not follow the exclusion rules. If you want to re-apply the exclusion rules, you need to uncheck the folder, then check it again.

Browse

Click Browse to add additional drives or shared network folders to the Local File System tree view. This allows you to add files from any drive that can be accessed from the local machine. New drives are rooted at the top of the tree view.

Remove

Click Remove to remove the selected files or folders from the pending list. This will update the state of the tree and file list to reflect that the items are not to be added.

Comment

Type a comment in the Comment dialog box. The comment applies to all files being added. If the Auto-Commit is on, they become the changeset comment.

OK

Click OK to add the files and folder to the Pending Change Set window.

If Auto-Commit has not been selected, the files and folders will be added to the repository as part of the next check in transaction. The comment is applied individually to each file.

If Auto-Commit has been selected (default), the files and folders will be added to the Vault Professional repository immediately. The comment will become the changeset comment.

Please see Auto-Commit for more information.

Cancel

Click Cancel to exit the Add Files dialog box without making any changes.

Blame

The Blame window shows the last user to modify any given line in a file. This is useful for determining why a build broke or to just generally assign credit or blame to content changes in a file.

The blame window has the following columns:

  • Line – The line number of the given line.

  • User – The user who made the last change. If the same user made changes for a block of lines, only the first line will display the user’s name and all the remaining lines in that block will be in the same shading to indicate it is the same user (without repeating the user’s name).

  • Version – The version number of the file that the line last changed on. Each version number is linked to a footnote table at the bottom of the page that shows which versions have changed content, which user checked that version in, and what the comment was for that check in.

  • File Contents – The actual line in the file.

Browse Work Items

The Browse Work Items dialog allows you to view/edit Work Itmes and queries.  This item is only enabled for the Vault Professional client.

The Browse Work Items dialog can be accessed from the View->Browse Work Items menu item or from the checkin dialog.  When accessed from the checkin dialog, the Browse Work Items dialog can be used to select Work Items to be updated with the checkin.

The left side of the dialog displays a tree containing all the projects a user has access to.  Under each project there are three nodes:

  • Queries – This node’s children will consist of the My Open and Open queries, which are not editable, and any saved queries the user has created.

  • Recent – This node’s children are the recent queries:  Recent Additions, Recent Updates and Recent Comments.

  • Summaries – This node has only one child query, the At-A-Glance query.

Any query in the tree can be run by either double-clicking or choosing Open from the right-click context menu.  The results will be displayed in a tab on the right side of the dialog.  Saved queries may be opened for editing using the Edit command on the right-click context menu.  The context menu also contains a Delete command (for deleting saved queries) and a Refresh command to refresh the results if the selected query’s results are currently displayed in a tab.

The toolbar has the following icons:

  • Save – Saves any changes to the visible tab.

  • Save All – Saves changes to all open tabs.

  • Refresh – Refreshes the query results, if the visible tab is displaying query results.

  • Query – Opens a blank query editor in a tab.

  • Add Item – Opens a new Work Item in a tab.

  • Item Id or Keyword – Enter an Item Id or a keyword search in the text box to perform a search.  If the Item Id is found, the item will be opened in a tab.  If a keyword search was entered, the results of that query will be opened in a tab.

Useful Hot Keys:

  • If there is a query editor open in the selected tab, use F5 to run the query and open the results in a new tab.

  • Both Ctrl+F4 and Ctrl+w will close the top tab.

Change Password

The Change Password dialog box allows a user to change his password.

The Change Password dialog box can be opened:

  • From the Tools menu, select Change Password

Old Password

Type your current password in the Old Password box.

New Password

Type a new password in the New Password box.

Verify

Type the new password again in the Verify box.

OK

Click OK to save the changes and close the Change Password dialog box.

Cancel

Click Cancel to close the Change Password dialog box without changing the password.

Check In/Commit

The Check In/Commit dialog box allows a user to check in all pending changes to files and folders. For more information, please see the section for checking in Files or Folders.

The Check In/Commit dialog box can be opened:

  1. From the Source menu, select Check In/Commit

  2. Right-click on selected file to bring up the File List Context Menu, select Check In/Commit

  3. Right-click on selected folder in bring up the Folder Tree Context Menu, select Check In/Commit

  4. Select Check In or Commit All on the appropriate Toolbar

  5. Ctrl+I

  6. In the Pending Change Set, click the Commit button or use Ctrl + M

Changes

The Changes box contains a list of all files (added, deleted or modified) that are included in this check in. The following are the columns of the list.

  • Item

  • Type

  • Details

Note

If a file’s status is Needs Merge, it must be merged prior to being committed to the repository, which can be accomplished by invoking the Show Merge command. If the file is already merged, invoke the Resolve Merge Status command to reset the file’s status to Merged.

Check All

Click Check All to select all the items in the list.

Uncheck All

Click Uncheck All to clear all the checkboxes in the list

Keep Checked Out

Check the Keep Checked Out checkbox to perform a check out operation on each file after the check in has completed.

Remove Local Copy

Check the Remove Local Copy checkbox to remove the checked in files from the working folder.

Update Bugs

Update Bugs allows you notify the bug tracking system that files relating to item numbers were checked in.

You can either type in the item ID in the text box or click the Browse button to see a list of bugs that are currently assigned to you, and select one or more from that list.

Type the case number in the Update Bugs box.

Note

The update bugs section of the checkin dialog is only enabled if files in the checkin transaction have a status of added or modified.

When the file is commited, the files that were checked in will be associated with the items in the bug tracking system.

Multiple ID numbers may be entered, separated by a comma or semicolon.

Diff

The Diff button is available when a selected file has been modified. Click on the button to bring up the Diff window to see your changes.

Comment

Type a comment in the Comment box. This will apply to all files checked in with the changeset. This is optional.

OK

Click OK to commit the selected items to the Vault Professional repository and close the Check In/Commit dialog box.

Cancel

Click Cancel to close the Check In/Commit dialog box. No items will be checked in.

Check Out

The Check Out dialog box allows you to check out a file from the Vault Professional 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:

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 menu dialog box will appear first. Select a working folder and continue with the Check Out command. Click Cancel on the Set Working Folder menu 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 Professional 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 Professional 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 MergeVault Professional 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.

Choose Repository

The Choose Repository dialog box allows you to choose a repository from the connected server. For more information, please see Working with Repositories.

The Choose Repository dialog box can be opened:

  1. From the File menu, select Choose Repository

  2. When connecting to a server, the Choose Repository dialog box will automatically appear

  3. Ctrl+P

Available Repositories

The Available Repositories box lists the repositories you have access to in the currently connected Vault Professional server. The repository’s version and number of files and folders are also listed. Access is set by the administrator in the Admin Web Client.

OK

Click OK to choose the selected Vault Professional repository and close the Choose Repository dialog box.

Cancel

Click Cancel to close the Choose Repository dialog box. If a repository is already opened, the current repository remains open. If no repository is open because you have just logged into a new server, the client is still logged into the server and you can still choose to open a different repository. Go to the File menu and select Choose Repository.

Connect to Server

The Connect to Server dialog box connects you to the Vault Professional server. For more information, please see Working with Repositories.

The Connect to Server dialog box can be opened:

  1. From the File menu, select Connect to Server

  2. Upon starting Vault Professional

You can only be connected to one server at a time. Therefore, if connect to a different server during a session, you will be disconnected from the current server.

Username

Type your User name. You must be an active Vault Professional user as defined in the Vault Professional Admin Web Client.

Password

Type your Password.

Vault Professional Server

Type the name of the Vault Professional server. This is the host name of the server and not a URL. You do not need to use http://. For example you might use myvaultserver to connect within the network or myvaultserver.mydomain.com over the Internet. You can also connect using the Vault server IP address as the server name. If your IIS is using a non-standard port, indicate the port number as in this example: myvaultserver.mydomain.com:888.

Use SSL

Check the Use SSL checkbox if you are using Secure Sockets Layer (SSL) for security.

Select Profile

Allows you to select an existing profile. If you select a profile, the information from that profile will be automatically placed in the login fields.

Edit Profiles

Click to bring up the Edit Profiles dialog, which allows you to enter and edit profiles for use in automatically logging in.

Automatically Connect using this profile

Check the Automatically Connect using this profile checkbox to automatically connect to the server specified by the current profile the next time Vault Professional is started. This option is available only if you are currently using a profile, and if that profile is configured to remember the user’s password (since the password must be supplied to automatically login).

OK

Click OK to attempt a login to the specified server. The Connect to Server dialog box will close and the Choose Repository dialog box will open unless you are using a profile that automatically connects to a repository, in which case that profile will be automatically chosen.

Cancel

Click Cancel to close the Connect to Server dialog box. If you are not currently logged in, the client remains in an unconnected state.

Copy Branch

A Copy Branch allows you to branch any file or folder, whether it is shared or not. For more information, please see Branch Items.

To open the Branch dialog box select a file or folder then either:

  • From the Source menu, select Branch

  • Select Branch on the Toolbar

Specify a folder/file name

Select a folder in the tree to place the branched version, and if desired, provide a new name for the copy of the file.

Comment

Type a comment for the branch operation in the Comment box. This is optional.

OK

Click OK to branch the select file or folder and return to the main window.

Cancel

Click Cancel to exit the Branch dialog box without making any changes.

Create Folder

The Create Folder dialog box allows you to create a new empty folder within the repository. For more information, please see Create, Add and Delete Folders.

The Create Folder dialog box can be opened:

  1. From the File menu, select Create Folder

  2. Right-click on folder to bring up the Folder Tree Context Menu, select Create Folder

  3. Select Create Folder on the Toolbar

  4. Press the INSERT key

New Folder Name

Type a new folder name in the New Folder Name box.

OK

Click OK to create the folder and close the Create Folder dialog box.

If Auto-Commit has been selected (default), the folder will be created in the Vault Professional repository immediately. If Auto-Commit has not been selected, the folder will be created in the repository as part of the next check in transaction.

Please see Auto-Commit for more information.

Cancel

Click Cancel to close the Create Folder dialog box. A new folder will not be made.

Detect New Files

The Detect New Files to Add from Working Folder dialog box 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 local files to the repository.

The Detect New Files dialog box can be opened:

  1. From the File menu, select Detect New Files to Add

  2. Right-click on selected folder to bring up the Folder Tree Context Menu, select Detect New Files to Add

  3. Ctrl+T

Tree View of Local File System

The top pane contains a tree control and a file list of the local file system, rooted at the working folder where the command was invoked. The tree is actually the repository tree, and if a node is selected, the working folder at that node is used to display the list of files that exist in the working folder, but not in the repository at that level.

Checking a folder will automatically check all the folders and files under that folder that meet the exclusion rules. All files that meet the exclusion rules are added as individual entries in the Files to be Added list, and they are added at the level in the repository that corresponds to the working folder the files belongs too.

If not all files/folders underneath a folder are checked, the folder’s checkbox will be partially checked. Checking a partially checked folder will fully check all files and folders under that folder. Checking a fully checked folder will uncheck all files and folders, and remove the entry from the Files to be Added list.

Files to be Added

Files to be Added is the list of pending files that are to be added from the local directory. The following columns are in this list:

  • Items – The local path of the file or folder to be added.

  • Properties – For files, the size of the file being added. For folders, the total size, and the number of folders and files included in the folder being added.

  • Repository Path – The path in the repository the items will be added.

Exclude

Click Exclude to display a dialog that allows you to view/edit the list of files and folders to exclude when checking a folder. This list is defined in the Admin Web Client and making changes to it here does not update the default list.

Changing this list does not go back and re-apply the exclusion rules to already checked folders, since it is possible you could have already made changes to the file list that cause it to not follow the exclusion rules. If you want to re-apply the exclusion rules, you need to uncheck the folder, then check it again.

Remove

Click Remove to remove the selected files or folders from the pending list. This will update the state of the tree and file list to reflect that the items are not to be added.

Comment

Type a comment in the Comment dialog box. The comment applies to all files being added. If the Auto-Commit is on, they become the changeset comment.

OK

Click OK to add the files and folder to the Pending Change Set window.

If Auto-Commit has not been selected, the files and folders will be added to the repository as part of the next check in transaction. The comment is applied individually to each file.

If Auto-Commit has been selected (default), the files and folders will be added to the Vault Professional repository immediately. The comment will become the changeset comment.

Please see Auto-Commit for more information.

Cancel

Click Cancel to exit the Add Files dialog box without making any changes.

Diff

The Diff command allows you to compare working files and folders to previous versions of themselves.

The Diff dialog box can be opened:

  1. From the Tools menu, select Show Differences

  2. Select Diff on the Toolbar

  3. Right-click on folder to bring up the Folder Tree Context Menu, select Show Differences

  4. Right-click on file to bring up the File List Context Menu, select Show Differences

Compare the working folder/file to:
  • The last version retrieved from the repository – This compares the working file or folder to the version that you started editing from which is the version that was retrieved from the repository.

  • The current version in the repository now – This compares the working file or folder to the current version in the repository that may have changed since you started editing.

  • A label applied to this folder/file – This compares the working file or folder to a version of the same file or folder that is part of a label that was previously applied. The Browse button will display the list of available labels that can be compared to the working file or folder.

  • Any local folder/file – This compares the working file or folder to a file or folder on the local disk. The browse button will display a local file/folder chooser that allows you to choose which file or folder to compare against the working file or folder.

  • Any repository folder/file – This compares the working file or folder to the current version of any file or folder in the repository. The Browse button will display the current repository tree and allow you to select a repository file or folder to compare against the working file or folder.

Recursive

When a folder has been selected, the Recursive checkbox will be available. Check Recursive to view the difference in the selected folder and all the subfolders. Uncheck Recursive to view the differences just in the selected folder.

The default is Checked.

Only show this dialog when the shift key is down

If you select this option, the dialog will be disabled and will not appear unless the shift-key is being held down. The default selections will apply to any item selected. See History/Labels Options to change the default selections.

OK

Click OK to bring up the default Diff Program.

Cancel

Click Cancel to close the Diff dialog box.

Delete

The Delete dialog box allows you to delete files or folders from the repository. The Delete command is non-destructive and the items still exists in the history of the repository. The items can be recovered by clicking the Undelete command found in the Folder Properties dialog box.

The Vault Professional client does not allow operations that destroy history. The Obliterate command is available in the Vault Professional Admin Web Client, which actually destroys the deleted file.

The Delete dialog box can be opened:

Delete file(s) from working folder

If you are deleting a file which is already in your working folder, this checkbox will become enabled. When checked, it will delete the file from the working folder as well as the repository. The default value of this checkbox is controlled by the -->Perform file deletes in working folder option.

Are you sure you want to delete the following files?

A list of the selected files or the folder will appear in the box. If a folder is selected, the folder and all of its contents, recursively, will be deleted.

OK

Click OK to delete the items and close the Delete dialog box.

If Auto-Commit has been selected (default), the files will be deleted in the Vault Professional repository immediately. If Auto-Commit has not selected, the files will be deleted in the repository as part of the next check in transaction.

Please see Auto-Commit for more information.

Cancel

Click Cancel to close the Delete dialog box. The item will not be deleted.

Edit File

The Edit File command edits a file by launching an external editor and allows you to check the file out if it is not already checked out. For more information, please see Editing Files.

The Edit File dialog box can be opened:

  • From the Edit menu, select Edit File

  • Select Edit on the Toolbar

  • Right-click the selected file to bring up the File List Context Menu, then select Edit

Use the system default

Select Use system default for this file type to use the default editor.

Use

Select Use and type the full path to the editor to use a different editor application. Use the Browse button to find the editor if necessary. Once a different application is selected, it will become the default.

The default editor for Windows is Notepad. To change the default application, see External Programs Options.

Check out file before editing

Select Check out file before editing to check out the file from the Vault Professional server. This option is disabled if the file is already checked out.

If you have the Requires Check Out before Check In option enabled in the Check In Options, the default will be checked.

Only show this dialog when the shift key is down

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

OK

Click OK to launch the external application and edit the selected file.

Cancel

Click Cancel to abort the operation.

Edit History Favorites

The Edit History Favorites dialog allows you to change and create history favorites.  It lists all of your defined history favorites in alphabetical order.  Clicking on a history favorite in the list will display a brief description of the query for the selected favorite beneath the favorites list. 

Adding a History Favorite

 To add a new History Favorite, click the New button.  This will display the History Query Filter/Sort dialog.  Choose the history filter options you want for your history favorite then click the Save button.  Provide a name for your favorite then click OK

 Renaming a History Favorite

 Click the Rename button and enter a new name in the dialog.

 Editing a History Favorite Query

Select a history favorite from the list and choose Edit to edit the query associated with the favorite.  This will display the History Query Filter dialog with the currently filtered items selected.  Make your changes to the filter options and then click the Save button.

Deleting a History Favorite

To delete a History Favorite, select one or more items from the History Favorites list then click the delete button.

 Run Query

To see the query results for a History Favorite, select an item from the History Favorite menu then click the Run Query button.  The query results will be displayed in a new History Explorer window.

Edit Profiles

The Edit Profiles command allows you to create and edit profiles for use in connecting to a Vault Professional server and repository. For more information, please see Profiles.

The Edit Profiles dialog box can be opened from the Edit Profiles button on the Connect To Server dialog.

Profile List

The Profile List contains the list of profiles that have already been defined. Selecting a profile in the list will populate the Login Information and Repository Information boxes with the data specified for that profile.

New

Click New to create a new, empty profile. You will be prompted to enter the profile name.

Delete

Click Delete to delete the selected profile.

Username

Contains the Username associated with the selected profile.

Password

Contains the Password associated with the selected profile. This is only enabled if the Remember Password checkbox is enabled. If this field has a value and the Remember Password checkbox is unchecked, the password will be removed on Save and the profile will no longer contain a password.

Vault Professional Server

Contains the Vault Professional Server associated with the selected profile, as it would be entered in the Connect To Server dialog.

Use SSL

If checked, this will connect to the server using SSL for the selected profile.

Remember Password

If checked, the password specified in the Password field will be saved and remembered, allowing the user to automatically connect to the server using this profile. If unchecked, the user will need to enter the password for each connection using this profile.

Default Repository

Contains the name of the repository to select by default after a connection is made to the server for this profile.

Automatically Choose This Repository

If checked, the Default Repository will be automatically chosen after connecting to the server for this profile. The Choose Repository dialog will not be displayed at all when this profile is used. This is only enabled if there is a value in the Default Repository List

Get Repository List

Brings up a dialog containing a list of repositories in the Vault Professional server associated with this profile. Note that this uses values specified in the Username, Password, and Vault Professional Server fields to login to that server in order to retrieve the repository list, so if they do not contain valid values, the repository list cannot be retrieved.

Save

Click Save to save any changes you have made to the profiles while in the dialog and then exit.

Cancel

Click Cancel to abort the operation.

File Properties

The File Properties dialog box allows you to view and modify the properties of a file. The dialog box has five tabs: General, Check Outs, Share Links, Visual SourceSafe Information, and Backup Files.

General

Name

The name is the full repository path of the selected file.

Type

The type of the selected file is displayed. This can be changed by selecting one of the following.

  1. Binary – Marks the file as not able to be merged. The file will require exclusive check outs and no attempt will be made to merge different versions together.

  2. Mergeable – Marks the file as able to be merged and not needing to be locked exclusively.

  3. Use default for this file type – File extensions are used to determine default types for mergeable files. This options uses the system default the file.

You must click Apply in order for this change to take effect.

EOL Conversion

The EOL (End of Line) of the selected file is displayed. The can be changed by selecting either:

  1. None

  2. Native – Native chooses the format of OS the client is currently running on

  3. Windows (CLRF)

  4. Unix (LF)

  5. Mac (CR)

You must click Apply in order for this change to take effect.

Local Copy Information

The Local Copy Information box contains the following information.

  1. Version – the version number of the file when it was checked out

  2. Modified Date – the last modified date time of the file in the working directory

  3. Size – the size in bytes of the file in the working directory

  4. Status –the status of the file as shown in the file list

If there is no local copy, this will be blank.

Latest in Repository Information

The Latest in Repository Information box contains the following information.

  1. Version – the most recent repository version number of the file

  2. Modified Date – the last modified date time of the file in the repository

  3. Check in Date – the check in date time of the file in the repository

  4. Size – the size in bytes of the file in the repository

  5. Status – this displays only if the file is pinned and will display which version the file is pinned at

Comment

The Comment box contains the comment of the transaction which created the file’s version.  

Apply

Click Apply to apply any changes made to any of the properties. The property changes increment the version number of the file.

Note

If the file is currently pinned, the edit is not allowed.

Close

Click Close to exit the Properties dialog box. If you have edited a property but not applied it, you will get a warning asking you whether you want to apply the change.

Check outs

The Check outs tab displays checkout information about the selected file. No items on this tab can be edited.

User

The User box lists all users who currently have the selected file checked out and includes the machine they have it checked out to.

The properties reflect the values for each user as they are selected.

Version

The Version is the repository version at the time the selected user checked out the file.

Date

The Date is the repository server’s date time when the selected user checked out the file.

Folder

The Folder is the folder and file name of the file that was checked out by the selected user.

Comment

The Comment is the check out comment the selected user entered.

Visual SourceSafe Information

This properties tab displays information about a file which was imported from Visual SourceSafe. If the file was not imported, this tab will not be displayed.

Path

The path of the original file in VSS.

Import Date

The date of the import run which originated the file.

Import User

The user that performed the import operation.

Share Links

The Share Links tab contains all links of the shared file in a list that you have access to. No items on this tab can be edited.

Backup Files

The Backup Files tab contains a list of all the available backup files for the selected file.

Date

The Date is the timestamp of the backup file.

Baseline Version

The Baseline Version is the repository version the file was based off of when the backup was made.

The Backup Files context menu contains the following commands.

Diff

The differences between the backup file and the current working folder version can be viewed by selecting Diff from the context menu.

View

The backup file can be viewed by selecting View from the context menu.

Restore

Selecting Restore from the context menu will overwrite the working folder version of the file with the selected backup file.

Delete

Any backup file may be permanently deleted by selecting Delete from the context menu.

The Find Shelvesets Dialog

This dialog is used to browse the shelvesets for a repository and get basic details about them. It can be opended by clicking the Unshelve button in the Pending Changes control, or selecting the View Shelved Changes menu item in the View menu. The controls are as follows:

User

This dropdown will display a list of all active users with access to the repository. Your user name is selected by default in this dialog. Selecting the first item in the dropdown (named “all”) will show all shelvesets from all active users in this repository.

Find

Clicking this button will populate the Shelveset list for the user selected in the user dropdown.

Results

This list will display all of the shelvesets for a selected user. If you don't have Read access to any of the shelved changes in a shelveset, it will not be included in the results. The path column displays the parent path of the items that are shelved (for example $/trunk/src or $/branches/1.0). Selecting a shelveset in this list will activate the Details button. You can unshelve the selected shelveset through the Shelveset Details dialog (opened by selecting a shelveset and clicking the Details button). The following operations are available in the context menu:

Details

View the details for the shelveset. (Double-clicking an item will also activate this action.)

Rename

Rename the shelveset. Renaming a shelveset will not affect the shelveset creation time. You may only rename your shelvesets. (F2 is a shortcut for this action.) No two shelvesets may have the same owner and shelveset name.

Delete

Delete the shelveset. You many only delete your shelvesets. (The delete key is a shortcut for this action.)

Diff

Perform a diff of the shelveset against a tree

Diff against working folder

Diff the shelveset against the working folder (both folders will be rooted at the deepest path in the shelveset).

Diff against baseline

Diff the shelveset against the baselines (at the time of the shelve operation).

When Diffing shelvesets, the Find Shelvesets dialog expands to allow you to select two shelvesets. The Diff function will fetch both shelvesets to a temporary directory and perform a folder diff.

Folder Properties

The Folder Properties dialog box allows you to view and modify the properties of a folder. Right-click on a folder in the tree and select Properties . . .

The dialog box has four tabs: General, Deleted Items, Share Links, and Backup Files.

General

Name

The Name displays the name of the selected folder.

This project is cloaked for me

Check the This project is cloaked for me checkbox to cloak the folder. This will update the state of the folder immediately.

Contains

The Contains box shows:

  • the number of files and the number of files deleted

  • the number of subprojects and the number of sub-folders deleted

  • the Tree Size which is the total size of all files recursively in the folder

  • the Disk Space Needed which is the amount of disk space required to do a Get to a working folder, which is double the tree size, since the state folder keeps a baseline copy of each file on the local disk.

Latest in Repository

The Latest in Repository box shows the version number and date of the selected folder.

Comment

The Comment box contains the comment that was entered when the user created the folder.

Close

Click Close to close the Folder Properties dialog box.

Deleted Items

Deleted Items

The Deleted Items tab contains a list of all items that have been deleted at this folder level.

Date Time

Since a deleted item may have the same name as another deleted item, there is a column with the date and time that each item was deleted.

Undelete

Click Undelete to remove a selected item from this list.

Close

Click Close to close the Folder Properties dialog box.

Links

Share Links

The Share Links tab contains all links of the shared folders in a list that you have access to. No items on this tab can be edited.

Backup Files Overview

The Backup Files tab has two sections. At the top is a tree representation of all items that have backup files in an _sgbak directory at this folder level. The bottom section is a table which will list files selected from the tree. The backup files for each file in the tree are shown as children of the file.  The creation date/time are shown with the name of each backup file.  Selecting a backup file in the tree and clicking Add will add the backup file to the table below the tree.  From this table, backup files may be deleted or restored.

Backup Files Tree Section

In the Tree Section of the Backup Files tab you can select files to add to the table below. They can then be restored to the working folder or deleted. Right-click on a backup file to to Add, Diff, or View the file.

Add All

To add all the backups under a particular node in the tree to the table, right-click the node and select Add All from the context menu at the folder level.

Add

A backup file may be added to the list by either selecting it in the tree and clicking the Add button or right-clicking the file in the tree and selecting Add from the context menu.

Backup Files Table

This table is divided into columns with information about the backup file.

Relative Path

This column displays the path to the file within the folder.

Date

The Date is the timestamp of the backup file.

Baseline Version

The Baseline Version is the repository version the file was based on when the backup was made.

Restore All

Click Restore All to overwrite the working copy of every file in the list with the chosen backup file.

Delete All

Click Delete All to delete every backup file in the list.

Clear All

Click Clear All to clear the contents of the list.

Backup Table Context Menu

Right-click on one or more files in the Backup Files table to bring up the context menu.

Clear

A backup file may be removed from the list by selecting the file and choosing Clear on the context menu.  This option is also available with multiple selections.

View

A backup file from the list can be viewed by selecting View from the context menu.

Diff

The differences between a backup file in the list and the current working folder version can be viewed by selecting Diff from the context menu.

Delete

Any backup file may be permanently deleted by selecting Delete from the context menu.  This option is also available with multiple selections.

Restore

Selecting Restore from the context menu will overwrite the working folder version of the file with the selected backup file.  This option is also available with multiple selections.

Select All

Select all items in the table of backup files.