Feature: Scripting!

Posted May 23, 2018 in Features

We’re ready (and excited!) to talk about a major feature coming to ReadySuite in the next release – scripting. Our clients and customers use ReadySuite today to attack tedious e-discovery workflows and perform many QC checks with relative ease. And we know there are many unique workflows firms and organizations need to solve that they can not perform in a single step.

Using scripting with ReadySuite, our clients will be able to access our pre-built script library, write their own scripts using our Scripting API, or request a new script from us to solve a workflow need.

For example, we have a ‘Split Date Fields’ script included which can find combined date & time fields – such as ‘Date Time Sent’ – and split the field into two separate fields – ‘Date Sent’ and ‘Time Sent’ respectively.

See this pre-built ReadySuite script in action below:

In the example above, we’re running the script using the included ‘Code Editor’ – designed to let you browse, edit, and view the code for built-in and user defined scripts. The code editor can also debug and build scripts on-the-fly. You can also use an external editor, such as Visual Studio Code, and reference our Scripting DLL for more advanced code completion.

We know a lot of our users are not super technical and may not have the ability to read and write code. Those users never have to open the ‘Code Editor’ to run a script – scripts are accessible directly from the Ribbon. We populate the available scripts into lists based on defined categories. The names of the categories are fully customizable from the scripts.

We’ve designed the API to be clean and easy to learn. A very basic, but runnable script below shows how easy it is to loop through all the imported documents, change the DocID, and add a populate a field value.

Scripts are not limited to reading and updating existing documents – you can also use them to create and import new documents.

When you attempt to compile or build a script, and if there are errors encountered, you’ll be able to quickly see the compiler errors within the editor.

You can include within your script a set of options users must define. For example, in our ‘Split Date Fields’ script, we can let the user set relevant date fields and change the default mask for the output date format.

Implementing options in your script is incredibly easy – inherit from the ‘ScriptOptions’ class (see below) and we will automatically show the ‘Set Options’ dialog to the user when they run the script.

We’re including a feature allowing users to create ‘Script Packs’ – script packs will allow you to combine multiple scripts together to run at once. We expect these to be useful for running several workflow steps with the click of a button. Steps such as transforming multiple metadata field values or executing several QC processes against an imported document volume.

We’re working on building out our library of built-in scripts before launch. Some examples include the ability to search through text files, find a ‘Redacted’ word, and flag the document for a QC check. A script to rename native files inline – by appending a ‘Confidential’ value to the filename for documents marked Confidential. Or a custom MD5 hash generator – where you define metadata fields to create a MD5 hash value from.

We’d love to get your suggestions – send an e-mail to justin@compiled.com if there is as script you want us to include.