On this page:

In this article, we show you how to configure a customized preview popup when you’re hovering over an Artifact link.

Example of an Issue Preview displayed when hovering a Jira Issue in IBM ELM.

Default field to appear in issue previews

There are a few fields that are shown by default, even if they are not in your Screen configuration:

  • Project Name

  • Issue Type

  • Priority

  • Affects Version/s

  • Description

  • Issue Links

  • Status

  • Resolution

  • Fix Version/s

  • Assignee

  • Reporter

  • Created Date

  • Updated Date

Creating an Issue Preview

To customize an Issue Preview, we leverage the Screens feature of Jira to list and organize which additional Fields should be displayed in the Preview.

To customize your Issue Preview:

  1. Go to the Screens configuration page of Jira.

  2. Click the Jira Administration icon in the top right corner and go to the Issues tab.

  3. Click Screens in the Screens section.

Upon reaching the Screens management page, you can either click the Add Screen button in the top right corner or Configure an existing Screen.

Use the input field at the bottom to add Fields to your Screen configuration. You can add multiple tabs to organize the Fields in different sections of the Preview.

In the above example, we have a simple Screen configuration with a single tab holding three Fields.

Related documentation:

Selecting an Issue Preview

Now that you have a custom Screen to use, you need to define when it will be used. This configuration is done on the OSLC Connect Issue Previews configuration page.

To reach this configuration page, simply:

  1. Click the Jira Administration icon in the top right corner and go to the Manage apps tab.

  2. Click Issue Previews in the OSLC Connect section.

This page will allow you to precisely choose when to use your custom Screen for previews:

  1. Start by choosing your Issue Type Scheme in the first list.

  2. Select a Default Scheme Screen in the list below. This will now be the default Screen used to preview issues.

  3. (Optional) If you want, you can choose a different Screen to preview a specific Issue Type.

  4. Click the Save button.

An example of Issue Preview configuration, using a Custom Preview screen for all Issue Types except for the Bug Type, that uses a specific Screen.

Before-after comparison

As an example, you can see below a comparison of the same issue being previewed from ELM.

The first image is the preview with a default empty screen configuration for the preview.

Preview with a default empty screen configuration.

The second image is the preview with a customized screen configuration that uses two sections (Additional Information; Details) to display four new fields (Summary; Labels; Component/s; Due Date).

Preview with a customized screen configuration that uses two sections to display four new fields.

Note that even though it pushes down the Description field, it is still fully readable by scrolling inside the preview or using the Show More option.

Related documentation: