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

Set custom field value [Script Runner]

Lars Sundell

I try to use Scriptrunner to set Epic Status as part of a issue flow.

The Idea is to attach a script as a post function.

To keep it as simple as possible (to write the script) and as flexible as possible as different projects has different workflows the idea is to have three differnt scrips.

Setting Epic status to "Done"
Setting Epic status to "In Progress"
Setting Epic status to "To Do"

I have done some searches and have found some suggestions I have tried. I have also tried to reverse engineer (See disclaimer) some code to test variants of the code i have found.

As of now I have the following code (some lines added to run it in console):

import com.atlassian.jira.component.ComponentAccessor

// Name of the custom field to change
final customFieldName = "Epic Status"
// New value for that field 
final newValue = "Done"

// Console only section
def issueManager = ComponentAccessor.issueManager // console Only
def issueKey = "PLA-136" // console only
def issue = issueManager.getIssueObject(issueKey); // console Only
// end of console only section

def customFieldManager = ComponentAccessor.customFieldManager
def customField = customFieldManager.getCustomFieldObjects(issue).find { it.name == customFieldName }
//def customField = customFieldManager.getCustomFieldObjectsByName(customFieldName)
log.warn("Value of customField=$customField")
assert customField: "Could not find custom field with name $customFieldName"

issue.setCustomFieldValue(customField, newValue)

The problem is that the code executes without errors, but the issue test on is not updated when I run the script, Epic status still is "To Do".

I see from the documentation that setCustomFieldValue does not actually update the db:

"Sets a custom field value on this Issue Object, but does not write it to the database. This is highly misleading.
To actually set a custom field value, use OrderableField.updateIssue(com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem, MutableIssue, java.util.Map)"

I suspect that this is the problem, but I have no idea on how to use the OrderableField.updateIssue function to achieve this.

Disclaimer:

I have no experience with writing groovy or java in any other that trying to reverse engineer code.

BTW: We use JIRA Server 8.5.6

Accepted answers

Nic Brough -Adaptavist-

Ok, that's not going to work, it's completely the wrong approach. You're not alone in landing here though, it's an easy mistake.

Epic Status is not a real issue field, it is derived from the status of the Epic the story is linked to. You can't set it for any given issue because the issue is looking to its Epic, not data on the issue.

On top of that, it's not a real custom field on the Epic either, again, it's derived from the actual status of the Epic. And that is not a field, it is an indicator of a position in the workflow of the Epic.

If you wish to change the Epic status on an issue, you need to change the status of the Epic, not a field on the issue. This means transitioning the Epic through its workflow. And bear in mind that affects ALL issues that are linked to the Epic because they're all looking at the same Epic status

All comments

Nic Brough -Adaptavist-

Ok, that's not going to work, it's completely the wrong approach. You're not alone in landing here though, it's an easy mistake.

Lars Sundell

Hello and thanks for the reply.

That is strange, my problem is that the epic status is NOT linked to the status of the epic, or the stories/issues in the epic. The filed is also listed in the

This page is one of many that talks about the issue and proposes using the JSU plugin to do exactly what I am trying to achieve. We do not have that plugin so I try to do the same with Scriptrunner.

Adaptavist even have this example, I just can get it to work.

I am able to manually (or by bulk edit) change the Epic status independent of other fields in the epic and have not seen any claim that it is an automated field (unless the JIRA admins has set up a script similar to what I am trying to do).

I have also tried changing other custom fields (that has nothing to do with epics/agile) , both text fields and select fields, but that does not get updated either.

Nic Brough -Adaptavist-

Ah, I didn't know you could set it yourself, I've never seen the point if you're just following the Epic workflow as intended.

The problem you've got with your script is that Epic Status is a field type that works differently to real fields. My "It's not a real field" is a very poor way to describe it, but the long explanation is very boring.

The field is of a type that is similar to select-lists. With a select list, you can't just jam a string into them, they need a pointer to a more complex object - an "option". One of the reasons your code is working without error is because a select list has code that returns errors if you feed it the wrong thing. The Epic Status does not, it just accepts any input and ignores it if it is not valid.

You need to extract the "option" representing "done" from the list of options and feed that back into the field.

The SR code you've found is for text fields, you should be using a select list as the basis - see https://library.adaptavist.com/entity/update-a-single-select-drop-down-custom-field (I have not tested it, but I'm 99% sure it will work fine if you change the custom field name to Epic Status, and the option it is searching for to "Done")

Lars Sundell

Thanks a lot!

The method you point to works as expected

I guess I am too used with python that lets you get a way with anything. On top of that I was unable to even update a custom text field when using the setCustomField method.

The script now works both in console and as a post script for a transaction in a workflow. The final version looks like this (with console specific lines commented out)


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

// Name of the custom field to change
final customFieldName = 'Epic Status'
// New value for that field 
final newValue = "Done"

// Console only section
//def issueManager = ComponentAccessor.issueManager // console Only
//def issueKey = "PLA-136" // console only
//def issue = ComponentAccessor.issueManager.getIssueByCurrentKey(issueKey)
//assert issue: "Could not find issue with key $issueKey"
// end of console only section

def customField = ComponentAccessor.customFieldManager.getCustomFieldObjects(issue).findByName(customFieldName)
assert customField: "Could not find custom field with name $customFieldName"
log.warn("Value of customField=$customField")

def availableOptions = ComponentAccessor.optionsManager.getOptions(customField.getRelevantConfig(issue))
def optionToSet = availableOptions.find { it.value == newValue }
assert optionToSet: "Could not find option with value $newValue. Available options are ${availableOptions*.value.join(",")}"

customField.updateValue(null, issue, new ModifiedValue(issue.getCustomFieldValue(customField), optionToSet), new DefaultIssueChangeHolder())

Welcome!

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

Quick Links

Find more posts tagged with

server

scriptrunner

custom-field

jira

jira-server

atl-gruland