When running Groovy scripts, JMWE makes contextual information available to your script through built-in variables, functions, the Component/Service Manager and Jira Standard Services. 

Using Groovy Variables and Functions

The variables are available anywhere that a Groovy editor is used. Additionally, clicking on the Globals tab provided under the Groovy editor displays the list of available variables and functions. These are categorized below based on the context.

Current issue

issue

originalIssue

relatedIssue

linkedIssue

parentIssue

Execution context

currentUser

transientVars

transientVars

Others

now

today

currentValue

newIssueKey

linkTypeName

textutils

log

Custom variables

In addition to the above variables, you can also define your own variables in the Groovy script.

For example, Condition to check whether the Fix Version/s has a particular version.

Deprecated variables

Functions

The functions are available in 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 script.

• Target issues section of all post-functions that operate on related issues when Issues returned by a Groovy script or Issues returned by JQL search is selected under Which Issues field.

• Shared Groovy Scripts under JMWE administration

Global Functions

jqlSearch("<JQL expression>", <maxResults>)

• JQL expression: A JQL query

• maxResults: maximum number of issues to return

• Fetch the first ticket of a specific project that has the same Cascading value set as of the current issue

   

• Fetch the first 10 issues that have the same Fix Version/s as the first Fix Version/s of the current issue.

   

secondsBetween(Date from, Date to)

secondsBetween(<Date from>, <Date to>) is a global function that returns a Long representing the number of seconds between two Date objects. It returns null if one of the two parameters is null. For example:

• returns the number of seconds between the issue creation and the due date.

• returns the number of seconds from the issue creation to now.

secondsBetween(Date from, Date to, String roundTo)

secondsBetween(<Date from>, <Date to>, String roundTo) is a global function that returns a Long representing the number of seconds between two Date objects optionally rounding the number of seconds to the nearest minute, hour, day or week. It returns null if one of the two parameters is null.

<roundTo>: is either "max" or one of "weeks", "days", "hours", "minutes" (or their equivalent: "w", "d", "h", "m"). If the rounding is "max", it will be rounded to the largest unit reached by the duration. For example:

• If secondsBetween(issue.created, issue.duedate) returns 2 hours 51 minutes,

  will be rounded to 10800 seconds (3*60*60 seconds) and will be displayed as 3 hours.

• If secondsBetween(issue.created, issue.duedate) returns 65328 seconds

  will be rounded and displayed as 64800 seconds

workdaysBetween(Date from, Date to)

workdaysBetween(<Date from>, <Date to>) is a global function that returns a Long representing the number of work days (excluding Saturdays and Sundays) between two Date objects. It returns null if one of the two parameters is null. For example:

• returns the number of days between the issue creation and the due date

• returns the number of days from the issue creation to now.

workdaysBetween(Date from, Date to, calendarId)

workdaysBetween(<Date from>, <Date to>, <calendarId>) is a global function that returns a Long representing the number of work days between two Date objects using the specified Jira Service Management calendar. It returns null if the calendarId parameters is null. 

For example:

• returns the number of days between the issue creation and the due date using the JSM calendar with an id of '2'.

• returns the number of days from the issue creation to now using the JSM calendar with an id of '2'.

workdaysBetween(Date from, Date to, Project, calendarName)

workdaysBetween(<Date from>, <Date to>, <project>, <calendarName>) is a global function that returns a Long representing the number of work days between two Date objects using the specified Jira Service Management calendar. It returns null if the calendarId parameters is null. 

For example:

• returns the number of days between the issue creation and the due date using the Project <project> and the JSM calendar with a name of <name>.

• returns the number of days from the issue creation to now using the Project <project> and the JSM calendar with a name of <name>.

asUser(String username){codeblock}

asUser() is a simple global function that runs a code impersonating a user. During the execution of the code block, the current user will be set to the user with the specified username. The function expects the following:

• username: Username of the user to impersonate

• codeblock: Code block to run while impersonating a user

For example:

returns jdoe, regardless of who the current user is. 

asUser(ApplicationUser user){codeblock}

asUser(ApplicationUser user) is a simple global function that runs a code impersonating a user. During the execution of the code block, the current user will be set to the specified user. The function expects the following:

• ApplicationUser: User to impersonate

• codeblock: Code block to run while impersonating a user

For example:

returns the name of the assignee of the issue, regardless of who the current user is.

getCurrentTransition()

getCurrentTransition is a global function that returns data on the current transition, including the actionId, name of the transition, and the targetStatus of the transition.

getOrganization(String organizationNameOrID)

getOrganization is a global function that returns a Jira Service Management Organization from its name or ID.

For example:

returns the Organization named “Appfire”.

return the Organization with ID 5.

getUsersInOrganization(CustomerOrganization organization)

getUsersInOrganization is a global function that returns the users that belong to an organization. The function returns a Set<ApplicationUser> and expects a CustomerOrganization object.

For example:

returns the users that belong to the Appfire organization.

Additionally, you can use the usersInOrganization attribute of the CustomerOrganization interface that returns the users in a Jira Service Management Organization.

For example:

getTransitionAttachments()

getTransitionAttachments is a global function that returns the Attachments that have been added on the transition or issue creation screen. The function returns a List<Attachment>.

renderAsHTML(String content)

renderAsHTML is a global function that accepts String input and returns that string formatted as HTML.

Accessing any Component/Service Manager

getComponent(Class interface)

But now you can directly import the class and get the Service, as shown below:

Note that you can also access the internal components/services that are registered as private (not "public") using this function. For example to get the DevStatusSummaryService from Jira's development integration plugin (which gives access to builds, commits, etc.)

Some more examples:

replace customfield_xxxxx with the custom field id of the field.

Accessing Standard Jira Services

You can access a few Standard Jira's services from the Groovy editor. Hover over any button to get the information, click on it to insert it into the editor.