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; } } }

Using scriptrunner to copy custom text field from parent to sub-task

Barbara Schnell

Hi,

I am trying to have a custom text field called "Initiative" that exists in all issue types populated from Story to sub-task using scriptrunner. I am new to scriptrunner and only have admin access to a dev server for exploration so may be unfamiliar with admin settings needed to make this work.

Reference: https://scriptrunner.adaptavist.com/5.4.47/jira/recipes/behaviours/subtask-default-fields.html

Problems:

I do not know how to do this: "The key to this is getting the parent issue ID via the parentIssueId form field. Once you have that you can load that issue, get the fields, and set them on the Create Issue dialog." Parent IssueID is not a field I can add to the form.
Should the script below work for text fields? I have ready that I may need to replace "option" with "string" but am uncertain where to do this.

Script (I removed some error-causing items that I don't think I need and retained some standard fields to inherit values from parent):

import com.atlassian.jira.component.ComponentAccessor
import com.atlassian.jira.issue.customfields.option.Option
import com.atlassian.jira.issue.fields.CustomField
//import com.atlassian.jira.web.util.OutlookDate
//import com.atlassian.jira.web.util.OutlookDateManager
import com.onresolve.jira.groovy.user.FieldBehaviours
import com.onresolve.jira.groovy.user.FormField
import groovy.transform.BaseScript

//import java.sql.Timestamp

import static com.atlassian.jira.issue.IssueFieldConstants.*

@BaseScript FieldBehaviours fieldBehaviours

FormField field = getFieldById(getFieldChanged())
FormField parent = getFieldById("parentIssueId")
Long parentIssueId = parent.getFormValue() as Long

if (!parentIssueId || field.getFormValue()) {
// this is not a subtask, or the field already has data
return
}

def issueManager = ComponentAccessor.getIssueManager()
def parentIssue = issueManager.getIssueObject(parentIssueId)
def customFieldManager = ComponentAccessor.getCustomFieldManager()

// REMOVE OR MODIFY THE SETTING OF THESE FIELDS AS NECESSARY
getFieldById(SUMMARY).setFormValue(parentIssue.summary)
//getFieldById(PRIORITY).setFormValue(parentIssue.getPriorityObject().id)

//OutlookDate outlookDate = ComponentAccessor.getComponent(OutlookDateManager).getOutlookDate(Locale.getDefault())
//getFieldById(DUE_DATE).setFormValue(outlookDate.formatDMY(parentIssue.getDueDate()))

//getFieldById(COMPONENTS).setFormValue(parentIssue.componentObjects*.id)
getFieldById(AFFECTED_VERSIONS).setFormValue(parentIssue.affectedVersions*.id)
getFieldById(FIX_FOR_VERSIONS).setFormValue(parentIssue.fixVersions*.id)
getFieldById(ASSIGNEE).setFormValue(parentIssue.assigneeId)
getFieldById(ENVIRONMENT).setFormValue(parentIssue.environment)
getFieldById(DESCRIPTION).setFormValue(parentIssue.description)
getFieldById(SECURITY).setFormValue(parentIssue.securityLevelId)
getFieldById(LABELS).setFormValue(parentIssue.labels)

// IF YOU DON'T WANT CUSTOM FIELDS COPIED REMOVE EVERYTHING BELOW HERE
// IF YOU ONLY WANT SOME FIELDS INHERITED ADD THEM TO THE LIST BELOW, OR LEAVE EMPTY FOR ALL
// eg ['Name of first custom field', 'Name of second custom field']
List copyCustomFields = ['Initiative']

List<CustomField> parentFields = customFieldManager.getCustomFieldObjects(parentIssue)

parentFields.each { cf ->
if (copyCustomFields && !copyCustomFields.contains(cf.name)) {
return
}

def parentValue = cf.getValue(parentIssue)

if (!parentValue) {
return
}

getFieldById(cf.id).setFormValue(parentValue)
log.debug("parentValue: ${parentValue?.class} for type ${cf.name}")

// if (parentValue instanceof Timestamp) {
// getFieldById(cf.id).setFormValue(outlookDate.formatDMY(parentValue))
// } else
if (parentValue instanceof Option) {
getFieldById(cf.id).setFormValue(parentValue.optionId)
} else if (parentValue instanceof List<Option>) {
parentValue = parentValue as List<Option> //This cast is just to placate the static type checker
getFieldById(cf.id).setFormValue(parentValue.collect { it.optionId })
} else {
getFieldById(cf.id).setFormValue(parentValue)
}
}

Accepted answers

All comments

Antoine Berry

Hi,

Are ou trying to do this in behaviours, or in a postfunction / script listener ?

For the latter, you can use this snippet to copy the field value of the parent issue :

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


//Your custom field ID 
int cfId = 10100
def cf = customFieldManager.getCustomFieldObject(cfId)
def cfValue = issue.getCustomFieldValue(cf)
def cfParentValue = issue.getParentObject().getCustomFieldValue(cf)

cf.updateValue(null, issue, new ModifiedValue(cfValue, cfParentValue), new DefaultIssueChangeHolder())

Antoine

Barbara Schnell

I am using a post function. Is the above the entirety of the code I would need? Or are you saying to add this to mine above?

Antoine Berry

Your code looks like a behaviours script, which would not work in a post function.

The code above will update the custom field (id 10100) with the value of this field on the parent issue. So make sure the post function is on a sub-task workflow only or use this condition to check that the issue is a sub-task :

if (issue.isSubTask()){ ...

Antoine

Barbara Schnell

ok, I used the approach of hovering over the custom field to get the cfid (mentioned here https://community.atlassian.com/t5/Jira-questions/How-can-I-find-the-ID-of-a-custom-field-in-Jira-5/qaq-p/272632)

This is the post function now and it still does not work. Do I need a separate workflow for sub-task?

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

int cfId = 1102
def cf = customFieldManager.getCustomFieldObject(cfId)
def cfValue = issue.getCustomFieldValue(cf)
def cfParentValue = issue.getParentObject().getCustomFieldValue(cf)

if (issue.isSubTask()){
cf.updateValue(null, issue, new ModifiedValue(cfValue, cfParentValue), new DefaultIssueChangeHolder())}

Barbara Schnell

I thought it would be good to summarize what finally worked here:

Goals:

Have a story, bug, task, etc. inherit a custom field value from epic upon create.
Have a sub-task inherit a custom field value from a parent task upon create.

Goal 1 Post Function (Copy custom field from Epic to Story upon create):

Create custom post function using script-runner on the Create transition in your workflow.
Script should precede the out-of-the-box "Create the issue originally" post function
Script:

import com.atlassian.jira.component.ComponentAccessor
import com.atlassian.jira.issue.Issue
import com.atlassian.jira.issue.MutableIssue

def customFieldManager = ComponentAccessor.getCustomFieldManager()

def issue = issue as MutableIssue

["Initiative"].each { cfname ->

def cf = customFieldManager.getCustomFieldObjects(issue).find {it.name == cfname}
log.error("cf : " + cf)
log.error("issue : " + issue)

def epicCf = customFieldManager.getCustomFieldObjects(issue).find {it.name == 'Epic Link'}

if (!cf || !epicCf) {return}

def epic = issue.getCustomFieldValue(epicCf) as Issue

if (!epic) {return}

def cfValue = cf.getValue(epic)
log.error("cfValue : " + cfValue)

issue.setCustomFieldValue(cf, cfValue)

}

4. Screen capture: Screenshot 2019-04-04 09.29.07.png

Goal 2 Post Function (Copy custom field from Story to sub-task upon create):

Create custom post function using script-runner on the Create transition in your workflow.
Script should FOLLOW the out-of-the-box "Create the issue originally" post function
Script:

mport com.atlassian.jira.issue.util.DefaultIssueChangeHolder

import com.atlassian.jira.issue.ModifiedValue

import com.atlassian.jira.component.ComponentAccessor

import com.atlassian.jira.issue.index.IssueIndexingService

def customFieldManager = ComponentAccessor.getCustomFieldManager()

int cfId = 11002

def cf = customFieldManager.getCustomFieldObject(cfId)

log.error("cf : " + cf)

log.error("issue : " + issue)

def cfValue = issue.getCustomFieldValue(cf)

log.error("cfValue : " + cfValue)

def cfParentValue = issue.getParentObject().getCustomFieldValue(cf)

log.error("cfParentValue : " + cfParentValue)

def issueIndexingService = ComponentAccessor.getComponent(IssueIndexingService)

issue.store()

issueIndexingService.reIndex(issue)

if (issue.isSubTask()){

cf.updateValue(null, issue, new ModifiedValue(cfValue, cfParentValue), new DefaultIssueChangeHolder())

log.error("Custom field updated on issue " + issue.getKey() + " with value " + cfParentValue)

}

Antoine Berry

Hi Barbara,

As for your first script, I would advise to update it from setCustomField(cf... method to cf.updateValue(... because as you can see here setCustomField does not write in the database. Although in that case, since you have a re-index postfunction, it is working.

You can also remove

def issueIndexingService = ComponentAccessor.getComponent(IssueIndexingService)
issue.store()
issueIndexingService.reIndex(issue)

in the second script I think (or place it after the update).

Interesting to see these two different approachs anyway.

Barbara Schnell

Hi Antoine,

I think I will leave the post functions separate for now since the epic one did not seem to work when I moved to follow the original issue create. I would like your feedback on how to modify the following so it writes to the database though. I'm not exactly sure where to change "setCustomField(cf... method to cf.updateValue(... ":

import com.atlassian.jira.component.ComponentAccessor
import com.atlassian.jira.issue.Issue
import com.atlassian.jira.issue.MutableIssue

def customFieldManager = ComponentAccessor.getCustomFieldManager()

def issue = issue as MutableIssue

["Initiative"].each { cfname ->

def cf = customFieldManager.getCustomFieldObjects(issue).find {it.name == cfname}
log.error("cf : " + cf)
log.error("issue : " + issue)

def epicCf = customFieldManager.getCustomFieldObjects(issue).find {it.name == 'Epic Link'}

if (!cf || !epicCf) {return}

def epic = issue.getCustomFieldValue(epicCf) as Issue

if (!epic) {return}

def cfValue = cf.getValue(epic)
log.error("cfValue : " + cfValue)

issue.setCustomFieldValue(cf, cfValue)

}

Antoine Berry

Hi,

Try this script :

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


def customFieldManager = ComponentAccessor.getCustomFieldManager()
def issue = issue as MutableIssue

def cf = customFieldManager.getCustomFieldObjects(issue).find {it.name == "Initiative"}
def epicCf = customFieldManager.getCustomFieldObjects(issue).find {it.name == 'Epic Link'}

if (!cf || !epicCf) {return}

def epic = issue.getCustomFieldValue(epicCf) as Issue

if (!epic) {return}

def cfEpicValue = epic.getCustomFieldValue(cf)
def cfCurrentValue = issue.getCustomFieldValue(cf)

cf.updateValue(null, issue, new ModifiedValue(cfCurrentValue, cfValue), new DefaultIssueChangeHolder())
issue.setCustomFieldValue(cf, cfValue)

Here you are retrieving the fields by name, i'd suggest using the ID but it is up to you.

Also you can remove the logs from the other script if you don't want to flood.

Antoine

Alan_joc8ak

Hey Antoine:

Tried your script above (to copy custom field value from parent) and got this:

Antoine Berry

Hi @Alan ,

Try executing as is, these are just warnings.

Sebastian Gomez_axdflx

This post was very helpful thank you! @Barbara Schnell @Antoine Berry

Laci

@Antoine Berry How difficult would something like this be to implement based on linked issues? So if I have stories that are derived from features (a level my team added into our hierarchy) I would like a text field flowed from my feature to my story.

Thanks!

wajdan zahid

Hi @Antoine Berry

looking at all the help you have been provided couldn't resist asking one for myself

Thank you first of all.

Can the same thing work for cloning issue in post function script?

I want to add multiple custom fields into description of the issue being cloned.

I am new to scriptrunner and cannot find a good place to look for this feature.

Thank you in advance

Antoine Berry

Hello @wajdan zahid ,

I would advise you create a new question for a thorough answer (you can ping me there), this one is getting messy. It is possible to copy field values to another issue. I am not sure if there is a way to detect that the issue is being cloned upon creation, and I would need to do some testing.

Welcome!

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

Quick Links

Find more posts tagged with

server

scriptrunner

jira

jira-server

sub-task