Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

How to use placeholders for JQL in JSU

Jira Query Language (JQL) allows you to do some advanced searching in Jira's search dialog. This is a very powerful feature provided by Atlassian in Jira. JSU extends JQL with additional placeholders, which will be replaced with the values of the current issue in transition.

...

The easiest way to write a JQL query for JSU is to prepare it first in Jira's standard search interface (use 'advanced search'!) with some sample value. Then copy it to JSU configuration and replace some of your sample values with {issue.FIELD NAME} s as required.


See JQL Use Cases for more examples.

...

(info) We recommend not to use any text fields as placeholders. Or any other field, of which the user can freely change the text. Only use fields which can contain one/several of clearly defined values.

Syntax for Field Names

Field names in your JQL should be the same as in the Advanced Search. We suggest to use the issue navigator's auto-complete feature to get the correct field names. In Jira's top menu bar, go to Issues > Search for issues, and switch to Advanced search.

System Fields

System Fields names should be same as used in JQL. For example:

  • reporter
  • assignee
  • issuetype
  • priority
    etc.

Custom Fields

Custom Fields names also should be same as used in JQL. For example:

...

(info) If you have several custom fields with the same name, you can only use the cf[12345] notation to refer to one of them.

Syntax for Values of the current Issue

Replaceable value from the current issue must be between curly brackets like

{issue.FIELD NAME}

System Fields

Use the place holders from the following list:

...

  • {issue.Affects Version/s}
    Label in the english Jira user interface.
  • {issue.versions}
    Technical field id. See also reference from Atlassian .
  • {issue.affectedVersion}
    JQL's way to refer to that field.

Custom Fields

You can use either the name of a custom field, or its id. For example:

...

(info) If you have several custom fields with the same name, you must use the custom field id.

Troubleshooting

In general it's a good idea to check your log files about any errors and warnings from JSU. Even more when you're using complex JQL queries in JSU.

...