The OrgJQL plugin adds organizational filters to your JQL queries. Here’s the table of contents for this page:
Quick Start
This will get you up and running with OrgJQL in two minutes.
Prerequisites
You’ll need a spreadsheet with the following columns:
First column: Jira display names of users (you don’t need a complete org listing – just add the people that are relevant for your queries)
Second column: Manager display name for each user
Here’s an example:
Step 1: Go to the “Update Org Data” card
Click on add org data and give your data a name.
Then paste your user/manager spreadsheet into the form (see Prerequisites) and click “Save”.
Step 2: Test the org data by going to the “Test Org Data” tab
Click on the “Test Org Data” tab and enter a query using your org data. OrgJQL defines an orgOf JQL function that takes a manager’s name and returns a list of everyone who rolls up to them. Here’s an example query:
assignee in orgOf("William MacLane")
Verify the expansion is correct.
Step 3: Try OrgJQL in the Issue Navigator
Copy your query from Step 2 and run it in Jira’s issue navigator. Verify the results, and you’re ready to go!
Step 4: Leave a review
Let us know if you run into any problems or if you’d like to request a feature by visiting the Forthix JSM Portal
Managing Org Data
In this section, we’ll show you how to add and update organizational data for OrgJQL
Update Org Data Tab
This tab lists what data you currently have set up. The default data is what’s used for the orgOf JQL function. Non-default data can be used when customizing the fx.users function. See “Customizing JQL Functions” below.
Viewing Org Data
You can view the data for an organization by clicking on its name. For instance, clicking on “Engineering” might show the following:
Updating Org Data
The format of the organizational data is an array of user/manager pairs. Note that the names are Jira Display names. Also note that, in OrgJQL, arrays use whitespace as separators instead of commas.
An alternative way to updating org data is to copy and paste it from a spreadsheet. In this case, the first column of the spreadsheet should be user names and the second, the corresponding manager:
When adding or updating org data, just add the relevant users and managers. While you can add your entire company, you can always start with a smaller, more relevant set of people.
Default Data
The default data set can be set by ensuring the “Default Data” slider is on for the dataset in question:
The default data is used for the orgOf word and for many of the customized JQL functions.
Testing Org Data
To check your default org data, go to the “Test Org Data” tab and enter a query using the orgOf JQL function:
You can check the query by clicking the “View in Jira” link.
Review JQL Executions
In this section, we'll go over how to view and manage OrgJQL executions. These "expansions" are stored by Jira for performance, but they are updated when issues are created or updated or when org data is changed. You can also force update any or all OrgJQL executions here.
Background on JQL Executions
When a JQL function is executed, it expands into a JQL fragment that is substituted into the query.
Jira stores these expansions in a pre-computations database to improve performance. The expansions for OrgJQL are listed in the table of the “Review JQL Executions” page.
Searching for clauses
You can filter the table by clauses:
Refreshing expansions
You can click on the “Refresh” control for each clause to force update an expansion:
When are Precomputations Updated?
The following trigger OrgJQL precomputation updates:
Ticket is created (after 15 minutes of inactivity)
Ticket is updated (after 15 minutes of inactivity)
OrgJQL data is updated
Custom JQL function code is updated
When “Refresh All” is clicked in the “Review JQL Executions” page
The refresh job is asynchronous and runs from a queue, so only one job is ever running at a time.
NOTE: Precomputations are only updated if their values have changed.
Stopping a Precomputation Refresh Job
You can stop a running precomputation job by clicking “Force Stop”:
Add Comment