Custom fields provided by apps

Owned by Rosen Marinkov
Last updated: Jul 26, 2023 by Julver Petrova (Deactivated)
2 min read

On this page:

JQL syntax for app-provided fields

Jira comes with a predefined set of custom field types, but apps by Marketplace vendors in the Atlassian ecosystem also can add their custom field types to Jira.

The extended JQL syntax of Issue Matrix for Jira allows filtering of the values of app custom fields in the current issue.

You can use theĀ Custom JQLĀ mode and theĀ JQL filteringĀ functionality to filter and show the custom field values in the current issue.

Two forms of the extended syntax also apply for custom fields provided by other apps in Jira:

  • Retrieving the custom field value using the id of the custom field

    customField = ${currentIssue.cf[10006]}

    Ā 

  • Retrieving the custom field value using the name of the custom field

    customField = ${currentIssue.cf["Custom field name"]}

When there are multiple custom fields with the same name, we recommend using the custom field id. Otherwise, we can't predict and guarantee the end result.

Some custom fields added by apps can return their values in a format that is not recognized by Jira, for example, an array collection of issue keys like [SP-10, SP-23, SP-34].

In Issue Matrix for Jira, we modify such collections to a string of comma-separated values if they inherit any known class in Jira like MultiSelectCFType, for instance.

If the custom field doesn't inherit any known class in Jira, we do not modify its value and it stays as an array for example. In such cases, there might be modifications to the extended JQL syntax and to the ways to get the end results.
In the list below you can find examples on how to use the extended JQL syntax with custom fields by other apps.

Multiple Issue Picker (by Scriptrunner)

The custom fieldĀ Multiple Issue PickerĀ (provided by Scriptrunner) returns an array collection of issue keys like [SP-10, SP-23, SP-34].

In IssueMatrix, we modify such collections to a string of comma-separated values if they inherit any known class like MultiSelectCFType, for instance. This custom field doesn't inherit any known class in Jira, and that's why we do not modify its value.

It stays as an array of comma-separated keys: [SP-10, SP-23, SP-34].

To compare, a key with any values is necessary only comma-separated values as a string value.

So youĀ can use this JQL to get all the values from the issue picker in the current issues listed in the Issue Matrix:

${currentIssue.cf["Issue picker cf"].join(", ")}

Ā 

Return value description

Comma-separated list of the value of the selected options surroundedĀ by double quotes

Return value example

"Option 1", "Option 2", "Option 3"

Examples

  • Find issues where the value of the "Issue picker cf" custom field is contained in the list of the values for the current Issue:

Ā