Is there a way to get all the JQL functions on my server?

Christian Nielsen

I have a list of all the core JIRA JQL functions, but the add-ons sometimes also supply extra functions.

 

Is there a way to dump a list of all the JQL functions my server understands so that I can create a compendium of documentation for our users?

 

At present I have to go read the user documentation of all the plugins when they get updated and that is taking a very long time.

Earl McCutcheon

Hello Christian,

In this specific scenario referring to the documentation for the Jira native JQL functions and then the Documentation for any of the third party applications you have installed for a list and description of the functions would be your best bet, as the JQL is not a value stored as an item that lives in the database but is called from system files and runs as a function in the application.  There would not be an easy way to generate a list, and listing of this nature already exist in the docs. 

A comprehensive list of all the Jira Native JQL functions is covered in the Advanced Searching documentation There is a table in the section Reference, use the Expand links titled "Show list of" then either fields, operators, keywords, or function for the high level list, then under the Reference page for each section of the table will take you to the functionality referance pages for the full list of capabilities of each parameter of the JQL functions.

Then For the add-ons it's going to be up to the vendors documentation site for similar data to the extended functions, links to a vendors documentation can be found under the support tab of the marketplace listing of an add-on.  While time consuming making internal documentation with links to the the functions would be useful, as well as reviewing the add-on release notes for changes and new functionality in updated versions.

Its highly unlikely that an add-on vendor would not have the functions fully documented but for some reason If you re unable to locate a specific document from an add-on you would need to reverse engineer the plugin data to attempt to retrieve the data about the functions provided, the following document in our Developer documentation space covers how a JQL add-on can be built, you would need to locate and extract the pom.xml and dig into the file looking for the JQL Functions:

• https://developer.atlassian.com/server/jira/platform/adding-a-jql-function-to-jira/

Regards,
Earl