Introduction

The JQL Lookup Field type can be used to show field values from one or more issues, as a read-only field on your issue. 

JQL Lookup field can only be used to display field values from another issue so this field cannot be edited.

The field also is not indexed and cannot be used in JQL searches.

Configuration

The field is configured through the config screen which is accessed like any other Jira custom field.

  • Go to "Administration >> Issues >> Custom Fields".
  • Find the JQL Advanced Select custom field that you want to configure.
  • Select the "Configure" menu item in the cog menu next to the field.
  • Click "Edit JQL Lookup Field" link.
  • The following config screen should appear.


JQL Pattern

You can enter any valid JQL for this settings. 

The issues returned by this JQL query will be rendered according to the View Pattern setting and will be shown as the value of this field.

You can use a static JQL query or use Token Strings in your query to create dynamic queries.

Please see JIS v2.0 - Dynamic Patterns for creating dynamic queries.

The ability to reference other JQL Advanced Fields in your dynamic JQL query makes this field especially powerful.

By referencing other JQL Advanced Fields, you can make JQL Lookup fields bring field values from issues selected in JQL Advanced Fields.

Quotes

This setting makes a difference when using dynamic JQL queries. It detemines whether to use single or double quotes while replacing Token Strings in your JQL query with the calculated values.

Double quotes are the default and will work for most cases. You can use single quotes for complex JQL's when you need to quote values inside an already double quoted string.

View Pattern

The Pattern you set here will determine how the issues selected in your field will be displayed on Jira pages.

The selection affects both view, edit screens and also issue navigator screen.

The pattern you enter here is expected to be a dynamic text as described in JIS v2.0 - Dynamic Patterns.

Value Pattern

This field has no Value Pattern since it cannot be edited and no value for this field is saved in the database.


Test

The right-hand side of the config screen includes a Test area which allows you to test your configuration with a sample issue.

Just enter an issuekey to the textbox and click "Test". The JQL Pattern and View Pattern will be calculated based on the issue you picked and will be shown below.







  • No labels