wiki:TracQuery

Version 1 (modified by trac, 6 years ago) (diff)

--

Trac Ticket Queries

In addition to reports, Trac provides support for custom ticket queries, used to display lists of tickets meeting a specified set of 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 filters will display all open tickets, or if you're logged in it will display open tickets assigned to you. Current filters can be removed by clicking the button to the right with the minus sign on the label. New filters are added from the pulldown list in the bottom-right corner of the filters box. Filters with either a text box or a pulldown menu of options can be added multiple times to perform an or of 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.

Once you've edited your filters click the Update button to refresh your results.

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

While Trac does not yet allow saving a named query and somehow making it available in a navigable list, you can save references to queries in Wiki content, as described below.

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

Using the [[TicketQuery]] Macro

The TicketQuery macro lets you display lists of tickets matching certain criteria anywhere you can use WikiFormatting.

Example:

[[TicketQuery(version=0.6|0.7&resolution=duplicate)]]

This is displayed as:

No results

Just like the query: wiki links, the parameter of this macro expects a query string formatted according to the rules of the simple ticket query language.

A more compact representation without the ticket summaries is also available:

[[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]

This is displayed as:

No results

Finally if you wish to receive only the number of defects that match the query using the count parameter.

[[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]]

This is displayed as:

0

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 by placing pipes (|) between the columns like below:

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

This is displayed as:

Results (1 - 3 of 543)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#615 fixed Crash when displaying a picture from a draft email tboeckel Elwood
#613 invalid Wrong command execute when clicking on html Raziel
#612 fixed Attachment reminder not properly erased/drawn tboeckel Raziel
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> like below:

[[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 543)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#615 fixed Crash when displaying a picture from a draft email tboeckel Elwood
Description

Summary

When I open a draft with a picture attachment, I can't "display" the file.

Steps to reproduce

  1. Create a draft with an attached picture
  2. in the draft listbrowser double-click the draft to edit it
  3. on the "attachment" area, right click the picture and select display in the context menu

Expected results

Picture displayed.

Actual results

Crash.

Regression

Notes

It works if I double-click the image. Only the right click/Display makes Yam crash. Version 03/02/2016. I can't test previous version now as I have to go to bed :-)

#613 invalid Wrong command execute when clicking on html Raziel
Description

Summary

I got an email which just holds a certain portion in readable text, the rest is html.

When i open the mail and choose the icon "Display" in the read window i get another windowq with the option to "Display message" No *1 Part 1.1 HTML document.

If i choose to do so i get an error requester telling me that

Error message The execution of the command 'Appdir:OWB "RAM Disk:T/1-YAMm00000056-p1.html"' failed (error code 205: object not found).

and right it is because APPDIR:OWB doesn't exist.

Actually OWB isn't even installed on my system, the APPDIR: entry "OWB" doesn't exist and the URL prefs setting for "OWB" also doesn't exist.

I don't even use the browser exe first at all to start the installed browser, i use a private script to check if the browser is running and use that instead of opening up a new instance and only if no running broswer is found it's run.

Now my question: Is "OWB" in some way hardcoded in YAM? How can i rectify that behaviour?

I'd like YAM to check for the URL prefs setting for a browser and not use "OWB".

Steps to reproduce

  1. Open an email with a html document
  2. Click on the "Display" icon
  3. Click on "Part *1 HTML document"

Expected results

Yam should check for the URL prefs setting and choose whatever it finds there My URL prefs setting for HTTP, HTTPS and WWW uses a private script

Actual results

YAM tries to open the html document with APPDIR:OWB

Regression

No idea, but i guess so, i haven't had that problems with earlier versions of YAM, which they are i can't really tell

Notes

#612 fixed Attachment reminder not properly erased/drawn tboeckel Raziel
Description

Summary

Once the attachemnt reminder kicks in, activated by a given key word, it adds itself to the bottom of a mail in writing. If the last line just above the bottom window border happens to have text in it, though, the attachment reminder will cut some of this line and use it as part of it's own frame once it's drawn (see screenshot)

Steps to reproduce

  1. Open the write window
  2. Enter text that has to be on the bottom (a signature e.g.)
  3. Scroll down (by using blank lines) until the text lines are just above the bottom write window border
  4. Now type any word that triggers the reminder to pop up, i use "I attach..."

Expected results

Attachment reminder popping up nice and clean

Actual results

Attachment reminder popping up with cut text which looks wrong

Regression

Don't think so

Notes

YAM 2.9p1 AmigaOS4.1FE

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. Basically, the filters are separated by ampersands (&). Each filter then 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.

The available operators are:

= the field content exactly matches the 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

See also: TracTickets, TracReports, TracGuide