Customize Simple Search

Owned by Becky Schwartz (Unlicensed)
Last updated: Aug 31, 2023
9 min read

See the customization options below!

 

Learn how to take your Simple Search to the next level with Simple Search fields and Display options

 

Simple Search Fields

The Jira fields, Jira filters, or Custom JQL you add here act as filters for all linked Custom Charts and Issue Lists.

To add fields to Simple Search…

  1. On the right side of Simple Search, ensure you’re on the Simple Search fields tab

  2. Scroll to the bottom of the tab and click + Add another field

  3. In the dropdown, type into the search bar to find a specific Jira field, or select from the 4 options under the Simple Search Fields section

    • Note: Use the Live Preview on the right to see how Simple Search will appear on the Dashboard

      • OPTIONAL: In the Live Preview, select values from any of the Simple Search fields to set them as default selections for the fields

  4. Click Save or Insert

Options

Description

Appearance for Users Viewing The Dashboard

Options

Description

Appearance for Users Viewing The Dashboard

System fields

Add any system field that ships with Jira as a Simple Search field. The fields already included as Simple Search fields when you add the gadget or macro are:

  1. Project

  2. Issue Type

  3. Status

  4. Assignee

 

Custom fields

 

Add any custom Jira field or fields that come from other apps (such as Scriptrunner) as a Simple Search field.

 

Contains text…

 

Allows Dashboard viewers to filter down linked reports using any set of text they choose. This is included by default, but can be removed.

 

Custom JQL Toggle

 

Allows you to write a Custom JQL statement and create a Simple Search filter directly in the gadget/macro.

 

 

 

Add saved filter toggle

 

Allows users to add an existing Jira filter as a Simple Search field. Once this filter is added, Dashboard viewers can use it as a filter on any linked reports.

Users can only add filters they have permission to access in Jira

 

Custom JQL Text Field

 

Allows Dashboard viewers to write their own JQL statement to filter down linked reports.

Saved filters - Multi-select

 

Once added to Simple Search in Edit mode, Dashboard viewers can use any Jira filter available to them as a filter on any linked reports.

Users can only add filters they have permission to access in Jira

 

Display options

Search Options

Search Options

Option

Description

Appearance for Users Viewing The Dashboard

This toggle gives users viewing the Jira Dashboard the ability to customize the order of issues on linked reports. Users can order by any Jira field, Ascending or Descending.

This is enabled by default

 

 

 

This toggle gives users viewing the Jira Dashboard the ability to add other fields as Simple Search field. They can add any Jira system field or custom field, fields from many 3rd party apps, and even Jira filters.

This is enabled by default

Only the user who adds the field will see it in Simple Search. Once they refresh the Dashboard, the field will be removed.

 

 

Description options

Option

Description

Appearance for Users Viewing The Dashboard

Show description

 

This toggle allows users to add a description to Simple Search. The Description Position dropdown allows users to choose where the description is shown, on either Bottom or Top.

This is enabled by default with position set to Bottom.

General Options

Dark Mode

 

This options enables Dark Mode for Simple Search

 

Simple Search Description

Add a Description

  1. With the gadget or macro in Edit mode, on the right side, click the Description tab

  2. Click into the text box and begin typing your description

  3. Click Save to lock in your changes

Change the Description Formatting

Option

What does it do?

What does it look like on gadgets/macros?

Keyboard shortcut

Option

What does it do?

What does it look like on gadgets/macros?

Keyboard shortcut

Text style dropdown

 

The Text Style dropdown gives users the ability to change the style of the text in the description. The styles align with the options available in Confluence.

 

 

Text Formatting

 

The Text Formatting options allow users to format the text in the description.

  1. B button: Bolds the description text

  2. I button: Italicize the description text

  3. Set of 3 dots: Access additional formatting options, including Underline, Strikethrough, Code, Subscript, and Superscript

 

  1. Bold text: Highlight the text, then hit “Command + B”

  2. Italicized text: Highlight the text, then hit “Command + I”

  3. Underlined text: Highlight the text, then hit “Command + U”

  4. Strikethrough text: Highlight the text, then hit “Command+Shift+S”

  5. Coded text: Highlight the text, then hit "Command+Shift+M"

Text Alignment

 

 

The Text Alignment dropdown determines the placement of the description text within the text box.

  1. Shifted to the right of the text box

  2. Shifted to the center of the text box

  3. Shifted to the left of the text box

 

 

Text Color option

 

The Text Color option allows users to adjust the color of the text in the description. Click the specific color square to choose the color. If the color you’re looking for does not match any of the boxes, click More colors to access additional colors.

 

N/A

Bullet List

 

The Bullet list option allows user to add a bulleted list to the description.

 

“Command + Shift + 8”

Numbered List

The Numbered list option allows users to add a numbered list to the description.

 

“Command + Shift + 7”

Link

 

 

 

 

The Link option allows users to insert a link to the description.

In the Paste link box, users can input the direct URL of the link.

In the Text to display box, users can input the text they would like to display the link as

 

“Command + K”

Code Snippet

 

The Code Snippet option allows users to insert a block of code into the chart description in a clean format. Simply enter your code into the grey box that appears.

Use the Select language dropdown to adjust the language of the code. The Trashcan icon removes the code snippet.

 

 

“

Quote

The Quote option allows users to insert a quotation block into the chart description.

 

 

“>”

Expand option

 

The Expand option allows add a block of text that can be hidden or shown based off

 

N/A

Add a Simple Search Title or Overall Gadget Title

Data Center/Server

Cloud

  1. With the gadget in Edit mode, on the right side, find the Chart title dropdown

    1. To add a title that appears within the gadget, select the Chart title radio button

    2. JIRA DC/SERVER ONLY: To add a title to the overall gadget (where it says Custom Charts in the blue bar in the screenshot above), select the Gadget title radio button

  2. Type your title in the text box next to the dropdown

    1. Optional: Use the alignment dropdown to the right of the text box to set the position of the title (Center, left, or right). It’s automatically aligned “Center”

  3. Click Save to lock in your settings

  1. With the gadget in Edit mode, find the Chart Title text box at the top of the gadget and type your desired Simple Search name in the text box

    1. Optional: Use the alignment dropdown to the right of the text box to set the position of the title (Left, center, or right). It’s automatically aligned left

  2. Click Save to lock in your settings