Vault Professional
Client Help
Copyright © 2003-2014
SourceGear
Table of Contents
Welcome to SourceGear
Vault Professional
1. Support
2. Tips for SourceSafe Users
3. Using
Vault Professional
Working with Repositories
Connecting to the Server
Profiles
Choosing Repositories
Disconnecting from Server
Working in the Main Window
The Toolbar
Messages
Status Bar
The Folder Tree
The File List
File
Check Outs
Local Version
Remote Version
Status
Ghost Folders and Files
Ghost Folders
Context Menu
Ghost Files
Context Menu
Pending Change Set
List
Toolbar
Search
Toolbar
List
Notifications
Notifications Tab
Find in Files
Find in Files Dialog
Find in Files Tab
Results List
Tool bar
Find in Files context menu
Working with Folders
Create, Add and Delete Folders
Creating Folders
Adding Folders
Deleting Folders
Check Out and Check In Folders
Checking Out Folders
Checking In Folders
Rename and Move Folders
Renaming Folders
Moving Folders
Pin Folders
Status
Shares
Commit Pin
Cloak Folders
Working with Files
Add, Detect New, View, Edit and Delete Files
Adding Files
Commit Add Files
Detecting New Files
Viewing Files
Editing Files
Working Folder
Check Out
Editor
Deleting Files
Check Out and Check In Files
Checking Out Files
Check Out File Multiple Times
Checking In Files
Rename and Move Files
Renaming Files
Moving Files
Pin Files
Restrictions
Delete a Pinned File
Branch a Pinned File
Pin a Shared File
Share a Pinned File
Commit Pin
Working with Shares and Branches
Share Items
Primary and Secondary
Shared Folders
Modified Shares
Name, Rename, Move Shares
Check Out or Check In Shares
Delete Shares
Commit Share
Branch Items
Branches on Folders
Share Branches
Copy Branches
Snapshots
Working with Labels
Deleted Items
Pinned Items
Shared Items
Viewing Labels
Label Promotion
Copy Label
History Explorer
History Query Filter/Sort
Favorites
General
Dates & Labels
Users
Filenames
Actions
Comments
Sort
Misc
History Results Menus
Query
View
Action
History Diff
Get from History
Help
Folder Versions
Version List
Edit History Favorites
Adding a History Favorite
Renaming a History Favorite
Editing a History Favorite Query
Deleting a History Favorite
Run Query
VSS History
History Favorites
Merge
Merge Window
Merge Branches
Additional Merge Branches Details
Binary Files
Folder Changes Archive
Shelve
What kinds of changes can be shelved?
Finding the Shelve Functions
How Do I Unshelve Changes?
4.
Vault Professional
Options
General Options
Act on Folders Recursively
Always Request Exclusive Locks
Double-Click on File
Automatic Refresh
Show Snapshot in the folder tree
Show non-version-controlled files ghosted in file list
Show non-version-controlled folders ghosted in folder list
Check for Latest Vault version at startup
Use check boxes to select items
Minimize to System Tray
Make
Vault Professional
your default SCC provider
Always display command dialog on Get Latest Version (available from Visual Studio only)
Always disconnect from server on Add/Open To/From Source Control (available from Visual Studio only)
Check In Options
Always Keep Files Checked Out
Remove Local Copy after Check In
Auto-Commit after each Operation
Require Check out before Check In
Check In Unchanged Files
Shelve Options
Undo changes in working folder after Shelve
Automatically delete shelveset after successful Unshelve
Local Files Options
Modified Working Copy
Prompt before overwriting locally modified files
Save files in backup folders before overwriting
Perform File Deletes in Working Folders
Perform Repository Deletions Locally
Make Writable
Set File Time
On Undo Checkout
Override Native EOL Type
Detect Modified Files Using CRCs Intead of Modification Times
Only use CRC checks for files smaller than [size]
Cache/Backup Locations
Store Client Cache Folder
Store Working Folder State/Baseline Files
Limit number of baseline files
Open Cache Folder
Reset Repository Cache
Save files in backup folders before overwriting
Store Backup Files
Limit number of backup files
Diff/Merge Options
Default item to diff against
Diff Program
Diff Arguments
Merge Program
Merge Arguments
History/Labels Options
History Diff when single version selected
Label Diff when single version selected
Limit Queries to
Fetch rows in chunks of
Act on queries recursively
Notification Options
Integration Components
Axosoft On Time
SourceGear Work Item Tracking
External Programs Options
Editor
Viewer
Command Dialogs Options
File List Columns
Warnings Options
Concurrent Development Style
Network Settings
Use chunked encoding
em: 100-Continue Headers
Request database delta
Proxy
Use system default proxy
Use a manually configured proxy
Do not use a proxy
Reset proxy user
5. SourceGear
Vault Professional
Classic Client (MSSCCI)
Enable / Disable Integration
Vault Professional
Global Options
Accessing
Vault Professional
Command Options
6. SourceGear
Vault Professional
Visual Studio Enhanced Client (VSIP)
Configuring the Enhanced Client as the default source control provider
Opening a project or solution file
Uploading a project or solution to the repository
The Change Bindings Dialog
Tool Windows
7. Eclipse Integration
Opening a project
Uploading a project to the repository
Views
8. Using
Vault Professional
via WebDAV
Configuring WebDAV
Constructing the
Vault Professional
WebDAV URL
Authentication
Sanity Check
Using WebDAV with Dreamweaver
Limitations
9.
Vault Professional
Work Item Tracking
Work Item Tracking Overview
View Work Items in the
Vault Professional
GUI Client
Work Items in the Pending Changes Tab
Browse Work Items
Update Work Items on Check In
View Integrated Work Item Tracking In Visual Studio and Eclipse
Connecting to
Vault Professional
Work Items
Disconnecting from
Vault Professional
Work Items
Reload the Project List
The
Vault Professional
Work Item Tracking Pane
Vault Professional
Item Tracking Folders
Work Items
Adding Items
Goto Work Item
Explanation of Keywords
Attachments
Image Editor
Explanation of Status Values
Link Notation
Queries
Performing Queries
Saving Queries
Query Results Table
Refreshing Query Results
Vault Professional
Time Tracking
Time Tracking for Work Items
Summaries
At-A-Glance Table
10. Axosoft OnTime Defect Tracking
OnTime Defect Tracking Integration
Configuring Axosoft OnTime Defect Tracking Integration
Enable OnTime Integration
OnTime URL
Login ID
Security Token
Test Connection
Advanced Settings
Proxy
Using Integrated OnTime Defect Tracking
Associating a Vault Pro Change Set with OnTime Defects
Committing a changeset and associated defects
Select Repository Items
Select Defects
The Commit Dialog
The Commit Dialog Vault Change Set View
The Commit Dialog Associated OnTime Defects View
Commit Dialog Comments
Vault Transaction Link
The OnTime View in the Pending Change Set
The OnTime Defects List
11. Reference Guide
Menus
Main Window
File
Edit
View
Source
Tools
Help
Folder Tree Context Menu
File List Context Menu
Pending Change Set Context Menu
Status Search Context Menu
Show Label Menus
Label
View
Action
Label Promotion Menus
File
View
History Menus
View
Action
Help
Dialog Boxes
Add Files/Folders
Tree View of Local File System
Files/Folders to be Added
Exclude
Browse
Remove
Comment
OK
Cancel
Blame
Browse Work Items
Change Password
Check In/Commit
Check Out
File Options
Only Show this Dialog When the Shift Key is Down
Comment
OK
Cancel
Choose Repository
Connect to Server
Copy Branch
Create Folder
Detect New Files
Diff
Delete
Edit File
Edit History Favorites
Adding a History Favorite
Renaming a History Favorite
Editing a History Favorite Query
Deleting a History Favorite
Run Query
Edit Profiles
File Properties
General
Check outs
Visual SourceSafe Information
Share Links
Backup Files
The Find Shelvesets Dialog
Folder Properties
General
Deleted Items
Links
Backup Files Overview
Backup Files Tree Section
Backup Files Table
Backup Table Context Menu
Folder Versions
Get Latest Version
Image Editor
Label Diff
Label File or Folder
Label Promotion
Move
Rename
Save History Results
Set Working Folder
Unset Working Folder
Share
Share Branch
The Shelve Changes Dialog
The Shelveset Details Dialog
Show History For
Show Labels
Show Line History
Snapshot Folder
Undo Check Out
Version Details
Version List
View File
Keyword Expansion
History Keywords
HTML Keywords
Expanding Keywords
Preserving Spacing
Time Formats
Keyboard Shortcuts
Client Logging
Enabling Logging: Finding the Configuration File
Enabling Logging: Editing the Configuration File
What Should I Log?
Where is the Log File?
Special IDE Log File
Examples
Branching a Folder
Folder Shares
Primary and Secondary Shares
Query Description
Rename and Working Folders
Share Branch
Naming Syntax, Conventions and Limitations
User names
User passwords
Repositories
Label Names
File Names
Paths
Groups
Size of File Stored in Database
Number of Versions of a Given File
List of Tables
4.1.
Concurrent Development Style Options
List of Examples
8.1.
A complete
Vault Professional
WebDAV URL