ScriptRunner Enhanced Search
Initial Synchronisation
You must carry out an initial JQL Keyword sync once only after installing Enhanced Search. The length of time that this sync will take is based on the following calculation:
(<number of issues in instance> * 0.00029) / 50
Based on this calculation, we can estimate a timeline for your initial sync. For example, if your instance has:
- 1,000,000 issues we estimate it will take 5.8 days to complete the initial sync.
- 2,000,000 issues we estimate it will take 11.6 days to complete the initial sync.
What is the ScriptRunner Enhanced Search feature?
The ScriptRunner Enhanced Search feature provides advanced JQL function search capabilities, or queries, in Jira Cloud which you can modify or extend. Also available for use within those JQL queries are JQL keywords.
In essence, the terms ScriptRunner Enhanced Search and JQL queries (which are advanced searches that are made up of JQL functions and keywords) mean the same thing.
What are ScriptRunner JQL Functions?
The ScriptRunner Enhanced Search feature provides advanced JQL function search capabilities, or queries, in Jira Cloud. These extend Jira's built-in capabilities and enable you to conduct searches with greater granularity, including much more detailed information about what is happening in your instance and projects. For example, the linkedIssuesOf function will return issues of a certain type based on a subquery you give it.
ScriptRunner for Jira Cloud's out-of-the-box JQL functions are available to all users but can only be used on the Enhanced Search screen under Apps > Enhanced Search.
Below are just some examples of how you can use ScriptRunner JQL functions:
- Use epicsOf to query on epic links, such as finding all epics that have unresolved stories.
Use issuesInEpics to find all stories for open epics in a project, and then look specifically at the status of issues, such as ‘in progress.’
- Use linkedIssuesOf to return linked issues, such as all unresolved issues that are blocked by open issues.
What are ScriptRunner JQL Keywords?
Alongside JQL Functions are the JQL Keywords that can be used within those advanced JQL searches. ScriptRunner Enhanced Search looks at each issue in your Jira instance and adds metadata to them for easier and faster searching. We call this metadata JQL Keywords. These keywords can be used within JQL queries to access this metadata and allow users to search for previously unavailable variables, such as the number of sub-tasks (numberOfSubtasks
).
JQL Keywords can be used in both the Enhanced Search screen under Apps > Enhanced Search or within Jira's issue navigator.
Below are just some examples of how you can use ScriptRunner JQL Keywords:
- Use numberOfAttachments to find issues that have a specified number of file attachments.
- Use numberOfSubtasks to search for issues that have a specified number of subtasks.
- Use commentedOn to find issues that have had a comment made on them on a specified date.