Fields missing from JQL auto complete due to missing customfieldsearcherkey
Platform Notice: Data Center Only - This article only applies to Atlassian products on the Data Center platform.
Note that this KB was created for the Data Center version of the product. Data Center KBs for non-Data-Center-specific features may also work for Server versions of the product, however they have not been tested. Support for Server* products ended on February 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.
*Except Fisheye and Crucible
Summary
Problem
Fields do not appear in auto complete when using advanced search in Issue Navigator. This has been seen after upgrades.
Diagnosis
Check the custom field in the database to see if the "customfieldsearcherkey" is populated.
Use the following to obtain list of custom fields:
1
SELECT id,cfname,customfieldsearcherkey FROM customfield;
Find custom field in the list
If the customfieldsearcherkey is empty then you may be affected by this issue.
If customfieldsearcherkey is empty, proceed to Resolution and attempt to obtain the correct customfieldsearcherkey for this customfield
Cause
It is unknown how the data got into this state.
Solution
Resolution
Step 1: Obtain Correct Value
First, obtain the correct "customfieldsearcherkey" for the field and add it to the database.
If you find that the customfieldsearcherkey is empty in all cases then you may be affected by a different problem. Contact Atlassian Support for assistance. Provide the following when contacting support:
Link to this article
Results of the diagnosis database query
Methods to obtain correct value:
1) Look at another instance of JIRA with this same custom field
This may be a new instance you set up to get the correct value, or it could be an existing instance of JIRA that is the same version and has the same custom field.
2) Look in an XML backup that was created before this problem occurred
Search for "<CustomField id=######" where ###### is the ID of the field identified in the Diagnosis section
Step 2: Add Value to Database
Always back up your data before making any database modifications. If possible, test any alter, insert, update, or delete SQL commands on a staging server first.
1) Make a backup of your data
2) Shutdown JIRA
3) Add value using the following SQL, or similar SQL:
1
2
3
UPDATE customfield
SET customfieldsearcherkey = 'XXXXXXXXXXXXX'
WHERE id = ######;
----NOTES----
Replace "XXXXXXXXXXXXX" with the correct customfieldsearcherkey
Replace "######" with the ID of the field identified in the diagnosis step
4) Start JIRA
5) Reindex JIRA
Examples
The following is an example of how the Epic custom fields appear. These fields were create by JIRA Software (JIRA Agile).
These examples show the correct customfieldsearcherkey for these particular fields.
1
2
3
4
<CustomField id="10002" customfieldtypekey="com.pyxis.greenhopper.jira:gh-epic-link" customfieldsearcherkey="com.pyxis.greenhopper.jira:gh-epic-link-searcher" name="Epic Link" description="Choose an epic to assign this issue to."/>
<CustomField id="10003" customfieldtypekey="com.pyxis.greenhopper.jira:gh-epic-status" customfieldsearcherkey="com.pyxis.greenhopper.jira:gh-epic-status-searcher" name="Epic Status" description="Epic Status field for JIRA Software use only."/>
<CustomField id="10004" customfieldtypekey="com.pyxis.greenhopper.jira:gh-epic-label" customfieldsearcherkey="com.pyxis.greenhopper.jira:gh-epic-label-searcher" name="Epic Name" description="Provide a short name to identify this epic."/>
<CustomField id="10005" customfieldtypekey="com.pyxis.greenhopper.jira:gh-epic-color" customfieldsearcherkey="com.pyxis.greenhopper.jira:gh-epic-color-searcher" name="Epic Color" description="Epic Color field for JIRA Software use only."/>
select * from customfield where customfieldtypekey like '%epic%';
id | customfieldtypekey | customfieldsearcherkey | cfname | description | defaultvalue | fieldtype | project | issuetype |
---|---|---|---|---|---|---|---|---|
10003 | com.pyxis.greenhopper.jira:gh-epic-status | com.pyxis.greenhopper.jira:gh-epic-status-searcher | Epic Status | Epic Status field for JIRA Software use only. | ||||
10004 | com.pyxis.greenhopper.jira:gh-epic-label | com.pyxis.greenhopper.jira:gh-epic-label-searcher | Epic Name | Provide a short name to identify this epic. | ||||
10005 | com.pyxis.greenhopper.jira:gh-epic-color | com.pyxis.greenhopper.jira:gh-epic-color-searcher | Epic Color | Epic Color field for JIRA Software use only. | ||||
10001 | com.pyxis.greenhopper.jira:gh-epic-link | com.pyxis.greenhopper.jira:gh-epic-link-searcher | Epic Link | Choose an epic to assign this issue to. |
Was this helpful?