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: 2 [[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: 0 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 0 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 2 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 4 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 4 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 3 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 18 [[TicketQuery(count)]]
Number of tickets reported or owned by current user: 0 [[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: #17, #18, #16 [[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 David Alexander
Summary Test Ticket

Format: list

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

This is displayed as:

No results

[[TicketQuery(id=123)]]

This is displayed as:

No results

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:

defect

13 / 15

enhancement

0 / 1

comment

2 / 2

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 15)

1 2 3 4 5
Ticket Resolution Summary Owner Reporter
#18 NoChangeNeeded DOS window/full screen crashes in PMSHELL.EXE on first keyboard press erdmann
#17 fixed System crash when calling "full screen command line" dirk
#16 duplicate System crash when calling "full screen command line" dirk
1 2 3 4 5

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 15)

1 2 3 4 5
Ticket Resolution Summary Owner Reporter
#18 NoChangeNeeded DOS window/full screen crashes in PMSHELL.EXE on first keyboard press erdmann
Description

If I open a DOS commandline / full screen and if attempt to type a key on the keyboard I get this trap in PMSHELL.EXE:


05-24-2014 10:17:23 SYS3170 PID 0031 TID 0001 Slot 007a D:\OS2\PMSHELL.EXE f12c0000 f12c0000 EAX=0000c0fc EBX=00000ee4 ECX=0000fc00 EDX=00000467 ESI=00000000 EDI=00000467 DS=9a6a DSACC= DSLIM= ES=053f ESACC=00f2 ESLIM=00000000 FS=0000 FSACC= FSLIM= GS=0000 GSACC= GSLIM= CS:EIP=eb00:00001001 CSACC= CSLIM= SS:ESP=053f:00000002 SSACC=00f2 SSLIM=00000000 EBP=00000000 FLG=000a2286

OS/2 command lines/full screen do not lead to a trap.

I am running eCS 2.2 beta II on an 8-core system. All cores are activated and work OK as such. I am using ACPI.PSD /VW with version 3.22.3.

#17 fixed System crash when calling "full screen command line" dirk
Description

Dear Sirs, I'm testing the available eCS2.2 BETA II, which has included the Panorama 1.06. We are running HP Elite 8300 machines.

I'm getting crashes in form of a coloured sprangled Monitor together with the system completely hung. It's only possible to switch off power with the system.

The crash is reproducible. It appears, when I switch very soon (within 5 seconds) after booting to an eCS full command prompt. It doesn't appear, if you give the system more time after booting. It also can be avoided, if PSD=ACPI.PSD /MAXCPU=1 is used.

I reported this already last year in the eCS bugtracker (ticket: 0003501), where Mr. Roderick Klein asked me to wait for the Panorama Version 1.06. But this error is NOT eliminated with this 1.06.

As a workaround I'm forced to use the MAXCPU=1 solution, as my machines have to run certain scripts and programs in fullscreen mode!

With kind regards Dirk

#16 duplicate System crash when calling "full screen command line" dirk
Description

Dear Sirs, I'm testing the available eCS2.2 BETA II, which has included the Panorama 1.06. We are running HP Elite 8300 machines.

I'm getting crashes in form of a coloured sprangled Monitor together with the system completely hung. It's only possible to switch off power with the system.

The crash is reproducible. It appears, when I switch very soon (within 5 seconds) after booting to an eCS full command prompt. It doesn't appear, if you give the system more time after booting. It also can be avoided, if PSD=ACPI.PSD /MAXCPU=1 is used.

I reported this already last year in the eCS bugtracker (ticket: 0003501), where Mr. Roderick Klein asked me to wait for the Panorama Version 1.06. But this error is NOT eliminated with this 1.06.

As a workaround I'm forced to use the MAXCPU=1 solution, as my machines have to run certain scripts and programs in fullscreen mode!

With kind regards Dirk

1 2 3 4 5


See also: TracQuery, TracTickets, TracReports