Last date modified: 2026-Oct-07
Scripts retirement
Relativity aiR is retiring its scripts framework, a legacy extensibility mechanism that allows customers to execute SQL-based scripts.
This retirement is being executed through customer account waves, and customers who use scripts will keep access to them until their retirement wave arrives. Each wave will be announced at least 90 days before it takes effect.
In addition, Relativity aiR is developing new and enhanced APIs and dedicated 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 will no longer be available. Note that creating new scripts with the names of those listed below is prohibited.
| Script | Notes |
|---|---|
| Upgrade Legacy Applications | This script is not fully functional in Relativity aiR. |
| Report sample-based statistics | This script is not fully functional in Relativity aiR. |
| Telemetry Smoke Test | This script is not fully functional in Relativity aiR. |
| Case Dynamics - Convert UTC format | This script is not fully functional in Relativity aiR. |
| Case Dynamics - Read Case Dynamics settings | This script is not fully functional in Relativity aiR. |
| Monitor Cluster Upgrade Jobs | This script is not fully functional in Relativity aiR. |
| Remove Unnecessary Search Provider From Saved Searches | This script is not fully functional in Relativity aiR. |
| Create Cluster Upgrade Jobs | This script is not fully functional in Relativity aiR. |
| Relativity SMTP Configuration | This script is not fully functional in Relativity aiR. |
| Workspace Upgrade Status | This script is not fully functional in Relativity aiR. |
| Imaging Set Scheduler | This script has been replaced by Automated Workflows. |
| Set Native Time Zone Offset with DST | This script is not fully functional in Relativity aiR. |
| Admin Groups Permissions | The Permissions API is available for users to pull all permissions assigned to a group. |
| Set Production Beg-End Attach Fields | This script has been replaced by a built-in feature within Production Sets. For details, see Production Sets. |
| Collect Folder Path Data Script | The related application is deprecated. |
| Remove Documents from Batch Sets | This has been replaced by Batch Set Cleanup and eventually will be part of Review Center. |
| Case Metrics Script | This script has been replaced by Case Metrics. |
| Track Document Field Edits by Reviewer Script | This script is not fully functional in Relativity aiR. |
| Get database size | This script is not fully functional in Relativity aiR. |
| Environment-Level User Login & Workspace | This script is not fully functional in Relativity aiR, and is scheduled for deprecation. Similar data can be found in the Audit API. |
| Login History by User Report | This script is not fully functional in Relativity aiR. |