Copy redactions across workspaces

The Copy Redactions Across Workspaces solution copies redactions placed on images from a source markup set to a destination markup set in a separate workspace. This solution does not copy redactions to native files.

To download the solution files, visit the Relativity Community.

This page includes the following sections:

Before you begin

The Copy Redactions Across Workspaces solution copies redactions from a source markup set to a destination markup set in a separate workspace. The solution does not remove original redactions. It only appends new ones to the selected destination set.

Supported versions

This script is supported in Relativity 8.0 – Server 2023 and RelativityOne.

Solution version Supported Relativity version
4.4.0.1 9.4.254.2 - Server 2023, RelativityOne

Components

This solution consists of the following components:

  • Relativity scripts that run at the workspace level.
  • Relativity script that runs at the admin level.

Considerations

  • These scripts should only be run by a system admin. If you are not a system admin, we recommend you do not run these scripts.
  • The results of the script cannot be undone. We recommend that you create a back-up copy of all redactions before you run the solution.
  • If there are no redactions in the selected markup set for the Source Markup Set input, no documents are affected.
  • The saved search used as inputs to the Read Source Markup Set script and Write Destination Markup Set script needs to have images. Otherwise no documents are affected.
  • This solution doesn't support the client domains (multi-tenancy) and Data Grid features of Relativity.

Deploying and configuring the solution

To deploy the solution, you first add it to the Application Library as a Relativity application. You can then install it from the Application Library to one or more workspaces.

Note: This script runs from the Admin level, you must install this application into a workspace for it to appear in the Script Library (at the instance level).

To add the solution to the Application Library:

  1. Log in to Relativity.
  2. Navigate to the Application Library tab.
  3. Click New Library Application.
  4. Either click Select File, or drag and drop the file into the Application.
  5. Navigate to and select the application file included in the solution, and then click Open.
  6. Click Save to upload the file to the Application Library.

To add the solution to a workspace:

  1. In the Workspaces Installed section, click Select to install the application to one or more workspaces.
  2. Select the workspace(s) where you want to install the application, and then click the Move selected left to right icon.
  3. Click Apply.
    The application is installed to the selected workspace(s). A list of workspace(s) where the application has been installed displays in the Workspaces Installed section.

Installing the Read Source Markup Set script

Install the Read Source Markup Set script to the workspace you want to copy redactions from.

  1. Navigate to the workspace which you are copying redactions from.
  2. Navigate to the Scripts tab.
  3. Click New Relativity Script.
  4. Next to Script Type, click Select from Script Library.
  5. Next to Scripts, click Select.
  6. Select the Copy Redactions Across Workspaces - Read Source Markup Set script from the list.
  7. Click Set.
  8. Click Save.

Installing the Write Destination Markup Set script

Install the Write Destination Markup Set script to the workspace you want to copy redactions to.

  1. Navigate to the workspace which you are copying redactions to.
  2. Navigate to the Scripts tab.
  3. Click New Relativity Script.
  4. For the Script Type field, click Select from Script Library.
  5. For the Relativity Script field, click Select.
  6. Select the Copy Redactions Across Workspaces - Write Destination Markup Set script from the list.
  7. Click Set.
  8. Click Save.

Running the solution

After you prepare the workspaces, you can configure and run each solution in its respective workspace.

Note: There should only be one instance of the solution running at a time. If you run multiple instances of the solution at the same time, the results may be unreliable.

Running the Setup script

The Copy Redactions Across Workspaces - Setup script only needs to be run once to begin using this application.

  1. At the instance level, navigate to the Relativity Script Library tab.
  2. Find and select Copy Redactions Across Workspaces - Setup from the list.
  3. Click Run Script.

Running the Read Source Markup Set script

Run the Read Source Markup Set script in the workspace which you are copying redactions from.

  1. In the workspace which you are copying redactions from, navigate to the Scripts tab.
  2. Click on the name of the Copy Redactions Across Workspaces - Read Source Markup Set script.
  3. Complete the following fields:
    • Source Document Set – select the saved search that contains a list of documents you wish to execute upon.
    • Doc Identifier – select the fixed-length text field that contains the Document Identifier field.
    • Source Markup Set – select the markup set field that you would like to copy the redactions from.
  4. Click Run.

Running the Write Destination Markup Set script

Run the Write Destination Markup Set script in the workspace which you are copying redactions to.

  1. In the workspace which you are copying redactions to, navigate to the Scripts tab.
  2. Click the name of the Copy Redactions Across Workspaces - Write Destination Markup Set script.
  3. Complete the following fields:
    • Dest. Document Set – select the saved search that contains a list of documents you wish to execute upon.
    • Doc Identifier – select the fixed-length field that contains the Document Identifier field.
    • Dest. Markup Set – select the markup set field that you would like to copy the redactions to.
  4. Click Run.

Note: Doc Identifier fields for both the source and destination workspaces need to contain identical values in order to copy all redactions.

Viewing the results

After you run the solution by running the Read Source Markup Set script, the results appear as a report on the script page. The report includes a list that indicates how many markup sets have successfully been copied.

The Copy Redactions Across Workspaces - Read Source script report indicating that six markup sets were copied successfully.

After you run the solution by running the Write Destination Markup Set script, the results appear as a report on the script page. The report includes a list that indicates how many markup sets have successfully been copied.

The Copy Redactions Across Workspaces - Write Destination script report indicating that six markup sets were copied successfully.