Production gap and overlap check

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 Production Gap and Overlap Check solution checks Bates numbers in a production set for gaps or overlaps.

This page includes the following sections: 

Before you begin

The Production Gap and Overlap Check solution checks Bates numbers in a production set for gaps or overlaps. The script looks at the ProductionDocumentFile Bates number field instead of the Document Beg Bates and End Bates. The Saved Search Gap and Overlap Check script looks at the Document.

The performance of the script depends on the number of documents in a production and the type of documents (native vs. image).

Supported versions

This solution is supported in Relativity 9.2 and above.

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

Solution version Supported Relativity version
3.2 9.3+
3.0 9.3
2.1 9.2

Components

This solution consists of a Relativity script that runs at the workspace level.

Special considerations

  • 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.
  • The script assumes that all the documents within a production have the same prefix.
  • For native-only productions, the Bates numbers are only stored in the Beg Bates and End Bates fields. If these fields are overwritten, the report doesn't provide the correct results.
  • Any Bates numbers that are not in the format of letters followed by numbers aren't included when determining gaps and overlaps.
  • This solution doesn't support the client domains (multi-tenancy) and Data Grid features of Relativity.

Deploying and configuring the solution

To install the Relativity application to the library, complete the following:

  1. Log in to Relativity.
  2. Click the Applications & Scripts tab, and then click the Application Library tab.
  3. Click the Upload Application button
  4. Click Browse… for the Application File field
  5. Select the location of the Production Gap and Overlap Check.rap file, and then click Open.
  6. Click Save.
  7. In the Workspaces Installed section, click Install.
  8. In the Workspaces section, click the ellipsis (…) button
  9. In the pop-up window, select the desired workspace(s), and then click Ok.
  10. Click Save.

Running the solution

After you prepare the workspace, you can configure and run the solution by doing the following:

  1. In the workspace, click the Administration tab, and then click the Scripts tab.
  2. Click the name of the Production Gap and Overlap Check script.
  3. In the Production drop-down field, click the name of the production you wish to check for gaps and overlaps.
  4. Click Run.

Viewing the results

After you run the solution using the Production Gap and Overlap Check script, the results appear as a report on the script page.

An example of the Production Gap and Overlap Check script report with sample data.

The following table lists and describes the columns in the report:

Column Description
Begin Range The range start.
Finish Range The range end.
Type Gap or Overlap.