How to perform a JQL search inside Jira DC incoming script

Script Library
,
1

This script demonstrates how to perform a Jira Query Language (JQL) search using the Jira DC (Data Center) incoming script, and return a list of issues based on specified criteria.

JQL Query Creation: The script uses the JqlQueryBuilder class to construct a JQL query. In this case, the query is set to:

  • Search for issues in the project KAN
  • Filter by issue type Bug
def query = JqlQueryBuilder.newBuilder()
    .where()
    .project("KAN")
    .and()
    .issueType("Bug")
    .buildQuery()

Authentication Context: The script sets up an authentication context to simulate the action of a user. The user is set as admin:

def authContext = ComponentAccessor.getJiraAuthenticationContext();
def user = ComponentAccessor.getUserManager().getUser("admin")
authContext.setLoggedInUser(user);

Search Service: The script leverages Jira’s SearchService to execute the JQL query. It uses the logged-in user to execute the search and retrieves the results using an unlimited pager filter:

def searchService = ComponentAccessor.getComponent(SearchService)
def results = searchService.search(user, query, PagerFilter.getUnlimitedFilter())

To avoid errors, add a check to ensure there are results before collecting the issue keys:

 if(results.total > 0) { 
  issueList = results.results.collect { it.key}
}

Incoming sync of Jira On-premise

import com.atlassian.jira.component.ComponentAccessor
import com.atlassian.jira.bc.issue.search.SearchService
import com.atlassian.jira.jql.builder.JqlQueryBuilder
import com.atlassian.query.Query
import com.atlassian.jira.web.bean.PagerFilter
import com.atlassian.jira.user.ApplicationUsers

def query = JqlQueryBuilder.newBuilder()
    .where()
    .project("KAN")
    .and()
    .issueType("Bug")
    .buildQuery()

def authContext = ComponentAccessor.getJiraAuthenticationContext();
def user = ComponentAccessor.getUserManager().getUser("admin")
authContext.setLoggedInUser(user);
def searchService = ComponentAccessor.getComponent(SearchService)
def results = searchService.search(user, query, PagerFilter.getUnlimitedFilter())
if (results.total > 0) {
    issueList = results.results.collect { it.key }
} else {
    issueList = []
}

To inspect the results, the script uses the following debug statement, which prints out the issue keys:

debug.error(issueList.toString())

Example Output:

[KAN-74, KAN-70, KAN-61, KAN-11]