Breadcrumbs

JQL Syntax

See how to use the JQL syntax to search for Requirement Yogi links (Data Center only).

đź“Ś

Requirement Yogi for Jira only (Data Center)

This page relates to Jira only. The Jira module is free, Data Center-supported, and its installation is described in Requirement Yogi for Jira configuration.

  • In Jira 11, the requirementYogiLinks() and requirementYogiKeys() functions are removed in favor of this simpler method (basically: “My Custom Field” = a value),

  • Requires a custom field for your requirements (See Custom field). The reason why it requires a customer field is that it allows us to add an indexer on the issue.

Example

Version

Intent

"My Custom Field" ~ 'REQ-*'

Jira 11+

The custom field has links to requirements starting with REQ-. The wildcard only works at the end, to search for a prefix. No other position works.

"My Custom Field" = 'REQ-001'

Jira 10-11

The custom field contains REQ-001.

… = requirement('REQ-001')

Jira 11+

Equivalent to the previous syntax, but the function has more arguments.

… = requirement('REQ-001', 7)

Jira 11+

The custom field contains a link to REQ-001 in baseline 7.

… = requirement('SP', 'REQ-001', 7)

Jira 11+

Requirement REQ-001, baseline 7, space SP.

… = requirement('SPACEKEY', 'REQ-001', 'CURRENT')

Jira 11+

Requirement can only be in the current version.

… = requirement('SPACEKEY', '*', '*')

… = requirement('SPACEKEY', '*', 7)

Jira 11+

Search for issues with links to requirements in a given space, or in a given baseline.

Wildcards are accepted for the requirement key and the baseline, but not for the space key. When the baseline is specified, the space must be specified as well.

… in requirementYogiKeys('REQ-001')

Jira 9-10

All custom fields which contain the requirement REQ-001.

… in requirementYogiKeys('REQ-%')

Jira 9-10

All custom fields which contain one of the REQ-... requirements.

… in requirementYogiKeys('REQ-001', 3)

Jira 9-10

Requirement REQ-001, in baseline 3.

… in requirementYogiKeys('REQ-001', "CURRENT")

Jira 9-10

Requirement REQ-001, in current version.

… in ('REQ-001', 'REQ-002')

Jira 9-10

The custom field has links to either REQ-001 or REQ-002 (no baseline possible).

In Jira 11:

  • No limit on the number if matched issues,

  • No limit on the number if matched requirements,

  • No limit on the usage of != or NOT.

In Jira 9-10:

  • It is not possible to specify the space key or the Confluence instance,

  • The criteria only matches the first 1000 issues,

  • The NOT criteria doesn’t work well for this field in Jira 8-10.

How to create the custom field

In 2.5, we've introduced the ability to search on the custom field directly:

  • Requires Jira 8.0+,

  • Create a custom field for requirements, in our example we will name the custom field: "RYLinks”

  • When you create the custom field, select the field type “RY Requirement Yogi links”, and that you have configured the relationship.

  • Edit the custom field and enable the "search template" on this field, named "Searcher for RY Links",

  • When you edit the search template, you will need to perform a re-index action so the search syntax can work properly. A popup will usually appear but you can go into System Administration → Advanced → Index, and make sure to tick “Full re-index"

In 2.2 to 2.5 (deprecated)

In 2.2.5, we've introduced a JQL Function named requirementYogiLinks to search for issues that are linked to RY requirements.

Usage: issue in requirementYogiLinks('applink_id', 'relationship', 'space_key', 'key#baseline_number')

Examples :

Example

Intent

issue in requirementYogiLinks('REQ-001')

Issues linked to requirement REQ-001

issue in requirementYogiLinks('REQ-001#3')

Issues linked to requirement REQ-001 in baseline 3

issue in requirementYogiLinks('PROD', 'REQ-001')

Issues linked to requirement REQ-001 and spaceKey PROD 

issue in requirementYogiLinks('abcd-fff1-acef-4343', 'resolves', '*', '*')

Issues linked to requirements from applink 'abcd-...' with relationship "resolves"

issue in requirementYogiLinks('abcd-fff1-acef-4343', '*', '*', '*')

Issues linked to requirements from applink 'abcd-...'

issue in requirementYogiLinks('resolves', '*', 'REQ-001#1')

Issues linked to requirement REQ-001 and baseline 1 with the relationship resolves

Any argument can be replaced with '*' if it's not relevant.