{"id":1077,"date":"2023-04-18T15:16:56","date_gmt":"2023-04-18T15:16:56","guid":{"rendered":"https:\/\/www.oasisdiscovery.com\/ediscovery-unredacted\/?p=1077"},"modified":"2023-04-18T15:19:17","modified_gmt":"2023-04-18T15:19:17","slug":"intro-to-relativity-scripting","status":"publish","type":"post","link":"https:\/\/www.oasisdiscovery.com\/ediscovery-unredacted\/ediscovery\/intro-to-relativity-scripting\/","title":{"rendered":"Intro to Relativity Scripting"},"content":{"rendered":"\n

The content of this blog post was originally posted in the Relativity community<\/a> by Jarrod Kimmel, Oasis VP of Engineering, in response to a user asking for advice on writing Relativity scripts.<\/em><\/p>\n\n\n\n

Background<\/h2>\n\n\n\n

A Relativity script<\/a> is a combination of XML that defines the properties, inputs, and outputs of the script and SQL logic that defines the actions of the script. You can use custom scripts to extend Relativity\u2019s functionality and modify data sets in workspaces. For example, you can develop scripts to generate custom reports, auto-populate fields, or reformat data based on predetermined parameters.<\/p>\n\n\n\n

Foundation<\/strong><\/h2>\n\n\n\n

In order to write the SQL logic for Relativity scripts, you will need a basic understanding of relational databases and Microsoft’s T-SQL syntax. You can start without this foundational knowledge (many of us do) but getting a basic understanding upfront will help you avoid a lot of beginner mistakes and questions.<\/p>\n\n\n\n

A good place to start is IBM’s course, Introduction to Relational Databases<\/a>. I also recommend The Manga Guide to Databases<\/a>\u2014this was my introduction to relational databases and it still holds up today. Microsoft also has a course specifically on T-SQL<\/a> (which Relativity is built on).<\/p>\n\n\n\n

Tooling<\/strong><\/h2>\n\n\n\n

You can write Relativity scripts entirely through the Relativity front end. However, it’s kind of like driving on the freeway after pepper spraying yourself directly in the eyes: it’s painful and you can’t see anything.<\/p>\n\n\n\n

To work with Relativity scripts more efficiently, it is recommended to use a tool such as SQL Server Management Studio (SSMS)<\/a>. This tool allows you to view the structure of Relativity’s databases and execute queries. SSMS can be daunting if you\u2019ve never seen it before, but this blog series<\/a> does a great job.<\/p>\n\n\n\n

Types of Relativity Databases<\/strong><\/h2>\n\n\n\n

It is important to note that Relativity does not maintain a document for its database structure and schema change documentation may not be comprehensive. To fully understand the structure of the Relativity databases, it may be necessary to explore them directly using a tool like SSMS.<\/p>\n\n\n\n

Relativity is comprised of several databases:<\/p>\n\n\n\n