Last date modified: 2026-Oct-27

Scripts retirement

Relativity aiR is retiring its scripts framework, a legacy extensibility mechanism that lets customers run SQL-based scripts directly from the Relativity UI. Scripts expose the platform’s internal database implementation. Retiring them allows Relativity to modernize the underlying architecture and improve performance.

The retirement is happening in customer account waves. Some accounts that did not use scripts have already had the framework removed. If your account uses scripts, you'll keep retain until your wave arrives. Relativity announces each wave at least 90 days before it takes effect.

Relativity is also building new and enhanced APIs and native features to replace scripts in the most common SQL-dependent workflows.

For more details, see the Relativity Scripts Deprecation FAQ on the Community.

What is being removed

The following components of the scripts framework will be removed from your environment when your retirement wave arrives:

  • UI tabs - Relativity Script Library and Scripts
  • Agents - Script Run Manager and Script Clean Up Agent
  • Service - Scripts Manager service

Relativity-authored scripts no longer available

Relativity-authored scripts are to be removed independently of retirement waves.

As part of this retirement, the following deprecated scripts are no longer be available.

Creating new scripts with the names of those listed below is prohibited.
Script Status Notes
Admin Groups Permissions Deprecated The Permissions API is available for users to pull all permissions assigned to a group.
Case Dynamics - Convert UTC format Deprecated This script is not fully functional in Relativity aiR.
Case Dynamics - Read Case Dynamics settings Deprecated This script is not fully functional in Relativity aiR.
Case Metrics Script Deprecated This script has been replaced by Case Metrics.
Create Cluster Upgrade Jobs Deprecated This script is not fully functional in Relativity aiR.
Collect Folder Path Data Script Deprecated The related application is deprecated.
Environment-Level User Login & Workspace Deprecated This script is not fully functional in Relativity aiR. Similar data can be found in Audit.
Get database size Deprecated This script is not fully functional in Relativity aiR.
Imaging Set Scheduler Deprecated This script has been replaced by Automated Workflows.
Login History by User Report Deprecated This script is not fully functional in Relativity aiR.
Monitor Cluster Upgrade Jobs Deprecated This script is not fully functional in Relativity aiR.
Relativity SMTP Configuration Deprecated This script is not fully functional in Relativity aiR.
Remove Unnecessary Search Provider From Saved Searches Deprecated This script is not fully functional in Relativity aiR.
Remove Documents from Batch Sets Deprecated This has been replaced by Batch Set Cleanup and eventually will be part of Review Center.
Report sample-based statistics Deprecated This script is not fully functional in Relativity aiR.
Set Native Time Zone Offset with DST Deprecated This script is not fully functional in Relativity aiR.
Set Production Beg-End Attach Fields Deprecated This script has been replaced by a built-in feature within Production Sets. For details, see Production Sets.
Telemetry Smoke Test Deprecated This script is not fully functional in Relativity aiR.
Track Document Field Edits by Reviewer Script Deprecated This script is not fully functional in Relativity aiR.
Upgrade Legacy Applications Deprecated This script is not fully functional in Relativity aiR.
Workspace Upgrade Status Deprecated This script is not fully functional in Relativity aiR.
Feedback