Documentation for JIRA 4.1. Documentation for other versions of JIRA is available too.

Skip to end of metadata
Go to start of metadata

JIRA allows you to view search results in several different formats, including Word, Excel, RSS or XML.

A search view that returns too many issues can take a long time for JIRA to complete and can use a large amount of memory. It can be a factor in OutOfMemoryErrors in JIRA.

An large RSS feed of search results can be particularly problematic, because:

  • the user's RSS reader will continue to make the request periodically (for example, every hour)
  • since the RSS reader makes the request, not the user directly, the user is unaware that the request takes a long time or is failing

You can use the following three properties in jira-application.properties to limit the number of issues returned by a search view.

See Making changes to jira.application.properties for the details of how to make and apply changes to jira-application.properties.

jira.search.views.default.max

jira.search.views.default.max sets a "soft" limit on the number of issues returned. It has a default value of 1000. You can set it to, for example, 100 as follows:

##
# The maximum number of results to issue navigator will request from a query
# - set this to zero or negative to be unrestricted (note that the server may forbid this, see below)
#
jira.search.views.default.max = 100

For an RSS or XML view, JIRA applies the limit by appending the tempMax parameter to the URL of the search view. For example:

In the above example, JIRA will limit the number of issues returned to 200 (in this example).

However users can override this "soft" default by removing the tempMax parameter from the URL or by increasing the value of tempMax.

jira.search.views.max.limit

jira.search.views.max.limit sets a "hard" limit on the number of issues returned. It is disabled (commented out) by default. You can set it to, for example, 200 as follows:

##
# Whether search results are capped to a hard limit, otherwise return a 403 (Forbidden) to the client.
#
# Set this to negative (-1) or empty for unlimited results.
#
# NOTE: this SHOULD BE EQUALS OR GREATER THAN than jira.search.views.default.max above, otherwise all issue navigator links will fail with a 403
#
jira.search.views.max.limit = 200

If a user makes a issue view request that would return more than 200 issues (in this example), JIRA does not return the issues but instead returns a 403 (Forbidden) error. While the user might not be happy, it prevents JIRA from consuming lots of resources and possibly running out of memory.

Make sure you set the value of jira.search.views.max.limit to greater than or equal to the "soft" limit set by jira.search.views.default.max. Otherwise all search views that would return issues limited by the default "soft" limit will instead return a 403 (Forbidden) error.

Icon

The jira.search.views.max.limit property was added to JIRA in version 3.10. It is not available in versions earlier than 3.10.

jira.search.views.max.unlimited.group

You may have a requirement for most users to have the limit imposed on them, but a few users to be exempt from the limit. One example of this is if your JIRA instance is Internet facing. You may want external (Internet) users to have the limit imposed on them, but for internal users to be able to produce unlimited search views. You can use the jira.search.views.max.unlimited.group parameter to achieve this.

The jira.search.views.max.unlimited.group property is disabled (commented out) by default. If you enable it, you must set it to a valid group or leave it empty. For example:

##
# Regardless of the above, users in this group will be able to request search requests that are unlimited.
#
# This MUST be a valid group or empty.
#
jira.search.views.max.unlimited.group = jira-administrators
Icon

The jira.search.views.max.unlimited.group property was also added to JIRA in version 3.10. It is not available in versions earlier than 3.10.

Icon

Users exempted from the limit via this technique will still have to add the tempMax parameter to the URL for an RSS or XML view, as described above, in order to exceed the jira.search.views.default.max soft limit.

  • No labels