wiki:TracQuery

Trac Ticket Queries

In addition to reports, Trac provides support for custom ticket queries, which can be used to display tickets that meet specified criteria.

To configure and execute a custom query, switch to the View Tickets module from the navigation bar, and select the Custom Query link.

Filters

When you first go to the query page, the default filter will display tickets relevant to you:

  • If logged in then all open tickets, it will display open tickets assigned to you.
  • If not logged in but you have specified a name or email address in the preferences, then it will display all open tickets where your email (or name if email not defined) is in the CC list.
  • If not logged in and no name/email is defined in the preferences, then all open issues are displayed.

Current filters can be removed by clicking the button to the left with the minus sign on the label. New filters are added from the pulldown lists at the bottom corners of the filters box; 'And' conditions on the left, 'Or' conditions on the right. Filters with either a text box or a pulldown menu of options can be added multiple times to perform an Or on the criteria.

You can use the fields just below the filters box to group the results based on a field, or display the full description for each ticket.

After you have edited your filters, click the Update button to refresh your results.

Some shortcuts can be used to manipulate checkbox filters.

  • Clicking on a filter row label toggles all checkboxes.
  • Pressing the modifier key while clicking on a filter row label inverts the state of all checkboxes.
  • Pressing the modifier key while clicking on a checkbox selects the checkbox and deselects all other checkboxes in the filter.

The modifier key is platform and browser dependent. On Mac the modified key is Option/Alt or Command. On Linux the modifier key is Ctrl + Alt. Opera on Windows seems to use Ctrl + Alt, while Alt is effective for other Windows browsers.

Clicking on one of the query results will take you to that ticket. You can navigate through the results by clicking the Next Ticket or Previous Ticket links just below the main menu bar, or click the Back to Query link to return to the query page.

You can safely edit any of the tickets and continue to navigate through the results using the Next/Previous/Back to Query links after saving your results. When you return to the query any tickets which were edited will be displayed with italicized text. If one of the tickets was edited such that it no longer matches the query criteria , the text will also be greyed. Lastly, if a new ticket matching the query criteria has been created, it will be shown in bold.

The query results can be refreshed and cleared of these status indicators by clicking the Update button again.

Saving Queries

Trac allows you to save the query as a named query accessible from the reports module. To save a query ensure that you have Updated the view and then click the Save query button displayed beneath the results. You can also save references to queries in Wiki content, as described below.

Note: one way to easily build queries like the ones below, you can build and test the queries in the Custom report module and when ready - click Save query. This will build the query string for you. All you need to do is remove the extra line breaks.

Note: you must have the REPORT_CREATE permission in order to save queries to the list of default reports. The Save query button will only appear if you are logged in as a user that has been granted this permission. If your account does not have permission to create reports, you can still use the methods below to save a query.

You may want to save some queries so that you can come back to them later. You can do this by making a link to the query from any Wiki page.

[query:status=new|assigned|reopened&version=1.0 Active tickets against 1.0]

Which is displayed as:

Active tickets against 1.0

This uses a very simple query language to specify the criteria, see Query Language.

Alternatively, you can copy the query string of a query and paste that into the Wiki link, including the leading ? character:

[query:?status=new&status=assigned&status=reopened&group=owner Assigned tickets by owner]

Which is displayed as:

Assigned tickets by owner

Customizing the table format

You can also customize the columns displayed in the table format (format=table) by using col≤field>. You can specify multiple fields and what order they are displayed in by placing pipes (|) between the columns:

[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter)]]

This is displayed as:

Results (1 - 3 of 371)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#386 fixed Selected items aren't shown in MUI 5.0-2017R4 Thore Böckelmann jPV
#385 fixed Selected item behaviour when sorting a listview jPV
#384 fixed Active item behaviour when sorting a listview Thore Böckelmann jPV
1 2 3 4 5 6 7 8 9 10 11

Full rows

In table format you can also have full rows by using rows≤field>:

[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter,rows=description)]]

This is displayed as:

Results (1 - 3 of 371)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#386 fixed Selected items aren't shown in MUI 5.0-2017R4 Thore Böckelmann jPV
Description

Summary

I got a report that my Hollywood program doesn't show the selected items in a listview. Items don't get highlighted if I select them programmatically, although they are in the selected state if I check them by the GetSelection method.

My OS4.1FE default MUI version does show them as expected, but the problem seems to be with newer MUI versions, 5.0-2017R4 in this case.

Steps to reproduce

  1. Try this example program: http://jpv.wmhost.com/testi/select/selectiontest (and have this in the same dir: http://jpv.wmhost.com/testi/select/muiroyale.hwp)

Expected results

You see two selected items in the list

Actual results

None of the items seem to get selected visibly

#385 fixed Selected item behaviour when sorting a listview jPV
Description

Summary

If I have a selected item in a listview and sort the listview (programmatically from Hollywood in my case), the selection doesn't follow the item if it moves to a new position.

According my betatester this happens with the MUI 5.0-2017R4, but it does not happen on my MUI from OS4.1FE. So sounds like it's got broken at some point.

I don't know if this got already fixed with the similar issue with active item sorting (bug #384)

Steps to reproduce

  1. Select an item in a listview, let's say the bottom one
  2. Sort the listview so that position of the previously selected item changes, let's say that the item in the step 1 will be at top after sorting

Expected results

The item at top should be selected

Actual results

The bottom item is selected

Notes

Here is a test executable: http://jpv.wmhost.com/testi/select/selectiontestsort And it requires this in the same dir: http://jpv.wmhost.com/testi/select/muiroyale.hwp

For my OS4.1FE default MUI it reports ("Selected item" lines): "Selected item is 2" "Selected item is 0"

But for 5.0-2017R4 it reports: "Selected item is 2" "Selected item is 2"

#384 fixed Active item behaviour when sorting a listview Thore Böckelmann jPV
Description

Summary

I came up with the issue when coding a Hollywood program. If I have an active item in a listview, and then sort the listview, activation doesn't follow the item that was originally activated. After a sort, a new item at the original item's position is activated, and this doesn't sound logical to me, because my program doesn't know anymore which item was activated by user before the sorting. This also behaves differently, for example, to MorphOS MUI. On MorphOS the same item is still activated as originally selected, but in a different position on the list (assuming the order changed in the sort).

Steps to reproduce

  1. Activate an item in a listview, let's say the bottom one
  2. Sort the listview so that position of the previously activated item changes, let's say that the item in the step 1 will be at top after sorting

Expected results

The item at top should be active

Actual results

The bottom item is active

Notes

I've personally tested this with MUI version that comes with OS4.1FE by default, but it seems to be an issue also with newer versions (my betatester reported the issue under 5.0-2017R4/OS4).

I think it's quite likely MUI's fault, but please correct me if it looks to be Hollywood's fault after all.

There may also be a problem with selecting items on newer MUI versions (works for me under OS4.1FE's MUI, but apparently can't select any items codewise from Hollywood under that 5.0-2017R4), but I don't have any more precise information about it atm, but if it's related or comes up when looking at the code…

Here's more information and a short example: https://forums.hollywood-mal.com/viewtopic.php?f=21&t=1926

1 2 3 4 5 6 7 8 9 10 11

Query Language

query: TracLinks and the [[TicketQuery]] macro both use a mini “query language” for specifying query filters. Filters are separated by ampersands (&). Each filter consists of the ticket field name, an operator and one or more values. More than one value are separated by a pipe (|), meaning that the filter matches any of the values. To include a literal & or | in a value, escape the character with a backslash (\).

The available operators are:

= the field content exactly matches one of the values
~= the field content contains one or more of the values
^= the field content starts with one of the values
$= the field content ends with one of the values

All of these operators can also be negated:

!= the field content matches none of the values
!~= the field content does not contain any of the values
!^= the field content does not start with any of the values
!$= the field content does not end with any of the values

The date fields created and modified can be constrained by using the = operator and specifying a value containing two dates separated by two dots (..). Either end of the date range can be left empty, meaning that the corresponding end of the range is open. The date parser understands a few natural date specifications like "3 weeks ago", "last month" and "now", as well as Bugzilla-style date specifications like "1d", "2w", "3m" or "4y" for 1 day, 2 weeks, 3 months and 4 years, respectively. Spaces in date specifications can be omitted to avoid having to quote the query string.

created=2007-01-01..2008-01-01 query tickets created in 2007
created=lastmonth..thismonth query tickets created during the previous month
modified=1weekago.. query tickets that have been modified in the last week
modified=..30daysago query tickets that have been inactive for the last 30 days

See also: TracTickets, TracReports, TracGuide, TicketQuery

Last modified 19 months ago Last modified on Dec 27, 2016, 1:09:11 AM