Vault Plugin Configuration Guide

A collection of information about Vault, including solutions to common problems.

Moderator: SourceGear


Posts: 9736
Joined: Tue Dec 16, 2003 1:25 pm
Location: SourceGear
PostPosted: Fri Nov 09, 2012 2:29 pm
Troubleshooting Vault Plugin errors

UPDATE: Starting in Vault 6.1.0, an Administrative section has been added for viewing and configuring Vault plugins for Shadow Folders, Vault Index Server, and Vault Notification Server. The information provided below is still relevant, except you will not make any changes directly to the databases. Instead, you will edit the URLs in the Vault Plugins page.

You may delete any additional entries that are set to False.

Do not have more than one URL for a service set to True. You should only have 3 set to True with Vault Standard, and 4 set to True for Vault Professional.

----------------------------------------------------------------------

Vault 6.0 and later versions use plugins for Shadow Folder, Notification and Index (Find in Files) services. In order for these features to work, the Vault Server needs to be able to connect to the plugin service and the plugin needs to be able to connect back to the Vault Server.

To connect to the plugin, the Vault Server gets the connection information (plugin URL) from these tables in the Vault sgvault and sdragnet databases:

  • sgvault.dbo.tblplugins

  • sgdragnet.dbo.plugins


Note: if you are using Vault Standard, there is an sgvault database but no sgdragnet database. Vault Pro has both an sgvault database for source control and an sgdragnet database for work item tracking.

Plugin Errors
Depending on your IIS/network configuration, the plugin URLs created by the Vault Server installer may or may not be valid.

If your plugins aren’t working properly, the first step is to check the log files for errors. The log names and default locations on the Vault Server machine are:

Code: Select all
Vault Server log:  C:\Windows\temp\sgvault\sgvault.log on the Vault server machine.

Vault Shadow Folder log: C:\Windows\temp\SGShadowFolder\vaultshadowfolderservice.txt

Vault Index Service (Find in Files) log:  C:\Windows\temp\SGVaultIndex\vaultindexservice.txt

Vault Notification Service log: C:\Windows\temp\SGVaultNotify\vaultnotifyservice.txt


Where does the plugin URL come from?

The Vault installer creates two plugin URLs.

• One is based on "localhost" http://127.0.0.1
• The other URL is based on the Vault servername and comes from information in IIS on the Vault Server machine.

The installer activates one of the plugin URLs, generally “localhost” or http://127.0.0.1. Since some server configurations do not support "localhost," the URL with the server name is provided as an additional option.

Vault Plugin Configuration Manager

Vault 6.1 and later versions of Vault provide a plugin configuration manager for testing and changing Vault plugin URLs. The Plugins page is in the Vault Admin Web Client under Server Settings->Vault/Vault Professional Plugins.
From the Plugins page you can edit, add, delete, and test the plugins associated with Vault Professional server.

The Plugins page contains data from the sgvault.dbo.tblplugins table in the sgvault (source code control) database and the sgdragnet.dbo.plugins table in the sgdragnet (work item tracking) database.

The Plugins list displays the following columns of information:

    • Server URL -- This is the URL of the plugin service. Click on the URL link to edit the entry in the database. Note: Any changes to plugin information may affect system operations. Please contact SourceGear Technical Support, support@sourcegear.com, regarding modifications to Plugin Configuration.

    • Test. -- Click the magnifier icon to test the plugin URL

    • Plugin Name -- This is the name of the plugin.

    • Active --This column displays the value "True" or "False" to indicate whether plugin URL is active or inactive.

    • Source -- The Source column lists the source of the data. "Source Code Control" indicates the data is from sgvault.dbo.tblplugins. "Work Item Tracking" indicates the data is from sgdragnet.dbo.plugins.

    • Delete-- Click the red "X" in the Delete column to delete a plugin entry. This will delete the specific plugin data from the database. Note: Any changes may affect system operations. Please contact SourceGear Technical Support, support@sourcegear.com, regarding modifications to Plugin configuration.

    • Add -- Click Add on the Plugins bar to add a plugin entry to the database. If you are adding a plugin URL for the VaultIndexService or Shadow Folders, select “Source Control” from the “Source” dropdown and “ChangeSetEvents” for the” Events” dropdowns.

    If you are adding a plugin URL for Source Control Notifcations, choose ”Source Code Control” from the “Source”dropdown and "Notification events" from the Events dropdown. Notification events include login/logout, checkin, add, etc..

    To add a plugin URL for Work Item notifications, choose Work Item Notifications from the Source dropdown and Notification Events from the Events dropdown.

Plugin Example
    An example of what working plugins are the following:
    Code: Select all
    Source Code Control http://127.0.0.1/VaultNotifyService/VaultNotifyService.asmx       VaultNotifyService.VaultNotifyService 

    Source Code Control http://127.0.0.1/VaultIndexService/VaultIndexService.asmx         VaultIndexService.VaultIndexService

    Source Code Control http://127.0.0.1/VaultShadowFolder/VaultShadowFolderService.asmx  VaultShadowFolder.VaultShadowFolderService

    If you are using Vault Professional, you will also have a plugin for notifications in the work item tracking:
    Code: Select all
    Work Item Tracking  http://127.0.0.1/VaultNotifyService/VaultNotifyService.asmx       VaultNotifyService.VaultNotifyService

    You can either use the loopback as the examples show (127.0.0.1), or you may use an IP address, server name or FQDN. A screenshot showing what the entries would look like is posted here: viewtopic.php?f=13&t=22855

What if my plugin URLS aren’t valid?

You can test the plugin URL in the Plugin Configuration Manager by clicking the magnifier icon in the Test column.
If the plugin is correctly configured, you will see the service .asmx page, like this:
http://vaultdemo.sourcegear.com/VaultNo ... rvice.asmx

You may need to edit the plugin URL in the table so that the URL correctly connects to the .asmx page of the service.

To edit a URL, click on the URL in the Server URL column in the Plugins Configuration Manager.
Type in the URL that correctly brings up the plugin’s .asmx page. Click "Save" to save your changes.

To make the URL active, check the Active box. If the URL is already activated and you wish to deactivate it, uncheck the Active box. Click “Save” to save your changes.

NOTE: Only one plugin URL should be active for each service, even if more than one is configured.

Now the plugin URLs are valid. What’s next?

If the plugin URLs are valid, but the plugins still aren’t working, the next step is to verify that the plugins are able to connect to the Vault Server. The plugins connect to Vault Server using a URL in the web.config file for each services.

For the Shadow Folder Service, look for the web.config in:

C:\inetpub\wwwroot\VaultService\VaultShadowFolder

Then find the Shadowfolder web.config server connection entry:

<add key="shadowfolder_vaultserver" value="http://127.0.0.1/VaultService" />

Test this URL in a web browser on the Vault Server. If it generates an error, you will need to determine the proper URL for the connection. For instance, if you are using a non-standard port, you may need to add the port number:

<add key="shadowfolder_vaultserver" value="http://127.0.0.1:7369/VaultService" />

Or if you are using SSL, you may need to edit the URL to use https:

<add key="shadowfolder_vaultserver" value="https://127.0.0.1:7369/VaultService" />

These are the locations of the other web.config files, and the string for the Vault Server URL. Verify that the server URL works in a web browser to connect to the Vault landing page:

Vault Index (Find in Files) Service

C:\inetpub\wwwroot\VaultService\VaultIndexService

<add key="vault_server" value="http://127.0.0.1/VaultService" />

Vault Notification Service

C:\inetpub\wwwroot\VaultService\VaultNotifyService

<add key="vault_server" value="http://127.0.0.1/VaultService" />

For further information or technical support, contact support@sourcegear.com
Linda Bauer
SourceGear
Technical Support Manager

Return to Knowledge Base (Vault)

Who is online

Users browsing this forum: No registered users and 7 guests

cron