Troubleshooting JQL Functions

This page covers some issues users may face when using ScriptRunner JQL functions:

• JQL function isn't returning any results / JQL function isn't appearing
• IssueFunction is not available due to indexing problems

JQL function isn't returning any results / JQL function isn't appearing

If you use multiple plugins to alter JQL functionality, you may encounter a case where function names are the same in each plugin. There are several plugins such as Power Script and JQL Tricks which use the same function names such as hasAttachments() and subtasksOf(). As the keys for these plugins appear first alphabetically, their functions take precedence over ScriptRunner functions, as designed by Atlassian. 

In cases where function names clash, you need to disable a function because the two plugins essentially cancel each other out. For example, if two plugins use the function subtasksOf() you need to disable one to be able to use the other.

Verify the problem

Go to ScriptRunner > JQL Functions and verify if the function is present. If not, it is likely that there is another plugin installed and enabled on your instance which uses the same function name. 

Workaround

If you want to use both plugins you need to disable the clashing JQL function module for one of the plugins. To disable a module proceed as follows:

1. Go to Administration > Manage apps. 
2. Select Manage apps.
   
3. Expand the plugin with the module you want to disable.
4. Select xx of xx modules enabled.
   All modules display below the license information. 

5. Find the module you want to disable.

   The following is an example of a ScriptRunner JQL module.

   You may want to use the search function (command + F or Ctrl + F) to find the module. 

   

6. Select Disable. 
7. Go to ScriptRunner > JQL Functions and verify if the function is now present where it was previously missing.

IssueFunction is not available due to indexing problems

Most ScriptRunner JQL functions work by using a custom field called issueFunction. This field is managed (locked), so it can't be on any screen and has a global context.

The Lucene indexers associated with issueFunction maintain the index data that allows the ScriptRunner JQL functions to work.

In extremely rare circumstances, Jira decides that the issueFunction field is not in scope for particular issues despite its global scope. This can result in problems with the affected issues either incorrectly appearing in the results of queries (such as linkedIssuesOf), or being missed from those results.

It appears that the issue in recognising issueFunction as a global custom field is due to a referential integrity problem in Jira's database, which could be caused by another plugin, or perhaps direct database edits.

Verify the problem

You can verify if Jira considers issueFunction out of scope by running the following script in the Script Console. Update ABC-1 in the script below to reference an existing issue you suspect is not being reindexed. If this script returns true, then reindexing is not the problem. If it returns false, follow the instructions in the workaround below. 

 
import com.atlassian.jira.component.ComponentAccessor

def customFieldManager = ComponentAccessor.customFieldManager
def issueManager = ComponentAccessor.issueManager

def fields = customFieldManager.getCustomFieldObjectsByName('issueFunction')
assert fields.size() == 1
def issueFunction = fields.first()

def issue = issueManager.getIssueObject('ABC-1') // CHANGE THIS ISSUE KEY

issueFunction.isInScope(issue.projectId, issue.issueTypeId)

Variation 

There is a variation of this problem where the custom field becomes hidden in a particular configuration scheme. To detect this issue, run the script below. If this script has any result, other than No problems, contact support.

 
import com.atlassian.jira.component.ComponentAccessor

def field = ComponentAccessor.customFieldManager.getCustomFieldObjects().find { it.name == 'issueFunction' }
assert field

ComponentAccessor.fieldLayoutManager.getEditableFieldLayouts().findAll {
    it.getFieldLayoutItem(field.id).isHidden()
}*.name ?: 'No problems'

Workaround

The workaround is to delete the issueFunction field using a script, disable then enable the ScriptRunner plugin, and then re-index Jira. When the plugin starts it will recreate this field. 

1. Enter the following script into the Script Console to delete the issueFunction field.

    
   import com.atlassian.jira.component.ComponentAccessor
   
   def customFieldManager = ComponentAccessor.customFieldManager
   def fields = customFieldManager.getCustomFieldObjectsByName('issueFunction')
   
   assert fields.size() == 1
   
   def field = fields.first()
   
   customFieldManager.removeCustomField(field)

2. Go to Administration > Manage apps. 
3. Select Manage apps.
   
4. Expand Adaptavist ScriptRunner for JIRA.
5. Select Disable.
   
6. Once disabled, select Enable. (You could also restart Jira instead).
7. Re-run the verification script. This should now return true where previously it returned false.
   JQL functions should now work for issues created or edited after this point.

8. Run a full re-index of Jira (foreground or background) at a time convenient to you to ensure all issues are correctly indexed.
   

   If you know which projects are affected, you can re-index specific projects rather than the entire Jira instance.