Workspace folder group security

Note: 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 Workspace folder group security solution provides a script that reports on the security permissions for each folder in the Document object.

This page contains the following sections:

Before you begin

Supported versions

This solution is supported in Relativity 8.2 – 10.3, RelativityOne.

Note: Some versions of this application may not be eligible for support by Customer Support. For more information, see the Version support policy.

Click on this link to download the appropriate version from the Relativity Community:

Solution version Supported Relativity version
1.0 8.2 - 10.3, RelativityOne


This solution consists of a Relativity script that runs at the workspace level. This script should only be run by a system admin. If you are not a system admin, we recommend you do not run this script.

Deploying and configuring the solution

Complete the following steps to add this solution to the Relativity Script Library:

  1. Open a text editor or a similar application.
  2. Open the Workspace Folder Group Security v. 1.0.rap file. The solution includes this file.
  3. Select and copy all the text from the file to your clipboard.
  4. Log in to Relativity.
  5. Navigate to the Relativity Script Library tab.
  6. Click New Relativity Script.
  7. In the Script Body section, delete all the text in the script field. Paste the text that you copied from the v 1.0.rap file.
  8. Click Save.

Note: This solution is available as an application. If you are upgrading from a script version of the solution to an application version of the solution, you must delete the original script before adding the new application to your environment and installing it to a workspace.

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: If this script is run from the Admin level, you must install this application into a workspace for it to appear in the Script Library.

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. Click Select file on the Application File field.
  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. Click Select in the Workspaces Installed section to install the application on workspaces.
  2. Select the desired workspaces in the Select Workspaces dialog and click Apply.

These workspaces now contain the application. Relativity lists the workspaces in the Workspaces Installed section on the detail view of the application.

Preparing the workspace

  1. Navigate to the workspace where you want to run the solution.
  2. Navigate to the Scripts tab.
  3. Click New Relativity Script.
  4. Click Select from Script Library in the Script Type field.
  5. Select the Workspace Folder Group Security v. 1.0. script. Click OK.
  6. Click Save.

Running the solution

After preparing the workspace, you can configure and run the solution.

Complete the following steps to run the solution:

  1. In the workspace, navigate to the Script tab.
  2. Click the name of the Workspace Folder Group Security v. 1.0 script.
  3. Click Run Script.
  4. Click Run.

Viewing the results

After you run the script, the results appear as a report.

The following table describes the columns in the report:

Column Definition
Folder Name The name of the folder.
Folder Path The path to the folder.
Security Inherited or Override.
Groups The user groups the folder belongs to.