The Adaptavist Group LogoDocumentation

componentMatch

The componentMatch function allows you to find issues based on components whose names match a specified text pattern. This functionality is helpful for:

  • Segmenting issues by specific component categories
  • Enhancing the organisation of issues within larger projects, where components may be numerous and varied
  • Grouping issues according to component characteristics defined by text patterns

Syntax and parameters:

componentMatch(Pattern Match)
  • Pattern match: A specific text pattern to be matched by component names.

  • 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.
  • Project keys (optional): A comma-separated list of project keys to narrow down the search. Specifying project keys improves query performance by limiting the search scope.

Example

  1. Finding issues with components starting with 'Web':

    For teams looking to manage or review all tasks related to web components:

    component in componentMatch("^Web.*")

    This query is particularly useful for teams responsible for web development or web-based services, enabling them to easily gather all relevant issues.

  2. Restricting the search to find specific projects:

    To enhance performance and focus on specific projects:

    component in componentMatch("^Web.*", "DEMO, EXAMPLE, TEST")
Tip:

Use precise pattern match: To ensure that your queries return the most relevant results, specifically match the naming conventions used for components within your projects.

Regular updates and reviews: As projects evolve and new components are added, regularly update and review your component-based queries to ensure they continue to meet your project management needs.

Combine with other queries: Use componentMatch in conjunction with other JQL functions for more comprehensive issue searches. For example, combining component matching with issueType or status filters can refine your issue management process further.

Search documentation

Start typing to search the docs.