Script groups

You can use script groups in Relativity to create a dashboard view into your scripting activities. Script groups are an extension of the Relativity script page where you can dynamically create script dashboards based on the category specified in the Relativity script XML. These dashboards provide you with a radio button list of all scripts, and they provide a centralized location to run your similar scripts.

Caution: Changes to SQL fields executed by Relativity Scripts do not produce Audit logs.

See Scripts for more information.

Using script groups

Imagine you're a system admin and you want an easy way to monitor script activities to verify the schedules for running the scripts don't execute during periods of peak activity.

You set up a script group that includes all scripts that have prescheduled executions. You create a tab to monitor and adjust the timing and execution of the various scripts in your environment. You keep this tab open in your Relativity environment, and you notice that someone is running the XYZ script every day at 11:00 a.m. You contact the system admin and ask them to run the script at a less active time.

Setting up a script group

Follow these steps to set up a script group:

  1. Create or select a group of Relativity scripts that you would like to add to a script group . They must all share the same Category. You can also create new categories. See Creating a new workspace script. Script group categories in a view
  2. Create a new external tab that links to your script group. See Creating and editing tabs. If the category name contains spaces, replace the spaces with the + sign.
    1. Copy the script category’s Report Group URL to your clipboard or Notepad. For example, if you are creating a script group for all scripts whose category is Case Functionality, open any script belonging to this category. Then, copy the entire path listed in Report Group URL.Report group URL field value
    2. Navigate to Workspace admin > Tabs, and then select New Tab.
    3. Enter the following:
      • Link Type - External
      • Link- Paste the entire Report Group URL path. It should look similar to the following:
      • %ApplicationPath%/Case/RelativityScript/Run.aspx?%AppID%&%SystemID%&category=Case+Functionality
      • Leave all other fields at default settings.
  3. Navigate to the new tab you created for your script group.

Note: Linked scripts can only be members of a script group as an admin tab. You can't create script groups of linked scripts within a workspace.