Groovy editor in JMWE

Groovy editor features

Groovy editor in JMWE is where you should be writing your Groovy scripts. This editor has the

• Basic features like automatically indenting the code, checking for syntax errors in the code, colorizing keywords, comments, variables and so on and
• Advanced features, such as Find and Replace, that are available through keyboard shortcuts. 

Groovy Help in the Groovy editor

The editor also has a Groovy help section that assists you in writing your Groovy scripts with ease. It has the following tabs:

Expected Value: This tab lists the possible expected values for the selected Field and Value Type. This is applicable in contexts where you set a field value or comment an issue or write a conditional Groovy script. Select the Field and Value Type. Click on Expected Value. The help editor displays the expected values for the selected field based on the value type. Expected values of all the fields are listed here.

Templates: This tab lists a few important Groovy markups that you might want to use to create your Groovy templates. This is applicable in contexts where you set a field value, comment an issue, write content (in the Email issue post-function) or a JQL search expression using Groovy templates. Hover over any button to get the information, click on it to insert it into the editor. For more information, click here.

Globals: This tab lists the Global variables and functions that are available for your Groovy expressions and templates. Hover over any button to get the information, click on it to insert it into the editor. For more information, click here.

Issue Fields: This tab lists the fields of the current issue, original issue, linked issue or the parent issue depending on the context. Select a field and an issue variable. The help editor displays a few Groovy expressions accessing the field values, sub-fields etc by the field name. You can refer to the issue either by the field name or the field ID.  Groovy expressions to access all the fields of an issue are listed here.

Issue Methods: This tab lists the methods applicable to the current issue, original issue, linked issue or the parent issue depending on the selected issue variable. Hover over any button to get the information, click on it to insert it into the editor. For more information, click here.

Interfaces: This tab can describe any Jira, Groovy or Java interface or class. Select an interface and the editor displays the properties and methods of the selected interface. Hover over any button to get the information, click on it to insert it into the editor. For more information, click here.

More help: This menu gives you access to additional help pages.

Using Groovy Help in the Groovy editor

Suppose you want the issue to get assigned to the Project Lead if left unassigned.

• Add the Set field value post-function to the transition of the issue workflow.
• Select the Assignee field.
• Select Groovy expression in the Value type.
• Click on Issue Fields tab of the help editor.
• Select Project under Select a field.
• Under the Accessing sub-fields section locate the Groovy expression to access the Project Lead.
• Click on it to insert it into the editor.
• Go to the Conditional Execution section of the post-function and activate it.
• Click on Issue Fields of the help editor.
• Select Assignee under Select a field.
• Under the Testing the field's value section locate the Groovy expression to test whether the Assignee field is empty.
• Click on it to insert it into the editor.

Groovy editor availability

• The Groovy script editor in JMWE is available on the:

  • Post-function configuration screen when you select:
    • Groovy expression/Groovy Template as Value type in the post-functions that set a field value
    • Groovy expression/Groovy Template as Comment type in the post-functions that comment an issue
    • the Conditional execution option in any post-function
  • Post-function configuration screen of the Create/Clone issue post-function when you select:
    • Calculated as Project
    • Calculated as Parent issue
    • Set field value from Groovy or Set field value from Groovy template while setting a field in Set fields of new issue
    • Groovy expression/Groovy Template as Comment type while adding a comment to the current issue
  • Post-function configuration screen of the Email issue post-function while writing the Email content and recipients
  • Post-function configuration screen of the Link issues to the current issue post-function while writing the JQL search expression
  • Post-function configuration screen of the Unlink issues from the current issue post-function
  • Configuration screens of the Scripted (Groovy) condition, Scripted (Groovy) validator and Scripted (Groovy) operation on issue post-function
  • Groovy script tester admin screen that allows you to test/run Groovy scripts

Groovy editor toolbar

The Groovy editor has a toolbar with the following features. Clicking on:

• Find: Opens the search box. Use /re/ syntax for regexp search
• Find Next: Finds the next occurrence of a search
• Replace: Opens the Replace window. Replace a certain text with a specified text
• Test Groovy Script: Opens the Test Groovy script window to input the Issue key. Use it to test your script.
• Test again: Retests your script

The shortcuts for Find, Find Next and Replace are shown in the table below.

Groovy editor keyboard shortcuts

You can use the following shortcut keys as an alternative to the mouse when working in this editor, while the cursor is active in a code editor: