nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

Need help with setting up a listener, to verify a field values and update the missing field value

Sreedevi Raman Pisharody

Hello Team,

We want to configure a listener to trigger during Issue create and Issue update on a set of jira projects, to fetch for the field values say a system field value (Fix Version/ Affects version) field and a Custom field (request number)

My requirement is to find a way to search for the Version field values and find the corresponding jira tickets which has request number field updated. In case Request number field is empty but Version field is not empty, it should check the version number field and its linked request number field value and update in the jira tickets with the appropriate request number wherever the same version number exists.

Please help me to figure out the logic for this without causing much load on the server. I tried with the keyset option to get from the jql search but it is not working.

Accepted answers

PD Sheehan

Can you elaborate on your requirement by showing a concrete example?

All comments

PD Sheehan

Can you elaborate on your requirement by showing a concrete example?

Sreedevi Raman Pisharody

Hello Peter,

I am trying to get field values of a system field and one custom field on a jira project for story issue types, and wherever the custom field associated to the respective fix version is not present, I will be using listener to update the respective custom field.

For eg.

In Project ABC on ABC-1 jira issue we have

Fix versions : 1.1

Request Number field : ABC1234

On other issue ABC-2 we have

Fix Version : 1.1

however the Request number is Empty.

I am planning to use the update script in order to update the Request number field

import com.atlassian.jira.component.ComponentAccessor
import com.atlassian.jira.issue.ModifiedValue
import com.atlassian.jira.issue.util.DefaultIssueChangeHolder

// the name of the custom field to update
final customFieldName = 'Request Number'
// the new value of the field
//final newValue = 'I love Groovy !'

def customFieldManager = ComponentAccessor.customFieldManager
def issue = event.issue
def customField = customFieldManager.getCustomFieldObjects(issue).findByName(customFieldName)
//assert customField : "Could not find custom field with name $customFieldName"
customField.updateValue(null, issue, new ModifiedValue(issue.getCustomFieldValue(customField), newValue), new DefaultIssueChangeHolder())

But what I am failing to get is the list of jira fix version values and the mapped Request number values to be fed to this update script.

If I am able to list the jira tickets with jql, to get the impacted issues, but not able to get the way to fed this needful list into the update script.

Please let me know if you want me to explain further.

Thanks and Regards,

Sreedevi

PD Sheehan

I am still not clear on what the trigger for this listener will be.

Or is it that every time a new issues is created with FixVersion = 1.1, you want to go find the correct Request Number (either via JQL or some other storage method) and apply that Request Number to the just-newly-created issue?

If the latter, one option is to include that Request Number in the Description of the Release.

Also, generally, using customField.updateValue is the least recommended method to update a custom field. IssueService is generally preferred, but IssueManager is also acceptable.

IssueService has the advantage of not needing to manually trigger a re-index.

Here is a sample script to grab the Request Number from the version description:

import com.atlassian.jira.component.ComponentAccessor
import com.atlassian.jira.event.type.EventDispatchOption
import com.atlassian.jira.issue.MutableIssue
import com.atlassian.jira.issue.index.IssueIndexingService

def currentUser = ComponentAccessor.jiraAuthenticationContext.loggedInUser

// the name of the custom field to update
final customFieldName = 'Request Number'
// the new value of the field
//final newValue = 'I love Groovy !'

def customFieldManager = ComponentAccessor.customFieldManager
def issue = event.issue as MutableIssue
if(!issue.fixVersions) return //nothing to do if there is no fixVersion
def requestNumber
issue.fixVersions.find{version->
    if(!version.description.contains("Request Number=")) return null //no request number in this version
    def matcher = version.description =~ $/Request Number=((.*?)\s|(.*$))/$
    if(!matcher) return null //pattern didn't return a match
    requestNumber = matcher[0][1]
return true //stop looking at other versions, we found a match
}
if(!requestNumber) return null //nothing more to do if we didn't find a request number
def requestNumberCf = customFieldManager.getCustomFieldObjects(issue).findByName(customFieldName)

issue.setCustomFieldValue(requestNumberCf, requestNumber)
ComponentAccessor.issueManager.updateIssue(currentUser, issue, EventDispatchOption.DO_NOT_DISPATCH, false)
ComponentAccessor.getComponent(IssueIndexingService).reIndex(issue)

Sreedevi Raman Pisharody

My listener would need to be triggered in both cases (i.e. at Issue creation and Issue updation)

Is it when the Request Number is added to ABC-1, you want to find all other issues with FixVersion = 1.1 and "Request Number" is empty and apply the same request number? to all issues that match the JQL? - Yes that what we are looking for, whenever a fix version field (say 1.1) is added to a ticket, may be at the time of creation or updation, we need to search for all the issue (i.e. story tickets) with same fix version and update the corresponding Request number which is available accordingly.

Whenever a user updates the fix version fields (it can be at the time of creation or updation) the listener should go and check if the Request number field is updated. In case it finds it to be empty it has to update,

I will test out the script you have provided, will post the updates.

Also, generally, using customField.updateValue is the least recommended method to update a custom field. IssueService is generally preferred, but IssueManager is also acceptable. - What would be the recommended approach. - Thanks for this suggestion, we had been facing some challenges with IssueManager, so will try using IssueService.

Do let me know if you need any more information

Ramesh Penuballi

Trying to set the request number field to null if there is any update on the fix versions field and used the below code..

if (event.eventTypeId == EventType.ISSUE_UPDATED_ID) {

def listOfFields = ['Fix Version', customFieldName]

def changeItems = ComponentAccessor.changeHistoryManager.getChangeHistoryById(event.changeLog.id as Long).changeItemBeans

log.info "Issue updated detected. Changed fields: ${changeItems*.field}"

log.warn "Issue updated detected. Changed fields: ${changeItems*.field}"

if (!changeItems.any { it.field in listOfFields }) {

//don't run the listener if the user changed an unrelated field.

log.warn "$listOfFields were not found in the list of changed fields."

return null

}

if ( changeItems.any { it.field == ‘Fix Version’ }).

{

issue.setCustomFieldValue(customField, null)

customField.updateValue(null, issue, new ModifiedValue(customFieldValue, null), new DefaultIssueChangeHolder())

}

Tried both customField.updateValu and issue.setCustomfield methods, but getting the syntax errors.

Please help.....

Ramesh Penuballi

Hello Peter,

Thanks for quick response to my queries.

I could solved the syntax errors and now the script is running fine as expected.

In my case I have to check two more scenarios where in when fix version is updated and the custom field (flagged) which is of single select type and when it is set to "Yes" then the request number shouldn't updated even if there is change in fix version else the request number should be cleared.

I could achieve the 2nd part of above requirement by adding the if condition as below.

if (changeItems.any {it.field == 'Fix Version'})

{

requestNumberCf.updateValue(null, event.issue, new ModifiedValue(customFieldName, null), new DefaultIssueChangeHolder())

}

I tried to update a condition to check where fix versions is updated and the flagged field value is set to "Yes" where is my script shouldn't make any changes in the request number field.However this logic seems to break the other conditions.

Could you please advice how I could handle this scenario.The part of the code where I made changes to the above script shared by you is as below.

@field String flagged = 'flagged'

@field CustomField flaggedCf = customFieldManager.getCustomFieldObjectsByName(flagged)[0]

def flaggedCfval = issue.getCustomFieldValue(flaggedCf)

if (event.eventTypeId == EventType.ISSUE_UPDATED_ID) {

def listOfFields = ['Fix Version', customFieldName,flagged]

def changeItems = ComponentAccessor.changeHistoryManager.getChangeHistoryById(event.changeLog.id as Long).changeItemBeans

log.info "Issue updated detected. Changed fields: ${changeItems*.field}"

if (!changeItems.any { it.field in listOfFields }) {

//don't run the listener if the user changed an unrelated field.

log.warn "$listOfFields were not found in the list of changed fields."

return null

}

if ((changeItems.any {it.field == 'Fix Version'}) && ("$flaggedCfval" == 'Yes'))

{

log.warn "Automated field set to Yes and $customFieldName and $flaggedCfval"

//requestNumberCf.updateValue(null, event.issue, new ModifiedValue(customFieldName,customFieldName), new DefaultIssueChangeHolder())

return "$customFieldName"

}

if (changeItems.any {it.field == 'Fix Version'})

{

requestNumberCf.updateValue(null, event.issue, new ModifiedValue(customFieldName, null), new DefaultIssueChangeHolder())

}

Thanks,

Ramesh

Ramesh Penuballi

I tried adding if else conditions at two places below but it works only for one case and fails for other.

Can you please help rectify this issue.

if (!issue.fixVersions)

{

log.info "fixVersion field is empty for $issue.key. Listener will not try to make updates"

requestNumberCf.updateValue(null, event.issue, new ModifiedValue(customFieldName, null), new DefaultIssueChangeHolder())

return null //nothing to do if there is no fixVersion

}

if ((!issue.fixVersions) && ("$flaggedCfval" == 'Yes'))

{

def val1 = issue.getCustomFieldValue(requestNumberCf)

requestNumberCf.updateValue(null, event.issue, new ModifiedValue(customFieldName,val1), new DefaultIssueChangeHolder())

}

else

{

requestNumberCf.updateValue(null, event.issue, new ModifiedValue(customFieldName, null), new DefaultIssueChangeHolder())

}

if (event.eventTypeId == EventType.ISSUE_UPDATED_ID) {

def listOfFields = ['Fix Version', customFieldName,flagged]

def changeItems = ComponentAccessor.changeHistoryManager.getChangeHistoryById(event.changeLog.id as Long).changeItemBeans

log.info "Issue updated detected. Changed fields: ${changeItems*.field}"

if (!changeItems.any { it.field in listOfFields }) {

//don't run the listener if the user changed an unrelated field.

log.warn "$listOfFields were not found in the list of changed fields."

return null

}

if ((changeItems.any {it.field == 'Fix Version'}) && ("$flaggedCfval" == 'Yes'))

{

def val = issue.getCustomFieldValue(requestNumberCf)

requestNumberCf.updateValue(null, event.issue, new ModifiedValue(customFieldName,val), new DefaultIssueChangeHolder())

}

else

{

requestNumberCf.updateValue(null, event.issue, new ModifiedValue(customFieldName, null), new DefaultIssueChangeHolder())

}

Thanks,

Ramesh Penuballi

PD Sheehan

The trick with single select custom field is understanding that the getCustomFieldValue will return an object of class "Option".

So rather than comparing the option object as a string, it is best to use its "value" property.

So instead of

" $flaggedCfval " == 'Yes'

Try

flaggedCfval.value == 'Yes'

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Unanswered
Groups
Help

Find more posts tagged with

server

adaptavist