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

how to script a rolling budget field

Scott Federman_r83gv8

Hey @Tarun Sapra here it is. This has been a very illusive request. The scenario is that I need to script a rolling budget field.

I have an issue type "Project Budget". This issue type has a "Budget" number field and a scripted "Remaining Budget" field.

There is another issue type called "Order Request" which contains a scripted "Expense" field.

These to issue types are linked using the "Related" link type.

I need to have the "Expense" from all of the order request issues that are linked to the project budget issue subtracted from the "Budget" field and return the "Remaining Budget" in the project budget issue.

Accepted answers

Tarun Sapra

Hello @Scott Federman

If you follow these steps then it should do the trick, basically the script will need to be in the scripted field "Remaining Budget"

Use following pseudo algo in the code

1) Fetch all the linked Issues in the script using this API

https://developer.atlassian.com/static/javadoc/jira/latest/reference/com/atlassian/jira/issue/link/IssueLinkManager.html#getLinkCollectionOverrideSecurity(com.atlassian.jira.issue.Issue)

2) Now, you will have all the linked Issues, then from the linked issues fetch the "Expense" field and do a summation in a loop i.e.

if(expense field is not empty) , then

totalExpense+= expense

3) Now, you have the totalExpense , thus you now need to do return the following in the scripted field - "Remaining Budget"

return (current issue "budget" - totalExpense)

And this should give you the desired value.

Stephen Cheesley _Adaptavist_

Hi Scott,

As per your question here (https://community.atlassian.com/t5/Jira-questions/Listener-script-needed-for-linked-issues/qaq-p/683466#M225230) which I believe is the same, I have tested the script that I gave you (above) in my local instance.

I have managed to get it to work, here is the same script with the field names changed that I had working in my local environment:

import com.atlassian.jira.component.ComponentAccessor

def issueLinkManager = ComponentAccessor.getIssueLinkManager()
def customFieldMgr = ComponentAccessor.getCustomFieldManager()

def budgetField = customFieldMgr.getCustomFieldObjectByName("Budget")
def oeField = customFieldMgr.getCustomFieldObjectByName("Expense")

// Get all of the linked issues for the project budget "issue"
def total = 0
issueLinkManager.getOutwardLinks(issue.id).each {issueLink ->
if (issueLink.issueLinkType.name == "Relates") {
// Linked Issue is going to be your order request
        def linkedIssue = issueLink.destinationObject
        // Get the Budget number field
        total += linkedIssue.getCustomFieldValue(oeField) as Double
    }
}

// Now get the budget field value
def budgetVal = issue.getCustomFieldValue(budgetField) as Double

return budgetVal - total

The setup for my field is:

If you want to let me know what issues you are having then I am happy to try to help you through them.

Thanks,

Steve

All comments

Tarun Sapra

Hello @Scott Federman

If you follow these steps then it should do the trick, basically the script will need to be in the scripted field "Remaining Budget"

Use following pseudo algo in the code

1) Fetch all the linked Issues in the script using this API

https://developer.atlassian.com/static/javadoc/jira/latest/reference/com/atlassian/jira/issue/link/IssueLinkManager.html#getLinkCollectionOverrideSecurity(com.atlassian.jira.issue.Issue)

2) Now, you will have all the linked Issues, then from the linked issues fetch the "Expense" field and do a summation in a loop i.e.

if(expense field is not empty) , then

totalExpense+= expense

3) Now, you have the totalExpense , thus you now need to do return the following in the scripted field - "Remaining Budget"

return (current issue "budget" - totalExpense)

And this should give you the desired value.

Scott Federman_r83gv8

heres what ive been trying to do. but it hasn't worked out. Any ideas?

def issueLinkManager = ComponentAccessor.getIssueLinkManager()
def customFieldMgr = ComponentAccessor.getCustomFieldManager()

def budgetField = customFieldMgr.getCustomFieldObjectByName("Budget")
def oeField = customFieldMgr.getCustomFieldObjectByName("total order expense (\$ )")

// Get all of the linked issues for the project budget "issue"
def total = 0
issueLinkManager.getOutwardLinks(issue.id).each {issueLink ->
if (issueLink.issueLinkType.name == "Related") {
// Linked Issue is going to be your order request
        def linkedIssue = issueLink.destinationObject
          // Get the Budget number field
        total += linkedIssue.getCustomFieldValue(oeField) as Double
    }
}

// Now get the budget field value
def budgetVal = issue.getCustomFieldValue(budgetField) as Double

return budgetVal - total

Stephen Cheesley _Adaptavist_

Hi Scott,

I have managed to get it to work, here is the same script with the field names changed that I had working in my local environment:

import com.atlassian.jira.component.ComponentAccessor

def issueLinkManager = ComponentAccessor.getIssueLinkManager()
def customFieldMgr = ComponentAccessor.getCustomFieldManager()

def budgetField = customFieldMgr.getCustomFieldObjectByName("Budget")
def oeField = customFieldMgr.getCustomFieldObjectByName("Expense")

// Get all of the linked issues for the project budget "issue"
def total = 0
issueLinkManager.getOutwardLinks(issue.id).each {issueLink ->
if (issueLink.issueLinkType.name == "Relates") {
// Linked Issue is going to be your order request
        def linkedIssue = issueLink.destinationObject
        // Get the Budget number field
        total += linkedIssue.getCustomFieldValue(oeField) as Double
    }
}

// Now get the budget field value
def budgetVal = issue.getCustomFieldValue(budgetField) as Double

return budgetVal - total

The setup for my field is:

If you want to let me know what issues you are having then I am happy to try to help you through them.

Thanks,

Steve

Tarun Sapra

what's the error as the code looks fine

Stephen Cheesley _Adaptavist_

Just a quick update, here is a screenshot of it working on a basic test project. The issue that has the expense has a value of 5.

Scott Federman_r83gv8

Hey Steve, Thank you for that. Its returning the same number thats in the budget field.

Here is the error im seeing in the log.

Time (on server): Wed Dec 13 2017 09:39:14 GMT-0600 (Central Standard Time)

The following log information was produced by this execution. Use statements like:log.info("...") to record logging information.

2017-12-13 08:39:14,016 ERROR [customfield.GroovyCustomField]: *************************************************************************************
Script field failed on issue: OPS-616, field: Remaining Budget
java.lang.NullPointerException: Cannot invoke method minus() on null object
 at Script117.run(Script117.groovy:23)

Scott Federman_r83gv8

is that because expenses is a scripted field?

Welcome!

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

Quick Links

Find more posts tagged with

scriptrunner

jira

addon-com.onresolve.jira.groovy.groovyrunner