Symantec Compliance Accelerator (tm) and Discovery Accelerator (tm) CheckSearches Utility

Article:TECH72848  |  Created: 2009-01-28  |  Updated: 2009-01-17  |  Article URL http://www.symantec.com/docs/TECH72848
Article Type
Technical Solution

Product(s)

Environment

Issue



Symantec Compliance Accelerator (tm) and Discovery Accelerator (tm) CheckSearches Utility

Solution



About CheckSearches
An issue in Enterprise Vault may cause searches conducted with Compliance Accelerator or Discovery Accelerator to return more results or fewer results than expected. The CheckSearches utility identifies these searches.  Using the original search as template, any affected search can be run again if necessary.

Please refer to the related documents section for more information and details of the issue.

Installing and running CheckSearches
CheckSearches requires version 2.0 or later of the Microsoft .NET Framework.

To install and run CheckSearches
1. Log in to the Accelerator server as a user with permission to access the Accelerator databases. For best results, it is recommended to run the CheckSearches utility under the Vault Service account.

2. Copy the supplied files (CheckSearches.exe, CheckSearches.exe.config, ChunkingAnalysis.dll, and ReadMe.htm) into the Business Accelerator program folder on the Accelerator server. (This folder is typically C:\Program Files\Enterprise Vault Business Accelerator).

3. Stop the Enterprise Vault Accelerator Manager service.

4. Open a Command Prompt window.

5. Change to the Business Accelerator program folder by typing a command like the following:
cd C:\Program Files\Enterprise Vault Business Accelerator

6. Type the following command, and then press Enter:
CheckSearches optional_parameters
See the next section for a description of the available parameters. If no parameters are entered, CheckSearches displays a series of prompts for the required information.

7. When CheckSearches successfully finishes, close the Command Prompt window.

8. Start the Enterprise Vault Accelerator Manager service.

CheckSearches syntax
CheckSearches [-A] [-C:CustomerID] [-ChunkSize:Size] [-G] [-I] [-L:LogFile] [-O] [-U] [-?]

The parameters are as follows:
 
ParameterFunction
-ASpecifies that you want CheckSearches to display and log all searches, regardless of whether they have potential issues. If you omit this parameter, only those searches in which there are potential issues are displayed and logged.
-C:CustomerIDProvides the numeric identifier of the Accelerator customer that you want to check. If you run CheckSearches without any parameters then, when prompted for a customer ID, you can type ? to list all the customer names and identifiers.
-ChunkSize:SizeSets the size of the search chunk to use. The default is 5000 words but this may have been altered via a registry change. Please refer to 328977 in the related documents for details.
-G(Compliance Accelerator only.) Instructs CheckSearches to check all the runs of guaranteed sample searches. If you omit this parameter, CheckSearches checks the template criteria on which the guaranteed sample searches are based but does not check the runs of those searches.
-IInstructs CheckSearches to check all the runs of scheduled searches. If you omit this parameter, CheckSearches checks the template criteria on which the scheduled searches are based but does not check the runs of those searches.
-L:LogFileSpecifies the name of the log file in which to record the activities of CheckSearches. The default file name is CheckSearches.log. If you omit this parameter, CheckSearches does not create a log file.
-OOverwrites the log file, if it exists. If you omit this parameter, and the log file exists, CheckSearches displays an information message and stops.
-UIgnores searches in closed departments or cases. By default, CheckSearches does not ignore these searches.
-?Displays online help on CheckSearches.


Examples
1. The following command checks the searches for the customer with the numeric identifier 2.
   CheckSearches -C:2

2. The following command checks the searches for customer 2 and creates a log file called Result_C2.log. This file overwrites any existing log file of the same name.
   CheckSearches -C:2 -L:Result_C2.log -O

3. The following command performs the same function as the previous command, but it uses a smaller search chunk size (1000 words rather than 5000). In addition, the command displays and logs only those searches in which there are potential issues, checks all the runs of both guaranteed sample searches and scheduled searches, and ignores searches in closed departments or cases.
 CheckSearches -C:2 -L:Result_C2.log -O -ChunkSize:1000 -A -G -I -U


Example Log File showing a possibly affected search

The tool will run using the following options:

The customer selected is                                  : 7 (EVBADiscovery DB: EVBADiscovery)
Log File                                                           : C:\SearchTool.Log
Override log file                                                : No
Chunk Size                                                      : 5000
Check run of schedule searches                        : Yes
Check run of guaranteed sample searches          : Yes
Exclude closed case/departments                     : Yes
Show Only potential affected searches               : No


8/6/2009 9:37:59 AM Starting ...
Search 'November 3rd 2008 Search' ID='1' In Case 'Case1' is not affected (using original search criteria)
.
.
.

Search '2400 Targets' ID='40' In Case 'Case3' is not affected (using original search criteria)
 
Search 'Large Target group with Hotword' ID='49' In Case ID=9 - 'Case3' has potentially returned more results than expected (using original search criteria) current number of hits: 1445 >
Search 'Large Target Group Search' ID='50' In Case 'Case3' is not affected (using original search criteria)
 
Search 'Quick Check' ID='70' In Case '1 Vault Case' is not affected (using original search criteria)
 
Search 'Search Dtrace' ID='72' In Case '1 Vault Case' is not affected (using original search criteria)
 
Search '1 hit wonder' ID='77' In Case '1 Vault Case' is not affected (using original search criteria)

55 searches were checked.
There is 1 search which may have returned more results than expected.
Finished successfully.
Writing Log file...

Note:  Depending on the size of the environment, the CheckSearches utility can take several hours to complete.
__________________________________________________________________________________

Attachments

check_searches_tool_328987.zip (81 kBytes)

Supplemental Materials

SourceETrack
Value1470425

SourceETrack
Value1478265


Legacy ID



328987


Article URL http://www.symantec.com/docs/TECH72848


Terms of use for this information are found in Legal Notices