Configuration
After successful installation, click on the 'Configure' link or navigate to Administration > Plugins > Search > JQL Tricks Config.
* If you are on version 3.1 or less, see the old documentation here.
Upload a valid license and you will see the configuration options. From v4.0, JQL Tricks introduces global configurations as well as function configurations.
Global configurations let you setup a global cache as well as restrict the entire functions to selected groups. Function configurations, on the other hand, can have a cache, restrict the function to selected groups and restrict the function to selected projects as well. More importantly, function configurations overrides the global configurations.
Global Configuration
There are 2 global configurations possible for JQL Tricks plugin.
Setup Cache
The plugin introduces a JQL cache of configurable delay for better performance. The default delay is 120 seconds. Once the cache delay is set, if a query is executed for a second time within the configured delay, results will be displayed from the cache. As with every cache, changes will not be reflected in the searches if the cache is not expired.
It is best to evaluate the plugin to find out the suitable cache delay. For smaller installations, no cache is required and you can set the value to 0. For bigger installations, the delay can be arrived at based on the performance and the need for real time results.
Also check out http://jira.atlassian.com/browse/JRA-22256 for some background on why the cache was originally introduced. Following picture shows how the global cache is set.
Global configurations let you setup a global cache as well as restrict the entire functions to selected groups. Function configurations, on the other hand, can have a cache, restrict the function to selected groups and restrict the function to selected projects as well. More importantly, function configurations overrides the global configurations.
Global Configuration
There are 2 global configurations possible for JQL Tricks plugin.
Setup Cache
The plugin introduces a JQL cache of configurable delay for better performance. The default delay is 120 seconds. Once the cache delay is set, if a query is executed for a second time within the configured delay, results will be displayed from the cache. As with every cache, changes will not be reflected in the searches if the cache is not expired.
It is best to evaluate the plugin to find out the suitable cache delay. For smaller installations, no cache is required and you can set the value to 0. For bigger installations, the delay can be arrived at based on the performance and the need for real time results.
Also check out http://jira.atlassian.com/browse/JRA-22256 for some background on why the cache was originally introduced. Following picture shows how the global cache is set.
Restrict to Groups
Since 3.0 version, JIRA Administrators can select multiple groups to which the plugin functionality will be restricted. Users will be able to use the JQL functions only if they are a member of at least one of the selected groups. If no groups are mapped, everyone will have access. This feature will be useful if you want to limit only selected people in the organization to use the plugin!
Note: This will be overridden by individual function settings. If not groups are selected under individual function settings, global configuration will be used.
Since 3.0 version, JIRA Administrators can select multiple groups to which the plugin functionality will be restricted. Users will be able to use the JQL functions only if they are a member of at least one of the selected groups. If no groups are mapped, everyone will have access. This feature will be useful if you want to limit only selected people in the organization to use the plugin!
Note: This will be overridden by individual function settings. If not groups are selected under individual function settings, global configuration will be used.
Function Configuration
Function configurations are set by navigating to Administration > Plugins > Search > JQL Tricks Function Config.
Restrict to Projects
JIRA Administrators can restrict individual functions to selected projects. The functions will return issues only in the selected projects. If no projects are mapped, issues from all projects will be returned. This will be useful if you want certain functions only in selected projects. Can also be useful if the performance is impacted when the number of issues is more and the plugin really is needed only in few projects!
Restrict to Groups
As mentioned above, JIRA Administrators can select multiple groups to which the selcted function will be restricted, there by overriding the global settings. Users will be able to use the JQL functions only if they are a member of at least one of the selected groups. If no groups are mapped, global settings will be used. This feature will be useful if you only want to limit selected functions to selected people.
Cache Delay
As mentioned above, JIRA Administrators can also configure different cache delay for the selected function. If the cache delay is -1, global delay will be used. If you don't need cache for certain functions, use 0 only for those functions.
Function configurations are set by navigating to Administration > Plugins > Search > JQL Tricks Function Config.
Restrict to Projects
JIRA Administrators can restrict individual functions to selected projects. The functions will return issues only in the selected projects. If no projects are mapped, issues from all projects will be returned. This will be useful if you want certain functions only in selected projects. Can also be useful if the performance is impacted when the number of issues is more and the plugin really is needed only in few projects!
Restrict to Groups
As mentioned above, JIRA Administrators can select multiple groups to which the selcted function will be restricted, there by overriding the global settings. Users will be able to use the JQL functions only if they are a member of at least one of the selected groups. If no groups are mapped, global settings will be used. This feature will be useful if you only want to limit selected functions to selected people.
Cache Delay
As mentioned above, JIRA Administrators can also configure different cache delay for the selected function. If the cache delay is -1, global delay will be used. If you don't need cache for certain functions, use 0 only for those functions.
With the help of global and function configurations, you can restrict all or selected functions to selected groups or projects and can also have different cache configurations.
