Administrator Guide

The Customfield Editor for Jira enables normal users to edit options of a customfield without beeing part of the jira-administrators group. Therefore the Jira administrator needs to grant permissions on customfields via the Permission Editor to normal users. For all actions described in this Administrator Guide you need Jira administrator privileges.

Permission Editor

To access the Permission Editor click on the Administration Icon in the Jira top navigation bar. In the drop-down click on Manage Apps. Wait while the Apps page is loading. Now click on Permission Editor in the left side navigation.

List Fields

The Permission Editor's List Fields page shows all customfields. Only the supported field types are editable. You can click the edit button for any supported customfield to navigate to the Edit Permissions Page.

Edit Permissions

The Edit Permissions page allows you to grant permissions to single users or groups. Just click into the textfield and start typing, an autocomplete-dropdown will open that let's you select the username or groupname. We recommend using groups for permissions.

You can grant permissions as Global Field Permissions meaning the user or group granted permission can access all contexts of the customfield. Or you can grant Context Permissions meaning you can grant a user or group only permission on one or more contexts of a customfield. If you for example have a project called ›VR-Max‹ and the customfield has a context for this project you can grant permissions on this context, so that users of project ›VR-Max‹ can only edit the options of customfield context linked to ›VR-Max‹.

The screencast GIF below shows how to use the Permission Editor to edit global field and context permissions.


A short note about using usernames for permissions. When doing so be aware that, when deleting a user, the permission is not deleted. Instead it will be kept. Since version 1.7.1 of the app a permission for a deleted user will display ›username ?NO_USER_FOUND?‹ in the user list. For app versions smaller than v1.7.1 please mind bug [CEP-47].

We strongly recommend using groups to grant permissions, since they usually do not change so often and you will not have 'dead users' in your permission user list.


Migration Status and Tasks

Since app version 1.2.1 after a version upgrade the app will automatically execute migration tasks. These migration tasks usually perform internal changes to the apps data storage if needed.

The Migration status should always display ›ok‹. But if you just installed the app or performed a version upgrade and see the status as ›fail‹ click the Execute Migration Tasks button to manually execute the tasks. Usually this should fix the problem and the status should afterwards display ›ok‹.

If the status permanently remains on ›fail‹ please open a ticket in the Issue Tracker and we will help you fix the problem. Usually failed migration task executions happen because of misconfigured base URLs or webserver proxy settings. Try to perform an Instance Health Check before opening an issue to make sure your Jira Installation is working as expected.



To access the Settings click on the Administration Icon in the Jira top navigation bar. In the drop-down click on Manage Apps. Wait while the Apps page is loading. Now click on Settings in the left side navigation.

The Navigation Links Setting lets you hide navigation entries for non-administrator users.

When you change the 'Navigation Links Setting' to 'Hide all administration links ... from non-administrators' a normal Jira user will see the sidebar navigation like this with hidden administrator links :



You will need to purchase a license in the Atlassian Marketplace for the app. You can use a 30 day test-license or buy a license that fits your Jira Host edition.

Without a valid license you cannot use the app and it will show messages like so.

When your testlicense is expired you will need to purchase a license.


You can use the UPM REST API to retrieve detailed App license information.

curl -u admin:admin http://localhost:2990/jira/rest/plugins/1.0/jiracustomfieldeditorplugin-key/license
  "pluginKey": "jiracustomfieldeditorplugin",
  "valid": false,
  "error": "EXPIRED",
  "evaluation": true,
  "nearlyExpired": false,
  "maximumNumberOfUsers": 10,
  "maintenanceExpiryDate": 1548501780385,
  "maintenanceExpired": true,
  "licenseType": "DEVELOPER",
  "licenseTypeDescriptionKey": "DEVELOPER",
  "creationDateString": "10/Sep/12",
  "expiryDate": 1548501780385,
  "expiryDateString": "26/Jan/19",
  "rawLicense": "AAABEA0ODAoPeNp9UE1Pg0AUvO+v...==X02dt",
  "organizationName": "Atlassian",
  "enterprise": false,
  "dataCenter": false,

You can use the same API to set a license or for testing purposes a 3 Hours Timebob License.

curl -u admin:admin -H "Content-Type: application/vnd.atl.plugins+json" -X PUT  -d '{"rawLicense":"LICENSE_HERE"}' http://localhost:2990/jira/rest/plugins/1.0/jiracustomfieldeditorplugin-key/license