Document toolboxDocument toolbox

Configuration

Issue Preview for Jira is easy to use, both for administrators and for users. You just have to configure which fields you want to see in the hover, and that's it!

Setting up the list of fields

1. As a Project administrator:

Go to Project Settings → Issue preview for Jira. There are 3 main actions you can do here:

1.1 Project Issue Preview

This is the main section for configuring Issue Preview for your Project. You can either opt to use the Global Issue Previews configured by the Jira Administrators, or you can Override them for your project. If you override them, you can set a Preview for all Issues (All remaining issues), or per a specific JQL.

Issues will be checked against the list, top to bottom, and assigned a Issue Preview based on the first matching JQL statement. The last option will be chosen if the issue does not match any other JQLs.

For each JQL in this table, you can either have a list of fields, or leave empty to not display any Issue Previews. JQLs are sortable, so you can easily change the priority.

Be reminded that the order of fields is configurable. You can change the order of the fields with drag and drop, or you can add new fields at the end of the list.

1.2 See Global Issue Preview

You can see the Global Issue Previews. Issues will be checked against the list, top to bottom, and assigned a Issue Preview based on the first matching JQL statement. The last option will be chosen if the issue does not match any other JQLs.

1.3 Test your Issue Preview here

After you finished your configuration, you can preview any hover you want. Put a valid Issue Key from your project and click on Preview to get a URL to that issue. Hover it to see the fields you selected.

2. As a Jira administrator:

Go to Jira Administration → Manage apps → Issue preview configuration. There are 4 main actions you can do:

2.1 Set Global Issue Preview

You can se a list of Global Previews. Projects can use this (by default), or override it. You can set a Preview for all Issues (All remaining issues), or per a specific JQL.

Issues will be checked against the list, top to bottom, and assigned a Issue Preview based on the first matching JQL statement. The last option will be chosen if the issue does not match any other JQLs.

For each JQL in this table, you can either have a list of fields, or leave empty to not display any Issue Previews. JQLs are sortable, so you can easily change the priority.

Be reminded that the order of fields is configurable. You can change the order of the fields with drag and drop, or you can add new fields at the end of the list.

2.2 Add project Issue Preview

You can override the Global Issue Previews for a specific project. The list displays all projects that don’t already override the Global Previews.

2.3 Test your Issue Preview here

After you finished your configuration, you can preview any hover you want. Put a valid Issue Key from your project and click on Preview to get a URL to that issue. Hover it to see the fields you selected.

2.4 Project Issue Preview

You can see a list of all Projects that override the Global Issue Previews. You can choose to remove all Project level Issue Previews and just use the Global Issue Previews, or configure the list as you wish.

If you override them, you can set a Preview for all Issues (All remaining issues), or per a specific JQL.

Issues will be checked against the list, top to bottom, and assigned a Issue Preview based on the first matching JQL statement. The last option will be chosen if the issue does not match any other JQLs.

For each JQL in this table, you can either have a list of fields, or leave empty to not display any Issue Previews. JQLs are sortable, so you can easily change the priority.

 

Be reminded that the order of fields is configurable. You can change the order of the fields with drag and drop, or you can add new fields at the end of the list.

Available Fields

We support a large variety of fields, including fields from Jira Software, Jira Service Desk, scripted and custom fields.

Default Settings

We recommend the first thing you do is to set the Global Issue Previews. Every project that do not have specific Issue Previews will display Previews according to this.

Viewing fields

A popup will show if you hover a URL of a project for more than 2 seconds. After leaving the popup, it will disappear in a short time.

The hover is scroll-able and re-sizeable, so you can view as many fields as you want.

Related articles