

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 Collect Folder Path Data solution reports the total number and size of document files, including native, image, and production files, that are in each workspace and folder in a Relativity instance.
To download the solution files, visit the Relativity Community.
The Collect Folder Path Data solution is an environment-level solution that collects and reports the total number and size, in gigabytes (GB), of document files in a Relativity instance. The report organizes data by workspace and folder, and, for each folder, provides details such as the total number of native, image, and production files within the folder as well as the total size of those files.
This solution consists of the following components:
Before you deploy and run the solution, it's important to keep the following in mind:
Note: If your environment has a version of Collect Folder Path before version 6.0, please uninstall the older version from each workspace and environment prior to installing version 6.0.
To deploy and configure the solution, perform the following:
In Solution Version 7.0 or above, specific workspaces can be skipped by the application by adding them to a blacklist. To accomplish this, you will need to update data on the SQL server of the environment. To skip certain workspaces, do the following:
INSERT INTO [EDDS].[eddsdbo].[KCD_1037595_WorkspacesToExcludes] (WorkspaceArtifactID) VALUES(/* comma separated workspace Artifact IDs */)
To begin using this solution, download and add it to the Application Library as a Relativity application.
To download the application:
Log in to the Relativity Community, and click on the Relativity Applications folder.
Locate the newest Collect Folder Path Data .rap file that is compatible with your version of Relativity and select it.
Note: The solutions in the Relativity Applications folder are sorted from most recently modified to oldest. As a result, solutions at the top of the page are normally the newest versions of the respective solutions. If you see more than one version of the solution, select the .rap file with the higher version number to ensure you're deploying the most up-to-date solution.
Click Download.
To add the solution to the Application Library:
After you add the solution to the Application Library and install it in a workspace, you're ready to create and enable a Folder Path Manager agent, which monitors data collection tasks for the solution, and one or more Folder Path Worker agents, which collect data about folders and files. Note that only one Folder Path Manager agent can be installed at a time. To optimize solution performance however, you can create and enable multiple Folder Path Worker agents.
To create and enable the Folder Path Manager agent:
Note: We recommend you adjust the agent run interval to execute once a day, or every 86400 seconds.
To create and enable a Folder Path Worker agent:
You can run the Collect Folder Path Data script from administration mode for the Relativity instance the workspace where you installed the solution application.
To check the job status of the Folder Path Worker agent, complete the following:
The Worker Queue page displays the current job status for each workspace that the Folder Path Worker agent is processing.
After the job status is "Completed" for each workspace, you can run the Collect Folder Path Data script by performing the following steps.
After you run the solution, the results appear as a report on the modal.
The report provides detailed information about the number and size of document files that are in each workspace and folder in the Relativity instance, minus any excluded workspaces. It includes the following columns:
Why was this not helpful?
Check one that applies.
Thank you for your feedback.
Want to tell us more?
Great!