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

2 votes
Henning Tietgens Community Champion Jan 20, 2014

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.

0 vote

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

0 vote

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

0 vote

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


Suggest an answer

Log in or Sign up to answer
Atlassian Community Anniversary

Happy Anniversary, Atlassian Community!

This community is celebrating its one-year anniversary and Atlassian co-founder Mike Cannon-Brookes has all the feels.

Read more
Community showcase
Bridget Sauer
Published Thursday in Marketplace Apps

Calling all developers––You're invited to Atlas Camp 2018

 Atlas Camp   is our developer event which will take place in Barcelona, Spain  from the 6th -7th of   September . This is a great opportunity to meet other developers and get n...

355 views 0 6
Read article

Atlassian User Groups

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

Find a group

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

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you