Community
Products
Jira
Questions
How to filter Module custom dropdown based on Component/s selection?

How to filter Module custom dropdown based on Component/s selection?

We are using the JIRA Native component/s field for our components. We have a custom field called Module for the specific aspect of the component that needs attention.

We have over 100 custom modules in the entire list; only 4 or 5 at a time can apply to any one component.

Can we write a behavior to filter those 100+ values to show only those applicable to the selected component?
I took a peek at Default Values but am not savvy enough to figure it out on my own.

(Adaptavist declined to work on this issue due to staffing/time restrictions in relation to scripting queries and directed me to Atlassian Answers.)

3 answers

1 accepted

1 vote

Answer accepted

Hi Lacey,

try something like the script below (assign it to Component fields)

def compForm = getFieldById(IssueFieldConstants.COMPONENTS)
def module = getFieldByName("Module")

def componentModuleMappings = [
    "Component B" : ["A", "B", "D"],
    "Component A" : ["A", "I", "L"],
    "Component C" : ["K", "M"],
]

def selectedComponents = compForm?.value as List

if (! selectedComponents) {
    // no components selected, do something
    compForm.clearError()
} else if (selectedComponents.size() &gt; 1) {
    // more than one components selected, display an error message
    compForm.setError("Please select only one component")
} else if ( selectedComponents.size() == 1) {
    // exactly one component selected, set the available options for the module field
    compForm.clearError()

def selectedCompName = selectedComponents[0]?.name
log.debug "Selected Component : ${selectedCompName}"
def moduleOptionValues = componentModuleMappings.get(selectedCompName)
    def optionManager = ComponentAccessor.getOptionsManager()

    def moduleCFConfig = ComponentAccessor.
        getCustomFieldManager().
        getCustomFieldObjectByName("Module")?.
        getRelevantConfig(issueContext)

    def optionsForModule = optionManager.getOptions(moduleCFConfig).findAll { it.value in moduleOptionValues }
    module.setFieldOptions(optionsForModule)
}

Please let me know if this does the trick. If this does not work please let me know what kind of error you get in your logs and please let me know how you "changed the Component/s field to render as a single select"

regards, Thanos

You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.

Comment

Well, I had removed from WEB-INF the "multiple" line but it looked stupid. So I restored the clause, restarted the instance, and now I have a global behavior instead to limit it to one choice:

def formComponent = getFieldById(getFieldChanged())
// if it's a list it has more than one value
if (formComponent.getFormValue().getClass().toString().contains('List')) {
    def List compos = []
    formComponent.getFormValue().each{obj-&gt;
        try{
            def objint = obj as int
                    compos.add(objint)
        }
        catch(e){}
         
    }
    if (compos.size() &gt; 1){
    formComponent.with {
        setValid(false)
        String s = "Please select only one component."
        setTitle (s)
        setHelpText("&lt;div class=\"warningBox\"&gt;$s&lt;/div&gt;")
    }                      }
}
else {
    formComponent.with {
        setValid(true)
        setTitle ("")
        setHelpText("")
    }
}

Same thing for fix version only where you see "Component" it says "fixVersions"

As for MODULE:

This is closer than I got. At least it has an effect at all - unfortunately, that effect is to completely remove all values from Module

It reads as an error on def selectedCompName = compForm?.value[0].name as List where it couldn't find a matching method java.lang.Object#getAt(int) ....

You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.

Comment

The only line in the atlassian-JIRA log I see that is remotely related to my issue update attempt is:

2016-11-11 15:50:10,491 http-bio-8080-exec-2 WARN Lacey87143 950x28024x2 gk1jak 10.255.250.124 /secure/AjaxIssueAction!default.jspa

You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.

Comment

Ok, Lacey what I can propose to leave the components field as a multi-select list and display an error message if more than one component is selected (with a behaviour),

I updated the script above. Hope that is better.

You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.

Comment

That script is what I had but applied to a separate Behavior called "Defaults" But now I see how to tie it into another rule! Thank you

Unfortunately, Module is still coming up blank, and it throws an error on "compForm?.value[0].name"

You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.

Comment

Hi Lacey,

The error you see is a static type checking error, ignore it. The Module will come blank if there is not the available Component - Module pair in the componentModuleMappings map.

Just added a debug message on the script above, so enable logging and check your log files.

You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.

Comment

That tipped me off - the spaces.

I had

" LOB - UK - Small Office ": [" Document ",     
    " Forms",     
    " Performance ",     
    " Premium Summary ",     
    " Rating ",     
    " Surcharges ",     
    "Tables ",     
    "Transactions ",     
    " UI "],

I took out the spaces and all is well

Have I told you lately that I love you????? :* THANK YOU

You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.

Comment

Glad that helped to sort it out, and for your kind words.

You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.

Comment

0 votes

@Thanos Batagiannis [Adaptavist] Here's an updated version of your solution for recent Jira API

import com.atlassian.jira.component.ComponentAccessor
import com.atlassian.jira.issue.IssueFieldConstants
import static com.atlassian.jira.issue.IssueFieldConstants.*
import com.atlassian.jira.issue.MutableIssue
import com.atlassian.jira.issue.CustomFieldManager;
import com.atlassian.jira.issue.fields.CustomField;

def compForm = getFieldById(IssueFieldConstants.COMPONENTS)
def module = getFieldByName("Module")
def customField = customFieldManager.getCustomFieldObject(module.getFieldId())

def componentModuleMappings = 
[

"Issue Data":
[
"Training",
"New Field"
],
"Projects":
[
"Training",
"Other"
]
]

def selectedComponents = compForm?.value as List

if (! selectedComponents) {
// none selected, do nothing
compForm.clearError()
}
else if (selectedComponents.size() >1) {
// more than one, throw an error
compForm.setError("To best service your request, please select only one Component. Each Component should have its own ticket. This helps us group similar incoming requests for review and approval.")
}
else if (selectedComponents.size() == 1) {
// exactly one selected, set available options for Modules field 
compForm.clearError()

def selectedCompName = selectedComponents[0]?.name
log.debug "Selected Component : ${selectedCompName}"
def moduleOptionValues = componentModuleMappings.get(selectedCompName)
def optionManager = ComponentAccessor.getOptionsManager()
def customFieldManager = ComponentAccessor.getCustomFieldManager()

def moduleCFConfig = customField.getRelevantConfig(getIssueContext())

def optionsForModule = optionManager.getOptions(moduleCFConfig).findAll {it.value in moduleOptionValues}
module.setFieldOptions(optionsForModule)
}

You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.

Comment

0 votes

import com.atlassian.jira.ComponentManager
import com.atlassian.jira.component.ComponentAccessor
import com.atlassian.jira.issue.CustomFieldManager
import com.atlassian.jira.issue.fields.CustomField
import com.atlassian.jira.component.ComponentAccessor;
import com.atlassian.jira.issue.CustomFieldManager;
import com.atlassian.jira.issue.fields.CustomField;
def customFieldManager = ComponentAccessor.getCustomFieldManager()
def optionsManager = ComponentAccessor.getOptionsManager()
def formModule = customFieldManager.getCustomFieldObject('Module')
def projectComponentManager = ComponentAccessor.getProjectComponentManager()
def components = projectComponentManager.findAllForProject(issueContext.projectObject.id)
def config = formModule.getRelevantConfig(getIssueContext())
def options = optionsManager.getOptions(config)
if (components == 'LOB - Classic CPP') return formModule = (options.findAll {it.value in 
['Document','Forms','Performance','Premium Summary','Rating','Surcharges','Tables','Transactions','UI']})
if (components == 'LOB - Commercial Package') return formModule = (options.findAll {it.value in 
['Document','Forms','Performance','Premium Summary','Rating','Surcharges','Tables','Transactions','UI']})

This says correct and it is definitely not working. @Thanos Batagiannis [Adaptavist] lol any ideas?

You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.

Comment

Hi Lacey,

As far as I understand let's say you want when Comp A is selected the available for selection options for the Single Select Module Custom Field to be A, B, C and if the Comp B is selected then available options to be A, B.

But the components is a multi select therefore what options you expect the field Module to have when Comp A and Comp B are selected as components ?

You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.

Comment

I changed the Compoent/s field to render as a single select

You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.

Comment

import com.atlassian.jira.ComponentManager
import com.atlassian.jira.component.ComponentAccessor
import com.atlassian.jira.issue.CustomFieldManager
import com.atlassian.jira.issue.fields.CustomField

def customFieldManager = ComponentAccessor.getCustomFieldManager()
def optionsManager = ComponentAccessor.getOptionsManager()
def formModule = customFieldManager.getCustomFieldObject('Module')
def projectComponentManager = ComponentAccessor.getProjectComponentManager()
def formComponent = getFieldById("components")
def config = formModule.getRelevantConfig(getIssueContext())
def options = optionsManager.getOptions(config)

Object componentFormValue = formComponent.getValue()

if (componentFormValue == 'LOB - Classic CPP')

formModule = (options.findAll {it.value in
['Document','Forms','Performance','Premium Summary','Rating','Surcharges','Tables','Transactions','UI']})

else if (componentFormValue == 'LOB - Commercial Package')

formModule = (options.findAll {it.value in
['Document','Forms','Performance','Premium Summary','Rating','Surcharges','Tables','Transactions','UI']})

still not working lol

You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.

Comment

Another one question... So you want to fill the Module Select List with default options or to change the available options ? (something like a cascading select list where the right options depend on the left selected option)

You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.

Comment

I want to change the available options like a cascading select.

(i.e. we have custom field MODULE values 1-100. if we select JIRA native field COMPONENT/S value A I want to Module dropdown to only show values 2,6,77,90),

You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.

Comment

Hi @Thanos Batagiannis [Adaptavist] ,

You are deserving of even more love than Lacey gave you!

I love you too!

You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.

Products

Community resources

Support

Top groups

Community resources

Support

Learn

Community resources

Support

Events

Community resources

Support

Get product advice from experts

Join a community group

Advance your career with learning paths

Earn badges and rewards

Connect and share ideas at events

How to filter Module custom dropdown based on Component/s selection?

3 answers

1 accepted

Suggest an answer

Was this helpful?

Thanks!

TAGS

Community showcase

Atlassian Community Events

Ask a question

Products

Community resources

Support

Top groups

Community resources

Support

Learn

Community resources

Support

Events

Community resources

Support

Get product advice from experts

Join a community group

Advance your career with learning paths

Earn badges and rewards

Connect and share ideas at events

How to filter Module custom dropdown based on Component/s selection?

3 answers

1 accepted

Suggest an answer

Was this helpful?

Thanks!

TAGS

Community showcase

Atlassian Community Events