How to check that the Enterprise Vault SharePoint components are installed and configured on the SharePoint Web FrontEnds.

book

Article ID: 100037946

calendar_today

Updated On:

Description

Description

 

Introduction

This document lists the ways to check the status of installation and configuration of Enterprise Vault SharePoint components on the SharePoint server.

 

Summary

The Enterprise Vault SharePoint components installed on the SharePoint box consists of the following components:  
- Enterprise Vault Administration Service
- Version History Page
- Enterprise Vault Custom Web Service
For each SharePoint Web application, we install the following components:
- Enterprise Vault Web Parts (Archive Search, Archive Explorer)
- Enterprise Vault HTTP Module  

Configuring Enterprise Vault on the SharePoint Web Front End

Configure Enterprise Vault on the SharePoint Web Front End as described in Setting up SharePoint Server Archiving help before you start to archive from SharePoint.

Enabling web applications added after configuring Enterprise Vault for Archiving

To enable archiving for all new SharePoint Web applications added after the installation of SharePoint components, run SharePointFeatureSetup.exe from the Enterprise Vault Install directory.

Enterprise Vault Component Installation and Configuration Status Checks

 
After the run of Enterprise Vault SharePoint Components setup, for each of these components, the checks to determine if they are installed and configured are listed next.

Files added on the SharePoint box

1)     Confirm that Enterprise Vault is listed in the Windows Add/Remove programs.  
2)     Fetch the Enterprise Vault install directory by reading the registry key
On 64 bit Windows: SOFTWARE\Wow6432Node\KVS\Enterprise Vault\Install\InstallPath
On 32 bit Windows: SOFTWARE\ KVS\Enterprise Vault\Install\InstallPath        
3)     Check the existence of the install folder and the Enterprise Vault binaries in it through Windows Explorer.  
4)     Determine the SharePoint root folder by reading the following registry key: SOFTWARE\Microsoft\Shared Tools\Web Server Extensions\\Location, where is the version of SharePoint. For WSS 3.0 or MOSS 2007 it is 12.0, and for SharePoint 2010 it is 14.0.  
5)     Open the SharePoint root folder in Windows Explorer. Check that the following files exist in the subfolder TEMPLATE\LAYOUTS:
- Versions.aspx
- EV_versions_BAK.aspx
- EVSearchWSS.aspx
- EVHttpError.aspx
- EVHttpUnsupported.aspx
- EVRestoreShortcut.aspx
 
6)     Open the SharePoint root folder in Windows Explorer. Check that the following files exist in the subfolder ISAPI:
- EVCustom.asmx
- EVCustomdisco.aspx
- EVCustomwsdl.aspx
-KVS.EnterpriseVault.SharepointWebService.dll 
 
7)     To check if all the required binaries are present in Global Address Cache (GAC). On the Windows->Start->Run prompt type “assembly”.  The following binaries should be listed in GAC explorer:
- KVS.EnterpriseVault.HttpModule
- KVS.EnterpriseVault.Interop.AdminService
- KVS.EnterpriseVault.Interop.AutoStorageOnlineOpns
- KVS.EnterpriseVault.Interop.EVContentManagementAPI
- KVS.EnterpriseVault.Interop.IndexClient
- KVS.EnterpriseVault.SharePointArchiveSearch
- KVS.EnterpriseVault.SharePointComponentsCommon
- KVS.EnterpriseVault.SharePointWebParts
- KVS.EnterpriseVault.SharePointWebService
 
8)     For any Web application that is added as a target in Enterprise Vault, fetch the Home Directory or the Physical path, using the Windows->Start->Run->“inetmgr” applet i.e. using IIS Manager:

9)     Open the home directory of the Web application in Windows Explorer and check that the following file exists in the subfolder WPCATALOG:
-  KVS.EnterpriseVault.SharePointWebParts____ArchiveSearchWebPart.dwp  

Enterprise Vault Administration Service

1)     On the Windows->Start->Run prompt type “services.msc”. Check in this Services applet that the Enterprise Vault Administration Service is present and running as the Enterprise Vault service account.  
2)     If the Enterprise Vault Administration Service is not running as the Enterprise Vault service account, run the Enterprise Vault SharePoint Configuration wizard. The wizard can be invoked from Windows->Start->All Programs->Enterprise Vault->SharePoint Configuration.
 
  Version History
 
1)     Determine the SharePoint root folder by reading the following registry key: SOFTWARE\Microsoft\Shared Tools\Web Server Extensions\\Location, where is the version of SharePoint. For WSS 3.0 or MOSS 2007 it is 12.0, and for SharePoint 2010 it is 14.0.  
2)     Open the SharePoint root folder in Windows Explorer and check that the following files exist in the subfolder TEMPLATE\LAYOUTS:
- Versions.aspx
- EV_versions_BAK.aspx  
3)     Open the file Versions.aspx. For the Version History to be properly installed this file should have the following entry:  
<% @ Register TagPrefix ="evavh" Namespace ="KVS.EnterpriseVault.ArchiveVersionHistory" Assembly ="KVS.EnterpriseVault.SharePointArchiveSearch, Version=[EV Version], Culture=neutral, PublicKeyToken=[KeyTokenValue]"   %>
4)     Open a SharePoint website with a Versioned List and some items archived by Enterprise Vault. The Version History page should show items present in the archive as shown in the following image:  

Web Parts (Archive Search, Archive Explorer)

1)     Determine the SharePoint root folder by reading the following registry key: SOFTWARE\Microsoft\Shared Tools\Web Server Extensions\\Location, where is the version of SharePoint. For WSS 3.0 or MOSS 2007 it is 12.0, and for SharePoint 2010 it is 14.0.  
2)     Open the SharePoint root folder in Windows Explorer and check that the following file exists in the subfolder TEMPLATE\LAYOUTS
- EVSearchWSS.aspx  
3)     For any Web application that is added as a target in Enterprise Vault, fetch the Home Directory or the Physical path, using the Windows->Start->Run->“inetmgr” applet i.e. IIS Manager.  
4)     Open the home directory of the Web application in Windows Explorer and check that the following file exists in the subfolder WPCATALOG:
- KVS.EnterpriseVault.SharePointWebParts____ArchiveSearchWebPart.dwp  
5)     For more information on adding Archive Search and Archive Explorer Web Part refer to help topic Setting up SharePoint Server Archiving.

Enterprise Vault HTTP Module

1)     Determine the SharePoint root folder by reading the following registry key: SOFTWARE\Microsoft\Shared Tools\Web Server Extensions\\Location, where is the version of SharePoint. For WSS 3.0 or MOSS 2007 it is 12.0, and for SharePoint 2010 it is 14.0.  
2)     Open the SharePoint root folder in Windows Explorer and check that the following files exist in the subfolder TEMPLATE\LAYOU
- EVHttpError.aspx
- EVHttpUnsupported.aspx
- EVRestoreShortcut.aspx  
3)     For any Web application that is added as a target in Enterprise Vault, fetch the Home Directory or the Physical path, using the Windows->Start->Run->“inetmgr” applet i.e. using IIS Manager.  
4)     From the home directory of the Web application, open the web.config file. This file should have the following entry:  
< add name = " EVHttpModule " type = " KVS.EnterpriseVault.SharePoint.EVHttpModule, KVS.EnterpriseVault.HttpModule, Version=[EV Version], Culture=neutral, PublicKeyToken=[KeyTokenValue] " />
The following module settings will also be present in the web.config file:  
< appSettings >
    < add key = " EnterpriseVault_LogEnabled " value = " false " />
    < add key = " EnterpriseVault_LogFolder " value = " C:\Program Files (x86)\Enterprise Vault\SharePoint Logs\ " />
    < add key = " EnterpriseVault_UsersToLog " value = "" />
    < add key = " EnterpriseVault_LogFileVersions " value = " 12 " />
    < add key = " EnterpriseVault_IndexShortcuts " value = " true " />
 
Note: These keys are not published to the users.
 
Key
Description
EnterpriseVault_LogEnabled
Set to “true” to enable logging for Enterprise Vault HTTP module. Defaults to “false”.
EnterpriseVault_LogFolder
Defaults to "\SharePoint Logs\" Note trailing backslash
EnterpriseVault_UsersToLog
A comma delimited list of users to generate logs for. Empty or null means all users. Defaults to all users.
EnterpriseVault_LogFileVersions
An integer that is the number of log files to keep per user, defaults to 12 with a max of 120 and a min of 1.
EnterpriseVault_IndexShortcuts
When set to “false”, and the MS Search crawler hits upon a Enterprise Vault shortcut, the content of the same will not be fetched from the archive. This will result in the item being indexed with just its metadata and not it’s content by the MS Search Crawler.
 
5)     The Enterprise Vault HTTP module requires the following assemblies to be present in the Global Address Cache (GAC):  
- KVS.EnterpriseVault.Interop.AdminService
- KVS.EnterpriseVault.Interop.EVContentManagementAPI
- KVS.EnterpriseVault.HttpModule
- Microsoft.SharePoint assemblies  
6)     To check the working of the Enterprise Vault HTTP module, check if you can access a document or attachment converted to shortcut by Enterprise Vault in SharePoint. You can also enable logging for the Enterprise Vault HTTP module using the application settings and check the logs.  

Enterprise Vault Custom Web Service

1)     Determine the SharePoint root folder by reading the following registry key: SOFTWARE\Microsoft\Shared Tools\Web Server Extensions\\Location, where is the version of SharePoint. For WSS 3.0 or MOSS 2007 it is 12.0, and for SharePoint 2010 it is 14.0.  
2)     Open the SharePoint root folder in Windows Explorer and check that the following files exist in the subfolder ISAPI:
- EVCustom.asmx
- EVCustomdisco.aspx
- EVCustomwsdl.aspx  
3)     For any Web application that is added as a target in Enterprise Vault, determine the site url within it. In the Web browser, attempt to open [Site url/_vti_bin/EVCustom.asmx]. This should return a list of functions available in the Web Service.

 

Issue/Introduction

How to check that the Enterprise Vault SharePoint components are installed and configured on the SharePoint Web FrontEnds.
Powered by Wolken Software