This set of tutorials is for the Jira admin who doesn’t know how to write Groovy code and wants to use ScriptRunner for Jira Server to automate and improve their Jira instance. The goal of these tutorials is to break down the barrier-to-entry for ScriptRunner and help people see what it can do and how easy it is to use.
There are extensive hands-on activities that go along with the course and help provide context and experience to all that ScriptRunner for Jira can do.
About These Tutorials
If you are here, you are likely a Jira administrator interested in providing more options in your Jira instance for customization and automation. To make the most of these walkthroughs, you don’t necessarily need any scripting experience, but you should feel comfortable creating and managing issues, building workflows, and working with Jira administration functions.
In these tutorial, you can learn about some of the functions of ScriptRunner and how to use them. Topics covered include:
- Introduction to ScriptRunner
- Feature Overview
- Before You Start
- Behaviours Tutorial
- Built-In Scripts Tutorial
- JQL Functions Tutorial
- Listeners Tutorial
- Script Field Tutorial
- Workflow Functions Tutorial
You can follow these tutorials in order (as displayed here) as part of a full course, or as stand-alone lessons.
What We Don’t Cover
While we do mention areas you can use custom scripts, along with some tips on how to use custom script options, we don’t teach any Groovy in this course. This course focuses more on the business user or administrator who doesn’t have or necessarily need scripting knowledge, so we don’t teach you how to write scripts. While available to ScriptRunner users, this course also doesn’t include working through script fragments or using the REST API. For coverage on topics we can’t cover, we recommend visiting the dedicated pages in the ScriptRunner documentation.
Over the course of these tutorials you may have already seen a reference to Great Adventure. What is Great Adventure?
Great Adventure is the fictitious company we use to help provide use cases and examples of concepts covered in the course. Great Adventure is a company that organizes specialized holidays for the discerning tourist.
Great Adventure has the same problems and issues faced by most companies. Great Adventure needs to automate more of its process using ScriptRunner, especially in their Virtual Tour and Finance teams. For instance, issues are sometimes raised that are not resolved in an appropriate time period. Obviously, management wishes to be able to identify these issues more readily and have them escalated. More on that soon, but first a few notes of caution.
Things to Remember
We recommend that you test ScriptRunner functionality in a staging or test environment until proven to work. You want to avoid working in your production environment for testing, and ScriptRunner loosens the Jira reins just enough to be dangerous.
Specifically, you need to be careful with recursive searches, as they can actually grind Jira to a halt. To avoid potential mayhem:
Provide a subquery in your search to help limit results.
Use a limited version of JQL functions to make sure you don’t go too far down the rabbit hole.
We also caution you when grabbing groovy scripts found on the Internet. Just make sure your script comes from a reputable source, such as the Adaptavist Library. In fact, check out the rest of our documentation. It contains discussions regarding efficiency, performance, and comparisons between differing approaches. Read it carefully during the planning stage, before you attempt to run something you are not 100% sure of.
Not sure how to navigate to ScriptRunner? Visit the Navigation guide.
Ready to get started? See our Introduction to ScriptRunner tutorial.