How to search Elements Connect custom fields with JQL in Jira

The need

As a Jira admin or user, you often need to search for issues based on custom field values, for example, finding all issues linked to a specific CRM account, customer ticket, asset reference, or product code.

Elements Connect lets you integrate external data sources into Jira through connected custom fields. This guide explains how to search for these connected custom fields using Jira Query Language (JQL) in the Jira search view.

The solution

Elements Connect custom fields can be queried in Jira using JQL operators, with the exact syntax depending on the type of connected custom field, snapshot or object. Understanding which JQL operators apply to each field type, and how Jira's JQL autocomplete behaves with each, will let you find relevant Jira issues quickly.

This page covers connected custom fields only. Connected Items use a different search behavior - see the Connected Items documentation for details.

Tutorial

Step 1: Identify your custom field type

Snapshot fields: these are
- Multiple-values select lists,
- Snapshot single-value select lists
- Read-Only Fields (single or multiple values)
Object fields: these are single-value select lists where you decided to store an ID and its corresponding value 👇

Nouveaux visuels documentation Connect (1840 x 900 px) (9).png

Step 2: choose your JQL search operator

For snapshot fields

Use the standard search operators in JQL, such as:
- = (Equals)
- != (Not Equals)
- IS (Empty or Null)
- IS NOT (Empty or Null)
- IN (Matches one of the provided values)
- NOT IN(Excludes multiple provided values)
Example: to find issues where the "CRM Type" custom field matches "Microsoft Dynamics," your query would look like:
```
"CRM Type" = "Microsoft Dynamics"
```
For those fields, you will be able to use autocomplete in JQL mode - you’ll see suggestions as you type in the JQL search bar

For object fields

Searching for full object values (JSON) or specific properties is possible.

Searching on the full object

You’ll need to use the following operators:

~ (Contains)
!~ (Does not contain)
IS (Empty or Null)
IS NOT (Empty or Null)

Example:

Example JQL for searching an object field based on full object:
```
"CRM Type" ~ "Microsoft Dynamics"
```

cross mark Searching on full object, you won’t be able to use autocomplete in JQL mode.

Searching on the object property

Meaning the field ID or Value - You’ll need to use the following operators:

= (Equals)
!= (Not Equals)
IS (Empty or Null)
IS NOT (Empty or Null)
IN (Matches one of the provided values)
NOT IN(Excludes multiple provided values)

Example: If you're searching by an object's ID or value (such as a database entry), you can use search aliases.

Capture d’écran 2024-10-22 à 12.10.47.png

Example JQL for searching an object field based on its value:
```
"CRM Type.Value" = "Microsoft Dynamics"
```

check mark Searching on object properties, you will be able to use autocomplete in JQL mode - you’ll see suggestions as you type in the JQL search bar.