Remove documents from batch sets

Note: Some of the recipes listed below now exist as knowledge base articles on the Relativity Community. When you click those links, you must enter valid Community credentials to access those articles. The remaining recipes will soon be integrated into their corresponding feature documentation so that they'll show up either as new topics or new headings within existing topics. Once this relocation is complete, we will be deprecating this home page, and all of the content below will be accessible via search on our sites.

You must have valid Relativity Community credentials in order to download any Community file linked to the documentation site. You'll need to enter those credentials on the Community login screen if you're not already logged in. If you're already logged in to the Community at the time you click a link, the file is automatically downloaded in the bottom left corner of your screen. If you get an error message stating "URL No Longer Exists" after clicking a Community link, it may be due to a single sign-on error related to the SAML Assertion Validator, and you should contact your IT department.

The Remove documents from batch sets solution removes all documents within a saved search of each batch set you specify.

This page contains the following sections:

Before you begin

This Relativity application removes all documents within a saved search of any batch set you identify while running the solution. Review the following information before proceeding:

Supported versions

This solution is supported in Relativity 8.2 - Server 2021, RelativityOne.

Click on any of these links to download the appropriate version from the Relativity Community:

Solution version Supported Relativity version
4.1.0.0 RelativityOne
3.6 8.2 - 9.2, 9.3.389.9 - Server 2021
2.1 7.5 - 8.2

Components

This solution consists of the following components:

  • Console event handler
  • Manager agent
  • Worker agent
  • Custom job RDO
  • Custom page
  • Relativity application

Considerations

  • When using a batch set with auto-batch enabled, ensure batching completes before using the batch set with this solution.
  • Purging a batch set or the records from a job, while it’s in progress, results in an error.
  • Selecting a saved search that contains no documents results in a job with an error status.
  • Custom components may not exhibit the same performance and behavior as native Relativity features.
  • While each solution is carefully built and thoroughly tested to work on your version of Relativity, they aren't considered core features, and aren't eligible for the same level of support as the Relativity platform.

Deploying and configuring the solution

To deploy and configure the Remove documents from batch sets solution in your workspace, you must perform the following steps:

  • Add the application to your application library.
  • Install manager and worker agents.
  • Install the application to your workspace.

Add application to the application library

To add the new application to your application library, perform the following steps:

  1. Log in to Relativity.
  2. Navigate to the Application Library tab from Home.
  3. Click Upload Application.
  4. Click the ellipsis next to Application File.
  5. Select the file RA_KCD_1041305RemoveDocsFromBatchSets.rap, and then click Open.
  6. Click Save.

Install Relativity application to workspace

To install the application to your workspace, perform the following steps:

  1. Log in to Relativity.
  2. Navigate to the Application Library tab from Home.
  3. Select the application KCD_1041305.RemoveDocsFromBatchSets.
  4. Click Install under Workspaces Installed.
  5. Click the ellipsis next to Workspaces and select one or multiple workspaces.
  6. Click OK, and then click Save.

Install manager and worker agents

To install the required manager and worker agents, perform the following steps:

  1. Navigate to the Agents tab from Relativity Home, and then click New Agent.
  2. Click the ellipsis next to Agent Type.
  3. Locate the RDFB Manager agent, select the radio button, and then click OK.
  4. Click the ellipsis next to Agent Server.
  5. Select the agent server on which you want the agent to run, and then click OK.
  6. Set the Run Interval to 5.
  7. Set the Logging level to the desired logging level.
  8. Set Enabled to Yes.
  9. Click Save. The agent appears in the Agents tab with the name RDFB Manager.
  10. Repeat the same process to add the RDFB Worker agent.

Note: This solution supports a maximum of 10 manger agents and 10 worker agents.

Running the solution

To run the solution in your workspace, perform the following steps:

Create a new job

  1. Navigate to the KCD_1041305.RemoveDocsFromBatchSets tab in your workspace.
  2. Click New RDFB Job.

Configure the job

  1. Select the job you created.
  2. Click Configure Job on the Manage Job console.
  3. Select the saved search containing the documents you want to remove.
  4. Select the batch sets you want those documents removed from.
  5. Click Save.
  6. Submit the job.

3.1.1 Canceling a job

The Cancel Job button enables on the Manage Job console whenever the current job is in progress. When you click Cancel Job, the agent finishes its current batch of up to 25,000 documents before fully canceling the job.

3.1.2 Purging a job

The Purge Job button enables on the Manage Job console whenever a job’s status is Ready, Completed, or Error. When you purge a job, the records from the tables associated with the job delete.

Viewing the results

The job is finished when its status updates to Complete.

The results display in the Message field of the job custom object you created. Results don't display until the job status is marked Ready. Click into a specific job and Refresh the page to update the results.

The following information is displayed in the results window:

(Click to expand)

Support

For additional assistance, contact Relativity Client Services at support@relativity.com.

Disclaimer

This script is intended for use only in the Relativity versions specified in this document and run under the guidelines presented. While each solution is carefully built and thoroughly tested to work on the versions of Relativity specified in this document, this script is not a core feature of Relativity and is not eligible for the same level of support as the Relativity platform.

In addition, custom components may not exhibit the same performance and behavior as native Relativity features. Custom solutions do not specify permission settings unless explicitly requested by the client.