issueFieldMatch
The issueFieldMatch function allows you to search any issue field by specifying a search pattern. This pattern helps you find text that follows a particular format within issue fields.
This is helpful for:
- Extracting specific patterns or data from various issue fields, such as descriptions, comments, or custom fields.
- Allowing for precise matching criteria, particularly useful in large datasets where standard searches might fall short.
- Filtering issues based on nuanced textual content or specific formatting.
How to use the issueFieldMatch JQL function demo video
Syntax and parameters:
issueFieldMatch(Subquery, FieldName, Pattern Match)- Subquery: A JQL query that defines the set of issues to search within. It is essential to make this as specific as possible to optimize performance.
- Field name: The name of the field to search within. This can be a standard field like
descriptionorsummary, or a custom field identified by its name. - Pattern match: The pattern of text to match against the field content.
- Syntax: Our example below uses regex syntax. You can refer to this website which is a regular expressions builder that can help you build an expression and provides definitions for each of the characters.
Examples
Finding issues with a specific pattern in descriptions:
To identify issues where the description contains a specific alphanumeric code pattern (e.g., ABC followed by any four digits):
issueFunction in issueFieldMatch("project = DEMO", "description", "ABC\d{4}")This query is particularly useful for tracking issues related to specific features or errors that are tagged systematically within descriptions.
Matching entire field content:
For cases where the entire field content must match a pattern (not just contain it):
issueFunction in issueFieldMatch("project = DEMO", "customfield_1234", "^ABC\d{4}$")This ensures that the custom field
customfield_1234contains nothing other than the specified pattern, useful for strict data integrity checks.
Optimise the subquery: Ensure the subquery filters down the issues to the smallest possible set to enhance performance and reduce processing time.
Use for custom data extraction: Leverage this function to extract custom data patterns from fields for reports or analytics, especially when such data is not easily accessible through standard JQL.