Script Registry

The Script Registry allows you to search your ScriptRunner custom scripts, view type-checking errors or deprecation warnings, and export all scripts and configurations on your instance.

Type-checking errors do not mean your code will not run - as we compile it statically and Groovy is a dynamic language, there may be false positives.

Script Registry lists scripts, their type, content, and location. Each script undergoes Static Type Checking to ensure it is written correctly.

We recommend that the Script Registry be used on staging instances after upgrading Jira to validate that all necessary APIs are available.

Using the Script Registry

  1. From ScriptRunner, navigate to Built-in Scripts > Script Registry. Alternatively, you can select the Ellipses Menu > Script Registry.
    Image of script registry location

  2. Click Run to view all configured scripts. All Groovy scripts on the Jira instance are listed.

  3. Scripts are sorted into category tabs, showing the number of scripts in each category. Click on a tab to display all scripts of that kind.
    Image example of the results

Exporting your scripts

You can export all scripts and configurations on your instance from the Script Registry, except for Workflow scripts and ScriptRunner JQL function information. 

Image of the export scripts button

What do we mean by "scripts"?

In this context, "scripts" encompass a broader range of elements than typical custom script files. Specifically, we include:

  • All scripts within your script roots.
  • All configured custom and built-in Jobs, Listeners, Fields, Behaviours, UI Fragments, REST Endpoints.

It's important to note that even configuration-only elements are considered "scripts" for the purpose of this export. For example, if you have a Behaviour or Script Field that has been configured without requiring a custom script to support it, it will still be included in the export as a "script".

Exporting all scripts

When you select Export all scripts from the Script Registry the following will be exported as a .zip file:

  • All of your scripts from your script roots (as .groovy files).
  • All of your configured Jobs, Listeners, Fields, Behaviours, UI Fragments, REST Endpoints (as .json files).
  • A .csv file containing all configured scripts in your instance (excluding script roots). This .csv file includes the following columns:
    • ID: Unique identifier of the configured script.
    • Type: Feature type of the script (for example Listener, Job, Behaviour, etc).
    • Name: User-defined name of the script.
    • Associated Scripts: Number of custom scripts linked to this configuration.
    • Project Mappings: List of projects the script is mapped to.
    • Last Run: Most recent execution date and time (if applicable).

If the export doesn't start automatically, please check your browser settings and try again.

Exporting active scripts only

You can select Export active scripts Only to make sure only active scripts are exported from your instance. Any Disabled scripts will be filtered out from this export. This does not include scripts in your script roots, these will always be included in the export file. 
Image of Export active scripts only button

On this page