Vault and Fortress Integration

This section describes Code Collaborator integration with Vault and Fortress.

Code Collaborator supports SourceGear Vault version 5.0 and Fortress version 2.0.  The integration is provided through SourceGear's Vault client API, available from the Smart Bear downloads page.  Currently, installation requires manual steps of downloading and copying the API .jar file.  First, install the Command Line Client.  Next, download the Vault client .jar file.  Then copy this file to the following directory under the Command Line Client installation directory (where xxx is the build number of the release):

       ui\plugins\com.smartbear.collaborator_5.0.xxxx\libs_single_instance

Reinstalling the Command Line Client will delete the previous directory, so you might want to temporarily move the Vault client .jar file to another directory before reinstallation.

Fortress Support

Fortress users will need to enable the global-option vault-fortress-mode in the Command Line Client or the GUI Client.

Windows Installation Notes

Installing under Windows may require a temporary workaround for the SourceGear Vault client API. If your system uses a workgroup instead of a domain, the USERDNSDOMAIN environment will not be set to a value. This variable is required for the Vault client API to understand the correct username of the client. You can determine the value of USERDNSDOMAIN by typing set at a command prompt and looking through the environment variables. If the variable is not set, it *must* be defined before running the Command Line Client, or items in Vault's pending change set will not be found. The variable must be set to the name of the local workgroup, typically mshome or workgroup. You can find the workgroup name of the system on the General tab of the System Properties dialog.

There are two ways to set this environment variable for the Command Line Client. Create or edit the ccollab.vmoptions file in the Command Line Client installation directory, and include the line (with your workgroup name substituted):

       userdnsdomain=workgroup-name

Note: the last line of this file *must* be followed by a line feed.

Another way to define this variable is in the User environment variable space. On the Advanced tab of System Properties, select the Environment Variables button and create a User variable named USERDNSDOMAIN with a value of the local workgroup name.

The GUI Client integrates with Vault and Fortress.  It can find and upload Vault pending change set items, or already committed Vault source files.

The Command Line Client integrates with Vault and Fortress.  It can find and upload Vault pending change set items, or already committed Vault source files.

Troubleshooting

Enabling debugging in the Code Collaborator clients when Vault is used will create a ccollab_vault.log file, in the current directory for the Command Line Client or the installation directory for the GUI Client.  This file contains trace logging from the SourceGear Vault API, which in addition to the Code Collaborator client debugging log, can be useful for troubleshooting Vault issues.  When submitting a client debugging log to technical support for a Vault issue, please also include this file.