On this page
Field configuration
Before starting the field configuration, please follow the instructions for creating custom fields: Create a Custom Field
Step 1: Set a name and description
Provide a good name for the new custom field. Make it descriptive, concise, and easy to understand for others who will use it. Avoid using ambiguous or overly technical terms.
Step 2: Default configuration
The Issue Picker can be utilized without additional configuration. For advanced configuration options, refer to the following sections.
Step 3 (optional): add custom JQL including placeholders
To refine the selection of issues available for linking in the issue picker, you have the option to supply custom JQL (Jira Query Language). Additionally, you can employ placeholders that are dynamically replaced with the current issue context.
Placeholders
Consider using the issue picker in a project like 'ACF'; your JQL might appear as follows before and after replacement:
project = {{project.key}}
→ project = ACF
You may use the following placeholders:
{{issue.key}}
, {{issue.type}}
, {{project.key}}
, {{project.type}}
Placeholder usage is limited to the issue view and may not be applicable in the issue create form and JSM request form. Using placeholders will generate an invalid JQL query in the search. For testing purposes, replace them with specific issue information.
Step 4 (optional): Skip permission check
Using this option allows you to bypass Jira permissions in service requests and make all selected issues visible (read-only) to anyone with access to the current service request in your Jira.
Please be careful when using this option and make sure you are aware of the impact.
Needed to be compatible with Jira Service Management
Step 5 (optional): Restrict the number of issues
Utilizing this option allows you to manage and control the number of links that can be established.
This option can lead to confusing behaviour with “reciprocal links“ (Step 6).
Step 5 (optional): Link back
Enabling this option establishes a reciprocal link for each connection made. Consequently, both issues become bidirectionally linked to each other.
Please note that if one side of a bi-directional link is removed, the other link will not be automatically deleted.
If a restricted number of issues is set in step 5, it's possible that the reciprocal link could surpass the maximum allowed. In such instances, you will receive a notification, and the backlink will not be established..
Field view and edit
Field edit
The "Select Issue" autocomplete initially offers a selection of recently accessed issues. You can search for issues based on either the summary or the issue key.
Field edit with maximum
In this scenario, the maximum number of issues is set to 1, and backlinks are enabled.
The current issue has reached its maximum limit (indicated by the purple ).
But the maximum is also reached in CMSP-21, as it seems to already have another link. This is indicated by the and a yellow confirm button.
For this example the backlink from CMSP-21 to the current issue won’t be established.
Field view
Linked issues are displayed along with their key, summary, and status. Clicking on the key opens a link to the respective issue in a new tab.
Related Use Cases
More use cases are coming soon. In the meantime, check out our other use cases.
Jira Service Management (JSM)
Request form: as Jira user
As a Jira user (internal customer), you have the ability to utilize the issue picker within the request form, just as you would in a standard issue form.
Request form: as customer
As an (external) customer, it is not possible to use the issue picker in the request, regardless of whether the 'skip permission check' setting is enabled.
Portal view
The issue picker links are visible to both internal and external customers.
JQL expression
The Issue Picker field can be accessed like this.
${fieldName}.Issues: string[]
Find further information here https://support.atlassian.com/jira-software-cloud/docs/find-specific-issues/
Example: perform a search for all issues that are linked with issue CMSP-19
"Issue Picker.Issues" = CMSP-19
The search will find also issues that have multiple links (for example [CMPS-1,CMSP-19]
)
Data Structure (Automation)
Maximum issues and JQL restrictions are not taken into account and backlinks are not created when using the Issue Picker with automation.
To set the value via automation, you need to at least set the dueDate
value. timeLeft
and formattedTimeRange
are set on the next rendering step in the issue view
{ "keys": string[] }
Example: The current issue is linked with two issues CMSP-1
and CMSP-19
.
{ "keys": ["CMSP-1", "CMSP-19"] }