Deletion Tool

As an administrator, it is important to keep the projects updated with only the required documents and delete the documents that are not required. When there are many documents in the collections that must be deleted in the IBM Watson Discovery V2 instance, there is a need to automate deletion. Deletion tool automatically deletes the documents from the collections in the IBM Watson Discovery V2 instance. 

For example, Jordan, an administrator, observes that a web crawler has created several documents in multiple collections in the IBM Watson Discovery V2 instance. All these documents are not useful and need to be deleted. Because there are too many documents and manual deletion would take time, Jordan uses the Deletion tool to remove the documents from the project. 

The Deletion tool performs the following two functions:

• Get the details of the documents from IBM Watson Discovery V2 instance. Document details including documentID, collectionID, and source URL.
• Delete the documents in the collection. 

You must know the documentID of the document that needs to be deleted. You can either manually search for the documentIDs  or you can run the Deletion tool to automatically get the documentIDs for all the documents in the collection. You can run the tool multiple times to get the list of documentIDs.

The Deletion tool deletes the documents in chunks. You can configure the number of documents to be deleted. For example, you can configure the Deletion tool to delete 100 documents at a time.

Before you begin

Make sure that you have completed the following tasks:

To delete the documents in the IBM Watson Discovery V2 instance collection

1. Get the list of document IDs using the Deletion tool, perform the following steps. Refer to the Properties filetable.
   
   1. In the properties file (refer to the Properties filetable and sample files), specify the values for the following parameters: 
      • documentIdsFile = <filename>.txt
      • filterPattern = SharePoint URL 
      • saveDocumentIdsToFileKey = Y 
      • responseFilenameKey = <filename>.json 
   2. Run the POST request on the IBM Watson Discovery V2 instance.
      The POST request returns documents that match the filter criteria.
      The Deletion tool writes document details in response.json.
      The Deletion tool writes the document IDs to <filename>.txt specified in the documentIdsFile parameters.
2. Modify the properties files. Refer to the Properties filetable and sample files.
3. Download the Deletion Tool jar file.
4. Ensure that the Java archive and its files are in the same folder.

5. Open command prompt and run the JAR file.

   java -DdeletionToolPropertyFile=<sample-deletionTool-file>.properties -jar com.bmc.dsm.DeletionTool-99.0.00-SNAPSHOT.jar

   When you run this command after getting the list of IDs, the documents are deleted.

Properties file

Following table describes the files and its attributes that are required to run the Deletion tool. You must set the attributes in the properties before running the Deletion tool.