Working with External Scripts

    This page describes how you can store advanced groovy scripts outside the Sync Rules processors.

    This feature requires a good understanding of Groovy, the entities of the underlying issue tracker, and Exalate itself.

    We offer training and professional services to deliver the solution you're looking for. Please contact for more information.

    Note: Starting with Exalate v. 8.5.1 we are running Groovy v. 4.


    Advanced synchronization scripts usually contain a huge number of code lines. Storing these scripts in the Sync Rules makes it hard to maintain.

    With a scripts-specific folder outside of the Sync Rules, you can have your own scripts library. You can create your own advanced .groovy scripts and add them to the library. Then call the script from the library in the Sync Rules configuration. Exalate will start to pick external files.

    External scripts library location

    Jira Server: $JIRA_HOME/scripts

    HP ALM/QC: opt/hpqcnode/data/scripts 

    Externalized scripts provide you an ability to configure a complex synchronization case with a reduced amount of code inside the Sync Rules.

    It allows making changes to your Exalate configuration easier and version scripts whenever you need it. You can share/copy the Sync Rules between different Connections.

    To get autocompletion for all the variables available in the script and the Jira API (such as com.atlassian.jira.component.ComponentAccessor), configure the IDE to use the shared Maven configuration repository. This helps to improve your scripting experience with Exalate. You can also version your scripts with any major change using version control systems.

    Externalized scripts functionality allows to include following files:

    • sources
      • groovy
      • compiled .class
      • packaged jar
    • resources - plain text and binary resources

    The scripts directory must have permission to write and read directories/files.

    Available External Scripts

    Exalate documentation includes a lot of example scripts containing approaches on how to implement various use cases. Please note that many of these scripts are used only for example purposes.

    Check out the External Scripts Library to know more script examples.