Trac Ticket Queries
Table of Contents
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 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 and no name/email defined in the preferences then all open issues are displayed.
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 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 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.
Navigating Tickets
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.
Using TracLinks
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:
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:
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 210)
| Ticket | Resolution | Summary | Owner | Reporter |
|---|---|---|---|---|
| #262 | duplicate | Can't import from sub-directories | drakkim | |
| #256 | wontfix | Can't open picture folder | salliema | |
| #250 | fixed | Comments should be Captcha enabled | dev0005 |
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 210)
| Ticket | Resolution | Summary | Owner | Reporter |
|---|---|---|---|---|
| #262 | duplicate | Can't import from sub-directories | drakkim | |
| Description |
When plog-import.php loads, it deletes all directories under "plog-content/uploads" without files, even if it has a sub-directory with files. example: I put pictures in "plog-content/uploads/dir1/dir2/" go to import and "plog-content/uploads/dir1/" is erased because it has no files, even though it has a sub-directory, and that sub-directory has files. I think this post may be related, but I'm not sure. For a quick fix, I commented out lines 220 - 225 in "plog-admin/plog-import.php", which removes the cleanup completely. (Posted here before I read how to submit bug reports) |
|||
| #256 | wontfix | Can't open picture folder | salliema | |
| Description |
I have four folders of pics, but only the following error message when trying to open ONE of the folders. Failed: $AvailableImageOutputFormats? = array(text;wbmp;gif;png;jpeg) in file "phpthumb.class.php" on line 519 $this->thumbnailFormat set to $this->config_output_format "jpeg" in file "phpthumb.class.php" on line 529 $this->thumbnailFormat staying as "jpeg" because "" ($this->f) is not in $AvailableImageOutputFormats? in file "phpthumb.class.php" on line 539 $this->thumbnailQuality set to "75" in file "phpthumb.class.php" on line 546 $this->config_cache_directory () is not a directory in file "phpthumb.class.php" on line 587 SetCacheFilename?() failed because $this->config_cache_directory is empty in file "phpthumb.class.php" on line 1815 GetImageSize?("") failed in file "phpthumb.class.php" on line 1800 starting SourceImageToGD() in file "phpthumb.class.php" on line 1886 Not using EXIF thumbnail data because $this->config_use_exif_thumbnail_for_speed is FALSE in file "phpthumb.class.php" on line 1889 phpThumb() v1.6.0-200507180958 "/home4/salliema/public_html/plogger/images/sallie's_portraits/cats/cat05.jpg" does not exist Also the same picture is duplicated and represents two folders as it's icon. I have "inherited" the task of administrating this site, am an admitted fool and have no idea what version of software I'm using and am obviously doing something wrong as I can get no response of the forum. Any help would be greatly appreciated. |
|||
| #250 | fixed | Comments should be Captcha enabled | dev0005 | |
| Description |
Hi, I am a new user of plogger,Onething i noticed that I received comments by Bot for moderation , so I thing that captcha is essentioanl for comments in plogger. Thanks Dev |
|||
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. To include a litteral & or | in a value, escape the character with a backslash (\).
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 |
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 left out 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
