CleanSPDA

Scope
Intended Audience
All  
CommVault Internal  
CE/System Test X
Development  

Platform
  • SharePoint DataArchiver

Release
  • 8.0.0

Description
SharePoint DataArchiver Cleanup Tool

This is a tool to clean up certain custom list columns created by Commvault Qinetix Sharepoint Data Archiver Product.
currently, two columns, "Archived" and "Commvault Stub", are created on every sharepoint list (docLibrary, PicLibrary etc)
processed by the DataArchiver. On uninstall of the DataArchiver product, these columns are not removed by the uninstaller
automatically. CleanSPDA tool provides this facility as a command line utility.

Usage
The usage of cleanSPDA.exe is as:
CleanSPDA [-force] [ [-vs <vs url>] | [-site <site url>] | [-web <web url>]] [-lib <library name>] [-col <column name>] [-log <logfile path>]

The parameters are:

-force : optional; if specified, will process non-empty lists; by default, non empty lists are skipped.

target options: The following mutually exclusive three options provide the tool with the starting point of processing
-vs <vs url> : optional; specifies a virtual server; All lists contained by this virtual server will be processed;
-site <site url> : optional; specifies a TopLevel Site collection; All lists contained by this sitecoll will be processed;
-web <web url> : optional; specifies a subsite; All lists contained by this subsite will be processed;

If none of the above target options are specified, then the entire webserver will be processed.

-lib <library name> : optional; specifies a sharepoint list to be processed; if not specified, all lists will be processed.

-col <column name> : optional; specifies the column names to remove; multiple -col instances can be specified; if not specified, defaults to the columns "Archived" and "Commvault Stub".

-log <logfile path> : optional; specifies the full path of the log file created; if not specified the logfile used is ./cleanSPDA.log

Special Notes for SharePoint V3/MOSS 2007
If this tool is being installed on a sharepoint platform built on .Net Framework 2.0,the file CleanSPDA.exe.config
also needs to be copied into the folder where the binary CleanSPDA.exe is placed.

If this tool is being installed on a sharepoint platform built on .Net Framework 1.x, then CleanSPDA.exe.config should
not be present at the folder where the binary CleanSPDA.exe is placed.

History
Revision Date Description
Revision 1 April 13, 2007 8.0.0 version

Disclaimer of Warranties

CommVault provides software tools and utilities on an "as is" basis, as a courtesy and convenience to its users, and they may be changed from time to time without notice. These tools and utilities are provided without express, implied, or statutory warranties of any kind. You assume full risk and responsibility for the selection, possession, performance and proper installation and use of the software tools and utilities, and for verifying the results obtained there from. Your use of CommVault software tools and utilities indicates your unconditional acceptance of the above disclaimer.