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

Developing custom field plugin

Andrew Pechnikov

Hello, dear developers!

I'd like to set my custom field required and as i know there're 2 ways: make it required via Field Configuration Scheme or to make a Validation of this field. The first way is not possible. So the question is : Is it aviable to set validation in customfield which extend TextCFType class? Or are there any methods which can make field required for Project or for Issue?

Best wishes, Andrew

Accepted answers

Jobin Kuruvilla [Adaptavist]

If you want to handle validation during editing, validateFromParams is indeed the method.

but i dont now how to set conclusion on CF value

What do you mean by this?

All comments

Jobin Kuruvilla [Adaptavist]

Where do you need the field as required? In a workflow? or in one purticular step while ediing the issue? While creating?

Nic Brough -Adaptavist-

The "field is mandatory" validators you can find in several plugins (e.g. Jira Suite Utilities) will validate any custom field, you won't need to worry about it.

Andrew Pechnikov

Nic, looks like this plugin adds validation in a workflow

Andrew Pechnikov

Jobin, Nic, much thanks for your response
Jobin, only while editing and creaeting the issue.
Nic, thank you, i will try.

Andrew Pechnikov

So, i tried ti validate it. validateFromParams method works but i dont now how to set conclusion on CF value. PLease help me if you can)

Nic Brough -Adaptavist-

I'm not sure what you are doing, could you explain where you're using that call and give us a brief outline of what you have set up, and what you are trying to do?

Andrew Pechnikov

Simple text customfield. I'm trying to set it's behaviour in plugin. Now o need to set it as required. in class MyCF.java i override method validateFromParams. to set validation which will stop user when he will try to apply issue editing when this CF is empty.

Jobin Kuruvilla [Adaptavist]

If you want to handle validation during editing, validateFromParams is indeed the method.

but i dont now how to set conclusion on CF value

What do you mean by this?

Nic Brough -Adaptavist-

Ah, I missed your previous comment about validating in workflow, rather than field.

Which validateFromParams method are you using? I mean, which class is it coming from or what have you imported to provide it in your code?

(also what does "set conclusion on CF value" mean? Validation should be a simple "valid" or "not valid, here's an error" type process)

Andrew Pechnikov

OMG i ment condition of course))))

public void validateFromParams(CustomFieldParams relevantParams, ErrorCollection errorCollectionToAddTo, FieldConfig config)
    {
    	
    	CustomField customField=config.getCustomField();
    	
    	
    	String selectedString = (String)relevantParams.getFirstValueForNullKey();
        if(!(StringUtils.isNotBlank(selectedString) &amp;&amp; !"-1".equals(selectedString)))

    	{
    			
                errorCollectionToAddTo.addError(customField.getId(), "This custom field is required.");
                

        }
    }

Now it shows message when CF is empty
But strange! When CF is filled with some value pressing on "update" button nothing happens.
No error message and no updating CF values.

Jobin Kuruvilla [Adaptavist]

That should be something to do with your edit template. Do you have the required headers, with custom field id etc, in the edit template?

Andrew Pechnikov

Nic, i explained below. And added some code

Andrew Pechnikov

Yes, i do.

#if($maName!="ThisIsSystemMaNameWhichShowsThatThisFieldDoNotExistsInThatProject")
#customControlHeader ($action $customField.id $maName $fieldLayoutItem.required $displayParameters $auiparams)

&lt;select class="select" name="$customField.id" id="$customField.id"&gt;
    
        &lt;option value="")&gt;$i18n.getText("common.words.none")&lt;/option&gt;
    
    #foreach ($cfValue in $cfValues)
        
            &lt;option#if ($value &amp;&amp; $value == $cfValue) selected="selected"#end value="$cfValue"&gt;$cfValueEncoder.encodeForHtml($cfValue)&lt;/option&gt;
        
    #end
&lt;/select&gt;

#customControlFooter ($action $customField.id $fieldLayoutItem.fieldDescription $displayParameters $auiparams)
#end

I changed customfield display name to maName. All other things i left as default. And yes, my customfild type extends TextCFType, just i needed some customization

Welcome!

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

Quick Links

Find more posts tagged with

custom-field

app