Custom Charts for Jira

Integration: Using ScriptRunner Enhanced Search with Custom Charts for Jira (Cloud)

Owned by Becky Schwartz
Last updated: Nov 07, 2022
4 min read

Due to the infrastructure of Jira Cloud, ScriptRunner functions cannot be accessed in Jira Query Language (JQL) queries in Issue Search and Jira Dashboards directly. To use ScriptRunner functions in queries, users must use ScriptRunner’s Enhanced Search feature. Here, users create a filter with the ScriptRunner function included, then save it, allowing it to be used across Jira in projects, reports, and Dashboards. You can use your filters in any Custom Charts for Jira gadgets, including Simple Search and Issue List.

To configure Enhanced Search filters, then use them in our gadgets, follow the steps below.

Jump to a Topic

  1. In the Jira header, click Apps-->ScriptRunner Enhanced Search

  2. In Enhanced Search, begin typing in your JQL query in the search bar. You can use ScriptRunner functions in the query

    1. If you click the + in the search bar, you can access a list of available ScriptRunner functions for your query

  3. Once you’ve written your JQL query, click Save as Filter

    1. In the dialog box that appears:

      1. Name the filter

      2. Turn the Sync Filter toggle on

      3. Optional: If you want any user to be able to pull the filter into boards and Dashboards, turn the Share with all toggle on

      4. Optional: If you want to restrict filter access to specific projects and/or Jira groups, select them in the Choose Projects and/or the Choose Groups drop downs

    2. Click Save. The Enhanced Search filter will now appear in the Filters dropdown in the Jira navigation header, and will be accessible in all gadgets on Dashboards

Step 2: Use Enhanced Search filter in Custom Charts gadgets

Source Dropdown

This is applicable across all of our gadgets, including Custom Charts, Issue List, and Simple Search

  1. On the right side of the gadget, click the Source dropdown and select Saved filters

  2. Click into the filter search bar, and begin typing in the name of your filter. Once it appears on the list, select it. This sets the Enhanced Search Filter as the gadget’s Source.

Chart By/Group By settings

This is applicable for the Custom Charts gadget only, as Issue List and Simple Search do not have these dropdowns

  1. On the right side of the gadget in the Chart by or Group by dropdown, select Saved filters

  2. Navigate to the Chart By tab or Group By tab on the right side of the gadget

  3. Click into the box that says “Search for saved filters…” and select your filter. This sets the Enhanced Search Filter as the Chart by or Group by value.

Simple Search Fields

This is applicable in Simple Search only, as Issue List and Custom Charts do not have Simple Search fields

  1. In the right side of Simple Search, navigate to the Simple Search Fields section, then click + Add saved filter toggle

  2. Click into the saved filter dropdown and select the Enhanced Search filter from the list. This sets the Enhanced Search Filter as a Simple Search field.

Issue List Quick Filters

  1. In the right side of Issue List, navigate to the Quick Filters section, then click + Add saved filter toggle

  2. Click into the saved filter dropdown and select the Enhanced Search filter from the list. This sets the Enhanced Search Filter as a Quick Filter.