Feature Overview
See Navigation for more information on how to access ScriptRunner features.
Script Console
On the Script Console page, you copy/paste or upload a script to run. The purpose of this particular area is to experiment with the Jira REST API, experiment with HAPI, or for running the odd one-time script. The Script Console page includes a script editor box to copy/paste or write your script. The script console, and anywhere you use a custom script, benefits from static type checking which provides information on whether your script is correctly written.
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.
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.
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.
Listeners
On the Listeners page, you can add and manage your script listeners, as well as run built-in listeners in your Jira instance.
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 script field that shows the number of times an issue has been in the selected status.
REST Endpoints
On the REST Endpoints page, you can see the REST endpoints available for the instance. If you ever need to manage those endpoints, you go to this page in the ScriptRunner menu.
UI Fragments
On the UI 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
On the Jobs page, you can automate issue escalation with escalation services, use a JQL query to periodically archive old issues, or run your own custom jobs 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 can enable and disable JQL functions from the UPM.
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.
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.
Workflow Functions
ScriptRunner conditions, validators, and post-functions are available through the Workflows section. Use these functions to further customize your workflows and set scripts to run before or after workflow transitions, or based on a certain condition.
Mail Handler
The ScriptRunner Mail Handler expands on Jira's built-in feature and allows users to run groovy scripts when a message is received. The Mail Handler processes incoming mail, automating tasks. such as creating a new issue from the mail subject, creating users from the recipient list, or triggering workflow actions.