

Scripts are Relativity artifacts. This means they have the same features as standard Relativity objects, allowing them to be secured and audited.
Note: Relativity Scripts are a tool to access and modify data stored in Relativity SQL databases. Not all data is available in SQL, and data currently in SQL may be migrated to other storage systems. The recommended integration mechanism is to use APIs/Services instead of scripts to avoid future migration or interruption.
You should only use scripts when an appropriate API is not available. Relativity will add new and updated APIs over time - review the available APIs periodically to determine if you can replace a script with an API or REST service call.
If a script is locked, it appears as read only, and you can't edit it. If a script is unlocked it's available for editing.
The following table represents the script permissions allowed for each group.
Locked Script | Unlocked Script | |||||||
---|---|---|---|---|---|---|---|---|
View | Run | Edit | Preview | Edit | Preview | Write | Link | |
System Admin | x | x | x | x | x | x | x | |
Standard User | x* | x* | x** |
* With view rights
** With add rights
You're a system admin and you've been facilitating a document review project for your client, a large construction company, who’s involved in litigation regarding the use of materials that they weren’t informed were potentially environmentally damaging when they purchased them from a major supplier.
This morning you learned that the other party involved in this litigation, the material supplier, provided evidence that they weren’t actually responsible for supplying your client with one of the materials in question, namely the asphalt your client used to pave the driveways in a housing development. You immediately performed a mass operation to remove all documents from the issues view that had been tagged with the “Asphalt” choice so that reviewers didn't waste any more time on those documents in a second-pass review.
Because the same documents you removed were part of at least two separate dtSearch indexes you set up for reviewers, you now need to perform an incremental build on those indexes, as well as any others you may have altered when you performed the mass delete. There's a script for that called dtSearch Index Auto Incremental Build. You go to the Scripts tab, find it in the Relativity Script Library, and run it.
All dtSearch indexes that once returned documents containing references to the inappropriately associated term are removed.
To improve system performance, architecture improvements are often applied to Relativity’s SQL tables for new versions.
When upgrading, your personally-created scripts must be tested and revalidated before you run them. Remember that the recommended integration mechanism is to use APIs instead of scripts to avoid potential disruption if the data schema or storage mechanism changes.
When upgrading your environment, the unique script key is referenced to determine if an update is required. If so, this is performed automatically.
Due to the complexity and impact a script can have, only Relativity, SQL, and XML expert users should create and run them.
To select a library script and add it to your workspace, perform the following steps:
You must set the AllowAddOrEditScripts instance setting to True to make the Create New Workspace Script option available.
Due to the complexity and impact a script can have, only Relativity, SQL, and XML expert users should create and run them.
To create a new workspace script, follow these steps:
In order for scripts to appear in your Script tab for your users to run, you must add them. To add a library script to the Script tab, follow these steps:
To run a script, follow these steps:
Why was this not helpful?
Check one that applies.
Thank you for your feedback.
Want to tell us more?
Great!