wiki:TicketQuery

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

--

TicketQuery Wiki Macro

The TicketQuery macro lets you display ticket information anywhere that accepts WikiFormatting. The query language used by the [[TicketQuery]] macro is described in the TracQuery page.

Usage

[[TicketQuery]]

Wiki macro listing tickets that match certain criteria.

This macro accepts a comma-separated list of keyed parameters, in the form "key=value".

If the key is the name of a field, the value must use the syntax of a filter specifier as defined in TracQuery#QueryLanguage. Note that this is not the same as the simplified URL syntax used for query: links starting with a ? character. Commas (,) can be included in field values by escaping them with a backslash (\).

Groups of field constraints to be OR-ed together can be separated by a literal or argument.

In addition to filters, several other named parameters can be used to control how the results are presented. All of them are optional.

The format parameter determines how the list of tickets is presented:

  • list -- the default presentation is to list the ticket ID next to the summary, with each ticket on a separate line.
  • compact -- the tickets are presented as a comma-separated list of ticket IDs.
  • count -- only the count of matching tickets is displayed
  • rawcount -- only the count of matching tickets is displayed, not even with a link to the corresponding query (since 1.1.1)
  • table -- a view similar to the custom query view (but without the controls)
  • progress -- a view similar to the milestone progress bars

The max parameter can be used to limit the number of tickets shown (defaults to 0, i.e. no maximum).

The order parameter sets the field used for ordering tickets (defaults to id).

The desc parameter indicates whether the order of the tickets should be reversed (defaults to false).

The group parameter sets the field used for grouping tickets (defaults to not being set).

The groupdesc parameter indicates whether the natural display order of the groups should be reversed (defaults to false).

The verbose parameter can be set to a true value in order to get the description for the listed tickets. For table format only. deprecated in favor of the rows parameter

The rows parameter can be used to specify which field(s) should be viewed as a row, e.g. rows=description|summary

The col parameter can be used to specify which fields should be viewed as columns. For table format only.

For compatibility with Trac 0.10, if there's a last positional parameter given to the macro, it will be used to specify the format. Also, using "&" as a field separator still works (except for order) but is deprecated.

Examples

Example Result Macro
Number of Triage tickets: 2 [[TicketQuery(status=new&milestone=,count)]]
Number of new tickets: 31 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 0 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 0 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 58 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 29 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 71 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 72 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 2025 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 2 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 2286 [[TicketQuery(count)]]
Number of tickets reported or owned by current user: 6 [[TicketQuery(reporter=$USER,or,owner=$USER,count)]]
Number of tickets created this month: 0 [[TicketQuery(created=thismonth..,count)]]
Number of closed Firefox tickets: 0 [[TicketQuery(status=closed,keywords~=firefox,count)]]
Number of closed Opera tickets: 0 [[TicketQuery(status=closed,keywords~=opera,count)]]
Number of closed tickets affecting Firefox and Opera: 0 [[TicketQuery(status=closed,keywords~=firefox opera,count)]]
Number of closed tickets affecting Firefox or Opera: 0 [[TicketQuery(status=closed,keywords~=firefox|opera,count)]]
Number of tickets that affect Firefox or are closed and affect Opera: 0 [[TicketQuery(status=closed,keywords~=opera,or,keywords~=firefox,count)]]
Number of closed Firefox tickets that don't affect Opera: 0 [[TicketQuery(status=closed,keywords~=firefox -opera,count)]]
Last 3 modified tickets: #2284, #2285, #2286 [[TicketQuery(max=3,order=modified,desc=1,compact)]]

Details of ticket #1:

[[TicketQuery(id=1,col=id|owner|reporter,rows=summary,table)]]

Ticket Owner Reporter
#1 Nicklas Nordborg Johan Enell
Summary column names in flatfile parser

Format: list

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

This is displayed as:

No results

[[TicketQuery(id=123)]]

This is displayed as:

#123
The textformat of item types in Edit role ->Permissions doesn't agree with the textformat of permissons in view ->role.

Format: compact

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

This is displayed as:

No results

Format: count

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

This is displayed as:

0

Format: progress

[[TicketQuery(milestone=0.12.8&group=type,format=progress)]]

This is displayed as:

Format: table

You can choose the columns displayed in the table format (format=table) using col=<field>. You can specify multiple fields and the order they are displayed 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 2255)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#2286 fixed Improve performance for multi-hop child->parent->child kolumns everyone Nicklas Nordborg
#2285 fixed Values from items with a "push-to-parent" subtype are not displayed in table list everyone Nicklas Nordborg
#2284 fixed Add support for encryption to the Packed file exporter plug-in everyone Nicklas Nordborg
1 2 3 4 5 6 7 8 9 10 11

Full rows

In table format you can specify full rows 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 2255)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#2286 fixed Improve performance for multi-hop child->parent->child kolumns everyone Nicklas Nordborg
Description

In #2282, new functionality made it possible to display values from a child1->parent->child2 relation in a table list. Depending on the distance between parent and child items this may require a lot of queries against the database before the final child item is reached. One big issue is that when the parent has been reached and the downwards path to the child2 item is started the queries will once again load the same items as when moving up to the parent item. If it is certain that the two child items live in different arms as seen from the parent item it would improve performance if the up-going path was ignored when going down to the second child item.

Note that it may also make sense to not do this filtering so it should be an option.

Here are two examples:

A:

  • A list with DNA extracts is displayed.
  • A column that display ->Parent(Lysate)->Child(RNA) will then display only the RNA that was extracted from the same Lysate as the corresponding DNA.
  • In this case it makes sense to enabled the performance optimization

B:

  • The same list with DNA extracts is displayed.
  • A column that display ->Parent(Patient)->Child(RNA) will then display all RNA that is related to the same patient as the DNA, including those RNA that are from different samples.
  • In this case the performance optimization can't be used.
#2285 fixed Values from items with a "push-to-parent" subtype are not displayed in table list everyone Nicklas Nordborg
Description

The simple structure of item types:

  1. Main parent is RNA.
  2. RNAQC is a child type with "push-to-parent" enabled.
  3. Library is another child type to RNA.
  1. In the table list for extracts, create a filter so that only "Library" items are displayed.
  2. Use the "Columns" dialog and add a parent column with "RNAQC" as the parent type and "BA_RIN" as the annotation to display.

The column is added but no values are displayed. Filtering on the column seems to work (see attached image).

NOTE! Since BASE 3.19.4 (#2282) there is a possible workaround by selecting RNA as the parent item and then RNAQC as the child item (this can be seen in the image).

#2284 fixed Add support for encryption to the Packed file exporter plug-in everyone Nicklas Nordborg
Description

It should be possible for ZIP files, but I don't know about the other currently implemented formats (tar, gzip and bgzip).

1 2 3 4 5 6 7 8 9 10 11


See also: TracQuery, TracTickets, TracReports