Come for the products,
stay for the community

The Atlassian Community can help you and your team get more value out of Atlassian products and practices.

Atlassian Community about banner
4,294,562
Community Members
 
Community Events
165
Community Groups

Unlock a field with Script Runner

Has anyone used Script Runner to unlock a custom field? The current case is the creating a new metric in Service Desk creates a locked SLA field. If you delete the particular service desk that uses the metric, the custom field is not removed.

4 answers

1 accepted

3 votes
Answer accepted

I think, something like this should work.

import com.atlassian.jira.component.ComponentAccessor
import com.atlassian.jira.config.managedconfiguration.ManagedConfigurationItemService
import com.atlassian.jira.issue.CustomFieldManager

ManagedConfigurationItemService managedConfigurationItemService = ComponentAccessor.getComponent(ManagedConfigurationItemService)
CustomFieldManager customFieldManager = ComponentAccessor.getCustomFieldManager()

def cf = customFieldManager.getCustomFieldObjectByName('My Customfield')

if (cf) {
    def mci = managedConfigurationItemService.getManagedCustomField(cf)
    if (mci) {
        managedConfigurationItemService.removeManagedConfigurationItem(mci)
    }
    customFieldManager.removeCustomField(cf)
}

But, I didn't test it because I don't want to have to set up a new test environment. :-)

Worked like a charm, thanks! For followers: to only unlock the field just comment out the removeCustomField method near the end.

I've heard that unlocking a custom field stops it appearing as a choice in the Add Column with JIRA 6.2 and later. Test this all in a staging JIRA first, as usual.

And from Rene Bodack (kreuzwerker) at https://confluence.atlassian.com/display/AGILEKB/How+to+unlock+a+Locked+fieldto lock the field again:

import com.atlassian.jira.component.ComponentAccessor
import com.atlassian.jira.config.managedconfiguration.ConfigurationItemAccessLevel
import com.atlassian.jira.config.managedconfiguration.ManagedConfigurationItemService
import com.atlassian.jira.issue.CustomFieldManager
ManagedConfigurationItemService managedConfigurationItemService = ComponentAccessor.getComponent(ManagedConfigurationItemService)
CustomFieldManager customFieldManager = ComponentAccessor.getCustomFieldManager()
 
def cf = customFieldManager.getCustomFieldObjectByName('My Customfield')
 
if (cf) {
    def mci = managedConfigurationItemService.getManagedCustomField(cf)
    if (mci) {
        def managedConfigurationItemBuilder = mci.newBuilder();
        def updatedMci = managedConfigurationItemBuilder
            .setManaged(true)
            .setConfigurationItemAccessLevel(ConfigurationItemAccessLevel.LOCKED)
            .build();
        managedConfigurationItemService.updateManagedConfigurationItem(updatedMci);
    }
}


I wonder if customFieldManager.removeCustomField(customFieldObject) will work on locked fields?

There is info how to do it at the database level at https://confluence.atlassian.com/display/AGILEKB/How+to+unlock+a+Locked+field

but I don't want to restart JIRA

Suggest an answer

Log in or Sign up to answer
TAGS
Community showcase
Published in Apps & Integrations

Marketplace Partner Spotlight: AppLiger

This month the spotlight is on AppLiger. We caught up with Pavel Pavlovsky, CEO and Product Manager, to learn how the company started and what fuels the team's creativity.    Atlassian:...

347 views 0 7
Read article

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you