wiki:TicketQuery

TicketQuery Wiki Macro

The TicketQuery macro lets you display information on tickets within wiki pages. The query language used by the [[TicketQuery]] macro is described in 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.

Example

Example Result Macro
Number of Triage tickets: 0 [[TicketQuery(status=new&milestone=,count)]]
Number of new tickets: 6 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 1 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 3 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 35 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 102 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 52 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 96 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 361 [[TicketQuery(status=closed,resolution=fixed,count)]]
Total number of tickets: 809 [[TicketQuery(count)]]
Number of tickets reported or owned by current user: 21 [[TicketQuery(reporter=$USER,or,owner=$USER,count)]]
Number of tickets created this month: 4 [[TicketQuery(created=thismonth..,count)]]
Last 3 modified tickets: #1209, #1208, #1207 [[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
No tickets found

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:

#14
Poor internet access in Convention Room 2
#16
[rt.amsl.com #9750] Convention 1 Wifi is barely 11 mb/sec......
#30
Poor connectivity in Convention2 and 3
#47
Bad access point in Convention 3
#88
[Fwd: Problem: No IP Address]
#176
looks like an AP is misconfig'd?
#243
Re: [79attendees] Problems with ietf-hotel network
#244
Re: [79attendees] Problems with ietf-hotel network
#245
Re: [79attendees] Problems with ietf-hotel network
#303
Audio stream not working in Valley Ballroom A (Transport Area Working Group)
#343
Re: can't reach AS2518
#344
Re: can't reach AS2518
#446
no audio in IPPM / room 253
#451
Opnieuw te bevestigen Internetbankieren Identity
#466
Re: Fwd: Remote participation
#467
http://ietf83streaming.dnsalias.net/ietf/ietf837.m3u (and others?)
#504
Fwd: [www.ietf.org/rt #49828] media stream
#526
Re: IETF 85 - Room 305
#528
Re: IETF 85 - Room 305
#538
Re: ipv6 routing up yet?
#565
1x troubles (fwd)
#572
Broken wired in my room (2433)
#573
No DHCP lease from Tower2 guest room wired connection
#583
Fwd: [www.ietf.org/rt #54682] low audio from Caribbean IV / SIDR
#867
ietf-hotel connection heavy packet losses from the hotel room
#907
trans wg in far east has no working audio
#914
Packet loss on ietf-hotel
#916
Packet loss on ietf-hotel
#925
room network troubles (bad wireless; wired not working at all)
#927
Wireless Issues - Room 3055
#928
Is ietf-hotel stable yet?
#929
IETF Hotel connection is slow and drops frequently
#931
FYI - ietf-hotel very slow in Hilton Prague room 5014
#932
hotel wireless issue
#933
Hotelroom wireless performance issue
#934
Hotel network
#935
Spotty Connection
#936
ietf-hotel network
#937
Re: [93attendees] Fwd: Ethernet cable?
#939
Nexus 10 DNS loss on ietf-hotel
#941
ietf-hotel
#942
Problem with Wifi access ietf-hotel in my Hilton room 6098
#949
Network keeps failing
#961
Significant packet loss on ietf-hotel SSID on L2
#963
hilton guest room problem
#965
room 5083 not wired ?
#966
(new and continued) issues on ietf-hotel
#969
Room wifi
#975
ietf-hotel, public communication
#978
6th floor at the Hilton
#1179
Having problems with nat64 SSID
#1186
ietf-NAT64 no route

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. This also displays the link and description of a single ticket:

[[TicketQuery(id=123)]]

This is displayed as:

#123
MaiLinX Alert from printer9

A more compact representation without the ticket summaries is:

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

This is displayed as:

#14, #16, #30, #47, #88, #176, #243, #244, #245, #303, #343, #344, #446, #451, #466, #467, #504, #526, #528, #538, #565, #572, #573, #583, #867, #907, #914, #916, #925, #927, #928, #929, #931, #932, #933, #934, #935, #936, #937, #939, #941, #942, #949, #961, #963, #965, #966, #969, #975, #978, #1179, #1186

If you wish to receive only the number of defects that match the query, use the count parameter:

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

This is displayed as:

52

A graphical use of the macro is with the format=progress attribute:

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

For example for one of the upcoming milestones, bars are shown by ticket type:


See also: TracQuery, TracTickets, TracReports, TracGuide

Last modified 11 months ago Last modified on 25 Jan 2017, 21:56:44