Getting Started with ScriptRunner for Jira Data Center
Welcome to ScriptRunner for Jira, your complete solution to automate, customise and extend Jira. Discover all the resources you could ever need right here.
Hello and welcome to ScriptRunner for Jira Data Center!
The ScriptRunner team are dedicated to bringing innovation to this essential Jira app, ensuring ongoing development and support.
The team’s top tips: use one of our no-code built-in-scripts to tidy up your instance or create a calculated custom field with Scripted Fields.
Make sure to bookmark this page to refer back to throughout your ScriptRunner journey. And if there's something you need that you can't find, please get in touch—we'd love to hear from you!
New to ScriptRunner for Jira?
Learn how to navigate your way round the app in less than 4 minutes!
4 steps for success
Now that you know your way around the app, follow our 4 steps below to prepare to build your first script.
Step 1: Get ScriptRunner up and running
Install ScriptRunner and familiarise yourself with the navigation
Congratulations, you’ve installed ScriptRunner for Jira! There are two main ways to navigate to ScriptRunner in Jira: through the Jira Administration menu or using the Administration quick search.
Step 2: Browse feature navigation
Use the Browse page to search and discover all the functionality ScriptRunner has to offer.
Save time by typing keywords into the search bar to filter scripts by name or goal, or select categories and filters to discover scripts.
To navigate to the Browse page, click ScriptRunner from the Jira Administration menu.
Automate your Jira tasks with ease
Say goodbye to manual and repetitive tasks. With ScriptRunner, you can set up custom scripts and automate workflows in no time.
Increase efficiency and productivity
With ScriptRunner, you can streamline your Jira workflows and complete tasks faster, without sacrificing quality.
Customize your Jira instance
Every team has unique needs. ScriptRunner allows you to customize your Jira instance to meet the specific needs of your team.
Step 3: Complete the beginners training path
Get to grips with ScriptRunner basics.
We have created a learning path especially for those who are new to ScriptRunner for Jira. Including best practices for making the most out of ScriptRunner.
Step 4: Explore HAPI, your scripting sidekick!
HAPI is a simplified and faster version of Groovy. Using HAPI, we've opened the doors of ScriptRunner to low- and no-code users, so you no longer need to be a Groovy master to get the most from ScriptRunner.
My advice is to start small. Start with creating or updating issues from the script console. Then explore the features, such as listeners, to start automating. And remember to check out Example scripts for heaps of ready-to-use scripts.
Reece Lander
Staff Engineer, ScriptRunner
What to try next?
Let's explore our most popular features
Behaviours
You can use ScriptRunner Behaviours to define how fields behave for issues in a given project or issue. For example, you can make a field mandatory depending on other data entered on the issue screen.
Built-in scripts
We have developed numerous built-in scripts that you can use to automate and customise your Jira instance. With these built-in scripts, the hard work is already done, you just have to fill in the necessary fields.
Listeners
You can use ScriptRunner Listeners to execute actions automatically in response to an event. You can use a built-in listener or configure a custom listener using HAPI scripts.
JQL functions
You can use ScriptRunner JQL Functions to extend Jira's built-in capabilities, allowing you to conduct more granular searches, and obtain more detailed information about what is happening in your instance and projects.
HAPI
Welcome to a quicker way to define your Jira automations and customisations. HAPI is compatible with existing scripts and is built around use cases and Jira terminology.
Workflows
Enhance and automate your workflows beyond Jira's native possibilities using ScriptRunner's workflow functions: script conditions, script validators, and script post functions.
Fragments
Use Script Fragments for UI changes, such as displaying an announcement banner, showing different banners for different users, and adding buttons to the Tools menu.
Essential resources
Our users said they couldn't do without these resources when they were getting started with ScriptRunner.
Documentation
Check out our helpful ScriptRunner documentation with everything you need to know about ScriptRunner for Jira.
Example scripts
A resource that saves you time! Our collection of Example scripts is packed with inspiration and help to get you started. Covering a wide range of use cases, ready to copy, paste, and tweak.
Atlassian Community forums
If you're stuck, check out the Atlassian Community! Someone may already have asked and answered your query, and if not, you can ask the thousands of experienced users for help.
Keep up to date
The Product Update Hub: discover recently released, what's coming soon, and how you can help us shape the future.
Release notes: for recent changes, fixes, and feature updates.
The support is really awesome!! A good product with excellent support is priceless.
Bernhard Reiter
Review from Atlassian Marketplace
Need help?
Can't find what you're looking for? Our expert Support team is ready to help you.