This document shows how users can use JQL to find orders matching specific criteria. One benefit of the JQL functionality is that we can configure things such as conditional approvals , create queues and even generate reports.
The following values are searchable in a Checkout Order.
Attribute | JQL Reference | Type |
|---|---|---|
Total |
| Number |
Order Status |
| Text |
Department Budget |
| Number |
Department Code |
| Text |
Department Name |
| Text |
Address Street Number |
| Text |
Address State |
| Text |
Address Country |
| Text |
Address Postal Code |
| Text |
The following attributes are searchable in checkout Purchase Order
Attribute | JQL Reference | Type |
|---|---|---|
Total |
|
...
Attribute
...
JQL Reference
...
Type
...
| Number |
Vendor Name |
|
...
Number
...
| Text |
For example. You can search for all items purchase made from Apple.
| Code Block |
|---|
issue.property['com.mumosystems.purchase-order'].vendor.name |
...
Text
~ "Apple" |
Total
Every Checkout order has a total price associated with it.
To search against that property, you can use the following types of JQL.
Return all tickets with orders greater than a certain value.
| Code Block |
|---|
issue.property['com.mumosystems.checkout-order'].total > 50 |
You can also use the operators =,!=,>=,<,<= in a comparison query.
Order Status
To query against the status property, use the following queries.
This will pull all the tickets with orders where the status is not equal to Canceled.
| Code Block |
|---|
issue.property['com.mumosystems.checkout-order'].status !~ "canceled" |
Users can also search for tickets which match a status using the ~ operator.
Valid options for the status are
New
Declined
Ordered
Completed
Canceled
Backfill
Return
Department Budget
Department Budget is a number field, which means that mathematical operators can be used.
The Department budget is not updated for every ticket as the departments budget changes, which means that this query is really most useful to run WHILE the order is being placed. For example, if you want to alert a specific user when a department budget dips below a certain amount, these JQL’s could be used.
| Code Block |
|---|
issue.property['com.mumosystems.checkout-order'].department.budget < 500 |
You can also use the operators =,!=,>=,<,<= in a comparison query.
Department Name
Department Name is a text value, which means that users will need to search for it using the ~/!~ operators.
| Code Block |
|---|
issue.property['com.mumosystems.checkout-order'].department.name ~ "Test Department" |
Department Code
Department Code is a text value, which means that users will need to search for it using the ~/!~ operators.
| Code Block |
|---|
issue.property['com.mumosystems.checkout-order'].department.code ~ "TD" |
Address Fields
The following information about an address can be searched:
Street number - searched using issue.property['com.mumosystems.checkout-order'].address.address
State - Searched using issue.property['com.mumosystems.checkout-order'].address.state
Country - Search using issue.property['com.mumosystems.checkout-order'].address.country
Postal code - Search using issue.property['com.mumosystems.checkout-order'].address.postalCode
Each address field is searchable as a text field.
| Code Block |
|---|
//Search for all tickets delivered to 6000 Grand Ave street address.
issue.property['com.mumosystems.checkout-order'].address.address ~ "6000 Grand Ave"
//Search for all tickets with an order placed to Iowa.
issue.property['com.mumosystems.checkout-order'].address.state ~ "Iowa"
//To search for a full address, perform a search like the following:
issue.property['com.mumosystems.checkout-order'].address.address ~ "6000 Grand Ave" AND
issue.property['com.mumosystems.checkout-order'].address.state ~ "Iowa" AND
issue.property['com.mumosystems.checkout-order'].address.country ~ "United States Of America" AND
issue.property['com.mumosystems.checkout-order'].address.postalCode ~ "50265" |