Features

Learn about all of the main features of ScriptRunner.

Script Console

On the Script Console page, you copy/paste or upload a script to run. The purpose of this particular area is for experimenting with the Jira REST API or for running the odd one-time script. The Script Console page includes a script editor box for you to copy/paste or write your script in.

Built-In Scripts

On the Built-in Scripts page, you can set up one of the built-in scripts available with ScriptRunner. These particular scripts are useful for global management, such as modifying field resolutions in bulk or viewing a list of all scheduled jobs set to run in your Jira instance.

Listeners

On the Listeners page, you can add and manage your script listeners, as well as run built-in listeners in your Jira instance.

Behaviours

On the Behaviours page, you add and manage behaviours for your Jira instance. Behaviours modify fields, and you can apply them to projects and/or issue types.

Script Fields

On the Script Fields page, you can add and manage script fields. With script fields, you can display a value from a ScriptRunner script in a new custom field that you create. For example, a scripted field that shows the number of times an issue has been in the selected status.

Workflow Functions

ScriptRunner conditions, validators, and post-functions are available through the Workflows section found in the Issues administration menu (for more information on how to navigate to them see our Workflow Functions documentation). Use these functions to further customize your workflows and set scripts to run before or after workflow transitions, or based on a certain condition.

REST Endpoints

On the REST Endpoints page, you can see the REST endpoints available for the instance. REST is outside of the scope of this tutorial, but if you ever need to manage those endpoints, you go to this page in the ScriptRunner menu.

Script Fragments

On the Script Fragments page, you can update web items and panels. This page includes both a custom web section, item, and provider; as well as built-in script fragments for user interface (UI) changes. Most of ScriptRunner deals with content and information, but script fragments allow you to use ScriptRunner for UI changes.

Jobs

ScriptRunner Jobs allow you to run your own code at regular intervals.

JQL Functions

On the JQL Functions page, you can see all the additional JQL functions from ScriptRunner that you can use on your instance. You enable and disable JQL functions from the UPM in the Modules section.

Again, you can only view the JQL functions on this page; you actually use them in regular JQL searches. These additional functions appear and act just like the standard Jira JQL functions, including being listed in the auto-complete suggestions as you write your JQL query. These functions are accessible by anyone who can search for issues in your instance, and this is the most common way that people use ScriptRunner without realizing it. Be aware that if you ever decide to uninstall ScriptRunner any searches or filters that used these additional JQL functions will break, which typically leads to unhappy users.

Resources

On the Resources page, manage and add database connections for use within custom scripts. With Resources you can set up connections to both internal and external databases, which are stored by ScriptRunner in a connection pool. This feature is outside of the scope of this tutorial.

And that’s it for our tour of ScriptRunner options from the Jira administration console.

Script Editor

Manage your .groovy script files and folders using the ScriptRunner Script Editor. Reuse and share scripts across an instance without the need for FTP services or server administrators. With the Script Editor, you can create, edit, move, save, rename, and delete .groovy script files and folders in root folders from the ScriptRunner front-end.

Mail Handler

The ScriptRunner Mail Handler expands on Jiras built-in feature and allows users to run groovy scripts when a message is received. The Mail Handler is available through the System administration menu, under Incoming Mail.