Scripting Other Plugins
A focus of ScriptRunner 3 is being able to script other plugins, for instance JIRA Agile (Greenhopper), Structure, etc etc.
There are two annotations that allow this. The first is @WithPlugin(pluginKey) , which will effectively make classes provided by the target plugin available to your script.
The second is @PluginModule, which injects an instance of this module in to your script.
|These annotations only work when running a script that is under a script root… not a script outside a script root, nor code pasted into the console.|
|JIRA Agile is a special case - see Working With JIRA Agile.|
This is an annotation that you can put in your or on a class. It takes the plugin key as an argument. You can get the plugin key from Manage Plugins:
When this annotation is present, the classloader for the target plugin is added to the list of classloaders when your script is compiled and run, so your imports from eg the Structure plugin will be resolved.
Currently there is no way to make this fail quietly if the plugin you request is not present - vote for - if this is an issue.
Annotating a variable in a class or a script, will inject an instance of this type into your script. This is most commonly used for getting hold of a module defined in another plugin. In a traditional plugin you would use
<component-import> to achieve the same thing.
If you are working with Structure you may use:
import com.onresolve.scriptrunner.runner.customisers.WithPlugin import com.almworks.jira.structure.api.StructureServices ... @PluginModule StructureServices structureServices
Structure is quite easy because given a StructureServices you can get all the other services from that.
Do not initialise the variable yourself, eg:
will produce an error:
startup failed: General error during semantic analysis: Cannot set plugin module when field already initialised
If you are working with Intellij IDEA you may get a warning about uninitialised variables:
You can disable this with
//noinspection GroovyVariableNotAssigned on your first use of the variable.
Have questions? Visit the Atlassian Community to connect, share, and learn with other Atlassian users and experts, including Adaptavist staff.
Want to learn more? Check out courses on Adaptavist Learn, an online platform to onboard and train new users for Atlassian solutions.